Changes between Version 1 and Version 2 of TracFastCgi


Ignore:
Timestamp:
11/06/17 14:13:59 (19 months ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracFastCgi

    v1 v2  
     1[[PageOutline]] 
     2 
    13= Trac with FastCGI = 
    24 
    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]. 
     5[http://www.fastcgi.com/ FastCGI] interface allows Trac to remain resident much like with [wiki:TracModPython mod_python] or [wiki:TracModWSGI mod_wsgi]. It is faster than external CGI interfaces which must start a new process for each request.  Additionally, it is supported by much wider variety of web servers. 
     6 
     7Note that unlike mod_python, FastCGI supports [http://httpd.apache.org/docs/suexec.html Apache SuEXEC], i.e. run with different permissions than web server running with (`mod_wsgi` supports the `WSGIDaemonProcess` with user / group parameters to achieve the same effect). 
     8 
     9'''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]/[trac:TracOnWindowsIisAjp ISAPI]. 
     10 
     11[[PageOutline(2-3,Overview,inline)]] 
     12 
    613 
    714== Simple Apache configuration == 
    815 
    916There 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: 
     17`mod_fcgid` (preferred). The latter is more up-to-date. 
     18 
     19The following sections focus on the FCGI specific setup, see also [wiki:TracModWSGI#ConfiguringAuthentication] for configuring the authentication in Apache. 
     20 
     21Regardless of which cgi module is used, be sure the web server has executable permissions on the cgi-bin folder. While FastCGI will throw specific permissions errors, mod_fcgid will throw an ambiguous error if this has not been done. (Connection reset by peer: mod_fcgid: error reading data from FastCGI server)  
     22 
     23=== Set up with `mod_fastcgi` === 
     24`mod_fastcgi` uses `FastCgiIpcDir` and `FastCgiConfig` directives that should be added to an appropriate Apache configuration file: 
    1625{{{ 
    1726# Enable fastcgi for .fcgi files 
     
    2938calling `trac.fcgi` instead of `trac.cgi`. 
    3039 
    31 You can set up the `TRAC_ENV` as an overall default: 
     40Add the following to the Apache configuration file (below the `FastCgiIpcDir` line) if you intend to set up the `TRAC_ENV` as an overall default: 
    3241{{{ 
    3342FastCgiConfig -initial-env TRAC_ENV=/path/to/env/trac 
    3443}}} 
    3544 
    36 Or you can serve multiple Trac projects in a directory like: 
     45Alternatively, you can serve multiple Trac projects in a directory by adding this: 
    3746{{{ 
    3847FastCgiConfig -initial-env TRAC_ENV_PARENT_DIR=/parent/dir/of/projects 
    3948}}} 
    4049 
    41 But neither of these will work for `mod_fcgid`.  A similar but partial 
    42 solution for `mod_fcgid` is: 
     50=== Set up with `mod_fcgid` === 
     51Configure `ScriptAlias` (see TracCgi for details), but call `trac.fcgi` 
     52instead of `trac.cgi`. Note that slash at the end - it is important. 
     53{{{ 
     54ScriptAlias /trac /path/to/www/trac/cgi-bin/trac.fcgi/ 
     55}}} 
     56 
     57To set up Trac environment for `mod_fcgid` it is necessary to use 
     58`DefaultInitEnv` directive. It cannot be used in `Directory` or 
     59`Location` context, so if you need to support multiple projects, try 
     60alternative environment setup below. 
     61 
    4362{{{ 
    4463DefaultInitEnv TRAC_ENV /path/to/env/trac/ 
    4564}}} 
    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.: 
     65 
     66=== alternative environment setup === 
     67A better method to specify path to Trac environment is to embed the path 
     68into `trac.fcgi` script itself. That doesn't require configuration of server 
     69environment variables, works for both FastCgi modules 
     70(and for [http://www.lighttpd.net/ lighttpd] and CGI as well): 
    5271{{{ 
    5372import os 
     
    6079}}} 
    6180 
    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. 
     81With this method different projects can be supported by using different 
     82`.fcgi` scripts with different `ScriptAliases`. 
    6583 
    6684See [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: 
     
    7189== Simple Cherokee Configuration == 
    7290 
    73 Configuration wanted. 
     91The configuration on Cherokee's side is quite simple. You will only need to know that you can spawn Trac as an SCGI process. 
     92You can either start it manually, or better yet, automatically by letting Cherokee spawn the server whenever it is down. 
     93First set up an information source in cherokee-admin with a local interpreter. 
     94 
     95{{{ 
     96Host: 
     97localhost:4433 
     98 
     99Interpreter: 
     100/usr/bin/tracd —single-env —daemonize —protocol=scgi —hostname=localhost —port=4433 /path/to/project/ 
     101}}} 
     102 
     103If 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''. 
     104 
     105After 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. 
     106The second rule will be there to serve the few static files needed to correctly display the Trac interface. Create it as ''Directory rule'' for ''/common'' and just set it to the ''Static files'' handler and with a ''Document root'' that points to the appropriate files: ''$TRAC_LOCAL/htdocs/'' (where $TRAC_LOCAL is a directory defined by the user or the system administrator to place local trac resources). 
     107 
     108Note:\\ 
     109If 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.\\ 
     110Python-flup is a dependency which provides trac with SCGI capability. You can install it on debian based systems with: 
     111{{{ 
     112sudo apt-get install python-flup 
     113}}} 
     114 
    74115 
    75116== Simple Lighttpd Configuration == 
     
    82123For using `trac.fcgi`(prior to 0.11) / fcgi_frontend.py (0.11) with lighttpd add the following to your lighttpd.conf: 
    83124{{{ 
    84 #var.fcgi_binary="/path/to/fcgi_frontend.py" # 0.11 if installed with easy_setup, it is inside the egg directory 
     125#var.fcgi_binary="/usr/bin/python /path/to/fcgi_frontend.py" # 0.11 if installed with easy_setup, it is inside the egg directory 
    85126var.fcgi_binary="/path/to/cgi-bin/trac.fcgi" # 0.10 name of prior fcgi executable 
    86127fastcgi.server = ("/trac" => 
     
    100141and you may set one of the two in `trac.fcgi` instead of in `lighttpd.conf` 
    101142using `bin-environment` (as in the section above on Apache configuration). 
     143 
     144Note 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 [trac:#2418]). This should be fixed since lighttpd 1.4.23, and you may need to add `"fix-root-scriptname" => "enable"` as parameter of fastcgi.server. 
    102145 
    103146For using two projects with lighttpd add the following to your `lighttpd.conf`: 
     
    128171Note that the above will result in different processes in any event, even 
    129172if both are running from the same `trac.fcgi` script. 
     173 
    130174{{{ 
    131175#!div class=important 
    132176'''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. 
    133177}}} 
     178 
    134179For authentication you should enable mod_auth in lighttpd.conf 'server.modules', select auth.backend and auth rules: 
    135180{{{ 
     
    179224server.modules += ("mod_alias") 
    180225 
    181 # Setup an alias for the static resources 
     226# Set up an alias for the static resources 
    182227alias.url = ("/trac/chrome/common" => "/usr/share/trac/htdocs") 
    183228 
     
    245290For details about languages specification see [trac:TracFaq TracFaq] question 2.13. 
    246291 
    247 Other 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. 
    248  
    249 If you use trac-0.9, read [http://lists.edgewall.com/archive/trac/2005-November/005311.html about small bug] 
     292Other important information like the [wiki:TracInstall#MappingStaticResources mapping static resources advices] are useful for non-fastcgi specific installation aspects. 
     293] 
    250294 
    251295Relaunch lighttpd, and browse to `http://yourhost.example.org/trac` to access Trac. 
     
    253297Note about running lighttpd with reduced permissions: 
    254298 
    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. 
     299If 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. 
    256300 
    257301 
     
    262306!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. 
    263307 
    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: 
     308 1. Please make sure you have first have a working install of a Trac project. Test install with “tracd” first. 
     309 
     310 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: 
    269311 
    270312{{{ 
     
    272314}}} 
    273315 
    274 3) Go “TracVhost → External Apps” tab and create a new “External Application”. 
     316 3. Go “!TracVhost → External Apps” tab and create a new “External Application”. 
    275317 
    276318{{{ 
     
    290332}}} 
    291333 
    292 4) Optional. If you need to use htpasswd based authentication. Go to “TracVhost → Security” tab and create a new security “Realm”. 
     334 4. Optional. If you need to use htpasswd based authentication. Go to “!TracVhost → Security” tab and create a new security “Realm”. 
    293335 
    294336{{{ 
     
    300342If 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. 
    301343 
    302 5) Go to “PythonVhost → Contexts” and create a new “FCGI Context”. 
     344 5. Go to “!PythonVhost → Contexts” and create a new “FCGI Context”. 
    303345 
    304346{{{ 
     
    308350}}} 
    309351 
    310 6) Modify /fullpathto/mytracproject/conf/trac.ini 
     352 6. Modify `/fullpathto/mytracproject/conf/trac.ini` 
    311353 
    312354{{{ 
     
    317359}}} 
    318360 
    319 7) Restart !LiteSpeed, “lswsctrl restart”, and access your new Trac project at:  
     361 7. Restart !LiteSpeed, “lswsctrl restart”, and access your new Trac project at:  
    320362 
    321363{{{ 
     
    323365}}} 
    324366 
    325 === Simple Nginx Configuration === 
    326  
    327 1) Nginx configuration snippet - confirmed to work on 0.5.36 
     367 
     368== Simple Nginx Configuration == 
     369 
     370Nginx is able to communicate with FastCGI processes, but can not spawn them. So you need to start FastCGI server for Trac separately. 
     371 
     372 1. Nginx configuration with basic authentication handled by Nginx - confirmed to work on 0.6.32 
    328373{{{ 
    329374    server { 
     
    341386        ssl_prefer_server_ciphers   on; 
    342387 
     388        # (Or ``^/some/prefix/(.*)``. 
     389        if ($uri ~ ^/(.*)) { 
     390             set $path_info /$1; 
     391        } 
     392 
     393        # it makes sense to serve static resources through Nginx 
     394        location /chrome/ { 
     395             alias /home/trac/instance/static/htdocs/; 
     396        } 
     397 
     398        # You can copy this whole location to ``location [/some/prefix]/login`` 
     399        # and remove the auth entries below if you want Trac to enforce 
     400        # authorization where appropriate instead of needing to authenticate 
     401        # for accessing the whole site. 
     402        # (Or ``location /some/prefix``.) 
    343403        location / { 
    344404            auth_basic            "trac realm"; 
    345405            auth_basic_user_file /home/trac/htpasswd; 
    346406 
    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           
    358407            # socket address 
    359408            fastcgi_pass   unix:/home/trac/run/instance.sock; 
     
    363412 
    364413            ## WSGI REQUIRED VARIABLES 
    365             # WSGI application name - trac instance prefix.  
    366             fastcgi_param  SCRIPT_NAME        /$script_name; 
     414            # WSGI application name - trac instance prefix. 
     415            # (Or ``fastcgi_param  SCRIPT_NAME  /some/prefix``.) 
     416            fastcgi_param  SCRIPT_NAME        ""; 
    367417            fastcgi_param  PATH_INFO          $path_info; 
    368418 
     
    372422            fastcgi_param  SERVER_PORT        $server_port; 
    373423            fastcgi_param  SERVER_PROTOCOL    $server_protocol; 
    374  
    375             # for authentication to work 
     424            fastcgi_param  QUERY_STRING       $query_string; 
     425 
     426            # For Nginx authentication to work - do not forget to comment these 
     427            # lines if not using Nginx for authentication 
     428            fastcgi_param  AUTH_USER          $remote_user; 
    376429            fastcgi_param  REMOTE_USER        $remote_user; 
     430 
     431            # for ip to work 
     432            fastcgi_param REMOTE_ADDR         $remote_addr; 
     433 
     434            # For attchments to work 
     435            fastcgi_param    CONTENT_TYPE     $content_type; 
     436            fastcgi_param    CONTENT_LENGTH   $content_length; 
    377437        } 
    378438    } 
    379439}}} 
    380440 
    381 2) Modified trac.fcgi: 
     441 2. Modified trac.fcgi: 
    382442 
    383443{{{ 
     
    413473}}} 
    414474 
    415 3) reload nginx and launch trac.fcgi like that: 
     475 3. reload nginx and launch trac.fcgi like that: 
    416476 
    417477{{{ 
     
    421481The above assumes that: 
    422482 * 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) 
     483 * `/home/trac/instance` contains a trac environment 
     484 * `/home/trac/htpasswd` contains authentication information 
     485 * `/home/trac/run` is owned by the same group the nginx runs under 
     486  * and if your system is Linux the `/home/trac/run` has setgid bit set (`chmod g+s run`) 
    427487  * and patch from ticket #T7239 is applied, or you'll have to fix the socket file permissions every time 
    428488 
     
    435495 
    436496---- 
    437 See also TracCgi, TracModPython, TracInstall, TracGuide, [trac:TracNginxRecipe TracNginxRecipe] 
     497See also:  TracGuide, TracInstall, [wiki:TracModWSGI ModWSGI], [wiki:TracCgi CGI], [wiki:TracModPython ModPython], [trac:TracNginxRecipe TracNginxRecipe]