Changes between Version 3 and Version 4 of TracInstall


Ignore:
Timestamp:
Aug 4, 2015, 3:23:11 PM (9 years 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.0
     2
    23[[TracGuideToc]]
    34
    45Trac 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.
    56
    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 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.
     7Since version 0.12, Trac can also be localized, and there is probably a translation available in your language. If you want to use the Trac interface in other languages, then make sure you have installed the optional package [#OtherPythonPackages Babel]. Pay attention to the extra steps for localization support in the [#InstallingTrac Installing Trac] section below. Lacking Babel, you will only get the default English version.
     8
     9If you're interested in contributing new translations for other languages or enhancing the existing translations, then please have a look at [trac:wiki:TracL10N TracL10N].
     10
     11What follows are generic instructions for installing and setting up Trac. While you may find instructions for installing Trac on specific systems at [trac:TracInstallPlatforms TracInstallPlatforms] on the main Trac site, please '''first read through these general instructions''' to get a good understanding of the tasks involved.
    1112
    1213[[PageOutline(2-3,Installation Steps,inline)]]
    1314
    14 == Dependencies ==
     15== Dependencies
     16
    1517=== Mandatory Dependencies
     18
    1619To install Trac, the following software packages must be installed:
    1720
    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)
    20  * [http://peak.telecommunity.com/DevCenter/setuptools setuptools], version >= 0.6
     21 * [http://www.python.org/ Python], version >= 2.5 and < 3.0
     22   (note that we dropped the support for Python 2.4 in this release)
     23 * [http://pypi.python.org/pypi/setuptools setuptools], version >= 0.6
    2124 * [http://genshi.edgewall.org/wiki/Download Genshi], version >= 0.6
    2225
    23 You also need a database system and the corresponding python bindings.
    24 The database can be either SQLite, PostgreSQL or MySQL.
     26You also need a database system and the corresponding python bindings. The database can be either SQLite, PostgreSQL or MySQL.
    2527
    2628==== For the SQLite database #ForSQLite
    2729
    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].
     30As 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.
     31
     32Optionally, you may install a newer version of [pypi:pysqlite pysqlite] than the one provided by the Python distribution. See [trac:PySqlite#ThePysqlite2bindings PySqlite] for details.
    5333
    5434==== For the PostgreSQL database #ForPostgreSQL
     
    5636You need to install the database and its Python bindings:
    5737 * [http://www.postgresql.org/ PostgreSQL], version 8.0 or later
    58  * [http://pypi.python.org/pypi/psycopg2 psycopg2]
     38 * [http://pypi.python.org/pypi/psycopg2 psycopg2], version 2.0 or later
    5939
    6040See [trac:DatabaseBackend#Postgresql DatabaseBackend] for details.
    6141
    62 
    6342==== For the MySQL database #ForMySQL
    6443
    65 Trac can now work quite well with MySQL, provided you follow the guidelines.
    66 
    67  * [http://mysql.com/ MySQL], version 5.0 or later
     44Trac works well with MySQL, provided you follow the guidelines:
     45
     46 * [http://mysql.com/ MySQL] or [http://mariadb.org/ MariaDB], version 5.0 or later
    6847 * [http://sf.net/projects/mysql-python MySQLdb], version 1.2.2 or later
    6948
    70 It is '''very''' important to read carefully the [trac:MySqlDb] page before creating the database.
     49Given the caveats and known issues surrounding MySQL, read the [trac:MySqlDb] page before creating the database.
    7150
    7251=== Optional Dependencies
    7352
    74 ==== Version Control System ====
    75 
    76 ===== Subversion =====
    77  * [http://subversion.apache.org/ Subversion], 1.5.x or 1.6.x and the '''''corresponding''''' Python bindings. 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).
    78 
    79 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.)
    80 
    81 Note that Trac '''doesn't''' use [http://pysvn.tigris.org/ PySVN], neither does it work yet with the newer `ctype`-style bindings. [Is there a ticket for implementing ctype bindings?]
    82 
    83 
    84 '''Please note:''' if using Subversion, Trac must be installed on the '''same machine'''. Remote repositories are currently [trac:ticket:493 not supported].
    85 
    86 
    87 ===== Others =====
    88 
    89 Support for other version control systems is provided via third-parties. See [trac:PluginList] and [trac:VersioningSystemBackend].
    90 
    91 ==== Web Server ====
    92 A web server is optional because Trac is shipped with a server included, see the [#RunningtheStandaloneServer Running the Standalone Server ] section below.
    93 
    94 Alternatively you configure Trac to run in any of the following environments.
     53==== Version Control System
     54
     55===== Subversion
     56 * [http://subversion.apache.org/ Subversion], 1.5.x or later and the '''corresponding''' Python bindings. Older versions starting from 1.0, like 1.2.4, 1.3.2 or 1.4.2, etc. may still work. For troubleshooting information, check the [trac:TracSubversion#Troubleshooting TracSubversion] page.
     57
     58There 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.)
     59
     60Note that Trac '''doesn't''' use [http://pysvn.tigris.org/ PySVN], neither does it work yet with the newer `ctype`-style bindings.
     61
     62'''Note:''' if using Subversion, Trac must be installed on the '''same machine'''. Remote repositories are currently [trac:ticket:493 not supported].
     63
     64===== Git
     65 * [http://git-scm.com/ Git] 1.5.6 or later.
     66
     67More information is available on the [trac:TracGit] page.
     68
     69===== Others
     70
     71Support for other version control systems is provided via third-parties. See [trac:PluginList#VersionControlSystems] and [trac:VersionControlSystem].
     72
     73==== Web Server
     74
     75A web server is optional because Trac has a server included, see the [#RunningtheStandaloneServer Running the Standalone Server] section below.
     76
     77Alternatively you can configure Trac to run in any of the following environments:
    9578 * [http://httpd.apache.org/ Apache] with
    9679   - [http://code.google.com/p/modwsgi/ mod_wsgi], see [wiki:TracModWSGI] and
    9780     http://code.google.com/p/modwsgi/wiki/IntegrationWithTrac
    98    - [http://modpython.org/ mod_python 3.3.1], deprecated: see TracModPython)
     81   - [http://modpython.org/ mod_python 3.5.0], see TracModPython
    9982 * a [http://www.fastcgi.com/ FastCGI]-capable web server (see TracFastCgi)
    10083 * an [http://tomcat.apache.org/connectors-doc/ajp/ajpv13a.html AJP]-capable web
    101    server (see [trac:TracOnWindowsIisAjp])
    102  * a CGI-capable web server (see TracCgi), '''but usage of Trac as a cgi script
    103    is highly discouraged''', better use one of the previous options.
     84   server (see [trac:TracOnWindowsIisAjp TracOnWindowsIisAjp])
     85 * a FastCGI and FastCGI-to-WSGI gateway (see [trac:TracOnWindowsIisWfastcgi])
     86 * a CGI-capable web server (see TracCgi), but //usage of Trac as a cgi script
     87   is highly discouraged//, better use one of the previous options.
    10488   
    105 
    106 ==== Other Python Packages ====
    107 
    108  * [http://babel.edgewall.org Babel], version >= 0.9.5,
    109    needed for localization support[[BR]]
    110    ''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.
     89==== Other Python Packages
     90
     91 * [http://babel.edgewall.org Babel], version 0.9.5, 0.9.6 or >= 1.3
     92   needed for localization support
    11193 * [http://docutils.sourceforge.net/ docutils], version >= 0.3.9
    11294   for WikiRestructuredText.
    113  * [http://pygments.pocoo.org Pygments] for
    114    [wiki:TracSyntaxColoring syntax highlighting].
     95 * [http://pygments.org Pygments] for
     96   [TracSyntaxColoring syntax highlighting].
    11597   [http://silvercity.sourceforge.net/ SilverCity] and/or
    11698   [http://gnu.org/software/enscript/enscript.html Enscript] may still be used
     
    120102   an internal time zone implementation.
    121103
    122 '''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].
    123 
    124 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!).
    125 
    126 
    127 == Installing Trac ==
     104{{{#!div style="border: 1pt dotted; margin: 1em"
     105**Attention**: The available versions of these dependencies are not necessarily interchangeable, so please pay attention to the version numbers. If you are having trouble getting Trac to work, please double-check all the dependencies before asking for help on the [trac:MailingList] or [trac:IrcChannel].
     106}}}
     107
     108Please refer to the documentation of these packages to find out how they are best installed. In addition, most of the [trac:TracInstallPlatforms platform-specific instructions] also describe the installation of the dependencies. Keep in mind however that the information there probably concern older versions of Trac than the one you're installing.
     109
     110== Installing Trac
     111
     112The [TracAdmin trac-admin] command-line tool, used to create and maintain [TracEnvironment project environments], as well as the [TracStandalone tracd] standalone server are installed along with Trac. There are several methods for installing Trac.
     113
    128114=== Using `easy_install`
    129 One way to install Trac is using [http://pypi.python.org/pypi/setuptools setuptools].
    130 With setuptools you can install Trac from the subversion repository;
    131 
    132 A few examples:
    133 
    134  - first install of the latest stable version Trac 0.12.1, with i18n support:
    135    {{{
    136    easy_install Babel==0.9.5 Genshi==0.6
    137    easy_install Trac
    138    }}}
    139    ''It's very important to run the two `easy_install` commands separately, otherwise the message catalogs won't be generated.''
    140 
    141  - upgrade to the latest stable version of Trac:
    142    {{{
    143    easy_install -U Trac
    144    }}}
    145 
    146  - upgrade to the latest trunk development version (0.13dev):
    147    {{{
    148    easy_install -U Trac==dev
    149    }}}
    150 
    151 For upgrades, reading the TracUpgrade page is mandatory, of course.
     115
     116Trac can be installed from [https://pypi.python.org/pypi/Trac PyPI] or the Subversion repository using [pypi:setuptools setuptools].
     117
     118A few command-line examples:
     119
     120 - Install Trac 1.0:
     121 {{{#!sh
     122$ easy_install Trac==1.0
     123}}}
     124 - Install latest development version:
     125 {{{#!sh
     126$ easy_install Trac==dev
     127}}}
     128   Note that in this case you won't have the possibility to run a localized version of Trac;
     129   either use a released version or install from source.
     130
     131More information can be found on the [trac:setuptools] page.
     132
     133{{{#!div style="border: 1pt dotted; margin: 1em"
     134**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].
     135}}}
     136
     137=== Using `pip`
     138
     139'pip' is an easy_install replacement that is very useful to quickly install Python packages.
     140To get a Trac installation up and running in less than 5 minutes:
     141
     142Assuming you want to have your entire pip installation in `/opt/user/trac`:
     143
     144 -
     145 {{{#!sh
     146$ pip install trac psycopg2
     147}}}
     148or:
     149 -
     150 {{{#!sh
     151$ pip install trac mysql-python
     152}}}
     153
     154Make sure your OS specific headers are available for pip to automatically build PostgreSQL (`libpq-dev`) or MySQL (`libmysqlclient-dev`) bindings.
     155
     156pip will automatically resolve all dependencies (like Genshi, pygments, etc.), download the latest packages from pypi.python.org and create a self contained installation in `/opt/user/trac`.
     157
     158All commands (`tracd`, `trac-admin`) are available in `/opt/user/trac/bin`. This can also be leveraged for `mod_python` (using `PythonHandler` directive) and `mod_wsgi` (using `WSGIDaemonProcess` directive).
     159
     160Additionally, you can install several Trac plugins (listed [https://pypi.python.org/pypi?:action=browse&show=all&c=516 here]) through pip.
    152161
    153162=== From source
    154 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]].
    155 
    156 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].
    157 
    158 Once you've unpacked the Trac archive or performed the checkout, move in the top-level folder and do:
    159 {{{
     163
     164Using the python-typical setup at the top of the source directory also works. You can obtain the source for a .tar.gz or .zip file corresponding to a release (e.g. `Trac-1.0.tar.gz`) from the [trac:TracDownload] page, or you can get the source directly from the repository. See [trac:TracRepositories#OfficialSubversionrepository TracRepositories] for details.
     165
     166{{{#!sh
    160167$ python ./setup.py install
    161168}}}
    162169
    163 ''You'll need root permissions or equivalent for this step.''
    164 
    165 This will byte-compile the python source code and install it as an .egg file or folder in the `site-packages` directory
    166 of your Python installation. The .egg will also contain all other resources needed by standard Trac, such as htdocs and templates.
    167 
    168 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.
    169 
    170 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):
    171 {{{
     170You will need root permissions or equivalent for this step.
     171
     172This will byte-compile the Python source code and install it as an .egg file or folder in the `site-packages` directory
     173of your Python installation. The .egg will also contain all other resources needed by standard Trac, such as `htdocs` and `templates`.
     174
     175If 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):
     176{{{#!sh
    172177$ python ./setup.py install
    173178}}}
    174 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`).
    175 
    176 === Advanced Options ===
     179
     180Alternatively, 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`).
     181
     182=== Using installer
     183
     184On Windows Trac can be installed using the exe installers available on the [trac:TracDownload] page. Installers are available for the 32 and 64 bit versions of Python. Make sure to use the installer that matches the architecture of your Python installation.
     185
     186=== Using package manager
     187
     188Trac may be available in the package repository for your platform. Note however, that the version provided by the package manager may not be the latest release.
     189
     190=== Advanced `easy_install` Options
    177191
    178192To install Trac to a custom location, or find out about other advanced installation options, run:
    179 {{{
    180 easy_install --help
    181 }}}
    182 
    183 Also see [http://docs.python.org/inst/inst.html Installing Python Modules] for detailed information.
     193{{{#!sh
     194$ easy_install --help
     195}}}
     196
     197Also see [http://docs.python.org/2/install/index.html Installing Python Modules] for detailed information.
    184198
    185199Specifically, you might be interested in:
    186 {{{
    187 easy_install --prefix=/path/to/installdir
    188 }}}
    189 or, if installing Trac to a Mac OS X system:
    190 {{{
    191 easy_install --prefix=/usr/local --install-dir=/Library/Python/2.5/site-packages
    192 }}}
    193 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
     200{{{#!sh
     201$ easy_install --prefix=/path/to/installdir
     202}}}
     203
     204or, if installing Trac on a Mac OS X system:
     205{{{#!sh
     206$ easy_install --prefix=/usr/local --install-dir=/Library/Python/2.5/site-packages
     207}}}
     208
     209'''Note''': If installing on Mac OS X 10.6 running {{{ easy_install http://svn.edgewall.org/repos/trac/trunk }}} will install into {{{ /usr/local }}} and {{{ /Library/Python/2.5/site-packages }}} by default.
    194210
    195211The 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.
    196212
    197 === Using `pip`
    198 'pip' is an easy_install replacement that is very useful to quickly install python packages.
    199 To get a trac installation up and running in less than 5 minutes:
    200 
    201 Assuming you want to have your entire pip installation in /opt/user/trac:
    202 
    203  -
    204 {{{
    205 pip -E /opt/user/trac install trac psycopg2
    206 }}}
    207 or
    208  -
    209 {{{
    210 pip -E /opt/user/trac install trac mysql-python
    211 }}}
    212 
    213 Make sure your OS specific headers are available for pip to automatically build PostgreSQL (libpq-dev) or MySQL (libmysqlclient-dev) bindings.
    214 
    215 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 .
    216 
    217 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)
    218 
    219 Additionally, you can install several trac plugins (listed [http://pypi.python.org/pypi?:action=search&term=trac&submit=search here]) through pip.
    220 
    221 
    222 
    223 == Creating a Project Environment ==
    224 
    225 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.
    226 
    227 A new environment is created using [wiki:TracAdmin trac-admin]:
    228 {{{
     213== Creating a Project Environment
     214
     215A [TracEnvironment Trac environment] is the backend where Trac stores information like wiki pages, tickets, reports, settings, etc. An environment is basically a directory that contains a human-readable [TracIni configuration file], and other files and directories.
     216
     217A new environment is created using [TracAdmin trac-admin]:
     218{{{#!sh
    229219$ trac-admin /path/to/myproject initenv
    230220}}}
     
    233223
    234224Using the default database connection string in particular will always work as long as you have SQLite installed.
    235 For the other [DatabaseBackend database backends] you should plan ahead and already have a database ready to use at this point.
    236 
    237 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.
     225For the other [trac:DatabaseBackend database backends] you should plan ahead and already have a database ready to use at this point.
     226
     227Since 0.12, Trac doesn't ask for a [TracEnvironment#SourceCodeRepository source code repository] anymore when creating an environment. Repositories can be [TracRepositoryAdmin added] afterwards, and support for specific version control systems is disabled by default.
    238228
    239229Also note that the values you specify here can be changed later by directly editing the [TracIni conf/trac.ini] configuration file.
    240230
     231{{{#!div style="border: 1pt dotted; margin: 1em"
     232**Filesystem Warning:** When selecting the location of your environment, make sure that the filesystem on which the environment directory resides supports sub-second timestamps (i.e. **not** `ext2` or `ext3` on Linux, or HFS+ on OSX), as the modification time of the `conf/trac.ini` file will be monitored to decide whether an environment restart is needed or not. A too coarse-grained timestamp resolution may result in inconsistencies in Trac < 1.0.2. The best advice is to opt for a platform with sub-second timestamp resolution, regardless of the Trac version.
     233}}}
     234
    241235Finally, 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:
    242 {{{
    243 # chown -R apache.apache /path/to/myproject
    244 }}}
     236{{{#!sh
     237$ chown -R apache.apache /path/to/myproject
     238}}}
     239
     240The actual username and groupname of the Apache server may not be exactly `apache`, and are specified in the Apache configuration file by the directives `User` and `Group` (if Apache `httpd` is what you use).
    245241
    246242{{{#!div class=important
     
    248244}}}
    249245
    250 
    251 == Running the Standalone Server ==
    252 
    253 After having created a Trac environment, you can easily try the web interface by running the standalone server [wiki:TracStandalone tracd]:
    254 {{{
     246== Deploying Trac
     247
     248=== Running the Standalone Server
     249
     250After having created a Trac environment, you can easily try the web interface by running the standalone server [TracStandalone tracd]:
     251{{{#!sh
    255252$ tracd --port 8000 /path/to/myproject
    256253}}}
    257254
    258255Then, 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:
    259 {{{
     256{{{#!sh
    260257$ tracd -s --port 8000 /path/to/myproject
    261258}}}
    262259
    263 == Running Trac on a Web Server ==
    264 
    265 Trac provides various options for connecting to a "real" web server: [wiki:TracCgi CGI], [wiki:TracFastCgi FastCGI], [wiki:TracModWSGI mod_wsgi] and [wiki:TracModPython mod_python]. For decent performance, it is recommended that you use either FastCGI or mod_wsgi.
    266 
    267 Trac also supports [trac:TracOnWindowsIisAjp AJP] which may be your choice if you want to connect to IIS.
    268 
    269 ==== Generating the Trac cgi-bin directory ====
    270 
    271 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].
    272 
    273 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:
    274 {{{
    275 mkdir -p /usr/share/trac/projects/my-project
    276 trac-admin /usr/share/trac/projects/my-project initenv
    277 trac-admin /usr/share/trac/projects/my-project deploy /tmp/deploy
    278 mv /tmp/deploy/* /usr/share/trac
    279 }}}
    280 
    281 ==== Setting up the Plugin Cache ====
    282 
    283 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.
    284 
    285 == Configuring Authentication ==
    286 
    287 The process of adding, removing, and configuring user accounts for authentication depends on the specific way you run Trac. The basic procedure is described in the [wiki:TracCgi#AddingAuthentication "Adding Authentication"] section on the TracCgi page. To learn how to setup authentication for the frontend you're using, please refer to one of the following pages:
    288 
    289  * TracStandalone if you use the standalone server, `tracd`.
    290  * TracCgi if you use the CGI or FastCGI web front ends.
    291  * [wiki:TracModWSGI] if you use the Apache mod_wsgi web front end.
    292  * TracModPython if you use the Apache mod_python web front end.
    293 
    294 
    295 == Automatic reference to the SVN changesets in Trac tickets ==
    296 
    297 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:
    298  * '''`Refs #123`''' - to reference this changeset in `#123` ticket
    299  * '''`Fixes #123`''' - to reference this changeset and close `#123` ticket with the default status ''fixed''
    300 
    301 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.
    302 {{{
    303 tracopt.ticket.commit_updater.* = enabled
    304 }}}
    305 For more information, see the documentation of the `CommitTicketUpdater` component in the "Plugins" admin panel.
    306 
    307 == Using Trac ==
     260{{{#!div style="border: 1pt dotted; margin: 1em"
     261**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.
     262
     263To 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`.
     264{{{#!sh
     265export PKG_RESOURCES_CACHE_ZIP_MANIFESTS=1
     266}}}
     267
     268Alternatively, the variable can be set in the shell before executing `tracd`:
     269{{{#!sh
     270$ PKG_RESOURCES_CACHE_ZIP_MANIFESTS=1 tracd --port 8000 /path/to/myproject
     271}}}
     272}}}
     273
     274=== Running Trac on a Web Server
     275
     276Trac provides various options for connecting to a "real" web server:
     277 - [TracFastCgi FastCGI]
     278 - [wiki:TracModWSGI mod_wsgi]
     279 - [TracModPython mod_python]
     280 - //[TracCgi CGI]: should not be used, as it degrades performance//
     281
     282Trac 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.
     283
     284==== Generating the Trac cgi-bin directory #cgi-bin
     285
     286In order for Trac to function properly with FastCGI you need to have a `trac.fcgi` file and for mod_wsgi a `trac.wsgi` file. These are Python scripts which load the appropriate Python code. They can be generated using the `deploy` option of [TracAdmin trac-admin].
     287
     288There is, however, a bit of a chicken-and-egg problem. The [TracAdmin trac-admin] command requires an existing environment to function, but complains if the deploy directory already exists. This is a problem, because environments are often stored in a subdirectory of the deploy. The solution is to do something like this:
     289{{{#!sh
     290$ mkdir -p /usr/share/trac/projects/my-project
     291$ trac-admin /usr/share/trac/projects/my-project initenv
     292$ trac-admin /usr/share/trac/projects/my-project deploy /tmp/deploy
     293$ mv /tmp/deploy/* /usr/share/trac
     294}}}
     295
     296Don't forget to check that the web server has the execution right on scripts in the `/usr/share/trac/cgi-bin` directory.
     297
     298==== Mapping Static Resources
     299
     300Out of the box, Trac will pass static resources such as style sheets or images through itself. For anything but a tracd only based deployment, this is far from optimal as the web server could be set up to directly serve those static resources. For CGI setup, this is '''highly undesirable''' as it causes abysmal performance.
     301
     302Web servers such as [http://httpd.apache.org/ Apache] allow you to create "Aliases" to resources, giving them a virtual URL that doesn't necessarily reflect the layout of the servers file system. We also can map requests for static resources directly to the directory on the file system, avoiding processing these requests by Trac itself.
     303
     304There 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.
     305
     306Note 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:
     307[[TracAdminHelp(deploy)]]
     308
     309The target `<directory>` will then contain an `htdocs` directory with:
     310 - `site/` - a copy of the environment's directory `htdocs/`
     311 - `common/` - the static resources of Trac itself
     312 - `<plugins>/` - one directory for each resource directory managed by the plugins enabled for this environment
     313
     314===== Example: Apache and `ScriptAlias` #ScriptAlias-example
     315
     316Assuming the deployment has been done this way:
     317{{{#!sh
     318$ trac-admin /var/trac/env deploy /path/to/shared/trac
     319}}}
     320
     321Add 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:
     322{{{#!apache
     323Alias /trac/chrome/common /path/to/trac/htdocs/common
     324Alias /trac/chrome/site /path/to/trac/htdocs/site
     325
     326<Directory "/path/to/www/trac/htdocs">
     327  Order allow,deny
     328  Allow from all
     329</Directory>
     330}}}
     331
     332If using mod_python, you might want to add this too, otherwise the alias will be ignored:
     333{{{#!apache
     334<Location "/trac/chrome/common/">
     335  SetHandler None
     336</Location>
     337}}}
     338
     339Note 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.
     340
     341Similarly, 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):
     342{{{#!apache
     343Alias /trac/chrome/site /path/to/projectenv/htdocs
     344
     345<Directory "/path/to/projectenv/htdocs">
     346  Order allow,deny
     347  Allow from all
     348</Directory>
     349}}}
     350
     351Alternatively to aliasing `/trac/chrome/common`, you can tell Trac to generate direct links for those static resources (and only those), using the [[TracIni#trac-section| [trac] htdocs_location]] configuration setting:
     352{{{#!ini
     353[trac]
     354htdocs_location = http://static.example.org/trac-common/
     355}}}
     356
     357Note that this makes it easy to have a dedicated domain serve those static resources, preferentially [http://code.google.com/speed/page-speed/docs/request.html#ServeFromCookielessDomain cookie-less].
     358
     359Of 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:
     360{{{#!sh
     361$ ln -s /path/to/trac/htdocs/common /var/www/static.example.org/trac-common
     362}}}
     363
     364==== Setting up the Plugin Cache
     365
     366Some 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.
     367
     368== Configuring Authentication
     369
     370Trac 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.
     371
     372The process of adding, removing, and configuring user accounts for authentication depends on the specific way you run Trac.
     373
     374Please refer to one of the following sections:
     375 * TracStandalone#UsingAuthentication if you use the standalone server, `tracd`.
     376 * [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`.
     377 * TracFastCgi if you are using another web server with FCGI support, such as Cherokee, Lighttpd, !LiteSpeed, nginx.
     378
     379The following document also contains some useful information for beginners: [trac:TracAuthenticationIntroduction].
     380
     381== Granting admin rights to the admin user
     382
     383Grant admin rights to user admin:
     384{{{#!sh
     385$ trac-admin /path/to/myproject permission add admin TRAC_ADMIN
     386}}}
     387
     388This user will have an "Admin" entry menu that will allow you to administrate your Trac project.
     389
     390== Finishing the install
     391
     392=== Enable version control components
     393
     394Support for version control systems is provided by optional components in Trac and the components are disabled by default //(since 1.0)//. Subversion and Git must be explicitly enabled if you wish to use them. See TracRepositoryAdmin for more details.
     395
     396The version control systems are enabled by adding the following to the `[components]` section of your [TracIni#components-section trac.ini], or enabling the components in the "Plugins" admin panel:
     397
     398{{{#!ini
     399[components]
     400tracopt.versioncontrol.svn.* = enabled
     401}}}
     402
     403{{{#!ini
     404[components]
     405tracopt.versioncontrol.git.* = enabled
     406}}}
     407
     408After enabling the components, repositories can be configured through the //Repositories// admin panel or by editing [TracIni#repositories-section trac.ini]. Automatic changeset references can be inserted as ticket comments by configuring [TracRepositoryAdmin#Automaticchangesetreferencesintickets CommitTicketUpdater].
     409
     410=== Using Trac
    308411
    309412Once 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.
    310413
    311 Keep in mind that anonymous (not logged in) users can by default access most but not all of the features. You will need to configure authentication and grant additional [wiki:TracPermissions permissions] to authenticated users to see the full set of features.
     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.
    312415
    313416'' Enjoy! ''
     
    316419
    317420----
    318 See also: [trac:TracInstallPlatforms TracInstallPlatforms], TracGuide, TracCgi, TracFastCgi, TracModPython, [wiki:TracModWSGI], TracUpgrade, TracPermissions
     421See also: [trac:TracInstallPlatforms TracInstallPlatforms], TracGuide, TracUpgrade, TracPermissions