Changes between Version 1 and Version 2 of TracInstall


Ignore:
Timestamp:
2011-01-15 11:33:03 (9 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracInstall

    v1 v2  
    1 = Trac Installation Guide for 0.11 =  
     1= Trac Installation Guide for 0.12 =  
    22[[TracGuideToc]] 
    33 
    4  
    5 Trac is written in the Python programming language and needs a database, [http://sqlite.org/ SQLite], [http://postgresql.org/ PostgreSQL], [http://mysql.com/ MySQL]. For HTML rendering, Trac uses the [http://genshi.edgewall.org Genshi] templating system. 
    6  
    7 What follows are generic instructions for installing and setting up Trac and its requirements. While you can 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. 
    8  
    9 See TracUpgrade for instructions on how to upgrade an existing installation. 
    10  
    11  
    12 == Quick Install a Released Version == 
    13 For a quick install, first make sure you have [http://python.org/download Python] (2.3-2.6) and [http://peak.telecommunity.com/DevCenter/EasyInstall#installing-easy-install easy_install]. 
    14  
    15 Then enter (''omitting 'sudo' if not applicable'') 
    16 {{{ 
    17 sudo easy_install Trac 
    18 }}} 
    19 to install Trac, SQLite, and Genshi. 
    20  
    21  
    22 == Requirements == 
    23 The hardware requirements for running Trac obviously depend on the expected data volume (number of wiki pages, tickets, revisions) and traffic. Very small projects will run fine with a 500MHz processor and 128MB RAM using SQLite. In general, the more RAM, the better. A fast hard disk also helps. 
    24  
     4Trac 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. 
     5 
     6Since version 0.12, Trac can also be localized, and there's probably a translation available for your language. If you want to be able to use the Trac interface in other languages, then make sure you **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. 
     7 
     8If you're interested in contributing new translations for other languages or enhance the existing translations, then please have a look at [trac:wiki:TracL10N TracL10N]. 
     9 
     10What follows are generic instructions for installing and setting up Trac and its requirements. While you may find instructions for installing Trac on specific systems at 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. 
     11 
     12[[PageOutline(2-3,Installation Steps,inline)]] 
     13 
     14== Dependencies == 
     15=== Mandatory Dependencies 
    2516To install Trac, the following software packages must be installed: 
    2617 
    27  * [http://www.python.org/ Python], version >=2.3 (<3.0) 
    28    * if using mod_python together with xml-related things, use python-2.5. expat is namespaced there and does not cause apache to crash any more(see [http://www.dscpl.com.au/wiki/ModPython/Articles/ExpatCausingApacheCrash here] for details). 
    29    * For RPM-based systems you might also need the `python-devel` and `python-xml` packages. 
    30    * See instructions in [trac:wiki:TracOnWindows/Python2.5 TracOnWindows/Python2.5] 
    31  * [wiki:setuptools], version >= 0.6 
    32  * [http://genshi.edgewall.org/wiki/Download Genshi], version >= 0.5 (was version >= 0.4.1 on previous 0.11 release candidates) 
    33  * You also need a database system and the corresponding python drivers for it. 
    34    The database can be either SQLite, PostgreSQL or MySQL. 
    35  * Optional if some plugins require it: [http://www.clearsilver.net/ ClearSilver] 
    36  
    37 ==== For SQLite ==== 
     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) 
     20 * [http://peak.telecommunity.com/DevCenter/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. 
     24The database can be either SQLite, PostgreSQL or MySQL. 
     25 
     26==== For the SQLite database #ForSQLite 
    3827 
    3928If you're using Python 2.5 or 2.6, you already have everything you need. 
    4029 
    41 If you're using Python 2.3 or 2.4 and need pysqlite, you can download from  
    42 [http://code.google.com/p/pysqlite/downloads/list google code] the Windows 
    43 installers or the tar.gz archive for building from source:  
     30If 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:  
    4432{{{ 
    4533$ tar xvfz <version>.tar.gz  
     
    4836}}} 
    4937  
    50 That way, the latest SQLite version will be downloaded and built into the  
    51 bindings.  
    52  
    53 If you're still using SQLite 2.x, you'll need pysqlite 1.0.x, although this  
    54 package is not easy to find anymore. For SQLite 3.x, try not to use 
    55 pysqlite 1.1.x, which has been deprecated in favor of pysqlite 2.x. 
    56  
    57 See additional information in [trac:PySqlite PySqlite]. 
    58  
    59 ==== For PostgreSQL ==== 
    60  
     38This will extract the SQLite code and build the bindings.  
     39 
     40To 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 
     46SQLite 2.x is no longer supported, and neither is !PySqlite 1.1.x. 
     47 
     48A known bug !PySqlite versions 2.5.2-4 prohibits upgrade of trac databases 
     49from 0.11.x to 0.12. Please use versions 2.5.5 and newer or 2.5.1 and 
     50older. See [trac:#9434] for more detail. 
     51 
     52See additional information in [trac:PySqlite]. 
     53 
     54==== For the PostgreSQL database #ForPostgreSQL 
     55 
     56You need to install the database and its Python bindings: 
    6157 * [http://www.postgresql.org/ PostgreSQL] 
    62  * [http://initd.org/projects/psycopg2 psycopg2] 
    63  * See [trac:wiki:DatabaseBackend#Postgresql DatabaseBackend] 
    64  
    65 '''Warning''': PostgreSQL 8.3 uses a strict type checking mechanism. To use Trac with the 8.3 Version of PostgreSQL, you will need [http://trac.edgewall.org/changeset/6512 trac-0.11] or later. 
    66  
    67 ==== For MySQL ==== 
    68  
    69  * [http://mysql.com/ MySQL], version 4.1 or later ([http://askmonty.org/wiki/index.php/MariaDB MariaDB] might work as well) 
    70  * [http://sf.net/projects/mysql-python MySQLdb], version 1.2.1 or later 
    71  
    72 See [trac:MySqlDb MySqlDb] for more detailed information. 
    73 It is ''very'' important to read carefully that page before creating the database. 
    74  
    75 == Optional Requirements == 
     58 * [http://pypi.python.org/pypi/psycopg2 psycopg2] 
     59 
     60See [trac:DatabaseBackend#Postgresql DatabaseBackend] for details. 
     61 
     62 
     63==== For the MySQL database #ForMySQL 
     64 
     65Trac can now work quite well with MySQL, provided you follow the guidelines. 
     66 
     67 * [http://mysql.com/ MySQL], version 5.0 or later 
     68 * [http://sf.net/projects/mysql-python MySQLdb], version 1.2.2 or later 
     69 
     70It is '''very''' important to read carefully the  [trac:MySqlDb] page before creating the database. 
     71 
     72=== Optional Dependencies 
    7673 
    7774==== Version Control System ==== 
    7875 
    79 '''Please note:''' if using Subversion, Trac must be installed on the '''same machine'''. Remote repositories are currently not supported (although Windows UNC paths such as {{{\\machine_name\path\to\svn}}} do work). 
    80  
    81  * [http://subversion.tigris.org/ Subversion], version >= 1.0. (versions recommended: 1.2.4, 1.3.2 or 1.4.2) and the '''''corresponding''''' Python bindings. For troubleshooting, check [trac:TracSubversion TracSubversion] 
    82    * Trac uses the [http://svnbook.red-bean.com/svnbook-1.1/ch08s02.html#svn-ch-8-sect-2.3 SWIG] bindings included in the Subversion distribution, '''not''' [http://pysvn.tigris.org/ PySVN] (which is sometimes confused with the standard SWIG bindings). 
    83    * If Subversion was already installed without the SWIG bindings, on Unix you'll need to re-`configure` Subversion and `make swig-py`, `make install-swig-py`. 
    84    * There are [http://subversion.tigris.org/servlets/ProjectDocumentList?folderID=91 pre-compiled bindings] available for win32.  
    85  * Support for other version control systems is provided via third-parties. See [trac:PluginList PluginList] and [trac:VersioningSystemBackend VersioningSystemBackend]. 
     76===== Subversion ===== 
     77 * [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. 
     78 
     79There 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.) 
     80 
     81Note that Trac '''doesn't''' use [http://pysvn.tigris.org/ PySVN], neither does it work yet with the newer `ctype`-style bindings. [Is there a ticket for implementing ctype bindings?] 
     82 
     83 
     84'''Please note:''' if using Subversion, Trac must be installed on the '''same machine'''. Remote repositories are currently [trac:ticket:493 not supported]. 
     85 
     86 
     87===== Others ===== 
     88 
     89Support for other version control systems is provided via third-parties. See [trac:PluginList] and [trac:VersioningSystemBackend]. 
    8690 
    8791==== Web Server ==== 
    88  * A CGI-capable web server (see TracCgi), or 
    89  * a [http://www.fastcgi.com/ FastCGI]-capable web server (see TracFastCgi), or 
    90  * an [http://tomcat.apache.org/connectors-doc/ajp/ajpv13a.html AJP]-capable web server (see [trac:TracOnWindowsIisAjp TracOnWindowsIisAjp]), or 
    91  * [http://httpd.apache.org/ Apache] with [http://code.google.com/p/modwsgi/ mod_wsgi] (see [wiki:TracModWSGI] or http://code.google.com/p/modwsgi/wiki/IntegrationWithTrac) or 
    92     * This should work with Apache 1.3, 2.0 or 2.2 and promises to deliver more performance than using mod_python. A little less mature than mod_python. 
    93  * [http://httpd.apache.org/ Apache] with [http://www.modpython.org/ mod_python 3.1.3+] (see TracModPython) 
    94     * When installing mod_python the development versions of Python and Apache are required (actually the libraries and header files) 
    95  
    96 For those stuck with Apache 1.3, it is also possible to get Trac working with [http://www.modpython.org/ mod_python 2.7] (see [trac:wiki:TracModPython2.7 TracModPython2.7]). This guide hasn't been updated since 0.84, so it may or may not work. 
    97  
    98 ==== Other Python Utilities ==== 
    99  * [http://docutils.sourceforge.net/ docutils], version >= 0.3.9 for WikiRestructuredText. 
    100  * [http://pygments.pocoo.org Pygments] for '''syntax highlighting''', although [http://silvercity.sourceforge.net/ SilverCity] >= 0.9.7 and/or [http://gnu.org/software/enscript/enscript.html GNU Enscript] are also possible. Refer to TracSyntaxColoring for details. 
    101  * [http://pytz.sf.net pytz] to get a complete list of time zones, otherwise Trac will fall back on a shorter list from an internal time zone implementation. 
    102  
    103 '''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]. 
     92A web server is optional because Trac is shipped with a server included, see the [#RunningtheStandaloneServer Running the Standalone Server ] section below. 
     93 
     94Alternatively you configure Trac to run in any of the following environments. 
     95 * [http://httpd.apache.org/ Apache] with  
     96   - [http://code.google.com/p/modwsgi/ mod_wsgi], see [wiki:TracModWSGI] and  
     97     http://code.google.com/p/modwsgi/wiki/IntegrationWithTrac 
     98   - [http://modpython.org/ mod_python 3.3.1], deprecated: see TracModPython) 
     99 * a [http://www.fastcgi.com/ FastCGI]-capable web server (see TracFastCgi) 
     100 * an [http://tomcat.apache.org/connectors-doc/ajp/ajpv13a.html AJP]-capable web 
     101   server (see [trac:TracOnWindowsIisAjp]) 
     102 * a CGI-capable web server (see TracCgi), '''but usage of Trac as a cgi script  
     103   is highly discouraged''', better use one of the previous options.  
     104    
     105 
     106==== Other Python Packages ==== 
     107 
     108 * [http://babel.edgewall.org Babel], version >= 0.9.5,  
     109   needed for localization support[[BR]] 
     110   ''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.  
     111 * [http://docutils.sourceforge.net/ docutils], version >= 0.3.9  
     112   for WikiRestructuredText. 
     113 * [http://pygments.pocoo.org Pygments] for  
     114   [wiki:TracSyntaxColoring syntax highlighting]. 
     115   [http://silvercity.sourceforge.net/ SilverCity] and/or  
     116   [http://gnu.org/software/enscript/enscript.html Enscript] may still be used 
     117   but are deprecated and you really should be using Pygments. 
     118 * [http://pytz.sf.net pytz] to get a complete list of time zones, 
     119   otherwise Trac will fall back on a shorter list from  
     120   an internal time zone implementation. 
     121 
     122'''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]. 
    104123 
    105124Please 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!). 
    106125 
     126 
    107127== Installing Trac == 
    108  
    109 One way to install Trac is using `setuptools`. 
    110 With setuptools you can install Trac from the subversion repository; for example, 
    111 to install release version 0.11 do: 
    112 {{{ 
    113 easy_install http://svn.edgewall.org/repos/trac/tags/trac-0.11 
    114 }}} 
    115  
    116 But of course the python-typical setup at the top of the source directory also works: 
     128=== Using `easy_install` 
     129One way to install Trac is using [http://pypi.python.org/pypi/setuptools setuptools]. 
     130With setuptools you can install Trac from the subversion repository;  
     131 
     132A few examples: 
     133 
     134 - install Trac 0.12: 
     135   {{{ 
     136   easy_install Trac==0.12 
     137   }}} 
     138 
     139 - install latest development version 0.12dev: 
     140   {{{ 
     141   easy_install Trac==dev 
     142   }}} 
     143   Note that in this case you won't have the possibility to run a localized version of Trac; 
     144   either use a released version or install from source  
     145 
     146=== Using `pip` 
     147'pip' is an easy_install replacement that is very useful to quickly install python packages. 
     148To get a trac installation up and running in less than 5 minutes: 
     149 
     150Assuming you want to have your entire pip installation in /opt/user/trac 
     151 
     152 -  
     153{{{ 
     154pip -E /opt/user/trac install trac psycopg2  
     155}}} 
     156or 
     157 -  
     158{{{ 
     159pip -E /opt/user/trac install trac mysql-python  
     160}}} 
     161 
     162Make sure your OS specific headers are available for pip to automatically build PostgreSQL (libpq-dev) or MySQL (libmysqlclient-dev) bindings. 
     163 
     164pip 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  
     165 
     166All 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) 
     167 
     168Additionally, you can install several trac plugins (listed [http://pypi.python.org/pypi?:action=search&term=trac&submit=search here]) through pip. 
     169 
     170 
     171 
     172=== From source 
     173Of course, using the python-typical setup at the top of the source directory also works. 
     174 
     175You 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). 
     176 
    117177{{{ 
    118178$ python ./setup.py install 
    119179}}} 
    120180 
    121 ''Note: you'll need root permissions or equivalent for this step.'' 
     181''You'll need root permissions or equivalent for this step.'' 
    122182 
    123183This will byte-compile the python source code and install it as an .egg file or folder in the `site-packages` directory 
     
    126186The 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. 
    127187 
    128 ==== Advanced Options ==== 
     188If 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): 
     189{{{ 
     190$ python ./setup.py install 
     191}}} 
     192Alternatively, 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`). 
     193 
     194=== Advanced Options === 
    129195 
    130196To install Trac to a custom location, or find out about other advanced installation options, run: 
     
    143209easy_install --prefix=/usr/local --install-dir=/Library/Python/2.5/site-packages 
    144210}}} 
     211Note: 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 
    145212 
    146213The 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. 
    147214 
     215 
    148216== Creating a Project Environment == 
    149217 
    150 A [wiki: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 configuration file and various other files and directories. 
     218A [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. 
    151219 
    152220A new environment is created using [wiki:TracAdmin trac-admin]: 
     
    155223}}} 
    156224 
    157 [wiki:TracAdmin trac-admin] will prompt you for the information it needs to create the environment, such as the name of the project, the type and the path to an existing [wiki:TracEnvironment#SourceCodeRepository source code repository], the [wiki:TracEnvironment#DatabaseConnectionStrings database connection string], and so on. If you're not sure what to specify for one of these options, just leave it blank to use the default value. The database connection string in particular will always work as long as you have SQLite installed. Leaving the path to the source code repository empty will disable any functionality related to version control, but you can always add that back when the basic system is running. 
    158  
    159 Also note that the values you specify here can be changed later by directly editing the [wiki:TracIni] configuration file. 
    160  
    161 ''Note: The user account under which the web server runs will require write permissions to the environment directory and all the files inside.  On Linux, with the web server running as user apache and group apache, enter:'' 
    162  
    163   chown -R apache.apache /path/to/myproject 
     225[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.  
     226 
     227Using the default database connection string in particular will always work as long as you have SQLite installed. 
     228For the other [DatabaseBackend database backends] you should plan ahead and already have a database ready to use at this point. 
     229 
     230Since 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. 
     231 
     232Also note that the values you specify here can be changed later by directly editing the [TracIni conf/trac.ini] configuration file. 
     233 
     234Finally, 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: 
     235{{{ 
     236# chown -R apache.apache /path/to/myproject 
     237}}} 
    164238 
    165239== Running the Standalone Server == 
     
    170244}}} 
    171245 
    172 Then, fire up a browser and visit `http://localhost:8000/`. You should get a simple listing of all environments that tracd knows about. Follow the link to the environment you just created, and you should see Trac in action. If you only plan on managing a single project with trac you can have the standalone server skip the environment list by starting it like this: 
     246Then, 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: 
    173247{{{ 
    174248$ tracd -s --port 8000 /path/to/myproject 
     
    177251== Running Trac on a Web Server == 
    178252 
    179 Trac provides three options for connecting to a "real" web server: [wiki:TracCgi CGI], [wiki:TracFastCgi FastCGI] and [wiki:TracModPython mod_python]. For decent performance, it is recommended that you use either FastCGI or mod_python. 
    180  
    181 If you're not afraid of running newer code, you can also try running Trac on [wiki:TracModWSGI mod_wsgi]. This should deliver even better performance than mod_python, but the module isn't as extensively tested as mod_python. 
     253Trac 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. 
    182254 
    183255Trac also supports [trac:TracOnWindowsIisAjp AJP] which may be your choice if you want to connect to IIS. 
     
    185257==== Generating the Trac cgi-bin directory ==== 
    186258 
    187 In order for Trac to function properly with FastCGI or mod_python, you need to have a trac.cgi file. This is an executable which loads the appropriate Python code. It can be generated using the `deploy` option of [wiki:TracAdmin trac-admin]. 
     259In 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]. 
    188260 
    189261There 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: 
     
    197269==== Setting up the Plugin Cache ==== 
    198270 
    199 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. 
     271Some 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. 
    200272 
    201273== Configuring Authentication == 
     
    204276 
    205277 * TracStandalone if you use the standalone server, `tracd`. 
    206  * TracCgi if you use the CGI or FastCGI methods. 
    207  * TracModPython if you use the mod_python method. 
     278 * TracCgi if you use the CGI or FastCGI web front ends. 
     279 * [wiki:TracModWSGI] if you use the Apache mod_wsgi web front end. 
     280 * TracModPython if you use the Apache mod_python web front end. 
     281 
    208282 
    209283== Automatic reference to the SVN changesets in Trac tickets == 
    210284 
    211 You can configure SVN to automatically add a reference to the changeset into the ticket comments, whenever files are committed to the repository. The description of the commit needs to contain one of the following formulas: 
    212  * '''Refs #123''' - to reference this changeset in #123 ticket 
    213  * '''Fixes #123''' - to reference this changeset and close #123 ticket with the default status ''fixed'' 
    214  
    215 All you have to do is to edit the ''post-commit'' hook in your SVN repository and make it execute ''trac-post-commit-hook'' coming with Trac. 
    216  
    217 If you are editing the ''post-commit'' hook for the first time you need to navigate to your SVN repository's hooks subfolder and rename existing there ''post-commit'' template: 
    218  
    219 {{{ 
    220 $ cd /path/to/svn/repository/hooks 
    221 $ mv post-commit.tmpl post-commit 
    222 $ chmod 755 post-commit 
    223 }}} 
    224  
    225 Next open it in any text editor and add a line with path to the Trac environment connected with this SVN repository and another line executing the ''trac-post-commit-hook'' script: 
    226  
    227 {{{ 
    228 REPOS="$1" 
    229 REV="$2" 
    230 TRAC_ENV="/path/to/your/trac/project" 
    231  
    232 /usr/bin/python /usr/local/bin/trac-post-commit-hook -p "$TRAC_ENV" -r "$REV" 
    233 }}} 
    234  
    235 Make sure that ''trac-post-commit-hook'' exists in above path with execution permissions for the same user which SVN is running from. This script can be found in contrib subfolder of your Trac distribution and the latest version can be always downloaded from [source:trunk/contrib/trac-post-commit-hook]. 
    236  
    237  
    238 == Platform-specifics installations == 
    239  
    240  * See [trac:TracInstallPlatforms TracInstallPlatforms] 
    241   
     285You 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: 
     286 * '''`Refs #123`''' - to reference this changeset in `#123` ticket 
     287 * '''`Fixes #123`''' - to reference this changeset and close `#123` ticket with the default status ''fixed'' 
     288 
     289This 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. 
     290{{{ 
     291tracopt.ticket.commit_updater.* = enabled 
     292}}} 
     293For more information, see the documentation of the `CommitTicketUpdater` component in the "Plugins" admin panel. 
    242294 
    243295== Using Trac == 
    244296 
    245 Once you have your Trac site up and running, you should be able to browse your subversion repository, create tickets, view the timeline, etc. 
     297Once 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. 
    246298 
    247299Keep 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. 
     
    253305---- 
    254306See also: [trac:TracInstallPlatforms TracInstallPlatforms], TracGuide, TracCgi, TracFastCgi, TracModPython, [wiki:TracModWSGI], TracUpgrade, TracPermissions 
    255