Changes between Version 2 and Version 3 of TracFastCgi
- Timestamp:
- Apr 4, 2012, 2:28:09 PM (12 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracFastCgi
v2 v3 1 1 = Trac with FastCGI = 2 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 '''Note for Windows:''' Trac's F CGI 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].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 6 7 7 == Simple Apache configuration == 8 8 9 9 There 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: 10 `mod_fcgid` (preferred). The latter is more up-to-date. 11 12 ==== setup with `mod_fastcgi` ==== 13 `mod_fastcgi` uses `FastCgiIpcDir` and `FastCgiConfig` directives that should be added to an appropriate Apache configuration file: 16 14 {{{ 17 15 # Enable fastcgi for .fcgi files … … 39 37 }}} 40 38 41 But neither of these will work for `mod_fcgid`. A similar but partial 42 solution for `mod_fcgid` is: 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. 42 {{{ 43 ScriptAlias /trac /path/to/www/trac/cgi-bin/trac.fcgi/ 44 }}} 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. 50 43 51 {{{ 44 52 DefaultInitEnv TRAC_ENV /path/to/env/trac/ 45 53 }}} 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.:54 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): 52 60 {{{ 53 61 import os … … 60 68 }}} 61 69 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. 70 With this method different projects can be supported by using different 71 `.fcgi` scripts with different `ScriptAliases`. 65 72 66 73 See [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: … … 97 104 For using `trac.fcgi`(prior to 0.11) / fcgi_frontend.py (0.11) with lighttpd add the following to your lighttpd.conf: 98 105 {{{ 99 #var.fcgi_binary="/ path/to/fcgi_frontend.py" # 0.11 if installed with easy_setup, it is inside the egg directory106 #var.fcgi_binary="/usr/bin/python /path/to/fcgi_frontend.py" # 0.11 if installed with easy_setup, it is inside the egg directory 100 107 var.fcgi_binary="/path/to/cgi-bin/trac.fcgi" # 0.10 name of prior fcgi executable 101 108 fastcgi.server = ("/trac" => … … 115 122 and you may set one of the two in `trac.fcgi` instead of in `lighttpd.conf` 116 123 using `bin-environment` (as in the section above on Apache configuration). 124 125 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. 117 126 118 127 For using two projects with lighttpd add the following to your `lighttpd.conf`: … … 268 277 Note about running lighttpd with reduced permissions: 269 278 270 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.279 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. 271 280 272 281 … … 277 286 !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. 278 287 279 Setup 280 281 1)Please make sure you have first have a working install of a Trac project. Test install with “tracd” first.282 283 2) Create a Virtual Host for this setup. From now on we will refer to this vhost asTracVhost. For this tutorial we will be assuming that your trac project will be accessible via:288 === Setup === 289 290 1. Please make sure you have first have a working install of a Trac project. Test install with “tracd” first. 291 292 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: 284 293 285 294 {{{ … … 287 296 }}} 288 297 289 3) Go “TracVhost → External Apps” tab and create a new “External Application”.298 3. Go “!TracVhost → External Apps” tab and create a new “External Application”. 290 299 291 300 {{{ … … 305 314 }}} 306 315 307 4) Optional. If you need to use htpasswd based authentication. Go to “TracVhost → Security” tab and create a new security “Realm”.316 4. Optional. If you need to use htpasswd based authentication. Go to “!TracVhost → Security” tab and create a new security “Realm”. 308 317 309 318 {{{ … … 315 324 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. 316 325 317 5) Go to “PythonVhost → Contexts” and create a new “FCGI Context”.326 5. Go to “!PythonVhost → Contexts” and create a new “FCGI Context”. 318 327 319 328 {{{ … … 323 332 }}} 324 333 325 6) Modify /fullpathto/mytracproject/conf/trac.ini 334 6. Modify `/fullpathto/mytracproject/conf/trac.ini` 326 335 327 336 {{{ … … 332 341 }}} 333 342 334 7)Restart !LiteSpeed, “lswsctrl restart”, and access your new Trac project at:343 7. Restart !LiteSpeed, “lswsctrl restart”, and access your new Trac project at: 335 344 336 345 {{{ … … 338 347 }}} 339 348 340 == = Simple Nginx Configuration ===341 342 1)Nginx configuration snippet - confirmed to work on 0.6.32349 == Simple Nginx Configuration == 350 351 1. Nginx configuration snippet - confirmed to work on 0.6.32 343 352 {{{ 344 353 server { … … 387 396 fastcgi_param SERVER_PORT $server_port; 388 397 fastcgi_param SERVER_PROTOCOL $server_protocol; 398 fastcgi_param QUERY_STRING $query_string; 389 399 390 400 # for authentication to work … … 395 405 }}} 396 406 397 2)Modified trac.fcgi:407 2. Modified trac.fcgi: 398 408 399 409 {{{ … … 429 439 }}} 430 440 431 3)reload nginx and launch trac.fcgi like that:441 3. reload nginx and launch trac.fcgi like that: 432 442 433 443 {{{ … … 437 447 The above assumes that: 438 448 * There is a user named 'trac' for running trac instances and keeping trac environments in its home directory. 439 * /home/trac/instancecontains a trac environment440 * /home/trac/htpasswdcontains authentication information441 * /home/trac/runis owned by the same group the nginx runs under442 * and if your system is Linux the /home/trac/run has setgid bit set (chmod g+s run)449 * `/home/trac/instance` contains a trac environment 450 * `/home/trac/htpasswd` contains authentication information 451 * `/home/trac/run` is owned by the same group the nginx runs under 452 * and if your system is Linux the `/home/trac/run` has setgid bit set (`chmod g+s run`) 443 453 * and patch from ticket #T7239 is applied, or you'll have to fix the socket file permissions every time 444 454