Changes between Initial Version and Version 1 of TracCgi

Feb 7, 2016, 1:07:44 AM (2 years ago)



  • TracCgi

    v1 v1  
     1= Installing Trac as CGI
     3{{{#!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.''
     7CGI script is the entrypoint that web-server calls when a web-request to an application is made. To generate the `trac.cgi` script run:
     9trac-admin /path/to/env deploy /path/to/www/trac
     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.
     13== Apache web-server configuration
     15In [ Apache] there are two ways to run Trac as CGI:
     17 1. Use a `ScriptAlias` directive that maps an URL to the `trac.cgi` script (recommended)
     18 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.
     20To make Trac available at `` add `ScriptAlias` directive to Apache configuration file, changing `trac.cgi` path to match your installation:
     22ScriptAlias /trac /path/to/www/trac/cgi-bin/trac.cgi
     25 ''Note that this directive requires enabled `mod_alias` module.''
     27If you're using Trac with a single project you need to set its location using the `TRAC_ENV` environment variable:
     29<Location "/trac">
     30  SetEnv TRAC_ENV "/path/to/projectenv"
     34Or to use multiple projects you can specify their common parent directory using the `TRAC_ENV_PARENT_DIR` variable:
     36<Location "/trac">
     37  SetEnv TRAC_ENV_PARENT_DIR "/path/to/project/parent/dir"
     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 ...":''
     44    import os
     45    os.environ['TRAC_ENV'] = "/path/to/projectenv"
     48 '' Or for TRAC_ENV_PARENT_DIR: ''
     51    import os
     52    os.environ['TRAC_ENV_PARENT_DIR'] = "/path/to/project/parent/dir"
     55If you are using the [ Apache suEXEC] feature please see [trac:ApacheSuexec].
     57On 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).
     59=== Using WSGI
     61You can run a [ WSGI handler] [ under CGI].  You can [wiki:TracModWSGI#Thetrac.wsgiscript write your own application function], or use the deployed trac.wsgi's application.
     63== Mapping Static Resources
     65See TracInstall#MappingStaticResources.
     67== Adding Authentication
     69See TracInstall#ConfiguringAuthentication.
     72See also:  TracGuide, TracInstall, [wiki:TracModWSGI], TracFastCgi, TracModPython