Changes between Version 1 and Version 2 of TracCgi


Ignore:
Timestamp:
Jun 9, 2024, 11:14:44 AM (5 months ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracCgi

    v1 v2  
    44
    55{{{#!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.''
    77}}}
    88
    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.
     9CGI 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.
    1010
    1111== Apache web-server configuration
    1212
    13 In [http://httpd.apache.org/ Apache] there are two ways to run Trac as CGI:
     13In [https://httpd.apache.org/ Apache] there are two ways to run Trac as CGI:
    1414
    15  1. Use a `ScriptAlias` directive that maps an 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.
     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.
    1717
    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:
     18To 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:
    1919{{{#!apache
    2020ScriptAlias /trac /path/to/www/trac/cgi-bin/trac.cgi
    2121}}}
    2222
    23  ''Note that this directive requires enabled `mod_alias` module.''
     23'''Note''': this directive requires that the `mod_alias` module is enabled.
    2424
    2525If you're using Trac with a single project you need to set its location using the `TRAC_ENV` environment variable:
    … …  
    3737}}}
    3838
    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
     41An alternative to `SetEnv` is editing `TRAC_ENV` or `TRAC_ENV_PARENT_DIR` in `trac.cgi`:
    4042
    4143{{{#!python
    42     import os
    4344    os.environ['TRAC_ENV'] = "/path/to/projectenv"
    4445}}}
    4546
    46  '' Or for TRAC_ENV_PARENT_DIR: ''
    47 
    4847{{{#!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"
    5149}}}
    5250
    53 If you are using the [http://httpd.apache.org/docs/suexec.html Apache suEXEC] feature please see [trac:ApacheSuexec].
     51If you are using the [https://httpd.apache.org/docs/suexec.html Apache suEXEC] feature please see [trac:ApacheSuexec].
    5452
    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).
     53On 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
     57The [TracInstall#egg-cache egg-cache] can be configured using an `os.environ` statement in `trac.cgi`, as shown above.
     58To do the same from the Apache configuration, use the `SetEnv` directive:
     59{{{#!apache
     60SetEnv PYTHON_EGG_CACHE /path/to/dir
     61}}}
     62
     63Put 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}}}
    5671
    5772=== Using WSGI
    5873
    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.
     74You 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.
    6075
    6176== Mapping Static Resources
    … …  
    6883
    6984----
    70 See also:  TracGuide, TracInstall, [wiki:TracModWSGI], TracFastCgi, TracModPython
     85See also:  TracInstall, [wiki:TracModWSGI], TracFastCgi, TracModPython