Changes between Version 2 and Version 3 of TracInstall

Show
Ignore:
Timestamp:
05/26/10 15:22:44 (5 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracInstall

    v2 v3  
    22[[TracGuideToc]] 
    33 
    4 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. 
     4 
     5Trac 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. 
    56 
    67What 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. 
    78 
    8 == Short - Install a released version == 
    9 For 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). 
    10 {{{ 
    11 sudo easy_install Trac==0.11 
    12 }}} 
    13  
    14 == Requirements - also older versions possible == 
     9See TracUpgrade for instructions on how to upgrade an existing installation. 
     10 
     11 
     12== Quick Install a Released Version == 
     13For 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 
     15Then enter (''omitting 'sudo' if not applicable'') 
     16{{{ 
     17sudo easy_install Trac 
     18}}} 
     19to install Trac, SQLite, and Genshi. 
     20 
     21 
     22== Requirements == 
     23The 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. 
    1524 
    1625To install Trac, the following software packages must be installed: 
    1726 
    18  * [http://www.python.org/ Python], version >= 2.3 
     27 * [http://www.python.org/ Python], version >=2.3 (<3.0) 
    1928   * 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). 
    2029   * For RPM-based systems you might also need the `python-devel` and `python-xml` packages. 
    21    * See instructions in ["TracOnWindows/Python2.5"] 
    22  * [http://peak.telecommunity.com/DevCenter/setuptools setuptools], version >= 0.6 
    23  * [http://genshi.edgewall.org/wiki/Download Genshi], version >= 0.4.1 
     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) 
    2433 * You also need a database system and the corresponding python drivers for it. 
    25    The database can be either SQLite, PostgreSQL or ''MySQL (experimental)''. 
    26  * optional if some plugins require it: [http://www.clearsilver.net/ ClearSilver] 
    27  
    28 === For SQLite === 
    29  
    30  * [http://www.sqlite.org/ SQLite], version 3.3.4 and above preferred. 
    31  * 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 PySqlite 
    32  
    33 ''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.'' 
    34  
    35 ''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).'' 
    36  
    37 === For PostgreSQL === 
     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 ==== 
     38 
     39If you're using Python 2.5 or 2.6, you already have everything you need. 
     40 
     41If you're using Python 2.3 or 2.4 and need pysqlite, you can download from  
     42[http://code.google.com/p/pysqlite/downloads/list google code] the Windows 
     43installers or the tar.gz archive for building from source:  
     44{{{ 
     45$ tar xvfz <version>.tar.gz  
     46$ cd <version>  
     47$ python setup.py build_static install  
     48}}} 
     49  
     50That way, the latest SQLite version will be downloaded and built into the  
     51bindings.  
     52 
     53If you're still using SQLite 2.x, you'll need pysqlite 1.0.x, although this  
     54package is not easy to find anymore. For SQLite 3.x, try not to use 
     55pysqlite 1.1.x, which has been deprecated in favor of pysqlite 2.x. 
     56 
     57See additional information in [trac:PySqlite PySqlite]. 
     58 
     59==== For PostgreSQL ==== 
    3860 
    3961 * [http://www.postgresql.org/ PostgreSQL] 
    40  * [http://initd.org/projects/psycopg2 psycopg2] or [http://pypgsql.sourceforge.net/ pyPgSQL] 
     62 * [http://initd.org/projects/psycopg2 psycopg2] 
     63 * See [trac:wiki:DatabaseBackend#Postgresql DatabaseBackend] 
    4164 
    4265'''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. 
    4366 
    44 === For MySQL === 
    45  
    46 '''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 MySqlDb for more detailed information. 
    47  
    48  * [http://mysql.com/ MySQL], version 4.1 or later 
     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) 
    4970 * [http://sf.net/projects/mysql-python MySQLdb], version 1.2.1 or later 
    5071 
    51 === Optional Requirements === 
     72See [trac:MySqlDb MySqlDb] for more detailed information. 
     73It is ''very'' important to read carefully that page before creating the database. 
     74 
     75== Optional Requirements == 
    5276 
    5377==== Version Control System ==== 
    5478 
    55 '''Please note:''' if using Subversion, Trac must be installed on the '''same machine'''. Remote repositories are currently not supported. 
    56  
    57  * [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 TracSubversion 
     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] 
    5882   * 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). 
    5983   * 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`. 
    6084   * There are [http://subversion.tigris.org/servlets/ProjectDocumentList?folderID=91 pre-compiled bindings] available for win32.  
    61  * Support for other version control systems is provided via third-parties. See PluginList and VersioningSystemBackend. 
     85 * Support for other version control systems is provided via third-parties. See [trac:PluginList PluginList] and [trac:VersioningSystemBackend VersioningSystemBackend]. 
    6286 
    6387==== Web Server ==== 
    6488 * A CGI-capable web server (see TracCgi), or 
    6589 * a [http://www.fastcgi.com/ FastCGI]-capable web server (see TracFastCgi), or 
    66  * [http://httpd.apache.org/ Apache] with [http://code.google.com/p/modwsgi/ mod_wsgi] (see [wiki:TracModWSGI]) 
     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 
    6792    * 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. 
    6893 * [http://httpd.apache.org/ Apache] with [http://www.modpython.org/ mod_python 3.1.3+] (see TracModPython) 
    6994    * When installing mod_python the development versions of Python and Apache are required (actually the libraries and header files) 
    7095 
    71 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 [wiki:TracModPython2.7 TracModPython2.7]). This guide hasn't been updated since 0.84, so it may or may not work. 
     96For 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. 
    7297 
    7398==== Other Python Utilities ==== 
    7499 * [http://docutils.sourceforge.net/ docutils], version >= 0.3.9 for WikiRestructuredText. 
    75  * [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. 
    76     * 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. 
     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. 
    77101 * [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. 
    78102 
    79 '''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 MailingList or IrcChannel. 
    80  
    81 Please refer to the documentation of these packages to find out how they are best installed. In addition, most of the [wiki: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!). 
     103'''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]. 
     104 
     105Please 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!). 
    82106 
    83107== Installing Trac == 
     
    85109One way to install Trac is using `setuptools`. 
    86110With setuptools you can install Trac from the subversion repository; for example, 
    87 to install release version 0.11b2 do: 
    88 {{{ 
    89 easy_install http://svn.edgewall.org/repos/trac/tags/trac-0.11b2 
     111to install release version 0.11 do: 
     112{{{ 
     113easy_install http://svn.edgewall.org/repos/trac/tags/trac-0.11 
    90114}}} 
    91115 
     
    102126The 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. 
    103127 
    104 === Advanced Options === 
     128==== Advanced Options ==== 
    105129 
    106130To install Trac to a custom location, or find out about other advanced installation options, run: 
     
    139163  chown -R apache.apache /path/to/myproject 
    140164 
    141  
    142165== Running the Standalone Server == 
    143166 
     
    152175}}} 
    153176 
    154  
    155177== Running Trac on a Web Server == 
    156178 
    157179Trac 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. 
    158180 
    159 If 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. 
     181If 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. 
     182 
     183Trac also supports [trac:TracOnWindowsIisAjp AJP] which may be your choice if you want to connect to IIS. 
     184 
     185==== Generating the Trac cgi-bin directory ==== 
     186 
     187In 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]. 
     188 
     189There 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: 
     190{{{ 
     191mkdir -p /usr/share/trac/projects/my-project 
     192trac-admin /usr/share/trac/projects/my-project initenv 
     193trac-admin /usr/share/trac/projects/my-project deploy /tmp/deploy 
     194mv /tmp/deploy/* /usr/share/trac 
     195}}} 
     196 
     197==== Setting up the Plugin Cache ==== 
     198 
     199Some 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. 
    160200 
    161201== Configuring Authentication == 
     
    167207 * TracModPython if you use the mod_python method. 
    168208 
    169 == Trac 0.11 & SVN on Mac OS X Leopard (10.5) == 
    170  
    171  * TracOnLeopardServer 
     209== Automatic reference to the SVN changesets in Trac tickets == 
     210 
     211You 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 
     215All 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 
     217If 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 
     225Next 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{{{ 
     228REPOS="$1" 
     229REV="$2" 
     230TRAC_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 
     235Make 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  
    172242 
    173243== Using Trac == 
     
    179249'' Enjoy! '' 
    180250 
    181 [wiki:TracTeam The Trac Team] 
     251[trac:TracTeam The Trac Team] 
    182252 
    183253---- 
    184 See also: TracGuide, TracCgi, TracFastCgi, TracModPython, [wiki:TracModWSGI], TracUpgrade, TracPermissions 
    185  
     254See also: [trac:TracInstallPlatforms TracInstallPlatforms], TracGuide, TracCgi, TracFastCgi, TracModPython, [wiki:TracModWSGI], TracUpgrade, TracPermissions 
     255