Changes between Version 1 and Version 2 of TracInstall


Ignore:
Timestamp:
05/09/10 05:59:49 (12 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracInstall

    v1 v2  
    1 = Trac Installation Guide =
     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 =
    27[[TracGuideToc]]
    38
    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.
    7 
    8 == Requirements ==
    9 
     9Trac 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.
     10
     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. Lacking Babel, you will only get the default english version, as usual.
     12
     13If you're interested in contributing new translations for other languages or enhance the existing translations, then please have a look at ["TracL10N"].
     14
     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[[PageOutline(2-3,Installation Steps,inline)]]
     18
     19== Dependencies ==
     20=== Mandatory Dependencies
    1021To install Trac, the following software packages must be installed:
    1122
    12  * [http://www.python.org/ Python], version >= 2.3.
    13    * 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`)
    18  * 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.''
    27 
    28 ''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.''
    29 
    30 ''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).''
    31 
    32 === For PostgreSQL ===
    33 
     23 * [http://www.python.org/ Python], version >= 2.4 and < 3.0
     24   (note that we dropped the support for Python 2.3 in this release)
     25 * [http://peak.telecommunity.com/DevCenter/setuptools setuptools], version >= 0.6
     26 * [http://genshi.edgewall.org/wiki/Download Genshi], version >= 0.6
     27
     28You also need a database system and the corresponding python bindings.
     29The database can be either SQLite, PostgreSQL or MySQL.
     30
     31==== For the SQLite database #ForSQLite
     32
     33If you're using Python 2.5 or 2.6, you already have everything you need.
     34
     35If 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
     37installers or the tar.gz archive for building from source:
     38{{{
     39$ tar xvfz <version>.tar.gz
     40$ cd <version>
     41$ python setup.py build_static install
     42}}}
     43 
     44This will extract the SQLite code and build the bindings.
     45
     46SQLite 2.x is no longer supported. For SQLite 3.x, the pysqlite 1.1.x
     47bindings are also no longer supported, use pysqlite 2.x.
     48
     49See additional information in [trac:PySqlite PySqlite].
     50
     51==== For the PostgreSQL database #ForPostgreSQL
     52
     53You need to install the database and its Python bindings:
    3454 * [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.
    42 
    43  * [http://mysql.com/ MySQL], version 4.1 or later
    44  * [http://sf.net/projects/mysql-python MySQLdb], version 1.2.1 or later
    45 
    46 ''Note: MySQL support requires Trac version 0.10 or later.''
    47 
    48 === Optional Requirements ===
     55 * [http://pypi.python.org/pypi/psycopg2 psycopg2]
     56
     57See [trac:DatabaseBackend#Postgresql DatabaseBackend] for details.
     58
     59
     60==== For the MySQL database #ForMySQL
     61
     62Trac can now work quite well with MySQL, provided you follow the guidelines.
     63
     64 * [http://mysql.com/ MySQL], version 5.0 or later
     65 * [http://sf.net/projects/mysql-python MySQLdb], version 1.2.2 or later
     66
     67It is '''very''' important to read carefully the  [trac:MySqlDb MySqlDb] page before creating the database.
     68
     69=== Optional Dependencies
    4970
    5071==== 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].
     72
     73===== Subversion =====
     74 * [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.
     75
     76There 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
     77
     78
     79'''Please note:''' if using Subversion, Trac must be installed on the '''same machine'''. Remote repositories are currently [trac:ticket:493 not supported].
     80
     81
     82===== Others =====
     83
     84Support for other version control systems is provided via third-parties. See [trac:PluginList PluginList] and [trac:VersioningSystemBackend VersioningSystemBackend].
    5585
    5686==== Web Server ====
    57  * A CGI-capable web server (see TracCgi), or
    58  * a [http://www.fastcgi.com/ FastCGI]-capable web server (see TracFastCgi), or
    59  * [http://httpd.apache.org/ Apache] with [http://www.modpython.org/ mod_python 3.1.3+] (see TracModPython)
    60     * When installing mod_python the development versions of Python and Apache are required (actually the libraries and header files)
    61 
    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.
    63 
    64 ==== Other Python Utilities ====
    65  * [http://peak.telecommunity.com/DevCenter/setuptools setuptools], version >= 0.6 for using plugins (see TracPlugins)
    66  * [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).
     87A web server is optional because Trac is shipped with a server included, see the [#RunningtheStandaloneServer Running the Standalone Server ] section below.
     88
     89Alternatively you configure Trac to run in any of the following environments.
     90 * [http://httpd.apache.org/ Apache] with
     91   - [http://code.google.com/p/modwsgi/ mod_wsgi], see [wiki:TracModWSGI] and
     92     http://code.google.com/p/modwsgi/wiki/IntegrationWithTrac
     93   - [http://modpython.org/ mod_python 3.3.1], see TracModPython)
     94 * a [http://www.fastcgi.com/ FastCGI]-capable web server (see TracFastCgi)
     95 * 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,
     99   
     100
     101==== Other Python Packages ====
     102
     103 * [http://babel.edgewall.org Babel], version >= 0.9.5,
     104   needed for localization support
     105 * [http://docutils.sourceforge.net/ docutils], version >= 0.3.9
     106   for WikiRestructuredText.
     107 * [http://pygments.pocoo.org Pygments] for
     108   [wiki:TracSyntaxColoring syntax highlighting].
     109   [http://silvercity.sourceforge.net/ SilverCity] and/or
     110   [http://gnu.org/software/enscript/enscript.html Enscript] may still be used
     111   but are deprecated and you really should be using Pygments.
     112 * [http://pytz.sf.net pytz] to get a complete list of time zones,
     113   otherwise Trac will fall back on a shorter list from
     114   an internal time zone implementation.
     115
     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].
     117
     118Please 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!).
     119
    74120
    75121== Installing Trac ==
    76 
    77 Like most Python programs, the Trac Python package is installed by running the following command at the top of the source directory:
     122=== Using `easy_install`
     123One way to install Trac is using `setuptools`.
     124With setuptools you can install Trac from the subversion repository;
     125
     126A few examples:
     127
     128 - install Trac 0.12 beta1::
     129   {{{
     130   easy_install Trac==0.12b1
     131   }}}
     132
     133 - install latest development version 0.12dev
     134   {{{
     135   easy_install Trac==dev
     136   }}}
     137   Note that in this case you won't have the possibility to run a localized version of Trac;
     138   either use a released version or install from source
     139
     140=== From source
     141Of course, using the python-typical setup at the top of the source directory also works.
     142
     143You 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).
     144
    78145{{{
    79146$ python ./setup.py install
    80147}}}
    81148
    82 ''Note: you'll need root permissions or equivalent for this step.''
    83 
    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]'').
     149''You'll need root permissions or equivalent for this step.''
     150
     151This will byte-compile the python source code and install it as an .egg file or folder in the `site-packages` directory
     152of your Python installation. The .egg will also contain all other resources needed by standard Trac, such as htdocs and templates.
    86153
    87154The 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.
    88155
     156If 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
     162
    89163=== Advanced Options ===
    90164
    91165To install Trac to a custom location, or find out about other advanced installation options, run:
    92166{{{
    93 $ python ./setup.py install --help
     167easy_install --help
    94168}}}
    95169
     
    98172Specifically, you might be interested in:
    99173{{{
    100 $ python ./setup.py install --prefix=/path/to/installdir
    101 }}}
     174easy_install --prefix=/path/to/installdir
     175}}}
     176or, if installing Trac to a Mac OS X system:
     177{{{
     178easy_install --prefix=/usr/local --install-dir=/Library/Python/2.5/site-packages
     179}}}
     180Note: If installing on Mac OS X 10.6 running {{{ easy_install http://svn.edgewall.org/repos/trac/trunk }}} will install into {{{ /usr/local }}} and {{{ /Library/Python/2.6/site-packages }}} by default
     181
     182The 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.
     183
    102184
    103185== Creating a Project Environment ==
    104186
    105 A [wiki:TracEnvironment Trac environment] is the backend storage where Trac stores information like wiki pages, tickets, reports, settings, etc. An environment is basically a directory that contains a human-readable configuration file and various other files and directories.
     187A [TracEnvironment Trac environment] is the backend storage where Trac stores information like wiki pages, tickets, reports, settings, etc. An environment is basically a directory that contains a human-readable [TracIni configuration file], and various other files and directories.
    106188
    107189A new environment is created using [wiki:TracAdmin trac-admin]:
     
    110192}}}
    111193
    112 [wiki:TracAdmin trac-admin] will prompt you for the information it needs to create the environment, such as the name of the project, the type and the path to an existing [wiki:TracEnvironment#SourceCodeRepository source code repository], the [wiki:TracEnvironment#DatabaseConnectionStrings database connection string], and so on. If you're not sure what to specify for one of these options, just leave it blank to use the default value. The database connection string in particular will always work as long as you have SQLite installed. Leaving the path to the source code repository empty will disable any functionality related to version control, but you can always add that back when the basic system is running.
    113 
    114 Also note that the values you specify here can be changed later by directly editing the [wiki:TracIni] configuration file.
    115 
    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 
     194[TracAdmin trac-admin] will prompt you for the information it needs to create the environment, such as the name of the project and the [TracEnvironment#DatabaseConnectionStrings database connection string]. If you're not sure what to specify for one of these options, just press `<Enter>` to use the default value.
     195
     196Using the default database connection string in particular will always work as long as you have SQLite installed.
     197For the other [DatabaseBackend database backends] you should plan ahead and already have a database ready to use at this point.
     198
     199Since 0.12, Trac doesn't ask for a [TracEnvironment#SourceCodeRepository source code repository] anymore when creating an environment. Repositories can be [TracRepositoryAdmin added] afterward, or the version control support can be disabled completely if you don't need it.
     200
     201Also note that the values you specify here can be changed later by directly editing the [TracIni conf/trac.ini] configuration file.
     202
     203Finally, make sure the user account under which the web front-end runs will have '''write permissions''' to the environment directory and all the files inside. This will be the case if you run `trac-admin ... initenv` as this user. If not, you should set the correct user afterwards. For example on Linux, with the web server running as user `apache` and group `apache`, enter:
     204{{{
     205# chown -R apache.apache /path/to/myproject
     206}}}
    119207
    120208== Running the Standalone Server ==
     
    125213}}}
    126214
    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.
    128 
     215Then, 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:
     216{{{
     217$ tracd -s --port 8000 /path/to/myproject
     218}}}
    129219
    130220== Running Trac on a Web Server ==
    131221
    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.
     222Trac provides various options for connecting to a "real" web server: [wiki:TracCgi CGI], [wiki:TracFastCgi FastCGI], [wiki:TracModWSGI mod_wsgi] and [wiki:TracModPython mod_python]. For decent performance, it is recommended that you use either FastCGI or mod_wsgi.
     223
     224Trac also supports [trac:TracOnWindowsIisAjp AJP] which may be your choice if you want to connect to IIS.
     225
     226==== Generating the Trac cgi-bin directory ====
     227
     228In order for Trac to function properly with FastCGI you need to have a `trac.fcgi` file and for mod_wsgi a `trac.wsgi` file. These are Python scripts which load the appropriate Python code. They can be generated using the `deploy` option of [wiki:TracAdmin trac-admin].
     229
     230There 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:
     231{{{
     232mkdir -p /usr/share/trac/projects/my-project
     233trac-admin /usr/share/trac/projects/my-project initenv
     234trac-admin /usr/share/trac/projects/my-project deploy /tmp/deploy
     235mv /tmp/deploy/* /usr/share/trac
     236}}}
     237
     238==== Setting up the Plugin Cache ====
     239
     240Some 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 on how to set environment variables.
    133241
    134242== Configuring Authentication ==
     
    137245
    138246 * TracStandalone if you use the standalone server, `tracd`.
    139  * TracCgi if you use the CGI or FastCGI methods.
    140  * TracModPython if you use the mod_python method.
     247 * TracCgi if you use the CGI or FastCGI web front ends.
     248 * [wiki:TracModWSGI] if you use the Apache mod_wsgi web front end.
     249 * TracModPython if you use the Apache mod_python web front end.
     250
     251
     252== Automatic reference to the SVN changesets in Trac tickets ==
     253
     254You can configure SVN to automatically add a reference to the changeset into the ticket comments, whenever changes are committed to the repository. The description of the commit needs to contain one of the following formulas:
     255 * '''`Refs #123`''' - to reference this changeset in `#123` ticket
     256 * '''`Fixes #123`''' - to reference this changeset and close `#123` ticket with the default status ''fixed''
     257
     258This functionality requires a post-commit hook to be installed as described in [wiki:TracRepositoryAdmin#ExplicitSync TracRepositoryAdmin], and enabling the optional commit updater components by adding the following line to the `[components]` section of your [wiki:TracIni#components-section trac.ini], or enabling the components in the "Plugins" admin panel.
     259{{{
     260tracopt.ticket.commit_updater.* = enabled
     261}}}
     262For more information, see the documentation of the `CommitTicketUpdater` component in the "Plugins" admin panel.
    141263
    142264== Using Trac ==
    143265
    144 Once you have your Trac site up and running, you should be able to browse your subversion repository, create tickets, view the timeline, etc.
     266Once you have your Trac site up and running, you should be able to create tickets, view the timeline, browse your version control repository if configured, etc.
    145267
    146268Keep in mind that anonymous (not logged in) users can by default access most but not all of the features. You will need to configure authentication and grant additional [wiki:TracPermissions permissions] to authenticated users to see the full set of features.
     
    148270'' Enjoy! ''
    149271
    150 [http://projects.edgewall.com/trac/wiki/TracTeam The Trac Team]
     272[trac:TracTeam The Trac Team]
    151273
    152274----
    153 See also:  TracGuide, TracCgi, TracFastCgi, TracModPython, TracUpgrade, TracPermissions
     275See also: [trac:TracInstallPlatforms TracInstallPlatforms], TracGuide, TracCgi, TracFastCgi, TracModPython, [wiki:TracModWSGI], TracUpgrade, TracPermissions