Changes between Version 5 and Version 6 of TracInstall


Ignore:
Timestamp:
2021-04-21T12:44:16+02:00 (4 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracInstall

    v5 v6  
    1 = Trac Installation Guide for 1.0
    2 
     1= Trac Installation Guide for 1.2
    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.
     4Trac is written in the Python programming language and needs a database, [https://sqlite.org/ SQLite], [https://www.postgresql.org/ PostgreSQL], or [https://www.mysql.com/ MySQL]. For HTML rendering, Trac uses the [https://genshi.edgewall.org/ Genshi] templating system.
     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.
    87
    98If 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].
    109
    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.
     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 >= 2.6 and < 3.0
     19   (note that we dropped the support for Python 2.5 in this release)
     20 * [https://pypi.org/project/setuptools setuptools], version >= 0.6
     21 * [https://pypi.org/project/Genshi Genshi], version >= 0.6
    2522
    2623You also need a database system and the corresponding python bindings. The database can be either SQLite, PostgreSQL or MySQL.
     
    2825==== For the SQLite database #ForSQLite
    2926
    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 [pypi:pysqlite pysqlite] than the one provided by the Python distribution. See [trac:PySqlite#ThePysqlite2bindings PySqlite] for details.
     27As you must be using Python 2.6 or 2.7, you already have the SQLite database bindings bundled with the standard distribution of Python (the `sqlite3` module).
     28
     29Optionally, 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.
    3330
    3431==== For the PostgreSQL database #ForPostgreSQL
    3532
    3633You 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
     34 * [https://www.postgresql.org/ PostgreSQL], version 8.0 or later
     35 * [https://pypi.org/project/psycopg2 psycopg2], version 2.0 or later
    3936
    4037See [trac:DatabaseBackend#Postgresql DatabaseBackend] for details.
     
    4441Trac works well with MySQL, provided you follow the guidelines:
    4542
    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.
     43 * [https://www.mysql.com/ MySQL], version 5.0 or later
     44 * [https://sf.net/projects/mysql-python MySQLdb], version 1.2.2 or later
     45
     46Given the caveats and known issues surrounding MySQL, read carefully the [trac:MySqlDb] page before creating the database.
    5047
    5148=== Optional Dependencies
    5249
    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].
     50==== Subversion
     51
     52[https://subversion.apache.org/ Subversion], 1.6.x or later and the '''''corresponding''''' Python bindings.
     53
     54There are [https://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 [https://alagazam.net Alagazam], which works for me under Python 2.6.)
     55
     56For troubleshooting information, see the [trac:TracSubversion#Troubleshooting TracSubversion] page.
     57
     58{{{#!div style="border: 1pt dotted; margin: 1em"
     59**Note:**
     60* Trac '''doesn't''' use [http://pysvn.tigris.org/ PySVN], nor does it work yet with the newer `ctype`-style bindings.
     61* If using Subversion, Trac must be installed on the '''same machine'''. Remote repositories are currently [trac:ticket:493 not supported].
     62}}}
     63
     64==== Git
     65
     66[https://git-scm.com/ Git] 1.5.6 or later is supported. More information is available on the [trac:TracGit] page.
     67
     68==== Other Version Control Systems
     69
     70Support for other version control systems is provided via third-party plugins. See [trac:PluginList#VersionControlSystems] and [trac:VersionControlSystem].
    7271
    7372==== Web Server
    74 
    75 A web server is optional because Trac has a server included, see the [#RunningtheStandaloneServer Running the Standalone Server] section below.
     73A web server is optional because Trac is shipped with a server included, see the [#RunningtheStandaloneServer Running the Standalone Server] section below.
    7674
    7775Alternatively 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
    81    - [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
     76 * [https://httpd.apache.org/ Apache] with
     77  * [https://github.com/GrahamDumpleton/mod_wsgi mod_wsgi], see [wiki:TracModWSGI] and [https://code.google.com/p/modwsgi/wiki/IntegrationWithTrac ModWSGI IntegrationWithTrac].
     78  * [http://modpython.org/ mod_python 3.5.0], see TracModPython
     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.
     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.
    8885   
     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.edgewall.org Babel], version 0.9.6 or >= 1.3,
    9290   needed for localization support
    9391 * [http://docutils.sourceforge.net/ docutils], version >= 0.3.9
     
    9593 * [http://pygments.org Pygments] for
    9694   [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.
    10095 * [http://pytz.sf.net pytz] to get a complete list of time zones,
    10196   otherwise Trac will fall back on a shorter list from
     
    106101}}}
    107102
    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.
     103Please 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''.
    109104
    110105== Installing Trac
     
    112107The [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.
    113108
     109It 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.
     110
    114111=== Using `easy_install`
    115 
    116 Trac can be installed from [https://pypi.python.org/pypi/Trac PyPI] or the Subversion repository using [pypi:setuptools setuptools].
    117 
    118 A few command-line examples:
    119 
    120  - Install Trac 1.0:
     112Trac can be installed from PyPI or the Subversion repository using [https://pypi.org/project/setuptools setuptools].
     113
     114A few examples:
     115
     116 - Install the latest stable version of Trac:
    121117 {{{#!sh
    122 $ easy_install Trac==1.0
     118$ easy_install Trac
    123119}}}
    124120 - Install latest development version:
    125121 {{{#!sh
    126 $ easy_install Trac==dev
     122$ easy_install https://download.edgewall.org/trac/Trac-latest-dev.tar.gz
    127123}}}
    128124   Note that in this case you won't have the possibility to run a localized version of Trac;
    129    either use a released version or install from source.
    130 
    131 More information can be found on the [trac:setuptools] page.
    132 
    133 {{{#!div style="border: 1pt dotted; margin: 1em"
    134 **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].
     125   either use a released version or install from source 
     126
     127More information can be found on the [trac:wiki:setuptools setuptools] page.
     128
     129{{{#!div style="border: 1pt dotted; margin: 1em"
     130**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].
    135131}}}
    136132
    137133=== Using `pip`
    138 
    139 'pip' is an easy_install replacement that is very useful to quickly install Python packages.
     134'pip' is an easy_install replacement that is very useful to quickly install python packages.
    140135To get a Trac installation up and running in less than 5 minutes:
    141136
    142 Assuming you want to have your entire pip installation in `/opt/user/trac`:
    143 
    144  -
     137Assuming you want to have your entire pip installation in `/opt/user/trac`
     138
    145139 {{{#!sh
    146140$ pip install trac psycopg2
    147141}}}
    148 or:
    149  -
     142or
    150143 {{{#!sh
    151144$ pip install trac mysql-python
     
    156149pip 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`.
    157150
    158 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).
     151All commands (`tracd`, `trac-admin`) are available in `/opt/user/trac/bin`. This can also be leveraged for `mod_python` (using `PythonHandler` directive) and `mod_wsgi` (using `WSGIDaemonProcess` directive)
    159152
    160153Additionally, you can install several Trac plugins (listed [https://pypi.python.org/pypi?:action=browse&show=all&c=516 here]) through pip.
    161154
    162155=== From source
    163 
    164156Using 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.
    165157
     
    168160}}}
    169161
    170 You will need root permissions or equivalent for this step.
     162''You will need root permissions or equivalent for this step.''
    171163
    172164This will byte-compile the Python source code and install it as an .egg file or folder in the `site-packages` directory
     
    177169$ python ./setup.py install
    178170}}}
    179 
    180171Alternatively, 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`).
    181172
    182173=== Using installer
    183174
    184 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.
     175On 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.
    185176
    186177=== Using package manager
    187178
    188 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.
     179Trac may be available in your platform's package repository. Note however, that the version provided by your package manager may not be the latest release.
    189180
    190181=== Advanced `easy_install` Options
     
    195186}}}
    196187
    197 Also see [http://docs.python.org/2/install/index.html Installing Python Modules] for detailed information.
     188Also see [https://docs.python.org/2/install/index.html Installing Python Modules] for detailed information.
    198189
    199190Specifically, you might be interested in:
     
    201192$ easy_install --prefix=/path/to/installdir
    202193}}}
    203 
    204194or, if installing Trac on a Mac OS X system:
    205195{{{#!sh
    206 $ easy_install --prefix=/usr/local --install-dir=/Library/Python/2.5/site-packages
    207 }}}
    208 
    209 '''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.
    210 
    211 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.
     196$ easy_install --prefix=/usr/local --install-dir=/Library/Python/2.6/site-packages
     197}}}
     198
     199{{{#!div style="border: 1pt dotted; margin: 1em"
     200**Mac OS X Note:** On Mac OS X 10.6,  running `easy_install trac` will install into `/usr/local` and `/Library/Python/2.6/site-packages` by default.
     201
     202The `tracd` and `trac-admin` commands will be placed in `/usr/local/bin` and will install the Trac libraries and dependencies into `/Library/Python/2.6/site-packages`, which is Apple's preferred location for third-party Python application installations.
     203}}}
    212204
    213205== Creating a Project Environment
    214206
    215 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.
     207A [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.
    216208
    217209A new environment is created using [TracAdmin trac-admin]:
     
    220212}}}
    221213
    222 [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.
    223 
    224 Using the default database connection string in particular will always work as long as you have SQLite installed.
    225 For the other [trac:DatabaseBackend database backends] you should plan ahead and already have a database ready to use at this point.
    226 
    227 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.
    228 
    229 Also note that the values you specify here can be changed later by directly editing the [TracIni conf/trac.ini] configuration file.
     214You will be prompted for the information needed 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.
     215
     216Using 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.
     217
     218Also note that the values you specify here can be changed later using TracAdmin or directly editing the [TracIni conf/trac.ini] configuration file.
    230219
    231220{{{#!div style="border: 1pt dotted; margin: 1em"
     
    235224Finally, 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:
    236225{{{#!sh
    237 $ chown -R apache.apache /path/to/myproject
    238 }}}
    239 
    240 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).
     226$ chown -R apache:apache /path/to/myproject
     227}}}
     228
     229The 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).
    241230
    242231{{{#!div class=important
     
    246235== Deploying Trac
    247236
     237{{{#!div style="border: 1pt dotted; margin: 1em"
     238**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.
     239
     240If 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.
     241
     242To 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`.
     243{{{#!sh
     244export PKG_RESOURCES_CACHE_ZIP_MANIFESTS=1
     245}}}
     246
     247Alternatively, the variable can be set in the shell before executing `tracd`:
     248{{{#!sh
     249$ PKG_RESOURCES_CACHE_ZIP_MANIFESTS=1 tracd --port 8000 /path/to/myproject
     250}}}
     251
     252If 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`.
     253}}}
     254
    248255=== Running the Standalone Server
    249256
     
    256263{{{#!sh
    257264$ tracd -s --port 8000 /path/to/myproject
    258 }}}
    259 
    260 {{{#!div style="border: 1pt dotted; margin: 1em"
    261 **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.
    262 
    263 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`.
    264 {{{#!sh
    265 export PKG_RESOURCES_CACHE_ZIP_MANIFESTS=1
    266 }}}
    267 
    268 Alternatively, the variable can be set in the shell before executing `tracd`:
    269 {{{#!sh
    270 $ PKG_RESOURCES_CACHE_ZIP_MANIFESTS=1 tracd --port 8000 /path/to/myproject
    271 }}}
    272265}}}
    273266
     
    276269Trac provides various options for connecting to a "real" web server:
    277270 - [TracFastCgi FastCGI]
    278  - [wiki:TracModWSGI mod_wsgi]
    279  - [TracModPython mod_python]
    280  - //[TracCgi CGI]: should not be used, as it degrades performance//
    281 
    282 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.
     271 - [wiki:TracModWSGI Apache with mod_wsgi]
     272 - [TracModPython Apache with mod_python]
     273 - [TracCgi CGI] //(should not be used, as the performance is far from optimal)//
     274
     275Trac 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.
    283276
    284277==== Generating the Trac cgi-bin directory #cgi-bin
    285278
    286 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].
    287 
    288 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:
    289 {{{#!sh
    290 $ mkdir -p /usr/share/trac/projects/my-project
    291 $ trac-admin /usr/share/trac/projects/my-project initenv
    292 $ trac-admin /usr/share/trac/projects/my-project deploy /tmp/deploy
    293 $ mv /tmp/deploy/* /usr/share/trac
    294 }}}
    295 
    296 Don't forget to check that the web server has the execution right on scripts in the `/usr/share/trac/cgi-bin` directory.
     279Application scripts for CGI, FastCGI and mod-wsgi can be generated using the [TracAdmin trac-admin] `deploy` command:
     280[[TracAdminHelp(deploy)]]
     281
     282Grant the web server execution right on scripts in the `cgi-bin` directory.
     283
     284For example, the following yields a typical directory structure:
     285{{{#!sh
     286$ mkdir -p /var/trac
     287$ trac-admin /var/trac/<project> initenv
     288$ trac-admin /var/trac/<project> deploy /var/www
     289$ ls /var/www
     290cgi-bin htdocs
     291$ chmod ugo+x /var/www/cgi-bin/*
     292}}}
    297293
    298294==== Mapping Static Resources
    299295
    300 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.
    301 
    302 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.
    303 
    304 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.
    305 
    306 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:
    307 [[TracAdminHelp(deploy)]]
    308 
    309 The target `<directory>` will then contain an `htdocs` directory with:
    310  - `site/` - a copy of the environment's directory `htdocs/`
    311  - `common/` - the static resources of Trac itself
    312  - `<plugins>/` - one directory for each resource directory managed by the plugins enabled for this environment
    313 
    314 ===== Example: Apache and `ScriptAlias` #ScriptAlias-example
    315 
    316 Assuming the deployment has been done this way:
    317 {{{#!sh
    318 $ trac-admin /var/trac/env deploy /path/to/shared/trac
    319 }}}
    320 
    321 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:
     296Without 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.
     297
     298Web 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.
     299
     300There 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.
     301
     302A 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.
     303
     304The `deploy` command creates an `htdocs` directory with:
     305 - `common/` - the static resources of Trac
     306 - `site/` - a copy of the environment's `htdocs/` directory
     307 - `shared` - the static resources shared by multiple Trac environments, with a location defined by the `[inherit]` `htdocs_dir` option
     308 - `<plugin>/` - one directory for each resource directory provided by the plugins enabled for this environment
     309
     310The 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:
    322311{{{#!apache
    323312Alias /trac/chrome/common /path/to/trac/htdocs/common
    324313Alias /trac/chrome/site /path/to/trac/htdocs/site
     314Alias /trac/chrome/shared /path/to/trac/htdocs/shared
     315Alias /trac/chrome/<plugin> /path/to/trac/htdocs/<plugin>
     316}}}
     317
     318===== Example: Apache and `ScriptAlias` #ScriptAlias-example
     319
     320Assuming the deployment has been done this way:
     321{{{#!sh
     322$ trac-admin /var/trac/<project> deploy /var/www
     323}}}
     324
     325Add 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:
     326{{{#!apache
     327Alias /trac/chrome /path/to/trac/htdocs
    325328
    326329<Directory "/path/to/www/trac/htdocs">
    327   Order allow,deny
    328   Allow from all
     330  # For Apache 2.2
     331  <IfModule !mod_authz_core.c>
     332    Order allow,deny
     333    Allow from all
     334  </IfModule>
     335  # For Apache 2.4
     336  <IfModule mod_authz_core.c>
     337    Require all granted
     338  </IfModule>
    329339</Directory>
    330340}}}
    331341
    332 If using mod_python, you might want to add this too, otherwise the alias will be ignored:
     342If using mod_python, add this too, otherwise the alias will be ignored:
    333343{{{#!apache
    334 <Location "/trac/chrome/common/">
     344<Location "/trac/chrome/common">
    335345  SetHandler None
    336346</Location>
    337347}}}
    338348
    339 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.
    340 
    341 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):
     349Alternatively, 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:
    342350{{{#!apache
    343351Alias /trac/chrome/site /path/to/projectenv/htdocs
    344352
    345353<Directory "/path/to/projectenv/htdocs">
    346   Order allow,deny
    347   Allow from all
     354  # For Apache 2.2
     355  <IfModule !mod_authz_core.c>
     356    Order allow,deny
     357    Allow from all
     358  </IfModule>
     359  # For Apache 2.4
     360  <IfModule mod_authz_core.c>
     361    Require all granted
     362  </IfModule>
    348363</Directory>
    349364}}}
    350365
    351 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:
     366Another alternative to aliasing `/trac/chrome/common` is having Trac generate direct links for those static resources (and only those), using the [TracIni#trac-section htdocs_location] configuration setting:
    352367{{{#!ini
    353368[trac]
     
    355370}}}
    356371
    357 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].
     372Note that this makes it easy to have a dedicated domain serve those static resources, preferentially cookie-less.
    358373
    359374Of 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:
     
    362377}}}
    363378
    364 ==== Setting up the Plugin Cache
     379==== Setting up the Plugin Cache #egg-cache
    365380
    366381Some 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.
     382
     383If you setup hook scripts that call Trac, such as the Subversion post-commit hook script provided in the `/contrib` directory, make sure you define the `PYTHON_EGG_CACHE` environment variable within these scripts as well.
    367384
    368385== Configuring Authentication
     
    374391Please refer to one of the following sections:
    375392 * TracStandalone#UsingAuthentication if you use the standalone server, `tracd`.
    376  * [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`.
    377  * TracFastCgi if you are using another web server with FCGI support, such as Cherokee, Lighttpd, !LiteSpeed, nginx.
    378 
    379 The following document also contains some useful information for beginners: [trac:TracAuthenticationIntroduction].
     393 * [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`.
     394 * TracFastCgi if you're using another web server with FCGI support (Cherokee, Lighttpd, !LiteSpeed, nginx)
     395
     396[trac:TracAuthenticationIntroduction] also contains some useful information for beginners.
    380397
    381398== Granting admin rights to the admin user
    382 
    383399Grant admin rights to user admin:
    384400{{{#!sh
     
    386402}}}
    387403
    388 This user will have an "Admin" entry menu that will allow you to administrate your Trac project.
    389 
    390 == Finishing the install
    391 
    392 === Enable version control components
    393 
    394 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.
    395 
    396 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:
    397 
    398 {{{#!ini
    399 [components]
    400 tracopt.versioncontrol.svn.* = enabled
    401 }}}
    402 
    403 {{{#!ini
    404 [components]
    405 tracopt.versioncontrol.git.* = enabled
    406 }}}
    407 
    408 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].
    409 
    410 === Using Trac
     404This user will have an //Admin// navigation item that directs to pages for administering your Trac project.
     405
     406== Configuring Trac
     407
     408TracRepositoryAdmin provides information on configuring version control repositories for your project.
     409
     410== Using Trac
    411411
    412412Once 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.