Changes between Version 1 and Version 2 of TracFastCgi


Ignore:
Timestamp:
08/23/10 11:39:44 (4 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. 
     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]. 
    46 
    57== Simple Apache configuration == 
    68 
    79There are two FastCGI modules commonly available for Apache: `mod_fastcgi` and 
    8 `mod_fcgid`.  The `FastCgiIpcDir` and `FastCgiConfig` directives discussed 
    9 below are `mod_fastcgi` directives; the `DefaultInitEnv` is a `mod_fgcid` 
    10 directive. 
    11  
    12 For `mod_fastcgi`, add the following to an appropriate Apache configuration 
    13 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: 
    1414{{{ 
    1515# Enable fastcgi for .fcgi files 
     
    3737}}} 
    3838 
    39 But neither of these will work for `mod_fcgid`.  A similar but partial 
    40 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 
    4151{{{ 
    4252DefaultInitEnv TRAC_ENV /path/to/env/trac/ 
    4353}}} 
    44 But this cannot be used in `Directory` or `Location` context, which makes it 
    45 difficult to support multiple projects. 
    46  
    47 A better method which works for both of these modules (and for  [http://www.lighttpd.net/ lighttpd] and CGI as well), because it involves 
    48 no server configuration settings for environment variables, is to set one 
    49 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): 
    5060{{{ 
    5161import os 
     
    5868}}} 
    5969 
    60 Using this method, different projects can be supported by using different 
    61 `.fcgi` scripts with different `ScriptAliases`, copying and appropriately 
    62 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`. 
     72 
     73See [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: 
     74{{{ 
     75ScriptAlias / /srv/tracsite/cgi-bin/trac.fcgi/ 
     76}}} 
     77 
     78== Simple Cherokee Configuration == 
     79 
     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/'' 
    6396 
    6497== Simple Lighttpd Configuration == 
     
    69102environments.  It has a very low memory footprint compared to other web servers and takes care of CPU load. 
    70103 
    71 For using `trac.fcgi` with lighttpd add the following to your lighttpd.conf: 
    72 {{{ 
     104For using `trac.fcgi`(prior to 0.11) / fcgi_frontend.py (0.11) with lighttpd add the following to your lighttpd.conf: 
     105{{{ 
     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 
     107var.fcgi_binary="/path/to/cgi-bin/trac.fcgi" # 0.10 name of prior fcgi executable 
    73108fastcgi.server = ("/trac" => 
     109    
    74110                   ("trac" => 
    75111                     ("socket" => "/tmp/trac-fastcgi.sock", 
    76                       "bin-path" => "/path/to/cgi-bin/trac.fcgi", 
     112                      "bin-path" => fcgi_binary, 
    77113                      "check-local" => "disable", 
    78114                      "bin-environment" => 
     
    87123using `bin-environment` (as in the section above on Apache configuration). 
    88124 
     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. 
     126 
    89127For using two projects with lighttpd add the following to your `lighttpd.conf`: 
    90128{{{ 
     
    92130                   ("first" => 
    93131                    ("socket" => "/tmp/trac-fastcgi-first.sock", 
    94                      "bin-path" => "/path/to/cgi-bin/trac.fcgi", 
     132                     "bin-path" => fcgi_binary, 
    95133                     "check-local" => "disable", 
    96134                     "bin-environment" => 
     
    101139                    ("second" => 
    102140                    ("socket" => "/tmp/trac-fastcgi-second.sock", 
    103                      "bin-path" => "/path/to/cgi-bin/trac.fcgi", 
     141                     "bin-path" => fcgi_binary, 
    104142                     "check-local" => "disable", 
    105143                     "bin-environment" => 
     
    115153if both are running from the same `trac.fcgi` script. 
    116154{{{ 
    117 #!html 
    118 <p style="background: #fdc; border: 2px solid #d00; font-style: italic; padding: 0 .5em; margin: 1em 0;"> 
    119 <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. 
    120 </p> 
     155#!div class=important 
     156'''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. 
    121157}}} 
    122158For authentication you should enable mod_auth in lighttpd.conf 'server.modules', select auth.backend and auth rules: 
     
    177213                   ("trac" => 
    178214                     ("socket" => "/tmp/trac-fastcgi.sock", 
    179                       "bin-path" => "/path/to/cgi-bin/trac.fcgi", 
     215                      "bin-path" => fcgi_binary, 
    180216                      "check-local" => "disable", 
    181217                      "bin-environment" => 
     
    196232                        ( 
    197233                          "socket" => "/tmp/trac.sock", 
    198                           "bin-path" => "/path/to/cgi-bin/trac.fcgi", 
     234                          "bin-path" => fcgi_binary, 
    199235                          "check-local" => "disable", 
    200236                          "bin-environment" => 
     
    222258                   ("trac" => 
    223259                     ("socket" => "/tmp/trac-fastcgi.sock", 
    224                       "bin-path" => "/path/to/cgi-bin/trac.fcgi", 
     260                      "bin-path" => fcgi_binary, 
    225261                      "check-local" => "disable", 
    226262                      "bin-environment" => 
     
    231267                 ) 
    232268}}} 
    233 For details about languages specification see TracFaq question 2.13. 
     269For details about languages specification see [trac:TracFaq TracFaq] question 2.13. 
    234270 
    235271Other 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. 
     
    241277Note about running lighttpd with reduced permissions: 
    242278 
    243   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. 
    244  
    245  
    246 == Simple LiteSpeed Configuration == 
     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. 
     280 
     281 
     282== Simple !LiteSpeed Configuration == 
    247283 
    248284The FastCGI front-end was developed primarily for use with alternative webservers, such as [http://www.litespeedtech.com/ LiteSpeed]. 
    249285 
    250 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. 
    251  
    252 Setup 
    253  
    254 1) Please make sure you have first have a working install of a Trac project. Test install with “tracd” first. 
    255  
    256 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: 
     286!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. 
     287 
     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: 
    257293 
    258294{{{ 
     
    260296}}} 
    261297 
    262 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”. 
    263299 
    264300{{{ 
     
    278314}}} 
    279315 
    280 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”. 
    281317 
    282318{{{ 
     
    288324If 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. 
    289325 
    290 5) Go to “PythonVhost → Contexts” and create a new “FCGI Context”. 
     326 5. Go to “!PythonVhost → Contexts” and create a new “FCGI Context”. 
    291327 
    292328{{{ 
    293329URI: /trac/                              <--- URI path to bind to python fcgi app we created     
    294330Fast CGI App: [VHost Level] MyTractFCGI  <--- select the trac fcgi extapp we just created 
    295 Realm: TracUserDB                        <--- only if (4) is set. select ream created in (4) 
    296 }}} 
    297  
    298 6) Modify /fullpathto/mytracproject/conf/trac.ini 
     331Realm: TracUserDB                        <--- only if (4) is set. select realm created in (4) 
     332}}} 
     333 
     334 6. Modify `/fullpathto/mytracproject/conf/trac.ini` 
    299335 
    300336{{{ 
     
    305341}}} 
    306342 
    307 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:  
    308344 
    309345{{{ 
     
    311347}}} 
    312348 
     349== Simple Nginx Configuration == 
     350 
     351 1. Nginx configuration snippet - confirmed to work on 0.6.32 
     352{{{ 
     353    server { 
     354        listen       10.9.8.7:443; 
     355        server_name  trac.example; 
     356 
     357        ssl                  on; 
     358        ssl_certificate      /etc/ssl/trac.example.crt; 
     359        ssl_certificate_key  /etc/ssl/trac.example.key; 
     360 
     361        ssl_session_timeout  5m; 
     362 
     363        ssl_protocols  SSLv2 SSLv3 TLSv1; 
     364        ssl_ciphers  ALL:!ADH:!EXPORT56:RC4+RSA:+HIGH:+MEDIUM:+LOW:+SSLv2:+EXP; 
     365        ssl_prefer_server_ciphers   on; 
     366 
     367        # (Or ``^/some/prefix/(.*)``. 
     368        if ($uri ~ ^/(.*)) { 
     369             set $path_info /$1; 
     370        } 
     371 
     372        # You can copy this whole location to ``location [/some/prefix]/login`` 
     373        # and remove the auth entries below if you want Trac to enforce 
     374        # authorization where appropriate instead of needing to authenticate 
     375        # for accessing the whole site. 
     376        # (Or ``location /some/prefix``.) 
     377        location / { 
     378            auth_basic            "trac realm"; 
     379            auth_basic_user_file /home/trac/htpasswd; 
     380 
     381            # socket address 
     382            fastcgi_pass   unix:/home/trac/run/instance.sock; 
     383 
     384            # python - wsgi specific 
     385            fastcgi_param HTTPS on; 
     386 
     387            ## WSGI REQUIRED VARIABLES 
     388            # WSGI application name - trac instance prefix. 
     389            # (Or ``fastcgi_param  SCRIPT_NAME  /some/prefix``.) 
     390            fastcgi_param  SCRIPT_NAME        ""; 
     391            fastcgi_param  PATH_INFO          $path_info; 
     392 
     393            ## WSGI NEEDED VARIABLES - trac warns about them 
     394            fastcgi_param  REQUEST_METHOD     $request_method; 
     395            fastcgi_param  SERVER_NAME        $server_name; 
     396            fastcgi_param  SERVER_PORT        $server_port; 
     397            fastcgi_param  SERVER_PROTOCOL    $server_protocol; 
     398            fastcgi_param  QUERY_STRING     $query_string; 
     399 
     400            # for authentication to work 
     401            fastcgi_param  AUTH_USER          $remote_user; 
     402            fastcgi_param  REMOTE_USER        $remote_user; 
     403        } 
     404    } 
     405}}} 
     406 
     407 2. Modified trac.fcgi: 
     408 
     409{{{ 
     410#!/usr/bin/env python 
     411import os 
     412sockaddr = '/home/trac/run/instance.sock' 
     413os.environ['TRAC_ENV'] = '/home/trac/instance' 
     414 
     415try: 
     416     from trac.web.main import dispatch_request 
     417     import trac.web._fcgi 
     418 
     419     fcgiserv = trac.web._fcgi.WSGIServer(dispatch_request,  
     420          bindAddress = sockaddr, umask = 7) 
     421     fcgiserv.run() 
     422 
     423except SystemExit: 
     424    raise 
     425except Exception, e: 
     426    print 'Content-Type: text/plain\r\n\r\n', 
     427    print 'Oops...' 
     428    print 
     429    print 'Trac detected an internal error:' 
     430    print 
     431    print e 
     432    print 
     433    import traceback 
     434    import StringIO 
     435    tb = StringIO.StringIO() 
     436    traceback.print_exc(file=tb) 
     437    print tb.getvalue() 
     438 
     439}}} 
     440 
     441 3. reload nginx and launch trac.fcgi like that: 
     442 
     443{{{ 
     444trac@trac.example ~ $ ./trac-standalone-fcgi.py  
     445}}} 
     446 
     447The above assumes that: 
     448 * 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`) 
     453  * and patch from ticket #T7239 is applied, or you'll have to fix the socket file permissions every time 
     454 
     455Unfortunately nginx does not support variable expansion in fastcgi_pass directive.  
     456Thus it is not possible to serve multiple trac instances from one server block.  
     457 
     458If you worry enough about security, run trac instances under separate users.  
     459 
     460Another way to run trac as a FCGI external application is offered in ticket #T6224 
     461 
    313462---- 
    314 See also TracCgi, TracModPython, TracInstall, TracGuide 
     463See also:  TracGuide, TracInstall, [wiki:TracModWSGI ModWSGI], [wiki:TracCgi CGI], [wiki:TracModPython ModPython], [trac:TracNginxRecipe TracNginxRecipe]