Changes between Version 1 and Version 2 of TracInstall


Ignore:
Timestamp:
Feb 13, 2021 12:24:55 AM (4 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracInstall

    v1 v2  
    1 = Trac Installation Guide =
     1= Trac Installation Guide for 1.0
     2
    23[[TracGuideToc]]
    34
    4 Trac is a lightweight project management tool that is implemented as a web-based application. Trac is written in the Python programming language and needs a database (either [http://sqlite.org/ SQLite], [http://www.postgresql.org/ PostgreSQL], or [http://mysql.com/ MySQL] works). For HTML rendering, Trac uses the [http://www.clearsilver.net/ ClearSilver] templating system.
    5 
    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 [http://projects.edgewall.com/trac/wiki/TracInstallPlatforms TracInstallPlatforms] on the main Trac site, please be sure to first read through these general instructions to get a good understanding of the tasks involved.
    7 
    8 == Requirements ==
     5Trac 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.
     6
     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
    918
    1019To install Trac, the following software packages must be installed:
    1120
    12  * [http://www.python.org/ Python], version >= 2.3.
    13    * For RPM-based systems you might also need the `python-devel` and `python-xml` packages.
    14    * If you want to use Trac with Subversion on Windows, note that there are no precompiled Subversion bindings for Python 2.4, so you probably need Python 2.3.
    15     * 2006-09-20: This seems to be no longer true, see http://subversion.tigris.org/servlets/ProjectDocumentList?folderID=91. For subversion 1.4.0 python 2.4 binary bindings are available.
    16  * [http://www.clearsilver.net/ ClearSilver], version >= 0.9.3
    17    * With python-bindings (`./configure --with-python=/usr/bin/python`)
    18  * You also need a database system and the corresponding python drivers for it.
    19    The database can be either SQLite, PostgreSQL or MySQL ''(experimental)''.
    20 
    21 === For SQLite ===
    22 
    23  * [http://www.sqlite.org/ SQLite], version 2.8.x or 3.x (preferred)
    24  * [http://pysqlite.org/ PySQLite], version 1.x (for SQLite 2.x) or version 2.x (for SQLite 3.x). For details see [http://trac.edgewall.org/wiki/PySqlite PySqlite]
    25 
    26 ''Note: Versions of Trac prior to 0.9 do '''not''' work with PySQLite 2.x.''
    27 
    28 ''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.''
    29 
    30 ''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).''
    31 
    32 === For PostgreSQL ===
    33 
    34  * [http://www.postgresql.org/ PostgreSQL]
    35  * [http://initd.org/projects/psycopg2 psycopg2] or [http://pypgsql.sourceforge.net/ pyPgSQL]
    36 
    37 ''Note: PostgreSQL support requires Trac version 0.9 or later.''
    38 
    39 === For MySQL ===
    40 
    41 '''Warning''': MySQL support is currently experimental. That means it works for some people, but has not been tested extensively yet.
    42 
    43  * [http://mysql.com/ MySQL], version 4.1 or later
    44  * [http://sf.net/projects/mysql-python MySQLdb], version 1.2.1 or later
    45 
    46 ''Note: MySQL support requires Trac version 0.10 or later.''
    47 
    48 === Optional Requirements ===
    49 
    50 ==== Version Control System ====
    51  * [http://subversion.tigris.org/ Subversion], version >= 1.0. (either 1.2.3 or >= 1.3.1 recommended) and corresponding [http://svnbook.red-bean.com/svnbook-1.1/ch08s02.html#svn-ch-8-sect-2.3 Python bindings]. For troubleshooting, check [http://projects.edgewall.com/trac/wiki/TracSubversion TracSubversion]
    52    * Trac uses the [http://www.swig.org/ SWIG] bindings included in the Subversion distribution, '''not''' [http://pysvn.tigris.org/ PySVN] (which is sometimes confused with the standard SWIG bindings).
    53    * If Subversion was already installed without the SWIG bindings, you'll need to re-`configure` Subversion and `make swig-py`, `make install-swig-py`.
    54  * Support for other version control systems is provided via third-parties. See [http://projects.edgewall.com/trac/wiki/PluginList PluginList] and [http://projects.edgewall.com/trac/wiki/VersioningSystemBackend VersioningSystemBackend].
    55 
    56 ==== Web Server ====
    57  * A CGI-capable web server (see TracCgi), or
    58  * a [http://www.fastcgi.com/ FastCGI]-capable web server (see TracFastCgi), or
    59  * [http://httpd.apache.org/ Apache] with [http://www.modpython.org/ mod_python 3.1.3+] (see TracModPython)
    60     * When installing mod_python the development versions of Python and Apache are required (actually the libraries and header files)
    61 
    62 For those stuck with Apache 1.3, it is also possible to get Trac 0.8.4 working with [http://www.modpython.org/ mod_python 2.7] (see [wiki:TracModPython2.7 TracModPython2.7]). This hasn't been tested with Trac 0.9, so it may or may not work.
    63 
    64 ==== Other Python Utilities ====
    65  * [http://peak.telecommunity.com/DevCenter/setuptools setuptools], version >= 0.6 for using plugins (see TracPlugins)
    66  * [http://docutils.sourceforge.net/ docutils], version >= 0.3.9 for WikiRestructuredText.
    67  * [http://silvercity.sourceforge.net/ SilverCity] and/or [http://www.gnu.org/software/enscript/enscript.html Enscript] for [wiki:TracSyntaxColoring syntax highlighting].
    68     * 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.
    69 
    70 '''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 [http://projects.edgewall.com/trac/wiki/MailingList MailingList] or [http://projects.edgewall.com/trac/wiki/IrcChannel IrcChannel].
    71 
    72 Please refer to the documentation of these packages to find out how they are best installed. In addition, most of the [http://projects.edgewall.com/trac/wiki/TracInstallPlatforms platform-specific instructions] also describe the installation of the dependencies. Keep in mind however that the information there might concern older versions of Trac than the one you're installing (in particular,
    73 there are still some pages that are about Trac 0.8).
    74 
    75 == Installing Trac ==
    76 
    77 Like most Python programs, the Trac Python package is installed by running the following command at the top of the source directory:
    78 {{{
     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 the latest stable version of Trac:
     123 {{{#!sh
     124$ easy_install Trac
     125}}}
     126 - Install latest development version:
     127 {{{#!sh
     128$ easy_install http://download.edgewall.org/trac/Trac-latest-dev.tar.gz
     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
    79169$ python ./setup.py install
    80170}}}
    81171
    82 ''Note: you'll need root permissions or equivalent for this step.''
    83 
    84 This will byte-compile the python source code and install it in the `site-packages` directory
    85 of your Python installation. The directories `cgi-bin`, `templates`, `htdocs`, `wiki-default` and `wiki-macros` are all copied to `$prefix/share/trac/`. `conf` and `plugins` stub directories are also created under `$prefix/share/trac/` (''since [milestone:0.10]'').
    86 
    87 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.
    88 
    89 === 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
    90193
    91194To install Trac to a custom location, or find out about other advanced installation options, run:
    92 {{{
    93 $ python ./setup.py install --help
    94 }}}
    95 
    96 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.
    97200
    98201Specifically, you might be interested in:
    99 {{{
    100 $ python ./setup.py install --prefix=/path/to/installdir
    101 }}}
    102 
    103 == Creating a Project Environment ==
    104 
    105 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.
    106 
    107 A new environment is created using [wiki:TracAdmin trac-admin]:
    108 {{{
     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.
     212
     213The 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.
     214
     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
    109221$ trac-admin /path/to/myproject initenv
    110222}}}
    111223
    112 [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.
    113 
    114 Also note that the values you specify here can be changed later by directly editing the [wiki:TracIni] configuration file.
    115 
    116 ''Note: The user account under which the web server runs will require write permissions to the environment
    117 directory and all the files inside.''
    118 
    119 
    120 == Running the Standalone Server ==
    121 
    122 After having created a Trac environment, you can easily try the web interface by running the standalone server [wiki:TracStandalone tracd]:
    123 {{{
     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
    124272$ tracd --port 8000 /path/to/myproject
    125273}}}
    126274
    127 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.
    128 
    129 
    130 == Running Trac on a Web Server ==
    131 
    132 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.
    133 
    134 == Configuring Authentication ==
    135 
    136 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:
    137 
    138  * TracStandalone if you use the standalone server, `tracd`.
    139  * TracCgi if you use the CGI or FastCGI methods.
    140  * TracModPython if you use the mod_python method.
    141 
    142 == Using Trac ==
    143 
    144 Once you have your Trac site up and running, you should be able to browse your subversion repository, create tickets, view the timeline, etc.
    145 
    146 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.
     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
     277$ tracd -s --port 8000 /path/to/myproject
     278}}}
     279
     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
     306Without 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.
     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 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.
     309
     310There 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.
     311
     312A single `/chrome` alias can used if the static resources are extracted for all plugins. This means that the `deploy` command must be executed after installing or updating a plugin that provides static resources, or after modifying resources in the `$env/htdocs` directory. This is probably appropriate for most installations but may not be what you want if, for example, you wish to upload plugins through the //Plugins// administration page.
     313
     314The resources are extracted using the [TracAdmin trac-admin]` <environment> deploy` command:
     315[[TracAdminHelp(deploy)]]
     316
     317The target `<directory>` will contain an `htdocs` directory with:
     318 - `common/` - the static resources of Trac
     319 - `site/` - a copy of the environment's `htdocs/` directory
     320 - `shared` - the static resources shared by multiple Trac environments, with a location defined by the `[inherit]` `htdocs_dir` option
     321 - `<plugin>/` - one directory for each resource directory provided by the plugins enabled for this environment
     322
     323The 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:
     324{{{#!apache
     325Alias /trac/chrome/common /path/to/trac/htdocs/common
     326Alias /trac/chrome/site /path/to/trac/htdocs/site
     327Alias /trac/chrome/shared /path/to/trac/htdocs/shared
     328Alias /trac/chrome/<plugin> /path/to/trac/htdocs/<plugin>
     329}}}
     330
     331===== Example: Apache and `ScriptAlias` #ScriptAlias-example
     332
     333Assuming the deployment has been done this way:
     334{{{#!sh
     335$ trac-admin /var/trac/env deploy /path/to/shared/trac
     336}}}
     337
     338Add 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:
     339{{{#!apache
     340Alias /trac/chrome /path/to/trac/htdocs
     341
     342<Directory "/path/to/www/trac/htdocs">
     343  # For Apache 2.2
     344  <IfModule !mod_authz_core.c>
     345    Order allow,deny
     346    Allow from all
     347  </IfModule>
     348  # For Apache 2.4
     349  <IfModule mod_authz_core.c>
     350    Require all granted
     351  </IfModule>
     352</Directory>
     353}}}
     354
     355If using mod_python, add this too, otherwise the alias will be ignored:
     356{{{#!apache
     357<Location "/trac/chrome/common">
     358  SetHandler None
     359</Location>
     360}}}
     361
     362Alternatively, 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:
     363{{{#!apache
     364Alias /trac/chrome/site /path/to/projectenv/htdocs
     365
     366<Directory "/path/to/projectenv/htdocs">
     367  # For Apache 2.2
     368  <IfModule !mod_authz_core.c>
     369    Order allow,deny
     370    Allow from all
     371  </IfModule>
     372  # For Apache 2.4
     373  <IfModule mod_authz_core.c>
     374    Require all granted
     375  </IfModule>
     376</Directory>
     377}}}
     378
     379Another alternative to aliasing `/trac/chrome/common` is having Trac generate direct links for those static resources (and only those), using the [[TracIni#trac-section| [trac] htdocs_location]] configuration setting:
     380{{{#!ini
     381[trac]
     382htdocs_location = http://static.example.org/trac-common/
     383}}}
     384
     385Note that this makes it easy to have a dedicated domain serve those static resources, preferentially cookie-less.
     386
     387Of 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:
     388{{{#!sh
     389$ ln -s /path/to/trac/htdocs/common /var/www/static.example.org/trac-common
     390}}}
     391
     392==== Setting up the Plugin Cache
     393
     394Some 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.
     395
     396== Configuring Authentication
     397
     398Trac 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.
     399
     400The process of adding, removing, and configuring user accounts for authentication depends on the specific way you run Trac.
     401
     402Please refer to one of the following sections:
     403 * TracStandalone#UsingAuthentication if you use the standalone server, `tracd`.
     404 * [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`.
     405 * TracFastCgi if you are using another web server with FCGI support, such as Cherokee, Lighttpd, !LiteSpeed, nginx.
     406
     407The following document also contains some useful information for beginners: [trac:TracAuthenticationIntroduction].
     408
     409== Granting admin rights to the admin user
     410
     411Grant admin rights to user admin:
     412{{{#!sh
     413$ trac-admin /path/to/myproject permission add admin TRAC_ADMIN
     414}}}
     415
     416This user will have an "Admin" entry menu that will allow you to administrate your Trac project.
     417
     418== Finishing the install
     419
     420=== Enable version control components
     421
     422Support 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.
     423
     424The 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:
     425
     426{{{#!ini
     427[components]
     428tracopt.versioncontrol.svn.* = enabled
     429}}}
     430
     431{{{#!ini
     432[components]
     433tracopt.versioncontrol.git.* = enabled
     434}}}
     435
     436After 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].
     437
     438=== Using Trac
     439
     440Once 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.
     441
     442Keep 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.
    147443
    148444'' Enjoy! ''
    149445
    150 [http://projects.edgewall.com/trac/wiki/TracTeam The Trac Team]
     446[trac:TracTeam The Trac Team]
    151447
    152448----
    153 See also:  TracGuide, TracCgi, TracFastCgi, TracModPython, TracUpgrade, TracPermissions
     449See also: [trac:TracInstallPlatforms TracInstallPlatforms], TracGuide, TracUpgrade, TracPermissions