Dispatching TurboGears Python via FCGI
This confirmed to run on Mac OS X 10.4.7 under Turbogears 0.9.9 and 1.1a (so, no reason not to run under the 1.0b release).
Information was drawn from the Turbogears trac wiki (http://trac.turbogears.org/turbogears/wiki/NginxIntegration) which show how to use Nginx to proxy to TG, and the nearby [NginxFcgiExample] page, the latter detailing the PHP/FCGI process.
This is for Nginx/FCGI/Turbogears
Conventions
Substitute thoughout with the values relevant to your own set-up:
${HOST} = localhost - (or whatever you choose)
${PORT} = 8080 - (or whatever you choose)
${NGINX} = /usr/local/nginx - location of nginx installation
${PROJECTBASE} /opt/projects/wiki20 - location of Turbogears project
${PROJECTNAME} wiki20
Getting the required files
Two files are required to be created: ${NGINX}/scripts/fcgi.py and ${NGINX}/scripts/${PROJECTNAME}.fcgi.
To create ${NGINX}/scripts/fcgi.py …
mkdir ${NGINX}/scripts
curl -o ${NGINX}/scripts/fcgi.py http://www.saddi.com/software/py-lib/py-lib/fcgi.py
To create ${NGINX}/scripts/${PROJECTNAME}.fcgi …
Copy and paste the following to ${NGINX}/scripts/${PROJECTNAME}.fcgi. Edit the file, navigate to the “USER EDIT SECTION” and replace each instance of ${PROJECTBASE} and ${PROJECTNAME} with the corresponding values for your project.
#!/usr/bin/python
#
# File name: project.fcgi
#
# This module provides the glue for running TurboGears applications behind
# FastCGI-enabled web servers. The code in this module depends on the fastcgi
# module downloadable from here:
#
# http://www.saddi.com/software/py-lib/py-lib/fcgi.py
#
# NOTE: The fcgi.py file needs to be placed in a location that is on the
# system path, such as the same the directory as the tg_fastcgi.py file
# or in the base directory of the TG app code.
#
# To configure this module, please edit the three variables in the "USER EDIT
# SECTION" before starting the TG application. Also remember to edit the
# top of this file with the correct Python installation information.
import cherrypy
import sys
import os
from os.path import *
import pkg_resources
import turbogears
pkg_resources.require("TurboGears")
# -- START USER EDIT SECTION
# -- Users must edit this section --
code_dir = '${PROJECTBASE}' # (Required) The base directory of the TG app code.
root_class_name = '${PROJECTNAME}.controllers.Root' # (Required) The fully qualified Root class name.
project_module_name = '${PROJECTNAME}.config' # (Required) The config module name.
log_dir = '' # (Optional) The log directory. Default = code_dir.
# -- END USER EDIT SECTION
class VirtualPathFilter(object):
def on_start_resource(self):
if not cherrypy.config.get('virtual_path_filter.on', False):
return
prefix = cherrypy.config.get('virtual_path_filter.prefix', '')
if not prefix:
return
path = cherrypy.request.object_path
if path == prefix:
path = '/'
elif path.startswith(prefix):
path = path[len(prefix):]
else:
raise cherrypy.NotFound(path)
cherrypy.request.object_path = path
def tg_init():
""" Checks for the required data and initializes the application. """
global code_dir
global root_class_name
global log_dir
global project_module_name
last_mark = 0
# Input checks
if not code_dir or not isdir(code_dir):
raise ValueError("""The code directory setting is missing.
The fastcgi code will be unable to find
the TG code without this setting.""")
if not root_class_name:
raise ValueError("""The fully qualified root class name must
be provided.""")
last_mark = root_class_name.rfind('.')
if (last_mark < 1) or (last_mark + 1) == len(root_class_name):
raise ValueError("""The user-defined class name is invalid.
Please make sure to include a fully
qualified class name for the root_class
value (e.g. wiki20.controllers.Root).""")
sys.path.append(code_dir)
# Change the directory so the TG log file will not be written to the
# web app root.
if log_dir and isdir(log_dir):
os.chdir(log_dir)
else:
os.chdir(code_dir)
log_dir = code_dir
sys.stdout = open(join(log_dir, 'stdout.log'),'a')
sys.stderr = open(join(log_dir, 'stderr.log'),'a')
if exists(join(code_dir, "setup.py")):
turbogears.update_config(configfile=join(code_dir, "dev.cfg"),modulename=project_module_name)
else:
turbogears.update_config(configfile=join(code_dir, "prod.cfg"),modulename=project_module_name)
# Set environment to production to disable auto-reload and
# add virutal path information.
cherrypy.config.update({
'global': {'server.environment': 'production'},
'/' : { 'virtual_path_filter.on' : True,
'virtual_path_filter.prefix' : '/bel.fcgi' }
})
# Parse out the root class information for Cherrypy Root class.
package_name = root_class_name[:last_mark]
class_name = root_class_name[last_mark+1:]
exec('from %s import %s as Root' % (package_name, class_name))
Root._cp_filters = [VirtualPathFilter()]
cherrypy.root = Root()
# Main section -
# Initialize the application, then start the server.
tg_init()
from fcgi import WSGIServer
cherrypy.server.start(initOnly=True, serverClass=None)
from cherrypy._cpwsgi import wsgiApp
WSGIServer(application=wsgiApp).run()
Adjust the TurboGears configuration
Edit the ${PROJECTBASE}/dev.cfg or ${PROJECTBASE}/prod.cfg file (whichever you are using), uncomment the server.socket_port assignment and change ${PORT} to a value of your choice (make sure nothing else is running on that port, Tomcat defaults to 8080, as does Jetty. Save yourself some time and check first with a telnet localhost 8080, you should see Connection refused).
The relevant lines in prod/dev.cfg are:
server.socket_port=${PORT}
Spawning a FastCGI TurboGears process
The lighttpd “spawn-fcgi” script is useful: download, compile and install lighttpd. Then (replacing ${HOST} and ${PORT} values appropriately), execute the following:
/usr/local/bin/spawn-fcgi -a ${HOST} -p ${PORT} -u nobody -f ${NGINX}/scripts/${PROJECTNAME}.fcgi
Nginx configuration
Save the following into ${NGINX}/conf/fastcgi_params
<span class="co1">#fastcgi.conf</span>
<a href="http://wiki.nginx.org/NginxHttpFcgiModule#fastcgi_param"><span class="kw11">fastcgi_param</span></a> GATEWAY_INTERFACE CGI/<span class="nu0">1.1</span>;
<a href="http://wiki.nginx.org/NginxHttpFcgiModule#fastcgi_param"><span class="kw11">fastcgi_param</span></a> SERVER_SOFTWARE nginx;
<a href="http://wiki.nginx.org/NginxHttpFcgiModule#fastcgi_param"><span class="kw11">fastcgi_param</span></a> QUERY_STRING <span class="re0">$query_string</span>;
<a href="http://wiki.nginx.org/NginxHttpFcgiModule#fastcgi_param"><span class="kw11">fastcgi_param</span></a> REQUEST_METHOD <span class="re0">$request_method</span>;
<a href="http://wiki.nginx.org/NginxHttpFcgiModule#fastcgi_param"><span class="kw11">fastcgi_param</span></a> CONTENT_TYPE <span class="re0">$content_type</span>;
<a href="http://wiki.nginx.org/NginxHttpFcgiModule#fastcgi_param"><span class="kw11">fastcgi_param</span></a> CONTENT_LENGTH <span class="re0">$content_length</span>;
<a href="http://wiki.nginx.org/NginxHttpFcgiModule#fastcgi_param"><span class="kw11">fastcgi_param</span></a> SCRIPT_NAME <span class="re0">$fastcgi_script_name</span>;
<a href="http://wiki.nginx.org/NginxHttpFcgiModule#fastcgi_param"><span class="kw11">fastcgi_param</span></a> REQUEST_URI <span class="re0">$request_uri</span>;
<a href="http://wiki.nginx.org/NginxHttpFcgiModule#fastcgi_param"><span class="kw11">fastcgi_param</span></a> DOCUMENT_URI <span class="re0">$document_uri</span>;
<a href="http://wiki.nginx.org/NginxHttpFcgiModule#fastcgi_param"><span class="kw11">fastcgi_param</span></a> DOCUMENT_ROOT <span class="re0">$document_root</span>;
<a href="http://wiki.nginx.org/NginxHttpFcgiModule#fastcgi_param"><span class="kw11">fastcgi_param</span></a> SERVER_PROTOCOL <span class="re0">$server_protocol</span>;
<a href="http://wiki.nginx.org/NginxHttpFcgiModule#fastcgi_param"><span class="kw11">fastcgi_param</span></a> REMOTE_ADDR <span class="re0">$remote_addr</span>;
<a href="http://wiki.nginx.org/NginxHttpFcgiModule#fastcgi_param"><span class="kw11">fastcgi_param</span></a> REMOTE_PORT <span class="re0">$remote_port</span>;
<a href="http://wiki.nginx.org/NginxHttpFcgiModule#fastcgi_param"><span class="kw11">fastcgi_param</span></a> SERVER_ADDR <span class="re0">$server_addr</span>;
<a href="http://wiki.nginx.org/NginxHttpFcgiModule#fastcgi_param"><span class="kw11">fastcgi_param</span></a> SERVER_PORT <span class="re0">$server_port</span>;
<a href="http://wiki.nginx.org/NginxHttpFcgiModule#fastcgi_param"><span class="kw11">fastcgi_param</span></a> SERVER_NAME <span class="re0">$server_name</span>;
Add the following to the server section of the ${NGINX}/conf/nginx.conf configuration file, changing ${HOST} and ${PORT} as appropriate:
<span class="co1"># static files</span>
<a href="http://wiki.nginx.org/NginxHttpCoreModule#location"><span class="kw3">location</span></a> ~ ^/<span class="br0">(</span>images|javascript|js|css|flash|media|static<span class="br0">)</span>/ <span class="br0">{</span>
<a href="http://wiki.nginx.org/NginxHttpCoreModule#root"><span class="kw3">root</span></a> $<span class="br0">{</span>PROJECTBASE<span class="br0">}</span>/$<span class="br0">{</span>PROJECTNAME<span class="br0">}</span>/static;
<span class="br0">}</span>
<a href="http://wiki.nginx.org/NginxHttpCoreModule#location"><span class="kw3">location</span></a> = /favicon.ico <span class="br0">{</span>
<a href="http://wiki.nginx.org/NginxHttpCoreModule#root"><span class="kw3">root</span></a> $<span class="br0">{</span>PROJECTBASE<span class="br0">}</span>/$<span class="br0">{</span>PROJECTNAME<span class="br0">}</span>/static/images;
<span class="br0">}</span>
<span class="co1"># pass all requests to FastCGI TG server listening on ${HOST}:${PORT}</span>
<span class="co1">#</span>
<a href="http://wiki.nginx.org/NginxHttpCoreModule#location"><span class="kw3">location</span></a> / <span class="br0">{</span>
<a href="http://wiki.nginx.org/NginxHttpFcgiModule#fastcgi_pass"><span class="kw11">fastcgi_pass</span></a> $<span class="br0">{</span>HOST<span class="br0">}</span>:$<span class="br0">{</span>PORT<span class="br0">}</span>;
<a href="http://wiki.nginx.org/NginxHttpFcgiModule#fastcgi_index"><span class="kw11">fastcgi_index</span></a> <a href="http://wiki.nginx.org/NginxHttpCoreModule#index"><span class="kw3">index</span></a>;
<a href="http://wiki.nginx.org/NginxHttpFcgiModule#fastcgi_param"><span class="kw11">fastcgi_param</span></a> SCRIPT_FILENAME /scripts<span class="re0">$fastcgi_script_name</span>;
<a href="http://wiki.nginx.org/NginxHttpMainModule#include"><span class="kw1">include</span></a> conf/fastcgi_params;
<span class="br0">}</span>
Starting nginx
Start nginx with ${NGINX}/sbin/nginx. Point your browser to [http://${HOST}:${PORT}/](http://%24%7Bhost%7D:${PORT}/), your Turboears project should be serving via FastCGI. If so … congratulations.
Performance test software
Basic but usefully free http://www.hpl.hp.com/research/linux/httperf/
Note
[I left the IP address as 0.0.0.0 because it worked for me, whereas 127.0.0.1 did not. If you’re experiencing difficulties connecting to 0.0.0.0:8080, these are both alternative options; localhost:8080, 127.0.0.1:8080.]
Good luck.