| 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 [wiki:TracModWSGI mod_wsgi], [TracModPython mod_python], [TracFastCgi FastCGI] and even [trac:TracOnWindowsIisAjp IIS/AJP] on Windows.'' |
| 7 | }}} |
| 8 | |
| 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. |
| 10 | |
| 11 | == Apache web-server configuration |
| 12 | |
| 13 | In [https://httpd.apache.org/ Apache] there are two ways to run Trac as CGI: |
| 14 | |
| 15 | 1. Use a `ScriptAlias` directive that maps a 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 | |
| 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: |
| 19 | {{{#!apache |
| 20 | ScriptAlias /trac /path/to/www/trac/cgi-bin/trac.cgi |
| 21 | }}} |
| 22 | |
| 23 | ''Note that this directive requires that the `mod_alias` module is enabled.'' |
| 24 | |
| 25 | If 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 | |
| 32 | Or 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 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 | |
| 43 | {{{#!python |
| 44 | os.environ['TRAC_ENV'] = "/path/to/projectenv" |
| 45 | }}} |
| 46 | |
| 47 | {{{#!python |
| 48 | os.environ['TRAC_ENV_PARENT_DIR'] = "/path/to/parent/dir" |
| 49 | }}} |
| 50 | |
| 51 | If you are using the [https://httpd.apache.org/docs/suexec.html Apache suEXEC] feature please see [trac:ApacheSuexec]. |
| 52 | |
| 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 | |
| 73 | |
| 74 | === Using WSGI |
| 75 | |
| 76 | You can run a [http://henry.precheur.org/python/how_to_serve_cgi WSGI handler] [https://thejimmyg.github.io/pythonweb/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. |
| 77 | |
| 78 | == Mapping Static Resources |
| 79 | |
| 80 | See TracInstall#MappingStaticResources. |
| 81 | |
| 82 | == Adding Authentication |
| 83 | |
| 84 | See TracInstall#ConfiguringAuthentication. |
| 85 | |
| 86 | ---- |
| 87 | See also: TracInstall, [wiki:TracModWSGI], TracFastCgi, TracModPython |