Changes between Version 2 and Version 3 of TracInstall


Ignore:
Timestamp:
May 2, 2019, 9:45:05 AM (14 months ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracInstall

    v2 v3  
    1 = Trac Installation Guide for 1.1
     1= Trac Installation Guide for 1.0
     2
    23[[TracGuideToc]]
    34
    45Trac 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.
    56
    6 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.
     7Since 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.
    78
    89If 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].
    910
    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.
     11What 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.
    1112
    1213[[PageOutline(2-3,Installation Steps,inline)]]
    1314
    1415== Dependencies
     16
    1517=== Mandatory Dependencies
     18
    1619To install Trac, the following software packages must be installed:
    1720
    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)
     21 * [http://www.python.org/ Python], version >= 2.5 and < 3.0
     22   (note that we dropped the support for Python 2.4 in this release)
    2023 * [http://pypi.python.org/pypi/setuptools setuptools], version >= 0.6
    2124 * [http://genshi.edgewall.org/wiki/Download Genshi], version >= 0.6
     
    2528==== For the SQLite database #ForSQLite
    2629
    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 [http://pypi.python.org/pypi/pysqlite pysqlite] than the one provided by the Python distribution. See [trac:PySqlite#ThePysqlite2bindings PySqlite] for details.
     30As you must be using Python 2.5, 2.6 or 2.7, you already have the SQLite database bindings bundled with the standard distribution of Python: the `sqlite3` module.
     31
     32Optionally, 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.
    3033
    3134==== For the PostgreSQL database #ForPostgreSQL
     
    4144Trac works well with MySQL, provided you follow the guidelines:
    4245
    43  * [http://mysql.com/ MySQL], version 5.0 or later
     46 * [http://mysql.com/ MySQL] or [http://mariadb.org/ MariaDB], version 5.0 or later
    4447 * [http://sf.net/projects/mysql-python MySQLdb], version 1.2.2 or later
    4548
    46 Given the caveats and known issues surrounding MySQL, read carefully the [trac:MySqlDb] page before creating the database.
     49Given the caveats and known issues surrounding MySQL, read the [trac:MySqlDb] page before creating the database.
    4750
    4851=== Optional Dependencies
    4952
    50 ==== Subversion
    51 
    52 [http://subversion.apache.org/ Subversion], 1.6.x or later and the '''''corresponding''''' Python bindings.
     53==== Version Control System
     54
     55===== Subversion
     56 * [http://subversion.apache.org/ Subversion], 1.5.x or later and the '''corresponding''' Python bindings. Older versions starting from 1.0, like 1.2.4, 1.3.2 or 1.4.2, etc. may still work. For troubleshooting information, check the [trac:TracSubversion#Troubleshooting TracSubversion] page.
    5357
    5458There 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.)
    5559
    56 For 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 
    70 Support for other version control systems is provided via third-party plugins. See [trac:PluginList#VersionControlSystems] and [trac:VersionControlSystem].
     60Note that Trac '''doesn't''' use [http://pysvn.tigris.org/ PySVN], neither does it work yet with the newer `ctype`-style bindings.
     61
     62'''Note:''' if using Subversion, Trac must be installed on the '''same machine'''. Remote repositories are currently [trac:ticket:493 not supported].
     63
     64===== Git
     65 * [http://git-scm.com/ Git] 1.5.6 or later.
     66
     67More information is available on the [trac:TracGit] page.
     68
     69===== Others
     70
     71Support for other version control systems is provided via third-parties. See [trac:PluginList#VersionControlSystems] and [trac:VersionControlSystem].
    7172
    7273==== Web Server
    73 A web server is optional because Trac is shipped with a server included, see the [#RunningtheStandaloneServer Running the Standalone Server] section below.
     74
     75A web server is optional because Trac has a server included, see the [#RunningtheStandaloneServer Running the Standalone Server] section below.
    7476
    7577Alternatively you can configure Trac to run in any of the following environments:
    7678 * [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].
     79   - [http://code.google.com/p/modwsgi/ mod_wsgi], see [wiki:TracModWSGI] and
     80     http://code.google.com/p/modwsgi/wiki/IntegrationWithTrac
    7981   - [http://modpython.org/ mod_python 3.5.0], see TracModPython
    8082 * a [http://www.fastcgi.com/ FastCGI]-capable web server (see TracFastCgi)
    8183 * an [http://tomcat.apache.org/connectors-doc/ajp/ajpv13a.html AJP]-capable web
    8284   server (see [trac:TracOnWindowsIisAjp TracOnWindowsIisAjp])
    83  * Microsoft IIS with FastCGI and a FastCGI-to-WSGI gateway (see [trac:CookBook/Installation/TracOnWindowsIisWfastcgi IIS with FastCGI])
    84  * a CGI-capable web server (see TracCgi), '''but usage of Trac as a cgi script
    85    is highly discouraged''', better use one of the previous options.
     85 * a FastCGI and FastCGI-to-WSGI gateway (see [trac:TracOnWindowsIisWfastcgi])
     86 * a CGI-capable web server (see TracCgi), but //usage of Trac as a cgi script
     87   is highly discouraged//, better use one of the previous options.
    8688   
    87 
    8889==== Other Python Packages
    8990
    90  * [http://babel.edgewall.org Babel], version 0.9.6 or >= 1.3,
     91 * [http://babel.edgewall.org Babel], version 0.9.5, 0.9.6 or >= 1.3
    9192   needed for localization support
    9293 * [http://docutils.sourceforge.net/ docutils], version >= 0.3.9
     
    9495 * [http://pygments.org Pygments] for
    9596   [TracSyntaxColoring syntax highlighting].
     97   [http://silvercity.sourceforge.net/ SilverCity] and/or
     98   [http://gnu.org/software/enscript/enscript.html Enscript] may still be used
     99   but are deprecated and you really should be using Pygments.
    96100 * [http://pytz.sf.net pytz] to get a complete list of time zones,
    97101   otherwise Trac will fall back on a shorter list from
     
    102106}}}
    103107
    104 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''.
     108Please 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.
    105109
    106110== Installing Trac
     
    108112The [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.
    109113
    110 It 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.
    111 
    112114=== Using `easy_install`
    113 Trac can be installed from PyPI or the Subversion repository using [http://pypi.python.org/pypi/setuptools setuptools].
    114 
    115 A few examples:
    116 
    117  - Install the latest stable version of Trac:
     115
     116Trac can be installed from [https://pypi.python.org/pypi/Trac PyPI] or the Subversion repository using [pypi:setuptools setuptools].
     117
     118A few command-line examples:
     119
     120 - Install Trac 1.0:
    118121 {{{#!sh
    119 $ easy_install Trac
     122$ easy_install Trac==1.0
    120123}}}
    121124 - Install latest development version:
    122125 {{{#!sh
    123 $ easy_install http://download.edgewall.org/trac/Trac-latest-dev.tar.gz
     126$ easy_install Trac==dev
    124127}}}
    125128   Note that in this case you won't have the possibility to run a localized version of Trac;
    126    either use a released version or install from source 
    127 
    128 More information can be found on the [trac:wiki:setuptools setuptools] page.
     129   either use a released version or install from source.
     130
     131More information can be found on the [trac:setuptools] page.
    129132
    130133{{{#!div style="border: 1pt dotted; margin: 1em"
    131 **Setuptools Warning:** If the version of your setuptools is in the range 5.4 through 5.6, the environment variable `PKG_RESOURCES_CACHE_ZIP_MANIFESTS` must be set in order to avoid significant performance degradation. More information may be found in [#DeployingTrac Deploying Trac].
     134**Setuptools Warning:** If the version of your setuptools is in the range 5.4 through 5.6, the environment variable `PKG_RESOURCES_CACHE_ZIP_MANIFESTS` must be set in order to avoid significant performance degradation. More information may be found in the sections on [#RunningtheStandaloneServer Running The Standalone Server] and [#RunningTraconaWebServer Running Trac on a Web Server].
    132135}}}
    133136
    134137=== Using `pip`
    135 'pip' is an easy_install replacement that is very useful to quickly install python packages.
     138
     139'pip' is an easy_install replacement that is very useful to quickly install Python packages.
    136140To get a Trac installation up and running in less than 5 minutes:
    137141
    138 Assuming you want to have your entire pip installation in `/opt/user/trac`
     142Assuming you want to have your entire pip installation in `/opt/user/trac`:
    139143
    140144 -
    141145 {{{#!sh
    142 pip install trac psycopg2
    143 }}}
    144 or
     146$ pip install trac psycopg2
     147}}}
     148or:
    145149 -
    146150 {{{#!sh
    147 pip install trac mysql-python
     151$ pip install trac mysql-python
    148152}}}
    149153
     
    152156pip 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`.
    153157
    154 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)
     158All 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).
    155159
    156160Additionally, you can install several Trac plugins (listed [https://pypi.python.org/pypi?:action=browse&show=all&c=516 here]) through pip.
    157161
    158162=== From source
     163
    159164Using 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.
    160165
     
    163168}}}
    164169
    165 ''You will need root permissions or equivalent for this step.''
     170You will need root permissions or equivalent for this step.
    166171
    167172This will byte-compile the Python source code and install it as an .egg file or folder in the `site-packages` directory
     
    172177$ python ./setup.py install
    173178}}}
     179
    174180Alternatively, 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`).
    175181
    176182=== Using installer
    177183
    178 On 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.
     184On 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.
    179185
    180186=== Using package manager
    181187
    182 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.
     188Trac 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.
    183189
    184190=== Advanced `easy_install` Options
     
    186192To install Trac to a custom location, or find out about other advanced installation options, run:
    187193{{{#!sh
    188 easy_install --help
     194$ easy_install --help
    189195}}}
    190196
     
    193199Specifically, you might be interested in:
    194200{{{#!sh
    195 easy_install --prefix=/path/to/installdir
    196 }}}
     201$ easy_install --prefix=/path/to/installdir
     202}}}
     203
    197204or, if installing Trac on a Mac OS X system:
    198205{{{#!sh
    199 easy_install --prefix=/usr/local --install-dir=/Library/Python/2.6/site-packages
    200 }}}
    201 
    202 {{{#!div style="border: 1pt dotted; margin: 1em"
    203 **Mac OS X Note:** On Mac OS X 10.6,  running `easy_install trac` will install into `/usr/local` and `/Library/Python/2.6/site-packages` by default.
    204 
    205 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.
    206 }}}
     206$ easy_install --prefix=/usr/local --install-dir=/Library/Python/2.5/site-packages
     207}}}
     208
     209'''Note''': If installing on Mac OS X 10.6 running {{{ easy_install http://svn.edgewall.org/repos/trac/trunk }}} will install into {{{ /usr/local }}} and {{{ /Library/Python/2.5/site-packages }}} by default.
     210
     211The 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.
    207212
    208213== Creating a Project Environment
    209214
    210 A [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.
     215A [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.
    211216
    212217A new environment is created using [TracAdmin trac-admin]:
     
    215220}}}
    216221
    217 [TracAdmin trac-admin] will prompt you for the information it needs to create the environment: the name of the project and the [TracEnvironment#DatabaseConnectionStrings database connection string]. If you're not sure what to specify for any of these options, just press `<Enter>` to use the default value.
    218 
    219 Using the default database connection string will always work as long as you have SQLite installed. For the other [trac:DatabaseBackend database backends] you should plan ahead and already have a database ready to use at this point.
    220 
    221 Also note that the values you specify here can be changed later using TracAdmin or directly editing the [TracIni conf/trac.ini] configuration file.
     222[TracAdmin trac-admin] will prompt you for the information it needs to create the environment, such as the name of the project and the [TracEnvironment#DatabaseConnectionStrings database connection string]. If you're not sure what to specify for one of these options, just press `<Enter>` to use the default value.
     223
     224Using the default database connection string in particular will always work as long as you have SQLite installed.
     225For the other [trac:DatabaseBackend database backends] you should plan ahead and already have a database ready to use at this point.
     226
     227Since 0.12, Trac doesn't ask for a [TracEnvironment#SourceCodeRepository source code repository] anymore when creating an environment. Repositories can be [TracRepositoryAdmin added] afterwards, and support for specific version control systems is disabled by default.
     228
     229Also note that the values you specify here can be changed later by directly editing the [TracIni conf/trac.ini] configuration file.
    222230
    223231{{{#!div style="border: 1pt dotted; margin: 1em"
     
    227235Finally, 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:
    228236{{{#!sh
    229 $ chown -R apache:apache /path/to/myproject
    230 }}}
    231 
    232 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).
     237$ chown -R apache.apache /path/to/myproject
     238}}}
     239
     240The 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).
    233241
    234242{{{#!div class=important
     
    238246== Deploying Trac
    239247
     248=== Running the Standalone Server
     249
     250After having created a Trac environment, you can easily try the web interface by running the standalone server [TracStandalone tracd]:
     251{{{#!sh
     252$ tracd --port 8000 /path/to/myproject
     253}}}
     254
     255Then, 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:
     256{{{#!sh
     257$ tracd -s --port 8000 /path/to/myproject
     258}}}
     259
    240260{{{#!div style="border: 1pt dotted; margin: 1em"
    241 **Setuptools Warning:** If the version of your setuptools is in the range 5.4 through 5.6, the environment variable `PKG_RESOURCES_CACHE_ZIP_MANIFESTS` must be set in order to avoid significant performance degradation.
    242 
    243 If 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.
     261**Setuptools Warning:** If the version of your setuptools is in the range 5.4 through 5.6, the environment variable `PKG_RESOURCES_CACHE_ZIP_MANIFESTS` must be set in order to avoid significant performance degradation. The environment variable can be set system-wide, or for just the user that runs the `tracd` process. There are several ways to accomplish this in addition to what is discussed here, and depending on the distribution of your OS.
    244262
    245263To 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`.
     
    252270$ PKG_RESOURCES_CACHE_ZIP_MANIFESTS=1 tracd --port 8000 /path/to/myproject
    253271}}}
    254 
    255 If running the Apache web server, !Ubuntu/Debian users should add the `export` statement to `/etc/apache2/envvars`. !RedHat/CentOS/Fedora should can add the `export` statement to `/etc/sysconfig/httpd`.
    256 }}}
    257 
    258 === Running the Standalone Server
    259 
    260 After having created a Trac environment, you can easily try the web interface by running the standalone server [TracStandalone tracd]:
    261 {{{#!sh
    262 $ tracd --port 8000 /path/to/myproject
    263 }}}
    264 
    265 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:
    266 {{{#!sh
    267 $ tracd -s --port 8000 /path/to/myproject
    268272}}}
    269273
     
    272276Trac provides various options for connecting to a "real" web server:
    273277 - [TracFastCgi FastCGI]
    274  - [wiki:TracModWSGI Apache with mod_wsgi]
    275  - [TracModPython Apache with mod_python]
    276  - //[TracCgi CGI] (should not be used, as the performance is far from optimal)//
     278 - [wiki:TracModWSGI mod_wsgi]
     279 - [TracModPython mod_python]
     280 - //[TracCgi CGI]: should not be used, as it degrades performance//
    277281
    278282Trac 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.
     
    284288There 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:
    285289{{{#!sh
    286 mkdir -p /usr/share/trac/projects/my-project
    287 trac-admin /usr/share/trac/projects/my-project initenv
    288 trac-admin /usr/share/trac/projects/my-project deploy /tmp/deploy
    289 mv /tmp/deploy/* /usr/share/trac
    290 }}}
     290$ mkdir -p /usr/share/trac/projects/my-project
     291$ trac-admin /usr/share/trac/projects/my-project initenv
     292$ trac-admin /usr/share/trac/projects/my-project deploy /tmp/deploy
     293$ mv /tmp/deploy/* /usr/share/trac
     294}}}
     295
    291296Don't forget to check that the web server has the execution right on scripts in the `/usr/share/trac/cgi-bin` directory.
    292297
    293298==== Mapping Static Resources
    294299
    295 Without additional configuration, Trac will handle requests for static resources such as stylesheets and images. For anything other than a TracStandalone deployment, this is not optimal as the web server can be set up to directly serve the static resources. For CGI setup, this is '''highly undesirable''' as it causes abysmal performance.
    296 
    297 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 their location on the file system. We can map requests for static resources directly to directories on the file system, to avoid Trac processing the requests.
    298 
    299 There are two primary URL paths for static resources: `/chrome/common` and `/chrome/site`. Plugins can add their own resources, usually accessible at the `/chrome/<plugin>` path.
    300 
    301 A single `/chrome` alias can used if the static resources are extracted for all plugins. This means that the `deploy` command must be executed after installing or updating a plugin that provides static resources, or after modifying resources in the `$env/htdocs` directory. This is probably appropriate for most installations but may not be what you want if, for example, you wish to upload plugins through the //Plugins// administration page.
    302 
    303 The resources are extracted using the [TracAdmin trac-admin]` <environment> deploy` command:
     300Out of the box, Trac will pass static resources such as style sheets or images through itself. For anything but a tracd only based deployment, this is far from optimal as the web server could be set up to directly serve those static resources. For CGI setup, this is '''highly undesirable''' as it causes abysmal performance.
     301
     302Web servers such as [http://httpd.apache.org/ Apache] allow you to create "Aliases" to resources, giving them a virtual URL that doesn't necessarily reflect the layout of the servers file system. We also can map requests for static resources directly to the directory on the file system, avoiding processing these requests by Trac itself.
     303
     304There are two primary URL paths for static resources - `/chrome/common` and `/chrome/site`. Plugins can add their own resources, usually accessible by `/chrome/<plugin>` path, so its important to override only known paths and not try to make universal `/chrome` alias for everything.
     305
     306Note 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:
    304307[[TracAdminHelp(deploy)]]
    305308
    306 The target `<directory>` will contain an `htdocs` directory with:
    307  - `common/` - the static resources of Trac
    308  - `site/` - a copy of the environment's `htdocs/` directory
    309  - `shared` - the static resources shared by multiple Trac environments, with a location defined by the `[inherit]` `htdocs_dir` option
    310  - `<plugin>/` - one directory for each resource directory provided by the plugins enabled for this environment
    311 
    312 The 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:
     309The target `<directory>` will then contain an `htdocs` directory with:
     310 - `site/` - a copy of the environment's directory `htdocs/`
     311 - `common/` - the static resources of Trac itself
     312 - `<plugins>/` - one directory for each resource directory managed by the plugins enabled for this environment
     313
     314===== Example: Apache and `ScriptAlias` #ScriptAlias-example
     315
     316Assuming the deployment has been done this way:
     317{{{#!sh
     318$ trac-admin /var/trac/env deploy /path/to/shared/trac
     319}}}
     320
     321Add 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:
    313322{{{#!apache
    314323Alias /trac/chrome/common /path/to/trac/htdocs/common
    315324Alias /trac/chrome/site /path/to/trac/htdocs/site
    316 Alias /trac/chrome/shared /path/to/trac/htdocs/shared
    317 Alias /trac/chrome/<plugin> /path/to/trac/htdocs/<plugin>
    318 }}}
    319 
    320 ===== Example: Apache and `ScriptAlias` #ScriptAlias-example
    321 
    322 Assuming the deployment has been done this way:
    323 {{{#!sh
    324 $ trac-admin /var/trac/env deploy /path/to/shared/trac
    325 }}}
    326 
    327 Add 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:
     325
     326<Directory "/path/to/www/trac/htdocs">
     327  Order allow,deny
     328  Allow from all
     329</Directory>
     330}}}
     331
     332If using mod_python, you might want to add this too, otherwise the alias will be ignored:
    328333{{{#!apache
    329 Alias /trac/chrome /path/to/trac/htdocs
    330 
    331 <Directory "/path/to/www/trac/htdocs">
    332   # For Apache 2.2
    333   <IfModule !mod_authz_core.c>
    334     Order allow,deny
    335     Allow from all
    336   </IfModule>
    337   # For Apache 2.4
    338   <IfModule mod_authz_core.c>
    339     Require all granted
    340   </IfModule>
    341 </Directory>
    342 }}}
    343 
    344 If using mod_python, add this too, otherwise the alias will be ignored:
    345 {{{#!apache
    346 <Location "/trac/chrome/common">
     334<Location "/trac/chrome/common/">
    347335  SetHandler None
    348336</Location>
    349337}}}
    350338
    351 Alternatively, 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:
     339Note that we mapped `/trac` part of the URL to the `trac.*cgi` script, and the path `/trac/chrome/common` is the path you have to append to that location to intercept requests to the static resources.
     340
     341Similarly, 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):
    352342{{{#!apache
    353343Alias /trac/chrome/site /path/to/projectenv/htdocs
    354344
    355345<Directory "/path/to/projectenv/htdocs">
    356   # For Apache 2.2
    357   <IfModule !mod_authz_core.c>
    358     Order allow,deny
    359     Allow from all
    360   </IfModule>
    361   # For Apache 2.4
    362   <IfModule mod_authz_core.c>
    363     Require all granted
    364   </IfModule>
     346  Order allow,deny
     347  Allow from all
    365348</Directory>
    366349}}}
    367350
    368 Another alternative to aliasing `/trac/chrome/common` is having Trac generate direct links for those static resources (and only those), using the [[TracIni#trac-section| [trac] htdocs_location]] configuration setting:
     351Alternatively 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:
    369352{{{#!ini
    370353[trac]
     
    372355}}}
    373356
    374 Note that this makes it easy to have a dedicated domain serve those static resources, preferentially cookie-less.
     357Note 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].
    375358
    376359Of 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:
     
    391374Please refer to one of the following sections:
    392375 * TracStandalone#UsingAuthentication if you use the standalone server, `tracd`.
    393  * [wiki:TracModWSGI#ConfiguringAuthentication TracModWSGI#ConfiguringAuthentication] if you use the Apache web server, with any of its front end: `mod_wsgi`, `mod_python`, `mod_fcgi` or `mod_fastcgi`.
    394  * TracFastCgi if you're using another web server with FCGI support (Cherokee, Lighttpd, !LiteSpeed, nginx)
    395 
    396 [trac:TracAuthenticationIntroduction] also contains some useful information for beginners.
     376 * [wiki:TracModWSGI#ConfiguringAuthentication TracModWSGI#ConfiguringAuthentication] if you use the Apache web server, with any of its front end: `mod_wsgi` of course, but the same instructions applies also for `mod_python`, `mod_fcgi` or `mod_fastcgi`.
     377 * TracFastCgi if you are using another web server with FCGI support, such as Cherokee, Lighttpd, !LiteSpeed, nginx.
     378
     379The following document also contains some useful information for beginners: [trac:TracAuthenticationIntroduction].
    397380
    398381== Granting admin rights to the admin user
     382
    399383Grant admin rights to user admin:
    400384{{{#!sh
     
    402386}}}
    403387
    404 This user will have an //Admin// navigation item that directs to pages for administering your Trac project.
    405 
    406 == Configuring Trac
    407 
    408 TracRepositoryAdmin provides information on configuring version control repositories for your project.
    409 
    410 == Using Trac
     388This user will have an "Admin" entry menu that will allow you to administrate your Trac project.
     389
     390== Finishing the install
     391
     392=== Enable version control components
     393
     394Support for version control systems is provided by optional components in Trac and the components are disabled by default //(since 1.0)//. Subversion and Git must be explicitly enabled if you wish to use them. See TracRepositoryAdmin for more details.
     395
     396The version control systems are enabled by adding the following to the `[components]` section of your [TracIni#components-section trac.ini], or enabling the components in the "Plugins" admin panel:
     397
     398{{{#!ini
     399[components]
     400tracopt.versioncontrol.svn.* = enabled
     401}}}
     402
     403{{{#!ini
     404[components]
     405tracopt.versioncontrol.git.* = enabled
     406}}}
     407
     408After enabling the components, repositories can be configured through the //Repositories// admin panel or by editing [TracIni#repositories-section trac.ini]. Automatic changeset references can be inserted as ticket comments by configuring [TracRepositoryAdmin#Automaticchangesetreferencesintickets CommitTicketUpdater].
     409
     410=== Using Trac
    411411
    412412Once you have your Trac site up and running, you should be able to create tickets, view the timeline, browse your version control repository if configured, etc.