Changes between Version 7 and Version 8 of TracInstall


Ignore:
Timestamp:
09/14/2019 03:12:53 PM (5 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracInstall

    v7 v8  
    1 = Trac Installation Guide for 1.1
     1= Trac Installation Guide for 1.3
    22[[TracGuideToc]]
    33
    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.
     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 will still be supported until at least 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  * [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)
    20  * [http://pypi.python.org/pypi/setuptools setuptools], version >= 0.6
    21  * [http://genshi.edgewall.org/wiki/Download Genshi], version >= 0.6
     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)
     20 * [https://pypi.org/project/setuptools setuptools], 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).
    28 
    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.
     31You already have the SQLite database bindings bundled with the standard distribution of Python (the `sqlite3` module).
     32
     33Optionally, 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.
    3034
    3135==== For the PostgreSQL database #ForPostgreSQL
    3236
    3337You need to install the database and its Python bindings:
    34  * [http://www.postgresql.org/ PostgreSQL], version 8.0 or later
    35  * [http://pypi.python.org/pypi/psycopg2 psycopg2], version 2.0 or later
     38 * [https://www.postgresql.org/ PostgreSQL], version 9.1 or later
     39 * [https://pypi.org/project/psycopg2 psycopg2], version 2.0 or later
    3640
    3741See [trac:DatabaseBackend#Postgresql DatabaseBackend] for details.
    … …  
    3943==== For the MySQL database #ForMySQL
    4044
    41 Trac works well with MySQL, provided you follow the guidelines:
    42 
    43  * [http://mysql.com/ MySQL], version 5.0 or later
    44  * [http://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.
    … …  
    5054==== Subversion
    5155
    52 [http://subversion.apache.org/ Subversion], 1.6.x or later and the '''''corresponding''''' Python bindings.
    53 
    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.)
    55 
    56 For troubleshooting information, see the [trac:TracSubversion#Troubleshooting TracSubversion] page.
     56[https://subversion.apache.org/ Subversion], 1.6.x or later and the '''''corresponding''''' Python bindings.
     57
     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
    6569
    66 [http://git-scm.com/ Git] 1.5.6 or later is supported. More information is available on the [trac:TracGit] page.
     70[https://git-scm.com/ Git] 1.5.6 or later is supported. More information is available on the [trac:TracGit] page.
    6771
    6872==== Other Version Control Systems
    … …  
    7478
    7579Alternatively you can configure Trac to run in any of the following environments:
    76  * [http://httpd.apache.org/ Apache] with
     80 * [https://httpd.apache.org/ Apache] with
    7781   - [https://github.com/GrahamDumpleton/mod_wsgi mod_wsgi], see [wiki:TracModWSGI] and
    78      [http://code.google.com/p/modwsgi/wiki/IntegrationWithTrac ModWSGI IntegrationWithTrac].
     82     [https://code.google.com/p/modwsgi/wiki/IntegrationWithTrac ModWSGI IntegrationWithTrac].
    7983   - [http://modpython.org/ mod_python 3.5.0], see TracModPython
    80  * a [http://www.fastcgi.com/ FastCGI]-capable web server (see TracFastCgi)
    81  * an [http://tomcat.apache.org/connectors-doc/ajp/ajpv13a.html AJP]-capable web
     84 * a [https://fastcgi-archives.github.io FastCGI]-capable web server (see TracFastCgi)
     85 * an [https://tomcat.apache.org/connectors-doc/ajp/ajpv13a.html AJP]-capable web
    8286   server (see [trac:TracOnWindowsIisAjp TracOnWindowsIisAjp])
    8387 * Microsoft IIS with FastCGI and a FastCGI-to-WSGI gateway (see [trac:CookBook/Installation/TracOnWindowsIisWfastcgi IIS with FastCGI])
    … …  
    8892==== Other Python Packages
    8993
    90  * [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,
    9195   needed for localization support
    92  * [http://docutils.sourceforge.net/ docutils], version >= 0.3.9
     96 * [http://docutils.sourceforge.net docutils], version >= 0.3.9
    9397   for WikiRestructuredText.
    9498 * [http://pygments.org Pygments] for
    9599   [TracSyntaxColoring syntax highlighting].
    96  * [http://pytz.sf.net pytz] to get a complete list of time zones,
     100 * [https://pypi.org/project/textile Textile] for rendering the [https://github.com/textile/python-textile Textile markup language].
     101 * [http://pytz.sourceforge.net pytz] to get a complete list of time zones,
    97102   otherwise Trac will fall back on a shorter list from
    98103   an internal time zone implementation.
     104 * [https://pypi.org/project/passlib passlib] on Windows to decode [TracStandalone#BasicAuthorization:Usingahtpasswdpasswordfile htpasswd formats] other than `SHA-1`.
     105 * [https://pypi.org/project/pyreadline pyreadline] on Windows for trac-admin [TracAdmin#InteractiveMode command completion].
    99106
    100107{{{#!div style="border: 1pt dotted; margin: 1em"
    … …  
    110117It 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.
    111118
    112 === Using `easy_install`
    113 Trac can be installed from PyPI or the Subversion repository using [http://pypi.python.org/pypi/setuptools setuptools].
    114 
    115 A few examples:
    116 
    117  - Install the latest stable version of Trac:
    118  {{{#!sh
    119 $ easy_install Trac
    120 }}}
    121  - Install latest development version:
    122  {{{#!sh
    123 $ easy_install http://download.edgewall.org/trac/Trac-latest-dev.tar.gz
    124 }}}
    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 source
    127 
    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 
    134119=== 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  -
    141  {{{#!sh
    142 pip install trac psycopg2
    143 }}}
    144 or
    145  -
    146  {{{#!sh
    147 pip install trac mysql-python
    148 }}}
    149 
    150 Make sure your OS specific headers are available for pip to automatically build PostgreSQL (`libpq-dev`) or MySQL (`libmysqlclient-dev`) bindings.
    151 
    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`.
    153 
    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)
    155 
    156 Additionally, you can install several Trac plugins (listed [https://pypi.python.org/pypi?:action=browse&show=all&c=516 here]) through pip.
    157 
    158 === From source
    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.
    160 
    161 {{{#!sh
    162 $ python ./setup.py install
    163 }}}
    164 
    165 ''You will need root permissions or equivalent for this step.''
    166 
    167 This will byte-compile the Python source code and install it as an .egg file or folder in the `site-packages` directory
    168 of your Python installation. The .egg will also contain all other resources needed by standard Trac, such as `htdocs` and `templates`.
    169 
    170 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):
    171 {{{#!sh
    172 $ python ./setup.py install
    173 }}}
    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`).
     120`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.
     121
     122{{{#!sh
     123$ pip install Trac
     124}}}
     125
     126`pip` will automatically resolve the //required// dependencies (Jinja2 and setuptools) and download the latest packages from pypi.org.
     127
     128You 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:
     129
     130{{{#!sh
     131$ pip install .
     132}}}
     133
     134`pip` supports numerous other install mechanisms. It can be passed the URL of an archive or other download location. Here are some examples:
     135
     136* Install the latest stable version from a zip archive:
     137{{{#!sh
     138$ pip install https://download.edgewall.org/trac/Trac-latest.zip
     139}}}
     140* Install the latest development version from a tar archive:
     141{{{#!sh
     142$ pip install https://download.edgewall.org/trac/Trac-latest-dev.tar.gz
     143}}}
     144* Install the unreleased 1.2-stable from subversion:
     145{{{#!sh
     146$ pip install svn+https://svn.edgewall.org/repos/trac/branches/1.2-stable
     147}}}
     148* Install the latest development preview (//not recommended for production installs//):
     149{{{#!sh
     150$ pip install --find-links=https://trac.edgewall.org/wiki/TracDownload Trac
     151}}}
     152
     153The optional dependencies can be installed from PyPI using `pip`:
     154{{{#!sh
     155$ pip install babel docutils pygments pytz textile
     156}}}
     157
     158Additionally, 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.
    175159
    176160=== Using installer
    … …  
    180164=== Using package manager
    181165
    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.
    183 
    184 === Advanced `easy_install` Options
    185 
    186 To install Trac to a custom location, or find out about other advanced installation options, run:
    187 {{{#!sh
    188 easy_install --help
    189 }}}
    190 
    191 Also see [http://docs.python.org/2/install/index.html Installing Python Modules] for detailed information.
    192 
    193 Specifically, you might be interested in:
    194 {{{#!sh
    195 easy_install --prefix=/path/to/installdir
    196 }}}
    197 or, if installing Trac on a Mac OS X system:
    198 {{{#!sh
    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 }}}
     166Trac may be available in your platform's package repository. However, your package manager may not provide the latest release of Trac.
    207167
    208168== Creating a Project Environment
    … …  
    220180
    221181Also note that the values you specify here can be changed later using TracAdmin or directly editing the [TracIni conf/trac.ini] configuration file.
    222 
    223 {{{#!div style="border: 1pt dotted; margin: 1em"
    224 **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.
    225 }}}
    226182
    227183Finally, 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:
    … …  
    263219}}}
    264220
    265 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:
     221Then, 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:
    266222{{{#!sh
    267223$ tracd -s --port 8000 /path/to/myproject
    … …  
    274230 - [wiki:TracModWSGI Apache with mod_wsgi]
    275231 - [TracModPython Apache with mod_python]
    276  - //[TracCgi CGI] (should not be used, as the performance is far from optimal)//
    277 
    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.
     232 - [TracCgi CGI] //(should not be used, as the performance is far from optimal)//
     233
     234Trac 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], [https://uwsgi-docs.readthedocs.io/en/latest/#Traconapacheinasub-uri uwsgi], [trac:TracOnWindowsIisIsapi Isapi-wsgi] etc.
    279235
    280236==== Generating the Trac cgi-bin directory #cgi-bin
    281237
    282 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 [TracAdmin trac-admin].
    283 
    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:
    285 {{{#!sh
    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 }}}
    291 Don't forget to check that the web server has the execution right on scripts in the `/usr/share/trac/cgi-bin` directory.
     238Application scripts for CGI, FastCGI and mod-wsgi can be generated using the [TracAdmin trac-admin] `deploy` command:
     239[[TracAdminHelp(deploy)]]
     240
     241Grant the web server execution right on scripts in the `cgi-bin` directory.
     242
     243For example, the following yields a typical directory structure:
     244{{{#!sh
     245$ mkdir -p /var/trac
     246$ trac-admin /var/trac/<project> initenv
     247$ trac-admin /var/trac/<project> deploy /var/www
     248$ ls /var/www
     249cgi-bin htdocs
     250$ chmod ugo+x /var/www/cgi-bin/*
     251}}}
    292252
    293253==== Mapping Static Resources
    … …  
    295255Without additional configuration, Trac will handle requests for static resources such as stylesheets and images. For anything other than a TracStandalone deployment, this is not optimal as the web server can be set up to directly serve the static resources. For CGI setup, this is '''highly undesirable''' as it causes abysmal performance.
    296256
    297 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 their location on the file system. We can map requests for static resources directly to directories on the file system, to avoid Trac processing the requests.
     257Web servers such as [https://httpd.apache.org/ Apache] allow you to create //Aliases// to resources, giving them a virtual URL that doesn't necessarily reflect their location on the file system. We can map requests for static resources directly to directories on the file system, to avoid Trac processing the requests.
    298258
    299259There are two primary URL paths for static resources: `/chrome/common` and `/chrome/site`. Plugins can add their own resources, usually accessible at the `/chrome/<plugin>` path.
    300260
    301 A single `/chrome` alias can used if the static resources are extracted for all plugins. This means that the `deploy` command must be executed after installing or updating a plugin that provides static resources, or after modifying resources in the `$env/htdocs` directory. This is probably appropriate for most installations but may not be what you want if, for example, you wish to upload plugins through the //Plugins// administration page.
    302 
    303 The resources are extracted using the [TracAdmin trac-admin]` <environment> deploy` command:
    304 [[TracAdminHelp(deploy)]]
    305 
    306 The target `<directory>` will contain an `htdocs` directory with:
     261A single `/chrome` alias can used if the static resources are extracted for all plugins. This means that the `deploy` command (discussed in the previous section) must be executed after installing or updating a plugin that provides static resources, or after modifying resources in the `$env/htdocs` directory. This is probably appropriate for most installations but may not be what you want if, for example, you wish to upload plugins through the //Plugins// administration page.
     262
     263The `deploy` command creates an `htdocs` directory with:
    307264 - `common/` - the static resources of Trac
    308265 - `site/` - a copy of the environment's `htdocs/` directory
    … …  
    322279Assuming the deployment has been done this way:
    323280{{{#!sh
    324 $ trac-admin /var/trac/env deploy /path/to/shared/trac
     281$ trac-admin /var/trac/<project> deploy /var/www
    325282}}}
    326283
    … …  
    366323}}}
    367324
    368 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| [trac] htdocs_location]] configuration setting:
     325Another 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:
    369326{{{#!ini
    370327[trac]
    … …  
    406363== Configuring Trac
    407364
     365Configuration options are documented on the TracIni page.
     366
    408367TracRepositoryAdmin provides information on configuring version control repositories for your project.
    409368
     369In addition to the optional version control backends, Trac provides several optional features that are disabled by default:
     370* [TracFineGrainedPermissions#AuthzPolicy Fine-grained permission policy]
     371* [TracPermissions#CreatingNewPrivileges Custom permissions]
     372* [TracTickets#deleter Ticket deletion]
     373* [TracTickets#cloner Ticket cloning]
     374* [TracRepositoryAdmin#CommitTicketUpdater Ticket changeset references]
     375
    410376== Using Trac
    411377
    … …  
    419385
    420386----
    421 See also: [trac:TracInstallPlatforms TracInstallPlatforms], TracGuide, TracUpgrade, TracPermissions
     387See also: [trac:TracInstallPlatforms TracInstallPlatforms], TracGuide, TracUpgrade