Changes between Initial Version and Version 1 of TracInstall

08/07/15 22:11:27 (5 years ago)



  • TracInstall

    v1 v1  
     1= Trac Installation Guide for 1.0
     4Trac is written in the Python programming language and needs a database, [ SQLite], [ PostgreSQL], or [ MySQL]. For HTML rendering, Trac uses the [ Genshi] templating system.
     6Since version 0.12, Trac can also be localized, and there is probably a translation available in your language. If you want 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.
     8If you're interested in contributing new translations for other languages or enhance the existing translations, then please have a look at [trac:wiki:TracL10N TracL10N].
     10What follows are generic instructions for installing and setting up Trac. While you may find instructions for installing Trac on specific systems at [trac:TracInstallPlatforms TracInstallPlatforms] on the main Trac site, please '''first read through these general instructions''' to get a good understanding of the tasks involved.
     12[[PageOutline(2-3,Installation Steps,inline)]]
     14== Dependencies
     15=== Mandatory Dependencies
     16To install Trac, the following software packages must be installed:
     18 * [ Python], version >= 2.5 and < 3.0
     19   (note that we dropped the support for Python 2.4 in this release)
     20 * [ setuptools], version >= 0.6
     21 * [ Genshi], version >= 0.6
     23You also need a database system and the corresponding python bindings. The database can be either SQLite, PostgreSQL or MySQL.
     25==== For the SQLite database #ForSQLite
     27As you must be using Python 2.5, 2.6 or 2.7, you already have the SQLite database bindings bundled with the standard distribution of Python: the `sqlite3` module.
     29However, if you like, you can download the latest and greatest version of [[trac:PySqlite]] from
     30[ google code], where you'll find the Windows
     31installers or the `tar.gz` archive for building from source:
     33$ tar xvfz <version>.tar.gz
     34$ cd <version>
     35$ python build_static install
     38This will download the latest SQLite code and build the bindings. SQLite 2.x is no longer supported.
     40A known bug in [trac:PySqlite] versions 2.5.2-4 prohibits upgrades of Trac databases from 0.11.x to 0.12. Please use versions 2.5.5 and newer or 2.5.1 and older. See [trac:#9434] for more detail. See additional information in [trac:PySqlite PySqlite].
     42==== For the PostgreSQL database #ForPostgreSQL
     44You need to install the database and its Python bindings:
     45 * [ PostgreSQL], version 8.0 or later
     46 * [ psycopg2], version 2.0 or later
     48See [trac:DatabaseBackend#Postgresql DatabaseBackend] for details.
     50==== For the MySQL database #ForMySQL
     52Trac works well with MySQL, provided you follow the guidelines:
     54 * [ MySQL], version 5.0 or later
     55 * [ MySQLdb], version 1.2.2 or later
     57Given the caveats and known issues surrounding MySQL, read carefully the [trac:MySqlDb] page before creating the database.
     59=== Optional Dependencies
     61==== Version Control System
     63===== Subversion
     64 * [ 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.
     66There are [ pre-compiled SWIG bindings] available for various platforms. (Good luck finding precompiled SWIG bindings for any Windows package at that listing. [trac:TracSubversion] points you to [ Alagazam], which works for me under Python 2.6.)
     68Note that Trac '''doesn't''' use [ PySVN], neither does it work yet with the newer `ctype`-style bindings.
     70'''Please note:''' if using Subversion, Trac must be installed on the '''same machine'''. Remote repositories are currently [trac:ticket:493 not supported].
     72===== Others
     74Support for other version control systems is provided via third-parties. See [trac:PluginList] and [trac:VersionControlSystem].
     76==== Web Server
     77A web server is optional because Trac is shipped with a server included, see the [#RunningtheStandaloneServer Running the Standalone Server] section below.
     79Alternatively you can configure Trac to run in any of the following environments:
     80 * [ Apache] with
     81   - [ mod_wsgi], see [wiki:TracModWSGI] and
     83   - [ mod_python >= 3.3.1], (deprecated: see TracModPython)
     84 * a [ FastCGI]-capable web server (see TracFastCgi)
     85 * an [ AJP]-capable web
     86   server (see [trac:TracOnWindowsIisAjp TracOnWindowsIisAjp])
     87 * a CGI-capable web server (see TracCgi), '''but usage of Trac as a cgi script
     88   is highly discouraged''', better use one of the previous options.
     91==== Other Python Packages
     93 * [ Babel], version >= 0.9.5,
     94   needed for localization support (unreleased version 1.0dev should work as well)
     95 * [ docutils], version >= 0.3.9
     96   for WikiRestructuredText.
     97 * [ Pygments] for
     98   [wiki:TracSyntaxColoring syntax highlighting].
     99   [ SilverCity] and/or
     100   [ Enscript] may still be used
     101   but are deprecated and you really should be using Pygments.
     102 * [ pytz] to get a complete list of time zones,
     103   otherwise Trac will fall back on a shorter list from
     104   an internal time zone implementation.
     106'''Attention''': The available versions of these dependencies are not necessarily interchangeable, so please pay attention to the version numbers. If you are having trouble getting Trac to work, please double-check all the dependencies before asking for help on the [trac:MailingList] or [trac:IrcChannel].
     108Please 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!
     110== Installing Trac
     111=== Using `easy_install`
     112One way to install Trac is using [ setuptools]. With setuptools you can install Trac from the Subversion repository.
     114A few examples:
     116 - Install Trac 1.0:
     117   {{{#!sh
     118   easy_install Trac==1.0
     119   }}}
     120 - Install latest development version:
     121   {{{#!sh
     122   easy_install Trac==dev
     123   }}}
     124   Note that in this case you won't have the possibility to run a localized version of Trac;
     125   either use a released version or install from source
     127{{{#!div style="border: 1pt dotted; margin: 1em"
     128**Setuptools Warning:** If the version of your setuptools is in the range 5.4 through 5.6, the environment variable `PKG_RESOURCES_CACHE_ZIP_MANIFESTS` must be set in order to avoid significant performance degradation. More information may be found in the sections on [#RunningtheStandaloneServer Running The Standalone Server] and [#RunningTraconaWebServer Running Trac on a Web Server].
     131=== Using `pip`
     132'pip' is an easy_install replacement that is very useful to quickly install python packages.
     133To get a Trac installation up and running in less than 5 minutes:
     135Assuming you want to have your entire pip installation in `/opt/user/trac`
     137 -
     138 {{{#!sh
     139pip install trac psycopg2
     142 -
     143 {{{#!sh
     144pip install trac mysql-python
     147Make sure your OS specific headers are available for pip to automatically build PostgreSQL (`libpq-dev`) or MySQL (`libmysqlclient-dev`) bindings.
     149pip will automatically resolve all dependencies (like Genshi, pygments, etc.) and download the latest packages on and create a self contained installation in `/opt/user/trac`.
     151All 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)
     153Additionally, you can install several Trac plugins (listed [ here]) through pip.
     155=== From source
     156Of 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-1.0.tar.gz`), or you can get the source directly from the repository. See [trac:SubversionRepository] for details.
     159$ python ./ install
     162''You will need root permissions or equivalent for this step.''
     164This will byte-compile the Python source code and install it as an .egg file or folder in the `site-packages` directory
     165of your Python installation. The .egg will also contain all other resources needed by standard Trac, such as `htdocs` and `templates`.
     167The 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.
     169If 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):
     171$ python ./ install
     173Alternatively, you can run `bdist_egg` and copy the .egg from `dist/` to the place of your choice, or you can create a Windows installer (`bdist_wininst`).
     175=== Advanced Options
     177To install Trac to a custom location, or find out about other advanced installation options, run:
     179easy_install --help
     182Also see [ Installing Python Modules] for detailed information.
     184Specifically, you might be interested in:
     186easy_install --prefix=/path/to/installdir
     188or, if installing Trac on a Mac OS X system:
     190easy_install --prefix=/usr/local --install-dir=/Library/Python/2.5/site-packages
     192Note: If installing on Mac OS X 10.6 running {{{ easy_install }}} will install into {{{ /usr/local }}} and {{{ /Library/Python/2.6/site-packages }}} by default.
     194The 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.
     196== Creating a Project Environment
     198A [TracEnvironment Trac environment] is the backend 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 other files and directories.
     200A new environment is created using [wiki:TracAdmin trac-admin]:
     202$ trac-admin /path/to/myproject initenv
     205[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.
     207Using the default database connection string in particular will always work as long as you have SQLite installed.
     208For the other [trac:DatabaseBackend database backends] you should plan ahead and already have a database ready to use at this point.
     210Since 0.12, Trac doesn't ask for a [TracEnvironment#SourceCodeRepository source code repository] anymore when creating an environment. Repositories can be [TracRepositoryAdmin added] afterwards, and support for specific version control systems is disabled by default.
     212Also note that the values you specify here can be changed later by directly editing the [TracIni conf/trac.ini] configuration file.
     214When selecting the location of your environment, make sure that the filesystem on which the environment directory resides supports sub-second timestamps (i.e. **not** `ext2` or `ext3` on Linux), as the modification time of the `conf/trac.ini` file will be monitored to decide whether an environment restart is needed or not. A too coarse-grained timestamp resolution may result in inconsistencies in Trac < 1.0.2. The best advice is to opt for a platform with sub-second timestamp resolution, regardless of the Trac version.
     216Finally, 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:
     218$ chown -R apache.apache /path/to/myproject
     221The actual username and groupname of the apache server may not be exactly `apache`, and are specified in the Apache configuration file by the directives `User` and `Group` (if Apache `httpd` is what you use).
     223{{{#!div class=important
     224'''Warning:''' Please only use ASCII-characters for account name and project path, unicode characters are not supported there.
     227== Deploying Trac
     229=== Running the Standalone Server
     231After having created a Trac environment, you can easily try the web interface by running the standalone server [wiki:TracStandalone tracd]:
     233$ tracd --port 8000 /path/to/myproject
     236Then, 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:
     238$ tracd -s --port 8000 /path/to/myproject
     241{{{#!div style="border: 1pt dotted; margin: 1em"
     242**Setuptools Warning:** If the version of your setuptools is in the range 5.4 through 5.6, the environment variable `PKG_RESOURCES_CACHE_ZIP_MANIFESTS` must be set in order to avoid significant performance degradation. The environment variable can be set system-wide, or for just the user that runs the `tracd` process. There are several ways to accomplish this in addition to what is discussed here, and depending on the distribution of your OS.
     244To be effective system-wide a shell script with the `export` statement may be added to `/etc/profile.d`. To be effective for a user session the `export` statement may be added to `~/.profile`.
     249Alternatively, the variable can be set in the shell before executing `tracd`:
     251$ PKG_RESOURCES_CACHE_ZIP_MANIFESTS=1 tracd --port 8000 /path/to/myproject
     255=== Running Trac on a Web Server
     257Trac provides various options for connecting to a "real" web server:
     258 - [wiki:TracFastCgi FastCGI]
     259 - [wiki:TracModWSGI mod_wsgi]
     260 - //[wiki:TracModPython mod_python] (no longer recommended, as mod_python is not actively maintained anymore)//
     261 - //[wiki:TracCgi CGI] (should not be used, as the performance is far from optimal)//
     263Trac also supports [trac:TracOnWindowsIisAjp AJP] which may be your choice if you want to connect to IIS. Other deployment scenarios are possible: [trac:TracNginxRecipe nginx], [ uwsgi], [trac:TracOnWindowsIisIsapi Isapi-wsgi] etc.
     265==== Generating the Trac cgi-bin directory #cgi-bin
     267In 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].
     269There 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:
     271mkdir -p /usr/share/trac/projects/my-project
     272trac-admin /usr/share/trac/projects/my-project initenv
     273trac-admin /usr/share/trac/projects/my-project deploy /tmp/deploy
     274mv /tmp/deploy/* /usr/share/trac
     276Don't forget to check that the web server has the execution right on scripts in the `/usr/share/trac/cgi-bin` directory.
     278==== Mapping Static Resources
     280Out of the box, Trac will pass static resources such as style sheets or images through itself. For anything but a tracd only based deployment, this is far from optimal as the web server could be set up to directly serve those static resources (for CGI setup, this is '''highly undesirable''' and will cause abysmal performance).
     282Web servers such as [ Apache] allow you to create “Aliases” to resources, giving them a virtual URL that doesn't necessarily reflect the layout of the servers file system. We also can map requests for static resources directly to the directory on the file system, avoiding processing these requests by Trac itself.
     284There are two primary URL paths for static resources - `/chrome/common` and `/chrome/site`. Plugins can add their own resources, usually accessible by `/chrome/<plugin>` path, so its important to override only known paths and not try to make universal `/chrome` alias for everything.
     286Note that in order to get those static resources on the filesystem, you need first to extract the relevant resources from Trac using the [TracAdmin trac-admin]` <environment> deploy` command:
     289The target `<directory>` will then contain an `htdocs` directory with:
     290 - `site/` - a copy of the environment's directory `htdocs/`
     291 - `common/` - the static resources of Trac itself
     292 - `<plugins>/` - one directory for each resource directory managed by the plugins enabled for this environment
     294===== Example: Apache and `ScriptAlias` #ScriptAlias-example
     296Assuming the deployment has been done this way:
     298$ trac-admin /var/trac/env deploy /path/to/shared/trac
     301Add the following snippet to Apache configuration ''before'' the `ScriptAlias` or `WSGIScriptAlias` (which map all the other requests to the Trac application), changing paths to match your deployment:
     303Alias /trac/chrome/common /path/to/trac/htdocs/common
     304Alias /trac/chrome/site /path/to/trac/htdocs/site
     306<Directory "/path/to/www/trac/htdocs">
     307  Order allow,deny
     308  Allow from all
     312If using mod_python, you might want to add this too (otherwise, the alias will be ignored):
     314<Location "/trac/chrome/common/">
     315  SetHandler None
     319Note that we mapped `/trac` part of the URL to the `trac.*cgi` script, and the path `/trac/chrome/common` is the path you have to append to that location to intercept requests to the static resources.
     321Similarly, if you have static resources in a project's `htdocs` directory (which is referenced by `/trac/chrome/site` URL in themes), you can configure Apache to serve those resources (again, put this ''before'' the `ScriptAlias` or `WSGIScriptAlias` for the .*cgi scripts, and adjust names and locations to match your installation):
     323Alias /trac/chrome/site /path/to/projectenv/htdocs
     325<Directory "/path/to/projectenv/htdocs">
     326  Order allow,deny
     327  Allow from all
     331Alternatively to aliasing `/trac/chrome/common`, you can tell Trac to generate direct links for those static resources (and only those), using the [[wiki:TracIni#trac-section| [trac] htdocs_location]] configuration setting:
     334htdocs_location =
     336Note that this makes it easy to have a dedicated domain serve those static resources (preferentially [ cookie-less]).
     338Of course, you still need to make the Trac `htdocs/common` directory available through the web server at the specified URL, for example by copying (or linking) the directory into the document root of the web server:
     340$ ln -s /path/to/trac/htdocs/common /var/www/
     343==== Setting up the Plugin Cache
     345Some 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.
     347== Configuring Authentication
     349Trac uses HTTP authentication. You'll need to configure your webserver to request authentication when the `.../login` URL is hit (the virtual path of the "login" button). Trac will automatically pick the `REMOTE_USER` variable up after you provide your credentials. Therefore, all user management goes through your web server configuration. Please consult the documentation of your web server for more info.
     351The process of adding, removing, and configuring user accounts for authentication depends on the specific way you run Trac.
     353Please refer to one of the following sections:
     354 * TracStandalone#UsingAuthentication if you use the standalone server, `tracd`.
     355 * [wiki:TracModWSGI#ConfiguringAuthentication TracModWSGI#ConfiguringAuthentication] if you use the Apache web server, with any of its front end: `mod_wsgi` of course, but the same instructions applies also for `mod_python`, `mod_fcgi` or `mod_fastcgi`.
     356 * TracFastCgi if you're using another web server with FCGI support (Cherokee, Lighttpd, !LiteSpeed, nginx)
     358The following document also constains some useful information for beginners: [trac:TracAuthenticationIntroduction].
     360== Granting admin rights to the admin user
     361Grant admin rights to user admin:
     363$ trac-admin /path/to/myproject permission add admin TRAC_ADMIN
     365This user will have an "Admin" entry menu that will allow you to administrate your Trac project.
     367== Finishing the install
     369=== Enable version control components
     371Support for version control systems is provided by optional components in Trac and the components are disabled by default //(since 1.0)//. Subversion and Git must be explicitly enabled if you wish to use them. See TracRepositoryAdmin for more details.
     373The components can be enabled by adding the following to the `[components]` section of your [TracIni#components-section trac.ini], or enabling the components in the "Plugins" admin panel.
     376tracopt.versioncontrol.svn.* = enabled
     380tracopt.versioncontrol.git.* = enabled
     383After enabling the components, repositories can be configured through the "Repositories" admin panel or by editing [TracIni#repositories-section trac.ini].
     385=== Automatic reference to the SVN changesets in Trac tickets
     387You 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:
     388 * '''`Refs #123`''' - to reference this changeset in `#123` ticket
     389 * '''`Fixes #123`''' - to reference this changeset and close `#123` ticket with the default status ''fixed''
     391This 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.
     393tracopt.ticket.commit_updater.* = enabled
     395For more information, see the documentation of the `CommitTicketUpdater` component in the "Plugins" admin panel.
     397=== Using Trac
     399Once 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.
     401Keep in mind that //anonymous// (not logged in) users can by default access only a few of the features, in particular they will have a read-only access to the resources. You will need to configure authentication and grant additional [wiki:TracPermissions permissions] to authenticated users to see the full set of features.
     403'' Enjoy! ''
     405[trac:TracTeam The Trac Team]
     408See also: [trac:TracInstallPlatforms TracInstallPlatforms], TracGuide, TracUpgrade, TracPermissions