ここの情報は古いです。ご理解頂いた上でお取り扱いください。

Changes between Version 3 and Version 4 of TracInstall


Ignore:
Timestamp:
May 30, 2017, 1:52:50 PM (6 months ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracInstall

    v3 v4  
    1 = Trac Installation Guide for 0.12 =
     1= Trac Installation Guide for 1.2
    22[[TracGuideToc]]
    33
    44Trac is written in the Python programming language and needs a database, [http://sqlite.org/ SQLite], [http://www.postgresql.org/ PostgreSQL], or [http://mysql.com/ MySQL]. For HTML rendering, Trac uses the [http://genshi.edgewall.org Genshi] templating system.
    55
    6 Since version 0.12, Trac can also be localized, and there's probably a translation available for your language. If you want to be able to use the Trac interface in other languages, then make sure you **first** have installed the optional package [#OtherPythonPackages Babel]. Lacking Babel, you will only get the default English version, as usual. If you install Babel later on, you will need to re-install Trac.
    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:wiki:TracL10N TracL10N].
    9 
    10 What follows are generic instructions for installing and setting up Trac and its requirements. While you may find instructions for installing Trac on specific systems at [trac:wiki:TracInstallPlatforms TracInstallPlatforms] on the main Trac site, please be sure to '''first read through these general instructions''' to get a good understanding of the tasks involved.
     6Trac 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.
     7
     8If 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].
     9
     10What follows are generic instructions for installing and setting up Trac. While you may find instructions for installing Trac on specific systems at [trac:TracInstallPlatforms TracInstallPlatforms], please '''first read through these general instructions''' to get a good understanding of the tasks involved.
    1111
    1212[[PageOutline(2-3,Installation Steps,inline)]]
    1313
    14 == Dependencies ==
     14== Dependencies
    1515=== Mandatory Dependencies
    1616To install Trac, the following software packages must be installed:
    1717
    18  * [http://www.python.org/ Python], version >= 2.4 and < 3.0
    19    //(note that we dropped the support for Python 2.3 in this release and that this will be the last Trac release supporting Python 2.4)//
    20  * [http://peak.telecommunity.com/DevCenter/setuptools setuptools], version >= 0.6
    21  * [http://genshi.edgewall.org/wiki/Download Genshi], version >= 0.6 (but < 0.7dev, i.e. don't use Genshi trunk)
    22 
    23 You also need a database system and the corresponding python bindings.
    24 The database can be either SQLite, PostgreSQL or MySQL.
     18 * [http://www.python.org/ Python], version >= 2.6 and < 3.0
     19   (note that we dropped the support for Python 2.5 in this release)
     20 * [http://pypi.python.org/pypi/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. The database can be either SQLite, PostgreSQL or MySQL.
    2524
    2625==== For the SQLite database #ForSQLite
    2726
    28 If you're using Python 2.5 or 2.6, you already have everything you need.
    29 
    30 If you're using Python 2.4 and need pysqlite, you can download from
    31 [http://code.google.com/p/pysqlite/downloads/list google code] the Windows installers or the tar.gz archive for building from source:
    32 {{{
    33 $ tar xvfz <version>.tar.gz
    34 $ cd <version>
    35 $ python setup.py build_static install
    36 }}}
    37  
    38 This will extract the SQLite code and build the bindings.
    39 
    40 To install SQLite, your system may require the development headers. Without these you will get various GCC related errors when attempting to build:
    41 
    42 {{{
    43 $ apt-get install libsqlite3-dev
    44 }}}
    45 
    46 SQLite 2.x is no longer supported, and neither is !PySqlite 1.1.x.
    47 
    48 A known bug !PySqlite versions 2.5.2-4 prohibits upgrade of trac databases
    49 from 0.11.x to 0.12. Please use versions 2.5.5 and newer or 2.5.1 and
    50 older. See [trac:#9434] for more detail.
    51 
    52 See additional information in [trac:PySqlite].
     27As you must be using Python 2.6 or 2.7, you already have the SQLite database bindings bundled with the standard distribution of Python (the `sqlite3` module).
     28
     29Optionally, you may install a newer version of [http://pypi.python.org/pypi/pysqlite pysqlite] than the one provided by the Python distribution. See [trac:PySqlite#ThePysqlite2bindings PySqlite] for details.
    5330
    5431==== For the PostgreSQL database #ForPostgreSQL
     
    5633You need to install the database and its Python bindings:
    5734 * [http://www.postgresql.org/ PostgreSQL], version 8.0 or later
    58  * [http://pypi.python.org/pypi/psycopg2 psycopg2]
     35 * [http://pypi.python.org/pypi/psycopg2 psycopg2], version 2.0 or later
    5936
    6037See [trac:DatabaseBackend#Postgresql DatabaseBackend] for details.
    6138
    62 
    6339==== For the MySQL database #ForMySQL
    6440
    65 Trac can now work quite well with MySQL, provided you follow the guidelines.
     41Trac works well with MySQL, provided you follow the guidelines:
    6642
    6743 * [http://mysql.com/ MySQL], version 5.0 or later
    6844 * [http://sf.net/projects/mysql-python MySQLdb], version 1.2.2 or later
    6945
    70 It is '''very''' important to read carefully the [trac:MySqlDb] page before creating the database.
     46Given the caveats and known issues surrounding MySQL, read carefully the [trac:MySqlDb] page before creating the database.
    7147
    7248=== Optional Dependencies
    7349
    74 ==== Version Control System ====
    75 
    76 ===== Subversion =====
    77 
    78 [http://subversion.apache.org/ Subversion] 1.5.x or 1.6.x and the '''''corresponding''''' Python bindings.
    79 
    80 There are [http://subversion.apache.org/packages.html pre-compiled SWIG bindings] available for various platforms. See also the [trac:TracSubversion] page for details about Windows packages.
    81 
    82 Older versions starting from 1.4.0, etc. should still work. For troubleshooting information, check the [trac:TracSubversion#Troubleshooting TracSubversion] page. Versions prior to 1.4.0 won't probably work since trac uses svn core functionality (e.g. svn_path_canonicalize) that is not implemented in the python swig wrapper in svn <= 1.3.x (although it exists in the svn lib itself).
    83 
    84 Note that Trac '''doesn't''' use [http://pysvn.tigris.org/ PySVN], neither does it work yet with the newer `ctype`-style bindings.
    85 
    86 '''Please note:''' if using Subversion, Trac must be installed on the '''same machine'''. Remote repositories are currently [trac:#493 not supported].
    87 
    88 
    89 ===== Others =====
    90 
    91 Support for other version control systems is provided via third-parties. See [trac:PluginList] and [trac:VersionControlSystem].
    92 
    93 ==== Web Server ====
    94 A web server is optional because Trac is shipped with a server included, see the [#RunningtheStandaloneServer Running the Standalone Server ] section below.
    95 
    96 Alternatively you configure Trac to run in any of the following environments.
     50==== Subversion
     51
     52[http://subversion.apache.org/ Subversion], 1.6.x or later and the '''''corresponding''''' Python bindings.
     53
     54There 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.)
     55
     56For troubleshooting information, see the [trac:TracSubversion#Troubleshooting TracSubversion] page.
     57
     58{{{#!div style="border: 1pt dotted; margin: 1em"
     59**Note:**
     60* Trac '''doesn't''' use [http://pysvn.tigris.org/ PySVN], nor does it work yet with the newer `ctype`-style bindings.
     61* If using Subversion, Trac must be installed on the '''same machine'''. Remote repositories are currently [trac:ticket:493 not supported].
     62}}}
     63
     64==== Git
     65
     66[http://git-scm.com/ Git] 1.5.6 or later is supported. More information is available on the [trac:TracGit] page.
     67
     68==== Other Version Control Systems
     69
     70Support for other version control systems is provided via third-party plugins. See [trac:PluginList#VersionControlSystems] and [trac:VersionControlSystem].
     71
     72==== Web Server
     73A web server is optional because Trac is shipped with a server included, see the [#RunningtheStandaloneServer Running the Standalone Server] section below.
     74
     75Alternatively you can configure Trac to run in any of the following environments:
    9776 * [http://httpd.apache.org/ Apache] with
    98    - [http://code.google.com/p/modwsgi/ mod_wsgi], see [wiki:TracModWSGI] (preferred)
    99    - //[http://modpython.org/ mod_python 3.3.1], see TracModPython (deprecated)//
    100  * any [http://www.fastcgi.com/ FastCGI]-capable web server, see TracFastCgi
    101  * any [http://tomcat.apache.org/connectors-doc/ajp/ajpv13a.html AJP]-capable web
    102    server, see [trac:TracOnWindowsIisAjp]
    103  * IIS with [http://code.google.com/p/isapi-wsgi/ Isapi-wsgi], see [trac:TracOnWindowsIisIsapi]
    104  * //as a last resort, a CGI-capable web server (see TracCgi), but usage of Trac as a cgi script
    105    is highly discouraged, better use one of the previous options.//
     77   - [https://github.com/GrahamDumpleton/mod_wsgi mod_wsgi], see [wiki:TracModWSGI] and
     78     [http://code.google.com/p/modwsgi/wiki/IntegrationWithTrac ModWSGI IntegrationWithTrac].
     79   - [http://modpython.org/ mod_python 3.5.0], see TracModPython
     80 * a [http://www.fastcgi.com/ FastCGI]-capable web server (see TracFastCgi)
     81 * an [http://tomcat.apache.org/connectors-doc/ajp/ajpv13a.html AJP]-capable web
     82   server (see [trac:TracOnWindowsIisAjp TracOnWindowsIisAjp])
     83 * Microsoft IIS with FastCGI and a FastCGI-to-WSGI gateway (see [trac:CookBook/Installation/TracOnWindowsIisWfastcgi IIS with FastCGI])
     84 * a CGI-capable web server (see TracCgi), '''but usage of Trac as a cgi script
     85   is highly discouraged''', better use one of the previous options.
    10686   
    10787
    108 ==== Other Python Packages ====
    109 
    110  * [http://babel.edgewall.org Babel], version 0.9.5,
    111    needed for localization support[[BR]]
    112    ''Note: '' If you want to be able to use the Trac interface in other languages, then make sure you first have installed the optional package Babel. Lacking Babel, you will only get the default english version, as usual. If you install Babel later on, you will need to re-install Trac.
     88==== Other Python Packages
     89
     90 * [http://babel.edgewall.org Babel], version 0.9.6 or >= 1.3,
     91   needed for localization support
    11392 * [http://docutils.sourceforge.net/ docutils], version >= 0.3.9
    11493   for WikiRestructuredText.
    115  * [http://pygments.pocoo.org Pygments] for
    116    [wiki:TracSyntaxColoring syntax highlighting].
    117    [http://silvercity.sourceforge.net/ SilverCity] and/or
    118    [http://gnu.org/software/enscript/enscript.html Enscript] may still be used
    119    but are deprecated and you really should be using Pygments.
     94 * [http://pygments.org Pygments] for
     95   [TracSyntaxColoring syntax highlighting].
    12096 * [http://pytz.sf.net pytz] to get a complete list of time zones,
    12197   otherwise Trac will fall back on a shorter list from
    12298   an internal time zone implementation.
    12399
    124 '''Attention''': The various available versions of these dependencies are not necessarily interchangable, so please pay attention to the version numbers above. If you are having trouble getting Trac to work please double-check all the dependencies before asking for help on the [trac:MailingList] or [trac:IrcChannel].
    125 
    126 Please refer to the documentation of these packages to find out how they are best installed. In addition, most of the [trac:TracInstallPlatforms platform-specific instructions] also describe the installation of the dependencies. Keep in mind however that the information there ''probably concern older versions of Trac than the one you're installing'' (there are even some pages that are still talking about Trac 0.8!).
    127 
    128 
    129 == Installing Trac ==
     100{{{#!div style="border: 1pt dotted; margin: 1em"
     101**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].
     102}}}
     103
     104Please 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''.
     105
     106== Installing Trac
     107
     108The [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.
     109
     110It is assumed throughout this guide that you have elevated permissions as the `root` user or by prefixing commands with `sudo`. The umask `0002` should be used for a typical installation on a Unix-based platform.
     111
    130112=== Using `easy_install`
    131 One way to install Trac is using [http://pypi.python.org/pypi/setuptools setuptools].
    132 With setuptools you can install Trac from the subversion repository;
     113Trac can be installed from PyPI or the Subversion repository using [http://pypi.python.org/pypi/setuptools setuptools].
    133114
    134115A few examples:
    135116
    136  - first install of the latest stable version Trac 0.12.3, with i18n support:
    137    {{{
    138    easy_install Babel==0.9.5
    139    easy_install Trac==0.12
    140    }}}
    141    ''It's very important to run the two `easy_install` commands separately, otherwise the message catalogs won't be generated.''
    142 
    143  - upgrade to the latest stable version of Trac:
    144    {{{
    145    easy_install -U Trac
    146    }}}
    147 
    148  - upgrade to the latest trunk development version:
    149    {{{
    150    easy_install -U Trac==dev
    151    }}}
    152 
    153 For upgrades, reading the TracUpgrade page is mandatory, of course.
    154 
    155 {{{#!div style="border: 1pt dotted; margin: 1em"
    156 **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].
    157 }}}
    158 
    159 === From source
    160 If you want more control, you can download the source in archive form, or do a checkout from one of the official [[Trac:TracRepositories|source code repositories]].
    161 
    162 Be sure to have the prerequisites already installed. You can also obtain the Genshi and Babel source packages from http://www.edgewall.org and follow for them a similar installation procedure, or you can just `easy_install` those, see [#Usingeasy_install above].
    163 
    164 Once you've unpacked the Trac archive or performed the checkout, move in the top-level folder and do:
    165 {{{
    166 $ python ./setup.py install
    167 }}}
    168 
    169 You'll need root permissions or equivalent for this step.
    170 
    171 This will byte-compile the python source code and install it as an .egg file or folder in the `site-packages` directory
    172 of your Python installation. The .egg will also contain all other resources needed by standard Trac, such as htdocs and templates.
    173 
    174 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.
    175 
    176 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):
    177 {{{
    178 $ python ./setup.py install
    179 }}}
    180 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`).
    181 
    182 === Advanced Options ===
    183 
    184 ==== Custom location with `easy_install`
    185 
    186 To install Trac to a custom location, or find out about other advanced installation options, run:
    187 {{{
    188 easy_install --help
    189 }}}
    190 
    191 Also see [http://docs.python.org/inst/inst.html Installing Python Modules] for detailed information.
    192 
    193 Specifically, you might be interested in:
    194 {{{
    195 easy_install --prefix=/path/to/installdir
    196 }}}
    197 or, if installing Trac to a Mac OS X system:
    198 {{{
    199 easy_install --prefix=/usr/local --install-dir=/Library/Python/2.5/site-packages
    200 }}}
    201 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
    202 
    203 The above will place your `tracd` and `trac-admin` commands into `/usr/local/bin` and will install the Trac libraries and dependencies into `/Library/Python/2.5/site-packages`, which is Apple's preferred location for third-party Python application installations.
    204 
    205 ==== Using `pip`
     117 - Install the latest stable version of Trac:
     118 {{{#!sh
     119$ easy_install Trac
     120}}}
     121 - Install latest development version:
     122 {{{#!sh
     123$ easy_install http://download.edgewall.org/trac/Trac-latest-dev.tar.gz
     124}}}
     125   Note that in this case you won't have the possibility to run a localized version of Trac;
     126   either use a released version or install from source
     127
     128More information can be found on the [trac:wiki:setuptools setuptools] page.
     129
     130{{{#!div style="border: 1pt dotted; margin: 1em"
     131**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 [#DeployingTrac Deploying Trac].
     132}}}
     133
     134=== Using `pip`
    206135'pip' is an easy_install replacement that is very useful to quickly install python packages.
    207 To get a trac installation up and running in less than 5 minutes:
    208 
    209 Assuming you want to have your entire pip installation in /opt/user/trac:
     136To get a Trac installation up and running in less than 5 minutes:
     137
     138Assuming you want to have your entire pip installation in `/opt/user/trac`
    210139
    211140 -
    212 {{{
    213 pip -E /opt/user/trac install trac psycopg2
     141 {{{#!sh
     142$ pip install trac psycopg2
    214143}}}
    215144or
    216145 -
    217 {{{
    218 pip -E /opt/user/trac install trac mysql-python
    219 }}}
    220 
    221 Make sure your OS specific headers are available for pip to automatically build PostgreSQL (libpq-dev) or MySQL (libmysqlclient-dev) bindings.
    222 
    223 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 .
    224 
    225 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)
    226 
    227 Additionally, you can install several trac plugins (listed [http://pypi.python.org/pypi?:action=search&term=trac&submit=search here]) through pip.
    228 
    229 
    230 
    231 == Creating a Project Environment ==
    232 
    233 A [TracEnvironment Trac environment] is the backend storage where Trac stores information like wiki pages, tickets, reports, settings, etc. An environment is basically a directory that contains a human-readable [TracIni configuration file], and various other files and directories.
    234 
    235 A new environment is created using [wiki:TracAdmin trac-admin]:
    236 {{{
     146 {{{#!sh
     147$ pip install trac mysql-python
     148}}}
     149
     150Make sure your OS specific headers are available for pip to automatically build PostgreSQL (`libpq-dev`) or MySQL (`libmysqlclient-dev`) bindings.
     151
     152pip 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`.
     153
     154All 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)
     155
     156Additionally, you can install several Trac plugins (listed [https://pypi.python.org/pypi?:action=browse&show=all&c=516 here]) through pip.
     157
     158=== From source
     159Using 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.
     160
     161{{{#!sh
     162$ python ./setup.py install
     163}}}
     164
     165''You will need root permissions or equivalent for this step.''
     166
     167This will byte-compile the Python source code and install it as an .egg file or folder in the `site-packages` directory
     168of your Python installation. The .egg will also contain all other resources needed by standard Trac, such as `htdocs` and `templates`.
     169
     170If 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):
     171{{{#!sh
     172$ python ./setup.py install
     173}}}
     174Alternatively, 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`).
     175
     176=== Using installer
     177
     178On Windows, Trac can be installed using the exe installers available on the [trac:TracDownload] page. Installers are available for the 32-bit and 64-bit versions of Python. Make sure to use the installer that matches the architecture of your Python installation.
     179
     180=== Using package manager
     181
     182Trac may be available in your platform's package repository. Note however, that the version provided by your package manager may not be the latest release.
     183
     184=== Advanced `easy_install` Options
     185
     186To install Trac to a custom location, or find out about other advanced installation options, run:
     187{{{#!sh
     188$ easy_install --help
     189}}}
     190
     191Also see [http://docs.python.org/2/install/index.html Installing Python Modules] for detailed information.
     192
     193Specifically, you might be interested in:
     194{{{#!sh
     195$ easy_install --prefix=/path/to/installdir
     196}}}
     197or, if installing Trac on a Mac OS X system:
     198{{{#!sh
     199$ easy_install --prefix=/usr/local --install-dir=/Library/Python/2.6/site-packages
     200}}}
     201
     202{{{#!div style="border: 1pt dotted; margin: 1em"
     203**Mac OS X Note:** On Mac OS X 10.6,  running `easy_install trac` will install into `/usr/local` and `/Library/Python/2.6/site-packages` by default.
     204
     205The `tracd` and `trac-admin` commands will be placed in `/usr/local/bin` and will install the Trac libraries and dependencies into `/Library/Python/2.6/site-packages`, which is Apple's preferred location for third-party Python application installations.
     206}}}
     207
     208== Creating a Project Environment
     209
     210A [TracEnvironment Trac environment] is the backend where Trac stores information like wiki pages, tickets, reports, settings, etc. An environment is a directory that contains a human-readable [TracIni configuration file], and other files and directories.
     211
     212A new environment is created using [TracAdmin trac-admin]:
     213{{{#!sh
    237214$ trac-admin /path/to/myproject initenv
    238215}}}
    239216
    240 [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.
    241 
    242 Using the default database connection string in particular will always work as long as you have SQLite installed.
    243 For the other [DatabaseBackend database backends] you should plan ahead and already have a database ready to use at this point.
    244 
    245 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.
    246 
    247 Also note that the values you specify here can be changed later by directly editing the [TracIni conf/trac.ini] configuration file.
     217[TracAdmin trac-admin] will prompt you for the information it needs to create the environment: the name of the project and the [TracEnvironment#DatabaseConnectionStrings database connection string]. If you're not sure what to specify for any of these options, just press `<Enter>` to use the default value.
     218
     219Using the default database connection string will always work as long as you have SQLite installed. For the other [trac:DatabaseBackend database backends] you should plan ahead and already have a database ready to use at this point.
     220
     221Also note that the values you specify here can be changed later using TracAdmin or directly editing the [TracIni conf/trac.ini] configuration file.
     222
     223{{{#!div style="border: 1pt dotted; margin: 1em"
     224**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.
     225}}}
    248226
    249227Finally, 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:
    250 {{{
    251 # chown -R apache.apache /path/to/myproject
    252 }}}
     228{{{#!sh
     229$ chown -R apache:apache /path/to/myproject
     230}}}
     231
     232The 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).
    253233
    254234{{{#!div class=important
     
    256236}}}
    257237
    258 
    259238== Deploying Trac
    260239
    261 === Running the Standalone Server ===
    262 
    263 After having created a Trac environment, you can easily try the web interface by running the standalone server [wiki:TracStandalone tracd]:
    264 {{{
     240{{{#!div style="border: 1pt dotted; margin: 1em"
     241**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.
     242
     243If running `tracd`, 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.
     244
     245To 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`.
     246{{{#!sh
     247export PKG_RESOURCES_CACHE_ZIP_MANIFESTS=1
     248}}}
     249
     250Alternatively, the variable can be set in the shell before executing `tracd`:
     251{{{#!sh
     252$ PKG_RESOURCES_CACHE_ZIP_MANIFESTS=1 tracd --port 8000 /path/to/myproject
     253}}}
     254
     255If running the Apache web server, !Ubuntu/Debian users should add the `export` statement to `/etc/apache2/envvars`. !RedHat/CentOS/Fedora should can add the `export` statement to `/etc/sysconfig/httpd`.
     256}}}
     257
     258=== Running the Standalone Server
     259
     260After having created a Trac environment, you can easily try the web interface by running the standalone server [TracStandalone tracd]:
     261{{{#!sh
    265262$ tracd --port 8000 /path/to/myproject
    266263}}}
    267264
    268265Then, 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:
    269 {{{
     266{{{#!sh
    270267$ tracd -s --port 8000 /path/to/myproject
    271268}}}
    272269
    273 {{{#!div style="border: 1pt dotted; margin: 1em"
    274 **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.
    275 
    276 To 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`.
    277 {{{#!sh
    278 export PKG_RESOURCES_CACHE_ZIP_MANIFESTS=1
    279 }}}
    280 
    281 Alternatively, the variable can be set in the shell before executing `tracd`:
    282 {{{#!sh
    283 $ PKG_RESOURCES_CACHE_ZIP_MANIFESTS=1 tracd --port 8000 /path/to/myproject
    284 }}}
    285 }}}
    286 
    287 === Running Trac on a Web Server ===
     270=== Running Trac on a Web Server
    288271
    289272Trac provides various options for connecting to a "real" web server:
    290  - [wiki:TracFastCgi FastCGI]
    291  - [wiki:TracModWSGI mod_wsgi]
    292  - //[wiki:TracModPython mod_python] (no longer recommended, as mod_python is not actively maintained anymore)//
    293  - //[wiki:TracCgi CGI] (should not be used, as the performance is far from optimal)//
     273 - [TracFastCgi FastCGI]
     274 - [wiki:TracModWSGI Apache with mod_wsgi]
     275 - [TracModPython Apache with mod_python]
     276 - //[TracCgi CGI] (should not be used, as the performance is far from optimal)//
    294277
    295278Trac 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.
    296279
    297 ==== Generating the Trac cgi-bin directory ==== #cgi-bin
    298 
    299 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].
    300 
    301 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:
    302 {{{
    303 mkdir -p /usr/share/trac/projects/my-project
    304 trac-admin /usr/share/trac/projects/my-project initenv
    305 trac-admin /usr/share/trac/projects/my-project deploy /tmp/deploy
    306 mv /tmp/deploy/* /usr/share/trac
    307 }}}
    308 
    309 
    310 ==== Mapping Static Resources ====
    311 
    312 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).
    313 
    314 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.
    315 
    316 There 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.
    317 
    318 Note that in order to get those static resources on the filesystem, you need first to extract the relevant resources from Trac using the [TracAdmin trac-admin]` <environment> deploy` command:
     280==== Generating the Trac cgi-bin directory #cgi-bin
     281
     282In 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].
     283
     284There 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:
     285{{{#!sh
     286$ mkdir -p /usr/share/trac/projects/my-project
     287$ trac-admin /usr/share/trac/projects/my-project initenv
     288$ trac-admin /usr/share/trac/projects/my-project deploy /tmp/deploy
     289$ mv /tmp/deploy/* /usr/share/trac
     290}}}
     291Don't forget to check that the web server has the execution right on scripts in the `/usr/share/trac/cgi-bin` directory.
     292
     293==== Mapping Static Resources
     294
     295Without additional configuration, Trac will handle requests for static resources such as stylesheets and images. For anything other than a TracStandalone deployment, this is not optimal as the web server can be set up to directly serve the static resources. For CGI setup, this is '''highly undesirable''' as it causes abysmal performance.
     296
     297Web 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 their location on the file system. We can map requests for static resources directly to directories on the file system, to avoid Trac processing the requests.
     298
     299There are two primary URL paths for static resources: `/chrome/common` and `/chrome/site`. Plugins can add their own resources, usually accessible at the `/chrome/<plugin>` path.
     300
     301A single `/chrome` alias can used if the static resources are extracted for all plugins. This means that the `deploy` command must be executed after installing or updating a plugin that provides static resources, or after modifying resources in the `$env/htdocs` directory. This is probably appropriate for most installations but may not be what you want if, for example, you wish to upload plugins through the //Plugins// administration page.
     302
     303The resources are extracted using the [TracAdmin trac-admin]` <environment> deploy` command:
    319304[[TracAdminHelp(deploy)]]
    320305
    321 The target `<directory>` will then contain an `htdocs` directory with:
    322  - `site/` - a copy of the environment's directory `htdocs/`
    323  - `common/` - the static resources of Trac itself
    324  - `<plugins>/` - one directory for each resource directory managed by the plugins enabled for this environment
    325 
    326 ===== Example: Apache and `ScriptAlias` ===== #ScriptAlias-example
    327 
    328 Assuming the deployment has been done this way:
    329 {{{
    330 $ trac-admin /var/trac/env deploy /path/to/trac/htdocs/common
    331 }}}
    332 
    333 Add 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:
    334 {{{
     306The target `<directory>` will contain an `htdocs` directory with:
     307 - `common/` - the static resources of Trac
     308 - `site/` - a copy of the environment's `htdocs/` directory
     309 - `shared` - the static resources shared by multiple Trac environments, with a location defined by the `[inherit]` `htdocs_dir` option
     310 - `<plugin>/` - one directory for each resource directory provided by the plugins enabled for this environment
     311
     312The example that follows will create a single `/chrome` alias. If that isn't the correct approach for your installation you simply need to create more specific aliases:
     313{{{#!apache
    335314Alias /trac/chrome/common /path/to/trac/htdocs/common
    336315Alias /trac/chrome/site /path/to/trac/htdocs/site
     316Alias /trac/chrome/shared /path/to/trac/htdocs/shared
     317Alias /trac/chrome/<plugin> /path/to/trac/htdocs/<plugin>
     318}}}
     319
     320===== Example: Apache and `ScriptAlias` #ScriptAlias-example
     321
     322Assuming the deployment has been done this way:
     323{{{#!sh
     324$ trac-admin /var/trac/env deploy /path/to/shared/trac
     325}}}
     326
     327Add the following snippet to Apache configuration, changing paths to match your deployment. The snippet must be placed ''before'' the `ScriptAlias` or `WSGIScriptAlias` directive, because those directives map all requests to the Trac application:
     328{{{#!apache
     329Alias /trac/chrome /path/to/trac/htdocs
    337330
    338331<Directory "/path/to/www/trac/htdocs">
    339   Order allow,deny
    340   Allow from all
     332  # For Apache 2.2
     333  <IfModule !mod_authz_core.c>
     334    Order allow,deny
     335    Allow from all
     336  </IfModule>
     337  # For Apache 2.4
     338  <IfModule mod_authz_core.c>
     339    Require all granted
     340  </IfModule>
    341341</Directory>
    342342}}}
    343343
    344 If using mod_python, you might want to add this too (otherwise, the alias will be ignored):
    345 {{{
    346 <Location "/trac/chrome/common/">
     344If using mod_python, add this too, otherwise the alias will be ignored:
     345{{{#!apache
     346<Location "/trac/chrome/common">
    347347  SetHandler None
    348348</Location>
    349349}}}
    350350
    351 Note that we mapped `/trac` part of the URL to the `trac.*cgi` script, and the path `/trac/chrome/common` is the path you have to append to that location to intercept requests to the static resources.
    352 
    353 Similarly, 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):
    354 {{{
     351Alternatively, if you wish to serve static resources directly from your project's `htdocs` directory rather than the location to which the files are extracted with the `deploy` command, 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:
     352{{{#!apache
    355353Alias /trac/chrome/site /path/to/projectenv/htdocs
    356354
    357355<Directory "/path/to/projectenv/htdocs">
    358   Order allow,deny
    359   Allow from all
     356  # For Apache 2.2
     357  <IfModule !mod_authz_core.c>
     358    Order allow,deny
     359    Allow from all
     360  </IfModule>
     361  # For Apache 2.4
     362  <IfModule mod_authz_core.c>
     363    Require all granted
     364  </IfModule>
    360365</Directory>
    361366}}}
    362367
    363 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:
    364 {{{
     368Another alternative to aliasing `/trac/chrome/common` is having Trac generate direct links for those static resources (and only those), using the [[TracIni#trac-section| [trac] htdocs_location]] configuration setting:
     369{{{#!ini
    365370[trac]
    366371htdocs_location = http://static.example.org/trac-common/
    367372}}}
    368 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]).
     373
     374Note that this makes it easy to have a dedicated domain serve those static resources, preferentially cookie-less.
    369375
    370376Of 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:
    371 {{{
     377{{{#!sh
    372378$ ln -s /path/to/trac/htdocs/common /var/www/static.example.org/trac-common
    373379}}}
    374380
    375 
    376 ==== Setting up the Plugin Cache ====
    377 
    378 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.
    379 
    380 == Configuring Authentication ==
    381 
    382 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.
     381==== Setting up the Plugin Cache
     382
     383Some 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.
     384
     385== Configuring Authentication
     386
     387Trac 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.
    383388
    384389The process of adding, removing, and configuring user accounts for authentication depends on the specific way you run Trac.
     
    386391Please refer to one of the following sections:
    387392 * TracStandalone#UsingAuthentication if you use the standalone server, `tracd`.
    388  * [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`.
     393 * [wiki:TracModWSGI#ConfiguringAuthentication TracModWSGI#ConfiguringAuthentication] if you use the Apache web server, with any of its front end: `mod_wsgi`, `mod_python`, `mod_fcgi` or `mod_fastcgi`.
    389394 * TracFastCgi if you're using another web server with FCGI support (Cherokee, Lighttpd, !LiteSpeed, nginx)
     395
     396[trac:TracAuthenticationIntroduction] also contains some useful information for beginners.
    390397
    391398== Granting admin rights to the admin user
    392399Grant admin rights to user admin:
    393 {{{
     400{{{#!sh
    394401$ trac-admin /path/to/myproject permission add admin TRAC_ADMIN
    395402}}}
    396 This user will have an "Admin" entry menu that will allow you to admin your trac project.
    397 
    398 == Finishing the install
    399 
    400 === Automatic reference to the SVN changesets in Trac tickets ===
    401 
    402 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:
    403  * '''`Refs #123`''' - to reference this changeset in `#123` ticket
    404  * '''`Fixes #123`''' - to reference this changeset and close `#123` ticket with the default status ''fixed''
    405 
    406 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.
    407 {{{
    408 tracopt.ticket.commit_updater.* = enabled
    409 }}}
    410 For more information, see the documentation of the `CommitTicketUpdater` component in the "Plugins" admin panel.
    411 
    412 === Using Trac ===
     403
     404This user will have an //Admin// navigation item that directs to pages for administering your Trac project.
     405
     406== Configuring Trac
     407
     408TracRepositoryAdmin provides information on configuring version control repositories for your project.
     409
     410== Using Trac
    413411
    414412Once 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.
    415413
    416 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.
    417415
    418416'' Enjoy! ''