Changes between Version 2 and Version 3 of TracInstall
- Timestamp:
- Oct 29, 2015, 1:00:54 PM (9 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracInstall
v2 v3 1 = Trac Installation Guide for 0.12 = 1 {{{#!div style="margin-top: .5em; padding: 0 1em; background-color: #ffd; border:1px outset #ddc; text-align: center" 2 3 '''NOTE: the information in this page applies to Trac 1.0, the current version of Trac. \\ 4 For installing previous Trac versions, please refer to [[wiki:0.12/TracInstall]] (for Trac 0.12)''' 5 }}} 6 7 = Trac Installation Guide for 1.0 2 8 [[TracGuideToc]] 3 9 4 10 Trac is written in the Python programming language and needs a database, [http://sqlite.org/ SQLite], [http://www.postgresql.org/ PostgreSQL], or [http://mysql.com/ MySQL]. For HTML rendering, Trac uses the [http://genshi.edgewall.org Genshi] templating system. 5 11 6 Since version 0.12, Trac can also be localized, and there's probably a translation available for your language. If you want to be able to use the Trac interface in other languages, then make sure you **first** have installed the optional package [#OtherPythonPackages Babel]. Lacking Babel, you will only get the default English version, as usual. If you install Babel later on, you will need to re-install Trac.12 Since version 0.12, Trac can also be localized, and there's probably a translation available for your language. If you want to be able to use the Trac interface in other languages, then make sure you have installed the optional package [#OtherPythonPackages Babel]. Pay attention to the extra steps for localization support in the [#InstallingTrac Installing Trac] section below. Lacking Babel, you will only get the default English version, as usual. 7 13 8 14 If you're interested in contributing new translations for other languages or enhance the existing translations, then please have a look at [trac:wiki:TracL10N TracL10N]. 9 15 10 What follows are generic instructions for installing and setting up Trac and its requirements. While you may find instructions for installing Trac on specific systems at [trac: wiki:TracInstallPlatforms TracInstallPlatforms] on the main Trac site, please be sure to '''first read through these general instructions''' to get a good understanding of the tasks involved.16 What follows are generic instructions for installing and setting up Trac and its requirements. While you may find instructions for installing Trac on specific systems at [trac:TracInstallPlatforms TracInstallPlatforms] on the main Trac site, please be sure to '''first read through these general instructions''' to get a good understanding of the tasks involved. 11 17 12 18 [[PageOutline(2-3,Installation Steps,inline)]] 13 19 14 == Dependencies ==20 == Dependencies 15 21 === Mandatory Dependencies 16 22 To install Trac, the following software packages must be installed: 17 23 18 * [http://www.python.org/ Python], version >= 2. 4and < 3.019 //(note that we dropped the support for Python 2.3 in this release and that this will be the last Trac release supporting Python 2.4)//24 * [http://www.python.org/ Python], version >= 2.5 and < 3.0 25 (note that we dropped the support for Python 2.4 in this release) 20 26 * [http://peak.telecommunity.com/DevCenter/setuptools setuptools], version >= 0.6 21 * [http://genshi.edgewall.org/wiki/Download Genshi], version >= 0.6 (but < 0.7dev, i.e. don't use Genshi trunk)27 * [http://genshi.edgewall.org/wiki/Download Genshi], version >= 0.6 22 28 23 29 You also need a database system and the corresponding python bindings. … … 26 32 ==== For the SQLite database #ForSQLite 27 33 28 If you're using Python 2.5 or 2.6, you already have everything you need. 29 30 If you're using Python 2.4 and need pysqlite, you can download from 31 [http://code.google.com/p/pysqlite/downloads/list google code] the Windows installers or the tar.gz archive for building from source: 32 {{{ 34 As you must be using Python 2.5, 2.6 or 2.7, you already have the SQLite database bindings bundled with the standard distribution of Python (the `sqlite3` module). 35 36 However, if you'd like, you can download the latest and greatest version of [[trac:PySqlite]] from 37 [http://code.google.com/p/pysqlite/downloads/list google code], where you'll find the Windows 38 installers or the `tar.gz` archive for building from source: 39 {{{#!sh 33 40 $ tar xvfz <version>.tar.gz 34 41 $ cd <version> … … 36 43 }}} 37 44 38 This will extract the SQLite code and build the bindings. 39 40 To install SQLite, your system may require the development headers. Without these you will get various GCC related errors when attempting to build: 41 42 {{{ 43 $ apt-get install libsqlite3-dev 44 }}} 45 46 SQLite 2.x is no longer supported, and neither is !PySqlite 1.1.x. 47 48 A known bug !PySqlite versions 2.5.2-4 prohibits upgrade of trac databases 45 This will download the latest SQLite code and build the bindings. 46 47 SQLite 2.x is no longer supported. 48 49 A known bug in PySqlite versions 2.5.2-4 prohibits upgrades of Trac databases 49 50 from 0.11.x to 0.12. Please use versions 2.5.5 and newer or 2.5.1 and 50 older. See [trac:#9434]for more detail.51 52 See additional information in [trac:PySqlite ].51 older. See #9434 for more detail. 52 53 See additional information in [trac:PySqlite PySqlite]. 53 54 54 55 ==== For the PostgreSQL database #ForPostgreSQL … … 56 57 You need to install the database and its Python bindings: 57 58 * [http://www.postgresql.org/ PostgreSQL], version 8.0 or later 58 * [http://pypi.python.org/pypi/psycopg2 psycopg2] 59 * [http://pypi.python.org/pypi/psycopg2 psycopg2], version 2.0 or later 59 60 60 61 See [trac:DatabaseBackend#Postgresql DatabaseBackend] for details. … … 72 73 === Optional Dependencies 73 74 74 ==== Version Control System ==== 75 76 ===== Subversion ===== 77 78 [http://subversion.apache.org/ Subversion] 1.5.x or 1.6.x and the '''''corresponding''''' Python bindings. 79 80 There are [http://subversion.apache.org/packages.html pre-compiled SWIG bindings] available for various platforms. See also the TracSubversion page for details about Windows packages. 81 82 Older versions starting from 1.4.0, etc. should still work. For troubleshooting information, check the [trac:TracSubversion#Troubleshooting TracSubversion] page. Versions prior to 1.4.0 won't probably work since trac uses svn core functionality (e.g. svn_path_canonicalize) that is not implemented in the python swig wrapper in svn <= 1.3.x (although it exists in the svn lib itself). 75 ==== Version Control System 76 77 ===== Subversion 78 * [http://subversion.apache.org/ Subversion], 1.5.x or 1.6.x and the '''''corresponding''''' Python bindings. Older versions starting from 1.0, like 1.2.4, 1.3.2 or 1.4.2, etc. should still work. For troubleshooting information, check the [trac:TracSubversion#Troubleshooting TracSubversion] page. 79 80 There are [http://subversion.apache.org/packages.html pre-compiled SWIG bindings] available for various platforms. (Good luck finding precompiled SWIG bindings for any Windows package at that listing. TracSubversion points you to [http://alagazam.net Algazam], which works for me under Python 2.6.) 83 81 84 82 Note that Trac '''doesn't''' use [http://pysvn.tigris.org/ PySVN], neither does it work yet with the newer `ctype`-style bindings. 85 83 86 '''Please note:''' if using Subversion, Trac must be installed on the '''same machine'''. Remote repositories are currently [trac:#493 not supported]. 87 88 89 ===== Others ===== 84 85 '''Please note:''' if using Subversion, Trac must be installed on the '''same machine'''. Remote repositories are currently [trac:ticket:493 not supported]. 86 87 88 ===== Others 90 89 91 90 Support for other version control systems is provided via third-parties. See [trac:PluginList] and [trac:VersionControlSystem]. 92 91 93 ==== Web Server ====94 A web server is optional because Trac is shipped with a server included, see the [#RunningtheStandaloneServer Running the Standalone Server 95 96 Alternatively you c onfigure Trac to run in any of the following environments.92 ==== Web Server 93 A web server is optional because Trac is shipped with a server included, see the [#RunningtheStandaloneServer Running the Standalone Server] section below. 94 95 Alternatively you can configure Trac to run in any of the following environments. 97 96 * [http://httpd.apache.org/ Apache] with 98 - [http://code.google.com/p/modwsgi/ mod_wsgi], see [wiki:TracModWSGI] (preferred)99 - //[http://modpython.org/ mod_python 3.3.1], see TracModPython (deprecated)//100 * any [http://www.fastcgi.com/ FastCGI]-capable web server, see TracFastCgi101 * a ny [http://tomcat.apache.org/connectors-doc/ajp/ajpv13a.html AJP]-capable web102 server, see [trac:TracOnWindowsIisAjp]103 * IIS with [http://code.google.com/p/isapi-wsgi/ Isapi-wsgi], see [trac:TracOnWindowsIisIsapi]104 * //as a last resort, a CGI-capable web server (see TracCgi),but usage of Trac as a cgi script105 is highly discouraged , better use one of the previous options.//97 - [http://code.google.com/p/modwsgi/ mod_wsgi], see [wiki:TracModWSGI] and 98 http://code.google.com/p/modwsgi/wiki/IntegrationWithTrac 99 - [http://modpython.org/ mod_python 3.3.1], (deprecated: see TracModPython) 100 * a [http://www.fastcgi.com/ FastCGI]-capable web server (see TracFastCgi) 101 * an [http://tomcat.apache.org/connectors-doc/ajp/ajpv13a.html AJP]-capable web 102 server (see [trac:TracOnWindowsIisAjp TracOnWindowsIisAjp]) 103 * a CGI-capable web server (see TracCgi), '''but usage of Trac as a cgi script 104 is highly discouraged''', better use one of the previous options. 106 105 107 106 108 ==== Other Python Packages ==== 109 110 * [http://babel.edgewall.org Babel], version 0.9.5, 111 needed for localization support[[BR]] 112 ''Note: '' If you want to be able to use the Trac interface in other languages, then make sure you first have installed the optional package Babel. Lacking Babel, you will only get the default english version, as usual. If you install Babel later on, you will need to re-install Trac. 107 ==== Other Python Packages 108 109 * [http://babel.edgewall.org Babel], version >= 0.9.5, 110 needed for localization support (unreleased version 1.0dev should work as well) 113 111 * [http://docutils.sourceforge.net/ docutils], version >= 0.3.9 114 112 for WikiRestructuredText. 115 * [http://pygments. pocoo.org Pygments] for113 * [http://pygments.org Pygments] for 116 114 [wiki:TracSyntaxColoring syntax highlighting]. 117 115 [http://silvercity.sourceforge.net/ SilverCity] and/or … … 122 120 an internal time zone implementation. 123 121 124 '''Attention''': The various available versions of these dependencies are not necessarily interchang able, so please pay attention to the version numbers above. If you are having trouble getting Trac to work please double-check all the dependencies before asking for help on the [trac:MailingList] or [trac:IrcChannel].122 '''Attention''': The various available versions of these dependencies are not necessarily interchangeable, so please pay attention to the version numbers above. If you are having trouble getting Trac to work please double-check all the dependencies before asking for help on the [trac:MailingList] or [trac:IrcChannel]. 125 123 126 124 Please refer to the documentation of these packages to find out how they are best installed. In addition, most of the [trac:TracInstallPlatforms platform-specific instructions] also describe the installation of the dependencies. Keep in mind however that the information there ''probably concern older versions of Trac than the one you're installing'' (there are even some pages that are still talking about Trac 0.8!). 127 125 128 126 129 == Installing Trac ==127 == Installing Trac 130 128 === Using `easy_install` 131 129 One way to install Trac is using [http://pypi.python.org/pypi/setuptools setuptools]. 132 With setuptools you can install Trac from the subversion repository;130 With setuptools you can install Trac from the Subversion repository; 133 131 134 132 A few examples: 135 133 136 - first install of the latest stable version Trac 0.12.3, with i18n support: 137 {{{ 138 easy_install Babel==0.9.5 139 easy_install Trac==0.12 134 - Install Trac 1.0: 135 {{{#!sh 136 easy_install Trac==1.0 140 137 }}} 141 ''It's very important to run the two `easy_install` commands separately, otherwise the message catalogs won't be generated.'' 142 143 - upgrade to the latest stable version of Trac: 144 {{{ 145 easy_install -U Trac 138 - Install latest development version: 139 {{{#!sh 140 easy_install Trac==dev 146 141 }}} 147 148 - upgrade to the latest trunk development version: 149 {{{ 150 easy_install -U Trac==dev 151 }}} 152 153 For upgrades, reading the TracUpgrade page is mandatory, of course. 154 155 === From source 156 If you want more control, you can download the source in archive form, or do a checkout from one of the official [[Trac:TracRepositories|source code repositories]]. 157 158 Be sure to have the prerequisites already installed. You can also obtain the Genshi and Babel source packages from http://www.edgewall.org and follow for them a similar installation procedure, or you can just `easy_install` those, see [#Usingeasy_install above]. 159 160 Once you've unpacked the Trac archive or performed the checkout, move in the top-level folder and do: 161 {{{ 162 $ python ./setup.py install 163 }}} 164 165 You'll need root permissions or equivalent for this step. 166 167 This will byte-compile the python source code and install it as an .egg file or folder in the `site-packages` directory 168 of your Python installation. The .egg will also contain all other resources needed by standard Trac, such as htdocs and templates. 169 170 The script will also install the [wiki:TracAdmin trac-admin] command-line tool, used to create and maintain [wiki:TracEnvironment project environments], as well as the [wiki:TracStandalone tracd] standalone server. 171 172 If you install from source and want to make Trac available in other languages, make sure Babel is installed. Only then, perform the `install` (or simply redo the `install` once again afterwards if you realize Babel was not yet installed): 173 {{{ 174 $ python ./setup.py install 175 }}} 176 Alternatively, you can do a `bdist_egg` and copy the .egg from dist/ to the place of your choice, or you can create a Windows installer (`bdist_wininst`). 177 178 === Advanced Options === 179 180 ==== Custom location with `easy_install` 181 182 To install Trac to a custom location, or find out about other advanced installation options, run: 183 {{{ 184 easy_install --help 185 }}} 186 187 Also see [http://docs.python.org/inst/inst.html Installing Python Modules] for detailed information. 188 189 Specifically, you might be interested in: 190 {{{ 191 easy_install --prefix=/path/to/installdir 192 }}} 193 or, if installing Trac to a Mac OS X system: 194 {{{ 195 easy_install --prefix=/usr/local --install-dir=/Library/Python/2.5/site-packages 196 }}} 197 Note: If installing on Mac OS X 10.6 running {{{ easy_install http://svn.edgewall.org/repos/trac/trunk }}} will install into {{{ /usr/local }}} and {{{ /Library/Python/2.6/site-packages }}} by default 198 199 The above will place your `tracd` and `trac-admin` commands into `/usr/local/bin` and will install the Trac libraries and dependencies into `/Library/Python/2.5/site-packages`, which is Apple's preferred location for third-party Python application installations. 200 201 ==== Using `pip` 142 Note that in this case you won't have the possibility to run a localized version of Trac; 143 either use a released version or install from source 144 145 {{{#!div style="border: 1pt dotted; margin: 1em" 146 **Setuptools Warning:** If the version of your setuptools is in the range 5.4 through 5.6, the environment variable `PKG_RESOURCES_CACHE_ZIP_MANIFESTS` must be set in order to avoid significant performance degradation. More information may be found in the sections on [#RunningtheStandaloneServer Running The Standalone Server] and [#RunningTraconaWebServer Running Trac on a Web Server]. 147 }}} 148 149 === Using `pip` 202 150 'pip' is an easy_install replacement that is very useful to quickly install python packages. 203 To get a trac installation up and running in less than 5 minutes:204 205 Assuming you want to have your entire pip installation in /opt/user/trac:151 To get a Trac installation up and running in less than 5 minutes: 152 153 Assuming you want to have your entire pip installation in `/opt/user/trac` 206 154 207 155 - 208 {{{ 209 pip -E /opt/user/tracinstall trac psycopg2156 {{{#!sh 157 pip install trac psycopg2 210 158 }}} 211 159 or 212 160 - 213 {{{ 214 pip -E /opt/user/trac install trac mysql-python 215 }}} 216 217 Make sure your OS specific headers are available for pip to automatically build PostgreSQL (libpq-dev) or MySQL (libmysqlclient-dev) bindings. 218 219 pip will automatically resolve all dependencies (like Genshi, pygments, etc.) and download the latest packages on pypi.python.org and create a self contained installation in /opt/user/trac . 220 221 All commands (tracd, trac-admin) are available in /opt/user/trac/bin. This can also be leveraged for mod_python (using !PythonHandler directive) and mod_wsgi (using WSGIDaemonProcess directive) 222 223 Additionally, you can install several trac plugins (listed [http://pypi.python.org/pypi?:action=search&term=trac&submit=search here]) through pip. 224 225 226 227 == Creating a Project Environment == 161 {{{#!sh 162 pip install trac mysql-python 163 }}} 164 165 Make sure your OS specific headers are available for pip to automatically build PostgreSQL (`libpq-dev`) or MySQL (`libmysqlclient-dev`) bindings. 166 167 pip will automatically resolve all dependencies (like Genshi, pygments, etc.) and download the latest packages on pypi.python.org and create a self contained installation in `/opt/user/trac`. 168 169 All commands (`tracd`, `trac-admin`) are available in `/opt/user/trac/bin`. This can also be leveraged for `mod_python` (using `PythonHandler` directive) and `mod_wsgi` (using `WSGIDaemonProcess` directive) 170 171 Additionally, you can install several Trac plugins (listed [http://pypi.python.org/pypi?:action=search&term=trac&submit=search here]) through pip. 172 173 174 175 === From source 176 Of course, using the python-typical setup at the top of the source directory also works. 177 178 You can obtain the source for a .tar.gz or .zip file corresponding to a release (e.g. `Trac-1.0.tar.gz`), or you can get the source directly from the repository (see [trac:SubversionRepository] for details). 179 180 {{{#!sh 181 $ python ./setup.py install 182 }}} 183 184 ''You'll need root permissions or equivalent for this step.'' 185 186 This will byte-compile the Python source code and install it as an .egg file or folder in the `site-packages` directory 187 of your Python installation. The .egg will also contain all other resources needed by standard Trac, such as `htdocs` and `templates`. 188 189 The script will also install the [wiki:TracAdmin trac-admin] command-line tool, used to create and maintain [wiki:TracEnvironment project environments], as well as the [wiki:TracStandalone tracd] standalone server. 190 191 If you install from source and want to make Trac available in other languages, make sure Babel is installed. Only then, perform the `install` (or simply redo the `install` once again afterwards if you realize Babel was not yet installed): 192 {{{#!sh 193 $ python ./setup.py install 194 }}} 195 Alternatively, you can run `bdist_egg` and copy the .egg from `dist/` to the place of your choice, or you can create a Windows installer (`bdist_wininst`). 196 197 === Advanced Options 198 199 To install Trac to a custom location, or find out about other advanced installation options, run: 200 {{{#!sh 201 easy_install --help 202 }}} 203 204 Also see [http://docs.python.org/2/install/index.html Installing Python Modules] for detailed information. 205 206 Specifically, you might be interested in: 207 {{{#!sh 208 easy_install --prefix=/path/to/installdir 209 }}} 210 or, if installing Trac on a Mac OS X system: 211 {{{#!sh 212 easy_install --prefix=/usr/local --install-dir=/Library/Python/2.5/site-packages 213 }}} 214 Note: If installing on Mac OS X 10.6 running {{{ easy_install http://svn.edgewall.org/repos/trac/trunk }}} will install into {{{ /usr/local }}} and {{{ /Library/Python/2.6/site-packages }}} by default. 215 216 The above will place your `tracd` and `trac-admin` commands into `/usr/local/bin` and will install the Trac libraries and dependencies into `/Library/Python/2.5/site-packages`, which is Apple's preferred location for third-party Python application installations. 217 218 219 == Creating a Project Environment 228 220 229 221 A [TracEnvironment Trac environment] is the backend storage where Trac stores information like wiki pages, tickets, reports, settings, etc. An environment is basically a directory that contains a human-readable [TracIni configuration file], and various other files and directories. 230 222 231 223 A new environment is created using [wiki:TracAdmin trac-admin]: 232 {{{ 224 {{{#!sh 233 225 $ trac-admin /path/to/myproject initenv 234 226 }}} … … 239 231 For the other [DatabaseBackend database backends] you should plan ahead and already have a database ready to use at this point. 240 232 241 Since 0.12, Trac doesn't ask for a [TracEnvironment#SourceCodeRepository source code repository] anymore when creating an environment. Repositories can be [TracRepositoryAdmin added] afterward , or the version control support can be disabled completely if you don't need it.233 Since 0.12, Trac doesn't ask for a [TracEnvironment#SourceCodeRepository source code repository] anymore when creating an environment. Repositories can be [TracRepositoryAdmin added] afterwards, and support for specific version control systems is disabled by default. 242 234 243 235 Also note that the values you specify here can be changed later by directly editing the [TracIni conf/trac.ini] configuration file. 244 236 237 When selecting the location of your environment, make sure that the filesystem on which the environment directory resides supports sub-second timestamps (i.e. **not** `ext2` or `ext3` on Linux), as the modification time of the `conf/trac.ini` file will be monitored to decide whether an environment restart is needed or not. A too coarse-grained timestamp resolution may result in inconsistencies in Trac < 1.0.2 (though the best advice is to opt for a platform with sub-second timestamp resolution when possible regardless of the version of Trac you are running). 238 245 239 Finally, make sure the user account under which the web front-end runs will have '''write permissions''' to the environment directory and all the files inside. This will be the case if you run `trac-admin ... initenv` as this user. If not, you should set the correct user afterwards. For example on Linux, with the web server running as user `apache` and group `apache`, enter: 246 {{{ 247 # chown -R apache.apache /path/to/myproject 248 }}} 240 {{{#!sh 241 $ chown -R apache.apache /path/to/myproject 242 }}} 243 244 The actual username and groupname of the apache server may not be exactly `apache`, and are specified in the Apache configuration file by the directives `User` and `Group` (if Apache `httpd` is what you use). 249 245 250 246 {{{#!div class=important … … 255 251 == Deploying Trac 256 252 257 === Running the Standalone Server ===253 === Running the Standalone Server 258 254 259 255 After having created a Trac environment, you can easily try the web interface by running the standalone server [wiki:TracStandalone tracd]: 260 {{{ 256 {{{#!sh 261 257 $ tracd --port 8000 /path/to/myproject 262 258 }}} 263 259 264 260 Then, fire up a browser and visit `http://localhost:8000/`. You should get a simple listing of all environments that `tracd` knows about. Follow the link to the environment you just created, and you should see Trac in action. If you only plan on managing a single project with Trac you can have the standalone server skip the environment list by starting it like this: 265 {{{ 261 {{{#!sh 266 262 $ tracd -s --port 8000 /path/to/myproject 267 263 }}} 268 264 269 === Running Trac on a Web Server === 265 {{{#!div style="border: 1pt dotted; margin: 1em" 266 **Setuptools Warning:** If the version of your setuptools is in the range 5.4 through 5.6, the environment variable `PKG_RESOURCES_CACHE_ZIP_MANIFESTS` must be set in order to avoid significant performance degradation. The environment variable can be set system-wide, or for just the user that runs the `tracd` process. There are several ways to accomplish this in addition to what is discussed here, and depending on the distribution of your OS. 267 268 To be effective system-wide a shell script with the `export` statement may be added to `/etc/profile.d`. To be effective for a user session the `export` statement may be added to `~/.profile`. 269 {{{#!sh 270 export PKG_RESOURCES_CACHE_ZIP_MANIFESTS=1 271 }}} 272 273 Alternatively, the variable can be set in the shell before executing `tracd`: 274 {{{#!sh 275 $ PKG_RESOURCES_CACHE_ZIP_MANIFESTS=1 tracd --port 8000 /path/to/myproject 276 }}} 277 }}} 278 279 === Running Trac on a Web Server 270 280 271 281 Trac provides various options for connecting to a "real" web server: … … 277 287 Trac also supports [trac:TracOnWindowsIisAjp AJP] which may be your choice if you want to connect to IIS. Other deployment scenarios are possible: [trac:TracNginxRecipe nginx], [http://projects.unbit.it/uwsgi/wiki/Example#Traconapacheinasub-uri uwsgi], [trac:TracOnWindowsIisIsapi Isapi-wsgi] etc. 278 288 279 ==== Generating the Trac cgi-bin directory ====#cgi-bin289 ==== Generating the Trac cgi-bin directory #cgi-bin 280 290 281 291 In order for Trac to function properly with FastCGI you need to have a `trac.fcgi` file and for mod_wsgi a `trac.wsgi` file. These are Python scripts which load the appropriate Python code. They can be generated using the `deploy` option of [wiki:TracAdmin trac-admin]. 282 292 283 293 There is, however, a bit of a chicken-and-egg problem. The [wiki:TracAdmin trac-admin] command requires an existing environment to function, but complains if the deploy directory already exists. This is a problem, because environments are often stored in a subdirectory of the deploy. The solution is to do something like this: 284 {{{ 294 {{{#!sh 285 295 mkdir -p /usr/share/trac/projects/my-project 286 296 trac-admin /usr/share/trac/projects/my-project initenv … … 288 298 mv /tmp/deploy/* /usr/share/trac 289 299 }}} 290 291 292 ==== Mapping Static Resources ==== 300 Don't forget to check that the web server has the execution right on scripts in the `/usr/share/trac/cgi-bin` directory. 301 302 303 ==== Mapping Static Resources 293 304 294 305 Out of the box, Trac will pass static resources such as style sheets or images through itself. For anything but a tracd only based deployment, this is far from optimal as the web server could be set up to directly serve those static resources (for CGI setup, this is '''highly undesirable''' and will cause abysmal performance). … … 306 317 - `<plugins>/` - one directory for each resource directory managed by the plugins enabled for this environment 307 318 308 ===== Example: Apache and `ScriptAlias` =====#ScriptAlias-example319 ===== Example: Apache and `ScriptAlias` #ScriptAlias-example 309 320 310 321 Assuming the deployment has been done this way: 311 {{{ 322 {{{#!sh 312 323 $ trac-admin /var/trac/env deploy /path/to/trac/htdocs/common 313 324 }}} 314 325 315 326 Add the following snippet to Apache configuration ''before'' the `ScriptAlias` or `WSGIScriptAlias` (which map all the other requests to the Trac application), changing paths to match your deployment: 316 {{{ 327 {{{#!apache 317 328 Alias /trac/chrome/common /path/to/trac/htdocs/common 318 329 Alias /trac/chrome/site /path/to/trac/htdocs/site … … 325 336 326 337 If using mod_python, you might want to add this too (otherwise, the alias will be ignored): 327 {{{ 338 {{{#!apache 328 339 <Location "/trac/chrome/common/"> 329 340 SetHandler None … … 334 345 335 346 Similarly, if you have static resources in a project's `htdocs` directory (which is referenced by `/trac/chrome/site` URL in themes), you can configure Apache to serve those resources (again, put this ''before'' the `ScriptAlias` or `WSGIScriptAlias` for the .*cgi scripts, and adjust names and locations to match your installation): 336 {{{ 347 {{{#!apache 337 348 Alias /trac/chrome/site /path/to/projectenv/htdocs 338 349 … … 344 355 345 356 Alternatively to aliasing `/trac/chrome/common`, you can tell Trac to generate direct links for those static resources (and only those), using the [[wiki:TracIni#trac-section| [trac] htdocs_location]] configuration setting: 346 {{{ 357 {{{#!ini 347 358 [trac] 348 359 htdocs_location = http://static.example.org/trac-common/ … … 351 362 352 363 Of course, you still need to make the Trac `htdocs/common` directory available through the web server at the specified URL, for example by copying (or linking) the directory into the document root of the web server: 353 {{{ 364 {{{#!sh 354 365 $ ln -s /path/to/trac/htdocs/common /var/www/static.example.org/trac-common 355 366 }}} 356 367 357 368 358 ==== Setting up the Plugin Cache ====359 360 Some Python plugins need to be extracted to a cache directory. By default the cache resides in the home directory of the current user. When running Trac on a Web Server as a dedicated user (which is highly recommended) who has no home directory, this might prevent the plugins from starting. To override the cache location you can set the PYTHON_EGG_CACHEenvironment variable. Refer to your server documentation for detailed instructions on how to set environment variables.361 362 == Configuring Authentication ==363 364 Trac uses HTTP authentication. You'll need to configure your webserver to request authentication when the `.../login` URL is hit (the virtual path of the "login" button). Trac will automatically pick the REMOTE_USERvariable up after you provide your credentials. Therefore, all user management goes through your web server configuration. Please consult the documentation of your web server for more info.369 ==== Setting up the Plugin Cache 370 371 Some Python plugins need to be extracted to a cache directory. By default the cache resides in the home directory of the current user. When running Trac on a Web Server as a dedicated user (which is highly recommended) who has no home directory, this might prevent the plugins from starting. To override the cache location you can set the `PYTHON_EGG_CACHE` environment variable. Refer to your server documentation for detailed instructions on how to set environment variables. 372 373 == Configuring Authentication 374 375 Trac uses HTTP authentication. You'll need to configure your webserver to request authentication when the `.../login` URL is hit (the virtual path of the "login" button). Trac will automatically pick the `REMOTE_USER` variable up after you provide your credentials. Therefore, all user management goes through your web server configuration. Please consult the documentation of your web server for more info. 365 376 366 377 The process of adding, removing, and configuring user accounts for authentication depends on the specific way you run Trac. … … 371 382 * TracFastCgi if you're using another web server with FCGI support (Cherokee, Lighttpd, !LiteSpeed, nginx) 372 383 384 The following document also constains some useful information for beginners: [trac:TracAuthenticationIntroduction]. 385 373 386 == Granting admin rights to the admin user 374 387 Grant admin rights to user admin: 375 {{{ 388 {{{#!sh 376 389 $ trac-admin /path/to/myproject permission add admin TRAC_ADMIN 377 390 }}} 378 This user will have an "Admin" entry menu that will allow you to admin your trac project.391 This user will have an "Admin" entry menu that will allow you to administrate your Trac project. 379 392 380 393 == Finishing the install 381 394 382 === Automatic reference to the SVN changesets in Trac tickets === 395 === Enable version control components 396 397 Support for version control systems is provided by optional components in Trac and the components are disabled by default //(since 1.0)//. Subversion and Git must be explicitly enabled if you wish to use them. See TracRepositoryAdmin for more details. 398 399 The components can be enabled by adding the following to the `[components]` section of your [TracIni#components-section trac.ini], or enabling the components in the "Plugins" admin panel. 400 401 {{{#!ini 402 tracopt.versioncontrol.svn.* = enabled 403 }}} 404 405 {{{#!ini 406 tracopt.versioncontrol.git.* = enabled 407 }}} 408 409 After enabling the components, repositories can be configured through the "Repositories" admin panel or by editing [TracIni#repositories-section trac.ini]. 410 411 === Automatic reference to the SVN changesets in Trac tickets 383 412 384 413 You can configure SVN to automatically add a reference to the changeset into the ticket comments, whenever changes are committed to the repository. The description of the commit needs to contain one of the following formulas: … … 387 416 388 417 This functionality requires a post-commit hook to be installed as described in [wiki:TracRepositoryAdmin#ExplicitSync TracRepositoryAdmin], and enabling the optional commit updater components by adding the following line to the `[components]` section of your [wiki:TracIni#components-section trac.ini], or enabling the components in the "Plugins" admin panel. 389 {{{ 418 {{{#!ini 390 419 tracopt.ticket.commit_updater.* = enabled 391 420 }}} 392 421 For more information, see the documentation of the `CommitTicketUpdater` component in the "Plugins" admin panel. 393 422 394 === Using Trac ===423 === Using Trac 395 424 396 425 Once you have your Trac site up and running, you should be able to create tickets, view the timeline, browse your version control repository if configured, etc.