Changes between Version 1 and Version 2 of TracInstall


Ignore:
Timestamp:
07/14/09 04:41:49 (5 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracInstall

    v1 v2  
    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. 
    5  
    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. 
     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. 
     5 
     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. 
     7 
     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). (You also might want to install python-dev to build genshi) 
     10{{{ 
     11sudo easy_install Trac 
     12}}} 
    713 
    814== Requirements == 
     15The hardware requirements for running Trac obviously depend on the expected data volume (number of wiki pages, tickets, revisions) and traffic. Very small projects will run fine with a 500MHz processor and 128MB RAM using SQLite. In general, the more RAM, the better. A fast hard disk also helps. 
    916 
    1017To install Trac, the following software packages must be installed: 
    1118 
    12  * [http://www.python.org/ Python], version >= 2.3. 
     19 * [http://www.python.org/ Python], version >= 2.3 
     20   * 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). 
    1321   * 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`) 
     22   * See instructions in ["TracOnWindows/Python2.5"] 
     23 * [http://peak.telecommunity.com/DevCenter/setuptools setuptools], version >= 0.6 
     24 * [http://genshi.edgewall.org/wiki/Download Genshi], version >= 0.5 (was version >= 0.4.1 on previous 0.11 release candidates) 
    1825 * You also need a database system and the corresponding python drivers for it. 
    19    The database can be either SQLite, PostgreSQL or MySQL ''(experimental)''. 
    20  
    21 === For SQLite === 
    22  
    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.'' 
     26   The database can be either SQLite, PostgreSQL or ''MySQL (experimental)''. 
     27 * Optional if some plugins require it: [http://www.clearsilver.net/ ClearSilver] 
     28 
     29==== For SQLite ==== 
     30 
     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 [trac:PySqlite PySqlite] 
    2733 
    2834''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.'' 
     
    3036''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).'' 
    3137 
    32 === For PostgreSQL === 
     38==== For PostgreSQL ==== 
    3339 
    3440 * [http://www.postgresql.org/ PostgreSQL] 
    35  * [http://initd.org/projects/psycopg2 psycopg2] or [http://pypgsql.sourceforge.net/ pyPgSQL] 
    36  
    37 ''Note: PostgreSQL support requires Trac version 0.9 or later.'' 
    38  
    39 === For MySQL === 
    40  
    41 '''Warning''': MySQL support is currently experimental. That means it works for some people, but has not been tested extensively yet. 
     41 * [http://initd.org/projects/psycopg2 psycopg2] 
     42 * See [trac:wiki:DatabaseBackend#Postgresql DatabaseBackend] 
     43 
     44'''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. 
     45 
     46==== For MySQL ==== 
     47 
     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 [trac:MySqlDb MySqlDb] for more detailed information. 
    4249 
    4350 * [http://mysql.com/ MySQL], version 4.1 or later 
    4451 * [http://sf.net/projects/mysql-python MySQLdb], version 1.2.1 or later 
    4552 
    46 ''Note: MySQL support requires Trac version 0.10 or later.'' 
    47  
    48 === Optional Requirements === 
     53== Optional Requirements == 
    4954 
    5055==== 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]. 
     56 
     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 [trac:TracSubversion TracSubversion] 
     60   * 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   * 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   * 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 [trac:PluginList PluginList] and [trac:VersioningSystemBackend VersioningSystemBackend]. 
    5564 
    5665==== Web Server ==== 
    5766 * A CGI-capable web server (see TracCgi), or 
    5867 * 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 TracOnWindowsIisAjp]), or 
     69 * [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) 
     70    * 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. 
    5971 * [http://httpd.apache.org/ Apache] with [http://www.modpython.org/ mod_python 3.1.3+] (see TracModPython) 
    6072    * When installing mod_python the development versions of Python and Apache are required (actually the libraries and header files) 
    6173 
    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. 
     74For 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. 
    6375 
    6476==== Other Python Utilities ==== 
    65  * [http://peak.telecommunity.com/DevCenter/setuptools setuptools], version >= 0.6 for using plugins (see TracPlugins) 
    6677 * [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]. 
    68     * 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. 
    69  
    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]. 
    71  
    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). 
     78 * [http://pygments.pocoo.org Pygments] for '''syntax highlighting''', although [http://silvercity.sourceforge.net/ SilverCity] >= 0.9.7 and/or [http://gnu.org/software/enscript/enscript.html GNU Enscript] are also possible. Refer to TracSyntaxColoring for details. 
     79 * [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 
     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 [trac:MailingList MailingList] or [trac:IrcChannel IrcChannel]. 
     82 
     83Please 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!). 
    7484 
    7585== Installing Trac == 
    7686 
    77 Like most Python programs, the Trac Python package is installed by running the following command at the top of the source directory: 
     87One way to install Trac is using `setuptools`. 
     88With setuptools you can install Trac from the subversion repository; for example, 
     89to install release version 0.11 do: 
     90{{{ 
     91easy_install http://svn.edgewall.org/repos/trac/tags/trac-0.11 
     92}}} 
     93 
     94But of course the python-typical setup at the top of the source directory also works: 
    7895{{{ 
    7996$ python ./setup.py install 
     
    8299''Note: you'll need root permissions or equivalent for this step.'' 
    83100 
    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]''). 
     101This will byte-compile the python source code and install it as an .egg file or folder in the `site-packages` directory 
     102of your Python installation. The .egg will also contain all other resources needed by standard Trac, such as htdocs and templates. 
    86103 
    87104The 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. 
    88105 
    89 === Advanced Options === 
     106==== Advanced Options ==== 
    90107 
    91108To install Trac to a custom location, or find out about other advanced installation options, run: 
    92109{{{ 
    93 $ python ./setup.py install --help 
     110easy_install --help 
    94111}}} 
    95112 
     
    98115Specifically, you might be interested in: 
    99116{{{ 
    100 $ python ./setup.py install --prefix=/path/to/installdir 
    101 }}} 
     117easy_install --prefix=/path/to/installdir 
     118}}} 
     119or, if installing Trac to a Mac OS X system: 
     120{{{ 
     121easy_install --prefix=/usr/local --install-dir=/Library/Python/2.5/site-packages 
     122}}} 
     123 
     124The 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. 
    102125 
    103126== Creating a Project Environment == 
     
    114137Also note that the values you specify here can be changed later by directly editing the [wiki:TracIni] configuration file. 
    115138 
    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.'' 
    118  
     139''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:'' 
     140 
     141  chown -R apache.apache /path/to/myproject 
     142 
     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''' 
    119144 
    120145== Running the Standalone Server == 
     
    125150}}} 
    126151 
    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. 
     152Then, 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: 
     153{{{ 
     154$ tracd -s --port 8000 /path/to/myproject 
     155}}} 
    128156 
    129157 
    130158== Running Trac on a Web Server == 
    131159 
    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. 
     160Trac 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. 
     161 
     162If you're not afraid of running newer code, you can also try running Trac on [wiki:TracModWSGI mod_wsgi]. This should deliver even better performance than mod_python, but the module isn't as extensively tested as mod_python. 
     163 
     164Trac also supports [trac:TracOnWindowsIisAjp AJP] which may be your choice if you want to connect to IIS. 
     165 
     166==== Setting up the Plugin Cache ==== 
     167 
     168Some 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. 
    133169 
    134170== Configuring Authentication == 
     
    140176 * TracModPython if you use the mod_python method. 
    141177 
     178== Automatic reference to the SVN changesets in Trac tickets == 
     179 
     180You 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: 
     181 * '''Refs #123''' - to reference this changeset in #123 ticket 
     182 * '''Fixes #123''' - to reference this changeset and close #123 ticket with the default status ''fixed'' 
     183 
     184All 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. 
     185 
     186If 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: 
     187 
     188{{{ 
     189$ cd /path/to/svn/repository/hooks 
     190$ mv post-commit.tmpl post-commit 
     191$ chmod 755 post-commit 
     192}}} 
     193 
     194Next 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: 
     195 
     196{{{ 
     197REPOS="$1" 
     198REV="$2" 
     199TRAC_ENV="/path/to/your/trac/project" 
     200 
     201/usr/bin/python /usr/local/bin/trac-post-commit-hook -p "$TRAC_ENV" -r "$REV" 
     202}}} 
     203 
     204Make 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]. 
     205 
     206 
     207== Platform-specifics installations == 
     208 
     209 * See [trac:TracInstallPlatforms TracInstallPlatforms] 
     210  
     211 
    142212== Using Trac == 
    143213 
     
    148218'' Enjoy! '' 
    149219 
    150 [http://projects.edgewall.com/trac/wiki/TracTeam The Trac Team] 
     220[trac:TracTeam The Trac Team] 
    151221 
    152222---- 
    153 See also:  TracGuide, TracCgi, TracFastCgi, TracModPython, TracUpgrade, TracPermissions 
     223See also:  TracInstallPlatforms, TracGuide, TracCgi, TracFastCgi, TracModPython, [wiki:TracModWSGI], TracUpgrade, TracPermissions