Changes between Version 2 and Version 3 of TracInstall


Ignore:
Timestamp:
Jun 8, 2011, 7:42:06 PM (13 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracInstall

    v2 v3  
    22[[TracGuideToc]]
    33
    4 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.
     4
     5Trac is written in the Python programming language and needs a database, [http://sqlite.org/ SQLite], [http://postgresql.org/ PostgreSQL], [http://mysql.com/ MySQL]. For HTML rendering, Trac uses the [http://genshi.edgewall.org Genshi] templating system.
    56
    67What 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.
    78
    8 == Short - Install a released version ==
    9 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). (You also might want to install python-dev to build genshi)
     9See TracUpgrade for instructions on how to upgrade an existing installation.
     10
     11
     12== Quick Install a Released Version ==
     13For a quick install, first make sure you have [http://python.org/download Python] (2.3-2.6) and [http://peak.telecommunity.com/DevCenter/EasyInstall#installing-easy-install easy_install].
     14
     15Then enter (''omit 'sudo' if not applicable'')
    1016{{{
    1117sudo easy_install Trac
    1218}}}
     19to install Trac, SQLite, and Genshi.
     20
    1321
    1422== Requirements ==
    … …  
    1725To install Trac, the following software packages must be installed:
    1826
    19  * [http://www.python.org/ Python], version >= 2.3
     27 * [http://www.python.org/ Python], version >=2.3 (<3.0)
    2028   * 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).
    2129   * For RPM-based systems you might also need the `python-devel` and `python-xml` packages.
    22    * See instructions in ["TracOnWindows/Python2.5"]
    23  * [http://peak.telecommunity.com/DevCenter/setuptools setuptools], version >= 0.6
     30   * See instructions in [trac:wiki:TracOnWindows/Python2.5 TracOnWindows/Python2.5]
     31 * [trac:wiki:setuptools setuptools], version >= 0.6
    2432 * [http://genshi.edgewall.org/wiki/Download Genshi], version >= 0.5 (was version >= 0.4.1 on previous 0.11 release candidates)
    2533 * You also need a database system and the corresponding python drivers for it.
    26    The database can be either SQLite, PostgreSQL or ''MySQL (experimental)''.
    27  * Optional if some plugins require it: [http://www.clearsilver.net/ ClearSilver]
     34   The database can be either SQLite, PostgreSQL or MySQL.
     35 * Optional if some plugins require it: [http://www.clearsilver.net/ ClearSilver] (for information on installing ClearSilver refer to the [wiki:0.10/TracInstall#Requirements 0.10/TracInstall] page and the Trac:ClearSilver page).
    2836
    2937==== For SQLite ====
    3038
    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]
    33 
    34 ''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.''
    35 
    36 ''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).''
     39If you're using Python 2.5 or 2.6, you already have everything you need.
     40
     41If you're using Python 2.3 or 2.4 and need pysqlite, you can download from
     42[http://code.google.com/p/pysqlite/downloads/list google code] the Windows
     43installers or the tar.gz archive for building from source:
     44{{{
     45$ tar xvfz <version>.tar.gz
     46$ cd <version>
     47$ python setup.py build_static install
     48}}}
     49 
     50That way, the latest SQLite version will be downloaded and built into the
     51bindings.
     52
     53If you're still using SQLite 2.x, you'll need pysqlite 1.0.x, although this
     54package is not easy to find anymore. For SQLite 3.x, try not to use
     55pysqlite 1.1.x, which has been deprecated in favor of pysqlite 2.x.
     56
     57See additional information in [trac:PySqlite PySqlite].
    3758
    3859==== For PostgreSQL ====
    … …  
    4667==== For MySQL ====
    4768
    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.
    49 
    50  * [http://mysql.com/ MySQL], version 4.1 or later
     69 * [http://mysql.com/ MySQL], version 4.1 or later ([http://askmonty.org/wiki/index.php/MariaDB MariaDB] might work as well)
    5170 * [http://sf.net/projects/mysql-python MySQLdb], version 1.2.1 or later
    5271
     72See [trac:MySqlDb MySqlDb] for more detailed information.
     73It is ''very'' important to read carefully that page before creating the database.
     74
    5375== Optional Requirements ==
    5476
    5577==== Version Control System ====
    5678
    57 '''Please note:''' if using Subversion, Trac must be installed on the '''same machine'''. Remote repositories are currently not supported.
     79'''Please note:''' if using Subversion, Trac must be installed on the '''same machine'''. Remote repositories are currently not supported (although Windows UNC paths such as {{{\\machine_name\path\to\svn}}} do work).
    5880
    5981 * [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]
    … …  
    6486
    6587==== Web Server ====
     88One of the following web servers:
    6689 * A CGI-capable web server (see TracCgi), or
    6790 * a [http://www.fastcgi.com/ FastCGI]-capable web server (see TracFastCgi), or
    6891 * 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)
     92 * [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) or
    7093    * 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.
     94    * You shouldn't use aliases for svn repos. For example, project located at /usr/local/www/trac, http://host/trac. And you want url http://host/trac/svn to point to the repo. You should define symlink ''ln -s /path/to/your/repo /usr/loca/www/trac/svn'', because with ''httpd.conf:Alias /trac/svn /path/to/your/repo'' repo will be unaccessible via http.
    7195 * [http://httpd.apache.org/ Apache] with [http://www.modpython.org/ mod_python 3.1.3+] (see TracModPython)
    7296    * When installing mod_python the development versions of Python and Apache are required (actually the libraries and header files)
    7397
    74 For 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.
     98For those stuck with Apache 1.3, it is also possible to get Trac working with [http://www.modpython.org/ mod_python 2.7] (see [trac:wiki:TracModPython2.7 TracModPython2.7]). This guide hasn't been updated since 0.84, so it may or may not work.
    7599
    76100==== Other Python Utilities ====
    … …  
    141165  chown -R apache.apache /path/to/myproject
    142166
    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'''
    144 
    145167== Running the Standalone Server ==
    146168
    … …  
    155177}}}
    156178
    157 
    158179== Running Trac on a Web Server ==
    159180
    … …  
    163184
    164185Trac also supports [trac:TracOnWindowsIisAjp AJP] which may be your choice if you want to connect to IIS.
     186
     187==== Generating the Trac cgi-bin directory ====
     188
     189In 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].
     190
     191There 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:
     192{{{
     193mkdir -p /usr/share/trac/projects/my-project
     194trac-admin /usr/share/trac/projects/my-project initenv
     195trac-admin /usr/share/trac/projects/my-project deploy /tmp/deploy
     196mv /tmp/deploy/* /usr/share/trac
     197}}}
    165198
    166199==== Setting up the Plugin Cache ====
    … …  
    202235}}}
    203236
    204 Make 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].
     237Make 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 [trac:source:branches/0.11-stable/contrib/trac-post-commit-hook branches/0.11-stable/contrib/trac-post-commit-hook].
    205238
    206239
    … …  
    221254
    222255----
    223 See also:  TracInstallPlatforms, TracGuide, TracCgi, TracFastCgi, TracModPython, [wiki:TracModWSGI], TracUpgrade, TracPermissions
     256See also: [trac:TracInstallPlatforms TracInstallPlatforms], TracGuide, TracCgi, TracFastCgi, TracModPython, [wiki:TracModWSGI], TracUpgrade, TracPermissions
     257