Changes between Version 1 and Version 2 of TracCgi


Ignore:
Timestamp:
Jul 17, 2007, 12:09:41 PM (17 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracCgi

    v1 v2  
    11= Installing Trac as CGI =
    22
    3 To install Trac as a CGI script, you need to make the `trac.cgi` executable as a CGI by your web server. If you're using [http://httpd.apache.org/ Apache HTTPD], there are a couple ways to do that:
     3To install Trac as a CGI script, you need to make the `trac.cgi` executable as a CGI by your web server.
     4
     5  ''Please note that using Trac via CGI is significantly slower than any other deployment method, such as [TracModPython mod_python] or [TracFastCgi FastCGI].''
     6
     7If you're using [http://httpd.apache.org/ Apache HTTPD], there are a couple ways to do that:
    48
    59 1. Use a `ScriptAlias` to map a URL to the `trac.cgi` script
    … …  
    1115{{{
    1216ScriptAlias /trac /usr/share/trac/cgi-bin/trac.cgi
     17}}}
    1318
    14 # Trac needs to know where the database is located
     19 ''Note that this directive requires the `mod_alias` module to be installed and enabled.''
     20
     21If you're using Trac with a single project you need to set its location using the `TRAC_ENV` environment variable:
     22{{{
    1523<Location "/trac">
    1624  SetEnv TRAC_ENV "/path/to/projectenv"
    … …  
    1826}}}
    1927
     28Or to use multiple projects you can specify their common parent directory using the `TRAC_ENV_PARENT_DIR` variable:
     29{{{
     30<Location "/trac">
     31  SetEnv TRAC_ENV_PARENT_DIR "/path/to/project/parent/dir"
     32</Location>
     33}}}
     34
     35 ''Note that the `SetEnv` directive requires the `mod_env` module to be installed and enable.''
     36
    2037This will make Trac available at `http://yourhost.example.org/trac`.
    2138
    22  ''Note: Make sure that the modules mod_alias and mod_env modules are available and enabled in your Apache configuration, otherwise Apache will complain about the above snippet.''
     39If you are using the [http://httpd.apache.org/docs/suexec.html Apache suEXEC] feature please see [http://trac.edgewall.org/wiki/ApacheSuexec].
    2340
    24  ''Note: If you are using the [http://httpd.apache.org/docs/suexec.html Apache suEXEC] feature see [http://projects.edgewall.com/trac/wiki/ApacheSuexec ApacheSuexec] (on the main Trac site).''
     41On 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).
    2542
    2643== Mapping Static Resources ==
    2744
    28 Out of the box, Trac will serve static resources such as style sheets or images itself. For a CGI setup, though, this is highly undesirable, because it results in the CGI script being invoked for documents that could be more efficiently served by the web server.
     45Out of the box, Trac will serve static resources such as style sheets or images itself. For a CGI setup, though, this is highly undesirable, because it results in the CGI script being invoked for documents that could be much more efficiently served by the web server directly.
    2946
    3047Web servers such as [http://httpd.apache.org/ Apache HTTPD] allow you to create “Aliases” to resources, thereby giving them a virtual URL that doesn't necessarily bear any resemblance to the layout of the servers file system. We already used this capability above when defining a `ScriptAlias` for the CGI script, and we'll use it now to map requests to the static resources to the directory on the file system that contains them, thereby bypassing the processing of such requests by the CGI script.
    … …  
    4966}}}
    5067
    51 Trac will then use this URL when embedding static resources into HTML pages. Of course, you still need to make the Trac `htdocs` directory available through the web server at the specified URL, for example by copying (or linking) the directory into the document root of the web server.
     68Trac will then use this URL when embedding static resources into HTML pages. Of course, you still need to make the Trac `htdocs` directory available through the web server at the specified URL, for example by copying (or linking) the directory into the document root of the web server:
     69{{{
     70$ ln -s /usr/share/trac/htdocs /var/www/your_site.com/htdocs/trac-htdocs
     71}}}
    5272
    5373== Adding Authentication ==
    … …  
    7595Now, you'll need to enable authentication against the password file in the Apache configuration:
    7696{{{
    77 <Location "/cgi-bin/trac.cgi/login">
     97<Location "/trac/login">
    7898  AuthType Basic
    7999  AuthName "Trac"
    … …  
    83103}}}
    84104
     105If you're hosting multiple projects you can use the same password file for all of them:
     106{{{
     107<LocationMatch "/trac/[^/]+/login">
     108  AuthType Basic
     109  AuthName "Trac"
     110  AuthUserFile /somewhere/trac.htpasswd
     111  Require valid-user
     112</LocationMatch>
     113}}}
     114
    85115For better security, it is recommended that you either enable SSL or at least use the “Digest” authentication scheme instead of “Basic”. Please read the [http://httpd.apache.org/docs/2.0/ Apache HTTPD documentation] to find out more.
    86116