Cyberduck Mountain Duck CLI

Changes between Version 11 and Version 12 of TracInstall


Ignore:
Timestamp:
Jun 6, 2016 11:04:08 AM (4 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracInstall

    v11 v12  
    1 = Trac Installation Guide for 0.12 =
     1= Trac Installation Guide for 1.0
    22[[TracGuideToc]]
    33
    44Trac is written in the Python programming language and needs a database, [http://sqlite.org/ SQLite], [http://www.postgresql.org/ PostgreSQL], or [http://mysql.com/ MySQL]. For HTML rendering, Trac uses the [http://genshi.edgewall.org Genshi] templating system.
    55
    6 Since version 0.12, Trac can also be localized, and there'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 **first** have installed the optional package [#OtherPythonPackages Babel]. Lacking Babel, you will only get the default English version, as usual. If you install Babel later on, you will need to re-install Trac.
     6Since 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.
    77
    88If 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].
    99
    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:wiki: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.
     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] on the main Trac site, 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.4 and < 3.0
    19    //(note that we dropped the support for Python 2.3 in this release and that this will be the last Trac release supporting Python 2.4)//
     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)
    2020 * [http://peak.telecommunity.com/DevCenter/setuptools setuptools], version >= 0.6
    21  * [http://genshi.edgewall.org/wiki/Download Genshi], version >= 0.6 (but < 0.7dev, i.e. don't use Genshi trunk)
    22 
    23 You also need a database system and the corresponding python bindings.
    24 The database can be either SQLite, PostgreSQL or MySQL.
     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 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 installers or the tar.gz archive for building from source:
    32 {{{
     27As you must be using Python 2.5, 2.6 or 2.7, you already have the SQLite database bindings bundled with the standard distribution of Python: the `sqlite3` module.
     28
     29However, if you like, you can download the latest and greatest version of [[trac:PySqlite]] from
     30[http://code.google.com/p/pysqlite/downloads/list google code], where you'll find the Windows
     31installers or the `tar.gz` archive for building from source:
     32{{{#!sh
    3333$ tar xvfz <version>.tar.gz
    3434$ cd <version>
     
    3636}}}
    3737 
    38 This will extract the SQLite code and build the bindings.
    39 
    40 To install SQLite, your system may require the development headers. Without these you will get various GCC related errors when attempting to build:
    41 
    42 {{{
    43 $ apt-get install libsqlite3-dev
    44 }}}
    45 
    46 SQLite 2.x is no longer supported, and neither is !PySqlite 1.1.x.
    47 
    48 A known bug !PySqlite versions 2.5.2-4 prohibits upgrade of trac databases
    49 from 0.11.x to 0.12. Please use versions 2.5.5 and newer or 2.5.1 and
    50 older. See [trac:#9434] for more detail.
    51 
    52 See additional information in [trac:PySqlite].
     38This will download the latest SQLite code and build the bindings. SQLite 2.x is no longer supported.
     39
     40A known bug in [trac:PySqlite] versions 2.5.2-4 prohibits upgrades of Trac databases from 0.11.x to 0.12. Please use versions 2.5.5 and newer or 2.5.1 and older. See [trac:#9434] for more detail. See additional information in [trac:PySqlite PySqlite].
    5341
    5442==== For the PostgreSQL database #ForPostgreSQL
     
    5644You need to install the database and its Python bindings:
    5745 * [http://www.postgresql.org/ PostgreSQL], version 8.0 or later
    58  * [http://pypi.python.org/pypi/psycopg2 psycopg2]
     46 * [http://pypi.python.org/pypi/psycopg2 psycopg2], version 2.0 or later
    5947
    6048See [trac:DatabaseBackend#Postgresql DatabaseBackend] for details.
    6149
    62 
    6350==== For the MySQL database #ForMySQL
    6451
    65 Trac can now work quite well with MySQL, provided you follow the guidelines.
     52Trac works well with MySQL, provided you follow the guidelines:
    6653
    6754 * [http://mysql.com/ MySQL], version 5.0 or later
    6855 * [http://sf.net/projects/mysql-python MySQLdb], version 1.2.2 or later
    6956
    70 It is '''very''' important to read carefully the [trac:MySqlDb] page before creating the database.
     57Given the caveats and known issues surrounding MySQL, read carefully the [trac:MySqlDb] page before creating the database.
    7158
    7259=== Optional Dependencies
    7360
    74 ==== Version Control System ====
    75 
    76 ===== Subversion =====
    77 
    78 [http://subversion.apache.org/ Subversion] 1.5.x or 1.6.x and the '''''corresponding''''' Python bindings.
    79 
    80 There are [http://subversion.apache.org/packages.html pre-compiled SWIG bindings] available for various platforms. See also the TracSubversion page for details about Windows packages.
    81 
    82 Older versions starting from 1.4.0, etc. should still work. For troubleshooting information, check the [trac:TracSubversion#Troubleshooting TracSubversion] page. Versions prior to 1.4.0 won't probably work since trac uses svn core functionality (e.g. svn_path_canonicalize) that is not implemented in the python swig wrapper in svn <= 1.3.x (although it exists in the svn lib itself).
     61==== Version Control System
     62
     63===== Subversion
     64 * [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.
     65
     66There 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.)
    8367
    8468Note that Trac '''doesn't''' use [http://pysvn.tigris.org/ PySVN], neither does it work yet with the newer `ctype`-style bindings.
    8569
    86 '''Please note:''' if using Subversion, Trac must be installed on the '''same machine'''. Remote repositories are currently [trac:#493 not supported].
    87 
    88 
    89 ===== Others =====
     70'''Please note:''' if using Subversion, Trac must be installed on the '''same machine'''. Remote repositories are currently [trac:ticket:493 not supported].
     71
     72===== Others
    9073
    9174Support for other version control systems is provided via third-parties. See [trac:PluginList] and [trac:VersionControlSystem].
    9275
    93 ==== Web Server ====
    94 A web server is optional because Trac is shipped with a server included, see the [#RunningtheStandaloneServer Running the Standalone Server ] section below.
    95 
    96 Alternatively you configure Trac to run in any of the following environments.
     76==== Web Server
     77A web server is optional because Trac is shipped with a server included, see the [#RunningtheStandaloneServer Running the Standalone Server] section below.
     78
     79Alternatively you can configure Trac to run in any of the following environments:
    9780 * [http://httpd.apache.org/ Apache] with
    98    - [http://code.google.com/p/modwsgi/ mod_wsgi], see [wiki:TracModWSGI] (preferred)
    99    - //[http://modpython.org/ mod_python 3.3.1], see TracModPython (deprecated)//
    100  * any [http://www.fastcgi.com/ FastCGI]-capable web server, see TracFastCgi
    101  * any [http://tomcat.apache.org/connectors-doc/ajp/ajpv13a.html AJP]-capable web
    102    server, see [trac:TracOnWindowsIisAjp]
    103  * IIS with [http://code.google.com/p/isapi-wsgi/ Isapi-wsgi], see [trac:TracOnWindowsIisIsapi]
    104  * //as a last resort, a CGI-capable web server (see TracCgi), but usage of Trac as a cgi script
    105    is highly discouraged, better use one of the previous options.//
     81   - [http://code.google.com/p/modwsgi/ mod_wsgi], see [wiki:TracModWSGI] and
     82     http://code.google.com/p/modwsgi/wiki/IntegrationWithTrac
     83   - [http://modpython.org/ mod_python >= 3.3.1], (deprecated: see TracModPython)
     84 * a [http://www.fastcgi.com/ FastCGI]-capable web server (see TracFastCgi)
     85 * an [http://tomcat.apache.org/connectors-doc/ajp/ajpv13a.html AJP]-capable web
     86   server (see [trac:TracOnWindowsIisAjp TracOnWindowsIisAjp])
     87 * a CGI-capable web server (see TracCgi), '''but usage of Trac as a cgi script
     88   is highly discouraged''', better use one of the previous options.
    10689   
    10790
    108 ==== Other Python Packages ====
    109 
    110  * [http://babel.edgewall.org Babel], version 0.9.5,
    111    needed for localization support[[BR]]
    112    ''Note: '' If you want to be able to use the Trac interface in other languages, then make sure you first have installed the optional package Babel. Lacking Babel, you will only get the default english version, as usual. If you install Babel later on, you will need to re-install Trac.
     91==== Other Python Packages
     92
     93 * [http://babel.edgewall.org Babel], version >= 0.9.5,
     94   needed for localization support (unreleased version 1.0dev should work as well)
    11395 * [http://docutils.sourceforge.net/ docutils], version >= 0.3.9
    11496   for WikiRestructuredText.
    115  * [http://pygments.pocoo.org Pygments] for
     97 * [http://pygments.org Pygments] for
    11698   [wiki:TracSyntaxColoring syntax highlighting].
    11799   [http://silvercity.sourceforge.net/ SilverCity] and/or
     
    122104   an internal time zone implementation.
    123105
    124 '''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].
    125 
    126 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!).
    127 
    128 
    129 == Installing Trac ==
     106'''Attention''': The available versions of these dependencies are not necessarily interchangeable, so please pay attention to the version numbers. If you are having trouble getting Trac to work, please double-check all the dependencies before asking for help on the [trac:MailingList] or [trac:IrcChannel].
     107
     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''. There are even some pages that are still talking about Trac 0.8!
     109
     110== Installing Trac
    130111=== Using `easy_install`
    131 One way to install Trac is using [http://pypi.python.org/pypi/setuptools setuptools].
    132 With setuptools you can install Trac from the subversion repository;
     112One way to install Trac is using [http://pypi.python.org/pypi/setuptools setuptools]. With setuptools you can install Trac from the Subversion repository.
    133113
    134114A few examples:
    135115
    136  - first install of the latest stable version Trac 0.12.3, with i18n support:
    137    {{{
    138    easy_install Babel==0.9.5
    139    easy_install Trac==0.12
     116 - Install Trac 1.0:
     117   {{{#!sh
     118   easy_install Trac==1.0
    140119   }}}
    141    ''It's very important to run the two `easy_install` commands separately, otherwise the message catalogs won't be generated.''
    142 
    143  - upgrade to the latest stable version of Trac:
    144    {{{
    145    easy_install -U Trac
     120 - Install latest development version:
     121   {{{#!sh
     122   easy_install Trac==dev
    146123   }}}
    147 
    148  - upgrade to the latest trunk development version:
    149    {{{
    150    easy_install -U Trac==dev
    151    }}}
    152 
    153 For upgrades, reading the TracUpgrade page is mandatory, of course.
    154 
    155 === From source
    156 If you want more control, you can download the source in archive form, or do a checkout from one of the official [[Trac:TracRepositories|source code repositories]].
    157 
    158 Be sure to have the prerequisites already installed. You can also obtain the Genshi and Babel source packages from http://www.edgewall.org and follow for them a similar installation procedure, or you can just `easy_install` those, see [#Usingeasy_install above].
    159 
    160 Once you've unpacked the Trac archive or performed the checkout, move in the top-level folder and do:
    161 {{{
    162 $ python ./setup.py install
    163 }}}
    164 
    165 You'll need root permissions or equivalent for this step.
    166 
    167 This will byte-compile the python source code and install it as an .egg file or folder in the `site-packages` directory
    168 of your Python installation. The .egg will also contain all other resources needed by standard Trac, such as htdocs and templates.
    169 
    170 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.
    171 
    172 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):
    173 {{{
    174 $ python ./setup.py install
    175 }}}
    176 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`).
    177 
    178 === Advanced Options ===
    179 
    180 ==== Custom location with `easy_install`
    181 
    182 To install Trac to a custom location, or find out about other advanced installation options, run:
    183 {{{
    184 easy_install --help
    185 }}}
    186 
    187 Also see [http://docs.python.org/inst/inst.html Installing Python Modules] for detailed information.
    188 
    189 Specifically, you might be interested in:
    190 {{{
    191 easy_install --prefix=/path/to/installdir
    192 }}}
    193 or, if installing Trac to a Mac OS X system:
    194 {{{
    195 easy_install --prefix=/usr/local --install-dir=/Library/Python/2.5/site-packages
    196 }}}
    197 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
    198 
    199 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.
    200 
    201 ==== Using `pip`
     124   Note that in this case you won't have the possibility to run a localized version of Trac;
     125   either use a released version or install from source
     126
     127{{{#!div style="border: 1pt dotted; margin: 1em"
     128**Setuptools Warning:** If the version of your setuptools is in the range 5.4 through 5.6, the environment variable `PKG_RESOURCES_CACHE_ZIP_MANIFESTS` must be set in order to avoid significant performance degradation. More information may be found in the sections on [#RunningtheStandaloneServer Running The Standalone Server] and [#RunningTraconaWebServer Running Trac on a Web Server].
     129}}}
     130
     131=== Using `pip`
    202132'pip' is an easy_install replacement that is very useful to quickly install python packages.
    203 To get a trac installation up and running in less than 5 minutes:
    204 
    205 Assuming you want to have your entire pip installation in /opt/user/trac:
     133To get a Trac installation up and running in less than 5 minutes:
     134
     135Assuming you want to have your entire pip installation in `/opt/user/trac`
    206136
    207137 -
    208 {{{
    209 pip -E /opt/user/trac install trac psycopg2
     138 {{{#!sh
     139pip install trac psycopg2
    210140}}}
    211141or
    212142 -
    213 {{{
    214 pip -E /opt/user/trac install trac mysql-python
    215 }}}
    216 
    217 Make sure your OS specific headers are available for pip to automatically build PostgreSQL (libpq-dev) or MySQL (libmysqlclient-dev) bindings.
    218 
    219 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 .
    220 
    221 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)
    222 
    223 Additionally, you can install several trac plugins (listed [http://pypi.python.org/pypi?:action=search&term=trac&submit=search here]) through pip.
    224 
    225 
    226 
    227 == Creating a Project Environment ==
    228 
    229 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.
     143 {{{#!sh
     144pip 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.) and download the latest packages on pypi.python.org and create a self contained installation in `/opt/user/trac`.
     150
     151All 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)
     152
     153Additionally, you can install several Trac plugins (listed [https://pypi.python.org/pypi?:action=browse&show=all&c=516 here]) through pip.
     154
     155=== From source
     156Of course, using the python-typical setup at the top of the source directory also works. You can obtain the source for a .tar.gz or .zip file corresponding to a release (e.g. `Trac-1.0.tar.gz`), or you can get the source directly from the repository. See [trac:SubversionRepository] for details.
     157
     158{{{#!sh
     159$ python ./setup.py install
     160}}}
     161
     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
     167The 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.
     168
     169If you install from source and want to make Trac available in other languages, make sure Babel is installed. Only then, perform the `install` (or simply redo the `install` once again afterwards if you realize Babel was not yet installed):
     170{{{#!sh
     171$ python ./setup.py install
     172}}}
     173Alternatively, you can run `bdist_egg` and copy the .egg from `dist/` to the place of your choice, or you can create a Windows installer (`bdist_wininst`).
     174
     175=== Advanced Options
     176
     177To install Trac to a custom location, or find out about other advanced installation options, run:
     178{{{#!sh
     179easy_install --help
     180}}}
     181
     182Also see [http://docs.python.org/2/install/index.html Installing Python Modules] for detailed information.
     183
     184Specifically, you might be interested in:
     185{{{#!sh
     186easy_install --prefix=/path/to/installdir
     187}}}
     188or, if installing Trac on a Mac OS X system:
     189{{{#!sh
     190easy_install --prefix=/usr/local --install-dir=/Library/Python/2.5/site-packages
     191}}}
     192Note: 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.
     193
     194The 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.
     195
     196== Creating a Project Environment
     197
     198A [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.
    230199
    231200A new environment is created using [wiki:TracAdmin trac-admin]:
    232 {{{
     201{{{#!sh
    233202$ trac-admin /path/to/myproject initenv
    234203}}}
     
    237206
    238207Using the default database connection string in particular will always work as long as you have SQLite installed.
    239 For the other [DatabaseBackend database backends] you should plan ahead and already have a database ready to use at this point.
    240 
    241 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.
     208For the other [trac:DatabaseBackend database backends] you should plan ahead and already have a database ready to use at this point.
     209
     210Since 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.
    242211
    243212Also note that the values you specify here can be changed later by directly editing the [TracIni conf/trac.ini] configuration file.
    244213
     214When selecting the location of your environment, make sure that the filesystem on which the environment directory resides supports sub-second timestamps (i.e. **not** `ext2` or `ext3` on Linux), as the modification time of the `conf/trac.ini` file will be monitored to decide whether an environment restart is needed or not. A too coarse-grained timestamp resolution may result in inconsistencies in Trac < 1.0.2. The best advice is to opt for a platform with sub-second timestamp resolution, regardless of the Trac version.
     215
    245216Finally, 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:
    246 {{{
    247 # chown -R apache.apache /path/to/myproject
    248 }}}
     217{{{#!sh
     218$ chown -R apache.apache /path/to/myproject
     219}}}
     220
     221The 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).
    249222
    250223{{{#!div class=important
     
    252225}}}
    253226
    254 
    255227== Deploying Trac
    256228
    257 === Running the Standalone Server ===
     229=== Running the Standalone Server
    258230
    259231After having created a Trac environment, you can easily try the web interface by running the standalone server [wiki:TracStandalone tracd]:
    260 {{{
     232{{{#!sh
    261233$ tracd --port 8000 /path/to/myproject
    262234}}}
    263235
    264236Then, 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:
    265 {{{
     237{{{#!sh
    266238$ tracd -s --port 8000 /path/to/myproject
    267239}}}
    268240
    269 === Running Trac on a Web Server ===
     241{{{#!div style="border: 1pt dotted; margin: 1em"
     242**Setuptools Warning:** If the version of your setuptools is in the range 5.4 through 5.6, the environment variable `PKG_RESOURCES_CACHE_ZIP_MANIFESTS` must be set in order to avoid significant performance degradation. The environment variable can be set system-wide, or for just the user that runs the `tracd` process. There are several ways to accomplish this in addition to what is discussed here, and depending on the distribution of your OS.
     243
     244To be effective system-wide a shell script with the `export` statement may be added to `/etc/profile.d`. To be effective for a user session the `export` statement may be added to `~/.profile`.
     245{{{#!sh
     246export PKG_RESOURCES_CACHE_ZIP_MANIFESTS=1
     247}}}
     248
     249Alternatively, the variable can be set in the shell before executing `tracd`:
     250{{{#!sh
     251$ PKG_RESOURCES_CACHE_ZIP_MANIFESTS=1 tracd --port 8000 /path/to/myproject
     252}}}
     253}}}
     254
     255=== Running Trac on a Web Server
    270256
    271257Trac provides various options for connecting to a "real" web server:
     
    277263Trac 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.
    278264
    279 ==== Generating the Trac cgi-bin directory ==== #cgi-bin
     265==== Generating the Trac cgi-bin directory #cgi-bin
    280266
    281267In 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].
    282268
    283269There 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:
    284 {{{
     270{{{#!sh
    285271mkdir -p /usr/share/trac/projects/my-project
    286272trac-admin /usr/share/trac/projects/my-project initenv
     
    288274mv /tmp/deploy/* /usr/share/trac
    289275}}}
    290 
    291 
    292 ==== Mapping Static Resources ====
     276Don't forget to check that the web server has the execution right on scripts in the `/usr/share/trac/cgi-bin` directory.
     277
     278==== Mapping Static Resources
    293279
    294280Out 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).
     
    306292 - `<plugins>/` - one directory for each resource directory managed by the plugins enabled for this environment
    307293
    308 ===== Example: Apache and `ScriptAlias` ===== #ScriptAlias-example
     294===== Example: Apache and `ScriptAlias` #ScriptAlias-example
    309295
    310296Assuming the deployment has been done this way:
    311 {{{
    312 $ trac-admin /var/trac/env deploy /path/to/trac/htdocs/common
     297{{{#!sh
     298$ trac-admin /var/trac/env deploy /path/to/shared/trac
    313299}}}
    314300
    315301Add 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:
    316 {{{
     302{{{#!apache
    317303Alias /trac/chrome/common /path/to/trac/htdocs/common
    318304Alias /trac/chrome/site /path/to/trac/htdocs/site
     
    325311
    326312If using mod_python, you might want to add this too (otherwise, the alias will be ignored):
    327 {{{
     313{{{#!apache
    328314<Location "/trac/chrome/common/">
    329315  SetHandler None
     
    334320
    335321Similarly, 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):
    336 {{{
     322{{{#!apache
    337323Alias /trac/chrome/site /path/to/projectenv/htdocs
    338324
     
    344330
    345331Alternatively 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:
    346 {{{
     332{{{#!ini
    347333[trac]
    348334htdocs_location = http://static.example.org/trac-common/
     
    351337
    352338Of 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:
    353 {{{
     339{{{#!sh
    354340$ ln -s /path/to/trac/htdocs/common /var/www/static.example.org/trac-common
    355341}}}
    356342
    357 
    358 ==== Setting up the Plugin Cache ====
    359 
    360 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.
    361 
    362 == Configuring Authentication ==
    363 
    364 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.
     343==== Setting up the Plugin Cache
     344
     345Some Python plugins need to be extracted to a cache directory. By default the cache resides in the home directory of the current user. When running Trac on a Web Server as a dedicated user (which is highly recommended) who has no home directory, this might prevent the plugins from starting. To override the cache location you can set the `PYTHON_EGG_CACHE` environment variable. Refer to your server documentation for detailed instructions on how to set environment variables.
     346
     347== Configuring Authentication
     348
     349Trac 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.
    365350
    366351The process of adding, removing, and configuring user accounts for authentication depends on the specific way you run Trac.
     
    371356 * TracFastCgi if you're using another web server with FCGI support (Cherokee, Lighttpd, !LiteSpeed, nginx)
    372357
     358The following document also constains some useful information for beginners: [trac:TracAuthenticationIntroduction].
     359
    373360== Granting admin rights to the admin user
    374361Grant admin rights to user admin:
    375 {{{
     362{{{#!sh
    376363$ trac-admin /path/to/myproject permission add admin TRAC_ADMIN
    377364}}}
    378 This user will have an "Admin" entry menu that will allow you to admin your trac project.
     365This user will have an "Admin" entry menu that will allow you to administrate your Trac project.
    379366
    380367== Finishing the install
    381368
    382 === Automatic reference to the SVN changesets in Trac tickets ===
     369=== Enable version control components
     370
     371Support for version control systems is provided by optional components in Trac and the components are disabled by default //(since 1.0)//. Subversion and Git must be explicitly enabled if you wish to use them. See TracRepositoryAdmin for more details.
     372
     373The components can be enabled by adding the following to the `[components]` section of your [TracIni#components-section trac.ini], or enabling the components in the "Plugins" admin panel.
     374
     375{{{#!ini
     376tracopt.versioncontrol.svn.* = enabled
     377}}}
     378
     379{{{#!ini
     380tracopt.versioncontrol.git.* = enabled
     381}}}
     382
     383After enabling the components, repositories can be configured through the "Repositories" admin panel or by editing [TracIni#repositories-section trac.ini].
     384
     385=== Automatic reference to the SVN changesets in Trac tickets
    383386
    384387You 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:
     
    387390
    388391This 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.
    389 {{{
     392{{{#!ini
    390393tracopt.ticket.commit_updater.* = enabled
    391394}}}
    392395For more information, see the documentation of the `CommitTicketUpdater` component in the "Plugins" admin panel.
    393396
    394 === Using Trac ===
     397=== Using Trac
    395398
    396399Once 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.
swiss made software