Changes between Version 427 and Version 428 of TracInstall
- Timestamp:
- Nov 14, 2016, 1:30:34 AM (7 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracInstall
v427 v428 1 = Trac Installation Guide for 1.0 2 1 = Trac Installation Guide for 1.1 3 2 [[TracGuideToc]] 4 [[TranslatedPages]]5 3 6 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. 7 5 8 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. 9 7 10 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]. 11 9 12 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. 13 11 14 12 [[PageOutline(2-3,Installation Steps,inline)]] 15 13 16 14 == Dependencies 17 18 15 === Mandatory Dependencies 19 20 16 To install Trac, the following software packages must be installed: 21 17 22 * [http://www.python.org/ Python], version >= 2. 5and < 3.023 (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) 24 20 * [http://pypi.python.org/pypi/setuptools setuptools], version >= 0.6 25 21 * [http://genshi.edgewall.org/wiki/Download Genshi], version >= 0.6 … … 29 25 ==== For the SQLite database #ForSQLite 30 26 31 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). 32 28 33 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. … … 45 41 Trac works well with MySQL, provided you follow the guidelines: 46 42 47 * [http://mysql.com/ MySQL] or [http://mariadb.org/ MariaDB], version 5.0 or later43 * [http://mysql.com/ MySQL], version 5.0 or later 48 44 * [http://sf.net/projects/mysql-python MySQLdb], version 1.2.2 or later 49 45 50 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. 51 47 52 48 === Optional Dependencies 53 49 54 ==== Version Control System 55 56 ===== Subversion 57 * [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. 58 53 59 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.) 60 55 61 Note that Trac '''doesn't''' use [http://pysvn.tigris.org/ PySVN], neither does it work yet with the newer `ctype`-style bindings. 62 63 '''Note:''' if using Subversion, Trac must be installed on the '''same machine'''. Remote repositories are currently [trac:ticket:493 not supported]. 64 65 ===== Git 66 * [http://git-scm.com/ Git] 1.5.6 or later. 67 68 More information is available on the [trac:TracGit] page. 69 70 ===== Others 71 72 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]. 73 71 74 72 ==== Web Server 75 76 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. 77 74 78 75 Alternatively you can configure Trac to run in any of the following environments: 79 76 * [http://httpd.apache.org/ Apache] with 80 - [http ://code.google.com/p/modwsgi/mod_wsgi], see [wiki:TracModWSGI] and81 http://code.google.com/p/modwsgi/wiki/IntegrationWithTrac77 - [https://github.com/GrahamDumpleton/mod_wsgi mod_wsgi], see [wiki:TracModWSGI] and 78 [http://code.google.com/p/modwsgi/wiki/IntegrationWithTrac ModWSGI IntegrationWithTrac]. 82 79 - [http://modpython.org/ mod_python 3.5.0], see TracModPython 83 80 * a [http://www.fastcgi.com/ FastCGI]-capable web server (see TracFastCgi) 84 81 * an [http://tomcat.apache.org/connectors-doc/ajp/ajpv13a.html AJP]-capable web 85 82 server (see [trac:TracOnWindowsIisAjp TracOnWindowsIisAjp]) 86 * a FastCGI and FastCGI-to-WSGI gateway (see [trac:TracOnWindowsIisWfastcgi])87 * a CGI-capable web server (see TracCgi), but //usage of Trac as a cgi script88 is highly discouraged //, better use one of the previous options.83 * Microsoft IIS with FastCGI and a FastCGI-to-WSGI gateway (see [trac:CookBook/Installation/TracOnWindowsIisWfastcgi IIS with FastCGI]) 84 * a CGI-capable web server (see TracCgi), '''but usage of Trac as a cgi script 85 is highly discouraged''', better use one of the previous options. 89 86 87 90 88 ==== Other Python Packages 91 89 92 * [http://babel.edgewall.org Babel], version 0.9. 5, 0.9.6 or >= 1.390 * [http://babel.edgewall.org Babel], version 0.9.6 or >= 1.3, 93 91 needed for localization support 94 92 * [http://docutils.sourceforge.net/ docutils], version >= 0.3.9 … … 96 94 * [http://pygments.org Pygments] for 97 95 [TracSyntaxColoring syntax highlighting]. 98 [http://silvercity.sourceforge.net/ SilverCity] and/or99 [http://gnu.org/software/enscript/enscript.html Enscript] may still be used100 but are deprecated and you really should be using Pygments.101 96 * [http://pytz.sf.net pytz] to get a complete list of time zones, 102 97 otherwise Trac will fall back on a shorter list from … … 107 102 }}} 108 103 109 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.104 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''. 110 105 111 106 == Installing Trac … … 113 108 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. 114 109 115 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.110 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. 116 111 117 112 === Using `easy_install` 118 119 Trac can be installed from [https://pypi.python.org/pypi/Trac PyPI] or the Subversion repository using [http://pypi.python.org/pypi/setuptools setuptools]. 120 121 A few command-line examples: 113 Trac can be installed from PyPI or the Subversion repository using [http://pypi.python.org/pypi/setuptools setuptools]. 114 115 A few examples: 122 116 123 117 - Install the latest stable version of Trac: … … 130 124 }}} 131 125 Note that in this case you won't have the possibility to run a localized version of Trac; 132 either use a released version or install from source .126 either use a released version or install from source 133 127 134 128 More information can be found on the [trac:wiki:setuptools setuptools] page. … … 139 133 140 134 === Using `pip` 141 142 'pip' is an easy_install replacement that is very useful to quickly install Python packages. 135 'pip' is an easy_install replacement that is very useful to quickly install python packages. 143 136 To get a Trac installation up and running in less than 5 minutes: 144 137 145 Assuming you want to have your entire pip installation in `/opt/user/trac` :138 Assuming you want to have your entire pip installation in `/opt/user/trac` 146 139 147 140 - 148 141 {{{#!sh 149 $pip install trac psycopg2150 }}} 151 or :142 pip install trac psycopg2 143 }}} 144 or 152 145 - 153 146 {{{#!sh 154 $pip install trac mysql-python147 pip install trac mysql-python 155 148 }}} 156 149 … … 159 152 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`. 160 153 161 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) .154 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) 162 155 163 156 Additionally, you can install several Trac plugins (listed [https://pypi.python.org/pypi?:action=browse&show=all&c=516 here]) through pip. 164 157 165 158 === From source 166 167 159 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. 168 160 … … 171 163 }}} 172 164 173 You will need root permissions or equivalent for this step. 165 ''You will need root permissions or equivalent for this step.'' 174 166 175 167 This will byte-compile the Python source code and install it as an .egg file or folder in the `site-packages` directory … … 180 172 $ python ./setup.py install 181 173 }}} 182 183 174 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`). 184 175 185 176 === Using installer 186 177 187 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.178 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. 188 179 189 180 === Using package manager 190 181 191 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.182 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. 192 183 193 184 === Advanced `easy_install` Options … … 195 186 To install Trac to a custom location, or find out about other advanced installation options, run: 196 187 {{{#!sh 197 $easy_install --help188 easy_install --help 198 189 }}} 199 190 … … 202 193 Specifically, you might be interested in: 203 194 {{{#!sh 204 $ easy_install --prefix=/path/to/installdir 205 }}} 206 195 easy_install --prefix=/path/to/installdir 196 }}} 207 197 or, if installing Trac on a Mac OS X system: 208 198 {{{#!sh 209 $ easy_install --prefix=/usr/local --install-dir=/Library/Python/2.5/site-packages 210 }}} 211 212 '''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. 213 214 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. 199 easy_install --prefix=/usr/local --install-dir=/Library/Python/2.6/site-packages 200 }}} 201 202 {{{#!div style="border: 1pt dotted; margin: 1em" 203 **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. 204 205 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. 206 }}} 215 207 216 208 == Creating a Project Environment 217 209 218 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.210 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. 219 211 220 212 A new environment is created using [TracAdmin trac-admin]: … … 223 215 }}} 224 216 225 [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. 226 227 Using the default database connection string in particular will always work as long as you have SQLite installed. 228 For the other [trac:DatabaseBackend database backends] you should plan ahead and already have a database ready to use at this point. 229 230 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. 231 232 Also note that the values you specify here can be changed later by directly editing the [TracIni conf/trac.ini] configuration file. 217 [TracAdmin trac-admin] will prompt you for the information it needs 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. 218 219 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. 220 221 Also note that the values you specify here can be changed later using TracAdmin or directly editing the [TracIni conf/trac.ini] configuration file. 233 222 234 223 {{{#!div style="border: 1pt dotted; margin: 1em" … … 238 227 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: 239 228 {{{#!sh 240 $ chown -R apache .apache /path/to/myproject241 }}} 242 243 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).229 $ chown -R apache:apache /path/to/myproject 230 }}} 231 232 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). 244 233 245 234 {{{#!div class=important … … 285 274 - [wiki:TracModWSGI Apache with mod_wsgi] 286 275 - [TracModPython Apache with mod_python] 287 - //[TracCgi CGI] : should not be used, as it degrades performance//276 - //[TracCgi CGI] (should not be used, as the performance is far from optimal)// 288 277 289 278 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. … … 295 284 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: 296 285 {{{#!sh 297 $ mkdir -p /usr/share/trac/projects/my-project 298 $ trac-admin /usr/share/trac/projects/my-project initenv 299 $ trac-admin /usr/share/trac/projects/my-project deploy /tmp/deploy 300 $ mv /tmp/deploy/* /usr/share/trac 301 }}} 302 286 mkdir -p /usr/share/trac/projects/my-project 287 trac-admin /usr/share/trac/projects/my-project initenv 288 trac-admin /usr/share/trac/projects/my-project deploy /tmp/deploy 289 mv /tmp/deploy/* /usr/share/trac 290 }}} 303 291 Don't forget to check that the web server has the execution right on scripts in the `/usr/share/trac/cgi-bin` directory. 304 292 … … 403 391 Please refer to one of the following sections: 404 392 * TracStandalone#UsingAuthentication if you use the standalone server, `tracd`. 405 * [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`.406 * TracFastCgi if you are using another web server with FCGI support, such as Cherokee, Lighttpd, !LiteSpeed, nginx.407 408 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. 409 397 410 398 == Granting admin rights to the admin user 411 412 399 Grant admin rights to user admin: 413 400 {{{#!sh … … 415 402 }}} 416 403 417 This user will have an "Admin" entry menu that will allow you to administrate your Trac project. 418 419 == Finishing the install 420 421 === Enable version control components 422 423 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. 424 425 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: 426 427 {{{#!ini 428 [components] 429 tracopt.versioncontrol.svn.* = enabled 430 }}} 431 432 {{{#!ini 433 [components] 434 tracopt.versioncontrol.git.* = enabled 435 }}} 436 437 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]. 438 439 === 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 440 411 441 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.