Changes between Version 6 and Version 7 of TracInstall


Ignore:
Timestamp:
Jun 27, 2010, 3:12:18 PM (12 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracInstall

    v6 v7  
    1 = Trac Installation Guide for 0.12dev =
    2 
     1= Trac Installation Guide for 0.12 =
    32[[TracGuideToc]]
    43
     
    76Since 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.
    87
    9 If you're interested in contributing new translations for other languages or enhance the existing translations, then please have a look at ["TracL10N"].
     8If you're interested in contributing new translations for other languages or enhance the existing translations, then please have a look at [[trac:TracL10N]].
    109
    1110What 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 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.
    1211
    13 
    14 == Prerequisites ==
    15 === Mandatory Prerequisites
     12[[PageOutline(2-3,Installation Steps,inline)]]
     13
     14== Dependencies ==
     15=== Mandatory Dependencies
    1616To install Trac, the following software packages must be installed:
    1717
    18  * [http://www.python.org/ Python], version >= 2.4 (we dropped the support for Python 2.3 in this release)
     18 * [http://www.python.org/ Python], version >= 2.4 and < 3.0
     19   (note that we dropped the support for Python 2.3 in this release)
    1920 * [http://peak.telecommunity.com/DevCenter/setuptools setuptools], version >= 0.6
    20  * [http://genshi.edgewall.org/wiki/Download Genshi], [genshi:source:trunk trunk], from svn, minimum required revision is [G1072], current [G1092] works fine as well.
     21 * [http://genshi.edgewall.org/wiki/Download Genshi], version >= 0.6
    2122
    2223You also need a database system and the corresponding python bindings.
     
    3637}}}
    3738 
    38 That way, the latest SQLite version will be downloaded and built into the
    39 bindings.
     39This will extract the SQLite code and build the bindings.
    4040
    4141SQLite 2.x is no longer supported. For SQLite 3.x, the pysqlite 1.1.x
     
    6262It is '''very''' important to read carefully the  [trac:MySqlDb MySqlDb] page before creating the database.
    6363
    64 === Optional Prerequisites
     64=== Optional Dependencies
    6565
    6666==== Version Control System ====
    6767
    6868===== Subversion =====
    69  * [http://subversion.apache.org/ Subversion], 1.5.x or 1.6.x and the '''''corresponding''''' Python bindings. Actually 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/
     69 * [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.
    7070
    7171There are [http://subversion.apache.org/packages.html pre-compiled SWIG bindings] available for various platforms. Note that Trac '''doesn't''' use [http://pysvn.tigris.org/ PySVN], neither does it work yet with the newer `ctype`-style bindings
     
    8080
    8181==== Web Server ====
    82  * A CGI-capable web server (see TracCgi), '''but usage of Trac as a cgi script
    83    is highly discouraged''', better use one of the following options,
    84  * a [http://www.fastcgi.com/ FastCGI]-capable web server (see TracFastCgi), or
    85  * an [http://tomcat.apache.org/connectors-doc/ajp/ajpv13a.html AJP]-capable web
    86    server (see [trac:TracOnWindowsIisAjp TracOnWindowsIisAjp]), or
     82A web server is optional because Trac is shipped with a server included, see the [#RunningtheStandaloneServer Running the Standalone Server ] section below.
     83
     84Alternatively you configure Trac to run in any of the following environments.
    8785 * [http://httpd.apache.org/ Apache] with
    8886   - [http://code.google.com/p/modwsgi/ mod_wsgi], see [wiki:TracModWSGI] and
    8987     http://code.google.com/p/modwsgi/wiki/IntegrationWithTrac
    9088   - [http://modpython.org/ mod_python 3.3.1], see TracModPython)
     89 * a [http://www.fastcgi.com/ FastCGI]-capable web server (see TracFastCgi)
     90 * an [http://tomcat.apache.org/connectors-doc/ajp/ajpv13a.html AJP]-capable web
     91   server (see [trac:TracOnWindowsIisAjp TracOnWindowsIisAjp])
     92 * a CGI-capable web server (see TracCgi), '''but usage of Trac as a cgi script
     93   is highly discouraged''', better use one of the previous options.
    9194   
    9295
    9396==== Other Python Packages ====
    9497
    95  * [http://babel.edgewall.org Babel], version >= 0.9.4,
     98 * [http://babel.edgewall.org Babel], version >= 0.9.5,
    9699   needed for localization support
    97100 * [http://docutils.sourceforge.net/ docutils], version >= 0.3.9
     
    112115
    113116== Installing Trac ==
    114 
     117=== Using `easy_install`
    115118One way to install Trac is using `setuptools`.
    116 With setuptools you can install Trac from the subversion repository; for example,
    117 to install release version 0.12dev do:
    118 {{{
    119 easy_install http://svn.edgewall.org/repos/trac/trunk
    120 }}}
    121 
    122 But of course the python-typical setup at the top of the source directory also works:
     119With setuptools you can install Trac from the subversion repository;
     120
     121A few examples:
     122
     123 - install Trac 0.12:
     124   {{{
     125   easy_install Trac==0.12
     126   }}}
     127
     128 - install latest development version 0.12dev:
     129   {{{
     130   easy_install Trac==dev
     131   }}}
     132   Note that in this case you won't have the possibility to run a localized version of Trac;
     133   either use a released version or install from source
     134
     135=== Using `pip`
     136'pip' is an easy_install replacement that is very useful to quickly install python packages.
     137To get a trac installation up and running in less than 5 minutes:
     138
     139Assuming you want to have your entire pip installation in /opt/user/trac
     140
     141 -
     142{{{
     143pip -E /opt/user/trac install trac psycopg2
     144}}}
     145or
     146 -
     147{{{
     148pip -E /opt/user/trac install trac mysql-python
     149}}}
     150
     151Make sure your OS specific headers are available for pip to automatically build PostgreSQL (libpq-dev) or MySQL (libmysqlclient-dev) bindings.
     152
     153pip 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
     154
     155All 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)
     156
     157Additionally, you can install several trac plugins (listed [http://pypi.python.org/pypi?:action=search&term=trac&submit=search here]) through pip.
     158
     159
     160
     161=== From source
     162Of course, using the python-typical setup at the top of the source directory also works.
     163
     164You can obtain the source for a .tar.gz or .zip file corresponding to a release (e.g. Trac-0.12.tar.gz), or you can get the source directly from the repository (see Trac:SubversionRepository for details).
     165
    123166{{{
    124167$ python ./setup.py install
    125168}}}
    126 See SubversionRepository for details about getting the source.
    127 
    128 ''Note 1: you'll need root permissions or equivalent for this step.'' [[br]]
    129 ''Note 2: installing from source is the preferred method if you want to have a localized version of Trac'' [[br]]
     169
     170''You'll need root permissions or equivalent for this step.''
    130171
    131172This will byte-compile the python source code and install it as an .egg file or folder in the `site-packages` directory
     
    134175The 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.
    135176
    136 If you want to make Trac available in other languages, make sure you have installed Babel and then run this additional step before doing the `install` (or simply redo the `install` afterwards):
    137 {{{
    138 $ python ./setup.py compile_catalog -f
    139 }}}
    140 (the `-f` flag is needed as long as some translations are marked ''fuzzy'', i.e. incomplete, which will most probably be the case during the whole development period, as  strings are continuously added or modified)
    141 
     177If 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):
     178{{{
     179$ python ./setup.py install
     180}}}
     181Alternatively, 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`).
    142182
    143183=== Advanced Options ===
     
    158198easy_install --prefix=/usr/local --install-dir=/Library/Python/2.5/site-packages
    159199}}}
    160 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
     200Note: 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
    161201
    162202The 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.
     
    174214[TracAdmin trac-admin] will prompt you for the information it needs to create the environment, such as the name of the project and the [TracEnvironment#DatabaseConnectionStrings database connection string]. If you're not sure what to specify for one of these options, just press `<Enter>` to use the default value.
    175215
    176 Leaving the database connection string empty in particular will always work as long as you have SQLite installed.
     216Using the default database connection string in particular will always work as long as you have SQLite installed.
    177217For the other [DatabaseBackend database backends] you should plan ahead and already have a database ready to use at this point.
    178218
     
    193233}}}
    194234
    195 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:
     235Then, 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:
    196236{{{
    197237$ tracd -s --port 8000 /path/to/myproject
     
    200240== Running Trac on a Web Server ==
    201241
    202 Trac provides three options for connecting to a "real" web server: [wiki:TracCgi CGI], [wiki:TracFastCgi FastCGI] and [wiki:TracModPython mod_python]. For decent performance, it is recommended that you use either FastCGI or mod_python.
    203 
     242Trac provides various options for connecting to a "real" web server: [wiki:TracCgi CGI], [wiki:TracFastCgi FastCGI], [wiki:TracModWSGI mod_wsgi] and [wiki:TracModPython mod_python]. For decent performance, it is recommended that you use either FastCGI or mod_wsgi.
    204243
    205244Trac also supports [trac:TracOnWindowsIisAjp AJP] which may be your choice if you want to connect to IIS.
     
    207246==== Generating the Trac cgi-bin directory ====
    208247
    209 In order for Trac to function properly with FastCGI or mod_python, you need to have a trac.cgi file. This is an executable which loads the appropriate Python code. It can be generated using the `deploy` option of [wiki:TracAdmin trac-admin].
     248In 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].
    210249
    211250There 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:
     
    219258==== Setting up the Plugin Cache ====
    220259
    221 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.
     260Some 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.
    222261
    223262== Configuring Authentication ==
     
    226265
    227266 * TracStandalone if you use the standalone server, `tracd`.
    228  * TracCgi if you use the CGI or FastCGI methods.
    229  * TracModPython if you use the mod_python method.
    230 
     267 * TracCgi if you use the CGI or FastCGI web front ends.
     268 * [wiki:TracModWSGI] if you use the Apache mod_wsgi web front end.
     269 * TracModPython if you use the Apache mod_python web front end.
     270
     271
     272== Automatic reference to the SVN changesets in Trac tickets ==
     273
     274You 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:
     275 * '''`Refs #123`''' - to reference this changeset in `#123` ticket
     276 * '''`Fixes #123`''' - to reference this changeset and close `#123` ticket with the default status ''fixed''
     277
     278This 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.
     279{{{
     280tracopt.ticket.commit_updater.* = enabled
     281}}}
     282For more information, see the documentation of the `CommitTicketUpdater` component in the "Plugins" admin panel.
    231283
    232284== Using Trac ==
    233285
    234 Once you have your Trac site up and running, you should be able to browse your subversion repository, create tickets, view the timeline, etc.
     286Once 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.
    235287
    236288Keep in mind that anonymous (not logged in) users can by default access most but not all of the features. You will need to configure authentication and grant additional [wiki:TracPermissions permissions] to authenticated users to see the full set of features.