| 6 | | Since version 0.12, Trac can also be localized, and there is probably a translation available in your language. If you want 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. |
| 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. While you may find instructions for installing Trac on specific systems at [trac:TracInstallPlatforms TracInstallPlatforms] on the main Trac site, please '''first read through these general instructions''' to get a good understanding of the tasks involved. |
| | 6 | Trac can also be localized, and there is probably a translation available in your language. If you want 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. |
| | 7 | |
| | 8 | If you're interested in contributing new translations for other languages or enhancing 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. While you may find instructions for installing Trac on specific systems at [trac:TracInstallPlatforms TracInstallPlatforms], please '''first read through these general instructions''' to get a good understanding of the tasks involved. |
| 27 | | 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. |
| 28 | | |
| 29 | | However, if you like, you can download the latest and greatest version of [[trac:PySqlite]] from |
| 30 | | [http://code.google.com/p/pysqlite/downloads/list google code], where you'll find the Windows |
| 31 | | installers or the `tar.gz` archive for building from source: |
| 32 | | {{{#!sh |
| 33 | | $ tar xvfz <version>.tar.gz |
| 34 | | $ cd <version> |
| 35 | | $ python setup.py build_static install |
| 36 | | }}} |
| 37 | | |
| 38 | | This will download the latest SQLite code and build the bindings. SQLite 2.x is no longer supported. |
| 39 | | |
| 40 | | A known bug in [trac:PySqlite] versions 2.5.2-4 prohibits upgrades of Trac databases from 0.11.x to 0.12. Please use versions 2.5.5 and newer or 2.5.1 and older. See [trac:#9434] for more detail. See additional information in [trac:PySqlite PySqlite]. |
| | 27 | As you must be using Python 2.6 or 2.7, you already have the SQLite database bindings bundled with the standard distribution of Python (the `sqlite3` module). |
| | 28 | |
| | 29 | Optionally, you may install a newer version of [http://pypi.python.org/pypi/pysqlite pysqlite] than the one provided by the Python distribution. See [trac:PySqlite#ThePysqlite2bindings PySqlite] for details. |
| 68 | | Note that Trac '''doesn't''' use [http://pysvn.tigris.org/ PySVN], neither does it work yet with the newer `ctype`-style bindings. |
| 69 | | |
| 70 | | '''Please note:''' if using Subversion, Trac must be installed on the '''same machine'''. Remote repositories are currently [trac:ticket:493 not supported]. |
| 71 | | |
| 72 | | ===== Others |
| 73 | | |
| 74 | | Support for other version control systems is provided via third-parties. See [trac:PluginList] and [trac:VersionControlSystem]. |
| | 56 | For troubleshooting information, see the [trac:TracSubversion#Troubleshooting TracSubversion] page. |
| | 57 | |
| | 58 | {{{#!div style="border: 1pt dotted; margin: 1em" |
| | 59 | **Note:** |
| | 60 | * Trac '''doesn't''' use [http://pysvn.tigris.org/ PySVN], nor does it work yet with the newer `ctype`-style bindings. |
| | 61 | * If using Subversion, Trac must be installed on the '''same machine'''. Remote repositories are currently [trac:ticket:493 not supported]. |
| | 62 | }}} |
| | 63 | |
| | 64 | ==== Git |
| | 65 | |
| | 66 | [http://git-scm.com/ Git] 1.5.6 or later is supported. More information is available on the [trac:TracGit] page. |
| | 67 | |
| | 68 | ==== Other Version Control Systems |
| | 69 | |
| | 70 | Support for other version control systems is provided via third-party plugins. See [trac:PluginList#VersionControlSystems] and [trac:VersionControlSystem]. |
| 81 | | - [http://code.google.com/p/modwsgi/ mod_wsgi], see [wiki:TracModWSGI] and |
| 82 | | http://code.google.com/p/modwsgi/wiki/IntegrationWithTrac |
| 83 | | - [http://modpython.org/ mod_python >= 3.3.1], (deprecated: see TracModPython) |
| | 77 | - [https://github.com/GrahamDumpleton/mod_wsgi mod_wsgi], see [wiki:TracModWSGI] and |
| | 78 | [http://code.google.com/p/modwsgi/wiki/IntegrationWithTrac ModWSGI IntegrationWithTrac]. |
| | 79 | - [http://modpython.org/ mod_python 3.5.0], see TracModPython |
| 106 | | '''Attention''': The available versions of these dependencies are not necessarily interchangeable, so please pay attention to the version numbers. 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]. |
| 107 | | |
| 108 | | 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! |
| | 100 | {{{#!div style="border: 1pt dotted; margin: 1em" |
| | 101 | **Attention**: The available versions of these dependencies are not necessarily interchangeable, so please pay attention to the version numbers. 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]. |
| | 102 | }}} |
| | 103 | |
| | 104 | 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''. |
| 190 | | easy_install --prefix=/usr/local --install-dir=/Library/Python/2.5/site-packages |
| 191 | | }}} |
| 192 | | 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. |
| 193 | | |
| 194 | | 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. |
| | 199 | easy_install --prefix=/usr/local --install-dir=/Library/Python/2.6/site-packages |
| | 200 | }}} |
| | 201 | |
| | 202 | {{{#!div style="border: 1pt dotted; margin: 1em" |
| | 203 | **Mac OS X Note:** On Mac OS X 10.6, running `easy_install trac` will install into `/usr/local` and `/Library/Python/2.6/site-packages` by default. |
| | 204 | |
| | 205 | The `tracd` and `trac-admin` commands will be placed in `/usr/local/bin` and will install the Trac libraries and dependencies into `/Library/Python/2.6/site-packages`, which is Apple's preferred location for third-party Python application installations. |
| | 206 | }}} |
| 198 | | A [TracEnvironment Trac environment] is the backend 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 other files and directories. |
| 199 | | |
| 200 | | A new environment is created using [wiki:TracAdmin trac-admin]: |
| | 210 | A [TracEnvironment Trac environment] is the backend where Trac stores information like wiki pages, tickets, reports, settings, etc. An environment is a directory that contains a human-readable [TracIni configuration file], and other files and directories. |
| | 211 | |
| | 212 | A new environment is created using [TracAdmin trac-admin]: |
| 205 | | [TracAdmin trac-admin] will prompt you for the information it needs to create the environment, such as the name of the project and the [TracEnvironment#DatabaseConnectionStrings database connection string]. If you're not sure what to specify for one of these options, just press `<Enter>` to use the default value. |
| 206 | | |
| 207 | | Using the default database connection string in particular will always work as long as you have SQLite installed. |
| 208 | | For the other [trac:DatabaseBackend database backends] you should plan ahead and already have a database ready to use at this point. |
| 209 | | |
| 210 | | 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. |
| 211 | | |
| 212 | | Also note that the values you specify here can be changed later by directly editing the [TracIni conf/trac.ini] configuration file. |
| 213 | | |
| 214 | | 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. The best advice is to opt for a platform with sub-second timestamp resolution, regardless of the Trac version. |
| | 217 | [TracAdmin trac-admin] will prompt you for the information it needs to create the environment: the name of the project and the [TracEnvironment#DatabaseConnectionStrings database connection string]. If you're not sure what to specify for any of these options, just press `<Enter>` to use the default value. |
| | 218 | |
| | 219 | Using the default database connection string will always work as long as you have SQLite installed. For the other [trac:DatabaseBackend database backends] you should plan ahead and already have a database ready to use at this point. |
| | 220 | |
| | 221 | Also note that the values you specify here can be changed later using TracAdmin or directly editing the [TracIni conf/trac.ini] configuration file. |
| | 222 | |
| | 223 | {{{#!div style="border: 1pt dotted; margin: 1em" |
| | 224 | **Filesystem Warning:** 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, or HFS+ on OSX), 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. The best advice is to opt for a platform with sub-second timestamp resolution, regardless of the Trac version. |
| | 225 | }}} |
| | 240 | {{{#!div style="border: 1pt dotted; margin: 1em" |
| | 241 | **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. |
| | 242 | |
| | 243 | If running `tracd`, 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. |
| | 244 | |
| | 245 | 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`. |
| | 246 | {{{#!sh |
| | 247 | export PKG_RESOURCES_CACHE_ZIP_MANIFESTS=1 |
| | 248 | }}} |
| | 249 | |
| | 250 | Alternatively, the variable can be set in the shell before executing `tracd`: |
| | 251 | {{{#!sh |
| | 252 | $ PKG_RESOURCES_CACHE_ZIP_MANIFESTS=1 tracd --port 8000 /path/to/myproject |
| | 253 | }}} |
| | 254 | |
| | 255 | If running the Apache web server, !Ubuntu/Debian users should add the `export` statement to `/etc/apache2/envvars`. !RedHat/CentOS/Fedora should can add the `export` statement to `/etc/sysconfig/httpd`. |
| | 256 | }}} |
| | 257 | |
| 241 | | {{{#!div style="border: 1pt dotted; margin: 1em" |
| 242 | | **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. |
| 243 | | |
| 244 | | 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`. |
| 245 | | {{{#!sh |
| 246 | | export PKG_RESOURCES_CACHE_ZIP_MANIFESTS=1 |
| 247 | | }}} |
| 248 | | |
| 249 | | Alternatively, the variable can be set in the shell before executing `tracd`: |
| 250 | | {{{#!sh |
| 251 | | $ PKG_RESOURCES_CACHE_ZIP_MANIFESTS=1 tracd --port 8000 /path/to/myproject |
| 252 | | }}} |
| 253 | | }}} |
| 254 | | |
| 258 | | - [wiki:TracFastCgi FastCGI] |
| 259 | | - [wiki:TracModWSGI |
| 260 | | - //[wiki:TracModPython mod_python] (no longer recommended, as mod_python is not actively maintained anymore)// |
| 261 | | - //[wiki:TracCgi CGI] (should not be used, as the performance is far from optimal)// |
| | 273 | - [TracFastCgi FastCGI] |
| | 274 | - [wiki:TracModWSGI Apache with mod_wsgi] |
| | 275 | - [TracModPython Apache with mod_python] |
| | 276 | - //[TracCgi CGI] (should not be used, as the performance is far from optimal)// |
| 267 | | 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]. |
| 268 | | |
| 269 | | 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: |
| | 282 | 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 [TracAdmin trac-admin]. |
| | 283 | |
| | 284 | There is, however, a bit of a chicken-and-egg problem. The [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: |
| 280 | | 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). |
| 281 | | |
| 282 | | 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. |
| 283 | | |
| 284 | | 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. |
| 285 | | |
| 286 | | 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: |
| | 295 | Without additional configuration, Trac will handle requests for static resources such as stylesheets and images. For anything other than a TracStandalone deployment, this is not optimal as the web server can be set up to directly serve the static resources. For CGI setup, this is '''highly undesirable''' as it causes abysmal performance. |
| | 296 | |
| | 297 | 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 their location on the file system. We can map requests for static resources directly to directories on the file system, to avoid Trac processing the requests. |
| | 298 | |
| | 299 | There are two primary URL paths for static resources: `/chrome/common` and `/chrome/site`. Plugins can add their own resources, usually accessible at the `/chrome/<plugin>` path. |
| | 300 | |
| | 301 | A single `/chrome` alias can used if the static resources are extracted for all plugins. This means that the `deploy` command must be executed after installing or updating a plugin that provides static resources, or after modifying resources in the `$env/htdocs` directory. This is probably appropriate for most installations but may not be what you want if, for example, you wish to upload plugins through the //Plugins// administration page. |
| | 302 | |
| | 303 | The resources are extracted using the [TracAdmin trac-admin]` <environment> deploy` command: |
| 289 | | The target `<directory>` will then contain an `htdocs` directory with: |
| 290 | | - `site/` - a copy of the environment's directory `htdocs/` |
| 291 | | - `common/` - the static resources of Trac itself |
| 292 | | - `<plugins>/` - one directory for each resource directory managed by the plugins enabled for this environment |
| 293 | | |
| 294 | | ===== Example: Apache and `ScriptAlias` #ScriptAlias-example |
| 295 | | |
| 296 | | Assuming the deployment has been done this way: |
| 297 | | {{{#!sh |
| 298 | | $ trac-admin /var/trac/env deploy /path/to/shared/trac |
| 299 | | }}} |
| 300 | | |
| 301 | | 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: |
| | 306 | The target `<directory>` will contain an `htdocs` directory with: |
| | 307 | - `common/` - the static resources of Trac |
| | 308 | - `site/` - a copy of the environment's `htdocs/` directory |
| | 309 | - `shared` - the static resources shared by multiple Trac environments, with a location defined by the `[inherit]` `htdocs_dir` option |
| | 310 | - `<plugin>/` - one directory for each resource directory provided by the plugins enabled for this environment |
| | 311 | |
| | 312 | The example that follows will create a single `/chrome` alias. If that isn't the correct approach for your installation you simply need to create more specific aliases: |
| | 316 | Alias /trac/chrome/shared /path/to/trac/htdocs/shared |
| | 317 | Alias /trac/chrome/<plugin> /path/to/trac/htdocs/<plugin> |
| | 318 | }}} |
| | 319 | |
| | 320 | ===== Example: Apache and `ScriptAlias` #ScriptAlias-example |
| | 321 | |
| | 322 | Assuming the deployment has been done this way: |
| | 323 | {{{#!sh |
| | 324 | $ trac-admin /var/trac/env deploy /path/to/shared/trac |
| | 325 | }}} |
| | 326 | |
| | 327 | Add the following snippet to Apache configuration, changing paths to match your deployment. The snippet must be placed ''before'' the `ScriptAlias` or `WSGIScriptAlias` directive, because those directives map all requests to the Trac application: |
| | 328 | {{{#!apache |
| | 329 | Alias /trac/chrome /path/to/trac/htdocs |
| 319 | | 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. |
| 320 | | |
| 321 | | 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): |
| | 351 | Alternatively, if you wish to serve static resources directly from your project's `htdocs` directory rather than the location to which the files are extracted with the `deploy` command, 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: |
| 365 | | This user will have an "Admin" entry menu that will allow you to administrate your Trac project. |
| 366 | | |
| 367 | | == Finishing the install |
| 368 | | |
| 369 | | === Enable version control components |
| 370 | | |
| 371 | | 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. |
| 372 | | |
| 373 | | 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. |
| 374 | | |
| 375 | | {{{#!ini |
| 376 | | tracopt.versioncontrol.svn.* = enabled |
| 377 | | }}} |
| 378 | | |
| 379 | | {{{#!ini |
| 380 | | tracopt.versioncontrol.git.* = enabled |
| 381 | | }}} |
| 382 | | |
| 383 | | After enabling the components, repositories can be configured through the "Repositories" admin panel or by editing [TracIni#repositories-section trac.ini]. |
| 384 | | |
| 385 | | === Automatic reference to the SVN changesets in Trac tickets |
| 386 | | |
| 387 | | 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: |
| 388 | | * '''`Refs #123`''' - to reference this changeset in `#123` ticket |
| 389 | | * '''`Fixes #123`''' - to reference this changeset and close `#123` ticket with the default status ''fixed'' |
| 390 | | |
| 391 | | 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. |
| 392 | | {{{#!ini |
| 393 | | tracopt.ticket.commit_updater.* = enabled |
| 394 | | }}} |
| 395 | | For more information, see the documentation of the `CommitTicketUpdater` component in the "Plugins" admin panel. |
| 396 | | |
| 397 | | === Using Trac |
| | 403 | |
| | 404 | This user will have an //Admin// navigation item that directs to pages for administering your Trac project. |
| | 405 | |
| | 406 | == Configuring Trac |
| | 407 | |
| | 408 | TracRepositoryAdmin provides information on configuring version control repositories for your project. |
| | 409 | |
| | 410 | == Using Trac |
