Changes between Version 2 and Version 3 of TracFastCgi


Ignore:
Timestamp:
Apr 4, 2012, 2:28:09 PM (13 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracFastCgi

    v2 v3  
    11= Trac with FastCGI =
    22
    3 Since version 0.9, Trac supports being run through the [http://www.fastcgi.com/ FastCGI] interface. Like [wiki:TracModPython mod_python], this allows Trac to remain resident, and is faster than external CGI interfaces which must start a new process for each request. However, unlike mod_python, it is able to support [http://httpd.apache.org/docs/suexec.html SuEXEC]. Additionally, it is supported by much wider variety of web servers.
    4 
    5 '''Note for Windows:''' Trac's FCGI does not run under Windows, as Windows does not implement `Socket.fromfd`, which is used by `_fcgi.py`. If you want to connect to IIS, your choice may be [trac:TracOnWindowsIisAjp AJP].
     3[http://www.fastcgi.com/ FastCGI] interface allows Trac to remain resident much like with [wiki:TracModPython mod_python]. It is faster than external CGI interfaces which must start a new process for each request. However, unlike mod_python, FastCGI supports [http://httpd.apache.org/docs/suexec.html Apache SuEXEC], i.e. run with different permissions than web server. Additionally, it is supported by much wider variety of web servers.
     4
     5'''Note for Windows:''' Trac's FastCGI does not run under Windows, as Windows does not implement `Socket.fromfd`, which is used by `_fcgi.py`. If you want to connect to IIS, you may want to try [trac:TracOnWindowsIisAjp AJP].
    66
    77== Simple Apache configuration ==
    88
    99There are two FastCGI modules commonly available for Apache: `mod_fastcgi` and
    10 `mod_fcgid`.  The `FastCgiIpcDir` and `FastCgiConfig` directives discussed
    11 below are `mod_fastcgi` directives; the `DefaultInitEnv` is a `mod_fcgid`
    12 directive.
    13 
    14 For `mod_fastcgi`, add the following to an appropriate Apache configuration
    15 file:
     10`mod_fcgid` (preferred). The latter is more up-to-date.
     11
     12==== setup with `mod_fastcgi` ====
     13`mod_fastcgi` uses `FastCgiIpcDir` and `FastCgiConfig` directives that should be added to an appropriate Apache configuration file:
    1614{{{
    1715# Enable fastcgi for .fcgi files
    … …  
    3937}}}
    4038
    41 But neither of these will work for `mod_fcgid`.  A similar but partial
    42 solution for `mod_fcgid` is:
     39==== setup with `mod_fcgid` ====
     40Configure `ScriptAlias` (see TracCgi for details), but call `trac.fcgi`
     41instead of `trac.cgi`. Note that slash at the end - it is important.
     42{{{
     43ScriptAlias /trac /path/to/www/trac/cgi-bin/trac.fcgi/
     44}}}
     45
     46To setup Trac environment for `mod_fcgid` it is necessary to use
     47`DefaultInitEnv` directive. It cannot be used in `Directory` or
     48`Location` context, so if you need to support multiple projects, try
     49alternative environment setup below.
     50
    4351{{{
    4452DefaultInitEnv TRAC_ENV /path/to/env/trac/
    4553}}}
    46 But this cannot be used in `Directory` or `Location` context, which makes it
    47 difficult to support multiple projects.
    48 
    49 A better method which works for both of these modules (and for  [http://www.lighttpd.net/ lighttpd] and CGI as well), because it involves
    50 no server configuration settings for environment variables, is to set one
    51 of the variables in `trac.fcgi`, e.g.:
     54
     55==== alternative environment setup ====
     56A better method to specify path to Trac environment it to embed the path
     57into `trac.fcgi` script itself. That doesn't require configuration of server
     58environment variables, works for both FastCgi modules
     59(and for [http://www.lighttpd.net/ lighttpd] and CGI as well):
    5260{{{
    5361import os
    … …  
    6068}}}
    6169
    62 Using this method, different projects can be supported by using different
    63 `.fcgi` scripts with different `ScriptAliases`, copying and appropriately
    64 renaming `trac.fcgi` and adding the above code to create each such script.
     70With this method different projects can be supported by using different
     71`.fcgi` scripts with different `ScriptAliases`.
    6572
    6673See [https://coderanger.net/~coderanger/httpd/fcgi_example.conf this fcgid example config] which uses a !ScriptAlias directive with trac.fcgi with a trailing / like this:
    … …  
    97104For using `trac.fcgi`(prior to 0.11) / fcgi_frontend.py (0.11) with lighttpd add the following to your lighttpd.conf:
    98105{{{
    99 #var.fcgi_binary="/path/to/fcgi_frontend.py" # 0.11 if installed with easy_setup, it is inside the egg directory
     106#var.fcgi_binary="/usr/bin/python /path/to/fcgi_frontend.py" # 0.11 if installed with easy_setup, it is inside the egg directory
    100107var.fcgi_binary="/path/to/cgi-bin/trac.fcgi" # 0.10 name of prior fcgi executable
    101108fastcgi.server = ("/trac" =>
    … …  
    115122and you may set one of the two in `trac.fcgi` instead of in `lighttpd.conf`
    116123using `bin-environment` (as in the section above on Apache configuration).
     124
     125Note that lighttpd has a bug related to 'SCRIPT_NAME' and 'PATH_INFO' when the uri of fastcgi.server is '/' instead of '/trac' in this example, see #Trac2418. This should be fixed since lighttpd 1.4.23, and you may need to add `"fix-root-scriptname" => "enable"` as parameter of fastcgi.server.
    117126
    118127For using two projects with lighttpd add the following to your `lighttpd.conf`:
    … …  
    268277Note about running lighttpd with reduced permissions:
    269278
    270   If nothing else helps and trac.fcgi doesn't start with lighttpd settings __server.username = "www-data"__, __server.groupname = "www-data"__, then in the `bin-environment` section set `PYTHON_EGG_CACHE` to the home directory of `www-data` or some other directory accessible to this account for writing.
     279  If nothing else helps and trac.fcgi doesn't start with lighttpd settings `server.username = "www-data"`, `server.groupname = "www-data"`, then in the `bin-environment` section set `PYTHON_EGG_CACHE` to the home directory of `www-data` or some other directory accessible to this account for writing.
    271280
    272281
    … …  
    277286!LiteSpeed web server is an event-driven asynchronous Apache replacement designed from the ground-up to be secure, scalable, and operate with minimal resources. !LiteSpeed can operate directly from an Apache config file and is targeted for business-critical environments.
    278287
    279 Setup
    280 
    281 1) Please make sure you have first have a working install of a Trac project. Test install with “tracd” first.
    282 
    283 2) Create a Virtual Host for this setup. From now on we will refer to this vhost as TracVhost. For this tutorial we will be assuming that your trac project will be accessible via:
     288=== Setup ===
     289
     290 1. Please make sure you have first have a working install of a Trac project. Test install with “tracd” first.
     291
     292 2. Create a Virtual Host for this setup. From now on we will refer to this vhost as !TracVhost. For this tutorial we will be assuming that your trac project will be accessible via:
    284293
    285294{{{
    … …  
    287296}}}
    288297
    289 3) Go “TracVhost → External Apps” tab and create a new “External Application”.
     298 3. Go “!TracVhost → External Apps” tab and create a new “External Application”.
    290299
    291300{{{
    … …  
    305314}}}
    306315
    307 4) Optional. If you need to use htpasswd based authentication. Go to “TracVhost → Security” tab and create a new security “Realm”.
     316 4. Optional. If you need to use htpasswd based authentication. Go to “!TracVhost → Security” tab and create a new security “Realm”.
    308317
    309318{{{
    … …  
    315324If you don’t have a htpasswd file or don’t know how to create the entries within one, go to http://sherylcanter.com/encrypt.php, to generate the user:password combos.
    316325
    317 5) Go to “PythonVhost → Contexts” and create a new “FCGI Context”.
     326 5. Go to “!PythonVhost → Contexts” and create a new “FCGI Context”.
    318327
    319328{{{
    … …  
    323332}}}
    324333
    325 6) Modify /fullpathto/mytracproject/conf/trac.ini
     334 6. Modify `/fullpathto/mytracproject/conf/trac.ini`
    326335
    327336{{{
    … …  
    332341}}}
    333342
    334 7) Restart !LiteSpeed, “lswsctrl restart”, and access your new Trac project at:
     343 7. Restart !LiteSpeed, “lswsctrl restart”, and access your new Trac project at:
    335344
    336345{{{
    … …  
    338347}}}
    339348
    340 === Simple Nginx Configuration ===
    341 
    342 1) Nginx configuration snippet - confirmed to work on 0.6.32
     349== Simple Nginx Configuration ==
     350
     351 1. Nginx configuration snippet - confirmed to work on 0.6.32
    343352{{{
    344353    server {
    … …  
    387396            fastcgi_param  SERVER_PORT        $server_port;
    388397            fastcgi_param  SERVER_PROTOCOL    $server_protocol;
     398            fastcgi_param  QUERY_STRING     $query_string;
    389399
    390400            # for authentication to work
    … …  
    395405}}}
    396406
    397 2) Modified trac.fcgi:
     407 2. Modified trac.fcgi:
    398408
    399409{{{
    … …  
    429439}}}
    430440
    431 3) reload nginx and launch trac.fcgi like that:
     441 3. reload nginx and launch trac.fcgi like that:
    432442
    433443{{{
    … …  
    437447The above assumes that:
    438448 * There is a user named 'trac' for running trac instances and keeping trac environments in its home directory.
    439  * /home/trac/instance contains a trac environment
    440  * /home/trac/htpasswd contains authentication information
    441  * /home/trac/run is owned by the same group the nginx runs under
    442   * and if your system is Linux the /home/trac/run has setgid bit set (chmod g+s run)
     449 * `/home/trac/instance` contains a trac environment
     450 * `/home/trac/htpasswd` contains authentication information
     451 * `/home/trac/run` is owned by the same group the nginx runs under
     452  * and if your system is Linux the `/home/trac/run` has setgid bit set (`chmod g+s run`)
    443453  * and patch from ticket #T7239 is applied, or you'll have to fix the socket file permissions every time
    444454