Context Navigation

Changes between Version 2 and Version 3 of TracFastCgi

Timestamp:: 18/06/13 12:48:03 (11 years ago)
Author:: trac
Comment:: --

Legend:

: Unmodified
: Added
: Removed
: Modified

TracFastCgi

-                      v2
+                      v3
+[[PageOutline]]
 = 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.
+{{{
+#!html
+<p style="background: #fdc; border: 2px solid #d00; font-style: italic; padding: 0 .5em; margin: 1em 0;">
+<strong>Note for Windows:</strong> Trac's FCGI does not run under Windows, as Windows does not implement Socket.fromfd, which is used by _fcgi.py
+</p>
+}}}
+[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.
+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).
+'''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].
+[[PageOutline(2-3,Overview,inline)]]
 == 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.
+The following sections focus on the FCGI specific setup, see also [wiki:TracModWSGI#ConfiguringAuthentication] for configuring the authentication in Apache.
+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)
+=== Set up 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
 …
 calling `trac.fcgi` instead of `trac.cgi`.
 You can set up the `TRAC_ENV` as an overall default:
+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:
 {{{
 FastCgiConfig -initial-env TRAC_ENV=/path/to/env/trac
 }}}
 Or you can serve multiple Trac projects in a directory like:
+Alternatively, you can serve multiple Trac projects in a directory by adding this:
 {{{
 FastCgiConfig -initial-env TRAC_ENV_PARENT_DIR=/parent/dir/of/projects
 }}}
+But neither of these will work for `mod_fcgid`.  A similar but partial
+solution for `mod_fcgid` is:
+=== Set up 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 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.
 {{{
 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 is 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:
+{{{
+ScriptAlias / /srv/tracsite/cgi-bin/trac.fcgi/
+}}}
+== Simple Cherokee Configuration ==
+The configuration on Cherokee's side is quite simple. You will only need to know that you can 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.
+First set up an information source in cherokee-admin with a local interpreter.
+{{{
+Host:
+localhost:4433
+Interpreter:
+/usr/bin/tracd —single-env —daemonize —protocol=scgi —hostname=localhost —port=4433 /path/to/project/
+}}}
+If the port was not reachable, the interpreter command would be launched. Note that, in the definition of the information source, you will have to manually launch the spawner if you use a ''Remote host'' as ''Information source'' instead of a ''Local interpreter''.
+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.
+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).
+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.\\
+Python-flup is a dependency which provides trac with SCGI capability. You can install it on debian based systems with:
+{{{
+sudo apt-get install python-flup
+}}}
 == Simple Lighttpd Configuration ==
 …
 environments.  It has a very low memory footprint compared to other web servers and takes care of CPU load.
+For using `trac.fcgi` with lighttpd add the following to your lighttpd.conf:
+{{{
+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="/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" =>
                    ("trac" =>
                      ("socket" => "/tmp/trac-fastcgi.sock",
                       "bin-path" => "/path/to/cgi-bin/trac.fcgi",
+                      "bin-path" => fcgi_binary,
                       "check-local" => "disable",
                       "bin-environment" =>
 …
 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 [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.
 For using two projects with lighttpd add the following to your `lighttpd.conf`:
 {{{
 …
                    ("first" =>
                     ("socket" => "/tmp/trac-fastcgi-first.sock",
                      "bin-path" => "/path/to/cgi-bin/trac.fcgi",
+                     "bin-path" => fcgi_binary,
                      "check-local" => "disable",
                      "bin-environment" =>
 …
                     ("second" =>
                     ("socket" => "/tmp/trac-fastcgi-second.sock",
                      "bin-path" => "/path/to/cgi-bin/trac.fcgi",
+                     "bin-path" => fcgi_binary,
                      "check-local" => "disable",
                      "bin-environment" =>
 …
 Note that the above will result in different processes in any event, even
 if both are running from the same `trac.fcgi` script.
+{{{
+#!html
+<p style="background: #fdc; border: 2px solid #d00; font-style: italic; padding: 0 .5em; margin: 1em 0;">
 <strong>Note from c00i90wn:</strong> It's very important the order on which server.modules are loaded, if mod_auth is not loaded <strong>BEFORE</strong> mod_fastcgi, then the server will fail to authenticate the user.
+</p>
+}}}
+{{{
+#!div class=important
+'''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.
+}}}
 For authentication you should enable mod_auth in lighttpd.conf 'server.modules', select auth.backend and auth rules:
 {{{
 …
 server.modules += ("mod_alias")
 # Setup an alias for the static resources
+# Set up an alias for the static resources
 alias.url = ("/trac/chrome/common" => "/usr/share/trac/htdocs")
 …
                    ("trac" =>
                      ("socket" => "/tmp/trac-fastcgi.sock",
                       "bin-path" => "/path/to/cgi-bin/trac.fcgi",
+                      "bin-path" => fcgi_binary,
                       "check-local" => "disable",
                       "bin-environment" =>
 …
+                        (
                           "socket" => "/tmp/trac.sock",
                           "bin-path" => "/path/to/cgi-bin/trac.fcgi",
+                          "bin-path" => fcgi_binary,
                           "check-local" => "disable",
                           "bin-environment" =>
 …
                    ("trac" =>
                      ("socket" => "/tmp/trac-fastcgi.sock",
                       "bin-path" => "/path/to/cgi-bin/trac.fcgi",
+                      "bin-path" => fcgi_binary,
                       "check-local" => "disable",
                       "bin-environment" =>
 …
+                 )
 }}}
+For details about languages specification see TracFaq question 2.13.
+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.
+If you use trac-0.9, read [http://lists.edgewall.com/archive/trac/2005-November/005311.html about small bug]
+For details about languages specification see [trac:TracFaq TracFaq] question 2.13.
+Other important information like the [wiki:TracInstall#MappingStaticResources mapping static resources advices] are useful for non-fastcgi specific installation aspects.
+]
 Relaunch lighttpd, and browse to `http://yourhost.example.org/trac` to access Trac.
 …
 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.
 == Simple LiteSpeed Configuration ==
+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.
+== Simple !LiteSpeed Configuration ==
 The FastCGI front-end was developed primarily for use with alternative webservers, such as [http://www.litespeedtech.com/ LiteSpeed].
+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
+) Please make sure you have first have a working install of a Trac project. Test install with “tracd” first.
+) 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:
+!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.
+. Please make sure you have first have a working install of a Trac project. Test install with “tracd” first.
+. 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:
 {{{
 …
 }}}
 ) Go “TracVhost → External Apps” tab and create a new “External Application”.
+. Go “!TracVhost → External Apps” tab and create a new “External Application”.
 {{{
 …
 }}}
 ) Optional. If you need to use htpasswd based authentication. Go to “TracVhost → Security” tab and create a new security “Realm”.
+. 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.
 ) Go to “PythonVhost → Contexts” and create a new “FCGI Context”.
+. Go to “!PythonVhost → Contexts” and create a new “FCGI Context”.
 {{{
 …
 }}}
+) Modify /fullpathto/mytracproject/conf/trac.ini
+. Modify `/fullpathto/mytracproject/conf/trac.ini`
 {{{
 …
 }}}
 ) Restart LiteSpeed, “lswsctrl restart”, and access your new Trac project at:
