Changes between Version 3 and Version 4 of TracFastCgi


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

--

Legend:

Unmodified
Added
Removed
Modified

  • TracFastCgi

    v3 v4  
    11= Trac with FastCGI =
    22
    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].
     3Since 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].
    66
    77== Simple Apache configuration ==
    88
    99There are two FastCGI modules commonly available for Apache: `mod_fastcgi` and
    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:
     10`mod_fcgid`.  The `FastCgiIpcDir` and `FastCgiConfig` directives discussed
     11below are `mod_fastcgi` directives; the `DefaultInitEnv` is a `mod_fcgid`
     12directive.
     13
     14For `mod_fastcgi`, add the following to an appropriate Apache configuration
     15file:
    1416{{{
    1517# Enable fastcgi for .fcgi files
    … …  
    3739}}}
    3840
    39 ==== setup with `mod_fcgid` ====
    40 Configure `ScriptAlias` (see TracCgi for details), but call `trac.fcgi`
    41 instead of `trac.cgi`. Note that slash at the end - it is important.
    42 {{{
    43 ScriptAlias /trac /path/to/www/trac/cgi-bin/trac.fcgi/
    44 }}}
    45 
    46 To 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
    49 alternative environment setup below.
    50 
     41But neither of these will work for `mod_fcgid`.  A similar but partial
     42solution for `mod_fcgid` is:
    5143{{{
    5244DefaultInitEnv TRAC_ENV /path/to/env/trac/
    5345}}}
    54 
    55 ==== alternative environment setup ====
    56 A better method to specify path to Trac environment it to embed the path
    57 into `trac.fcgi` script itself. That doesn't require configuration of server
    58 environment variables, works for both FastCgi modules
    59 (and for [http://www.lighttpd.net/ lighttpd] and CGI as well):
     46But this cannot be used in `Directory` or `Location` context, which makes it
     47difficult to support multiple projects.
     48
     49A better method which works for both of these modules (and for  [http://www.lighttpd.net/ lighttpd] and CGI as well), because it involves
     50no server configuration settings for environment variables, is to set one
     51of the variables in `trac.fcgi`, e.g.:
    6052{{{
    6153import os
    … …  
    6860}}}
    6961
    70 With this method different projects can be supported by using different
    71 `.fcgi` scripts with different `ScriptAliases`.
     62Using this method, different projects can be supported by using different
     63`.fcgi` scripts with different `ScriptAliases`, copying and appropriately
     64renaming `trac.fcgi` and adding the above code to create each such script.
    7265
    7366See [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:
    … …  
    10497For using `trac.fcgi`(prior to 0.11) / fcgi_frontend.py (0.11) with lighttpd add the following to your lighttpd.conf:
    10598{{{
    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
     99#var.fcgi_binary="/path/to/fcgi_frontend.py" # 0.11 if installed with easy_setup, it is inside the egg directory
    107100var.fcgi_binary="/path/to/cgi-bin/trac.fcgi" # 0.10 name of prior fcgi executable
    108101fastcgi.server = ("/trac" =>
    … …  
    122115and you may set one of the two in `trac.fcgi` instead of in `lighttpd.conf`
    123116using `bin-environment` (as in the section above on Apache configuration).
    124 
    125 Note 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.
    126117
    127118For using two projects with lighttpd add the following to your `lighttpd.conf`:
    … …  
    277268Note about running lighttpd with reduced permissions:
    278269
    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.
     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.
    280271
    281272
    … …  
    286277!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.
    287278
    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:
     279Setup
     280
     2811) Please make sure you have first have a working install of a Trac project. Test install with “tracd” first.
     282
     2832) 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:
    293284
    294285{{{
    … …  
    296287}}}
    297288
    298  3. Go “!TracVhost → External Apps” tab and create a new “External Application”.
     2893) Go “TracVhost → External Apps” tab and create a new “External Application”.
    299290
    300291{{{
    … …  
    314305}}}
    315306
    316  4. Optional. If you need to use htpasswd based authentication. Go to “!TracVhost → Security” tab and create a new security “Realm”.
     3074) Optional. If you need to use htpasswd based authentication. Go to “TracVhost → Security” tab and create a new security “Realm”.
    317308
    318309{{{
    … …  
    324315If 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.
    325316
    326  5. Go to “!PythonVhost → Contexts” and create a new “FCGI Context”.
     3175) Go to “PythonVhost → Contexts” and create a new “FCGI Context”.
    327318
    328319{{{
    … …  
    332323}}}
    333324
    334  6. Modify `/fullpathto/mytracproject/conf/trac.ini`
     3256) Modify /fullpathto/mytracproject/conf/trac.ini
    335326
    336327{{{
    … …  
    341332}}}
    342333
    343  7. Restart !LiteSpeed, “lswsctrl restart”, and access your new Trac project at:
     3347) Restart !LiteSpeed, “lswsctrl restart”, and access your new Trac project at:
    344335
    345336{{{
    … …  
    347338}}}
    348339
    349 == Simple Nginx Configuration ==
    350 
    351  1. Nginx configuration snippet - confirmed to work on 0.6.32
     340=== Simple Nginx Configuration ===
     341
     3421) Nginx configuration snippet - confirmed to work on 0.6.32
    352343{{{
    353344    server {
    … …  
    396387            fastcgi_param  SERVER_PORT        $server_port;
    397388            fastcgi_param  SERVER_PROTOCOL    $server_protocol;
    398             fastcgi_param  QUERY_STRING     $query_string;
    399389
    400390            # for authentication to work
    … …  
    405395}}}
    406396
    407  2. Modified trac.fcgi:
     3972) Modified trac.fcgi:
    408398
    409399{{{
    … …  
    439429}}}
    440430
    441  3. reload nginx and launch trac.fcgi like that:
     4313) reload nginx and launch trac.fcgi like that:
    442432
    443433{{{
    … …  
    447437The above assumes that:
    448438 * There is a user named 'trac' for running trac instances and keeping trac environments in its home directory.
    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`)
     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)
    453443  * and patch from ticket #T7239 is applied, or you'll have to fix the socket file permissions every time
    454444