Changes between Version 439 and Version 440 of TracInstall
- Timestamp:
- Oct 15, 2019, 6:36:06 AM (5 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracInstall
v439 v440 1 = Trac Installation Guide for 1. 21 = Trac Installation Guide for 1.3 2 2 [[TracGuideToc]] 3 3 [[TranslatedPages]] 4 4 5 Trac is written in the Python programming language and needs a database, [https://sqlite.org/ SQLite], [https://www.postgresql.org/ PostgreSQL], or [https:// www.mysql.com/ MySQL]. For HTML rendering, Trac uses the [https://genshi.edgewall.org/ Genshi] templating system.5 Trac is written in the Python programming language and needs a database, [https://sqlite.org/ SQLite], [https://www.postgresql.org/ PostgreSQL], or [https://mysql.com/ MySQL]. For HTML rendering, Trac uses the [http://jinja.pocoo.org Jinja2] templating system, though Genshi templates will still be supported until at least Trac 1.5.1. 6 6 7 7 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 8 9 If you're interested in contributing new translations for other languages or enhancing the existing translations, thenplease have a look at [trac:wiki:TracL10N TracL10N].9 If you're interested in contributing new translations for other languages or enhancing the existing translations, please have a look at [trac:wiki:TracL10N TracL10N]. 10 10 11 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], please '''first read through these general instructions''' to get a good understanding of the tasks involved. … … 17 17 To install Trac, the following software packages must be installed: 18 18 19 * [https://www.python.org/ Python], version >= 2. 6and < 3.020 (note that we dropped the support for Python 2. 5in this release)19 * [https://www.python.org/ Python], version >= 2.7 and < 3.0 20 (note that we dropped the support for Python 2.6 in this release) 21 21 * [https://pypi.org/project/setuptools setuptools], version >= 0.6 22 * [https://pypi.org/project/Genshi Genshi], version >= 0.6 22 * [https://pypi.org/project/Jinja2 Jinja2], version >= 2.9.3 23 24 {{{#!div style="border: 1pt dotted; margin: 1em" 25 **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]. 26 }}} 23 27 24 28 You also need a database system and the corresponding python bindings. The database can be either SQLite, PostgreSQL or MySQL. … … 26 30 ==== For the SQLite database #ForSQLite 27 31 28 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 You already have the SQLite database bindings bundled with the standard distribution of Python (the `sqlite3` module). 29 33 30 34 Optionally, you may install a newer version of [https://pypi.org/project/pysqlite pysqlite] than the one provided by the Python distribution. See [trac:PySqlite#ThePysqlite2bindings PySqlite] for details. … … 33 37 34 38 You need to install the database and its Python bindings: 35 * [https://www.postgresql.org/ PostgreSQL], version 8.0or later39 * [https://www.postgresql.org/ PostgreSQL], version 9.1 or later 36 40 * [https://pypi.org/project/psycopg2 psycopg2], version 2.0 or later 37 41 … … 40 44 ==== For the MySQL database #ForMySQL 41 45 42 Trac works well with MySQL, provided you follow the guidelines:43 44 * [https:// www.mysql.com/ MySQL], version 5.0 or later45 * [https:// sf.net/projects/mysql-python MySQLdb], version 1.2.2 or later46 Trac works well with MySQL, provided you use the following: 47 48 * [https://mysql.com/ MySQL], version 5.0 or later 49 * [https://pypi.org/project/PyMySQL PyMySQL] 46 50 47 51 Given the caveats and known issues surrounding MySQL, read carefully the [trac:MySqlDb] page before creating the database. … … 53 57 [https://subversion.apache.org/ Subversion], 1.6.x or later and the '''''corresponding''''' Python bindings. 54 58 55 There are [https://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 [https://alagazam.net Alagazam], which works for me under Python 2.6.) 56 57 For troubleshooting information, see the [trac:TracSubversion#Troubleshooting TracSubversion] page. 59 There are [https://subversion.apache.org/packages.html pre-compiled SWIG bindings] available for various platforms. See [trac:TracSubversion#GettingSubversion getting Subversion] for more information. 58 60 59 61 {{{#!div style="border: 1pt dotted; margin: 1em" 60 62 **Note:** 61 63 * Trac '''doesn't''' use [http://pysvn.tigris.org/ PySVN], nor does it work yet with the newer `ctype`-style bindings. 62 * If using Subversion, Trac must be installed on the '''same machine'''. Remote repositories are currently [trac:ticket:493 not supported]. 63 }}} 64 * If using Subversion, Trac must be installed on the '''same machine'''. Remote repositories are [trac:ticket:493 not supported]. 65 }}} 66 67 For troubleshooting information, see the [trac:TracSubversion#Troubleshooting TracSubversion] page. 64 68 65 69 ==== Git … … 75 79 76 80 Alternatively you can configure Trac to run in any of the following environments: 77 * [https://httpd.apache.org/ Apache] with 78 * [https://github.com/GrahamDumpleton/mod_wsgi mod_wsgi], see [wiki:TracModWSGI] and [https://code.google.com/p/modwsgi/wiki/IntegrationWithTrac ModWSGI IntegrationWithTrac]. 79 * [http://modpython.org/ mod_python 3.5.0], see TracModPython 80 * a [https://fastcgi-archives.github.io/ FastCGI]-capable web server (see TracFastCgi) 81 * [https://httpd.apache.org/ Apache] with 82 - [https://github.com/GrahamDumpleton/mod_wsgi mod_wsgi], see [wiki:TracModWSGI] and 83 [https://code.google.com/p/modwsgi/wiki/IntegrationWithTrac ModWSGI IntegrationWithTrac]. 84 - [http://modpython.org/ mod_python 3.5.0], see TracModPython 85 * a [https://fastcgi-archives.github.io FastCGI]-capable web server (see TracFastCgi) 81 86 * an [https://tomcat.apache.org/connectors-doc/ajp/ajpv13a.html AJP]-capable web 82 87 server (see [trac:TracOnWindowsIisAjp TracOnWindowsIisAjp]) 83 88 * 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. 86 89 * a CGI-capable web server (see TracCgi), '''but usage of Trac as a cgi script 90 is highly discouraged''', better use one of the previous options. 91 87 92 88 93 ==== Other Python Packages 89 94 90 * [http://babel. edgewall.org Babel], version 0.9.6 or >= 1.3,95 * [http://babel.pocoo.org Babel], version 0.9.6 or >= 1.3, 91 96 needed for localization support 92 * [http://docutils.sourceforge.net / docutils], version >= 0.3.997 * [http://docutils.sourceforge.net docutils], version >= 0.3.9 93 98 for WikiRestructuredText. 94 * [http://pygments.org Pygments] for 99 * [http://pygments.org Pygments] for 95 100 [TracSyntaxColoring syntax highlighting]. 96 * [http://pytz.sf.net pytz] to get a complete list of time zones, 97 otherwise Trac will fall back on a shorter list from 101 * [https://pypi.org/project/textile Textile] for rendering the [https://github.com/textile/python-textile Textile markup language]. 102 * [http://pytz.sourceforge.net pytz] to get a complete list of time zones, 103 otherwise Trac will fall back on a shorter list from 98 104 an internal time zone implementation. 105 * [https://pypi.org/project/passlib passlib] on Windows to decode [TracStandalone#BasicAuthorization:Usingahtpasswdpasswordfile htpasswd formats] other than `SHA-1`. 106 * [https://pypi.org/project/pyreadline pyreadline] on Windows for trac-admin [TracAdmin#InteractiveMode command completion]. 99 107 100 108 {{{#!div style="border: 1pt dotted; margin: 1em" … … 110 118 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. 111 119 112 === Using `easy_install`113 Trac can be installed from PyPI or the Subversion repository using [https://pypi.org/project/setuptools setuptools].114 115 A few examples:116 117 - Install the latest stable version of Trac:118 {{{#!sh119 $ easy_install Trac120 }}}121 - Install latest development version:122 {{{#!sh123 $ easy_install https://download.edgewall.org/trac/Trac-latest-dev.tar.gz124 }}}125 Note that in this case you won't have the possibility to run a localized version of Trac;126 either use a released version or install from source127 128 More information can be found on the [trac:wiki:setuptools setuptools] page.129 130 {{{#!div style="border: 1pt dotted; margin: 1em"131 **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].132 }}}133 134 120 === Using `pip` 135 'pip' is an easy_install replacement that is very useful to quickly install python packages. 136 To get a Trac installation up and running in less than 5 minutes: 137 138 Assuming you want to have your entire pip installation in `/opt/user/trac` 139 140 {{{#!sh 141 $ pip install trac psycopg2 142 }}} 143 or 144 {{{#!sh 145 $ pip install trac mysql-python 146 }}} 147 148 Make sure your OS specific headers are available for pip to automatically build PostgreSQL (`libpq-dev`) or MySQL (`libmysqlclient-dev`) bindings. 149 150 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`. 151 152 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) 153 154 Additionally, you can install several Trac plugins (listed [https://pypi.python.org/pypi?:action=browse&show=all&c=516 here]) through pip. 155 156 === From source 157 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. 158 159 {{{#!sh 160 $ python ./setup.py install 161 }}} 162 163 ''You will need root permissions or equivalent for this step.'' 164 165 This will byte-compile the Python source code and install it as an .egg file or folder in the `site-packages` directory 166 of your Python installation. The .egg will also contain all other resources needed by standard Trac, such as `htdocs` and `templates`. 167 168 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): 169 {{{#!sh 170 $ python ./setup.py install 171 }}} 172 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`). 121 `pip` is the modern Python package manager and is included in Python 2.7.9 and later. Use [https://bootstrap.pypa.io/get-pip.py get-pip.py] to install `pip` for an earlier version of Python. 122 123 {{{#!sh 124 $ pip install Trac 125 }}} 126 127 `pip` will automatically resolve the //required// dependencies (Jinja2 and setuptools) and download the latest packages from pypi.org. 128 129 You can also install directly from a source package. You can obtain the source in a tar or zip from the [trac:TracDownload] page. After extracting the archive, change to the directory containing `setup.py` and run: 130 131 {{{#!sh 132 $ pip install . 133 }}} 134 135 `pip` supports numerous other install mechanisms. It can be passed the URL of an archive or other download location. Here are some examples: 136 137 * Install the latest stable version from a zip archive: 138 {{{#!sh 139 $ pip install https://download.edgewall.org/trac/Trac-latest.zip 140 }}} 141 * Install the latest development version from a tar archive: 142 {{{#!sh 143 $ pip install https://download.edgewall.org/trac/Trac-latest-dev.tar.gz 144 }}} 145 * Install the unreleased 1.2-stable from subversion: 146 {{{#!sh 147 $ pip install svn+https://svn.edgewall.org/repos/trac/branches/1.2-stable 148 }}} 149 * Install the latest development preview (//not recommended for production installs//): 150 {{{#!sh 151 $ pip install --find-links=https://trac.edgewall.org/wiki/TracDownload Trac 152 }}} 153 154 The optional dependencies can be installed from PyPI using `pip`: 155 {{{#!sh 156 $ pip install babel docutils pygments pytz textile 157 }}} 158 159 Additionally, you can install several Trac plugins from PyPI (listed [https://pypi.org/search/?c=Framework+%3A%3A+Trac here]) using pip. See TracPlugins for more information. 173 160 174 161 === Using installer … … 178 165 === Using package manager 179 166 180 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. 181 182 === Advanced `easy_install` Options 183 184 To install Trac to a custom location, or find out about other advanced installation options, run: 185 {{{#!sh 186 $ easy_install --help 187 }}} 188 189 Also see [https://docs.python.org/2/install/index.html Installing Python Modules] for detailed information. 190 191 Specifically, you might be interested in: 192 {{{#!sh 193 $ easy_install --prefix=/path/to/installdir 194 }}} 195 or, if installing Trac on a Mac OS X system: 196 {{{#!sh 197 $ easy_install --prefix=/usr/local --install-dir=/Library/Python/2.6/site-packages 198 }}} 199 200 {{{#!div style="border: 1pt dotted; margin: 1em" 201 **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. 202 203 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. 204 }}} 167 Trac may be available in your platform's package repository. However, your package manager may not provide the latest release of Trac. 205 168 206 169 == Creating a Project Environment … … 213 176 }}} 214 177 215 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. 178 [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. 216 179 217 180 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. 218 181 219 182 Also note that the values you specify here can be changed later using TracAdmin or directly editing the [TracIni conf/trac.ini] configuration file. 220 221 {{{#!div style="border: 1pt dotted; margin: 1em"222 **Filesystem Warning:** 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, or HFS+ on OSX), 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.223 }}}224 183 225 184 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: … … 261 220 }}} 262 221 263 Then, fire upa 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:222 Then, open 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: 264 223 {{{#!sh 265 224 $ tracd -s --port 8000 /path/to/myproject … … 268 227 === Running Trac on a Web Server 269 228 270 Trac provides various options for connecting to a "real" web server: 229 Trac provides various options for connecting to a "real" web server: 271 230 - [TracFastCgi FastCGI] 272 - [wiki:TracModWSGI Apache with mod_wsgi] 231 - [wiki:TracModWSGI Apache with mod_wsgi] 273 232 - [TracModPython Apache with mod_python] 274 233 - [TracCgi CGI] //(should not be used, as the performance is far from optimal)// … … 365 324 }}} 366 325 367 Another alternative to aliasing `/trac/chrome/common` is having Trac generate direct links for those static resources (and only those), using the [TracIni#trac- sectionhtdocs_location] configuration setting:326 Another alternative to aliasing `/trac/chrome/common` is having Trac generate direct links for those static resources (and only those), using the [TracIni#trac-htdocs_location-option trac.htdocs_location] configuration setting: 368 327 {{{#!ini 369 328 [trac] … … 378 337 }}} 379 338 380 ==== Setting up the Plugin Cache #egg-cache339 ==== Setting up the Plugin Cache 381 340 382 341 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. 383 342 384 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.385 386 343 == Configuring Authentication 387 344 388 345 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. 389 346 390 The process of adding, removing, and configuring user accounts for authentication depends on the specific way you run Trac. 347 The process of adding, removing, and configuring user accounts for authentication depends on the specific way you run Trac. 391 348 392 349 Please refer to one of the following sections: … … 407 364 == Configuring Trac 408 365 366 Configuration options are documented on the TracIni page. 367 409 368 TracRepositoryAdmin provides information on configuring version control repositories for your project. 410 369 370 In addition to the optional version control backends, Trac provides several optional features that are disabled by default: 371 * [TracFineGrainedPermissions#AuthzPolicy Fine-grained permission policy] 372 * [TracPermissions#CreatingNewPrivileges Custom permissions] 373 * [TracTickets#deleter Ticket deletion] 374 * [TracTickets#cloner Ticket cloning] 375 * [TracRepositoryAdmin#CommitTicketUpdater Ticket changeset references] 376 411 377 == Using Trac 412 378 … … 420 386 421 387 ---- 422 See also: [trac:TracInstallPlatforms TracInstallPlatforms], TracGuide, TracUpgrade , TracPermissions388 See also: [trac:TracInstallPlatforms TracInstallPlatforms], TracGuide, TracUpgrade