Changes between Version 3 and Version 4 of TracFastCgi


Ignore:
Timestamp:
2015-03-21T12:46:07Z (5 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracFastCgi

    v3 v4  
    1 = Trac with FastCGI =
    2 
    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].
    6 
    7 == Simple Apache configuration ==
     1= Trac with FastCGI
     2
     3[[TracGuideToc]]
     4[[PageOutline(2-5, Contents, floated)]]
     5
     6[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.
     7
     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.
     9
     10'''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].
     11
     12== Simple Apache configuration
    813
    914There are two FastCGI modules commonly available for Apache: `mod_fastcgi` and
    1015`mod_fcgid` (preferred). The latter is more up-to-date.
    1116
    12 ==== setup with `mod_fastcgi` ====
     17The following sections focus on the FCGI specific setup, see also [wiki:TracModWSGI#ConfiguringAuthentication] for configuring the authentication in Apache.
     18
     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
    1323`mod_fastcgi` uses `FastCgiIpcDir` and `FastCgiConfig` directives that should be added to an appropriate Apache configuration file:
    1424{{{
     
    2737calling `trac.fcgi` instead of `trac.cgi`.
    2838
    29 You can set up the `TRAC_ENV` as an overall default:
     39Add the following to the Apache configuration file (below the `FastCgiIpcDir` line) if you intend to set up the `TRAC_ENV` as an overall default:
    3040{{{
    3141FastCgiConfig -initial-env TRAC_ENV=/path/to/env/trac
    3242}}}
    3343
    34 Or you can serve multiple Trac projects in a directory like:
     44Alternatively, you can serve multiple Trac projects in a directory by adding this:
    3545{{{
    3646FastCgiConfig -initial-env TRAC_ENV_PARENT_DIR=/parent/dir/of/projects
    3747}}}
    3848
    39 ==== setup with `mod_fcgid` ====
    40 Configure `ScriptAlias` (see TracCgi for details), but call `trac.fcgi`
    41 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`:
    4252{{{
    4353ScriptAlias /trac /path/to/www/trac/cgi-bin/trac.fcgi/
    4454}}}
    45 
    46 To 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
    49 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.
    5058
    5159{{{
     
    5361}}}
    5462
    55 ==== alternative environment setup ====
    56 A better method to specify path to Trac environment it to embed the path
    57 into `trac.fcgi` script itself. That doesn't require configuration of server
    58 environment variables, works for both FastCgi modules
    59 (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:
    6066{{{
    6167import os
    6268os.environ['TRAC_ENV'] = "/path/to/projectenv"
    6369}}}
    64 or
     70or:
    6571{{{
    6672import os
     
    6874}}}
    6975
    70 With this method different projects can be supported by using different
    71 `.fcgi` scripts with different `ScriptAliases`.
     76With this method different projects can be supported by using different `.fcgi` scripts with different `ScriptAliases`.
    7277
    7378See [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:
     
    7681}}}
    7782
    78 == Simple Cherokee Configuration ==
     83== Simple Cherokee Configuration
    7984
    8085The configuration on Cherokee's side is quite simple. You will only need to know that you can spawn Trac as an SCGI process.
    8186You can either start it manually, or better yet, automatically by letting Cherokee spawn the server whenever it is down.
    82 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:
    8388
    8489{{{
     
    9398
    9499After 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.
    95 The 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/''
     100The 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).
    96101
    97102Note:\\
     
    102107}}}
    103108
    104 == Simple Lighttpd Configuration ==
    105 
    106 The FastCGI front-end was developed primarily for use with alternative webservers, such as [http://www.lighttpd.net/ lighttpd].
    107 
    108 lighttpd is a secure, fast, compliant and very flexible web-server that has been optimized for high-performance
    109 environments.  It has a very low memory footprint compared to other web servers and takes care of CPU load.
    110 
    111 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:
    112116{{{
    113117#var.fcgi_binary="/usr/bin/python /path/to/fcgi_frontend.py" # 0.11 if installed with easy_setup, it is inside the egg directory
     
    126130}}}
    127131
    128 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,
    129 and you may set one of the two in `trac.fcgi` instead of in `lighttpd.conf`
    130 using `bin-environment` (as in the section above on Apache configuration).
    131 
    132 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 #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.
     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.
    133135
    134136For using two projects with lighttpd add the following to your `lighttpd.conf`:
     
    154156                )
    155157}}}
    156 Note that field values are different.  If you prefer setting the environment
    157 variables in the `.fcgi` scripts, then copy/rename `trac.fcgi`, e.g., to
    158 `first.fcgi` and `second.fcgi`, and reference them in the above settings.
    159 Note that the above will result in different processes in any event, even
    160 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.
     161
    161162{{{
    162163#!div class=important
    163164'''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.
    164165}}}
     166
    165167For authentication you should enable mod_auth in lighttpd.conf 'server.modules', select auth.backend and auth rules:
    166168{{{
     
    199201               )
    200202
    201 
    202 }}}
    203 Note that lighttpd (I use version 1.4.3) stopped if password file doesn't exist.
    204 
    205 Note that lighttpd doesn't support 'valid-user' in versions prior to 1.3.16.
    206 
    207 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:
    208209{{{
    209210# Aliasing functionality is needed
    210211server.modules += ("mod_alias")
    211212
    212 # Setup an alias for the static resources
     213# Set up an alias for the static resources
    213214alias.url = ("/trac/chrome/common" => "/usr/share/trac/htdocs")
    214215
     
    229230}
    230231}}}
     232
    231233The 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.
    232234Also 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:
     
    260262}}}
    261263
    262 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:
    263265{{{
    264266fastcgi.server = ("/trac" =>
     
    276278For details about languages specification see [trac:TracFaq TracFaq] question 2.13.
    277279
    278 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.
    279 
    280 If you use trac-0.9, read [http://lists.edgewall.com/archive/trac/2005-November/005311.html about small bug]
    281 
    282 Relaunch lighttpd, and browse to `http://yourhost.example.org/trac` to access Trac.
    283 
    284 Note about running lighttpd with reduced permissions:
    285 
    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 ==
     280Other important information like the [wiki:TracInstall#MappingStaticResources mapping static resources advices] are useful for non-fastcgi specific installation aspects.
     281]
     282
     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
    290288
    291289The FastCGI front-end was developed primarily for use with alternative webservers, such as [http://www.litespeedtech.com/ LiteSpeed].
     
    293291!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.
    294292
    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:
    300 
     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:
    301296{{{
    302297http://yourdomain.com/trac/
    303298}}}
    304299
    305  3. Go “!TracVhost → External Apps” tab and create a new “External Application”.
    306 
     300 3. Go "!TracVhost → External Apps" tab and create a new "External Application".
    307301{{{
    308302Name: MyTracFCGI       
     
    321315}}}
    322316
    323  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.
    324318
    325319{{{
     
    331325If 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.
    332326
    333  5. Go to “!PythonVhost → Contexts” and create a new “FCGI Context”.
     327 5. Go to "!PythonVhost → Contexts" and create a new FCGI Context.
    334328
    335329{{{
     
    354348}}}
    355349
    356 == Simple Nginx Configuration ==
    357 
    358  1. Nginx configuration snippet - confirmed to work on 0.6.32
    359 {{{
     350== Simple Nginx Configuration
     351
     352Nginx is able to communicate with FastCGI processes, but can not spawn them. So you need to start FastCGI server for Trac separately.
     353
     354 1. Nginx configuration with basic authentication handled by Nginx - confirmed to work on 0.6.32
     355 {{{
    360356    server {
    361357        listen       10.9.8.7:443;
     
    372368        ssl_prefer_server_ciphers   on;
    373369
    374         # (Or ``^/some/prefix/(.*)``.
    375         if ($uri ~ ^/(.*)) {
    376              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;
    377373        }
    378374
    379         # You can copy this whole location to ``location [/some/prefix]/login``
     375        # You can copy this whole location to ``location [/some/prefix](/login)``
    380376        # and remove the auth entries below if you want Trac to enforce
    381377        # authorization where appropriate instead of needing to authenticate
    382378        # for accessing the whole site.
    383         # (Or ``location /some/prefix``.)
    384         location / {
     379        # (Or ``~ location /some/prefix(/.*)``.)
     380        location ~ (/.*) {
    385381            auth_basic            "trac realm";
    386382            auth_basic_user_file /home/trac/htpasswd;
     
    396392            # (Or ``fastcgi_param  SCRIPT_NAME  /some/prefix``.)
    397393            fastcgi_param  SCRIPT_NAME        "";
    398             fastcgi_param  PATH_INFO          $path_info;
     394            fastcgi_param  PATH_INFO          $1;
    399395
    400396            ## WSGI NEEDED VARIABLES - trac warns about them
     
    403399            fastcgi_param  SERVER_PORT        $server_port;
    404400            fastcgi_param  SERVER_PROTOCOL    $server_protocol;
    405             fastcgi_param  QUERY_STRING     $query_string;
    406 
    407             # for authentication to work
     401            fastcgi_param  QUERY_STRING       $query_string;
     402
     403            # For Nginx authentication to work - do not forget to comment these
     404            # lines if not using Nginx for authentication
    408405            fastcgi_param  AUTH_USER          $remote_user;
    409406            fastcgi_param  REMOTE_USER        $remote_user;
     407
     408            # for ip to work
     409            fastcgi_param REMOTE_ADDR         $remote_addr;
     410
     411            # For attchments to work
     412            fastcgi_param    CONTENT_TYPE     $content_type;
     413            fastcgi_param    CONTENT_LENGTH   $content_length;
    410414        }
    411415    }
    412416}}}
    413 
    414  2. Modified trac.fcgi:
    415 
    416 {{{
     417 1. Modified trac.fcgi:
     418 {{{
    417419#!/usr/bin/env python
    418420import os
     
    445447
    446448}}}
    447 
    448  3. reload nginx and launch trac.fcgi like that:
    449 
    450 {{{
     449 1. reload nginx and launch trac.fcgi like that:
     450 {{{#!sh
    451451trac@trac.example ~ $ ./trac-standalone-fcgi.py
    452452}}}
    453453
    454454The above assumes that:
    455  * 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
    456456 * `/home/trac/instance` contains a trac environment
    457457 * `/home/trac/htpasswd` contains authentication information
     
    461461
    462462Unfortunately nginx does not support variable expansion in fastcgi_pass directive.
    463 Thus it is not possible to serve multiple trac instances from one server block.
    464 
    465 If you worry enough about security, run trac instances under separate users.
    466 
    467 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
    468468
    469469----