Changes between Version 1 and Version 2 of TracInstall
- Timestamp:
- Jan 13, 2020, 10:28:03 PM (4 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracInstall
v1 v2 1 = Trac Installation Guide for 1.0 2 1 = Trac Installation Guide for 1.2 3 2 [[TracGuideToc]] 4 3 5 4 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. 6 5 7 Since version 0.12,Trac can also be localized, and there is probably a translation available in your language. If you want to use the Trac interface in other languages, then make sure you have installed the optional package [#OtherPythonPackages Babel]. Pay attention to the extra steps for localization support in the [#InstallingTrac Installing Trac] section below. Lacking Babel, you will only get the default English version.6 Trac can also be localized, and there is probably a translation available in your language. If you want to use the Trac interface in other languages, then make sure you have installed the optional package [#OtherPythonPackages Babel]. Pay attention to the extra steps for localization support in the [#InstallingTrac Installing Trac] section below. Lacking Babel, you will only get the default English version. 8 7 9 8 If you're interested in contributing new translations for other languages or enhancing the existing translations, then please have a look at [trac:wiki:TracL10N TracL10N]. 10 9 11 What follows are generic instructions for installing and setting up Trac. While you may find instructions for installing Trac on specific systems at [trac:TracInstallPlatforms TracInstallPlatforms] on the main Trac site, please '''first read through these general instructions''' to get a good understanding of the tasks involved.10 What follows are generic instructions for installing and setting up Trac. While you may find instructions for installing Trac on specific systems at [trac:TracInstallPlatforms TracInstallPlatforms], please '''first read through these general instructions''' to get a good understanding of the tasks involved. 12 11 13 12 [[PageOutline(2-3,Installation Steps,inline)]] 14 13 15 14 == Dependencies 16 17 15 === Mandatory Dependencies 18 19 16 To install Trac, the following software packages must be installed: 20 17 21 * [http://www.python.org/ Python], version >= 2. 5and < 3.022 (note that we dropped the support for Python 2. 4in this release)18 * [http://www.python.org/ Python], version >= 2.6 and < 3.0 19 (note that we dropped the support for Python 2.5 in this release) 23 20 * [http://pypi.python.org/pypi/setuptools setuptools], version >= 0.6 24 21 * [http://genshi.edgewall.org/wiki/Download Genshi], version >= 0.6 … … 28 25 ==== For the SQLite database #ForSQLite 29 26 30 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.27 As you must be using Python 2.6 or 2.7, you already have the SQLite database bindings bundled with the standard distribution of Python (the `sqlite3` module). 31 28 32 29 Optionally, you may install a newer version of [http://pypi.python.org/pypi/pysqlite pysqlite] than the one provided by the Python distribution. See [trac:PySqlite#ThePysqlite2bindings PySqlite] for details. … … 44 41 Trac works well with MySQL, provided you follow the guidelines: 45 42 46 * [http://mysql.com/ MySQL] or [http://mariadb.org/ MariaDB], version 5.0 or later43 * [http://mysql.com/ MySQL], version 5.0 or later 47 44 * [http://sf.net/projects/mysql-python MySQLdb], version 1.2.2 or later 48 45 49 Given the caveats and known issues surrounding MySQL, read the [trac:MySqlDb] page before creating the database.46 Given the caveats and known issues surrounding MySQL, read carefully the [trac:MySqlDb] page before creating the database. 50 47 51 48 === Optional Dependencies 52 49 53 ==== Version Control System 54 55 ===== Subversion 56 * [http://subversion.apache.org/ Subversion], 1.5.x or later and the '''corresponding''' Python bindings. Older versions starting from 1.0, like 1.2.4, 1.3.2 or 1.4.2, etc. may still work. For troubleshooting information, check the [trac:TracSubversion#Troubleshooting TracSubversion] page. 50 ==== Subversion 51 52 [http://subversion.apache.org/ Subversion], 1.6.x or later and the '''''corresponding''''' Python bindings. 57 53 58 54 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. [trac:TracSubversion] points you to [http://alagazam.net Alagazam], which works for me under Python 2.6.) 59 55 60 Note that Trac '''doesn't''' use [http://pysvn.tigris.org/ PySVN], neither does it work yet with the newer `ctype`-style bindings. 61 62 '''Note:''' if using Subversion, Trac must be installed on the '''same machine'''. Remote repositories are currently [trac:ticket:493 not supported]. 63 64 ===== Git 65 * [http://git-scm.com/ Git] 1.5.6 or later. 66 67 More information is available on the [trac:TracGit] page. 68 69 ===== Others 70 71 Support for other version control systems is provided via third-parties. See [trac:PluginList#VersionControlSystems] and [trac:VersionControlSystem]. 56 For troubleshooting information, see the [trac:TracSubversion#Troubleshooting TracSubversion] page. 57 58 {{{#!div style="border: 1pt dotted; margin: 1em" 59 **Note:** 60 * Trac '''doesn't''' use [http://pysvn.tigris.org/ PySVN], nor does it work yet with the newer `ctype`-style bindings. 61 * If using Subversion, Trac must be installed on the '''same machine'''. Remote repositories are currently [trac:ticket:493 not supported]. 62 }}} 63 64 ==== Git 65 66 [http://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 70 Support for other version control systems is provided via third-party plugins. See [trac:PluginList#VersionControlSystems] and [trac:VersionControlSystem]. 72 71 73 72 ==== Web Server 74 75 A web server is optional because Trac has a server included, see the [#RunningtheStandaloneServer Running the Standalone Server] section below. 73 A web server is optional because Trac is shipped with a server included, see the [#RunningtheStandaloneServer Running the Standalone Server] section below. 76 74 77 75 Alternatively you can configure Trac to run in any of the following environments: 78 76 * [http://httpd.apache.org/ Apache] with 79 - [http://code.google.com/p/modwsgi/ mod_wsgi], see [wiki:TracModWSGI] and 80 http://code.google.com/p/modwsgi/wiki/IntegrationWithTrac 81 - [http://modpython.org/ mod_python 3.5.0], see TracModPython 77 * [https://github.com/GrahamDumpleton/mod_wsgi mod_wsgi], see [wiki:TracModWSGI] and [http://code.google.com/p/modwsgi/wiki/IntegrationWithTrac ModWSGI IntegrationWithTrac]. 78 * [http://modpython.org/ mod_python 3.5.0], see TracModPython 82 79 * a [http://www.fastcgi.com/ FastCGI]-capable web server (see TracFastCgi) 83 80 * an [http://tomcat.apache.org/connectors-doc/ajp/ajpv13a.html AJP]-capable web 84 81 server (see [trac:TracOnWindowsIisAjp TracOnWindowsIisAjp]) 85 * a FastCGI and FastCGI-to-WSGI gateway (see [trac:TracOnWindowsIisWfastcgi])86 * a CGI-capable web server (see TracCgi), but //usage of Trac as a cgi script87 is highly discouraged //, better use one of the previous options.82 * Microsoft IIS with FastCGI and a FastCGI-to-WSGI gateway (see [trac:CookBook/Installation/TracOnWindowsIisWfastcgi IIS with FastCGI]) 83 * a CGI-capable web server (see TracCgi), '''but usage of Trac as a cgi script 84 is highly discouraged''', better use one of the previous options. 88 85 86 89 87 ==== Other Python Packages 90 88 91 * [http://babel.edgewall.org Babel], version 0.9. 5, 0.9.6 or >= 1.389 * [http://babel.edgewall.org Babel], version 0.9.6 or >= 1.3, 92 90 needed for localization support 93 91 * [http://docutils.sourceforge.net/ docutils], version >= 0.3.9 … … 95 93 * [http://pygments.org Pygments] for 96 94 [TracSyntaxColoring syntax highlighting]. 97 [http://silvercity.sourceforge.net/ SilverCity] and/or98 [http://gnu.org/software/enscript/enscript.html Enscript] may still be used99 but are deprecated and you really should be using Pygments.100 95 * [http://pytz.sf.net pytz] to get a complete list of time zones, 101 96 otherwise Trac will fall back on a shorter list from … … 106 101 }}} 107 102 108 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.103 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''. 109 104 110 105 == Installing Trac … … 112 107 The [TracAdmin trac-admin] command-line tool, used to create and maintain [TracEnvironment project environments], as well as the [TracStandalone tracd] standalone server are installed along with Trac. There are several methods for installing Trac. 113 108 114 It is assumed throughout this guide that you have elevated permissions as the `root` user , or by prefixing commands with `sudo`. The umask `0022` should be used for a typical installation on a Unix-based platform.109 It 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. 115 110 116 111 === Using `easy_install` 117 118 Trac can be installed from [https://pypi.python.org/pypi/Trac PyPI] or the Subversion repository using [http://pypi.python.org/pypi/setuptools setuptools]. 119 120 A few command-line examples: 121 122 - Install Trac 1.0: 112 Trac can be installed from PyPI or the Subversion repository using [http://pypi.python.org/pypi/setuptools setuptools]. 113 114 A few examples: 115 116 - Install the latest stable version of Trac: 123 117 {{{#!sh 124 $ easy_install Trac ==1.0118 $ easy_install Trac 125 119 }}} 126 120 - Install latest development version: 127 121 {{{#!sh 128 $ easy_install Trac==dev122 $ easy_install http://download.edgewall.org/trac/Trac-latest-dev.tar.gz 129 123 }}} 130 124 Note that in this case you won't have the possibility to run a localized version of Trac; 131 either use a released version or install from source .125 either use a released version or install from source 132 126 133 127 More information can be found on the [trac:wiki:setuptools setuptools] page. 134 128 135 129 {{{#!div style="border: 1pt dotted; margin: 1em" 136 **Setuptools Warning:** If the version of your setuptools is in the range 5.4 through 5.6, the environment variable `PKG_RESOURCES_CACHE_ZIP_MANIFESTS` must be set in order to avoid significant performance degradation. More information may be found in the sections on [#RunningtheStandaloneServer Running The Standalone Server] and [#RunningTraconaWebServer Running Trac on a Web Server].130 **Setuptools Warning:** If the version of your setuptools is in the range 5.4 through 5.6, the environment variable `PKG_RESOURCES_CACHE_ZIP_MANIFESTS` must be set in order to avoid significant performance degradation. More information may be found in [#DeployingTrac Deploying Trac]. 137 131 }}} 138 132 139 133 === Using `pip` 140 141 'pip' is an easy_install replacement that is very useful to quickly install Python packages. 134 'pip' is an easy_install replacement that is very useful to quickly install python packages. 142 135 To get a Trac installation up and running in less than 5 minutes: 143 136 144 Assuming you want to have your entire pip installation in `/opt/user/trac`: 145 146 - 137 Assuming you want to have your entire pip installation in `/opt/user/trac` 138 147 139 {{{#!sh 148 140 $ pip install trac psycopg2 149 141 }}} 150 or: 151 - 142 or 152 143 {{{#!sh 153 144 $ pip install trac mysql-python … … 158 149 pip will automatically resolve all dependencies (like Genshi, pygments, etc.), download the latest packages from pypi.python.org and create a self contained installation in `/opt/user/trac`. 159 150 160 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) .151 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) 161 152 162 153 Additionally, you can install several Trac plugins (listed [https://pypi.python.org/pypi?:action=browse&show=all&c=516 here]) through pip. 163 154 164 155 === From source 165 166 156 Using the python-typical setup at the top of the source directory also works. You can obtain the source for a .tar.gz or .zip file corresponding to a release (e.g. `Trac-1.0.tar.gz`) from the [trac:TracDownload] page, or you can get the source directly from the repository. See [trac:TracRepositories#OfficialSubversionrepository TracRepositories] for details. 167 157 … … 170 160 }}} 171 161 172 You will need root permissions or equivalent for this step. 162 ''You will need root permissions or equivalent for this step.'' 173 163 174 164 This will byte-compile the Python source code and install it as an .egg file or folder in the `site-packages` directory … … 179 169 $ python ./setup.py install 180 170 }}} 181 182 171 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`). 183 172 184 173 === Using installer 185 174 186 On Windows Trac can be installed using the exe installers available on the [trac:TracDownload] page. Installers are available for the 32 and 64bit versions of Python. Make sure to use the installer that matches the architecture of your Python installation.175 On 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. 187 176 188 177 === Using package manager 189 178 190 Trac may be available in the package repository for your platform. Note however, that the version provided by thepackage manager may not be the latest release.179 Trac may be available in your platform's package repository. Note however, that the version provided by your package manager may not be the latest release. 191 180 192 181 === Advanced `easy_install` Options … … 203 192 $ easy_install --prefix=/path/to/installdir 204 193 }}} 205 206 194 or, if installing Trac on a Mac OS X system: 207 195 {{{#!sh 208 $ easy_install --prefix=/usr/local --install-dir=/Library/Python/2.5/site-packages 209 }}} 210 211 '''Note''': If installing on Mac OS X 10.6 running {{{ easy_install http://svn.edgewall.org/repos/trac/trunk }}} will install into {{{ /usr/local }}} and {{{ /Library/Python/2.5/site-packages }}} by default. 212 213 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. 196 $ easy_install --prefix=/usr/local --install-dir=/Library/Python/2.6/site-packages 197 }}} 198 199 {{{#!div style="border: 1pt dotted; margin: 1em" 200 **Mac OS X Note:** On Mac OS X 10.6, running `easy_install trac` will install into `/usr/local` and `/Library/Python/2.6/site-packages` by default. 201 202 The `tracd` and `trac-admin` commands will be placed in `/usr/local/bin` and will install the Trac libraries and dependencies into `/Library/Python/2.6/site-packages`, which is Apple's preferred location for third-party Python application installations. 203 }}} 214 204 215 205 == Creating a Project Environment 216 206 217 A [TracEnvironment Trac environment] is the backend where Trac stores information like wiki pages, tickets, reports, settings, etc. An environment is basicallya directory that contains a human-readable [TracIni configuration file], and other files and directories.207 A [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. 218 208 219 209 A new environment is created using [TracAdmin trac-admin]: … … 222 212 }}} 223 213 224 [TracAdmin trac-admin] will prompt you for the information it needs to create the environment, such as the name of the project and the [TracEnvironment#DatabaseConnectionStrings database connection string]. If you're not sure what to specify for one of these options, just press `<Enter>` to use the default value. 225 226 Using the default database connection string in particular will always work as long as you have SQLite installed. 227 For the other [trac:DatabaseBackend database backends] you should plan ahead and already have a database ready to use at this point. 228 229 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. 230 231 Also note that the values you specify here can be changed later by directly editing the [TracIni conf/trac.ini] configuration file. 214 You will be prompted for the information needed 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. 215 216 Using 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. 217 218 Also note that the values you specify here can be changed later using TracAdmin or directly editing the [TracIni conf/trac.ini] configuration file. 232 219 233 220 {{{#!div style="border: 1pt dotted; margin: 1em" … … 237 224 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: 238 225 {{{#!sh 239 $ chown -R apache .apache /path/to/myproject240 }}} 241 242 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).226 $ chown -R apache:apache /path/to/myproject 227 }}} 228 229 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). 243 230 244 231 {{{#!div class=important … … 248 235 == Deploying Trac 249 236 237 {{{#!div style="border: 1pt dotted; margin: 1em" 238 **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. 239 240 If running `tracd`, the environment variable can be set system-wide or for just the user that runs the `tracd` process. There are several ways to accomplish this in addition to what is discussed here, and depending on the distribution of your OS. 241 242 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`. 243 {{{#!sh 244 export PKG_RESOURCES_CACHE_ZIP_MANIFESTS=1 245 }}} 246 247 Alternatively, the variable can be set in the shell before executing `tracd`: 248 {{{#!sh 249 $ PKG_RESOURCES_CACHE_ZIP_MANIFESTS=1 tracd --port 8000 /path/to/myproject 250 }}} 251 252 If running the Apache web server, !Ubuntu/Debian users should add the `export` statement to `/etc/apache2/envvars`. !RedHat/CentOS/Fedora should can add the `export` statement to `/etc/sysconfig/httpd`. 253 }}} 254 250 255 === Running the Standalone Server 251 256 … … 258 263 {{{#!sh 259 264 $ tracd -s --port 8000 /path/to/myproject 260 }}}261 262 {{{#!div style="border: 1pt dotted; margin: 1em"263 **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.264 265 To be effective system-wide a shell script with the `export` statement may be added to `/etc/profile.d`. !Ubuntu/Debian users can add the `export` statement to `/etc/apache2/envvars`. !RedHat/CentOS/Fedora users can add the `export` statement to `/etc/sysconfig/httpd`. To be effective for a user session the `export` statement may be added to `~/.profile`.266 {{{#!sh267 export PKG_RESOURCES_CACHE_ZIP_MANIFESTS=1268 }}}269 270 Alternatively, the variable can be set in the shell before executing `tracd`:271 {{{#!sh272 $ PKG_RESOURCES_CACHE_ZIP_MANIFESTS=1 tracd --port 8000 /path/to/myproject273 }}}274 265 }}} 275 266 … … 278 269 Trac provides various options for connecting to a "real" web server: 279 270 - [TracFastCgi FastCGI] 280 - [wiki:TracModWSGI mod_wsgi]281 - [TracModPython mod_python]282 - //[TracCgi CGI]: should not be used, as it degrades performance//271 - [wiki:TracModWSGI Apache with mod_wsgi] 272 - [TracModPython Apache with mod_python] 273 - [TracCgi CGI] //(should not be used, as the performance is far from optimal)// 283 274 284 275 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. … … 286 277 ==== Generating the Trac cgi-bin directory #cgi-bin 287 278 288 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 [TracAdmin trac-admin]. 289 290 There is, however, a bit of a chicken-and-egg problem. The [TracAdmin trac-admin] command requires an existing environment to function, but complains if the deploy directory already exists. This is a problem, because environments are often stored in a subdirectory of the deploy. The solution is to do something like this: 291 {{{#!sh 292 $ mkdir -p /usr/share/trac/projects/my-project 293 $ trac-admin /usr/share/trac/projects/my-project initenv 294 $ trac-admin /usr/share/trac/projects/my-project deploy /tmp/deploy 295 $ mv /tmp/deploy/* /usr/share/trac 296 }}} 297 298 Don't forget to check that the web server has the execution right on scripts in the `/usr/share/trac/cgi-bin` directory. 279 Application scripts for CGI, FastCGI and mod-wsgi can be generated using the [TracAdmin trac-admin] `deploy` command: 280 [[TracAdminHelp(deploy)]] 281 282 Grant the web server execution right on scripts in the `cgi-bin` directory. 283 284 For example, the following yields a typical directory structure: 285 {{{#!sh 286 $ mkdir -p /var/trac 287 $ trac-admin /var/trac/<project> initenv 288 $ trac-admin /var/trac/<project> deploy /var/www 289 $ ls /var/www 290 cgi-bin htdocs 291 $ chmod ugo+x /var/www/cgi-bin/* 292 }}} 299 293 300 294 ==== Mapping Static Resources 301 295 302 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''' as it causes abysmal performance. 303 304 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. 305 306 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. 307 308 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: 309 [[TracAdminHelp(deploy)]] 310 311 The target `<directory>` will then contain an `htdocs` directory with: 312 - `site/` - a copy of the environment's directory `htdocs/` 313 - `common/` - the static resources of Trac itself 314 - `<plugins>/` - one directory for each resource directory managed by the plugins enabled for this environment 315 316 ===== Example: Apache and `ScriptAlias` #ScriptAlias-example 317 318 Assuming the deployment has been done this way: 319 {{{#!sh 320 $ trac-admin /var/trac/env deploy /path/to/shared/trac 321 }}} 322 323 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: 296 Without 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. 297 298 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 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. 299 300 There 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. 301 302 A 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. 303 304 The `deploy` command creates an `htdocs` directory with: 305 - `common/` - the static resources of Trac 306 - `site/` - a copy of the environment's `htdocs/` directory 307 - `shared` - the static resources shared by multiple Trac environments, with a location defined by the `[inherit]` `htdocs_dir` option 308 - `<plugin>/` - one directory for each resource directory provided by the plugins enabled for this environment 309 310 The example that follows will create a single `/chrome` alias. If that isn't the correct approach for your installation you simply need to create more specific aliases: 324 311 {{{#!apache 325 312 Alias /trac/chrome/common /path/to/trac/htdocs/common 326 313 Alias /trac/chrome/site /path/to/trac/htdocs/site 314 Alias /trac/chrome/shared /path/to/trac/htdocs/shared 315 Alias /trac/chrome/<plugin> /path/to/trac/htdocs/<plugin> 316 }}} 317 318 ===== Example: Apache and `ScriptAlias` #ScriptAlias-example 319 320 Assuming the deployment has been done this way: 321 {{{#!sh 322 $ trac-admin /var/trac/<project> deploy /var/www 323 }}} 324 325 Add 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: 326 {{{#!apache 327 Alias /trac/chrome /path/to/trac/htdocs 327 328 328 329 <Directory "/path/to/www/trac/htdocs"> 329 Order allow,deny 330 Allow from all 330 # For Apache 2.2 331 <IfModule !mod_authz_core.c> 332 Order allow,deny 333 Allow from all 334 </IfModule> 335 # For Apache 2.4 336 <IfModule mod_authz_core.c> 337 Require all granted 338 </IfModule> 331 339 </Directory> 332 340 }}} 333 341 334 If using mod_python, you might want toadd this too, otherwise the alias will be ignored:342 If using mod_python, add this too, otherwise the alias will be ignored: 335 343 {{{#!apache 336 <Location "/trac/chrome/common /">344 <Location "/trac/chrome/common"> 337 345 SetHandler None 338 346 </Location> 339 347 }}} 340 348 341 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. 342 343 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): 349 Alternatively, 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: 344 350 {{{#!apache 345 351 Alias /trac/chrome/site /path/to/projectenv/htdocs 346 352 347 353 <Directory "/path/to/projectenv/htdocs"> 348 Order allow,deny 349 Allow from all 354 # For Apache 2.2 355 <IfModule !mod_authz_core.c> 356 Order allow,deny 357 Allow from all 358 </IfModule> 359 # For Apache 2.4 360 <IfModule mod_authz_core.c> 361 Require all granted 362 </IfModule> 350 363 </Directory> 351 364 }}} 352 365 353 A lternatively to aliasing `/trac/chrome/common`, you can tell Trac to generate direct links for those static resources (and only those), using the [[TracIni#trac-section| [trac] htdocs_location]] configuration setting:366 Another alternative to aliasing `/trac/chrome/common` is having Trac generate direct links for those static resources (and only those), using the [TracIni#trac-section htdocs_location] configuration setting: 354 367 {{{#!ini 355 368 [trac] … … 357 370 }}} 358 371 359 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].372 Note that this makes it easy to have a dedicated domain serve those static resources, preferentially cookie-less. 360 373 361 374 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 377 }}} 365 378 366 ==== Setting up the Plugin Cache 379 ==== Setting up the Plugin Cache #egg-cache 367 380 368 381 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. 382 383 If you setup hook scripts that call Trac, such as the Subversion post-commit hook script provided in the `/contrib` directory, make sure you define the `PYTHON_EGG_CACHE` environment variable within these scripts as well. 369 384 370 385 == Configuring Authentication … … 376 391 Please refer to one of the following sections: 377 392 * TracStandalone#UsingAuthentication if you use the standalone server, `tracd`. 378 * [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`.379 * TracFastCgi if you are using another web server with FCGI support, such as Cherokee, Lighttpd, !LiteSpeed, nginx.380 381 The following document also contains some useful information for beginners: [trac:TracAuthenticationIntroduction].393 * [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`. 394 * TracFastCgi if you're using another web server with FCGI support (Cherokee, Lighttpd, !LiteSpeed, nginx) 395 396 [trac:TracAuthenticationIntroduction] also contains some useful information for beginners. 382 397 383 398 == Granting admin rights to the admin user 384 385 399 Grant admin rights to user admin: 386 400 {{{#!sh … … 388 402 }}} 389 403 390 This user will have an "Admin" entry menu that will allow you to administrate your Trac project. 391 392 == Finishing the install 393 394 === Enable version control components 395 396 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. 397 398 The version control systems are enabled by adding the following to the `[components]` section of your [TracIni#components-section trac.ini], or enabling the components in the "Plugins" admin panel: 399 400 {{{#!ini 401 [components] 402 tracopt.versioncontrol.svn.* = enabled 403 }}} 404 405 {{{#!ini 406 [components] 407 tracopt.versioncontrol.git.* = enabled 408 }}} 409 410 After enabling the components, repositories can be configured through the //Repositories// admin panel or by editing [TracIni#repositories-section trac.ini]. Automatic changeset references can be inserted as ticket comments by configuring [TracRepositoryAdmin#Automaticchangesetreferencesintickets CommitTicketUpdater]. 411 412 === Using Trac 404 This user will have an //Admin// navigation item that directs to pages for administering your Trac project. 405 406 == Configuring Trac 407 408 TracRepositoryAdmin provides information on configuring version control repositories for your project. 409 410 == Using Trac 413 411 414 412 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.
