Changes between Version 2 and Version 3 of TracInstall


Ignore:
Timestamp:
10/01/2009 04:59:24 PM (15 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracInstall

    v2 v3  
    77
    88== 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 ==
     9For 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)
     10{{{
     11sudo easy_install Trac
     12}}}
     13
     14== Requirements ==
     15The 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.
    1516
    1617To install Trac, the following software packages must be installed:
    … …  
    2122   * See instructions in ["TracOnWindows/Python2.5"]
    2223 * [http://peak.telecommunity.com/DevCenter/setuptools setuptools], version >= 0.6
    23  * [http://genshi.edgewall.org/wiki/Download Genshi], version >= 0.4.1
     24 * [http://genshi.edgewall.org/wiki/Download Genshi], version >= 0.5 (was version >= 0.4.1 on previous 0.11 release candidates)
    2425 * You also need a database system and the corresponding python drivers for it.
    2526   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
     27 * Optional if some plugins require it: [http://www.clearsilver.net/ ClearSilver]
     28
     29==== For SQLite ====
     30
     31 * [http://www.sqlite.org/ SQLite], version 3.3.4 and above preferred (note: it is preinstalled in Python 2.5.2).
     32 * 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]
    3233
    3334''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.''
    … …  
    3536''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).''
    3637
    37 === For PostgreSQL ===
     38==== For PostgreSQL ====
    3839
    3940 * [http://www.postgresql.org/ PostgreSQL]
    40  * [http://initd.org/projects/psycopg2 psycopg2] or [http://pypgsql.sourceforge.net/ pyPgSQL]
     41 * [http://initd.org/projects/psycopg2 psycopg2]
     42 * See [trac:wiki:DatabaseBackend#Postgresql DatabaseBackend]
    4143
    4244'''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.
    4345
    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.
     46==== For MySQL ====
     47
     48'''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.
    4749
    4850 * [http://mysql.com/ MySQL], version 4.1 or later
    4951 * [http://sf.net/projects/mysql-python MySQLdb], version 1.2.1 or later
    5052
    51 === Optional Requirements ===
     53== Optional Requirements ==
    5254
    5355==== Version Control System ====
    … …  
    5557'''Please note:''' if using Subversion, Trac must be installed on the '''same machine'''. Remote repositories are currently not supported.
    5658
    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
     59 * [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]
    5860   * 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).
    5961   * 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`.
    6062   * 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.
     63 * Support for other version control systems is provided via third-parties. See [trac:PluginList PluginList] and [trac:VersioningSystemBackend VersioningSystemBackend].
    6264
    6365==== Web Server ====
    6466 * A CGI-capable web server (see TracCgi), or
    6567 * 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])
     68 * an [http://tomcat.apache.org/connectors-doc/ajp/ajpv13a.html AJP]-capable web server (see [trac:TracOnWindowsIisAjp TracOnWindowsIisAjp]), or
     69 * [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)
    6770    * 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.
    6871 * [http://httpd.apache.org/ Apache] with [http://www.modpython.org/ mod_python 3.1.3+] (see TracModPython)
    … …  
    7376==== Other Python Utilities ====
    7477 * [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.
     78 * [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.
    7779 * [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.
    7880
    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!).
     81'''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].
     82
     83Please 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!).
    8284
    8385== Installing Trac ==
    … …  
    8587One way to install Trac is using `setuptools`.
    8688With 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
     89to install release version 0.11 do:
     90{{{
     91easy_install http://svn.edgewall.org/repos/trac/tags/trac-0.11
    9092}}}
    9193
    … …  
    102104The 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.
    103105
    104 === Advanced Options ===
     106==== Advanced Options ====
    105107
    106108To install Trac to a custom location, or find out about other advanced installation options, run:
    … …  
    139141  chown -R apache.apache /path/to/myproject
    140142
     143'''Warning: If the trac.cgi files are not installed where you expect, then the current documentation is insufficient; it might be necessary to use the 'deploy' command in trac-admin.  See tickets http://trac.edgewall.org/ticket/7312 and possibly http://trac.edgewall.org/ticket/6827'''
    141144
    142145== Running the Standalone Server ==
    … …  
    157160Trac 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.
    158161
    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.
     162If 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.
     163
     164Trac also supports [trac:TracOnWindowsIisAjp AJP] which may be your choice if you want to connect to IIS.
     165
     166==== Setting up the Plugin Cache ====
     167
     168Some 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.
    160169
    161170== Configuring Authentication ==
    … …  
    167176 * TracModPython if you use the mod_python method.
    168177
    169 == Trac 0.11 & SVN on Mac OS X Leopard (10.5) ==
    170 
    171  * TracOnLeopardServer
     178== Automatic reference to the SVN changesets in Trac tickets ==
     179
     180You 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:
     181 * '''Refs #123''' - to reference this changeset in #123 ticket
     182 * '''Fixes #123''' - to reference this changeset and close #123 ticket with the default status ''fixed''
     183
     184All 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.
     185
     186If 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:
     187
     188{{{
     189$ cd /path/to/svn/repository/hooks
     190$ mv post-commit.tmpl post-commit
     191$ chmod 755 post-commit
     192}}}
     193
     194Next 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:
     195
     196{{{
     197REPOS="$1"
     198REV="$2"
     199TRAC_ENV="/path/to/your/trac/project"
     200
     201/usr/bin/python /usr/local/bin/trac-post-commit-hook -p "$TRAC_ENV" -r "$REV"
     202}}}
     203
     204Make 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].
     205
     206
     207== Platform-specifics installations ==
     208
     209 * See [trac:TracInstallPlatforms TracInstallPlatforms]
     210 
    172211
    173212== Using Trac ==
    … …  
    179218'' Enjoy! ''
    180219
    181 [wiki:TracTeam The Trac Team]
     220[trac:TracTeam The Trac Team]
    182221
    183222----
    184 See also:  TracGuide, TracCgi, TracFastCgi, TracModPython, [wiki:TracModWSGI], TracUpgrade, TracPermissions
    185 
     223See also:  TracInstallPlatforms, TracGuide, TracCgi, TracFastCgi, TracModPython, [wiki:TracModWSGI], TracUpgrade, TracPermissions