Changes between Initial Version and Version 1 of TracCgi


Ignore:
Timestamp:
02/24/2006 09:48:37 PM (9 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracCgi

    v1 v1  
     1= Installing Trac as CGI = 
     2 
     3To 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: 
     4 
     5 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. 
     7 
     8The first option is recommended as it also allows you to map the CGI to a friendly URL. 
     9 
     10Now, edit the Apache configuration file and add this snippet, file names and locations changed to match your installation: 
     11{{{ 
     12ScriptAlias /trac /usr/share/trac/cgi-bin/trac.cgi 
     13 
     14# Trac needs to know where the database is located 
     15<Location "/trac"> 
     16  SetEnv TRAC_ENV "/path/to/projectenv" 
     17</Location> 
     18}}} 
     19 
     20This will make Trac available at `http://yourhost.example.org/trac`. 
     21 
     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.'' 
     23 
     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).'' 
     25 
     26== Mapping Static Resources == 
     27 
     28Out 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. 
     29 
     30Web 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. 
     31 
     32Edit 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: 
     33{{{ 
     34Alias /trac/chrome/common /usr/share/trac/htdocs 
     35<Directory "/usr/share/trac/htdocs"> 
     36  Order allow,deny 
     37  Allow from all 
     38</Directory> 
     39}}} 
     40 
     41Note 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.  
     42 
     43For 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`. 
     44 
     45Alternatively, you can set the `htdocs_location` configuration option in [wiki:TracIni trac.ini]: 
     46{{{ 
     47[trac] 
     48htdocs_location = /trac-htdocs 
     49}}} 
     50 
     51Trac 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. 
     52 
     53== Adding Authentication == 
     54 
     55The simplest way to enable authentication with Apache is to create a password file. Use the `htpasswd` program to create the password file: 
     56{{{ 
     57$ htpasswd -c /somewhere/trac.htpasswd admin 
     58New password: <type password> 
     59Re-type new password: <type password again> 
     60Adding password for user admin 
     61}}} 
     62 
     63After the first user, you dont need the "-c" option anymore: 
     64{{{ 
     65$ htpasswd /somewhere/trac.htpasswd john 
     66New password: <type password> 
     67Re-type new password: <type password again> 
     68Adding password for user john 
     69}}} 
     70 
     71  ''See the man page for `htpasswd` for full documentation.'' 
     72 
     73After you've created the users, you can set their permissions using TracPermissions. 
     74 
     75Now, you'll need to enable authentication against the password file in the Apache configuration: 
     76{{{ 
     77<Location "/cgi-bin/trac.cgi/login"> 
     78  AuthType Basic 
     79  AuthName "Trac" 
     80  AuthUserFile /somewhere/trac.htpasswd 
     81  Require valid-user 
     82</Location> 
     83}}} 
     84 
     85For 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. 
     86 
     87---- 
     88See also:  TracGuide, TracInstall, TracFastCgi, TracModPython