Changes between Version 86 and Version 87 of TracFastCgi
- Timestamp:
- Jul 27, 2015, 10:31:48 PM (9 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracFastCgi
v86 v87 4 4 [[PageOutline(2-5, Contents, floated)]] 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 [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 a much wider variety of web servers. 7 7 8 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. … … 10 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 11 12 == Simple Apache configuration 13 14 There are two FastCGI modules commonly available for Apache: `mod_fastcgi` and 15 `mod_fcgid` (preferred). The latter is more up-to-date. 12 == Apache configuration 13 14 There are two FastCGI modules commonly available for Apache: `mod_fastcgi` and `mod_fcgid` (preferred). The latter is more up-to-date. 16 15 17 16 The following sections focus on the FCGI specific setup, see also [wiki:TracModWSGI#ConfiguringAuthentication] for configuring the authentication in Apache. 18 17 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.18 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 19 21 20 === Set up with `mod_fastcgi` 22 21 23 22 `mod_fastcgi` uses `FastCgiIpcDir` and `FastCgiConfig` directives that should be added to an appropriate Apache configuration file: 24 {{{ 23 {{{#!apache 25 24 # Enable fastcgi for .fcgi files 26 25 # (If you're using a distro package for mod_fcgi, something like … … 32 31 LoadModule fastcgi_module /usr/lib/apache2/modules/mod_fastcgi.so 33 32 }}} 33 34 34 Setting `FastCgiIpcDir` is optional if the default is suitable. Note that the `LoadModule` line must be after the `IfModule` group. 35 35 36 Configure `ScriptAlias` or similar options as described in TracCgi, but 37 calling `trac.fcgi` instead of `trac.cgi`. 36 Configure `ScriptAlias` or similar options as described in TracCgi, but calling `trac.fcgi` instead of `trac.cgi`. 38 37 39 38 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: 40 {{{ 39 {{{#!apache 41 40 FastCgiConfig -initial-env TRAC_ENV=/path/to/env/trac 42 41 }}} 43 42 44 43 Alternatively, you can serve multiple Trac projects in a directory by adding this: 45 {{{ 44 {{{#!apache 46 45 FastCgiConfig -initial-env TRAC_ENV_PARENT_DIR=/parent/dir/of/projects 47 46 }}} … … 50 49 51 50 Configure `ScriptAlias` (see TracCgi for details), but call `trac.fcgi` instead of `trac.cgi`: 52 {{{ 51 {{{#!apache 53 52 ScriptAlias /trac /path/to/www/trac/cgi-bin/trac.fcgi/ 54 53 }}} 55 54 Note the slash at the end. 56 55 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 {{{ 56 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 the alternative environment setup below: 57 {{{#!apache 60 58 DefaultInitEnv TRAC_ENV /path/to/env/trac/ 61 59 }}} 62 60 63 === alternative environment setup64 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:66 {{{ 61 === Alternative environment setup 62 63 A better method to specify the 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: 64 {{{#!python 67 65 import os 68 66 os.environ['TRAC_ENV'] = "/path/to/projectenv" 69 67 }}} 70 68 or: 71 {{{ 69 {{{#!python 72 70 import os 73 71 os.environ['TRAC_ENV_PARENT_DIR'] = "/path/to/project/parent/dir" … … 77 75 78 76 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: 79 {{{ 77 {{{#!apache 80 78 ScriptAlias / /srv/tracsite/cgi-bin/trac.fcgi/ 81 79 }}} 82 80 83 == SimpleCherokee Configuration84 85 The configuration o n Cherokee's sideis quite simple. You will only need to know that you can spawn Trac as an SCGI process.81 == Cherokee Configuration 82 83 The configuration of Cherokee with Trac is quite simple. You will only need to know that you can spawn Trac as an SCGI process. 86 84 You can either start it manually, or better yet, automatically by letting Cherokee spawn the server whenever it is down. 87 85 First set up an information source in cherokee-admin with a local interpreter: … … 100 98 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 99 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 {{{ 100 '''Note:''' 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 (#9903). Python-flup is a dependency which provides trac with SCGI capability. You can install it on Debian based systems with: 101 {{{#!sh 106 102 sudo apt-get install python-flup 107 103 }}} 108 104 109 == SimpleLighttpd Configuration105 == Lighttpd Configuration 110 106 111 107 The FastCGI front-end was developed primarily for use with alternative webservers, such as [http://www.lighttpd.net/ Lighttpd]. … … 157 153 }}} 158 154 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.155 Note that the 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 156 Note that the above will result in different processes in any event, even if both are running from the same `trac.fcgi` script. 161 157 162 158 {{{ 163 159 #!div class=important 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.160 '''Note:''' The order in which the server.modules are loaded is very important: if mod_auth is not loaded '''before''' mod_fastcgi, then the server will fail to authenticate the user. 165 161 }}} 166 162 … … 232 228 233 229 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. 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: 230 231 Also there is another way to handle multiple projects and it uses `TRAC_ENV_PARENT_DIR` instead of `TRAC_ENV` as well as global authentication: 235 232 {{{ 236 233 # This is for handling multiple projects … … 279 276 280 277 Other important information like the [wiki:TracInstall#MappingStaticResources mapping static resources advices] are useful for non-fastcgi specific installation aspects. 281 ]282 278 283 279 Relaunch Lighttpd and browse to `http://yourhost.example.org/trac` to access Trac. … … 285 281 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 282 287 == Simple!LiteSpeed Configuration283 == !LiteSpeed Configuration 288 284 289 285 The FastCGI front-end was developed primarily for use with alternative webservers, such as [http://www.litespeedtech.com/ LiteSpeed]. … … 292 288 293 289 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: 290 1. 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: 296 291 {{{ 297 292 http://yourdomain.com/trac/ 298 293 }}} 299 300 3. Go "!TracVhost → External Apps" tab and create a new "External Application". 294 1. Go "!TracVhost → External Apps" tab and create a new "External Application": 301 295 {{{ 302 296 Name: MyTracFCGI … … 314 308 Instances: 10 315 309 }}} 316 317 4. Optional: If you need to use htpasswd based authentication. Go to "!TracVhost → Security" tab and create a new security Realm. 318 319 {{{ 310 1. Optional: If you need to use htpasswd based authentication. Go to "!TracVhost → Security" tab and create a new security Realm: 311 {{{ 320 312 DB Type: Password File 321 313 Realm Name: MyTracUserDB <--- any name you wish and referenced later 322 314 User DB Location: /fullpathto/htpasswd <--- path to your htpasswd file 323 315 }}} 324 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. 326 327 5. Go to "!PythonVhost → Contexts" and create a new FCGI Context. 328 329 {{{ 316 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. 317 1. Go to "!PythonVhost → Contexts" and create a new FCGI Context: 318 {{{ 330 319 URI: /trac/ <--- URI path to bind to python fcgi app we created 331 320 Fast CGI App: [VHost Level] MyTractFCGI <--- select the trac fcgi extapp we just created 332 321 Realm: TracUserDB <--- only if (4) is set. select realm created in (4) 333 322 }}} 334 335 6. Modify `/fullpathto/mytracproject/conf/trac.ini` 336 337 {{{ 323 1. Modify `/fullpathto/mytracproject/conf/trac.ini`: 324 {{{ 338 325 #find/set base_rul, url, and link variables 339 326 base_url = http://yourdomain.com/trac/ <--- base url to generate correct links to … … 341 328 link = http://yourdomain.com/trac/ <--- link of graphic logo 342 329 }}} 343 344 7. Restart !LiteSpeed, “lswsctrl restart”, and access your new Trac project at: 345 346 {{{ 347 http://yourdomain.com/trac/ 348 }}} 349 350 == Simple Nginx Configuration 330 1. Restart !LiteSpeed: `lswsctrl restart`, and access your new Trac project at {{{http://yourdomain.com/trac/}}}. 331 332 == Nginx Configuration 351 333 352 334 Nginx is able to communicate with FastCGI processes, but can not spawn them. So you need to start FastCGI server for Trac separately. … … 447 429 448 430 }}} 449 1. reload nginx and launch trac.fcgi like that:431 1. Reload nginx and launch trac.fcgi: 450 432 {{{#!sh 451 433 trac@trac.example ~ $ ./trac-standalone-fcgi.py … … 453 435 454 436 The above assumes that: 455 * There is a user named 'trac' for running trac instances and keeping trac environments in its home directory456 * `/home/trac/instance` contains a trac environment437 * There is a user named 'trac' for running Trac instances and keeping Trac environments in its home directory 438 * `/home/trac/instance` contains a Trac environment 457 439 * `/home/trac/htpasswd` contains authentication information 458 * `/home/trac/run` is owned by the same group the nginx runs under440 * `/home/trac/run` is owned by the same group the Nginx runs under 459 441 * and if your system is Linux the `/home/trac/run` has setgid bit set (`chmod g+s run`) 460 * and patch from ticket #T7239 is applied, or you'll have to fix the socket file permissions every time461 462 Unfortunately nginx does not support variable expansion in fastcgi_pass directive.442 * and patch from #7239 is applied, or you'll have to fix the socket file permissions every time 443 444 Unfortunately Nginx does not support variable expansion in fastcgi_pass directive. 463 445 Thus it is not possible to serve multiple Trac instances from one server block. 464 446 465 447 If you worry enough about security, run Trac instances under separate users. 466 448 467 Another way to run Trac as a FCGI external application is offered in ticket #T6224449 Another way to run Trac as a FCGI external application is offered in #6224. 468 450 469 451 ----