Changes between Version 5 and Version 6 of TracCgi


Ignore:
Timestamp:
Jan 12, 2016, 11:21:52 PM (4 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracCgi

    v5 v6  
    1 = Installing Trac as CGI
    2 [[TracGuideToc]]
    3 [[PageOutline]]
     1= Installing Trac as CGI =
    42
    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.''
     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.''
    76}}}
    87
    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.
     8CGI 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{{{
     10trac-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.
    1013
    11 == Apache web-server configuration
     14== Apache web-server configuration ==
    1215
    1316In [http://httpd.apache.org/ Apache] there are two ways to run Trac as CGI:
    1417
    1518 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.
     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.
    1720
    1821To 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
     22{{{
    2023ScriptAlias /trac /path/to/www/trac/cgi-bin/trac.cgi
    2124}}}
     
    2427
    2528If you're using Trac with a single project you need to set its location using the `TRAC_ENV` environment variable:
    26 {{{#!apache
     29{{{
    2730<Location "/trac">
    2831  SetEnv TRAC_ENV "/path/to/projectenv"
     
    3134
    3235Or to use multiple projects you can specify their common parent directory using the `TRAC_ENV_PARENT_DIR` variable:
    33 {{{#!apache
     36{{{
    3437<Location "/trac">
    3538  SetEnv TRAC_ENV_PARENT_DIR "/path/to/project/parent/dir"
     
    3942 ''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 ...":''
    4043
    41 {{{#!python
     44{{{
    4245    import os
    4346    os.environ['TRAC_ENV'] = "/path/to/projectenv"
     
    4649 '' Or for TRAC_ENV_PARENT_DIR: ''
    4750
    48 {{{#!python
     51{{{
    4952    import os
    5053    os.environ['TRAC_ENV_PARENT_DIR'] = "/path/to/project/parent/dir"
    5154}}}
    5255
    53 If you are using the [http://httpd.apache.org/docs/suexec.html Apache suEXEC] feature please see [trac:ApacheSuexec].
     56If you are using the [http://httpd.apache.org/docs/suexec.html Apache suEXEC] feature please see [http://trac.edgewall.org/wiki/ApacheSuexec].
    5457
    5558On 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).
    5659
    57 === Using WSGI
     60=== Using WSGI ===
    5861
    5962You 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.
    6063
    61 == Mapping Static Resources
     64== Mapping Static Resources ==
    6265
    6366See TracInstall#MappingStaticResources.
    6467
    65 == Adding Authentication
     68== Adding Authentication ==
    6669
    6770See TracInstall#ConfiguringAuthentication.