| 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 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 | | |
| 8 | | == Short - Install a released version == |
| 9 | | For the quick install, make sure you have [http://python.org Python-2.5], [http://peak.telecommunity.com/DevCenter/EasyInstall#installing-easy-install easy_install] and SQlite-3.3.4 installed (or above). |
| 10 | | {{{ |
| 11 | | sudo easy_install Trac==0.11 |
| 12 | | }}} |
| 13 | | |
| 14 | | == Requirements - also older versions possible == |
| 15 | | |
| | 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 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 |
| 23 | | * [http://genshi.edgewall.org/wiki/Download Genshi], version >= 0.4.1 |
| 24 | | * You also need a database system and the corresponding python drivers for it. |
| 25 | | The database can be either SQLite, PostgreSQL or ''MySQL (experimental)''. |
| 26 | | * optional if some plugins require it: [http://www.clearsilver.net/ ClearSilver] |
| 27 | | |
| 28 | | === For SQLite === |
| 29 | | |
| 30 | | * [http://www.sqlite.org/ SQLite], version 3.3.4 and above preferred. |
| 31 | | * If not using Python-2.5: [http://pysqlite.org/ PySQLite], version 1.x (for SQLite 2.x) or version 2.x (for SQLite 3.x), version 2.3.2 preferred. For details see PySqlite |
| 32 | | |
| 33 | | ''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.'' |
| 34 | | |
| 35 | | ''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).'' |
| 36 | | |
| 37 | | === For PostgreSQL === |
| 38 | | |
| | 21 | * [http://genshi.edgewall.org/wiki/Download Genshi], version >= 0.6 |
| | 22 | |
| | 23 | You also need a database system and the corresponding python bindings. |
| | 24 | The database can be either SQLite, PostgreSQL or MySQL. |
| | 25 | |
| | 26 | ==== For the SQLite database #ForSQLite |
| | 27 | |
| | 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]. |
| | 53 | |
| | 54 | ==== For the PostgreSQL database #ForPostgreSQL |
| | 55 | |
| | 56 | You need to install the database and its Python bindings: |
| 40 | | * [http://initd.org/projects/psycopg2 psycopg2] or [http://pypgsql.sourceforge.net/ pyPgSQL] |
| 41 | | |
| 42 | | '''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. |
| 43 | | |
| 44 | | === For MySQL === |
| 45 | | |
| 46 | | '''Warning''': MySQL support is currently ''still'' experimental. That means it works for some people, but several issues remain, in particular regarding the use of unicode and the key length in the repository cache. See MySqlDb for more detailed information. |
| 47 | | |
| 48 | | * [http://mysql.com/ MySQL], version 4.1 or later |
| 49 | | * [http://sf.net/projects/mysql-python MySQLdb], version 1.2.1 or later |
| 50 | | |
| 51 | | === Optional Requirements === |
| | 58 | * [http://pypi.python.org/pypi/psycopg2 psycopg2] |
| | 59 | |
| | 60 | See [trac:DatabaseBackend#Postgresql DatabaseBackend] for details. |
| | 61 | |
| | 62 | |
| | 63 | ==== For the MySQL database #ForMySQL |
| | 64 | |
| | 65 | Trac can now work quite well with MySQL, provided you follow the guidelines. |
| | 66 | |
| | 67 | * [http://mysql.com/ MySQL], version 5.0 or later |
| | 68 | * [http://sf.net/projects/mysql-python MySQLdb], version 1.2.2 or later |
| | 69 | |
| | 70 | It is '''very''' important to read carefully the [trac:MySqlDb] page before creating the database. |
| | 71 | |
| | 72 | === Optional Dependencies |
| 55 | | '''Please note:''' if using Subversion, Trac must be installed on the '''same machine'''. Remote repositories are currently not supported. |
| 56 | | |
| 57 | | * [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 TracSubversion |
| 58 | | * 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). |
| 59 | | * 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`. |
| 60 | | * There are [http://subversion.tigris.org/servlets/ProjectDocumentList?folderID=91 pre-compiled bindings] available for win32. |
| 61 | | * Support for other version control systems is provided via third-parties. See PluginList and VersioningSystemBackend. |
| | 76 | ===== Subversion ===== |
| | 77 | * [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. |
| | 78 | |
| | 79 | 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.) |
| | 80 | |
| | 81 | Note that Trac '''doesn't''' use [http://pysvn.tigris.org/ PySVN], neither does it work yet with the newer `ctype`-style bindings. [Is there a ticket for implementing ctype bindings?] |
| | 82 | |
| | 83 | |
| | 84 | '''Please note:''' if using Subversion, Trac must be installed on the '''same machine'''. Remote repositories are currently [trac:ticket:493 not supported]. |
| | 85 | |
| | 86 | |
| | 87 | ===== Others ===== |
| | 88 | |
| | 89 | Support for other version control systems is provided via third-parties. See [trac:PluginList] and [trac:VersioningSystemBackend]. |
| 64 | | * A CGI-capable web server (see TracCgi), or |
| 65 | | * a [http://www.fastcgi.com/ FastCGI]-capable web server (see TracFastCgi), or |
| 66 | | * [http://httpd.apache.org/ Apache] with [http://code.google.com/p/modwsgi/ mod_wsgi] (see [wiki:TracModWSGI]) |
| 67 | | * This should work with Apache 1.3, 2.0 or 2.2 and promises to deliver more performance than using mod_python. A little less mature than mod_python. |
| 68 | | * [http://httpd.apache.org/ Apache] with [http://www.modpython.org/ mod_python 3.1.3+] (see TracModPython) |
| 69 | | * When installing mod_python the development versions of Python and Apache are required (actually the libraries and header files) |
| 70 | | |
| 71 | | For those stuck with Apache 1.3, it is also possible to get Trac working with [http://www.modpython.org/ mod_python 2.7] (see [wiki:TracModPython2.7 TracModPython2.7]). This guide hasn't been updated since 0.84, so it may or may not work. |
| 72 | | |
| 73 | | ==== Other Python Utilities ==== |
| 74 | | * [http://docutils.sourceforge.net/ docutils], version >= 0.3.9 for WikiRestructuredText. |
| 75 | | * [http://pygments.pocoo.org Pygments] for [wiki:TracSyntaxColoring syntax highlighting], also [http://silvercity.sourceforge.net/ SilverCity] and/or [http://gnu.org/software/enscript/enscript.html Enscript] may still be used. |
| 76 | | * 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. |
| 77 | | * [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. |
| 78 | | |
| 79 | | '''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 MailingList or IrcChannel. |
| 80 | | |
| 81 | | Please refer to the documentation of these packages to find out how they are best installed. In addition, most of the [wiki: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!). |
| | 92 | A web server is optional because Trac is shipped with a server included, see the [#RunningtheStandaloneServer Running the Standalone Server ] section below. |
| | 93 | |
| | 94 | Alternatively you configure Trac to run in any of the following environments. |
| | 95 | * [http://httpd.apache.org/ Apache] with |
| | 96 | - [http://code.google.com/p/modwsgi/ mod_wsgi], see [wiki:TracModWSGI] and |
| | 97 | http://code.google.com/p/modwsgi/wiki/IntegrationWithTrac |
| | 98 | - [http://modpython.org/ mod_python 3.3.1], deprecated: see TracModPython) |
| | 99 | * a [http://www.fastcgi.com/ FastCGI]-capable web server (see TracFastCgi) |
| | 100 | * an [http://tomcat.apache.org/connectors-doc/ajp/ajpv13a.html AJP]-capable web |
| | 101 | server (see [trac:TracOnWindowsIisAjp]) |
| | 102 | * a CGI-capable web server (see TracCgi), '''but usage of Trac as a cgi script |
| | 103 | is highly discouraged''', better use one of the previous options. |
| | 104 | |
| | 105 | |
| | 106 | ==== Other Python Packages ==== |
| | 107 | |
| | 108 | * [http://babel.edgewall.org Babel], version >= 0.9.5, |
| | 109 | needed for localization support[[BR]] |
| | 110 | ''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. |
| | 111 | * [http://docutils.sourceforge.net/ docutils], version >= 0.3.9 |
| | 112 | for WikiRestructuredText. |
| | 113 | * [http://pygments.pocoo.org Pygments] for |
| | 114 | [wiki:TracSyntaxColoring syntax highlighting]. |
| | 115 | [http://silvercity.sourceforge.net/ SilverCity] and/or |
| | 116 | [http://gnu.org/software/enscript/enscript.html Enscript] may still be used |
| | 117 | but are deprecated and you really should be using Pygments. |
| | 118 | * [http://pytz.sf.net pytz] to get a complete list of time zones, |
| | 119 | otherwise Trac will fall back on a shorter list from |
| | 120 | an internal time zone implementation. |
| | 121 | |
| | 122 | '''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]. |
| | 123 | |
| | 124 | 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!). |
| | 125 | |
| 84 | | |
| 85 | | One way to install Trac is using `setuptools`. |
| 86 | | With setuptools you can install Trac from the subversion repository; for example, |
| 87 | | to install release version 0.11b2 do: |
| 88 | | {{{ |
| 89 | | easy_install http://svn.edgewall.org/repos/trac/tags/trac-0.11b2 |
| 90 | | }}} |
| 91 | | |
| 92 | | But of course the python-typical setup at the top of the source directory also works: |
| | 128 | === Using `easy_install` |
| | 129 | One way to install Trac is using [http://pypi.python.org/pypi/setuptools setuptools]. |
| | 130 | With setuptools you can install Trac from the subversion repository; |
| | 131 | |
| | 132 | A few examples: |
| | 133 | |
| | 134 | - install Trac 0.12: |
| | 135 | {{{ |
| | 136 | easy_install Trac==0.12 |
| | 137 | }}} |
| | 138 | |
| | 139 | - install latest development version 0.12dev: |
| | 140 | {{{ |
| | 141 | easy_install Trac==dev |
| | 142 | }}} |
| | 143 | Note that in this case you won't have the possibility to run a localized version of Trac; |
| | 144 | either use a released version or install from source |
| | 145 | |
| | 146 | === Using `pip` |
| | 147 | 'pip' is an easy_install replacement that is very useful to quickly install python packages. |
| | 148 | To get a trac installation up and running in less than 5 minutes: |
| | 149 | |
| | 150 | Assuming you want to have your entire pip installation in /opt/user/trac |
| | 151 | |
| | 152 | - |
| | 153 | {{{ |
| | 154 | pip -E /opt/user/trac install trac psycopg2 |
| | 155 | }}} |
| | 156 | or |
| | 157 | - |
| | 158 | {{{ |
| | 159 | pip -E /opt/user/trac install trac mysql-python |
| | 160 | }}} |
| | 161 | |
| | 162 | Make sure your OS specific headers are available for pip to automatically build PostgreSQL (libpq-dev) or MySQL (libmysqlclient-dev) bindings. |
| | 163 | |
| | 164 | 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 |
| | 165 | |
| | 166 | 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) |
| | 167 | |
| | 168 | Additionally, you can install several trac plugins (listed [http://pypi.python.org/pypi?:action=search&term=trac&submit=search here]) through pip. |
| | 169 | |
| | 170 | |
| | 171 | |
| | 172 | === From source |
| | 173 | Of course, using the python-typical setup at the top of the source directory also works. |
| | 174 | |
| | 175 | You can obtain the source for a .tar.gz or .zip file corresponding to a release (e.g. Trac-0.12.tar.gz), or you can get the source directly from the repository (see [trac:SubversionRepository] for details). |
| | 176 | |
| 133 | | [wiki:TracAdmin trac-admin] will prompt you for the information it needs to create the environment, such as the name of the project, the type and the path to an existing [wiki:TracEnvironment#SourceCodeRepository source code repository], the [wiki:TracEnvironment#DatabaseConnectionStrings database connection string], and so on. If you're not sure what to specify for one of these options, just leave it blank to use the default value. The database connection string in particular will always work as long as you have SQLite installed. Leaving the path to the source code repository empty will disable any functionality related to version control, but you can always add that back when the basic system is running. |
| 134 | | |
| 135 | | Also note that the values you specify here can be changed later by directly editing the [wiki:TracIni] configuration file. |
| 136 | | |
| 137 | | ''Note: The user account under which the web server runs will require write permissions to the environment directory and all the files inside. On Linux, with the web server running as user apache and group apache, enter:'' |
| 138 | | |
| 139 | | chown -R apache.apache /path/to/myproject |
| 140 | | |
| | 225 | [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. |
| | 226 | |
| | 227 | Using the default database connection string in particular will always work as long as you have SQLite installed. |
| | 228 | For the other [DatabaseBackend database backends] you should plan ahead and already have a database ready to use at this point. |
| | 229 | |
| | 230 | 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. |
| | 231 | |
| | 232 | Also note that the values you specify here can be changed later by directly editing the [TracIni conf/trac.ini] configuration file. |
| | 233 | |
| | 234 | Finally, make sure the user account under which the web front-end runs will have '''write permissions''' to the environment directory and all the files inside. This will be the case if you run `trac-admin ... initenv` as this user. If not, you should set the correct user afterwards. For example on Linux, with the web server running as user `apache` and group `apache`, enter: |
| | 235 | {{{ |
| | 236 | # chown -R apache.apache /path/to/myproject |
| | 237 | }}} |
| 157 | | 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. |
| 158 | | |
| 159 | | If you're not afraid of running development code, you can also try running Trac on [wiki:TracModWSGI mod_wsgi]. This should deliver even better performance than mod_python, but the module is not considered stable just yet. |
| | 253 | Trac provides various options for connecting to a "real" web server: [wiki:TracCgi CGI], [wiki:TracFastCgi FastCGI], [wiki:TracModWSGI mod_wsgi] and [wiki:TracModPython mod_python]. For decent performance, it is recommended that you use either FastCGI or mod_wsgi. |
| | 254 | |
| | 255 | Trac also supports [trac:TracOnWindowsIisAjp AJP] which may be your choice if you want to connect to IIS. |
| | 256 | |
| | 257 | ==== Generating the Trac cgi-bin directory ==== |
| | 258 | |
| | 259 | 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]. |
| | 260 | |
| | 261 | 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: |
| | 262 | {{{ |
| | 263 | mkdir -p /usr/share/trac/projects/my-project |
| | 264 | trac-admin /usr/share/trac/projects/my-project initenv |
| | 265 | trac-admin /usr/share/trac/projects/my-project deploy /tmp/deploy |
| | 266 | mv /tmp/deploy/* /usr/share/trac |
| | 267 | }}} |
| | 268 | |
| | 269 | ==== Setting up the Plugin Cache ==== |
| | 270 | |
| | 271 | 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. |
| 166 | | * TracCgi if you use the CGI or FastCGI methods. |
| 167 | | * TracModPython if you use the mod_python method. |
| 168 | | |
| 169 | | == Trac 0.11 & SVN on Mac OS X Leopard (10.5) == |
| 170 | | |
| 171 | | * TracOnLeopardServer |
| | 278 | * TracCgi if you use the CGI or FastCGI web front ends. |
| | 279 | * [wiki:TracModWSGI] if you use the Apache mod_wsgi web front end. |
| | 280 | * TracModPython if you use the Apache mod_python web front end. |
| | 281 | |
| | 282 | |
| | 283 | == Automatic reference to the SVN changesets in Trac tickets == |
| | 284 | |
| | 285 | 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: |
| | 286 | * '''`Refs #123`''' - to reference this changeset in `#123` ticket |
| | 287 | * '''`Fixes #123`''' - to reference this changeset and close `#123` ticket with the default status ''fixed'' |
| | 288 | |
| | 289 | 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. |
| | 290 | {{{ |
| | 291 | tracopt.ticket.commit_updater.* = enabled |
| | 292 | }}} |
| | 293 | For more information, see the documentation of the `CommitTicketUpdater` component in the "Plugins" admin panel. |
