This page documents the 1.2 (latest stable) release. See 1.0/TracEnvironment if you need the previous version.
The Trac Environment
Table of Contents
Trac uses a directory structure and a database for storing project data. The directory is referred to as the environment.
Creating an Environment
A new Trac environment is created using the initenv command:
$ trac-admin /path/to/myproject initenv
trac-admin will ask you for the name of the project and the database connection string.
- Place your environment's directory on a filesystem which supports sub-second timestamps, as Trac monitors the timestamp of its configuration files and changes happening on a filesystem with too coarse-grained timestamp resolution may go undetected in Trac < 1.0.2. This is also true for the location of authentication files when using TracStandalone.
- The user under which the web server runs will require file system write permission to the environment directory and all the files inside. Please remember to set the appropriate permissions. The same applies to the source code repository, although the user under which Trac runs will only require write access to a Subversion repository created with the BDB file system; for other repository types, check the corresponding plugin's documentation.
initenvdoes not create a version control repository for the specified path. If you wish to specify a default repository using the optional arguments to
initenvyou must create the repository first, otherwise you will see a message when initializing the environment: Warning: couldn't index the default repository.
- Non-ascii environment paths are not supported.
- TracPlugins located in a shared plugins directory that is defined in an inherited configuration are not enabled by default, in contrast to plugins in the environment
pluginsdirectory. Hence, if they need to create extra tables, for example, the tables will not be created during environment creation and you'll need to upgrade the environment. Alternatively you can avoid the need to upgrade the environment by explicitly enabling the plugin in the inherited configuration, or in a configuration file using the
--configoption. See TracAdmin#FullCommandReference for more information.
Database Connection Strings
You will need to specify a database connection string at the time the environment is created. The default is SQLite, which is sufficient for most projects. The SQLite database file is stored in the environment directory, and can easily be backed up together with the rest of the environment.
Note that if the username or password of the connection string (if applicable) contains the
@ characters, they need to be URL encoded.
$ python -c "import urllib; print urllib.quote('password@:/123', '')" password%40%3A%2F123
SQLite Connection String
The connection string for an SQLite database is:
db/trac.db is the path to the database file within the Trac environment.
PostgreSQL Connection String
The connection string for PostgreSQL is a bit more complex. For example, to connect to a PostgreSQL database named
localhost for user
johndoe and password
If PostgreSQL is running on a non-standard port, for example 9342, use:
On UNIX, you might want to select a UNIX socket for the transport, either the default socket as defined by the PGHOST environment variable:
or a specific one:
See the PostgreSQL documentation for detailed instructions on how to administer PostgreSQL.
Generally, the following is sufficient to create a database user named
tracuser and a database named
$ createuser -U postgres -E -P tracuser $ createdb -U postgres -O tracuser -E UTF8 trac
createuser you will be prompted for the password for the
tracuser. This new user will not be a superuser, will not be allowed to create other databases and will not be allowed to create other roles. These privileges are not needed to run a Trac instance. If no password is desired for the user, simply remove the
-E options from the
createuser command. Also note that the database should be created as UTF8. LATIN1 encoding causes errors, because of Trac's use of unicode.
Under some default configurations (Debian), run the
createdb scripts as the
$ sudo su - postgres -c 'createuser -U postgres -S -D -R -E -P tracuser' $ sudo su - postgres -c 'createdb -U postgres -O tracuser -E UTF8 trac'
Trac uses the
public schema by default, but you can specify a different schema in the connection string:
MySQL Connection String
The format of the MySQL connection string is similar to PostgreSQL, with the
postgres scheme being replaced by
mysql. For example, to connect to a MySQL database on
trac for user
johndoe with password
Source Code Repository
A single environment can be connected to more than one repository. However, by default Trac is not connected to any source code repository, and the Browse Source navigation item will not be displayed.
There are several ways to connect repositories to an environment, see TracRepositoryAdmin. A single repository can be specified when the environment is created by passing the optional arguments
repository_dir to the
An environment consists of the following files and directories:
README- Brief description of the environment.
VERSION- Environment version identifier.
attachments- Attachments to wiki pages and tickets.
trac.ini- Main configuration file.
trac.db- The SQLite database, if you are using SQLite.
htdocs- Directory containing web resources, which can be referenced in templates using the path
log- Default directory for log files when
filelogging is enabled and a relative path is given.
plugins- Environment-specific plugins.
templates- Custom Genshi environment-specific templates.
site.html- Method to customize the site header, footer, and style.