Changes between Version 1 and Version 2 of TracFastCgi
- Timestamp:
- Jul 30, 2012 5:33:42 PM (12 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracFastCgi
v1 v2 1 [[PageOutline]] 2 1 3 = Trac with FastCGI = 2 4 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]. 5 [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 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 9 '''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 [[PageOutline(2-3,Overview,inline)]] 12 6 13 7 14 == Simple Apache configuration == … … 10 17 `mod_fcgid` (preferred). The latter is more up-to-date. 11 18 12 ==== setup with `mod_fastcgi` ==== 19 The following sections focus on the FCGI specific setup, see also [wiki:TracModWSGI#ConfiguringAuthentication] for configuring the authentication in Apache. 20 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` === 13 24 `mod_fastcgi` uses `FastCgiIpcDir` and `FastCgiConfig` directives that should be added to an appropriate Apache configuration file: 14 25 {{{ … … 27 38 calling `trac.fcgi` instead of `trac.cgi`. 28 39 29 You canset up the `TRAC_ENV` as an overall default:40 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 41 {{{ 31 42 FastCgiConfig -initial-env TRAC_ENV=/path/to/env/trac 32 43 }}} 33 44 34 Or you can serve multiple Trac projects in a directory like:45 Alternatively, you can serve multiple Trac projects in a directory by adding this: 35 46 {{{ 36 47 FastCgiConfig -initial-env TRAC_ENV_PARENT_DIR=/parent/dir/of/projects 37 48 }}} 38 49 39 === = setup with `mod_fcgid` ====50 === Set up with `mod_fcgid` === 40 51 Configure `ScriptAlias` (see TracCgi for details), but call `trac.fcgi` 41 52 instead of `trac.cgi`. Note that slash at the end - it is important. … … 44 55 }}} 45 56 46 To set up Trac environment for `mod_fcgid` it is necessary to use47 ` FCGIDDefaultInitEnv` directive. It cannot be used in `Directory` or57 To set up Trac environment for `mod_fcgid` it is necessary to use 58 `DefaultInitEnv` directive. It cannot be used in `Directory` or 48 59 `Location` context, so if you need to support multiple projects, try 49 60 alternative environment setup below. 50 61 51 62 {{{ 52 FCGIDDefaultInitEnv TRAC_ENV /path/to/env/trac/53 }}} 54 55 === = alternative environment setup ====56 A better method to specify path to Trac environment i tto embed the path63 DefaultInitEnv TRAC_ENV /path/to/env/trac/ 64 }}} 65 66 === alternative environment setup === 67 A better method to specify path to Trac environment is to embed the path 57 68 into `trac.fcgi` script itself. That doesn't require configuration of server 58 69 environment variables, works for both FastCgi modules … … 93 104 94 105 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/'' 106 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). 107 108 Note:\\ 109 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.\\ 110 Python-flup is a dependency which provides trac with SCGI capability. You can install it on debian based systems with: 111 {{{ 112 sudo apt-get install python-flup 113 }}} 114 96 115 97 116 == Simple Lighttpd Configuration == … … 122 141 and you may set one of the two in `trac.fcgi` instead of in `lighttpd.conf` 123 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 should be fixed since lighttpd 1.4.23, and you may need to add `"fix-root-scriptname" => "enable"` as parameter of fastcgi.server. 124 145 125 146 For using two projects with lighttpd add the following to your `lighttpd.conf`: … … 150 171 Note that the above will result in different processes in any event, even 151 172 if both are running from the same `trac.fcgi` script. 173 152 174 {{{ 153 175 #!div class=important 154 176 '''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 177 }}} 178 156 179 For authentication you should enable mod_auth in lighttpd.conf 'server.modules', select auth.backend and auth rules: 157 180 {{{ … … 201 224 server.modules += ("mod_alias") 202 225 203 # Set up an alias for the static resources226 # Set up an alias for the static resources 204 227 alias.url = ("/trac/chrome/common" => "/usr/share/trac/htdocs") 205 228 … … 267 290 For details about languages specification see [trac:TracFaq TracFaq] question 2.13. 268 291 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] 292 Other important information like the [wiki:TracInstall#MappingStaticResources mapping static resources advices] are useful for non-fastcgi specific installation aspects. 293 ] 272 294 273 295 Relaunch lighttpd, and browse to `http://yourhost.example.org/trac` to access Trac. … … 275 297 Note about running lighttpd with reduced permissions: 276 298 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.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. 278 300 279 301 … … 284 306 !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 307 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: 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: 291 311 292 312 {{{ … … 294 314 }}} 295 315 296 3) Go “TracVhost → External Apps” tab and create a new “External Application”.316 3. Go “!TracVhost → External Apps” tab and create a new “External Application”. 297 317 298 318 {{{ … … 312 332 }}} 313 333 314 4) Optional. If you need to use htpasswd based authentication. Go to “TracVhost → Security” tab and create a new security “Realm”.334 4. Optional. If you need to use htpasswd based authentication. Go to “!TracVhost → Security” tab and create a new security “Realm”. 315 335 316 336 {{{ … … 322 342 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 343 324 5) Go to “PythonVhost → Contexts” and create a new “FCGI Context”.344 5. Go to “!PythonVhost → Contexts” and create a new “FCGI Context”. 325 345 326 346 {{{ … … 330 350 }}} 331 351 332 6) Modify /fullpathto/mytracproject/conf/trac.ini 352 6. Modify `/fullpathto/mytracproject/conf/trac.ini` 333 353 334 354 {{{ … … 339 359 }}} 340 360 341 7)Restart !LiteSpeed, “lswsctrl restart”, and access your new Trac project at:361 7. Restart !LiteSpeed, “lswsctrl restart”, and access your new Trac project at: 342 362 343 363 {{{ … … 345 365 }}} 346 366 347 === Simple Nginx Configuration === 348 349 1) Nginx configuration snippet - confirmed to work on 0.6.32 367 368 == Simple Nginx Configuration == 369 370 Nginx is able to communicate with FastCGI processes, but can not spawn them. So you need to start FastCGI server for Trac separately. 371 372 1. Nginx configuration with basic authentication handled by Nginx - confirmed to work on 0.6.32 350 373 {{{ 351 374 server { … … 366 389 if ($uri ~ ^/(.*)) { 367 390 set $path_info /$1; 391 } 392 393 # it makes sense to serve static resources through Nginx 394 location /chrome/ { 395 alias /home/trac/instance/static/htdocs/; 368 396 } 369 397 … … 394 422 fastcgi_param SERVER_PORT $server_port; 395 423 fastcgi_param SERVER_PROTOCOL $server_protocol; 396 397 # for authentication to work 424 fastcgi_param QUERY_STRING $query_string; 425 426 # For Nginx authentication to work - do not forget to comment these 427 # lines if not using Nginx for authentication 398 428 fastcgi_param AUTH_USER $remote_user; 399 429 fastcgi_param REMOTE_USER $remote_user; 430 431 # for ip to work 432 fastcgi_param REMOTE_ADDR $remote_addr; 433 434 # For attchments to work 435 fastcgi_param CONTENT_TYPE $content_type; 436 fastcgi_param CONTENT_LENGTH $content_length; 400 437 } 401 438 } 402 439 }}} 403 440 404 2)Modified trac.fcgi:441 2. Modified trac.fcgi: 405 442 406 443 {{{ … … 436 473 }}} 437 474 438 3)reload nginx and launch trac.fcgi like that:475 3. reload nginx and launch trac.fcgi like that: 439 476 440 477 {{{ … … 444 481 The above assumes that: 445 482 * 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)483 * `/home/trac/instance` contains a trac environment 484 * `/home/trac/htpasswd` contains authentication information 485 * `/home/trac/run` is owned by the same group the nginx runs under 486 * and if your system is Linux the `/home/trac/run` has setgid bit set (`chmod g+s run`) 450 487 * and patch from ticket #T7239 is applied, or you'll have to fix the socket file permissions every time 451 488