close
Warning:
Can't synchronize with repository "(default)" (The repository directory has changed, you should resynchronize the repository with: trac-admin $ENV repository resync '(default)'). Look in the Trac log for more information.
- Timestamp:
-
2018-05-12T08:27:23-07:00 (7 years ago)
- Author:
-
trac
- Comment:
-
--
Legend:
- Unmodified
- Added
- Removed
- Modified
-
v3
|
v4
|
|
1 | 1 | = Installing Trac as CGI |
| 2 | [[TracGuideToc]] |
| 3 | [[PageOutline]] |
2 | 4 | |
3 | 5 | {{{#!div class=important |
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 | ''Please note that using Trac via CGI is the slowest deployment method available. It is slower than [wiki:TracModWSGI mod_wsgi], [TracModPython mod_python], [TracFastCgi FastCGI] and even [trac:TracOnWindowsIisAjp IIS/AJP] on Windows.'' |
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: |
8 | | {{{#!sh |
9 | | trac-admin /path/to/env deploy /path/to/www/trac |
10 | | }}} |
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. |
| 9 | 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. |
12 | 10 | |
13 | 11 | == Apache web-server configuration |
… |
… |
|
15 | 13 | In [http://httpd.apache.org/ Apache] there are two ways to run Trac as CGI: |
16 | 14 | |
17 | | 1. Use a `ScriptAlias` directive that maps an URL to the `trac.cgi` script (recommended) |
| 15 | 1. Use a `ScriptAlias` directive that maps a URL to the `trac.cgi` script (recommended) |
18 | 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. |
19 | 17 | |
20 | 18 | 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: |
21 | | {{{#!sh |
| 19 | {{{#!apache |
22 | 20 | ScriptAlias /trac /path/to/www/trac/cgi-bin/trac.cgi |
23 | 21 | }}} |
24 | 22 | |
25 | | ''Note that this directive requires enabled `mod_alias` module.'' |
| 23 | ''Note that this directive requires that the `mod_alias` module is enabled.'' |
26 | 24 | |
27 | 25 | If you're using Trac with a single project you need to set its location using the `TRAC_ENV` environment variable: |
… |
… |
|
39 | 37 | }}} |
40 | 38 | |
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 ...":'' |
| 39 | ''Note that the `SetEnv` directive requires that the `mod_env` module is enabled.'' |
| 40 | |
| 41 | An alternative to `SetEnv` is editing `TRAC_ENV` or `TRAC_ENV_PARENT_DIR` in `trac.cgi`: |
42 | 42 | |
43 | 43 | {{{#!python |
44 | | import os |
45 | 44 | os.environ['TRAC_ENV'] = "/path/to/projectenv" |
46 | 45 | }}} |
47 | 46 | |
48 | | '' Or for TRAC_ENV_PARENT_DIR: '' |
49 | | |
50 | 47 | {{{#!python |
51 | | import os |
52 | | os.environ['TRAC_ENV_PARENT_DIR'] = "/path/to/project/parent/dir" |
| 48 | os.environ['TRAC_ENV_PARENT_DIR'] = "/path/to/parent/dir" |
53 | 49 | }}} |
54 | 50 | |
55 | 51 | If you are using the [http://httpd.apache.org/docs/suexec.html Apache suEXEC] feature please see [trac:ApacheSuexec]. |
56 | 52 | |
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). |
| 53 | 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). |
| 54 | |
| 55 | === Python Egg Cache |
| 56 | |
| 57 | The [TracInstall#egg-cache egg-cache] can be configured using an `os.environ` statement in `trac.cgi`, as shown above. |
| 58 | To do the same from the Apache configuration, use the `SetEnv` directive: |
| 59 | {{{#!apache |
| 60 | SetEnv PYTHON_EGG_CACHE /path/to/dir |
| 61 | }}} |
| 62 | |
| 63 | Put this directive next to where you set the path to the [TracEnvironment Trac environment], i.e. in the same `<Location>` block. |
| 64 | |
| 65 | {{{#!apache |
| 66 | <Location /trac> |
| 67 | SetEnv TRAC_ENV /path/to/projenv |
| 68 | SetEnv PYTHON_EGG_CACHE /path/to/dir |
| 69 | </Location> |
| 70 | }}} |
| 71 | |
| 72 | |
58 | 73 | |
59 | 74 | === Using WSGI |
… |
… |
|
70 | 85 | |
71 | 86 | ---- |
72 | | See also: TracGuide, TracInstall, [wiki:TracModWSGI], TracFastCgi, TracModPython |
| 87 | See also: TracInstall, [wiki:TracModWSGI], TracFastCgi, TracModPython |