Context Navigation

Changes between Version 4 and Version 5 of TracInstall

Timestamp:: 2014-11-04T21:22:55Z (10 years ago)
Author:: trac
Comment:: --

Legend:

: Unmodified
: Added
: Removed
: Modified

TracInstall

-              v4
+              v5
+= Trac Installation Guide for 1.0 =
+{{{#!div style="margin-top: .5em; padding: 0 1em; background-color: #ffd; border:1px outset #ddc; text-align: center"
+ '''NOTE: the information in this page applies to Trac 1.0, the current version of Trac. \\
+ For installing previous Trac versions, please refer to [[wiki:0.12/TracInstall]] (for Trac 0.12)'''
+}}}
+= Trac Installation Guide for 1.0
 [[TracGuideToc]]
 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.
 Since version 0.12, Trac can also be localized, and there's probably a translation available for your language. If you want to be able 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, as usual.
 If you're interested in contributing new translations for other languages or enhance the existing translations, then please have a look at [[trac:TracL10N]].
+Since version 0.12, Trac can also be localized, and there's probably a translation available for your language. If you want to be able 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, as usual.
+If you're interested in contributing new translations for other languages or enhance the existing translations, then please have a look at [trac:wiki:TracL10N TracL10N].
 What follows are generic instructions for installing and setting up Trac and its requirements. While you may find instructions for installing Trac on specific systems at [trac:TracInstallPlatforms TracInstallPlatforms] on the main Trac site, please be sure to '''first read through these general instructions''' to get a good understanding of the tasks involved.
 …
 [[PageOutline(2-3,Installation Steps,inline)]]
 == Dependencies ==
