Changes between Version 2 and Version 3 of TracFastCgi


Ignore:
Timestamp:
May 30, 2012, 7:12:16 PM (12 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:
    … …  
    7178== Simple Cherokee Configuration ==
    7279
    73 Configuration wanted.
     80The configuration on Cherokee's side is quite simple. You will only need to know that you can spawn Trac as an SCGI process.
     81You can either start it manually, or better yet, automatically by letting Cherokee spawn the server whenever it is down.
     82First set up an information source in cherokee-admin with a local interpreter.
     83
     84{{{
     85Host:
     86localhost:4433
     87
     88Interpreter:
     89/usr/bin/tracd —single-env —daemonize —protocol=scgi —hostname=localhost —port=4433 /path/to/project/
     90}}}
     91
     92If the port was not reachable, the interpreter command would be launched. Note that, in the definition of the information source, you will have to manually launch the spawner if you use a ''Remote host'' as ''Information source'' instead of a ''Local interpreter''.
     93
     94After doing this, we will just have to create a new rule managed by the SCGI handler to access Trac. It can be created in a new virtual server, trac.example.net for instance, and will only need two rules. The '''default''' one will use the SCGI handler associated to the previously created information source.
     95The second rule will be there to serve the few static files needed to correctly display the Trac interface. Create it as ''Directory rule'' for ''/chrome/common'' and just set it to the ''Static files'' handler and with a ''Document root'' that points to the appropriate files: ''/usr/share/trac/htdocs/''
     96
     97Note:\\
     98If the tracd process fails to start up, and cherokee displays a 503 error page, you might be missing the [http://trac.saddi.com/flup python-flup] package.\\
     99Python-flup is a dependency which provides trac with SCGI capability. You can install it on debian based systems with:
     100{{{
     101sudo apt-get install python-flup
     102}}}
    74103
    75104== Simple Lighttpd Configuration ==
    … …  
    82111For using `trac.fcgi`(prior to 0.11) / fcgi_frontend.py (0.11) with lighttpd add the following to your lighttpd.conf:
    83112{{{
    84 #var.fcgi_binary="/path/to/fcgi_frontend.py" # 0.11 if installed with easy_setup, it is inside the egg directory
     113#var.fcgi_binary="/usr/bin/python /path/to/fcgi_frontend.py" # 0.11 if installed with easy_setup, it is inside the egg directory
    85114var.fcgi_binary="/path/to/cgi-bin/trac.fcgi" # 0.10 name of prior fcgi executable
    86115fastcgi.server = ("/trac" =>
    … …  
    100129and you may set one of the two in `trac.fcgi` instead of in `lighttpd.conf`
    101130using `bin-environment` (as in the section above on Apache configuration).
     131
     132Note 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.
    102133
    103134For using two projects with lighttpd add the following to your `lighttpd.conf`:
    … …  
    253284Note about running lighttpd with reduced permissions:
    254285
    255   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.
     286  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.
    256287
    257288
    … …  
    262293!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.
    263294
    264 Setup
    265 
    266 1) Please make sure you have first have a working install of a Trac project. Test install with “tracd” first.
    267 
    268 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:
     295=== Setup ===
     296
     297 1. Please make sure you have first have a working install of a Trac project. Test install with “tracd” first.
     298
     299 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:
    269300
    270301{{{
    … …  
    272303}}}
    273304
    274 3) Go “TracVhost → External Apps” tab and create a new “External Application”.
     305 3. Go “!TracVhost → External Apps” tab and create a new “External Application”.
    275306
    276307{{{
    … …  
    290321}}}
    291322
    292 4) Optional. If you need to use htpasswd based authentication. Go to “TracVhost → Security” tab and create a new security “Realm”.
     323 4. Optional. If you need to use htpasswd based authentication. Go to “!TracVhost → Security” tab and create a new security “Realm”.
    293324
    294325{{{
    … …  
    300331If 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.
    301332
    302 5) Go to “PythonVhost → Contexts” and create a new “FCGI Context”.
     333 5. Go to “!PythonVhost → Contexts” and create a new “FCGI Context”.
    303334
    304335{{{
    … …  
    308339}}}
    309340
    310 6) Modify /fullpathto/mytracproject/conf/trac.ini
     341 6. Modify `/fullpathto/mytracproject/conf/trac.ini`
    311342
    312343{{{
    … …  
    317348}}}
    318349
    319 7) Restart !LiteSpeed, “lswsctrl restart”, and access your new Trac project at:
     350 7. Restart !LiteSpeed, “lswsctrl restart”, and access your new Trac project at:
    320351
    321352{{{
    … …  
    323354}}}
    324355
    325 === Simple Nginx Configuration ===
    326 
    327 1) Nginx configuration snippet - confirmed to work on 0.5.36
     356== Simple Nginx Configuration ==
     357
     358 1. Nginx configuration snippet - confirmed to work on 0.6.32
    328359{{{
    329360    server {
    … …  
    341372        ssl_prefer_server_ciphers   on;
    342373
     374        # (Or ``^/some/prefix/(.*)``.
     375        if ($uri ~ ^/(.*)) {
     376             set $path_info /$1;
     377        }
     378
     379        # You can copy this whole location to ``location [/some/prefix]/login``
     380        # and remove the auth entries below if you want Trac to enforce
     381        # authorization where appropriate instead of needing to authenticate
     382        # for accessing the whole site.
     383        # (Or ``location /some/prefix``.)
    343384        location / {
    344385            auth_basic            "trac realm";
    345386            auth_basic_user_file /home/trac/htpasswd;
    346387
    347             # full path
    348             if ($uri ~ ^/([^/]+)(/.*)) {
    349                  set $script_name $1;
    350                  set $path_info $2;
    351             }
    352 
    353             # index redirect
    354             if ($uri ~ ^/([^/]+)$) {
    355                  rewrite (.+) $1/ permanent;
    356             }
    357          
    358388            # socket address
    359389            fastcgi_pass   unix:/home/trac/run/instance.sock;
    … …  
    363393
    364394            ## WSGI REQUIRED VARIABLES
    365             # WSGI application name - trac instance prefix.
    366             fastcgi_param  SCRIPT_NAME        /$script_name;
     395            # WSGI application name - trac instance prefix.
     396            # (Or ``fastcgi_param  SCRIPT_NAME  /some/prefix``.)
     397            fastcgi_param  SCRIPT_NAME        "";
    367398            fastcgi_param  PATH_INFO          $path_info;
    368399
    … …  
    372403            fastcgi_param  SERVER_PORT        $server_port;
    373404            fastcgi_param  SERVER_PROTOCOL    $server_protocol;
     405            fastcgi_param  QUERY_STRING     $query_string;
    374406
    375407            # for authentication to work
     408            fastcgi_param  AUTH_USER          $remote_user;
    376409            fastcgi_param  REMOTE_USER        $remote_user;
    377410        }
    … …  
    379412}}}
    380413
    381 2) Modified trac.fcgi:
     414 2. Modified trac.fcgi:
    382415
    383416{{{
    … …  
    413446}}}
    414447
    415 3) reload nginx and launch trac.fcgi like that:
     448 3. reload nginx and launch trac.fcgi like that:
    416449
    417450{{{
    … …  
    421454The above assumes that:
    422455 * There is a user named 'trac' for running trac instances and keeping trac environments in its home directory.
    423  * /home/trac/instance contains a trac environment
    424  * /home/trac/htpasswd contains authentication information
    425  * /home/trac/run is owned by the same group the nginx runs under
    426   * and if your system is Linux the /home/trac/run has setgid bit set (chmod g+s run)
     456 * `/home/trac/instance` contains a trac environment
     457 * `/home/trac/htpasswd` contains authentication information
     458 * `/home/trac/run` is owned by the same group the nginx runs under
     459  * and if your system is Linux the `/home/trac/run` has setgid bit set (`chmod g+s run`)
    427460  * and patch from ticket #T7239 is applied, or you'll have to fix the socket file permissions every time
    428461
    … …  
    435468
    436469----
    437 See also TracCgi, TracModPython, TracInstall, TracGuide, [trac:TracNginxRecipe TracNginxRecipe]
     470See also:  TracGuide, TracInstall, [wiki:TracModWSGI ModWSGI], [wiki:TracCgi CGI], [wiki:TracModPython ModPython], [trac:TracNginxRecipe TracNginxRecipe]