Changes between Version 3 and Version 4 of TracInstall


Ignore:
Timestamp:
Oct 14, 2008, 3:14:20 PM (16 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracInstall

    v3 v4  
    1 = Trac Installation Guide =
     1= Trac Installation Guide for 0.11 =
    22[[TracGuideToc]]
    33
    4 Trac is a lightweight project management tool that is implemented as a web-based application. Trac is written in the Python programming language and needs a database (either [http://sqlite.org/ SQLite], [http://www.postgresql.org/ PostgreSQL], or [http://mysql.com/ MySQL] works). For HTML rendering, Trac uses the [http://www.clearsilver.net/ ClearSilver] templating system.
     4Trac 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.
    55
    6 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 [http://projects.edgewall.com/trac/wiki/TracInstallPlatforms 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.
     6What 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.
    77
    8 == Requirements ==
     8== Short - Install a released version ==
     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).
     10{{{
     11sudo easy_install Trac==0.11
     12}}}
     13
     14== Requirements - also older versions possible ==
    915
    1016To install Trac, the following software packages must be installed:
    1117
    12  * [http://www.python.org/ Python], version >= 2.3.
     18 * [http://www.python.org/ Python], version >= 2.3
     19   * 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).
    1320   * For RPM-based systems you might also need the `python-devel` and `python-xml` packages.
    14    * If you want to use Trac with Subversion on Windows, note that there are no precompiled Subversion bindings for Python 2.4, so you probably need Python 2.3.
    15     * 2006-09-20: This seems to be no longer true, see http://subversion.tigris.org/servlets/ProjectDocumentList?folderID=91. For subversion 1.4.0 python 2.4 binary bindings are available.
    16  * [http://www.clearsilver.net/ ClearSilver], version >= 0.9.3
    17    * With python-bindings (`./configure --with-python=/usr/bin/python`)
     21   * See instructions in ["TracOnWindows/Python2.5"]
     22 * [http://peak.telecommunity.com/DevCenter/setuptools setuptools], version >= 0.6
     23 * [http://genshi.edgewall.org/wiki/Download Genshi], version >= 0.4.1
    1824 * You also need a database system and the corresponding python drivers for it.
    19    The database can be either SQLite, PostgreSQL or MySQL ''(experimental)''.
     25   The database can be either SQLite, PostgreSQL or ''MySQL (experimental)''.
     26 * optional if some plugins require it: [http://www.clearsilver.net/ ClearSilver]
    2027
    2128=== For SQLite ===
    2229
    23  * [http://www.sqlite.org/ SQLite], version 2.8.x or 3.x (preferred)
    24  * [http://pysqlite.org/ PySQLite], version 1.x (for SQLite 2.x) or version 2.x (for SQLite 3.x). For details see [http://trac.edgewall.org/wiki/PySqlite PySqlite]
    25 
    26 ''Note: Versions of Trac prior to 0.9 do '''not''' work with PySQLite 2.x.''
     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
    2732
    2833''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.''
    … …  
    3540 * [http://initd.org/projects/psycopg2 psycopg2] or [http://pypgsql.sourceforge.net/ pyPgSQL]
    3641
    37 ''Note: PostgreSQL support requires Trac version 0.9 or later.''
     42'''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.
    3843
    3944=== For MySQL ===
    4045
    41 '''Warning''': MySQL support is currently experimental. That means it works for some people, but has not been tested extensively yet.
     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.
    4247
    4348 * [http://mysql.com/ MySQL], version 4.1 or later
    4449 * [http://sf.net/projects/mysql-python MySQLdb], version 1.2.1 or later
    4550
    46 ''Note: MySQL support requires Trac version 0.10 or later.''
    47 
    4851=== Optional Requirements ===
    4952
    5053==== Version Control System ====
    51  * [http://subversion.tigris.org/ Subversion], version >= 1.0. (either 1.2.3 or >= 1.3.1 recommended) and corresponding [http://svnbook.red-bean.com/svnbook-1.1/ch08s02.html#svn-ch-8-sect-2.3 Python bindings]. For troubleshooting, check [http://projects.edgewall.com/trac/wiki/TracSubversion TracSubversion]
    52    * Trac uses the [http://www.swig.org/ SWIG] bindings included in the Subversion distribution, '''not''' [http://pysvn.tigris.org/ PySVN] (which is sometimes confused with the standard SWIG bindings).
    53    * If Subversion was already installed without the SWIG bindings, you'll need to re-`configure` Subversion and `make swig-py`, `make install-swig-py`.
    54  * Support for other version control systems is provided via third-parties. See [http://projects.edgewall.com/trac/wiki/PluginList PluginList] and [http://projects.edgewall.com/trac/wiki/VersioningSystemBackend VersioningSystemBackend].
     54
     55'''Please note:''' if using Subversion, Trac must be installed on the '''same machine'''. Remote repositories are currently not supported.
     56
     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
     58   * 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).
     59   * 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`.
     60   * 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.
    5562
    5663==== Web Server ====
    5764 * A CGI-capable web server (see TracCgi), or
    5865 * 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])
     67    * 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.
    5968 * [http://httpd.apache.org/ Apache] with [http://www.modpython.org/ mod_python 3.1.3+] (see TracModPython)
    6069    * When installing mod_python the development versions of Python and Apache are required (actually the libraries and header files)
    6170
    62 For those stuck with Apache 1.3, it is also possible to get Trac 0.8.4 working with [http://www.modpython.org/ mod_python 2.7] (see [wiki:TracModPython2.7 TracModPython2.7]). This hasn't been tested with Trac 0.9, so it may or may not work.
     71For 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.
    6372
    6473==== Other Python Utilities ====
    65  * [http://peak.telecommunity.com/DevCenter/setuptools setuptools], version >= 0.6 for using plugins (see TracPlugins)
    6674 * [http://docutils.sourceforge.net/ docutils], version >= 0.3.9 for WikiRestructuredText.
    67  * [http://silvercity.sourceforge.net/ SilverCity] and/or [http://www.gnu.org/software/enscript/enscript.html Enscript] for [wiki:TracSyntaxColoring syntax highlighting].
     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.
    6876    * 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.
     77 * [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.
    6978
    70 '''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 [http://projects.edgewall.com/trac/wiki/MailingList MailingList] or [http://projects.edgewall.com/trac/wiki/IrcChannel IrcChannel].
     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.
    7180
    72 Please refer to the documentation of these packages to find out how they are best installed. In addition, most of the [http://projects.edgewall.com/trac/wiki/TracInstallPlatforms platform-specific instructions] also describe the installation of the dependencies. Keep in mind however that the information there might concern older versions of Trac than the one you're installing (in particular,
    73 there are still some pages that are about Trac 0.8).
     81Please 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!).
    7482
    7583== Installing Trac ==
    7684
    77 Like most Python programs, the Trac Python package is installed by running the following command at the top of the source directory:
     85One way to install Trac is using `setuptools`.
     86With setuptools you can install Trac from the subversion repository; for example,
     87to install release version 0.11b2 do:
     88{{{
     89easy_install http://svn.edgewall.org/repos/trac/tags/trac-0.11b2
     90}}}
     91
     92But of course the python-typical setup at the top of the source directory also works:
    7893{{{
    7994$ python ./setup.py install
    … …  
    8297''Note: you'll need root permissions or equivalent for this step.''
    8398
    84 This will byte-compile the python source code and install it in the `site-packages` directory
    85 of your Python installation. The directories `cgi-bin`, `templates`, `htdocs`, `wiki-default` and `wiki-macros` are all copied to `$prefix/share/trac/`. `conf` and `plugins` stub directories are also created under `$prefix/share/trac/` (''since [milestone:0.10]'').
     99This will byte-compile the python source code and install it as an .egg file or folder in the `site-packages` directory
     100of your Python installation. The .egg will also contain all other resources needed by standard Trac, such as htdocs and templates.
    86101
    87102The 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.
    … …  
    91106To install Trac to a custom location, or find out about other advanced installation options, run:
    92107{{{
    93 $ python ./setup.py install --help
     108easy_install --help
    94109}}}
    95110
    … …  
    98113Specifically, you might be interested in:
    99114{{{
    100 $ python ./setup.py install --prefix=/path/to/installdir
     115easy_install --prefix=/path/to/installdir
    101116}}}
     117or, if installing Trac to a Mac OS X system:
     118{{{
     119easy_install --prefix=/usr/local --install-dir=/Library/Python/2.5/site-packages
     120}}}
     121
     122The 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.
    102123
    103124== Creating a Project Environment ==
    … …  
    114135Also note that the values you specify here can be changed later by directly editing the [wiki:TracIni] configuration file.
    115136
    116 ''Note: The user account under which the web server runs will require write permissions to the environment
    117 directory and all the files inside.''
     137''Note: The user account under which the web server runs will require write permissions to the environment directory and all the files inside.  On Linux, with the web server running as user apache and group apache, enter:''
     138
     139  chown -R apache.apache /path/to/myproject
    118140
    119141
    … …  
    125147}}}
    126148
    127 Then, fire up a browser and visit `http://localhost:8000/`. You should get a simple listing of all environments that tracd knows about. Follow the link to the environment you just created, and you should see Trac in action.
     149Then, fire up a browser and visit `http://localhost:8000/`. You should get a simple listing of all environments that tracd knows about. Follow the link to the environment you just created, and you should see Trac in action. If you only plan on managing a single project with trac you can have the standalone server skip the environment list by starting it like this:
     150{{{
     151$ tracd -s --port 8000 /path/to/myproject
     152}}}
    128153
    129154
    130155== Running Trac on a Web Server ==
    131156
    132 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.
     157Trac 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.
     158
     159If 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.
    133160
    134161== Configuring Authentication ==
    … …  
    140167 * TracModPython if you use the mod_python method.
    141168
     169== Trac 0.11 & SVN on Mac OS X Leopard (10.5) ==
     170
     171 * TracOnLeopardServer
     172
    142173== Using Trac ==
    143174
    … …  
    148179'' Enjoy! ''
    149180
    150 [http://projects.edgewall.com/trac/wiki/TracTeam The Trac Team]
     181[wiki:TracTeam The Trac Team]
    151182
    152183----
    153 See also:  TracGuide, TracCgi, TracFastCgi, TracModPython, TracUpgrade, TracPermissions
     184See also:  TracGuide, TracCgi, TracFastCgi, TracModPython, [wiki:TracModWSGI], TracUpgrade, TracPermissions
     185