Changes between Version 2 and Version 3 of TracInstall


Ignore:
Timestamp:
Nov 6, 2016, 11:54:58 AM (3 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracInstall

    v2 v3  
    1 = Trac Installation Guide for 0.11 =
     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 What follows are generic instructions for installing and setting up Trac and its requirements. While you can 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.
    7 
    8 == Short - Install a released version ==
    9 For the quick install, make sure you have [http://python.org Python-2.5], [http://peak.telecommunity.com/DevCenter/EasyInstall#installing-easy-install easy_install] and SQlite-3.3.4 installed (or above).
    10 {{{
    11 sudo easy_install Trac==0.11
    12 }}}
    13 
    14 == Requirements - also older versions possible ==
     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.
     12
     13[[PageOutline(2-3,Installation Steps,inline)]]
     14
     15== Dependencies
     16
     17=== Mandatory Dependencies
    1518
    1619To install Trac, the following software packages must be installed:
    1720
    18  * [http://www.python.org/ Python], version >= 2.3
    19    * if using mod_python together with xml-related things, use python-2.5. expat is namespaced there and does not cause apache to crash any more(see [http://www.dscpl.com.au/wiki/ModPython/Articles/ExpatCausingApacheCrash here] for details).
    20    * For RPM-based systems you might also need the `python-devel` and `python-xml` packages.
    21    * See instructions in ["TracOnWindows/Python2.5"]
    22  * [http://peak.telecommunity.com/DevCenter/setuptools setuptools], version >= 0.6
    23  * [http://genshi.edgewall.org/wiki/Download Genshi], version >= 0.4.1
    24  * You also need a database system and the corresponding python drivers for it.
    25    The database can be either SQLite, PostgreSQL or ''MySQL (experimental)''.
    26  * optional if some plugins require it: [http://www.clearsilver.net/ ClearSilver]
    27 
    28 === For SQLite ===
    29 
    30  * [http://www.sqlite.org/ SQLite], version 3.3.4 and above preferred.
    31  * If not using Python-2.5: [http://pysqlite.org/ PySQLite], version 1.x (for SQLite 2.x) or version 2.x (for SQLite 3.x), version 2.3.2 preferred. For details see PySqlite
    32 
    33 ''Note: It appears that PySQLite 2.x is required for Trac 0.9+/SQLite 3.x if you plan to use the 'trac-post-commit-hook.py' script available from the 'contrib' section of the source repository.''
    34 
    35 ''Note: Users of Mac OS X please take care; the Apple-supplied SQLite contains additional code to support file locking on network filesystems like AFP or SMB. This is not presently (3.3.6) in the mainline sources, so if you build your own SQLite from source it will not function correctly on such filesystems - typically it gives the error "{{{database is locked}}}". [http://www.alastairs-place.net/2006/07/sqlite_and_mac/ A patch] is available for version 3.3.6, based on Apple's code, otherwise you're probably best off using the Apple supplied version (presently 3.1.3).''
    36 
    37 === For PostgreSQL ===
    38 
    39  * [http://www.postgresql.org/ PostgreSQL]
    40  * [http://initd.org/projects/psycopg2 psycopg2] or [http://pypgsql.sourceforge.net/ pyPgSQL]
    41 
    42 '''Warning''': PostgreSQL 8.3 uses a strict type checking mechanism. To use Trac with the 8.3 Version of PostgreSQL, you will need [http://trac.edgewall.org/changeset/6512 trac-0.11] or later.
    43 
    44 === For MySQL ===
    45 
    46 '''Warning''': MySQL support is currently ''still'' experimental. That means it works for some people, but several issues remain, in particular regarding the use of unicode and the key length in the repository cache. See MySqlDb for more detailed information.
    47 
    48  * [http://mysql.com/ MySQL], version 4.1 or later
    49  * [http://sf.net/projects/mysql-python MySQLdb], version 1.2.1 or later
    50 
    51 === Optional Requirements ===
    52 
    53 ==== Version Control System ====
    54 
    55 '''Please note:''' if using Subversion, Trac must be installed on the '''same machine'''. Remote repositories are currently not supported.
    56 
    57  * [http://subversion.tigris.org/ Subversion], version >= 1.0. (versions recommended: 1.2.4, 1.3.2 or 1.4.2) and the '''''corresponding''''' Python bindings. For troubleshooting, check TracSubversion
    58    * Trac uses the [http://svnbook.red-bean.com/svnbook-1.1/ch08s02.html#svn-ch-8-sect-2.3 SWIG] bindings included in the Subversion distribution, '''not''' [http://pysvn.tigris.org/ PySVN] (which is sometimes confused with the standard SWIG bindings).
    59    * If Subversion was already installed without the SWIG bindings, on Unix you'll need to re-`configure` Subversion and `make swig-py`, `make install-swig-py`.
    60    * There are [http://subversion.tigris.org/servlets/ProjectDocumentList?folderID=91 pre-compiled bindings] available for win32.
    61  * Support for other version control systems is provided via third-parties. See PluginList and VersioningSystemBackend.
    62 
    63 ==== Web Server ====
    64  * A CGI-capable web server (see TracCgi), or
    65  * a [http://www.fastcgi.com/ FastCGI]-capable web server (see TracFastCgi), or
    66  * [http://httpd.apache.org/ Apache] with [http://code.google.com/p/modwsgi/ mod_wsgi] (see [wiki:TracModWSGI])
    67     * This should work with Apache 1.3, 2.0 or 2.2 and promises to deliver more performance than using mod_python. A little less mature than mod_python.
    68  * [http://httpd.apache.org/ Apache] with [http://www.modpython.org/ mod_python 3.1.3+] (see TracModPython)
    69     * When installing mod_python the development versions of Python and Apache are required (actually the libraries and header files)
    70 
    71 For those stuck with Apache 1.3, it is also possible to get Trac working with [http://www.modpython.org/ mod_python 2.7] (see [wiki:TracModPython2.7 TracModPython2.7]). This guide hasn't been updated since 0.84, so it may or may not work.
    72 
    73 ==== Other Python Utilities ====
    74  * [http://docutils.sourceforge.net/ docutils], version >= 0.3.9 for WikiRestructuredText.
    75  * [http://pygments.pocoo.org Pygments] for [wiki:TracSyntaxColoring syntax highlighting], also [http://silvercity.sourceforge.net/ SilverCity] and/or [http://gnu.org/software/enscript/enscript.html Enscript] may still be used.
    76     * Note that !SilverCity 0.9.6 has a [http://sourceforge.net/tracker/index.php?func=detail&aid=1424436&group_id=45693&atid=443739 bug] that breaks Python syntax highlighting in Trac. Until an update is made available, we recommend using version 0.9.5.
    77  * [http://pytz.sf.net pytz] to get a complete list of time zones, otherwise Trac will fall back on a shorter list from an internal time zone implementation.
    78 
    79 '''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 MailingList or IrcChannel.
    80 
    81 Please refer to the documentation of these packages to find out how they are best installed. In addition, most of the [wiki: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!).
    82 
    83 == Installing Trac ==
    84 
    85 One way to install Trac is using `setuptools`.
    86 With setuptools you can install Trac from the subversion repository; for example,
    87 to install release version 0.11b2 do:
    88 {{{
    89 easy_install http://svn.edgewall.org/repos/trac/tags/trac-0.11b2
    90 }}}
    91 
    92 But of course the python-typical setup at the top of the source directory also works:
    93 {{{
     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
     24 * [http://genshi.edgewall.org/wiki/Download Genshi], version >= 0.6
     25
     26You also need a database system and the corresponding python bindings. The database can be either SQLite, PostgreSQL or MySQL.
     27
     28==== For the SQLite database #ForSQLite
     29
     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 [http://pypi.python.org/pypi/pysqlite pysqlite] than the one provided by the Python distribution. See [trac:PySqlite#ThePysqlite2bindings PySqlite] for details.
     33
     34==== For the PostgreSQL database #ForPostgreSQL
     35
     36You need to install the database and its Python bindings:
     37 * [http://www.postgresql.org/ PostgreSQL], version 8.0 or later
     38 * [http://pypi.python.org/pypi/psycopg2 psycopg2], version 2.0 or later
     39
     40See [trac:DatabaseBackend#Postgresql DatabaseBackend] for details.
     41
     42==== For the MySQL database #ForMySQL
     43
     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
     47 * [http://sf.net/projects/mysql-python MySQLdb], version 1.2.2 or later
     48
     49Given the caveats and known issues surrounding MySQL, read the [trac:MySqlDb] page before creating the database.
     50
     51=== Optional Dependencies
     52
     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:
     78 * [http://httpd.apache.org/ Apache] with
     79   - [http://code.google.com/p/modwsgi/ mod_wsgi], see [wiki:TracModWSGI] and
     80     http://code.google.com/p/modwsgi/wiki/IntegrationWithTrac
     81   - [http://modpython.org/ mod_python 3.5.0], see TracModPython
     82 * a [http://www.fastcgi.com/ FastCGI]-capable web server (see TracFastCgi)
     83 * an [http://tomcat.apache.org/connectors-doc/ajp/ajpv13a.html AJP]-capable web
     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.
     88   
     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
     93 * [http://docutils.sourceforge.net/ docutils], version >= 0.3.9
     94   for WikiRestructuredText.
     95 * [http://pygments.org Pygments] for
     96   [TracSyntaxColoring syntax highlighting].
     97   [http://silvercity.sourceforge.net/ SilverCity] and/or
     98   [http://gnu.org/software/enscript/enscript.html Enscript] may still be used
     99   but are deprecated and you really should be using Pygments.
     100 * [http://pytz.sf.net pytz] to get a complete list of time zones,
     101   otherwise Trac will fall back on a shorter list from
     102   an internal time zone implementation.
     103
     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
     114It is assumed throughout this guide that you have elevated permissions as the `root` user, or by prefixing commands with `sudo`. The umask `0022` should be used for a typical installation on a Unix-based platform.
     115
     116=== Using `easy_install`
     117
     118Trac can be installed from [https://pypi.python.org/pypi/Trac PyPI] or the Subversion repository using [http://pypi.python.org/pypi/setuptools setuptools].
     119
     120A few command-line examples:
     121
     122 - Install Trac 1.0:
     123 {{{#!sh
     124$ easy_install Trac==1.0
     125}}}
     126 - Install latest development version:
     127 {{{#!sh
     128$ easy_install Trac==dev
     129}}}
     130   Note that in this case you won't have the possibility to run a localized version of Trac;
     131   either use a released version or install from source.
     132
     133More information can be found on the [trac:wiki:setuptools setuptools] page.
     134
     135{{{#!div style="border: 1pt dotted; margin: 1em"
     136**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].
     137}}}
     138
     139=== Using `pip`
     140
     141'pip' is an easy_install replacement that is very useful to quickly install Python packages.
     142To get a Trac installation up and running in less than 5 minutes:
     143
     144Assuming you want to have your entire pip installation in `/opt/user/trac`:
     145
     146 -
     147 {{{#!sh
     148$ pip install trac psycopg2
     149}}}
     150or:
     151 -
     152 {{{#!sh
     153$ pip install trac mysql-python
     154}}}
     155
     156Make sure your OS specific headers are available for pip to automatically build PostgreSQL (`libpq-dev`) or MySQL (`libmysqlclient-dev`) bindings.
     157
     158pip 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`.
     159
     160All 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
     162Additionally, you can install several Trac plugins (listed [https://pypi.python.org/pypi?:action=browse&show=all&c=516 here]) through pip.
     163
     164=== From source
     165
     166Using 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.
     167
     168{{{#!sh
    94169$ python ./setup.py install
    95170}}}
    96171
    97 ''Note: you'll need root permissions or equivalent for this step.''
    98 
    99 This will byte-compile the python source code and install it as an .egg file or folder in the `site-packages` directory
    100 of your Python installation. The .egg will also contain all other resources needed by standard Trac, such as htdocs and templates.
    101 
    102 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.
    103 
    104 === Advanced Options ===
     172You will need root permissions or equivalent for this step.
     173
     174This will byte-compile the Python source code and install it as an .egg file or folder in the `site-packages` directory
     175of your Python installation. The .egg will also contain all other resources needed by standard Trac, such as `htdocs` and `templates`.
     176
     177If 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):
     178{{{#!sh
     179$ python ./setup.py install
     180}}}
     181
     182Alternatively, 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`).
     183
     184=== Using installer
     185
     186On 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.
     187
     188=== Using package manager
     189
     190Trac 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.
     191
     192=== Advanced `easy_install` Options
    105193
    106194To install Trac to a custom location, or find out about other advanced installation options, run:
    107 {{{
    108 easy_install --help
    109 }}}
    110 
    111 Also see [http://docs.python.org/inst/inst.html Installing Python Modules] for detailed information.
     195{{{#!sh
     196$ easy_install --help
     197}}}
     198
     199Also see [http://docs.python.org/2/install/index.html Installing Python Modules] for detailed information.
    112200
    113201Specifically, you might be interested in:
    114 {{{
    115 easy_install --prefix=/path/to/installdir
    116 }}}
    117 or, if installing Trac to a Mac OS X system:
    118 {{{
    119 easy_install --prefix=/usr/local --install-dir=/Library/Python/2.5/site-packages
    120 }}}
     202{{{#!sh
     203$ easy_install --prefix=/path/to/installdir
     204}}}
     205
     206or, if installing Trac on a Mac OS X system:
     207{{{#!sh
     208$ easy_install --prefix=/usr/local --install-dir=/Library/Python/2.5/site-packages
     209}}}
     210
     211'''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.
    121212
    122213The 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.
    123214
    124 == Creating a Project Environment ==
    125 
    126 A [wiki: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 configuration file and various other files and directories.
    127 
    128 A new environment is created using [wiki:TracAdmin trac-admin]:
    129 {{{
     215== Creating a Project Environment
     216
     217A [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.
     218
     219A new environment is created using [TracAdmin trac-admin]:
     220{{{#!sh
    130221$ trac-admin /path/to/myproject initenv
    131222}}}
    132223
    133 [wiki:TracAdmin trac-admin] will prompt you for the information it needs to create the environment, such as the name of the project, the type and the path to an existing [wiki:TracEnvironment#SourceCodeRepository source code repository], the [wiki:TracEnvironment#DatabaseConnectionStrings database connection string], and so on. If you're not sure what to specify for one of these options, just leave it blank to use the default value. The database connection string in particular will always work as long as you have SQLite installed. Leaving the path to the source code repository empty will disable any functionality related to version control, but you can always add that back when the basic system is running.
    134 
    135 Also note that the values you specify here can be changed later by directly editing the [wiki:TracIni] configuration file.
    136 
    137 ''Note: The user account under which the web server runs will require write permissions to the environment directory and all the files inside.  On Linux, with the web server running as user apache and group apache, enter:''
    138 
    139   chown -R apache.apache /path/to/myproject
    140 
    141 
    142 == Running the Standalone Server ==
    143 
    144 After having created a Trac environment, you can easily try the web interface by running the standalone server [wiki:TracStandalone tracd]:
    145 {{{
     224[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.
     225
     226Using the default database connection string in particular will always work as long as you have SQLite installed.
     227For the other [trac:DatabaseBackend database backends] you should plan ahead and already have a database ready to use at this point.
     228
     229Since 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.
     230
     231Also note that the values you specify here can be changed later by directly editing the [TracIni conf/trac.ini] configuration file.
     232
     233{{{#!div style="border: 1pt dotted; margin: 1em"
     234**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.
     235}}}
     236
     237Finally, 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:
     238{{{#!sh
     239$ chown -R apache.apache /path/to/myproject
     240}}}
     241
     242The 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).
     243
     244{{{#!div class=important
     245'''Warning:''' Please only use ASCII-characters for account name and project path, unicode characters are not supported there.
     246}}}
     247
     248== Deploying Trac
     249
     250{{{#!div style="border: 1pt dotted; margin: 1em"
     251**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.
     252
     253If 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.
     254
     255To 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`.
     256{{{#!sh
     257export PKG_RESOURCES_CACHE_ZIP_MANIFESTS=1
     258}}}
     259
     260Alternatively, the variable can be set in the shell before executing `tracd`:
     261{{{#!sh
     262$ PKG_RESOURCES_CACHE_ZIP_MANIFESTS=1 tracd --port 8000 /path/to/myproject
     263}}}
     264
     265If 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`.
     266}}}
     267
     268=== Running the Standalone Server
     269
     270After having created a Trac environment, you can easily try the web interface by running the standalone server [TracStandalone tracd]:
     271{{{#!sh
    146272$ tracd --port 8000 /path/to/myproject
    147273}}}
    148274
    149 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:
    150 {{{
     275Then, 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:
     276{{{#!sh
    151277$ tracd -s --port 8000 /path/to/myproject
    152278}}}
    153279
    154 
    155 == Running Trac on a Web Server ==
    156 
    157 Trac provides three options for connecting to a "real" web server: [wiki:TracCgi CGI], [wiki:TracFastCgi FastCGI] and [wiki:TracModPython mod_python]. For decent performance, it is recommended that you use either FastCGI or mod_python.
    158 
    159 If you're not afraid of running development code, you can also try running Trac on [wiki:TracModWSGI mod_wsgi]. This should deliver even better performance than mod_python, but the module is not considered stable just yet.
    160 
    161 == Configuring Authentication ==
    162 
    163 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:
    164 
    165  * TracStandalone if you use the standalone server, `tracd`.
    166  * TracCgi if you use the CGI or FastCGI methods.
    167  * TracModPython if you use the mod_python method.
    168 
    169 == Trac 0.11 & SVN on Mac OS X Leopard (10.5) ==
    170 
    171  * TracOnLeopardServer
    172 
    173 == Using Trac ==
    174 
    175 Once you have your Trac site up and running, you should be able to browse your subversion repository, create tickets, view the timeline, etc.
    176 
    177 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.
     280=== Running Trac on a Web Server
     281
     282Trac provides various options for connecting to a "real" web server:
     283 - [TracFastCgi FastCGI]
     284 - [wiki:TracModWSGI Apache with mod_wsgi]
     285 - [TracModPython Apache with mod_python]
     286 - //[TracCgi CGI]: should not be used, as it degrades performance//
     287
     288Trac 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.
     289
     290==== Generating the Trac cgi-bin directory #cgi-bin
     291
     292In 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].
     293
     294There 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:
     295{{{#!sh
     296$ mkdir -p /usr/share/trac/projects/my-project
     297$ trac-admin /usr/share/trac/projects/my-project initenv
     298$ trac-admin /usr/share/trac/projects/my-project deploy /tmp/deploy
     299$ mv /tmp/deploy/* /usr/share/trac
     300}}}
     301
     302Don't forget to check that the web server has the execution right on scripts in the `/usr/share/trac/cgi-bin` directory.
     303
     304==== Mapping Static Resources
     305
     306Out 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.
     307
     308Web 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.
     309
     310There 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.
     311
     312Note 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:
     313[[TracAdminHelp(deploy)]]
     314
     315The target `<directory>` will then contain an `htdocs` directory with:
     316 - `site/` - a copy of the environment's directory `htdocs/`
     317 - `common/` - the static resources of Trac itself
     318 - `<plugins>/` - one directory for each resource directory managed by the plugins enabled for this environment
     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 ''before'' the `ScriptAlias` or `WSGIScriptAlias` (which map all the other requests to the Trac application), changing paths to match your deployment:
     328{{{#!apache
     329Alias /trac/chrome/common /path/to/trac/htdocs/common
     330Alias /trac/chrome/site /path/to/trac/htdocs/site
     331
     332<Directory "/path/to/www/trac/htdocs">
     333  # For Apache 2.2
     334  <IfModule !mod_authz_core.c>
     335    Order allow,deny
     336    Allow from all
     337  </IfModule>
     338  # For Apache 2.4
     339  <IfModule mod_authz_core.c>
     340    Require all granted
     341  </IfModule>
     342</Directory>
     343}}}
     344
     345If using mod_python, you might want to add this too, otherwise the alias will be ignored:
     346{{{#!apache
     347<Location "/trac/chrome/common/">
     348  SetHandler None
     349</Location>
     350}}}
     351
     352Note 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.
     353
     354Similarly, 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):
     355{{{#!apache
     356Alias /trac/chrome/site /path/to/projectenv/htdocs
     357
     358<Directory "/path/to/projectenv/htdocs">
     359  # For Apache 2.2
     360  <IfModule !mod_authz_core.c>
     361    Order allow,deny
     362    Allow from all
     363  </IfModule>
     364  # For Apache 2.4
     365  <IfModule mod_authz_core.c>
     366    Require all granted
     367  </IfModule>
     368</Directory>
     369}}}
     370
     371Alternatively 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:
     372{{{#!ini
     373[trac]
     374htdocs_location = http://static.example.org/trac-common/
     375}}}
     376
     377Note 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].
     378
     379Of 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:
     380{{{#!sh
     381$ ln -s /path/to/trac/htdocs/common /var/www/static.example.org/trac-common
     382}}}
     383
     384==== Setting up the Plugin Cache
     385
     386Some 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.
     387
     388== Configuring Authentication
     389
     390Trac 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.
     391
     392The process of adding, removing, and configuring user accounts for authentication depends on the specific way you run Trac.
     393
     394Please refer to one of the following sections:
     395 * TracStandalone#UsingAuthentication if you use the standalone server, `tracd`.
     396 * [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`.
     397 * TracFastCgi if you are using another web server with FCGI support, such as Cherokee, Lighttpd, !LiteSpeed, nginx.
     398
     399The following document also contains some useful information for beginners: [trac:TracAuthenticationIntroduction].
     400
     401== Granting admin rights to the admin user
     402
     403Grant admin rights to user admin:
     404{{{#!sh
     405$ trac-admin /path/to/myproject permission add admin TRAC_ADMIN
     406}}}
     407
     408This user will have an "Admin" entry menu that will allow you to administrate your Trac project.
     409
     410== Finishing the install
     411
     412=== Enable version control components
     413
     414Support 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.
     415
     416The 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:
     417
     418{{{#!ini
     419[components]
     420tracopt.versioncontrol.svn.* = enabled
     421}}}
     422
     423{{{#!ini
     424[components]
     425tracopt.versioncontrol.git.* = enabled
     426}}}
     427
     428After 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].
     429
     430=== Using Trac
     431
     432Once 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.
     433
     434Keep 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.
    178435
    179436'' Enjoy! ''
    180437
    181 [wiki:TracTeam The Trac Team]
     438[trac:TracTeam The Trac Team]
    182439
    183440----
    184 See also:  TracGuide, TracCgi, TracFastCgi, TracModPython, [wiki:TracModWSGI], TracUpgrade, TracPermissions
    185 
     441See also: [trac:TracInstallPlatforms TracInstallPlatforms], TracGuide, TracUpgrade, TracPermissions