Changes between Version 1 and Version 2 of TracCgi


Ignore:
Timestamp:
Nov 19, 2009, 3:10:44 PM (15 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{{{
     6#!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.''
     8}}}
     9
     10If you're using [http://httpd.apache.org/ Apache HTTPD], there are a couple ways to do that:
    411
    512 1. Use a `ScriptAlias` to map a URL to the `trac.cgi` script
    6  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.
     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.
    714
    815The first option is recommended as it also allows you to map the CGI to a friendly URL.
    … …  
    1118{{{
    1219ScriptAlias /trac /usr/share/trac/cgi-bin/trac.cgi
     20}}}
    1321
    14 # Trac needs to know where the database is located
     22 ''Note that this directive requires the `mod_alias` module to be installed and enabled.''
     23
     24If you're using Trac with a single project you need to set its location using the `TRAC_ENV` environment variable:
     25{{{
    1526<Location "/trac">
    1627  SetEnv TRAC_ENV "/path/to/projectenv"
    … …  
    1829}}}
    1930
     31Or to use multiple projects you can specify their common parent directory using the `TRAC_ENV_PARENT_DIR` variable:
     32{{{
     33<Location "/trac">
     34  SetEnv TRAC_ENV_PARENT_DIR "/path/to/project/parent/dir"
     35</Location>
     36}}}
     37
     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 ...":''
     39
     40{{{
     41    import os
     42    os.environ['TRAC_ENV'] = "/path/to/projectenv"
     43}}}
     44
     45 '' Or for TRAC_ENV_PARENT_DIR: ''
     46
     47{{{
     48    import os
     49    os.environ['TRAC_ENV_PARENT_DIR'] = "/path/to/project/parent/dir"
     50}}}
     51
    2052This will make Trac available at `http://yourhost.example.org/trac`.
    2153
    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.''
     54If you are using the [http://httpd.apache.org/docs/suexec.html Apache suEXEC] feature please see [http://trac.edgewall.org/wiki/ApacheSuexec].
    2355
    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).''
     56On 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).
    2557
    2658== Mapping Static Resources ==
    2759
    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.
     60Out 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.
    2961
    3062Web 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.
    … …  
    4375For 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`.
    4476
     77Similarly, 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):
     78
     79{{{
     80Alias /trac/chrome/site /path/to/projectenv/htdocs
     81<Directory "/path/to/projectenv/htdocs">
     82  Order allow,deny
     83  Allow from all
     84</Directory>
     85}}}
     86
    4587Alternatively, you can set the `htdocs_location` configuration option in [wiki:TracIni trac.ini]:
    4688{{{
    … …  
    4991}}}
    5092
    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.
     93Trac 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:
     94{{{
     95$ ln -s /usr/share/trac/htdocs /var/www/your_site.com/htdocs/trac-htdocs
     96}}}
     97
     98Note that in order to get this `htdocs` directory, you need first to extract the relevant Trac resources using the `deploy` command of TracAdmin:
     99[[TracAdminHelp(deploy)]]
     100
    52101
    53102== Adding Authentication ==
    … …  
    75124Now, you'll need to enable authentication against the password file in the Apache configuration:
    76125{{{
    77 <Location "/cgi-bin/trac.cgi/login">
     126<Location "/trac/login">
    78127  AuthType Basic
    79128  AuthName "Trac"
    … …  
    83132}}}
    84133
    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.
     134If you're hosting multiple projects you can use the same password file for all of them:
     135{{{
     136<LocationMatch "/trac/[^/]+/login">
     137  AuthType Basic
     138  AuthName "Trac"
     139  AuthUserFile /somewhere/trac.htpasswd
     140  Require valid-user
     141</LocationMatch>
     142}}}
     143
     144For 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:
     145{{{
     146<Location "/trac/login">
     147    LoadModule auth_digest_module /usr/lib/apache2/modules/mod_auth_digest.so
     148    AuthType Digest
     149    AuthName "trac"
     150    AuthDigestDomain /trac
     151    AuthUserFile /somewhere/trac.htpasswd
     152    Require valid-user
     153</Location>
     154}}}
     155and you'll have to create your .htpasswd file with htdigest instead of htpasswd as follows:
     156{{{
     157# htdigest /somewhere/trac.htpasswd trac admin
     158}}}
     159where the "trac" parameter above is the same as !AuthName above  ("Realm" in apache-docs).
    86160
    87161----
    88 See also:  TracGuide, TracInstall, TracFastCgi, TracModPython
     162See also:  TracGuide, TracInstall, wiki:TracModWSGI, TracFastCgi, TracModPython