Installing Trac asCGI

CGI script is the entrypoint that web-server calls when a web-request to an application is made. Thetrac.cgi script can be created using thetrac-admin <env> deploy <dir> command which automatically substitutes the required paths, seeTracInstall#cgi-bin. Make sure the script is executable by your web server.

Apache web-server configuration

In​Apache there are two ways to run Trac asCGI:

1. Use aScriptAlias directive that maps aURL to thetrac.cgi script (recommended)
2. Copy thetrac.cgi file into the directory forCGI executables used by your web server (commonly namedcgi-bin). You can also create a symbolic link, but in that case make sure that theFollowSymLinks option is enabled for thecgi-bin directory.

To make Trac available athttp://yourhost.example.org/trac addScriptAlias directive to Apache configuration file, changingtrac.cgi path to match your installation:

ScriptAlias/trac/path/to/www/trac/cgi-bin/trac.cgi

Note that this directive requires that themod_alias module is enabled.

If you're using Trac with a single project you need to set its location using theTRAC_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 theTRAC_ENV_PARENT_DIR variable:

<Location"/trac">SetEnv TRAC_ENV_PARENT_DIR"/path/to/project/parent/dir"</Location>

Note that theSetEnv directive requires that themod_env module is enabled.

An alternative toSetEnv is editingTRAC_ENV orTRAC_ENV_PARENT_DIR intrac.cgi:

    os.environ['TRAC_ENV']="/path/to/projectenv"

    os.environ['TRAC_ENV_PARENT_DIR']="/path/to/parent/dir"

If you are using the​Apache suEXEC feature please see​ApacheSuexec.

On some systems, youmay need to edit the shebang line in thetrac.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).

Python Egg Cache

Theegg-cache can be configured using anos.environ statement intrac.cgi, as shown above.To do the same from the Apache configuration, use theSetEnv directive:

SetEnv PYTHON_EGG_CACHE/path/to/dir

Put this directive next to where you set the path to theTrac environment, i.e. in the same<Location> block.

<Location/trac>SetEnv TRAC_ENV/path/to/projenvSetEnv PYTHON_EGG_CACHE/path/to/dir</Location>

Using WSGI

You can run a​WSGI handler​under CGI. You canwrite your own application function, or use the deployed trac.wsgi's application.

Mapping Static Resources

SeeTracInstall#MappingStaticResources.

Adding Authentication

SeeTracInstall#ConfiguringAuthentication.

See also:TracInstall,TracModWSGI,TracFastCgi,TracModPython