Bug Tracker

Changes between Version 1 and Version 2 of TracInstall


Ignore:
Timestamp:
Nov 29, 2015, 3:01:08 AM (6 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracInstall

    v1 v2  
    1 = Trac Installation Guide for 0.12 =
     1= Trac Installation Guide for 1.0
     2
    23[[TracGuideToc]]
    34
    45Trac 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.
    56
    6 Since version 0.12, Trac can also be localized, and there's probably a translation available for your language. If you want to be able to use the Trac interface in other languages, then make sure you 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, as usual.
    7 
    8 If you're interested in contributing new translations for other languages or enhance the existing translations, then please have a look at [[trac:TracL10N]].
    9 
    10 What follows are generic instructions for installing and setting up Trac and its requirements. While you may find instructions for installing Trac on specific systems at TracInstallPlatforms on the main Trac site, please be sure to '''first read through these general instructions''' to get a good understanding of the tasks involved.
     7Since 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.
     8
     9If you're interested in contributing new translations for other languages or enhancing the existing translations, then please have a look at [trac:wiki:TracL10N TracL10N].
     10
     11What 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.
    1112
    1213[[PageOutline(2-3,Installation Steps,inline)]]
    1314
    14 == Dependencies ==
     15== Dependencies
     16
    1517=== Mandatory Dependencies
     18
    1619To install Trac, the following software packages must be installed:
    1720
    18  * [http://www.python.org/ Python], version >= 2.4 and < 3.0
    19    (note that we dropped the support for Python 2.3 in this release)
    20  * [http://peak.telecommunity.com/DevCenter/setuptools setuptools], version >= 0.6
     21 * [http://www.python.org/ Python], version >= 2.5 and < 3.0
     22   (note that we dropped the support for Python 2.4 in this release)
     23 * [http://pypi.python.org/pypi/setuptools setuptools], version >= 0.6
    2124 * [http://genshi.edgewall.org/wiki/Download Genshi], version >= 0.6
    2225
    23 You also need a database system and the corresponding python bindings.
    24 The database can be either SQLite, PostgreSQL or MySQL.
     26You also need a database system and the corresponding python bindings. The database can be either SQLite, PostgreSQL or MySQL.
    2527
    2628==== For the SQLite database #ForSQLite
    2729
    28 If you're using Python 2.5 or 2.6, you already have everything you need.
    29 
    30 If you're using Python 2.4 and need pysqlite, you can download from
    31 [http://code.google.com/p/pysqlite/downloads/list google code] the Windows
    32 installers or the tar.gz archive for building from source:
    33 {{{
    34 $ tar xvfz <version>.tar.gz
    35 $ cd <version>
    36 $ python setup.py build_static install
    37 }}}
    38  
    39 This will extract the SQLite code and build the bindings.
    40 
    41 SQLite 2.x is no longer supported. For SQLite 3.x, the pysqlite 1.1.x
    42 bindings are also no longer supported, use pysqlite 2.x.
    43 
    44 See additional information in [trac:PySqlite PySqlite].
     30As 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.
     31
     32Optionally, you may install a newer version of [http://pypi.python.org/pypi/pysqlite pysqlite] than the one provided by the Python distribution. See [trac:PySqlite#ThePysqlite2bindings PySqlite] for details.
    4533
    4634==== For the PostgreSQL database #ForPostgreSQL
    4735
    4836You need to install the database and its Python bindings:
    49  * [http://www.postgresql.org/ PostgreSQL]
    50  * [http://pypi.python.org/pypi/psycopg2 psycopg2]
     37 * [http://www.postgresql.org/ PostgreSQL], version 8.0 or later
     38 * [http://pypi.python.org/pypi/psycopg2 psycopg2], version 2.0 or later
    5139
    5240See [trac:DatabaseBackend#Postgresql DatabaseBackend] for details.
    5341
    54 
    5542==== For the MySQL database #ForMySQL
    5643
    57 Trac can now work quite well with MySQL, provided you follow the guidelines.
    58 
    59  * [http://mysql.com/ MySQL], version 5.0 or later
     44Trac works well with MySQL, provided you follow the guidelines:
     45
     46 * [http://mysql.com/ MySQL] or [http://mariadb.org/ MariaDB], version 5.0 or later
    6047 * [http://sf.net/projects/mysql-python MySQLdb], version 1.2.2 or later
    6148
    62 It is '''very''' important to read carefully the  [trac:MySqlDb MySqlDb] page before creating the database.
     49Given the caveats and known issues surrounding MySQL, read the [trac:MySqlDb] page before creating the database.
    6350
    6451=== Optional Dependencies
    6552
    66 ==== Version Control System ====
    67 
    68 ===== Subversion =====
    69  * [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.
    70 
    71 There are [http://subversion.apache.org/packages.html pre-compiled SWIG bindings] available for various platforms. Note that Trac '''doesn't''' use [http://pysvn.tigris.org/ PySVN], neither does it work yet with the newer `ctype`-style bindings
    72 
    73 
    74 '''Please note:''' if using Subversion, Trac must be installed on the '''same machine'''. Remote repositories are currently [trac:ticket:493 not supported].
    75 
    76 
    77 ===== Others =====
    78 
    79 Support for other version control systems is provided via third-parties. See [trac:PluginList PluginList] and [trac:VersioningSystemBackend VersioningSystemBackend].
    80 
    81 ==== Web Server ====
    82 A web server is optional because Trac is shipped with a server included, see the [#RunningtheStandaloneServer Running the Standalone Server ] section below.
    83 
    84 Alternatively you configure Trac to run in any of the following environments.
     53==== Version Control System
     54
     55===== Subversion
     56 * [http://subversion.apache.org/ Subversion], 1.5.x or later and the '''corresponding''' Python bindings. Older versions starting from 1.0, like 1.2.4, 1.3.2 or 1.4.2, etc. may still work. For troubleshooting information, check the [trac:TracSubversion#Troubleshooting TracSubversion] page.
     57
     58There 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.)
     59
     60Note that Trac '''doesn't''' use [http://pysvn.tigris.org/ PySVN], neither does it work yet with the newer `ctype`-style bindings.
     61
     62'''Note:''' if using Subversion, Trac must be installed on the '''same machine'''. Remote repositories are currently [trac:ticket:493 not supported].
     63
     64===== Git
     65 * [http://git-scm.com/ Git] 1.5.6 or later.
     66
     67More information is available on the [trac:TracGit] page.
     68
     69===== Others
     70
     71Support for other version control systems is provided via third-parties. See [trac:PluginList#VersionControlSystems] and [trac:VersionControlSystem].
     72
     73==== Web Server
     74
     75A web server is optional because Trac has a server included, see the [#RunningtheStandaloneServer Running the Standalone Server] section below.
     76
     77Alternatively you can configure Trac to run in any of the following environments:
    8578 * [http://httpd.apache.org/ Apache] with
    8679   - [http://code.google.com/p/modwsgi/ mod_wsgi], see [wiki:TracModWSGI] and
    8780     http://code.google.com/p/modwsgi/wiki/IntegrationWithTrac
    88    - [http://modpython.org/ mod_python 3.3.1], see TracModPython)
     81   - [http://modpython.org/ mod_python 3.5.0], see TracModPython
    8982 * a [http://www.fastcgi.com/ FastCGI]-capable web server (see TracFastCgi)
    9083 * an [http://tomcat.apache.org/connectors-doc/ajp/ajpv13a.html AJP]-capable web
    9184   server (see [trac:TracOnWindowsIisAjp TracOnWindowsIisAjp])
    92  * a CGI-capable web server (see TracCgi), '''but usage of Trac as a cgi script
    93    is highly discouraged''', better use one of the previous options.
     85 * a FastCGI and FastCGI-to-WSGI gateway (see [trac:TracOnWindowsIisWfastcgi])
     86 * a CGI-capable web server (see TracCgi), but //usage of Trac as a cgi script
     87   is highly discouraged//, better use one of the previous options.
    9488   
    95 
    96 ==== Other Python Packages ====
    97 
    98  * [http://babel.edgewall.org Babel], version >= 0.9.5,
     89==== Other Python Packages
     90
     91 * [http://babel.edgewall.org Babel], version 0.9.5, 0.9.6 or >= 1.3
    9992   needed for localization support
    10093 * [http://docutils.sourceforge.net/ docutils], version >= 0.3.9
    10194   for WikiRestructuredText.
    102  * [http://pygments.pocoo.org Pygments] for
    103    [wiki:TracSyntaxColoring syntax highlighting].
     95 * [http://pygments.org Pygments] for
     96   [TracSyntaxColoring syntax highlighting].
    10497   [http://silvercity.sourceforge.net/ SilverCity] and/or
    10598   [http://gnu.org/software/enscript/enscript.html Enscript] may still be used
     
    109102   an internal time zone implementation.
    110103
    111 '''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].
    112 
    113 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!).
    114 
    115 
    116 == Installing Trac ==
     104{{{#!div style="border: 1pt dotted; margin: 1em"
     105**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].
     106}}}
     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.
     109
     110== Installing Trac
     111
     112The [TracAdmin trac-admin] command-line tool, used to create and maintain [TracEnvironment project environments], as well as the [TracStandalone tracd] standalone server are installed along with Trac. There are several methods for installing Trac.
     113
     114It is assumed throughout this guide that you have elevated permissions as the `root` user, or by prefixing commands with `sudo`. The umask `0022` should be used for a typical installation on a Unix-based platform.
     115
    117116=== Using `easy_install`
    118 One way to install Trac is using `setuptools`.
    119 With setuptools you can install Trac from the subversion repository;
    120 
    121 A few examples:
    122 
    123  - install Trac 0.12:
    124    {{{
    125    easy_install Trac==0.12
    126    }}}
    127 
    128  - install latest development version 0.12dev:
    129    {{{
    130    easy_install Trac==dev
    131    }}}
     117
     118Trac can be installed from [https://pypi.python.org/pypi/Trac PyPI] or the Subversion repository using [http://pypi.python.org/pypi/setuptools setuptools].
     119
     120A few command-line examples:
     121
     122 - Install Trac 1.0:
     123 {{{#!sh
     124$ easy_install Trac==1.0
     125}}}
     126 - Install latest development version:
     127 {{{#!sh
     128$ easy_install Trac==dev
     129}}}
    132130   Note that in this case you won't have the possibility to run a localized version of Trac;
    133    either use a released version or install from source
     131   either use a released version or install from source.
     132
     133More information can be found on the [trac:wiki:setuptools setuptools] page.
     134
     135{{{#!div style="border: 1pt dotted; margin: 1em"
     136**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].
     137}}}
    134138
    135139=== Using `pip`
    136 'pip' is an easy_install replacement that is very useful to quickly install python packages.
    137 To get a trac installation up and running in less than 5 minutes:
    138 
    139 Assuming you want to have your entire pip installation in /opt/user/trac
     140
     141'pip' is an easy_install replacement that is very useful to quickly install Python packages.
     142To get a Trac installation up and running in less than 5 minutes:
     143
     144Assuming you want to have your entire pip installation in `/opt/user/trac`:
    140145
    141146 -
    142 {{{
    143 pip -E /opt/user/trac install trac psycopg2
    144 }}}
    145 or
     147 {{{#!sh
     148$ pip install trac psycopg2
     149}}}
     150or:
    146151 -
    147 {{{
    148 pip -E /opt/user/trac install trac mysql-python
    149 }}}
    150 
    151 Make sure your OS specific headers are available for pip to automatically build PostgreSQL (libpq-dev) or MySQL (libmysqlclient-dev) bindings.
    152 
    153 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
    154 
    155 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)
    156 
    157 Additionally, you can install several trac plugins (listed [http://pypi.python.org/pypi?:action=search&term=trac&submit=search here]) through pip.
    158 
    159 
     152 {{{#!sh
     153$ pip install trac mysql-python
     154}}}
     155
     156Make sure your OS specific headers are available for pip to automatically build PostgreSQL (`libpq-dev`) or MySQL (`libmysqlclient-dev`) bindings.
     157
     158pip will automatically resolve all dependencies (like Genshi, pygments, etc.), download the latest packages from pypi.python.org and create a self contained installation in `/opt/user/trac`.
     159
     160All 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).
     161
     162Additionally, you can install several Trac plugins (listed [https://pypi.python.org/pypi?:action=browse&show=all&c=516 here]) through pip.
    160163
    161164=== From source
    162 Of course, using the python-typical setup at the top of the source directory also works.
    163 
    164 You can obtain the source for a .tar.gz or .zip file corresponding to a release (e.g. Trac-0.12.tar.gz), or you can get the source directly from the repository (see Trac:SubversionRepository for details).
    165 
    166 {{{
     165
     166Using 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`) from the [trac:TracDownload] page, or you can get the source directly from the repository. See [trac:TracRepositories#OfficialSubversionrepository TracRepositories] for details.
     167
     168{{{#!sh
    167169$ python ./setup.py install
    168170}}}
    169171
    170 ''You'll need root permissions or equivalent for this step.''
    171 
    172 This will byte-compile the python source code and install it as an .egg file or folder in the `site-packages` directory
    173 of your Python installation. The .egg will also contain all other resources needed by standard Trac, such as htdocs and templates.
    174 
    175 The 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.
    176 
    177 If 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):
    178 {{{
     172You will need root permissions or equivalent for this step.
     173
     174This will byte-compile the Python source code and install it as an .egg file or folder in the `site-packages` directory
     175of your Python installation. The .egg will also contain all other resources needed by standard Trac, such as `htdocs` and `templates`.
     176
     177If 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):
     178{{{#!sh
    179179$ python ./setup.py install
    180180}}}
    181 Alternatively, you can do a `bdist_egg` and copy the .egg from dist/ to the place of your choice, or you can create a Windows installer (`bdist_wininst`).
    182 
    183 === Advanced Options ===
     181
     182Alternatively, 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`).
     183
     184=== Using installer
     185
     186On Windows Trac can be installed using the exe installers available on the [trac:TracDownload] page. Installers are available for the 32 and 64 bit versions of Python. Make sure to use the installer that matches the architecture of your Python installation.
     187
     188=== Using package manager
     189
     190Trac may be available in the package repository for your platform. Note however, that the version provided by the package manager may not be the latest release.
     191
     192=== Advanced `easy_install` Options
    184193
    185194To install Trac to a custom location, or find out about other advanced installation options, run:
    186 {{{
    187 easy_install --help
    188 }}}
    189 
    190 Also see [http://docs.python.org/inst/inst.html Installing Python Modules] for detailed information.
     195{{{#!sh
     196$ easy_install --help
     197}}}
     198
     199Also see [http://docs.python.org/2/install/index.html Installing Python Modules] for detailed information.
    191200
    192201Specifically, you might be interested in:
    193 {{{
    194 easy_install --prefix=/path/to/installdir
    195 }}}
    196 or, if installing Trac to a Mac OS X system:
    197 {{{
    198 easy_install --prefix=/usr/local --install-dir=/Library/Python/2.5/site-packages
    199 }}}
    200 Note: 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
     202{{{#!sh
     203$ easy_install --prefix=/path/to/installdir
     204}}}
     205
     206or, if installing Trac on a Mac OS X system:
     207{{{#!sh
     208$ easy_install --prefix=/usr/local --install-dir=/Library/Python/2.5/site-packages
     209}}}
     210
     211'''Note''': 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.5/site-packages }}} by default.
    201212
    202213The 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.
    203214
    204 
    205 == Creating a Project Environment ==
    206 
    207 A [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 [TracIni configuration file], and various other files and directories.
    208 
    209 A new environment is created using [wiki:TracAdmin trac-admin]:
    210 {{{
     215== Creating a Project Environment
     216
     217A [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.
     218
     219A new environment is created using [TracAdmin trac-admin]:
     220{{{#!sh
    211221$ trac-admin /path/to/myproject initenv
    212222}}}
     
    215225
    216226Using the default database connection string in particular will always work as long as you have SQLite installed.
    217 For the other [DatabaseBackend database backends] you should plan ahead and already have a database ready to use at this point.
    218 
    219 Since 0.12, Trac doesn't ask for a [TracEnvironment#SourceCodeRepository source code repository] anymore when creating an environment. Repositories can be [TracRepositoryAdmin added] afterward, or the version control support can be disabled completely if you don't need it.
     227For the other [trac:DatabaseBackend database backends] you should plan ahead and already have a database ready to use at this point.
     228
     229Since 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.
    220230
    221231Also note that the values you specify here can be changed later by directly editing the [TracIni conf/trac.ini] configuration file.
    222232
     233{{{#!div style="border: 1pt dotted; margin: 1em"
     234**Filesystem Warning:** 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, or HFS+ on OSX), 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.
     235}}}
     236
    223237Finally, 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:
    224 {{{
    225 # chown -R apache.apache /path/to/myproject
    226 }}}
    227 
    228 == Running the Standalone Server ==
    229 
    230 After having created a Trac environment, you can easily try the web interface by running the standalone server [wiki:TracStandalone tracd]:
    231 {{{
     238{{{#!sh
     239$ chown -R apache.apache /path/to/myproject
     240}}}
     241
     242The 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).
     243
     244{{{#!div class=important
     245'''Warning:''' Please only use ASCII-characters for account name and project path, unicode characters are not supported there.
     246}}}
     247
     248== Deploying Trac
     249
     250=== Running the Standalone Server
     251
     252After having created a Trac environment, you can easily try the web interface by running the standalone server [TracStandalone tracd]:
     253{{{#!sh
    232254$ tracd --port 8000 /path/to/myproject
    233255}}}
    234256
    235257Then, 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:
    236 {{{
     258{{{#!sh
    237259$ tracd -s --port 8000 /path/to/myproject
    238260}}}
    239261
    240 == Running Trac on a Web Server ==
    241 
    242 Trac provides various options for connecting to a "real" web server: [wiki:TracCgi CGI], [wiki:TracFastCgi FastCGI], [wiki:TracModWSGI mod_wsgi] and [wiki:TracModPython mod_python]. For decent performance, it is recommended that you use either FastCGI or mod_wsgi.
    243 
    244 Trac also supports [trac:TracOnWindowsIisAjp AJP] which may be your choice if you want to connect to IIS.
    245 
    246 ==== Generating the Trac cgi-bin directory ====
    247 
    248 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].
    249 
    250 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:
    251 {{{
    252 mkdir -p /usr/share/trac/projects/my-project
    253 trac-admin /usr/share/trac/projects/my-project initenv
    254 trac-admin /usr/share/trac/projects/my-project deploy /tmp/deploy
    255 mv /tmp/deploy/* /usr/share/trac
    256 }}}
    257 
    258 ==== Setting up the Plugin Cache ====
    259 
    260 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.
    261 
    262 == Configuring Authentication ==
    263 
    264 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:
    265 
    266  * TracStandalone if you use the standalone server, `tracd`.
    267  * TracCgi if you use the CGI or FastCGI web front ends.
    268  * [wiki:TracModWSGI] if you use the Apache mod_wsgi web front end.
    269  * TracModPython if you use the Apache mod_python web front end.
    270 
    271 
    272 == Automatic reference to the SVN changesets in Trac tickets ==
    273 
    274 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:
    275  * '''`Refs #123`''' - to reference this changeset in `#123` ticket
    276  * '''`Fixes #123`''' - to reference this changeset and close `#123` ticket with the default status ''fixed''
    277 
    278 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.
    279 {{{
    280 tracopt.ticket.commit_updater.* = enabled
    281 }}}
    282 For more information, see the documentation of the `CommitTicketUpdater` component in the "Plugins" admin panel.
    283 
    284 == Using Trac ==
     262{{{#!div style="border: 1pt dotted; margin: 1em"
     263**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.
     264
     265To be effective system-wide a shell script with the `export` statement may be added to `/etc/profile.d`.  !Ubuntu/Debian users can add the `export` statement to `/etc/apache2/envvars`. !RedHat/CentOS/Fedora users can add the `export` statement to `/etc/sysconfig/httpd`. To be effective for a user session the `export` statement may be added to `~/.profile`.
     266{{{#!sh
     267export PKG_RESOURCES_CACHE_ZIP_MANIFESTS=1
     268}}}
     269
     270Alternatively, the variable can be set in the shell before executing `tracd`:
     271{{{#!sh
     272$ PKG_RESOURCES_CACHE_ZIP_MANIFESTS=1 tracd --port 8000 /path/to/myproject
     273}}}
     274}}}
     275
     276=== Running Trac on a Web Server
     277
     278Trac provides various options for connecting to a "real" web server:
     279 - [TracFastCgi FastCGI]
     280 - [wiki:TracModWSGI mod_wsgi]
     281 - [TracModPython mod_python]
     282 - //[TracCgi CGI]: should not be used, as it degrades performance//
     283
     284Trac 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.
     285
     286==== Generating the Trac cgi-bin directory #cgi-bin
     287
     288In 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 [TracAdmin trac-admin].
     289
     290There is, however, a bit of a chicken-and-egg problem. The [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:
     291{{{#!sh
     292$ mkdir -p /usr/share/trac/projects/my-project
     293$ trac-admin /usr/share/trac/projects/my-project initenv
     294$ trac-admin /usr/share/trac/projects/my-project deploy /tmp/deploy
     295$ mv /tmp/deploy/* /usr/share/trac
     296}}}
     297
     298Don't forget to check that the web server has the execution right on scripts in the `/usr/share/trac/cgi-bin` directory.
     299
     300==== Mapping Static Resources
     301
     302Out 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''' as it causes abysmal performance.
     303
     304Web 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.
     305
     306There 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.
     307
     308Note 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:
     309[[TracAdminHelp(deploy)]]
     310
     311The target `<directory>` will then contain an `htdocs` directory with:
     312 - `site/` - a copy of the environment's directory `htdocs/`
     313 - `common/` - the static resources of Trac itself
     314 - `<plugins>/` - one directory for each resource directory managed by the plugins enabled for this environment
     315
     316===== Example: Apache and `ScriptAlias` #ScriptAlias-example
     317
     318Assuming the deployment has been done this way:
     319{{{#!sh
     320$ trac-admin /var/trac/env deploy /path/to/shared/trac
     321}}}
     322
     323Add 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:
     324{{{#!apache
     325Alias /trac/chrome/common /path/to/trac/htdocs/common
     326Alias /trac/chrome/site /path/to/trac/htdocs/site
     327
     328<Directory "/path/to/www/trac/htdocs">
     329  Order allow,deny
     330  Allow from all
     331</Directory>
     332}}}
     333
     334If using mod_python, you might want to add this too, otherwise the alias will be ignored:
     335{{{#!apache
     336<Location "/trac/chrome/common/">
     337  SetHandler None
     338</Location>
     339}}}
     340
     341Note 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.
     342
     343Similarly, 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):
     344{{{#!apache
     345Alias /trac/chrome/site /path/to/projectenv/htdocs
     346
     347<Directory "/path/to/projectenv/htdocs">
     348  Order allow,deny
     349  Allow from all
     350</Directory>
     351}}}
     352
     353Alternatively to aliasing `/trac/chrome/common`, you can tell Trac to generate direct links for those static resources (and only those), using the [[TracIni#trac-section| [trac] htdocs_location]] configuration setting:
     354{{{#!ini
     355[trac]
     356htdocs_location = http://static.example.org/trac-common/
     357}}}
     358
     359Note 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].
     360
     361Of 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:
     362{{{#!sh
     363$ ln -s /path/to/trac/htdocs/common /var/www/static.example.org/trac-common
     364}}}
     365
     366==== Setting up the Plugin Cache
     367
     368Some 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.
     369
     370== Configuring Authentication
     371
     372Trac 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.
     373
     374The process of adding, removing, and configuring user accounts for authentication depends on the specific way you run Trac.
     375
     376Please refer to one of the following sections:
     377 * TracStandalone#UsingAuthentication if you use the standalone server, `tracd`.
     378 * [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`.
     379 * TracFastCgi if you are using another web server with FCGI support, such as Cherokee, Lighttpd, !LiteSpeed, nginx.
     380
     381The following document also contains some useful information for beginners: [trac:TracAuthenticationIntroduction].
     382
     383== Granting admin rights to the admin user
     384
     385Grant admin rights to user admin:
     386{{{#!sh
     387$ trac-admin /path/to/myproject permission add admin TRAC_ADMIN
     388}}}
     389
     390This user will have an "Admin" entry menu that will allow you to administrate your Trac project.
     391
     392== Finishing the install
     393
     394=== Enable version control components
     395
     396Support 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.
     397
     398The version control systems are 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:
     399
     400{{{#!ini
     401[components]
     402tracopt.versioncontrol.svn.* = enabled
     403}}}
     404
     405{{{#!ini
     406[components]
     407tracopt.versioncontrol.git.* = enabled
     408}}}
     409
     410After enabling the components, repositories can be configured through the //Repositories// admin panel or by editing [TracIni#repositories-section trac.ini]. Automatic changeset references can be inserted as ticket comments by configuring [TracRepositoryAdmin#Automaticchangesetreferencesintickets CommitTicketUpdater].
     411
     412=== Using Trac
    285413
    286414Once 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.
    287415
    288 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.
     416Keep 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 [TracPermissions permissions] to authenticated users to see the full set of features.
    289417
    290418'' Enjoy! ''
     
    293421
    294422----
    295 See also: [trac:TracInstallPlatforms TracInstallPlatforms], TracGuide, TracCgi, TracFastCgi, TracModPython, [wiki:TracModWSGI], TracUpgrade, TracPermissions
     423See also: [trac:TracInstallPlatforms TracInstallPlatforms], TracGuide, TracUpgrade, TracPermissions