Trac is being migrated to new services! Issues can be found in our new
YouTrack instance and WIKI pages can be found on our
website.
- Timestamp:
-
Oct 26, 2014, 6:01:55 PM (9 years ago)
- Author:
-
trac
- Comment:
-
--
Legend:
- Unmodified
- Added
- Removed
- Modified
-
v3
|
v4
|
|
1 | | = Installing Trac as CGI = |
| 1 | = Installing Trac as CGI |
2 | 2 | |
3 | | {{{ |
4 | | #!div class=important |
| 3 | {{{#!div class=important |
5 | 4 | ''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 | 5 | }}} |
7 | 6 | |
8 | 7 | 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: |
9 | | {{{ |
| 8 | {{{#!sh |
10 | 9 | trac-admin /path/to/env deploy /path/to/www/trac |
11 | 10 | }}} |
12 | 11 | `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 | 12 | |
14 | | == Apache web-server configuration == |
| 13 | == Apache web-server configuration |
15 | 14 | |
16 | 15 | In [http://httpd.apache.org/ Apache] there are two ways to run Trac as CGI: |
17 | 16 | |
18 | 17 | 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. |
| 18 | 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. |
20 | 19 | |
21 | 20 | 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: |
22 | | {{{ |
| 21 | {{{#!sh |
23 | 22 | ScriptAlias /trac /path/to/www/trac/cgi-bin/trac.cgi |
24 | 23 | }}} |
… |
… |
|
27 | 26 | |
28 | 27 | If you're using Trac with a single project you need to set its location using the `TRAC_ENV` environment variable: |
29 | | {{{ |
| 28 | {{{#!apache |
30 | 29 | <Location "/trac"> |
31 | 30 | SetEnv TRAC_ENV "/path/to/projectenv" |
… |
… |
|
34 | 33 | |
35 | 34 | Or to use multiple projects you can specify their common parent directory using the `TRAC_ENV_PARENT_DIR` variable: |
36 | | {{{ |
| 35 | {{{#!apache |
37 | 36 | <Location "/trac"> |
38 | 37 | SetEnv TRAC_ENV_PARENT_DIR "/path/to/project/parent/dir" |
… |
… |
|
42 | 41 | ''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 | 42 | |
44 | | {{{ |
| 43 | {{{#!python |
45 | 44 | import os |
46 | 45 | os.environ['TRAC_ENV'] = "/path/to/projectenv" |
… |
… |
|
49 | 48 | '' Or for TRAC_ENV_PARENT_DIR: '' |
50 | 49 | |
51 | | {{{ |
| 50 | {{{#!python |
52 | 51 | import os |
53 | 52 | os.environ['TRAC_ENV_PARENT_DIR'] = "/path/to/project/parent/dir" |
54 | 53 | }}} |
55 | 54 | |
56 | | If you are using the [http://httpd.apache.org/docs/suexec.html Apache suEXEC] feature please see [http://trac.edgewall.org/wiki/ApacheSuexec]. |
| 55 | If you are using the [http://httpd.apache.org/docs/suexec.html Apache suEXEC] feature please see [trac:ApacheSuexec]. |
57 | 56 | |
58 | 57 | 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). |
59 | 58 | |
60 | | === Using WSGI === |
| 59 | === Using WSGI |
61 | 60 | |
62 | 61 | You 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 | 62 | |
64 | | == Mapping Static Resources == |
| 63 | == Mapping Static Resources |
65 | 64 | |
66 | 65 | See TracInstall#MappingStaticResources. |
67 | 66 | |
68 | | == Adding Authentication == |
| 67 | == Adding Authentication |
69 | 68 | |
70 | 69 | See TracInstall#ConfiguringAuthentication. |
All information, including names and email addresses, entered onto this website or sent to mailing lists affiliated with this website will be public. Do not post confidential information, especially passwords!