Changes between Version 5 and Version 6 of TracInstall


Ignore:
Timestamp:
Mar 19, 2010, 10:16:03 AM (12 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracInstall

    v5 v6  
    1 = Trac Installation Guide for 0.11 =
     1= Trac Installation Guide for 0.12dev =
     2
    23[[TracGuideToc]]
    34
    4 
    5 Trac is written in the Python programming language and needs a database, [http://sqlite.org/ SQLite], [http://postgresql.org/ PostgreSQL], [http://mysql.com/ MySQL]. For HTML rendering, Trac uses the [http://genshi.edgewall.org Genshi] templating system.
    6 
    7 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 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.
    8 
    9 See TracUpgrade for instructions on how to upgrade an existing installation.
    10 
    11 
    12 == Quick Install a Released Version ==
    13 For a quick install, first make sure you have [http://python.org/download Python] (2.3-2.6) and [http://peak.telecommunity.com/DevCenter/EasyInstall#installing-easy-install easy_install].
    14 
    15 Then enter (''omitting 'sudo' if not applicable'')
    16 {{{
    17 sudo easy_install Trac
    18 }}}
    19 to install Trac, SQLite, and Genshi.
    20 
    21 
    22 == Requirements ==
    23 The hardware requirements for running Trac obviously depend on the expected data volume (number of wiki pages, tickets, revisions) and traffic. Very small projects will run fine with a 500MHz processor and 128MB RAM using SQLite. In general, the more RAM, the better. A fast hard disk also helps.
    24 
     5Trac 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.
     6
     7Since 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.
     8
     9If you're interested in contributing new translations for other languages or enhance the existing translations, then please have a look at ["TracL10N"].
     10
     11What 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.
     12
     13
     14== Prerequisites ==
     15=== Mandatory Prerequisites
    2516To install Trac, the following software packages must be installed:
    2617
    27  * [http://www.python.org/ Python], version >=2.3 (<3.0)
    28    * 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).
    29    * For RPM-based systems you might also need the `python-devel` and `python-xml` packages.
    30    * See instructions in [trac:wiki:TracOnWindows/Python2.5 TracOnWindows/Python2.5]
    31  * [wiki:setuptools], version >= 0.6
    32  * [http://genshi.edgewall.org/wiki/Download Genshi], version >= 0.5 (was version >= 0.4.1 on previous 0.11 release candidates)
    33  * You also need a database system and the corresponding python drivers for it.
    34    The database can be either SQLite, PostgreSQL or MySQL.
    35  * Optional if some plugins require it: [http://www.clearsilver.net/ ClearSilver]
    36 
    37 ==== For SQLite ====
     18 * [http://www.python.org/ Python], version >= 2.4 (we dropped the support for Python 2.3 in this release)
     19 * [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
     22You also need a database system and the corresponding python bindings.
     23The database can be either SQLite, PostgreSQL or MySQL.
     24
     25==== For the SQLite database #ForSQLite
    3826
    3927If you're using Python 2.5 or 2.6, you already have everything you need.
    4028
    41 If you're using Python 2.3 or 2.4 and need pysqlite, you can download from
     29If you're using Python 2.4 and need pysqlite, you can download from
    4230[http://code.google.com/p/pysqlite/downloads/list google code] the Windows
    4331installers or the tar.gz archive for building from source:
     
    5139bindings.
    5240
    53 If you're still using SQLite 2.x, you'll need pysqlite 1.0.x, although this
    54 package is not easy to find anymore. For SQLite 3.x, try not to use
    55 pysqlite 1.1.x, which has been deprecated in favor of pysqlite 2.x.
     41SQLite 2.x is no longer supported. For SQLite 3.x, the pysqlite 1.1.x
     42bindings are also no longer supported, use pysqlite 2.x.
    5643
    5744See additional information in [trac:PySqlite PySqlite].
    5845
    59 ==== For PostgreSQL ====
    60 
     46==== For the PostgreSQL database #ForPostgreSQL
     47
     48You need to install the database and its Python bindings:
    6149 * [http://www.postgresql.org/ PostgreSQL]
    62  * [http://initd.org/projects/psycopg2 psycopg2]
    63  * See [trac:wiki:DatabaseBackend#Postgresql DatabaseBackend]
    64 
    65 '''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.
    66 
    67 ==== For MySQL ====
    68 
    69  * [http://mysql.com/ MySQL], version 4.1 or later ([http://askmonty.org/wiki/index.php/MariaDB MariaDB] might work as well)
    70  * [http://sf.net/projects/mysql-python MySQLdb], version 1.2.1 or later
    71 
    72 See [trac:MySqlDb MySqlDb] for more detailed information.
    73 It is ''very'' important to read carefully that page before creating the database.
    74 
    75 == Optional Requirements ==
     50 * [http://pypi.python.org/pypi/psycopg2 psycopg2]
     51
     52See [trac:DatabaseBackend#Postgresql DatabaseBackend] for details.
     53
     54
     55==== For the MySQL database #ForMySQL
     56
     57Trac can now work quite well with MySQL, provided you follow the guidelines.
     58
     59 * [http://mysql.com/ MySQL], version 5.0 or later
     60 * [http://sf.net/projects/mysql-python MySQLdb], version 1.2.2 or later
     61
     62It is '''very''' important to read carefully the  [trac:MySqlDb MySqlDb] page before creating the database.
     63
     64=== Optional Prerequisites
    7665
    7766==== Version Control System ====
    7867
    79 '''Please note:''' if using Subversion, Trac must be installed on the '''same machine'''. Remote repositories are currently not supported (although Windows UNC paths such as {{{\\machine_name\path\to\svn}}} do work).
    80 
    81  * [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]
    82    * 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).
    83    * 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`.
    84    * There are [http://subversion.tigris.org/servlets/ProjectDocumentList?folderID=91 pre-compiled bindings] available for win32.
    85  * Support for other version control systems is provided via third-parties. See [trac:PluginList PluginList] and [trac:VersioningSystemBackend VersioningSystemBackend].
     68===== 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/
     70
     71There 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
     72
     73
     74'''Please note:''' if using Subversion, Trac must be installed on the '''same machine'''. Remote repositories are currently [trac:ticket:493 not supported].
     75
     76
     77===== Others =====
     78
     79Support for other version control systems is provided via third-parties. See [trac:PluginList PluginList] and [trac:VersioningSystemBackend VersioningSystemBackend].
    8680
    8781==== Web Server ====
    88  * A CGI-capable web server (see TracCgi), or
     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,
    8984 * a [http://www.fastcgi.com/ FastCGI]-capable web server (see TracFastCgi), or
    90  * an [http://tomcat.apache.org/connectors-doc/ajp/ajpv13a.html AJP]-capable web server (see [trac:TracOnWindowsIisAjp TracOnWindowsIisAjp]), or
    91  * [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) or
    92     * 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.
    93  * [http://httpd.apache.org/ Apache] with [http://www.modpython.org/ mod_python 3.1.3+] (see TracModPython)
    94     * When installing mod_python the development versions of Python and Apache are required (actually the libraries and header files)
    95 
    96 For those stuck with Apache 1.3, it is also possible to get Trac working with [http://www.modpython.org/ mod_python 2.7] (see [trac:wiki:TracModPython2.7 TracModPython2.7]). This guide hasn't been updated since 0.84, so it may or may not work.
    97 
    98 ==== Other Python Utilities ====
    99  * [http://docutils.sourceforge.net/ docutils], version >= 0.3.9 for WikiRestructuredText.
    100  * [http://pygments.pocoo.org Pygments] for '''syntax highlighting''', although [http://silvercity.sourceforge.net/ SilverCity] >= 0.9.7 and/or [http://gnu.org/software/enscript/enscript.html GNU Enscript] are also possible. Refer to TracSyntaxColoring for details.
    101  * [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.
     85 * an [http://tomcat.apache.org/connectors-doc/ajp/ajpv13a.html AJP]-capable web
     86   server (see [trac:TracOnWindowsIisAjp TracOnWindowsIisAjp]), or
     87 * [http://httpd.apache.org/ Apache] with
     88   - [http://code.google.com/p/modwsgi/ mod_wsgi], see [wiki:TracModWSGI] and
     89     http://code.google.com/p/modwsgi/wiki/IntegrationWithTrac
     90   - [http://modpython.org/ mod_python 3.3.1], see TracModPython)
     91   
     92
     93==== Other Python Packages ====
     94
     95 * [http://babel.edgewall.org Babel], version >= 0.9.4,
     96   needed for localization support
     97 * [http://docutils.sourceforge.net/ docutils], version >= 0.3.9
     98   for WikiRestructuredText.
     99 * [http://pygments.pocoo.org Pygments] for
     100   [wiki:TracSyntaxColoring syntax highlighting].
     101   [http://silvercity.sourceforge.net/ SilverCity] and/or
     102   [http://gnu.org/software/enscript/enscript.html Enscript] may still be used
     103   but are deprecated and you really should be using Pygments.
     104 * [http://pytz.sf.net pytz] to get a complete list of time zones,
     105   otherwise Trac will fall back on a shorter list from
     106   an internal time zone implementation.
    102107
    103108'''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].
    104109
    105110Please 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!).
     111
    106112
    107113== Installing Trac ==
     
    109115One way to install Trac is using `setuptools`.
    110116With setuptools you can install Trac from the subversion repository; for example,
    111 to install release version 0.11 do:
    112 {{{
    113 easy_install http://svn.edgewall.org/repos/trac/tags/trac-0.11
     117to install release version 0.12dev do:
     118{{{
     119easy_install http://svn.edgewall.org/repos/trac/trunk
    114120}}}
    115121
     
    118124$ python ./setup.py install
    119125}}}
    120 
    121 ''Note: you'll need root permissions or equivalent for this step.''
     126See 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]]
    122130
    123131This will byte-compile the python source code and install it as an .egg file or folder in the `site-packages` directory
     
    126134The 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.
    127135
    128 ==== Advanced Options ====
     136If 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
     142
     143=== Advanced Options ===
    129144
    130145To install Trac to a custom location, or find out about other advanced installation options, run:
     
    143158easy_install --prefix=/usr/local --install-dir=/Library/Python/2.5/site-packages
    144159}}}
     160Note: 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
    145161
    146162The 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.
    147163
     164
    148165== Creating a Project Environment ==
    149166
    150 A [wiki: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 configuration file and various other files and directories.
     167A [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.
    151168
    152169A new environment is created using [wiki:TracAdmin trac-admin]:
     
    155172}}}
    156173
    157 [wiki:TracAdmin trac-admin] will prompt you for the information it needs to create the environment, such as the name of the project, the type and the path to an existing [wiki:TracEnvironment#SourceCodeRepository source code repository], the [wiki:TracEnvironment#DatabaseConnectionStrings database connection string], and so on. If you're not sure what to specify for one of these options, just leave it blank to use the default value. The database connection string in particular will always work as long as you have SQLite installed. Leaving the path to the source code repository empty will disable any functionality related to version control, but you can always add that back when the basic system is running.
    158 
    159 Also note that the values you specify here can be changed later by directly editing the [wiki:TracIni] configuration file.
    160 
    161 ''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:''
    162 
    163   chown -R apache.apache /path/to/myproject
     174[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.
     175
     176Leaving the database connection string empty in particular will always work as long as you have SQLite installed.
     177For the other [DatabaseBackend database backends] you should plan ahead and already have a database ready to use at this point.
     178
     179Since 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.
     180
     181Also note that the values you specify here can be changed later by directly editing the [TracIni conf/trac.ini] configuration file.
     182
     183Finally, 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:
     184{{{
     185# chown -R apache.apache /path/to/myproject
     186}}}
    164187
    165188== Running the Standalone Server ==
     
    179202Trac 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.
    180203
    181 If you're not afraid of running newer code, you can also try running Trac on [wiki:TracModWSGI mod_wsgi]. This should deliver even better performance than mod_python, but the module isn't as extensively tested as mod_python.
    182204
    183205Trac also supports [trac:TracOnWindowsIisAjp AJP] which may be your choice if you want to connect to IIS.
     
    207229 * TracModPython if you use the mod_python method.
    208230
    209 == Automatic reference to the SVN changesets in Trac tickets ==
    210 
    211 You 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:
    212  * '''Refs #123''' - to reference this changeset in #123 ticket
    213  * '''Fixes #123''' - to reference this changeset and close #123 ticket with the default status ''fixed''
    214 
    215 All 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.
    216 
    217 If 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:
    218 
    219 {{{
    220 $ cd /path/to/svn/repository/hooks
    221 $ mv post-commit.tmpl post-commit
    222 $ chmod 755 post-commit
    223 }}}
    224 
    225 Next 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:
    226 
    227 {{{
    228 REPOS="$1"
    229 REV="$2"
    230 TRAC_ENV="/path/to/your/trac/project"
    231 
    232 /usr/bin/python /usr/local/bin/trac-post-commit-hook -p "$TRAC_ENV" -r "$REV"
    233 }}}
    234 
    235 Make 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].
    236 
    237 
    238 == Platform-specifics installations ==
    239 
    240  * See [trac:TracInstallPlatforms TracInstallPlatforms]
    241  
    242231
    243232== Using Trac ==
     
    253242----
    254243See also: [trac:TracInstallPlatforms TracInstallPlatforms], TracGuide, TracCgi, TracFastCgi, TracModPython, [wiki:TracModWSGI], TracUpgrade, TracPermissions
    255