gibuu is hosted by Hepforge, IPPP Durham
GiBUU

Changes between Version 2 and Version 3 of TracInstall


Ignore:
Timestamp:
Jul 10, 2013, 2:10:19 PM (11 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 =
    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 
    64Trac 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.
    75
    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 ==
    19 
     6Since version 0.12, Trac can also be localized, and there's probably a translation available for your language. If you want to be able to use the Trac interface in other languages, then make sure you have installed the optional package [#OtherPythonPackages Babel]. Pay attention to the extra steps for localization support in the [#InstallingTrac Installing Trac] section below. Lacking Babel, you will only get the default english version, as usual.
     7
     8If you're interested in contributing new translations for other languages or enhance the existing translations, then please have a look at [[trac:TracL10N]].
     9
     10What follows are generic instructions for installing and setting up Trac and its requirements. While you may find instructions for installing Trac on specific systems at [trac:TracInstallPlatforms TracInstallPlatforms] on the main Trac site, please be sure to '''first read through these general instructions''' to get a good understanding of the tasks involved.
     11
     12[[PageOutline(2-3,Installation Steps,inline)]]
     13
     14== Dependencies ==
     15=== Mandatory Dependencies
    2016To install Trac, the following software packages must be installed:
    2117
    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 ===
     18 * [http://www.python.org/ Python], version >= 2.5 and < 3.0
     19   (note that we dropped the support for Python 2.4 in this release)
     20 * [http://peak.telecommunity.com/DevCenter/setuptools setuptools], version >= 0.6, or better yet, [http://pypi.python.org/pypi/distribute distribute]
     21 * [http://genshi.edgewall.org/wiki/Download Genshi], version >= 0.6 (unreleased version 0.7dev should work as well)
     22
     23You also need a database system and the corresponding python bindings.
     24The database can be either SQLite, PostgreSQL or MySQL.
     25
     26==== For the SQLite database #ForSQLite
     27
     28As you must be using Python 2.5, 2.6 or 2.7, you already have the SQLite database bindings bundled with the standard distribution of Python (the `sqlite3` module).
     29
     30However, if you'd like, you can download the latest and greatest version of [[trac:Pysqlite]] from
     31[http://code.google.com/p/pysqlite/downloads/list google code], where you'll find the Windows
     32installers or the `tar.gz` archive for building from source:
     33{{{
     34$ tar xvfz <version>.tar.gz
     35$ cd <version>
     36$ python setup.py build_static install
     37}}}
     38 
     39This will download the latest SQLite code and build the bindings.
     40
     41SQLite 2.x is no longer supported.
     42
     43A known bug PySqlite versions 2.5.2-4 prohibits upgrade of trac databases
     44from 0.11.x to 0.12. Please use versions 2.5.5 and newer or 2.5.1 and
     45older. See #9434 for more detail.
     46
     47See additional information in [trac:PySqlite PySqlite].
     48
     49==== For the PostgreSQL database #ForPostgreSQL
     50
     51You need to install the database and its Python bindings:
     52 * [http://www.postgresql.org/ PostgreSQL], version 8.0 or later
     53 * [http://pypi.python.org/pypi/psycopg2 psycopg2]
     54
     55See [trac:DatabaseBackend#Postgresql DatabaseBackend] for details.
     56
     57
     58==== For the MySQL database #ForMySQL
     59
     60Trac can now work quite well with MySQL, provided you follow the guidelines.
     61
     62 * [http://mysql.com/ MySQL], version 5.0 or later
     63 * [http://sf.net/projects/mysql-python MySQLdb], version 1.2.2 or later
     64
     65It is '''very''' important to read carefully the  [trac:MySqlDb] page before creating the database.
     66
     67=== Optional Dependencies
    5468
    5569==== Version Control System ====
    5670
    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.
     71===== Subversion =====
     72 * [http://subversion.apache.org/ Subversion], 1.5.x or 1.6.x and the '''''corresponding''''' Python bindings. Older versions starting from 1.0, like 1.2.4, 1.3.2 or 1.4.2, etc. should still work. For troubleshooting information, check the [trac:TracSubversion#Troubleshooting TracSubversion] page.
     73
     74There are [http://subversion.apache.org/packages.html pre-compiled SWIG bindings] available for various platforms. (Good luck finding precompiled SWIG bindings for any Windows package at that listing. TracSubversion points you to [http://alagazam.net Algazam], which works for me under Python 2.6.)
     75
     76Note that Trac '''doesn't''' use [http://pysvn.tigris.org/ PySVN], neither does it work yet with the newer `ctype`-style bindings.
     77
     78
     79'''Please note:''' if using Subversion, Trac must be installed on the '''same machine'''. Remote repositories are currently [trac:ticket:493 not supported].
     80
     81
     82===== Others =====
     83
     84Support for other version control systems is provided via third-parties. See [trac:PluginList] and [trac:VersionControlSystem].
    6485
    6586==== 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!).
     87A web server is optional because Trac is shipped with a server included, see the [#RunningtheStandaloneServer Running the Standalone Server ] section below.
     88
     89Alternatively you configure Trac to run in any of the following environments.
     90 * [http://httpd.apache.org/ Apache] with
     91   - [http://code.google.com/p/modwsgi/ mod_wsgi], see [wiki:TracModWSGI] and
     92     http://code.google.com/p/modwsgi/wiki/IntegrationWithTrac
     93   - [http://modpython.org/ mod_python 3.3.1], deprecated: see TracModPython)
     94 * a [http://www.fastcgi.com/ FastCGI]-capable web server (see TracFastCgi)
     95 * an [http://tomcat.apache.org/connectors-doc/ajp/ajpv13a.html AJP]-capable web
     96   server (see [trac:TracOnWindowsIisAjp TracOnWindowsIisAjp])
     97 * a CGI-capable web server (see TracCgi), '''but usage of Trac as a cgi script
     98   is highly discouraged''', better use one of the previous options.
     99   
     100
     101==== Other Python Packages ====
     102
     103 * [http://babel.edgewall.org Babel], version >= 0.9.5,
     104   needed for localization support (unreleased version 1.0dev should work as well)
     105 * [http://docutils.sourceforge.net/ docutils], version >= 0.3.9
     106   for WikiRestructuredText.
     107 * [http://pygments.pocoo.org Pygments] for
     108   [wiki:TracSyntaxColoring syntax highlighting].
     109   [http://silvercity.sourceforge.net/ SilverCity] and/or
     110   [http://gnu.org/software/enscript/enscript.html Enscript] may still be used
     111   but are deprecated and you really should be using Pygments.
     112 * [http://pytz.sf.net pytz] to get a complete list of time zones,
     113   otherwise Trac will fall back on a shorter list from
     114   an internal time zone implementation.
     115
     116'''Attention''': The various available versions of these dependencies are not necessarily interchangable, so please pay attention to the version numbers above. If you are having trouble getting Trac to work please double-check all the dependencies before asking for help on the [trac:MailingList] or [trac:IrcChannel].
     117
     118Please refer to the documentation of these packages to find out how they are best installed. In addition, most of the [trac:TracInstallPlatforms platform-specific instructions] also describe the installation of the dependencies. Keep in mind however that the information there ''probably concern older versions of Trac than the one you're installing'' (there are even some pages that are still talking about Trac 0.8!).
     119
    84120
    85121== 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:
     122=== Using `easy_install`
     123One way to install Trac is using [http://pypi.python.org/pypi/setuptools setuptools].
     124With setuptools you can install Trac from the subversion repository;
     125
     126A few examples:
     127
     128 - install Trac 1.0:
     129   {{{
     130   easy_install Trac==1.0
     131   }}}
     132   (NOT YET ENABLED)
     133 - install latest development version 1.0dev:
     134   {{{
     135   easy_install Trac==dev
     136   }}}
     137   Note that in this case you won't have the possibility to run a localized version of Trac;
     138   either use a released version or install from source
     139
     140=== Using `pip`
     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{{{
     148pip -E /opt/user/trac install trac psycopg2
     149}}}
     150or
     151 -
     152{{{
     153pip -E /opt/user/trac 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.) and download the latest packages on 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 [http://pypi.python.org/pypi?:action=search&term=trac&submit=search here]) through pip.
     163
     164
     165
     166=== From source
     167Of course, using the python-typical setup at the top of the source directory also works.
     168
     169You can obtain the source for a .tar.gz or .zip file corresponding to a release (e.g. Trac-1.0.tar.gz), or you can get the source directly from the repository (see Trac:SubversionRepository for details).
     170
    95171{{{
    96172$ python ./setup.py install
    97173}}}
    98174
    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.
     175''You'll need root permissions or equivalent for this step.''
     176
     177This will byte-compile the python source code and install it as an .egg file or folder in the `site-packages` directory
     178of your Python installation. The .egg will also contain all other resources needed by standard Trac, such as htdocs and templates.
    104179
    105180The 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.
    106181
     182If you install from source and want to make Trac available in other languages, make sure  Babel is installed. Only then, perform the `install` (or simply redo the `install` once again afterwards if you realize Babel was not yet installed):
     183{{{
     184$ python ./setup.py install
     185}}}
     186Alternatively, you can do a `bdist_egg` and copy the .egg from dist/ to the place of your choice, or you can create a Windows installer (`bdist_wininst`).
     187
    107188=== Advanced Options ===
    108189
    … …  
    118199easy_install --prefix=/path/to/installdir
    119200}}}
     201or, if installing Trac to a Mac OS X system:
     202{{{
     203easy_install --prefix=/usr/local --install-dir=/Library/Python/2.5/site-packages
     204}}}
     205Note: If installing on Mac OS X 10.6 running {{{ easy_install http://svn.edgewall.org/repos/trac/trunk }}} will install into {{{ /usr/local }}} and {{{ /Library/Python/2.6/site-packages }}} by default
     206
     207The above will place your `tracd` and `trac-admin` commands into `/usr/local/bin` and will install the Trac libraries and dependencies into `/Library/Python/2.5/site-packages`, which is Apple's preferred location for third-party Python application installations.
     208
    120209
    121210== Creating a Project Environment ==
    122211
    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.
     212A [TracEnvironment Trac environment] is the backend storage where Trac stores information like wiki pages, tickets, reports, settings, etc. An environment is basically a directory that contains a human-readable [TracIni configuration file], and various other files and directories.
    124213
    125214A new environment is created using [wiki:TracAdmin trac-admin]:
    … …  
    128217}}}
    129218
    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 ==
     219[TracAdmin trac-admin] will prompt you for the information it needs to create the environment, such as the name of the project and the [TracEnvironment#DatabaseConnectionStrings database connection string]. If you're not sure what to specify for one of these options, just press `<Enter>` to use the default value.
     220
     221Using the default database connection string in particular will always work as long as you have SQLite installed.
     222For the other [DatabaseBackend database backends] you should plan ahead and already have a database ready to use at this point.
     223
     224Since 0.12, Trac doesn't ask for a [TracEnvironment#SourceCodeRepository source code repository] anymore when creating an environment. Repositories can be [TracRepositoryAdmin added] afterward, or the version control support can be disabled completely if you don't need it.
     225
     226Also note that the values you specify here can be changed later by directly editing the [TracIni conf/trac.ini] configuration file.
     227
     228Finally, make sure the user account under which the web front-end runs will have '''write permissions''' to the environment directory and all the files inside. This will be the case if you run `trac-admin ... initenv` as this user. If not, you should set the correct user afterwards. For example on Linux, with the web server running as user `apache` and group `apache`, enter:
     229{{{
     230# chown -R apache.apache /path/to/myproject
     231}}}
     232
     233{{{#!div class=important
     234'''Warning:''' Please only use ASCII-characters for account name and project path, unicode characters are not supported there.
     235}}}
     236
     237
     238== Deploying Trac
     239
     240=== Running the Standalone Server ===
    140241
    141242After having created a Trac environment, you can easily try the web interface by running the standalone server [wiki:TracStandalone tracd]:
    … …  
    144245}}}
    145246
    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.
     247Then, fire up a browser and visit `http://localhost:8000/`. You should get a simple listing of all environments that `tracd` knows about. Follow the link to the environment you just created, and you should see Trac in action. If you only plan on managing a single project with Trac you can have the standalone server skip the environment list by starting it like this:
     248{{{
     249$ tracd -s --port 8000 /path/to/myproject
     250}}}
     251
     252=== Running Trac on a Web Server ===
     253
     254Trac provides various options for connecting to a "real" web server:
     255 - [wiki:TracFastCgi FastCGI]
     256 - [wiki:TracModWSGI mod_wsgi]
     257 - //[wiki:TracModPython mod_python] (no longer recommended, as mod_python is not actively maintained anymore)//
     258 - //[wiki:TracCgi CGI] (should not be used, as the performance is far from optimal)//
     259
     260Trac also supports [trac:TracOnWindowsIisAjp AJP] which may be your choice if you want to connect to IIS. Other deployment scenarios are possible: [trac:TracNginxRecipe nginx], [http://projects.unbit.it/uwsgi/wiki/Example#Traconapacheinasub-uri uwsgi], [trac:TracOnWindowsIisIsapi Isapi-wsgi] etc.
     261
     262==== Generating the Trac cgi-bin directory ==== #cgi-bin
     263
     264In order for Trac to function properly with FastCGI you need to have a `trac.fcgi` file and for mod_wsgi a `trac.wsgi` file. These are Python scripts which load the appropriate Python code. They can be generated using the `deploy` option of [wiki:TracAdmin trac-admin].
     265
     266There is, however, a bit of a chicken-and-egg problem. The [wiki:TracAdmin trac-admin] command requires an existing environment to function, but complains if the deploy directory already exists. This is a problem, because environments are often stored in a subdirectory of the deploy. The solution is to do something like this:
     267{{{
     268mkdir -p /usr/share/trac/projects/my-project
     269trac-admin /usr/share/trac/projects/my-project initenv
     270trac-admin /usr/share/trac/projects/my-project deploy /tmp/deploy
     271mv /tmp/deploy/* /usr/share/trac
     272}}}
     273
     274
     275==== Mapping Static Resources ====
     276
     277Out of the box, Trac will pass static resources such as style sheets or images through itself. For anything but a tracd only based deployment, this is far from optimal as the web server could be set up to directly serve those static resources (for CGI setup, this is '''highly undesirable''' and will cause abysmal performance).
     278
     279Web servers such as [http://httpd.apache.org/ Apache] allow you to create “Aliases” to resources, giving them a virtual URL that doesn't necessarily reflect the layout of the servers file system. We also can map requests for static resources directly to the directory on the file system, avoiding processing these requests by Trac itself.
     280
     281There are two primary URL paths for static resources - `/chrome/common` and `/chrome/site`. Plugins can add their own resources, usually accessible by `/chrome/<plugin>` path, so its important to override only known paths and not try to make universal `/chrome` alias for everything.
     282
     283Note 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:
     284[[TracAdminHelp(deploy)]]
     285
     286The target `<directory>` will then contain an `htdocs` directory with:
     287 - `site/` - a copy of the environment's directory `htdocs/`
     288 - `common/` - the static resources of Trac itself
     289 - `<plugins>/` - one directory for each resource directory managed by the plugins enabled for this environment
     290
     291===== Example: Apache and `ScriptAlias` ===== #ScriptAlias-example
     292
     293Assuming the deployment has been done this way:
     294{{{
     295$ trac-admin /var/trac/env deploy /path/to/trac/htdocs/common
     296}}}
     297
     298Add the following snippet to Apache configuration ''before'' the `ScriptAlias` or `WSGIScriptAlias` (which map all the other requests to the Trac application), changing paths to match your deployment:
     299{{{
     300Alias /trac/chrome/common /path/to/trac/htdocs/common
     301Alias /trac/chrome/site /path/to/trac/htdocs/site
     302
     303<Directory "/path/to/www/trac/htdocs">
     304  Order allow,deny
     305  Allow from all
     306</Directory>
     307}}}
     308
     309If using mod_python, you might want to add this too (otherwise, the alias will be ignored):
     310{{{
     311<Location "/trac/chrome/common/">
     312  SetHandler None
     313</Location>
     314}}}
     315
     316Note that we mapped `/trac` part of the URL to the `trac.*cgi` script, and the path `/trac/chrome/common` is the path you have to append to that location to intercept requests to the static resources.
     317
     318Similarly, if you have static resources in a project's `htdocs` directory (which is referenced by `/trac/chrome/site` URL in themes), you can configure Apache to serve those resources (again, put this ''before'' the `ScriptAlias` or `WSGIScriptAlias` for the .*cgi scripts, and adjust names and locations to match your installation):
     319{{{
     320Alias /trac/chrome/site /path/to/projectenv/htdocs
     321
     322<Directory "/path/to/projectenv/htdocs">
     323  Order allow,deny
     324  Allow from all
     325</Directory>
     326}}}
     327
     328Alternatively to aliasing `/trac/chrome/common`, you can tell Trac to generate direct links for those static resources (and only those), using the [[wiki:TracIni#trac-section| [trac] htdocs_location]] configuration setting:
     329{{{
     330[trac]
     331htdocs_location = http://static.example.org/trac-common/
     332}}}
     333Note 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]).
     334
     335Of course, you still need to make the Trac `htdocs/common` directory available through the web server at the specified URL, for example by copying (or linking) the directory into the document root of the web server:
     336{{{
     337$ ln -s /path/to/trac/htdocs/common /var/www/static.example.org/trac-common
     338}}}
     339
     340
     341==== Setting up the Plugin Cache ====
     342
     343Some 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.
    154344
    155345== Configuring Authentication ==
    156346
    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.
     347Trac 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.
     348
     349The process of adding, removing, and configuring user accounts for authentication depends on the specific way you run Trac.
     350
     351Please refer to one of the following sections:
     352 * TracStandalone#UsingAuthentication if you use the standalone server, `tracd`.
     353 * [wiki:TracModWSGI#ConfiguringAuthentication TracModWSGI#ConfiguringAuthentication] if you use the Apache web server, with any of its front end: `mod_wsgi` of course, but the same instructions applies also for `mod_python`, `mod_fcgi` or `mod_fastcgi`.
     354 * TracFastCgi if you're using another web server with FCGI support (Cherokee, Lighttpd, !LiteSpeed, nginx)
     355
     356== Granting admin rights to the admin user
     357Grant admin rights to user admin:
     358{{{
     359$ trac-admin /path/to/myproject permission add admin TRAC_ADMIN
     360}}}
     361This user will have an "Admin" entry menu that will allow you to admin your trac project.
     362
     363== Finishing the install
     364
     365=== Automatic reference to the SVN changesets in Trac tickets ===
     366
     367You can configure SVN to automatically add a reference to the changeset into the ticket comments, whenever changes are committed to the repository. The description of the commit needs to contain one of the following formulas:
     368 * '''`Refs #123`''' - to reference this changeset in `#123` ticket
     369 * '''`Fixes #123`''' - to reference this changeset and close `#123` ticket with the default status ''fixed''
     370
     371This functionality requires a post-commit hook to be installed as described in [wiki:TracRepositoryAdmin#ExplicitSync TracRepositoryAdmin], and enabling the optional commit updater components by adding the following line to the `[components]` section of your [wiki:TracIni#components-section trac.ini], or enabling the components in the "Plugins" admin panel.
     372{{{
     373tracopt.ticket.commit_updater.* = enabled
     374}}}
     375For more information, see the documentation of the `CommitTicketUpdater` component in the "Plugins" admin panel.
     376
     377=== Using Trac ===
     378
     379Once 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.
     380
     381Keep in mind that //anonymous// (not logged in) users can by default access only a few of the features, in particular they will have a read-only access to the resources. You will need to configure authentication and grant additional [wiki:TracPermissions permissions] to authenticated users to see the full set of features.
    168382
    169383'' Enjoy! ''
    170384
    171 [wiki:TracTeam The Trac Team]
     385[trac:TracTeam The Trac Team]
    172386
    173387----
    174 See also:  TracGuide, TracCgi, TracFastCgi, TracModPython, [wiki:TracModWSGI], TracUpgrade, TracPermissions
     388See also: [trac:TracInstallPlatforms TracInstallPlatforms], TracGuide, TracUpgrade, TracPermissions