# Changes between Version 1 and Version 2 of TracFastCgi

Ignore:
Timestamp:
Jun 1, 2010 11:09:27 PM (12 years ago)
Comment:

--

### Legend:

Unmodified
 v1 = Trac with FastCGI = Since version 0.9, Trac supports being run through the [http://www.fastcgi.com/ FastCGI] interface. Like [wiki:TracModPython mod_python], this allows Trac to remain resident, and is faster than external CGI interfaces which must start a new process for each request. However, unlike mod_python, it is able to support [http://httpd.apache.org/docs/suexec.html SuEXEC]. Additionally, it is supported by much wider variety of web servers. '''Note for Windows:''' Trac's FCGI 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, your choice may be [trac:TracOnWindowsIisAjp AJP]. [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. '''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]. == Simple Apache configuration == There are two FastCGI modules commonly available for Apache: mod_fastcgi and mod_fcgid.  The FastCgiIpcDir and FastCgiConfig directives discussed below are mod_fastcgi directives; the DefaultInitEnv is a mod_fcgid directive. For mod_fastcgi, add the following to an appropriate Apache configuration file: mod_fcgid (preferred). The latter is more up-to-date. ==== setup with mod_fastcgi ==== mod_fastcgi uses FastCgiIpcDir and FastCgiConfig directives that should be added to an appropriate Apache configuration file: {{{ # Enable fastcgi for .fcgi files }}} But neither of these will work for mod_fcgid.  A similar but partial solution for mod_fcgid is: ==== setup with mod_fcgid ==== Configure ScriptAlias (see TracCgi for details), but call trac.fcgi instead of trac.cgi. Note that slash at the end - it is important. {{{ ScriptAlias /trac /path/to/www/trac/cgi-bin/trac.fcgi/ }}} To setup 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. {{{ DefaultInitEnv TRAC_ENV /path/to/env/trac/ }}} But this cannot be used in Directory or Location context, which makes it difficult to support multiple projects. A better method which works for both of these modules (and for  [http://www.lighttpd.net/ lighttpd] and CGI as well), because it involves no server configuration settings for environment variables, is to set one of the variables in trac.fcgi, e.g.: ==== alternative environment setup ==== A better method to specify path to Trac environment it to embed the path into trac.fcgi script itself. That doesn't require configuration of server environment variables, works for both FastCgi modules (and for [http://www.lighttpd.net/ lighttpd] and CGI as well): {{{ import os }}} Using this method, different projects can be supported by using different .fcgi scripts with different ScriptAliases, copying and appropriately renaming trac.fcgi and adding the above code to create each such script. With this method different projects can be supported by using different .fcgi scripts with different ScriptAliases. 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: For using trac.fcgi(prior to 0.11) / fcgi_frontend.py (0.11) with lighttpd add the following to your lighttpd.conf: {{{ #var.fcgi_binary="/path/to/fcgi_frontend.py" # 0.11 if installed with easy_setup, it is inside the egg directory #var.fcgi_binary="/usr/bin/python /path/to/fcgi_frontend.py" # 0.11 if installed with easy_setup, it is inside the egg directory var.fcgi_binary="/path/to/cgi-bin/trac.fcgi" # 0.10 name of prior fcgi executable fastcgi.server = ("/trac" => 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). 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 #Trac2418. This should be fixed since lighttpd 1.4.23, and you may need to add "fix-root-scriptname" => "enable" as parameter of fastcgi.server. For using two projects with lighttpd add the following to your lighttpd.conf: 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. 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. !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. Setup 1) Please make sure you have first have a working install of a Trac project. Test install with “tracd” first. 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: === Setup === 1. Please make sure you have first have a working install of a Trac project. Test install with “tracd” first. 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: {{{ }}} 3) Go “TracVhost → External Apps” tab and create a new “External Application”. 3. Go “!TracVhost → External Apps” tab and create a new “External Application”. {{{ }}} 4) Optional. If you need to use htpasswd based authentication. Go to “TracVhost → Security” tab and create a new security “Realm”. 4. Optional. If you need to use htpasswd based authentication. Go to “!TracVhost → Security” tab and create a new security “Realm”. {{{ 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. 5) Go to “PythonVhost → Contexts” and create a new “FCGI Context”. 5. Go to “!PythonVhost → Contexts” and create a new “FCGI Context”. {{{ }}} 6) Modify /fullpathto/mytracproject/conf/trac.ini 6. Modify /fullpathto/mytracproject/conf/trac.ini {{{ }}} 7) Restart !LiteSpeed, “lswsctrl restart”, and access your new Trac project at: 7. Restart !LiteSpeed, “lswsctrl restart”, and access your new Trac project at: {{{ }}} === Simple Nginx Configuration === 1) Nginx configuration snippet - confirmed to work on 0.6.32 == Simple Nginx Configuration == 1. Nginx configuration snippet - confirmed to work on 0.6.32 {{{ server { fastcgi_param  SERVER_PORT        $server_port; fastcgi_param SERVER_PROTOCOL$server_protocol; fastcgi_param  QUERY_STRING     \$query_string; # for authentication to work }}} 2) Modified trac.fcgi: 2. Modified trac.fcgi: {{{ }}} 3) reload nginx and launch trac.fcgi like that: 3. reload nginx and launch trac.fcgi like that: {{{ The above assumes that: * There is a user named 'trac' for running trac instances and keeping trac environments in its home directory. * /home/trac/instance contains a trac environment * /home/trac/htpasswd contains authentication information * /home/trac/run is owned by the same group the nginx runs under * and if your system is Linux the /home/trac/run has setgid bit set (chmod g+s run) * /home/trac/instance contains a trac environment * /home/trac/htpasswd contains authentication information * /home/trac/run is owned by the same group the nginx runs under * and if your system is Linux the /home/trac/run has setgid bit set (chmod g+s run) * and patch from ticket #T7239 is applied, or you'll have to fix the socket file permissions every time