Changes between Version 1 and Version 2 of TracCgi

Show
Ignore:
Timestamp:
10/09/08 04:57:28 (6 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  ''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: 
    48 
    59 1. Use a `ScriptAlias` to map a URL to the `trac.cgi` script 
     
    1115{{{ 
    1216ScriptAlias /trac /usr/share/trac/cgi-bin/trac.cgi 
     17}}} 
    1318 
    14 # Trac needs to know where the database is located 
     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{{{ 
    1523<Location "/trac"> 
    1624  SetEnv TRAC_ENV "/path/to/projectenv" 
     
    1826}}} 
    1927 
     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. If not, you could set TRAC_ENV in trac.cgi. Just add the following code between "try:" and "from trac.web ...":'' 
     36 
     37{{{ 
     38    import os 
     39    os.environ['TRAC_ENV'] = "/path/to/projectenv" 
     40}}} 
     41 
     42 '' Or for TRAC_ENV_PARENT_DIR: '' 
     43 
     44{{{ 
     45    import os 
     46    os.environ['TRAC_ENV_PARENT_DIR'] = "/path/to/project/parent/dir" 
     47}}} 
     48 
    2049This will make Trac available at `http://yourhost.example.org/trac`. 
    2150 
    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.'' 
     51If you are using the [http://httpd.apache.org/docs/suexec.html Apache suEXEC] feature please see [http://trac.edgewall.org/wiki/ApacheSuexec]. 
    2352 
    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).'' 
     53On 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). 
    2554 
    2655== Mapping Static Resources == 
    2756 
    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. 
     57Out 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. 
    2958 
    3059Web 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. 
     
    4372For 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`. 
    4473 
     74Similarly, 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): 
     75 
     76{{{ 
     77Alias /trac/chrome/site /path/to/projectenv/htdocs 
     78<Directory "/path/to/projectenv/htdocs"> 
     79  Order allow,deny 
     80  Allow from all 
     81</Directory> 
     82}}} 
     83 
    4584Alternatively, you can set the `htdocs_location` configuration option in [wiki:TracIni trac.ini]: 
    4685{{{ 
     
    4988}}} 
    5089 
    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. 
     90Trac 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: 
     91{{{ 
     92$ ln -s /usr/share/trac/htdocs /var/www/your_site.com/htdocs/trac-htdocs 
     93}}} 
     94 
     95Note that in order to get this `htdocs` directory, you need first to extract the relevant Trac resources using the `deploy` command of TracAdmin: 
     96[[TracAdminHelp(deploy)]] 
     97 
    5298 
    5399== Adding Authentication == 
     
    75121Now, you'll need to enable authentication against the password file in the Apache configuration: 
    76122{{{ 
    77 <Location "/cgi-bin/trac.cgi/login"> 
     123<Location "/trac/login"> 
    78124  AuthType Basic 
    79125  AuthName "Trac" 
     
    83129}}} 
    84130 
    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. 
     131If you're hosting multiple projects you can use the same password file for all of them: 
     132{{{ 
     133<LocationMatch "/trac/[^/]+/login"> 
     134  AuthType Basic 
     135  AuthName "Trac" 
     136  AuthUserFile /somewhere/trac.htpasswd 
     137  Require valid-user 
     138</LocationMatch> 
     139}}} 
     140 
     141For 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: 
     142{{{ 
     143<Location "/trac/login"> 
     144    LoadModule auth_digest_module /usr/lib/apache2/modules/mod_auth_digest.so 
     145    AuthType Digest 
     146    AuthName "trac" 
     147    AuthDigestDomain /trac 
     148    AuthDigestFile /somewhere/trac.htpasswd 
     149    Require valid-user 
     150</Location> 
     151}}} 
     152and you'll have to create your .htpasswd file with htdigest instead of htpasswd as follows: 
     153{{{ 
     154# htdigest /somewhere/trac.htpasswd trac admin 
     155}}} 
     156where the "trac" parameter above is the same as !AuthName above  ("Realm" in apache-docs).  
    86157 
    87158----