Changes between Version 1 and Version 2 of TracCgi


Ignore:
Timestamp:
Mar 2, 2017 6:39:50 AM (8 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracCgi

    v1 v2  
    1 = Installing Trac as CGI =
     1= Installing Trac as CGI
     2[[TracGuideToc]]
     3[[PageOutline]]
    24
    3 To 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.''
     5{{{#!div class=important
     6 ''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.''
    87}}}
    98
    10 If you're using [http://httpd.apache.org/ Apache HTTPD], there are a couple ways to do that:
     9CGI script is the entrypoint that web-server calls when a web-request to an application is made. The `trac.cgi` script can be created using the `trac-admin <env> deploy <dir>` command which automatically substitutes the required paths, see TracInstall#cgi-bin. Make sure the script is executable by your web server.
    1110
    12  1. Use a `ScriptAlias` to map a URL to the `trac.cgi` script
    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.
     11== Apache web-server configuration
    1412
    15 The first option is recommended as it also allows you to map the CGI to a friendly URL.
     13In [http://httpd.apache.org/ Apache] there are two ways to run Trac as CGI:
    1614
    17 Now, edit the Apache configuration file and add this snippet, file names and locations changed to match your installation:
    18 {{{
    19 ScriptAlias /trac /usr/share/trac/cgi-bin/trac.cgi
     15 1. Use a `ScriptAlias` directive that maps an URL to the `trac.cgi` script (recommended)
     16 1. 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.
     17
     18To make Trac available at `http://yourhost.example.org/trac` add `ScriptAlias` directive to Apache configuration file, changing `trac.cgi` path to match your installation:
     19{{{#!apache
     20ScriptAlias /trac /path/to/www/trac/cgi-bin/trac.cgi
    2021}}}
    2122
    22  ''Note that this directive requires the `mod_alias` module to be installed and enabled.''
     23 ''Note that this directive requires enabled `mod_alias` module.''
    2324
    2425If you're using Trac with a single project you need to set its location using the `TRAC_ENV` environment variable:
    25 {{{
     26{{{#!apache
    2627<Location "/trac">
    2728  SetEnv TRAC_ENV "/path/to/projectenv"
    … …  
    3031
    3132Or to use multiple projects you can specify their common parent directory using the `TRAC_ENV_PARENT_DIR` variable:
    32 {{{
     33{{{#!apache
    3334<Location "/trac">
    3435  SetEnv TRAC_ENV_PARENT_DIR "/path/to/project/parent/dir"
    … …  
    3637}}}
    3738
    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 ''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 ...":''
    3940
    40 {{{
     41{{{#!python
    4142    import os
    4243    os.environ['TRAC_ENV'] = "/path/to/projectenv"
    … …  
    4546 '' Or for TRAC_ENV_PARENT_DIR: ''
    4647
    47 {{{
     48{{{#!python
    4849    import os
    4950    os.environ['TRAC_ENV_PARENT_DIR'] = "/path/to/project/parent/dir"
    5051}}}
    5152
    52 This will make Trac available at `http://yourhost.example.org/trac`.
    53 
    54 If you are using the [http://httpd.apache.org/docs/suexec.html Apache suEXEC] feature please see [http://trac.edgewall.org/wiki/ApacheSuexec].
     53If you are using the [http://httpd.apache.org/docs/suexec.html Apache suEXEC] feature please see [trac:ApacheSuexec].
    5554
    5655On 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).
    5756
    58 == Mapping Static Resources ==
     57=== Using WSGI
    5958
    60 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 much more efficiently served by the web server directly.
     59You 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.
    6160
    62 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.
     61== Mapping Static Resources
    6362
    64 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:
    65 {{{
    66 Alias /trac/chrome/common /usr/share/trac/htdocs
    67 <Directory "/usr/share/trac/htdocs">
    68   Order allow,deny
    69   Allow from all
    70 </Directory>
    71 }}}
     63See TracInstall#MappingStaticResources.
    7264
    73 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.
     65== Adding Authentication
    7466
    75 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`.
    76 
    77 Similarly, 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 {{{
    80 Alias /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 
    87 Alternatively, you can set the `htdocs_location` configuration option in [wiki:TracIni trac.ini]:
    88 {{{
    89 [trac]
    90 htdocs_location = /trac-htdocs
    91 }}}
    92 
    93 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:
    94 {{{
    95 $ ln -s /usr/share/trac/htdocs /var/www/your_site.com/htdocs/trac-htdocs
    96 }}}
    97 
    98 Note 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 
    101 
    102 == Adding Authentication ==
    103 
    104 The simplest way to enable authentication with Apache is to create a password file. Use the `htpasswd` program to create the password file:
    105 {{{
    106 $ htpasswd -c /somewhere/trac.htpasswd admin
    107 New password: <type password>
    108 Re-type new password: <type password again>
    109 Adding password for user admin
    110 }}}
    111 
    112 After the first user, you dont need the "-c" option anymore:
    113 {{{
    114 $ htpasswd /somewhere/trac.htpasswd john
    115 New password: <type password>
    116 Re-type new password: <type password again>
    117 Adding password for user john
    118 }}}
    119 
    120   ''See the man page for `htpasswd` for full documentation.''
    121 
    122 After you've created the users, you can set their permissions using TracPermissions.
    123 
    124 Now, you'll need to enable authentication against the password file in the Apache configuration:
    125 {{{
    126 <Location "/trac/login">
    127   AuthType Basic
    128   AuthName "Trac"
    129   AuthUserFile /somewhere/trac.htpasswd
    130   Require valid-user
    131 </Location>
    132 }}}
    133 
    134 If 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 
    144 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. 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 }}}
    155 and you'll have to create your .htpasswd file with htdigest instead of htpasswd as follows:
    156 {{{
    157 # htdigest /somewhere/trac.htpasswd trac admin
    158 }}}
    159 where the "trac" parameter above is the same as !AuthName above  ("Realm" in apache-docs).
     67See TracInstall#ConfiguringAuthentication.
    16068
    16169----
    162 See also:  TracGuide, TracInstall, TracFastCgi, TracModPython
     70See also:  TracGuide, TracInstall, [wiki:TracModWSGI], TracFastCgi, TracModPython