Version 11 (modified by 19 years ago) ( diff ) | ,
---|
This page documents the 1.4 (latest stable) release. Documentation for other releases can be found here.
Trac and mod_python
Trac 0.7.1 and later supports mod_python, which speeds up Trac's response times considerably and permits use of many Apache features not possible with tracd/mod_proxy.
Warning!
Although it may seem trivial to rewrite the below configuration as a directory in your document root with a .htaccess file, this does not work. Apache will append a "/" to any Trac URLs, which interferes with its correct operation.
It may be possible to work around this with mod_rewrite, but I failed to get this working. In all, it is more hassle than it is worth. Stick to the provided instructions. :)
Simple configuration
Here's a typical Trac CGI/Apache setup:
ScriptAlias /projects/myproject /path/to/python/share/trac/cgi-bin/trac.cgi <Location /projects/myproject> SetEnv TRAC_ENV /var/trac/myproject </Location>
The equivalent mod_python setup is:
<Location /projects/myproject> SetHandler mod_python PythonHandler trac.ModPythonHandler PythonOption TracUriRoot "/projects/myproject" PythonOption TracEnv /var/trac/myproject </Location>
Also do not forget to fix your authentication setup from the original <Location "/cgi-bin/trac.cgi/login"> to:
<Location "/projects/myproject/login"> AuthType Basic AuthName "myproject" AuthUserFile /var/trac/myproject/.htaccess Require valid-user </Location>
Note that the option TracUriRoot may or may not be necessary in your setup. Try without first, and if the URLs produced by Trac look wrong, add the TracUriRoot option.
Setting up a project on the root of the webserver
To install Trac on the root of the webserver (in a virtual host context for example) and make it available at the http://some-hostname/ URL, use the following:
<LocationMatch "^/(?!trac/)"> SetHandler mod_python PythonHandler trac.ModPythonHandler PythonOption TracUriRoot "/" PythonOption TracEnv /var/trac/myproject </LocationMatch>
The regular expression used in the LocationMatch directive permits clients to escape mod_python and access Trac "real" files (located at /var/www/some-hostname/htdocs/trac/
on the filesystem). Any other URLs will be handled by mod_python.
Setting up multiple projects
The Trac mod_python handler handler supports a configuration option similar to Subversion's SvnParentPath
, called TracEnvParentDir
:
<Location /projects> SetHandler mod_python PythonHandler trac.ModPythonHandler PythonOption TracUriRoot /projects PythonOption TracEnvParentDir "/var/trac" </Location>
When you request the /projects
URL, you will get a (currently very simple) listing of all subdirectories of the directory you set as TracEnvParentDir
. Selecting any project in the list will bring you to the corresponding Trac instance. You should make sure that the configured directory only contains Trac environment directories that match the currently installed Trac version, because that is not checked prior the the generation of the project list.
Adding authentication
Adding authentication is straightforward in both cases. For example:
<LocationMatch /projects/[[:alnum:]]+/login> AuthType Basic AuthName "Trac" AuthUserFile /var/www/passwd Require valid-user </LocationMatch>
Win32 Issues
If you run trac with mod_python on Windows, attachments will not work.
There is a (simple) workaround for this which is to apply the patch attached to ticket #554.
OS X issues
There is a mod_python issue on OSX: Look at the end of its README. You need to either define the environment variable DYLD_FORCE_FLAT_NAMESPACE before starting httpd or apply this patch to mod_python.
See also TracGuide, TracInstall, TracMultipleProjects