Changes between Version 8 and Version 9 of TracInstall


Игнорировать:
Время:
5 февр. 2025 г., 17:42:05 (20 месяцев назад)
Автор:
trac
Комментарий:

--

Обозначения:

Без изменений
Добавлено
Удалено
Изменено
  • TracInstall

    v8 v9  
    1 = Trac Installation Guide for 1.1
     1= Trac Installation Guide for 1.5
    22[[TracGuideToc]]
    33
    4 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.
     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.
    55
    66Trac 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.
    77
    8 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].
    9 
    10 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], please '''first read through these general instructions''' to get a good understanding of the tasks involved.
     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
     10These 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.
    1111
    1212[[PageOutline(2-3,Installation Steps,inline)]]
     
    1414== Dependencies
    1515=== Mandatory Dependencies
     16
    1617To install Trac, the following software packages must be installed:
    1718
    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)
    20  * [http://pypi.python.org/pypi/setuptools setuptools], version >= 0.6
    21  * [http://genshi.edgewall.org/wiki/Download Genshi], version >= 0.6
    22 
    23 You also need a database system and the corresponding python bindings. The database can be either SQLite, PostgreSQL or MySQL.
     19 * [https://www.python.org/ Python], version >= 3.5
     20 * [https://pypi.org/project/setuptools setuptools], version > 5.6
     21 * [https://pypi.org/project/Jinja2 Jinja2], version >= 2.9.3
     22
     23You also need a database system and the corresponding Python bindings. The database can be either SQLite, PostgreSQL or MySQL.
    2424
    2525==== For the SQLite database #ForSQLite
    2626
    27 As 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 
    29 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.
     27You 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.
    3030
    3131==== For the PostgreSQL database #ForPostgreSQL
    3232
    3333You need to install the database and its Python bindings:
    34  * [http://www.postgresql.org/ PostgreSQL], version 8.0 or later
    35  * [http://pypi.python.org/pypi/psycopg2 psycopg2], version 2.0 or later
     34 * [https://www.postgresql.org/ PostgreSQL], version 9.1 or later
     35 * [https://pypi.org/project/psycopg2 psycopg2], version 2.5 or later
    3636
    3737See [trac:DatabaseBackend#Postgresql DatabaseBackend] for details.
     
    3939==== For the MySQL database #ForMySQL
    4040
    41 Trac works well with MySQL, provided you follow the guidelines:
    42 
    43  * [http://mysql.com/ MySQL], version 5.0 or later
    44  * [http://sf.net/projects/mysql-python MySQLdb], version 1.2.2 or later
     41Trac works well with MySQL, provided you use the following:
     42
     43 * [https://mysql.com/ MySQL], version 5.0 or later
     44 * [https://pypi.org/project/PyMySQL PyMySQL]
    4545
    4646Given the caveats and known issues surrounding MySQL, read carefully the [trac:MySqlDb] page before creating the database.
     
    5050==== Subversion
    5151
    52 [http://subversion.apache.org/ Subversion], 1.6.x or later and the '''''corresponding''''' Python bindings.
    53 
    54 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.)
    55 
    56 For troubleshooting information, see the [trac:TracSubversion#Troubleshooting TracSubversion] page.
     52[https://subversion.apache.org/ Subversion], 1.14.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. See [trac:TracSubversion#GettingSubversion getting Subversion] for more information.
    5755
    5856{{{#!div style="border: 1pt dotted; margin: 1em"
    5957**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 }}}
     58* Trac '''doesn't''' use [https://pypi.org/project/PySVN PySVN], nor does it work yet with the newer `ctype`-style bindings.
     59* If using Subversion, Trac must be installed on the '''same machine'''. Remote repositories are [trac:ticket:493 not supported].
     60}}}
     61
     62For troubleshooting information, see the [trac:TracSubversion#Troubleshooting TracSubversion] page.
    6363
    6464==== Git
    6565
    66 [http://git-scm.com/ Git] 1.5.6 or later is supported. More information is available on the [trac:TracGit] page.
     66[https://git-scm.com/ Git] 1.5.6 or later is supported. More information is available on the [trac:TracGit] page.
    6767
    6868==== Other Version Control Systems
     
    7171
    7272==== Web Server
     73
    7374A web server is optional because Trac is shipped with a server included, see the [#RunningtheStandaloneServer Running the Standalone Server] section below.
    7475
    7576Alternatively you can configure Trac to run in any of the following environments:
    76  * [http://httpd.apache.org/ Apache] with
    77    - [https://github.com/GrahamDumpleton/mod_wsgi mod_wsgi], see [wiki:TracModWSGI] and 
    78      [http://code.google.com/p/modwsgi/wiki/IntegrationWithTrac ModWSGI IntegrationWithTrac].
     77 * [https://httpd.apache.org/ Apache] with
     78   - [https://github.com/GrahamDumpleton/mod_wsgi mod_wsgi], see [wiki:TracModWSGI] and
     79     [https://code.google.com/p/modwsgi/wiki/IntegrationWithTrac ModWSGI IntegrationWithTrac].
    7980   - [http://modpython.org/ mod_python 3.5.0], see TracModPython
    80  * a [http://www.fastcgi.com/ FastCGI]-capable web server (see TracFastCgi)
    81  * an [http://tomcat.apache.org/connectors-doc/ajp/ajpv13a.html AJP]-capable web
    82    server (see [trac:TracOnWindowsIisAjp TracOnWindowsIisAjp])
     81 * a [https://fastcgi-archives.github.io FastCGI]-capable web server (see TracFastCgi)
     82 * an [https://tomcat.apache.org/connectors-doc/ajp/ajpv13a.html AJP]-capable web server (see [trac:TracOnWindowsIisAjp TracOnWindowsIisAjp])
    8383 * 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.
    86    
     84 * a CGI-capable web server (see TracCgi), '''but usage of Trac as a cgi script is highly discouraged''', better use one of the previous options.
    8785
    8886==== Other Python Packages
    8987
    90  * [http://babel.edgewall.org Babel], version 0.9.6 or >= 1.3,
    91    needed for localization support
    92  * [http://docutils.sourceforge.net/ docutils], version >= 0.3.9
    93    for WikiRestructuredText.
    94  * [http://pygments.org Pygments] for
    95    [TracSyntaxColoring syntax highlighting].
    96  * [http://pytz.sf.net pytz] to get a complete list of time zones,
    97    otherwise Trac will fall back on a shorter list from
    98    an internal time zone implementation.
     88 * [http://babel.pocoo.org Babel], version >= 2.2, needed for localization support
     89 * [http://pytz.sourceforge.net pytz] to get a complete list of time zones, otherwise Trac will fall back on a shorter list from an internal time zone implementation. Installing Babel will install pytz.
     90 * [http://docutils.sourceforge.net docutils], version >= 0.14, for WikiRestructuredText.
     91 * [http://pygments.org Pygments], version >= 1.0, for [TracSyntaxColoring syntax highlighting].
     92 * [https://pypi.org/project/textile Textile], version >= 2.3, for rendering the [https://github.com/textile/python-textile Textile markup language].
     93 * [https://pypi.org/project/passlib passlib] on Windows to decode [TracStandalone#BasicAuthorization:Usingahtpasswdpasswordfile htpasswd formats] other than `SHA-1`.
     94 * [https://pypi.org/project/pyreadline pyreadline] on Windows for trac-admin [TracAdmin#InteractiveMode command completion].
    9995
    10096{{{#!div style="border: 1pt dotted; margin: 1em"
     
    108104The [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.
    109105
    110 === Using `easy_install`
    111 Trac can be installed from PyPI or the Subversion repository using [http://pypi.python.org/pypi/setuptools setuptools].
    112 
    113 A few examples:
    114 
    115  - Install Trac 1.0:
    116    {{{#!sh
    117    easy_install Trac==1.0
    118    }}}
    119  - Install latest development version:
    120    {{{#!sh
    121    easy_install Trac==dev
    122    }}}
    123    Note that in this case you won't have the possibility to run a localized version of Trac;
    124    either use a released version or install from source
    125 
    126 More information can be found on the [trac:setuptools] page.
    127 
    128 {{{#!div style="border: 1pt dotted; margin: 1em"
    129 **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].
    130 }}}
     106It 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.
    131107
    132108=== Using `pip`
    133 'pip' is an easy_install replacement that is very useful to quickly install python packages.
    134 To get a Trac installation up and running in less than 5 minutes:
    135 
    136 Assuming you want to have your entire pip installation in `/opt/user/trac`
    137 
    138  -
    139  {{{#!sh
    140 pip install trac psycopg2
    141 }}}
    142 or
    143  -
    144  {{{#!sh
    145 pip install trac mysql-python
    146 }}}
    147 
    148 Make sure your OS specific headers are available for pip to automatically build PostgreSQL (`libpq-dev`) or MySQL (`libmysqlclient-dev`) bindings.
    149 
    150 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`.
    151 
    152 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)
    153 
    154 Additionally, you can install several Trac plugins (listed [https://pypi.python.org/pypi?:action=browse&show=all&c=516 here]) through pip.
    155 
    156 === From source
    157 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.
    158 
    159 {{{#!sh
    160 $ python ./setup.py install
    161 }}}
    162 
    163 ''You will need root permissions or equivalent for this step.''
    164 
    165 This will byte-compile the Python source code and install it as an .egg file or folder in the `site-packages` directory
    166 of your Python installation. The .egg will also contain all other resources needed by standard Trac, such as `htdocs` and `templates`.
    167 
    168 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):
    169 {{{#!sh
    170 $ python ./setup.py install
    171 }}}
    172 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`).
     109
     110`pip` is the modern Python package manager and is included in Python distributions. `pip` will automatically resolve the //required// dependencies (Jinja2 and setuptools) and download the latest packages from pypi.org.
     111
     112You 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:
     113
     114{{{#!sh
     115$ pip install .
     116}}}
     117
     118`pip` supports numerous other install mechanisms. It can be passed the URL of an archive or other download location. Here are some examples:
     119
     120* Install the latest development version from a tar archive:
     121{{{#!sh
     122$ pip install https://download.edgewall.org/trac/Trac-latest-dev.tar.gz
     123}}}
     124* Install the unreleased 1.4-stable from subversion:
     125{{{#!sh
     126$ pip install svn+https://svn.edgewall.org/repos/trac/branches/1.4-stable
     127}}}
     128* Install the latest development preview (//not recommended for production installs//):
     129{{{#!sh
     130$ pip install --find-links=https://trac.edgewall.org/wiki/TracDownload Trac
     131}}}
     132
     133The optional dependencies can be installed from PyPI using `pip`:
     134{{{#!sh
     135$ pip install babel docutils pygments textile
     136}}}
     137
     138The optional dependencies can alternatively be
     139specified using the `extras` keys in the setup file:
     140{{{#!sh
     141$ pip install Trac[babel,rest,pygments,textile]
     142}}}
     143
     144`rest` is the extra that installs the `docutils`
     145dependency.
     146
     147Include `mysql` or `psycopg2-binary` in the
     148list if using the MySQL or PostgreSQL database.
     149
     150Additionally, 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.
    173151
    174152=== Using installer
     
    178156=== Using package manager
    179157
    180 Trac 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.
    181 
    182 === Advanced `easy_install` Options
    183 
    184 To install Trac to a custom location, or find out about other advanced installation options, run:
    185 {{{#!sh
    186 easy_install --help
    187 }}}
    188 
    189 Also see [http://docs.python.org/2/install/index.html Installing Python Modules] for detailed information.
    190 
    191 Specifically, you might be interested in:
    192 {{{#!sh
    193 easy_install --prefix=/path/to/installdir
    194 }}}
    195 or, if installing Trac on a Mac OS X system:
    196 {{{#!sh
    197 easy_install --prefix=/usr/local --install-dir=/Library/Python/2.6/site-packages
    198 }}}
    199 
    200 {{{#!div style="border: 1pt dotted; margin: 1em"
    201 **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.
    202 
    203 The `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.
    204 }}}
     158Trac may be available in your platform's package repository. However, your package manager may not provide the latest release of Trac.
    205159
    206160== Creating a Project Environment
     
    213167}}}
    214168
    215 [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. 
     169[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.
    216170
    217171Using 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.
    218172
    219173Also note that the values you specify here can be changed later using TracAdmin or directly editing the [TracIni conf/trac.ini] configuration file.
    220 
    221 {{{#!div style="border: 1pt dotted; margin: 1em"
    222 **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.
    223 }}}
    224174
    225175Finally, 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:
     
    243193}}}
    244194
    245 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:
     195Then, 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:
    246196{{{#!sh
    247197$ tracd -s --port 8000 /path/to/myproject
    248198}}}
    249199
    250 {{{#!div style="border: 1pt dotted; margin: 1em"
    251 **Setuptools Warning:** If the version of your setuptools is in the range 5.4 through 5.6, the environment variable `PKG_RESOURCES_CACHE_ZIP_MANIFESTS` must be set in order to avoid significant performance degradation. 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.
    252 
    253 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`.
    254 {{{#!sh
    255 export PKG_RESOURCES_CACHE_ZIP_MANIFESTS=1
    256 }}}
    257 
    258 Alternatively, the variable can be set in the shell before executing `tracd`:
    259 {{{#!sh
    260 $ PKG_RESOURCES_CACHE_ZIP_MANIFESTS=1 tracd --port 8000 /path/to/myproject
    261 }}}
    262 }}}
    263 
    264200=== Running Trac on a Web Server
    265201
    266 Trac provides various options for connecting to a "real" web server: 
     202Trac provides various options for connecting to a "real" web server:
    267203 - [TracFastCgi FastCGI]
    268  - [wiki:TracModWSGI mod_wsgi]
    269  - [TracModPython mod_python]
    270  - //[TracCgi CGI] (should not be used, as the performance is far from optimal)//
    271 
    272 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.
     204 - [wiki:TracModWSGI Apache with mod_wsgi]
     205 - [TracModPython Apache with mod_python]
     206 - [TracCgi CGI] //(should not be used, as the performance is far from optimal)//
     207
     208Trac 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.
    273209
    274210==== Generating the Trac cgi-bin directory #cgi-bin
    275211
    276 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].
    277 
    278 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:
    279 {{{#!sh
    280 mkdir -p /usr/share/trac/projects/my-project
    281 trac-admin /usr/share/trac/projects/my-project initenv
    282 trac-admin /usr/share/trac/projects/my-project deploy /tmp/deploy
    283 mv /tmp/deploy/* /usr/share/trac
    284 }}}
    285 Don't forget to check that the web server has the execution right on scripts in the `/usr/share/trac/cgi-bin` directory.
     212Application scripts for CGI, FastCGI and mod-wsgi can be generated using the [TracAdmin trac-admin] `deploy` command:
     213[[TracAdminHelp(deploy)]]
     214
     215Grant the web server execution right on scripts in the `cgi-bin` directory.
     216
     217For example, the following yields a typical directory structure:
     218{{{#!sh
     219$ mkdir -p /var/trac
     220$ trac-admin /var/trac/<project> initenv
     221$ trac-admin /var/trac/<project> deploy /var/www
     222$ ls /var/www
     223cgi-bin htdocs
     224$ chmod ugo+x /var/www/cgi-bin/*
     225}}}
    286226
    287227==== Mapping Static Resources
    288228
    289 Out of the box, Trac will pass static resources such as style sheets or images through itself. For anything but a tracd only based deployment, this is far from optimal as the web server could be set up to directly serve those static resources (for CGI setup, this is '''highly undesirable''' and will cause abysmal performance).
    290 
    291 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.
    292 
    293 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.
    294 
    295 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 `deploy` command:
    296 [[TracAdminHelp(deploy)]]
    297 
    298 The target `<directory>` will then contain an `htdocs` directory with:
    299  - `site/` - a copy of the environment's directory `htdocs/`
    300  - `common/` - the static resources of Trac itself
    301  - `<plugins>/` - one directory for each resource directory managed by the plugins enabled for this environment
    302 
    303 ===== Example: Apache and `ScriptAlias` #ScriptAlias-example
    304 
    305 Assuming the deployment has been done this way:
    306 {{{#!sh
    307 $ trac-admin /var/trac/env deploy /path/to/shared/trac
    308 }}}
    309 
    310 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:
     229Without 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.
     230
     231Web 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.
     232
     233There 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.
     234
     235A 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.
     236
     237The `deploy` command creates an `htdocs` directory with:
     238 - `common/` - the static resources of Trac
     239 - `site/` - a copy of the environment's `htdocs/` directory
     240 - `shared` - the static resources shared by multiple Trac environments, with a location defined by the `[inherit]` `htdocs_dir` option
     241 - `<plugin>/` - one directory for each resource directory provided by the plugins enabled for this environment
     242
     243The 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:
    311244{{{#!apache
    312245Alias /trac/chrome/common /path/to/trac/htdocs/common
    313246Alias /trac/chrome/site /path/to/trac/htdocs/site
    314 
    315 <Directory "/path/to/www/trac/htdocs">
    316   Order allow,deny
    317   Allow from all
     247Alias /trac/chrome/shared /path/to/trac/htdocs/shared
     248Alias /trac/chrome/<plugin> /path/to/trac/htdocs/<plugin>
     249}}}
     250
     251===== Example: Apache and `ScriptAlias` #ScriptAlias-example
     252
     253Assuming the deployment has been done this way:
     254{{{#!sh
     255$ trac-admin /var/trac/<project> deploy /var/www/trac
     256}}}
     257
     258Add 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:
     259{{{#!apache
     260Alias /trac/chrome /var/www/trac/htdocs
     261
     262<Directory "/var/www/trac/htdocs">
     263  # For Apache 2.2
     264  <IfModule !mod_authz_core.c>
     265    Order allow,deny
     266    Allow from all
     267  </IfModule>
     268  # For Apache 2.4
     269  <IfModule mod_authz_core.c>
     270    Require all granted
     271  </IfModule>
    318272</Directory>
    319273}}}
    320274
    321 If using mod_python, you might want to add this too (otherwise, the alias will be ignored):
     275If using mod_python, add this too, otherwise the alias will be ignored:
    322276{{{#!apache
    323 <Location "/trac/chrome/common/">
     277<Location "/trac/chrome/common">
    324278  SetHandler None
    325279</Location>
    326280}}}
    327281
    328 Note that we mapped the `/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.
    329 
    330 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):
     282Alternatively, 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:
    331283{{{#!apache
    332284Alias /trac/chrome/site /path/to/projectenv/htdocs
    333285
    334286<Directory "/path/to/projectenv/htdocs">
    335   Order allow,deny
    336   Allow from all
     287  # For Apache 2.2
     288  <IfModule !mod_authz_core.c>
     289    Order allow,deny
     290    Allow from all
     291  </IfModule>
     292  # For Apache 2.4
     293  <IfModule mod_authz_core.c>
     294    Require all granted
     295  </IfModule>
    337296</Directory>
    338297}}}
    339298
    340 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:
     299Another 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:
    341300{{{#!ini
    342301[trac]
    343302htdocs_location = http://static.example.org/trac-common/
    344303}}}
    345 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]).
     304
     305Note that this makes it easy to have a dedicated domain serve those static resources, preferentially cookie-less.
    346306
    347307Of 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:
     
    356316== Configuring Authentication
    357317
    358 Trac 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.
    359 
    360 The process of adding, removing, and configuring user accounts for authentication depends on the specific way you run Trac. 
     318Trac uses HTTP authentication. You'll need to configure your web server 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.
     319
     320The process of adding, removing, and configuring user accounts for authentication depends on the specific way you run Trac.
    361321
    362322Please refer to one of the following sections:
     
    377337== Configuring Trac
    378338
     339Configuration options are documented on the TracIni page.
     340
    379341TracRepositoryAdmin provides information on configuring version control repositories for your project.
    380342
     343In addition to the optional version control backends, Trac provides several optional features that are disabled by default:
     344* [TracFineGrainedPermissions#AuthzPolicy Fine-grained permission policy]
     345* [TracPermissions#CreatingNewPrivileges Custom permissions]
     346* [TracTickets#deleter Ticket deletion]
     347* [TracTickets#cloner Ticket cloning]
     348* [TracRepositoryAdmin#CommitTicketUpdater Ticket changeset references]
     349
    381350== Using Trac
    382351
     
    390359
    391360----
    392 See also: [trac:TracInstallPlatforms TracInstallPlatforms], TracGuide, TracUpgrade, TracPermissions
     361See also: [trac:TracInstallPlatforms TracInstallPlatforms], TracGuide, TracUpgrade