| 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 == |
| 8 | | |
| 9 | | There are two FastCGI modules commonly available for Apache: `mod_fastcgi` and |
| 10 | | `mod_fcgid` (preferred). The latter is more up-to-date. |
| 11 | | |
| 12 | | ==== setup with `mod_fastcgi` ==== |
| | 1 | = Trac with FastCGI |
| | 2 | |
| | 3 | [[TracGuideToc]] |
| | 4 | [[PageOutline(2-5, Contents, floated)]] |
| | 5 | |
| | 6 | [https://fastcgi-archives.github.io 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 | |
| | 8 | Note that unlike mod_python, FastCGI supports [https://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 | == 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. |
| | 15 | |
| | 16 | The following sections focus on the FCGI specific setup, see also [wiki:TracModWSGI#ConfiguringAuthentication] for configuring the authentication in Apache. |
| | 17 | |
| | 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`. |
| | 19 | |
| | 20 | === Set up with `mod_fastcgi` |
| | 21 | |
| 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. |
| 42 | | {{{ |
| | 48 | You can also specify the `PYTHON_EGG_CACHE` environment variable using a second `-initial-env` directive: |
| | 49 | {{{#!apache |
| | 50 | FastCgiConfig -initial-env TRAC_ENV=/var/lib/trac \ |
| | 51 | -initial-env PYTHON_EGG_CACHE=/var/lib/trac/plugin-cache |
| | 52 | }}} |
| | 53 | |
| | 54 | === Set up with `mod_fcgid` |
| | 55 | |
| | 56 | Configure `ScriptAlias` (see TracCgi for details), but call `trac.fcgi` instead of `trac.cgi`: |
| | 57 | {{{#!apache |
| 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): |
| 60 | | {{{ |
| | 61 | Note the slash at the end. |
| | 62 | |
| | 63 | 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: |
| | 64 | {{{#!apache |
| | 65 | DefaultInitEnv TRAC_ENV /path/to/env/trac/ |
| | 66 | }}} |
| | 67 | |
| | 68 | === Alternative environment setup |
| | 69 | |
| | 70 | 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 [https://www.lighttpd.net/ lighttpd] and CGI: |
| | 71 | {{{#!python |
| 78 | | == Simple Cherokee Configuration == |
| 79 | | |
| 80 | | 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 | | 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. |
| | 89 | == Cherokee Configuration |
| | 90 | |
| | 91 | 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. |
| | 92 | |
| | 93 | First set up an information source in cherokee-admin with a local interpreter: |
| 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: |
| | 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:''' If the tracd process fails to start up, and Cherokee displays a 503 error page, you might be missing the [https://www.saddi.com/software/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: |
| | 109 | {{{#!sh |
| | 110 | sudo apt-get install python-flup |
| | 111 | }}} |
| | 112 | |
| | 113 | == Lighttpd Configuration |
| | 114 | |
| | 115 | The FastCGI front-end was developed primarily for use with alternative webservers, such as [https://www.lighttpd.net/ Lighttpd]. |
| | 116 | |
| | 117 | 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. |
| | 118 | |
| | 119 | For using `trac.fcgi`(prior to 0.11) / fcgi_frontend.py (0.11) with Lighttpd add the following to your lighttpd.conf: |
| 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). |
| | 136 | 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. |
| | 137 | |
| | 138 | 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. |
| 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. |
| 152 | | {{{ |
| 153 | | #!div class=important |
| 154 | | '''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 | | }}} |
| | 162 | |
| | 163 | 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. |
| | 164 | Note that the above will result in different processes in any event, even if both are running from the same `trac.fcgi` script. |
| | 165 | |
| | 166 | {{{#!div class=important |
| | 167 | '''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. |
| | 168 | }}} |
| | 169 | |
| 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 == |
| 281 | | |
| 282 | | The FastCGI front-end was developed primarily for use with alternative webservers, such as [http://www.litespeedtech.com/ LiteSpeed]. |
| | 286 | Other important information like the [wiki:TracInstall#MappingStaticResources mapping static resources advices] are useful for non-fastcgi specific installation aspects. |
| | 287 | |
| | 288 | Relaunch Lighttpd and browse to `http://yourhost.example.org/trac` to access Trac. |
| | 289 | |
| | 290 | 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. |
| | 291 | |
| | 292 | == !LiteSpeed Configuration |
| | 293 | |
| | 294 | The FastCGI front-end was developed primarily for use with alternative webservers, such as [https://www.litespeedtech.com/ LiteSpeed]. |
| 340 | | |
| 341 | | 7) Restart !LiteSpeed, “lswsctrl restart”, and access your new Trac project at: |
| 342 | | |
| 343 | | {{{ |
| 344 | | http://yourdomain.com/trac/ |
| 345 | | }}} |
| 346 | | |
| 347 | | === Simple Nginx Configuration === |
| 348 | | |
| 349 | | 1) Nginx configuration snippet - confirmed to work on 0.6.32 |
| 350 | | {{{ |
| | 339 | 1. Restart !LiteSpeed: `lswsctrl restart`, and access your new Trac project at {{{http://yourdomain.com/trac/}}}. |
| | 340 | |
| | 341 | == Nginx Configuration |
| | 342 | |
| | 343 | [https://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. |
| | 344 | |
| | 345 | 1. Nginx configuration with basic authentication handled by Nginx - confirmed to work on 0.6.32 |
| | 346 | {{{#!nginx |
| 445 | | * There is a user named 'trac' for running trac instances and keeping trac environments in its home directory. |
| 446 | | * /home/trac/instance contains a trac environment |
| 447 | | * /home/trac/htpasswd contains authentication information |
| 448 | | * /home/trac/run is owned by the same group the nginx runs under |
| 449 | | * and if your system is Linux the /home/trac/run has setgid bit set (chmod g+s run) |
| 450 | | * and patch from ticket #T7239 is applied, or you'll have to fix the socket file permissions every time |
| 451 | | |
| 452 | | 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 #T6224 |
| | 446 | * There is a user named 'trac' for running Trac instances and keeping Trac environments in its home directory |
| | 447 | * `/home/trac/instance` contains a Trac environment |
| | 448 | * `/home/trac/htpasswd` contains authentication information |
| | 449 | * `/home/trac/run` is owned by the same group the Nginx runs under |
| | 450 | * and if your system is Linux the `/home/trac/run` has setgid bit set (`chmod g+s run`) |
| | 451 | * and patch from [trac:#7239] is applied, or you'll have to fix the socket file permissions every time |
| | 452 | |
| | 453 | Unfortunately Nginx does not support variable expansion in fastcgi_pass directive. |
| | 454 | Thus it is not possible to serve multiple Trac instances from one server block. |
| | 455 | |
| | 456 | If you worry enough about security, run Trac instances under separate users. |
| | 457 | |
| | 458 | Another way to run Trac as a FCGI external application is offered in [trac:#6224]. |
