Changes between Version 7 and Version 8 of TracInstall


Ignore:
Timestamp:
Jul 25, 2015, 7:08:55 PM (4 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracInstall

    v7 v8  
    66Since version 0.12, Trac can also be localized, and there is probably a translation available in your language. If you want to use the Trac interface in other languages, then make sure you have installed the optional package [#OtherPythonPackages Babel]. Pay attention to the extra steps for localization support in the [#InstallingTrac Installing Trac] section below. Lacking Babel, you will only get the default English version.
    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 enhance the existing translations, then 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] on the main Trac site, please '''first read through these general instructions''' to get a good understanding of the tasks involved.
     
    1818 * [http://www.python.org/ Python], version >= 2.5 and < 3.0
    1919   (note that we dropped the support for Python 2.4 in this release)
    20  * [http://pypi.python.org/pypi/setuptools setuptools], version >= 0.6
     20 * [http://peak.telecommunity.com/DevCenter/setuptools setuptools], version >= 0.6
    2121 * [http://genshi.edgewall.org/wiki/Download Genshi], version >= 0.6
    2222
     
    2727As 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.
    2828
    29 Optionally, you may install a newer version of [pypi:pysqlite pysqlite] than the one provided by the Python distribution. See [trac:PySqlite#ThePysqlite2bindings PySqlite] for details.
     29However, if you like, you can download the latest and greatest version of [[trac:PySqlite]] from
     30[http://code.google.com/p/pysqlite/downloads/list google code], where you'll find the Windows
     31installers or the `tar.gz` archive for building from source:
     32{{{#!sh
     33$ tar xvfz <version>.tar.gz
     34$ cd <version>
     35$ python setup.py build_static install
     36}}}
     37 
     38This will download the latest SQLite code and build the bindings. SQLite 2.x is no longer supported.
     39
     40A known bug in [trac: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 [trac:#9434] for more detail. See additional information in [trac:PySqlite PySqlite].
    3041
    3142==== For the PostgreSQL database #ForPostgreSQL
     
    5162
    5263===== Subversion
    53  * [http://subversion.apache.org/ Subversion], 1.5.x or later and the '''''corresponding''''' Python bindings. Older versions starting from 1.0, like 1.2.4, 1.3.2 or 1.4.2, etc. may still work. For troubleshooting information, check the [trac:TracSubversion#Troubleshooting TracSubversion] page.
     64 * [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.
    5465
    5566There 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.)
     
    5970'''Please note:''' if using Subversion, Trac must be installed on the '''same machine'''. Remote repositories are currently [trac:ticket:493 not supported].
    6071
    61 ===== Git
    62  * [http://git-scm.com/ Git] 1.5.6 or later.
    63 
    64 More information is available on the [trac:TracGit] page.
    65 
    6672===== Others
    6773
    68 Support for other version control systems is provided via third-parties. See [trac:PluginList#VersionControlSystems] and [trac:VersionControlSystem].
     74Support for other version control systems is provided via third-parties. See [trac:PluginList] and [trac:VersionControlSystem].
    6975
    7076==== Web Server
     
    7581   - [http://code.google.com/p/modwsgi/ mod_wsgi], see [wiki:TracModWSGI] and
    7682     http://code.google.com/p/modwsgi/wiki/IntegrationWithTrac
    77    - [http://modpython.org/ mod_python 3.5.0], see TracModPython
     83   - [http://modpython.org/ mod_python >= 3.3.1], (deprecated: see TracModPython)
    7884 * a [http://www.fastcgi.com/ FastCGI]-capable web server (see TracFastCgi)
    7985 * an [http://tomcat.apache.org/connectors-doc/ajp/ajpv13a.html AJP]-capable web
    8086   server (see [trac:TracOnWindowsIisAjp TracOnWindowsIisAjp])
    81  * a FastCGI and FastCGI-to-WSGI gateway (see [trac:TracOnWindowsIisWfastcgi])
    8287 * a CGI-capable web server (see TracCgi), '''but usage of Trac as a cgi script
    8388   is highly discouraged''', better use one of the previous options.
     
    8691==== Other Python Packages
    8792
    88  * [http://babel.edgewall.org Babel], version 0.9.5, 0.9.6 or >= 1.3
    89    needed for localization support
     93 * [http://babel.edgewall.org Babel], version >= 0.9.5,
     94   needed for localization support (unreleased version 1.0dev should work as well)
    9095 * [http://docutils.sourceforge.net/ docutils], version >= 0.3.9
    9196   for WikiRestructuredText.
    9297 * [http://pygments.org Pygments] for
    93    [TracSyntaxColoring syntax highlighting].
     98   [wiki:TracSyntaxColoring syntax highlighting].
    9499   [http://silvercity.sourceforge.net/ SilverCity] and/or
    95100   [http://gnu.org/software/enscript/enscript.html Enscript] may still be used
     
    99104   an internal time zone implementation.
    100105
    101 {{{#!div style="border: 1pt dotted; margin: 1em"
    102 **Attention**: The available versions of these dependencies are not necessarily interchangeable, so please pay attention to the version numbers. 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].
    103 }}}
    104 
    105 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''.
     106'''Attention''': The available versions of these dependencies are not necessarily interchangeable, so please pay attention to the version numbers. 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].
     107
     108Please 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!
    106109
    107110== Installing Trac
    108 
    109 The [TracAdmin trac-admin] command-line tool, used to create and maintain [TracEnvironment project environments], as well as the [TracStandalone tracd] standalone server are installed along with Trac. There are several methods for installing Trac.
    110 
    111111=== Using `easy_install`
    112 Trac can be installed from PyPI or the Subversion repository using [http://pypi.python.org/pypi/setuptools setuptools].
     112One way to install Trac is using [http://pypi.python.org/pypi/setuptools setuptools]. With setuptools you can install Trac from the Subversion repository.
    113113
    114114A few examples:
     
    125125   either use a released version or install from source
    126126
    127 More information can be found on the [trac:setuptools] page.
    128 
    129127{{{#!div style="border: 1pt dotted; margin: 1em"
    130128**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].
     
    149147Make sure your OS specific headers are available for pip to automatically build PostgreSQL (`libpq-dev`) or MySQL (`libmysqlclient-dev`) bindings.
    150148
    151 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`.
     149pip 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`.
    152150
    153151All 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)
     
    156154
    157155=== From source
    158 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.
     156Of 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.
    159157
    160158{{{#!sh
     
    167165of your Python installation. The .egg will also contain all other resources needed by standard Trac, such as `htdocs` and `templates`.
    168166
     167The 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.
     168
    169169If 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):
    170170{{{#!sh
     
    173173Alternatively, 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`).
    174174
    175 === Using installer
    176 
    177 On Windows Trac can be installed using the exe installers available on the [trac:TracDownload] page. Installers are available for the 32 and 64 bit versions of Python. Make sure to use the installer that matches the architecture of your Python installation.
    178 
    179 === Using package manager
    180 
    181 Trac may be available in the package repository for your platform. Note however, that the version provided by the package manager may not be the latest release.
    182 
    183 === Advanced `easy_install` Options
     175=== Advanced Options
    184176
    185177To install Trac to a custom location, or find out about other advanced installation options, run:
     
    198190easy_install --prefix=/usr/local --install-dir=/Library/Python/2.5/site-packages
    199191}}}
    200 Note: If installing on Mac OS X 10.6 running {{{ easy_install http://svn.edgewall.org/repos/trac/trunk }}} will install into {{{ /usr/local }}} and {{{ /Library/Python/2.5/site-packages }}} by default.
     192Note: 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.
    201193
    202194The 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.
     
    206198A [TracEnvironment Trac environment] is the backend 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 other files and directories.
    207199
    208 A new environment is created using [TracAdmin trac-admin]:
     200A new environment is created using [wiki:TracAdmin trac-admin]:
    209201{{{#!sh
    210202$ trac-admin /path/to/myproject initenv
     
    220212Also note that the values you specify here can be changed later by directly editing the [TracIni conf/trac.ini] configuration file.
    221213
    222 {{{#!div style="border: 1pt dotted; margin: 1em"
    223 **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), 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.
    224 }}}
     214When 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. The best advice is to opt for a platform with sub-second timestamp resolution, regardless of the Trac version.
    225215
    226216Finally, 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:
     
    239229=== Running the Standalone Server
    240230
    241 After having created a Trac environment, you can easily try the web interface by running the standalone server [TracStandalone tracd]:
     231After having created a Trac environment, you can easily try the web interface by running the standalone server [wiki:TracStandalone tracd]:
    242232{{{#!sh
    243233$ tracd --port 8000 /path/to/myproject
     
    266256
    267257Trac provides various options for connecting to a "real" web server:
    268  - [TracFastCgi FastCGI]
     258 - [wiki:TracFastCgi FastCGI]
    269259 - [wiki:TracModWSGI mod_wsgi]
    270  - [TracModPython mod_python]
    271  - //[TracCgi CGI] (should not be used, as the performance is far from optimal)//
     260 - //[wiki:TracModPython mod_python] (no longer recommended, as mod_python is not actively maintained anymore)//
     261 - //[wiki:TracCgi CGI] (should not be used, as the performance is far from optimal)//
    272262
    273263Trac 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.
     
    275265==== Generating the Trac cgi-bin directory #cgi-bin
    276266
    277 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].
    278 
    279 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:
     267In 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].
     268
     269There 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:
    280270{{{#!sh
    281271mkdir -p /usr/share/trac/projects/my-project
     
    339329}}}
    340330
    341 Alternatively to aliasing `/trac/chrome/common`, you can tell Trac to generate direct links for those static resources (and only those), using the [[TracIni#trac-section| [trac] htdocs_location]] configuration setting:
     331Alternatively 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:
    342332{{{#!ini
    343333[trac]
     
    366356 * TracFastCgi if you're using another web server with FCGI support (Cherokee, Lighttpd, !LiteSpeed, nginx)
    367357
    368 The following document also contains some useful information for beginners: [trac:TracAuthenticationIntroduction].
     358The following document also constains some useful information for beginners: [trac:TracAuthenticationIntroduction].
    369359
    370360== Granting admin rights to the admin user
     
    381371Support 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.
    382372
    383 The version control systems are enabled by adding the following to the `[components]` section of your [TracIni#components-section trac.ini], or enabling the components in the "Plugins" admin panel.
     373The 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.
    384374
    385375{{{#!ini
     
    391381}}}
    392382
    393 After enabling the components, repositories can be configured through the //Repositories// admin panel or by editing [TracIni#repositories-section trac.ini]. Automatic changeset references can be inserted as ticket comments by configuring [TracRepositoryAdmin#Automaticchangesetreferencesintickets CommitTicketUpdater].
     383After enabling the components, repositories can be configured through the "Repositories" admin panel or by editing [TracIni#repositories-section trac.ini].
     384
     385=== Automatic reference to the SVN changesets in Trac tickets
     386
     387You 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:
     388 * '''`Refs #123`''' - to reference this changeset in `#123` ticket
     389 * '''`Fixes #123`''' - to reference this changeset and close `#123` ticket with the default status ''fixed''
     390
     391This 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.
     392{{{#!ini
     393tracopt.ticket.commit_updater.* = enabled
     394}}}
     395For more information, see the documentation of the `CommitTicketUpdater` component in the "Plugins" admin panel.
    394396
    395397=== Using Trac
     
    397399Once 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.
    398400
    399 Keep in mind that //anonymous// (not logged in) users can by default access only a few of the features, in particular they will have a read-only access to the resources. You will need to configure authentication and grant additional [TracPermissions permissions] to authenticated users to see the full set of features.
     401Keep in mind that //anonymous// (not logged in) users can by default access only a few of the features, in particular they will have a read-only access to the resources. You will need to configure authentication and grant additional [wiki:TracPermissions permissions] to authenticated users to see the full set of features.
    400402
    401403'' Enjoy! ''

Search

Context Navigation

ZOO Sponsors

http://www.zoo-project.org/trac/chrome/site/img/geolabs-logo.pnghttp://www.zoo-project.org/trac/chrome/site/img/neogeo-logo.png http://www.zoo-project.org/trac/chrome/site/img/apptech-logo.png http://www.zoo-project.org/trac/chrome/site/img/3liz-logo.png http://www.zoo-project.org/trac/chrome/site/img/gateway-logo.png

Become a sponsor !

Knowledge partners

http://www.zoo-project.org/trac/chrome/site/img/ocu-logo.png http://www.zoo-project.org/trac/chrome/site/img/gucas-logo.png http://www.zoo-project.org/trac/chrome/site/img/polimi-logo.png http://www.zoo-project.org/trac/chrome/site/img/fem-logo.png http://www.zoo-project.org/trac/chrome/site/img/supsi-logo.png http://www.zoo-project.org/trac/chrome/site/img/cumtb-logo.png

Become a knowledge partner

Related links

http://zoo-project.org/img/ogclogo.png http://zoo-project.org/img/osgeologo.png