Changes between Version 3 and Version 4 of TracInstall


Ignore:
Timestamp:
12/02/2016 05:46:01 PM (12 months 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.1
    32[[TracGuideToc]]
    43
    54Trac 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.
    65
    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.
     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)
     18 * [http://www.python.org/ Python], version >= 2.6 and < 3.0
     19   (note that we dropped the support for Python 2.5 in this release)
    2320 * [http://pypi.python.org/pypi/setuptools setuptools], version >= 0.6
    2421 * [http://genshi.edgewall.org/wiki/Download Genshi], version >= 0.6
     
    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.
     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).
    3128
    3229Optionally, 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.
     
    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
     43 * [http://mysql.com/ MySQL], version 5.0 or later
    4744 * [http://sf.net/projects/mysql-python MySQLdb], version 1.2.2 or later
    4845
    49 Given the caveats and known issues surrounding MySQL, read the [trac:MySqlDb] page before creating the database.
     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.
     50==== Subversion
     51
     52[http://subversion.apache.org/ Subversion], 1.6.x or later and the '''''corresponding''''' Python bindings.
    5753
    5854There 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.)
    5955
    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].
     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[http://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:
    7876 * [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
     77   - [https://github.com/GrahamDumpleton/mod_wsgi mod_wsgi], see [wiki:TracModWSGI] and
     78     [http://code.google.com/p/modwsgi/wiki/IntegrationWithTrac ModWSGI IntegrationWithTrac].
    8179   - [http://modpython.org/ mod_python 3.5.0], see TracModPython
    8280 * a [http://www.fastcgi.com/ FastCGI]-capable web server (see TracFastCgi)
    8381 * an [http://tomcat.apache.org/connectors-doc/ajp/ajpv13a.html AJP]-capable web
    8482   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.
     83 * Microsoft IIS with FastCGI and a FastCGI-to-WSGI gateway (see [trac:CookBook/Installation/TracOnWindowsIisWfastcgi IIS with FastCGI])
     84 * a CGI-capable web server (see TracCgi), '''but usage of Trac as a cgi script
     85   is highly discouraged''', better use one of the previous options.
    8886   
     87
    8988==== Other Python Packages
    9089
    91  * [http://babel.edgewall.org Babel], version 0.9.5, 0.9.6 or >= 1.3
     90 * [http://babel.edgewall.org Babel], version 0.9.6 or >= 1.3,
    9291   needed for localization support
    9392 * [http://docutils.sourceforge.net/ docutils], version >= 0.3.9
     
    9594 * [http://pygments.org Pygments] for
    9695   [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.
    10096 * [http://pytz.sf.net pytz] to get a complete list of time zones,
    10197   otherwise Trac will fall back on a shorter list from
     
    106102}}}
    107103
    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.
     104Please 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''.
    109105
    110106== Installing Trac
     
    112108The [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.
    113109
    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.
     110It 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.
    115111
    116112=== 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:
     113Trac can be installed from PyPI or the Subversion repository using [http://pypi.python.org/pypi/setuptools setuptools].
     114
     115A few examples:
     116
     117 - Install the latest stable version of Trac:
    123118 {{{#!sh
    124 $ easy_install Trac==1.0
     119$ easy_install Trac
    125120}}}
    126121 - Install latest development version:
    127122 {{{#!sh
    128 $ easy_install Trac==dev
     123$ easy_install http://download.edgewall.org/trac/Trac-latest-dev.tar.gz
    129124}}}
    130125   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.
     126   either use a released version or install from source 
    132127
    133128More information can be found on the [trac:wiki:setuptools setuptools] page.
    134129
    135130{{{#!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].
     131**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].
    137132}}}
    138133
    139134=== Using `pip`
    140 
    141 'pip' is an easy_install replacement that is very useful to quickly install Python packages.
     135'pip' is an easy_install replacement that is very useful to quickly install python packages.
    142136To get a Trac installation up and running in less than 5 minutes:
    143137
    144 Assuming you want to have your entire pip installation in `/opt/user/trac`:
     138Assuming you want to have your entire pip installation in `/opt/user/trac`
    145139
    146140 -
    147141 {{{#!sh
    148 $ pip install trac psycopg2
    149 }}}
    150 or:
     142pip install trac psycopg2
     143}}}
     144or
    151145 -
    152146 {{{#!sh
    153 $ pip install trac mysql-python
     147pip install trac mysql-python
    154148}}}
    155149
     
    158152pip 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`.
    159153
    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).
     154All 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)
    161155
    162156Additionally, you can install several Trac plugins (listed [https://pypi.python.org/pypi?:action=browse&show=all&c=516 here]) through pip.
    163157
    164158=== From source
    165 
    166159Using 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.
    167160
     
    170163}}}
    171164
    172 You will need root permissions or equivalent for this step.
     165''You will need root permissions or equivalent for this step.''
    173166
    174167This will byte-compile the Python source code and install it as an .egg file or folder in the `site-packages` directory
     
    179172$ python ./setup.py install
    180173}}}
    181 
    182174Alternatively, 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`).
    183175
    184176=== Using installer
    185177
    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.
     178On 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.
    187179
    188180=== Using package manager
    189181
    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.
     182Trac 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.
    191183
    192184=== Advanced `easy_install` Options
     
    194186To install Trac to a custom location, or find out about other advanced installation options, run:
    195187{{{#!sh
    196 $ easy_install --help
     188easy_install --help
    197189}}}
    198190
     
    201193Specifically, you might be interested in:
    202194{{{#!sh
    203 $ easy_install --prefix=/path/to/installdir
    204 }}}
    205 
     195easy_install --prefix=/path/to/installdir
     196}}}
    206197or, if installing Trac on a Mac OS X system:
    207198{{{#!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.
     199easy_install --prefix=/usr/local --install-dir=/Library/Python/2.6/site-packages
     200}}}
     201
     202{{{#!div style="border: 1pt dotted; margin: 1em"
     203**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.
     204
     205The `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.
     206}}}
    214207
    215208== Creating a Project Environment
    216209
    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.
     210A [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.
    218211
    219212A new environment is created using [TracAdmin trac-admin]:
     
    222215}}}
    223216
    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.
     217[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.
     218
     219Using 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.
     220
     221Also note that the values you specify here can be changed later using TracAdmin or directly editing the [TracIni conf/trac.ini] configuration file.
    232222
    233223{{{#!div style="border: 1pt dotted; margin: 1em"
     
    237227Finally, 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:
    238228{{{#!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).
     229$ chown -R apache:apache /path/to/myproject
     230}}}
     231
     232The 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).
    243233
    244234{{{#!div class=important
     
    248238== Deploying Trac
    249239
     240{{{#!div style="border: 1pt dotted; margin: 1em"
     241**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.
     242
     243If 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.
     244
     245To 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`.
     246{{{#!sh
     247export PKG_RESOURCES_CACHE_ZIP_MANIFESTS=1
     248}}}
     249
     250Alternatively, the variable can be set in the shell before executing `tracd`:
     251{{{#!sh
     252$ PKG_RESOURCES_CACHE_ZIP_MANIFESTS=1 tracd --port 8000 /path/to/myproject
     253}}}
     254
     255If 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`.
     256}}}
     257
    250258=== Running the Standalone Server
    251259
     
    258266{{{#!sh
    259267$ tracd -s --port 8000 /path/to/myproject
    260 }}}
    261 
    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 }}}
    274268}}}
    275269
     
    278272Trac provides various options for connecting to a "real" web server:
    279273 - [TracFastCgi FastCGI]
    280  - [wiki:TracModWSGI mod_wsgi]
    281  - [TracModPython mod_python]
    282  - //[TracCgi CGI]: should not be used, as it degrades performance//
     274 - [wiki:TracModWSGI Apache with mod_wsgi]
     275 - [TracModPython Apache with mod_python]
     276 - //[TracCgi CGI] (should not be used, as the performance is far from optimal)//
    283277
    284278Trac 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.
     
    290284There 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:
    291285{{{#!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 
     286mkdir -p /usr/share/trac/projects/my-project
     287trac-admin /usr/share/trac/projects/my-project initenv
     288trac-admin /usr/share/trac/projects/my-project deploy /tmp/deploy
     289mv /tmp/deploy/* /usr/share/trac
     290}}}
    298291Don't forget to check that the web server has the execution right on scripts in the `/usr/share/trac/cgi-bin` directory.
    299292
    300293==== Mapping Static Resources
    301294
    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:
     295Without 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.
     296
     297Web 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.
     298
     299There 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.
     300
     301A 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.
     302
     303The resources are extracted using the [TracAdmin trac-admin]` <environment> deploy` command:
    309304[[TracAdminHelp(deploy)]]
    310305
    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:
     306The target `<directory>` will contain an `htdocs` directory with:
     307 - `common/` - the static resources of Trac
     308 - `site/` - a copy of the environment's `htdocs/` directory
     309 - `shared` - the static resources shared by multiple Trac environments, with a location defined by the `[inherit]` `htdocs_dir` option
     310 - `<plugin>/` - one directory for each resource directory provided by the plugins enabled for this environment
     311
     312The 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:
    324313{{{#!apache
    325314Alias /trac/chrome/common /path/to/trac/htdocs/common
    326315Alias /trac/chrome/site /path/to/trac/htdocs/site
     316Alias /trac/chrome/shared /path/to/trac/htdocs/shared
     317Alias /trac/chrome/<plugin> /path/to/trac/htdocs/<plugin>
     318}}}
     319
     320===== Example: Apache and `ScriptAlias` #ScriptAlias-example
     321
     322Assuming the deployment has been done this way:
     323{{{#!sh
     324$ trac-admin /var/trac/env deploy /path/to/shared/trac
     325}}}
     326
     327Add 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:
     328{{{#!apache
     329Alias /trac/chrome /path/to/trac/htdocs
    327330
    328331<Directory "/path/to/www/trac/htdocs">
    329   Order allow,deny
    330   Allow from all
     332  # For Apache 2.2
     333  <IfModule !mod_authz_core.c>
     334    Order allow,deny
     335    Allow from all
     336  </IfModule>
     337  # For Apache 2.4
     338  <IfModule mod_authz_core.c>
     339    Require all granted
     340  </IfModule>
    331341</Directory>
    332342}}}
    333343
    334 If using mod_python, you might want to add this too, otherwise the alias will be ignored:
     344If using mod_python, add this too, otherwise the alias will be ignored:
    335345{{{#!apache
    336 <Location "/trac/chrome/common/">
     346<Location "/trac/chrome/common">
    337347  SetHandler None
    338348</Location>
    339349}}}
    340350
    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):
     351Alternatively, 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:
    344352{{{#!apache
    345353Alias /trac/chrome/site /path/to/projectenv/htdocs
    346354
    347355<Directory "/path/to/projectenv/htdocs">
    348   Order allow,deny
    349   Allow from all
     356  # For Apache 2.2
     357  <IfModule !mod_authz_core.c>
     358    Order allow,deny
     359    Allow from all
     360  </IfModule>
     361  # For Apache 2.4
     362  <IfModule mod_authz_core.c>
     363    Require all granted
     364  </IfModule>
    350365</Directory>
    351366}}}
    352367
    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:
     368Another 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:
    354369{{{#!ini
    355370[trac]
     
    357372}}}
    358373
    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].
     374Note that this makes it easy to have a dedicated domain serve those static resources, preferentially cookie-less.
    360375
    361376Of 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:
     
    376391Please refer to one of the following sections:
    377392 * 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].
     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.
    382397
    383398== Granting admin rights to the admin user
    384 
    385399Grant admin rights to user admin:
    386400{{{#!sh
     
    388402}}}
    389403
    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
     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
    413411
    414412Once 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.