| 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 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 | | |
| 8 | | If you're interested in contributing new translations for other languages or enhance the existing translations, then please have a look at [[trac:TracL10N]]. |
| 9 | | |
| 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 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. |
| | 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. |
| | 7 | |
| | 8 | 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 | |
| | 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. |
| 41 | | SQLite 2.x is no longer supported. For SQLite 3.x, the pysqlite 1.1.x |
| 42 | | bindings are also no longer supported, use pysqlite 2.x. |
| 43 | | |
| 44 | | See additional information in [trac:PySqlite PySqlite]. |
| | 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 |
| | 49 | 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]. |
| 69 | | * [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. |
| 70 | | |
| 71 | | There are [http://subversion.apache.org/packages.html pre-compiled SWIG bindings] available for various platforms. Note that Trac '''doesn't''' use [http://pysvn.tigris.org/ PySVN], neither does it work yet with the newer `ctype`-style bindings |
| 72 | | |
| 73 | | |
| 74 | | '''Please note:''' if using Subversion, Trac must be installed on the '''same machine'''. Remote repositories are currently [trac:ticket:493 not supported]. |
| | 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 [trac: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). |
| | 83 | |
| | 84 | Note that Trac '''doesn't''' use [http://pysvn.tigris.org/ PySVN], neither does it work yet with the newer `ctype`-style bindings. |
| | 85 | |
| | 86 | '''Please note:''' if using Subversion, Trac must be installed on the '''same machine'''. Remote repositories are currently [trac:#493 not supported]. |
| 86 | | - [http://code.google.com/p/modwsgi/ mod_wsgi], see [wiki:TracModWSGI] and |
| 87 | | http://code.google.com/p/modwsgi/wiki/IntegrationWithTrac |
| 88 | | - [http://modpython.org/ mod_python 3.3.1], see TracModPython) |
| 89 | | * a [http://www.fastcgi.com/ FastCGI]-capable web server (see TracFastCgi) |
| 90 | | * an [http://tomcat.apache.org/connectors-doc/ajp/ajpv13a.html AJP]-capable web |
| 91 | | server (see [trac:TracOnWindowsIisAjp TracOnWindowsIisAjp]) |
| 92 | | * a CGI-capable web server (see TracCgi), '''but usage of Trac as a cgi script |
| 93 | | is highly discouraged''', better use one of the previous options. |
| | 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 TracFastCgi |
| | 101 | * any [http://tomcat.apache.org/connectors-doc/ajp/ajpv13a.html AJP]-capable web |
| | 102 | 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 script |
| | 105 | is highly discouraged, better use one of the previous options.// |
| 98 | | * [http://babel.edgewall.org Babel], version >= 0.9.5, |
| 99 | | needed for localization support |
| | 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. |
| 132 | | Note that in this case you won't have the possibility to run a localized version of Trac; |
| 133 | | either use a released version or install from source |
| 134 | | |
| 135 | | === Using `pip` |
| | 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 | {{{#!div style="border: 1pt dotted; margin: 1em" |
| | 156 | **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]. |
| | 157 | }}} |
| | 158 | |
| | 159 | === From source |
| | 160 | 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]]. |
| | 161 | |
| | 162 | 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]. |
| | 163 | |
| | 164 | Once you've unpacked the Trac archive or performed the checkout, move in the top-level folder and do: |
| | 165 | {{{ |
| | 166 | $ python ./setup.py install |
| | 167 | }}} |
| | 168 | |
| | 169 | You'll need root permissions or equivalent for this step. |
| | 170 | |
| | 171 | This will byte-compile the python source code and install it as an .egg file or folder in the `site-packages` directory |
| | 172 | of your Python installation. The .egg will also contain all other resources needed by standard Trac, such as htdocs and templates. |
| | 173 | |
| | 174 | 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. |
| | 175 | |
| | 176 | 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): |
| | 177 | {{{ |
| | 178 | $ python ./setup.py install |
| | 179 | }}} |
| | 180 | 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`). |
| | 181 | |
| | 182 | === Advanced Options === |
| | 183 | |
| | 184 | ==== Custom location with `easy_install` |
| | 185 | |
| | 186 | To install Trac to a custom location, or find out about other advanced installation options, run: |
| | 187 | {{{ |
| | 188 | easy_install --help |
| | 189 | }}} |
| | 190 | |
| | 191 | Also see [http://docs.python.org/inst/inst.html Installing Python Modules] for detailed information. |
| | 192 | |
| | 193 | Specifically, you might be interested in: |
| | 194 | {{{ |
| | 195 | easy_install --prefix=/path/to/installdir |
| | 196 | }}} |
| | 197 | or, if installing Trac to a Mac OS X system: |
| | 198 | {{{ |
| | 199 | easy_install --prefix=/usr/local --install-dir=/Library/Python/2.5/site-packages |
| | 200 | }}} |
| | 201 | 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 |
| | 202 | |
| | 203 | 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. |
| | 204 | |
| | 205 | ==== Using `pip` |
| 159 | | |
| 160 | | |
| 161 | | === From source |
| 162 | | Of course, using the python-typical setup at the top of the source directory also works. |
| 163 | | |
| 164 | | You can obtain the source for a .tar.gz or .zip file corresponding to a release (e.g. Trac-0.12.tar.gz), or you can get the source directly from the repository (see Trac:SubversionRepository for details). |
| 165 | | |
| 166 | | {{{ |
| 167 | | $ python ./setup.py install |
| 168 | | }}} |
| 169 | | |
| 170 | | ''You'll need root permissions or equivalent for this step.'' |
| 171 | | |
| 172 | | This will byte-compile the python source code and install it as an .egg file or folder in the `site-packages` directory |
| 173 | | of your Python installation. The .egg will also contain all other resources needed by standard Trac, such as htdocs and templates. |
| 174 | | |
| 175 | | 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. |
| 176 | | |
| 177 | | 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): |
| 178 | | {{{ |
| 179 | | $ python ./setup.py install |
| 180 | | }}} |
| 181 | | 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`). |
| 182 | | |
| 183 | | === Advanced Options === |
| 184 | | |
| 185 | | To install Trac to a custom location, or find out about other advanced installation options, run: |
| 186 | | {{{ |
| 187 | | easy_install --help |
| 188 | | }}} |
| 189 | | |
| 190 | | Also see [http://docs.python.org/inst/inst.html Installing Python Modules] for detailed information. |
| 191 | | |
| 192 | | Specifically, you might be interested in: |
| 193 | | {{{ |
| 194 | | easy_install --prefix=/path/to/installdir |
| 195 | | }}} |
| 196 | | or, if installing Trac to a Mac OS X system: |
| 197 | | {{{ |
| 198 | | easy_install --prefix=/usr/local --install-dir=/Library/Python/2.5/site-packages |
| 199 | | }}} |
| 200 | | 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 |
| 201 | | |
| 202 | | 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. |
| 240 | | == Running Trac on a Web Server == |
| 241 | | |
| 242 | | Trac provides various options for connecting to a "real" web server: [wiki:TracCgi CGI], [wiki:TracFastCgi FastCGI], [wiki:TracModWSGI mod_wsgi] and [wiki:TracModPython mod_python]. For decent performance, it is recommended that you use either FastCGI or mod_wsgi. |
| 243 | | |
| 244 | | Trac also supports [trac:TracOnWindowsIisAjp AJP] which may be your choice if you want to connect to IIS. |
| 245 | | |
| 246 | | ==== Generating the Trac cgi-bin directory ==== |
| | 273 | {{{#!div style="border: 1pt dotted; margin: 1em" |
| | 274 | **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. |
| | 275 | |
| | 276 | 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`. |
| | 277 | {{{#!sh |
| | 278 | export PKG_RESOURCES_CACHE_ZIP_MANIFESTS=1 |
| | 279 | }}} |
| | 280 | |
| | 281 | Alternatively, the variable can be set in the shell before executing `tracd`: |
| | 282 | {{{#!sh |
| | 283 | $ PKG_RESOURCES_CACHE_ZIP_MANIFESTS=1 tracd --port 8000 /path/to/myproject |
| | 284 | }}} |
| | 285 | }}} |
| | 286 | |
| | 287 | === Running Trac on a Web Server === |
| | 288 | |
| | 289 | Trac provides various options for connecting to a "real" web server: |
| | 290 | - [wiki:TracFastCgi FastCGI] |
| | 291 | - [wiki:TracModWSGI mod_wsgi] |
| | 292 | - //[wiki:TracModPython mod_python] (no longer recommended, as mod_python is not actively maintained anymore)// |
| | 293 | - //[wiki:TracCgi CGI] (should not be used, as the performance is far from optimal)// |
| | 294 | |
| | 295 | 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. |
| | 296 | |
| | 297 | ==== Generating the Trac cgi-bin directory ==== #cgi-bin |
| | 309 | |
| | 310 | ==== Mapping Static Resources ==== |
| | 311 | |
| | 312 | 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). |
| | 313 | |
| | 314 | Web servers such as [http://httpd.apache.org/ Apache] allow you to create “Aliases” to resources, giving them a virtual URL that doesn't necessarily reflect the layout of the servers file system. We also can map requests for static resources directly to the directory on the file system, avoiding processing these requests by Trac itself. |
| | 315 | |
| | 316 | There are two primary URL paths for static resources - `/chrome/common` and `/chrome/site`. Plugins can add their own resources, usually accessible by `/chrome/<plugin>` path, so its important to override only known paths and not try to make universal `/chrome` alias for everything. |
| | 317 | |
| | 318 | Note that in order to get those static resources on the filesystem, you need first to extract the relevant resources from Trac using the [TracAdmin trac-admin]` <environment> deploy` command: |
| | 319 | [[TracAdminHelp(deploy)]] |
| | 320 | |
| | 321 | The target `<directory>` will then contain an `htdocs` directory with: |
| | 322 | - `site/` - a copy of the environment's directory `htdocs/` |
| | 323 | - `common/` - the static resources of Trac itself |
| | 324 | - `<plugins>/` - one directory for each resource directory managed by the plugins enabled for this environment |
| | 325 | |
| | 326 | ===== Example: Apache and `ScriptAlias` ===== #ScriptAlias-example |
| | 327 | |
| | 328 | Assuming the deployment has been done this way: |
| | 329 | {{{ |
| | 330 | $ trac-admin /var/trac/env deploy /path/to/trac/htdocs/common |
| | 331 | }}} |
| | 332 | |
| | 333 | 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: |
| | 334 | {{{ |
| | 335 | Alias /trac/chrome/common /path/to/trac/htdocs/common |
| | 336 | Alias /trac/chrome/site /path/to/trac/htdocs/site |
| | 337 | |
| | 338 | <Directory "/path/to/www/trac/htdocs"> |
| | 339 | Order allow,deny |
| | 340 | Allow from all |
| | 341 | </Directory> |
| | 342 | }}} |
| | 343 | |
| | 344 | If using mod_python, you might want to add this too (otherwise, the alias will be ignored): |
| | 345 | {{{ |
| | 346 | <Location "/trac/chrome/common/"> |
| | 347 | SetHandler None |
| | 348 | </Location> |
| | 349 | }}} |
| | 350 | |
| | 351 | Note that we mapped `/trac` part of the URL to the `trac.*cgi` script, and the path `/trac/chrome/common` is the path you have to append to that location to intercept requests to the static resources. |
| | 352 | |
| | 353 | 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): |
| | 354 | {{{ |
| | 355 | Alias /trac/chrome/site /path/to/projectenv/htdocs |
| | 356 | |
| | 357 | <Directory "/path/to/projectenv/htdocs"> |
| | 358 | Order allow,deny |
| | 359 | Allow from all |
| | 360 | </Directory> |
| | 361 | }}} |
| | 362 | |
| | 363 | 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: |
| | 364 | {{{ |
| | 365 | [trac] |
| | 366 | htdocs_location = http://static.example.org/trac-common/ |
| | 367 | }}} |
| | 368 | Note that this makes it easy to have a dedicated domain serve those static resources (preferentially [http://code.google.com/speed/page-speed/docs/request.html#ServeFromCookielessDomain cookie-less]). |
| | 369 | |
| | 370 | 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: |
| | 371 | {{{ |
| | 372 | $ ln -s /path/to/trac/htdocs/common /var/www/static.example.org/trac-common |
| | 373 | }}} |
| | 374 | |
| | 375 | |
| 264 | | The process of adding, removing, and configuring user accounts for authentication depends on the specific way you run Trac. The basic procedure is described in the [wiki:TracCgi#AddingAuthentication "Adding Authentication"] section on the TracCgi page. To learn how to setup authentication for the frontend you're using, please refer to one of the following pages: |
| 265 | | |
| 266 | | * TracStandalone if you use the standalone server, `tracd`. |
| 267 | | * TracCgi if you use the CGI or FastCGI web front ends. |
| 268 | | * [wiki:TracModWSGI] if you use the Apache mod_wsgi web front end. |
| 269 | | * TracModPython if you use the Apache mod_python web front end. |
| 270 | | |
| 271 | | |
| 272 | | == Automatic reference to the SVN changesets in Trac tickets == |
| | 382 | 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. |
| | 383 | |
| | 384 | The process of adding, removing, and configuring user accounts for authentication depends on the specific way you run Trac. |
| | 385 | |
| | 386 | Please refer to one of the following sections: |
| | 387 | * TracStandalone#UsingAuthentication if you use the standalone server, `tracd`. |
| | 388 | * [wiki:TracModWSGI#ConfiguringAuthentication TracModWSGI#ConfiguringAuthentication] if you use the Apache web server, with any of its front end: `mod_wsgi` of course, but the same instructions applies also for `mod_python`, `mod_fcgi` or `mod_fastcgi`. |
| | 389 | * TracFastCgi if you're using another web server with FCGI support (Cherokee, Lighttpd, !LiteSpeed, nginx) |
| | 390 | |
| | 391 | == Granting admin rights to the admin user |
| | 392 | Grant admin rights to user admin: |
| | 393 | {{{ |
| | 394 | $ trac-admin /path/to/myproject permission add admin TRAC_ADMIN |
| | 395 | }}} |
| | 396 | This user will have an "Admin" entry menu that will allow you to admin your trac project. |
| | 397 | |
| | 398 | == Finishing the install |
| | 399 | |
| | 400 | === Automatic reference to the SVN changesets in Trac tickets === |
