Changes between Version 2 and Version 3 of TracFastCgi
- Timestamp:
- 04/22/15 15:16:45 (10 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracFastCgi
v2 v3 1 = Trac with FastCGI = 2 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 7 == Simple Apache configuration == 1 = Trac with FastCGI 2 3 [[TracGuideToc]] 4 [[PageOutline(2-5, Contents, floated)]] 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. 7 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. 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 == Simple Apache configuration 8 13 9 14 There are two FastCGI modules commonly available for Apache: `mod_fastcgi` and 10 15 `mod_fcgid` (preferred). The latter is more up-to-date. 11 16 12 ==== setup with `mod_fastcgi` ==== 17 The following sections focus on the FCGI specific setup, see also [wiki:TracModWSGI#ConfiguringAuthentication] for configuring the authentication in Apache. 18 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 13 23 `mod_fastcgi` uses `FastCgiIpcDir` and `FastCgiConfig` directives that should be added to an appropriate Apache configuration file: 14 24 {{{ … … 27 37 calling `trac.fcgi` instead of `trac.cgi`. 28 38 29 You canset up the `TRAC_ENV` as an overall default:39 Add the following to the Apache configuration file (below the `FastCgiIpcDir` line) if you intend to set up the `TRAC_ENV` as an overall default: 30 40 {{{ 31 41 FastCgiConfig -initial-env TRAC_ENV=/path/to/env/trac 32 42 }}} 33 43 34 Or you can serve multiple Trac projects in a directory like:44 Alternatively, you can serve multiple Trac projects in a directory by adding this: 35 45 {{{ 36 46 FastCgiConfig -initial-env TRAC_ENV_PARENT_DIR=/parent/dir/of/projects 37 47 }}} 38 48 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. 49 === Set up with `mod_fcgid` 50 51 Configure `ScriptAlias` (see TracCgi for details), but call `trac.fcgi` instead of `trac.cgi`: 42 52 {{{ 43 53 ScriptAlias /trac /path/to/www/trac/cgi-bin/trac.fcgi/ 44 54 }}} 45 46 To setup Trac environment for `mod_fcgid` it is necessary to use 47 `FCGIDDefaultInitEnv` 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 51 {{{ 52 FCGIDDefaultInitEnv TRAC_ENV /path/to/env/trac/ 53 }}} 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): 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. 58 59 {{{ 60 DefaultInitEnv TRAC_ENV /path/to/env/trac/ 61 }}} 62 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: 60 66 {{{ 61 67 import os 62 68 os.environ['TRAC_ENV'] = "/path/to/projectenv" 63 69 }}} 64 or 70 or: 65 71 {{{ 66 72 import os … … 68 74 }}} 69 75 70 With this method different projects can be supported by using different 71 `.fcgi` scripts with different `ScriptAliases`. 76 With this method different projects can be supported by using different `.fcgi` scripts with different `ScriptAliases`. 72 77 73 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: … … 76 81 }}} 77 82 78 == Simple Cherokee Configuration ==83 == Simple Cherokee Configuration 79 84 80 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. 81 86 You can either start it manually, or better yet, automatically by letting Cherokee spawn the server whenever it is down. 82 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: 83 88 84 89 {{{ … … 93 98 94 99 After 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. 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/'' 96 97 == Simple Lighttpd Configuration == 98 99 The FastCGI front-end was developed primarily for use with alternative webservers, such as [http://www.lighttpd.net/ lighttpd]. 100 101 lighttpd is a secure, fast, compliant and very flexible web-server that has been optimized for high-performance 102 environments. It has a very low memory footprint compared to other web servers and takes care of CPU load. 103 104 For using `trac.fcgi`(prior to 0.11) / fcgi_frontend.py (0.11) with lighttpd add the following to your lighttpd.conf: 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 {{{ 106 sudo apt-get install python-flup 107 }}} 108 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: 105 116 {{{ 106 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 … … 119 130 }}} 120 131 121 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, 122 and you may set one of the two in `trac.fcgi` instead of in `lighttpd.conf` 123 using `bin-environment` (as in the section above on Apache configuration).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. 124 135 125 136 For using two projects with lighttpd add the following to your `lighttpd.conf`: … … 145 156 ) 146 157 }}} 147 Note that field values are different. If you prefer setting the environment 148 variables in the `.fcgi` scripts, then copy/rename `trac.fcgi`, e.g., to 149 `first.fcgi` and `second.fcgi`, and reference them in the above settings. 150 Note that the above will result in different processes in any event, even 151 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. 161 152 162 {{{ 153 163 #!div class=important 154 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. 155 165 }}} 166 156 167 For authentication you should enable mod_auth in lighttpd.conf 'server.modules', select auth.backend and auth rules: 157 168 {{{ … … 190 201 ) 191 202 192 193 }}} 194 Note that lighttpd (I use version 1.4.3) stopped if password file doesn't exist. 195 196 Note that lighttpd doesn't support 'valid-user' in versions prior to 1.3.16. 197 198 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: 199 209 {{{ 200 210 # Aliasing functionality is needed 201 211 server.modules += ("mod_alias") 202 212 203 # Set up an alias for the static resources213 # Set up an alias for the static resources 204 214 alias.url = ("/trac/chrome/common" => "/usr/share/trac/htdocs") 205 215 … … 220 230 } 221 231 }}} 232 222 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. 223 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: … … 251 262 }}} 252 263 253 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: 254 265 {{{ 255 266 fastcgi.server = ("/trac" => … … 267 278 For details about languages specification see [trac:TracFaq TracFaq] question 2.13. 268 279 269 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. 270 271 If you use trac-0.9, read [http://lists.edgewall.com/archive/trac/2005-November/005311.html about small bug] 272 273 Relaunch lighttpd, and browse to `http://yourhost.example.org/trac` to access Trac. 274 275 Note about running lighttpd with reduced permissions: 276 277 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. 278 279 280 == Simple !LiteSpeed Configuration == 280 Other important information like the [wiki:TracInstall#MappingStaticResources mapping static resources advices] are useful for non-fastcgi specific installation aspects. 281 ] 282 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 281 288 282 289 The FastCGI front-end was developed primarily for use with alternative webservers, such as [http://www.litespeedtech.com/ LiteSpeed]. … … 284 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. 285 292 286 Setup 287 288 1) Please make sure you have first have a working install of a Trac project. Test install with “tracd” first. 289 290 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: 291 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: 292 296 {{{ 293 297 http://yourdomain.com/trac/ 294 298 }}} 295 299 296 3) Go “TracVhost → External Apps” tab and create a new “External Application”. 297 300 3. Go "!TracVhost → External Apps" tab and create a new "External Application". 298 301 {{{ 299 302 Name: MyTracFCGI … … 312 315 }}} 313 316 314 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. 315 318 316 319 {{{ … … 322 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. 323 326 324 5) Go to “PythonVhost → Contexts” and create a new “FCGI Context”.327 5. Go to "!PythonVhost → Contexts" and create a new FCGI Context. 325 328 326 329 {{{ … … 330 333 }}} 331 334 332 6) Modify /fullpathto/mytracproject/conf/trac.ini 335 6. Modify `/fullpathto/mytracproject/conf/trac.ini` 333 336 334 337 {{{ … … 339 342 }}} 340 343 341 7)Restart !LiteSpeed, “lswsctrl restart”, and access your new Trac project at:344 7. Restart !LiteSpeed, “lswsctrl restart”, and access your new Trac project at: 342 345 343 346 {{{ … … 345 348 }}} 346 349 347 === Simple Nginx Configuration === 348 349 1) Nginx configuration snippet - confirmed to work on 0.6.32 350 {{{ 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. 353 354 1. Nginx configuration with basic authentication handled by Nginx - confirmed to work on 0.6.32 355 {{{ 351 356 server { 352 357 listen 10.9.8.7:443; … … 363 368 ssl_prefer_server_ciphers on; 364 369 365 # (Or ``^/some/prefix/(.*)``.366 if ($uri ~ ^/(.*)) {367 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; 368 373 } 369 374 370 # You can copy this whole location to ``location [/some/prefix] /login``375 # You can copy this whole location to ``location [/some/prefix](/login)`` 371 376 # and remove the auth entries below if you want Trac to enforce 372 377 # authorization where appropriate instead of needing to authenticate 373 378 # for accessing the whole site. 374 # (Or `` location /some/prefix``.)375 location /{379 # (Or ``~ location /some/prefix(/.*)``.) 380 location ~ (/.*) { 376 381 auth_basic "trac realm"; 377 382 auth_basic_user_file /home/trac/htpasswd; … … 387 392 # (Or ``fastcgi_param SCRIPT_NAME /some/prefix``.) 388 393 fastcgi_param SCRIPT_NAME ""; 389 fastcgi_param PATH_INFO $ path_info;394 fastcgi_param PATH_INFO $1; 390 395 391 396 ## WSGI NEEDED VARIABLES - trac warns about them … … 394 399 fastcgi_param SERVER_PORT $server_port; 395 400 fastcgi_param SERVER_PROTOCOL $server_protocol; 396 397 # for authentication to work 401 fastcgi_param QUERY_STRING $query_string; 402 403 # For Nginx authentication to work - do not forget to comment these 404 # lines if not using Nginx for authentication 398 405 fastcgi_param AUTH_USER $remote_user; 399 406 fastcgi_param REMOTE_USER $remote_user; 407 408 # for ip to work 409 fastcgi_param REMOTE_ADDR $remote_addr; 410 411 # For attchments to work 412 fastcgi_param CONTENT_TYPE $content_type; 413 fastcgi_param CONTENT_LENGTH $content_length; 400 414 } 401 415 } 402 416 }}} 403 404 2) Modified trac.fcgi: 405 406 {{{ 417 1. Modified trac.fcgi: 418 {{{ 407 419 #!/usr/bin/env python 408 420 import os … … 435 447 436 448 }}} 437 438 3) reload nginx and launch trac.fcgi like that: 439 440 {{{ 449 1. reload nginx and launch trac.fcgi like that: 450 {{{#!sh 441 451 trac@trac.example ~ $ ./trac-standalone-fcgi.py 442 452 }}} 443 453 444 454 The above assumes that: 445 * There is a user named 'trac' for running trac instances and keeping trac environments in its home directory .446 * /home/trac/instancecontains a trac environment447 * /home/trac/htpasswdcontains authentication information448 * /home/trac/runis owned by the same group the nginx runs under449 * and if your system is Linux the /home/trac/run has setgid bit set (chmod g+s run)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 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`) 450 460 * and patch from ticket #T7239 is applied, or you'll have to fix the socket file permissions every time 451 461 452 462 Unfortunately nginx does not support variable expansion in fastcgi_pass directive. 453 Thus it is not possible to serve multiple trac instances from one server block.454 455 If you worry enough about security, run trac instances under separate users.456 457 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 458 468 459 469 ----