Changes between Version 2 and Version 3 of TracCgi


Ignore:
Timestamp:
Jan 30, 2018 2:16:51 PM (7 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracCgi

    v2 v3  
    1 = Installing Trac as CGI = 
     1= Installing Trac as CGI 
     2[[TracGuideToc]] 
     3[[PageOutline]] 
    24 
    3 {{{ 
    4 #!div class=important 
    5   ''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.'' 
     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.'' 
    67}}} 
    78 
    8 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 {{{ 
    10 trac-admin /path/to/env deploy /path/to/www/trac 
    11 }}} 
    12 `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. 
     9CGI 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. 
    1310 
    14 == Apache web-server configuration == 
     11== Apache web-server configuration 
    1512 
    1613In [http://httpd.apache.org/ Apache] there are two ways to run Trac as CGI: 
    1714 
    18  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. 
     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. 
    2017 
    2118To 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 {{{ 
     19{{{#!apache 
    2320ScriptAlias /trac /path/to/www/trac/cgi-bin/trac.cgi 
    2421}}} 
    2522 
    26  ''Note that this directive requires enabled `mod_alias` module.'' 
     23 ''Note that this directive requires that the `mod_alias` module is enabled.'' 
    2724 
    2825If you're using Trac with a single project you need to set its location using the `TRAC_ENV` environment variable: 
    29 {{{ 
     26{{{#!apache 
    3027<Location "/trac"> 
    3128  SetEnv TRAC_ENV "/path/to/projectenv" 
    … …  
    3431 
    3532Or to use multiple projects you can specify their common parent directory using the `TRAC_ENV_PARENT_DIR` variable: 
    36 {{{ 
     33{{{#!apache 
    3734<Location "/trac"> 
    3835  SetEnv TRAC_ENV_PARENT_DIR "/path/to/project/parent/dir" 
    … …  
    4037}}} 
    4138 
    42  ''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.'' 
    4340 
    44 {{{ 
    45     import os 
     41An alternative to `SetEnv` is editing `TRAC_ENV` or `TRAC_ENV_PARENT_DIR` in `trac.cgi`: 
     42 
     43{{{#!python 
    4644    os.environ['TRAC_ENV'] = "/path/to/projectenv" 
    4745}}} 
    4846 
    49  '' Or for TRAC_ENV_PARENT_DIR: '' 
    50  
    51 {{{ 
    52     import os 
    53     os.environ['TRAC_ENV_PARENT_DIR'] = "/path/to/project/parent/dir" 
     47{{{#!python 
     48    os.environ['TRAC_ENV_PARENT_DIR'] = "/path/to/parent/dir" 
    5449}}} 
    5550 
    56 If you are using the [http://httpd.apache.org/docs/suexec.html Apache suEXEC] feature please see [http://trac.edgewall.org/wiki/ApacheSuexec]. 
     51If you are using the [http://httpd.apache.org/docs/suexec.html Apache suEXEC] feature please see [trac:ApacheSuexec]. 
    5752 
    58 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 a Windows system you may need to configure Windows to know how to execute a `.cgi` file (Explorer -> Tools -> Folder Options -> File Types -> CGI). 
    5954 
    60 === Using WSGI === 
     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}}} 
     71 
     72 
     73 
     74=== Using WSGI 
    6175 
    6276You 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. 
    6377 
    64 == Mapping Static Resources == 
     78== Mapping Static Resources 
    6579 
    6680See TracInstall#MappingStaticResources. 
    6781 
    68 == Adding Authentication == 
     82== Adding Authentication 
    6983 
    7084See TracInstall#ConfiguringAuthentication. 
    7185 
    7286---- 
    73 See also:  TracGuide, TracInstall, [wiki:TracModWSGI], TracFastCgi, TracModPython 
     87See also:  TracInstall, [wiki:TracModWSGI], TracFastCgi, TracModPython