Changes between Version 3 and Version 4 of TracInstall


Ignore:
Timestamp:
Jan 13, 2020, 10:34:25 PM (4 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracInstall

    v3 v4  
    1 = Trac Installation Guide for 1.0 =
     1= Trac Installation Guide for 1.2
    22[[TracGuideToc]]
    33
    44Trac is written in the Python programming language and needs a database, [http://sqlite.org/ SQLite], [http://www.postgresql.org/ PostgreSQL], or [http://mysql.com/ MySQL]. For HTML rendering, Trac uses the [http://genshi.edgewall.org Genshi] templating system.
    55
    6 Since version 0.12, Trac can also be localized, and there'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 [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.
     6Trac can also be localized, and there is probably a translation available in your language. If you want to use the Trac interface in other languages, then make sure you have installed the optional package [#OtherPythonPackages Babel]. Pay attention to the extra steps for localization support in the [#InstallingTrac Installing Trac] section below. Lacking Babel, you will only get the default English version.
     7
     8If you're interested in contributing new translations for other languages or enhancing the existing translations, then please have a look at [trac:wiki:TracL10N TracL10N].
     9
     10What follows are generic instructions for installing and setting up Trac. While you may find instructions for installing Trac on specific systems at [trac:TracInstallPlatforms TracInstallPlatforms], please '''first read through these general instructions''' to get a good understanding of the tasks involved.
    1111
    1212[[PageOutline(2-3,Installation Steps,inline)]]
    1313
    14 == Dependencies ==
     14== Dependencies
    1515=== Mandatory Dependencies
    1616To install Trac, the following software packages must be installed:
    1717
    18  * [http://www.python.org/ Python], version >= 2.5 and < 3.0
    19    (note that we dropped the support for Python 2.4 in this release)
    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 
    23 You also need a database system and the corresponding python bindings.
    24 The database can be either SQLite, PostgreSQL or MySQL.
     18 * [http://www.python.org/ Python], version >= 2.6 and < 3.0
     19   (note that we dropped the support for Python 2.5 in this release)
     20 * [http://pypi.python.org/pypi/setuptools setuptools], version >= 0.6
     21 * [http://genshi.edgewall.org/wiki/Download Genshi], version >= 0.6
     22
     23You also need a database system and the corresponding python bindings. The database can be either SQLite, PostgreSQL or MySQL.
    2524
    2625==== For the SQLite database #ForSQLite
    2726
    28 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).
    29 
    30 However, if you'd like, you can download the latest and greatest version of [[trac:Pysqlite]] from
    31 [http://code.google.com/p/pysqlite/downloads/list google code], where you'll find the Windows
    32 installers or the `tar.gz` archive for building from source:
    33 {{{
    34 $ tar xvfz <version>.tar.gz
    35 $ cd <version>
    36 $ python setup.py build_static install
    37 }}}
    38  
    39 This will download the latest SQLite code and build the bindings.
    40 
    41 SQLite 2.x is no longer supported.
    42 
    43 A known bug PySqlite versions 2.5.2-4 prohibits upgrade of trac databases
    44 from 0.11.x to 0.12. Please use versions 2.5.5 and newer or 2.5.1 and
    45 older. See #9434 for more detail.
    46 
    47 See additional information in [trac:PySqlite PySqlite].
     27As you must be using Python 2.6 or 2.7, you already have the SQLite database bindings bundled with the standard distribution of Python (the `sqlite3` module).
     28
     29Optionally, you may install a newer version of [http://pypi.python.org/pypi/pysqlite pysqlite] than the one provided by the Python distribution. See [trac:PySqlite#ThePysqlite2bindings PySqlite] for details.
    4830
    4931==== For the PostgreSQL database #ForPostgreSQL
     
    5133You need to install the database and its Python bindings:
    5234 * [http://www.postgresql.org/ PostgreSQL], version 8.0 or later
    53  * [http://pypi.python.org/pypi/psycopg2 psycopg2]
     35 * [http://pypi.python.org/pypi/psycopg2 psycopg2], version 2.0 or later
    5436
    5537See [trac:DatabaseBackend#Postgresql DatabaseBackend] for details.
    5638
    57 
    5839==== For the MySQL database #ForMySQL
    5940
    60 Trac can now work quite well with MySQL, provided you follow the guidelines.
     41Trac works well with MySQL, provided you follow the guidelines:
    6142
    6243 * [http://mysql.com/ MySQL], version 5.0 or later
    6344 * [http://sf.net/projects/mysql-python MySQLdb], version 1.2.2 or later
    6445
    65 It is '''very''' important to read carefully the [trac:MySqlDb] page before creating the database.
     46Given the caveats and known issues surrounding MySQL, read carefully the [trac:MySqlDb] page before creating the database.
    6647
    6748=== Optional Dependencies
    6849
    69 ==== Version Control System ====
    70 
    71 ===== Subversion =====
    72  * [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.
    73 
    74 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. TracSubversion points you to [http://alagazam.net Algazam], which works for me under Python 2.6.)
    75 
    76 Note that Trac '''doesn't''' use [http://pysvn.tigris.org/ PySVN], neither does it work yet with the newer `ctype`-style bindings.
    77 
    78 
    79 '''Please note:''' if using Subversion, Trac must be installed on the '''same machine'''. Remote repositories are currently [trac:ticket:493 not supported].
    80 
    81 
    82 ===== Others =====
    83 
    84 Support for other version control systems is provided via third-parties. See [trac:PluginList] and [trac:VersionControlSystem].
    85 
    86 ==== Web Server ====
    87 A web server is optional because Trac is shipped with a server included, see the [#RunningtheStandaloneServer Running the Standalone Server ] section below.
    88 
    89 Alternatively you configure Trac to run in any of the following environments.
     50==== Subversion
     51
     52[http://subversion.apache.org/ Subversion], 1.6.x or later and the '''''corresponding''''' Python bindings.
     53
     54There are [http://subversion.apache.org/packages.html pre-compiled SWIG bindings] available for various platforms. (Good luck finding precompiled SWIG bindings for any Windows package at that listing. [trac:TracSubversion] points you to [http://alagazam.net Alagazam], which works for me under Python 2.6.)
     55
     56For troubleshooting information, see the [trac:TracSubversion#Troubleshooting TracSubversion] page.
     57
     58{{{#!div style="border: 1pt dotted; margin: 1em"
     59**Note:**
     60* Trac '''doesn't''' use [http://pysvn.tigris.org/ PySVN], nor does it work yet with the newer `ctype`-style bindings.
     61* If using Subversion, Trac must be installed on the '''same machine'''. Remote repositories are currently [trac:ticket:493 not supported].
     62}}}
     63
     64==== Git
     65
     66[http://git-scm.com/ Git] 1.5.6 or later is supported. More information is available on the [trac:TracGit] page.
     67
     68==== Other Version Control Systems
     69
     70Support for other version control systems is provided via third-party plugins. See [trac:PluginList#VersionControlSystems] and [trac:VersionControlSystem].
     71
     72==== Web Server
     73A web server is optional because Trac is shipped with a server included, see the [#RunningtheStandaloneServer Running the Standalone Server] section below.
     74
     75Alternatively you can configure Trac to run in any of the following environments:
    9076 * [http://httpd.apache.org/ Apache] with
    91    - [http://code.google.com/p/modwsgi/ mod_wsgi], see [wiki:TracModWSGI] and
    92      http://code.google.com/p/modwsgi/wiki/IntegrationWithTrac
    93    - [http://modpython.org/ mod_python 3.3.1], deprecated: see TracModPython)
     77  * [https://github.com/GrahamDumpleton/mod_wsgi mod_wsgi], see [wiki:TracModWSGI] and [http://code.google.com/p/modwsgi/wiki/IntegrationWithTrac ModWSGI IntegrationWithTrac].
     78  * [http://modpython.org/ mod_python 3.5.0], see TracModPython
    9479 * a [http://www.fastcgi.com/ FastCGI]-capable web server (see TracFastCgi)
    9580 * an [http://tomcat.apache.org/connectors-doc/ajp/ajpv13a.html AJP]-capable web
    9681   server (see [trac:TracOnWindowsIisAjp TracOnWindowsIisAjp])
     82 * Microsoft IIS with FastCGI and a FastCGI-to-WSGI gateway (see [trac:CookBook/Installation/TracOnWindowsIisWfastcgi IIS with FastCGI])
    9783 * a CGI-capable web server (see TracCgi), '''but usage of Trac as a cgi script
    9884   is highly discouraged''', better use one of the previous options.
    9985   
    10086
    101 ==== Other Python Packages ====
    102 
    103  * [http://babel.edgewall.org Babel], version >= 0.9.5,
    104    needed for localization support (unreleased version 1.0dev should work as well)
     87==== Other Python Packages
     88
     89 * [http://babel.edgewall.org Babel], version 0.9.6 or >= 1.3,
     90   needed for localization support
    10591 * [http://docutils.sourceforge.net/ docutils], version >= 0.3.9
    10692   for WikiRestructuredText.
    107  * [http://pygments.pocoo.org Pygments] for
    108    [wiki:TracSyntaxColoring syntax highlighting].
    109    [http://silvercity.sourceforge.net/ SilverCity] and/or
    110    [http://gnu.org/software/enscript/enscript.html Enscript] may still be used
    111    but are deprecated and you really should be using Pygments.
     93 * [http://pygments.org Pygments] for
     94   [TracSyntaxColoring syntax highlighting].
    11295 * [http://pytz.sf.net pytz] to get a complete list of time zones,
    11396   otherwise Trac will fall back on a shorter list from
    11497   an internal time zone implementation.
    11598
    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 
    118 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!).
    119 
    120 
    121 == Installing Trac ==
     99{{{#!div style="border: 1pt dotted; margin: 1em"
     100**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].
     101}}}
     102
     103Please 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''.
     104
     105== Installing Trac
     106
     107The [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.
     108
     109It is assumed throughout this guide that you have elevated permissions as the `root` user or by prefixing commands with `sudo`. The umask `0002` should be used for a typical installation on a Unix-based platform.
     110
    122111=== Using `easy_install`
    123 One way to install Trac is using [http://pypi.python.org/pypi/setuptools setuptools].
    124 With setuptools you can install Trac from the subversion repository;
     112Trac can be installed from PyPI or the Subversion repository using [http://pypi.python.org/pypi/setuptools setuptools].
    125113
    126114A few examples:
    127115
    128  - install Trac 1.0:
    129    {{{
    130    easy_install Trac==1.0
    131    }}}
    132    (NOT YET ENABLED)
    133  - install latest development version 1.0dev:
    134    {{{
    135    easy_install Trac==dev
    136    }}}
     116 - Install the latest stable version of Trac:
     117 {{{#!sh
     118$ easy_install Trac
     119}}}
     120 - Install latest development version:
     121 {{{#!sh
     122$ easy_install http://download.edgewall.org/trac/Trac-latest-dev.tar.gz
     123}}}
    137124   Note that in this case you won't have the possibility to run a localized version of Trac;
    138125   either use a released version or install from source
    139126
     127More information can be found on the [trac:wiki:setuptools setuptools] page.
     128
     129{{{#!div style="border: 1pt dotted; margin: 1em"
     130**Setuptools Warning:** If the version of your setuptools is in the range 5.4 through 5.6, the environment variable `PKG_RESOURCES_CACHE_ZIP_MANIFESTS` must be set in order to avoid significant performance degradation. More information may be found in [#DeployingTrac Deploying Trac].
     131}}}
     132
    140133=== Using `pip`
    141134'pip' is an easy_install replacement that is very useful to quickly install python packages.
    142 To get a trac installation up and running in less than 5 minutes:
     135To get a Trac installation up and running in less than 5 minutes:
    143136
    144137Assuming you want to have your entire pip installation in `/opt/user/trac`
    145138
    146  -
    147 {{{
    148 pip -E /opt/user/trac install trac psycopg2
     139 {{{#!sh
     140$ pip install trac psycopg2
    149141}}}
    150142or
    151  -
    152 {{{
    153 pip -E /opt/user/trac install trac mysql-python
    154 }}}
    155 
    156 Make sure your OS specific headers are available for pip to automatically build PostgreSQL (libpq-dev) or MySQL (libmysqlclient-dev) bindings.
    157 
    158 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`.
     143 {{{#!sh
     144$ pip install trac mysql-python
     145}}}
     146
     147Make sure your OS specific headers are available for pip to automatically build PostgreSQL (`libpq-dev`) or MySQL (`libmysqlclient-dev`) bindings.
     148
     149pip 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`.
    159150
    160151All 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)
    161152
    162 Additionally, you can install several trac plugins (listed [http://pypi.python.org/pypi?:action=search&term=trac&submit=search here]) through pip.
    163 
    164 
     153Additionally, you can install several Trac plugins (listed [https://pypi.python.org/pypi?:action=browse&show=all&c=516 here]) through pip.
    165154
    166155=== From source
    167 Of course, using the python-typical setup at the top of the source directory also works.
    168 
    169 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).
    170 
    171 {{{
     156Using 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.
     157
     158{{{#!sh
    172159$ python ./setup.py install
    173160}}}
    174161
    175 ''You'll need root permissions or equivalent for this step.''
    176 
    177 This will byte-compile the python source code and install it as an .egg file or folder in the `site-packages` directory
    178 of your Python installation. The .egg will also contain all other resources needed by standard Trac, such as htdocs and templates.
    179 
    180 The 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.
    181 
    182 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):
    183 {{{
     162''You will need root permissions or equivalent for this step.''
     163
     164This will byte-compile the Python source code and install it as an .egg file or folder in the `site-packages` directory
     165of your Python installation. The .egg will also contain all other resources needed by standard Trac, such as `htdocs` and `templates`.
     166
     167If 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):
     168{{{#!sh
    184169$ python ./setup.py install
    185170}}}
    186 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`).
    187 
    188 === Advanced Options ===
     171Alternatively, 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`).
     172
     173=== Using installer
     174
     175On Windows, Trac can be installed using the exe installers available on the [trac:TracDownload] page. Installers are available for the 32-bit and 64-bit versions of Python. Make sure to use the installer that matches the architecture of your Python installation.
     176
     177=== Using package manager
     178
     179Trac may be available in your platform's package repository. Note however, that the version provided by your package manager may not be the latest release.
     180
     181=== Advanced `easy_install` Options
    189182
    190183To install Trac to a custom location, or find out about other advanced installation options, run:
    191 {{{
    192 easy_install --help
    193 }}}
    194 
    195 Also see [http://docs.python.org/inst/inst.html Installing Python Modules] for detailed information.
     184{{{#!sh
     185$ easy_install --help
     186}}}
     187
     188Also see [http://docs.python.org/2/install/index.html Installing Python Modules] for detailed information.
    196189
    197190Specifically, you might be interested in:
    198 {{{
    199 easy_install --prefix=/path/to/installdir
    200 }}}
    201 or, if installing Trac to a Mac OS X system:
    202 {{{
    203 easy_install --prefix=/usr/local --install-dir=/Library/Python/2.5/site-packages
    204 }}}
    205 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
    206 
    207 The above will place your `tracd` and `trac-admin` commands into `/usr/local/bin` and will install the Trac libraries and dependencies into `/Library/Python/2.5/site-packages`, which is Apple's preferred location for third-party Python application installations.
    208 
    209 
    210 == Creating a Project Environment ==
    211 
    212 A [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.
    213 
    214 A new environment is created using [wiki:TracAdmin trac-admin]:
    215 {{{
     191{{{#!sh
     192$ easy_install --prefix=/path/to/installdir
     193}}}
     194or, if installing Trac on a Mac OS X system:
     195{{{#!sh
     196$ easy_install --prefix=/usr/local --install-dir=/Library/Python/2.6/site-packages
     197}}}
     198
     199{{{#!div style="border: 1pt dotted; margin: 1em"
     200**Mac OS X Note:** On Mac OS X 10.6,  running `easy_install trac` will install into `/usr/local` and `/Library/Python/2.6/site-packages` by default.
     201
     202The `tracd` and `trac-admin` commands will be placed in `/usr/local/bin` and will install the Trac libraries and dependencies into `/Library/Python/2.6/site-packages`, which is Apple's preferred location for third-party Python application installations.
     203}}}
     204
     205== Creating a Project Environment
     206
     207A [TracEnvironment Trac environment] is the backend where Trac stores information like wiki pages, tickets, reports, settings, etc. An environment is a directory that contains a human-readable [TracIni configuration file], and other files and directories.
     208
     209A new environment is created using [TracAdmin trac-admin]:
     210{{{#!sh
    216211$ trac-admin /path/to/myproject initenv
    217212}}}
    218213
    219 [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.
    220 
    221 Using the default database connection string in particular will always work as long as you have SQLite installed.
    222 For the other [DatabaseBackend database backends] you should plan ahead and already have a database ready to use at this point.
    223 
    224 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.
    225 
    226 Also note that the values you specify here can be changed later by directly editing the [TracIni conf/trac.ini] configuration file.
     214You will be prompted for the information needed to create the environment: the name of the project and the [TracEnvironment#DatabaseConnectionStrings database connection string]. If you're not sure what to specify for any of these options, just press `<Enter>` to use the default value.
     215
     216Using the default database connection string will always work as long as you have SQLite installed. For the other [trac:DatabaseBackend database backends] you should plan ahead and already have a database ready to use at this point.
     217
     218Also note that the values you specify here can be changed later using TracAdmin or directly editing the [TracIni conf/trac.ini] configuration file.
     219
     220{{{#!div style="border: 1pt dotted; margin: 1em"
     221**Filesystem Warning:** When selecting the location of your environment, make sure that the filesystem on which the environment directory resides supports sub-second timestamps (i.e. **not** `ext2` or `ext3` on Linux, or HFS+ on OSX), as the modification time of the `conf/trac.ini` file will be monitored to decide whether an environment restart is needed or not. A too coarse-grained timestamp resolution may result in inconsistencies in Trac < 1.0.2. The best advice is to opt for a platform with sub-second timestamp resolution, regardless of the Trac version.
     222}}}
    227223
    228224Finally, 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:
    229 {{{
    230 # chown -R apache.apache /path/to/myproject
    231 }}}
     225{{{#!sh
     226$ chown -R apache:apache /path/to/myproject
     227}}}
     228
     229The 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).
    232230
    233231{{{#!div class=important
     
    235233}}}
    236234
    237 
    238235== Deploying Trac
    239236
    240 === Running the Standalone Server ===
    241 
    242 After having created a Trac environment, you can easily try the web interface by running the standalone server [wiki:TracStandalone tracd]:
    243 {{{
     237{{{#!div style="border: 1pt dotted; margin: 1em"
     238**Setuptools Warning:** If the version of your setuptools is in the range 5.4 through 5.6, the environment variable `PKG_RESOURCES_CACHE_ZIP_MANIFESTS` must be set in order to avoid significant performance degradation.
     239
     240If running `tracd`, the environment variable can be set system-wide or for just the user that runs the `tracd` process. There are several ways to accomplish this in addition to what is discussed here, and depending on the distribution of your OS.
     241
     242To be effective system-wide a shell script with the `export` statement may be added to `/etc/profile.d`. To be effective for a user session the `export` statement may be added to `~/.profile`.
     243{{{#!sh
     244export PKG_RESOURCES_CACHE_ZIP_MANIFESTS=1
     245}}}
     246
     247Alternatively, the variable can be set in the shell before executing `tracd`:
     248{{{#!sh
     249$ PKG_RESOURCES_CACHE_ZIP_MANIFESTS=1 tracd --port 8000 /path/to/myproject
     250}}}
     251
     252If running the Apache web server, !Ubuntu/Debian users should add the `export` statement to `/etc/apache2/envvars`. !RedHat/CentOS/Fedora should can add the `export` statement to `/etc/sysconfig/httpd`.
     253}}}
     254
     255=== Running the Standalone Server
     256
     257After having created a Trac environment, you can easily try the web interface by running the standalone server [TracStandalone tracd]:
     258{{{#!sh
    244259$ tracd --port 8000 /path/to/myproject
    245260}}}
    246261
    247262Then, 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:
    248 {{{
     263{{{#!sh
    249264$ tracd -s --port 8000 /path/to/myproject
    250265}}}
    251266
    252 === Running Trac on a Web Server ===
     267=== Running Trac on a Web Server
    253268
    254269Trac provides various options for connecting to a "real" web server:
    255  - [wiki:TracFastCgi FastCGI]
    256  - [wiki:TracModWSGI mod_wsgi]
    257  - //[wiki:TracModPython mod_python] (no longer recommended, as mod_python is not actively maintained anymore)//
    258  - //[wiki:TracCgi CGI] (should not be used, as the performance is far from optimal)//
     270 - [TracFastCgi FastCGI]
     271 - [wiki:TracModWSGI Apache with mod_wsgi]
     272 - [TracModPython Apache with mod_python]
     273 - [TracCgi CGI] //(should not be used, as the performance is far from optimal)//
    259274
    260275Trac 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.
    261276
    262 ==== Generating the Trac cgi-bin directory ==== #cgi-bin
    263 
    264 In order for Trac to function properly with FastCGI you need to have a `trac.fcgi` file and for mod_wsgi a `trac.wsgi` file. These are Python scripts which load the appropriate Python code. They can be generated using the `deploy` option of [wiki:TracAdmin trac-admin].
    265 
    266 There 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:
    267 {{{
    268 mkdir -p /usr/share/trac/projects/my-project
    269 trac-admin /usr/share/trac/projects/my-project initenv
    270 trac-admin /usr/share/trac/projects/my-project deploy /tmp/deploy
    271 mv /tmp/deploy/* /usr/share/trac
    272 }}}
    273 
    274 
    275 ==== Mapping Static Resources ====
    276 
    277 Out of the box, Trac will pass static resources such as style sheets or images through itself. For anything but a tracd only based deployment, this is far from optimal as the web server could be set up to directly serve those static resources (for CGI setup, this is '''highly undesirable''' and will cause abysmal performance).
    278 
    279 Web servers such as [http://httpd.apache.org/ Apache] allow you to create “Aliases” to resources, giving them a virtual URL that doesn't necessarily reflect the layout of the servers file system. We also can map requests for static resources directly to the directory on the file system, avoiding processing these requests by Trac itself.
    280 
    281 There are two primary URL paths for static resources - `/chrome/common` and `/chrome/site`. Plugins can add their own resources, usually accessible by `/chrome/<plugin>` path, so its important to override only known paths and not try to make universal `/chrome` alias for everything.
    282 
    283 Note that in order to get those static resources on the filesystem, you need first to extract the relevant resources from Trac using the [TracAdmin trac-admin]` <environment> deploy` command:
     277==== Generating the Trac cgi-bin directory #cgi-bin
     278
     279Application scripts for CGI, FastCGI and mod-wsgi can be generated using the [TracAdmin trac-admin] `deploy` command:
    284280[[TracAdminHelp(deploy)]]
    285281
    286 The target `<directory>` will then contain an `htdocs` directory with:
    287  - `site/` - a copy of the environment's directory `htdocs/`
    288  - `common/` - the static resources of Trac itself
    289  - `<plugins>/` - one directory for each resource directory managed by the plugins enabled for this environment
    290 
    291 ===== Example: Apache and `ScriptAlias` ===== #ScriptAlias-example
    292 
    293 Assuming the deployment has been done this way:
    294 {{{
    295 $ trac-admin /var/trac/env deploy /path/to/trac/htdocs/common
    296 }}}
    297 
    298 Add the following snippet to Apache configuration ''before'' the `ScriptAlias` or `WSGIScriptAlias` (which map all the other requests to the Trac application), changing paths to match your deployment:
    299 {{{
     282Grant the web server execution right on scripts in the `cgi-bin` directory.
     283
     284For example, the following yields a typical directory structure:
     285{{{#!sh
     286$ mkdir -p /var/trac
     287$ trac-admin /var/trac/<project> initenv
     288$ trac-admin /var/trac/<project> deploy /var/www
     289$ ls /var/www
     290cgi-bin htdocs
     291$ chmod ugo+x /var/www/cgi-bin/*
     292}}}
     293
     294==== Mapping Static Resources
     295
     296Without additional configuration, Trac will handle requests for static resources such as stylesheets and images. For anything other than a TracStandalone deployment, this is not optimal as the web server can be set up to directly serve the static resources. For CGI setup, this is '''highly undesirable''' as it causes abysmal performance.
     297
     298Web servers such as [http://httpd.apache.org/ Apache] allow you to create //Aliases// to resources, giving them a virtual URL that doesn't necessarily reflect their location on the file system. We can map requests for static resources directly to directories on the file system, to avoid Trac processing the requests.
     299
     300There are two primary URL paths for static resources: `/chrome/common` and `/chrome/site`. Plugins can add their own resources, usually accessible at the `/chrome/<plugin>` path.
     301
     302A single `/chrome` alias can used if the static resources are extracted for all plugins. This means that the `deploy` command (discussed in the previous section) must be executed after installing or updating a plugin that provides static resources, or after modifying resources in the `$env/htdocs` directory. This is probably appropriate for most installations but may not be what you want if, for example, you wish to upload plugins through the //Plugins// administration page.
     303
     304The `deploy` command creates an `htdocs` directory with:
     305 - `common/` - the static resources of Trac
     306 - `site/` - a copy of the environment's `htdocs/` directory
     307 - `shared` - the static resources shared by multiple Trac environments, with a location defined by the `[inherit]` `htdocs_dir` option
     308 - `<plugin>/` - one directory for each resource directory provided by the plugins enabled for this environment
     309
     310The example that follows will create a single `/chrome` alias. If that isn't the correct approach for your installation you simply need to create more specific aliases:
     311{{{#!apache
    300312Alias /trac/chrome/common /path/to/trac/htdocs/common
    301313Alias /trac/chrome/site /path/to/trac/htdocs/site
     314Alias /trac/chrome/shared /path/to/trac/htdocs/shared
     315Alias /trac/chrome/<plugin> /path/to/trac/htdocs/<plugin>
     316}}}
     317
     318===== Example: Apache and `ScriptAlias` #ScriptAlias-example
     319
     320Assuming the deployment has been done this way:
     321{{{#!sh
     322$ trac-admin /var/trac/<project> deploy /var/www
     323}}}
     324
     325Add the following snippet to Apache configuration, changing paths to match your deployment. The snippet must be placed ''before'' the `ScriptAlias` or `WSGIScriptAlias` directive, because those directives map all requests to the Trac application:
     326{{{#!apache
     327Alias /trac/chrome /path/to/trac/htdocs
    302328
    303329<Directory "/path/to/www/trac/htdocs">
    304   Order allow,deny
    305   Allow from all
     330  # For Apache 2.2
     331  <IfModule !mod_authz_core.c>
     332    Order allow,deny
     333    Allow from all
     334  </IfModule>
     335  # For Apache 2.4
     336  <IfModule mod_authz_core.c>
     337    Require all granted
     338  </IfModule>
    306339</Directory>
    307340}}}
    308341
    309 If using mod_python, you might want to add this too (otherwise, the alias will be ignored):
    310 {{{
    311 <Location "/trac/chrome/common/">
     342If using mod_python, add this too, otherwise the alias will be ignored:
     343{{{#!apache
     344<Location "/trac/chrome/common">
    312345  SetHandler None
    313346</Location>
    314347}}}
    315348
    316 Note that we mapped `/trac` part of the URL to the `trac.*cgi` script, and the path `/trac/chrome/common` is the path you have to append to that location to intercept requests to the static resources.
    317 
    318 Similarly, if you have static resources in a project's `htdocs` directory (which is referenced by `/trac/chrome/site` URL in themes), you can configure Apache to serve those resources (again, put this ''before'' the `ScriptAlias` or `WSGIScriptAlias` for the .*cgi scripts, and adjust names and locations to match your installation):
    319 {{{
     349Alternatively, if you wish to serve static resources directly from your project's `htdocs` directory rather than the location to which the files are extracted with the `deploy` command, you can configure Apache to serve those resources. Again, put this ''before'' the `ScriptAlias` or `WSGIScriptAlias` for the .*cgi scripts, and adjust names and locations to match your installation:
     350{{{#!apache
    320351Alias /trac/chrome/site /path/to/projectenv/htdocs
    321352
    322353<Directory "/path/to/projectenv/htdocs">
    323   Order allow,deny
    324   Allow from all
     354  # For Apache 2.2
     355  <IfModule !mod_authz_core.c>
     356    Order allow,deny
     357    Allow from all
     358  </IfModule>
     359  # For Apache 2.4
     360  <IfModule mod_authz_core.c>
     361    Require all granted
     362  </IfModule>
    325363</Directory>
    326364}}}
    327365
    328 Alternatively 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:
    329 {{{
     366Another alternative to aliasing `/trac/chrome/common` is having Trac generate direct links for those static resources (and only those), using the [TracIni#trac-section htdocs_location] configuration setting:
     367{{{#!ini
    330368[trac]
    331369htdocs_location = http://static.example.org/trac-common/
    332370}}}
    333 Note that this makes it easy to have a dedicated domain serve those static resources (preferentially [http://code.google.com/speed/page-speed/docs/request.html#ServeFromCookielessDomain cookie-less]).
     371
     372Note that this makes it easy to have a dedicated domain serve those static resources, preferentially cookie-less.
    334373
    335374Of 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:
    336 {{{
     375{{{#!sh
    337376$ ln -s /path/to/trac/htdocs/common /var/www/static.example.org/trac-common
    338377}}}
    339378
    340 
    341 ==== Setting up the Plugin Cache ====
    342 
    343 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.
    344 
    345 == Configuring Authentication ==
    346 
    347 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.
     379==== Setting up the Plugin Cache #egg-cache
     380
     381Some Python plugins need to be extracted to a cache directory. By default the cache resides in the home directory of the current user. When running Trac on a Web Server as a dedicated user (which is highly recommended) who has no home directory, this might prevent the plugins from starting. To override the cache location you can set the `PYTHON_EGG_CACHE` environment variable. Refer to your server documentation for detailed instructions on how to set environment variables.
     382
     383If you setup hook scripts that call Trac, such as the Subversion post-commit hook script provided in the `/contrib` directory, make sure you define the `PYTHON_EGG_CACHE` environment variable within these scripts as well.
     384
     385== Configuring Authentication
     386
     387Trac 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.
    348388
    349389The process of adding, removing, and configuring user accounts for authentication depends on the specific way you run Trac.
     
    351391Please refer to one of the following sections:
    352392 * TracStandalone#UsingAuthentication if you use the standalone server, `tracd`.
    353  * [wiki:TracModWSGI#ConfiguringAuthentication TracModWSGI#ConfiguringAuthentication] if you use the Apache web server, with any of its front end: `mod_wsgi` of course, but the same instructions applies also for `mod_python`, `mod_fcgi` or `mod_fastcgi`.
     393 * [wiki:TracModWSGI#ConfiguringAuthentication TracModWSGI#ConfiguringAuthentication] if you use the Apache web server, with any of its front end: `mod_wsgi`, `mod_python`, `mod_fcgi` or `mod_fastcgi`.
    354394 * 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.
    355397
    356398== Granting admin rights to the admin user
    357399Grant admin rights to user admin:
    358 {{{
     400{{{#!sh
    359401$ trac-admin /path/to/myproject permission add admin TRAC_ADMIN
    360402}}}
    361 This user will have an "Admin" entry menu that will allow you to admin your trac project.
    362 
    363 == Finishing the install
    364 
    365 === Automatic reference to the SVN changesets in Trac tickets ===
    366 
    367 You 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:
    368  * '''`Refs #123`''' - to reference this changeset in `#123` ticket
    369  * '''`Fixes #123`''' - to reference this changeset and close `#123` ticket with the default status ''fixed''
    370 
    371 This 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.
    372 {{{
    373 tracopt.ticket.commit_updater.* = enabled
    374 }}}
    375 For more information, see the documentation of the `CommitTicketUpdater` component in the "Plugins" admin panel.
    376 
    377 === Using Trac ===
     403
     404This user will have an //Admin// navigation item that directs to pages for administering your Trac project.
     405
     406== Configuring Trac
     407
     408TracRepositoryAdmin provides information on configuring version control repositories for your project.
     409
     410== Using Trac
    378411
    379412Once 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.
    380413
    381 Keep 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.
     414Keep 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 [TracPermissions permissions] to authenticated users to see the full set of features.
    382415
    383416'' Enjoy! ''