Changes between Version 5 and Version 6 of TracInstall
- Timestamp:
- 03/08/15 04:36:54 (10 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracInstall
v5 v6 1 = Trac Installation Guide for 1.0 =1 = Trac Installation Guide for 1.0 2 2 [[TracGuideToc]] 3 3 4 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. 5 5 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 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 8 If you're interested in contributing new translations for other languages or enhance the existing translations, then please have a look at [ [trac:TracL10N]].9 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 [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.6 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. 7 8 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 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] on the main Trac site, please '''first read through these general instructions''' to get a good understanding of the tasks involved. 11 11 12 12 [[PageOutline(2-3,Installation Steps,inline)]] 13 13 14 == Dependencies ==14 == Dependencies 15 15 === Mandatory Dependencies 16 16 To install Trac, the following software packages must be installed: … … 18 18 * [http://www.python.org/ Python], version >= 2.5 and < 3.0 19 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 23 You also need a database system and the corresponding python bindings. 24 The database can be either SQLite, PostgreSQL or MySQL. 20 * [http://peak.telecommunity.com/DevCenter/setuptools setuptools], version >= 0.6 21 * [http://genshi.edgewall.org/wiki/Download Genshi], version >= 0.6 22 23 You also need a database system and the corresponding python bindings. The database can be either SQLite, PostgreSQL or MySQL. 25 24 26 25 ==== For the SQLite database #ForSQLite 27 26 28 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).29 30 However, if you 'd like, you can download the latest and greatest version of [[trac:Pysqlite]] from27 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. 28 29 However, if you like, you can download the latest and greatest version of [[trac:PySqlite]] from 31 30 [http://code.google.com/p/pysqlite/downloads/list google code], where you'll find the Windows 32 31 installers or the `tar.gz` archive for building from source: 33 {{{ 32 {{{#!sh 34 33 $ tar xvfz <version>.tar.gz 35 34 $ cd <version> … … 37 36 }}} 38 37 39 This will download the latest SQLite code and build the bindings. 40 41 SQLite 2.x is no longer supported. 42 43 A known bug PySqlite versions 2.5.2-4 prohibits upgrade of trac databases 44 from 0.11.x to 0.12. Please use versions 2.5.5 and newer or 2.5.1 and 45 older. See #9434 for more detail. 46 47 See additional information in [trac:PySqlite PySqlite]. 38 This will download the latest SQLite code and build the bindings. SQLite 2.x is no longer supported. 39 40 A known bug in [trac:PySqlite] versions 2.5.2-4 prohibits upgrades of Trac databases from 0.11.x to 0.12. Please use versions 2.5.5 and newer or 2.5.1 and older. See [trac:#9434] for more detail. See additional information in [trac:PySqlite PySqlite]. 48 41 49 42 ==== For the PostgreSQL database #ForPostgreSQL … … 51 44 You need to install the database and its Python bindings: 52 45 * [http://www.postgresql.org/ PostgreSQL], version 8.0 or later 53 * [http://pypi.python.org/pypi/psycopg2 psycopg2] 46 * [http://pypi.python.org/pypi/psycopg2 psycopg2], version 2.0 or later 54 47 55 48 See [trac:DatabaseBackend#Postgresql DatabaseBackend] for details. 56 49 57 58 50 ==== For the MySQL database #ForMySQL 59 51 60 Trac can now work quite well with MySQL, provided you follow the guidelines.52 Trac works well with MySQL, provided you follow the guidelines: 61 53 62 54 * [http://mysql.com/ MySQL], version 5.0 or later 63 55 * [http://sf.net/projects/mysql-python MySQLdb], version 1.2.2 or later 64 56 65 It is '''very''' important to read carefully the[trac:MySqlDb] page before creating the database.57 Given the caveats and known issues surrounding MySQL, read carefully the [trac:MySqlDb] page before creating the database. 66 58 67 59 === Optional Dependencies 68 60 69 ==== Version Control System ====70 71 ===== Subversion =====61 ==== Version Control System 62 63 ===== Subversion 72 64 * [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 65 74 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.)66 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.) 75 67 76 68 Note that Trac '''doesn't''' use [http://pysvn.tigris.org/ PySVN], neither does it work yet with the newer `ctype`-style bindings. 77 69 78 79 70 '''Please note:''' if using Subversion, Trac must be installed on the '''same machine'''. Remote repositories are currently [trac:ticket:493 not supported]. 80 71 81 82 ===== Others ===== 72 ===== Others 83 73 84 74 Support for other version control systems is provided via third-parties. See [trac:PluginList] and [trac:VersionControlSystem]. 85 75 86 ==== Web Server ====87 A web server is optional because Trac is shipped with a server included, see the [#RunningtheStandaloneServer Running the Standalone Server 88 89 Alternatively you c onfigure Trac to run in any of the following environments.76 ==== Web Server 77 A web server is optional because Trac is shipped with a server included, see the [#RunningtheStandaloneServer Running the Standalone Server] section below. 78 79 Alternatively you can configure Trac to run in any of the following environments: 90 80 * [http://httpd.apache.org/ Apache] with 91 81 - [http://code.google.com/p/modwsgi/ mod_wsgi], see [wiki:TracModWSGI] and 92 82 http://code.google.com/p/modwsgi/wiki/IntegrationWithTrac 93 - [http://modpython.org/ mod_python 3.3.1],deprecated: see TracModPython)83 - [http://modpython.org/ mod_python >= 3.3.1], (deprecated: see TracModPython) 94 84 * a [http://www.fastcgi.com/ FastCGI]-capable web server (see TracFastCgi) 95 85 * an [http://tomcat.apache.org/connectors-doc/ajp/ajpv13a.html AJP]-capable web … … 99 89 100 90 101 ==== Other Python Packages ====91 ==== Other Python Packages 102 92 103 93 * [http://babel.edgewall.org Babel], version >= 0.9.5, … … 105 95 * [http://docutils.sourceforge.net/ docutils], version >= 0.3.9 106 96 for WikiRestructuredText. 107 * [http://pygments. pocoo.org Pygments] for97 * [http://pygments.org Pygments] for 108 98 [wiki:TracSyntaxColoring syntax highlighting]. 109 99 [http://silvercity.sourceforge.net/ SilverCity] and/or … … 114 104 an internal time zone implementation. 115 105 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 118 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!). 119 120 121 == Installing Trac == 106 '''Attention''': The available versions of these dependencies are not necessarily interchangeable, so please pay attention to the version numbers. If you are having trouble getting Trac to work, please double-check all the dependencies before asking for help on the [trac:MailingList] or [trac:IrcChannel]. 107 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''. There are even some pages that are still talking about Trac 0.8! 109 110 == Installing Trac 122 111 === Using `easy_install` 123 One way to install Trac is using [http://pypi.python.org/pypi/setuptools setuptools]. 124 With setuptools you can install Trac from the subversion repository; 112 One way to install Trac is using [http://pypi.python.org/pypi/setuptools setuptools]. With setuptools you can install Trac from the Subversion repository. 125 113 126 114 A few examples: 127 115 128 - install Trac 1.0:129 {{{ 116 - Install Trac 1.0: 117 {{{#!sh 130 118 easy_install Trac==1.0 131 119 }}} 132 (NOT YET ENABLED) 133 - install latest development version 1.0dev: 134 {{{ 120 - Install latest development version: 121 {{{#!sh 135 122 easy_install Trac==dev 136 123 }}} … … 138 125 either use a released version or install from source 139 126 127 {{{#!div style="border: 1pt dotted; margin: 1em" 128 **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]. 129 }}} 130 140 131 === Using `pip` 141 132 'pip' is an easy_install replacement that is very useful to quickly install python packages. 142 To get a trac installation up and running in less than 5 minutes:133 To get a Trac installation up and running in less than 5 minutes: 143 134 144 135 Assuming you want to have your entire pip installation in `/opt/user/trac` 145 136 146 137 - 147 {{{ 148 pip -E /opt/user/tracinstall trac psycopg2138 {{{#!sh 139 pip install trac psycopg2 149 140 }}} 150 141 or 151 142 - 152 {{{ 153 pip -E /opt/user/tracinstall trac mysql-python154 }}} 155 156 Make sure your OS specific headers are available for pip to automatically build PostgreSQL ( libpq-dev) or MySQL (libmysqlclient-dev) bindings.143 {{{#!sh 144 pip install trac mysql-python 145 }}} 146 147 Make sure your OS specific headers are available for pip to automatically build PostgreSQL (`libpq-dev`) or MySQL (`libmysqlclient-dev`) bindings. 157 148 158 149 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`. … … 160 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 Additionally, you can install several trac plugins (listed [http://pypi.python.org/pypi?:action=search&term=trac&submit=search here]) through pip. 163 164 153 Additionally, you can install several Trac plugins (listed [https://pypi.python.org/pypi?:action=browse&show=all&c=516 here]) through pip. 165 154 166 155 === From source 167 Of course, using the python-typical setup at the top of the source directory also works. 168 169 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). 170 171 {{{ 156 Of course, 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`), or you can get the source directly from the repository. See [trac:SubversionRepository] for details. 157 158 {{{#!sh 172 159 $ python ./setup.py install 173 160 }}} 174 161 175 ''You 'll need root permissions or equivalent for this step.''176 177 This will byte-compile the python source code and install it as an .egg file or folder in the `site-packages` directory178 of your Python installation. The .egg will also contain all other resources needed by standard Trac, such as htdocs and templates.162 ''You will need root permissions or equivalent for this step.'' 163 164 This will byte-compile the Python source code and install it as an .egg file or folder in the `site-packages` directory 165 of your Python installation. The .egg will also contain all other resources needed by standard Trac, such as `htdocs` and `templates`. 179 166 180 167 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. 181 168 182 If you install from source and want to make Trac available in other languages, make sure 183 {{{ 169 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): 170 {{{#!sh 184 171 $ python ./setup.py install 185 172 }}} 186 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`).187 188 === Advanced Options ===173 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`). 174 175 === Advanced Options 189 176 190 177 To install Trac to a custom location, or find out about other advanced installation options, run: 191 {{{ 178 {{{#!sh 192 179 easy_install --help 193 180 }}} 194 181 195 Also see [http://docs.python.org/ inst/inst.html Installing Python Modules] for detailed information.182 Also see [http://docs.python.org/2/install/index.html Installing Python Modules] for detailed information. 196 183 197 184 Specifically, you might be interested in: 198 {{{ 185 {{{#!sh 199 186 easy_install --prefix=/path/to/installdir 200 187 }}} 201 or, if installing Trac toa Mac OS X system:202 {{{ 188 or, if installing Trac on a Mac OS X system: 189 {{{#!sh 203 190 easy_install --prefix=/usr/local --install-dir=/Library/Python/2.5/site-packages 204 191 }}} 205 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 192 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. 206 193 207 194 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. 208 195 209 210 == Creating a Project Environment == 211 212 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. 196 == Creating a Project Environment 197 198 A [TracEnvironment Trac environment] is the backend where Trac stores information like wiki pages, tickets, reports, settings, etc. An environment is basically a directory that contains a human-readable [TracIni configuration file], and other files and directories. 213 199 214 200 A new environment is created using [wiki:TracAdmin trac-admin]: 215 {{{ 201 {{{#!sh 216 202 $ trac-admin /path/to/myproject initenv 217 203 }}} … … 220 206 221 207 Using the default database connection string in particular will always work as long as you have SQLite installed. 222 For the other [ DatabaseBackend database backends] you should plan ahead and already have a database ready to use at this point.223 224 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.208 For the other [trac:DatabaseBackend database backends] you should plan ahead and already have a database ready to use at this point. 209 210 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. 225 211 226 212 Also note that the values you specify here can be changed later by directly editing the [TracIni conf/trac.ini] configuration file. 227 213 214 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. The best advice is to opt for a platform with sub-second timestamp resolution, regardless of the Trac version. 215 228 216 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: 229 {{{ 230 # chown -R apache.apache /path/to/myproject 231 }}} 217 {{{#!sh 218 $ chown -R apache.apache /path/to/myproject 219 }}} 220 221 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). 232 222 233 223 {{{#!div class=important … … 235 225 }}} 236 226 237 238 227 == Deploying Trac 239 228 240 === Running the Standalone Server ===229 === Running the Standalone Server 241 230 242 231 After having created a Trac environment, you can easily try the web interface by running the standalone server [wiki:TracStandalone tracd]: 243 {{{ 232 {{{#!sh 244 233 $ tracd --port 8000 /path/to/myproject 245 234 }}} 246 235 247 236 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: 248 {{{ 237 {{{#!sh 249 238 $ tracd -s --port 8000 /path/to/myproject 250 239 }}} 251 240 252 === Running Trac on a Web Server === 241 {{{#!div style="border: 1pt dotted; margin: 1em" 242 **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. 243 244 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`. 245 {{{#!sh 246 export PKG_RESOURCES_CACHE_ZIP_MANIFESTS=1 247 }}} 248 249 Alternatively, the variable can be set in the shell before executing `tracd`: 250 {{{#!sh 251 $ PKG_RESOURCES_CACHE_ZIP_MANIFESTS=1 tracd --port 8000 /path/to/myproject 252 }}} 253 }}} 254 255 === Running Trac on a Web Server 253 256 254 257 Trac provides various options for connecting to a "real" web server: … … 260 263 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. 261 264 262 ==== Generating the Trac cgi-bin directory ====#cgi-bin265 ==== Generating the Trac cgi-bin directory #cgi-bin 263 266 264 267 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]. 265 268 266 269 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: 267 {{{ 270 {{{#!sh 268 271 mkdir -p /usr/share/trac/projects/my-project 269 272 trac-admin /usr/share/trac/projects/my-project initenv … … 271 274 mv /tmp/deploy/* /usr/share/trac 272 275 }}} 273 274 275 ==== Mapping Static Resources ====276 Don't forget to check that the web server has the execution right on scripts in the `/usr/share/trac/cgi-bin` directory. 277 278 ==== Mapping Static Resources 276 279 277 280 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). … … 289 292 - `<plugins>/` - one directory for each resource directory managed by the plugins enabled for this environment 290 293 291 ===== Example: Apache and `ScriptAlias` =====#ScriptAlias-example294 ===== Example: Apache and `ScriptAlias` #ScriptAlias-example 292 295 293 296 Assuming the deployment has been done this way: 294 {{{ 295 $ trac-admin /var/trac/env deploy /path/to/ trac/htdocs/common297 {{{#!sh 298 $ trac-admin /var/trac/env deploy /path/to/shared/trac 296 299 }}} 297 300 298 301 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: 299 {{{ 302 {{{#!apache 300 303 Alias /trac/chrome/common /path/to/trac/htdocs/common 301 304 Alias /trac/chrome/site /path/to/trac/htdocs/site … … 308 311 309 312 If using mod_python, you might want to add this too (otherwise, the alias will be ignored): 310 {{{ 313 {{{#!apache 311 314 <Location "/trac/chrome/common/"> 312 315 SetHandler None … … 317 320 318 321 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): 319 {{{ 322 {{{#!apache 320 323 Alias /trac/chrome/site /path/to/projectenv/htdocs 321 324 … … 327 330 328 331 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: 329 {{{ 332 {{{#!ini 330 333 [trac] 331 334 htdocs_location = http://static.example.org/trac-common/ … … 334 337 335 338 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: 336 {{{ 339 {{{#!sh 337 340 $ ln -s /path/to/trac/htdocs/common /var/www/static.example.org/trac-common 338 341 }}} 339 342 340 341 ==== Setting up the Plugin Cache ==== 342 343 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. 344 345 == Configuring Authentication == 346 347 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. 343 ==== Setting up the Plugin Cache 344 345 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. 346 347 == Configuring Authentication 348 349 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. 348 350 349 351 The process of adding, removing, and configuring user accounts for authentication depends on the specific way you run Trac. … … 354 356 * TracFastCgi if you're using another web server with FCGI support (Cherokee, Lighttpd, !LiteSpeed, nginx) 355 357 358 The following document also constains some useful information for beginners: [trac:TracAuthenticationIntroduction]. 359 356 360 == Granting admin rights to the admin user 357 361 Grant admin rights to user admin: 358 {{{ 362 {{{#!sh 359 363 $ trac-admin /path/to/myproject permission add admin TRAC_ADMIN 360 364 }}} 361 This user will have an "Admin" entry menu that will allow you to admin your trac project.365 This user will have an "Admin" entry menu that will allow you to administrate your Trac project. 362 366 363 367 == Finishing the install 364 368 365 === Automatic reference to the SVN changesets in Trac tickets === 369 === Enable version control components 370 371 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. 372 373 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. 374 375 {{{#!ini 376 tracopt.versioncontrol.svn.* = enabled 377 }}} 378 379 {{{#!ini 380 tracopt.versioncontrol.git.* = enabled 381 }}} 382 383 After enabling the components, repositories can be configured through the "Repositories" admin panel or by editing [TracIni#repositories-section trac.ini]. 384 385 === Automatic reference to the SVN changesets in Trac tickets 366 386 367 387 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: … … 370 390 371 391 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. 372 {{{ 392 {{{#!ini 373 393 tracopt.ticket.commit_updater.* = enabled 374 394 }}} 375 395 For more information, see the documentation of the `CommitTicketUpdater` component in the "Plugins" admin panel. 376 396 377 === Using Trac ===397 === Using Trac 378 398 379 399 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.