Changes between Version 7 and Version 8 of 0.12/TracInstall
- Timestamp:
- Sep 2, 2009, 12:31:41 PM (15 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
0.12/TracInstall
v7 v8 9 9 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. 10 10 11 Since 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. 11 Since 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. Note Trac can still be installed without Babel, but then you will only get the default english version, as usual. 12 12 13 If you're interested in contributing new translations for other languages or enhance the existing translations, then please have a look at ["TracL10N"]. 13 14 14 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. 15 16 == Short - Install a released version == 17 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). 18 {{{ 19 sudo easy_install http://svn.edgewall.org/repos/trac/trunk 20 }}} 21 22 == Requirements - also older versions possible == 15 What 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. 16 17 18 == Prerequisites == 23 19 24 20 To install Trac, the following software packages must be installed: 25 21 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). 28 * For RPM-based systems you might also need the `python-devel` and `python-xml` packages. 29 * See instructions in ["TracOnWindows/Python2.5"] 22 * [http://www.python.org/ Python], version >= 2.4 (we dropped the support for Python 2.3 in this release) 30 23 * [http://peak.telecommunity.com/DevCenter/setuptools setuptools], version >= 0.6 31 * [http://genshi.edgewall.org/wiki/Download Genshi], version >= 0.4.1 24 * [http://genshi.edgewall.org/wiki/Download Genshi], [genshi:source:branches/experimental/advanced-18n advanced-18n] branch, from svn. 25 Note that even if you don't plan to use Babel and i18n support, you'll nevertheless still need that specific Genshi branch, as the templates contain specific tags and attributes which are only correctly interpreted with that version. 32 26 * You also need a database system and the corresponding python drivers for it. 33 The database can be either SQLite, PostgreSQL or ''MySQL (experimental)''.27 The database can be either SQLite, PostgreSQL or MySQL. 34 28 35 29 === For SQLite === 36 30 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.'' 41 42 ''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).'' 31 If you're using Python 2.5 or newer, you'll have a bundled version of SQLite and the bindings. If you're using Python 2.4 or you want to use a specific version of SQLite and/or the bindings, you can grab them from: 32 * [http://www.sqlite.org/ sqlite.org] 33 * [http://pysqlite.org/ pysqlite.org] 34 35 Note that SQLite v2.x databases are not supported anymore, you 36 need to migrate them to SQLite v3.x. 37 38 For details see the [trac:PySqlite PySqlite] page. 39 43 40 44 41 === For PostgreSQL === 45 42 43 You need to install the database and its Python bindings: 46 44 * [http://www.postgresql.org/ PostgreSQL] 47 45 * [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. 46 47 See [trac:DatabaseBackend#Postgresql DatabaseBackend] for details 48 51 49 52 50 === For MySQL === 53 51 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.55 56 * [http://mysql.com/ MySQL], version 4.1or later52 MySQL support is now good in Trac, provided you follow the guidelines. 53 54 * [http://mysql.com/ MySQL], version 5.0 or later 57 55 * [http://sf.net/projects/mysql-python MySQLdb], version 1.2.2 or later 58 56 57 See [trac:MySqlDb MySqlDb] for more detailed information. 58 59 59 60 === Optional Requirements === 60 61 61 62 ==== Version Control System ==== 62 63 64 ===== Subversion ===== 63 65 '''Please note:''' if using Subversion, Trac must be installed on the '''same machine'''. Remote repositories are currently not supported. 64 66 65 67 * [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). 68 [[br]] ''FIXME'' upgrade the requirements; it makes no sense to still support 1.0 or even 1.3, as Subversion itself only still supports 1.4.x 69 * 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), neither does it support the newer `ctype`-style bindings 67 70 * 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 71 * 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]. 72 73 ===== Others ===== 74 75 Support for other version control systems is provided via third-parties. See [trac:PluginList PluginList] and [trac:VersioningSystemBackend VersioningSystemBackend]. 70 76 71 77 ==== Web Server ==== 72 * A CGI-capable web server (see TracCgi), or 78 * A CGI-capable web server (see TracCgi), '''but usage of Trac as a cgi script 79 is highly discouraged''', better use one of the following options, 73 80 * a [http://www.fastcgi.com/ FastCGI]-capable web server (see TracFastCgi), or 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) 78 * When installing mod_python the development versions of Python and Apache are required (actually the libraries and header files) 79 80 For 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. 81 82 ==== Other Python Utilities ==== 83 * [http://babel.edgewall.org Babel], version >= 0.9.2 for localization support 84 * [http://docutils.sourceforge.net/ docutils], version >= 0.3.9 for WikiRestructuredText. 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. 86 * 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. 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. 81 * an [http://tomcat.apache.org/connectors-doc/ajp/ajpv13a.html AJP]-capable web 82 server (see [trac:TracOnWindowsIisAjp TracOnWindowsIisAjp]), or 83 * [http://httpd.apache.org/ Apache] with 84 - [http://code.google.com/p/modwsgi/ mod_wsgi], see [wiki:TracModWSGI] or 85 http://code.google.com/p/modwsgi/wiki/IntegrationWithTrac 86 - [http://modpython.org/ mod_python 3.3.1], see TracModPython) 87 88 89 ==== Other Python Packages ==== 90 91 * [http://babel.edgewall.org Babel], version >= 0.9.4, 92 needed for localization support 93 * [http://docutils.sourceforge.net/ docutils], version >= 0.3.9 94 for WikiRestructuredText. 95 * [http://pygments.pocoo.org Pygments] for 96 [wiki:TracSyntaxColoring syntax highlighting]. 97 [http://silvercity.sourceforge.net/ SilverCity] and/or 98 [http://gnu.org/software/enscript/enscript.html Enscript] may still be used 99 but are deprecated and you really should be using Pygments. 100 * [http://pytz.sf.net pytz] to get a complete list of time zones, 101 otherwise Trac will fall back on a shorter list from 102 an internal time zone implementation. 88 103 89 104 '''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 105 91 106 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!). 107 92 108 93 109 == Installing Trac == … … 120 136 (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 137 138 122 139 === Advanced Options === 123 140 … … 140 157 The 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. 141 158 159 142 160 == Creating a Project Environment == 143 161 … … 173 191 == Running Trac on a Web Server == 174 192 175 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. 176 177 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. 193 Trac provides three options for connecting to a "real" web server: [wiki:TracCgi CGI], [wiki:TracFastCgi FastCGI], [wiki:TracModPython mod_python], [wiki:TracModWSGI mod_wsgi]. For decent performance, it is recommended that you use either FastCGI, mod_python or mod_wsgi. 194 178 195 179 196 == Configuring Authentication == … … 185 202 * TracModPython if you use the mod_python method. 186 203 187 == Trac 0.11 & SVN on Mac OS X Leopard (10.5) ==188 189 * [trac:TracOnLeopardServer TracOnLeopardServer]190 204 191 205 == Using Trac ==