Changes between Initial Version and Version 1 of TracInstall

Feb 24, 2010, 12:11:38 AM (5 years ago)



  • TracInstall

    v1 v1  
     1= Trac Installation Guide for 0.11 =
     5Trac is written in the Python programming language and needs a database, [ SQLite], [ PostgreSQL], [ MySQL]. For HTML rendering, Trac uses the [ Genshi] templating system.
     7What 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.
     9See TracUpgrade for instructions on how to upgrade an existing installation.
     12== Quick Install a Released Version ==
     13For a quick install, first make sure you have [ Python] (2.3-2.6) and [ easy_install].
     15Then enter (''omitting 'sudo' if not applicable'')
     17sudo easy_install Trac
     19to install Trac, SQLite, and Genshi.
     22== Requirements ==
     23The 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.
     25To install Trac, the following software packages must be installed:
     27 * [ Python], version >=2.3 (<3.0)
     28   * 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 [ here] for details).
     29   * For RPM-based systems you might also need the `python-devel` and `python-xml` packages.
     30   * See instructions in [trac:wiki:TracOnWindows/Python2.5 TracOnWindows/Python2.5]
     31 * [wiki:setuptools], version >= 0.6
     32 * [ Genshi], version >= 0.5 (was version >= 0.4.1 on previous 0.11 release candidates)
     33 * You also need a database system and the corresponding python drivers for it.
     34   The database can be either SQLite, PostgreSQL or MySQL.
     35 * Optional if some plugins require it: [ ClearSilver]
     37==== For SQLite ====
     39If you're using Python 2.5 or 2.6, you already have everything you need.
     41If you're using Python 2.3 or 2.4 and need pysqlite, you can download from
     42[ google code] the Windows
     43installers or the tar.gz archive for building from source:
     45$ tar xvfz <version>.tar.gz
     46$ cd <version>
     47$ python build_static install
     50That way, the latest SQLite version will be downloaded and built into the
     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.
     57See additional information in [trac:PySqlite PySqlite].
     59==== For PostgreSQL ====
     61 * [ PostgreSQL]
     62 * [ psycopg2]
     63 * See [trac:wiki:DatabaseBackend#Postgresql DatabaseBackend]
     65'''Warning''': PostgreSQL 8.3 uses a strict type checking mechanism. To use Trac with the 8.3 Version of PostgreSQL, you will need [ trac-0.11] or later.
     67==== For MySQL ====
     69 * [ MySQL], version 4.1 or later ([ MariaDB] might work as well)
     70 * [ MySQLdb], version 1.2.1 or later
     72See [trac:MySqlDb MySqlDb] for more detailed information.
     73It is ''very'' important to read carefully that page before creating the database.
     75== Optional Requirements ==
     77==== Version Control System ====
     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).
     81 * [ 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]
     82   * Trac uses the [ SWIG] bindings included in the Subversion distribution, '''not''' [ PySVN] (which is sometimes confused with the standard SWIG bindings).
     83   * 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`.
     84   * There are [ pre-compiled bindings] available for win32.
     85 * Support for other version control systems is provided via third-parties. See [trac:PluginList PluginList] and [trac:VersioningSystemBackend VersioningSystemBackend].
     87==== Web Server ====
     88 * A CGI-capable web server (see TracCgi), or
     89 * a [ FastCGI]-capable web server (see TracFastCgi), or
     90 * an [ AJP]-capable web server (see [trac:TracOnWindowsIisAjp TracOnWindowsIisAjp]), or
     91 * [ Apache] with [ mod_wsgi] (see [wiki:TracModWSGI] or or
     92    * 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.
     93 * [ Apache] with [ mod_python 3.1.3+] (see TracModPython)
     94    * When installing mod_python the development versions of Python and Apache are required (actually the libraries and header files)
     96For those stuck with Apache 1.3, it is also possible to get Trac working with [ 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.
     98==== Other Python Utilities ====
     99 * [ docutils], version >= 0.3.9 for WikiRestructuredText.
     100 * [ Pygments] for '''syntax highlighting''', although [ SilverCity] >= 0.9.7 and/or [ GNU Enscript] are also possible. Refer to TracSyntaxColoring for details.
     101 * [ pytz] to get a complete list of time zones, otherwise Trac will fall back on a shorter list from an internal time zone implementation.
     103'''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].
     105Please 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!).
     107== Installing Trac ==
     109One way to install Trac is using `setuptools`.
     110With setuptools you can install Trac from the subversion repository; for example,
     111to install release version 0.11 do:
     116But of course the python-typical setup at the top of the source directory also works:
     118$ python ./ install
     121''Note: you'll need root permissions or equivalent for this step.''
     123This will byte-compile the python source code and install it as an .egg file or folder in the `site-packages` directory
     124of your Python installation. The .egg will also contain all other resources needed by standard Trac, such as htdocs and templates.
     126The 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.
     128==== Advanced Options ====
     130To install Trac to a custom location, or find out about other advanced installation options, run:
     132easy_install --help
     135Also see [ Installing Python Modules] for detailed information.
     137Specifically, you might be interested in:
     139easy_install --prefix=/path/to/installdir
     141or, if installing Trac to a Mac OS X system:
     143easy_install --prefix=/usr/local --install-dir=/Library/Python/2.5/site-packages
     146The 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.
     148== Creating a Project Environment ==
     150A [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.
     152A new environment is created using [wiki:TracAdmin trac-admin]:
     154$ trac-admin /path/to/myproject initenv
     157[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.
     159Also note that the values you specify here can be changed later by directly editing the [wiki:TracIni] configuration file.
     161''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:''
     163  chown -R apache.apache /path/to/myproject
     165== Running the Standalone Server ==
     167After having created a Trac environment, you can easily try the web interface by running the standalone server [wiki:TracStandalone tracd]:
     169$ tracd --port 8000 /path/to/myproject
     172Then, 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:
     174$ tracd -s --port 8000 /path/to/myproject
     177== Running Trac on a Web Server ==
     179Trac 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.
     181If 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.
     183Trac also supports [trac:TracOnWindowsIisAjp AJP] which may be your choice if you want to connect to IIS.
     185==== Generating the Trac cgi-bin directory ====
     187In 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].
     189There 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:
     191mkdir -p /usr/share/trac/projects/my-project
     192trac-admin /usr/share/trac/projects/my-project initenv
     193trac-admin /usr/share/trac/projects/my-project deploy /tmp/deploy
     194mv /tmp/deploy/* /usr/share/trac
     197==== Setting up the Plugin Cache ====
     199Some 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.
     201== Configuring Authentication ==
     203The process of adding, removing, and configuring user accounts for authentication depends on the specific way you run Trac. The basic procedure is described in the [wiki:TracCgi#AddingAuthentication "Adding Authentication"] section on the TracCgi page. To learn how to setup authentication for the frontend you're using, please refer to one of the following pages:
     205 * TracStandalone if you use the standalone server, `tracd`.
     206 * TracCgi if you use the CGI or FastCGI methods.
     207 * TracModPython if you use the mod_python method.
     209== Automatic reference to the SVN changesets in Trac tickets ==
     211You 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:
     212 * '''Refs #123''' - to reference this changeset in #123 ticket
     213 * '''Fixes #123''' - to reference this changeset and close #123 ticket with the default status ''fixed''
     215All 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.
     217If 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:
     220$ cd /path/to/svn/repository/hooks
     221$ mv post-commit.tmpl post-commit
     222$ chmod 755 post-commit
     225Next 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:
     232/usr/bin/python /usr/local/bin/trac-post-commit-hook -p "$TRAC_ENV" -r "$REV"
     235Make 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].
     238== Platform-specifics installations ==
     240 * See [trac:TracInstallPlatforms TracInstallPlatforms]
     243== Using Trac ==
     245Once you have your Trac site up and running, you should be able to browse your subversion repository, create tickets, view the timeline, etc.
     247Keep 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.
     249'' Enjoy! ''
     251[trac:TracTeam The Trac Team]
     254See also: [trac:TracInstallPlatforms TracInstallPlatforms], TracGuide, TracCgi, TracFastCgi, TracModPython, [wiki:TracModWSGI], TracUpgrade, TracPermissions