| 12 | | * [http://www.python.org/ Python], version >= 2.3. |
| 13 | | * For RPM-based systems you might also need the `python-devel` and `python-xml` packages. |
| 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`) |
| 18 | | * You also need a database system and the corresponding python drivers for it. |
| 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 === |
| 33 | | |
| 34 | | * [http://www.postgresql.org/ 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 |
| 44 | | * [http://sf.net/projects/mysql-python MySQLdb], version 1.2.1 or later |
| 45 | | |
| 46 | | ''Note: MySQL support requires Trac version 0.10 or later.'' |
| 47 | | |
| 48 | | === Optional Requirements === |
| 49 | | |
| 50 | | ==== Version Control System ==== |
| 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]. |
| 55 | | |
| 56 | | ==== Web Server ==== |
| 57 | | * A CGI-capable web server (see TracCgi), or |
| 58 | | * a [http://www.fastcgi.com/ FastCGI]-capable web server (see TracFastCgi), or |
| 59 | | * [http://httpd.apache.org/ Apache] with [http://www.modpython.org/ mod_python 3.1.3+] (see TracModPython) |
| 60 | | * When installing mod_python the development versions of Python and Apache are required (actually the libraries and header files) |
| 61 | | |
| 62 | | For those stuck with Apache 1.3, it is also possible to get Trac 0.8.4 working with [http://www.modpython.org/ mod_python 2.7] (see [wiki:TracModPython2.7 TracModPython2.7]). This hasn't been tested with Trac 0.9, so it may or may not work. |
| 63 | | |
| 64 | | ==== Other Python Utilities ==== |
| 65 | | * [http://peak.telecommunity.com/DevCenter/setuptools setuptools], version >= 0.6 for using plugins (see TracPlugins) |
| 66 | | * [http://docutils.sourceforge.net/ docutils], version >= 0.3.9 for WikiRestructuredText. |
| 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). |
| 74 | | |
| 75 | | == Installing Trac == |
| 76 | | |
| 77 | | Like most Python programs, the Trac Python package is installed by running the following command at the top of the source directory: |
| 78 | | {{{ |
| | 24 | * [http://www.python.org/ Python], version >= 2.5 and < 3.0 |
| | 25 | (note that we dropped the support for Python 2.4 in this release) |
| | 26 | * [http://peak.telecommunity.com/DevCenter/setuptools setuptools], version >= 0.6 |
| | 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]. |
| | 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 | |
| | 126 | |
| | 127 | == Installing Trac |
| | 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 1.0: |
| | 135 | {{{#!sh |
| | 136 | easy_install Trac==1.0 |
| | 137 | }}} |
| | 138 | - Install latest development version: |
| | 139 | {{{#!sh |
| | 140 | easy_install Trac==dev |
| | 141 | }}} |
| | 142 | Note that in this case you won't have the possibility to run a localized version of Trac; |
| | 143 | either use a released version or install from source |
| | 144 | |
| | 145 | {{{#!div style="border: 1pt dotted; margin: 1em" |
| | 146 | **Setuptools Warning:** If the version of your setuptools is in the range 5.4 through 5.6, the environment variable `PKG_RESOURCES_CACHE_ZIP_MANIFESTS` must be set in order to avoid significant performance degradation. More information may be found in the sections on [#RunningtheStandaloneServer Running The Standalone Server] and [#RunningTraconaWebServer Running Trac on a Web Server]. |
| | 147 | }}} |
| | 148 | |
| | 149 | === Using `pip` |
| | 150 | 'pip' is an easy_install replacement that is very useful to quickly install python packages. |
| | 151 | To get a Trac installation up and running in less than 5 minutes: |
| | 152 | |
| | 153 | Assuming you want to have your entire pip installation in `/opt/user/trac` |
| | 154 | |
| | 155 | - |
| | 156 | {{{#!sh |
| | 157 | pip install trac psycopg2 |
| | 158 | }}} |
| | 159 | or |
| | 160 | - |
| | 161 | {{{#!sh |
| | 162 | pip install trac mysql-python |
| | 163 | }}} |
| | 164 | |
| | 165 | Make sure your OS specific headers are available for pip to automatically build PostgreSQL (`libpq-dev`) or MySQL (`libmysqlclient-dev`) bindings. |
| | 166 | |
| | 167 | 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`. |
| | 168 | |
| | 169 | 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) |
| | 170 | |
| | 171 | Additionally, you can install several Trac plugins (listed [http://pypi.python.org/pypi?:action=search&term=trac&submit=search here]) through pip. |
| | 172 | |
| | 173 | |
| | 174 | |
| | 175 | === From source |
| | 176 | Of course, using the python-typical setup at the top of the source directory also works. |
| | 177 | |
| | 178 | 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). |
| | 179 | |
| | 180 | {{{#!sh |
| 127 | | Then, fire up a browser and visit `http://localhost:8000/`. You should get a simple listing of all environments that tracd knows about. Follow the link to the environment you just created, and you should see Trac in action. |
| 128 | | |
| 129 | | |
| 130 | | == Running Trac on a Web Server == |
| 131 | | |
| 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. |
| 133 | | |
| 134 | | == Configuring Authentication == |
| 135 | | |
| 136 | | 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: |
| 137 | | |
| 138 | | * TracStandalone if you use the standalone server, `tracd`. |
| 139 | | * TracCgi if you use the CGI or FastCGI methods. |
| 140 | | * TracModPython if you use the mod_python method. |
| 141 | | |
| 142 | | == Using Trac == |
| 143 | | |
| 144 | | Once you have your Trac site up and running, you should be able to browse your subversion repository, create tickets, view the timeline, etc. |
| 145 | | |
| 146 | | 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. |
| | 260 | Then, fire up a browser and visit `http://localhost:8000/`. You should get a simple listing of all environments that `tracd` knows about. Follow the link to the environment you just created, and you should see Trac in action. If you only plan on managing a single project with Trac you can have the standalone server skip the environment list by starting it like this: |
| | 261 | {{{#!sh |
| | 262 | $ tracd -s --port 8000 /path/to/myproject |
| | 263 | }}} |
| | 264 | |
| | 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. |
![(please configure the [header_logo] section in trac.ini)](/pubtrac/GeniusWeb/chrome/site/your_project_logo.png){kind=logo}
