Changes between Version 3 and Version 4 of TracInstall


Ignore:
Timestamp:
May 12, 2020, 3:24:44 PM (6 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracInstall

    v3 v4  
    1 = Trac Installation Guide for 1.0 =
     1= Trac Installation Guide for 1.3
    22[[TracGuideToc]]
    33
    4 Trac is written in the Python programming language and needs a database, [http://sqlite.org/ SQLite], [http://www.postgresql.org/ PostgreSQL], or [http://mysql.com/ MySQL]. For HTML rendering, Trac uses the [http://genshi.edgewall.org Genshi] templating system.
    5 
    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]].
    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: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.
     4Trac is written in the Python programming language and needs a database, [https://sqlite.org/ SQLite], [https://www.postgresql.org/ PostgreSQL], or [https://mysql.com/ MySQL]. For HTML rendering, Trac uses the [http://jinja.pocoo.org Jinja2] templating system, though Genshi templates will still be supported until at least Trac 1.5.1.
     5
     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, 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.5 and < 3.0
    19    (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)
    22 
    23 You also need a database system and the corresponding python bindings.
    24 The database can be either SQLite, PostgreSQL or MySQL.
     18 * [https://www.python.org/ Python], version >= 2.7 and < 3.0
     19   (note that we dropped the support for Python 2.6 in this release)
     20 * [https://pypi.org/project/setuptools setuptools], version >= 0.6
     21 * [https://pypi.org/project/Jinja2 Jinja2], version >= 2.9.3
     22
     23{{{#!div style="border: 1pt dotted; margin: 1em"
     24**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].
     25}}}
     26
     27You also need a database system and the corresponding python bindings. The database can be either SQLite, PostgreSQL or MySQL.
    2528
    2629==== For the SQLite database #ForSQLite
    2730
    28 As 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).
    29 
    30 However, if you'd like, you can download the latest and greatest version of [[trac:Pysqlite]] from
    31 [http://code.google.com/p/pysqlite/downloads/list google code], where you'll find the Windows
    32 installers or the `tar.gz` archive for building from source:
    33 {{{
    34 $ tar xvfz <version>.tar.gz
    35 $ cd <version>
    36 $ python setup.py build_static install
    37 }}}
    38  
    39 This will download the latest SQLite code and build the bindings.
    40 
    41 SQLite 2.x is no longer supported.
    42 
    43 A known bug PySqlite versions 2.5.2-4 prohibits upgrade of trac databases
    44 from 0.11.x to 0.12. Please use versions 2.5.5 and newer or 2.5.1 and
    45 older. See #9434 for more detail.
    46 
    47 See additional information in [trac:PySqlite PySqlite].
     31You already have the SQLite database bindings bundled with the standard distribution of Python (the `sqlite3` module).
     32
     33Optionally, you may install a newer version of [https://pypi.org/project/pysqlite pysqlite] than the one provided by the Python distribution. See [trac:PySqlite#ThePysqlite2bindings PySqlite] for details.
    4834
    4935==== For the PostgreSQL database #ForPostgreSQL
    5036
    5137You need to install the database and its Python bindings:
    52  * [http://www.postgresql.org/ PostgreSQL], version 8.0 or later
    53  * [http://pypi.python.org/pypi/psycopg2 psycopg2]
     38 * [https://www.postgresql.org/ PostgreSQL], version 9.1 or later
     39 * [https://pypi.org/project/psycopg2 psycopg2], version 2.0 or later
    5440
    5541See [trac:DatabaseBackend#Postgresql DatabaseBackend] for details.
    5642
    57 
    5843==== For the MySQL database #ForMySQL
    5944
    60 Trac can now work quite well with MySQL, provided you follow the guidelines.
    61 
    62  * [http://mysql.com/ MySQL], version 5.0 or later
    63  * [http://sf.net/projects/mysql-python MySQLdb], version 1.2.2 or later
    64 
    65 It is '''very''' important to read carefully the [trac:MySqlDb] page before creating the database.
     45Trac works well with MySQL, provided you use the following:
     46
     47 * [https://mysql.com/ MySQL], version 5.0 or later
     48 * [https://pypi.org/project/PyMySQL PyMySQL]
     49
     50Given the caveats and known issues surrounding MySQL, read carefully the [trac:MySqlDb] page before creating the database.
    6651
    6752=== Optional Dependencies
    6853
    69 ==== Version Control System ====
    70 
    71 ===== Subversion =====
    72  * [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.
    73 
    74 There are [http://subversion.apache.org/packages.html pre-compiled SWIG bindings] available for various platforms. (Good luck finding precompiled SWIG bindings for any Windows package at that listing. TracSubversion points you to [http://alagazam.net Algazam], which works for me under Python 2.6.)
    75 
    76 Note that Trac '''doesn't''' use [http://pysvn.tigris.org/ PySVN], neither does it work yet with the newer `ctype`-style bindings.
    77 
    78 
    79 '''Please note:''' if using Subversion, Trac must be installed on the '''same machine'''. Remote repositories are currently [trac:ticket:493 not supported].
    80 
    81 
    82 ===== Others =====
    83 
    84 Support for other version control systems is provided via third-parties. See [trac:PluginList] and [trac:VersionControlSystem].
    85 
    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.
    90  * [http://httpd.apache.org/ Apache] with
    91    - [http://code.google.com/p/modwsgi/ mod_wsgi], see [wiki:TracModWSGI] and
    92      http://code.google.com/p/modwsgi/wiki/IntegrationWithTrac
    93    - [http://modpython.org/ mod_python 3.3.1], deprecated: see TracModPython)
    94  * a [http://www.fastcgi.com/ FastCGI]-capable web server (see TracFastCgi)
    95  * an [http://tomcat.apache.org/connectors-doc/ajp/ajpv13a.html AJP]-capable web
     54==== Subversion
     55
     56[https://subversion.apache.org/ Subversion], 1.6.x or later and the '''''corresponding''''' Python bindings.
     57
     58There are [https://subversion.apache.org/packages.html pre-compiled SWIG bindings] available for various platforms. See [trac:TracSubversion#GettingSubversion getting Subversion] for more information.
     59
     60{{{#!div style="border: 1pt dotted; margin: 1em"
     61**Note:**
     62* Trac '''doesn't''' use [http://pysvn.tigris.org/ PySVN], nor does it work yet with the newer `ctype`-style bindings.
     63* If using Subversion, Trac must be installed on the '''same machine'''. Remote repositories are [trac:ticket:493 not supported].
     64}}}
     65
     66For troubleshooting information, see the [trac:TracSubversion#Troubleshooting TracSubversion] page.
     67
     68==== Git
     69
     70[https://git-scm.com/ Git] 1.5.6 or later is supported. More information is available on the [trac:TracGit] page.
     71
     72==== Other Version Control Systems
     73
     74Support for other version control systems is provided via third-party plugins. See [trac:PluginList#VersionControlSystems] and [trac:VersionControlSystem].
     75
     76==== Web Server
     77A web server is optional because Trac is shipped with a server included, see the [#RunningtheStandaloneServer Running the Standalone Server] section below.
     78
     79Alternatively you can configure Trac to run in any of the following environments:
     80 * [https://httpd.apache.org/ Apache] with
     81   - [https://github.com/GrahamDumpleton/mod_wsgi mod_wsgi], see [wiki:TracModWSGI] and
     82     [https://code.google.com/p/modwsgi/wiki/IntegrationWithTrac ModWSGI IntegrationWithTrac].
     83   - [http://modpython.org/ mod_python 3.5.0], see TracModPython
     84 * a [https://fastcgi-archives.github.io FastCGI]-capable web server (see TracFastCgi)
     85 * an [https://tomcat.apache.org/connectors-doc/ajp/ajpv13a.html AJP]-capable web
    9686   server (see [trac:TracOnWindowsIisAjp TracOnWindowsIisAjp])
     87 * Microsoft IIS with FastCGI and a FastCGI-to-WSGI gateway (see [trac:CookBook/Installation/TracOnWindowsIisWfastcgi IIS with FastCGI])
    9788 * a CGI-capable web server (see TracCgi), '''but usage of Trac as a cgi script
    9889   is highly discouraged''', better use one of the previous options.
    9990   
    10091
    101 ==== Other Python Packages ====
    102 
    103  * [http://babel.edgewall.org Babel], version >= 0.9.5,
    104    needed for localization support (unreleased version 1.0dev should work as well)
    105  * [http://docutils.sourceforge.net/ docutils], version >= 0.3.9
     92==== Other Python Packages
     93
     94 * [http://babel.pocoo.org Babel], version 0.9.6 or >= 1.3,
     95   needed for localization support
     96 * [http://docutils.sourceforge.net docutils], version >= 0.3.9
    10697   for WikiRestructuredText.
    107  * [http://pygments.pocoo.org Pygments] for
    108    [wiki:TracSyntaxColoring syntax highlighting].
    109    [http://silvercity.sourceforge.net/ SilverCity] and/or
    110    [http://gnu.org/software/enscript/enscript.html Enscript] may still be used
    111    but are deprecated and you really should be using Pygments.
    112  * [http://pytz.sf.net pytz] to get a complete list of time zones,
     98 * [http://pygments.org Pygments] for
     99   [TracSyntaxColoring syntax highlighting].
     100 * [https://pypi.org/project/textile Textile] for rendering the [https://github.com/textile/python-textile Textile markup language].
     101 * [http://pytz.sourceforge.net pytz] to get a complete list of time zones,
    113102   otherwise Trac will fall back on a shorter list from
    114103   an internal time zone implementation.
    115 
    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].
    117 
    118 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!).
    119 
    120 
    121 == Installing Trac ==
    122 === Using `easy_install`
    123 One way to install Trac is using [http://pypi.python.org/pypi/setuptools setuptools].
    124 With setuptools you can install Trac from the subversion repository;
    125 
    126 A few examples:
    127 
    128  - install Trac 1.0:
    129    {{{
    130    easy_install Trac==1.0
    131    }}}
    132    (NOT YET ENABLED)
    133  - install latest development version 1.0dev:
    134    {{{
    135    easy_install Trac==dev
    136    }}}
    137    Note that in this case you won't have the possibility to run a localized version of Trac;
    138    either use a released version or install from source
     104 * [https://pypi.org/project/passlib passlib] on Windows to decode [TracStandalone#BasicAuthorization:Usingahtpasswdpasswordfile htpasswd formats] other than `SHA-1`.
     105 * [https://pypi.org/project/pyreadline pyreadline] on Windows for trac-admin [TracAdmin#InteractiveMode command completion].
     106
     107{{{#!div style="border: 1pt dotted; margin: 1em"
     108**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].
     109}}}
     110
     111Please 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''.
     112
     113== Installing Trac
     114
     115The [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.
     116
     117It 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.
    139118
    140119=== Using `pip`
    141 '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:
    143 
    144 Assuming you want to have your entire pip installation in `/opt/user/trac`
    145 
    146  -
    147 {{{
    148 pip -E /opt/user/trac install trac psycopg2
    149 }}}
    150 or
    151  -
    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.
    157 
    158 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`.
    159 
    160 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)
    161 
    162 Additionally, you can install several trac plugins (listed [http://pypi.python.org/pypi?:action=search&term=trac&submit=search here]) through pip.
    163 
    164 
    165 
    166 === From source
    167 Of course, using the python-typical setup at the top of the source directory also works.
    168 
    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 {{{
    172 $ python ./setup.py install
    173 }}}
    174 
    175 ''You'll need root permissions or equivalent for this step.''
    176 
    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.
    179 
    180 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.
    181 
    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 {{{
    184 $ python ./setup.py install
    185 }}}
    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 ===
    189 
    190 To install Trac to a custom location, or find out about other advanced installation options, run:
    191 {{{
    192 easy_install --help
    193 }}}
    194 
    195 Also see [http://docs.python.org/inst/inst.html Installing Python Modules] for detailed information.
    196 
    197 Specifically, you might be interested in:
    198 {{{
    199 easy_install --prefix=/path/to/installdir
    200 }}}
    201 or, if installing Trac to a Mac OS X system:
    202 {{{
    203 easy_install --prefix=/usr/local --install-dir=/Library/Python/2.5/site-packages
    204 }}}
    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
    206 
    207 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.
    208 
    209 
    210 == Creating a Project Environment ==
    211 
    212 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.
    213 
    214 A new environment is created using [wiki:TracAdmin trac-admin]:
    215 {{{
     120`pip` is the modern Python package manager and is included in Python 2.7.9 and later. Use [https://bootstrap.pypa.io/get-pip.py get-pip.py] to install `pip` for an earlier version of Python.
     121
     122{{{#!sh
     123$ pip install Trac
     124}}}
     125
     126`pip` will automatically resolve the //required// dependencies (Jinja2 and setuptools) and download the latest packages from pypi.org.
     127
     128You can also install directly from a source package. You can obtain the source in a tar or zip from the [trac:TracDownload] page. After extracting the archive, change to the directory containing `setup.py` and run:
     129
     130{{{#!sh
     131$ pip install .
     132}}}
     133
     134`pip` supports numerous other install mechanisms. It can be passed the URL of an archive or other download location. Here are some examples:
     135
     136* Install the latest stable version from a zip archive:
     137{{{#!sh
     138$ pip install https://download.edgewall.org/trac/Trac-latest.zip
     139}}}
     140* Install the latest development version from a tar archive:
     141{{{#!sh
     142$ pip install https://download.edgewall.org/trac/Trac-latest-dev.tar.gz
     143}}}
     144* Install the unreleased 1.2-stable from subversion:
     145{{{#!sh
     146$ pip install svn+https://svn.edgewall.org/repos/trac/branches/1.2-stable
     147}}}
     148* Install the latest development preview (//not recommended for production installs//):
     149{{{#!sh
     150$ pip install --find-links=https://trac.edgewall.org/wiki/TracDownload Trac
     151}}}
     152
     153The optional dependencies can be installed from PyPI using `pip`:
     154{{{#!sh
     155$ pip install babel docutils pygments pytz textile
     156}}}
     157
     158Additionally, you can install several Trac plugins from PyPI (listed [https://pypi.org/search/?c=Framework+%3A%3A+Trac here]) using pip. See TracPlugins for more information.
     159
     160=== Using installer
     161
     162On 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.
     163
     164=== Using package manager
     165
     166Trac may be available in your platform's package repository. However, your package manager may not provide the latest release of Trac.
     167
     168== Creating a Project Environment
     169
     170A [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.
     171
     172A new environment is created using [TracAdmin trac-admin]:
     173{{{#!sh
    216174$ trac-admin /path/to/myproject initenv
    217175}}}
    218176
    219 [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.
    220 
    221 Using the default database connection string in particular will always work as long as you have SQLite installed.
    222 For the other [DatabaseBackend database backends] you should plan ahead and already have a database ready to use at this point.
    223 
    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.
    225 
    226 Also note that the values you specify here can be changed later by directly editing the [TracIni conf/trac.ini] configuration file.
     177[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.
     178
     179Using 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.
     180
     181Also note that the values you specify here can be changed later using TracAdmin or directly editing the [TracIni conf/trac.ini] configuration file.
    227182
    228183Finally, 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 }}}
     184{{{#!sh
     185$ chown -R apache:apache /path/to/myproject
     186}}}
     187
     188The 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).
    232189
    233190{{{#!div class=important
    … …  
    235192}}}
    236193
    237 
    238194== Deploying Trac
    239195
    240 === Running the Standalone Server ===
    241 
    242 After having created a Trac environment, you can easily try the web interface by running the standalone server [wiki:TracStandalone tracd]:
    243 {{{
     196{{{#!div style="border: 1pt dotted; margin: 1em"
     197**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.
     198
     199If 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.
     200
     201To 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`.
     202{{{#!sh
     203export PKG_RESOURCES_CACHE_ZIP_MANIFESTS=1
     204}}}
     205
     206Alternatively, the variable can be set in the shell before executing `tracd`:
     207{{{#!sh
     208$ PKG_RESOURCES_CACHE_ZIP_MANIFESTS=1 tracd --port 8000 /path/to/myproject
     209}}}
     210
     211If 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`.
     212}}}
     213
     214=== Running the Standalone Server
     215
     216After having created a Trac environment, you can easily try the web interface by running the standalone server [TracStandalone tracd]:
     217{{{#!sh
    244218$ tracd --port 8000 /path/to/myproject
    245219}}}
    246220
    247 Then, fire up a browser and visit `http://localhost:8000/`. You should get a simple listing of all environments that `tracd` knows about. Follow the link to the environment you just created, and you should see Trac in action. If you only plan on managing a single project with Trac you can have the standalone server skip the environment list by starting it like this:
    248 {{{
     221Then, open 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:
     222{{{#!sh
    249223$ tracd -s --port 8000 /path/to/myproject
    250224}}}
    251225
    252 === Running Trac on a Web Server ===
     226=== Running Trac on a Web Server
    253227
    254228Trac provides various options for connecting to a "real" web server:
    255  - [wiki:TracFastCgi FastCGI]
    256  - [wiki:TracModWSGI mod_wsgi]
    257  - //[wiki:TracModPython mod_python] (no longer recommended, as mod_python is not actively maintained anymore)//
    258  - //[wiki:TracCgi CGI] (should not be used, as the performance is far from optimal)//
    259 
    260 Trac 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.
    261 
    262 ==== Generating the Trac cgi-bin directory ==== #cgi-bin
    263 
    264 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].
    265 
    266 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:
    267 {{{
    268 mkdir -p /usr/share/trac/projects/my-project
    269 trac-admin /usr/share/trac/projects/my-project initenv
    270 trac-admin /usr/share/trac/projects/my-project deploy /tmp/deploy
    271 mv /tmp/deploy/* /usr/share/trac
    272 }}}
    273 
    274 
    275 ==== Mapping Static Resources ====
    276 
    277 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).
    278 
    279 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.
    280 
    281 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.
    282 
    283 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:
     229 - [TracFastCgi FastCGI]
     230 - [wiki:TracModWSGI Apache with mod_wsgi]
     231 - [TracModPython Apache with mod_python]
     232 - [TracCgi CGI] //(should not be used, as the performance is far from optimal)//
     233
     234Trac 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], [https://uwsgi-docs.readthedocs.io/en/latest/#Traconapacheinasub-uri uwsgi], [trac:TracOnWindowsIisIsapi Isapi-wsgi] etc.
     235
     236==== Generating the Trac cgi-bin directory #cgi-bin
     237
     238Application scripts for CGI, FastCGI and mod-wsgi can be generated using the [TracAdmin trac-admin] `deploy` command:
    284239[[TracAdminHelp(deploy)]]
    285240
    286 The target `<directory>` will then contain an `htdocs` directory with:
    287  - `site/` - a copy of the environment's directory `htdocs/`
    288  - `common/` - the static resources of Trac itself
    289  - `<plugins>/` - one directory for each resource directory managed by the plugins enabled for this environment
    290 
    291 ===== Example: Apache and `ScriptAlias` ===== #ScriptAlias-example
    292 
    293 Assuming the deployment has been done this way:
    294 {{{
    295 $ trac-admin /var/trac/env deploy /path/to/trac/htdocs/common
    296 }}}
    297 
    298 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:
    299 {{{
     241Grant the web server execution right on scripts in the `cgi-bin` directory.
     242
     243For example, the following yields a typical directory structure:
     244{{{#!sh
     245$ mkdir -p /var/trac
     246$ trac-admin /var/trac/<project> initenv
     247$ trac-admin /var/trac/<project> deploy /var/www
     248$ ls /var/www
     249cgi-bin htdocs
     250$ chmod ugo+x /var/www/cgi-bin/*
     251}}}
     252
     253==== Mapping Static Resources
     254
     255Without 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.
     256
     257Web servers such as [https://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.
     258
     259There 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.
     260
     261A single `/chrome` alias can used if the static resources are extracted for all plugins. This means that the `deploy` command (discussed in the previous section) 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.
     262
     263The `deploy` command creates an `htdocs` directory with:
     264 - `common/` - the static resources of Trac
     265 - `site/` - a copy of the environment's `htdocs/` directory
     266 - `shared` - the static resources shared by multiple Trac environments, with a location defined by the `[inherit]` `htdocs_dir` option
     267 - `<plugin>/` - one directory for each resource directory provided by the plugins enabled for this environment
     268
     269The 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:
     270{{{#!apache
    300271Alias /trac/chrome/common /path/to/trac/htdocs/common
    301272Alias /trac/chrome/site /path/to/trac/htdocs/site
     273Alias /trac/chrome/shared /path/to/trac/htdocs/shared
     274Alias /trac/chrome/<plugin> /path/to/trac/htdocs/<plugin>
     275}}}
     276
     277===== Example: Apache and `ScriptAlias` #ScriptAlias-example
     278
     279Assuming the deployment has been done this way:
     280{{{#!sh
     281$ trac-admin /var/trac/<project> deploy /var/www
     282}}}
     283
     284Add 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:
     285{{{#!apache
     286Alias /trac/chrome /path/to/trac/htdocs
    302287
    303288<Directory "/path/to/www/trac/htdocs">
    304   Order allow,deny
    305   Allow from all
     289  # For Apache 2.2
     290  <IfModule !mod_authz_core.c>
     291    Order allow,deny
     292    Allow from all
     293  </IfModule>
     294  # For Apache 2.4
     295  <IfModule mod_authz_core.c>
     296    Require all granted
     297  </IfModule>
    306298</Directory>
    307299}}}
    308300
    309 If using mod_python, you might want to add this too (otherwise, the alias will be ignored):
    310 {{{
    311 <Location "/trac/chrome/common/">
     301If using mod_python, add this too, otherwise the alias will be ignored:
     302{{{#!apache
     303<Location "/trac/chrome/common">
    312304  SetHandler None
    313305</Location>
    314306}}}
    315307
    316 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.
    317 
    318 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):
    319 {{{
     308Alternatively, 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:
     309{{{#!apache
    320310Alias /trac/chrome/site /path/to/projectenv/htdocs
    321311
    322312<Directory "/path/to/projectenv/htdocs">
    323   Order allow,deny
    324   Allow from all
     313  # For Apache 2.2
     314  <IfModule !mod_authz_core.c>
     315    Order allow,deny
     316    Allow from all
     317  </IfModule>
     318  # For Apache 2.4
     319  <IfModule mod_authz_core.c>
     320    Require all granted
     321  </IfModule>
    325322</Directory>
    326323}}}
    327324
    328 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:
    329 {{{
     325Another alternative to aliasing `/trac/chrome/common` is having Trac generate direct links for those static resources (and only those), using the [TracIni#trac-htdocs_location-option trac.htdocs_location] configuration setting:
     326{{{#!ini
    330327[trac]
    331328htdocs_location = http://static.example.org/trac-common/
    332329}}}
    333 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]).
     330
     331Note that this makes it easy to have a dedicated domain serve those static resources, preferentially cookie-less.
    334332
    335333Of 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 {{{
     334{{{#!sh
    337335$ ln -s /path/to/trac/htdocs/common /var/www/static.example.org/trac-common
    338336}}}
    339337
    340 
    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.
     338==== Setting up the Plugin Cache
     339
     340Some 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.
     341
     342== Configuring Authentication
     343
     344Trac 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.
    348345
    349346The process of adding, removing, and configuring user accounts for authentication depends on the specific way you run Trac.
    … …  
    351348Please refer to one of the following sections:
    352349 * TracStandalone#UsingAuthentication if you use the standalone server, `tracd`.
    353  * [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`.
     350 * [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`.
    354351 * TracFastCgi if you're using another web server with FCGI support (Cherokee, Lighttpd, !LiteSpeed, nginx)
     352
     353[trac:TracAuthenticationIntroduction] also contains some useful information for beginners.
    355354
    356355== Granting admin rights to the admin user
    357356Grant admin rights to user admin:
    358 {{{
     357{{{#!sh
    359358$ trac-admin /path/to/myproject permission add admin TRAC_ADMIN
    360359}}}
    361 This user will have an "Admin" entry menu that will allow you to admin your trac project.
    362 
    363 == Finishing the install
    364 
    365 === Automatic reference to the SVN changesets in Trac tickets ===
    366 
    367 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:
    368  * '''`Refs #123`''' - to reference this changeset in `#123` ticket
    369  * '''`Fixes #123`''' - to reference this changeset and close `#123` ticket with the default status ''fixed''
    370 
    371 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.
    372 {{{
    373 tracopt.ticket.commit_updater.* = enabled
    374 }}}
    375 For more information, see the documentation of the `CommitTicketUpdater` component in the "Plugins" admin panel.
    376 
    377 === Using Trac ===
     360
     361This user will have an //Admin// navigation item that directs to pages for administering your Trac project.
     362
     363== Configuring Trac
     364
     365Configuration options are documented on the TracIni page.
     366
     367TracRepositoryAdmin provides information on configuring version control repositories for your project.
     368
     369In addition to the optional version control backends, Trac provides several optional features that are disabled by default:
     370* [TracFineGrainedPermissions#AuthzPolicy Fine-grained permission policy]
     371* [TracPermissions#CreatingNewPrivileges Custom permissions]
     372* [TracTickets#deleter Ticket deletion]
     373* [TracTickets#cloner Ticket cloning]
     374* [TracRepositoryAdmin#CommitTicketUpdater Ticket changeset references]
     375
     376== Using Trac
    378377
    379378Once 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.
    380379
    381 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.
     380Keep 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.
    382381
    383382'' Enjoy! ''
    … …  
    386385
    387386----
    388 See also: [trac:TracInstallPlatforms TracInstallPlatforms], TracGuide, TracUpgrade, TracPermissions
     387See also: [trac:TracInstallPlatforms TracInstallPlatforms], TracGuide, TracUpgrade