| 4 | | Trac is a lightweight project management tool that is implemented as a web-based application. Trac is written in the Python programming language and needs a database (either [http://sqlite.org/ SQLite], [http://www.postgresql.org/ PostgreSQL], or [http://mysql.com/ MySQL] works). For HTML rendering, Trac uses the [http://www.clearsilver.net/ ClearSilver] templating system. |
| 5 | | |
| 6 | | What follows are generic instructions for installing and setting up Trac and its requirements. While you can find instructions for installing Trac on specific systems at [http://projects.edgewall.com/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. |
| | 4 | |
| | 5 | Trac is written in the Python programming language and needs a database, [http://sqlite.org/ SQLite], [http://postgresql.org/ PostgreSQL], [http://mysql.com/ MySQL]. For HTML rendering, Trac uses the [http://genshi.edgewall.org Genshi] templating system. |
| | 6 | |
| | 7 | What follows are generic instructions for installing and setting up Trac and its requirements. While you can 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. |
| | 8 | |
| | 9 | See TracUpgrade for instructions on how to upgrade an existing installation. |
| | 10 | |
| | 11 | |
| | 12 | == Quick Install a Released Version == |
| | 13 | For a quick install, first make sure you have [http://python.org/download Python] (2.3-2.6) and [http://peak.telecommunity.com/DevCenter/EasyInstall#installing-easy-install easy_install]. |
| | 14 | |
| | 15 | Then enter (''omitting 'sudo' if not applicable'') |
| | 16 | {{{ |
| | 17 | sudo easy_install Trac |
| | 18 | }}} |
| | 19 | to install Trac, SQLite, and Genshi. |
| | 20 | |
| 14 | | * If you want to use Trac with Subversion on Windows, note that there are no precompiled Subversion bindings for Python 2.4, so you probably need Python 2.3. |
| 15 | | * 2006-09-20: This seems to be no longer true, see http://subversion.tigris.org/servlets/ProjectDocumentList?folderID=91. For subversion 1.4.0 python 2.4 binary bindings are available. |
| 16 | | * [http://www.clearsilver.net/ ClearSilver], version >= 0.9.3 |
| 17 | | * With python-bindings (`./configure --with-python=/usr/bin/python`) |
| | 30 | * See instructions in [trac:wiki:TracOnWindows/Python2.5 TracOnWindows/Python2.5] |
| | 31 | * [wiki:setuptools], version >= 0.6 |
| | 32 | * [http://genshi.edgewall.org/wiki/Download Genshi], version >= 0.5 (was version >= 0.4.1 on previous 0.11 release candidates) |
| 19 | | The database can be either SQLite, PostgreSQL or MySQL ''(experimental)''. |
| 20 | | |
| 21 | | === For SQLite === |
| 22 | | |
| 23 | | * [http://www.sqlite.org/ SQLite], version 2.8.x or 3.x (preferred) |
| 24 | | * [http://pysqlite.org/ PySQLite], version 1.x (for SQLite 2.x) or version 2.x (for SQLite 3.x). For details see [http://trac.edgewall.org/wiki/PySqlite PySqlite] |
| 25 | | |
| 26 | | ''Note: Versions of Trac prior to 0.9 do '''not''' work with PySQLite 2.x.'' |
| 27 | | |
| 28 | | ''Note: It appears that PySQLite 2.x is required for Trac 0.9+/SQLite 3.x if you plan to use the 'trac-post-commit-hook.py' script available from the 'contrib' section of the source repository.'' |
| 29 | | |
| 30 | | ''Note: Users of Mac OS X please take care; the Apple-supplied SQLite contains additional code to support file locking on network filesystems like AFP or SMB. This is not presently (3.3.6) in the mainline sources, so if you build your own SQLite from source it will not function correctly on such filesystems - typically it gives the error "{{{database is locked}}}". [http://www.alastairs-place.net/2006/07/sqlite_and_mac/ A patch] is available for version 3.3.6, based on Apple's code, otherwise you're probably best off using the Apple supplied version (presently 3.1.3).'' |
| 31 | | |
| 32 | | === For PostgreSQL === |
| | 34 | The database can be either SQLite, PostgreSQL or MySQL. |
| | 35 | * Optional if some plugins require it: [http://www.clearsilver.net/ ClearSilver] |
| | 36 | |
| | 37 | ==== For SQLite ==== |
| | 38 | |
| | 39 | If you're using Python 2.5 or 2.6, you already have everything you need. |
| | 40 | |
| | 41 | If you're using Python 2.3 or 2.4 and need pysqlite, you can download from |
| | 42 | [http://code.google.com/p/pysqlite/downloads/list google code] the Windows |
| | 43 | installers or the tar.gz archive for building from source: |
| | 44 | {{{ |
| | 45 | $ tar xvfz <version>.tar.gz |
| | 46 | $ cd <version> |
| | 47 | $ python setup.py build_static install |
| | 48 | }}} |
| | 49 | |
| | 50 | That way, the latest SQLite version will be downloaded and built into the |
| | 51 | bindings. |
| | 52 | |
| | 53 | If you're still using SQLite 2.x, you'll need pysqlite 1.0.x, although this |
| | 54 | package is not easy to find anymore. For SQLite 3.x, try not to use |
| | 55 | pysqlite 1.1.x, which has been deprecated in favor of pysqlite 2.x. |
| | 56 | |
| | 57 | See additional information in [trac:PySqlite PySqlite]. |
| | 58 | |
| | 59 | ==== For PostgreSQL ==== |
| 35 | | * [http://initd.org/projects/psycopg2 psycopg2] or [http://pypgsql.sourceforge.net/ pyPgSQL] |
| 36 | | |
| 37 | | ''Note: PostgreSQL support requires Trac version 0.9 or later.'' |
| 38 | | |
| 39 | | === For MySQL === |
| 40 | | |
| 41 | | '''Warning''': MySQL support is currently experimental. That means it works for some people, but has not been tested extensively yet. |
| 42 | | |
| 43 | | * [http://mysql.com/ MySQL], version 4.1 or later |
| | 62 | * [http://initd.org/projects/psycopg2 psycopg2] |
| | 63 | * See [trac:wiki:DatabaseBackend#Postgresql DatabaseBackend] |
| | 64 | |
| | 65 | '''Warning''': PostgreSQL 8.3 uses a strict type checking mechanism. To use Trac with the 8.3 Version of PostgreSQL, you will need [http://trac.edgewall.org/changeset/6512 trac-0.11] or later. |
| | 66 | |
| | 67 | ==== For MySQL ==== |
| | 68 | |
| | 69 | * [http://mysql.com/ MySQL], version 4.1 or later ([http://askmonty.org/wiki/index.php/MariaDB MariaDB] might work as well) |
| 51 | | * [http://subversion.tigris.org/ Subversion], version >= 1.0. (either 1.2.3 or >= 1.3.1 recommended) and corresponding [http://svnbook.red-bean.com/svnbook-1.1/ch08s02.html#svn-ch-8-sect-2.3 Python bindings]. For troubleshooting, check [http://projects.edgewall.com/trac/wiki/TracSubversion TracSubversion] |
| 52 | | * Trac uses the [http://www.swig.org/ SWIG] bindings included in the Subversion distribution, '''not''' [http://pysvn.tigris.org/ PySVN] (which is sometimes confused with the standard SWIG bindings). |
| 53 | | * If Subversion was already installed without the SWIG bindings, you'll need to re-`configure` Subversion and `make swig-py`, `make install-swig-py`. |
| 54 | | * Support for other version control systems is provided via third-parties. See [http://projects.edgewall.com/trac/wiki/PluginList PluginList] and [http://projects.edgewall.com/trac/wiki/VersioningSystemBackend VersioningSystemBackend]. |
| | 78 | |
| | 79 | '''Please note:''' if using Subversion, Trac must be installed on the '''same machine'''. Remote repositories are currently not supported (although Windows UNC paths such as {{{\\machine_name\path\to\svn}}} do work). |
| | 80 | |
| | 81 | * [http://subversion.tigris.org/ Subversion], version >= 1.0. (versions recommended: 1.2.4, 1.3.2 or 1.4.2) and the '''''corresponding''''' Python bindings. For troubleshooting, check [trac:TracSubversion TracSubversion] |
| | 82 | * Trac uses the [http://svnbook.red-bean.com/svnbook-1.1/ch08s02.html#svn-ch-8-sect-2.3 SWIG] bindings included in the Subversion distribution, '''not''' [http://pysvn.tigris.org/ PySVN] (which is sometimes confused with the standard SWIG bindings). |
| | 83 | * If Subversion was already installed without the SWIG bindings, on Unix you'll need to re-`configure` Subversion and `make swig-py`, `make install-swig-py`. |
| | 84 | * There are [http://subversion.tigris.org/servlets/ProjectDocumentList?folderID=91 pre-compiled bindings] available for win32. |
| | 85 | * Support for other version control systems is provided via third-parties. See [trac:PluginList PluginList] and [trac:VersioningSystemBackend VersioningSystemBackend]. |
| 67 | | * [http://silvercity.sourceforge.net/ SilverCity] and/or [http://www.gnu.org/software/enscript/enscript.html Enscript] for [wiki:TracSyntaxColoring syntax highlighting]. |
| 68 | | * Note that !SilverCity 0.9.6 has a [http://sourceforge.net/tracker/index.php?func=detail&aid=1424436&group_id=45693&atid=443739 bug] that breaks Python syntax highlighting in Trac. Until an update is made available, we recommend using version 0.9.5. |
| 69 | | |
| 70 | | '''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 [http://projects.edgewall.com/trac/wiki/MailingList MailingList] or [http://projects.edgewall.com/trac/wiki/IrcChannel IrcChannel]. |
| 71 | | |
| 72 | | Please refer to the documentation of these packages to find out how they are best installed. In addition, most of the [http://projects.edgewall.com/trac/wiki/TracInstallPlatforms platform-specific instructions] also describe the installation of the dependencies. Keep in mind however that the information there might concern older versions of Trac than the one you're installing (in particular, |
| 73 | | there are still some pages that are about Trac 0.8). |
| | 100 | * [http://pygments.pocoo.org Pygments] for '''syntax highlighting''', although [http://silvercity.sourceforge.net/ SilverCity] >= 0.9.7 and/or [http://gnu.org/software/enscript/enscript.html GNU Enscript] are also possible. Refer to TracSyntaxColoring for details. |
| | 101 | * [http://pytz.sf.net pytz] to get a complete list of time zones, otherwise Trac will fall back on a shorter list from an internal time zone implementation. |
| | 102 | |
| | 103 | '''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 MailingList] or [trac:IrcChannel IrcChannel]. |
| | 104 | |
| | 105 | 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!). |
| 132 | | 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. |
| | 179 | 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. |
| | 180 | |
| | 181 | If you're not afraid of running newer code, you can also try running Trac on [wiki:TracModWSGI mod_wsgi]. This should deliver even better performance than mod_python, but the module isn't as extensively tested as mod_python. |
| | 182 | |
| | 183 | Trac also supports [trac:TracOnWindowsIisAjp AJP] which may be your choice if you want to connect to IIS. |
| | 184 | |
| | 185 | ==== Generating the Trac cgi-bin directory ==== |
| | 186 | |
| | 187 | 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]. |
| | 188 | |
| | 189 | 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: |
| | 190 | {{{ |
| | 191 | mkdir -p /usr/share/trac/projects/my-project |
| | 192 | trac-admin /usr/share/trac/projects/my-project initenv |
| | 193 | trac-admin /usr/share/trac/projects/my-project deploy /tmp/deploy |
| | 194 | mv /tmp/deploy/* /usr/share/trac |
| | 195 | }}} |
| | 196 | |
| | 197 | ==== Setting up the Plugin Cache ==== |
| | 198 | |
| | 199 | 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. |
| | 209 | == Automatic reference to the SVN changesets in Trac tickets == |
| | 210 | |
| | 211 | You can configure SVN to automatically add a reference to the changeset into the ticket comments, whenever files are committed to the repository. The description of the commit needs to contain one of the following formulas: |
| | 212 | * '''Refs #123''' - to reference this changeset in #123 ticket |
| | 213 | * '''Fixes #123''' - to reference this changeset and close #123 ticket with the default status ''fixed'' |
| | 214 | |
| | 215 | All you have to do is to edit the ''post-commit'' hook in your SVN repository and make it execute ''trac-post-commit-hook'' coming with Trac. |
| | 216 | |
| | 217 | If you are editing the ''post-commit'' hook for the first time you need to navigate to your SVN repository's hooks subfolder and rename existing there ''post-commit'' template: |
| | 218 | |
| | 219 | {{{ |
| | 220 | $ cd /path/to/svn/repository/hooks |
| | 221 | $ mv post-commit.tmpl post-commit |
| | 222 | $ chmod 755 post-commit |
| | 223 | }}} |
| | 224 | |
| | 225 | Next open it in any text editor and add a line with path to the Trac environment connected with this SVN repository and another line executing the ''trac-post-commit-hook'' script: |
| | 226 | |
| | 227 | {{{ |
| | 228 | REPOS="$1" |
| | 229 | REV="$2" |
| | 230 | TRAC_ENV="/path/to/your/trac/project" |
| | 231 | |
| | 232 | /usr/bin/python /usr/local/bin/trac-post-commit-hook -p "$TRAC_ENV" -r "$REV" |
| | 233 | }}} |
| | 234 | |
| | 235 | Make sure that ''trac-post-commit-hook'' exists in above path with execution permissions for the same user which SVN is running from. This script can be found in contrib subfolder of your Trac distribution and the latest version can be always downloaded from [source:trunk/contrib/trac-post-commit-hook]. |
| | 236 | |
| | 237 | |
| | 238 | == Platform-specifics installations == |
| | 239 | |
| | 240 | * See [trac:TracInstallPlatforms TracInstallPlatforms] |
| | 241 | |
| | 242 | |
