Changes between Version 1 and Version 2 of TracInstall


Ignore:
Timestamp:
May 15, 2010, 9:05:30 PM (15 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracInstall

    v1 v2  
    1 = Trac Installation Guide =
     1= Trac Installation Guide for 0.12dev =
     2{{{
     3#!div style="margin-top: .5em; padding: 0 1em; background-color: #ffd; border:1px outset #ddc;"
     4
     5  '''NOTE: this page is for 0.12dev (trunk), for which development has started. For installing previous Trac versions, please refer to TracInstall (0.11)'''
     6}}}
    27[[TracGuideToc]]
    38
    4 Trac is a lightweight project management tool that is implemented as a web-based application. Trac is written in the Python programming language and needs a database (either [http://sqlite.org/ SQLite], [http://www.postgresql.org/ PostgreSQL], or [http://mysql.com/ MySQL] works). For HTML rendering, Trac uses the [http://www.clearsilver.net/ ClearSilver] templating system.
    5 
    6 What follows are generic instructions for installing and setting up Trac and its requirements. While you can find instructions for installing Trac on specific systems at [http://projects.edgewall.com/trac/wiki/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.
    7 
    8 == Requirements ==
     9Trac 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.
     10
     11Since 0.12, Trac can also be localized, and there's probably a translation available for your language. If this is what you want, then make sure you have installed the optional package [#OtherPythonUtilities Babel]. Trac can still be installed without Babel, but then you will only get the english version, as usual.
     12If you're interested in contributing new translations for other languages or enhance the existing translations, then please have a look at ["TracL10N"].
     13
     14What follows are generic instructions for installing and setting up Trac and its requirements. While you can 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.
     15
     16== Short - Install a released version ==
     17For the quick install, make sure you have [http://python.org Python-2.5], [http://peak.telecommunity.com/DevCenter/EasyInstall#installing-easy-install easy_install] and SQlite-3.3.4 installed (or above). (You also might want to install python-dev to build genshi)
     18{{{
     19sudo easy_install http://svn.edgewall.org/repos/trac/trunk
     20}}}
     21
     22== Requirements - also older versions possible ==
    923
    1024To install Trac, the following software packages must be installed:
    1125
    12  * [http://www.python.org/ Python], version >= 2.3.
     26 * [http://www.python.org/ Python], version >= 2.3
     27   * if using mod_python together with xml-related things, use python-2.5. expat is namespaced there and does not cause apache to crash any more(see [http://www.dscpl.com.au/wiki/ModPython/Articles/ExpatCausingApacheCrash here] for details).
    1328   * For RPM-based systems you might also need the `python-devel` and `python-xml` packages.
    14    * If you want to use Trac with Subversion on Windows, note that there are no precompiled Subversion bindings for Python 2.4, so you probably need Python 2.3.
    15     * 2006-09-20: This seems to be no longer true, see http://subversion.tigris.org/servlets/ProjectDocumentList?folderID=91. For subversion 1.4.0 python 2.4 binary bindings are available.
    16  * [http://www.clearsilver.net/ ClearSilver], version >= 0.9.3
    17    * With python-bindings (`./configure --with-python=/usr/bin/python`)
     29   * See instructions in ["TracOnWindows/Python2.5"]
     30 * [http://peak.telecommunity.com/DevCenter/setuptools setuptools], version >= 0.6
     31 * [http://genshi.edgewall.org/wiki/Download Genshi], version >= 0.4.1
    1832 * You also need a database system and the corresponding python drivers for it.
    19    The database can be either SQLite, PostgreSQL or MySQL ''(experimental)''.
     33   The database can be either SQLite, PostgreSQL or ''MySQL (experimental)''.
    2034
    2135=== For SQLite ===
    2236
    23  * [http://www.sqlite.org/ SQLite], version 2.8.x or 3.x (preferred)
    24  * [http://pysqlite.org/ PySQLite], version 1.x (for SQLite 2.x) or version 2.x (for SQLite 3.x). For details see [http://trac.edgewall.org/wiki/PySqlite PySqlite]
    25 
    26 ''Note: Versions of Trac prior to 0.9 do '''not''' work with PySQLite 2.x.''
    27 
    28 ''Note: It appears that PySQLite 2.x is required for Trac 0.9+/SQLite 3.x if you plan to use the 'trac-post-commit-hook.py' script available from the 'contrib' section of the source repository.''
     37 * [http://www.sqlite.org/ SQLite], version 3.3.4 and above preferred (note: it is preinstalled in Python 2.5.2).
     38 * If not using Python-2.5: [http://pysqlite.org/ PySQLite], version 1.x (for SQLite 2.x) or version 2.x (for SQLite 3.x), version 2.3.2 preferred. For details see [trac:PySqlite PySqlite]
     39
     40''Note: It appears that PySQLite 2.x is required if you plan to use the 'trac-post-commit-hook.py' script available from the 'contrib' section of the source repository.''
    2941
    3042''Note: Users of Mac OS X please take care; the Apple-supplied SQLite contains additional code to support file locking on network filesystems like AFP or SMB. This is not presently (3.3.6) in the mainline sources, so if you build your own SQLite from source it will not function correctly on such filesystems - typically it gives the error "{{{database is locked}}}". [http://www.alastairs-place.net/2006/07/sqlite_and_mac/ A patch] is available for version 3.3.6, based on Apple's code, otherwise you're probably best off using the Apple supplied version (presently 3.1.3).''
    … …  
    3345
    3446 * [http://www.postgresql.org/ PostgreSQL]
    35  * [http://initd.org/projects/psycopg2 psycopg2] or [http://pypgsql.sourceforge.net/ pyPgSQL]
    36 
    37 ''Note: PostgreSQL support requires Trac version 0.9 or later.''
     47 * [http://initd.org/projects/psycopg2 psycopg2]
     48 * See [trac:wiki:DatabaseBackend#Postgresql DatabaseBackend]
     49
     50'''Warning''': PostgreSQL 8.3 uses a strict type checking mechanism. To use Trac with the 8.3 Version of PostgreSQL, you will need [http://trac.edgewall.org/changeset/6512 trac-0.11] or later.
    3851
    3952=== For MySQL ===
    4053
    41 '''Warning''': MySQL support is currently experimental. That means it works for some people, but has not been tested extensively yet.
     54'''Warning''': MySQL support is currently ''still'' experimental. That means it works for some people, but several issues remain, in particular regarding the use of unicode and the key length in the repository cache. See [trac:MySqlDb MySqlDb] for more detailed information.
    4255
    4356 * [http://mysql.com/ MySQL], version 4.1 or later
    44  * [http://sf.net/projects/mysql-python MySQLdb], version 1.2.1 or later
    45 
    46 ''Note: MySQL support requires Trac version 0.10 or later.''
     57 * [http://sf.net/projects/mysql-python MySQLdb], version 1.2.2 or later
    4758
    4859=== Optional Requirements ===
    4960
    5061==== Version Control System ====
    51  * [http://subversion.tigris.org/ Subversion], version >= 1.0. (either 1.2.3 or >= 1.3.1 recommended) and corresponding [http://svnbook.red-bean.com/svnbook-1.1/ch08s02.html#svn-ch-8-sect-2.3 Python bindings]. For troubleshooting, check [http://projects.edgewall.com/trac/wiki/TracSubversion TracSubversion]
    52    * Trac uses the [http://www.swig.org/ SWIG] bindings included in the Subversion distribution, '''not''' [http://pysvn.tigris.org/ PySVN] (which is sometimes confused with the standard SWIG bindings).
    53    * If Subversion was already installed without the SWIG bindings, you'll need to re-`configure` Subversion and `make swig-py`, `make install-swig-py`.
    54  * Support for other version control systems is provided via third-parties. See [http://projects.edgewall.com/trac/wiki/PluginList PluginList] and [http://projects.edgewall.com/trac/wiki/VersioningSystemBackend VersioningSystemBackend].
     62
     63'''Please note:''' if using Subversion, Trac must be installed on the '''same machine'''. Remote repositories are currently not supported.
     64
     65 * [http://subversion.tigris.org/ Subversion], version >= 1.0. (versions recommended: 1.2.4, 1.3.2 or 1.4.2) and the '''''corresponding''''' Python bindings. For troubleshooting, check [trac:TracSubversion TracSubversion]
     66   * Trac uses the [http://svnbook.red-bean.com/svnbook-1.1/ch08s02.html#svn-ch-8-sect-2.3 SWIG] bindings included in the Subversion distribution, '''not''' [http://pysvn.tigris.org/ PySVN] (which is sometimes confused with the standard SWIG bindings).
     67   * If Subversion was already installed without the SWIG bindings, on Unix you'll need to re-`configure` Subversion and `make swig-py`, `make install-swig-py`.
     68   * There are [http://subversion.tigris.org/servlets/ProjectDocumentList?folderID=91 pre-compiled bindings] available for win32.
     69 * Support for other version control systems is provided via third-parties. See [trac:PluginList PluginList] and [trac:VersioningSystemBackend VersioningSystemBackend].
    5570
    5671==== Web Server ====
    5772 * A CGI-capable web server (see TracCgi), or
    5873 * a [http://www.fastcgi.com/ FastCGI]-capable web server (see TracFastCgi), or
    59  * [http://httpd.apache.org/ Apache] with [http://www.modpython.org/ mod_python 3.1.3+] (see TracModPython)
     74 * an [http://tomcat.apache.org/connectors-doc/ajp/ajpv13a.html AJP]-capable web server (see [trac:TracOnWindowsIisAjp TracOnWindowsIisAjp]), or
     75 * [http://httpd.apache.org/ Apache] with [http://code.google.com/p/modwsgi/ mod_wsgi] (see [wiki:TracModWSGI] or http://code.google.com/p/modwsgi/wiki/IntegrationWithTrac)
     76    * This should work with Apache 1.3, 2.0 or 2.2 and promises to deliver more performance than using mod_python. A little less mature than mod_python.
     77 * [http://httpd.apache.org/ Apache] with [http://modpython.org/ mod_python 3.1.3+] (see TracModPython)
    6078    * When installing mod_python the development versions of Python and Apache are required (actually the libraries and header files)
    6179
    62 For those stuck with Apache 1.3, it is also possible to get Trac 0.8.4 working with [http://www.modpython.org/ mod_python 2.7] (see [wiki:TracModPython2.7 TracModPython2.7]). This hasn't been tested with Trac 0.9, so it may or may not work.
     80For those stuck with Apache 1.3, it is also possible to get Trac working with [http://modpython.org/ mod_python 2.7] (see [wiki:TracModPython2.7 TracModPython2.7]). This guide hasn't been updated since 0.84, so it may or may not work.
    6381
    6482==== Other Python Utilities ====
    65  * [http://peak.telecommunity.com/DevCenter/setuptools setuptools], version >= 0.6 for using plugins (see TracPlugins)
     83 * [http://babel.edgewall.org Babel], version >= 0.9.2 for localization support
    6684 * [http://docutils.sourceforge.net/ docutils], version >= 0.3.9 for WikiRestructuredText.
    67  * [http://silvercity.sourceforge.net/ SilverCity] and/or [http://www.gnu.org/software/enscript/enscript.html Enscript] for [wiki:TracSyntaxColoring syntax highlighting].
     85 * [http://pygments.pocoo.org Pygments] for [wiki:TracSyntaxColoring syntax highlighting], also [http://silvercity.sourceforge.net/ SilverCity] and/or [http://gnu.org/software/enscript/enscript.html Enscript] may still be used.
    6886    * Note that !SilverCity 0.9.6 has a [http://sourceforge.net/tracker/index.php?func=detail&aid=1424436&group_id=45693&atid=443739 bug] that breaks Python syntax highlighting in Trac. Until an update is made available, we recommend using version 0.9.5.
    69 
    70 '''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 [http://projects.edgewall.com/trac/wiki/MailingList MailingList] or [http://projects.edgewall.com/trac/wiki/IrcChannel IrcChannel].
    71 
    72 Please refer to the documentation of these packages to find out how they are best installed. In addition, most of the [http://projects.edgewall.com/trac/wiki/TracInstallPlatforms platform-specific instructions] also describe the installation of the dependencies. Keep in mind however that the information there might concern older versions of Trac than the one you're installing (in particular,
    73 there are still some pages that are about Trac 0.8).
     87 * [http://pytz.sf.net pytz] to get a complete list of time zones, otherwise Trac will fall back on a shorter list from an internal time zone implementation.
     88
     89'''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 MailingList] or [trac:IrcChannel IrcChannel].
     90
     91Please 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!).
    7492
    7593== Installing Trac ==
    7694
    77 Like most Python programs, the Trac Python package is installed by running the following command at the top of the source directory:
     95One way to install Trac is using `setuptools`.
     96With setuptools you can install Trac from the subversion repository; for example,
     97to install release version 0.12dev do:
     98{{{
     99easy_install http://svn.edgewall.org/repos/trac/trunk
     100}}}
     101
     102But of course the python-typical setup at the top of the source directory also works:
    78103{{{
    79104$ python ./setup.py install
    80105}}}
    81 
    82 ''Note: you'll need root permissions or equivalent for this step.''
    83 
    84 This will byte-compile the python source code and install it in the `site-packages` directory
    85 of your Python installation. The directories `cgi-bin`, `templates`, `htdocs`, `wiki-default` and `wiki-macros` are all copied to `$prefix/share/trac/`. `conf` and `plugins` stub directories are also created under `$prefix/share/trac/` (''since [milestone:0.10]'').
     106See SubversionRepository for details about getting the source.
     107
     108''Note 1: you'll need root permissions or equivalent for this step.'' [[br]]
     109''Note 2: installing from source is the preferred method if you want to have a localized version of Trac'' [[br]]
     110
     111This will byte-compile the python source code and install it as an .egg file or folder in the `site-packages` directory
     112of your Python installation. The .egg will also contain all other resources needed by standard Trac, such as htdocs and templates.
    86113
    87114The 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.
    88115
     116If 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):
     117{{{
     118$ python ./setup.py compile_catalog -f
     119}}}
     120(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)
     121
    89122=== Advanced Options ===
    90123
    91124To install Trac to a custom location, or find out about other advanced installation options, run:
    92125{{{
    93 $ python ./setup.py install --help
     126easy_install --help
    94127}}}
    95128
    … …  
    98131Specifically, you might be interested in:
    99132{{{
    100 $ python ./setup.py install --prefix=/path/to/installdir
    101 }}}
     133easy_install --prefix=/path/to/installdir
     134}}}
     135or, if installing Trac to a Mac OS X system:
     136{{{
     137easy_install --prefix=/usr/local --install-dir=/Library/Python/2.5/site-packages
     138}}}
     139
     140The 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.
    102141
    103142== Creating a Project Environment ==
    … …  
    114153Also note that the values you specify here can be changed later by directly editing the [wiki:TracIni] configuration file.
    115154
    116 ''Note: The user account under which the web server runs will require write permissions to the environment
    117 directory and all the files inside.''
     155''Note: The user account under which the web server runs will require write permissions to the environment directory and all the files inside.  On Linux, with the web server running as user apache and group apache, enter:''
     156
     157  chown -R apache.apache /path/to/myproject
    118158
    119159
    … …  
    125165}}}
    126166
    127 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.
     167Then, 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:
     168{{{
     169$ tracd -s --port 8000 /path/to/myproject
     170}}}
    128171
    129172
    130173== Running Trac on a Web Server ==
    131174
    132 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.
     175Trac 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.
     176
     177If you're not afraid of running development code, you can also try running Trac on [wiki:TracModWSGI mod_wsgi]. This should deliver even better performance than mod_python, but the module is not considered stable just yet.
    133178
    134179== Configuring Authentication ==
    … …  
    140185 * TracModPython if you use the mod_python method.
    141186
     187== Automatic reference to the SVN changesets in Trac tickets ==
     188
     189You can configure SVN to automatically add a reference to the changeset into the ticket comments, whenever files are committed to the repository. The description of the commit needs to contain one of the following formulas:
     190 * '''Refs #123''' - to reference this changeset in #123 ticket
     191 * '''Fixes #123''' - to reference this changeset and close #123 ticket with the default status ''fixed''
     192
     193All you have to do is to edit the ''post-commit'' hook in your SVN repository and make it execute ''trac-post-commit-hook'' coming with Trac.
     194
     195If you are editing the ''post-commit'' hook for the first time you need to navigate to your SVN repository's hooks subfolder and rename existing there ''post-commit'' template:
     196
     197{{{
     198$ cd /path/to/svn/repository/hooks
     199$ mv post-commit.tmpl post-commit
     200$ chmod 755 post-commit
     201}}}
     202
     203Next open it in any text editor and add a line with path to the Trac environment connected with this SVN repository and another line executing the ''trac-post-commit-hook'' script:
     204
     205{{{
     206REPOS="$1"
     207REV="$2"
     208TRAC_ENV="/path/to/your/trac/project"
     209
     210/usr/bin/python /usr/local/bin/trac-post-commit-hook -p "$TRAC_ENV" -r "$REV"
     211}}}
     212
     213Make sure that ''trac-post-commit-hook'' exists in above path with execution permissions for the same user which SVN is running from. This script can be found in contrib subfolder of your Trac distribution and the latest version can be always downloaded from [source:trunk/contrib/trac-post-commit-hook].
     214
     215
     216== Platform-specifics installations ==
     217
     218 * See [trac:TracInstallPlatforms TracInstallPlatforms]
     219 
     220
    142221== Using Trac ==
    143222
    … …  
    148227'' Enjoy! ''
    149228
    150 [http://projects.edgewall.com/trac/wiki/TracTeam The Trac Team]
     229[trac:TracTeam The Trac Team]
    151230
    152231----
    153 See also:  TracGuide, TracCgi, TracFastCgi, TracModPython, TracUpgrade, TracPermissions
     232See also:  TracInstallPlatforms, TracGuide, TracCgi, TracFastCgi, TracModPython, [wiki:TracModWSGI], TracUpgrade, TracPermissions