Changes between Version 1 and Version 2 of TracInstall


Ignore:
Timestamp:
Dec 2, 2009, 12:08:12 AM (16 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracInstall

    v1 v2  
    33#!div style="margin-top: .5em; padding: 0 1em; background-color: #ffd; border:1px outset #ddc;"
    44
    5   '''NOTE: this page is for 0.12dev (trunk), for which development has started. For installing previous Trac versions, please refer to TracInstall (0.11)'''
     5  '''NOTE: this page is for 0.12dev (trunk), the version currently in development. For installing previous Trac versions, please refer to TracInstall (0.11)'''
    66}}}
    77[[TracGuideToc]]
    … …  
    99Trac 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.
    1010
    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.
     11Since 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
    1213If you're interested in contributing new translations for other languages or enhance the existing translations, then please have a look at ["TracL10N"].
    1314
    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 ==
     15What 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 ==
    2319
    2420To install Trac, the following software packages must be installed:
    2521
    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)
    3023 * [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:trunk trunk], from svn, minimum required revision is [G1072].
    3225 * You also need a database system and the corresponding python drivers for it.
    33    The database can be either SQLite, PostgreSQL or ''MySQL (experimental)''.
     26   The database can be either SQLite, PostgreSQL or MySQL.
    3427
    3528=== For SQLite ===
    3629
    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).''
     30If you're using Python 2.5 or 2.6, you already have everything you need.
     31
     32If you're using Python 2.4 and need pysqlite, you can download from
     33[http://code.google.com/p/pysqlite/downloads/list google code] the Windows
     34installers or the tar.gz archive for building from source:
     35{{{
     36$ tar xvfz <version>.tar.gz
     37$ cd <version>
     38$ python setup.py build_static install
     39}}}
     40 
     41That way, the latest SQLite version will be downloaded and built into the
     42bindings.
     43
     44SQLite 2.x is no longer supported. For SQLite 3.x, the pysqlite 1.1.x
     45bindings are also no longer supported, use pysqlite 2.x.
     46
     47See additional information in [trac:PySqlite PySqlite].
    4348
    4449=== For PostgreSQL ===
    4550
     51You need to install the database and its Python bindings:
    4652 * [http://www.postgresql.org/ PostgreSQL]
    4753 * [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.
     54
     55See [trac:DatabaseBackend#Postgresql DatabaseBackend] for details
     56
    5157
    5258=== For MySQL ===
    5359
    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.1 or later
     60Trac can now work quite well with MySQL, provided you follow the guidelines.
     61
     62 * [http://mysql.com/ MySQL], version 5.0 or later
    5763 * [http://sf.net/projects/mysql-python MySQLdb], version 1.2.2 or later
    5864
     65See [trac:MySqlDb MySqlDb] for more detailed information.
     66It is ''very'' important to read carefully that page before creating the database.
     67
    5968=== Optional Requirements ===
    6069
    6170==== Version Control System ====
    6271
     72===== Subversion =====
    6373'''Please note:''' if using Subversion, Trac must be installed on the '''same machine'''. Remote repositories are currently not supported.
    6474
    6575 * [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).
     76   [[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
     77   * 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
    6778   * 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`.
    6879   * 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].
     80
     81===== Others =====
     82
     83Support for other version control systems is provided via third-parties. See [trac:PluginList PluginList] and [trac:VersioningSystemBackend VersioningSystemBackend].
    7084
    7185==== Web Server ====
    72  * A CGI-capable web server (see TracCgi), or
     86 * A CGI-capable web server (see TracCgi), '''but usage of Trac as a cgi script
     87   is highly discouraged''', better use one of the following options,
    7388 * 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.
     89 * an [http://tomcat.apache.org/connectors-doc/ajp/ajpv13a.html AJP]-capable web
     90   server (see [trac:TracOnWindowsIisAjp TracOnWindowsIisAjp]), or
     91 * [http://httpd.apache.org/ Apache] with
     92   - [http://code.google.com/p/modwsgi/ mod_wsgi], see [wiki:TracModWSGI] or
     93     http://code.google.com/p/modwsgi/wiki/IntegrationWithTrac
     94   - [http://modpython.org/ mod_python 3.3.1], see TracModPython)
     95   
     96
     97==== Other Python Packages ====
     98
     99 * [http://babel.edgewall.org Babel], version >= 0.9.4,
     100   needed for localization support
     101 * [http://docutils.sourceforge.net/ docutils], version >= 0.3.9
     102   for WikiRestructuredText.
     103 * [http://pygments.pocoo.org Pygments] for
     104   [wiki:TracSyntaxColoring syntax highlighting].
     105   [http://silvercity.sourceforge.net/ SilverCity] and/or
     106   [http://gnu.org/software/enscript/enscript.html Enscript] may still be used
     107   but are deprecated and you really should be using Pygments.
     108 * [http://pytz.sf.net pytz] to get a complete list of time zones,
     109   otherwise Trac will fall back on a shorter list from
     110   an internal time zone implementation.
    88111
    89112'''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].
    90113
    91114Please 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!).
     115
    92116
    93117== Installing Trac ==
    … …  
    120144(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)
    121145
     146
    122147=== Advanced Options ===
    123148
    … …  
    140165The 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.
    141166
     167
    142168== Creating a Project Environment ==
    143169
    … …  
    157183  chown -R apache.apache /path/to/myproject
    158184
    159 
    160185== Running the Standalone Server ==
    161186
    … …  
    170195}}}
    171196
    172 
    173197== Running Trac on a Web Server ==
    174198
    175199Trac 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.
    176200
    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.
     201
     202Trac also supports [trac:TracOnWindowsIisAjp AJP] which may be your choice if you want to connect to IIS.
     203
     204==== Generating the Trac cgi-bin directory ====
     205
     206In 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].
     207
     208There 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:
     209{{{
     210mkdir -p /usr/share/trac/projects/my-project
     211trac-admin /usr/share/trac/projects/my-project initenv
     212trac-admin /usr/share/trac/projects/my-project deploy /tmp/deploy
     213mv /tmp/deploy/* /usr/share/trac
     214}}}
     215
     216==== Setting up the Plugin Cache ====
     217
     218Some 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.
    178219
    179220== Configuring Authentication ==
    … …  
    185226 * TracModPython if you use the mod_python method.
    186227
    187 == Trac 0.11 & SVN on Mac OS X Leopard (10.5) ==
    188 
    189  * [trac:TracOnLeopardServer TracOnLeopardServer]
    190228
    191229== Using Trac ==
    … …  
    200238
    201239----
    202 See also: TracGuide, TracCgi, TracFastCgi, TracModPython, [wiki:TracModWSGI], TracUpgrade, TracPermissions
    203 
     240See also: [trac:TracInstallPlatforms TracInstallPlatforms], TracGuide, TracCgi, TracFastCgi, TracModPython, [wiki:TracModWSGI], TracUpgrade, TracPermissions
     241