Changes between Version 1 and Version 2 of TracFastCgi


Ignore:
Timestamp:
07/10/20 13:09:46 (2 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracFastCgi

    v1 v2  
    1 = Trac with FastCGI =
    2 
    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 == Simple Apache configuration ==
    6 
    7 There 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:
    14 {{{
     1= Trac with FastCGI
     2
     3[[TracGuideToc]]
     4[[PageOutline(2-5, Contents, floated)]]
     5
     6[https://fastcgi-archives.github.io 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.
     7
     8Note that unlike mod_python, FastCGI supports [https://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== 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.
     15
     16The following sections focus on the FCGI specific setup, see also [wiki:TracModWSGI#ConfiguringAuthentication] for configuring the authentication in Apache.
     17
     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`.
     19
     20=== Set up with `mod_fastcgi`
     21
     22`mod_fastcgi` uses `FastCgiIpcDir` and `FastCgiConfig` directives that should be added to an appropriate Apache configuration file:
     23{{{#!apache
    1524# Enable fastcgi for .fcgi files
    1625# (If you're using a distro package for mod_fcgi, something like
     
    1827<IfModule mod_fastcgi.c>
    1928   AddHandler fastcgi-script .fcgi
    20    FastCgiIpcDir /var/lib/apache2/fastcgi 
     29   FastCgiIpcDir /var/lib/apache2/fastcgi
    2130</IfModule>
    2231LoadModule fastcgi_module /usr/lib/apache2/modules/mod_fastcgi.so
    2332}}}
     33
    2434Setting `FastCgiIpcDir` is optional if the default is suitable. Note that the `LoadModule` line must be after the `IfModule` group.
    2535
    26 Configure `ScriptAlias` or similar options as described in TracCgi, but
    27 calling `trac.fcgi` instead of `trac.cgi`.
    28 
    29 You can set up the `TRAC_ENV` as an overall default:
    30 {{{
     36Configure `ScriptAlias` or similar options as described in TracCgi, but calling `trac.fcgi` instead of `trac.cgi`.
     37
     38Add the following to the Apache configuration file (below the `FastCgiIpcDir` line) if you intend to set up the `TRAC_ENV` as an overall default:
     39{{{#!apache
    3140FastCgiConfig -initial-env TRAC_ENV=/path/to/env/trac
    3241}}}
    3342
    34 Or you can serve multiple Trac projects in a directory like:
    35 {{{
     43Alternatively, you can serve multiple Trac projects in a directory by adding this:
     44{{{#!apache
    3645FastCgiConfig -initial-env TRAC_ENV_PARENT_DIR=/parent/dir/of/projects
    3746}}}
    3847
    39 But neither of these will work for `mod_fcgid`.  A similar but partial
    40 solution for `mod_fcgid` is:
    41 {{{
     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
     54=== Set up with `mod_fcgid`
     55
     56Configure `ScriptAlias` (see TracCgi for details), but call `trac.fcgi` instead of `trac.cgi`:
     57{{{#!apache
     58ScriptAlias /trac /path/to/www/trac/cgi-bin/trac.fcgi/
     59}}}
     60
     61Note the slash at the end.
     62
     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
    4265DefaultInitEnv TRAC_ENV /path/to/env/trac/
    4366}}}
    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.:
    50 {{{
     67
     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 [https://www.lighttpd.net/ lighttpd] and CGI:
     71{{{#!python
    5172import os
    5273os.environ['TRAC_ENV'] = "/path/to/projectenv"
    5374}}}
    54 or
    55 {{{
     75
     76or:
     77{{{#!python
    5678import os
    5779os.environ['TRAC_ENV_PARENT_DIR'] = "/path/to/project/parent/dir"
    5880}}}
    5981
    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.
    63 
    64 == Simple Lighttpd Configuration ==
    65 
    66 The FastCGI front-end was developed primarily for use with alternative webservers, such as [http://www.lighttpd.net/ lighttpd].
    67 
    68 lighttpd is a secure, fast, compliant and very flexible web-server that has been optimized for high-performance
    69 environments.  It has a very low memory footprint compared to other web servers and takes care of CPU load.
    70 
    71 For using `trac.fcgi` with lighttpd add the following to your lighttpd.conf:
    72 {{{
     82With this method different projects can be supported by using different `.fcgi` scripts with different `ScriptAliases`.
     83
     84See [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:
     85{{{#!apache
     86ScriptAlias / /srv/tracsite/cgi-bin/trac.fcgi/
     87}}}
     88
     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
     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
     108'''Note:''' If the tracd process fails to start up, and Cherokee displays a 503 error page, you might be missing the [https://www.saddi.com/software/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
     110sudo apt-get install python-flup
     111}}}
     112
     113== Lighttpd Configuration
     114
     115The FastCGI front-end was developed primarily for use with alternative webservers, such as [https://www.lighttpd.net/ Lighttpd].
     116
     117Lighttpd 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.
     118
     119For using `trac.fcgi`(prior to 0.11) / fcgi_frontend.py (0.11) with Lighttpd add the following to your lighttpd.conf:
     120{{{
     121#var.fcgi_binary="/usr/bin/python /path/to/fcgi_frontend.py" # 0.11 if installed with easy_setup, it is inside the egg directory
     122var.fcgi_binary="/path/to/cgi-bin/trac.fcgi" # 0.10 name of prior fcgi executable
    73123fastcgi.server = ("/trac" =>
     124
    74125                   ("trac" =>
    75126                     ("socket" => "/tmp/trac-fastcgi.sock",
    76                       "bin-path" => "/path/to/cgi-bin/trac.fcgi",
     127                      "bin-path" => fcgi_binary,
    77128                      "check-local" => "disable",
    78129                      "bin-environment" =>
     
    83134}}}
    84135
    85 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,
    86 and you may set one of the two in `trac.fcgi` instead of in `lighttpd.conf`
    87 using `bin-environment` (as in the section above on Apache configuration).
     136Note 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.
     137
     138Note 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.
    88139
    89140For using two projects with lighttpd add the following to your `lighttpd.conf`:
     
    92143                   ("first" =>
    93144                    ("socket" => "/tmp/trac-fastcgi-first.sock",
    94                      "bin-path" => "/path/to/cgi-bin/trac.fcgi",
     145                     "bin-path" => fcgi_binary,
    95146                     "check-local" => "disable",
    96147                     "bin-environment" =>
     
    101152                    ("second" =>
    102153                    ("socket" => "/tmp/trac-fastcgi-second.sock",
    103                      "bin-path" => "/path/to/cgi-bin/trac.fcgi",
     154                     "bin-path" => fcgi_binary,
    104155                     "check-local" => "disable",
    105156                     "bin-environment" =>
     
    109160                )
    110161}}}
    111 Note that field values are different.  If you prefer setting the environment
    112 variables in the `.fcgi` scripts, then copy/rename `trac.fcgi`, e.g., to
    113 `first.fcgi` and `second.fcgi`, and reference them in the above settings.
    114 Note that the above will result in different processes in any event, even
    115 if both are running from the same `trac.fcgi` script.
    116 {{{
    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>
    121 }}}
     162
     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.
     164Note that the above will result in different processes in any event, even if both are running from the same `trac.fcgi` script.
     165
     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.
     168}}}
     169
    122170For authentication you should enable mod_auth in lighttpd.conf 'server.modules', select auth.backend and auth rules:
    123171{{{
     
    132180# Separated password files for each project
    133181# See "Conditional Configuration" in
    134 # http://trac.lighttpd.net/trac/file/branches/lighttpd-merge-1.4.x/doc/configuration.txt
     182# https://redmine.lighttpd.net/projects/lighttpd/repository/entry/doc/configuration.txt?rev=lighttpd-1.4.28
    135183
    136184$HTTP["url"] =~ "^/first/" {
     
    142190
    143191# Enable auth on trac URLs, see
    144 # http://trac.lighttpd.net/trac/file/branches/lighttpd-merge-1.4.x/doc/authentication.txt
     192# https://redmine.lighttpd.net/projects/lighttpd/repository/entry/doc/authentication.txt?rev=lighttpd-1.4.28
    145193
    146194auth.require = ("/first/login" =>
     
    156204               )
    157205
    158 
    159 }}}
    160 Note that lighttpd (I use version 1.4.3) stopped if password file doesn't exist.
    161 
    162 Note that lighttpd doesn't support 'valid-user' in versions prior to 1.3.16.
    163 
    164 Conditional configuration is also useful for mapping static resources, i.e. serving out images and CSS directly instead of through FastCGI:
     206}}}
     207
     208Note that Lighttpd (v1.4.3) stops if the password file doesn't exist.
     209
     210Note that Lighttpd doesn't support 'valid-user' in versions prior to 1.3.16.
     211
     212Conditional configuration is also useful for mapping static resources, ie serving out images and CSS directly instead of through FastCGI:
    165213{{{
    166214# Aliasing functionality is needed
    167215server.modules += ("mod_alias")
    168216
    169 # Setup an alias for the static resources
     217# Set up an alias for the static resources
    170218alias.url = ("/trac/chrome/common" => "/usr/share/trac/htdocs")
    171219
     
    177225                   ("trac" =>
    178226                     ("socket" => "/tmp/trac-fastcgi.sock",
    179                       "bin-path" => "/path/to/cgi-bin/trac.fcgi",
     227                      "bin-path" => fcgi_binary,
    180228                      "check-local" => "disable",
    181229                      "bin-environment" =>
     
    186234}
    187235}}}
     236
    188237The 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.
    189 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:
    190240{{{
    191241#  This is for handling multiple projects
     
    196246                        (
    197247                          "socket" => "/tmp/trac.sock",
    198                           "bin-path" => "/path/to/cgi-bin/trac.fcgi",
     248                          "bin-path" => fcgi_binary,
    199249                          "check-local" => "disable",
    200250                          "bin-environment" =>
     
    217267}}}
    218268
    219 Changing date/time format also supported by lighttpd over environment variable LC_TIME
     269Changing date/time format also supported by lighttpd over environment variable LC_TIME:
    220270{{{
    221271fastcgi.server = ("/trac" =>
    222272                   ("trac" =>
    223273                     ("socket" => "/tmp/trac-fastcgi.sock",
    224                       "bin-path" => "/path/to/cgi-bin/trac.fcgi",
     274                      "bin-path" => fcgi_binary,
    225275                      "check-local" => "disable",
    226276                      "bin-environment" =>
     
    231281                 )
    232282}}}
    233 For details about languages specification see TracFaq question 2.13.
    234 
    235 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.
    236 
    237 If you use trac-0.9, read [http://lists.edgewall.com/archive/trac/2005-November/005311.html about small bug]
    238 
    239 Relaunch lighttpd, and browse to `http://yourhost.example.org/trac` to access Trac.
    240 
    241 Note about running lighttpd with reduced permissions:
    242 
    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 ==
    247 
    248 The FastCGI front-end was developed primarily for use with alternative webservers, such as [http://www.litespeedtech.com/ LiteSpeed].
    249 
    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:
    257 
     283
     284For details about languages specification see [trac:TracFaq TracFaq] question 2.13.
     285
     286Other important information like the [wiki:TracInstall#MappingStaticResources mapping static resources advices] are useful for non-fastcgi specific installation aspects.
     287
     288Relaunch Lighttpd and browse to `http://yourhost.example.org/trac` to access Trac.
     289
     290Note 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.
     291
     292== !LiteSpeed Configuration
     293
     294The FastCGI front-end was developed primarily for use with alternative webservers, such as [https://www.litespeedtech.com/ LiteSpeed].
     295
     296!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.
     297
     298 1. Please make sure you have a working install of a Trac project. Test install with "tracd" first.
     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:
    258300{{{
    259301http://yourdomain.com/trac/
    260302}}}
    261 
    262 3) Go “TracVhost → External Apps” tab and create a new “External Application”.
    263 
     303 1. Go "!TracVhost → External Apps" tab and create a new "External Application":
    264304{{{
    265305Name: MyTracFCGI       
     
    277317Instances: 10
    278318}}}
    279 
    280 4) Optional. If you need to use htpasswd based authentication. Go to “TracVhost → Security” tab and create a new security “Realm”.
    281 
    282 {{{
     319 1. Optional: If you need to use htpasswd based authentication. Go to "!TracVhost → Security" tab and create a new security Realm:
     320 {{{
    283321DB Type: Password File
    284322Realm Name: MyTracUserDB               <--- any name you wish and referenced later
    285323User DB Location: /fullpathto/htpasswd <--- path to your htpasswd file
    286324}}}
    287 
    288 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.
    289 
    290 5) Go to “PythonVhost → Contexts” and create a new “FCGI Context”.
    291 
    292 {{{
     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 {{{
    293328URI: /trac/                              <--- URI path to bind to python fcgi app we created   
    294 Fast 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
    299 
    300 {{{
     329Fast CGI App: [VHost Level] MyTractFCGI  <--- select the Trac fcgi extapp we just created
     330Realm: TracUserDB                        <--- only if (4) is set. select realm created in (4)
     331}}}
     332 1. Modify `/fullpathto/mytracproject/conf/trac.ini`:
     333 {{{
    301334#find/set base_rul, url, and link variables
    302335base_url = http://yourdomain.com/trac/ <--- base url to generate correct links to
     
    304337link = http://yourdomain.com/trac/     <--- link of graphic logo
    305338}}}
    306 
    307 7) Restart LiteSpeed, “lswsctrl restart”, and access your new Trac project at:
    308 
    309 {{{
    310 http://yourdomain.com/trac/
    311 }}}
     339 1. Restart !LiteSpeed: `lswsctrl restart`, and access your new Trac project at {{{http://yourdomain.com/trac/}}}.
     340
     341== Nginx Configuration
     342
     343[https://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.
     344
     345 1. Nginx configuration with basic authentication handled by Nginx - confirmed to work on 0.6.32
     346 {{{#!nginx
     347    server {
     348        listen       10.9.8.7:443;
     349        server_name  trac.example;
     350
     351        ssl                  on;
     352        ssl_certificate      /etc/ssl/trac.example.crt;
     353        ssl_certificate_key  /etc/ssl/trac.example.key;
     354
     355        ssl_session_timeout  5m;
     356
     357        ssl_protocols  SSLv2 SSLv3 TLSv1;
     358        ssl_ciphers  ALL:!ADH:!EXPORT56:RC4+RSA:+HIGH:+MEDIUM:+LOW:+SSLv2:+EXP;
     359        ssl_prefer_server_ciphers   on;
     360
     361        # it makes sense to serve static resources through Nginx (or ``~ [/some/prefix]/chrome/(.*)``)
     362        location ~ /chrome/(.*) {
     363             alias /home/trac/instance/static/htdocs/$1;
     364        }
     365
     366        # You can copy this whole location to ``location [/some/prefix](/login)``
     367        # and remove the auth entries below if you want Trac to enforce
     368        # authorization where appropriate instead of needing to authenticate
     369        # for accessing the whole site.
     370        # (Or ``~ location /some/prefix(/.*)``.)
     371        location ~ (/.*) {
     372            auth_basic            "trac realm";
     373            auth_basic_user_file /home/trac/htpasswd;
     374
     375            # socket address
     376            fastcgi_pass   unix:/home/trac/run/instance.sock;
     377
     378            # python - wsgi specific
     379            fastcgi_param HTTPS on;
     380
     381            ## WSGI REQUIRED VARIABLES
     382            # WSGI application name - trac instance prefix.
     383            # (Or ``fastcgi_param  SCRIPT_NAME  /some/prefix``.)
     384            fastcgi_param  SCRIPT_NAME        "";
     385            fastcgi_param  PATH_INFO          $1;
     386
     387            ## WSGI NEEDED VARIABLES - trac warns about them
     388            fastcgi_param  REQUEST_METHOD     $request_method;
     389            fastcgi_param  SERVER_NAME        $server_name;
     390            fastcgi_param  SERVER_PORT        $server_port;
     391            fastcgi_param  SERVER_PROTOCOL    $server_protocol;
     392            fastcgi_param  QUERY_STRING       $query_string;
     393
     394            # For Nginx authentication to work - do not forget to comment these
     395            # lines if not using Nginx for authentication
     396            fastcgi_param  AUTH_USER          $remote_user;
     397            fastcgi_param  REMOTE_USER        $remote_user;
     398
     399            # for ip to work
     400            fastcgi_param REMOTE_ADDR         $remote_addr;
     401
     402            # For attchments to work
     403            fastcgi_param    CONTENT_TYPE     $content_type;
     404            fastcgi_param    CONTENT_LENGTH   $content_length;
     405        }
     406    }
     407}}}
     408 1. Modified trac.fcgi:
     409 {{{#!python
     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 1. Reload nginx and launch trac.fcgi:
     441 {{{#!sh
     442trac@trac.example ~ $ ./trac-standalone-fcgi.py
     443}}}
     444
     445The above assumes that:
     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
     448 * `/home/trac/htpasswd` contains authentication information
     449 * `/home/trac/run` is owned by the same group the Nginx runs under
     450  * and if your system is Linux the `/home/trac/run` has setgid bit set (`chmod g+s run`)
     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.
     454Thus it is not possible to serve multiple Trac instances from one server block.
     455
     456If you worry enough about security, run Trac instances under separate users.
     457
     458Another way to run Trac as a FCGI external application is offered in [trac:#6224].
    312459
    313460----
    314 See also TracCgi, TracModPython, TracInstall, TracGuide
     461See also: TracGuide, TracInstall, [wiki:TracModWSGI ModWSGI], [wiki:TracCgi CGI], [wiki:TracModPython ModPython], [trac:TracNginxRecipe TracNginxRecipe]