Changes between Version 1 and Version 2 of TracInstall


Ignore:
Timestamp:
2017-10-15T03:11:40-08:00 (3 months ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracInstall

    v1 v2  
    1 {{{#!div style="margin-top: .5em; padding: 0 1em; background-color: #ffd; border:1px outset #ddc; text-align: center"
    2 
    3  '''NOTE: the information in this page applies to Trac 1.0, the current version of Trac. \\
    4  For installing previous Trac versions, please refer to [[wiki:0.12/TracInstall]] (for Trac 0.12)'''
    5 }}}
    6 
    71= Trac Installation Guide for 1.0
     2
    83[[TracGuideToc]]
    94
    105Trac 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.
    116
    12 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.
    13 
    14 If you're interested in contributing new translations for other languages or enhance the existing translations, then please have a look at [trac:wiki:TracL10N TracL10N].
    15 
    16 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 [trac:TracInstallPlatforms 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.
    1712
    1813[[PageOutline(2-3,Installation Steps,inline)]]
    1914
    2015== Dependencies
     16
    2117=== Mandatory Dependencies
     18
    2219To install Trac, the following software packages must be installed:
    2320
    2421 * [http://www.python.org/ Python], version >= 2.5 and < 3.0
    2522   (note that we dropped the support for Python 2.4 in this release)
    26  * [http://peak.telecommunity.com/DevCenter/setuptools setuptools], version >= 0.6
     23 * [http://pypi.python.org/pypi/setuptools setuptools], version >= 0.6
    2724 * [http://genshi.edgewall.org/wiki/Download Genshi], version >= 0.6
    2825
    29 You also need a database system and the corresponding python bindings.
    30 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.
    3127
    3228==== For the SQLite database #ForSQLite
    3329
    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].
     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.
    5433
    5534==== For the PostgreSQL database #ForPostgreSQL
     
    6140See [trac:DatabaseBackend#Postgresql DatabaseBackend] for details.
    6241
    63 
    6442==== For the MySQL database #ForMySQL
    6543
    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
     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
    6947 * [http://sf.net/projects/mysql-python MySQLdb], version 1.2.2 or later
    7048
    71 It is '''very''' important to read carefully the [trac:MySqlDb] page before creating the database.
     49Given the caveats and known issues surrounding MySQL, read the [trac:MySqlDb] page before creating the database.
    7250
    7351=== Optional Dependencies
     
    7654
    7755===== 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.)
     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.)
    8159
    8260Note that Trac '''doesn't''' use [http://pysvn.tigris.org/ PySVN], neither does it work yet with the newer `ctype`-style bindings.
    8361
    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 
     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.
    8768
    8869===== Others
    8970
    90 Support for other version control systems is provided via third-parties. See [trac:PluginList] and [trac:VersionControlSystem].
     71Support for other version control systems is provided via third-parties. See [trac:PluginList#VersionControlSystems] and [trac:VersionControlSystem].
    9172
    9273==== 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.
     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:
    9678 * [http://httpd.apache.org/ Apache] with
    9779   - [http://code.google.com/p/modwsgi/ mod_wsgi], see [wiki:TracModWSGI] and
    9880     http://code.google.com/p/modwsgi/wiki/IntegrationWithTrac
    99    - [http://modpython.org/ mod_python 3.3.1], (deprecated: see TracModPython)
     81   - [http://modpython.org/ mod_python 3.5.0], see TracModPython
    10082 * a [http://www.fastcgi.com/ FastCGI]-capable web server (see TracFastCgi)
    10183 * an [http://tomcat.apache.org/connectors-doc/ajp/ajpv13a.html AJP]-capable web
    10284   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.
     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.
    10588   
    106 
    10789==== Other Python Packages
    10890
    109  * [http://babel.edgewall.org Babel], version >= 0.9.5,
    110    needed for localization support (unreleased version 1.0dev should work as well)
     91 * [http://babel.edgewall.org Babel], version 0.9.5, 0.9.6 or >= 1.3
     92   needed for localization support
    11193 * [http://docutils.sourceforge.net/ docutils], version >= 0.3.9
    11294   for WikiRestructuredText.
    11395 * [http://pygments.org Pygments] for
    114    [wiki:TracSyntaxColoring syntax highlighting].
     96   [TracSyntaxColoring syntax highlighting].
    11597   [http://silvercity.sourceforge.net/ SilverCity] and/or
    11698   [http://gnu.org/software/enscript/enscript.html Enscript] may still be used
     
    120102   an internal time zone implementation.
    121103
    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 
     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.
    126109
    127110== 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
    128116=== 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    }}}
     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 the latest stable version of Trac:
     123 {{{#!sh
     124$ easy_install Trac
     125}}}
    138126 - Install latest development version:
    139    {{{#!sh
    140    easy_install Trac==dev
    141    }}}
     127 {{{#!sh
     128$ easy_install http://download.edgewall.org/trac/Trac-latest-dev.tar.gz
     129}}}
    142130   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
     131   either use a released version or install from source.
     132
     133More information can be found on the [trac:wiki:setuptools setuptools] page.
    144134
    145135{{{#!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].
     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 [#DeployingTrac Deploying Trac].
    147137}}}
    148138
    149139=== Using `pip`
    150 'pip' is an easy_install replacement that is very useful to quickly install python packages.
     140
     141'pip' is an easy_install replacement that is very useful to quickly install Python packages.
    151142To get a Trac installation up and running in less than 5 minutes:
    152143
    153 Assuming you want to have your entire pip installation in `/opt/user/trac`
     144Assuming you want to have your entire pip installation in `/opt/user/trac`:
    154145
    155146 -
    156147 {{{#!sh
    157 pip install trac psycopg2
    158 }}}
    159 or
     148$ pip install trac psycopg2
     149}}}
     150or:
    160151 -
    161152 {{{#!sh
    162 pip install trac mysql-python
     153$ pip install trac mysql-python
    163154}}}
    164155
    165156Make sure your OS specific headers are available for pip to automatically build PostgreSQL (`libpq-dev`) or MySQL (`libmysqlclient-dev`) bindings.
    166157
    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 
     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.
    174163
    175164=== 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).
     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.
    179167
    180168{{{#!sh
     
    182170}}}
    183171
    184 ''You'll need root permissions or equivalent for this step.''
     172You will need root permissions or equivalent for this step.
    185173
    186174This will byte-compile the Python source code and install it as an .egg file or folder in the `site-packages` directory
    187175of your Python installation. The .egg will also contain all other resources needed by standard Trac, such as `htdocs` and `templates`.
    188176
    189 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.
    190 
    191177If 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):
    192178{{{#!sh
    193179$ python ./setup.py install
    194180}}}
     181
    195182Alternatively, 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`).
    196183
    197 === Advanced Options
     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
    198193
    199194To install Trac to a custom location, or find out about other advanced installation options, run:
    200195{{{#!sh
    201 easy_install --help
     196$ easy_install --help
    202197}}}
    203198
     
    206201Specifically, you might be interested in:
    207202{{{#!sh
    208 easy_install --prefix=/path/to/installdir
    209 }}}
     203$ easy_install --prefix=/path/to/installdir
     204}}}
     205
    210206or, if installing Trac on a Mac OS X system:
    211207{{{#!sh
    212 easy_install --prefix=/usr/local --install-dir=/Library/Python/2.5/site-packages
    213 }}}
    214 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.
     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.
    215212
    216213The 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.
    217214
    218 
    219215== Creating a Project Environment
    220216
    221 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.
    222 
    223 A new environment is created using [wiki:TracAdmin trac-admin]:
     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]:
    224220{{{#!sh
    225221$ trac-admin /path/to/myproject initenv
     
    229225
    230226Using the default database connection string in particular will always work as long as you have SQLite installed.
    231 For the other [DatabaseBackend database backends] you should plan ahead and already have a database ready to use at this point.
     227For the other [trac:DatabaseBackend database backends] you should plan ahead and already have a database ready to use at this point.
    232228
    233229Since 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.
     
    235231Also note that the values you specify here can be changed later by directly editing the [TracIni conf/trac.ini] configuration file.
    236232
    237 When selecting the location of your environment, make sure that the filesystem on which the environment directory resides supports sub-second timestamps (i.e. **not** `ext2` or `ext3` on Linux), as the modification time of the `conf/trac.ini` file will be monitored to decide whether an environment restart is needed or not. A too coarse-grained timestamp resolution may result in inconsistencies in Trac < 1.0.2 (though the best advice is to opt for a platform with sub-second timestamp resolution when possible regardless of the version of Trac you are running).
     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}}}
    238236
    239237Finally, 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:
     
    242240}}}
    243241
    244 The actual username and groupname of the apache server may not be exactly `apache`, and are specified in the Apache configuration file by the directives `User` and `Group` (if Apache `httpd` is what you use).
     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).
    245243
    246244{{{#!div class=important
     
    248246}}}
    249247
    250 
    251248== Deploying Trac
    252249
     250{{{#!div style="border: 1pt dotted; margin: 1em"
     251**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.
     252
     253If running `tracd`, 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.
     254
     255To 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`.
     256{{{#!sh
     257export PKG_RESOURCES_CACHE_ZIP_MANIFESTS=1
     258}}}
     259
     260Alternatively, the variable can be set in the shell before executing `tracd`:
     261{{{#!sh
     262$ PKG_RESOURCES_CACHE_ZIP_MANIFESTS=1 tracd --port 8000 /path/to/myproject
     263}}}
     264
     265If running the Apache web server, !Ubuntu/Debian users should add the `export` statement to `/etc/apache2/envvars`. !RedHat/CentOS/Fedora should can add the `export` statement to `/etc/sysconfig/httpd`.
     266}}}
     267
    253268=== Running the Standalone Server
    254269
    255 After having created a Trac environment, you can easily try the web interface by running the standalone server [wiki:TracStandalone tracd]:
     270After having created a Trac environment, you can easily try the web interface by running the standalone server [TracStandalone tracd]:
    256271{{{#!sh
    257272$ tracd --port 8000 /path/to/myproject
     
    263278}}}
    264279
    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 
    279280=== Running Trac on a Web Server
    280281
    281282Trac 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)//
     283 - [TracFastCgi FastCGI]
     284 - [wiki:TracModWSGI Apache with mod_wsgi]
     285 - [TracModPython Apache with mod_python]
     286 - //[TracCgi CGI]: should not be used, as it degrades performance//
    286287
    287288Trac 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.
     
    289290==== Generating the Trac cgi-bin directory #cgi-bin
    290291
    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 }}}
     292In 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].
     293
     294There 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:
     295{{{#!sh
     296$ mkdir -p /usr/share/trac/projects/my-project
     297$ trac-admin /usr/share/trac/projects/my-project initenv
     298$ trac-admin /usr/share/trac/projects/my-project deploy /tmp/deploy
     299$ mv /tmp/deploy/* /usr/share/trac
     300}}}
     301
    300302Don't forget to check that the web server has the execution right on scripts in the `/usr/share/trac/cgi-bin` directory.
    301303
    302 
    303304==== Mapping Static Resources
    304305
    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:
     306Without additional configuration, Trac will handle requests for static resources such as stylesheets and images. For anything other than a TracStandalone deployment, this is not optimal as the web server can be set up to directly serve the static resources. For CGI setup, this is '''highly undesirable''' as it causes abysmal performance.
     307
     308Web 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 their location on the file system. We can map requests for static resources directly to directories on the file system, to avoid Trac processing the requests.
     309
     310There are two primary URL paths for static resources: `/chrome/common` and `/chrome/site`. Plugins can add their own resources, usually accessible at the `/chrome/<plugin>` path.
     311
     312A single `/chrome` alias can used if the static resources are extracted for all plugins. This means that the `deploy` command must be executed after installing or updating a plugin that provides static resources, or after modifying resources in the `$env/htdocs` directory. This is probably appropriate for most installations but may not be what you want if, for example, you wish to upload plugins through the //Plugins// administration page.
     313
     314The resources are extracted using the [TracAdmin trac-admin]` <environment> deploy` command:
    312315[[TracAdminHelp(deploy)]]
    313316
    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:
     317The target `<directory>` will contain an `htdocs` directory with:
     318 - `common/` - the static resources of Trac
     319 - `site/` - a copy of the environment's `htdocs/` directory
     320 - `shared` - the static resources shared by multiple Trac environments, with a location defined by the `[inherit]` `htdocs_dir` option
     321 - `<plugin>/` - one directory for each resource directory provided by the plugins enabled for this environment
     322
     323The example that follows will create a single `/chrome` alias. If that isn't the correct approach for your installation you simply need to create more specific aliases:
    327324{{{#!apache
    328325Alias /trac/chrome/common /path/to/trac/htdocs/common
    329326Alias /trac/chrome/site /path/to/trac/htdocs/site
     327Alias /trac/chrome/shared /path/to/trac/htdocs/shared
     328Alias /trac/chrome/<plugin> /path/to/trac/htdocs/<plugin>
     329}}}
     330
     331===== Example: Apache and `ScriptAlias` #ScriptAlias-example
     332
     333Assuming the deployment has been done this way:
     334{{{#!sh
     335$ trac-admin /var/trac/env deploy /path/to/shared/trac
     336}}}
     337
     338Add the following snippet to Apache configuration, changing paths to match your deployment. The snippet must be placed ''before'' the `ScriptAlias` or `WSGIScriptAlias` directive, because those directives map all requests to the Trac application:
     339{{{#!apache
     340Alias /trac/chrome /path/to/trac/htdocs
    330341
    331342<Directory "/path/to/www/trac/htdocs">
    332   Order allow,deny
    333   Allow from all
     343  # For Apache 2.2
     344  <IfModule !mod_authz_core.c>
     345    Order allow,deny
     346    Allow from all
     347  </IfModule>
     348  # For Apache 2.4
     349  <IfModule mod_authz_core.c>
     350    Require all granted
     351  </IfModule>
    334352</Directory>
    335353}}}
    336354
    337 If using mod_python, you might want to add this too (otherwise, the alias will be ignored):
     355If using mod_python, add this too, otherwise the alias will be ignored:
    338356{{{#!apache
    339 <Location "/trac/chrome/common/">
     357<Location "/trac/chrome/common">
    340358  SetHandler None
    341359</Location>
    342360}}}
    343361
    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):
     362Alternatively, if you wish to serve static resources directly from your project's `htdocs` directory rather than the location to which the files are extracted with the `deploy` command, 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:
    347363{{{#!apache
    348364Alias /trac/chrome/site /path/to/projectenv/htdocs
    349365
    350366<Directory "/path/to/projectenv/htdocs">
    351   Order allow,deny
    352   Allow from all
     367  # For Apache 2.2
     368  <IfModule !mod_authz_core.c>
     369    Order allow,deny
     370    Allow from all
     371  </IfModule>
     372  # For Apache 2.4
     373  <IfModule mod_authz_core.c>
     374    Require all granted
     375  </IfModule>
    353376</Directory>
    354377}}}
    355378
    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:
     379Another alternative to aliasing `/trac/chrome/common` is having Trac generate direct links for those static resources (and only those), using the [[TracIni#trac-section| [trac] htdocs_location]] configuration setting:
    357380{{{#!ini
    358381[trac]
    359382htdocs_location = http://static.example.org/trac-common/
    360383}}}
    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]).
     384
     385Note that this makes it easy to have a dedicated domain serve those static resources, preferentially cookie-less.
    362386
    363387Of 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:
     
    365389$ ln -s /path/to/trac/htdocs/common /var/www/static.example.org/trac-common
    366390}}}
    367 
    368391
    369392==== Setting up the Plugin Cache
     
    380403 * TracStandalone#UsingAuthentication if you use the standalone server, `tracd`.
    381404 * [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].
     405 * TracFastCgi if you are using another web server with FCGI support, such as Cherokee, Lighttpd, !LiteSpeed, nginx.
     406
     407The following document also contains some useful information for beginners: [trac:TracAuthenticationIntroduction].
    385408
    386409== Granting admin rights to the admin user
     410
    387411Grant admin rights to user admin:
    388412{{{#!sh
    389413$ trac-admin /path/to/myproject permission add admin TRAC_ADMIN
    390414}}}
     415
    391416This user will have an "Admin" entry menu that will allow you to administrate your Trac project.
    392417
     
    397422Support 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.
    398423
    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.
     424The 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:
    400425
    401426{{{#!ini
     427[components]
    402428tracopt.versioncontrol.svn.* = enabled
    403429}}}
    404430
    405431{{{#!ini
     432[components]
    406433tracopt.versioncontrol.git.* = enabled
    407434}}}
    408435
    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.
     436After 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].
    422437
    423438=== Using Trac
     
    425440Once 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.
    426441
    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.
     442Keep 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.
    428443
    429444'' Enjoy! ''