Changes between Version 1 and Version 2 of TracCgi


Ignore:
Timestamp:
Apr 13, 2011, 8:59:31 PM (14 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:
     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  1. Use a `ScriptAlias` to map a URL to the `trac.cgi` script
     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.
     13
     14== Apache web-server configuration ==
     15
     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)
    619 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.
    720
    8 The first option is recommended as it also allows you to map the CGI to a friendly URL.
     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:
     22{{{
     23ScriptAlias /trac /path/to/www/trac/cgi-bin/trac.cgi
     24}}}
    925
    10 Now, edit the Apache configuration file and add this snippet, file names and locations changed to match your installation:
     26 ''Note that this directive requires enabled `mod_alias` module.''
     27
     28If you're using Trac with a single project you need to set its location using the `TRAC_ENV` environment variable:
    1129{{{
    12 ScriptAlias /trac /usr/share/trac/cgi-bin/trac.cgi
    13 
    14 # Trac needs to know where the database is located
    1530<Location "/trac">
    1631  SetEnv TRAC_ENV "/path/to/projectenv"
    … …  
    1833}}}
    1934
    20 This will make Trac available at `http://yourhost.example.org/trac`.
     35Or to use multiple projects you can specify their common parent directory using the `TRAC_ENV_PARENT_DIR` variable:
     36{{{
     37<Location "/trac">
     38  SetEnv TRAC_ENV_PARENT_DIR "/path/to/project/parent/dir"
     39</Location>
     40}}}
    2141
    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.''
     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 ...":''
    2343
    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).''
     44{{{
     45    import os
     46    os.environ['TRAC_ENV'] = "/path/to/projectenv"
     47}}}
     48
     49 '' Or for TRAC_ENV_PARENT_DIR: ''
     50
     51{{{
     52    import os
     53    os.environ['TRAC_ENV_PARENT_DIR'] = "/path/to/project/parent/dir"
     54}}}
     55
     56If you are using the [http://httpd.apache.org/docs/suexec.html Apache suEXEC] feature please see [http://trac.edgewall.org/wiki/ApacheSuexec].
     57
     58On 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).
    2559
    2660== Mapping Static Resources ==
    2761
    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.
     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.
    2963
    30 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.
    3165
    32 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:
    3369{{{
    34 Alias /trac/chrome/common /usr/share/trac/htdocs
    35 <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">
    3673  Order allow,deny
    3774  Allow from all
    … …  
    3976}}}
    4077
    41 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.
    4286
    4387For 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`.
    4488
    45 Alternatively, you can set the `htdocs_location` configuration option in [wiki:TracIni trac.ini]:
     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):
     90
     91{{{
     92Alias /trac/chrome/site /path/to/projectenv/htdocs
     93<Directory "/path/to/projectenv/htdocs">
     94  Order allow,deny
     95  Allow from all
     96</Directory>
     97}}}
     98
     99Alternatively to hacking `/trac/chrome/site`, you can directly specify path to static resources using `htdocs_location` configuration option in [wiki:TracIni trac.ini]:
    46100{{{
    47101[trac]
    48 htdocs_location = /trac-htdocs
     102htdocs_location = http://yourhost.example.org/trac-htdocs
    49103}}}
    50104
    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.
     105Trac 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:
     106{{{
     107$ ln -s /path/to/www/trac/htdocs /var/www/yourhost.example.org/trac-htdocs
     108}}}
     109
     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)]]
     112
    52113
    53114== Adding Authentication ==
    … …  
    75136Now, you'll need to enable authentication against the password file in the Apache configuration:
    76137{{{
    77 <Location "/cgi-bin/trac.cgi/login">
     138<Location "/trac/login">
    78139  AuthType Basic
    79140  AuthName "Trac"
    … …  
    83144}}}
    84145
    85 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.
     146If you're hosting multiple projects you can use the same password file for all of them:
     147{{{
     148<LocationMatch "/trac/[^/]+/login">
     149  AuthType Basic
     150  AuthName "Trac"
     151  AuthUserFile /somewhere/trac.htpasswd
     152  Require valid-user
     153</LocationMatch>
     154}}}
     155
     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:
     157{{{
     158<Location "/trac/login">
     159    LoadModule auth_digest_module /usr/lib/apache2/modules/mod_auth_digest.so
     160    AuthType Digest
     161    AuthName "trac"
     162    AuthDigestDomain /trac
     163    AuthUserFile /somewhere/trac.htpasswd
     164    Require valid-user
     165</Location>
     166}}}
     167and you'll have to create your .htpasswd file with htdigest instead of htpasswd as follows:
     168{{{
     169# htdigest /somewhere/trac.htpasswd trac admin
     170}}}
     171where the "trac" parameter above is the same as !AuthName above  ("Realm" in apache-docs).
    86172
    87173----
    88 See also:  TracGuide, TracInstall, TracFastCgi, TracModPython
     174See also:  TracGuide, TracInstall, [wiki:TracModWSGI], TracFastCgi, TracModPython