| 9 | | If you're interested in contributing new translations for other languages or enhance the existing translations, then please have a look at ["TracL10N"]. |
| 10 | | |
| 11 | | 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. |
| 12 | | |
| 13 | | |
| 14 | | == Prerequisites == |
| 15 | | === Mandatory Prerequisites |
| | 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. |
| | 11 | |
| | 12 | [[PageOutline(2-3,Installation Steps,inline)]] |
| | 13 | |
| | 14 | == Dependencies == |
| | 15 | === Mandatory Dependencies |
| 18 | | * [http://www.python.org/ Python], version >= 2.4 (we dropped the support for Python 2.3 in this release) |
| 19 | | * [http://peak.telecommunity.com/DevCenter/setuptools setuptools], version >= 0.6 |
| 20 | | * [http://genshi.edgewall.org/wiki/Download Genshi], [genshi:source:trunk trunk], from svn, minimum required revision is [G1072], current [G1092] works fine as well. |
| | 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) |
| 27 | | If you're using Python 2.5 or 2.6, you already have everything you need. |
| 28 | | |
| 29 | | If you're using Python 2.4 and need pysqlite, you can download from |
| 30 | | [http://code.google.com/p/pysqlite/downloads/list google code] |
| 31 | | installers or the tar.gz archive for building from source: |
| | 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: |
| 38 | | That way, the latest SQLite version will be downloaded and built into the |
| 39 | | bindings. |
| 40 | | |
| 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. |
| | 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. |
| 69 | | * [http://subversion.apache.org/ Subversion], 1.5.x or 1.6.x and the '''''corresponding''''' Python bindings. Actually 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 | * [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. |
| 82 | | * A CGI-capable web server (see TracCgi), '''but usage of Trac as a cgi script |
| 83 | | is highly discouraged''', better use one of the following options, |
| 84 | | * a [http://www.fastcgi.com/ FastCGI]-capable web server (see TracFastCgi), or |
| 85 | | * an [http://tomcat.apache.org/connectors-doc/ajp/ajpv13a.html AJP]-capable web |
| 86 | | server (see [trac:TracOnWindowsIisAjp TracOnWindowsIisAjp]), or |
| | 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. |
| 90 | | - [http://modpython.org/ mod_python 3.3.1], see TracModPython) |
| | 93 | - [http://modpython.org/ mod_python 3.3.1], deprecated: see TracModPython) |
| | 94 | * a [http://www.fastcgi.com/ FastCGI]-capable web server (see TracFastCgi) |
| | 95 | * an [http://tomcat.apache.org/connectors-doc/ajp/ajpv13a.html AJP]-capable web |
| | 96 | server (see [trac:TracOnWindowsIisAjp TracOnWindowsIisAjp]) |
| | 97 | * a CGI-capable web server (see TracCgi), '''but usage of Trac as a cgi script |
| | 98 | is highly discouraged''', better use one of the previous options. |
| 114 | | |
| 115 | | One way to install Trac is using `setuptools`. |
| 116 | | With setuptools you can install Trac from the subversion repository; for example, |
| 117 | | to install release version 0.12dev do: |
| 118 | | {{{ |
| 119 | | easy_install http://svn.edgewall.org/repos/trac/trunk |
| 120 | | }}} |
| 121 | | |
| 122 | | But of course the python-typical setup at the top of the source directory also works: |
| | 122 | === Using `easy_install` |
| | 123 | One way to install Trac is using [http://pypi.python.org/pypi/setuptools setuptools]. |
| | 124 | With setuptools you can install Trac from the subversion repository; |
| | 125 | |
| | 126 | A few examples: |
| | 127 | |
| | 128 | - install Trac 1.0: |
| | 129 | {{{ |
| | 130 | easy_install Trac==1.0 |
| | 131 | }}} |
| | 132 | (NOT YET ENABLED) |
| | 133 | - install latest development version 1.0dev: |
| | 134 | {{{ |
| | 135 | easy_install Trac==dev |
| | 136 | }}} |
| | 137 | Note that in this case you won't have the possibility to run a localized version of Trac; |
| | 138 | either use a released version or install from source |
| | 139 | |
| | 140 | === Using `pip` |
| | 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 | {{{ |
| | 148 | pip -E /opt/user/trac install trac psycopg2 |
| | 149 | }}} |
| | 150 | or |
| | 151 | - |
| | 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`. |
| | 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 [http://pypi.python.org/pypi?:action=search&term=trac&submit=search here]) through pip. |
| | 163 | |
| | 164 | |
| | 165 | |
| | 166 | === From source |
| | 167 | Of course, using the python-typical setup at the top of the source directory also works. |
| | 168 | |
| | 169 | You can obtain the source for a .tar.gz or .zip file corresponding to a release (e.g. Trac-1.0.tar.gz), or you can get the source directly from the repository (see Trac:SubversionRepository for details). |
| | 170 | |
| 136 | | If you want to make Trac available in other languages, make sure you have installed Babel and then run this additional step before doing the `install` (or simply redo the `install` afterwards): |
| 137 | | {{{ |
| 138 | | $ python ./setup.py compile_catalog -f |
| 139 | | }}} |
| 140 | | (the `-f` flag is needed as long as some translations are marked ''fuzzy'', i.e. incomplete, which will most probably be the case during the whole development period, as strings are continuously added or modified) |
| 141 | | |
| | 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 | {{{ |
| | 184 | $ python ./setup.py install |
| | 185 | }}} |
| | 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`). |
| 200 | | == Running Trac on a Web Server == |
| 201 | | |
| 202 | | Trac provides three options for connecting to a "real" web server: [wiki:TracCgi CGI], [wiki:TracFastCgi FastCGI] and [wiki:TracModPython mod_python]. For decent performance, it is recommended that you use either FastCGI or mod_python. |
| 203 | | |
| 204 | | |
| 205 | | Trac also supports [trac:TracOnWindowsIisAjp AJP] which may be your choice if you want to connect to IIS. |
| 206 | | |
| 207 | | ==== Generating the Trac cgi-bin directory ==== |
| 208 | | |
| 209 | | In order for Trac to function properly with FastCGI or mod_python, you need to have a trac.cgi file. This is an executable which loads the appropriate Python code. It can be generated using the `deploy` option of [wiki:TracAdmin trac-admin]. |
| | 252 | === Running Trac on a Web Server === |
| | 253 | |
| | 254 | Trac provides various options for connecting to a "real" web server: |
| | 255 | - [wiki:TracFastCgi FastCGI] |
| | 256 | - [wiki:TracModWSGI mod_wsgi] |
| | 257 | - //[wiki:TracModPython mod_python] (no longer recommended, as mod_python is not actively maintained anymore)// |
| | 258 | - //[wiki:TracCgi CGI] (should not be used, as the performance is far from optimal)// |
| | 259 | |
| | 260 | 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. |
| | 261 | |
| | 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]. |
| | 274 | |
| | 275 | ==== Mapping Static Resources ==== |
| | 276 | |
| | 277 | 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). |
| | 278 | |
| | 279 | 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. |
| | 280 | |
| | 281 | 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. |
| | 282 | |
| | 283 | 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: |
| | 284 | [[TracAdminHelp(deploy)]] |
| | 285 | |
| | 286 | The target `<directory>` will then contain an `htdocs` directory with: |
| | 287 | - `site/` - a copy of the environment's directory `htdocs/` |
| | 288 | - `common/` - the static resources of Trac itself |
| | 289 | - `<plugins>/` - one directory for each resource directory managed by the plugins enabled for this environment |
| | 290 | |
| | 291 | ===== Example: Apache and `ScriptAlias` ===== #ScriptAlias-example |
| | 292 | |
| | 293 | Assuming the deployment has been done this way: |
| | 294 | {{{ |
| | 295 | $ trac-admin /var/trac/env deploy /path/to/trac/htdocs/common |
| | 296 | }}} |
| | 297 | |
| | 298 | 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: |
| | 299 | {{{ |
| | 300 | Alias /trac/chrome/common /path/to/trac/htdocs/common |
| | 301 | Alias /trac/chrome/site /path/to/trac/htdocs/site |
| | 302 | |
| | 303 | <Directory "/path/to/www/trac/htdocs"> |
| | 304 | Order allow,deny |
| | 305 | Allow from all |
| | 306 | </Directory> |
| | 307 | }}} |
| | 308 | |
| | 309 | If using mod_python, you might want to add this too (otherwise, the alias will be ignored): |
| | 310 | {{{ |
| | 311 | <Location "/trac/chrome/common/"> |
| | 312 | SetHandler None |
| | 313 | </Location> |
| | 314 | }}} |
| | 315 | |
| | 316 | 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. |
| | 317 | |
| | 318 | 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): |
| | 319 | {{{ |
| | 320 | Alias /trac/chrome/site /path/to/projectenv/htdocs |
| | 321 | |
| | 322 | <Directory "/path/to/projectenv/htdocs"> |
| | 323 | Order allow,deny |
| | 324 | Allow from all |
| | 325 | </Directory> |
| | 326 | }}} |
| | 327 | |
| | 328 | 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: |
| | 329 | {{{ |
| | 330 | [trac] |
| | 331 | htdocs_location = http://static.example.org/trac-common/ |
| | 332 | }}} |
| | 333 | 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]). |
| | 334 | |
| | 335 | 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: |
| | 336 | {{{ |
| | 337 | $ ln -s /path/to/trac/htdocs/common /var/www/static.example.org/trac-common |
| | 338 | }}} |
| | 339 | |
| | 340 | |
| 225 | | 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: |
| 226 | | |
| 227 | | * TracStandalone if you use the standalone server, `tracd`. |
| 228 | | * TracCgi if you use the CGI or FastCGI methods. |
| 229 | | * TracModPython if you use the mod_python method. |
| 230 | | |
| 231 | | |
| 232 | | == Using Trac == |
| 233 | | |
| 234 | | Once you have your Trac site up and running, you should be able to browse your subversion repository, create tickets, view the timeline, etc. |
| 235 | | |
| 236 | | Keep in mind that anonymous (not logged in) users can by default access most but not all of the features. You will need to configure authentication and grant additional [wiki:TracPermissions permissions] to authenticated users to see the full set of features. |
| | 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. |
| | 348 | |
| | 349 | The process of adding, removing, and configuring user accounts for authentication depends on the specific way you run Trac. |
| | 350 | |
| | 351 | Please refer to one of the following sections: |
| | 352 | * TracStandalone#UsingAuthentication if you use the standalone server, `tracd`. |
| | 353 | * [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`. |
| | 354 | * TracFastCgi if you're using another web server with FCGI support (Cherokee, Lighttpd, !LiteSpeed, nginx) |
| | 355 | |
| | 356 | == Granting admin rights to the admin user |
| | 357 | Grant admin rights to user admin: |
| | 358 | {{{ |
| | 359 | $ trac-admin /path/to/myproject permission add admin TRAC_ADMIN |
| | 360 | }}} |
| | 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 === |
| | 378 | |
| | 379 | Once you have your Trac site up and running, you should be able to create tickets, view the timeline, browse your version control repository if configured, etc. |
| | 380 | |
| | 381 | Keep in mind that //anonymous// (not logged in) users can by default access only a few of the features, in particular they will have a read-only access to the resources. You will need to configure authentication and grant additional [wiki:TracPermissions permissions] to authenticated users to see the full set of features. |
