Changes between Version 6 and Version 7 of TracFastCgi
- Timestamp:
- Apr 24, 2015, 5:15:04 PM (10 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracFastCgi
v6 v7 1 [[PageOutline]] 2 3 = Trac with FastCGI = 1 = Trac with FastCGI 2 3 [[TracGuideToc]] 4 [[PageOutline(2-5, Contents, floated)]] 4 5 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. 6 7 7 Note that unlike mod_python, FastCGI supports [http://httpd.apache.org/docs/suexec.html Apache SuEXEC], i .e. run with different permissions than web server running with (`mod_wsgi` supports the `WSGIDaemonProcess` with user / group parameters to achieve the same effect).8 Note 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. 8 9 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]. 10 11 11 [[PageOutline(2-3,Overview,inline)]] 12 13 14 == Simple Apache configuration == 12 == Simple Apache configuration 15 13 16 14 There are two FastCGI modules commonly available for Apache: `mod_fastcgi` and … … 19 17 The following sections focus on the FCGI specific setup, see also [wiki:TracModWSGI#ConfiguringAuthentication] for configuring the authentication in Apache. 20 18 21 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) 22 23 === Set up with `mod_fastcgi` === 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. 20 21 === Set up with `mod_fastcgi` 22 24 23 `mod_fastcgi` uses `FastCgiIpcDir` and `FastCgiConfig` directives that should be added to an appropriate Apache configuration file: 25 24 {{{ … … 48 47 }}} 49 48 50 === Set up with `mod_fcgid` ===51 Configure `ScriptAlias` (see TracCgi for details), but call `trac.fcgi` 52 instead of `trac.cgi`. Note that slash at the end - it is important. 49 === Set up with `mod_fcgid` 50 51 Configure `ScriptAlias` (see TracCgi for details), but call `trac.fcgi` instead of `trac.cgi`: 53 52 {{{ 54 53 ScriptAlias /trac /path/to/www/trac/cgi-bin/trac.fcgi/ 55 54 }}} 56 57 To set up Trac environment for `mod_fcgid` it is necessary to use 58 `DefaultInitEnv` directive. It cannot be used in `Directory` or 59 `Location` context, so if you need to support multiple projects, try 60 alternative environment setup below. 55 Note the slash at the end. 56 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. 61 58 62 59 {{{ … … 64 61 }}} 65 62 66 === alternative environment setup === 67 A better method to specify path to Trac environment is to embed the path 68 into `trac.fcgi` script itself. That doesn't require configuration of server 69 environment variables, works for both FastCgi modules 70 (and for [http://www.lighttpd.net/ lighttpd] and CGI as well): 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: 71 66 {{{ 72 67 import os 73 68 os.environ['TRAC_ENV'] = "/path/to/projectenv" 74 69 }}} 75 or 70 or: 76 71 {{{ 77 72 import os … … 79 74 }}} 80 75 81 With this method different projects can be supported by using different 82 `.fcgi` scripts with different `ScriptAliases`. 76 With this method different projects can be supported by using different `.fcgi` scripts with different `ScriptAliases`. 83 77 84 78 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: … … 87 81 }}} 88 82 89 == Simple Cherokee Configuration ==83 == Simple Cherokee Configuration 90 84 91 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. 92 86 You can either start it manually, or better yet, automatically by letting Cherokee spawn the server whenever it is down. 93 First set up an information source in cherokee-admin with a local interpreter .87 First set up an information source in cherokee-admin with a local interpreter: 94 88 95 89 {{{ … … 113 107 }}} 114 108 115 116 == Simple Lighttpd Configuration == 117 118 The FastCGI front-end was developed primarily for use with alternative webservers, such as [http://www.lighttpd.net/ lighttpd]. 119 120 lighttpd is a secure, fast, compliant and very flexible web-server that has been optimized for high-performance 121 environments. It has a very low memory footprint compared to other web servers and takes care of CPU load. 122 123 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 111 The FastCGI front-end was developed primarily for use with alternative webservers, such as [http://www.lighttpd.net/ Lighttpd]. 112 113 Lighttpd 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 115 For using `trac.fcgi`(prior to 0.11) / fcgi_frontend.py (0.11) with Lighttpd add the following to your lighttpd.conf: 124 116 {{{ 125 117 #var.fcgi_binary="/usr/bin/python /path/to/fcgi_frontend.py" # 0.11 if installed with easy_setup, it is inside the egg directory … … 138 130 }}} 139 131 140 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, 141 and you may set one of the two in `trac.fcgi` instead of in `lighttpd.conf` 142 using `bin-environment` (as in the section above on Apache configuration). 143 144 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 [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. 132 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, 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 134 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 [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. 145 135 146 136 For using two projects with lighttpd add the following to your `lighttpd.conf`: … … 166 156 ) 167 157 }}} 168 Note that field values are different. If you prefer setting the environment 169 variables in the `.fcgi` scripts, then copy/rename `trac.fcgi`, e.g., to 170 `first.fcgi` and `second.fcgi`, and reference them in the above settings. 171 Note that the above will result in different processes in any event, even 172 if both are running from the same `trac.fcgi` script. 158 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. 160 Note that the above will result in different processes in any event, even if both are running from the same `trac.fcgi` script. 173 161 174 162 {{{ … … 213 201 ) 214 202 215 216 }}} 217 Note that lighttpd (I use version 1.4.3) stopped if password file doesn't exist. 218 219 Note that lighttpd doesn't support 'valid-user' in versions prior to 1.3.16. 220 221 Conditional configuration is also useful for mapping static resources, i.e. serving out images and CSS directly instead of through FastCGI: 203 }}} 204 Note that Lighttpd (v1.4.3) stops if the password file doesn't exist. 205 206 Note that Lighttpd doesn't support 'valid-user' in versions prior to 1.3.16. 207 208 Conditional configuration is also useful for mapping static resources, ie serving out images and CSS directly instead of through FastCGI: 222 209 {{{ 223 210 # Aliasing functionality is needed … … 243 230 } 244 231 }}} 232 245 233 The 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. 246 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: … … 274 262 }}} 275 263 276 Changing date/time format also supported by lighttpd over environment variable LC_TIME 264 Changing date/time format also supported by lighttpd over environment variable LC_TIME: 277 265 {{{ 278 266 fastcgi.server = ("/trac" => … … 293 281 ] 294 282 295 Relaunch lighttpd, and browse to `http://yourhost.example.org/trac` to access Trac. 296 297 Note about running lighttpd with reduced permissions: 298 299 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. 300 301 302 == Simple !LiteSpeed Configuration == 283 Relaunch Lighttpd and browse to `http://yourhost.example.org/trac` to access Trac. 284 285 Note 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 303 288 304 289 The FastCGI front-end was developed primarily for use with alternative webservers, such as [http://www.litespeedtech.com/ LiteSpeed]. … … 306 291 !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. 307 292 308 1. Please make sure you have first have a working install of a Trac project. Test install with “tracd” first. 309 310 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: 311 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: 312 296 {{{ 313 297 http://yourdomain.com/trac/ 314 298 }}} 315 299 316 3. Go “!TracVhost → External Apps” tab and create a new “External Application”. 317 300 3. Go "!TracVhost → External Apps" tab and create a new "External Application". 318 301 {{{ 319 302 Name: MyTracFCGI … … 332 315 }}} 333 316 334 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. 335 318 336 319 {{{ … … 342 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. 343 326 344 5. Go to “!PythonVhost → Contexts” and create a new “FCGI Context”.327 5. Go to "!PythonVhost → Contexts" and create a new FCGI Context. 345 328 346 329 {{{ … … 365 348 }}} 366 349 367 368 == Simple Nginx Configuration == 350 == Simple Nginx Configuration 369 351 370 352 Nginx is able to communicate with FastCGI processes, but can not spawn them. So you need to start FastCGI server for Trac separately. … … 386 368 ssl_prefer_server_ciphers on; 387 369 388 # (Or ``^/some/prefix/(.*)``.389 if ($uri ~ ^/(.*)) {390 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; 391 373 } 392 374 393 # it makes sense to serve static resources through Nginx 394 location /chrome/ { 395 alias /home/trac/instance/static/htdocs/; 396 } 397 398 # You can copy this whole location to ``location [/some/prefix]/login`` 375 # You can copy this whole location to ``location [/some/prefix](/login)`` 399 376 # and remove the auth entries below if you want Trac to enforce 400 377 # authorization where appropriate instead of needing to authenticate 401 378 # for accessing the whole site. 402 # (Or `` location /some/prefix``.)403 location /{379 # (Or ``~ location /some/prefix(/.*)``.) 380 location ~ (/.*) { 404 381 auth_basic "trac realm"; 405 382 auth_basic_user_file /home/trac/htpasswd; … … 415 392 # (Or ``fastcgi_param SCRIPT_NAME /some/prefix``.) 416 393 fastcgi_param SCRIPT_NAME ""; 417 fastcgi_param PATH_INFO $fastcgi_script_name;394 fastcgi_param PATH_INFO $1; 418 395 419 396 ## WSGI NEEDED VARIABLES - trac warns about them … … 476 453 477 454 The above assumes that: 478 * 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 479 456 * `/home/trac/instance` contains a trac environment 480 457 * `/home/trac/htpasswd` contains authentication information … … 484 461 485 462 Unfortunately nginx does not support variable expansion in fastcgi_pass directive. 486 Thus it is not possible to serve multiple trac instances from one server block.487 488 If you worry enough about security, run trac instances under separate users.489 490 Another way to run trac as a FCGI external application is offered in ticket #T6224463 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 491 468 492 469 ----
