Changes from Version 1 of TracCgi

Show
Ignore:
Author:
trac (IP: 127.0.0.1)
Timestamp:
10/01/07 16:23:00 (10 years ago)
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracCgi

    v0 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. 
     4 
     5  ''Please note that using Trac via CGI is significantly slower than any other deployment method, such as [TracModPython mod_python] or [TracFastCgi FastCGI].'' 
     6 
     7If you're using [http://httpd.apache.org/ Apache HTTPD], there are a couple ways to do that: 
     8 
     9 1. Use a `ScriptAlias` to map a URL to the `trac.cgi` script 
     10 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. 
     11 
     12The first option is recommended as it also allows you to map the CGI to a friendly URL. 
     13 
     14Now, edit the Apache configuration file and add this snippet, file names and locations changed to match your installation: 
     15{{{ 
     16ScriptAlias /trac /usr/share/trac/cgi-bin/trac.cgi 
     17}}} 
     18 
     19 ''Note that this directive requires the `mod_alias` module to be installed and enabled.'' 
     20 
     21If you're using Trac with a single project you need to set its location using the `TRAC_ENV` environment variable: 
     22{{{ 
     23<Location "/trac"> 
     24  SetEnv TRAC_ENV "/path/to/projectenv" 
     25</Location> 
     26}}} 
     27 
     28Or to use multiple projects you can specify their common parent directory using the `TRAC_ENV_PARENT_DIR` variable: 
     29{{{ 
     30<Location "/trac"> 
     31  SetEnv TRAC_ENV_PARENT_DIR "/path/to/project/parent/dir" 
     32</Location> 
     33}}} 
     34 
     35 ''Note that the `SetEnv` directive requires the `mod_env` module to be installed and enable.'' 
     36 
     37This will make Trac available at `http://yourhost.example.org/trac`. 
     38 
     39If you are using the [http://httpd.apache.org/docs/suexec.html Apache suEXEC] feature please see [http://trac.edgewall.org/wiki/ApacheSuexec]. 
     40 
     41On 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). 
     42 
     43== Mapping Static Resources == 
     44 
     45Out 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. 
     46 
     47Web 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. 
     48 
     49Edit 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: 
     50{{{ 
     51Alias /trac/chrome/common /usr/share/trac/htdocs 
     52<Directory "/usr/share/trac/htdocs"> 
     53  Order allow,deny 
     54  Allow from all 
     55</Directory> 
     56}}} 
     57 
     58Note 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.  
     59 
     60For 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`. 
     61 
     62Alternatively, you can set the `htdocs_location` configuration option in [wiki:TracIni trac.ini]: 
     63{{{ 
     64[trac] 
     65htdocs_location = /trac-htdocs 
     66}}} 
     67 
     68Trac 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: 
     69{{{ 
     70$ ln -s /usr/share/trac/htdocs /var/www/your_site.com/htdocs/trac-htdocs 
     71}}} 
     72 
     73== Adding Authentication == 
     74 
     75The simplest way to enable authentication with Apache is to create a password file. Use the `htpasswd` program to create the password file: 
     76{{{ 
     77$ htpasswd -c /somewhere/trac.htpasswd admin 
     78New password: <type password> 
     79Re-type new password: <type password again> 
     80Adding password for user admin 
     81}}} 
     82 
     83After the first user, you dont need the "-c" option anymore: 
     84{{{ 
     85$ htpasswd /somewhere/trac.htpasswd john 
     86New password: <type password> 
     87Re-type new password: <type password again> 
     88Adding password for user john 
     89}}} 
     90 
     91  ''See the man page for `htpasswd` for full documentation.'' 
     92 
     93After you've created the users, you can set their permissions using TracPermissions. 
     94 
     95Now, you'll need to enable authentication against the password file in the Apache configuration: 
     96{{{ 
     97<Location "/trac/login"> 
     98  AuthType Basic 
     99  AuthName "Trac" 
     100  AuthUserFile /somewhere/trac.htpasswd 
     101  Require valid-user 
     102</Location> 
     103}}} 
     104 
     105If you're hosting multiple projects you can use the same password file for all of them: 
     106{{{ 
     107<LocationMatch "/trac/[^/]+/login"> 
     108  AuthType Basic 
     109  AuthName "Trac" 
     110  AuthUserFile /somewhere/trac.htpasswd 
     111  Require valid-user 
     112</LocationMatch> 
     113}}} 
     114 
     115For 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. 
     116 
     117---- 
     118See also:  TracGuide, TracInstall, TracFastCgi, TracModPython