Changes between Version 3 and Version 4 of TracInstall


Ignore:
Timestamp:
2024-11-18T21:51:26Z (6 days ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracInstall

    v3 v4  
    1 = Trac Installation Guide for 1.0
    2 
     1= Trac Installation Guide for 1.5
    32[[TracGuideToc]]
    43
    5 Trac 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.
    6 
    7 Since 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 
    9 If 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 
    11 What 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.
     4Trac is written in the Python programming language and needs a database, [https://sqlite.org/ SQLite], [https://www.postgresql.org/ PostgreSQL], or [https://mysql.com/ MySQL]. For HTML rendering, Trac uses the [http://jinja.pocoo.org Jinja2] templating system, though Genshi templates are supported until Trac 1.5.1.
     5
     6Trac 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 enhancing the existing translations, 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], please '''first read through these general instructions''' to get a good understanding of the tasks involved.
    1211
    1312[[PageOutline(2-3,Installation Steps,inline)]]
    1413
    1514== Dependencies
    16 
    1715=== Mandatory Dependencies
    18 
    1916To install Trac, the following software packages must be installed:
    2017
    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
    24  * [http://genshi.edgewall.org/wiki/Download Genshi], version >= 0.6
     18 * [https://www.python.org/ Python], version >= 3.5
     19 * [https://pypi.org/project/setuptools setuptools], version > 5.6
     20 * [https://pypi.org/project/Jinja2 Jinja2], version >= 2.9.3
    2521
    2622You also need a database system and the corresponding python bindings. The database can be either SQLite, PostgreSQL or MySQL.
     
    2824==== For the SQLite database #ForSQLite
    2925
    30 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.
    31 
    32 Optionally, 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.
     26You already have the SQLite database bindings bundled with the standard distribution of Python (the `sqlite3` module).
     27
     28Optionally, you may install a newer version of [https://pypi.org/project/pysqlite pysqlite] than the one provided by the Python distribution. See [trac:PySqlite#ThePysqlite2bindings PySqlite] for details.
    3329
    3430==== For the PostgreSQL database #ForPostgreSQL
    3531
    3632You need to install the database and its Python bindings:
    37  * [http://www.postgresql.org/ PostgreSQL], version 8.0 or later
    38  * [http://pypi.python.org/pypi/psycopg2 psycopg2], version 2.0 or later
     33 * [https://www.postgresql.org/ PostgreSQL], version 9.1 or later
     34 * [https://pypi.org/project/psycopg2 psycopg2], version 2.5 or later
    3935
    4036See [trac:DatabaseBackend#Postgresql DatabaseBackend] for details.
     
    4238==== For the MySQL database #ForMySQL
    4339
    44 Trac 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
    47  * [http://sf.net/projects/mysql-python MySQLdb], version 1.2.2 or later
    48 
    49 Given the caveats and known issues surrounding MySQL, read the [trac:MySqlDb] page before creating the database.
     40Trac works well with MySQL, provided you use the following:
     41
     42 * [https://mysql.com/ MySQL], version 5.0 or later
     43 * [https://pypi.org/project/PyMySQL PyMySQL]
     44
     45Given the caveats and known issues surrounding MySQL, read carefully the [trac:MySqlDb] page before creating the database.
    5046
    5147=== Optional Dependencies
    5248
    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 
    58 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. [trac:TracSubversion] points you to [http://alagazam.net Alagazam], which works for me under Python 2.6.)
    59 
    60 Note 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 
    67 More information is available on the [trac:TracGit] page.
    68 
    69 ===== Others
    70 
    71 Support for other version control systems is provided via third-parties. See [trac:PluginList#VersionControlSystems] and [trac:VersionControlSystem].
     49==== Subversion
     50
     51[https://subversion.apache.org/ Subversion], 1.14.x or later and the '''''corresponding''''' Python bindings.
     52
     53There are [https://subversion.apache.org/packages.html pre-compiled SWIG bindings] available for various platforms. See [trac:TracSubversion#GettingSubversion getting Subversion] for more information.
     54
     55{{{#!div style="border: 1pt dotted; margin: 1em"
     56**Note:**
     57* Trac '''doesn't''' use [http://pysvn.tigris.org/ PySVN], nor does it work yet with the newer `ctype`-style bindings.
     58* If using Subversion, Trac must be installed on the '''same machine'''. Remote repositories are [trac:ticket:493 not supported].
     59}}}
     60
     61For troubleshooting information, see the [trac:TracSubversion#Troubleshooting TracSubversion] page.
     62
     63==== Git
     64
     65[https://git-scm.com/ Git] 1.5.6 or later is supported. More information is available on the [trac:TracGit] page.
     66
     67==== Other Version Control Systems
     68
     69Support for other version control systems is provided via third-party plugins. See [trac:PluginList#VersionControlSystems] and [trac:VersionControlSystem].
    7270
    7371==== Web Server
    74 
    75 A web server is optional because Trac has a server included, see the [#RunningtheStandaloneServer Running the Standalone Server] section below.
     72A web server is optional because Trac is shipped with a server included, see the [#RunningtheStandaloneServer Running the Standalone Server] section below.
    7673
    7774Alternatively you can configure Trac to run in any of the following environments:
    78  * [http://httpd.apache.org/ Apache] with
    79    - [http://code.google.com/p/modwsgi/ mod_wsgi], see [wiki:TracModWSGI] and
    80      http://code.google.com/p/modwsgi/wiki/IntegrationWithTrac
     75 * [https://httpd.apache.org/ Apache] with
     76   - [https://github.com/GrahamDumpleton/mod_wsgi mod_wsgi], see [wiki:TracModWSGI] and
     77     [https://code.google.com/p/modwsgi/wiki/IntegrationWithTrac ModWSGI IntegrationWithTrac].
    8178   - [http://modpython.org/ mod_python 3.5.0], see TracModPython
    82  * a [http://www.fastcgi.com/ FastCGI]-capable web server (see TracFastCgi)
    83  * an [http://tomcat.apache.org/connectors-doc/ajp/ajpv13a.html AJP]-capable web
     79 * a [https://fastcgi-archives.github.io FastCGI]-capable web server (see TracFastCgi)
     80 * an [https://tomcat.apache.org/connectors-doc/ajp/ajpv13a.html AJP]-capable web
    8481   server (see [trac:TracOnWindowsIisAjp TracOnWindowsIisAjp])
    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.
    88    
     82 * Microsoft IIS with FastCGI and a FastCGI-to-WSGI gateway (see [trac:CookBook/Installation/TracOnWindowsIisWfastcgi IIS with FastCGI])
     83 * a CGI-capable web server (see TracCgi), '''but usage of Trac as a cgi script
     84   is highly discouraged''', better use one of the previous options.
     85
     86
    8987==== Other Python Packages
    9088
    91  * [http://babel.edgewall.org Babel], version 0.9.5, 0.9.6 or >= 1.3
     89 * [http://babel.pocoo.org Babel], version >= 2.2,
    9290   needed for localization support
    93  * [http://docutils.sourceforge.net/ docutils], version >= 0.3.9
    94    for WikiRestructuredText.
    95  * [http://pygments.org Pygments] for
    96    [TracSyntaxColoring syntax highlighting].
    97    [http://silvercity.sourceforge.net/ SilverCity] and/or
    98    [http://gnu.org/software/enscript/enscript.html Enscript] may still be used
    99    but are deprecated and you really should be using Pygments.
    100  * [http://pytz.sf.net pytz] to get a complete list of time zones,
    101    otherwise Trac will fall back on a shorter list from
    102    an internal time zone implementation.
     91 * [http://pytz.sourceforge.net pytz] to get a complete list of time zones,
     92   otherwise Trac will fall back on a shorter list from
     93   an internal time zone implementation. Installing Babel
     94   will install pytz.
     95 * [http://docutils.sourceforge.net docutils],
     96   version >= 0.14, for WikiRestructuredText.
     97 * [http://pygments.org Pygments], version >= 1.0,
     98   for [TracSyntaxColoring syntax highlighting].
     99 * [https://pypi.org/project/textile Textile],
     100   version >= 2.3,
     101   for rendering the [https://github.com/textile/python-textile Textile markup language].
     102 * [https://pypi.org/project/passlib passlib] on Windows to decode [TracStandalone#BasicAuthorization:Usingahtpasswdpasswordfile htpasswd formats] other than `SHA-1`.
     103 * [https://pypi.org/project/pyreadline pyreadline] on Windows for trac-admin [TracAdmin#InteractiveMode command completion].
    103104
    104105{{{#!div style="border: 1pt dotted; margin: 1em"
     
    106107}}}
    107108
    108 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.
     109Please 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''.
    109110
    110111== Installing Trac
     
    112113The [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.
    113114
    114 It 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 
    116 === Using `easy_install`
    117 
    118 Trac can be installed from [https://pypi.python.org/pypi/Trac PyPI] or the Subversion repository using [http://pypi.python.org/pypi/setuptools setuptools].
    119 
    120 A 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 }}}
    130    Note that in this case you won't have the possibility to run a localized version of Trac;
    131    either use a released version or install from source.
    132 
    133 More 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 }}}
     115It is assumed throughout this guide that you have elevated permissions as the `root` user or by prefixing commands with `sudo`. The umask `0002` should be used for a typical installation on a Unix-based platform.
    138116
    139117=== Using `pip`
    140 
    141 'pip' is an easy_install replacement that is very useful to quickly install Python packages.
    142 To get a Trac installation up and running in less than 5 minutes:
    143 
    144 Assuming you want to have your entire pip installation in `/opt/user/trac`:
    145 
    146  -
    147  {{{#!sh
    148 $ pip install trac psycopg2
    149 }}}
    150 or:
    151  -
    152  {{{#!sh
    153 $ pip install trac mysql-python
    154 }}}
    155 
    156 Make sure your OS specific headers are available for pip to automatically build PostgreSQL (`libpq-dev`) or MySQL (`libmysqlclient-dev`) bindings.
    157 
    158 pip 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 
    160 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).
    161 
    162 Additionally, you can install several Trac plugins (listed [https://pypi.python.org/pypi?:action=browse&show=all&c=516 here]) through pip.
    163 
    164 === From source
    165 
    166 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`) 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
    169 $ python ./setup.py install
    170 }}}
    171 
    172 You will need root permissions or equivalent for this step.
    173 
    174 This will byte-compile the Python source code and install it as an .egg file or folder in the `site-packages` directory
    175 of your Python installation. The .egg will also contain all other resources needed by standard Trac, such as `htdocs` and `templates`.
    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 {{{#!sh
    179 $ python ./setup.py install
    180 }}}
    181 
    182 Alternatively, 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`).
     118`pip` is the modern Python package manager and is included in Python distributions. `pip` will automatically
     119resolve the //required// dependencies (Jinja2 and
     120setuptools) and download the latest packages from pypi.org.
     121
     122You can also install directly from a source package. You can obtain the source in a tar or zip from the [trac:TracDownload] page. After extracting the archive, change to the directory containing `setup.py` and run:
     123
     124{{{#!sh
     125$ pip install .
     126}}}
     127
     128`pip` supports numerous other install mechanisms. It can be passed the URL of an archive or other download location. Here are some examples:
     129
     130* Install the latest stable version from a zip archive:
     131{{{#!sh
     132$ pip install https://download.edgewall.org/trac/Trac-latest.zip
     133}}}
     134* Install the latest development version from a tar archive:
     135{{{#!sh
     136$ pip install https://download.edgewall.org/trac/Trac-latest-dev.tar.gz
     137}}}
     138* Install the unreleased 1.4-stable from subversion:
     139{{{#!sh
     140$ pip install svn+https://svn.edgewall.org/repos/trac/branches/1.2-stable
     141}}}
     142* Install the latest development preview (//not recommended for production installs//):
     143{{{#!sh
     144$ pip install --find-links=https://trac.edgewall.org/wiki/TracDownload Trac
     145}}}
     146
     147The optional dependencies can be installed from PyPI using `pip`:
     148{{{#!sh
     149$ pip install babel docutils pygments textile
     150}}}
     151
     152The optional dependencies can alternatively be
     153specified using the `extras` keys in the setup file:
     154{{{#!sh
     155$ pip install Trac[babel,rest,pygments,textile]
     156}}}
     157
     158`rest` is the extra that installs the `docutils`
     159dependency.
     160
     161Include `mysql` or `psycopg2-binary` in the
     162list if using the MySQL or PostgreSQL database.
     163
     164Additionally, you can install several Trac plugins from PyPI (listed [https://pypi.org/search/?c=Framework+%3A%3A+Trac here]) using pip. See TracPlugins for more information.
    183165
    184166=== Using installer
    185167
    186 On 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.
     168On Windows, Trac can be installed using the exe installers available on the [trac:TracDownload] page. Installers are available for the 32-bit and 64-bit versions of Python. Make sure to use the installer that matches the architecture of your Python installation.
    187169
    188170=== Using package manager
    189171
    190 Trac 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
    193 
    194 To install Trac to a custom location, or find out about other advanced installation options, run:
    195 {{{#!sh
    196 $ easy_install --help
    197 }}}
    198 
    199 Also see [http://docs.python.org/2/install/index.html Installing Python Modules] for detailed information.
    200 
    201 Specifically, you might be interested in:
    202 {{{#!sh
    203 $ easy_install --prefix=/path/to/installdir
    204 }}}
    205 
    206 or, 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.
    212 
    213 The 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.
     172Trac may be available in your platform's package repository. However, your package manager may not provide the latest release of Trac.
    214173
    215174== Creating a Project Environment
    216175
    217 A [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.
     176A [TracEnvironment Trac environment] is the backend where Trac stores information like wiki pages, tickets, reports, settings, etc. An environment is a directory that contains a human-readable [TracIni configuration file], and other files and directories.
    218177
    219178A new environment is created using [TracAdmin trac-admin]:
     
    222181}}}
    223182
    224 [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.
    225 
    226 Using the default database connection string in particular will always work as long as you have SQLite installed.
    227 For the other [trac:DatabaseBackend database backends] you should plan ahead and already have a database ready to use at this point.
    228 
    229 Since 0.12, Trac doesn't ask for a [TracEnvironment#SourceCodeRepository source code repository] anymore when creating an environment. Repositories can be [TracRepositoryAdmin added] afterwards, and support for specific version control systems is disabled by default.
    230 
    231 Also note that the values you specify here can be changed later by directly editing the [TracIni conf/trac.ini] configuration file.
    232 
    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 }}}
     183[TracAdmin trac-admin] will prompt you for the information it needs to create the environment: the name of the project and the [TracEnvironment#DatabaseConnectionStrings database connection string]. If you're not sure what to specify for any of these options, just press `<Enter>` to use the default value.
     184
     185Using the default database connection string will always work as long as you have SQLite installed. For the other [trac:DatabaseBackend database backends] you should plan ahead and already have a database ready to use at this point.
     186
     187Also note that the values you specify here can be changed later using TracAdmin or directly editing the [TracIni conf/trac.ini] configuration file.
    236188
    237189Finally, 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:
    238190{{{#!sh
    239 $ chown -R apache.apache /path/to/myproject
    240 }}}
    241 
    242 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).
     191$ chown -R apache:apache /path/to/myproject
     192}}}
     193
     194The 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).
    243195
    244196{{{#!div class=important
     
    255207}}}
    256208
    257 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:
     209Then, open 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:
    258210{{{#!sh
    259211$ tracd -s --port 8000 /path/to/myproject
    260212}}}
    261213
    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 
    265 To 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
    267 export PKG_RESOURCES_CACHE_ZIP_MANIFESTS=1
    268 }}}
    269 
    270 Alternatively, 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 
    276214=== Running Trac on a Web Server
    277215
    278 Trac provides various options for connecting to a "real" web server: 
     216Trac provides various options for connecting to a "real" web server:
    279217 - [TracFastCgi FastCGI]
    280  - [wiki:TracModWSGI mod_wsgi]
    281  - [TracModPython mod_python]
    282  - //[TracCgi CGI]: should not be used, as it degrades performance//
    283 
    284 Trac also supports [trac:TracOnWindowsIisAjp AJP] which may be your choice if you want to connect to IIS. Other deployment scenarios are possible: [trac:TracNginxRecipe nginx], [http://projects.unbit.it/uwsgi/wiki/Example#Traconapacheinasub-uri uwsgi], [trac:TracOnWindowsIisIsapi Isapi-wsgi] etc.
     218 - [wiki:TracModWSGI Apache with mod_wsgi]
     219 - [TracModPython Apache with mod_python]
     220 - [TracCgi CGI] //(should not be used, as the performance is far from optimal)//
     221
     222Trac 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], [https://uwsgi-docs.readthedocs.io/en/latest/#Traconapacheinasub-uri uwsgi], [trac:TracOnWindowsIisIsapi Isapi-wsgi] etc.
    285223
    286224==== Generating the Trac cgi-bin directory #cgi-bin
    287225
    288 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 [TracAdmin trac-admin].
    289 
    290 There 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 
    298 Don't forget to check that the web server has the execution right on scripts in the `/usr/share/trac/cgi-bin` directory.
     226Application scripts for CGI, FastCGI and mod-wsgi can be generated using the [TracAdmin trac-admin] `deploy` command:
     227[[TracAdminHelp(deploy)]]
     228
     229Grant the web server execution right on scripts in the `cgi-bin` directory.
     230
     231For example, the following yields a typical directory structure:
     232{{{#!sh
     233$ mkdir -p /var/trac
     234$ trac-admin /var/trac/<project> initenv
     235$ trac-admin /var/trac/<project> deploy /var/www
     236$ ls /var/www
     237cgi-bin htdocs
     238$ chmod ugo+x /var/www/cgi-bin/*
     239}}}
    299240
    300241==== Mapping Static Resources
    301242
    302 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''' as it causes abysmal performance.
    303 
    304 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.
    305 
    306 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.
    307 
    308 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:
    309 [[TracAdminHelp(deploy)]]
    310 
    311 The 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 
    318 Assuming the deployment has been done this way:
    319 {{{#!sh
    320 $ trac-admin /var/trac/env deploy /path/to/shared/trac
    321 }}}
    322 
    323 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:
     243Without 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.
     244
     245Web servers such as [https://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.
     246
     247There 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.
     248
     249A single `/chrome` alias can used if the static resources are extracted for all plugins. This means that the `deploy` command (discussed in the previous section) 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.
     250
     251The `deploy` command creates an `htdocs` directory with:
     252 - `common/` - the static resources of Trac
     253 - `site/` - a copy of the environment's `htdocs/` directory
     254 - `shared` - the static resources shared by multiple Trac environments, with a location defined by the `[inherit]` `htdocs_dir` option
     255 - `<plugin>/` - one directory for each resource directory provided by the plugins enabled for this environment
     256
     257The 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:
    324258{{{#!apache
    325259Alias /trac/chrome/common /path/to/trac/htdocs/common
    326260Alias /trac/chrome/site /path/to/trac/htdocs/site
     261Alias /trac/chrome/shared /path/to/trac/htdocs/shared
     262Alias /trac/chrome/<plugin> /path/to/trac/htdocs/<plugin>
     263}}}
     264
     265===== Example: Apache and `ScriptAlias` #ScriptAlias-example
     266
     267Assuming the deployment has been done this way:
     268{{{#!sh
     269$ trac-admin /var/trac/<project> deploy /var/www
     270}}}
     271
     272Add 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:
     273{{{#!apache
     274Alias /trac/chrome /path/to/trac/htdocs
    327275
    328276<Directory "/path/to/www/trac/htdocs">
    329   Order allow,deny
    330   Allow from all
     277  # For Apache 2.2
     278  <IfModule !mod_authz_core.c>
     279    Order allow,deny
     280    Allow from all
     281  </IfModule>
     282  # For Apache 2.4
     283  <IfModule mod_authz_core.c>
     284    Require all granted
     285  </IfModule>
    331286</Directory>
    332287}}}
    333288
    334 If using mod_python, you might want to add this too, otherwise the alias will be ignored:
     289If using mod_python, add this too, otherwise the alias will be ignored:
    335290{{{#!apache
    336 <Location "/trac/chrome/common/">
     291<Location "/trac/chrome/common">
    337292  SetHandler None
    338293</Location>
    339294}}}
    340295
    341 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.
    342 
    343 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):
     296Alternatively, 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:
    344297{{{#!apache
    345298Alias /trac/chrome/site /path/to/projectenv/htdocs
    346299
    347300<Directory "/path/to/projectenv/htdocs">
    348   Order allow,deny
    349   Allow from all
     301  # For Apache 2.2
     302  <IfModule !mod_authz_core.c>
     303    Order allow,deny
     304    Allow from all
     305  </IfModule>
     306  # For Apache 2.4
     307  <IfModule mod_authz_core.c>
     308    Require all granted
     309  </IfModule>
    350310</Directory>
    351311}}}
    352312
    353 Alternatively 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:
     313Another alternative to aliasing `/trac/chrome/common` is having Trac generate direct links for those static resources (and only those), using the [TracIni#trac-htdocs_location-option trac.htdocs_location] configuration setting:
    354314{{{#!ini
    355315[trac]
     
    357317}}}
    358318
    359 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].
     319Note that this makes it easy to have a dedicated domain serve those static resources, preferentially cookie-less.
    360320
    361321Of 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:
     
    372332Trac 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.
    373333
    374 The process of adding, removing, and configuring user accounts for authentication depends on the specific way you run Trac. 
     334The process of adding, removing, and configuring user accounts for authentication depends on the specific way you run Trac.
    375335
    376336Please refer to one of the following sections:
    377337 * 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 
    381 The following document also contains some useful information for beginners: [trac:TracAuthenticationIntroduction].
     338 * [wiki:TracModWSGI#ConfiguringAuthentication TracModWSGI#ConfiguringAuthentication] if you use the Apache web server, with any of its front end: `mod_wsgi`, `mod_python`, `mod_fcgi` or `mod_fastcgi`.
     339 * TracFastCgi if you're using another web server with FCGI support (Cherokee, Lighttpd, !LiteSpeed, nginx)
     340
     341[trac:TracAuthenticationIntroduction] also contains some useful information for beginners.
    382342
    383343== Granting admin rights to the admin user
    384 
    385344Grant admin rights to user admin:
    386345{{{#!sh
     
    388347}}}
    389348
    390 This 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 
    396 Support for version control systems is provided by optional components in Trac and the components are disabled by default //(since 1.0)//. Subversion and Git must be explicitly enabled if you wish to use them. See TracRepositoryAdmin for more details.
    397 
    398 The 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]
    402 tracopt.versioncontrol.svn.* = enabled
    403 }}}
    404 
    405 {{{#!ini
    406 [components]
    407 tracopt.versioncontrol.git.* = enabled
    408 }}}
    409 
    410 After 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
     349This user will have an //Admin// navigation item that directs to pages for administering your Trac project.
     350
     351== Configuring Trac
     352
     353Configuration options are documented on the TracIni page.
     354
     355TracRepositoryAdmin provides information on configuring version control repositories for your project.
     356
     357In addition to the optional version control backends, Trac provides several optional features that are disabled by default:
     358* [TracFineGrainedPermissions#AuthzPolicy Fine-grained permission policy]
     359* [TracPermissions#CreatingNewPrivileges Custom permissions]
     360* [TracTickets#deleter Ticket deletion]
     361* [TracTickets#cloner Ticket cloning]
     362* [TracRepositoryAdmin#CommitTicketUpdater Ticket changeset references]
     363
     364== Using Trac
    413365
    414366Once 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.
     
    421373
    422374----
    423 See also: [trac:TracInstallPlatforms TracInstallPlatforms], TracGuide, TracUpgrade, TracPermissions
     375See also: [trac:TracInstallPlatforms TracInstallPlatforms], TracGuide, TracUpgrade