Changes between Version 2 and Version 3 of TracCgi
- Timestamp:
- Aug 1, 2024, 10:29:35 AM (4 weeks ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracCgi
v2 v3 4 4 5 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.''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 7 }}} 8 8 9 CGI script is the entry point thatweb-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.9 CGI script is the entry point that the 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 10 11 11 == Apache web-server configuration 12 12 13 In [http ://httpd.apache.org/ Apache] there are two ways to run Trac as CGI:13 In [https://httpd.apache.org/ Apache] there are two ways to run Trac as CGI: 14 14 15 1. Use a `ScriptAlias` directive that maps a nURL 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.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 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:18 To make Trac available at `http://yourhost.example.org/trac` add `ScriptAlias` directive to your Apache configuration file, changing `trac.cgi` path to match your installation: 19 19 {{{#!apache 20 20 ScriptAlias /trac /path/to/www/trac/cgi-bin/trac.cgi 21 21 }}} 22 22 23 ''Note that this directive requires enabled `mod_alias` module.'' 23 '''Note''': this directive requires that the `mod_alias` module is enabled. 24 24 25 25 If you're using Trac with a single project you need to set its location using the `TRAC_ENV` environment variable: … … 37 37 }}} 38 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 ...":'' 39 '''Note''': 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`: 40 42 41 43 {{{#!python 42 import os43 44 os.environ['TRAC_ENV'] = "/path/to/projectenv" 44 45 }}} 45 46 46 '' Or for TRAC_ENV_PARENT_DIR: ''47 48 47 {{{#!python 49 import os 50 os.environ['TRAC_ENV_PARENT_DIR'] = "/path/to/project/parent/dir" 48 os.environ['TRAC_ENV_PARENT_DIR'] = "/path/to/parent/dir" 51 49 }}} 52 50 53 If you are using the [http ://httpd.apache.org/docs/suexec.html Apache suEXEC] feature please see [trac:ApacheSuexec].51 If you are using the [https://httpd.apache.org/docs/suexec.html Apache suEXEC] feature please see [trac:ApacheSuexec]. 54 52 55 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 Windows, configure the execution of 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 }}} 56 71 57 72 === Using WSGI 58 73 59 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.74 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. 60 75 61 76 == Mapping Static Resources … … 68 83 69 84 ---- 70 See also: Trac Guide, TracInstall, [wiki:TracModWSGI], TracFastCgi, TracModPython85 See also: TracInstall, [wiki:TracModWSGI], TracFastCgi, TracModPython