Changes between Version 4 and Version 5 of TracInstall


Ignore:
Timestamp:
Jun 27, 2018 1:17:52 PM (14 months ago)
Author:
trac
Comment:

Legend:

Unmodified
Added
Removed
Modified
  • TracInstall

    v4 v5  
    1 = Trac Installation Guide for 1.0
     1= Trac Installation Guide for 1.2
    22[[TracGuideToc]]
    33
    44Trac 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.
    55
    6 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.
    77
    88If 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].
    99
    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] 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.
    1111
    1212[[PageOutline(2-3,Installation Steps,inline)]]
     
    1616To install Trac, the following software packages must be installed:
    1717
    18  * [http://www.python.org/ Python], version >= 2.5 and < 3.0
    19    (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)
    2020 * [http://pypi.python.org/pypi/setuptools setuptools], version >= 0.6
    2121 * [http://genshi.edgewall.org/wiki/Download Genshi], version >= 0.6
     
    2525==== For the SQLite database #ForSQLite
    2626
    27 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.
    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.
     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 [http://pypi.python.org/pypi/pysqlite pysqlite] than the one provided by the Python distribution. See [trac:PySqlite#ThePysqlite2bindings PySqlite] for details.
    3030
    3131==== For the PostgreSQL database #ForPostgreSQL
     
    4848=== Optional Dependencies
    4949
    50 ==== Version Control System
    51 
    52 ===== Subversion
    53  * [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.
    5453
    5554There 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.)
    5655
    57 Note that Trac '''doesn't''' use [http://pysvn.tigris.org/ PySVN], neither does it work yet with the newer `ctype`-style bindings.
    58 
    59 '''Please note:''' if using Subversion, Trac must be installed on the '''same machine'''. Remote repositories are currently [trac:ticket:493 not supported].
    60 
    61 ===== Git
    62  * [http://git-scm.com/ Git] 1.5.6 or later.
    63 
    64 More information is available on the [trac:TracGit] page.
    65 
    66 ===== Others
    67 
    68 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].
    6971
    7072==== Web Server
     
    7375Alternatively you can configure Trac to run in any of the following environments:
    7476 * [http://httpd.apache.org/ Apache] with
    75    - [http://code.google.com/p/modwsgi/ mod_wsgi], see [wiki:TracModWSGI] and
    76      http://code.google.com/p/modwsgi/wiki/IntegrationWithTrac
    77    - [http://modpython.org/ mod_python 3.5.0], see TracModPython
     77  * [https://github.com/GrahamDumpleton/mod_wsgi mod_wsgi], see [wiki:TracModWSGI] and [http://code.google.com/p/modwsgi/wiki/IntegrationWithTrac ModWSGI IntegrationWithTrac].
     78  * [http://modpython.org/ mod_python 3.5.0], see TracModPython
    7879 * a [http://www.fastcgi.com/ FastCGI]-capable web server (see TracFastCgi)
    7980 * an [http://tomcat.apache.org/connectors-doc/ajp/ajpv13a.html AJP]-capable web
    8081   server (see [trac:TracOnWindowsIisAjp TracOnWindowsIisAjp])
    81  * a FastCGI and FastCGI-to-WSGI gateway (see [trac:TracOnWindowsIisWfastcgi])
     82 * Microsoft IIS with FastCGI and a FastCGI-to-WSGI gateway (see [trac:CookBook/Installation/TracOnWindowsIisWfastcgi IIS with FastCGI])
    8283 * a CGI-capable web server (see TracCgi), '''but usage of Trac as a cgi script
    8384   is highly discouraged''', better use one of the previous options.
     
    8687==== Other Python Packages
    8788
    88  * [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,
    8990   needed for localization support
    9091 * [http://docutils.sourceforge.net/ docutils], version >= 0.3.9
     
    9293 * [http://pygments.org Pygments] for
    9394   [TracSyntaxColoring syntax highlighting].
    94    [http://silvercity.sourceforge.net/ SilverCity] and/or
    95    [http://gnu.org/software/enscript/enscript.html Enscript] may still be used
    96    but are deprecated and you really should be using Pygments.
    9795 * [http://pytz.sf.net pytz] to get a complete list of time zones,
    9896   otherwise Trac will fall back on a shorter list from
     
    109107The [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.
    110108
     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
    111111=== Using `easy_install`
    112112Trac can be installed from PyPI or the Subversion repository using [http://pypi.python.org/pypi/setuptools setuptools].
     
    114114A few examples:
    115115
    116  - Install Trac 1.0:
    117    {{{#!sh
    118    easy_install Trac==1.0
    119    }}}
     116 - Install the latest stable version of Trac:
     117 {{{#!sh
     118$ easy_install Trac
     119}}}
    120120 - Install latest development version:
    121    {{{#!sh
    122    easy_install Trac==dev
    123    }}}
     121 {{{#!sh
     122$ easy_install http://download.edgewall.org/trac/Trac-latest-dev.tar.gz
     123}}}
    124124   Note that in this case you won't have the possibility to run a localized version of Trac;
    125125   either use a released version or install from source
    126126
    127 More information can be found on the [trac: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 the sections on [#RunningtheStandaloneServer Running The Standalone Server] and [#RunningTraconaWebServer Running Trac on a Web Server].
     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].
    131131}}}
    132132
     
    137137Assuming you want to have your entire pip installation in `/opt/user/trac`
    138138
    139  -
    140139 {{{#!sh
    141 pip install trac psycopg2
     140$ pip install trac psycopg2
    142141}}}
    143142or
    144  -
    145143 {{{#!sh
    146 pip install trac mysql-python
     144$ pip install trac mysql-python
    147145}}}
    148146
     
    175173=== Using installer
    176174
    177 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.
    178176
    179177=== Using package manager
    180178
    181 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.
    182180
    183181=== Advanced `easy_install` Options
     
    185183To install Trac to a custom location, or find out about other advanced installation options, run:
    186184{{{#!sh
    187 easy_install --help
     185$ easy_install --help
    188186}}}
    189187
     
    192190Specifically, you might be interested in:
    193191{{{#!sh
    194 easy_install --prefix=/path/to/installdir
     192$ easy_install --prefix=/path/to/installdir
    195193}}}
    196194or, if installing Trac on a Mac OS X system:
    197195{{{#!sh
    198 easy_install --prefix=/usr/local --install-dir=/Library/Python/2.5/site-packages
    199 }}}
    200 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.
    201 
    202 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}}}
    203204
    204205== Creating a Project Environment
    205206
    206 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.
    207208
    208209A new environment is created using [TracAdmin trac-admin]:
     
    211212}}}
    212213
    213 [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.
    214 
    215 Using the default database connection string in particular will always work as long as you have SQLite installed.
    216 For the other [trac:DatabaseBackend database backends] you should plan ahead and already have a database ready to use at this point.
    217 
    218 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.
    219 
    220 Also note that the values you specify here can be changed later by directly editing the [TracIni conf/trac.ini] configuration file.
    221 
    222 {{{#!div style="border: 1pt dotted; margin: 1em"
    223 **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), 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.
     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.
     219
     220{{{#!div style="border: 1pt dotted; margin: 1em"
     221**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.
    224222}}}
    225223
    226224Finally, 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:
    227225{{{#!sh
    228 $ chown -R apache.apache /path/to/myproject
     226$ chown -R apache:apache /path/to/myproject
    229227}}}
    230228
     
    237235== Deploying Trac
    238236
     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
    239255=== Running the Standalone Server
    240256
     
    247263{{{#!sh
    248264$ tracd -s --port 8000 /path/to/myproject
    249 }}}
    250 
    251 {{{#!div style="border: 1pt dotted; margin: 1em"
    252 **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.
    253 
    254 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`.
    255 {{{#!sh
    256 export PKG_RESOURCES_CACHE_ZIP_MANIFESTS=1
    257 }}}
    258 
    259 Alternatively, the variable can be set in the shell before executing `tracd`:
    260 {{{#!sh
    261 $ PKG_RESOURCES_CACHE_ZIP_MANIFESTS=1 tracd --port 8000 /path/to/myproject
    262 }}}
    263265}}}
    264266
     
    267269Trac provides various options for connecting to a "real" web server:
    268270 - [TracFastCgi FastCGI]
    269  - [wiki:TracModWSGI mod_wsgi]
    270  - [TracModPython mod_python]
    271  - //[TracCgi CGI] (should not be used, as the performance is far from optimal)//
     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)//
    272274
    273275Trac 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.
     
    275277==== Generating the Trac cgi-bin directory #cgi-bin
    276278
    277 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].
    278 
    279 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:
    280 {{{#!sh
    281 mkdir -p /usr/share/trac/projects/my-project
    282 trac-admin /usr/share/trac/projects/my-project initenv
    283 trac-admin /usr/share/trac/projects/my-project deploy /tmp/deploy
    284 mv /tmp/deploy/* /usr/share/trac
    285 }}}
    286 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}}}
    287293
    288294==== Mapping Static Resources
    289295
    290 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).
    291 
    292 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.
    293 
    294 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.
    295 
    296 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:
    297 [[TracAdminHelp(deploy)]]
    298 
    299 The target `<directory>` will then contain an `htdocs` directory with:
    300  - `site/` - a copy of the environment's directory `htdocs/`
    301  - `common/` - the static resources of Trac itself
    302  - `<plugins>/` - one directory for each resource directory managed by the plugins enabled for this environment
    303 
    304 ===== Example: Apache and `ScriptAlias` #ScriptAlias-example
    305 
    306 Assuming the deployment has been done this way:
    307 {{{#!sh
    308 $ trac-admin /var/trac/env deploy /path/to/shared/trac
    309 }}}
    310 
    311 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 [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.
     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:
    312311{{{#!apache
    313312Alias /trac/chrome/common /path/to/trac/htdocs/common
    314313Alias /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
    315328
    316329<Directory "/path/to/www/trac/htdocs">
    317   Order allow,deny
    318   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>
    319339</Directory>
    320340}}}
    321341
    322 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:
    323343{{{#!apache
    324 <Location "/trac/chrome/common/">
     344<Location "/trac/chrome/common">
    325345  SetHandler None
    326346</Location>
    327347}}}
    328348
    329 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.
    330 
    331 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:
    332350{{{#!apache
    333351Alias /trac/chrome/site /path/to/projectenv/htdocs
    334352
    335353<Directory "/path/to/projectenv/htdocs">
    336   Order allow,deny
    337   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>
    338363</Directory>
    339364}}}
    340365
    341 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:
    342367{{{#!ini
    343368[trac]
    344369htdocs_location = http://static.example.org/trac-common/
    345370}}}
    346 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]).
     371
     372Note that this makes it easy to have a dedicated domain serve those static resources, preferentially cookie-less.
    347373
    348374Of 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:
     
    351377}}}
    352378
    353 ==== Setting up the Plugin Cache
     379==== Setting up the Plugin Cache #egg-cache
    354380
    355381Some 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.
    356384
    357385== Configuring Authentication
     
    363391Please refer to one of the following sections:
    364392 * TracStandalone#UsingAuthentication if you use the standalone server, `tracd`.
    365  * [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`.
     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`.
    366394 * TracFastCgi if you're using another web server with FCGI support (Cherokee, Lighttpd, !LiteSpeed, nginx)
    367395
    368 The following document also contains some useful information for beginners: [trac:TracAuthenticationIntroduction].
     396[trac:TracAuthenticationIntroduction] also contains some useful information for beginners.
    369397
    370398== Granting admin rights to the admin user
     
    373401$ trac-admin /path/to/myproject permission add admin TRAC_ADMIN
    374402}}}
    375 This user will have an "Admin" entry menu that will allow you to administrate your Trac project.
    376 
    377 == Finishing the install
    378 
    379 === Enable version control components
    380 
    381 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.
    382 
    383 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.
    384 
    385 {{{#!ini
    386 tracopt.versioncontrol.svn.* = enabled
    387 }}}
    388 
    389 {{{#!ini
    390 tracopt.versioncontrol.git.* = enabled
    391 }}}
    392 
    393 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].
    394 
    395 === Using Trac
     403
     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
    396411
    397412Once 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.