This page documents the 0.12 release. Documentation for other releases can be found here.
Installing Trac as CGI
CGI script is the entrypoint that web-server calls when a web-request to an application is made. To generate the
trac.cgi script run:
trac-admin /path/to/env deploy /path/to/www/trac
trac.cgi will be in the
cgi-bin folder inside the given path. Make sure it is executable by your web server. This command also copies
static resource files to a
htdocs directory of a given destination.
Apache web-server configuration
In Apache there are two ways to run Trac as CGI:
- Use a
ScriptAliasdirective that maps an URL to the
- Copy the
trac.cgifile into the directory for CGI executables used by your web server (commonly named
cgi-bin). You can also create a symbolic link, but in that case make sure that the
FollowSymLinksoption is enabled for the
To make Trac available at
ScriptAlias directive to Apache configuration file, changing
trac.cgi path to match your installation:
ScriptAlias /trac /path/to/www/trac/cgi-bin/trac.cgi
Note that this directive requires enabled
If you're using Trac with a single project you need to set its location using the
TRAC_ENV environment variable:
<Location "/trac"> SetEnv TRAC_ENV "/path/to/projectenv" </Location>
Or to use multiple projects you can specify their common parent directory using the
<Location "/trac"> SetEnv TRAC_ENV_PARENT_DIR "/path/to/project/parent/dir" </Location>
Note that the
SetEnvdirective requires enabled
mod_envmodule. It is also possible to set TRAC_ENV in trac.cgi. Just add the following code between "try:" and "from trac.web …":
import os os.environ['TRAC_ENV'] = "/path/to/projectenv"
Or for TRAC_ENV_PARENT_DIR:
import os os.environ['TRAC_ENV_PARENT_DIR'] = "/path/to/project/parent/dir"
On some systems, you may need to edit the shebang line in the
trac.cgi file to point to your real Python installation path. On a Windows system you may need to configure Windows to know how to execute a .cgi file (Explorer → Tools → Folder Options → File Types → CGI).