Changes between Version 6 and Version 7 of TracInstall
- Timestamp:
- Dec 2, 2009, 4:25:51 PM (14 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracInstall
v6 v7 2 2 [[TracGuideToc]] 3 3 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 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. 5 6 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. 7 8 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). 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'') 10 16 {{{ 11 17 sudo easy_install Trac 12 18 }}} 19 to install Trac, SQLite, and Genshi. 20 13 21 14 22 == Requirements == … … 17 25 To install Trac, the following software packages must be installed: 18 26 19 * [http://www.python.org/ Python], version >= 2.327 * [http://www.python.org/ Python], version >=2.3 (<3.0) 20 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). 21 29 * For RPM-based systems you might also need the `python-devel` and `python-xml` packages. 22 * See instructions in [ "TracOnWindows/Python2.5"]23 * [ http://peak.telecommunity.com/DevCenter/setuptoolssetuptools], version >= 0.630 * See instructions in [trac:wiki:TracOnWindows/Python2.5 TracOnWindows/Python2.5] 31 * [wiki:setuptools], version >= 0.6 24 32 * [http://genshi.edgewall.org/wiki/Download Genshi], version >= 0.5 (was version >= 0.4.1 on previous 0.11 release candidates) 25 33 * You also need a database system and the corresponding python drivers for it. 26 The database can be either SQLite, PostgreSQL or ''MySQL (experimental)''.34 The database can be either SQLite, PostgreSQL or MySQL. 27 35 * Optional if some plugins require it: [http://www.clearsilver.net/ ClearSilver] 28 36 29 37 ==== For SQLite ==== 30 38 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 PySqlite 33 34 ''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.'' 35 36 ''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).'' 39 If you're using Python 2.5 or 2.6, you already have everything you need. 40 41 If 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 43 installers 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 50 That way, the latest SQLite version will be downloaded and built into the 51 bindings. 52 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. 56 57 See additional information in [trac:PySqlite PySqlite]. 37 58 38 59 ==== For PostgreSQL ==== … … 40 61 * [http://www.postgresql.org/ PostgreSQL] 41 62 * [http://initd.org/projects/psycopg2 psycopg2] 42 * See [ wiki:DatabaseBackend#Postgresql]63 * See [trac:wiki:DatabaseBackend#Postgresql DatabaseBackend] 43 64 44 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. … … 46 67 ==== For MySQL ==== 47 68 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 MySqlDb for more detailed information. 49 50 * [http://mysql.com/ MySQL], version 4.1 or later 69 * [http://mysql.com/ MySQL], version 4.1 or later ([http://askmonty.org/wiki/index.php/MariaDB MariaDB] might work as well) 51 70 * [http://sf.net/projects/mysql-python MySQLdb], version 1.2.1 or later 52 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 53 75 == Optional Requirements == 54 76 55 77 ==== Version Control System ==== 56 78 57 '''Please note:''' if using Subversion, Trac must be installed on the '''same machine'''. Remote repositories are currently not supported .58 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 TracSubversion79 '''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] 60 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). 61 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`. 62 84 * There are [http://subversion.tigris.org/servlets/ProjectDocumentList?folderID=91 pre-compiled bindings] available for win32. 63 * 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]. 64 86 65 87 ==== Web Server ==== 66 88 * A CGI-capable web server (see TracCgi), or 67 89 * a [http://www.fastcgi.com/ FastCGI]-capable web server (see TracFastCgi), or 68 * an [http://tomcat.apache.org/connectors-doc/ajp/ajpv13a.html AJP]-capable web server (see Trac:TracOnWindowsIisAjp), or69 * [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) 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 70 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. 71 93 * [http://httpd.apache.org/ Apache] with [http://www.modpython.org/ mod_python 3.1.3+] (see TracModPython) 72 94 * When installing mod_python the development versions of Python and Apache are required (actually the libraries and header files) 73 95 74 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.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. 75 97 76 98 ==== Other Python Utilities ==== … … 79 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. 80 102 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 MailingList or IrcChannel.82 83 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 105 Please 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!). 84 106 85 107 == Installing Trac == … … 141 163 chown -R apache.apache /path/to/myproject 142 164 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'''144 145 165 == Running the Standalone Server == 146 166 … … 155 175 }}} 156 176 157 158 177 == Running Trac on a Web Server == 159 178 … … 163 182 164 183 Trac 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 187 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]. 188 189 There 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 {{{ 191 mkdir -p /usr/share/trac/projects/my-project 192 trac-admin /usr/share/trac/projects/my-project initenv 193 trac-admin /usr/share/trac/projects/my-project deploy /tmp/deploy 194 mv /tmp/deploy/* /usr/share/trac 195 }}} 165 196 166 197 ==== Setting up the Plugin Cache ==== … … 176 207 * TracModPython if you use the mod_python method. 177 208 178 == Trac 0.11 & SVN on Mac OS X Leopard (10.5) == 179 180 * TracOnLeopardServer 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 181 242 182 243 == Using Trac == … … 188 249 '' Enjoy! '' 189 250 190 [ wiki:TracTeam The Trac Team]251 [trac:TracTeam The Trac Team] 191 252 192 253 ---- 193 See also: TracGuide, TracCgi, TracFastCgi, TracModPython, [wiki:TracModWSGI], TracUpgrade, TracPermissions194 254 See also: [trac:TracInstallPlatforms TracInstallPlatforms], TracGuide, TracCgi, TracFastCgi, TracModPython, [wiki:TracModWSGI], TracUpgrade, TracPermissions 255