Changes between Version 4 and Version 5 of TracInstall


Ignore:
Timestamp:
May 5, 2015, 2:14:41 PM (10 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracInstall

    v4 v5  
    1 = Trac Installation Guide for 0.11 =
     1= Trac Installation Guide for 1.0
    22[[TracGuideToc]]
    33
    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 
    21 
    22 == Requirements ==
    23 The hardware requirements for running Trac obviously depend on the expected data volume (number of wiki pages, tickets, revisions) and traffic. Very small projects will run fine with a 500MHz processor and 128MB RAM using SQLite. In general, the more RAM, the better. A fast hard disk also helps.
    24 
     4Trac is written in the Python programming language and needs a database, [http://sqlite.org/ SQLite], [http://www.postgresql.org/ PostgreSQL], or [http://mysql.com/ MySQL]. For HTML rendering, Trac uses the [http://genshi.edgewall.org Genshi] templating system.
     5
     6Since version 0.12, Trac can also be localized, and there is probably a translation available in your language. If you want to use the Trac interface in other languages, then make sure you have installed the optional package [#OtherPythonPackages Babel]. Pay attention to the extra steps for localization support in the [#InstallingTrac Installing Trac] section below. Lacking Babel, you will only get the default English version.
     7
     8If 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
     10What follows are generic instructions for installing and setting up Trac. While you may find instructions for installing Trac on specific systems at [trac:TracInstallPlatforms TracInstallPlatforms] on the main Trac site, please '''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
    2516To install Trac, the following software packages must be installed:
    2617
    27  * [http://www.python.org/ Python], version >=2.3 (<3.0)
    28    * if using mod_python together with xml-related things, use python-2.5. expat is namespaced there and does not cause apache to crash any more(see [http://www.dscpl.com.au/wiki/ModPython/Articles/ExpatCausingApacheCrash here] for details).
    29    * For RPM-based systems you might also need the `python-devel` and `python-xml` packages.
    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)
    33  * You also need a database system and the corresponding python drivers for it.
    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 {{{
     18 * [http://www.python.org/ Python], version >= 2.5 and < 3.0
     19   (note that we dropped the support for Python 2.4 in this release)
     20 * [http://peak.telecommunity.com/DevCenter/setuptools setuptools], version >= 0.6
     21 * [http://genshi.edgewall.org/wiki/Download Genshi], version >= 0.6
     22
     23You also need a database system and the corresponding python bindings. The database can be either SQLite, PostgreSQL or MySQL.
     24
     25==== For the SQLite database #ForSQLite
     26
     27As 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.
     28
     29However, if you like, you can download the latest and greatest version of [[trac:PySqlite]] from
     30[http://code.google.com/p/pysqlite/downloads/list google code], where you'll find the Windows
     31installers or the `tar.gz` archive for building from source:
     32{{{#!sh
    4533$ tar xvfz <version>.tar.gz
    4634$ cd <version>
    … …  
    4836}}}
    4937 
    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 ====
    60 
    61  * [http://www.postgresql.org/ PostgreSQL]
    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)
    70  * [http://sf.net/projects/mysql-python MySQLdb], version 1.2.1 or later
    71 
    72 See [trac:MySqlDb MySqlDb] for more detailed information.
    73 It is ''very'' important to read carefully that page before creating the database.
    74 
    75 == Optional Requirements ==
    76 
    77 ==== Version Control System ====
    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].
    86 
    87 ==== Web Server ====
    88  * A CGI-capable web server (see TracCgi), or
    89  * a [http://www.fastcgi.com/ FastCGI]-capable web server (see TracFastCgi), or
    90  * an [http://tomcat.apache.org/connectors-doc/ajp/ajpv13a.html AJP]-capable web server (see [trac:TracOnWindowsIisAjp TracOnWindowsIisAjp]), or
    91  * [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) or
    92     * 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.
    93  * [http://httpd.apache.org/ Apache] with [http://www.modpython.org/ mod_python 3.1.3+] (see TracModPython)
    94     * When installing mod_python the development versions of Python and Apache are required (actually the libraries and header files)
    95 
    96 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 [trac:wiki:TracModPython2.7 TracModPython2.7]). This guide hasn't been updated since 0.84, so it may or may not work.
    97 
    98 ==== Other Python Utilities ====
    99  * [http://docutils.sourceforge.net/ docutils], version >= 0.3.9 for WikiRestructuredText.
    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!).
    106 
    107 == Installing Trac ==
    108 
    109 One way to install Trac is using `setuptools`.
    110 With setuptools you can install Trac from the subversion repository; for example,
    111 to install release version 0.11 do:
    112 {{{
    113 easy_install http://svn.edgewall.org/repos/trac/tags/trac-0.11
    114 }}}
    115 
    116 But of course the python-typical setup at the top of the source directory also works:
    117 {{{
     38This will download the latest SQLite code and build the bindings. SQLite 2.x is no longer supported.
     39
     40A known bug in [trac:PySqlite] versions 2.5.2-4 prohibits upgrades of Trac databases from 0.11.x to 0.12. Please use versions 2.5.5 and newer or 2.5.1 and older. See [trac:#9434] for more detail. See additional information in [trac:PySqlite PySqlite].
     41
     42==== For the PostgreSQL database #ForPostgreSQL
     43
     44You need to install the database and its Python bindings:
     45 * [http://www.postgresql.org/ PostgreSQL], version 8.0 or later
     46 * [http://pypi.python.org/pypi/psycopg2 psycopg2], version 2.0 or later
     47
     48See [trac:DatabaseBackend#Postgresql DatabaseBackend] for details.
     49
     50==== For the MySQL database #ForMySQL
     51
     52Trac works well with MySQL, provided you follow the guidelines:
     53
     54 * [http://mysql.com/ MySQL], version 5.0 or later
     55 * [http://sf.net/projects/mysql-python MySQLdb], version 1.2.2 or later
     56
     57Given the caveats and known issues surrounding MySQL, read carefully the [trac:MySqlDb] page before creating the database.
     58
     59=== Optional Dependencies
     60
     61==== Version Control System
     62
     63===== Subversion
     64 * [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.
     65
     66There 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. [trac:TracSubversion] points you to [http://alagazam.net Alagazam], which works for me under Python 2.6.)
     67
     68Note that Trac '''doesn't''' use [http://pysvn.tigris.org/ PySVN], neither does it work yet with the newer `ctype`-style bindings.
     69
     70'''Please note:''' if using Subversion, Trac must be installed on the '''same machine'''. Remote repositories are currently [trac:ticket:493 not supported].
     71
     72===== Others
     73
     74Support for other version control systems is provided via third-parties. See [trac:PluginList] and [trac:VersionControlSystem].
     75
     76==== Web Server
     77A web server is optional because Trac is shipped with a server included, see the [#RunningtheStandaloneServer Running the Standalone Server] section below.
     78
     79Alternatively you can configure Trac to run in any of the following environments:
     80 * [http://httpd.apache.org/ Apache] with
     81   - [http://code.google.com/p/modwsgi/ mod_wsgi], see [wiki:TracModWSGI] and
     82     http://code.google.com/p/modwsgi/wiki/IntegrationWithTrac
     83   - [http://modpython.org/ mod_python >= 3.3.1], (deprecated: see TracModPython)
     84 * a [http://www.fastcgi.com/ FastCGI]-capable web server (see TracFastCgi)
     85 * an [http://tomcat.apache.org/connectors-doc/ajp/ajpv13a.html AJP]-capable web
     86   server (see [trac:TracOnWindowsIisAjp TracOnWindowsIisAjp])
     87 * a CGI-capable web server (see TracCgi), '''but usage of Trac as a cgi script
     88   is highly discouraged''', better use one of the previous options.
     89   
     90
     91==== Other Python Packages
     92
     93 * [http://babel.edgewall.org Babel], version >= 0.9.5,
     94   needed for localization support (unreleased version 1.0dev should work as well)
     95 * [http://docutils.sourceforge.net/ docutils], version >= 0.3.9
     96   for WikiRestructuredText.
     97 * [http://pygments.org Pygments] for
     98   [wiki:TracSyntaxColoring syntax highlighting].
     99   [http://silvercity.sourceforge.net/ SilverCity] and/or
     100   [http://gnu.org/software/enscript/enscript.html Enscript] may still be used
     101   but are deprecated and you really should be using Pygments.
     102 * [http://pytz.sf.net pytz] to get a complete list of time zones,
     103   otherwise Trac will fall back on a shorter list from
     104   an internal time zone implementation.
     105
     106'''Attention''': The available versions of these dependencies are not necessarily interchangeable, so please pay attention to the version numbers. 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].
     107
     108Please 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!
     109
     110== Installing Trac
     111=== Using `easy_install`
     112One way to install Trac is using [http://pypi.python.org/pypi/setuptools setuptools]. With setuptools you can install Trac from the Subversion repository.
     113
     114A few examples:
     115
     116 - Install Trac 1.0:
     117   {{{#!sh
     118   easy_install Trac==1.0
     119   }}}
     120 - Install latest development version:
     121   {{{#!sh
     122   easy_install Trac==dev
     123   }}}
     124   Note that in this case you won't have the possibility to run a localized version of Trac;
     125   either use a released version or install from source
     126
     127{{{#!div style="border: 1pt dotted; margin: 1em"
     128**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].
     129}}}
     130
     131=== Using `pip`
     132'pip' is an easy_install replacement that is very useful to quickly install python packages.
     133To get a Trac installation up and running in less than 5 minutes:
     134
     135Assuming you want to have your entire pip installation in `/opt/user/trac`
     136
     137 -
     138 {{{#!sh
     139pip install trac psycopg2
     140}}}
     141or
     142 -
     143 {{{#!sh
     144pip install trac mysql-python
     145}}}
     146
     147Make sure your OS specific headers are available for pip to automatically build PostgreSQL (`libpq-dev`) or MySQL (`libmysqlclient-dev`) bindings.
     148
     149pip 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`.
     150
     151All 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)
     152
     153Additionally, you can install several Trac plugins (listed [https://pypi.python.org/pypi?:action=browse&show=all&c=516 here]) through pip.
     154
     155=== From source
     156Of course, using the python-typical setup at the top of the source directory also works. 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.
     157
     158{{{#!sh
    118159$ python ./setup.py install
    119160}}}
    120161
    121 ''Note: you'll need root permissions or equivalent for this step.''
    122 
    123 This will byte-compile the python source code and install it as an .egg file or folder in the `site-packages` directory
    124 of your Python installation. The .egg will also contain all other resources needed by standard Trac, such as htdocs and templates.
     162''You will need root permissions or equivalent for this step.''
     163
     164This will byte-compile the Python source code and install it as an .egg file or folder in the `site-packages` directory
     165of your Python installation. The .egg will also contain all other resources needed by standard Trac, such as `htdocs` and `templates`.
    125166
    126167The script will also install the [wiki:TracAdmin trac-admin] command-line tool, used to create and maintain [wiki:TracEnvironment project environments], as well as the [wiki:TracStandalone tracd] standalone server.
    127168
    128 ==== Advanced Options ====
     169If you install from source and want to make Trac available in other languages, make sure Babel is installed. Only then, perform the `install` (or simply redo the `install` once again afterwards if you realize Babel was not yet installed):
     170{{{#!sh
     171$ python ./setup.py install
     172}}}
     173Alternatively, you can run `bdist_egg` and copy the .egg from `dist/` to the place of your choice, or you can create a Windows installer (`bdist_wininst`).
     174
     175=== Advanced Options
    129176
    130177To install Trac to a custom location, or find out about other advanced installation options, run:
    131 {{{
     178{{{#!sh
    132179easy_install --help
    133180}}}
    134181
    135 Also see [http://docs.python.org/inst/inst.html Installing Python Modules] for detailed information.
     182Also see [http://docs.python.org/2/install/index.html Installing Python Modules] for detailed information.
    136183
    137184Specifically, you might be interested in:
    138 {{{
     185{{{#!sh
    139186easy_install --prefix=/path/to/installdir
    140187}}}
    141 or, if installing Trac to a Mac OS X system:
    142 {{{
     188or, if installing Trac on a Mac OS X system:
     189{{{#!sh
    143190easy_install --prefix=/usr/local --install-dir=/Library/Python/2.5/site-packages
    144191}}}
     192Note: If installing on Mac OS X 10.6 running {{{ easy_install http://svn.edgewall.org/repos/trac/trunk }}} will install into {{{ /usr/local }}} and {{{ /Library/Python/2.6/site-packages }}} by default.
    145193
    146194The above will place your `tracd` and `trac-admin` commands into `/usr/local/bin` and will install the Trac libraries and dependencies into `/Library/Python/2.5/site-packages`, which is Apple's preferred location for third-party Python application installations.
    147195
    148 == Creating a Project Environment ==
    149 
    150 A [wiki:TracEnvironment Trac environment] is the backend storage where Trac stores information like wiki pages, tickets, reports, settings, etc. An environment is basically a directory that contains a human-readable configuration file and various other files and directories.
     196== Creating a Project Environment
     197
     198A [TracEnvironment Trac environment] is the backend where Trac stores information like wiki pages, tickets, reports, settings, etc. An environment is basically a directory that contains a human-readable [TracIni configuration file], and other files and directories.
    151199
    152200A new environment is created using [wiki:TracAdmin trac-admin]:
    153 {{{
     201{{{#!sh
    154202$ trac-admin /path/to/myproject initenv
    155203}}}
    156204
    157 [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.
    158 
    159 Also note that the values you specify here can be changed later by directly editing the [wiki:TracIni] configuration file.
    160 
    161 ''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:''
    162 
    163   chown -R apache.apache /path/to/myproject
    164 
    165 == Running the Standalone Server ==
     205[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.
     206
     207Using the default database connection string in particular will always work as long as you have SQLite installed.
     208For the other [trac:DatabaseBackend database backends] you should plan ahead and already have a database ready to use at this point.
     209
     210Since 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.
     211
     212Also note that the values you specify here can be changed later by directly editing the [TracIni conf/trac.ini] configuration file.
     213
     214When 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. The best advice is to opt for a platform with sub-second timestamp resolution, regardless of the Trac version.
     215
     216Finally, 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:
     217{{{#!sh
     218$ chown -R apache.apache /path/to/myproject
     219}}}
     220
     221The 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).
     222
     223{{{#!div class=important
     224'''Warning:''' Please only use ASCII-characters for account name and project path, unicode characters are not supported there.
     225}}}
     226
     227== Deploying Trac
     228
     229=== Running the Standalone Server
    166230
    167231After having created a Trac environment, you can easily try the web interface by running the standalone server [wiki:TracStandalone tracd]:
    168 {{{
     232{{{#!sh
    169233$ tracd --port 8000 /path/to/myproject
    170234}}}
    171235
    172 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:
    173 {{{
     236Then, 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:
     237{{{#!sh
    174238$ tracd -s --port 8000 /path/to/myproject
    175239}}}
    176240
    177 == Running Trac on a Web Server ==
    178 
    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].
     241{{{#!div style="border: 1pt dotted; margin: 1em"
     242**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.
     243
     244To 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`.
     245{{{#!sh
     246export PKG_RESOURCES_CACHE_ZIP_MANIFESTS=1
     247}}}
     248
     249Alternatively, the variable can be set in the shell before executing `tracd`:
     250{{{#!sh
     251$ PKG_RESOURCES_CACHE_ZIP_MANIFESTS=1 tracd --port 8000 /path/to/myproject
     252}}}
     253}}}
     254
     255=== Running Trac on a Web Server
     256
     257Trac provides various options for connecting to a "real" web server:
     258 - [wiki:TracFastCgi FastCGI]
     259 - [wiki:TracModWSGI mod_wsgi]
     260 - //[wiki:TracModPython mod_python] (no longer recommended, as mod_python is not actively maintained anymore)//
     261 - //[wiki:TracCgi CGI] (should not be used, as the performance is far from optimal)//
     262
     263Trac 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.
     264
     265==== Generating the Trac cgi-bin directory #cgi-bin
     266
     267In 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].
    188268
    189269There 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 {{{
     270{{{#!sh
    191271mkdir -p /usr/share/trac/projects/my-project
    192272trac-admin /usr/share/trac/projects/my-project initenv
    … …  
    194274mv /tmp/deploy/* /usr/share/trac
    195275}}}
    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.
    200 
    201 == Configuring Authentication ==
    202 
    203 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:
    204 
    205  * TracStandalone if you use the standalone server, `tracd`.
    206  * TracCgi if you use the CGI or FastCGI methods.
    207  * TracModPython if you use the mod_python method.
    208 
    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 
    243 == Using Trac ==
    244 
    245 Once you have your Trac site up and running, you should be able to browse your subversion repository, create tickets, view the timeline, etc.
    246 
    247 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.
     276Don't forget to check that the web server has the execution right on scripts in the `/usr/share/trac/cgi-bin` directory.
     277
     278==== Mapping Static Resources
     279
     280Out 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).
     281
     282Web 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.
     283
     284There 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.
     285
     286Note 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:
     287[[TracAdminHelp(deploy)]]
     288
     289The target `<directory>` will then contain an `htdocs` directory with:
     290 - `site/` - a copy of the environment's directory `htdocs/`
     291 - `common/` - the static resources of Trac itself
     292 - `<plugins>/` - one directory for each resource directory managed by the plugins enabled for this environment
     293
     294===== Example: Apache and `ScriptAlias` #ScriptAlias-example
     295
     296Assuming the deployment has been done this way:
     297{{{#!sh
     298$ trac-admin /var/trac/env deploy /path/to/shared/trac
     299}}}
     300
     301Add 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:
     302{{{#!apache
     303Alias /trac/chrome/common /path/to/trac/htdocs/common
     304Alias /trac/chrome/site /path/to/trac/htdocs/site
     305
     306<Directory "/path/to/www/trac/htdocs">
     307  Order allow,deny
     308  Allow from all
     309</Directory>
     310}}}
     311
     312If using mod_python, you might want to add this too (otherwise, the alias will be ignored):
     313{{{#!apache
     314<Location "/trac/chrome/common/">
     315  SetHandler None
     316</Location>
     317}}}
     318
     319Note 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.
     320
     321Similarly, 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):
     322{{{#!apache
     323Alias /trac/chrome/site /path/to/projectenv/htdocs
     324
     325<Directory "/path/to/projectenv/htdocs">
     326  Order allow,deny
     327  Allow from all
     328</Directory>
     329}}}
     330
     331Alternatively 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:
     332{{{#!ini
     333[trac]
     334htdocs_location = http://static.example.org/trac-common/
     335}}}
     336Note 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]).
     337
     338Of 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:
     339{{{#!sh
     340$ ln -s /path/to/trac/htdocs/common /var/www/static.example.org/trac-common
     341}}}
     342
     343==== Setting up the Plugin Cache
     344
     345Some 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.
     346
     347== Configuring Authentication
     348
     349Trac 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.
     350
     351The process of adding, removing, and configuring user accounts for authentication depends on the specific way you run Trac.
     352
     353Please refer to one of the following sections:
     354 * TracStandalone#UsingAuthentication if you use the standalone server, `tracd`.
     355 * [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`.
     356 * TracFastCgi if you're using another web server with FCGI support (Cherokee, Lighttpd, !LiteSpeed, nginx)
     357
     358The following document also constains some useful information for beginners: [trac:TracAuthenticationIntroduction].
     359
     360== Granting admin rights to the admin user
     361Grant admin rights to user admin:
     362{{{#!sh
     363$ trac-admin /path/to/myproject permission add admin TRAC_ADMIN
     364}}}
     365This user will have an "Admin" entry menu that will allow you to administrate your Trac project.
     366
     367== Finishing the install
     368
     369=== Enable version control components
     370
     371Support 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.
     372
     373The 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.
     374
     375{{{#!ini
     376tracopt.versioncontrol.svn.* = enabled
     377}}}
     378
     379{{{#!ini
     380tracopt.versioncontrol.git.* = enabled
     381}}}
     382
     383After enabling the components, repositories can be configured through the "Repositories" admin panel or by editing [TracIni#repositories-section trac.ini].
     384
     385=== Automatic reference to the SVN changesets in Trac tickets
     386
     387You 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:
     388 * '''`Refs #123`''' - to reference this changeset in `#123` ticket
     389 * '''`Fixes #123`''' - to reference this changeset and close `#123` ticket with the default status ''fixed''
     390
     391This 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.
     392{{{#!ini
     393tracopt.ticket.commit_updater.* = enabled
     394}}}
     395For more information, see the documentation of the `CommitTicketUpdater` component in the "Plugins" admin panel.
     396
     397=== Using Trac
     398
     399Once 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.
     400
     401Keep 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.
    248402
    249403'' Enjoy! ''
    … …  
    252406
    253407----
    254 See also: [trac:TracInstallPlatforms TracInstallPlatforms], TracGuide, TracCgi, TracFastCgi, TracModPython, [wiki:TracModWSGI], TracUpgrade, TracPermissions
    255 
     408See also: [trac:TracInstallPlatforms TracInstallPlatforms], TracGuide, TracUpgrade, TracPermissions