Changes between Version 4 and Version 5 of TracFastCgi


Ignore:
Timestamp:
Jun 27, 2018 1:17:52 PM (11 months ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracFastCgi

    v4 v5  
    44[[PageOutline(2-5, Contents, floated)]]
    55
    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.
     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 a much wider variety of web servers.
    77
    88Note 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.
     
    1010'''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].
    1111
    12 == Simple Apache configuration
    13 
    14 There are two FastCGI modules commonly available for Apache: `mod_fastcgi` and
    15 `mod_fcgid` (preferred). The latter is more up-to-date.
     12== Apache configuration
     13
     14There are two FastCGI modules commonly available for Apache: `mod_fastcgi` and `mod_fcgid` (preferred). The latter is more up-to-date.
    1615
    1716The following sections focus on the FCGI specific setup, see also [wiki:TracModWSGI#ConfiguringAuthentication] for configuring the authentication in Apache.
    1817
    19 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.
     18Regardless 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`.
    2019
    2120=== Set up with `mod_fastcgi`
    2221
    2322`mod_fastcgi` uses `FastCgiIpcDir` and `FastCgiConfig` directives that should be added to an appropriate Apache configuration file:
    24 {{{
     23{{{#!apache
    2524# Enable fastcgi for .fcgi files
    2625# (If you're using a distro package for mod_fcgi, something like
     
    3231LoadModule fastcgi_module /usr/lib/apache2/modules/mod_fastcgi.so
    3332}}}
     33
    3434Setting `FastCgiIpcDir` is optional if the default is suitable. Note that the `LoadModule` line must be after the `IfModule` group.
    3535
    36 Configure `ScriptAlias` or similar options as described in TracCgi, but
    37 calling `trac.fcgi` instead of `trac.cgi`.
     36Configure `ScriptAlias` or similar options as described in TracCgi, but calling `trac.fcgi` instead of `trac.cgi`.
    3837
    3938Add the following to the Apache configuration file (below the `FastCgiIpcDir` line) if you intend to set up the `TRAC_ENV` as an overall default:
    40 {{{
     39{{{#!apache
    4140FastCgiConfig -initial-env TRAC_ENV=/path/to/env/trac
    4241}}}
    4342
    4443Alternatively, you can serve multiple Trac projects in a directory by adding this:
    45 {{{
     44{{{#!apache
    4645FastCgiConfig -initial-env TRAC_ENV_PARENT_DIR=/parent/dir/of/projects
    4746}}}
    4847
     48You can also specify the `PYTHON_EGG_CACHE` environment variable using a second `-initial-env` directive:
     49{{{#!apache
     50FastCgiConfig -initial-env TRAC_ENV=/var/lib/trac \
     51    -initial-env PYTHON_EGG_CACHE=/var/lib/trac/plugin-cache
     52}}}
     53
    4954=== Set up with `mod_fcgid`
    5055
    5156Configure `ScriptAlias` (see TracCgi for details), but call `trac.fcgi` instead of `trac.cgi`:
    52 {{{
     57{{{#!apache
    5358ScriptAlias /trac /path/to/www/trac/cgi-bin/trac.fcgi/
    5459}}}
     60
    5561Note the slash at the end.
    5662
    57 To 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.
    58 
    59 {{{
     63To 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 the alternative environment setup below:
     64{{{#!apache
    6065DefaultInitEnv TRAC_ENV /path/to/env/trac/
    6166}}}
    6267
    63 === alternative environment setup
    64 
    65 A 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:
    66 {{{
     68=== Alternative environment setup
     69
     70A better method to specify the 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:
     71{{{#!python
    6772import os
    6873os.environ['TRAC_ENV'] = "/path/to/projectenv"
    6974}}}
     75
    7076or:
    71 {{{
     77{{{#!python
    7278import os
    7379os.environ['TRAC_ENV_PARENT_DIR'] = "/path/to/project/parent/dir"
     
    7783
    7884See [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:
    79 {{{
     85{{{#!apache
    8086ScriptAlias / /srv/tracsite/cgi-bin/trac.fcgi/
    8187}}}
    8288
    83 == Simple Cherokee Configuration
    84 
    85 The configuration on Cherokee's side is quite simple. You will only need to know that you can spawn Trac as an SCGI process.
    86 You can either start it manually, or better yet, automatically by letting Cherokee spawn the server whenever it is down.
     89== Cherokee Configuration
     90
     91Configuring [http://cherokee-project.com/ Cherokee] with Trac is straightforward, if you spawn Trac as an SCGI process. You can either start it manually, or better yet, automatically by letting Cherokee spawn the server whenever it is down.
     92
    8793First set up an information source in cherokee-admin with a local interpreter:
    8894
     
    98104
    99105After 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.
    100 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 ''/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).
    101 
    102 Note:\\
    103 If 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.\\
    104 Python-flup is a dependency which provides trac with SCGI capability. You can install it on debian based systems with:
    105 {{{
     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
     108'''Note:''' If 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 ([trac:#9903]). Python-flup is a dependency which provides Trac with SCGI capability. You can install it on Debian based systems with:
     109{{{#!sh
    106110sudo apt-get install python-flup
    107111}}}
    108112
    109 == Simple Lighttpd Configuration
     113== Lighttpd Configuration
    110114
    111115The FastCGI front-end was developed primarily for use with alternative webservers, such as [http://www.lighttpd.net/ Lighttpd].
     
    157161}}}
    158162
    159 Note 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.
     163Note that the 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.
    160164Note that the above will result in different processes in any event, even if both are running from the same `trac.fcgi` script.
    161165
    162 {{{
    163 #!div class=important
    164 '''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.
     166{{{#!div class=important
     167'''Note:''' The order in which the server.modules are loaded is very important: if mod_auth is not loaded '''before''' mod_fastcgi, then the server will fail to authenticate the user.
    165168}}}
    166169
     
    202205
    203206}}}
     207
    204208Note that Lighttpd (v1.4.3) stops if the password file doesn't exist.
    205209
     
    232236
    233237The 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.
    234 Also 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:
     238
     239Also there is another way to handle multiple projects and it uses `TRAC_ENV_PARENT_DIR` instead of `TRAC_ENV` as well as global authentication:
    235240{{{
    236241#  This is for handling multiple projects
     
    276281                 )
    277282}}}
     283
    278284For details about languages specification see [trac:TracFaq TracFaq] question 2.13.
    279285
    280286Other important information like the [wiki:TracInstall#MappingStaticResources mapping static resources advices] are useful for non-fastcgi specific installation aspects.
    281 ]
    282287
    283288Relaunch Lighttpd and browse to `http://yourhost.example.org/trac` to access Trac.
     
    285290Note 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.
    286291
    287 == Simple !LiteSpeed Configuration
     292== !LiteSpeed Configuration
    288293
    289294The FastCGI front-end was developed primarily for use with alternative webservers, such as [http://www.litespeedtech.com/ LiteSpeed].
     
    292297
    293298 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:
     299 1. 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:
    296300{{{
    297301http://yourdomain.com/trac/
    298302}}}
    299 
    300  3. Go "!TracVhost → External Apps" tab and create a new "External Application".
     303 1. Go "!TracVhost → External Apps" tab and create a new "External Application":
    301304{{{
    302305Name: MyTracFCGI       
     
    314317Instances: 10
    315318}}}
    316 
    317  4. Optional: If you need to use htpasswd based authentication. Go to "!TracVhost → Security" tab and create a new security Realm.
    318 
    319 {{{
     319 1. Optional: If you need to use htpasswd based authentication. Go to "!TracVhost → Security" tab and create a new security Realm:
     320 {{{
    320321DB Type: Password File
    321322Realm Name: MyTracUserDB               <--- any name you wish and referenced later
    322323User DB Location: /fullpathto/htpasswd <--- path to your htpasswd file
    323324}}}
    324 
    325 If 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.
    326 
    327  5. Go to "!PythonVhost → Contexts" and create a new FCGI Context.
    328 
    329 {{{
     325 If 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.
     326 1. Go to "!PythonVhost → Contexts" and create a new FCGI Context:
     327 {{{
    330328URI: /trac/                              <--- URI path to bind to python fcgi app we created   
    331 Fast CGI App: [VHost Level] MyTractFCGI  <--- select the trac fcgi extapp we just created
     329Fast CGI App: [VHost Level] MyTractFCGI  <--- select the Trac fcgi extapp we just created
    332330Realm: TracUserDB                        <--- only if (4) is set. select realm created in (4)
    333331}}}
    334 
    335  6. Modify `/fullpathto/mytracproject/conf/trac.ini`
    336 
    337 {{{
     332 1. Modify `/fullpathto/mytracproject/conf/trac.ini`:
     333 {{{
    338334#find/set base_rul, url, and link variables
    339335base_url = http://yourdomain.com/trac/ <--- base url to generate correct links to
     
    341337link = http://yourdomain.com/trac/     <--- link of graphic logo
    342338}}}
    343 
    344  7. Restart !LiteSpeed, “lswsctrl restart”, and access your new Trac project at:
    345 
    346 {{{
    347 http://yourdomain.com/trac/
    348 }}}
    349 
    350 == Simple Nginx Configuration
    351 
    352 Nginx is able to communicate with FastCGI processes, but can not spawn them. So you need to start FastCGI server for Trac separately.
     339 1. Restart !LiteSpeed: `lswsctrl restart`, and access your new Trac project at {{{http://yourdomain.com/trac/}}}.
     340
     341== Nginx Configuration
     342
     343[http://nginx.org/en/ Nginx] is able to communicate with FastCGI processes, but can not spawn them. So you need to start FastCGI server for Trac separately.
    353344
    354345 1. Nginx configuration with basic authentication handled by Nginx - confirmed to work on 0.6.32
    355  {{{
     346 {{{#!nginx
    356347    server {
    357348        listen       10.9.8.7:443;
     
    416407}}}
    417408 1. Modified trac.fcgi:
    418  {{{
     409 {{{#!python
    419410#!/usr/bin/env python
    420411import os
     
    447438
    448439}}}
    449  1. reload nginx and launch trac.fcgi like that:
     440 1. Reload nginx and launch trac.fcgi:
    450441 {{{#!sh
    451442trac@trac.example ~ $ ./trac-standalone-fcgi.py
     
    453444
    454445The 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
     446 * There is a user named 'trac' for running Trac instances and keeping Trac environments in its home directory
     447 * `/home/trac/instance` contains a Trac environment
    457448 * `/home/trac/htpasswd` contains authentication information
    458  * `/home/trac/run` is owned by the same group the nginx runs under
     449 * `/home/trac/run` is owned by the same group the Nginx runs under
    459450  * 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 
    462 Unfortunately nginx does not support variable expansion in fastcgi_pass directive.
     451  * and patch from [trac:#7239] is applied, or you'll have to fix the socket file permissions every time
     452
     453Unfortunately Nginx does not support variable expansion in fastcgi_pass directive.
    463454Thus it is not possible to serve multiple Trac instances from one server block.
    464455
    465456If you worry enough about security, run Trac instances under separate users.
    466457
    467 Another way to run Trac as a FCGI external application is offered in ticket #T6224
     458Another way to run Trac as a FCGI external application is offered in [trac:#6224].
    468459
    469460----
    470 See also:  TracGuide, TracInstall, [wiki:TracModWSGI ModWSGI], [wiki:TracCgi CGI], [wiki:TracModPython ModPython], [trac:TracNginxRecipe TracNginxRecipe]
     461See also: TracGuide, TracInstall, [wiki:TracModWSGI ModWSGI], [wiki:TracCgi CGI], [wiki:TracModPython ModPython], [trac:TracNginxRecipe TracNginxRecipe]