source: wiki/pages/TracCgi @ 26484

Last change on this file since 26484 was 26484, checked in by obi, 8 years ago

add wiki pages

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