Edgewall Software

Changes between Version 41 and Version 42 of TracCgi


Ignore:
Timestamp:
Sep 23, 2009, 10:30:04 AM (15 years ago)
Author:
anatoly techtonik <techtonik@…>
Comment:

add reference to deploy procedure, cleanup a bit

Legend:

Unmodified
Added
Removed
Modified

  • TracCgi

    v41 v42  
    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.
     3When installing Trac as a CGI script, make sure `trac.cgi` is executable by your web server.
    44
    55{{{
    66#!div class=important
    7   ''Please note that using Trac via CGI is significantly slower than any other deployment method, such as [TracModPython mod_python] or [TracFastCgi FastCGI] or even [trac:TracOnWindowsIisAjp IIS/AJP] on Windows.''
     7  ''Please note that using Trac via CGI is the slowest deployment method available. It slower than [TracModPython mod_python], [TracFastCgi FastCGI] or even [trac:TracOnWindowsIisAjp IIS/AJP] on Windows.''
    88}}}
    99
    10 If you're using [http://httpd.apache.org/ Apache HTTPD], there are a couple ways to do that:
     10CGI script is the entrypoint that web-server calls when a web-request to an application is made. To generate the `trac.cgi` script run:
     11{{{
     12trac-admin /path/to/env deploy /path/to/www/trac
     13}}}
     14It will be in the `cgi-bin` folder inside the given path. This also copies `static resource` files to a `htdocs` directory of a given destination.
    1115
    12  1. Use a `ScriptAlias` to map a URL to the `trac.cgi` script
    13  2. Copy the `trac.cgi` file into the directory for CGI executables used by your web server (commonly named `cgi-bin`). A word of warning, copying the file directly from the repository onto a windows server 2003 machine created difficulties. Rather create a new text file and cut and copy the text into the newly created file. You can also create a symbolic link, but in that case make sure that the `FollowSymLinks` option is enabled for the `cgi-bin` directory.
     16== Apache web-server configuration ==
    1417
    15 The first option is recommended as it also allows you to map the CGI to a friendly URL.
     18In [http://httpd.apache.org/ Apache] there are two ways to run Trac as CGI:
    1619
    17 Now, edit the Apache configuration file and add this snippet, file names and locations changed to match your installation:
     20 1. Use a `ScriptAlias` directive that maps an URL to the `trac.cgi` script (recommended)
     21 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.
     22
     23To make Trac available at `http://yourhost.example.org/trac` add `ScriptAlias` directive to Apache configuration file, changing `trac.cgi` path to match your installation:
    1824{{{
    19 ScriptAlias /trac /usr/share/trac/cgi-bin/trac.cgi
     25ScriptAlias /trac /path/to/www/trac/cgi-bin/trac.cgi
    2026}}}
    2127
    22  ''Note that this directive requires the `mod_alias` module to be installed and enabled.''
     28 ''Note that this directive requires enabled `mod_alias` module.''
    2329
    2430If you're using Trac with a single project you need to set its location using the `TRAC_ENV` environment variable:
    … …  
    3642}}}
    3743
    38  ''Note that the `SetEnv` directive requires the `mod_env` module to be installed and enable. If not, you could set TRAC_ENV in trac.cgi. Just add the following code between "try:" and "from trac.web ...":''
     44 ''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 ...":''
    3945
    4046{{{
    … …  
    5056}}}
    5157
    52 This will make Trac available at `http://yourhost.example.org/trac`.
    53 
    5458If you are using the [http://httpd.apache.org/docs/suexec.html Apache suEXEC] feature please see [http://trac.edgewall.org/wiki/ApacheSuexec].
    5559
    … …  
    5862== Mapping Static Resources ==
    5963
    60 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 much more efficiently served by the web server directly.
     64Out of the box, Trac will pass static resources such as style sheets or images through itself. For a CGI setup this is '''highly undesirable''', because this way CGI script is invoked for documents that could be much more efficiently served directly by web server.
    6165
    62 Web 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.
     66Web servers such as [http://httpd.apache.org/ Apache] allow you to create “Aliases” to resources, giving them a virtual URL that doesn't necessarily reflect the layout of the servers file system. We already used this capability by defining a `ScriptAlias` for the CGI script. We also can map requests for static resources directly to the directory on the file system, avoiding processing these requests by CGI script.
    6367
    64 Edit the Apache configuration file again and add the following snippet '''before''' the `ScriptAlias` for the CGI script , file names and locations changed to match your installation:
     68Add the following snippet to Apache configuration '''before''' the `ScriptAlias` for the CGI script, changing paths to match your deployment:
    6569{{{
    66 Alias /trac/chrome/common /usr/share/trac/htdocs
    67 <Directory "/usr/share/trac/htdocs">
     70Alias /trac/chrome/common /path/to/www/trac/htdocs
     71<Directory "/path/to/www/trac/htdocs">
    6872  Order allow,deny
    6973  Allow from all
    … …  
    7175}}}
    7276
    73 Note that whatever URL path you mapped the `trac.cgi` script to, the path `/chrome/common` is the path you have to append to that location to intercept requests to the static resources.
     77Note that we mapped `/trac` part of the URL to the `trac.cgi` script, and the path `/chrome/common` is the path you have to append to that location to intercept requests to the static resources.
    7478
    7579For example, if Trac is mapped to `/cgi-bin/trac.cgi` on your server, the URL of the Alias should be `/cgi-bin/trac.cgi/chrome/common`.