| 24 | | * [http://genshi.edgewall.org/wiki/Download Genshi], version >= 0.5 (was version >= 0.4.1 on previous 0.11 release candidates) |
| 25 | | * You also need a database system and the corresponding python drivers for it. |
| 26 | | The database can be either SQLite, PostgreSQL or ''MySQL (experimental)''. |
| 27 | | * Optional if some plugins require it: [http://www.clearsilver.net/ ClearSilver] |
| 28 | | |
| 29 | | ==== For SQLite ==== |
| 30 | | |
| 31 | | * [http://www.sqlite.org/ SQLite], version 3.3.4 and above preferred (note: it is preinstalled in Python 2.5.2). |
| 32 | | * 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 [trac:PySqlite PySqlite] |
| 33 | | |
| 34 | | ''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.'' |
| 35 | | |
| 36 | | ''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).'' |
| 37 | | |
| 38 | | ==== For PostgreSQL ==== |
| 39 | | |
| 40 | | * [http://www.postgresql.org/ PostgreSQL] |
| 41 | | * [http://initd.org/projects/psycopg2 psycopg2] |
| 42 | | * See [trac:wiki:DatabaseBackend#Postgresql DatabaseBackend] |
| 43 | | |
| 44 | | '''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. |
| 45 | | |
| 46 | | ==== For MySQL ==== |
| 47 | | |
| 48 | | '''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 [trac:MySqlDb MySqlDb] for more detailed information. |
| 49 | | |
| 50 | | * [http://mysql.com/ MySQL], version 4.1 or later |
| 51 | | * [http://sf.net/projects/mysql-python MySQLdb], version 1.2.1 or later |
| 52 | | |
| 53 | | == Optional Requirements == |
| 54 | | |
| 55 | | ==== Version Control System ==== |
| 56 | | |
| 57 | | '''Please note:''' if using Subversion, Trac must be installed on the '''same machine'''. Remote repositories are currently not supported. |
| 58 | | |
| 59 | | * [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] |
| 60 | | * 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). |
| 61 | | * 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`. |
| 62 | | * There are [http://subversion.tigris.org/servlets/ProjectDocumentList?folderID=91 pre-compiled bindings] available for win32. |
| 63 | | * Support for other version control systems is provided via third-parties. See [trac:PluginList PluginList] and [trac:VersioningSystemBackend VersioningSystemBackend]. |
| 64 | | |
| 65 | | ==== Web Server ==== |
| 66 | | * A CGI-capable web server (see TracCgi), or |
| 67 | | * a [http://www.fastcgi.com/ FastCGI]-capable web server (see TracFastCgi), or |
| 68 | | * an [http://tomcat.apache.org/connectors-doc/ajp/ajpv13a.html AJP]-capable web server (see [trac:TracOnWindowsIisAjp TracOnWindowsIisAjp]), or |
| 69 | | * [http://httpd.apache.org/ Apache] with [http://code.google.com/p/modwsgi/ mod_wsgi] (see [wiki:TracModWSGI] or http://code.google.com/p/modwsgi/wiki/IntegrationWithTrac) |
| 70 | | * 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. |
| 71 | | * [http://httpd.apache.org/ Apache] with [http://www.modpython.org/ mod_python 3.1.3+] (see TracModPython) |
| 72 | | * When installing mod_python the development versions of Python and Apache are required (actually the libraries and header files) |
| 73 | | |
| 74 | | 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. |
| 75 | | |
| 76 | | ==== Other Python Utilities ==== |
| 77 | | * [http://docutils.sourceforge.net/ docutils], version >= 0.3.9 for WikiRestructuredText. |
| 78 | | * [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. |
| 79 | | * [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. |
| 80 | | |
| 81 | | '''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]. |
| | 27 | * [http://genshi.edgewall.org/wiki/Download Genshi], version >= 0.6 |
| | 28 | |
| | 29 | You also need a database system and the corresponding python bindings. |
| | 30 | The database can be either SQLite, PostgreSQL or MySQL. |
| | 31 | |
| | 32 | ==== For the SQLite database #ForSQLite |
| | 33 | |
| | 34 | 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). |
| | 35 | |
| | 36 | However, if you'd like, you can download the latest and greatest version of [[trac:PySqlite]] from |
| | 37 | [http://code.google.com/p/pysqlite/downloads/list google code], where you'll find the Windows |
| | 38 | installers or the `tar.gz` archive for building from source: |
| | 39 | {{{#!sh |
| | 40 | $ tar xvfz <version>.tar.gz |
| | 41 | $ cd <version> |
| | 42 | $ python setup.py build_static install |
| | 43 | }}} |
| | 44 | |
| | 45 | This will download the latest SQLite code and build the bindings. |
| | 46 | |
| | 47 | SQLite 2.x is no longer supported. |
| | 48 | |
| | 49 | A known bug in PySqlite versions 2.5.2-4 prohibits upgrades of Trac databases |
| | 50 | from 0.11.x to 0.12. Please use versions 2.5.5 and newer or 2.5.1 and |
| | 51 | older. See #9434 for more detail. |
| | 52 | |
| | 53 | See additional information in [trac:PySqlite PySqlite]. |
| | 54 | |
| | 55 | ==== For the PostgreSQL database #ForPostgreSQL |
| | 56 | |
| | 57 | You need to install the database and its Python bindings: |
| | 58 | * [http://www.postgresql.org/ PostgreSQL], version 8.0 or later |
| | 59 | * [http://pypi.python.org/pypi/psycopg2 psycopg2], version 2.0 or later |
| | 60 | |
| | 61 | See [trac:DatabaseBackend#Postgresql DatabaseBackend] for details. |
| | 62 | |
| | 63 | |
| | 64 | ==== For the MySQL database #ForMySQL |
| | 65 | |
| | 66 | Trac can now work quite well with MySQL, provided you follow the guidelines. |
| | 67 | |
| | 68 | * [http://mysql.com/ MySQL], version 5.0 or later |
| | 69 | * [http://sf.net/projects/mysql-python MySQLdb], version 1.2.2 or later |
| | 70 | |
| | 71 | It is '''very''' important to read carefully the [trac:MySqlDb] page before creating the database. |
| | 72 | |
| | 73 | === Optional Dependencies |
| | 74 | |
| | 75 | ==== Version Control System |
| | 76 | |
| | 77 | ===== Subversion |
| | 78 | * [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. |
| | 79 | |
| | 80 | 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.) |
| | 81 | |
| | 82 | Note that Trac '''doesn't''' use [http://pysvn.tigris.org/ PySVN], neither does it work yet with the newer `ctype`-style bindings. |
| | 83 | |
| | 84 | |
| | 85 | '''Please note:''' if using Subversion, Trac must be installed on the '''same machine'''. Remote repositories are currently [trac:ticket:493 not supported]. |
| | 86 | |
| | 87 | |
| | 88 | ===== Others |
| | 89 | |
| | 90 | Support for other version control systems is provided via third-parties. See [trac:PluginList] and [trac:VersionControlSystem]. |
| | 91 | |
| | 92 | ==== Web Server |
| | 93 | A web server is optional because Trac is shipped with a server included, see the [#RunningtheStandaloneServer Running the Standalone Server] section below. |
| | 94 | |
| | 95 | Alternatively you can configure Trac to run in any of the following environments. |
| | 96 | * [http://httpd.apache.org/ Apache] with |
| | 97 | - [http://code.google.com/p/modwsgi/ mod_wsgi], see [wiki:TracModWSGI] and |
| | 98 | http://code.google.com/p/modwsgi/wiki/IntegrationWithTrac |
| | 99 | - [http://modpython.org/ mod_python 3.3.1], (deprecated: see TracModPython) |
| | 100 | * a [http://www.fastcgi.com/ FastCGI]-capable web server (see TracFastCgi) |
| | 101 | * an [http://tomcat.apache.org/connectors-doc/ajp/ajpv13a.html AJP]-capable web |
| | 102 | server (see [trac:TracOnWindowsIisAjp TracOnWindowsIisAjp]) |
| | 103 | * a CGI-capable web server (see TracCgi), '''but usage of Trac as a cgi script |
| | 104 | is highly discouraged''', better use one of the previous options. |
| | 105 | |
| | 106 | |
| | 107 | ==== Other Python Packages |
| | 108 | |
| | 109 | * [http://babel.edgewall.org Babel], version >= 0.9.5, |
| | 110 | needed for localization support (unreleased version 1.0dev should work as well) |
| | 111 | * [http://docutils.sourceforge.net/ docutils], version >= 0.3.9 |
| | 112 | for WikiRestructuredText. |
| | 113 | * [http://pygments.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 interchangeable, 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]. |
| 135 | | [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. |
| 136 | | |
| 137 | | Also note that the values you specify here can be changed later by directly editing the [wiki:TracIni] configuration file. |
| 138 | | |
| 139 | | ''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:'' |
| 140 | | |
| 141 | | chown -R apache.apache /path/to/myproject |
| 142 | | |
| 143 | | '''Warning: If the trac.cgi files are not installed where you expect, then the current documentation is insufficient; it might be necessary to use the 'deploy' command in trac-admin. See tickets http://trac.edgewall.org/ticket/7312 and possibly http://trac.edgewall.org/ticket/6827''' |
| 144 | | |
| 145 | | == Running the Standalone Server == |
| | 228 | [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. |
| | 229 | |
| | 230 | Using the default database connection string in particular will always work as long as you have SQLite installed. |
| | 231 | For the other [DatabaseBackend database backends] you should plan ahead and already have a database ready to use at this point. |
| | 232 | |
| | 233 | Since 0.12, Trac doesn't ask for a [TracEnvironment#SourceCodeRepository source code repository] anymore when creating an environment. Repositories can be [TracRepositoryAdmin added] afterwards, and support for specific version control systems is disabled by default. |
| | 234 | |
| | 235 | Also note that the values you specify here can be changed later by directly editing the [TracIni conf/trac.ini] configuration file. |
| | 236 | |
| | 237 | When selecting the location of your environment, make sure that the filesystem on which the environment directory resides supports sub-second timestamps (i.e. **not** `ext2` or `ext3` on Linux), as the modification time of the `conf/trac.ini` file will be monitored to decide whether an environment restart is needed or not. A too coarse-grained timestamp resolution may result in inconsistencies in Trac < 1.0.2 (though the best advice is to opt for a platform with sub-second timestamp resolution when possible regardless of the version of Trac you are running). |
| | 238 | |
| | 239 | 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: |
| | 240 | {{{#!sh |
| | 241 | $ chown -R apache.apache /path/to/myproject |
| | 242 | }}} |
| | 243 | |
| | 244 | The actual username and groupname of the apache server may not be exactly `apache`, and are specified in the Apache configuration file by the directives `User` and `Group` (if Apache `httpd` is what you use). |
| | 245 | |
| | 246 | {{{#!div class=important |
| | 247 | '''Warning:''' Please only use ASCII-characters for account name and project path, unicode characters are not supported there. |
| | 248 | }}} |
| | 249 | |
| | 250 | |
| | 251 | == Deploying Trac |
| | 252 | |
| | 253 | === Running the Standalone Server |
| 157 | | |
| 158 | | == Running Trac on a Web Server == |
| 159 | | |
| 160 | | 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. |
| 161 | | |
| 162 | | 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. |
| 163 | | |
| 164 | | Trac also supports [trac:TracOnWindowsIisAjp AJP] which may be your choice if you want to connect to IIS. |
| 165 | | |
| 166 | | ==== Setting up the Plugin Cache ==== |
| 167 | | |
| 168 | | 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. |
| 169 | | |
| 170 | | == Configuring Authentication == |
| 171 | | |
| 172 | | 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: |
| 173 | | |
| 174 | | * TracStandalone if you use the standalone server, `tracd`. |
| 175 | | * TracCgi if you use the CGI or FastCGI methods. |
| 176 | | * TracModPython if you use the mod_python method. |
| 177 | | |
| 178 | | == Automatic reference to the SVN changesets in Trac tickets == |
| 179 | | |
| 180 | | 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: |
| 181 | | * '''Refs #123''' - to reference this changeset in #123 ticket |
| 182 | | * '''Fixes #123''' - to reference this changeset and close #123 ticket with the default status ''fixed'' |
| 183 | | |
| 184 | | 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. |
| 185 | | |
| 186 | | 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: |
| 187 | | |
| 188 | | {{{ |
| 189 | | $ cd /path/to/svn/repository/hooks |
| 190 | | $ mv post-commit.tmpl post-commit |
| 191 | | $ chmod 755 post-commit |
| 192 | | }}} |
| 193 | | |
| 194 | | 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: |
| 195 | | |
| 196 | | {{{ |
| 197 | | REPOS="$1" |
| 198 | | REV="$2" |
| 199 | | TRAC_ENV="/path/to/your/trac/project" |
| 200 | | |
| 201 | | /usr/bin/python /usr/local/bin/trac-post-commit-hook -p "$TRAC_ENV" -r "$REV" |
| 202 | | }}} |
| 203 | | |
| 204 | | 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]. |
| 205 | | |
| 206 | | |
| 207 | | == Platform-specifics installations == |
| 208 | | |
| 209 | | * See [trac:TracInstallPlatforms TracInstallPlatforms] |
| 210 | | |
| 211 | | |
| 212 | | == Using Trac == |
| 213 | | |
| 214 | | Once you have your Trac site up and running, you should be able to browse your subversion repository, create tickets, view the timeline, etc. |
| 215 | | |
| 216 | | 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. |
| | 265 | {{{#!div style="border: 1pt dotted; margin: 1em" |
| | 266 | **Setuptools Warning:** If the version of your setuptools is in the range 5.4 through 5.6, the environment variable `PKG_RESOURCES_CACHE_ZIP_MANIFESTS` must be set in order to avoid significant performance degradation. The environment variable can be set system-wide, or for just the user that runs the `tracd` process. There are several ways to accomplish this in addition to what is discussed here, and depending on the distribution of your OS. |
| | 267 | |
| | 268 | 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`. |
| | 269 | {{{#!sh |
| | 270 | export PKG_RESOURCES_CACHE_ZIP_MANIFESTS=1 |
| | 271 | }}} |
| | 272 | |
| | 273 | Alternatively, the variable can be set in the shell before executing `tracd`: |
| | 274 | {{{#!sh |
| | 275 | $ PKG_RESOURCES_CACHE_ZIP_MANIFESTS=1 tracd --port 8000 /path/to/myproject |
| | 276 | }}} |
| | 277 | }}} |
| | 278 | |
| | 279 | === Running Trac on a Web Server |
| | 280 | |
| | 281 | Trac provides various options for connecting to a "real" web server: |
| | 282 | - [wiki:TracFastCgi FastCGI] |
| | 283 | - [wiki:TracModWSGI mod_wsgi] |
| | 284 | - //[wiki:TracModPython mod_python] (no longer recommended, as mod_python is not actively maintained anymore)// |
| | 285 | - //[wiki:TracCgi CGI] (should not be used, as the performance is far from optimal)// |
| | 286 | |
| | 287 | 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. |
| | 288 | |
| | 289 | ==== Generating the Trac cgi-bin directory #cgi-bin |
| | 290 | |
| | 291 | 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]. |
| | 292 | |
| | 293 | 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: |
| | 294 | {{{#!sh |
| | 295 | mkdir -p /usr/share/trac/projects/my-project |
| | 296 | trac-admin /usr/share/trac/projects/my-project initenv |
| | 297 | trac-admin /usr/share/trac/projects/my-project deploy /tmp/deploy |
| | 298 | mv /tmp/deploy/* /usr/share/trac |
| | 299 | }}} |
| | 300 | Don't forget to check that the web server has the execution right on scripts in the `/usr/share/trac/cgi-bin` directory. |
| | 301 | |
| | 302 | |
| | 303 | ==== Mapping Static Resources |
| | 304 | |
| | 305 | 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). |
| | 306 | |
| | 307 | 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. |
| | 308 | |
| | 309 | 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. |
| | 310 | |
| | 311 | 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: |
| | 312 | [[TracAdminHelp(deploy)]] |
| | 313 | |
| | 314 | The target `<directory>` will then contain an `htdocs` directory with: |
| | 315 | - `site/` - a copy of the environment's directory `htdocs/` |
| | 316 | - `common/` - the static resources of Trac itself |
| | 317 | - `<plugins>/` - one directory for each resource directory managed by the plugins enabled for this environment |
| | 318 | |
| | 319 | ===== Example: Apache and `ScriptAlias` #ScriptAlias-example |
| | 320 | |
| | 321 | Assuming the deployment has been done this way: |
| | 322 | {{{#!sh |
| | 323 | $ trac-admin /var/trac/env deploy /path/to/trac/htdocs/common |
| | 324 | }}} |
| | 325 | |
| | 326 | 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: |
| | 327 | {{{#!apache |
| | 328 | Alias /trac/chrome/common /path/to/trac/htdocs/common |
| | 329 | Alias /trac/chrome/site /path/to/trac/htdocs/site |
| | 330 | |
| | 331 | <Directory "/path/to/www/trac/htdocs"> |
| | 332 | Order allow,deny |
| | 333 | Allow from all |
| | 334 | </Directory> |
| | 335 | }}} |
| | 336 | |
| | 337 | If using mod_python, you might want to add this too (otherwise, the alias will be ignored): |
| | 338 | {{{#!apache |
| | 339 | <Location "/trac/chrome/common/"> |
| | 340 | SetHandler None |
| | 341 | </Location> |
| | 342 | }}} |
| | 343 | |
| | 344 | 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. |
| | 345 | |
| | 346 | 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): |
| | 347 | {{{#!apache |
| | 348 | Alias /trac/chrome/site /path/to/projectenv/htdocs |
| | 349 | |
| | 350 | <Directory "/path/to/projectenv/htdocs"> |
| | 351 | Order allow,deny |
| | 352 | Allow from all |
| | 353 | </Directory> |
| | 354 | }}} |
| | 355 | |
| | 356 | 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: |
| | 357 | {{{#!ini |
| | 358 | [trac] |
| | 359 | htdocs_location = http://static.example.org/trac-common/ |
| | 360 | }}} |
| | 361 | 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]). |
| | 362 | |
| | 363 | 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: |
| | 364 | {{{#!sh |
| | 365 | $ ln -s /path/to/trac/htdocs/common /var/www/static.example.org/trac-common |
| | 366 | }}} |
| | 367 | |
| | 368 | |
| | 369 | ==== Setting up the Plugin Cache |
| | 370 | |
| | 371 | 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. |
| | 372 | |
| | 373 | == Configuring Authentication |
| | 374 | |
| | 375 | 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. |
| | 376 | |
| | 377 | The process of adding, removing, and configuring user accounts for authentication depends on the specific way you run Trac. |
| | 378 | |
| | 379 | Please refer to one of the following sections: |
| | 380 | * TracStandalone#UsingAuthentication if you use the standalone server, `tracd`. |
| | 381 | * [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`. |
| | 382 | * TracFastCgi if you're using another web server with FCGI support (Cherokee, Lighttpd, !LiteSpeed, nginx) |
| | 383 | |
| | 384 | The following document also constains some useful information for beginners: [trac:TracAuthenticationIntroduction]. |
| | 385 | |
| | 386 | == Granting admin rights to the admin user |
| | 387 | Grant admin rights to user admin: |
| | 388 | {{{#!sh |
| | 389 | $ trac-admin /path/to/myproject permission add admin TRAC_ADMIN |
| | 390 | }}} |
| | 391 | This user will have an "Admin" entry menu that will allow you to administrate your Trac project. |
| | 392 | |
| | 393 | == Finishing the install |
| | 394 | |
| | 395 | === Enable version control components |
| | 396 | |
| | 397 | 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. |
| | 398 | |
| | 399 | The components can be 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. |
| | 400 | |
| | 401 | {{{#!ini |
| | 402 | tracopt.versioncontrol.svn.* = enabled |
| | 403 | }}} |
| | 404 | |
| | 405 | {{{#!ini |
| | 406 | tracopt.versioncontrol.git.* = enabled |
| | 407 | }}} |
| | 408 | |
| | 409 | After enabling the components, repositories can be configured through the "Repositories" admin panel or by editing [TracIni#repositories-section trac.ini]. |
| | 410 | |
| | 411 | === Automatic reference to the SVN changesets in Trac tickets |
| | 412 | |
| | 413 | 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: |
| | 414 | * '''`Refs #123`''' - to reference this changeset in `#123` ticket |
| | 415 | * '''`Fixes #123`''' - to reference this changeset and close `#123` ticket with the default status ''fixed'' |
| | 416 | |
| | 417 | 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. |
| | 418 | {{{#!ini |
| | 419 | tracopt.ticket.commit_updater.* = enabled |
| | 420 | }}} |
| | 421 | For more information, see the documentation of the `CommitTicketUpdater` component in the "Plugins" admin panel. |
| | 422 | |
| | 423 | === Using Trac |
| | 424 | |
| | 425 | 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. |
| | 426 | |
| | 427 | 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. |
