Changes between Version 5 and Version 6 of TracFastCgi


Ignore:
Timestamp:
Dec 2, 2009, 4:25:55 PM (14 years ago)
Author:
trac
Comment:

—

Legend:

Unmodified
Added
Removed
Modified

  • TracFastCgi

    v5 v6  
    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:
    43 {{{
    44 DefaultInitEnv TRAC_ENV /path/to/env/trac/
    45 }}}
    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.:
     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`FCGIDDefaultInitEnv` 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
     51{{{
     52FCGIDDefaultInitEnv TRAC_ENV /path/to/env/trac/
     53}}}
     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/''
    7496
    7597== Simple Lighttpd Configuration ==
    … …  
    82104For using `trac.fcgi`(prior to 0.11) / fcgi_frontend.py (0.11) with lighttpd add the following to your lighttpd.conf:
    83105{{{
    84 #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
    85107var.fcgi_binary="/path/to/cgi-bin/trac.fcgi" # 0.10 name of prior fcgi executable
    86108fastcgi.server = ("/trac" =>
    … …  
    243265                 )
    244266}}}
    245 For details about languages specification see TracFaq question 2.13.
     267For details about languages specification see [trac:TracFaq TracFaq] question 2.13.
    246268
    247269Other important information like [http://trac.lighttpd.net/trac/wiki/TracInstall this updated TracInstall page], [wiki:TracCgi#MappingStaticResources and this] are useful for non-fastcgi specific installation aspects.
    … …  
    256278
    257279
    258 == Simple LiteSpeed Configuration ==
     280== Simple !LiteSpeed Configuration ==
    259281
    260282The FastCGI front-end was developed primarily for use with alternative webservers, such as [http://www.litespeedtech.com/ LiteSpeed].
    261283
    262 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.
     284!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.
    263285
    264286Setup
    … …  
    317339}}}
    318340
    319 7) Restart LiteSpeed, “lswsctrl restart”, and access your new Trac project at:
     3417) Restart !LiteSpeed, “lswsctrl restart”, and access your new Trac project at:
    320342
    321343{{{
    … …  
    325347=== Simple Nginx Configuration ===
    326348
    327 1) Nginx configuration snippet - confirmed to work on 0.5.36
     3491) Nginx configuration snippet - confirmed to work on 0.6.32
    328350{{{
    329351    server {
    … …  
    341363        ssl_prefer_server_ciphers   on;
    342364
     365        # (Or ``^/some/prefix/(.*)``.
     366        if ($uri ~ ^/(.*)) {
     367             set $path_info /$1;
     368        }
     369
     370        # You can copy this whole location to ``location [/some/prefix]/login``
     371        # and remove the auth entries below if you want Trac to enforce
     372        # authorization where appropriate instead of needing to authenticate
     373        # for accessing the whole site.
     374        # (Or ``location /some/prefix``.)
    343375        location / {
    344376            auth_basic            "trac realm";
    345377            auth_basic_user_file /home/trac/htpasswd;
    346378
    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          
    358379            # socket address
    359380            fastcgi_pass   unix:/home/trac/run/instance.sock;
    … …  
    363384
    364385            ## WSGI REQUIRED VARIABLES
    365             # WSGI application name - trac instance prefix.
    366             fastcgi_param  SCRIPT_NAME        /$script_name;
     386            # WSGI application name - trac instance prefix.
     387            # (Or ``fastcgi_param  SCRIPT_NAME  /some/prefix``.)
     388            fastcgi_param  SCRIPT_NAME        "";
    367389            fastcgi_param  PATH_INFO          $path_info;
    368390
    … …  
    374396
    375397            # for authentication to work
     398            fastcgi_param  AUTH_USER          $remote_user;
    376399            fastcgi_param  REMOTE_USER        $remote_user;
    377400        }
    … …  
    425448 * /home/trac/run is owned by the same group the nginx runs under
    426449  * and if your system is Linux the /home/trac/run has setgid bit set (chmod g+s run)
    427   * and patch from ticket #7239 is applied, or you'll have to fix the socket file permissions every time
     450  * and patch from ticket #T7239 is applied, or you'll have to fix the socket file permissions every time
    428451
    429452Unfortunately nginx does not support variable expansion in fastcgi_pass directive.
    … …  
    432455If you worry enough about security, run trac instances under separate users.
    433456
    434 Another way to run trac as a FCGI external application is offered in ticket #6224
     457Another way to run trac as a FCGI external application is offered in ticket #T6224
    435458
    436459----
    437 See also TracCgi, TracModPython, TracInstall, TracGuide, [Trac:TracNginxRecipe]
     460See also:  TracGuide, TracInstall, [wiki:TracModWSGI ModWSGI], [wiki:TracCgi CGI], [wiki:TracModPython ModPython], [trac:TracNginxRecipe TracNginxRecipe]