Changes between Version 1 and Version 2 of TracInstall

Ignore:
Timestamp:
Jun 14, 2010, 11:11:20 PM (7 years ago)
Comment:

Legend:

Unmodified
 v1 = Trac Installation Guide for 0.11 = = Trac Installation Guide for 0.12 = [[TracGuideToc]] Trac 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. 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 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. See TracUpgrade for instructions on how to upgrade an existing installation. == Quick Install a Released Version == For 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]. Then enter (''omitting 'sudo' if not applicable'') {{{ sudo easy_install Trac }}} to install Trac, SQLite, and Genshi. == Requirements == The 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. 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. 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. If you're interested in contributing new translations for other languages or enhance the existing translations, then please have a look at [[trac:TracL10N]]. What 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. [[PageOutline(2-3,Installation Steps,inline)]] == Dependencies == === Mandatory Dependencies To install Trac, the following software packages must be installed: * [http://www.python.org/ Python], version >=2.3 (<3.0) * 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). * For RPM-based systems you might also need the python-devel and python-xml packages. * See instructions in [trac:wiki:TracOnWindows/Python2.5 TracOnWindows/Python2.5] * [wiki:setuptools], version >= 0.6 * [http://genshi.edgewall.org/wiki/Download Genshi], version >= 0.5 (was version >= 0.4.1 on previous 0.11 release candidates) * You also need a database system and the corresponding python drivers for it. The database can be either SQLite, PostgreSQL or MySQL. * Optional if some plugins require it: [http://www.clearsilver.net/ ClearSilver] ==== For SQLite ==== * [http://www.python.org/ Python], version >= 2.4 and < 3.0 (note that we dropped the support for Python 2.3 in this release) * [http://peak.telecommunity.com/DevCenter/setuptools setuptools], version >= 0.6 * [http://genshi.edgewall.org/wiki/Download Genshi], version >= 0.6 You also need a database system and the corresponding python bindings. The database can be either SQLite, PostgreSQL or MySQL. ==== For the SQLite database #ForSQLite If you're using Python 2.5 or 2.6, you already have everything you need. If you're using Python 2.3 or 2.4 and need pysqlite, you can download from If you're using Python 2.4 and need pysqlite, you can download from [http://code.google.com/p/pysqlite/downloads/list google code] the Windows installers or the tar.gz archive for building from source: }}} That way, the latest SQLite version will be downloaded and built into the bindings. If you're still using SQLite 2.x, you'll need pysqlite 1.0.x, although this package is not easy to find anymore. For SQLite 3.x, try not to use pysqlite 1.1.x, which has been deprecated in favor of pysqlite 2.x. This will extract the SQLite code and build the bindings. SQLite 2.x is no longer supported. For SQLite 3.x, the pysqlite 1.1.x bindings are also no longer supported, use pysqlite 2.x. See additional information in [trac:PySqlite PySqlite]. ==== For PostgreSQL ==== ==== For the PostgreSQL database #ForPostgreSQL You need to install the database and its Python bindings: * [http://www.postgresql.org/ PostgreSQL] * [http://initd.org/projects/psycopg2 psycopg2] * See [trac:wiki:DatabaseBackend#Postgresql DatabaseBackend] '''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. ==== For MySQL ==== * [http://mysql.com/ MySQL], version 4.1 or later ([http://askmonty.org/wiki/index.php/MariaDB MariaDB] might work as well) * [http://sf.net/projects/mysql-python MySQLdb], version 1.2.1 or later See [trac:MySqlDb MySqlDb] for more detailed information. It is ''very'' important to read carefully that page before creating the database. == Optional Requirements == * [http://pypi.python.org/pypi/psycopg2 psycopg2] See [trac:DatabaseBackend#Postgresql DatabaseBackend] for details. ==== For the MySQL database #ForMySQL Trac can now work quite well with MySQL, provided you follow the guidelines. * [http://mysql.com/ MySQL], version 5.0 or later * [http://sf.net/projects/mysql-python MySQLdb], version 1.2.2 or later It is '''very''' important to read carefully the  [trac:MySqlDb MySqlDb] page before creating the database. === Optional Dependencies ==== Version Control System ==== '''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). * [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] * 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). * 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. * There are [http://subversion.tigris.org/servlets/ProjectDocumentList?folderID=91 pre-compiled bindings] available for win32. * Support for other version control systems is provided via third-parties. See [trac:PluginList PluginList] and [trac:VersioningSystemBackend VersioningSystemBackend]. ===== Subversion ===== * [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. 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 '''Please note:''' if using Subversion, Trac must be installed on the '''same machine'''. Remote repositories are currently [trac:ticket:493 not supported]. ===== Others ===== Support for other version control systems is provided via third-parties. See [trac:PluginList PluginList] and [trac:VersioningSystemBackend VersioningSystemBackend]. ==== Web Server ==== * A CGI-capable web server (see TracCgi), or * a [http://www.fastcgi.com/ FastCGI]-capable web server (see TracFastCgi), or * an [http://tomcat.apache.org/connectors-doc/ajp/ajpv13a.html AJP]-capable web server (see [trac:TracOnWindowsIisAjp TracOnWindowsIisAjp]), or * [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 * 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. * [http://httpd.apache.org/ Apache] with [http://www.modpython.org/ mod_python 3.1.3+] (see TracModPython) * When installing mod_python the development versions of Python and Apache are required (actually the libraries and header files) 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 [trac:wiki:TracModPython2.7 TracModPython2.7]). This guide hasn't been updated since 0.84, so it may or may not work. ==== Other Python Utilities ==== * [http://docutils.sourceforge.net/ docutils], version >= 0.3.9 for WikiRestructuredText. * [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. * [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. A web server is optional because Trac is shipped with a server included, see the [#RunningtheStandaloneServer Running the Standalone Server ] section below. Alternatively you configure Trac to run in any of the following environments. * [http://httpd.apache.org/ Apache] with - [http://code.google.com/p/modwsgi/ mod_wsgi], see [wiki:TracModWSGI] and http://code.google.com/p/modwsgi/wiki/IntegrationWithTrac - [http://modpython.org/ mod_python 3.3.1], see TracModPython) * a [http://www.fastcgi.com/ FastCGI]-capable web server (see TracFastCgi) * an [http://tomcat.apache.org/connectors-doc/ajp/ajpv13a.html AJP]-capable web server (see [trac:TracOnWindowsIisAjp TracOnWindowsIisAjp]) * a CGI-capable web server (see TracCgi), '''but usage of Trac as a cgi script is highly discouraged''', better use one of the previous options. ==== Other Python Packages ==== * [http://babel.edgewall.org Babel], version >= 0.9.5, needed for localization support * [http://docutils.sourceforge.net/ docutils], version >= 0.3.9 for WikiRestructuredText. * [http://pygments.pocoo.org Pygments] for [wiki:TracSyntaxColoring syntax highlighting]. [http://silvercity.sourceforge.net/ SilverCity] and/or [http://gnu.org/software/enscript/enscript.html Enscript] may still be used but are deprecated and you really should be using Pygments. * [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. '''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]. Please 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!). == Installing Trac == === Using easy_install One way to install Trac is using setuptools. With setuptools you can install Trac from the subversion repository; for example, to install release version 0.11 do: {{{ easy_install http://svn.edgewall.org/repos/trac/tags/trac-0.11 }}} But of course the python-typical setup at the top of the source directory also works: With setuptools you can install Trac from the subversion repository; A few examples: - install Trac 0.12: {{{ easy_install Trac==0.12 }}} - install latest development version 0.12dev: {{{ easy_install Trac==dev }}} Note that in this case you won't have the possibility to run a localized version of Trac; either use a released version or install from source === Using pip 'pip' is an easy_install replacement that is very useful to quickly install python packages. To get a trac installation up and running in less than 5 minutes: Assuming you want to have your entire pip installation in /opt/user/trac - {{{ pip -E /opt/user/trac install trac psycopg2 }}} or - {{{ pip -E /opt/user/trac install trac mysql-python }}} Make sure your OS specific headers are available for pip to automatically build PostgreSQL (libpq-dev) or MySQL (libmysqlclient-dev) bindings. pip 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 All 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) Additionally, you can install several trac plugins (listed [http://pypi.python.org/pypi?:action=search&term=trac&submit=search here]) through pip. === From source Of course, using the python-typical setup at the top of the source directory also works. You 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). {{{ $python ./setup.py install }}} ''Note: you'll need root permissions or equivalent for this step.'' ''You'll need root permissions or equivalent for this step.'' This will byte-compile the python source code and install it as an .egg file or folder in the site-packages directory The 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. ==== Advanced Options ==== If 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): {{{$ python ./setup.py install }}} Alternatively, 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). === Advanced Options === To install Trac to a custom location, or find out about other advanced installation options, run: easy_install --prefix=/usr/local --install-dir=/Library/Python/2.5/site-packages }}} Note: 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 The 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. == Creating a Project Environment == 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. A [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. A new environment is created using [wiki:TracAdmin trac-admin]: }}} [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. Also note that the values you specify here can be changed later by directly editing the [wiki:TracIni] configuration file. ''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:'' chown -R apache.apache /path/to/myproject [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  to use the default value. Using the default database connection string in particular will always work as long as you have SQLite installed. For the other [DatabaseBackend database backends] you should plan ahead and already have a database ready to use at this point. Since 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. Also note that the values you specify here can be changed later by directly editing the [TracIni conf/trac.ini] configuration file. Finally, 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: {{{ # chown -R apache.apache /path/to/myproject }}} == Running the Standalone Server == }}} 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. 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: 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. 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: {{{ $tracd -s --port 8000 /path/to/myproject == Running Trac on a Web Server == 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. If 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. Trac 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. Trac also supports [trac:TracOnWindowsIisAjp AJP] which may be your choice if you want to connect to IIS. ==== Generating the Trac cgi-bin directory ==== In 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]. In 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]. There 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: ==== Setting up the Plugin Cache ==== Some 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. Some 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. == Configuring Authentication == * TracStandalone if you use the standalone server, tracd. * TracCgi if you use the CGI or FastCGI methods. * TracModPython if you use the mod_python method. * TracCgi if you use the CGI or FastCGI web front ends. * [wiki:TracModWSGI] if you use the Apache mod_wsgi web front end. * TracModPython if you use the Apache mod_python web front end. == Automatic reference to the SVN changesets in Trac tickets == You 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: * '''Refs #123''' - to reference this changeset in #123 ticket * '''Fixes #123''' - to reference this changeset and close #123 ticket with the default status ''fixed'' All 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. If 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: {{{$ cd /path/to/svn/repository/hooks $mv post-commit.tmpl post-commit$ chmod 755 post-commit }}} Next 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: {{{ REPOS="$1" REV="$2" TRAC_ENV="/path/to/your/trac/project" /usr/bin/python /usr/local/bin/trac-post-commit-hook -p "$TRAC_ENV" -r "$REV" }}} 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]. == Platform-specifics installations == * See [trac:TracInstallPlatforms TracInstallPlatforms] You 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: * '''Refs #123''' - to reference this changeset in #123 ticket * '''Fixes #123''' - to reference this changeset and close #123 ticket with the default status ''fixed'' This 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. {{{ tracopt.ticket.commit_updater.* = enabled }}} For more information, see the documentation of the CommitTicketUpdater component in the "Plugins" admin panel. == Using Trac == Once you have your Trac site up and running, you should be able to browse your subversion repository, create tickets, view the timeline, etc. Once 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. Keep 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. ---- See also: [trac:TracInstallPlatforms TracInstallPlatforms], TracGuide, TracCgi, TracFastCgi, TracModPython, [wiki:TracModWSGI], TracUpgrade, TracPermissions