+== Dependencies
 === Mandatory Dependencies
 To install Trac, the following software packages must be installed:
 …
  * [http://www.python.org/ Python], version >= 2.5 and < 3.0
    (note that we dropped the support for Python 2.4 in this release)
  * [http://peak.telecommunity.com/DevCenter/setuptools setuptools], version >= 0.6, or better yet, [http://pypi.python.org/pypi/distribute distribute]
  * [http://genshi.edgewall.org/wiki/Download Genshi], version >= 0.6 (unreleased version 0.7dev should work as well)
+ * [http://peak.telecommunity.com/DevCenter/setuptools setuptools], version >= 0.6
+ * [http://genshi.edgewall.org/wiki/Download Genshi], version >= 0.6
 You also need a database system and the corresponding python bindings.
 …
 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).
 However, if you'd like, you can download the latest and greatest version of [[trac:Pysqlite]] from
+However, if you'd like, you can download the latest and greatest version of [[trac:PySqlite]] from
 [http://code.google.com/p/pysqlite/downloads/list google code], where you'll find the Windows
 installers or the `tar.gz` archive for building from source:
 {{{
+{{{#!sh
 $ tar xvfz <version>.tar.gz
 $ cd <version>
 …
 SQLite 2.x is no longer supported.
 A known bug PySqlite versions 2.5.2-4 prohibits upgrade of trac databases
+A known bug in PySqlite versions 2.5.2-4 prohibits upgrades of Trac databases
 from 0.11.x to 0.12. Please use versions 2.5.5 and newer or 2.5.1 and
 older. See #9434 for more detail.
 …
 You need to install the database and its Python bindings:
  * [http://www.postgresql.org/ PostgreSQL], version 8.0 or later
  * [http://pypi.python.org/pypi/psycopg2 psycopg2]
+ * [http://pypi.python.org/pypi/psycopg2 psycopg2], version 2.0 or later
 See [trac:DatabaseBackend#Postgresql DatabaseBackend] for details.
 …
 === Optional Dependencies
 ==== Version Control System ====
 ===== Subversion =====
+==== Version Control System
+===== Subversion
  * [http://subversion.apache.org/ Subversion], 1.5.x or 1.6.x and the '''''corresponding''''' Python bindings. Older versions starting from 1.0, like 1.2.4, 1.3.2 or 1.4.2, etc. should still work. For troubleshooting information, check the [trac:TracSubversion#Troubleshooting TracSubversion] page.
 …
 ===== Others =====
+===== Others
 Support for other version control systems is provided via third-parties. See [trac:PluginList] and [trac:VersionControlSystem].
 ==== Web Server ====
 A web server is optional because Trac is shipped with a server included, see the [#RunningtheStandaloneServer Running the Standalone Server ] section below.
 Alternatively you configure Trac to run in any of the following environments.
+==== Web Server
+A web server is optional because Trac is shipped with a server included, see the [#RunningtheStandaloneServer Running the Standalone Server] section below.
+Alternatively you can configure Trac to run in any of the following environments.
  * [http://httpd.apache.org/ Apache] with
    - [http://code.google.com/p/modwsgi/ mod_wsgi], see [wiki:TracModWSGI] and
      http://code.google.com/p/modwsgi/wiki/IntegrationWithTrac
    - [http://modpython.org/ mod_python 3.3.1], deprecated: see TracModPython)
+   - [http://modpython.org/ mod_python 3.3.1], (deprecated: see TracModPython)
  * a [http://www.fastcgi.com/ FastCGI]-capable web server (see TracFastCgi)
  * an [http://tomcat.apache.org/connectors-doc/ajp/ajpv13a.html AJP]-capable web
 …
 ==== Other Python Packages ====
+==== Other Python Packages
  * [http://babel.edgewall.org Babel], version >= 0.9.5,
 …
  * [http://docutils.sourceforge.net/ docutils], version >= 0.3.9
    for WikiRestructuredText.
  * [http://pygments.pocoo.org Pygments] for
+ * [http://pygments.org Pygments] for
    [wiki:TracSyntaxColoring syntax highlighting].
    [http://silvercity.sourceforge.net/ SilverCity] and/or
 …
    an internal time zone implementation.
 '''Attention''': The various available versions of these dependencies are not necessarily interchangable, so please pay attention to the version numbers above. If you are having trouble getting Trac to work please double-check all the dependencies before asking for help on the [trac:MailingList] or [trac:IrcChannel].
+'''Attention''': The various available versions of these dependencies are not necessarily interchangeable, so please pay attention to the version numbers above. If you are having trouble getting Trac to work please double-check all the dependencies before asking for help on the [trac:MailingList] or [trac:IrcChannel].
 Please refer to the documentation of these packages to find out how they are best installed. In addition, most of the [trac:TracInstallPlatforms platform-specific instructions] also describe the installation of the dependencies. Keep in mind however that the information there ''probably concern older versions of Trac than the one you're installing'' (there are even some pages that are still talking about Trac 0.8!).
 == Installing Trac ==
+== Installing Trac
 === Using `easy_install`
 One way to install Trac is using [http://pypi.python.org/pypi/setuptools setuptools].
 With setuptools you can install Trac from the subversion repository;
+With setuptools you can install Trac from the Subversion repository;
 A few examples:
  - install Trac 1.0:
    {{{
+ - Install Trac 1.0:
+   {{{#!sh
    easy_install Trac==1.0
    }}}
+   (NOT YET ENABLED)
+ - install latest development version 1.0dev:
+   {{{
+ - Install latest development version:
+   {{{#!sh
    easy_install Trac==dev
    }}}
 …
    either use a released version or install from source
+{{{#!div style="border: 1pt dotted; margin: 1em"
+**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 the sections on [#RunningtheStandaloneServer Running The Standalone Server] and [#RunningTraconaWebServer Running Trac on a Web Server].
+}}}
 === Using `pip`
 'pip' is an easy_install replacement that is very useful to quickly install python packages.
 To get a trac installation up and running in less than 5 minutes:
+To get a Trac installation up and running in less than 5 minutes:
 Assuming you want to have your entire pip installation in `/opt/user/trac`
+ -
+{{{
 pip -E /opt/user/trac install trac psycopg2
+ {{{#!sh
+pip install trac psycopg2
 }}}
 or
+ -
+{{{
 pip -E /opt/user/trac install trac mysql-python
 }}}
 Make sure your OS specific headers are available for pip to automatically build PostgreSQL (libpq-dev) or MySQL (libmysqlclient-dev) bindings.
+ {{{#!sh
+pip install trac mysql-python
+}}}
+Make sure your OS specific headers are available for pip to automatically build PostgreSQL (`libpq-dev`) or MySQL (`libmysqlclient-dev`) bindings.
 pip will automatically resolve all dependencies (like Genshi, pygments, etc.) and download the latest packages on pypi.python.org and create a self contained installation in `/opt/user/trac`.
 …
 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)
 Additionally, you can install several trac plugins (listed [http://pypi.python.org/pypi?:action=search&term=trac&submit=search here]) through pip.
+Additionally, you can install several Trac plugins (listed [http://pypi.python.org/pypi?:action=search&term=trac&submit=search here]) through pip.
 …
 Of course, 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), or you can get the source directly from the repository (see Trac:SubversionRepository for details).
 {{{
+You can obtain the source for a .tar.gz or .zip file corresponding to a release (e.g. `Trac-1.0.tar.gz`), or you can get the source directly from the repository (see [trac:SubversionRepository] for details).
+{{{#!sh
 $ python ./setup.py install
 }}}
 …
 ''You'll need root permissions or equivalent for this step.''
 This will byte-compile the python source code and install it as an .egg file or folder in the `site-packages` directory
 of your Python installation. The .egg will also contain all other resources needed by standard Trac, such as htdocs and templates.
+This will byte-compile the Python source code and install it as an .egg file or folder in the `site-packages` directory
+of your Python installation. The .egg will also contain all other resources needed by standard Trac, such as `htdocs` and `templates`.
 The script will also install the [wiki:TracAdmin trac-admin] command-line tool, used to create and maintain [wiki:TracEnvironment project environments], as well as the [wiki:TracStandalone tracd] standalone server.
 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):
 {{{
+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):
+{{{#!sh
 $ python ./setup.py install
 }}}
 Alternatively, you can do a `bdist_egg` and copy the .egg from dist/ to the place of your choice, or you can create a Windows installer (`bdist_wininst`).
 === Advanced Options ===
+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`).
+=== Advanced Options
 To install Trac to a custom location, or find out about other advanced installation options, run:
 {{{
+{{{#!sh
 easy_install --help
 }}}
 Also see [http://docs.python.org/inst/inst.html Installing Python Modules] for detailed information.
+Also see [http://docs.python.org/2/install/index.html Installing Python Modules] for detailed information.
 Specifically, you might be interested in:
 {{{
+{{{#!sh
 easy_install --prefix=/path/to/installdir
 }}}
 or, if installing Trac to a Mac OS X system:
 {{{
+or, if installing Trac on a Mac OS X system:
+{{{#!sh
 easy_install --prefix=/usr/local --install-dir=/Library/Python/2.5/site-packages
 }}}
 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.6/site-packages }}} by default
+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.6/site-packages }}} by default.
 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.
 == Creating a Project Environment ==
+== Creating a Project Environment
 A [TracEnvironment Trac environment] is the backend storage where Trac stores information like wiki pages, tickets, reports, settings, etc. An environment is basically a directory that contains a human-readable [TracIni configuration file], and various other files and directories.
 A new environment is created using [wiki:TracAdmin trac-admin]:
 {{{
+{{{#!sh
 $ trac-admin /path/to/myproject initenv
 }}}
 …
 For the other [DatabaseBackend database backends] you should plan ahead and already have a database ready to use at this point.
 Since 0.12, Trac doesn't ask for a [TracEnvironment#SourceCodeRepository source code repository] anymore when creating an environment. Repositories can be [TracRepositoryAdmin added] afterward, or the version control support can be disabled completely if you don't need it.
+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.
 Also note that the values you specify here can be changed later by directly editing the [TracIni conf/trac.ini] configuration file.
+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), 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 (though the best advice is to opt for a platform with sub-second timestamp resolution when possible regardless of the version of Trac you are running).
 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:
+{{{
+# chown -R apache.apache /path/to/myproject
+}}}
+{{{#!sh
+$ chown -R apache.apache /path/to/myproject
+}}}
+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).
 {{{#!div class=important
 …
 == Deploying Trac
 === Running the Standalone Server ===
+=== Running the Standalone Server
 After having created a Trac environment, you can easily try the web interface by running the standalone server [wiki:TracStandalone tracd]:
 {{{
+{{{#!sh
 $ tracd --port 8000 /path/to/myproject
 }}}
 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:
 {{{
+{{{#!sh
 $ tracd -s --port 8000 /path/to/myproject
 }}}
+=== Running Trac on a Web Server ===
+{{{#!div style="border: 1pt dotted; margin: 1em"
+**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. The environment variable can be set system-wide, or for just the user that runs the `tracd` process. There are several ways to accomplish this in addition to what is discussed here, and depending on the distribution of your OS.
+To be effective system-wide a shell script with the `export` statement may be added to `/etc/profile.d`. To be effective for a user session the `export` statement may be added to `~/.profile`.
+{{{#!sh
+export PKG_RESOURCES_CACHE_ZIP_MANIFESTS=1
+}}}
+Alternatively, the variable can be set in the shell before executing `tracd`:
+{{{#!sh
+$ PKG_RESOURCES_CACHE_ZIP_MANIFESTS=1 tracd --port 8000 /path/to/myproject
+}}}
+}}}
+=== Running Trac on a Web Server
 Trac provides various options for connecting to a "real" web server:
 …
 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.
 ==== Generating the Trac cgi-bin directory ==== #cgi-bin
+==== Generating the Trac cgi-bin directory #cgi-bin
 In order for Trac to function properly with FastCGI you need to have a `trac.fcgi` file and for mod_wsgi a `trac.wsgi` file. These are Python scripts which load the appropriate Python code. They can be generated using the `deploy` option of [wiki:TracAdmin trac-admin].
 There is, however, a bit of a chicken-and-egg problem. The [wiki: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:
 {{{
+{{{#!sh
 mkdir -p /usr/share/trac/projects/my-project
 trac-admin /usr/share/trac/projects/my-project initenv
 …
 mv /tmp/deploy/* /usr/share/trac
 }}}
+==== Mapping Static Resources ====
+Don't forget to check that the web server has the execution right on scripts in the `/usr/share/trac/cgi-bin` directory.
+==== Mapping Static Resources
 Out of the box, Trac will pass static resources such as style sheets or images through itself. For anything but a tracd only based deployment, this is far from optimal as the web server could be set up to directly serve those static resources (for CGI setup, this is '''highly undesirable''' and will cause abysmal performance).
 …
  - `<plugins>/` - one directory for each resource directory managed by the plugins enabled for this environment
 ===== Example: Apache and `ScriptAlias` ===== #ScriptAlias-example
+===== Example: Apache and `ScriptAlias` #ScriptAlias-example
 Assuming the deployment has been done this way:
 {{{
+{{{#!sh
 $ trac-admin /var/trac/env deploy /path/to/trac/htdocs/common
 }}}
 Add the following snippet to Apache configuration ''before'' the `ScriptAlias` or `WSGIScriptAlias` (which map all the other requests to the Trac application), changing paths to match your deployment:
 {{{
+{{{#!apache
 Alias /trac/chrome/common /path/to/trac/htdocs/common
 Alias /trac/chrome/site /path/to/trac/htdocs/site
 …
 If using mod_python, you might want to add this too (otherwise, the alias will be ignored):
 {{{
+{{{#!apache
 <Location "/trac/chrome/common/">
   SetHandler None
 …
 Similarly, if you have static resources in a project's `htdocs` directory (which is referenced by `/trac/chrome/site` URL in themes), you can configure Apache to serve those resources (again, put this ''before'' the `ScriptAlias` or `WSGIScriptAlias` for the .*cgi scripts, and adjust names and locations to match your installation):
 {{{
+{{{#!apache
 Alias /trac/chrome/site /path/to/projectenv/htdocs
 …
 Alternatively to aliasing `/trac/chrome/common`, you can tell Trac to generate direct links for those static resources (and only those), using the [[wiki:TracIni#trac-section| [trac] htdocs_location]] configuration setting:
 {{{
+{{{#!ini
 [trac]
 htdocs_location = http://static.example.org/trac-common/
 …
 Of course, you still need to make the Trac `htdocs/common` directory available through the web server at the specified URL, for example by copying (or linking) the directory into the document root of the web server:
 {{{
+{{{#!sh
 $ ln -s /path/to/trac/htdocs/common /var/www/static.example.org/trac-common
 }}}
 ==== Setting up the Plugin Cache ====
 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.
 == Configuring Authentication ==
 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.
+==== Setting up the Plugin Cache
+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.
+== Configuring Authentication
+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.
 The process of adding, removing, and configuring user accounts for authentication depends on the specific way you run Trac.
 …
  * TracFastCgi if you're using another web server with FCGI support (Cherokee, Lighttpd, !LiteSpeed, nginx)
+The following document also constains some useful information for beginners: [trac:TracAuthenticationIntroduction].
 == Granting admin rights to the admin user
 Grant admin rights to user admin:
 {{{
+{{{#!sh
 $ trac-admin /path/to/myproject permission add admin TRAC_ADMIN
 }}}
 This user will have an "Admin" entry menu that will allow you to admin your trac project.
+This user will have an "Admin" entry menu that will allow you to administrate your Trac project.
 == Finishing the install
+=== Automatic reference to the SVN changesets in Trac tickets ===
+=== Enable version control components
+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.
+The components can be 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.
+{{{#!ini
+tracopt.versioncontrol.svn.* = enabled
+}}}
+{{{#!ini
+tracopt.versioncontrol.git.* = enabled
+}}}
+After enabling the components, repositories can be configured through the "Repositories" admin panel or by editing [TracIni#repositories-section trac.ini].
+=== Automatic reference to the SVN changesets in Trac tickets
 You can configure SVN to automatically add a reference to the changeset into the ticket comments, whenever changes are committed to the repository. The description of the commit needs to contain one of the following formulas:
 …
 This functionality requires a post-commit hook to be installed as described in [wiki:TracRepositoryAdmin#ExplicitSync TracRepositoryAdmin], and enabling the optional commit updater components by adding the following line to the `[components]` section of your [wiki:TracIni#components-section trac.ini], or enabling the components in the "Plugins" admin panel.
 {{{
+{{{#!ini
 tracopt.ticket.commit_updater.* = enabled
 }}}
 For more information, see the documentation of the `CommitTicketUpdater` component in the "Plugins" admin panel.
 === Using Trac ===
+=== Using Trac
 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.