| 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 [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. |
| | 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. |
| 18 | | * [http://www.python.org/ Python], version >= 2.5 and < 3.0 |
| 19 | | (note that we dropped the support for Python 2.4 in this release) |
| 20 | | * [http://peak.telecommunity.com/DevCenter/setuptools setuptools], version >= 0.6, or better yet, [http://pypi.python.org/pypi/distribute distribute] |
| 21 | | * [http://genshi.edgewall.org/wiki/Download Genshi], version >= 0.6 (unreleased version 0.7dev should work as well) |
| 22 | | |
| 23 | | You also need a database system and the corresponding python bindings. |
| 24 | | The database can be either SQLite, PostgreSQL or MySQL. |
| | 18 | * [http://www.python.org/ Python], version >= 2.6 and < 3.0 |
| | 19 | (note that we dropped the support for Python 2.5 in this release) |
| | 20 | * [http://pypi.python.org/pypi/setuptools setuptools], version >= 0.6 |
| | 21 | * [http://genshi.edgewall.org/wiki/Download Genshi], version >= 0.6 |
| | 22 | |
| | 23 | You also need a database system and the corresponding python bindings. The database can be either SQLite, PostgreSQL or MySQL. |
| 28 | | 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). |
| 29 | | |
| 30 | | However, if you'd like, you can download the latest and greatest version of [[trac:Pysqlite]] from |
| 31 | | [http://code.google.com/p/pysqlite/downloads/list google code], where you'll find the Windows |
| 32 | | installers or the `tar.gz` archive for building from source: |
| 33 | | {{{ |
| 34 | | $ tar xvfz <version>.tar.gz |
| 35 | | $ cd <version> |
| 36 | | $ python setup.py build_static install |
| 37 | | }}} |
| 38 | | |
| 39 | | This will download the latest SQLite code and build the bindings. |
| 40 | | |
| 41 | | SQLite 2.x is no longer supported. |
| 42 | | |
| 43 | | A known bug PySqlite versions 2.5.2-4 prohibits upgrade of trac databases |
| 44 | | from 0.11.x to 0.12. Please use versions 2.5.5 and newer or 2.5.1 and |
| 45 | | older. See #9434 for more detail. |
| 46 | | |
| 47 | | 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 [pypi:pysqlite pysqlite] than the one provided by the Python distribution. See [trac:PySqlite#ThePysqlite2bindings PySqlite] for details. |
| 69 | | ==== Version Control System ==== |
| 70 | | |
| 71 | | ===== Subversion ===== |
| 72 | | * [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. |
| 73 | | |
| 74 | | 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.) |
| 75 | | |
| 76 | | Note that Trac '''doesn't''' use [http://pysvn.tigris.org/ PySVN], neither does it work yet with the newer `ctype`-style bindings. |
| 77 | | |
| 78 | | |
| 79 | | '''Please note:''' if using Subversion, Trac must be installed on the '''same machine'''. Remote repositories are currently [trac:ticket:493 not supported]. |
| 80 | | |
| 81 | | |
| 82 | | ===== Others ===== |
| 83 | | |
| 84 | | Support for other version control systems is provided via third-parties. See [trac:PluginList] and [trac:VersionControlSystem]. |
| 85 | | |
| 86 | | ==== Web Server ==== |
| 87 | | A web server is optional because Trac is shipped with a server included, see the [#RunningtheStandaloneServer Running the Standalone Server ] section below. |
| 88 | | |
| 89 | | Alternatively you configure Trac to run in any of the following environments. |
| | 50 | ==== Subversion |
| | 51 | |
| | 52 | [http://subversion.apache.org/ Subversion], 1.6.x or later and the '''''corresponding''''' Python bindings. |
| | 53 | |
| | 54 | 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. [trac:TracSubversion] points you to [http://alagazam.net Alagazam], which works for me under Python 2.6.) |
| | 55 | |
| | 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]. |
| | 71 | |
| | 72 | ==== Web Server |
| | 73 | A web server is optional because Trac is shipped with a server included, see the [#RunningtheStandaloneServer Running the Standalone Server] section below. |
| | 74 | |
| | 75 | Alternatively you can configure Trac to run in any of the following environments: |
| 91 | | - [http://code.google.com/p/modwsgi/ mod_wsgi], see [wiki:TracModWSGI] and |
| 92 | | http://code.google.com/p/modwsgi/wiki/IntegrationWithTrac |
| 93 | | - [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 |
| 116 | | '''Attention''': The various available versions of these dependencies are not necessarily interchangable, 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]. |
| 117 | | |
| 118 | | 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!). |
| 119 | | |
| 120 | | |
| 121 | | == Installing Trac == |
| | 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''. |
| | 105 | |
| | 106 | == Installing Trac |
| | 107 | |
| | 108 | The [TracAdmin trac-admin] command-line tool, used to create and maintain [TracEnvironment project environments], as well as the [TracStandalone tracd] standalone server are installed along with Trac. There are several methods for installing Trac. |
| | 109 | |
| 152 | | {{{ |
| 153 | | pip -E /opt/user/trac install trac mysql-python |
| 154 | | }}} |
| 155 | | |
| 156 | | Make sure your OS specific headers are available for pip to automatically build PostgreSQL (libpq-dev) or MySQL (libmysqlclient-dev) bindings. |
| 157 | | |
| 158 | | 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`. |
| | 144 | {{{#!sh |
| | 145 | pip install trac mysql-python |
| | 146 | }}} |
| | 147 | |
| | 148 | Make sure your OS specific headers are available for pip to automatically build PostgreSQL (`libpq-dev`) or MySQL (`libmysqlclient-dev`) bindings. |
| | 149 | |
| | 150 | pip will automatically resolve all dependencies (like Genshi, pygments, etc.), download the latest packages from pypi.python.org and create a self contained installation in `/opt/user/trac`. |
| 175 | | ''You'll need root permissions or equivalent for this step.'' |
| 176 | | |
| 177 | | This will byte-compile the python source code and install it as an .egg file or folder in the `site-packages` directory |
| 178 | | of your Python installation. The .egg will also contain all other resources needed by standard Trac, such as htdocs and templates. |
| 179 | | |
| 180 | | 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. |
| 181 | | |
| 182 | | 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): |
| 183 | | {{{ |
| | 163 | ''You will need root permissions or equivalent for this step.'' |
| | 164 | |
| | 165 | This will byte-compile the Python source code and install it as an .egg file or folder in the `site-packages` directory |
| | 166 | of your Python installation. The .egg will also contain all other resources needed by standard Trac, such as `htdocs` and `templates`. |
| | 167 | |
| | 168 | 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): |
| | 169 | {{{#!sh |
| 186 | | 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`). |
| 187 | | |
| 188 | | === Advanced Options === |
| | 172 | 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`). |
| | 173 | |
| | 174 | === Using installer |
| | 175 | |
| | 176 | On Windows, Trac can be installed using the exe installers available on the [trac:TracDownload] page. Installers are available for the 32-bit and 64-bit versions of Python. Make sure to use the installer that matches the architecture of your Python installation. |
| | 177 | |
| | 178 | === Using package manager |
| | 179 | |
| | 180 | Trac may be available in your platform's package repository. Note however, that the version provided by your package manager may not be the latest release. |
| | 181 | |
| | 182 | === Advanced `easy_install` Options |
| 201 | | or, if installing Trac to a Mac OS X system: |
| 202 | | {{{ |
| 203 | | easy_install --prefix=/usr/local --install-dir=/Library/Python/2.5/site-packages |
| 204 | | }}} |
| 205 | | 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 |
| 206 | | |
| 207 | | 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. |
| 208 | | |
| 209 | | |
| 210 | | == Creating a Project Environment == |
| 211 | | |
| 212 | | 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. |
| 213 | | |
| 214 | | A new environment is created using [wiki:TracAdmin trac-admin]: |
| 215 | | {{{ |
| | 195 | or, if installing Trac on a Mac OS X system: |
| | 196 | {{{#!sh |
| | 197 | easy_install --prefix=/usr/local --install-dir=/Library/Python/2.6/site-packages |
| | 198 | }}} |
| | 199 | |
| | 200 | {{{#!div style="border: 1pt dotted; margin: 1em" |
| | 201 | **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. |
| | 202 | |
| | 203 | 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. |
| | 204 | }}} |
| | 205 | |
| | 206 | == Creating a Project Environment |
| | 207 | |
| | 208 | 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. |
| | 209 | |
| | 210 | A new environment is created using [TracAdmin trac-admin]: |
| | 211 | {{{#!sh |
| 219 | | [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. |
| 220 | | |
| 221 | | Using the default database connection string in particular will always work as long as you have SQLite installed. |
| 222 | | For the other [DatabaseBackend database backends] you should plan ahead and already have a database ready to use at this point. |
| 223 | | |
| 224 | | 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. |
| 225 | | |
| 226 | | Also note that the values you specify here can be changed later by directly editing the [TracIni conf/trac.ini] configuration file. |
| | 215 | [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. |
| | 216 | |
| | 217 | 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. |
| | 218 | |
| | 219 | Also note that the values you specify here can be changed later using TracAdmin or directly editing the [TracIni conf/trac.ini] configuration file. |
| | 220 | |
| | 221 | {{{#!div style="border: 1pt dotted; margin: 1em" |
| | 222 | **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. |
| | 223 | }}} |
| 252 | | === Running Trac on a Web Server === |
| | 250 | {{{#!div style="border: 1pt dotted; margin: 1em" |
| | 251 | **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. |
| | 252 | |
| | 253 | 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`. |
| | 254 | {{{#!sh |
| | 255 | export PKG_RESOURCES_CACHE_ZIP_MANIFESTS=1 |
| | 256 | }}} |
| | 257 | |
| | 258 | Alternatively, the variable can be set in the shell before executing `tracd`: |
| | 259 | {{{#!sh |
| | 260 | $ PKG_RESOURCES_CACHE_ZIP_MANIFESTS=1 tracd --port 8000 /path/to/myproject |
| | 261 | }}} |
| | 262 | }}} |
| | 263 | |
| | 264 | === Running Trac on a Web Server |
| 262 | | ==== Generating the Trac cgi-bin directory ==== #cgi-bin |
| 263 | | |
| 264 | | 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]. |
| 265 | | |
| 266 | | 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: |
| 267 | | {{{ |
| | 274 | ==== Generating the Trac cgi-bin directory #cgi-bin |
| | 275 | |
| | 276 | 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]. |
| | 277 | |
| | 278 | 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: |
| | 279 | {{{#!sh |
| 340 | | |
| 341 | | ==== Setting up the Plugin Cache ==== |
| 342 | | |
| 343 | | 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. |
| 344 | | |
| 345 | | == Configuring Authentication == |
| 346 | | |
| 347 | | 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. |
| | 352 | ==== Setting up the Plugin Cache |
| | 353 | |
| | 354 | 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. |
| | 355 | |
| | 356 | == Configuring Authentication |
| | 357 | |
| | 358 | 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. |
| 361 | | This user will have an "Admin" entry menu that will allow you to admin your trac project. |
| 362 | | |
| 363 | | == Finishing the install |
| 364 | | |
| 365 | | === Automatic reference to the SVN changesets in Trac tickets === |
| 366 | | |
| 367 | | 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: |
| 368 | | * '''`Refs #123`''' - to reference this changeset in `#123` ticket |
| 369 | | * '''`Fixes #123`''' - to reference this changeset and close `#123` ticket with the default status ''fixed'' |
| 370 | | |
| 371 | | 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. |
| 372 | | {{{ |
| 373 | | tracopt.ticket.commit_updater.* = enabled |
| 374 | | }}} |
| 375 | | For more information, see the documentation of the `CommitTicketUpdater` component in the "Plugins" admin panel. |
| 376 | | |
| 377 | | === Using Trac === |
| | 374 | |
| | 375 | This user will have an //Admin// navigation item that directs to pages for administering your Trac project. |
| | 376 | |
| | 377 | == Configuring Trac |
| | 378 | |
| | 379 | TracRepositoryAdmin provides information on configuring version control repositories for your project. |
| | 380 | |
| | 381 | == Using Trac |
