| 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. |
| | 7 | 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. |
| | 8 | |
| | 9 | 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]. |
| | 10 | |
| | 11 | 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. |
| 18 | | * [http://www.python.org/ Python], version >= 2.4 and < 3.0 |
| 19 | | //(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)// |
| 20 | | * [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) |
| 22 | | |
| 23 | | You also need a database system and the corresponding python bindings. |
| 24 | | The database can be either SQLite, PostgreSQL or MySQL. |
| | 21 | * [http://www.python.org/ Python], version >= 2.5 and < 3.0 |
| | 22 | (note that we dropped the support for Python 2.4 in this release) |
| | 23 | * [http://pypi.python.org/pypi/setuptools setuptools], version >= 0.6 |
| | 24 | * [http://genshi.edgewall.org/wiki/Download Genshi], version >= 0.6 |
| | 25 | |
| | 26 | You also need a database system and the corresponding python bindings. The database can be either SQLite, PostgreSQL or MySQL. |
| 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 | | {{{ |
| 33 | | $ tar xvfz <version>.tar.gz |
| 34 | | $ cd <version> |
| 35 | | $ python setup.py build_static install |
| 36 | | }}} |
| 37 | | |
| 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 |
| 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]. |
| | 30 | 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. |
| | 31 | |
| | 32 | 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. |
| 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). |
| | 53 | ==== Version Control System |
| | 54 | |
| | 55 | ===== Subversion |
| | 56 | * [http://subversion.apache.org/ Subversion], 1.5.x or later and the '''corresponding''' Python bindings. Older versions starting from 1.0, like 1.2.4, 1.3.2 or 1.4.2, etc. may still work. For troubleshooting information, check the [trac:TracSubversion#Troubleshooting TracSubversion] page. |
| | 57 | |
| | 58 | 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.) |
| 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 ===== |
| 90 | | |
| 91 | | Support for other version control systems is provided via third-parties. See [trac:PluginList] and [trac:VersionControlSystem]. |
| 92 | | |
| 93 | | ==== Web Server ==== |
| 94 | | A web server is optional because Trac is shipped with a server included, see the [#RunningtheStandaloneServer Running the Standalone Server ] section below. |
| 95 | | |
| 96 | | Alternatively you configure Trac to run in any of the following environments. |
| | 62 | '''Note:''' if using Subversion, Trac must be installed on the '''same machine'''. Remote repositories are currently [trac:ticket:493 not supported]. |
| | 63 | |
| | 64 | ===== Git |
| | 65 | * [http://git-scm.com/ Git] 1.5.6 or later. |
| | 66 | |
| | 67 | More information is available on the [trac:TracGit] page. |
| | 68 | |
| | 69 | ===== Others |
| | 70 | |
| | 71 | Support for other version control systems is provided via third-parties. See [trac:PluginList#VersionControlSystems] and [trac:VersionControlSystem]. |
| | 72 | |
| | 73 | ==== Web Server |
| | 74 | |
| | 75 | A web server is optional because Trac has a server included, see the [#RunningtheStandaloneServer Running the Standalone Server] section below. |
| | 76 | |
| | 77 | Alternatively you can configure Trac to run in any of the following environments: |
| 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.// |
| | 79 | - [http://code.google.com/p/modwsgi/ mod_wsgi], see [wiki:TracModWSGI] and |
| | 80 | http://code.google.com/p/modwsgi/wiki/IntegrationWithTrac |
| | 81 | - [http://modpython.org/ mod_python 3.5.0], see TracModPython |
| | 82 | * a [http://www.fastcgi.com/ FastCGI]-capable web server (see TracFastCgi) |
| | 83 | * an [http://tomcat.apache.org/connectors-doc/ajp/ajpv13a.html AJP]-capable web |
| | 84 | server (see [trac:TracOnWindowsIisAjp TracOnWindowsIisAjp]) |
| | 85 | * a FastCGI and FastCGI-to-WSGI gateway (see [trac:TracOnWindowsIisWfastcgi]) |
| | 86 | * a CGI-capable web server (see TracCgi), but //usage of Trac as a cgi script |
| | 87 | is highly discouraged//, better use one of the previous options. |
| 107 | | |
| 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. |
| | 89 | ==== Other Python Packages |
| | 90 | |
| | 91 | * [http://babel.edgewall.org Babel], version 0.9.5, 0.9.6 or >= 1.3 |
| | 92 | needed for localization support |
| 124 | | '''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]. |
| 125 | | |
| 126 | | 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 | | |
| 128 | | |
| 129 | | == Installing Trac == |
| | 104 | {{{#!div style="border: 1pt dotted; margin: 1em" |
| | 105 | **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]. |
| | 106 | }}} |
| | 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. |
| | 109 | |
| | 110 | == Installing Trac |
| | 111 | |
| | 112 | 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. |
| | 113 | |
| | 114 | It is assumed throughout this guide that you have elevated permissions as the `root` user, or by prefixing commands with `sudo`. The umask `0022` should be used for a typical installation on a Unix-based platform. |
| | 115 | |
| 131 | | 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; |
| 133 | | |
| 134 | | A few examples: |
| 135 | | |
| 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 |
| 140 | | }}} |
| 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 |
| 146 | | }}} |
| 147 | | |
| 148 | | - upgrade to the latest trunk development version (0.13dev): |
| 149 | | {{{ |
| 150 | | easy_install -U Trac==dev |
| 151 | | }}} |
| 152 | | |
| 153 | | For upgrades, reading the TracUpgrade page is mandatory, of course. |
| | 117 | |
| | 118 | Trac can be installed from [https://pypi.python.org/pypi/Trac PyPI] or the Subversion repository using [http://pypi.python.org/pypi/setuptools setuptools]. |
| | 119 | |
| | 120 | A few command-line examples: |
| | 121 | |
| | 122 | - Install the latest stable version of Trac: |
| | 123 | {{{#!sh |
| | 124 | $ easy_install Trac |
| | 125 | }}} |
| | 126 | - Install latest development version: |
| | 127 | {{{#!sh |
| | 128 | $ easy_install http://download.edgewall.org/trac/Trac-latest-dev.tar.gz |
| | 129 | }}} |
| | 130 | Note that in this case you won't have the possibility to run a localized version of Trac; |
| | 131 | either use a released version or install from source. |
| | 132 | |
| | 133 | More information can be found on the [trac:wiki:setuptools setuptools] page. |
| | 134 | |
| | 135 | {{{#!div style="border: 1pt dotted; margin: 1em" |
| | 136 | **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 [#DeployingTrac Deploying Trac]. |
| | 137 | }}} |
| | 138 | |
| | 139 | === Using `pip` |
| | 140 | |
| | 141 | 'pip' is an easy_install replacement that is very useful to quickly install Python packages. |
| | 142 | To get a Trac installation up and running in less than 5 minutes: |
| | 143 | |
| | 144 | Assuming you want to have your entire pip installation in `/opt/user/trac`: |
| | 145 | |
| | 146 | - |
| | 147 | {{{#!sh |
| | 148 | $ pip install trac psycopg2 |
| | 149 | }}} |
| | 150 | or: |
| | 151 | - |
| | 152 | {{{#!sh |
| | 153 | $ pip 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.), download the latest packages from pypi.python.org and create a self contained installation in `/opt/user/trac`. |
| | 159 | |
| | 160 | 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). |
| | 161 | |
| | 162 | Additionally, you can install several Trac plugins (listed [https://pypi.python.org/pypi?:action=browse&show=all&c=516 here]) through pip. |
| 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 | | {{{ |
| | 172 | You will need root permissions or equivalent for this step. |
| | 173 | |
| | 174 | This will byte-compile the Python source code and install it as an .egg file or folder in the `site-packages` directory |
| | 175 | of your Python installation. The .egg will also contain all other resources needed by standard Trac, such as `htdocs` and `templates`. |
| | 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 | {{{#!sh |
| 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 | 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`). |
| | 183 | |
| | 184 | === Using installer |
| | 185 | |
| | 186 | On Windows Trac can be installed using the exe installers available on the [trac:TracDownload] page. Installers are available for the 32 and 64 bit versions of Python. Make sure to use the installer that matches the architecture of your Python installation. |
| | 187 | |
| | 188 | === Using package manager |
| | 189 | |
| | 190 | Trac may be available in the package repository for your platform. Note however, that the version provided by the package manager may not be the latest release. |
| | 191 | |
| | 192 | === Advanced `easy_install` Options |
| 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 |
| | 202 | {{{#!sh |
| | 203 | $ easy_install --prefix=/path/to/installdir |
| | 204 | }}} |
| | 205 | |
| | 206 | or, if installing Trac on a Mac OS X system: |
| | 207 | {{{#!sh |
| | 208 | $ easy_install --prefix=/usr/local --install-dir=/Library/Python/2.5/site-packages |
| | 209 | }}} |
| | 210 | |
| | 211 | '''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.5/site-packages }}} by default. |
| 201 | | ==== Using `pip` |
| 202 | | '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: |
| 206 | | |
| 207 | | - |
| 208 | | {{{ |
| 209 | | pip -E /opt/user/trac install trac psycopg2 |
| 210 | | }}} |
| 211 | | or |
| 212 | | - |
| 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 == |
| 228 | | |
| 229 | | 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 | | |
| 231 | | A new environment is created using [wiki:TracAdmin trac-admin]: |
| 232 | | {{{ |
| | 215 | == Creating a Project Environment |
| | 216 | |
| | 217 | 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. |
| | 218 | |
| | 219 | A new environment is created using [TracAdmin trac-admin]: |
| | 220 | {{{#!sh |
| 257 | | === Running the Standalone Server === |
| 258 | | |
| 259 | | After having created a Trac environment, you can easily try the web interface by running the standalone server [wiki:TracStandalone tracd]: |
| 260 | | {{{ |
| | 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. |
| | 252 | |
| | 253 | 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. |
| | 254 | |
| | 255 | 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`. |
| | 256 | {{{#!sh |
| | 257 | export PKG_RESOURCES_CACHE_ZIP_MANIFESTS=1 |
| | 258 | }}} |
| | 259 | |
| | 260 | Alternatively, the variable can be set in the shell before executing `tracd`: |
| | 261 | {{{#!sh |
| | 262 | $ PKG_RESOURCES_CACHE_ZIP_MANIFESTS=1 tracd --port 8000 /path/to/myproject |
| | 263 | }}} |
| | 264 | |
| | 265 | 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`. |
| | 266 | }}} |
| | 267 | |
| | 268 | === Running the Standalone Server |
| | 269 | |
| | 270 | After having created a Trac environment, you can easily try the web interface by running the standalone server [TracStandalone tracd]: |
| | 271 | {{{#!sh |
| 279 | | ==== Generating the Trac cgi-bin directory ==== #cgi-bin |
| 280 | | |
| 281 | | 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 | | |
| 283 | | 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 | | {{{ |
| 285 | | mkdir -p /usr/share/trac/projects/my-project |
| 286 | | trac-admin /usr/share/trac/projects/my-project initenv |
| 287 | | trac-admin /usr/share/trac/projects/my-project deploy /tmp/deploy |
| 288 | | mv /tmp/deploy/* /usr/share/trac |
| 289 | | }}} |
| 290 | | |
| 291 | | |
| 292 | | ==== Mapping Static Resources ==== |
| 293 | | |
| 294 | | 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). |
| 295 | | |
| 296 | | 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. |
| 297 | | |
| 298 | | 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. |
| 299 | | |
| 300 | | 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: |
| | 290 | ==== Generating the Trac cgi-bin directory #cgi-bin |
| | 291 | |
| | 292 | 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]. |
| | 293 | |
| | 294 | 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: |
| | 295 | {{{#!sh |
| | 296 | $ mkdir -p /usr/share/trac/projects/my-project |
| | 297 | $ trac-admin /usr/share/trac/projects/my-project initenv |
| | 298 | $ trac-admin /usr/share/trac/projects/my-project deploy /tmp/deploy |
| | 299 | $ mv /tmp/deploy/* /usr/share/trac |
| | 300 | }}} |
| | 301 | |
| | 302 | Don't forget to check that the web server has the execution right on scripts in the `/usr/share/trac/cgi-bin` directory. |
| | 303 | |
| | 304 | ==== Mapping Static Resources |
| | 305 | |
| | 306 | 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. |
| | 307 | |
| | 308 | 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. |
| | 309 | |
| | 310 | 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. |
| | 311 | |
| | 312 | 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. |
| | 313 | |
| | 314 | The resources are extracted using the [TracAdmin trac-admin]` <environment> deploy` command: |
| 303 | | The target `<directory>` will then contain an `htdocs` directory with: |
| 304 | | - `site/` - a copy of the environment's directory `htdocs/` |
| 305 | | - `common/` - the static resources of Trac itself |
| 306 | | - `<plugins>/` - one directory for each resource directory managed by the plugins enabled for this environment |
| 307 | | |
| 308 | | ===== Example: Apache and `ScriptAlias` ===== #ScriptAlias-example |
| 309 | | |
| 310 | | Assuming the deployment has been done this way: |
| 311 | | {{{ |
| 312 | | $ trac-admin /var/trac/env deploy /path/to/trac/htdocs/common |
| 313 | | }}} |
| 314 | | |
| 315 | | 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 | | {{{ |
| | 317 | The target `<directory>` will contain an `htdocs` directory with: |
| | 318 | - `common/` - the static resources of Trac |
| | 319 | - `site/` - a copy of the environment's `htdocs/` directory |
| | 320 | - `shared` - the static resources shared by multiple Trac environments, with a location defined by the `[inherit]` `htdocs_dir` option |
| | 321 | - `<plugin>/` - one directory for each resource directory provided by the plugins enabled for this environment |
| | 322 | |
| | 323 | 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: |
| | 324 | {{{#!apache |
| 357 | | |
| 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_CACHE environment 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_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. |
| | 392 | ==== Setting up the Plugin Cache |
| | 393 | |
| | 394 | 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. |
| | 395 | |
| | 396 | == Configuring Authentication |
| | 397 | |
| | 398 | 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. |
| 382 | | === Automatic reference to the SVN changesets in Trac tickets === |
| 383 | | |
| 384 | | 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: |
| 385 | | * '''`Refs #123`''' - to reference this changeset in `#123` ticket |
| 386 | | * '''`Fixes #123`''' - to reference this changeset and close `#123` ticket with the default status ''fixed'' |
| 387 | | |
| 388 | | 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 | | {{{ |
| 390 | | tracopt.ticket.commit_updater.* = enabled |
| 391 | | }}} |
| 392 | | For more information, see the documentation of the `CommitTicketUpdater` component in the "Plugins" admin panel. |
| 393 | | |
| 394 | | === Using Trac === |
| | 420 | === Enable version control components |
| | 421 | |
| | 422 | 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. |
| | 423 | |
| | 424 | The version control systems are 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: |
| | 425 | |
| | 426 | {{{#!ini |
| | 427 | [components] |
| | 428 | tracopt.versioncontrol.svn.* = enabled |
| | 429 | }}} |
| | 430 | |
| | 431 | {{{#!ini |
| | 432 | [components] |
| | 433 | tracopt.versioncontrol.git.* = enabled |
| | 434 | }}} |
| | 435 | |
| | 436 | After enabling the components, repositories can be configured through the //Repositories// admin panel or by editing [TracIni#repositories-section trac.ini]. Automatic changeset references can be inserted as ticket comments by configuring [TracRepositoryAdmin#Automaticchangesetreferencesintickets CommitTicketUpdater]. |
| | 437 | |
| | 438 | === Using Trac |
