Changes between Version 1 and Version 2 of TracFastCgi
- Timestamp:
- Apr 4, 2011, 10:40:05 PM (14 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracFastCgi
v1 v2 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: … … 88 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/'' 89 96 97 Note:\\ 98 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.\\ 99 Python-flup is a dependency which provides trac with SCGI capability. You can install it on debian based systems with: 100 {{{ 101 sudo apt-get install python-flup 102 }}} 103 90 104 == Simple Lighttpd Configuration == 91 105 … … 97 111 For using `trac.fcgi`(prior to 0.11) / fcgi_frontend.py (0.11) with lighttpd add the following to your lighttpd.conf: 98 112 {{{ 99 #var.fcgi_binary="/ path/to/fcgi_frontend.py" # 0.11 if installed with easy_setup, it is inside the egg directory113 #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 114 var.fcgi_binary="/path/to/cgi-bin/trac.fcgi" # 0.10 name of prior fcgi executable 101 115 fastcgi.server = ("/trac" => … … 115 129 and you may set one of the two in `trac.fcgi` instead of in `lighttpd.conf` 116 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. 117 133 118 134 For using two projects with lighttpd add the following to your `lighttpd.conf`: … … 268 284 Note about running lighttpd with reduced permissions: 269 285 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.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. 271 287 272 288 … … 277 293 !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 294 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: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: 284 300 285 301 {{{ … … 287 303 }}} 288 304 289 3) Go “TracVhost → External Apps” tab and create a new “External Application”.305 3. Go “!TracVhost → External Apps” tab and create a new “External Application”. 290 306 291 307 {{{ … … 305 321 }}} 306 322 307 4) Optional. If you need to use htpasswd based authentication. Go to “TracVhost → Security” tab and create a new security “Realm”.323 4. Optional. If you need to use htpasswd based authentication. Go to “!TracVhost → Security” tab and create a new security “Realm”. 308 324 309 325 {{{ … … 315 331 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 332 317 5) Go to “PythonVhost → Contexts” and create a new “FCGI Context”.333 5. Go to “!PythonVhost → Contexts” and create a new “FCGI Context”. 318 334 319 335 {{{ … … 323 339 }}} 324 340 325 6) Modify /fullpathto/mytracproject/conf/trac.ini 341 6. Modify `/fullpathto/mytracproject/conf/trac.ini` 326 342 327 343 {{{ … … 332 348 }}} 333 349 334 7)Restart !LiteSpeed, “lswsctrl restart”, and access your new Trac project at:350 7. Restart !LiteSpeed, “lswsctrl restart”, and access your new Trac project at: 335 351 336 352 {{{ … … 338 354 }}} 339 355 340 == = Simple Nginx Configuration ===341 342 1)Nginx configuration snippet - confirmed to work on 0.6.32356 == Simple Nginx Configuration == 357 358 1. Nginx configuration snippet - confirmed to work on 0.6.32 343 359 {{{ 344 360 server { … … 387 403 fastcgi_param SERVER_PORT $server_port; 388 404 fastcgi_param SERVER_PROTOCOL $server_protocol; 405 fastcgi_param QUERY_STRING $query_string; 389 406 390 407 # for authentication to work … … 395 412 }}} 396 413 397 2)Modified trac.fcgi:414 2. Modified trac.fcgi: 398 415 399 416 {{{ … … 429 446 }}} 430 447 431 3)reload nginx and launch trac.fcgi like that:448 3. reload nginx and launch trac.fcgi like that: 432 449 433 450 {{{ … … 437 454 The above assumes that: 438 455 * 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)456 * `/home/trac/instance` contains a trac environment 457 * `/home/trac/htpasswd` contains authentication information 458 * `/home/trac/run` is owned by the same group the nginx runs under 459 * and if your system is Linux the `/home/trac/run` has setgid bit set (`chmod g+s run`) 443 460 * and patch from ticket #T7239 is applied, or you'll have to fix the socket file permissions every time 444 461