Changes between Version 6 and Version 7 of TracInstall


Ignore:
Timestamp:
03/24/15 23:15:03 (2 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracInstall

    v6 v7  
    1 = Trac Installation Guide for 1.0
     1= Trac Installation Guide for 1.0 =
    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.
    7 
    8 If you're interested in contributing new translations for other languages or enhance 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] on the main Trac site, please '''first read through these general instructions''' to get a good understanding of the tasks involved.
     6Since version 0.12, Trac can also be localized, and there's probably a translation available for your language. If you want to be able 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, as usual.
     7
     8If you're interested in contributing new translations for other languages or enhance the existing translations, then please have a look at [[trac:TracL10N]].
     9
     10What follows are generic instructions for installing and setting up Trac and its requirements. While you may find instructions for installing Trac on specific systems at [trac:TracInstallPlatforms TracInstallPlatforms] on the main Trac site, please be sure to '''first read through these general instructions''' to get a good understanding of the tasks involved.
    1111
    1212[[PageOutline(2-3,Installation Steps,inline)]]
    1313
    14 == Dependencies
     14== Dependencies ==
    1515=== Mandatory Dependencies
    1616To install Trac, the following software packages must be installed:
     
    1818 * [http://www.python.org/ Python], version >= 2.5 and < 3.0
    1919   (note that we dropped the support for Python 2.4 in this release)
    20  * [http://peak.telecommunity.com/DevCenter/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.
     20 * [http://peak.telecommunity.com/DevCenter/setuptools setuptools], version >= 0.6, or better yet, [http://pypi.python.org/pypi/distribute distribute]
     21 * [http://genshi.edgewall.org/wiki/Download Genshi], version >= 0.6 (unreleased version 0.7dev should work as well)
     22
     23You also need a database system and the corresponding python bindings.
     24The database can be either SQLite, PostgreSQL or MySQL.
    2425
    2526==== For the SQLite database #ForSQLite
    2627
    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 However, if you like, you can download the latest and greatest version of [[trac:PySqlite]] from
     28As 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).
     29
     30However, if you'd like, you can download the latest and greatest version of [[trac:Pysqlite]] from
    3031[http://code.google.com/p/pysqlite/downloads/list google code], where you'll find the Windows
    3132installers or the `tar.gz` archive for building from source:
    32 {{{#!sh
     33{{{
    3334$ tar xvfz <version>.tar.gz
    3435$ cd <version>
     
    3637}}}
    3738 
    38 This will download the latest SQLite code and build the bindings. SQLite 2.x is no longer supported.
    39 
    40 A known bug in [trac:PySqlite] versions 2.5.2-4 prohibits upgrades of Trac databases from 0.11.x to 0.12. Please use versions 2.5.5 and newer or 2.5.1 and older. See [trac:#9434] for more detail. See additional information in [trac:PySqlite PySqlite].
     39This will download the latest SQLite code and build the bindings.
     40
     41SQLite 2.x is no longer supported.
     42
     43A known bug PySqlite versions 2.5.2-4 prohibits upgrade of trac databases
     44from 0.11.x to 0.12. Please use versions 2.5.5 and newer or 2.5.1 and
     45older. See #9434 for more detail.
     46
     47See additional information in [trac:PySqlite PySqlite].
    4148
    4249==== For the PostgreSQL database #ForPostgreSQL
     
    4451You need to install the database and its Python bindings:
    4552 * [http://www.postgresql.org/ PostgreSQL], version 8.0 or later
    46  * [http://pypi.python.org/pypi/psycopg2 psycopg2], version 2.0 or later
     53 * [http://pypi.python.org/pypi/psycopg2 psycopg2]
    4754
    4855See [trac:DatabaseBackend#Postgresql DatabaseBackend] for details.
    4956
     57
    5058==== For the MySQL database #ForMySQL
    5159
    52 Trac works well with MySQL, provided you follow the guidelines:
     60Trac can now work quite well with MySQL, provided you follow the guidelines.
    5361
    5462 * [http://mysql.com/ MySQL], version 5.0 or later
    5563 * [http://sf.net/projects/mysql-python MySQLdb], version 1.2.2 or later
    5664
    57 Given the caveats and known issues surrounding MySQL, read carefully the [trac:MySqlDb] page before creating the database.
     65It is '''very''' important to read carefully the [trac:MySqlDb] page before creating the database.
    5866
    5967=== Optional Dependencies
    6068
    61 ==== Version Control System
    62 
    63 ===== Subversion
     69==== Version Control System ====
     70
     71===== Subversion =====
    6472 * [http://subversion.apache.org/ Subversion], 1.5.x or 1.6.x and the '''''corresponding''''' Python bindings. Older versions starting from 1.0, like 1.2.4, 1.3.2 or 1.4.2, etc. should still work. For troubleshooting information, check the [trac:TracSubversion#Troubleshooting TracSubversion] page.
    6573
    66 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.)
     74There 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. TracSubversion points you to [http://alagazam.net Algazam], which works for me under Python 2.6.)
    6775
    6876Note that Trac '''doesn't''' use [http://pysvn.tigris.org/ PySVN], neither does it work yet with the newer `ctype`-style bindings.
    6977
     78
    7079'''Please note:''' if using Subversion, Trac must be installed on the '''same machine'''. Remote repositories are currently [trac:ticket:493 not supported].
    7180
    72 ===== Others
     81
     82===== Others =====
    7383
    7484Support for other version control systems is provided via third-parties. See [trac:PluginList] and [trac:VersionControlSystem].
    7585
    76 ==== Web Server
    77 A web server is optional because Trac is shipped with a server included, see the [#RunningtheStandaloneServer Running the Standalone Server] section below.
    78 
    79 Alternatively you can configure Trac to run in any of the following environments:
     86==== Web Server ====
     87A web server is optional because Trac is shipped with a server included, see the [#RunningtheStandaloneServer Running the Standalone Server ] section below.
     88
     89Alternatively you configure Trac to run in any of the following environments.
    8090 * [http://httpd.apache.org/ Apache] with
    8191   - [http://code.google.com/p/modwsgi/ mod_wsgi], see [wiki:TracModWSGI] and
    8292     http://code.google.com/p/modwsgi/wiki/IntegrationWithTrac
    83    - [http://modpython.org/ mod_python >= 3.3.1], (deprecated: see TracModPython)
     93   - [http://modpython.org/ mod_python 3.3.1], deprecated: see TracModPython)
    8494 * a [http://www.fastcgi.com/ FastCGI]-capable web server (see TracFastCgi)
    8595 * an [http://tomcat.apache.org/connectors-doc/ajp/ajpv13a.html AJP]-capable web
     
    8999   
    90100
    91 ==== Other Python Packages
     101==== Other Python Packages ====
    92102
    93103 * [http://babel.edgewall.org Babel], version >= 0.9.5,
     
    95105 * [http://docutils.sourceforge.net/ docutils], version >= 0.3.9
    96106   for WikiRestructuredText.
    97  * [http://pygments.org Pygments] for
     107 * [http://pygments.pocoo.org Pygments] for
    98108   [wiki:TracSyntaxColoring syntax highlighting].
    99109   [http://silvercity.sourceforge.net/ SilverCity] and/or
     
    104114   an internal time zone implementation.
    105115
    106 '''Attention''': The available versions of these dependencies are not necessarily interchangeable, so please pay attention to the version numbers. If you are having trouble getting Trac to work, please double-check all the dependencies before asking for help on the [trac:MailingList] or [trac:IrcChannel].
    107 
    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''. There are even some pages that are still talking about Trac 0.8!
    109 
    110 == Installing Trac
     116'''Attention''': The various available versions of these dependencies are not necessarily interchangable, so please pay attention to the version numbers above. If you are having trouble getting Trac to work please double-check all the dependencies before asking for help on the [trac:MailingList] or [trac:IrcChannel].
     117
     118Please 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'' (there are even some pages that are still talking about Trac 0.8!).
     119
     120
     121== Installing Trac ==
    111122=== Using `easy_install`
    112 One way to install Trac is using [http://pypi.python.org/pypi/setuptools setuptools]. With setuptools you can install Trac from the Subversion repository.
     123One way to install Trac is using [http://pypi.python.org/pypi/setuptools setuptools].
     124With setuptools you can install Trac from the subversion repository;
    113125
    114126A few examples:
    115127
    116  - Install Trac 1.0:
    117    {{{#!sh
     128 - install Trac 1.0:
     129   {{{
    118130   easy_install Trac==1.0
    119131   }}}
    120  - Install latest development version:
    121    {{{#!sh
     132   (NOT YET ENABLED)
     133 - install latest development version 1.0dev:
     134   {{{
    122135   easy_install Trac==dev
    123136   }}}
     
    125138   either use a released version or install from source
    126139
    127 {{{#!div style="border: 1pt dotted; margin: 1em"
    128 **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].
    129 }}}
    130 
    131140=== Using `pip`
    132141'pip' is an easy_install replacement that is very useful to quickly install python packages.
    133 To get a Trac installation up and running in less than 5 minutes:
     142To get a trac installation up and running in less than 5 minutes:
    134143
    135144Assuming you want to have your entire pip installation in `/opt/user/trac`
    136145
    137146 -
    138  {{{#!sh
    139 pip install trac psycopg2
     147{{{
     148pip -E /opt/user/trac install trac psycopg2
    140149}}}
    141150or
    142151 -
    143  {{{#!sh
    144 pip install trac mysql-python
    145 }}}
    146 
    147 Make sure your OS specific headers are available for pip to automatically build PostgreSQL (`libpq-dev`) or MySQL (`libmysqlclient-dev`) bindings.
     152{{{
     153pip -E /opt/user/trac install trac mysql-python
     154}}}
     155
     156Make sure your OS specific headers are available for pip to automatically build PostgreSQL (libpq-dev) or MySQL (libmysqlclient-dev) bindings.
    148157
    149158pip will automatically resolve all dependencies (like Genshi, pygments, etc.) and download the latest packages on pypi.python.org and create a self contained installation in `/opt/user/trac`.
     
    151160All 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)
    152161
    153 Additionally, you can install several Trac plugins (listed [https://pypi.python.org/pypi?:action=browse&show=all&c=516 here]) through pip.
     162Additionally, you can install several trac plugins (listed [http://pypi.python.org/pypi?:action=search&term=trac&submit=search here]) through pip.
     163
     164
    154165
    155166=== From source
    156 Of course, 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`), or you can get the source directly from the repository. See [trac:SubversionRepository] for details.
    157 
    158 {{{#!sh
     167Of course, using the python-typical setup at the top of the source directory also works.
     168
     169You can obtain the source for a .tar.gz or .zip file corresponding to a release (e.g. Trac-1.0.tar.gz), or you can get the source directly from the repository (see Trac:SubversionRepository for details).
     170
     171{{{
    159172$ python ./setup.py install
    160173}}}
    161174
    162 ''You will need root permissions or equivalent for this step.''
    163 
    164 This will byte-compile the Python source code and install it as an .egg file or folder in the `site-packages` directory
    165 of your Python installation. The .egg will also contain all other resources needed by standard Trac, such as `htdocs` and `templates`.
     175''You'll need root permissions or equivalent for this step.''
     176
     177This will byte-compile the python source code and install it as an .egg file or folder in the `site-packages` directory
     178of your Python installation. The .egg will also contain all other resources needed by standard Trac, such as htdocs and templates.
    166179
    167180The script will also install the [wiki:TracAdmin trac-admin] command-line tool, used to create and maintain [wiki:TracEnvironment project environments], as well as the [wiki:TracStandalone tracd] standalone server.
    168181
    169 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):
    170 {{{#!sh
     182If 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):
     183{{{
    171184$ python ./setup.py install
    172185}}}
    173 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`).
    174 
    175 === Advanced Options
     186Alternatively, you can do a `bdist_egg` and copy the .egg from dist/ to the place of your choice, or you can create a Windows installer (`bdist_wininst`).
     187
     188=== Advanced Options ===
    176189
    177190To install Trac to a custom location, or find out about other advanced installation options, run:
    178 {{{#!sh
     191{{{
    179192easy_install --help
    180193}}}
    181194
    182 Also see [http://docs.python.org/2/install/index.html Installing Python Modules] for detailed information.
     195Also see [http://docs.python.org/inst/inst.html Installing Python Modules] for detailed information.
    183196
    184197Specifically, you might be interested in:
    185 {{{#!sh
     198{{{
    186199easy_install --prefix=/path/to/installdir
    187200}}}
    188 or, if installing Trac on a Mac OS X system:
    189 {{{#!sh
     201or, if installing Trac to a Mac OS X system:
     202{{{
    190203easy_install --prefix=/usr/local --install-dir=/Library/Python/2.5/site-packages
    191204}}}
    192 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.6/site-packages }}} by default.
     205Note: 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.6/site-packages }}} by default
    193206
    194207The 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.
    195208
    196 == Creating a Project Environment
    197 
    198 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.
     209
     210== Creating a Project Environment ==
     211
     212A [TracEnvironment Trac environment] is the backend storage 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 various other files and directories.
    199213
    200214A new environment is created using [wiki:TracAdmin trac-admin]:
    201 {{{#!sh
     215{{{
    202216$ trac-admin /path/to/myproject initenv
    203217}}}
     
    206220
    207221Using the default database connection string in particular will always work as long as you have SQLite installed.
    208 For the other [trac:DatabaseBackend database backends] you should plan ahead and already have a database ready to use at this point.
    209 
    210 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.
     222For the other [DatabaseBackend database backends] you should plan ahead and already have a database ready to use at this point.
     223
     224Since 0.12, Trac doesn't ask for a [TracEnvironment#SourceCodeRepository source code repository] anymore when creating an environment. Repositories can be [TracRepositoryAdmin added] afterward, or the version control support can be disabled completely if you don't need it.
    211225
    212226Also note that the values you specify here can be changed later by directly editing the [TracIni conf/trac.ini] configuration file.
    213227
    214 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.
    215 
    216228Finally, 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:
    217 {{{#!sh
    218 $ chown -R apache.apache /path/to/myproject
    219 }}}
    220 
    221 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{{{
     230# chown -R apache.apache /path/to/myproject
     231}}}
    222232
    223233{{{#!div class=important
     
    225235}}}
    226236
     237
    227238== Deploying Trac
    228239
    229 === Running the Standalone Server
     240=== Running the Standalone Server ===
    230241
    231242After having created a Trac environment, you can easily try the web interface by running the standalone server [wiki:TracStandalone tracd]:
    232 {{{#!sh
     243{{{
    233244$ tracd --port 8000 /path/to/myproject
    234245}}}
    235246
    236247Then, 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:
    237 {{{#!sh
     248{{{
    238249$ tracd -s --port 8000 /path/to/myproject
    239250}}}
    240251
    241 {{{#!div style="border: 1pt dotted; margin: 1em"
    242 **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.
    243 
    244 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`.
    245 {{{#!sh
    246 export PKG_RESOURCES_CACHE_ZIP_MANIFESTS=1
    247 }}}
    248 
    249 Alternatively, the variable can be set in the shell before executing `tracd`:
    250 {{{#!sh
    251 $ PKG_RESOURCES_CACHE_ZIP_MANIFESTS=1 tracd --port 8000 /path/to/myproject
    252 }}}
    253 }}}
    254 
    255 === Running Trac on a Web Server
     252=== Running Trac on a Web Server ===
    256253
    257254Trac provides various options for connecting to a "real" web server:
     
    263260Trac 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.
    264261
    265 ==== Generating the Trac cgi-bin directory #cgi-bin
     262==== Generating the Trac cgi-bin directory ==== #cgi-bin
    266263
    267264In 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 [wiki:TracAdmin trac-admin].
    268265
    269266There is, however, a bit of a chicken-and-egg problem. The [wiki: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:
    270 {{{#!sh
     267{{{
    271268mkdir -p /usr/share/trac/projects/my-project
    272269trac-admin /usr/share/trac/projects/my-project initenv
     
    274271mv /tmp/deploy/* /usr/share/trac
    275272}}}
    276 Don't forget to check that the web server has the execution right on scripts in the `/usr/share/trac/cgi-bin` directory.
    277 
    278 ==== Mapping Static Resources
     273
     274
     275==== Mapping Static Resources ====
    279276
    280277Out 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).
     
    292289 - `<plugins>/` - one directory for each resource directory managed by the plugins enabled for this environment
    293290
    294 ===== Example: Apache and `ScriptAlias` #ScriptAlias-example
     291===== Example: Apache and `ScriptAlias` ===== #ScriptAlias-example
    295292
    296293Assuming the deployment has been done this way:
    297 {{{#!sh
    298 $ trac-admin /var/trac/env deploy /path/to/shared/trac
     294{{{
     295$ trac-admin /var/trac/env deploy /path/to/trac/htdocs/common
    299296}}}
    300297
    301298Add 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:
    302 {{{#!apache
     299{{{
    303300Alias /trac/chrome/common /path/to/trac/htdocs/common
    304301Alias /trac/chrome/site /path/to/trac/htdocs/site
     
    311308
    312309If using mod_python, you might want to add this too (otherwise, the alias will be ignored):
    313 {{{#!apache
     310{{{
    314311<Location "/trac/chrome/common/">
    315312  SetHandler None
     
    320317
    321318Similarly, 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):
    322 {{{#!apache
     319{{{
    323320Alias /trac/chrome/site /path/to/projectenv/htdocs
    324321
     
    330327
    331328Alternatively to aliasing `/trac/chrome/common`, you can tell Trac to generate direct links for those static resources (and only those), using the [[wiki:TracIni#trac-section| [trac] htdocs_location]] configuration setting:
    332 {{{#!ini
     329{{{
    333330[trac]
    334331htdocs_location = http://static.example.org/trac-common/
     
    337334
    338335Of 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:
    339 {{{#!sh
     336{{{
    340337$ ln -s /path/to/trac/htdocs/common /var/www/static.example.org/trac-common
    341338}}}
    342339
    343 ==== Setting up the Plugin Cache
    344 
    345 Some 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.
    346 
    347 == Configuring Authentication
    348 
    349 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.
     340
     341==== Setting up the Plugin Cache ====
     342
     343Some 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.
     344
     345== Configuring Authentication ==
     346
     347Trac 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.
    350348
    351349The process of adding, removing, and configuring user accounts for authentication depends on the specific way you run Trac.
     
    356354 * TracFastCgi if you're using another web server with FCGI support (Cherokee, Lighttpd, !LiteSpeed, nginx)
    357355
    358 The following document also constains some useful information for beginners: [trac:TracAuthenticationIntroduction].
    359 
    360356== Granting admin rights to the admin user
    361357Grant admin rights to user admin:
    362 {{{#!sh
     358{{{
    363359$ trac-admin /path/to/myproject permission add admin TRAC_ADMIN
    364360}}}
    365 This user will have an "Admin" entry menu that will allow you to administrate your Trac project.
     361This user will have an "Admin" entry menu that will allow you to admin your trac project.
    366362
    367363== Finishing the install
    368364
    369 === Enable version control components
    370 
    371 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.
    372 
    373 The components can be 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.
    374 
    375 {{{#!ini
    376 tracopt.versioncontrol.svn.* = enabled
    377 }}}
    378 
    379 {{{#!ini
    380 tracopt.versioncontrol.git.* = enabled
    381 }}}
    382 
    383 After enabling the components, repositories can be configured through the "Repositories" admin panel or by editing [TracIni#repositories-section trac.ini].
    384 
    385 === Automatic reference to the SVN changesets in Trac tickets
     365=== Automatic reference to the SVN changesets in Trac tickets ===
    386366
    387367You can configure SVN to automatically add a reference to the changeset into the ticket comments, whenever changes are committed to the repository. The description of the commit needs to contain one of the following formulas:
     
    390370
    391371This functionality requires a post-commit hook to be installed as described in [wiki:TracRepositoryAdmin#ExplicitSync TracRepositoryAdmin], and enabling the optional commit updater components by adding the following line to the `[components]` section of your [wiki:TracIni#components-section trac.ini], or enabling the components in the "Plugins" admin panel.
    392 {{{#!ini
     372{{{
    393373tracopt.ticket.commit_updater.* = enabled
    394374}}}
    395375For more information, see the documentation of the `CommitTicketUpdater` component in the "Plugins" admin panel.
    396376
    397 === Using Trac
     377=== Using Trac ===
    398378
    399379Once 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.