Changes between Version 1 and Version 2 of TracCgi


Ignore:
Timestamp:
Jun 6, 2013 4:39:51 AM (14 months 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). 
     59 
     60=== Using WSGI === 
     61 
     62You can run a [http://henry.precheur.org/python/how_to_serve_cgi WSGI handler] [http://pythonweb.org/projects/webmodules/doc/0.5.3/html_multipage/lib/example-webserver-web-wsgi-simple-cgi.html under CGI].  You can [wiki:TracModWSGI#Thetrac.wsgiscript write your own application function], or use the deployed trac.wsgi's application. 
    2563 
    2664== Mapping Static Resources == 
    2765 
    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. 
    29  
    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. 
    31  
    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: 
    33 {{{ 
    34 Alias /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  
    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.  
    42  
    43 For 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  
    45 Alternatively, you can set the `htdocs_location` configuration option in [wiki:TracIni trac.ini]: 
    46 {{{ 
    47 [trac] 
    48 htdocs_location = /trac-htdocs 
    49 }}} 
    50  
    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. 
     66See TracInstall#MappingStaticResources. 
    5267 
    5368== Adding Authentication == 
    5469 
    55 The 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 
    58 New password: <type password> 
    59 Re-type new password: <type password again> 
    60 Adding password for user admin 
    61 }}} 
    62  
    63 After the first user, you dont need the "-c" option anymore: 
    64 {{{ 
    65 $ htpasswd /somewhere/trac.htpasswd john 
    66 New password: <type password> 
    67 Re-type new password: <type password again> 
    68 Adding password for user john 
    69 }}} 
    70  
    71   ''See the man page for `htpasswd` for full documentation.'' 
    72  
    73 After you've created the users, you can set their permissions using TracPermissions. 
    74  
    75 Now, 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  
    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. 
     70See TracInstall#ConfiguringAuthentication. 
    8671 
    8772---- 
    88 See also:  TracGuide, TracInstall, TracFastCgi, TracModPython 
     73See also:  TracGuide, TracInstall, [wiki:TracModWSGI], TracFastCgi, TracModPython