Changes between Version 2 and Version 3 of TracInstall


Ignore:
Timestamp:
2023-04-20T18:47:43Z (19 months 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.5
    22[[TracGuideToc]]
    33
    4   '''NOTE: this page is now for 0.11, which will be released soon. For installing previous Trac versions, please refer to wiki:0.10/TracInstall.'''
    5 
    6 Trac is written in the Python programming language and needs a database, [http://sqlite.org/ SQLite], [http://www.postgresql.org/ PostgreSQL], or [http://mysql.com/ MySQL]. For HTML rendering, Trac uses the [http://genshi.edgewall.org Genshi] templating system.
    7 
    8 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.
    9 
    10 == Short - Install a released version ==
    11 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).
    12 {{{
    13 sudo easy_install Pygments
    14 sudo easy_install Genshi
    15 sudo easy_install Trac
    16 }}}
    17 
    18 == Requirements - also older versions possible ==
     4Trac is written in the Python programming language and needs a database, [https://sqlite.org/ SQLite], [https://www.postgresql.org/ PostgreSQL], or [https://mysql.com/ MySQL]. For HTML rendering, Trac uses the [http://jinja.pocoo.org Jinja2] templating system, though Genshi templates are supported until Trac 1.5.1.
     5
     6Trac can also be localized, and there is probably a translation available in your language. If you want to use the Trac interface in other languages, then make sure you have installed the optional package [#OtherPythonPackages Babel]. Pay attention to the extra steps for localization support in the [#InstallingTrac Installing Trac] section below. Lacking Babel, you will only get the default English version.
     7
     8If you're interested in contributing new translations for other languages or enhancing the existing translations, please have a look at [trac:wiki:TracL10N TracL10N].
     9
     10These are generic instructions for installing and setting up Trac. While you may find instructions for installing Trac on specific systems at [trac:TracInstallPlatforms TracInstallPlatforms], please '''first read through these general instructions''' to get a good understanding of the tasks involved.
     11
     12[[PageOutline(2-3,Installation Steps,inline)]]
     13
     14== Dependencies
     15=== Mandatory Dependencies
    1916
    2017To install Trac, the following software packages must be installed:
    2118
    22  * [http://www.python.org/ Python], version >= 2.3
    23    * 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).
    24    * For RPM-based systems you might also need the `python-devel` and `python-xml` packages.
    25    * See instructions in ["TracOnWindows/Python2.5"]
    26  * [http://peak.telecommunity.com/DevCenter/setuptools setuptools], version >= 0.6
    27  * [http://genshi.edgewall.org/wiki/Download Genshi], version >= 0.3.6
    28  * You also need a database system and the corresponding python drivers for it.
    29    The database can be either SQLite, PostgreSQL or ''MySQL (experimental)''.
    30  * optional if some plugins require it: [http://www.clearsilver.net/ ClearSilver]
    31 
    32 === For SQLite ===
    33 
    34  * [http://www.sqlite.org/ SQLite], version 3.3.4 and above preferred.
    35  * 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
    36 
    37 ''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.''
    38 
    39 ''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).''
    40 
    41 === For PostgreSQL ===
    42 
    43  * [http://www.postgresql.org/ PostgreSQL]
    44  * [http://initd.org/projects/psycopg2 psycopg2] or [http://pypgsql.sourceforge.net/ pyPgSQL]
    45 
    46 === For MySQL ===
    47 
    48 '''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 informations.
    49 
    50  * [http://mysql.com/ MySQL], version 4.1 or later
    51  * [http://sf.net/projects/mysql-python MySQLdb], version 1.2.1 or later
    52 
    53 === Optional Requirements ===
    54 
    55 ==== Version Control System ====
    56 
    57 '''Please note:''' if using Subversion, Trac must be installed on the '''same machine'''. Remote repositories are currently not supported.
    58 
    59  * [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
    60    * 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).
    61    * 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`.
    62    * There are [http://subversion.tigris.org/servlets/ProjectDocumentList?folderID=91 pre-compiled bindings] available for win32.
    63  * Support for other version control systems is provided via third-parties. See PluginList and VersioningSystemBackend.
    64 
    65 ==== Web Server ====
    66  * A CGI-capable web server (see TracCgi), or
    67  * a [http://www.fastcgi.com/ FastCGI]-capable web server (see TracFastCgi), or
    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  * [http://httpd.apache.org/ Apache] with [http://code.google.com/p/modwsgi/ mod_wsgi] (see [wiki:TracModWSGI])
    71     * While mod_wsgi is very new and somewhat experimental, this should work with Apache 1.3, 2.0 or 2.2 and promises to deliver more performance than using mod_python.
    72 
    73 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.
    74 
    75 ==== Other Python Utilities ====
    76  * [http://docutils.sourceforge.net/ docutils], version >= 0.3.9 for WikiRestructuredText.
    77  * [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.
    78     * 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.
    79  * [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.
    80 
    81 '''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.
    82 
    83 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!).
    84 
    85 == Installing Trac ==
    86 
    87 One way to install Trac is using `setuptools`.
    88 With setuptools you can install Trac from the subversion repository; for example,
    89 to install release version 0.11 do:
    90 {{{
    91 easy_install http://svn.edgewall.com/repos/trac/tags/trac-0.11
    92 }}}
    93 
    94 But of course the python-typical setup at the top of the source directory also works:
    95 {{{
    96 $ python ./setup.py install
    97 }}}
    98 
    99 ''Note: you'll need root permissions or equivalent for this step.''
    100 
    101 This will byte-compile the python source code and install it in the `site-packages` directory
    102 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/`.
    103 On Linux, the default value of `$prefix` is `/usr`, so the installation will be to `/usr/share/trac`, whereas the BSDs use `/usr/local`. Other Unix or Unix-like systems might use a similar prefix or something like `/opt`, please see your system's documentation for details.
    104 
    105 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.
    106 
    107 === Advanced Options ===
    108 
    109 To install Trac to a custom location, or find out about other advanced installation options, run:
    110 {{{
    111 easy_install --help
    112 }}}
    113 
    114 Also see [http://docs.python.org/inst/inst.html Installing Python Modules] for detailed information.
    115 
    116 Specifically, you might be interested in:
    117 {{{
    118 easy_install --prefix=/path/to/installdir
    119 }}}
    120 
    121 == Creating a Project Environment ==
    122 
    123 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.
    124 
    125 A new environment is created using [wiki:TracAdmin trac-admin]:
    126 {{{
     19 * [https://www.python.org/ Python], version >= 3.5
     20 * [https://pypi.org/project/setuptools setuptools], version > 5.6
     21 * [https://pypi.org/project/Jinja2 Jinja2], version >= 2.9.3
     22
     23You also need a database system and the corresponding Python bindings. The database can be either SQLite, PostgreSQL or MySQL.
     24
     25==== For the SQLite database #ForSQLite
     26
     27You already have the SQLite database bindings bundled with the standard distribution of Python (the `sqlite3` module).
     28
     29Optionally, you may install a newer version of [https://pypi.org/project/pysqlite pysqlite] than the one provided by the Python distribution. See [trac:PySqlite#ThePysqlite2bindings PySqlite] for details.
     30
     31==== For the PostgreSQL database #ForPostgreSQL
     32
     33You need to install the database and its Python bindings:
     34 * [https://www.postgresql.org/ PostgreSQL], version 9.1 or later
     35 * [https://pypi.org/project/psycopg2 psycopg2], version 2.5 or later
     36
     37See [trac:DatabaseBackend#Postgresql DatabaseBackend] for details.
     38
     39==== For the MySQL database #ForMySQL
     40
     41Trac works well with MySQL, provided you use the following:
     42
     43 * [https://mysql.com/ MySQL], version 5.0 or later
     44 * [https://pypi.org/project/PyMySQL PyMySQL]
     45
     46Given the caveats and known issues surrounding MySQL, read carefully the [trac:MySqlDb] page before creating the database.
     47
     48=== Optional Dependencies
     49
     50==== Subversion
     51
     52[https://subversion.apache.org/ Subversion], 1.14.x or later and the '''corresponding''' Python bindings.
     53
     54There are [https://subversion.apache.org/packages.html pre-compiled SWIG bindings] available for various platforms. See [trac:TracSubversion#GettingSubversion getting Subversion] for more information.
     55
     56{{{#!div style="border: 1pt dotted; margin: 1em"
     57**Note:**
     58* Trac '''doesn't''' use [https://pypi.org/project/PySVN PySVN], nor does it work yet with the newer `ctype`-style bindings.
     59* If using Subversion, Trac must be installed on the '''same machine'''. Remote repositories are [trac:ticket:493 not supported].
     60}}}
     61
     62For troubleshooting information, see the [trac:TracSubversion#Troubleshooting TracSubversion] page.
     63
     64==== Git
     65
     66[https://git-scm.com/ Git] 1.5.6 or later is supported. More information is available on the [trac:TracGit] page.
     67
     68==== Other Version Control Systems
     69
     70Support for other version control systems is provided via third-party plugins. See [trac:PluginList#VersionControlSystems] and [trac:VersionControlSystem].
     71
     72==== Web Server
     73
     74A web server is optional because Trac is shipped with a server included, see the [#RunningtheStandaloneServer Running the Standalone Server] section below.
     75
     76Alternatively you can configure Trac to run in any of the following environments:
     77 * [https://httpd.apache.org/ Apache] with
     78   - [https://github.com/GrahamDumpleton/mod_wsgi mod_wsgi], see [wiki:TracModWSGI] and
     79     [https://code.google.com/p/modwsgi/wiki/IntegrationWithTrac ModWSGI IntegrationWithTrac].
     80   - [http://modpython.org/ mod_python 3.5.0], see TracModPython
     81 * a [https://fastcgi-archives.github.io FastCGI]-capable web server (see TracFastCgi)
     82 * an [https://tomcat.apache.org/connectors-doc/ajp/ajpv13a.html AJP]-capable web server (see [trac:TracOnWindowsIisAjp TracOnWindowsIisAjp])
     83 * Microsoft IIS with FastCGI and a FastCGI-to-WSGI gateway (see [trac:CookBook/Installation/TracOnWindowsIisWfastcgi IIS with FastCGI])
     84 * a CGI-capable web server (see TracCgi), '''but usage of Trac as a cgi script is highly discouraged''', better use one of the previous options.
     85
     86==== Other Python Packages
     87
     88 * [http://babel.pocoo.org Babel], version >= 2.2, needed for localization support
     89 * [http://pytz.sourceforge.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. Installing Babel will install pytz.
     90 * [http://docutils.sourceforge.net docutils], version >= 0.14, for WikiRestructuredText.
     91 * [http://pygments.org Pygments], version >= 1.0, for [TracSyntaxColoring syntax highlighting].
     92 * [https://pypi.org/project/textile Textile], version >= 2.3, for rendering the [https://github.com/textile/python-textile Textile markup language].
     93 * [https://pypi.org/project/passlib passlib] on Windows to decode [TracStandalone#BasicAuthorization:Usingahtpasswdpasswordfile htpasswd formats] other than `SHA-1`.
     94 * [https://pypi.org/project/pyreadline pyreadline] on Windows for trac-admin [TracAdmin#InteractiveMode command completion].
     95
     96{{{#!div style="border: 1pt dotted; margin: 1em"
     97**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].
     98}}}
     99
     100Please 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''.
     101
     102== Installing Trac
     103
     104The [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.
     105
     106It is assumed throughout this guide that you have elevated permissions as the `root` user or by prefixing commands with `sudo`. The umask `0002` should be used for a typical installation on a Unix-based platform.
     107
     108=== Using `pip`
     109
     110`pip` is the modern Python package manager and is included in Python distributions. `pip` will automatically resolve the //required// dependencies (Jinja2 and setuptools) and download the latest packages from pypi.org.
     111
     112You can also install directly from a source package. You can obtain the source in a tar or zip from the [trac:TracDownload] page. After extracting the archive, change to the directory containing `setup.py` and run:
     113
     114{{{#!sh
     115$ pip install .
     116}}}
     117
     118`pip` supports numerous other install mechanisms. It can be passed the URL of an archive or other download location. Here are some examples:
     119
     120* Install the latest development version from a tar archive:
     121{{{#!sh
     122$ pip install https://download.edgewall.org/trac/Trac-latest-dev.tar.gz
     123}}}
     124* Install the unreleased 1.4-stable from subversion:
     125{{{#!sh
     126$ pip install svn+https://svn.edgewall.org/repos/trac/branches/1.4-stable
     127}}}
     128* Install the latest development preview (//not recommended for production installs//):
     129{{{#!sh
     130$ pip install --find-links=https://trac.edgewall.org/wiki/TracDownload Trac
     131}}}
     132
     133The optional dependencies can be installed from PyPI using `pip`:
     134{{{#!sh
     135$ pip install babel docutils pygments textile
     136}}}
     137
     138The optional dependencies can alternatively be
     139specified using the `extras` keys in the setup file:
     140{{{#!sh
     141$ pip install Trac[babel,rest,pygments,textile]
     142}}}
     143
     144`rest` is the extra that installs the `docutils`
     145dependency.
     146
     147Include `mysql` or `psycopg2-binary` in the
     148list if using the MySQL or PostgreSQL database.
     149
     150Additionally, you can install several Trac plugins from PyPI (listed [https://pypi.org/search/?c=Framework+%3A%3A+Trac here]) using pip. See TracPlugins for more information.
     151
     152=== Using installer
     153
     154On Windows, Trac can be installed using the exe installers available on the [trac:TracDownload] page. Installers are available for the 32-bit and 64-bit versions of Python. Make sure to use the installer that matches the architecture of your Python installation.
     155
     156=== Using package manager
     157
     158Trac may be available in your platform's package repository. However, your package manager may not provide the latest release of Trac.
     159
     160== Creating a Project Environment
     161
     162A [TracEnvironment Trac environment] is the backend where Trac stores information like wiki pages, tickets, reports, settings, etc. An environment is a directory that contains a human-readable [TracIni configuration file], and other files and directories.
     163
     164A new environment is created using [TracAdmin trac-admin]:
     165{{{#!sh
    127166$ trac-admin /path/to/myproject initenv
    128167}}}
    129168
    130 [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.
    131 
    132 Also note that the values you specify here can be changed later by directly editing the [wiki:TracIni] configuration file.
    133 
    134 ''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:''
    135 
    136   chown -R apache.apache /path/to/myproject
    137 
    138 
    139 == Running the Standalone Server ==
    140 
    141 After having created a Trac environment, you can easily try the web interface by running the standalone server [wiki:TracStandalone tracd]:
    142 {{{
     169[TracAdmin trac-admin] will prompt you for the information it needs to create the environment: the name of the project and the [TracEnvironment#DatabaseConnectionStrings database connection string]. If you're not sure what to specify for any of these options, just press `<Enter>` to use the default value.
     170
     171Using the default database connection string will always work as long as you have SQLite installed. For the other [trac:DatabaseBackend database backends] you should plan ahead and already have a database ready to use at this point.
     172
     173Also note that the values you specify here can be changed later using TracAdmin or directly editing the [TracIni conf/trac.ini] configuration file.
     174
     175Finally, 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:
     176{{{#!sh
     177$ chown -R apache:apache /path/to/myproject
     178}}}
     179
     180The 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).
     181
     182{{{#!div class=important
     183'''Warning:''' Please only use ASCII-characters for account name and project path, unicode characters are not supported there.
     184}}}
     185
     186== Deploying Trac
     187
     188=== Running the Standalone Server
     189
     190After having created a Trac environment, you can easily try the web interface by running the standalone server [TracStandalone tracd]:
     191{{{#!sh
    143192$ tracd --port 8000 /path/to/myproject
    144193}}}
    145194
    146 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.
    147 
    148 
    149 == Running Trac on a Web Server ==
    150 
    151 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.
    152 
    153 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.
    154 
    155 == Configuring Authentication ==
    156 
    157 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:
    158 
    159  * TracStandalone if you use the standalone server, `tracd`.
    160  * TracCgi if you use the CGI or FastCGI methods.
    161  * TracModPython if you use the mod_python method.
    162 
    163 == Using Trac ==
    164 
    165 Once you have your Trac site up and running, you should be able to browse your subversion repository, create tickets, view the timeline, etc.
    166 
    167 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.
     195Then, open a browser and visit `http://localhost:8000/`. You should get a simple listing of all environments that `tracd` knows about. Follow the link to the environment you just created, and you should see Trac in action. If you only plan on managing a single project with Trac you can have the standalone server skip the environment list by starting it like this:
     196{{{#!sh
     197$ tracd -s --port 8000 /path/to/myproject
     198}}}
     199
     200=== Running Trac on a Web Server
     201
     202Trac provides various options for connecting to a "real" web server:
     203 - [TracFastCgi FastCGI]
     204 - [wiki:TracModWSGI Apache with mod_wsgi]
     205 - [TracModPython Apache with mod_python]
     206 - [TracCgi CGI] //(should not be used, as the performance is far from optimal)//
     207
     208Trac also supports [trac:TracOnWindowsIisAjp AJP] which may be your choice if you want to connect to IIS. Other deployment scenarios are possible: [trac:TracNginxRecipe nginx], [https://uwsgi-docs.readthedocs.io/en/latest/#Traconapacheinasub-uri uwsgi], [trac:TracOnWindowsIisIsapi Isapi-wsgi] etc.
     209
     210==== Generating the Trac cgi-bin directory #cgi-bin
     211
     212Application scripts for CGI, FastCGI and mod-wsgi can be generated using the [TracAdmin trac-admin] `deploy` command:
     213[[TracAdminHelp(deploy)]]
     214
     215Grant the web server execution right on scripts in the `cgi-bin` directory.
     216
     217For example, the following yields a typical directory structure:
     218{{{#!sh
     219$ mkdir -p /var/trac
     220$ trac-admin /var/trac/<project> initenv
     221$ trac-admin /var/trac/<project> deploy /var/www
     222$ ls /var/www
     223cgi-bin htdocs
     224$ chmod ugo+x /var/www/cgi-bin/*
     225}}}
     226
     227==== Mapping Static Resources
     228
     229Without 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.
     230
     231Web servers such as [https://httpd.apache.org/ Apache] allow you to create //Aliases// to resources, giving them a virtual URL that doesn't necessarily reflect their location on the file system. We can map requests for static resources directly to directories on the file system, to avoid Trac processing the requests.
     232
     233There 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.
     234
     235A single `/chrome` alias can used if the static resources are extracted for all plugins. This means that the `deploy` command (discussed in the previous section) must be executed after installing or updating a plugin that provides static resources, or after modifying resources in the `$env/htdocs` directory. This is probably appropriate for most installations but may not be what you want if, for example, you wish to upload plugins through the //Plugins// administration page.
     236
     237The `deploy` command creates an `htdocs` directory with:
     238 - `common/` - the static resources of Trac
     239 - `site/` - a copy of the environment's `htdocs/` directory
     240 - `shared` - the static resources shared by multiple Trac environments, with a location defined by the `[inherit]` `htdocs_dir` option
     241 - `<plugin>/` - one directory for each resource directory provided by the plugins enabled for this environment
     242
     243The 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:
     244{{{#!apache
     245Alias /trac/chrome/common /path/to/trac/htdocs/common
     246Alias /trac/chrome/site /path/to/trac/htdocs/site
     247Alias /trac/chrome/shared /path/to/trac/htdocs/shared
     248Alias /trac/chrome/<plugin> /path/to/trac/htdocs/<plugin>
     249}}}
     250
     251===== Example: Apache and `ScriptAlias` #ScriptAlias-example
     252
     253Assuming the deployment has been done this way:
     254{{{#!sh
     255$ trac-admin /var/trac/<project> deploy /var/www/trac
     256}}}
     257
     258Add 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:
     259{{{#!apache
     260Alias /trac/chrome /var/www/trac/htdocs
     261
     262<Directory "/var/www/trac/htdocs">
     263  # For Apache 2.2
     264  <IfModule !mod_authz_core.c>
     265    Order allow,deny
     266    Allow from all
     267  </IfModule>
     268  # For Apache 2.4
     269  <IfModule mod_authz_core.c>
     270    Require all granted
     271  </IfModule>
     272</Directory>
     273}}}
     274
     275If using mod_python, add this too, otherwise the alias will be ignored:
     276{{{#!apache
     277<Location "/trac/chrome/common">
     278  SetHandler None
     279</Location>
     280}}}
     281
     282Alternatively, 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:
     283{{{#!apache
     284Alias /trac/chrome/site /path/to/projectenv/htdocs
     285
     286<Directory "/path/to/projectenv/htdocs">
     287  # For Apache 2.2
     288  <IfModule !mod_authz_core.c>
     289    Order allow,deny
     290    Allow from all
     291  </IfModule>
     292  # For Apache 2.4
     293  <IfModule mod_authz_core.c>
     294    Require all granted
     295  </IfModule>
     296</Directory>
     297}}}
     298
     299Another alternative to aliasing `/trac/chrome/common` is having Trac generate direct links for those static resources (and only those), using the [TracIni#trac-htdocs_location-option trac.htdocs_location] configuration setting:
     300{{{#!ini
     301[trac]
     302htdocs_location = http://static.example.org/trac-common/
     303}}}
     304
     305Note that this makes it easy to have a dedicated domain serve those static resources, preferentially cookie-less.
     306
     307Of 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:
     308{{{#!sh
     309$ ln -s /path/to/trac/htdocs/common /var/www/static.example.org/trac-common
     310}}}
     311
     312==== Setting up the Plugin Cache
     313
     314Some 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.
     315
     316== Configuring Authentication
     317
     318Trac uses HTTP authentication. You'll need to configure your web server 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.
     319
     320The process of adding, removing, and configuring user accounts for authentication depends on the specific way you run Trac.
     321
     322Please refer to one of the following sections:
     323 * TracStandalone#UsingAuthentication if you use the standalone server, `tracd`.
     324 * [wiki:TracModWSGI#ConfiguringAuthentication TracModWSGI#ConfiguringAuthentication] if you use the Apache web server, with any of its front end: `mod_wsgi`, `mod_python`, `mod_fcgi` or `mod_fastcgi`.
     325 * TracFastCgi if you're using another web server with FCGI support (Cherokee, Lighttpd, !LiteSpeed, nginx)
     326
     327[trac:TracAuthenticationIntroduction] also contains some useful information for beginners.
     328
     329== Granting admin rights to the admin user
     330Grant admin rights to user admin:
     331{{{#!sh
     332$ trac-admin /path/to/myproject permission add admin TRAC_ADMIN
     333}}}
     334
     335This user will have an //Admin// navigation item that directs to pages for administering your Trac project.
     336
     337== Configuring Trac
     338
     339Configuration options are documented on the TracIni page.
     340
     341TracRepositoryAdmin provides information on configuring version control repositories for your project.
     342
     343In addition to the optional version control backends, Trac provides several optional features that are disabled by default:
     344* [TracFineGrainedPermissions#AuthzPolicy Fine-grained permission policy]
     345* [TracPermissions#CreatingNewPrivileges Custom permissions]
     346* [TracTickets#deleter Ticket deletion]
     347* [TracTickets#cloner Ticket cloning]
     348* [TracRepositoryAdmin#CommitTicketUpdater Ticket changeset references]
     349
     350== Using Trac
     351
     352Once 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.
     353
     354Keep 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.
    168355
    169356'' Enjoy! ''
    170357
    171 [wiki:TracTeam The Trac Team]
     358[trac:TracTeam The Trac Team]
    172359
    173360----
    174 See also:  TracGuide, TracCgi, TracFastCgi, TracModPython, [wiki:TracModWSGI], TracUpgrade, TracPermissions
     361See also: [trac:TracInstallPlatforms TracInstallPlatforms], TracGuide, TracUpgrade