raw-wiki-dump/TracCgi.md


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70


Installing Trac as CGI
[[TracGuideToc]]
[[PageOutline]]
```#!div class=important
 ''Please note that using Trac via CGI is the slowest deployment method available. It is slower than [TracModPython mod_python], [TracFastCgi FastCGI] and even [trac:TracOnWindowsIisAjp IIS/AJP] on Windows.''
CGI script is the entrypoint that web-server calls when a web-request to an application is made. The `trac.cgi` script can be created using the `trac-admin <env> deploy <dir>` command which automatically substitutes the required paths, see TracInstall#cgi-bin. Make sure the script is executable by your web server.

## Apache web-server configuration

In [Apache](http://httpd.apache.org/) there are two ways to run Trac as CGI:

 1. Use a `ScriptAlias` directive that maps an URL to the `trac.cgi` script (recommended)
 1. Copy the `trac.cgi` file 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 `FollowSymLinks` option is enabled for the `cgi-bin` directory.

To make Trac available at `http://yourhost.example.org/trac` add `ScriptAlias` directive to Apache configuration file, changing `trac.cgi` path to match your installation:
```#!apache
ScriptAlias /trac /path/to/www/trac/cgi-bin/trac.cgi


Note that this directive requires enabled mod_alias module.
If you're using Trac with a single project you need to set its location using the TRAC_ENV environment variable:
```#!apache

  SetEnv TRAC_ENV "/path/to/projectenv"

Or to use multiple projects you can specify their common parent directory using the `TRAC_ENV_PARENT_DIR` variable:
```#!apache
<Location "/trac">
  SetEnv TRAC_ENV_PARENT_DIR "/path/to/project/parent/dir"
</Location>


Note that the SetEnv directive requires enabled mod_env module. It is also possible to set TRAC_ENV in trac.cgi. Just add the following code between "try:" and "from trac.web ...":
```#!python
    import os
    os.environ['TRAC_ENV'] = "/path/to/projectenv"
 * Or for TRAC_ENV_PARENT_DIR: *

```#!python
    import os
    os.environ['TRAC_ENV_PARENT_DIR'] = "/path/to/project/parent/dir"


If you are using the [Apache suEXEC] feature please see trac:ApacheSuexec.
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).
Using WSGI
You can run a [WSGI handler] [http://pythonweb.org/projects/webmodules/doc/0.5.3/html_multipage/lib/example-webserver-web-wsgi-simple-cgi.html under CGI].  You can wiki:TracModWSGI#Thetrac.wsgiscript write your own application function, or use the deployed trac.wsgi's application.
Mapping Static Resources
See TracInstall#MappingStaticResources.
Adding Authentication
See TracInstall#ConfiguringAuthentication.

See also:  TracGuide, TracInstall, [wiki:TracModWSGI], TracFastCgi, TracModPython