Changes between Version 2 and Version 3 of TracInstall


Ignore:
Timestamp:
09/06/22 11:37:41 (2 years ago)
Author:
trac
Comment:

—

Legend:

Unmodified
Added
Removed
Modified

  • TracInstall

    v2 v3  
    1 = Trac Installation Guide for 1.2
     1= Trac Installation Guide for 1.4
    22[[TracGuideToc]]
    33
    4 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.
     4Trac 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 are supported until Trac 1.5.1.
    55
    66Trac 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.
    77
    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].
     8If you're interested in contributing new translations for other languages or enhancing the existing translations, please have a look at [trac:wiki:TracL10N TracL10N].
    99
    1010What 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.
    … …  
    1616To install Trac, the following software packages must be installed:
    1717
    18  * [https://www.python.org/ Python], version >= 2.6 and < 3.0
    19    (note that we dropped the support for Python 2.5 in this release)
     18 * [https://www.python.org/ Python], version >= 2.7 and < 3.0
     19   (note that we dropped the support for Python 2.6 in this release)
    2020 * [https://pypi.org/project/setuptools setuptools], version >= 0.6
    21  * [https://pypi.org/project/Genshi Genshi], version >= 0.6
     21 * [https://pypi.org/project/Jinja2 Jinja2], version >= 2.9.3
     22
     23{{{#!div style="border: 1pt dotted; margin: 1em"
     24**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].
     25}}}
    2226
    2327You also need a database system and the corresponding python bindings. The database can be either SQLite, PostgreSQL or MySQL.
    … …  
    2529==== For the SQLite database #ForSQLite
    2630
    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).
     31You already have the SQLite database bindings bundled with the standard distribution of Python (the `sqlite3` module).
    2832
    2933Optionally, 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.
    … …  
    3236
    3337You need to install the database and its Python bindings:
    34  * [https://www.postgresql.org/ PostgreSQL], version 8.0 or later
     38 * [https://www.postgresql.org/ PostgreSQL], version 9.1 or later
    3539 * [https://pypi.org/project/psycopg2 psycopg2], version 2.0 or later
    3640
    … …  
    3943==== For the MySQL database #ForMySQL
    4044
    41 Trac works well with MySQL, provided you follow the guidelines:
    42 
    43  * [https://www.mysql.com/ MySQL], version 5.0 or later
    44  * [https://sf.net/projects/mysql-python MySQLdb], version 1.2.2 or later
     45Trac works well with MySQL, provided you use the following:
     46
     47 * [https://mysql.com/ MySQL], version 5.0 or later
     48 * [https://pypi.org/project/PyMySQL PyMySQL]
    4549
    4650Given the caveats and known issues surrounding MySQL, read carefully the [trac:MySqlDb] page before creating the database.
    … …  
    5256[https://subversion.apache.org/ Subversion], 1.6.x or later and the '''''corresponding''''' Python bindings.
    5357
    54 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.)
    55 
    56 For troubleshooting information, see the [trac:TracSubversion#Troubleshooting TracSubversion] page.
     58There are [https://subversion.apache.org/packages.html pre-compiled SWIG bindings] available for various platforms. See [trac:TracSubversion#GettingSubversion getting Subversion] for more information.
    5759
    5860{{{#!div style="border: 1pt dotted; margin: 1em"
    5961**Note:**
    6062* 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* If using Subversion, Trac must be installed on the '''same machine'''. Remote repositories are [trac:ticket:493 not supported].
     64}}}
     65
     66For troubleshooting information, see the [trac:TracSubversion#Troubleshooting TracSubversion] page.
    6367
    6468==== Git
    … …  
    7478
    7579Alternatively you can configure Trac to run in any of the following environments:
    76  * [https://httpd.apache.org/ Apache] with
    77   * [https://github.com/GrahamDumpleton/mod_wsgi mod_wsgi], see [wiki:TracModWSGI] and [https://code.google.com/p/modwsgi/wiki/IntegrationWithTrac ModWSGI IntegrationWithTrac].
    78   * [http://modpython.org/ mod_python 3.5.0], see TracModPython
    79  * a [https://fastcgi-archives.github.io/ FastCGI]-capable web server (see TracFastCgi)
     80 * [https://httpd.apache.org/ Apache] with
     81   - [https://github.com/GrahamDumpleton/mod_wsgi mod_wsgi], see [wiki:TracModWSGI] and
     82     [https://code.google.com/p/modwsgi/wiki/IntegrationWithTrac ModWSGI IntegrationWithTrac].
     83   - [http://modpython.org/ mod_python 3.5.0], see TracModPython
     84 * a [https://fastcgi-archives.github.io FastCGI]-capable web server (see TracFastCgi)
    8085 * an [https://tomcat.apache.org/connectors-doc/ajp/ajpv13a.html AJP]-capable web
    8186   server (see [trac:TracOnWindowsIisAjp TracOnWindowsIisAjp])
    8287 * Microsoft IIS with FastCGI and a FastCGI-to-WSGI gateway (see [trac:CookBook/Installation/TracOnWindowsIisWfastcgi IIS with FastCGI])
    83  * a CGI-capable web server (see TracCgi), '''but usage of Trac as a cgi script 
    84    is highly discouraged''', better use one of the previous options. 
    85    
     88 * a CGI-capable web server (see TracCgi), '''but usage of Trac as a cgi script
     89   is highly discouraged''', better use one of the previous options.
     90
    8691
    8792==== Other Python Packages
    8893
    89  * [http://babel.edgewall.org Babel], version 0.9.6 or >= 1.3,
     94 * [http://babel.pocoo.org Babel], version 0.9.6 or >= 1.3,
    9095   needed for localization support
    91  * [http://docutils.sourceforge.net/ docutils], version >= 0.3.9
     96 * [http://pytz.sourceforge.net pytz] to get a complete list of time zones,
     97   otherwise Trac will fall back on a shorter list from
     98   an internal time zone implementation. Installing Babel
     99   will install pytz.
     100 * [http://docutils.sourceforge.net docutils], version >= 0.3.9
    92101   for WikiRestructuredText.
    93  * [http://pygments.org Pygments] for 
     102 * [http://pygments.org Pygments] for
    94103   [TracSyntaxColoring syntax highlighting].
    95  * [http://pytz.sf.net pytz] to get a complete list of time zones,
    96    otherwise Trac will fall back on a shorter list from
    97    an internal time zone implementation.
     104 * [https://pypi.org/project/textile Textile] for rendering the [https://github.com/textile/python-textile Textile markup language].
     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].
    98107
    99108{{{#!div style="border: 1pt dotted; margin: 1em"
    … …  
    109118It 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.
    110119
    111 === Using `easy_install`
    112 Trac can be installed from PyPI or the Subversion repository using [https://pypi.org/project/setuptools setuptools].
    113 
    114 A few examples:
    115 
    116  - Install the latest stable version of Trac:
    117  {{{#!sh
    118 $ easy_install Trac
    119 }}}
    120  - Install latest development version:
    121  {{{#!sh
    122 $ easy_install https://download.edgewall.org/trac/Trac-latest-dev.tar.gz
    123 }}}
    124    Note that in this case you won't have the possibility to run a localized version of Trac;
    125    either use a released version or install from source
    126 
    127 More information can be found on the [trac:wiki:setuptools setuptools] page.
    128 
    129 {{{#!div style="border: 1pt dotted; margin: 1em"
    130 **Setuptools Warning:** If the version of your setuptools is in the range 5.4 through 5.6, the environment variable `PKG_RESOURCES_CACHE_ZIP_MANIFESTS` must be set in order to avoid significant performance degradation. More information may be found in [#DeployingTrac Deploying Trac].
    131 }}}
    132 
    133120=== Using `pip`
    134 'pip' is an easy_install replacement that is very useful to quickly install python packages.
    135 To get a Trac installation up and running in less than 5 minutes:
    136 
    137 Assuming you want to have your entire pip installation in `/opt/user/trac`
    138 
    139  {{{#!sh
    140 $ pip install trac psycopg2
    141 }}}
    142 or
    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.
    148 
    149 pip will automatically resolve all dependencies (like Genshi, pygments, etc.), download the latest packages from pypi.python.org and create a self contained installation in `/opt/user/trac`.
    150 
    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)
    152 
    153 Additionally, you can install several Trac plugins (listed [https://pypi.python.org/pypi?:action=browse&show=all&c=516 here]) through pip.
    154 
    155 === From source
    156 Using the python-typical setup at the top of the source directory also works. You can obtain the source for a .tar.gz or .zip file corresponding to a release (e.g. `Trac-1.0.tar.gz`) from the [trac:TracDownload] page, or you can get the source directly from the repository. See [trac:TracRepositories#OfficialSubversionrepository TracRepositories] for details.
    157 
    158 {{{#!sh
    159 $ python ./setup.py install
    160 }}}
    161 
    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`.
    166 
    167 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):
    168 {{{#!sh
    169 $ python ./setup.py install
    170 }}}
    171 Alternatively, you can run `bdist_egg` and copy the .egg from `dist/` to the place of your choice, or you can create a Windows installer (`bdist_wininst`).
     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
     129You 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
     154The optional dependencies can be installed from PyPI using `pip`:
     155{{{#!sh
     156$ pip install babel docutils pygments textile
     157}}}
     158
     159The optional dependencies can alternatively be
     160specified using the `extras` keys in the setup file:
     161{{{#!sh
     162$ pip install Trac[babel,rest,pygments,textile]
     163}}}
     164
     165`rest` is the extra that installs the `docutils`
     166dependency.
     167
     168Include `mysql` or `psycopg2-binary` in the
     169list if using the MySQL or PostgreSQL database.
     170
     171Additionally, 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.
    172172
    173173=== Using installer
    … …  
    177177=== Using package manager
    178178
    179 Trac may be available in your platform's package repository. Note however, that the version provided by your package manager may not be the latest release.
    180 
    181 === Advanced `easy_install` Options
    182 
    183 To install Trac to a custom location, or find out about other advanced installation options, run:
    184 {{{#!sh
    185 $ easy_install --help
    186 }}}
    187 
    188 Also see [https://docs.python.org/2/install/index.html Installing Python Modules] for detailed information.
    189 
    190 Specifically, you might be interested in:
    191 {{{#!sh
    192 $ easy_install --prefix=/path/to/installdir
    193 }}}
    194 or, if installing Trac on a Mac OS X system:
    195 {{{#!sh
    196 $ easy_install --prefix=/usr/local --install-dir=/Library/Python/2.6/site-packages
    197 }}}
    198 
    199 {{{#!div style="border: 1pt dotted; margin: 1em"
    200 **Mac OS X Note:** On Mac OS X 10.6,  running `easy_install trac` will install into `/usr/local` and `/Library/Python/2.6/site-packages` by default.
    201 
    202 The `tracd` and `trac-admin` commands will be placed in `/usr/local/bin` and will install the Trac libraries and dependencies into `/Library/Python/2.6/site-packages`, which is Apple's preferred location for third-party Python application installations.
    203 }}}
     179Trac may be available in your platform's package repository. However, your package manager may not provide the latest release of Trac.
    204180
    205181== Creating a Project Environment
    … …  
    212188}}}
    213189
    214 You will be prompted for the information needed to create the environment: the name of the project and the [TracEnvironment#DatabaseConnectionStrings database connection string]. If you're not sure what to specify for any of these options, just press `<Enter>` to use the default value.
     190[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.
    215191
    216192Using 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.
    217193
    218194Also note that the values you specify here can be changed later using TracAdmin or directly editing the [TracIni conf/trac.ini] configuration file.
    219 
    220 {{{#!div style="border: 1pt dotted; margin: 1em"
    221 **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.
    222 }}}
    223195
    224196Finally, 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:
    … …  
    260232}}}
    261233
    262 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:
     234Then, 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:
    263235{{{#!sh
    264236$ tracd -s --port 8000 /path/to/myproject
    … …  
    267239=== Running Trac on a Web Server
    268240
    269 Trac provides various options for connecting to a "real" web server: 
     241Trac provides various options for connecting to a "real" web server:
    270242 - [TracFastCgi FastCGI]
    271  - [wiki:TracModWSGI Apache with mod_wsgi] 
     243 - [wiki:TracModWSGI Apache with mod_wsgi]
    272244 - [TracModPython Apache with mod_python]
    273245 - [TracCgi CGI] //(should not be used, as the performance is far from optimal)//
    … …  
    364336}}}
    365337
    366 Another alternative to aliasing `/trac/chrome/common` is having Trac generate direct links for those static resources (and only those), using the [TracIni#trac-section htdocs_location] configuration setting:
     338Another 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:
    367339{{{#!ini
    368340[trac]
    … …  
    377349}}}
    378350
    379 ==== Setting up the Plugin Cache #egg-cache
     351==== Setting up the Plugin Cache
    380352
    381353Some 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.
    382354
    383 If you setup hook scripts that call Trac, such as the Subversion post-commit hook script provided in the `/contrib` directory, make sure you define the `PYTHON_EGG_CACHE` environment variable within these scripts as well.
    384 
    385355== Configuring Authentication
    386356
    387357Trac 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.
    388358
    389 The process of adding, removing, and configuring user accounts for authentication depends on the specific way you run Trac. 
     359The process of adding, removing, and configuring user accounts for authentication depends on the specific way you run Trac.
    390360
    391361Please refer to one of the following sections:
    … …  
    406376== Configuring Trac
    407377
     378Configuration options are documented on the TracIni page.
     379
    408380TracRepositoryAdmin provides information on configuring version control repositories for your project.
    409381
     382In addition to the optional version control backends, Trac provides several optional features that are disabled by default:
     383* [TracFineGrainedPermissions#AuthzPolicy Fine-grained permission policy]
     384* [TracPermissions#CreatingNewPrivileges Custom permissions]
     385* [TracTickets#deleter Ticket deletion]
     386* [TracTickets#cloner Ticket cloning]
     387* [TracRepositoryAdmin#CommitTicketUpdater Ticket changeset references]
     388
    410389== Using Trac
    411390
    … …  
    419398
    420399----
    421 See also: [trac:TracInstallPlatforms TracInstallPlatforms], TracGuide, TracUpgrade, TracPermissions
     400See also: [trac:TracInstallPlatforms TracInstallPlatforms], TracGuide, TracUpgrade