Changes between Initial Version and Version 1 of TracInstall

02/23/15 10:26:52 (8 years ago)



  • TracInstall

    v1 v1  
     1= Trac Installation Guide for 0.12 =
     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'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 **first** have installed the optional package [#OtherPythonPackages Babel]. Lacking Babel, you will only get the default English version, as usual. If you install Babel later on, you will need to re-install Trac.
     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 and its requirements. While you may find instructions for installing Trac on specific systems at [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.
     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.4 and < 3.0
     19   //(note that we dropped the support for Python 2.3 in this release and that this will be the last Trac release supporting Python 2.4)//
     20 * [ setuptools], version >= 0.6
     21 * [ Genshi], version >= 0.6 (but < 0.7dev, i.e. don't use Genshi trunk)
     23You also need a database system and the corresponding python bindings.
     24The database can be either SQLite, PostgreSQL or MySQL.
     26==== For the SQLite database #ForSQLite
     28If you're using Python 2.5 or 2.6, you already have everything you need.
     30If you're using Python 2.4 and need pysqlite, you can download from
     31[ google code] the Windows installers 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 extract the SQLite code and build the bindings.
     40To install SQLite, your system may require the development headers. Without these you will get various GCC related errors when attempting to build:
     43$ apt-get install libsqlite3-dev
     46SQLite 2.x is no longer supported, and neither is !PySqlite 1.1.x.
     48A known bug !PySqlite versions 2.5.2-4 prohibits upgrade of trac databases
     49from 0.11.x to 0.12. Please use versions 2.5.5 and newer or 2.5.1 and
     50older. See [trac:#9434] for more detail.
     52See additional information in [trac:PySqlite].
     54==== For the PostgreSQL database #ForPostgreSQL
     56You need to install the database and its Python bindings:
     57 * [ PostgreSQL], version 8.0 or later
     58 * [ psycopg2]
     60See [trac:DatabaseBackend#Postgresql DatabaseBackend] for details.
     63==== For the MySQL database #ForMySQL
     65Trac can now work quite well with MySQL, provided you follow the guidelines.
     67 * [ MySQL], version 5.0 or later
     68 * [ MySQLdb], version 1.2.2 or later
     70It is '''very''' important to read carefully the  [trac:MySqlDb] page before creating the database.
     72=== Optional Dependencies
     74==== Version Control System ====
     76===== Subversion =====
     78[ Subversion] 1.5.x or 1.6.x and the '''''corresponding''''' Python bindings.
     80There are [ pre-compiled SWIG bindings] available for various platforms. See also the TracSubversion page for details about Windows packages.
     82Older versions starting from 1.4.0, etc. should still work. For troubleshooting information, check the [trac:TracSubversion#Troubleshooting TracSubversion] page. Versions prior to 1.4.0 won't probably work since trac uses svn core functionality (e.g. svn_path_canonicalize) that is not implemented in the python swig wrapper in svn <= 1.3.x (although it exists in the svn lib itself).
     84Note that Trac '''doesn't''' use [ PySVN], neither does it work yet with the newer `ctype`-style bindings.
     86'''Please note:''' if using Subversion, Trac must be installed on the '''same machine'''. Remote repositories are currently [trac:#493 not supported].
     89===== Others =====
     91Support for other version control systems is provided via third-parties. See [trac:PluginList] and [trac:VersionControlSystem].
     93==== Web Server ====
     94A web server is optional because Trac is shipped with a server included, see the [#RunningtheStandaloneServer Running the Standalone Server ] section below.
     96Alternatively you configure Trac to run in any of the following environments.
     97 * [ Apache] with
     98   - [ mod_wsgi], see [wiki:TracModWSGI] (preferred)
     99   - //[ mod_python 3.3.1], see TracModPython (deprecated)//
     100 * any [ FastCGI]-capable web server, see TracFastCgi
     101 * any [ AJP]-capable web
     102   server, see [trac:TracOnWindowsIisAjp]
     103 * IIS with [ Isapi-wsgi], see [trac:TracOnWindowsIisIsapi]
     104 * //as a last resort, a CGI-capable web server (see TracCgi), but usage of Trac as a cgi script
     105   is highly discouraged, better use one of the previous options.//
     108==== Other Python Packages ====
     110 * [ Babel], version 0.9.5,
     111   needed for localization support[[BR]]
     112   ''Note: '' If you want to be able to use the Trac interface in other languages, then make sure you first have installed the optional package Babel. Lacking Babel, you will only get the default english version, as usual. If you install Babel later on, you will need to re-install Trac.
     113 * [ docutils], version >= 0.3.9
     114   for WikiRestructuredText.
     115 * [ Pygments] for
     116   [wiki:TracSyntaxColoring syntax highlighting].
     117   [ SilverCity] and/or
     118   [ Enscript] may still be used
     119   but are deprecated and you really should be using Pygments.
     120 * [ pytz] to get a complete list of time zones,
     121   otherwise Trac will fall back on a shorter list from
     122   an internal time zone implementation.
     124'''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] or [trac:IrcChannel].
     126Please 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!).
     129== Installing Trac ==
     130=== Using `easy_install`
     131One way to install Trac is using [ setuptools].
     132With setuptools you can install Trac from the subversion repository;
     134A few examples:
     136 - first install of the latest stable version Trac 0.12.3, with i18n support:
     137   {{{
     138   easy_install Babel==0.9.5
     139   easy_install Trac==0.12
     140   }}}
     141   ''It's very important to run the two `easy_install` commands separately, otherwise the message catalogs won't be generated.''
     143 - upgrade to the latest stable version of Trac:
     144   {{{
     145   easy_install -U Trac
     146   }}}
     148 - upgrade to the latest trunk development version:
     149   {{{
     150   easy_install -U Trac==dev
     151   }}}
     153For upgrades, reading the TracUpgrade page is mandatory, of course.
     155=== From source
     156If you want more control, you can download the source in archive form, or do a checkout from one of the official [[Trac:TracRepositories|source code repositories]].
     158Be sure to have the prerequisites already installed. You can also obtain the Genshi and Babel source packages from and follow for them a similar installation procedure, or you can just `easy_install` those, see [#Usingeasy_install above].
     160Once you've unpacked the Trac archive or performed the checkout, move in the top-level folder and do:
     162$ python ./ install
     165You'll need root permissions or equivalent for this step.
     167This will byte-compile the python source code and install it as an .egg file or folder in the `site-packages` directory
     168of your Python installation. The .egg will also contain all other resources needed by standard Trac, such as htdocs and templates.
     170The 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.
     172If 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):
     174$ python ./ install
     176Alternatively, 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`).
     178=== Advanced Options ===
     180==== Custom location with `easy_install`
     182To install Trac to a custom location, or find out about other advanced installation options, run:
     184easy_install --help
     187Also see [ Installing Python Modules] for detailed information.
     189Specifically, you might be interested in:
     191easy_install --prefix=/path/to/installdir
     193or, if installing Trac to a Mac OS X system:
     195easy_install --prefix=/usr/local --install-dir=/Library/Python/2.5/site-packages
     197Note: 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
     199The 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.
     201==== Using `pip`
     202'pip' is an easy_install replacement that is very useful to quickly install python packages.
     203To get a trac installation up and running in less than 5 minutes:
     205Assuming you want to have your entire pip installation in /opt/user/trac:
     207 -
     209pip -E /opt/user/trac install trac psycopg2
     212 -
     214pip -E /opt/user/trac install trac mysql-python
     217Make sure your OS specific headers are available for pip to automatically build PostgreSQL (libpq-dev) or MySQL (libmysqlclient-dev) bindings.
     219pip 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 .
     221All 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)
     223Additionally, you can install several trac plugins (listed [ here]) through pip.
     227== Creating a Project Environment ==
     229A [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.
     231A new environment is created using [wiki:TracAdmin trac-admin]:
     233$ trac-admin /path/to/myproject initenv
     236[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.
     238Using the default database connection string in particular will always work as long as you have SQLite installed.
     239For the other [DatabaseBackend database backends] you should plan ahead and already have a database ready to use at this point.
     241Since 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.
     243Also note that the values you specify here can be changed later by directly editing the [TracIni conf/trac.ini] configuration file.
     245Finally, 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:
     247# chown -R apache.apache /path/to/myproject
     250{{{#!div class=important
     251'''Warning:''' Please only use ASCII-characters for account name and project path, unicode characters are not supported there.
     255== Deploying Trac
     257=== Running the Standalone Server ===
     259After having created a Trac environment, you can easily try the web interface by running the standalone server [wiki:TracStandalone tracd]:
     261$ tracd --port 8000 /path/to/myproject
     264Then, 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:
     266$ tracd -s --port 8000 /path/to/myproject
     269=== Running Trac on a Web Server ===
     271Trac provides various options for connecting to a "real" web server:
     272 - [wiki:TracFastCgi FastCGI]
     273 - [wiki:TracModWSGI mod_wsgi]
     274 - //[wiki:TracModPython mod_python] (no longer recommended, as mod_python is not actively maintained anymore)//
     275 - //[wiki:TracCgi CGI] (should not be used, as the performance is far from optimal)//
     277Trac 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.
     279==== Generating the Trac cgi-bin directory ==== #cgi-bin
     281In 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].
     283There 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:
     285mkdir -p /usr/share/trac/projects/my-project
     286trac-admin /usr/share/trac/projects/my-project initenv
     287trac-admin /usr/share/trac/projects/my-project deploy /tmp/deploy
     288mv /tmp/deploy/* /usr/share/trac
     292==== Mapping Static Resources ====
     294Out 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).
     296Web 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.
     298There 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.
     300Note 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:
     303The target `<directory>` will then contain an `htdocs` directory with:
     304 - `site/` - a copy of the environment's directory `htdocs/`
     305 - `common/` - the static resources of Trac itself
     306 - `<plugins>/` - one directory for each resource directory managed by the plugins enabled for this environment
     308===== Example: Apache and `ScriptAlias` ===== #ScriptAlias-example
     310Assuming the deployment has been done this way:
     312$ trac-admin /var/trac/env deploy /path/to/trac/htdocs/common
     315Add 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:
     317Alias /trac/chrome/common /path/to/trac/htdocs/common
     318Alias /trac/chrome/site /path/to/trac/htdocs/site
     320<Directory "/path/to/www/trac/htdocs">
     321  Order allow,deny
     322  Allow from all
     326If using mod_python, you might want to add this too (otherwise, the alias will be ignored):
     328<Location "/trac/chrome/common/">
     329  SetHandler None
     333Note 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.
     335Similarly, 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):
     337Alias /trac/chrome/site /path/to/projectenv/htdocs
     339<Directory "/path/to/projectenv/htdocs">
     340  Order allow,deny
     341  Allow from all
     345Alternatively 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:
     348htdocs_location =
     350Note that this makes it easy to have a dedicated domain serve those static resources (preferentially [ cookie-less]).
     352Of 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:
     354$ ln -s /path/to/trac/htdocs/common /var/www/
     358==== Setting up the Plugin Cache ====
     360Some 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.
     362== Configuring Authentication ==
     364Trac 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.
     366The process of adding, removing, and configuring user accounts for authentication depends on the specific way you run Trac.
     368Please refer to one of the following sections:
     369 * TracStandalone#UsingAuthentication if you use the standalone server, `tracd`.
     370 * [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`.
     371 * TracFastCgi if you're using another web server with FCGI support (Cherokee, Lighttpd, !LiteSpeed, nginx)
     373== Granting admin rights to the admin user
     374Grant admin rights to user admin:
     376$ trac-admin /path/to/myproject permission add admin TRAC_ADMIN
     378This user will have an "Admin" entry menu that will allow you to admin your trac project.
     380== Finishing the install
     382=== Automatic reference to the SVN changesets in Trac tickets ===
     384You 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:
     385 * '''`Refs #123`''' - to reference this changeset in `#123` ticket
     386 * '''`Fixes #123`''' - to reference this changeset and close `#123` ticket with the default status ''fixed''
     388This 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.
     390tracopt.ticket.commit_updater.* = enabled
     392For more information, see the documentation of the `CommitTicketUpdater` component in the "Plugins" admin panel.
     394=== Using Trac ===
     396Once 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.
     398Keep 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.
     400'' Enjoy! ''
     402[trac:TracTeam The Trac Team]
     405See also: [trac:TracInstallPlatforms TracInstallPlatforms], TracGuide, TracUpgrade, TracPermissions