Changes between Version 4 and Version 5 of TracFastCgi


Ignore:
Timestamp:
08/08/15 13:07:49 (2 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracFastCgi

    v4 v5  
    1 [[PageOutline]] 
    2  
    3 = Trac with FastCGI = 
     1= Trac with FastCGI 
     2 
     3[[TracGuideToc]] 
     4[[PageOutline(2-5, Contents, floated)]] 
    45 
    56[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. 
    67 
    7 Note 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). 
     8Note that unlike mod_python, FastCGI supports [http://httpd.apache.org/docs/suexec.html Apache SuEXEC], ie run with different permissions than the web server runs with. `mod_wsgi` supports the `WSGIDaemonProcess` with user / group parameters to achieve the same effect. 
    89 
    910'''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]. 
    1011 
    11 [[PageOutline(2-3,Overview,inline)]] 
    12  
    13  
    14 == Simple Apache configuration == 
     12== Simple Apache configuration 
    1513 
    1614There are two FastCGI modules commonly available for Apache: `mod_fastcgi` and 
     
    1917The following sections focus on the FCGI specific setup, see also [wiki:TracModWSGI#ConfiguringAuthentication] for configuring the authentication in Apache. 
    2018 
    21 Regardless 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` === 
     19Regardless 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. 
     20 
     21=== Set up with `mod_fastcgi` 
     22 
    2423`mod_fastcgi` uses `FastCgiIpcDir` and `FastCgiConfig` directives that should be added to an appropriate Apache configuration file: 
    2524{{{ 
     
    4847}}} 
    4948 
    50 === Set up with `mod_fcgid` === 
    51 Configure `ScriptAlias` (see TracCgi for details), but call `trac.fcgi` 
    52 instead of `trac.cgi`. Note that slash at the end - it is important. 
     49=== Set up with `mod_fcgid` 
     50 
     51Configure `ScriptAlias` (see TracCgi for details), but call `trac.fcgi` instead of `trac.cgi`: 
    5352{{{ 
    5453ScriptAlias /trac /path/to/www/trac/cgi-bin/trac.fcgi/ 
    5554}}} 
    56  
    57 To 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 
    60 alternative environment setup below. 
     55Note the slash at the end. 
     56 
     57To set up Trac environment for `mod_fcgid` it is necessary to use `DefaultInitEnv` directive. It cannot be used in `Directory` or `Location` context, so if you need to support multiple projects, try alternative environment setup below. 
    6158 
    6259{{{ 
     
    6461}}} 
    6562 
    66 === alternative environment setup === 
    67 A better method to specify path to Trac environment is to embed the path 
    68 into `trac.fcgi` script itself. That doesn't require configuration of server 
    69 environment variables, works for both FastCgi modules 
    70 (and for [http://www.lighttpd.net/ lighttpd] and CGI as well): 
     63=== alternative environment setup 
     64 
     65A better method to specify path to the Trac environment is to embed the path into `trac.fcgi` script itself. That doesn't require configuration of the server environment variables, works for both [trac:FastCgi] modules as well as for [http://www.lighttpd.net/ lighttpd] and CGI: 
    7166{{{ 
    7267import os 
    7368os.environ['TRAC_ENV'] = "/path/to/projectenv" 
    7469}}} 
    75 or 
     70or: 
    7671{{{ 
    7772import os 
     
    7974}}} 
    8075 
    81 With this method different projects can be supported by using different 
    82 `.fcgi` scripts with different `ScriptAliases`. 
     76With this method different projects can be supported by using different `.fcgi` scripts with different `ScriptAliases`. 
    8377 
    8478See [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: 
     
    8781}}} 
    8882 
    89 == Simple Cherokee Configuration == 
     83== Simple Cherokee Configuration 
    9084 
    9185The configuration on Cherokee's side is quite simple. You will only need to know that you can spawn Trac as an SCGI process. 
    9286You can either start it manually, or better yet, automatically by letting Cherokee spawn the server whenever it is down. 
    93 First set up an information source in cherokee-admin with a local interpreter. 
     87First set up an information source in cherokee-admin with a local interpreter: 
    9488 
    9589{{{ 
     
    113107}}} 
    114108 
    115  
    116 == Simple Lighttpd Configuration == 
    117  
    118 The FastCGI front-end was developed primarily for use with alternative webservers, such as [http://www.lighttpd.net/ lighttpd]. 
    119  
    120 lighttpd is a secure, fast, compliant and very flexible web-server that has been optimized for high-performance 
    121 environments.  It has a very low memory footprint compared to other web servers and takes care of CPU load. 
    122  
    123 For using `trac.fcgi`(prior to 0.11) / fcgi_frontend.py (0.11) with lighttpd add the following to your lighttpd.conf: 
     109== Simple Lighttpd Configuration 
     110 
     111The FastCGI front-end was developed primarily for use with alternative webservers, such as [http://www.lighttpd.net/ Lighttpd]. 
     112 
     113Lighttpd is a secure, fast, compliant and very flexible web-server that has been optimized for high-performance environments. It has a very low memory footprint compared to other web servers and takes care of CPU load. 
     114 
     115For using `trac.fcgi`(prior to 0.11) / fcgi_frontend.py (0.11) with Lighttpd add the following to your lighttpd.conf: 
    124116{{{ 
    125117#var.fcgi_binary="/usr/bin/python /path/to/fcgi_frontend.py" # 0.11 if installed with easy_setup, it is inside the egg directory 
     
    138130}}} 
    139131 
    140 Note that you will need to add a new entry to `fastcgi.server` for each separate Trac instance that you wish to run. Alternatively, you may use the `TRAC_ENV_PARENT_DIR` variable instead of `TRAC_ENV` as described above, 
    141 and you may set one of the two in `trac.fcgi` instead of in `lighttpd.conf` 
    142 using `bin-environment` (as in the section above on Apache configuration). 
    143  
    144 Note 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. 
     132Note that you will need to add a new entry to `fastcgi.server` for each separate Trac instance that you wish to run. Alternatively, you may use the `TRAC_ENV_PARENT_DIR` variable instead of `TRAC_ENV` as described above, and you may set one of the two in `trac.fcgi` instead of in `lighttpd.conf` using `bin-environment`, as in the section above on Apache configuration. 
     133 
     134Note 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 is fixed in Lighttpd 1.5, and under Lighttpd 1.4.23 or later the workaround is to add `"fix-root-scriptname" => "enable"` as a parameter of fastcgi.server. 
    145135 
    146136For using two projects with lighttpd add the following to your `lighttpd.conf`: 
     
    166156                ) 
    167157}}} 
    168 Note that field values are different.  If you prefer setting the environment 
    169 variables in the `.fcgi` scripts, then copy/rename `trac.fcgi`, e.g., to 
    170 `first.fcgi` and `second.fcgi`, and reference them in the above settings. 
    171 Note that the above will result in different processes in any event, even 
    172 if both are running from the same `trac.fcgi` script. 
     158 
     159Note that field values are different. If you prefer setting the environment variables in the `.fcgi` scripts, then copy/rename `trac.fcgi`, eg to `first.fcgi` and `second.fcgi`, and reference them in the above settings. 
     160Note that the above will result in different processes in any event, even if both are running from the same `trac.fcgi` script. 
    173161 
    174162{{{ 
     
    213201               ) 
    214202 
    215  
    216 }}} 
    217 Note that lighttpd (I use version 1.4.3) stopped if password file doesn't exist. 
    218  
    219 Note that lighttpd doesn't support 'valid-user' in versions prior to 1.3.16. 
    220  
    221 Conditional configuration is also useful for mapping static resources, i.e. serving out images and CSS directly instead of through FastCGI: 
     203}}} 
     204Note that Lighttpd (v1.4.3) stops if the password file doesn't exist. 
     205 
     206Note that Lighttpd doesn't support 'valid-user' in versions prior to 1.3.16. 
     207 
     208Conditional configuration is also useful for mapping static resources, ie serving out images and CSS directly instead of through FastCGI: 
    222209{{{ 
    223210# Aliasing functionality is needed 
     
    243230} 
    244231}}} 
     232 
    245233The technique can be easily adapted for use with multiple projects by creating aliases for each of them, and wrapping the fastcgi.server declarations inside conditional configuration blocks. 
    246234Also there is another way to handle multiple projects and it's to use TRAC_ENV_PARENT_DIR instead of TRAC_ENV and use global auth, let's see an example: 
     
    274262}}} 
    275263 
    276 Changing date/time format also supported by lighttpd over environment variable LC_TIME 
     264Changing date/time format also supported by lighttpd over environment variable LC_TIME: 
    277265{{{ 
    278266fastcgi.server = ("/trac" => 
     
    293281] 
    294282 
    295 Relaunch lighttpd, and browse to `http://yourhost.example.org/trac` to access Trac. 
    296  
    297 Note about running lighttpd with reduced permissions: 
    298  
    299 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. 
    300  
    301  
    302 == Simple !LiteSpeed Configuration == 
     283Relaunch Lighttpd and browse to `http://yourhost.example.org/trac` to access Trac. 
     284 
     285Note about running Lighttpd with reduced permissions: 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 
     287== Simple !LiteSpeed Configuration 
    303288 
    304289The FastCGI front-end was developed primarily for use with alternative webservers, such as [http://www.litespeedtech.com/ LiteSpeed]. 
     
    306291!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. 
    307292 
    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: 
    311  
     293 1. Please make sure you have a working install of a Trac project. Test install with "tracd" first. 
     294 
     295 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: 
    312296{{{ 
    313297http://yourdomain.com/trac/ 
    314298}}} 
    315299 
    316  3. Go “!TracVhost → External Apps” tab and create a new “External Application”. 
    317  
     300 3. Go "!TracVhost → External Apps" tab and create a new "External Application". 
    318301{{{ 
    319302Name: MyTracFCGI         
     
    332315}}} 
    333316 
    334  4. Optional. If you need to use htpasswd based authentication. Go to “!TracVhost → Security” tab and create a new security “Realm”. 
     317 4. Optional: If you need to use htpasswd based authentication. Go to "!TracVhost → Security" tab and create a new security Realm. 
    335318 
    336319{{{ 
     
    342325If 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. 
    343326 
    344  5. Go to “!PythonVhost → Contexts” and create a new “FCGI Context”. 
     327 5. Go to "!PythonVhost → Contexts" and create a new FCGI Context. 
    345328 
    346329{{{ 
     
    365348}}} 
    366349 
    367  
    368 == Simple Nginx Configuration == 
     350== Simple Nginx Configuration 
    369351 
    370352Nginx is able to communicate with FastCGI processes, but can not spawn them. So you need to start FastCGI server for Trac separately. 
    371353 
    372354 1. Nginx configuration with basic authentication handled by Nginx - confirmed to work on 0.6.32 
    373 {{{ 
     355 {{{ 
    374356    server { 
    375357        listen       10.9.8.7:443; 
     
    386368        ssl_prefer_server_ciphers   on; 
    387369 
    388         # (Or ``^/some/prefix/(.*)``. 
    389         if ($uri ~ ^/(.*)) { 
    390              set $path_info /$1; 
     370        # it makes sense to serve static resources through Nginx (or ``~ [/some/prefix]/chrome/(.*)``) 
     371        location ~ /chrome/(.*) { 
     372             alias /home/trac/instance/static/htdocs/$1; 
    391373        } 
    392374 
    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`` 
     375        # You can copy this whole location to ``location [/some/prefix](/login)`` 
    399376        # and remove the auth entries below if you want Trac to enforce 
    400377        # authorization where appropriate instead of needing to authenticate 
    401378        # for accessing the whole site. 
    402         # (Or ``location /some/prefix``.) 
    403         location / { 
     379        # (Or ``~ location /some/prefix(/.*)``.) 
     380        location ~ (/.*) { 
    404381            auth_basic            "trac realm"; 
    405382            auth_basic_user_file /home/trac/htpasswd; 
     
    415392            # (Or ``fastcgi_param  SCRIPT_NAME  /some/prefix``.) 
    416393            fastcgi_param  SCRIPT_NAME        ""; 
    417             fastcgi_param  PATH_INFO          $path_info; 
     394            fastcgi_param  PATH_INFO          $1; 
    418395 
    419396            ## WSGI NEEDED VARIABLES - trac warns about them 
     
    438415    } 
    439416}}} 
    440  
    441  2. Modified trac.fcgi: 
    442  
    443 {{{ 
     417 1. Modified trac.fcgi: 
     418 {{{ 
    444419#!/usr/bin/env python 
    445420import os 
     
    472447 
    473448}}} 
    474  
    475  3. reload nginx and launch trac.fcgi like that: 
    476  
    477 {{{ 
     449 1. reload nginx and launch trac.fcgi like that:  
     450 {{{#!sh 
    478451trac@trac.example ~ $ ./trac-standalone-fcgi.py  
    479452}}} 
    480453 
    481454The above assumes that: 
    482  * There is a user named 'trac' for running trac instances and keeping trac environments in its home directory. 
     455 * There is a user named 'trac' for running trac instances and keeping trac environments in its home directory 
    483456 * `/home/trac/instance` contains a trac environment 
    484457 * `/home/trac/htpasswd` contains authentication information 
     
    488461 
    489462Unfortunately nginx does not support variable expansion in fastcgi_pass directive.  
    490 Thus it is not possible to serve multiple trac instances from one server block.  
    491  
    492 If you worry enough about security, run trac instances under separate users.  
    493  
    494 Another way to run trac as a FCGI external application is offered in ticket #T6224 
     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 
    495468 
    496469----