Changes between Version 4 and Version 5 of TracInstall


Ignore:
Timestamp:
Aug 9, 2015, 2:19:44 AM (9 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracInstall

    v4 v5  
    11= Trac Installation Guide for 1.0
     2
    23[[TracGuideToc]]
    34
     
    67Since 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.
    78
    8 If 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].
     9If you're interested in contributing new translations for other languages or enhancing the existing translations, then please have a look at [trac:wiki:TracL10N TracL10N].
    910
    1011What 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.
     
    1314
    1415== Dependencies
     16
    1517=== Mandatory Dependencies
     18
    1619To install Trac, the following software packages must be installed:
    1720
    1821 * [http://www.python.org/ Python], version >= 2.5 and < 3.0
    1922   (note that we dropped the support for Python 2.4 in this release)
    20  * [http://peak.telecommunity.com/DevCenter/setuptools setuptools], version >= 0.6
     23 * [http://pypi.python.org/pypi/setuptools setuptools], version >= 0.6
    2124 * [http://genshi.edgewall.org/wiki/Download Genshi], version >= 0.6
    2225
     
    2730As 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.
    2831
    29 However, 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
    31 installers or the `tar.gz` archive for building from source:
    32 {{{#!sh
    33 $ tar xvfz <version>.tar.gz
    34 $ cd <version>
    35 $ python setup.py build_static install
    36 }}}
    37  
    38 This will download the latest SQLite code and build the bindings. SQLite 2.x is no longer supported.
    39 
    40 A 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].
     32Optionally, you may install a newer version of [pypi:pysqlite pysqlite] than the one provided by the Python distribution. See [trac:PySqlite#ThePysqlite2bindings PySqlite] for details.
    4133
    4234==== For the PostgreSQL database #ForPostgreSQL
     
    5244Trac works well with MySQL, provided you follow the guidelines:
    5345
    54  * [http://mysql.com/ MySQL], version 5.0 or later
     46 * [http://mysql.com/ MySQL] or [http://mariadb.org/ MariaDB], version 5.0 or later
    5547 * [http://sf.net/projects/mysql-python MySQLdb], version 1.2.2 or later
    5648
    57 Given the caveats and known issues surrounding MySQL, read carefully the [trac:MySqlDb] page before creating the database.
     49Given the caveats and known issues surrounding MySQL, read the [trac:MySqlDb] page before creating the database.
    5850
    5951=== Optional Dependencies
     
    6254
    6355===== 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.
     56 * [http://subversion.apache.org/ Subversion], 1.5.x or later and the '''corresponding''' Python bindings. Older versions starting from 1.0, like 1.2.4, 1.3.2 or 1.4.2, etc. may still work. For troubleshooting information, check the [trac:TracSubversion#Troubleshooting TracSubversion] page.
    6557
    6658There 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.)
     
    6860Note that Trac '''doesn't''' use [http://pysvn.tigris.org/ PySVN], neither does it work yet with the newer `ctype`-style bindings.
    6961
    70 '''Please note:''' if using Subversion, Trac must be installed on the '''same machine'''. Remote repositories are currently [trac:ticket:493 not supported].
     62'''Note:''' if using Subversion, Trac must be installed on the '''same machine'''. Remote repositories are currently [trac:ticket:493 not supported].
     63
     64===== Git
     65 * [http://git-scm.com/ Git] 1.5.6 or later.
     66
     67More information is available on the [trac:TracGit] page.
    7168
    7269===== Others
    7370
    74 Support for other version control systems is provided via third-parties. See [trac:PluginList] and [trac:VersionControlSystem].
     71Support for other version control systems is provided via third-parties. See [trac:PluginList#VersionControlSystems] and [trac:VersionControlSystem].
    7572
    7673==== Web Server
    77 A web server is optional because Trac is shipped with a server included, see the [#RunningtheStandaloneServer Running the Standalone Server] section below.
     74
     75A web server is optional because Trac has a server included, see the [#RunningtheStandaloneServer Running the Standalone Server] section below.
    7876
    7977Alternatively you can configure Trac to run in any of the following environments:
     
    8179   - [http://code.google.com/p/modwsgi/ mod_wsgi], see [wiki:TracModWSGI] and
    8280     http://code.google.com/p/modwsgi/wiki/IntegrationWithTrac
    83    - [http://modpython.org/ mod_python >= 3.3.1], (deprecated: see TracModPython)
     81   - [http://modpython.org/ mod_python 3.5.0], see TracModPython
    8482 * a [http://www.fastcgi.com/ FastCGI]-capable web server (see TracFastCgi)
    8583 * an [http://tomcat.apache.org/connectors-doc/ajp/ajpv13a.html AJP]-capable web
    8684   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.
     85 * a FastCGI and FastCGI-to-WSGI gateway (see [trac:TracOnWindowsIisWfastcgi])
     86 * a CGI-capable web server (see TracCgi), but //usage of Trac as a cgi script
     87   is highly discouraged//, better use one of the previous options.
    8988   
    90 
    9189==== Other Python Packages
    9290
    93  * [http://babel.edgewall.org Babel], version >= 0.9.5,
    94    needed for localization support (unreleased version 1.0dev should work as well)
     91 * [http://babel.edgewall.org Babel], version 0.9.5, 0.9.6 or >= 1.3
     92   needed for localization support
    9593 * [http://docutils.sourceforge.net/ docutils], version >= 0.3.9
    9694   for WikiRestructuredText.
    9795 * [http://pygments.org Pygments] for
    98    [wiki:TracSyntaxColoring syntax highlighting].
     96   [TracSyntaxColoring syntax highlighting].
    9997   [http://silvercity.sourceforge.net/ SilverCity] and/or
    10098   [http://gnu.org/software/enscript/enscript.html Enscript] may still be used
     
    104102   an internal time zone implementation.
    105103
    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 
    108 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!
     104{{{#!div style="border: 1pt dotted; margin: 1em"
     105**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].
     106}}}
     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.
    109109
    110110== Installing Trac
     111
     112The [TracAdmin trac-admin] command-line tool, used to create and maintain [TracEnvironment project environments], as well as the [TracStandalone tracd] standalone server are installed along with Trac. There are several methods for installing Trac.
     113
    111114=== Using `easy_install`
    112 One way to install Trac is using [http://pypi.python.org/pypi/setuptools setuptools]. With setuptools you can install Trac from the Subversion repository.
    113 
    114 A few examples:
     115
     116Trac can be installed from [https://pypi.python.org/pypi/Trac PyPI] or the Subversion repository using [pypi:setuptools setuptools].
     117
     118A few command-line examples:
    115119
    116120 - Install Trac 1.0:
    117    {{{#!sh
    118   easy_install Trac==1.0
    119    }}}
     121 {{{#!sh
     122$ easy_install Trac==1.0
     123}}}
    120124 - Install latest development version:
    121    {{{#!sh
    122   easy_install Trac==dev
    123    }}}
     125 {{{#!sh
     126$ easy_install Trac==dev
     127}}}
    124128   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
     129   either use a released version or install from source.
     130
     131More information can be found on the [trac:setuptools] page.
    126132
    127133{{{#!div style="border: 1pt dotted; margin: 1em"
     
    130136
    131137=== Using `pip`
    132 'pip' is an easy_install replacement that is very useful to quickly install python packages.
     138
     139'pip' is an easy_install replacement that is very useful to quickly install Python packages.
    133140To get a Trac installation up and running in less than 5 minutes:
    134141
    135 Assuming you want to have your entire pip installation in `/opt/user/trac`
     142Assuming you want to have your entire pip installation in `/opt/user/trac`:
    136143
    137144 -
    138145 {{{#!sh
    139 pip install trac psycopg2
    140 }}}
    141 or
     146$ pip install trac psycopg2
     147}}}
     148or:
    142149 -
    143150 {{{#!sh
    144 pip install trac mysql-python
     151$ pip install trac mysql-python
    145152}}}
    146153
    147154Make sure your OS specific headers are available for pip to automatically build PostgreSQL (`libpq-dev`) or MySQL (`libmysqlclient-dev`) bindings.
    148155
    149 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`.
    150 
    151 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)
     156pip will automatically resolve all dependencies (like Genshi, pygments, etc.), download the latest packages from pypi.python.org and create a self contained installation in `/opt/user/trac`.
     157
     158All 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).
    152159
    153160Additionally, you can install several Trac plugins (listed [https://pypi.python.org/pypi?:action=browse&show=all&c=516 here]) through pip.
    154161
    155162=== From source
    156 Of 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.
     163
     164Using the python-typical setup at the top of the source directory also works. You can obtain the source for a .tar.gz or .zip file corresponding to a release (e.g. `Trac-1.0.tar.gz`) from the [trac:TracDownload] page, or you can get the source directly from the repository. See [trac:TracRepositories#OfficialSubversionrepository TracRepositories] for details.
    157165
    158166{{{#!sh
     
    160168}}}
    161169
    162 ''You will need root permissions or equivalent for this step.''
     170You will need root permissions or equivalent for this step.
    163171
    164172This will byte-compile the Python source code and install it as an .egg file or folder in the `site-packages` directory
    165173of your Python installation. The .egg will also contain all other resources needed by standard Trac, such as `htdocs` and `templates`.
    166174
    167 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.
    168 
    169175If 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):
    170176{{{#!sh
    171177$ python ./setup.py install
    172178}}}
     179
    173180Alternatively, 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`).
    174181
    175 === Advanced Options
     182=== Using installer
     183
     184On Windows Trac can be installed using the exe installers available on the [trac:TracDownload] page. Installers are available for the 32 and 64 bit versions of Python. Make sure to use the installer that matches the architecture of your Python installation.
     185
     186=== Using package manager
     187
     188Trac may be available in the package repository for your platform. Note however, that the version provided by the package manager may not be the latest release.
     189
     190=== Advanced `easy_install` Options
    176191
    177192To install Trac to a custom location, or find out about other advanced installation options, run:
    178193{{{#!sh
    179 easy_install --help
     194$ easy_install --help
    180195}}}
    181196
     
    184199Specifically, you might be interested in:
    185200{{{#!sh
    186 easy_install --prefix=/path/to/installdir
    187 }}}
     201$ easy_install --prefix=/path/to/installdir
     202}}}
     203
    188204or, if installing Trac on a Mac OS X system:
    189205{{{#!sh
    190 easy_install --prefix=/usr/local --install-dir=/Library/Python/2.5/site-packages
    191 }}}
    192 Note: If installing on Mac OS X 10.6 running {{{ easy_install http://svn.edgewall.org/repos/trac/trunk }}} will install into {{{ /usr/local }}} and {{{ /Library/Python/2.6/site-packages }}} by default.
     206$ easy_install --prefix=/usr/local --install-dir=/Library/Python/2.5/site-packages
     207}}}
     208
     209'''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.5/site-packages }}} by default.
    193210
    194211The 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.
     
    198215A [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.
    199216
    200 A new environment is created using [wiki:TracAdmin trac-admin]:
     217A new environment is created using [TracAdmin trac-admin]:
    201218{{{#!sh
    202219$ trac-admin /path/to/myproject initenv
     
    212229Also note that the values you specify here can be changed later by directly editing the [TracIni conf/trac.ini] configuration file.
    213230
    214 When selecting the location of your environment, make sure that the filesystem on which the environment directory resides supports sub-second timestamps (i.e. **not** `ext2` or `ext3` on Linux), 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.
     231{{{#!div style="border: 1pt dotted; margin: 1em"
     232**Filesystem Warning:** When selecting the location of your environment, make sure that the filesystem on which the environment directory resides supports sub-second timestamps (i.e. **not** `ext2` or `ext3` on Linux, or HFS+ on OSX), as the modification time of the `conf/trac.ini` file will be monitored to decide whether an environment restart is needed or not. A too coarse-grained timestamp resolution may result in inconsistencies in Trac < 1.0.2. The best advice is to opt for a platform with sub-second timestamp resolution, regardless of the Trac version.
     233}}}
    215234
    216235Finally, 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:
     
    219238}}}
    220239
    221 The 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).
     240The 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).
    222241
    223242{{{#!div class=important
     
    229248=== Running the Standalone Server
    230249
    231 After having created a Trac environment, you can easily try the web interface by running the standalone server [wiki:TracStandalone tracd]:
     250After having created a Trac environment, you can easily try the web interface by running the standalone server [TracStandalone tracd]:
    232251{{{#!sh
    233252$ tracd --port 8000 /path/to/myproject
     
    256275
    257276Trac provides various options for connecting to a "real" web server:
    258  - [wiki:TracFastCgi FastCGI]
     277 - [TracFastCgi FastCGI]
    259278 - [wiki:TracModWSGI mod_wsgi]
    260  - //[wiki:TracModPython mod_python] (no longer recommended, as mod_python is not actively maintained anymore)//
    261  - //[wiki:TracCgi CGI] (should not be used, as the performance is far from optimal)//
     279 - [TracModPython mod_python]
     280 - //[TracCgi CGI]: should not be used, as it degrades performance//
    262281
    263282Trac 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.
     
    265284==== Generating the Trac cgi-bin directory #cgi-bin
    266285
    267 In order for Trac to function properly with FastCGI you need to have a `trac.fcgi` file and for mod_wsgi a `trac.wsgi` file. These are Python scripts which load the appropriate Python code. They can be generated using the `deploy` option of [wiki:TracAdmin trac-admin].
    268 
    269 There is, however, a bit of a chicken-and-egg problem. The [wiki:TracAdmin trac-admin] command requires an existing environment to function, but complains if the deploy directory already exists. This is a problem, because environments are often stored in a subdirectory of the deploy. The solution is to do something like this:
    270 {{{#!sh
    271 mkdir -p /usr/share/trac/projects/my-project
    272 trac-admin /usr/share/trac/projects/my-project initenv
    273 trac-admin /usr/share/trac/projects/my-project deploy /tmp/deploy
    274 mv /tmp/deploy/* /usr/share/trac
    275 }}}
     286In 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 [TracAdmin trac-admin].
     287
     288There is, however, a bit of a chicken-and-egg problem. The [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:
     289{{{#!sh
     290$ mkdir -p /usr/share/trac/projects/my-project
     291$ trac-admin /usr/share/trac/projects/my-project initenv
     292$ trac-admin /usr/share/trac/projects/my-project deploy /tmp/deploy
     293$ mv /tmp/deploy/* /usr/share/trac
     294}}}
     295
    276296Don't forget to check that the web server has the execution right on scripts in the `/usr/share/trac/cgi-bin` directory.
    277297
    278298==== Mapping Static Resources
    279299
    280 Out of the box, Trac will pass static resources such as style sheets or images through itself. For anything but a tracd only based deployment, this is far from optimal as the web server could be set up to directly serve those static resources (for CGI setup, this is '''highly undesirable''' and will cause abysmal performance).
    281 
    282 Web servers such as [http://httpd.apache.org/ Apache] allow you to create “Aliases” to resources, giving them a virtual URL that doesn't necessarily reflect the layout of the servers file system. We also can map requests for static resources directly to the directory on the file system, avoiding processing these requests by Trac itself.
     300Out 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''' as it causes abysmal performance.
     301
     302Web servers such as [http://httpd.apache.org/ Apache] allow you to create "Aliases" to resources, giving them a virtual URL that doesn't necessarily reflect the layout of the servers file system. We also can map requests for static resources directly to the directory on the file system, avoiding processing these requests by Trac itself.
    283303
    284304There are two primary URL paths for static resources - `/chrome/common` and `/chrome/site`. Plugins can add their own resources, usually accessible by `/chrome/<plugin>` path, so its important to override only known paths and not try to make universal `/chrome` alias for everything.
     
    310330}}}
    311331
    312 If using mod_python, you might want to add this too (otherwise, the alias will be ignored):
     332If using mod_python, you might want to add this too, otherwise the alias will be ignored:
    313333{{{#!apache
    314334<Location "/trac/chrome/common/">
     
    329349}}}
    330350
    331 Alternatively to aliasing `/trac/chrome/common`, you can tell Trac to generate direct links for those static resources (and only those), using the [[wiki:TracIni#trac-section| [trac] htdocs_location]] configuration setting:
     351Alternatively to aliasing `/trac/chrome/common`, you can tell Trac to generate direct links for those static resources (and only those), using the [[TracIni#trac-section| [trac] htdocs_location]] configuration setting:
    332352{{{#!ini
    333353[trac]
    334354htdocs_location = http://static.example.org/trac-common/
    335355}}}
    336 Note that this makes it easy to have a dedicated domain serve those static resources (preferentially [http://code.google.com/speed/page-speed/docs/request.html#ServeFromCookielessDomain cookie-less]).
     356
     357Note that this makes it easy to have a dedicated domain serve those static resources, preferentially [http://code.google.com/speed/page-speed/docs/request.html#ServeFromCookielessDomain cookie-less].
    337358
    338359Of 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:
     
    354375 * TracStandalone#UsingAuthentication if you use the standalone server, `tracd`.
    355376 * [wiki:TracModWSGI#ConfiguringAuthentication TracModWSGI#ConfiguringAuthentication] if you use the Apache web server, with any of its front end: `mod_wsgi` of course, but the same instructions applies also for `mod_python`, `mod_fcgi` or `mod_fastcgi`.
    356  * TracFastCgi if you're using another web server with FCGI support (Cherokee, Lighttpd, !LiteSpeed, nginx)
    357 
    358 The following document also constains some useful information for beginners: [trac:TracAuthenticationIntroduction].
     377 * TracFastCgi if you are using another web server with FCGI support, such as Cherokee, Lighttpd, !LiteSpeed, nginx.
     378
     379The following document also contains some useful information for beginners: [trac:TracAuthenticationIntroduction].
    359380
    360381== Granting admin rights to the admin user
     382
    361383Grant admin rights to user admin:
    362384{{{#!sh
    363385$ trac-admin /path/to/myproject permission add admin TRAC_ADMIN
    364386}}}
     387
    365388This user will have an "Admin" entry menu that will allow you to administrate your Trac project.
    366389
     
    371394Support 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.
    372395
    373 The 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.
     396The version control systems are 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:
    374397
    375398{{{#!ini
     399[components]
    376400tracopt.versioncontrol.svn.* = enabled
    377401}}}
    378402
    379403{{{#!ini
     404[components]
    380405tracopt.versioncontrol.git.* = enabled
    381406}}}
    382407
    383 After 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
    386 
    387 You can configure SVN to automatically add a reference to the changeset into the ticket comments, whenever changes are committed to the repository. The description of the commit needs to contain one of the following formulas:
    388  * '''`Refs #123`''' - to reference this changeset in `#123` ticket
    389  * '''`Fixes #123`''' - to reference this changeset and close `#123` ticket with the default status ''fixed''
    390 
    391 This functionality requires a post-commit hook to be installed as described in [wiki:TracRepositoryAdmin#ExplicitSync TracRepositoryAdmin], and enabling the optional commit updater components by adding the following line to the `[components]` section of your [wiki:TracIni#components-section trac.ini], or enabling the components in the "Plugins" admin panel.
    392 {{{#!ini
    393 tracopt.ticket.commit_updater.* = enabled
    394 }}}
    395 For more information, see the documentation of the `CommitTicketUpdater` component in the "Plugins" admin panel.
     408After enabling the components, repositories can be configured through the //Repositories// admin panel or by editing [TracIni#repositories-section trac.ini]. Automatic changeset references can be inserted as ticket comments by configuring [TracRepositoryAdmin#Automaticchangesetreferencesintickets CommitTicketUpdater].
    396409
    397410=== Using Trac
     
    399412Once 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.
    400413
    401 Keep in mind that //anonymous// (not logged in) users can by default access only a few of the features, in particular they will have a read-only access to the resources. You will need to configure authentication and grant additional [wiki:TracPermissions permissions] to authenticated users to see the full set of features.
     414Keep in mind that //anonymous// (not logged in) users can by default access only a few of the features, in particular they will have a read-only access to the resources. You will need to configure authentication and grant additional [TracPermissions permissions] to authenticated users to see the full set of features.
    402415
    403416'' Enjoy! ''