Changes between Version 2 and Version 3 of TracInstall


Ignore:
Timestamp:
10/08/16 19:26:27 (8 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracInstall

    v2 v3  
    1 = Trac Installation Guide for 0.12 =
     1{{{#!div style="margin-top: .5em; padding: 0 1em; background-color: #ffd; border:1px outset #ddc; text-align: center"
     2
     3 '''NOTE: the information in this page applies to Trac 1.0, the current version of Trac. \\
     4 For installing previous Trac versions, please refer to [[wiki:0.12/TracInstall]] (for Trac 0.12)'''
     5}}}
     6
     7= Trac Installation Guide for 1.0
    28[[TracGuideToc]]
    39
    410Trac 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.
    511
    6 Since 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 
    8 If you're interested in contributing new translations for other languages or enhance the existing translations, then please have a look at [[trac:TracL10N]].
    9 
    10 What 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 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.
     12Since 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.
     13
     14If 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].
     15
     16What 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.
    1117
    1218[[PageOutline(2-3,Installation Steps,inline)]]
    1319
    14 == Dependencies ==
     20== Dependencies
    1521=== Mandatory Dependencies
    1622To install Trac, the following software packages must be installed:
    1723
    18  * [http://www.python.org/ Python], version >= 2.4 and < 3.0
    19    (note that we dropped the support for Python 2.3 in this release)
     24 * [http://www.python.org/ Python], version >= 2.5 and < 3.0
     25   (note that we dropped the support for Python 2.4 in this release)
    2026 * [http://peak.telecommunity.com/DevCenter/setuptools setuptools], version >= 0.6
    2127 * [http://genshi.edgewall.org/wiki/Download Genshi], version >= 0.6
    … …  
    2632==== For the SQLite database #ForSQLite
    2733
    28 If you're using Python 2.5 or 2.6, you already have everything you need.
    29 
    30 If you're using Python 2.4 and need pysqlite, you can download from
    31 [http://code.google.com/p/pysqlite/downloads/list google code] the Windows
    32 installers or the tar.gz archive for building from source:
    33 {{{
     34As 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).
     35
     36However, if you'd like, you can download the latest and greatest version of [[trac:PySqlite]] from
     37[http://code.google.com/p/pysqlite/downloads/list google code], where you'll find the Windows
     38installers or the `tar.gz` archive for building from source:
     39{{{#!sh
    3440$ tar xvfz <version>.tar.gz
    3541$ cd <version>
    … …  
    3743}}}
    3844 
    39 This will extract the SQLite code and build the bindings.
    40 
    41 SQLite 2.x is no longer supported. For SQLite 3.x, the pysqlite 1.1.x
    42 bindings are also no longer supported, use pysqlite 2.x.
     45This will download the latest SQLite code and build the bindings.
     46
     47SQLite 2.x is no longer supported.
     48
     49A known bug in PySqlite versions 2.5.2-4 prohibits upgrades of Trac databases
     50from 0.11.x to 0.12. Please use versions 2.5.5 and newer or 2.5.1 and
     51older. See #9434 for more detail.
    4352
    4453See additional information in [trac:PySqlite PySqlite].
    … …  
    4756
    4857You need to install the database and its Python bindings:
    49  * [http://www.postgresql.org/ PostgreSQL]
    50  * [http://pypi.python.org/pypi/psycopg2 psycopg2]
     58 * [http://www.postgresql.org/ PostgreSQL], version 8.0 or later
     59 * [http://pypi.python.org/pypi/psycopg2 psycopg2], version 2.0 or later
    5160
    5261See [trac:DatabaseBackend#Postgresql DatabaseBackend] for details.
    … …  
    6069 * [http://sf.net/projects/mysql-python MySQLdb], version 1.2.2 or later
    6170
    62 It is '''very''' important to read carefully the  [trac:MySqlDb MySqlDb] page before creating the database.
     71It is '''very''' important to read carefully the  [trac:MySqlDb] page before creating the database.
    6372
    6473=== Optional Dependencies
    6574
    66 ==== Version Control System ====
    67 
    68 ===== Subversion =====
     75==== Version Control System
     76
     77===== Subversion
    6978 * [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.
    7079
    71 There are [http://subversion.apache.org/packages.html pre-compiled SWIG bindings] available for various platforms. Note that Trac '''doesn't''' use [http://pysvn.tigris.org/ PySVN], neither does it work yet with the newer `ctype`-style bindings
     80There 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.)
     81
     82Note that Trac '''doesn't''' use [http://pysvn.tigris.org/ PySVN], neither does it work yet with the newer `ctype`-style bindings.
    7283
    7384
    … …  
    7586
    7687
    77 ===== Others =====
    78 
    79 Support for other version control systems is provided via third-parties. See [trac:PluginList PluginList] and [trac:VersioningSystemBackend VersioningSystemBackend].
    80 
    81 ==== Web Server ====
    82 A web server is optional because Trac is shipped with a server included, see the [#RunningtheStandaloneServer Running the Standalone Server ] section below.
    83 
    84 Alternatively you configure Trac to run in any of the following environments.
     88===== Others
     89
     90Support for other version control systems is provided via third-parties. See [trac:PluginList] and [trac:VersionControlSystem].
     91
     92==== Web Server
     93A web server is optional because Trac is shipped with a server included, see the [#RunningtheStandaloneServer Running the Standalone Server] section below.
     94
     95Alternatively you can configure Trac to run in any of the following environments.
    8596 * [http://httpd.apache.org/ Apache] with
    8697   - [http://code.google.com/p/modwsgi/ mod_wsgi], see [wiki:TracModWSGI] and
    8798     http://code.google.com/p/modwsgi/wiki/IntegrationWithTrac
    88    - [http://modpython.org/ mod_python 3.3.1], see TracModPython)
     99   - [http://modpython.org/ mod_python 3.3.1], (deprecated: see TracModPython)
    89100 * a [http://www.fastcgi.com/ FastCGI]-capable web server (see TracFastCgi)
    90101 * an [http://tomcat.apache.org/connectors-doc/ajp/ajpv13a.html AJP]-capable web
    … …  
    94105   
    95106
    96 ==== Other Python Packages ====
     107==== Other Python Packages
    97108
    98109 * [http://babel.edgewall.org Babel], version >= 0.9.5,
    99    needed for localization support
     110   needed for localization support (unreleased version 1.0dev should work as well)
    100111 * [http://docutils.sourceforge.net/ docutils], version >= 0.3.9
    101112   for WikiRestructuredText.
    102  * [http://pygments.pocoo.org Pygments] for
     113 * [http://pygments.org Pygments] for
    103114   [wiki:TracSyntaxColoring syntax highlighting].
    104115   [http://silvercity.sourceforge.net/ SilverCity] and/or
    … …  
    109120   an internal time zone implementation.
    110121
    111 '''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 MailingList] or [trac:IrcChannel IrcChannel].
     122'''Attention''': The various available versions of these dependencies are not necessarily interchangeable, 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].
    112123
    113124Please 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!).
    114125
    115126
    116 == Installing Trac ==
     127== Installing Trac
    117128=== Using `easy_install`
    118 One way to install Trac is using `setuptools`.
    119 With setuptools you can install Trac from the subversion repository;
     129One way to install Trac is using [http://pypi.python.org/pypi/setuptools setuptools].
     130With setuptools you can install Trac from the Subversion repository;
    120131
    121132A few examples:
    122133
    123  - install Trac 0.12:
    124    {{{
    125    easy_install Trac==0.12
     134 - Install Trac 1.0:
     135   {{{#!sh
     136   easy_install Trac==1.0
    126137   }}}
    127 
    128  - install latest development version 0.12dev:
    129    {{{
     138 - Install latest development version:
     139   {{{#!sh
    130140   easy_install Trac==dev
    131141   }}}
    … …  
    133143   either use a released version or install from source
    134144
     145{{{#!div style="border: 1pt dotted; margin: 1em"
     146**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].
     147}}}
     148
    135149=== Using `pip`
    136150'pip' is an easy_install replacement that is very useful to quickly install python packages.
    137 To get a trac installation up and running in less than 5 minutes:
    138 
    139 Assuming you want to have your entire pip installation in /opt/user/trac
     151To get a Trac installation up and running in less than 5 minutes:
     152
     153Assuming you want to have your entire pip installation in `/opt/user/trac`
    140154
    141155 -
    142 {{{
    143 pip -E /opt/user/trac install trac psycopg2
     156 {{{#!sh
     157pip install trac psycopg2
    144158}}}
    145159or
    146160 -
    147 {{{
    148 pip -E /opt/user/trac install trac mysql-python
    149 }}}
    150 
    151 Make sure your OS specific headers are available for pip to automatically build PostgreSQL (libpq-dev) or MySQL (libmysqlclient-dev) bindings.
    152 
    153 pip 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
    154 
    155 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)
    156 
    157 Additionally, you can install several trac plugins (listed [http://pypi.python.org/pypi?:action=search&term=trac&submit=search here]) through pip.
     161 {{{#!sh
     162pip install trac mysql-python
     163}}}
     164
     165Make sure your OS specific headers are available for pip to automatically build PostgreSQL (`libpq-dev`) or MySQL (`libmysqlclient-dev`) bindings.
     166
     167pip 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`.
     168
     169All 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)
     170
     171Additionally, you can install several Trac plugins (listed [http://pypi.python.org/pypi?:action=search&term=trac&submit=search here]) through pip.
    158172
    159173
    … …  
    162176Of course, using the python-typical setup at the top of the source directory also works.
    163177
    164 You can obtain the source for a .tar.gz or .zip file corresponding to a release (e.g. Trac-0.12.tar.gz), or you can get the source directly from the repository (see Trac:SubversionRepository for details).
    165 
    166 {{{
     178You 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).
     179
     180{{{#!sh
    167181$ python ./setup.py install
    168182}}}
    … …  
    170184''You'll need root permissions or equivalent for this step.''
    171185
    172 This will byte-compile the python source code and install it as an .egg file or folder in the `site-packages` directory
    173 of your Python installation. The .egg will also contain all other resources needed by standard Trac, such as htdocs and templates.
     186This will byte-compile the Python source code and install it as an .egg file or folder in the `site-packages` directory
     187of your Python installation. The .egg will also contain all other resources needed by standard Trac, such as `htdocs` and `templates`.
    174188
    175189The 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.
    176190
    177 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):
    178 {{{
     191If 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):
     192{{{#!sh
    179193$ python ./setup.py install
    180194}}}
    181 Alternatively, 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`).
    182 
    183 === Advanced Options ===
     195Alternatively, 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`).
     196
     197=== Advanced Options
    184198
    185199To install Trac to a custom location, or find out about other advanced installation options, run:
    186 {{{
     200{{{#!sh
    187201easy_install --help
    188202}}}
    189203
    190 Also see [http://docs.python.org/inst/inst.html Installing Python Modules] for detailed information.
     204Also see [http://docs.python.org/2/install/index.html Installing Python Modules] for detailed information.
    191205
    192206Specifically, you might be interested in:
    193 {{{
     207{{{#!sh
    194208easy_install --prefix=/path/to/installdir
    195209}}}
    196 or, if installing Trac to a Mac OS X system:
    197 {{{
     210or, if installing Trac on a Mac OS X system:
     211{{{#!sh
    198212easy_install --prefix=/usr/local --install-dir=/Library/Python/2.5/site-packages
    199213}}}
    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.6/site-packages }}} by default
     214Note: 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.
    201215
    202216The 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.
    203217
    204218
    205 == Creating a Project Environment ==
     219== Creating a Project Environment
    206220
    207221A [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.
    208222
    209223A new environment is created using [wiki:TracAdmin trac-admin]:
    210 {{{
     224{{{#!sh
    211225$ trac-admin /path/to/myproject initenv
    212226}}}
    … …  
    217231For the other [DatabaseBackend database backends] you should plan ahead and already have a database ready to use at this point.
    218232
    219 Since 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.
     233Since 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.
    220234
    221235Also note that the values you specify here can be changed later by directly editing the [TracIni conf/trac.ini] configuration file.
    222236
     237When 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 (though the best advice is to opt for a platform with sub-second timestamp resolution when possible regardless of the version of Trac you are running).
     238
    223239Finally, 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:
    224 {{{
    225 # chown -R apache.apache /path/to/myproject
    226 }}}
    227 
    228 == Running the Standalone Server ==
     240{{{#!sh
     241$ chown -R apache.apache /path/to/myproject
     242}}}
     243
     244The 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).
     245
     246{{{#!div class=important
     247'''Warning:''' Please only use ASCII-characters for account name and project path, unicode characters are not supported there.
     248}}}
     249
     250
     251== Deploying Trac
     252
     253=== Running the Standalone Server
    229254
    230255After having created a Trac environment, you can easily try the web interface by running the standalone server [wiki:TracStandalone tracd]:
    231 {{{
     256{{{#!sh
    232257$ tracd --port 8000 /path/to/myproject
    233258}}}
    234259
    235260Then, 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:
    236 {{{
     261{{{#!sh
    237262$ tracd -s --port 8000 /path/to/myproject
    238263}}}
    239264
    240 == Running Trac on a Web Server ==
    241 
    242 Trac provides various options for connecting to a "real" web server: [wiki:TracCgi CGI], [wiki:TracFastCgi FastCGI], [wiki:TracModWSGI mod_wsgi] and [wiki:TracModPython mod_python]. For decent performance, it is recommended that you use either FastCGI or mod_wsgi.
    243 
    244 Trac also supports [trac:TracOnWindowsIisAjp AJP] which may be your choice if you want to connect to IIS.
    245 
    246 ==== Generating the Trac cgi-bin directory ====
     265{{{#!div style="border: 1pt dotted; margin: 1em"
     266**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.
     267
     268To 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`.
     269{{{#!sh
     270export PKG_RESOURCES_CACHE_ZIP_MANIFESTS=1
     271}}}
     272
     273Alternatively, the variable can be set in the shell before executing `tracd`:
     274{{{#!sh
     275$ PKG_RESOURCES_CACHE_ZIP_MANIFESTS=1 tracd --port 8000 /path/to/myproject
     276}}}
     277}}}
     278
     279=== Running Trac on a Web Server
     280
     281Trac provides various options for connecting to a "real" web server:
     282 - [wiki:TracFastCgi FastCGI]
     283 - [wiki:TracModWSGI mod_wsgi]
     284 - //[wiki:TracModPython mod_python] (no longer recommended, as mod_python is not actively maintained anymore)//
     285 - //[wiki:TracCgi CGI] (should not be used, as the performance is far from optimal)//
     286
     287Trac 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.
     288
     289==== Generating the Trac cgi-bin directory #cgi-bin
    247290
    248291In 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].
    249292
    250293There 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:
    251 {{{
     294{{{#!sh
    252295mkdir -p /usr/share/trac/projects/my-project
    253296trac-admin /usr/share/trac/projects/my-project initenv
    … …  
    255298mv /tmp/deploy/* /usr/share/trac
    256299}}}
    257 
    258 ==== Setting up the Plugin Cache ====
    259 
    260 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.
    261 
    262 == Configuring Authentication ==
    263 
    264 The process of adding, removing, and configuring user accounts for authentication depends on the specific way you run Trac. The basic procedure is described in the [wiki:TracCgi#AddingAuthentication "Adding Authentication"] section on the TracCgi page. To learn how to setup authentication for the frontend you're using, please refer to one of the following pages:
    265 
    266  * TracStandalone if you use the standalone server, `tracd`.
    267  * TracCgi if you use the CGI or FastCGI web front ends.
    268  * [wiki:TracModWSGI] if you use the Apache mod_wsgi web front end.
    269  * TracModPython if you use the Apache mod_python web front end.
    270 
    271 
    272 == Automatic reference to the SVN changesets in Trac tickets ==
     300Don't forget to check that the web server has the execution right on scripts in the `/usr/share/trac/cgi-bin` directory.
     301
     302
     303==== Mapping Static Resources
     304
     305Out 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).
     306
     307Web 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.
     308
     309There 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.
     310
     311Note 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:
     312[[TracAdminHelp(deploy)]]
     313
     314The target `<directory>` will then contain an `htdocs` directory with:
     315 - `site/` - a copy of the environment's directory `htdocs/`
     316 - `common/` - the static resources of Trac itself
     317 - `<plugins>/` - one directory for each resource directory managed by the plugins enabled for this environment
     318
     319===== Example: Apache and `ScriptAlias` #ScriptAlias-example
     320
     321Assuming the deployment has been done this way:
     322{{{#!sh
     323$ trac-admin /var/trac/env deploy /path/to/trac/htdocs/common
     324}}}
     325
     326Add 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:
     327{{{#!apache
     328Alias /trac/chrome/common /path/to/trac/htdocs/common
     329Alias /trac/chrome/site /path/to/trac/htdocs/site
     330
     331<Directory "/path/to/www/trac/htdocs">
     332  Order allow,deny
     333  Allow from all
     334</Directory>
     335}}}
     336
     337If using mod_python, you might want to add this too (otherwise, the alias will be ignored):
     338{{{#!apache
     339<Location "/trac/chrome/common/">
     340  SetHandler None
     341</Location>
     342}}}
     343
     344Note 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.
     345
     346Similarly, 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):
     347{{{#!apache
     348Alias /trac/chrome/site /path/to/projectenv/htdocs
     349
     350<Directory "/path/to/projectenv/htdocs">
     351  Order allow,deny
     352  Allow from all
     353</Directory>
     354}}}
     355
     356Alternatively 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:
     357{{{#!ini
     358[trac]
     359htdocs_location = http://static.example.org/trac-common/
     360}}}
     361Note 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]).
     362
     363Of 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:
     364{{{#!sh
     365$ ln -s /path/to/trac/htdocs/common /var/www/static.example.org/trac-common
     366}}}
     367
     368
     369==== Setting up the Plugin Cache
     370
     371Some 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.
     372
     373== Configuring Authentication
     374
     375Trac 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.
     376
     377The process of adding, removing, and configuring user accounts for authentication depends on the specific way you run Trac.
     378
     379Please refer to one of the following sections:
     380 * TracStandalone#UsingAuthentication if you use the standalone server, `tracd`.
     381 * [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`.
     382 * TracFastCgi if you're using another web server with FCGI support (Cherokee, Lighttpd, !LiteSpeed, nginx)
     383
     384The following document also constains some useful information for beginners: [trac:TracAuthenticationIntroduction].
     385
     386== Granting admin rights to the admin user
     387Grant admin rights to user admin:
     388{{{#!sh
     389$ trac-admin /path/to/myproject permission add admin TRAC_ADMIN
     390}}}
     391This user will have an "Admin" entry menu that will allow you to administrate your Trac project.
     392
     393== Finishing the install
     394
     395=== Enable version control components
     396
     397Support 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.
     398
     399The 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.
     400
     401{{{#!ini
     402tracopt.versioncontrol.svn.* = enabled
     403}}}
     404
     405{{{#!ini
     406tracopt.versioncontrol.git.* = enabled
     407}}}
     408
     409After enabling the components, repositories can be configured through the "Repositories" admin panel or by editing [TracIni#repositories-section trac.ini].
     410
     411=== Automatic reference to the SVN changesets in Trac tickets
    273412
    274413You 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:
    … …  
    277416
    278417This 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.
    279 {{{
     418{{{#!ini
    280419tracopt.ticket.commit_updater.* = enabled
    281420}}}
    282421For more information, see the documentation of the `CommitTicketUpdater` component in the "Plugins" admin panel.
    283422
    284 == Using Trac ==
     423=== Using Trac
    285424
    286425Once 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.
    287426
    288 Keep in mind that anonymous (not logged in) users can by default access most but not all of the features. You will need to configure authentication and grant additional [wiki:TracPermissions permissions] to authenticated users to see the full set of features.
     427Keep in mind that //anonymous// (not logged in) users can by default access only a few of the features, in particular they will have a read-only access to the resources. You will need to configure authentication and grant additional [wiki:TracPermissions permissions] to authenticated users to see the full set of features.
    289428
    290429'' Enjoy! ''
    … …  
    293432
    294433----
    295 See also: [trac:TracInstallPlatforms TracInstallPlatforms], TracGuide, TracCgi, TracFastCgi, TracModPython, [wiki:TracModWSGI], TracUpgrade, TracPermissions
     434See also: [trac:TracInstallPlatforms TracInstallPlatforms], TracGuide, TracUpgrade, TracPermissions