Trac is being migrated to new services! Issues can be found in our new YouTrack instance and WIKI pages can be found on our website.

Changes between Version 3 and Version 4 of TracInstall


Ignore:
Timestamp:
Oct 26, 2014, 6:01:55 PM (9 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracInstall

    v3 v4  
    1 = Trac Installation Guide for 1.0 =
     1{{{#!div style="margin-top: .5em; padding: 0 1em; background-color: #ffd; border:1px outset #ddc; text-align: center"
     2
     3 '''NOTE: the information in this page applies to Trac 1.0, the current version of Trac. \\
     4 For installing previous Trac versions, please refer to [[wiki:0.12/TracInstall]] (for Trac 0.12)'''
     5}}}
     6
     7= Trac Installation Guide for 1.0
    28[[TracGuideToc]]
    39
    410Trac 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.
    511
    6 Since version 0.12, Trac can also be localized, and there's probably a translation available for your language. If you want to be able to use the Trac interface in other languages, then make sure you have installed the optional package [#OtherPythonPackages Babel]. Pay attention to the extra steps for localization support in the [#InstallingTrac Installing Trac] section below. Lacking Babel, you will only get the default english version, as usual.
    7 
    8 If you're interested in contributing new translations for other languages or enhance the existing translations, then please have a look at [[trac:TracL10N]].
     12Since 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.
     13
     14If 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].
    915
    1016What follows are generic instructions for installing and setting up Trac and its requirements. While you may find instructions for installing Trac on specific systems at [trac:TracInstallPlatforms TracInstallPlatforms] on the main Trac site, please be sure to '''first read through these general instructions''' to get a good understanding of the tasks involved.
     
    1218[[PageOutline(2-3,Installation Steps,inline)]]
    1319
    14 == Dependencies ==
     20== Dependencies
    1521=== Mandatory Dependencies
    1622To install Trac, the following software packages must be installed:
     
    1824 * [http://www.python.org/ Python], version >= 2.5 and < 3.0
    1925   (note that we dropped the support for Python 2.4 in this release)
    20  * [http://peak.telecommunity.com/DevCenter/setuptools setuptools], version >= 0.6, or better yet, [http://pypi.python.org/pypi/distribute distribute]
    21  * [http://genshi.edgewall.org/wiki/Download Genshi], version >= 0.6 (unreleased version 0.7dev should work as well)
     26 * [http://peak.telecommunity.com/DevCenter/setuptools setuptools], version >= 0.6
     27 * [http://genshi.edgewall.org/wiki/Download Genshi], version >= 0.6
    2228
    2329You also need a database system and the corresponding python bindings.
     
    2834As 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).
    2935
    30 However, if you'd like, you can download the latest and greatest version of [[trac:Pysqlite]] from
     36However, if you'd like, you can download the latest and greatest version of [[trac:PySqlite]] from
    3137[http://code.google.com/p/pysqlite/downloads/list google code], where you'll find the Windows
    3238installers or the `tar.gz` archive for building from source:
    33 {{{
     39{{{#!sh
    3440$ tar xvfz <version>.tar.gz
    3541$ cd <version>
     
    4147SQLite 2.x is no longer supported.
    4248
    43 A known bug PySqlite versions 2.5.2-4 prohibits upgrade of trac databases
     49A known bug in PySqlite versions 2.5.2-4 prohibits upgrades of Trac databases
    4450from 0.11.x to 0.12. Please use versions 2.5.5 and newer or 2.5.1 and
    4551older. See #9434 for more detail.
     
    5157You need to install the database and its Python bindings:
    5258 * [http://www.postgresql.org/ PostgreSQL], version 8.0 or later
    53  * [http://pypi.python.org/pypi/psycopg2 psycopg2]
     59 * [http://pypi.python.org/pypi/psycopg2 psycopg2], version 2.0 or later
    5460
    5561See [trac:DatabaseBackend#Postgresql DatabaseBackend] for details.
     
    6773=== Optional Dependencies
    6874
    69 ==== Version Control System ====
    70 
    71 ===== Subversion =====
     75==== Version Control System
     76
     77===== Subversion
    7278 * [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.
    7379
     
    8086
    8187
    82 ===== Others =====
     88===== Others
    8389
    8490Support for other version control systems is provided via third-parties. See [trac:PluginList] and [trac:VersionControlSystem].
    8591
    86 ==== Web Server ====
    87 A web server is optional because Trac is shipped with a server included, see the [#RunningtheStandaloneServer Running the Standalone Server ] section below.
    88 
    89 Alternatively you configure Trac to run in any of the following environments.
     92==== Web Server
     93A web server is optional because Trac is shipped with a server included, see the [#RunningtheStandaloneServer Running the Standalone Server] section below.
     94
     95Alternatively you can configure Trac to run in any of the following environments.
    9096 * [http://httpd.apache.org/ Apache] with
    9197   - [http://code.google.com/p/modwsgi/ mod_wsgi], see [wiki:TracModWSGI] and
    9298     http://code.google.com/p/modwsgi/wiki/IntegrationWithTrac
    93    - [http://modpython.org/ mod_python 3.3.1], deprecated: see TracModPython)
     99   - [http://modpython.org/ mod_python 3.3.1], (deprecated: see TracModPython)
    94100 * a [http://www.fastcgi.com/ FastCGI]-capable web server (see TracFastCgi)
    95101 * an [http://tomcat.apache.org/connectors-doc/ajp/ajpv13a.html AJP]-capable web
     
    99105   
    100106
    101 ==== Other Python Packages ====
     107==== Other Python Packages
    102108
    103109 * [http://babel.edgewall.org Babel], version >= 0.9.5,
     
    105111 * [http://docutils.sourceforge.net/ docutils], version >= 0.3.9
    106112   for WikiRestructuredText.
    107  * [http://pygments.pocoo.org Pygments] for
     113 * [http://pygments.org Pygments] for
    108114   [wiki:TracSyntaxColoring syntax highlighting].
    109115   [http://silvercity.sourceforge.net/ SilverCity] and/or
     
    114120   an internal time zone implementation.
    115121
    116 '''Attention''': The various available versions of these dependencies are not necessarily interchangable, so please pay attention to the version numbers above. If you are having trouble getting Trac to work please double-check all the dependencies before asking for help on the [trac:MailingList] or [trac:IrcChannel].
     122'''Attention''': The various available versions of these dependencies are not necessarily interchangeable, 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].
    117123
    118124Please 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!).
    119125
    120126
    121 == Installing Trac ==
     127== Installing Trac
    122128=== Using `easy_install`
    123129One way to install Trac is using [http://pypi.python.org/pypi/setuptools setuptools].
    124 With setuptools you can install Trac from the subversion repository;
     130With setuptools you can install Trac from the Subversion repository;
    125131
    126132A few examples:
    127133
    128  - install Trac 1.0:
    129    {{{
     134 - Install Trac 1.0:
     135   {{{#!sh
    130136   easy_install Trac==1.0
    131137   }}}
    132    (NOT YET ENABLED)
    133  - install latest development version 1.0dev:
    134    {{{
     138 - Install latest development version:
     139   {{{#!sh
    135140   easy_install Trac==dev
    136141   }}}
     
    138143   either use a released version or install from source
    139144
     145{{{#!div style="border: 1pt dotted; margin: 1em"
     146**Setuptools Warning:** If the version of your setuptools is in the range 5.4 through 5.6, the environment variable `PKG_RESOURCES_CACHE_ZIP_MANIFESTS` must be set in order to avoid significant performance degradation. More information may be found in the sections on [#RunningtheStandaloneServer Running The Standalone Server] and [#RunningTraconaWebServer Running Trac on a Web Server].
     147}}}
     148
    140149=== Using `pip`
    141150'pip' is an easy_install replacement that is very useful to quickly install python packages.
    142 To get a trac installation up and running in less than 5 minutes:
     151To get a Trac installation up and running in less than 5 minutes:
    143152
    144153Assuming you want to have your entire pip installation in `/opt/user/trac`
    145154
    146155 -
    147 {{{
    148 pip -E /opt/user/trac install trac psycopg2
     156 {{{#!sh
     157pip install trac psycopg2
    149158}}}
    150159or
    151160 -
    152 {{{
    153 pip -E /opt/user/trac install trac mysql-python
    154 }}}
    155 
    156 Make sure your OS specific headers are available for pip to automatically build PostgreSQL (libpq-dev) or MySQL (libmysqlclient-dev) bindings.
     161 {{{#!sh
     162pip install trac mysql-python
     163}}}
     164
     165Make sure your OS specific headers are available for pip to automatically build PostgreSQL (`libpq-dev`) or MySQL (`libmysqlclient-dev`) bindings.
    157166
    158167pip 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`.
     
    160169All 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)
    161170
    162 Additionally, you can install several trac plugins (listed [http://pypi.python.org/pypi?:action=search&term=trac&submit=search here]) through pip.
     171Additionally, you can install several Trac plugins (listed [http://pypi.python.org/pypi?:action=search&term=trac&submit=search here]) through pip.
    163172
    164173
     
    167176Of course, using the python-typical setup at the top of the source directory also works.
    168177
    169 You can obtain the source for a .tar.gz or .zip file corresponding to a release (e.g. Trac-1.0.tar.gz), or you can get the source directly from the repository (see Trac:SubversionRepository for details).
    170 
    171 {{{
     178You 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).
     179
     180{{{#!sh
    172181$ python ./setup.py install
    173182}}}
     
    175184''You'll need root permissions or equivalent for this step.''
    176185
    177 This will byte-compile the python source code and install it as an .egg file or folder in the `site-packages` directory
    178 of your Python installation. The .egg will also contain all other resources needed by standard Trac, such as htdocs and templates.
     186This will byte-compile the Python source code and install it as an .egg file or folder in the `site-packages` directory
     187of your Python installation. The .egg will also contain all other resources needed by standard Trac, such as `htdocs` and `templates`.
    179188
    180189The 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.
    181190
    182 If you install from source and want to make Trac available in other languages, make sure  Babel is installed. Only then, perform the `install` (or simply redo the `install` once again afterwards if you realize Babel was not yet installed):
    183 {{{
     191If 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):
     192{{{#!sh
    184193$ python ./setup.py install
    185194}}}
    186 Alternatively, you can do a `bdist_egg` and copy the .egg from dist/ to the place of your choice, or you can create a Windows installer (`bdist_wininst`).
    187 
    188 === Advanced Options ===
     195Alternatively, 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`).
     196
     197=== Advanced Options
    189198
    190199To install Trac to a custom location, or find out about other advanced installation options, run:
    191 {{{
     200{{{#!sh
    192201easy_install --help
    193202}}}
    194203
    195 Also see [http://docs.python.org/inst/inst.html Installing Python Modules] for detailed information.
     204Also see [http://docs.python.org/2/install/index.html Installing Python Modules] for detailed information.
    196205
    197206Specifically, you might be interested in:
    198 {{{
     207{{{#!sh
    199208easy_install --prefix=/path/to/installdir
    200209}}}
    201 or, if installing Trac to a Mac OS X system:
    202 {{{
     210or, if installing Trac on a Mac OS X system:
     211{{{#!sh
    203212easy_install --prefix=/usr/local --install-dir=/Library/Python/2.5/site-packages
    204213}}}
    205 Note: If installing on Mac OS X 10.6 running {{{ easy_install http://svn.edgewall.org/repos/trac/trunk }}} will install into {{{ /usr/local }}} and {{{ /Library/Python/2.6/site-packages }}} by default
     214Note: 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.
    206215
    207216The 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.
    208217
    209218
    210 == Creating a Project Environment ==
     219== Creating a Project Environment
    211220
    212221A [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.
    213222
    214223A new environment is created using [wiki:TracAdmin trac-admin]:
    215 {{{
     224{{{#!sh
    216225$ trac-admin /path/to/myproject initenv
    217226}}}
     
    222231For the other [DatabaseBackend database backends] you should plan ahead and already have a database ready to use at this point.
    223232
    224 Since 0.12, Trac doesn't ask for a [TracEnvironment#SourceCodeRepository source code repository] anymore when creating an environment. Repositories can be [TracRepositoryAdmin added] afterward, or the version control support can be disabled completely if you don't need it.
     233Since 0.12, Trac doesn't ask for a [TracEnvironment#SourceCodeRepository source code repository] anymore when creating an environment. Repositories can be [TracRepositoryAdmin added] afterwards, and support for specific version control systems is disabled by default.
    225234
    226235Also note that the values you specify here can be changed later by directly editing the [TracIni conf/trac.ini] configuration file.
    227236
     237When 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 (though the best advice is to opt for a platform with sub-second timestamp resolution when possible regardless of the version of Trac you are running).
     238
    228239Finally, make sure the user account under which the web front-end runs will have '''write permissions''' to the environment directory and all the files inside. This will be the case if you run `trac-admin ... initenv` as this user. If not, you should set the correct user afterwards. For example on Linux, with the web server running as user `apache` and group `apache`, enter:
    229 {{{
    230 # chown -R apache.apache /path/to/myproject
    231 }}}
     240{{{#!sh
     241$ chown -R apache.apache /path/to/myproject
     242}}}
     243
     244The 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).
    232245
    233246{{{#!div class=important
     
    238251== Deploying Trac
    239252
    240 === Running the Standalone Server ===
     253=== Running the Standalone Server
    241254
    242255After having created a Trac environment, you can easily try the web interface by running the standalone server [wiki:TracStandalone tracd]:
    243 {{{
     256{{{#!sh
    244257$ tracd --port 8000 /path/to/myproject
    245258}}}
    246259
    247260Then, fire up a browser and visit `http://localhost:8000/`. You should get a simple listing of all environments that `tracd` knows about. Follow the link to the environment you just created, and you should see Trac in action. If you only plan on managing a single project with Trac you can have the standalone server skip the environment list by starting it like this:
    248 {{{
     261{{{#!sh
    249262$ tracd -s --port 8000 /path/to/myproject
    250263}}}
    251264
    252 === Running Trac on a Web Server ===
     265{{{#!div style="border: 1pt dotted; margin: 1em"
     266**Setuptools Warning:** If the version of your setuptools is in the range 5.4 through 5.6, the environment variable `PKG_RESOURCES_CACHE_ZIP_MANIFESTS` must be set in order to avoid significant performance degradation. The environment variable can be set system-wide, or for just the user that runs the `tracd` process. There are several ways to accomplish this in addition to what is discussed here, and depending on the distribution of your OS.
     267
     268To be effective system-wide a shell script with the `export` statement may be added to `/etc/profile.d`. To be effective for a user session the `export` statement may be added to `~/.profile`.
     269{{{#!sh
     270export PKG_RESOURCES_CACHE_ZIP_MANIFESTS=1
     271}}}
     272
     273Alternatively, the variable can be set in the shell before executing `tracd`:
     274{{{#!sh
     275$ PKG_RESOURCES_CACHE_ZIP_MANIFESTS=1 tracd --port 8000 /path/to/myproject
     276}}}
     277}}}
     278
     279=== Running Trac on a Web Server
    253280
    254281Trac provides various options for connecting to a "real" web server:
     
    260287Trac 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.
    261288
    262 ==== Generating the Trac cgi-bin directory ==== #cgi-bin
     289==== Generating the Trac cgi-bin directory #cgi-bin
    263290
    264291In 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].
    265292
    266293There is, however, a bit of a chicken-and-egg problem. The [wiki:TracAdmin trac-admin] command requires an existing environment to function, but complains if the deploy directory already exists. This is a problem, because environments are often stored in a subdirectory of the deploy. The solution is to do something like this:
    267 {{{
     294{{{#!sh
    268295mkdir -p /usr/share/trac/projects/my-project
    269296trac-admin /usr/share/trac/projects/my-project initenv
     
    271298mv /tmp/deploy/* /usr/share/trac
    272299}}}
    273 
    274 
    275 ==== Mapping Static Resources ====
     300Don't forget to check that the web server has the execution right on scripts in the `/usr/share/trac/cgi-bin` directory.
     301
     302
     303==== Mapping Static Resources
    276304
    277305Out 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).
     
    289317 - `<plugins>/` - one directory for each resource directory managed by the plugins enabled for this environment
    290318
    291 ===== Example: Apache and `ScriptAlias` ===== #ScriptAlias-example
     319===== Example: Apache and `ScriptAlias` #ScriptAlias-example
    292320
    293321Assuming the deployment has been done this way:
    294 {{{
     322{{{#!sh
    295323$ trac-admin /var/trac/env deploy /path/to/trac/htdocs/common
    296324}}}
    297325
    298326Add the following snippet to Apache configuration ''before'' the `ScriptAlias` or `WSGIScriptAlias` (which map all the other requests to the Trac application), changing paths to match your deployment:
    299 {{{
     327{{{#!apache
    300328Alias /trac/chrome/common /path/to/trac/htdocs/common
    301329Alias /trac/chrome/site /path/to/trac/htdocs/site
     
    308336
    309337If using mod_python, you might want to add this too (otherwise, the alias will be ignored):
    310 {{{
     338{{{#!apache
    311339<Location "/trac/chrome/common/">
    312340  SetHandler None
     
    317345
    318346Similarly, if you have static resources in a project's `htdocs` directory (which is referenced by `/trac/chrome/site` URL in themes), you can configure Apache to serve those resources (again, put this ''before'' the `ScriptAlias` or `WSGIScriptAlias` for the .*cgi scripts, and adjust names and locations to match your installation):
    319 {{{
     347{{{#!apache
    320348Alias /trac/chrome/site /path/to/projectenv/htdocs
    321349
     
    327355
    328356Alternatively to aliasing `/trac/chrome/common`, you can tell Trac to generate direct links for those static resources (and only those), using the [[wiki:TracIni#trac-section| [trac] htdocs_location]] configuration setting:
    329 {{{
     357{{{#!ini
    330358[trac]
    331359htdocs_location = http://static.example.org/trac-common/
     
    334362
    335363Of course, you still need to make the Trac `htdocs/common` directory available through the web server at the specified URL, for example by copying (or linking) the directory into the document root of the web server:
    336 {{{
     364{{{#!sh
    337365$ ln -s /path/to/trac/htdocs/common /var/www/static.example.org/trac-common
    338366}}}
    339367
    340368
    341 ==== Setting up the Plugin Cache ====
    342 
    343 Some Python plugins need to be extracted to a cache directory. By default the cache resides in the home directory of the current user. When running Trac on a Web Server as a dedicated user (which is highly recommended) who has no home directory, this might prevent the plugins from starting. To override the cache location you can set the PYTHON_EGG_CACHE environment variable. Refer to your server documentation for detailed instructions on how to set environment variables.
    344 
    345 == Configuring Authentication ==
    346 
    347 Trac uses HTTP authentication. You'll need to configure your webserver to request authentication when the `.../login` URL is hit (the virtual path of the "login" button). Trac will automatically pick the REMOTE_USER variable up after you provide your credentials. Therefore, all user management goes through your web server configuration. Please consult the documentation of your web server for more info.
     369==== Setting up the Plugin Cache
     370
     371Some 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.
     372
     373== Configuring Authentication
     374
     375Trac uses HTTP authentication. You'll need to configure your webserver to request authentication when the `.../login` URL is hit (the virtual path of the "login" button). Trac will automatically pick the `REMOTE_USER` variable up after you provide your credentials. Therefore, all user management goes through your web server configuration. Please consult the documentation of your web server for more info.
    348376
    349377The process of adding, removing, and configuring user accounts for authentication depends on the specific way you run Trac.
     
    354382 * TracFastCgi if you're using another web server with FCGI support (Cherokee, Lighttpd, !LiteSpeed, nginx)
    355383
     384The following document also constains some useful information for beginners: [trac:TracAuthenticationIntroduction].
     385
    356386== Granting admin rights to the admin user
    357387Grant admin rights to user admin:
    358 {{{
     388{{{#!sh
    359389$ trac-admin /path/to/myproject permission add admin TRAC_ADMIN
    360390}}}
    361 This user will have an "Admin" entry menu that will allow you to admin your trac project.
     391This user will have an "Admin" entry menu that will allow you to administrate your Trac project.
    362392
    363393== Finishing the install
    364394
    365 === Automatic reference to the SVN changesets in Trac tickets ===
     395=== Enable version control components
     396
     397Support 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.
     398
     399The 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.
     400
     401{{{#!ini
     402tracopt.versioncontrol.svn.* = enabled
     403}}}
     404
     405{{{#!ini
     406tracopt.versioncontrol.git.* = enabled
     407}}}
     408
     409After enabling the components, repositories can be configured through the "Repositories" admin panel or by editing [TracIni#repositories-section trac.ini].
     410
     411=== Automatic reference to the SVN changesets in Trac tickets
    366412
    367413You 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:
     
    370416
    371417This functionality requires a post-commit hook to be installed as described in [wiki:TracRepositoryAdmin#ExplicitSync TracRepositoryAdmin], and enabling the optional commit updater components by adding the following line to the `[components]` section of your [wiki:TracIni#components-section trac.ini], or enabling the components in the "Plugins" admin panel.
    372 {{{
     418{{{#!ini
    373419tracopt.ticket.commit_updater.* = enabled
    374420}}}
    375421For more information, see the documentation of the `CommitTicketUpdater` component in the "Plugins" admin panel.
    376422
    377 === Using Trac ===
     423=== Using Trac
    378424
    379425Once 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.
All information, including names and email addresses, entered onto this website or sent to mailing lists affiliated with this website will be public. Do not post confidential information, especially passwords!