Changes between Version 1 and Version 2 of TracCgi


Ignore:
Timestamp:
Feb 13, 2021 12:24:55 AM (3 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   ''Please note that using Trac via CGI is significantly slower than any other deployment method, such as [TracModPython mod_python] or [TracFastCgi FastCGI].''
    6 
    7 If 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 
    12 The first option is recommended as it also allows you to map the CGI to a friendly URL.
    13 
    14 Now, edit the Apache configuration file and add this snippet, file names and locations changed to match your installation:
    15 {{{
    16 ScriptAlias /trac /usr/share/trac/cgi-bin/trac.cgi
     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.''
    177}}}
    188
    19  ''Note that this directive requires the `mod_alias` module to be installed and enabled.''
     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.
     10
     11== Apache web-server configuration
     12
     13In [http://httpd.apache.org/ Apache] there are two ways to run Trac as CGI:
     14
     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
     21}}}
     22
     23 ''Note that this directive requires enabled `mod_alias` module.''
    2024
    2125If you're using Trac with a single project you need to set its location using the `TRAC_ENV` environment variable:
    22 {{{
     26{{{#!apache
    2327<Location "/trac">
    2428  SetEnv TRAC_ENV "/path/to/projectenv"
    … …  
    2731
    2832Or to use multiple projects you can specify their common parent directory using the `TRAC_ENV_PARENT_DIR` variable:
    29 {{{
     33{{{#!apache
    3034<Location "/trac">
    3135  SetEnv TRAC_ENV_PARENT_DIR "/path/to/project/parent/dir"
    … …  
    3337}}}
    3438
    35  ''Note that the `SetEnv` directive requires the `mod_env` module to be installed and enable.''
     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 ...":''
    3640
    37 This will make Trac available at `http://yourhost.example.org/trac`.
     41{{{#!python
     42    import os
     43    os.environ['TRAC_ENV'] = "/path/to/projectenv"
     44}}}
    3845
    39 If you are using the [http://httpd.apache.org/docs/suexec.html Apache suEXEC] feature please see [http://trac.edgewall.org/wiki/ApacheSuexec].
     46 '' Or for TRAC_ENV_PARENT_DIR: ''
     47
     48{{{#!python
     49    import os
     50    os.environ['TRAC_ENV_PARENT_DIR'] = "/path/to/project/parent/dir"
     51}}}
     52
     53If you are using the [http://httpd.apache.org/docs/suexec.html Apache suEXEC] feature please see [trac:ApacheSuexec].
    4054
    4155On 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).
    4256
    43 == Mapping Static Resources ==
     57=== Using WSGI
    4458
    45 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.
    4660
    47 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
    4862
    49 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:
    50 {{{
    51 Alias /trac/chrome/common /usr/share/trac/htdocs
    52 <Directory "/usr/share/trac/htdocs">
    53   Order allow,deny
    54   Allow from all
    55 </Directory>
    56 }}}
     63See TracInstall#MappingStaticResources.
    5764
    58 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
    5966
    60 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`.
    61 
    62 Alternatively, you can set the `htdocs_location` configuration option in [wiki:TracIni trac.ini]:
    63 {{{
    64 [trac]
    65 htdocs_location = /trac-htdocs
    66 }}}
    67 
    68 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:
    69 {{{
    70 $ ln -s /usr/share/trac/htdocs /var/www/your_site.com/htdocs/trac-htdocs
    71 }}}
    72 
    73 == Adding Authentication ==
    74 
    75 The 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
    78 New password: <type password>
    79 Re-type new password: <type password again>
    80 Adding password for user admin
    81 }}}
    82 
    83 After the first user, you dont need the "-c" option anymore:
    84 {{{
    85 $ htpasswd /somewhere/trac.htpasswd john
    86 New password: <type password>
    87 Re-type new password: <type password again>
    88 Adding password for user john
    89 }}}
    90 
    91   ''See the man page for `htpasswd` for full documentation.''
    92 
    93 After you've created the users, you can set their permissions using TracPermissions.
    94 
    95 Now, 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 
    105 If 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 
    115 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.
     67See TracInstall#ConfiguringAuthentication.
    11668
    11769----
    118 See also:  TracGuide, TracInstall, TracFastCgi, TracModPython
     70See also:  TracGuide, TracInstall, [wiki:TracModWSGI], TracFastCgi, TracModPython