Changes between Version 2 and Version 3 of TracInstall


Ignore:
Timestamp:
Oct 31, 2010 9:00:39 PM (12 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracInstall

    v2 v3  
    1 {{{
    2 #!div style="margin-top: .5em; padding: 0 1em; background-color: #ffd; border:1px outset #ddc;"
    3 
    4   '''NOTE: this page is for 0.12dev (trunk), the version currently in development. For installing previous Trac versions, please refer to [[0.11/TracInstall]]'''
    5 }}}
    6 = Trac Installation Guide for 0.12dev =
     1= Trac Installation Guide for 0.12 =
    72[[TracGuideToc]]
    83
    94Trac 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.
    105
    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. Lacking Babel, you will only get the default english version, as usual.
    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"].
     6Since 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 **first** have installed the optional package [#OtherPythonPackages Babel]. Lacking Babel, you will only get the default english version, as usual. If you install Babel later on, you will need to re-install Trac.
     7
     8If you're interested in contributing new translations for other languages or enhance the existing translations, then please have a look at [trac:wiki:TracL10N TracL10N].
    149
    1510What 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.
     
    3429
    3530If you're using Python 2.4 and need pysqlite, you can download from
    36 [http://code.google.com/p/pysqlite/downloads/list google code] the Windows
    37 installers or the tar.gz archive for building from source:
     31[http://code.google.com/p/pysqlite/downloads/list google code] the Windows installers or the tar.gz archive for building from source:
    3832{{{
    3933$ tar xvfz <version>.tar.gz
     
    4438This will extract the SQLite code and build the bindings.
    4539
    46 SQLite 2.x is no longer supported. For SQLite 3.x, the pysqlite 1.1.x
    47 bindings are also no longer supported, use pysqlite 2.x.
    48 
    49 See additional information in [trac:PySqlite PySqlite].
     40To install SQLite, your system may require the development headers. Without these you will get various GCC related errors when attempting to build:
     41
     42{{{
     43$ apt-get install libsqlite3-dev
     44}}}
     45
     46SQLite 2.x is no longer supported, and neither is !PySqlite 1.1.x.
     47
     48A known bug !PySqlite versions 2.5.2-4 prohibits upgrade of trac databases
     49from 0.11.x to 0.12. Please use versions 2.5.5 and newer or 2.5.1 and
     50older. See [trac:#9434] for more detail.
     51
     52See additional information in [trac:PySqlite].
    5053
    5154==== For the PostgreSQL database #ForPostgreSQL
     
    6568 * [http://sf.net/projects/mysql-python MySQLdb], version 1.2.2 or later
    6669
    67 It is '''very''' important to read carefully the  [trac:MySqlDb MySqlDb] page before creating the database.
     70It is '''very''' important to read carefully the  [trac:MySqlDb] page before creating the database.
    6871
    6972=== Optional Dependencies
     
    7477 * [http://subversion.apache.org/ Subversion], 1.5.x or 1.6.x and the '''''corresponding''''' Python bindings. Older versions starting from 1.0, like 1.2.4, 1.3.2 or 1.4.2, etc. should still work. For troubleshooting information, check the [trac:TracSubversion#Troubleshooting TracSubversion] page.
    7578
    76 There are [http://subversion.apache.org/packages.html pre-compiled SWIG bindings] available for various platforms. Note that Trac '''doesn't''' use [http://pysvn.tigris.org/ PySVN], neither does it work yet with the newer `ctype`-style bindings
     79There are [http://subversion.apache.org/packages.html pre-compiled SWIG bindings] available for various platforms. (Good luck finding precompiled SWIG bindings for any Windows package at that listing. TracSubversion points you to [http://alagazam.net Algazam], which works for me under Python 2.6.)
     80
     81Note that Trac '''doesn't''' use [http://pysvn.tigris.org/ PySVN], neither does it work yet with the newer `ctype`-style bindings. [Is there a ticket for implementing ctype bindings?]
    7782
    7883
     
    8287===== Others =====
    8388
    84 Support for other version control systems is provided via third-parties. See [trac:PluginList PluginList] and [trac:VersioningSystemBackend VersioningSystemBackend].
     89Support for other version control systems is provided via third-parties. See [trac:PluginList] and [trac:VersioningSystemBackend].
    8590
    8691==== Web Server ====
     
    9196   - [http://code.google.com/p/modwsgi/ mod_wsgi], see [wiki:TracModWSGI] and
    9297     http://code.google.com/p/modwsgi/wiki/IntegrationWithTrac
    93    - [http://modpython.org/ mod_python 3.3.1], see TracModPython)
     98   - [http://modpython.org/ mod_python 3.3.1], deprecated: see TracModPython)
    9499 * a [http://www.fastcgi.com/ FastCGI]-capable web server (see TracFastCgi)
    95100 * an [http://tomcat.apache.org/connectors-doc/ajp/ajpv13a.html AJP]-capable web
    96    server (see [trac:TracOnWindowsIisAjp TracOnWindowsIisAjp])
    97  * A CGI-capable web server (see TracCgi), '''but usage of Trac as a cgi script
    98    is highly discouraged''', better use one of the following options,
     101   server (see [trac:TracOnWindowsIisAjp])
     102 * a CGI-capable web server (see TracCgi), '''but usage of Trac as a cgi script
     103   is highly discouraged''', better use one of the previous options.
    99104   
    100105
     
    102107
    103108 * [http://babel.edgewall.org Babel], version >= 0.9.5,
    104    needed for localization support
     109   needed for localization support[[BR]]
     110   ''Note: '' If you want to be able to use the Trac interface in other languages, then make sure you first have installed the optional package Babel. Lacking Babel, you will only get the default english version, as usual. If you install Babel later on, you will need to re-install Trac.
    105111 * [http://docutils.sourceforge.net/ docutils], version >= 0.3.9
    106112   for WikiRestructuredText.
     
    114120   an internal time zone implementation.
    115121
    116 '''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].
     122'''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] or [trac:IrcChannel].
    117123
    118124Please 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!).
     
    121127== Installing Trac ==
    122128=== Using `easy_install`
    123 One way to install Trac is using `setuptools`.
     129One way to install Trac is using [http://pypi.python.org/pypi/setuptools setuptools].
    124130With setuptools you can install Trac from the subversion repository;
    125131
    126132A few examples:
    127133
    128  - install Trac 0.12 beta1::
     134 - install Trac 0.12:
    129135   {{{
    130    easy_install Trac==0.12b1
     136   easy_install Trac==0.12
    131137   }}}
    132138
    133  - install latest development version 0.12dev
     139 - install latest development version 0.12dev:
    134140   {{{
    135141   easy_install Trac==dev
     
    138144   either use a released version or install from source
    139145
     146=== Using `pip`
     147'pip' is an easy_install replacement that is very useful to quickly install python packages.
     148To get a trac installation up and running in less than 5 minutes:
     149
     150Assuming you want to have your entire pip installation in /opt/user/trac
     151
     152 -
     153{{{
     154pip -E /opt/user/trac install trac psycopg2
     155}}}
     156or
     157 -
     158{{{
     159pip -E /opt/user/trac install trac mysql-python
     160}}}
     161
     162Make sure your OS specific headers are available for pip to automatically build PostgreSQL (libpq-dev) or MySQL (libmysqlclient-dev) bindings.
     163
     164pip will automatically resolve all dependencies (like Genshi, pygments, etc.) and download the latest packages on pypi.python.org and create a self contained installation in /opt/user/trac
     165
     166All commands (tracd, trac-admin) are available in /opt/user/trac/bin . This can also be leveraged for mod_python (using PythonHandler directive) and mod_wsgi (using WSGIDaemonProcess directive)
     167
     168Additionally, you can install several trac plugins (listed [http://pypi.python.org/pypi?:action=search&term=trac&submit=search here]) through pip.
     169
     170
     171
    140172=== From source
    141173Of course, using the python-typical setup at the top of the source directory also works.
    142174
    143 You can obtain the source for a .tar.gz or .zip file corresponding to a release (e.g. Trac-0.12b1.tar.gz), or you can get the source directly from the repository (see Trac:SubversionRepository for details).
     175You can obtain the source for a .tar.gz or .zip file corresponding to a release (e.g. Trac-0.12.tar.gz), or you can get the source directly from the repository (see [trac:SubversionRepository] for details).
    144176
    145177{{{
     
    154186The 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.
    155187
    156 If you install from source and want to make Trac available in other languages, make sure you have installed Babel and then run this additional step before doing the `install` (or simply redo the `install` afterwards):
    157 {{{
    158 $ python ./setup.py compile_catalog -f
    159 }}}
    160 (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)
    161 
     188If you install from source and want to make Trac available in other languages, make sure  Babel is installed. Only then, perform the `install` (or simply redo the `install` once again afterwards if you realize Babel was not yet installed):
     189{{{
     190$ python ./setup.py install
     191}}}
     192Alternatively, you can do a `bdist_egg` and copy the .egg from dist/ to the place of your choice, or you can create a Windows installer (`bdist_wininst`).
    162193
    163194=== Advanced Options ===