Changes between Version 1 and Version 2 of TracModPython

Timestamp:

Apr 13, 2011, 9:04:35 PM (15 years ago)

Author:

trac

Comment:

--

TracModPython

@@ -1 +1 @@
 = Trac and mod_python =
-
-Trac supports [http://www.modpython.org/ mod_python], which speeds up Trac's response times considerably and permits use of many Apache features not possible with [wiki:TracStandalone tracd]/mod_proxy.
+[[TracGuideToc]]
+
+Trac supports [http://www.modpython.org/ mod_python], which speeds up Trac's response times considerably, especially compared to [TracCgi CGI], and permits use of many Apache features not possible with [wiki:TracStandalone tracd]/mod_proxy.
+
+These instructions are for Apache 2; if you are still using Apache 1.3, you may have some luck with [trac:wiki:TracModPython2.7 TracModPython2.7].
+
+== A Word of Warning ==
+
+As of 16^th^ June 2010, the mod_python project is officially dead.  If you are considering using mod_python for a new installation, '''please don't'''!  There are known issues which will not be fixed and there are now better alternatives.  Check out the main TracInstall pages for your target version for more information.
 
 == Simple configuration ==
@@ -10 +17 @@
 }}}
 
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
 A simple setup of Trac on mod_python looks like this:
 {{{
+
 <Location /projects/myproject>
    SetHandler mod_python
+
    PythonHandler trac.web.modpython_frontend 
    PythonOption TracEnv /var/trac/myproject
    PythonOption TracUriRoot /projects/myproject
-</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 or if Trac does not seem to recognize the URLs correctly, add the `TracUriRoot` option.
-
-Configuring authentication works the same as for [wiki:TracCgi#AddingAuthentication CGI]:
-{{{
-<Location "/projects/myproject/login">
+   Order allow,deny
+   Allow from all
+</Location>
+}}}
+
+The option '''`TracUriRoot`''' may or may not be necessary in your setup. Try your configuration without it; if the URLs produced by Trac look wrong, if Trac does not seem to recognize URLs correctly, or you get an odd "No handler matched request to..." error, add the '''`TracUriRoot`''' option.  You will notice that the `Location` and '''`TracUriRoot`''' have the same path.
+
+The options available are
+{{{
+    # For a single project
+    PythonOption TracEnv /var/trac/myproject
+    # For multiple projects
+    PythonOption TracEnvParentDir /var/trac/myprojects
+    # For the index of multiple projects
+    PythonOption TracEnvIndexTemplate /srv/www/htdocs/trac/project_list_template.html
+    # A space delimitted list, with a "," between key and value pairs.
+    PythonOption TracTemplateVars key1,val1 key2,val2
+    # Useful to get the date in the wanted order
+    PythonOption TracLocale en_GB.UTF8
+    # See description above        
+    PythonOption TracUriRoot /projects/myproject
+}}}
+
+=== Python Egg Cache ===
+
+Compressed python eggs like Genshi are normally extracted into a directory named `.python-eggs` in the users home directory. Since apache's home usually is not writable an alternate egg cache directory can be specified like this:
+{{{
+PythonOption PYTHON_EGG_CACHE /var/trac/myprojects/egg-cache
+}}}
+
+or you can uncompress the Genshi egg to resolve problems extracting from it.
+=== Configuring Authentication ===
+
+Creating password files and configuring authentication works similar to the process for [wiki:TracCgi#AddingAuthentication CGI]:
+{{{
+#!xml
+<Location /projects/myproject/login>
   AuthType Basic
   AuthName "myproject"
-  AuthUserFile /var/trac/myproject/.htaccess
+  AuthUserFile /var/trac/myproject/.ht
   Require valid-user
 </Location>
 }}}
 
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
 If the Trac installation isn't installed in your Python path, you'll have to tell Apache where to find the Trac mod_python handler  using the `PythonPath` directive:
 {{{
+
 <Location /projects/myproject>
   ...
@@ -41 +184 @@
 }}}
 
+
 
 == Setting up multiple projects ==
 
-The Trac mod_python handler handler supports a configuration option similar to Subversion's `SvnParentPath`, called `TracEnvParentDir`:
-{{{
+The Trac mod_python handler supports a configuration option similar to Subversion's `SvnParentPath`, called `TracEnvParentDir`:
+{{{
+#!xml
 <Location /projects>
   SetHandler mod_python
+
   PythonHandler trac.web.modpython_frontend 
   PythonOption TracEnvParentDir /var/trac
@@ -54 +200 @@
 }}}
 
-When you request the `/projects` URL, you will get a listing of all subdirectories of the directory you set as `TracEnvParentDir`. Selecting any project in the list will bring you to the corresponding Trac environment.
+When you request the `/projects` URL, you will get a listing of all subdirectories of the directory you set as `TracEnvParentDir`. Selecting any project in the list will bring you to the corresponding Trac environment.
 
 If you don't want to have the subdirectory listing as your projects home page you can use a
 {{{
+
 <LocationMatch "/.+/">
 }}}
@@ -65 +212 @@
 You can also use the same authentication realm for all of the projects using a `<LocationMatch>` directive:
 {{{
-<LocationMatch "/[^/]+/login">
+#!xml
+<LocationMatch "/projects/[^/]+/login">
   AuthType Basic
   AuthName "Trac"
-  AuthUserFile /var/trac/.htaccess
+  AuthUserFile /var/trac/.ht
   Require valid-user
 </LocationMatch>
@@ -79 +227 @@
 
 {{{
+
 <VirtualHost * >
-    DocumentRoot /var/trac/myproject
+    DocumentRoot /var//myproject
     ServerName trac.mycompany.com
-    <Directory />
+    < />
         SetHandler mod_python
+
         PythonHandler trac.web.modpython_frontend
         PythonOption TracEnv /var/trac/myproject
         PythonOption TracUriRoot /
-    </Directory>
+    </>
     <Location /login>
         AuthType Basic
         AuthName "MyCompany Trac Server"
-        AuthUserFile /var/trac/myproject/.htusers
+        AuthUserFile /var/trac/myproject/.ht
         Require valid-user
     </Location>
@@ -97 +247 @@
 }}}
 
+
+
+
+
+
+
+
+
+
 == Troubleshooting ==
 
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
 === Form submission problems ===
 
 If you're experiencing problems submitting some of the forms in Trac (a common problem is that you get redirected to the start page after submission), check whether your {{{DocumentRoot}}} contains a folder or file with the same path that you mapped the mod_python handler to. For some reason, mod_python gets confused when it is mapped to a location that also matches a static resource.
 
+
+
+
+
+
+
+
+
+
+
+
+
+
+
 === Using .htaccess ===
 
@@ -109 +303 @@
 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. :)
 
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
 === Win32 Issues ===
-
-If you run trac with mod_python (3.1.3 or 3.1.4) on Windows, 
-uploading attachments will '''not''' work.
-This is a known problem which we can't solve cleanly at the Trac level.
-
-However, there is a workaround for this at the mod_python level, 
-which is to apply the following patch [http://projects.edgewall.com/trac/attachment/ticket/554/util_py.patch attachment:ticket:554:util_py.patch] 
-to the (Lib/site-packages)/modpython/util.py file.
-
-If you don't have the `patch` command, that file can be replaced with the [http://svn.apache.org/viewcvs.cgi/httpd/mod_python/trunk/lib/python/mod_python/util.py?rev=103562&view=markup  fixed util.py] (fix which, although done prior to the 3.1.4 release, is ''not'' 
-present in 3.1.4).
+If you run trac with mod_python < 3.2 on Windows, uploading attachments will '''not''' work. This problem is resolved in mod_python 3.1.4 or later, so please upgrade mod_python to fix this.
+
 
 === OS X issues ===
@@ -126 +338 @@
 When using mod_python on OS X you will not be able to restart Apache using `apachectl restart`. This is apparently fixed in mod_python 3.2, but there's also a patch available for earlier versions [http://www.dscpl.com.au/projects/vampire/patches.html here].
 
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
 ----
-See also TracGuide, TracInstall, TracCgi, TracFastCgi
+See also