source: wiki/pages/TracCgi @ 37371

Last change on this file since 37371 was 37343, checked in by aafsvn, 6 years ago

[titan] autoupdate wiki files

File size: 3.1 KB
Line 
1= Installing Trac as CGI
2[[TracGuideToc]]
3[[PageOutline]]
4
5{{{#!div class=important
6 ''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.''
7}}}
8
9CGI 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.
10
11== Apache web-server configuration
12
13In [http://httpd.apache.org/ Apache] there are two ways to run Trac as CGI:
14
15 1. Use a `ScriptAlias` directive that maps an URL to the `trac.cgi` script (recommended)
16 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.
17
18To make Trac available at `http://yourhost.example.org/trac` add `ScriptAlias` directive to Apache configuration file, changing `trac.cgi` path to match your installation:
19{{{#!apache
20ScriptAlias /trac /path/to/www/trac/cgi-bin/trac.cgi
21}}}
22
23 ''Note that this directive requires enabled `mod_alias` module.''
24
25If you're using Trac with a single project you need to set its location using the `TRAC_ENV` environment variable:
26{{{#!apache
27<Location "/trac">
28  SetEnv TRAC_ENV "/path/to/projectenv"
29</Location>
30}}}
31
32Or to use multiple projects you can specify their common parent directory using the `TRAC_ENV_PARENT_DIR` variable:
33{{{#!apache
34<Location "/trac">
35  SetEnv TRAC_ENV_PARENT_DIR "/path/to/project/parent/dir"
36</Location>
37}}}
38
39 ''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 ...":''
40
41{{{#!python
42    import os
43    os.environ['TRAC_ENV'] = "/path/to/projectenv"
44}}}
45
46 '' Or for TRAC_ENV_PARENT_DIR: ''
47
48{{{#!python
49    import os
50    os.environ['TRAC_ENV_PARENT_DIR'] = "/path/to/project/parent/dir"
51}}}
52
53If you are using the [http://httpd.apache.org/docs/suexec.html Apache suEXEC] feature please see [trac:ApacheSuexec].
54
55On 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).
56
57=== Using WSGI
58
59You can run a [http://henry.precheur.org/python/how_to_serve_cgi 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.
60
61== Mapping Static Resources
62
63See TracInstall#MappingStaticResources.
64
65== Adding Authentication
66
67See TracInstall#ConfiguringAuthentication.
68
69----
70See also:  TracGuide, TracInstall, [wiki:TracModWSGI], TracFastCgi, TracModPython
Note: See TracBrowser for help on using the repository browser.