Changes between Version 2 and Version 3 of TracCgi


Ignore:
Timestamp:
05/30/11 20:19:36 (14 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracCgi

    v2 v3  
    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. 
     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.'' 
     6}}} 
    47 
    5   ''Please note that using Trac via CGI is significantly slower than any other deployment method, such as [TracModPython mod_python] or [TracFastCgi FastCGI].'' 
     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. 
    613 
    7 If you're using [http://httpd.apache.org/ Apache HTTPD], there are a couple ways to do that: 
     14== Apache web-server configuration == 
    815 
    9  1. Use a `ScriptAlias` to map a URL to the `trac.cgi` script 
     16In [http://httpd.apache.org/ Apache] there are two ways to run Trac as CGI: 
     17 
     18 1. Use a `ScriptAlias` directive that maps an URL to the `trac.cgi` script (recommended) 
    1019 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. 
    1120 
    12 The first option is recommended as it also allows you to map the CGI to a friendly URL. 
    13  
    14 Now, edit the Apache configuration file and add this snippet, file names and locations changed to match your installation: 
     21To make Trac available at `http://yourhost.example.org/trac` add `ScriptAlias` directive to Apache configuration file, changing `trac.cgi` path to match your installation: 
    1522{{{ 
    16 ScriptAlias /trac /usr/share/trac/cgi-bin/trac.cgi 
     23ScriptAlias /trac /path/to/www/trac/cgi-bin/trac.cgi 
    1724}}} 
    1825 
    19  ''Note that this directive requires the `mod_alias` module to be installed and enabled.'' 
     26 ''Note that this directive requires enabled `mod_alias` module.'' 
    2027 
    2128If you're using Trac with a single project you need to set its location using the `TRAC_ENV` environment variable: 
    … …  
    3340}}} 
    3441 
    35  ''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 ...":'' 
     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 ...":'' 
    3643 
    3744{{{ 
    … …  
    4754}}} 
    4855 
    49 This will make Trac available at `http://yourhost.example.org/trac`. 
    50  
    5156If you are using the [http://httpd.apache.org/docs/suexec.html Apache suEXEC] feature please see [http://trac.edgewall.org/wiki/ApacheSuexec]. 
    5257 
    … …  
    5560== Mapping Static Resources == 
    5661 
    57 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. 
     62Out 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. 
    5863 
    59 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. 
     64Web 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. 
    6065 
    61 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: 
     66There are two primary URL paths for static resources - `/chrome/common` and `/chrome/site`. Plugins can add their own resources usually accessible by `/chrome/plugin` path, so its important to override only known paths and not try to make universal `/chrome` alias for everything. 
     67 
     68Add the following snippet to Apache configuration '''before''' the `ScriptAlias` for the CGI script, changing paths to match your deployment: 
    6269{{{ 
    63 Alias /trac/chrome/common /usr/share/trac/htdocs 
    64 <Directory "/usr/share/trac/htdocs"> 
     70Alias /trac/chrome/common /path/to/trac/htdocs/common 
     71Alias /trac/chrome/site /path/to/trac/htdocs/site 
     72<Directory "/path/to/www/trac/htdocs"> 
    6573  Order allow,deny 
    6674  Allow from all 
    … …  
    6876}}} 
    6977 
    70 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.  
     78If using mod_python, you might want to add this too (otherwise, the alias will be ignored): 
     79{{{ 
     80<Location "/trac/chrome/common/"> 
     81  SetHandler None 
     82</Location> 
     83}}} 
     84 
     85Note 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.  
    7186 
    7287For 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`. 
    7388 
    74 Similarly, if you have static resources in a projects htdocs directory, you can configure apache to serve those resources (again, put this '''before''' the `ScriptAlias` for the CGI script, and adjust names and locations to match your installation): 
     89Similarly, if you have static resources in a project's htdocs directory (which is referenced by /chrome/site URL in themes), you can configure Apache to serve those resources (again, put this '''before''' the `ScriptAlias` for the CGI script, and adjust names and locations to match your installation): 
    7590 
    7691{{{ 
    … …  
    8297}}} 
    8398 
    84 Alternatively, you can set the `htdocs_location` configuration option in [wiki:TracIni trac.ini]: 
     99Alternatively to hacking `/trac/chrome/site`, you can directly specify path to static resources using `htdocs_location` configuration option in [wiki:TracIni trac.ini]: 
    85100{{{ 
    86101[trac] 
    87 htdocs_location = /trac-htdocs 
     102htdocs_location = http://yourhost.example.org/trac-htdocs 
    88103}}} 
    89104 
    90105Trac 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: 
    91106{{{ 
    92 $ ln -s /usr/share/trac/htdocs /var/www/your_site.com/htdocs/trac-htdocs 
     107$ ln -s /path/to/www/trac/htdocs /var/www/yourhost.example.org/trac-htdocs 
    93108}}} 
    94109 
    95 Note that in order to get this `htdocs` directory, you need first to extract the relevant Trac resources using the `copystatic` command of TracAdmin: 
    96 [[TracAdminHelp(copystatic)]] 
     110Note that in order to get this `htdocs` directory, you need first to extract the relevant Trac resources using the `deploy` command of TracAdmin: 
     111[[TracAdminHelp(deploy)]] 
    97112 
    98113 
    … …  
    139154}}} 
    140155 
    141 For 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. For example, on a Debian 4.0r1 (etch) system the relevant section  in apache configuration can look like this: 
     156For 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. For example, on a Debian 4.0r1 (etch) system the relevant section  in apache configuration can look like this: 
    142157{{{ 
    143158<Location "/trac/login"> 
    … …  
    146161    AuthName "trac" 
    147162    AuthDigestDomain /trac 
    148     AuthDigestFile /somewhere/trac.htpasswd 
     163    AuthUserFile /somewhere/trac.htpasswd 
    149164    Require valid-user 
    150165</Location> 
    … …  
    157172 
    158173---- 
    159 See also:  TracGuide, TracInstall, TracFastCgi, TracModPython 
     174See also:  TracGuide, TracInstall, [wiki:TracModWSGI], TracFastCgi, TracModPython