Changes between Version 2 and Version 3 of TracInstall
- Timestamp:
- 2015-05-25T08:23:07-07:00 (10 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracInstall
v2 v3 1 = Trac Installation Guide for 0.12 = 1 {{{#!div style="margin-top: .5em; padding: 0 1em; background-color: #ffd; border:1px outset #ddc; text-align: center" 2 3 '''NOTE: the information in this page applies to Trac 1.0, the current version of Trac. \\ 4 For installing previous Trac versions, please refer to [[wiki:0.12/TracInstall]] (for Trac 0.12)''' 5 }}} 6 7 = Trac Installation Guide for 1.0 2 8 [[TracGuideToc]] 3 9 4 10 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. 5 11 6 Since version 0.12, Trac can also be localized, and there's probably a translation available for your language. If you want to be able to use the Trac interface in other languages, then make sure you **first** have installed the optional package [#OtherPythonPackages Babel]. Lacking Babel, you will only get the default english version, as usual. If you install Babel later on, you will need to re-install Trac.12 Since version 0.12, Trac can also be localized, and there's probably a translation available for your language. If you want to be able to use the Trac interface in other languages, then make sure you 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 13 8 14 If you're interested in contributing new translations for other languages or enhance the existing translations, then please have a look at [trac:wiki:TracL10N TracL10N]. 9 15 10 What follows are generic instructions for installing and setting up Trac and its requirements. While you may find instructions for installing Trac on specific systems at TracInstallPlatformson the main Trac site, please be sure to '''first read through these general instructions''' to get a good understanding of the tasks involved.16 What follows are generic instructions for installing and setting up Trac and its requirements. While you may find instructions for installing Trac on specific systems at [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 17 12 18 [[PageOutline(2-3,Installation Steps,inline)]] 13 19 14 == Dependencies ==20 == Dependencies 15 21 === Mandatory Dependencies 16 22 To install Trac, the following software packages must be installed: 17 23 18 * [http://www.python.org/ Python], version >= 2. 4and < 3.019 (note that we dropped the support for Python 2. 3in this release)24 * [http://www.python.org/ Python], version >= 2.5 and < 3.0 25 (note that we dropped the support for Python 2.4 in this release) 20 26 * [http://peak.telecommunity.com/DevCenter/setuptools setuptools], version >= 0.6 21 27 * [http://genshi.edgewall.org/wiki/Download Genshi], version >= 0.6 … … 26 32 ==== For the SQLite database #ForSQLite 27 33 28 If you're using Python 2.5 or 2.6, you already have everything you need. 29 30 If you're using Python 2.4 and need pysqlite, you can download from 31 [http://code.google.com/p/pysqlite/downloads/list google code] the Windows installers or the tar.gz archive for building from source: 32 {{{ 34 As 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). 35 36 However, if you'd like, you can download the latest and greatest version of [[trac:PySqlite]] from 37 [http://code.google.com/p/pysqlite/downloads/list google code], where you'll find the Windows 38 installers or the `tar.gz` archive for building from source: 39 {{{#!sh 33 40 $ tar xvfz <version>.tar.gz 34 41 $ cd <version> … … 36 43 }}} 37 44 38 This will extract the SQLite code and build the bindings. 39 40 To install SQLite, your system may require the development headers. Without these you will get various GCC related errors when attempting to build: 41 42 {{{ 43 $ apt-get install libsqlite3-dev 44 }}} 45 46 SQLite 2.x is no longer supported, and neither is !PySqlite 1.1.x. 47 48 A known bug !PySqlite versions 2.5.2-4 prohibits upgrade of trac databases 45 This will download the latest SQLite code and build the bindings. 46 47 SQLite 2.x is no longer supported. 48 49 A known bug in PySqlite versions 2.5.2-4 prohibits upgrades of Trac databases 49 50 from 0.11.x to 0.12. Please use versions 2.5.5 and newer or 2.5.1 and 50 older. See [trac:#9434]for more detail.51 52 See additional information in [trac:PySqlite ].51 older. See #9434 for more detail. 52 53 See additional information in [trac:PySqlite PySqlite]. 53 54 54 55 ==== For the PostgreSQL database #ForPostgreSQL … … 56 57 You need to install the database and its Python bindings: 57 58 * [http://www.postgresql.org/ PostgreSQL], version 8.0 or later 58 * [http://pypi.python.org/pypi/psycopg2 psycopg2] 59 * [http://pypi.python.org/pypi/psycopg2 psycopg2], version 2.0 or later 59 60 60 61 See [trac:DatabaseBackend#Postgresql DatabaseBackend] for details. … … 72 73 === Optional Dependencies 73 74 74 ==== Version Control System ====75 76 ===== Subversion =====77 * [http://subversion.apache.org/ Subversion], 1.5.x or 1.6.x and the '''''corresponding''''' Python bindings. Older versions starting from 1. 4.0, etc. should still work. For troubleshooting information, check the [trac:TracSubversion#Troubleshooting TracSubversion] page. Versions prior to 1.4.0 won't probably work since trac uses svn core functionality (e.g. svn_path_canonicalize) that is not implemented in the python swig wrapper in svn <= 1.3.x (although it exists in the svn lib itself).75 ==== Version Control System 76 77 ===== Subversion 78 * [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. 78 79 79 80 There are [http://subversion.apache.org/packages.html pre-compiled SWIG bindings] available for various platforms. (Good luck finding precompiled SWIG bindings for any Windows package at that listing. TracSubversion points you to [http://alagazam.net Algazam], which works for me under Python 2.6.) 80 81 81 Note that Trac '''doesn't''' use [http://pysvn.tigris.org/ PySVN], neither does it work yet with the newer `ctype`-style bindings. [Is there a ticket for implementing ctype bindings?]82 Note that Trac '''doesn't''' use [http://pysvn.tigris.org/ PySVN], neither does it work yet with the newer `ctype`-style bindings. 82 83 83 84 … … 85 86 86 87 87 ===== Others =====88 89 Support for other version control systems is provided via third-parties. See [trac:PluginList] and [trac:Version ingSystemBackend].90 91 ==== Web Server ====92 A web server is optional because Trac is shipped with a server included, see the [#RunningtheStandaloneServer Running the Standalone Server 93 94 Alternatively you c onfigure Trac to run in any of the following environments.88 ===== Others 89 90 Support for other version control systems is provided via third-parties. See [trac:PluginList] and [trac:VersionControlSystem]. 91 92 ==== Web Server 93 A web server is optional because Trac is shipped with a server included, see the [#RunningtheStandaloneServer Running the Standalone Server] section below. 94 95 Alternatively you can configure Trac to run in any of the following environments. 95 96 * [http://httpd.apache.org/ Apache] with 96 97 - [http://code.google.com/p/modwsgi/ mod_wsgi], see [wiki:TracModWSGI] and 97 98 http://code.google.com/p/modwsgi/wiki/IntegrationWithTrac 98 - [http://modpython.org/ mod_python 3.3.1], deprecated: see TracModPython)99 - [http://modpython.org/ mod_python 3.3.1], (deprecated: see TracModPython) 99 100 * a [http://www.fastcgi.com/ FastCGI]-capable web server (see TracFastCgi) 100 101 * an [http://tomcat.apache.org/connectors-doc/ajp/ajpv13a.html AJP]-capable web 101 server (see [trac:TracOnWindowsIisAjp ])102 server (see [trac:TracOnWindowsIisAjp TracOnWindowsIisAjp]) 102 103 * a CGI-capable web server (see TracCgi), '''but usage of Trac as a cgi script 103 104 is highly discouraged''', better use one of the previous options. 104 105 105 106 106 ==== Other Python Packages ====107 ==== Other Python Packages 107 108 108 109 * [http://babel.edgewall.org Babel], version >= 0.9.5, 109 needed for localization support[[BR]] 110 ''Note: '' If you want to be able to use the Trac interface in other languages, then make sure you first have installed the optional package Babel. Lacking Babel, you will only get the default english version, as usual. If you install Babel later on, you will need to re-install Trac. 110 needed for localization support (unreleased version 1.0dev should work as well) 111 111 * [http://docutils.sourceforge.net/ docutils], version >= 0.3.9 112 112 for WikiRestructuredText. 113 * [http://pygments. pocoo.org Pygments] for113 * [http://pygments.org Pygments] for 114 114 [wiki:TracSyntaxColoring syntax highlighting]. 115 115 [http://silvercity.sourceforge.net/ SilverCity] and/or … … 120 120 an internal time zone implementation. 121 121 122 '''Attention''': The various available versions of these dependencies are not necessarily interchang able, 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].122 '''Attention''': The various available versions of these dependencies are not necessarily interchangeable, so please pay attention to the version numbers above. If you are having trouble getting Trac to work please double-check all the dependencies before asking for help on the [trac:MailingList] or [trac:IrcChannel]. 123 123 124 124 Please refer to the documentation of these packages to find out how they are best installed. In addition, most of the [trac:TracInstallPlatforms platform-specific instructions] also describe the installation of the dependencies. Keep in mind however that the information there ''probably concern older versions of Trac than the one you're installing'' (there are even some pages that are still talking about Trac 0.8!). 125 125 126 126 127 == Installing Trac ==127 == Installing Trac 128 128 === Using `easy_install` 129 129 One way to install Trac is using [http://pypi.python.org/pypi/setuptools setuptools]. 130 With setuptools you can install Trac from the subversion repository;130 With setuptools you can install Trac from the Subversion repository; 131 131 132 132 A few examples: 133 133 134 - first install of the latest stable version Trac 0.12.1, with i18n support: 135 {{{ 136 easy_install Babel==0.9.5 Genshi==0.6 137 easy_install Trac 134 - Install Trac 1.0: 135 {{{#!sh 136 easy_install Trac==1.0 138 137 }}} 139 ''It's very important to run the two `easy_install` commands separately, otherwise the message catalogs won't be generated.'' 140 141 - upgrade to the latest stable version of Trac: 142 {{{ 143 easy_install -U Trac 138 - Install latest development version: 139 {{{#!sh 140 easy_install Trac==dev 144 141 }}} 145 146 - upgrade to the latest trunk development version (0.13dev): 147 {{{ 148 easy_install -U Trac==dev 149 }}} 150 151 For upgrades, reading the TracUpgrade page is mandatory, of course. 152 153 === From source 154 If you want more control, you can download the source in archive form, or do a checkout from one of the official [[Trac:TracRepositories|source code repositories]]. 155 156 Be sure to have the prerequisites already installed. You can also obtain the Genshi and Babel source packages from http://www.edgewall.org and follow for them a similar installation procedure, or you can just easy_install those, see [#Usingeasy_install above]. 157 158 Once you've unpacked the Trac archive or performed the checkout, move in the top-level folder and do: 159 {{{ 160 $ python ./setup.py install 161 }}} 162 163 ''You'll need root permissions or equivalent for this step.'' 164 165 This will byte-compile the python source code and install it as an .egg file or folder in the `site-packages` directory 166 of your Python installation. The .egg will also contain all other resources needed by standard Trac, such as htdocs and templates. 167 168 The script will also install the [wiki:TracAdmin trac-admin] command-line tool, used to create and maintain [wiki:TracEnvironment project environments], as well as the [wiki:TracStandalone tracd] standalone server. 169 170 If you install from source and want to make Trac available in other languages, make sure Babel is installed. Only then, perform the `install` (or simply redo the `install` once again afterwards if you realize Babel was not yet installed): 171 {{{ 172 $ python ./setup.py install 173 }}} 174 Alternatively, you can do a `bdist_egg` and copy the .egg from dist/ to the place of your choice, or you can create a Windows installer (`bdist_wininst`). 175 176 === Advanced Options === 177 178 To install Trac to a custom location, or find out about other advanced installation options, run: 179 {{{ 180 easy_install --help 181 }}} 182 183 Also see [http://docs.python.org/inst/inst.html Installing Python Modules] for detailed information. 184 185 Specifically, you might be interested in: 186 {{{ 187 easy_install --prefix=/path/to/installdir 188 }}} 189 or, if installing Trac to a Mac OS X system: 190 {{{ 191 easy_install --prefix=/usr/local --install-dir=/Library/Python/2.5/site-packages 192 }}} 193 Note: If installing on Mac OS X 10.6 running {{{ easy_install http://svn.edgewall.org/repos/trac/trunk }}} will install into {{{ /usr/local }}} and {{{ /Library/Python/2.6/site-packages }}} by default 194 195 The 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. 142 Note that in this case you won't have the possibility to run a localized version of Trac; 143 either use a released version or install from source 144 145 {{{#!div style="border: 1pt dotted; margin: 1em" 146 **Setuptools Warning:** If the version of your setuptools is in the range 5.4 through 5.6, the environment variable `PKG_RESOURCES_CACHE_ZIP_MANIFESTS` must be set in order to avoid significant performance degradation. More information may be found in the sections on [#RunningtheStandaloneServer Running The Standalone Server] and [#RunningTraconaWebServer Running Trac on a Web Server]. 147 }}} 196 148 197 149 === Using `pip` 198 150 'pip' is an easy_install replacement that is very useful to quickly install python packages. 199 To get a trac installation up and running in less than 5 minutes:200 201 Assuming you want to have your entire pip installation in /opt/user/trac:151 To get a Trac installation up and running in less than 5 minutes: 152 153 Assuming you want to have your entire pip installation in `/opt/user/trac` 202 154 203 155 - 204 {{{ 205 pip -E /opt/user/tracinstall trac psycopg2156 {{{#!sh 157 pip install trac psycopg2 206 158 }}} 207 159 or 208 160 - 209 {{{ 210 pip -E /opt/user/trac install trac mysql-python 211 }}} 212 213 Make sure your OS specific headers are available for pip to automatically build PostgreSQL (libpq-dev) or MySQL (libmysqlclient-dev) bindings. 214 215 pip will automatically resolve all dependencies (like Genshi, pygments, etc.) and download the latest packages on pypi.python.org and create a self contained installation in /opt/user/trac . 216 217 All commands (tracd, trac-admin) are available in /opt/user/trac/bin. This can also be leveraged for mod_python (using !PythonHandler directive) and mod_wsgi (using WSGIDaemonProcess directive) 218 219 Additionally, you can install several trac plugins (listed [http://pypi.python.org/pypi?:action=search&term=trac&submit=search here]) through pip. 220 221 222 223 == Creating a Project Environment == 161 {{{#!sh 162 pip install trac mysql-python 163 }}} 164 165 Make sure your OS specific headers are available for pip to automatically build PostgreSQL (`libpq-dev`) or MySQL (`libmysqlclient-dev`) bindings. 166 167 pip will automatically resolve all dependencies (like Genshi, pygments, etc.) and download the latest packages on pypi.python.org and create a self contained installation in `/opt/user/trac`. 168 169 All commands (`tracd`, `trac-admin`) are available in `/opt/user/trac/bin`. This can also be leveraged for `mod_python` (using `PythonHandler` directive) and `mod_wsgi` (using `WSGIDaemonProcess` directive) 170 171 Additionally, you can install several Trac plugins (listed [http://pypi.python.org/pypi?:action=search&term=trac&submit=search here]) through pip. 172 173 174 175 === From source 176 Of course, using the python-typical setup at the top of the source directory also works. 177 178 You 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). 179 180 {{{#!sh 181 $ python ./setup.py install 182 }}} 183 184 ''You'll need root permissions or equivalent for this step.'' 185 186 This will byte-compile the Python source code and install it as an .egg file or folder in the `site-packages` directory 187 of your Python installation. The .egg will also contain all other resources needed by standard Trac, such as `htdocs` and `templates`. 188 189 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. 190 191 If you install from source and want to make Trac available in other languages, make sure Babel is installed. Only then, perform the `install` (or simply redo the `install` once again afterwards if you realize Babel was not yet installed): 192 {{{#!sh 193 $ python ./setup.py install 194 }}} 195 Alternatively, 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`). 196 197 === Advanced Options 198 199 To install Trac to a custom location, or find out about other advanced installation options, run: 200 {{{#!sh 201 easy_install --help 202 }}} 203 204 Also see [http://docs.python.org/2/install/index.html Installing Python Modules] for detailed information. 205 206 Specifically, you might be interested in: 207 {{{#!sh 208 easy_install --prefix=/path/to/installdir 209 }}} 210 or, if installing Trac on a Mac OS X system: 211 {{{#!sh 212 easy_install --prefix=/usr/local --install-dir=/Library/Python/2.5/site-packages 213 }}} 214 Note: If installing on Mac OS X 10.6 running {{{ easy_install http://svn.edgewall.org/repos/trac/trunk }}} will install into {{{ /usr/local }}} and {{{ /Library/Python/2.6/site-packages }}} by default. 215 216 The 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. 217 218 219 == Creating a Project Environment 224 220 225 221 A [TracEnvironment Trac environment] is the backend storage where Trac stores information like wiki pages, tickets, reports, settings, etc. An environment is basically a directory that contains a human-readable [TracIni configuration file], and various other files and directories. 226 222 227 223 A new environment is created using [wiki:TracAdmin trac-admin]: 228 {{{ 224 {{{#!sh 229 225 $ trac-admin /path/to/myproject initenv 230 226 }}} … … 235 231 For the other [DatabaseBackend database backends] you should plan ahead and already have a database ready to use at this point. 236 232 237 Since 0.12, Trac doesn't ask for a [TracEnvironment#SourceCodeRepository source code repository] anymore when creating an environment. Repositories can be [TracRepositoryAdmin added] afterward , or the version control support can be disabled completely if you don't need it.233 Since 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. 238 234 239 235 Also note that the values you specify here can be changed later by directly editing the [TracIni conf/trac.ini] configuration file. 240 236 237 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), 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 (though the best advice is to opt for a platform with sub-second timestamp resolution when possible regardless of the version of Trac you are running). 238 241 239 Finally, make sure the user account under which the web front-end runs will have '''write permissions''' to the environment directory and all the files inside. This will be the case if you run `trac-admin ... initenv` as this user. If not, you should set the correct user afterwards. For example on Linux, with the web server running as user `apache` and group `apache`, enter: 242 {{{ 243 # chown -R apache.apache /path/to/myproject 244 }}} 240 {{{#!sh 241 $ chown -R apache.apache /path/to/myproject 242 }}} 243 244 The 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). 245 245 246 246 {{{#!div class=important … … 249 249 250 250 251 == Running the Standalone Server == 251 == Deploying Trac 252 253 === Running the Standalone Server 252 254 253 255 After having created a Trac environment, you can easily try the web interface by running the standalone server [wiki:TracStandalone tracd]: 254 {{{ 256 {{{#!sh 255 257 $ tracd --port 8000 /path/to/myproject 256 258 }}} 257 259 258 260 Then, fire up a browser and visit `http://localhost:8000/`. You should get a simple listing of all environments that `tracd` knows about. Follow the link to the environment you just created, and you should see Trac in action. If you only plan on managing a single project with Trac you can have the standalone server skip the environment list by starting it like this: 259 {{{ 261 {{{#!sh 260 262 $ tracd -s --port 8000 /path/to/myproject 261 263 }}} 262 264 263 == Running Trac on a Web Server == 264 265 Trac provides various options for connecting to a "real" web server: [wiki:TracCgi CGI], [wiki:TracFastCgi FastCGI], [wiki:TracModWSGI mod_wsgi] and [wiki:TracModPython mod_python]. For decent performance, it is recommended that you use either FastCGI or mod_wsgi. 266 267 Trac also supports [trac:TracOnWindowsIisAjp AJP] which may be your choice if you want to connect to IIS. 268 269 ==== Generating the Trac cgi-bin directory ==== 265 {{{#!div style="border: 1pt dotted; margin: 1em" 266 **Setuptools Warning:** If the version of your setuptools is in the range 5.4 through 5.6, the environment variable `PKG_RESOURCES_CACHE_ZIP_MANIFESTS` must be set in order to avoid significant performance degradation. The environment variable can be set system-wide, or for just the user that runs the `tracd` process. There are several ways to accomplish this in addition to what is discussed here, and depending on the distribution of your OS. 267 268 To 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`. 269 {{{#!sh 270 export PKG_RESOURCES_CACHE_ZIP_MANIFESTS=1 271 }}} 272 273 Alternatively, the variable can be set in the shell before executing `tracd`: 274 {{{#!sh 275 $ PKG_RESOURCES_CACHE_ZIP_MANIFESTS=1 tracd --port 8000 /path/to/myproject 276 }}} 277 }}} 278 279 === Running Trac on a Web Server 280 281 Trac provides various options for connecting to a "real" web server: 282 - [wiki:TracFastCgi FastCGI] 283 - [wiki:TracModWSGI mod_wsgi] 284 - //[wiki:TracModPython mod_python] (no longer recommended, as mod_python is not actively maintained anymore)// 285 - //[wiki:TracCgi CGI] (should not be used, as the performance is far from optimal)// 286 287 Trac 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. 288 289 ==== Generating the Trac cgi-bin directory #cgi-bin 270 290 271 291 In order for Trac to function properly with FastCGI you need to have a `trac.fcgi` file and for mod_wsgi a `trac.wsgi` file. These are Python scripts which load the appropriate Python code. They can be generated using the `deploy` option of [wiki:TracAdmin trac-admin]. 272 292 273 293 There is, however, a bit of a chicken-and-egg problem. The [wiki:TracAdmin trac-admin] command requires an existing environment to function, but complains if the deploy directory already exists. This is a problem, because environments are often stored in a subdirectory of the deploy. The solution is to do something like this: 274 {{{ 294 {{{#!sh 275 295 mkdir -p /usr/share/trac/projects/my-project 276 296 trac-admin /usr/share/trac/projects/my-project initenv … … 278 298 mv /tmp/deploy/* /usr/share/trac 279 299 }}} 280 281 ==== Setting up the Plugin Cache ==== 282 283 Some Python plugins need to be extracted to a cache directory. By default the cache resides in the home directory of the current user. When running Trac on a Web Server as a dedicated user (which is highly recommended) who has no home directory, this might prevent the plugins from starting. To override the cache location you can set the PYTHON_EGG_CACHE environment variable. Refer to your server documentation for detailed instructions on how to set environment variables. 284 285 == Configuring Authentication == 286 287 The process of adding, removing, and configuring user accounts for authentication depends on the specific way you run Trac. The basic procedure is described in the [wiki:TracCgi#AddingAuthentication "Adding Authentication"] section on the TracCgi page. To learn how to setup authentication for the frontend you're using, please refer to one of the following pages: 288 289 * TracStandalone if you use the standalone server, `tracd`. 290 * TracCgi if you use the CGI or FastCGI web front ends. 291 * [wiki:TracModWSGI] if you use the Apache mod_wsgi web front end. 292 * TracModPython if you use the Apache mod_python web front end. 293 294 295 == Automatic reference to the SVN changesets in Trac tickets == 300 Don't forget to check that the web server has the execution right on scripts in the `/usr/share/trac/cgi-bin` directory. 301 302 303 ==== Mapping Static Resources 304 305 Out 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). 306 307 Web 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. 308 309 There 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. 310 311 Note 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: 312 [[TracAdminHelp(deploy)]] 313 314 The target `<directory>` will then contain an `htdocs` directory with: 315 - `site/` - a copy of the environment's directory `htdocs/` 316 - `common/` - the static resources of Trac itself 317 - `<plugins>/` - one directory for each resource directory managed by the plugins enabled for this environment 318 319 ===== Example: Apache and `ScriptAlias` #ScriptAlias-example 320 321 Assuming the deployment has been done this way: 322 {{{#!sh 323 $ trac-admin /var/trac/env deploy /path/to/trac/htdocs/common 324 }}} 325 326 Add 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: 327 {{{#!apache 328 Alias /trac/chrome/common /path/to/trac/htdocs/common 329 Alias /trac/chrome/site /path/to/trac/htdocs/site 330 331 <Directory "/path/to/www/trac/htdocs"> 332 Order allow,deny 333 Allow from all 334 </Directory> 335 }}} 336 337 If using mod_python, you might want to add this too (otherwise, the alias will be ignored): 338 {{{#!apache 339 <Location "/trac/chrome/common/"> 340 SetHandler None 341 </Location> 342 }}} 343 344 Note 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. 345 346 Similarly, 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): 347 {{{#!apache 348 Alias /trac/chrome/site /path/to/projectenv/htdocs 349 350 <Directory "/path/to/projectenv/htdocs"> 351 Order allow,deny 352 Allow from all 353 </Directory> 354 }}} 355 356 Alternatively 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: 357 {{{#!ini 358 [trac] 359 htdocs_location = http://static.example.org/trac-common/ 360 }}} 361 Note 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]). 362 363 Of 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: 364 {{{#!sh 365 $ ln -s /path/to/trac/htdocs/common /var/www/static.example.org/trac-common 366 }}} 367 368 369 ==== Setting up the Plugin Cache 370 371 Some Python plugins need to be extracted to a cache directory. By default the cache resides in the home directory of the current user. When running Trac on a Web Server as a dedicated user (which is highly recommended) who has no home directory, this might prevent the plugins from starting. To override the cache location you can set the `PYTHON_EGG_CACHE` environment variable. Refer to your server documentation for detailed instructions on how to set environment variables. 372 373 == Configuring Authentication 374 375 Trac 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. 376 377 The process of adding, removing, and configuring user accounts for authentication depends on the specific way you run Trac. 378 379 Please refer to one of the following sections: 380 * TracStandalone#UsingAuthentication if you use the standalone server, `tracd`. 381 * [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`. 382 * TracFastCgi if you're using another web server with FCGI support (Cherokee, Lighttpd, !LiteSpeed, nginx) 383 384 The following document also constains some useful information for beginners: [trac:TracAuthenticationIntroduction]. 385 386 == Granting admin rights to the admin user 387 Grant admin rights to user admin: 388 {{{#!sh 389 $ trac-admin /path/to/myproject permission add admin TRAC_ADMIN 390 }}} 391 This user will have an "Admin" entry menu that will allow you to administrate your Trac project. 392 393 == Finishing the install 394 395 === Enable version control components 396 397 Support 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. 398 399 The components can be 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. 400 401 {{{#!ini 402 tracopt.versioncontrol.svn.* = enabled 403 }}} 404 405 {{{#!ini 406 tracopt.versioncontrol.git.* = enabled 407 }}} 408 409 After enabling the components, repositories can be configured through the "Repositories" admin panel or by editing [TracIni#repositories-section trac.ini]. 410 411 === Automatic reference to the SVN changesets in Trac tickets 296 412 297 413 You can configure SVN to automatically add a reference to the changeset into the ticket comments, whenever changes are committed to the repository. The description of the commit needs to contain one of the following formulas: … … 300 416 301 417 This functionality requires a post-commit hook to be installed as described in [wiki:TracRepositoryAdmin#ExplicitSync TracRepositoryAdmin], and enabling the optional commit updater components by adding the following line to the `[components]` section of your [wiki:TracIni#components-section trac.ini], or enabling the components in the "Plugins" admin panel. 302 {{{ 418 {{{#!ini 303 419 tracopt.ticket.commit_updater.* = enabled 304 420 }}} 305 421 For more information, see the documentation of the `CommitTicketUpdater` component in the "Plugins" admin panel. 306 422 307 == Using Trac ==423 === Using Trac 308 424 309 425 Once 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. 310 426 311 Keep in mind that anonymous (not logged in) users can by default access most but not all of the features. You will need to configure authentication and grant additional [wiki:TracPermissions permissions] to authenticated users to see the full set of features.427 Keep 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. 312 428 313 429 '' Enjoy! '' … … 316 432 317 433 ---- 318 See also: [trac:TracInstallPlatforms TracInstallPlatforms], TracGuide, Trac Cgi, TracFastCgi, TracModPython, [wiki:TracModWSGI], TracUpgrade, TracPermissions434 See also: [trac:TracInstallPlatforms TracInstallPlatforms], TracGuide, TracUpgrade, TracPermissions