Changes between Version 1 and Version 2 of TracFastCgi


Ignore:
Timestamp:
03/16/11 19:34:05 (3 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracFastCgi

    v1 v2  
    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 {{{ 
    6 #!html 
    7 <p style="background: #fdc; border: 2px solid #d00; font-style: italic; padding: 0 .5em; margin: 1em 0;"> 
    8 <strong>Note for Windows:</strong> Trac's FCGI does not run under Windows, as Windows does not implement Socket.fromfd, which is used by _fcgi.py 
    9 </p> 
    10 }}} 
     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]. 
    116 
    127== Simple Apache configuration == 
    138 
    149There are two FastCGI modules commonly available for Apache: `mod_fastcgi` and 
    15 `mod_fcgid`.  The `FastCgiIpcDir` and `FastCgiConfig` directives discussed 
    16 below are `mod_fastcgi` directives; the `DefaultInitEnv` is a `mod_fcgid` 
    17 directive. 
    18  
    19 For `mod_fastcgi`, add the following to an appropriate Apache configuration 
    20 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: 
    2114{{{ 
    2215# Enable fastcgi for .fcgi files 
     
    4437}}} 
    4538 
    46 But neither of these will work for `mod_fcgid`.  A similar but partial 
    47 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 
    4851{{{ 
    4952DefaultInitEnv TRAC_ENV /path/to/env/trac/ 
    5053}}} 
    51 But this cannot be used in `Directory` or `Location` context, which makes it 
    52 difficult to support multiple projects. 
    53  
    54 A better method which works for both of these modules (and for  [http://www.lighttpd.net/ lighttpd] and CGI as well), because it involves 
    55 no server configuration settings for environment variables, is to set one 
    56 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): 
    5760{{{ 
    5861import os 
     
    6568}}} 
    6669 
    67 Using this method, different projects can be supported by using different 
    68 `.fcgi` scripts with different `ScriptAliases`, copying and appropriately 
    69 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`. 
    7072 
    7173See [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: 
     
    7678== Simple Cherokee Configuration == 
    7779 
    78 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}}} 
    79103 
    80104== Simple Lighttpd Configuration == 
     
    85109environments.  It has a very low memory footprint compared to other web servers and takes care of CPU load. 
    86110 
    87 For using `trac.fcgi` with lighttpd add the following to your lighttpd.conf: 
    88 {{{ 
     111For using `trac.fcgi`(prior to 0.11) / fcgi_frontend.py (0.11) with lighttpd add the following to your lighttpd.conf: 
     112{{{ 
     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 
     114var.fcgi_binary="/path/to/cgi-bin/trac.fcgi" # 0.10 name of prior fcgi executable 
    89115fastcgi.server = ("/trac" => 
     116    
    90117                   ("trac" => 
    91118                     ("socket" => "/tmp/trac-fastcgi.sock", 
    92                       "bin-path" => "/path/to/cgi-bin/trac.fcgi", 
     119                      "bin-path" => fcgi_binary, 
    93120                      "check-local" => "disable", 
    94121                      "bin-environment" => 
     
    103130using `bin-environment` (as in the section above on Apache configuration). 
    104131 
     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. 
     133 
    105134For using two projects with lighttpd add the following to your `lighttpd.conf`: 
    106135{{{ 
     
    108137                   ("first" => 
    109138                    ("socket" => "/tmp/trac-fastcgi-first.sock", 
    110                      "bin-path" => "/path/to/cgi-bin/trac.fcgi", 
     139                     "bin-path" => fcgi_binary, 
    111140                     "check-local" => "disable", 
    112141                     "bin-environment" => 
     
    117146                    ("second" => 
    118147                    ("socket" => "/tmp/trac-fastcgi-second.sock", 
    119                      "bin-path" => "/path/to/cgi-bin/trac.fcgi", 
     148                     "bin-path" => fcgi_binary, 
    120149                     "check-local" => "disable", 
    121150                     "bin-environment" => 
     
    131160if both are running from the same `trac.fcgi` script. 
    132161{{{ 
    133 #!html 
    134 <p style="background: #fdc; border: 2px solid #d00; font-style: italic; padding: 0 .5em; margin: 1em 0;"> 
    135 <strong>Note from c00i90wn:</strong> It's very important the order on which server.modules are loaded, if mod_auth is not loaded <strong>BEFORE</strong> mod_fastcgi, then the server will fail to authenticate the user. 
    136 </p> 
     162#!div class=important 
     163'''Note''' It's very important the order on which server.modules are loaded, if mod_auth is not loaded '''BEFORE''' mod_fastcgi, then the server will fail to authenticate the user. 
    137164}}} 
    138165For authentication you should enable mod_auth in lighttpd.conf 'server.modules', select auth.backend and auth rules: 
     
    193220                   ("trac" => 
    194221                     ("socket" => "/tmp/trac-fastcgi.sock", 
    195                       "bin-path" => "/path/to/cgi-bin/trac.fcgi", 
     222                      "bin-path" => fcgi_binary, 
    196223                      "check-local" => "disable", 
    197224                      "bin-environment" => 
     
    212239                        ( 
    213240                          "socket" => "/tmp/trac.sock", 
    214                           "bin-path" => "/path/to/cgi-bin/trac.fcgi", 
     241                          "bin-path" => fcgi_binary, 
    215242                          "check-local" => "disable", 
    216243                          "bin-environment" => 
     
    238265                   ("trac" => 
    239266                     ("socket" => "/tmp/trac-fastcgi.sock", 
    240                       "bin-path" => "/path/to/cgi-bin/trac.fcgi", 
     267                      "bin-path" => fcgi_binary, 
    241268                      "check-local" => "disable", 
    242269                      "bin-environment" => 
     
    247274                 ) 
    248275}}} 
    249 For details about languages specification see TracFaq question 2.13. 
     276For details about languages specification see [trac:TracFaq TracFaq] question 2.13. 
    250277 
    251278Other 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. 
     
    257284Note about running lighttpd with reduced permissions: 
    258285 
    259   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. 
    260  
    261  
    262 == Simple LiteSpeed Configuration == 
     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. 
     287 
     288 
     289== Simple !LiteSpeed Configuration == 
    263290 
    264291The FastCGI front-end was developed primarily for use with alternative webservers, such as [http://www.litespeedtech.com/ LiteSpeed]. 
    265292 
    266 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. 
    267  
    268 Setup 
    269  
    270 1) Please make sure you have first have a working install of a Trac project. Test install with “tracd” first. 
    271  
    272 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: 
     293!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. 
     294 
     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: 
    273300 
    274301{{{ 
     
    276303}}} 
    277304 
    278 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”. 
    279306 
    280307{{{ 
     
    294321}}} 
    295322 
    296 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”. 
    297324 
    298325{{{ 
     
    304331If 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. 
    305332 
    306 5) Go to “PythonVhost → Contexts” and create a new “FCGI Context”. 
     333 5. Go to “!PythonVhost → Contexts” and create a new “FCGI Context”. 
    307334 
    308335{{{ 
     
    312339}}} 
    313340 
    314 6) Modify /fullpathto/mytracproject/conf/trac.ini 
     341 6. Modify `/fullpathto/mytracproject/conf/trac.ini` 
    315342 
    316343{{{ 
     
    321348}}} 
    322349 
    323 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:  
    324351 
    325352{{{ 
     
    327354}}} 
    328355 
     356== Simple Nginx Configuration == 
     357 
     358 1. Nginx configuration snippet - confirmed to work on 0.6.32 
     359{{{ 
     360    server { 
     361        listen       10.9.8.7:443; 
     362        server_name  trac.example; 
     363 
     364        ssl                  on; 
     365        ssl_certificate      /etc/ssl/trac.example.crt; 
     366        ssl_certificate_key  /etc/ssl/trac.example.key; 
     367 
     368        ssl_session_timeout  5m; 
     369 
     370        ssl_protocols  SSLv2 SSLv3 TLSv1; 
     371        ssl_ciphers  ALL:!ADH:!EXPORT56:RC4+RSA:+HIGH:+MEDIUM:+LOW:+SSLv2:+EXP; 
     372        ssl_prefer_server_ciphers   on; 
     373 
     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``.) 
     384        location / { 
     385            auth_basic            "trac realm"; 
     386            auth_basic_user_file /home/trac/htpasswd; 
     387 
     388            # socket address 
     389            fastcgi_pass   unix:/home/trac/run/instance.sock; 
     390 
     391            # python - wsgi specific 
     392            fastcgi_param HTTPS on; 
     393 
     394            ## WSGI REQUIRED VARIABLES 
     395            # WSGI application name - trac instance prefix. 
     396            # (Or ``fastcgi_param  SCRIPT_NAME  /some/prefix``.) 
     397            fastcgi_param  SCRIPT_NAME        ""; 
     398            fastcgi_param  PATH_INFO          $path_info; 
     399 
     400            ## WSGI NEEDED VARIABLES - trac warns about them 
     401            fastcgi_param  REQUEST_METHOD     $request_method; 
     402            fastcgi_param  SERVER_NAME        $server_name; 
     403            fastcgi_param  SERVER_PORT        $server_port; 
     404            fastcgi_param  SERVER_PROTOCOL    $server_protocol; 
     405            fastcgi_param  QUERY_STRING     $query_string; 
     406 
     407            # for authentication to work 
     408            fastcgi_param  AUTH_USER          $remote_user; 
     409            fastcgi_param  REMOTE_USER        $remote_user; 
     410        } 
     411    } 
     412}}} 
     413 
     414 2. Modified trac.fcgi: 
     415 
     416{{{ 
     417#!/usr/bin/env python 
     418import os 
     419sockaddr = '/home/trac/run/instance.sock' 
     420os.environ['TRAC_ENV'] = '/home/trac/instance' 
     421 
     422try: 
     423     from trac.web.main import dispatch_request 
     424     import trac.web._fcgi 
     425 
     426     fcgiserv = trac.web._fcgi.WSGIServer(dispatch_request,  
     427          bindAddress = sockaddr, umask = 7) 
     428     fcgiserv.run() 
     429 
     430except SystemExit: 
     431    raise 
     432except Exception, e: 
     433    print 'Content-Type: text/plain\r\n\r\n', 
     434    print 'Oops...' 
     435    print 
     436    print 'Trac detected an internal error:' 
     437    print 
     438    print e 
     439    print 
     440    import traceback 
     441    import StringIO 
     442    tb = StringIO.StringIO() 
     443    traceback.print_exc(file=tb) 
     444    print tb.getvalue() 
     445 
     446}}} 
     447 
     448 3. reload nginx and launch trac.fcgi like that: 
     449 
     450{{{ 
     451trac@trac.example ~ $ ./trac-standalone-fcgi.py  
     452}}} 
     453 
     454The above assumes that: 
     455 * There is a user named 'trac' for running trac instances and keeping trac environments in its home directory. 
     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`) 
     460  * and patch from ticket #T7239 is applied, or you'll have to fix the socket file permissions every time 
     461 
     462Unfortunately nginx does not support variable expansion in fastcgi_pass directive.  
     463Thus it is not possible to serve multiple trac instances from one server block.  
     464 
     465If you worry enough about security, run trac instances under separate users.  
     466 
     467Another way to run trac as a FCGI external application is offered in ticket #T6224 
     468 
    329469---- 
    330 See also TracCgi, TracModPython, TracInstall, TracGuide 
     470See also:  TracGuide, TracInstall, [wiki:TracModWSGI ModWSGI], [wiki:TracCgi CGI], [wiki:TracModPython ModPython], [trac:TracNginxRecipe TracNginxRecipe]