Changes between Version 3 and Version 4 of TracFastCgi
- Timestamp:
- 1 Feb 2017, 00:38:41 (8 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracFastCgi
v3 v4 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 bymuch 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 }}} 54 55 55 Note the slash at the end. 56 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 {{{ 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 the alternative environment setup below: 58 {{{#!apache 60 59 DefaultInitEnv TRAC_ENV /path/to/env/trac/ 61 60 }}} 62 61 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 {{{ 62 === Alternative environment setup 63 64 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: 65 {{{#!python 67 66 import os 68 67 os.environ['TRAC_ENV'] = "/path/to/projectenv" 69 68 }}} 69 70 70 or: 71 {{{ 71 {{{#!python 72 72 import os 73 73 os.environ['TRAC_ENV_PARENT_DIR'] = "/path/to/project/parent/dir" … … 77 77 78 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: 79 {{{ 79 {{{#!apache 80 80 ScriptAlias / /srv/tracsite/cgi-bin/trac.fcgi/ 81 81 }}} 82 82 83 == SimpleCherokee Configuration84 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.86 You can either start it manually, or better yet, automatically by letting Cherokee spawn the server whenever it is down. 83 == Cherokee Configuration 84 85 Configuring [http://cherokee-project.com/ Cherokee] with Trac is straightforward, if you spawn Trac as an SCGI process. You can either start it manually, or better yet, automatically by letting Cherokee spawn the server whenever it is down. 86 87 87 First set up an information source in cherokee-admin with a local interpreter: 88 88 … … 98 98 99 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. 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 {{{ 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:''' 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 ([trac:#9903]). Python-flup is a dependency which provides Trac with SCGI capability. You can install it on Debian based systems with: 103 {{{#!sh 106 104 sudo apt-get install python-flup 107 105 }}} 108 106 109 == SimpleLighttpd Configuration107 == Lighttpd Configuration 110 108 111 109 The FastCGI front-end was developed primarily for use with alternative webservers, such as [http://www.lighttpd.net/ Lighttpd]. … … 157 155 }}} 158 156 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.157 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 158 Note that the above will result in different processes in any event, even if both are running from the same `trac.fcgi` script. 161 159 162 {{{ 163 #!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 {{{#!div class=important 161 '''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 162 }}} 166 163 … … 202 199 203 200 }}} 201 204 202 Note that Lighttpd (v1.4.3) stops if the password file doesn't exist. 205 203 … … 232 230 233 231 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: 232 233 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 234 {{{ 236 235 # This is for handling multiple projects … … 276 275 ) 277 276 }}} 277 278 278 For details about languages specification see [trac:TracFaq TracFaq] question 2.13. 279 279 280 280 Other important information like the [wiki:TracInstall#MappingStaticResources mapping static resources advices] are useful for non-fastcgi specific installation aspects. 281 ]282 281 283 282 Relaunch Lighttpd and browse to `http://yourhost.example.org/trac` to access Trac. … … 285 284 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 285 287 == Simple!LiteSpeed Configuration286 == !LiteSpeed Configuration 288 287 289 288 The FastCGI front-end was developed primarily for use with alternative webservers, such as [http://www.litespeedtech.com/ LiteSpeed]. … … 292 291 293 292 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: 293 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 294 {{{ 297 295 http://yourdomain.com/trac/ 298 296 }}} 299 300 3. Go "!TracVhost → External Apps" tab and create a new "External Application". 297 1. Go "!TracVhost → External Apps" tab and create a new "External Application": 301 298 {{{ 302 299 Name: MyTracFCGI … … 314 311 Instances: 10 315 312 }}} 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 {{{ 313 1. Optional: If you need to use htpasswd based authentication. Go to "!TracVhost → Security" tab and create a new security Realm: 314 {{{ 320 315 DB Type: Password File 321 316 Realm Name: MyTracUserDB <--- any name you wish and referenced later 322 317 User DB Location: /fullpathto/htpasswd <--- path to your htpasswd file 323 318 }}} 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 {{{ 319 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. 320 1. Go to "!PythonVhost → Contexts" and create a new FCGI Context: 321 {{{ 330 322 URI: /trac/ <--- URI path to bind to python fcgi app we created 331 Fast CGI App: [VHost Level] MyTractFCGI <--- select the trac fcgi extapp we just created323 Fast CGI App: [VHost Level] MyTractFCGI <--- select the Trac fcgi extapp we just created 332 324 Realm: TracUserDB <--- only if (4) is set. select realm created in (4) 333 325 }}} 334 335 6. Modify `/fullpathto/mytracproject/conf/trac.ini` 336 337 {{{ 326 1. Modify `/fullpathto/mytracproject/conf/trac.ini`: 327 {{{ 338 328 #find/set base_rul, url, and link variables 339 329 base_url = http://yourdomain.com/trac/ <--- base url to generate correct links to … … 341 331 link = http://yourdomain.com/trac/ <--- link of graphic logo 342 332 }}} 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 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. 333 1. Restart !LiteSpeed: `lswsctrl restart`, and access your new Trac project at {{{http://yourdomain.com/trac/}}}. 334 335 == Nginx Configuration 336 337 [http://nginx.org/en/ Nginx] is able to communicate with FastCGI processes, but can not spawn them. So you need to start FastCGI server for Trac separately. 353 338 354 339 1. Nginx configuration with basic authentication handled by Nginx - confirmed to work on 0.6.32 355 {{{ 340 {{{#!nginx 356 341 server { 357 342 listen 10.9.8.7:443; … … 416 401 }}} 417 402 1. Modified trac.fcgi: 418 {{{ 403 {{{#!python 419 404 #!/usr/bin/env python 420 405 import os … … 447 432 448 433 }}} 449 1. reload nginx and launch trac.fcgi like that:434 1. Reload nginx and launch trac.fcgi: 450 435 {{{#!sh 451 436 trac@trac.example ~ $ ./trac-standalone-fcgi.py … … 453 438 454 439 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 environment440 * There is a user named 'trac' for running Trac instances and keeping Trac environments in its home directory 441 * `/home/trac/instance` contains a Trac environment 457 442 * `/home/trac/htpasswd` contains authentication information 458 * `/home/trac/run` is owned by the same group the nginx runs under443 * `/home/trac/run` is owned by the same group the Nginx runs under 459 444 * and if your system is Linux the `/home/trac/run` has setgid bit set (`chmod g+s run`) 460 * and patch from ticket #T7239is 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.445 * and patch from [trac:#7239] is applied, or you'll have to fix the socket file permissions every time 446 447 Unfortunately Nginx does not support variable expansion in fastcgi_pass directive. 463 448 Thus it is not possible to serve multiple Trac instances from one server block. 464 449 465 450 If you worry enough about security, run Trac instances under separate users. 466 451 467 Another way to run Trac as a FCGI external application is offered in ticket #T6224452 Another way to run Trac as a FCGI external application is offered in [trac:#6224]. 468 453 469 454 ---- 470 See also: 455 See also: TracGuide, TracInstall, [wiki:TracModWSGI ModWSGI], [wiki:TracCgi CGI], [wiki:TracModPython ModPython], [trac:TracNginxRecipe TracNginxRecipe]