+. Restart !LiteSpeed, “lswsctrl restart”, and access your new Trac project at:
 {{{
 …
 }}}
+== Simple Nginx Configuration ==
+Nginx is able to communicate with FastCGI processes, but can not spawn them. So you need to start FastCGI server for Trac separately.
+. Nginx configuration with basic authentication handled by Nginx - confirmed to work on 0.6.32
+{{{
+    server {
+        listen       10.9.8.7:443;
+        server_name  trac.example;
+        ssl                  on;
+        ssl_certificate      /etc/ssl/trac.example.crt;
+        ssl_certificate_key  /etc/ssl/trac.example.key;
+        ssl_session_timeout  5m;
+        ssl_protocols  SSLv2 SSLv3 TLSv1;
+        ssl_ciphers  ALL:!ADH:!EXPORT56:RC4+RSA:+HIGH:+MEDIUM:+LOW:+SSLv2:+EXP;
+        ssl_prefer_server_ciphers   on;
+        # (Or ``^/some/prefix/(.*)``.
+        if ($uri ~ ^/(.*)) {
+             set $path_info /$1;
+        }
+        # it makes sense to serve static resources through Nginx
+        location /chrome/ {
+             alias /home/trac/instance/static/htdocs/;
+        }
+        # You can copy this whole location to ``location [/some/prefix]/login``
+        # and remove the auth entries below if you want Trac to enforce
+        # authorization where appropriate instead of needing to authenticate
+        # for accessing the whole site.
+        # (Or ``location /some/prefix``.)
+        location / {
+            auth_basic            "trac realm";
+            auth_basic_user_file /home/trac/htpasswd;
+            # socket address
+            fastcgi_pass   unix:/home/trac/run/instance.sock;
+            # python - wsgi specific
+            fastcgi_param HTTPS on;
+            ## WSGI REQUIRED VARIABLES
+            # WSGI application name - trac instance prefix.
+            # (Or ``fastcgi_param  SCRIPT_NAME  /some/prefix``.)
+            fastcgi_param  SCRIPT_NAME        "";
+            fastcgi_param  PATH_INFO          $path_info;
+            ## WSGI NEEDED VARIABLES - trac warns about them
+            fastcgi_param  REQUEST_METHOD     $request_method;
+            fastcgi_param  SERVER_NAME        $server_name;
+            fastcgi_param  SERVER_PORT        $server_port;
+            fastcgi_param  SERVER_PROTOCOL    $server_protocol;
+            fastcgi_param  QUERY_STRING       $query_string;
+            # For Nginx authentication to work - do not forget to comment these
+            # lines if not using Nginx for authentication
+            fastcgi_param  AUTH_USER          $remote_user;
+            fastcgi_param  REMOTE_USER        $remote_user;
+            # for ip to work
+            fastcgi_param REMOTE_ADDR         $remote_addr;
+            # For attchments to work
+            fastcgi_param    CONTENT_TYPE     $content_type;
+            fastcgi_param    CONTENT_LENGTH   $content_length;
+        }
+    }
+}}}
+. Modified trac.fcgi:
+{{{
+#!/usr/bin/env python
+import os
+sockaddr = '/home/trac/run/instance.sock'
+os.environ['TRAC_ENV'] = '/home/trac/instance'
+try:
+     from trac.web.main import dispatch_request
+     import trac.web._fcgi
+     fcgiserv = trac.web._fcgi.WSGIServer(dispatch_request,
+          bindAddress = sockaddr, umask = 7)
+     fcgiserv.run()
+except SystemExit:
+    raise
+except Exception, e:
+    print 'Content-Type: text/plain\r\n\r\n',
+    print 'Oops...'
+    print
+    print 'Trac detected an internal error:'
+    print
+    print e
+    print
+    import traceback
+    import StringIO
+    tb = StringIO.StringIO()
+    traceback.print_exc(file=tb)
+    print tb.getvalue()
+}}}
+. reload nginx and launch trac.fcgi like that:
+{{{
+trac@trac.example ~ $ ./trac-standalone-fcgi.py
+}}}
+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`)
+  * and patch from ticket #T7239 is applied, or you'll have to fix the socket file permissions every time
+Unfortunately nginx does not support variable expansion in fastcgi_pass directive.
+Thus it is not possible to serve multiple trac instances from one server block.
+If you worry enough about security, run trac instances under separate users.
+Another way to run trac as a FCGI external application is offered in ticket #T6224
 ----
 See also TracCgi, TracModPython, TracInstall, TracGuide
+See also:  TracGuide, TracInstall, [wiki:TracModWSGI ModWSGI], [wiki:TracCgi CGI], [wiki:TracModPython ModPython], [trac:TracNginxRecipe TracNginxRecipe]