Changes between Version 3 and Version 4 of TracInstall
- Timestamp:
- Jun 25, 2013, 11:16:30 PM (12 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracInstall
v3 v4 1 = Trac Installation Guide for 0.12=1 = Trac Installation Guide for 1.0 = 2 2 [[TracGuideToc]] 3 3 … … 8 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 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 TracInstallPlatformson the main Trac site, please be sure to '''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 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 11 12 12 [[PageOutline(2-3,Installation Steps,inline)]] … … 16 16 To install Trac, the following software packages must be installed: 17 17 18 * [http://www.python.org/ Python], version >= 2. 4and < 3.019 (note that we dropped the support for Python 2. 3in this release)20 * [http://peak.telecommunity.com/DevCenter/setuptools setuptools], version >= 0.6 21 * [http://genshi.edgewall.org/wiki/Download Genshi], version >= 0.6 18 * [http://www.python.org/ Python], version >= 2.5 and < 3.0 19 (note that we dropped the support for Python 2.4 in this release) 20 * [http://peak.telecommunity.com/DevCenter/setuptools setuptools], version >= 0.6, or better yet, [http://pypi.python.org/pypi/distribute distribute] 21 * [http://genshi.edgewall.org/wiki/Download Genshi], version >= 0.6 (unreleased version 0.7dev should work as well) 22 22 23 23 You also need a database system and the corresponding python bindings. … … 26 26 ==== For the SQLite database #ForSQLite 27 27 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 downloadfrom31 [http://code.google.com/p/pysqlite/downloads/list google code] the Windows32 installers or the tar.gzarchive for building from source: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]] from 31 [http://code.google.com/p/pysqlite/downloads/list google code], where you'll find the Windows 32 installers or the `tar.gz` archive for building from source: 33 33 {{{ 34 34 $ tar xvfz <version>.tar.gz … … 37 37 }}} 38 38 39 This will extract the SQLite code and build the bindings. 40 41 SQLite 2.x is no longer supported. For SQLite 3.x, the pysqlite 1.1.x 42 bindings are also no longer supported, use pysqlite 2.x. 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. 43 46 44 47 See additional information in [trac:PySqlite PySqlite]. … … 47 50 48 51 You need to install the database and its Python bindings: 49 * [http://www.postgresql.org/ PostgreSQL] 52 * [http://www.postgresql.org/ PostgreSQL], version 8.0 or later 50 53 * [http://pypi.python.org/pypi/psycopg2 psycopg2] 51 54 … … 60 63 * [http://sf.net/projects/mysql-python MySQLdb], version 1.2.2 or later 61 64 62 It is '''very''' important to read carefully the [trac:MySqlDb MySqlDb] page before creating the database.65 It is '''very''' important to read carefully the [trac:MySqlDb] page before creating the database. 63 66 64 67 === Optional Dependencies … … 69 72 * [http://subversion.apache.org/ Subversion], 1.5.x or 1.6.x and the '''''corresponding''''' Python bindings. Older versions starting from 1.0, like 1.2.4, 1.3.2 or 1.4.2, etc. should still work. For troubleshooting information, check the [trac:TracSubversion#Troubleshooting TracSubversion] page. 70 73 71 There are [http://subversion.apache.org/packages.html pre-compiled SWIG bindings] available for various platforms. Note that Trac '''doesn't''' use [http://pysvn.tigris.org/ PySVN], neither does it work yet with the newer `ctype`-style bindings 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.) 75 76 Note that Trac '''doesn't''' use [http://pysvn.tigris.org/ PySVN], neither does it work yet with the newer `ctype`-style bindings. 72 77 73 78 … … 77 82 ===== Others ===== 78 83 79 Support for other version control systems is provided via third-parties. See [trac:PluginList PluginList] and [trac:VersioningSystemBackend VersioningSystemBackend].84 Support for other version control systems is provided via third-parties. See [trac:PluginList] and [trac:VersionControlSystem]. 80 85 81 86 ==== Web Server ==== … … 86 91 - [http://code.google.com/p/modwsgi/ mod_wsgi], see [wiki:TracModWSGI] and 87 92 http://code.google.com/p/modwsgi/wiki/IntegrationWithTrac 88 - [http://modpython.org/ mod_python 3.3.1], see TracModPython)93 - [http://modpython.org/ mod_python 3.3.1], deprecated: see TracModPython) 89 94 * a [http://www.fastcgi.com/ FastCGI]-capable web server (see TracFastCgi) 90 95 * an [http://tomcat.apache.org/connectors-doc/ajp/ajpv13a.html AJP]-capable web … … 97 102 98 103 * [http://babel.edgewall.org Babel], version >= 0.9.5, 99 needed for localization support 104 needed for localization support (unreleased version 1.0dev should work as well) 100 105 * [http://docutils.sourceforge.net/ docutils], version >= 0.3.9 101 106 for WikiRestructuredText. … … 109 114 an internal time zone implementation. 110 115 111 '''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 MailingList] or [trac:IrcChannelIrcChannel].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]. 112 117 113 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!). … … 116 121 == Installing Trac == 117 122 === Using `easy_install` 118 One way to install Trac is using `setuptools`.123 One way to install Trac is using [http://pypi.python.org/pypi/setuptools setuptools]. 119 124 With setuptools you can install Trac from the subversion repository; 120 125 121 126 A few examples: 122 127 123 - install Trac 0.12:128 - install Trac 1.0: 124 129 {{{ 125 easy_install Trac== 0.12130 easy_install Trac==1.0 126 131 }}} 127 128 - install latest development version 0.12dev:132 (NOT YET ENABLED) 133 - install latest development version 1.0dev: 129 134 {{{ 130 135 easy_install Trac==dev … … 137 142 To get a trac installation up and running in less than 5 minutes: 138 143 139 Assuming you want to have your entire pip installation in /opt/user/trac144 Assuming you want to have your entire pip installation in `/opt/user/trac` 140 145 141 146 - … … 151 156 Make sure your OS specific headers are available for pip to automatically build PostgreSQL (libpq-dev) or MySQL (libmysqlclient-dev) bindings. 152 157 153 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/trac154 155 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 WSGIDaemonProcessdirective)158 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`. 159 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) 156 161 157 162 Additionally, you can install several trac plugins (listed [http://pypi.python.org/pypi?:action=search&term=trac&submit=search here]) through pip. … … 162 167 Of course, using the python-typical setup at the top of the source directory also works. 163 168 164 You can obtain the source for a .tar.gz or .zip file corresponding to a release (e.g. Trac- 0.12.tar.gz), or you can get the source directly from the repository (see Trac:SubversionRepository for details).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). 165 170 166 171 {{{ … … 226 231 }}} 227 232 228 == Running the Standalone Server == 233 {{{#!div class=important 234 '''Warning:''' Please only use ASCII-characters for account name and project path, unicode characters are not supported there. 235 }}} 236 237 238 == Deploying Trac 239 240 === Running the Standalone Server === 229 241 230 242 After having created a Trac environment, you can easily try the web interface by running the standalone server [wiki:TracStandalone tracd]: … … 238 250 }}} 239 251 240 == Running Trac on a Web Server == 241 242 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. 243 244 Trac also supports [trac:TracOnWindowsIisAjp AJP] which may be your choice if you want to connect to IIS. 245 246 ==== Generating the Trac cgi-bin directory ==== 252 === Running Trac on a Web Server === 253 254 Trac provides various options for connecting to a "real" web server: 255 - [wiki:TracFastCgi FastCGI] 256 - [wiki:TracModWSGI mod_wsgi] 257 - //[wiki:TracModPython mod_python] (no longer recommended, as mod_python is not actively maintained anymore)// 258 - //[wiki:TracCgi CGI] (should not be used, as the performance is far from optimal)// 259 260 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 262 ==== Generating the Trac cgi-bin directory ==== #cgi-bin 247 263 248 264 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]. … … 256 272 }}} 257 273 274 275 ==== Mapping Static Resources ==== 276 277 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). 278 279 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. 280 281 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. 282 283 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: 284 [[TracAdminHelp(deploy)]] 285 286 The target `<directory>` will then contain an `htdocs` directory with: 287 - `site/` - a copy of the environment's directory `htdocs/` 288 - `common/` - the static resources of Trac itself 289 - `<plugins>/` - one directory for each resource directory managed by the plugins enabled for this environment 290 291 ===== Example: Apache and `ScriptAlias` ===== #ScriptAlias-example 292 293 Assuming the deployment has been done this way: 294 {{{ 295 $ trac-admin /var/trac/env deploy /path/to/trac/htdocs/common 296 }}} 297 298 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 {{{ 300 Alias /trac/chrome/common /path/to/trac/htdocs/common 301 Alias /trac/chrome/site /path/to/trac/htdocs/site 302 303 <Directory "/path/to/www/trac/htdocs"> 304 Order allow,deny 305 Allow from all 306 </Directory> 307 }}} 308 309 If using mod_python, you might want to add this too (otherwise, the alias will be ignored): 310 {{{ 311 <Location "/trac/chrome/common/"> 312 SetHandler None 313 </Location> 314 }}} 315 316 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. 317 318 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 {{{ 320 Alias /trac/chrome/site /path/to/projectenv/htdocs 321 322 <Directory "/path/to/projectenv/htdocs"> 323 Order allow,deny 324 Allow from all 325 </Directory> 326 }}} 327 328 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 {{{ 330 [trac] 331 htdocs_location = http://static.example.org/trac-common/ 332 }}} 333 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]). 334 335 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 {{{ 337 $ ln -s /path/to/trac/htdocs/common /var/www/static.example.org/trac-common 338 }}} 339 340 258 341 ==== Setting up the Plugin Cache ==== 259 342 … … 262 345 == Configuring Authentication == 263 346 264 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: 265 266 * TracStandalone if you use the standalone server, `tracd`. 267 * TracCgi if you use the CGI or FastCGI web front ends. 268 * [wiki:TracModWSGI] if you use the Apache mod_wsgi web front end. 269 * TracModPython if you use the Apache mod_python web front end. 270 271 272 == Automatic reference to the SVN changesets in Trac tickets == 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. 348 349 The process of adding, removing, and configuring user accounts for authentication depends on the specific way you run Trac. 350 351 Please refer to one of the following sections: 352 * TracStandalone#UsingAuthentication if you use the standalone server, `tracd`. 353 * [wiki:TracModWSGI#ConfiguringAuthentication TracModWSGI#ConfiguringAuthentication] if you use the Apache web server, with any of its front end: `mod_wsgi` of course, but the same instructions applies also for `mod_python`, `mod_fcgi` or `mod_fastcgi`. 354 * TracFastCgi if you're using another web server with FCGI support (Cherokee, Lighttpd, !LiteSpeed, nginx) 355 356 == Granting admin rights to the admin user 357 Grant admin rights to user admin: 358 {{{ 359 $ trac-admin /path/to/myproject permission add admin TRAC_ADMIN 360 }}} 361 This user will have an "Admin" entry menu that will allow you to admin your trac project. 362 363 == Finishing the install 364 365 === Automatic reference to the SVN changesets in Trac tickets === 273 366 274 367 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: … … 282 375 For more information, see the documentation of the `CommitTicketUpdater` component in the "Plugins" admin panel. 283 376 284 == Using Trac==377 === Using Trac === 285 378 286 379 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. 287 380 288 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.381 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. 289 382 290 383 '' Enjoy! '' … … 293 386 294 387 ---- 295 See also: [trac:TracInstallPlatforms TracInstallPlatforms], TracGuide, Trac Cgi, TracFastCgi, TracModPython, [wiki:TracModWSGI], TracUpgrade, TracPermissions388 See also: [trac:TracInstallPlatforms TracInstallPlatforms], TracGuide, TracUpgrade, TracPermissions