Changes between Version 4 and Version 5 of TracInstall


Ignore:
Timestamp:
04/06/12 16:33:19 (8 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracInstall

    v4 v5  
    1 = Trac Installation Guide for 0.11 =
     1= Trac Installation Guide for 0.12 =
    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 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.
    7 
    8 == Short - Install a released version ==
    9 For the quick install, make sure you have [http://python.org Python-2.5], [http://peak.telecommunity.com/DevCenter/EasyInstall#installing-easy-install easy_install] and SQlite-3.3.4 installed (or above). (You also might want to install python-dev to build genshi)
    10 {{{
    11 sudo easy_install Trac
    12 }}}
    13 
    14 == Requirements ==
    15 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.
    16 
     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 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
     8If you're interested in contributing new translations for other languages or enhance the existing translations, then please have a look at [[trac: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
    1716To install Trac, the following software packages must be installed:
    1817
    19  * [http://www.python.org/ Python], version >= 2.3
    20    * 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).
    21    * For RPM-based systems you might also need the `python-devel` and `python-xml` packages.
    22    * See instructions in ["TracOnWindows/Python2.5"]
     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)
    2320 * [http://peak.telecommunity.com/DevCenter/setuptools setuptools], version >= 0.6
    24  * [http://genshi.edgewall.org/wiki/Download Genshi], version >= 0.5 (was version >= 0.4.1 on previous 0.11 release candidates)
    25  * You also need a database system and the corresponding python drivers for it.
    26    The database can be either SQLite, PostgreSQL or ''MySQL (experimental)''.
    27  * Optional if some plugins require it: [http://www.clearsilver.net/ ClearSilver]
    28 
    29 ==== For SQLite ====
    30 
    31  * [http://www.sqlite.org/ SQLite], version 3.3.4 and above preferred (note: it is preinstalled in Python 2.5.2).
    32  * If not using Python-2.5: [http://pysqlite.org/ PySQLite], version 1.x (for SQLite 2.x) or version 2.x (for SQLite 3.x), version 2.3.2 preferred. For details see [trac:PySqlite PySqlite]
    33 
    34 ''Note: It appears that PySQLite 2.x is required for Trac 0.9+/SQLite 3.x if you plan to use the 'trac-post-commit-hook.py' script available from the 'contrib' section of the source repository.''
    35 
    36 ''Note: Users of Mac OS X please take care; the Apple-supplied SQLite contains additional code to support file locking on network filesystems like AFP or SMB. This is not presently (3.3.6) in the mainline sources, so if you build your own SQLite from source it will not function correctly on such filesystems - typically it gives the error "{{{
    37 database is locked
    38 }}}". [http://www.alastairs-place.net/2006/07/sqlite_and_mac/ A patch] is available for version 3.3.6, based on Apple's code, otherwise you're probably best off using the Apple supplied version (presently 3.1.3).''
    39 
    40 ==== For PostgreSQL ====
    41 
     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
     27
     28If you're using Python 2.5 or 2.6, you already have everything you need.
     29
     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
     32installers 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 
     39This will extract the SQLite code and build the bindings.
     40
     41SQLite 2.x is no longer supported. For SQLite 3.x, the pysqlite 1.1.x
     42bindings are also no longer supported, use pysqlite 2.x.
     43
     44See additional information in [trac:PySqlite PySqlite].
     45
     46==== For the PostgreSQL database #ForPostgreSQL
     47
     48You need to install the database and its Python bindings:
    4249 * [http://www.postgresql.org/ PostgreSQL]
    43  * [http://initd.org/projects/psycopg2 psycopg2]
    44  * See [trac:wiki:DatabaseBackend#Postgresql DatabaseBackend]
    45 
    46 '''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.
    47 
    48 ==== For MySQL ====
    49 
    50 '''Warning''': MySQL support is currently ''still'' experimental. That means it works for some people, but several issues remain, in particular regarding the use of unicode and the key length in the repository cache. See [trac:MySqlDb MySqlDb] for more detailed information.
    51 
    52  * [http://mysql.com/ MySQL], version 4.1 or later
    53  * [http://sf.net/projects/mysql-python MySQLdb], version 1.2.1 or later
    54 
    55 == Optional Requirements ==
     50 * [http://pypi.python.org/pypi/psycopg2 psycopg2]
     51
     52See [trac:DatabaseBackend#Postgresql DatabaseBackend] for details.
     53
     54
     55==== For the MySQL database #ForMySQL
     56
     57Trac can now work quite well with MySQL, provided you follow the guidelines.
     58
     59 * [http://mysql.com/ MySQL], version 5.0 or later
     60 * [http://sf.net/projects/mysql-python MySQLdb], version 1.2.2 or later
     61
     62It is '''very''' important to read carefully the  [trac:MySqlDb MySqlDb] page before creating the database.
     63
     64=== Optional Dependencies
    5665
    5766==== Version Control System ====
    5867
    59 '''Please note:''' if using Subversion, Trac must be installed on the '''same machine'''. Remote repositories are currently not supported.
    60 
    61  * [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]
    62    * 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).
    63    * 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`.
    64    * There are [http://subversion.tigris.org/servlets/ProjectDocumentList?folderID=91 pre-compiled bindings] available for win32.
    65  * Support for other version control systems is provided via third-parties. See [trac:PluginList PluginList] and [trac:VersioningSystemBackend VersioningSystemBackend].
     68===== Subversion =====
     69 * [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.
     70
     71There are [http://subversion.apache.org/packages.html pre-compiled SWIG bindings] available for various platforms. Note that Trac '''doesn't''' use [http://pysvn.tigris.org/ PySVN], neither does it work yet with the newer `ctype`-style bindings
     72
     73
     74'''Please note:''' if using Subversion, Trac must be installed on the '''same machine'''. Remote repositories are currently [trac:ticket:493 not supported].
     75
     76
     77===== Others =====
     78
     79Support for other version control systems is provided via third-parties. See [trac:PluginList PluginList] and [trac:VersioningSystemBackend VersioningSystemBackend].
    6680
    6781==== Web Server ====
    68  * A CGI-capable web server (see TracCgi), or
    69  * a [http://www.fastcgi.com/ FastCGI]-capable web server (see TracFastCgi), or
    70  * an [http://tomcat.apache.org/connectors-doc/ajp/ajpv13a.html AJP]-capable web server (see [trac:TracOnWindowsIisAjp TracOnWindowsIisAjp]), or
    71  * [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)
    72     * 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.
    73  * [http://httpd.apache.org/ Apache] with [http://www.modpython.org/ mod_python 3.1.3+] (see TracModPython)
    74     * When installing mod_python the development versions of Python and Apache are required (actually the libraries and header files)
    75 
    76 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 [wiki:TracModPython2.7 TracModPython2.7]). This guide hasn't been updated since 0.84, so it may or may not work.
    77 
    78 ==== Other Python Utilities ====
    79  * [http://docutils.sourceforge.net/ docutils], version >= 0.3.9 for WikiRestructuredText.
    80  * [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.
    81  * [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.
     82A web server is optional because Trac is shipped with a server included, see the [#RunningtheStandaloneServer Running the Standalone Server ] section below.
     83
     84Alternatively you configure Trac to run in any of the following environments.
     85 * [http://httpd.apache.org/ Apache] with
     86   - [http://code.google.com/p/modwsgi/ mod_wsgi], see [wiki:TracModWSGI] and
     87     http://code.google.com/p/modwsgi/wiki/IntegrationWithTrac
     88   - [http://modpython.org/ mod_python 3.3.1], see TracModPython)
     89 * a [http://www.fastcgi.com/ FastCGI]-capable web server (see TracFastCgi)
     90 * an [http://tomcat.apache.org/connectors-doc/ajp/ajpv13a.html AJP]-capable web
     91   server (see [trac:TracOnWindowsIisAjp TracOnWindowsIisAjp])
     92 * a CGI-capable web server (see TracCgi), '''but usage of Trac as a cgi script
     93   is highly discouraged''', better use one of the previous options.
     94   
     95
     96==== Other Python Packages ====
     97
     98 * [http://babel.edgewall.org Babel], version >= 0.9.5,
     99   needed for localization support
     100 * [http://docutils.sourceforge.net/ docutils], version >= 0.3.9
     101   for WikiRestructuredText.
     102 * [http://pygments.pocoo.org Pygments] for
     103   [wiki:TracSyntaxColoring syntax highlighting].
     104   [http://silvercity.sourceforge.net/ SilverCity] and/or
     105   [http://gnu.org/software/enscript/enscript.html Enscript] may still be used
     106   but are deprecated and you really should be using Pygments.
     107 * [http://pytz.sf.net pytz] to get a complete list of time zones,
     108   otherwise Trac will fall back on a shorter list from
     109   an internal time zone implementation.
    82110
    83111'''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].
     
    85113Please 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!).
    86114
     115
    87116== Installing Trac ==
    88 
     117=== Using `easy_install`
    89118One way to install Trac is using `setuptools`.
    90 With setuptools you can install Trac from the subversion repository; for example,
    91 to install release version 0.11 do:
    92 {{{
    93 easy_install http://svn.edgewall.org/repos/trac/tags/trac-0.11
    94 }}}
    95 
    96 But of course the python-typical setup at the top of the source directory also works:
     119With setuptools you can install Trac from the subversion repository;
     120
     121A few examples:
     122
     123 - install Trac 0.12:
     124   {{{
     125   easy_install Trac==0.12
     126   
     127}}}
     128
     129 - install latest development version 0.12dev:
     130   {{{
     131   easy_install Trac==dev
     132   
     133}}}
     134   Note that in this case you won't have the possibility to run a localized version of Trac;
     135   either use a released version or install from source
     136
     137=== Using `pip`
     138'pip' is an easy_install replacement that is very useful to quickly install python packages.
     139To get a trac installation up and running in less than 5 minutes:
     140
     141Assuming you want to have your entire pip installation in /opt/user/trac
     142
     143 -
     144{{{
     145pip -E /opt/user/trac install trac psycopg2
     146}}}
     147or
     148 -
     149{{{
     150pip -E /opt/user/trac install trac mysql-python
     151}}}
     152
     153Make sure your OS specific headers are available for pip to automatically build PostgreSQL (libpq-dev) or MySQL (libmysqlclient-dev) bindings.
     154
     155pip 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
     156
     157All 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)
     158
     159Additionally, you can install several trac plugins (listed [http://pypi.python.org/pypi?:action=search&term=trac&submit=search here]) through pip.
     160
     161
     162
     163=== From source
     164Of course, using the python-typical setup at the top of the source directory also works.
     165
     166You 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).
     167
    97168{{{
    98169$ python ./setup.py install
    99170}}}
    100171
    101 ''Note: you'll need root permissions or equivalent for this step.''
     172''You'll need root permissions or equivalent for this step.''
    102173
    103174This will byte-compile the python source code and install it as an .egg file or folder in the `site-packages` directory
     
    106177The 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.
    107178
    108 ==== Advanced Options ====
     179If 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):
     180{{{
     181$ python ./setup.py install
     182}}}
     183Alternatively, 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`).
     184
     185=== Advanced Options ===
    109186
    110187To install Trac to a custom location, or find out about other advanced installation options, run:
     
    123200easy_install --prefix=/usr/local --install-dir=/Library/Python/2.5/site-packages
    124201}}}
     202Note: If installing on Mac OS X 10.6 running {{{
     203easy_install http://svn.edgewall.org/repos/trac/trunk
     204}}} will install into {{{
     205/usr/local
     206}}} and {{{
     207/Library/Python/2.6/site-packages
     208}}} by default
    125209
    126210The 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.
    127211
     212
    128213== Creating a Project Environment ==
    129214
    130 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.
     215A [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.
    131216
    132217A new environment is created using [wiki:TracAdmin trac-admin]:
     
    135220}}}
    136221
    137 [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.
    138 
    139 Also note that the values you specify here can be changed later by directly editing the [wiki:TracIni] configuration file.
    140 
    141 ''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:''
    142 
    143   chown -R apache.apache /path/to/myproject
    144 
    145 '''Warning: If the trac.cgi files are not installed where you expect, then the current documentation is insufficient; it might be necessary to use the 'deploy' command in trac-admin.  See tickets http://trac.edgewall.org/ticket/7312 and possibly http://trac.edgewall.org/ticket/6827'''
     222[TracAdmin trac-admin] will prompt you for the information it needs to create the environment, such as the name of the project and the [TracEnvironment#DatabaseConnectionStrings database connection string]. If you're not sure what to specify for one of these options, just press `<Enter>` to use the default value.
     223
     224Using the default database connection string in particular will always work as long as you have SQLite installed.
     225For the other [DatabaseBackend database backends] you should plan ahead and already have a database ready to use at this point.
     226
     227Since 0.12, Trac doesn't ask for a [TracEnvironment#SourceCodeRepository source code repository] anymore when creating an environment. Repositories can be [TracRepositoryAdmin added] afterward, or the version control support can be disabled completely if you don't need it.
     228
     229Also note that the values you specify here can be changed later by directly editing the [TracIni conf/trac.ini] configuration file.
     230
     231Finally, 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:
     232{{{
     233# chown -R apache.apache /path/to/myproject
     234}}}
    146235
    147236== Running the Standalone Server ==
     
    152241}}}
    153242
    154 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:
     243Then, 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:
    155244{{{
    156245$ tracd -s --port 8000 /path/to/myproject
    157246}}}
    158247
    159 
    160248== Running Trac on a Web Server ==
    161249
    162 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.
    163 
    164 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.
     250Trac 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.
    165251
    166252Trac also supports [trac:TracOnWindowsIisAjp AJP] which may be your choice if you want to connect to IIS.
    167253
     254==== Generating the Trac cgi-bin directory ====
     255
     256In 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].
     257
     258There 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:
     259{{{
     260mkdir -p /usr/share/trac/projects/my-project
     261trac-admin /usr/share/trac/projects/my-project initenv
     262trac-admin /usr/share/trac/projects/my-project deploy /tmp/deploy
     263mv /tmp/deploy/* /usr/share/trac
     264}}}
     265
    168266==== Setting up the Plugin Cache ====
    169267
    170 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.
     268Some 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.
    171269
    172270== Configuring Authentication ==
     
    175273
    176274 * TracStandalone if you use the standalone server, `tracd`.
    177  * TracCgi if you use the CGI or FastCGI methods.
    178  * TracModPython if you use the mod_python method.
     275 * TracCgi if you use the CGI or FastCGI web front ends.
     276 * [wiki:TracModWSGI] if you use the Apache mod_wsgi web front end.
     277 * TracModPython if you use the Apache mod_python web front end.
     278
    179279
    180280== Automatic reference to the SVN changesets in Trac tickets ==
    181281
    182 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:
    183  * '''Refs #123''' - to reference this changeset in #123 ticket
    184  * '''Fixes #123''' - to reference this changeset and close #123 ticket with the default status ''fixed''
    185 
    186 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.
    187 
    188 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:
    189 
    190 {{{
    191 $ cd /path/to/svn/repository/hooks
    192 $ mv post-commit.tmpl post-commit
    193 $ chmod 755 post-commit
    194 }}}
    195 
    196 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:
    197 
    198 {{{
    199 REPOS="$1"
    200 REV="$2"
    201 TRAC_ENV="/path/to/your/trac/project"
    202 
    203 /usr/bin/python /usr/local/bin/trac-post-commit-hook -p "$TRAC_ENV" -r "$REV"
    204 }}}
    205 
    206 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].
    207 
    208 
    209 == Platform-specifics installations ==
    210 
    211  * See [trac:TracInstallPlatforms TracInstallPlatforms]
    212  
     282You 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:
     283 * '''`Refs #123`''' - to reference this changeset in `#123` ticket
     284 * '''`Fixes #123`''' - to reference this changeset and close `#123` ticket with the default status ''fixed''
     285
     286This 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.
     287{{{
     288tracopt.ticket.commit_updater.* = enabled
     289}}}
     290For more information, see the documentation of the `CommitTicketUpdater` component in the "Plugins" admin panel.
    213291
    214292== Using Trac ==
    215293
    216 Once you have your Trac site up and running, you should be able to browse your subversion repository, create tickets, view the timeline, etc.
     294Once 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.
    217295
    218296Keep 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.
     
    223301
    224302----
    225 See also:  TracInstallPlatforms, TracGuide, TracCgi, TracFastCgi, TracModPython, [wiki:TracModWSGI], TracUpgrade, TracPermissions
    226 
     303See also: [trac:TracInstallPlatforms TracInstallPlatforms], TracGuide, TracCgi, TracFastCgi, TracModPython, [wiki:TracModWSGI], TracUpgrade, TracPermissions
     304