Context Navigation

Changes between Version 3 and Version 4 of TracModPython

Timestamp:: 02/13/13 21:04:27 (12 years ago)
Author:: trac
Comment:: --

Legend:

: Unmodified
: Added
: Removed
: Modified

TracModPython

-                      v3
+                      v4
 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 ==
+{{{#!div class="important"
+** 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 ==
+}}}
+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], but you'll be totally on your own.
+[[PageOutline(2-3,Overview,inline)]]
+== Simple configuration: single project == #Simpleconfiguration
 If you just installed mod_python, you may have to add a line to load the module in the Apache configuration:
 …
     # 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
 …
 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/.htpasswd
+  Require valid-user
+</Location>
+}}}
+Configuration for mod_ldap authentication in Apache is a bit tricky (httpd 2.2.x and OpenLDAP: slapd 2.3.19)
+. You need to load the following modules in Apache httpd.conf
+{{{
+LoadModule ldap_module modules/mod_ldap.so
+LoadModule authnz_ldap_module modules/mod_authnz_ldap.so
+}}}
+. Your httpd.conf also needs to look something like:
+{{{
+#!xml
+<Location /trac/>
+  SetHandler mod_python
+  PythonInterpreter main_interpreter
+  PythonHandler trac.web.modpython_frontend
+  PythonOption TracEnv /home/trac/
+  PythonOption TracUriRoot /trac/
+  Order deny,allow
+  Deny from all
+  Allow from 192.168.11.0/24
+  AuthType Basic
+  AuthName "Trac"
+  AuthBasicProvider "ldap"
+  AuthLDAPURL "ldap://127.0.0.1/dc=example,dc=co,dc=ke?uid?sub?(objectClass=inetOrgPerson)"
+  authzldapauthoritative Off
+  require valid-user
+</Location>
+}}}
+Or the LDAP interface to a Microsoft Active Directory:
+{{{
+#!xml
+<Location /trac/>
+  SetHandler mod_python
+  PythonInterpreter main_interpreter
+  PythonHandler trac.web.modpython_frontend
+  PythonOption TracEnv /home/trac/
+  PythonOption TracUriRoot /trac/
+  Order deny,allow
+  Deny from all
+  Allow from 192.168.11.0/24
+  AuthType Basic
+  AuthName "Trac"
+  AuthBasicProvider "ldap"
+  AuthLDAPURL "ldap://adserver.company.com:3268/DC=company,DC=com?sAMAccountName?sub?(objectClass=user)"
+  AuthLDAPBindDN       ldap-auth-user@company.com
+  AuthLDAPBindPassword "the_password"
+  authzldapauthoritative Off
+  # require valid-user
+  require ldap-group CN=Trac Users,CN=Users,DC=company,DC=com
+</Location>
+}}}
+Note 1: This is the case where the LDAP search will get around the multiple OUs, conecting to Global Catalog Server portion of AD (Notice the port is 3268, not the normal LDAP 389). The GCS is basically a "flattened" tree which allows searching for a user without knowing to which OU they belong.
+Note 2: Active Directory requires an authenticating user/password to access records (AuthLDAPBindDN and AuthLDAPBindPassword).
+Note 3: The directive "require ldap-group ..."  specifies an AD group whose members are allowed access.
+See corresponding section in the [wiki:TracModWSGI#ConfiguringAuthentication] page.
+== Advanced Configuration
 === Setting the Python Egg Cache ===
 …
 Be careful about using the !PythonPath directive, and ''not'' `SetEnv PYTHONPATH`, as the latter won't work.
 == Setting up multiple projects ==
+=== Setting up multiple projects ===
 The Trac mod_python handler supports a configuration option similar to Subversion's `SvnParentPath`, called `TracEnvParentDir`:
 …
 }}}
 == Virtual Host Configuration ==
+=== Virtual Host Configuration ===
 Below is the sample configuration required to set up your trac as a virtual server (i.e. when you access it at the URLs like
 …
 For multiple projects, try restarting the server as well.
+=== Login Not Working ===
+If you've used `<Location />` directive, it will override any other directives, as well as `<Location /login>`.
+The workaround is to use negation expression as follows (for multi project setups):
+{{{
+#!xml
+#this one for other pages
+<Location ~ "/*(?!login)">
+   SetHandler mod_python
+   PythonHandler trac.web.modpython_frontend
+   PythonOption TracEnvParentDir /projects
+   PythonOption TracUriRoot /
+</Location>
+#this one for login page
+<Location ~ "/[^/]+/login">
+   SetHandler mod_python
+   PythonHandler trac.web.modpython_frontend
+   PythonOption TracEnvParentDir /projects
+   PythonOption TracUriRoot /
+   #remove these if you don't want to force SSL
+   RewriteEngine On
+   RewriteCond %{HTTPS} off
+   RewriteRule (.*) https://%{HTTP_HOST}%{REQUEST_URI}
+   AuthType Basic
+   AuthName "Trac"
+   AuthUserFile /projects/.htpasswd
+   Require valid-user
+</Location>
+}}}
 === Expat-related segmentation faults === #expat
 …
 A success story: For me it worked out-of-box, with following trivial config:
 {{{
+{{{#!xml
 SetHandler mod_python
 PythonInterpreter main_interpreter
 …
 }}}
 === Win32 Issues ===
+=== Platform specific issues
+==== Win32 Issues ====
 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 ===
+==== OS X issues ====
 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].
 === SELinux issues ===
+==== SELinux issues ====
 If Trac reports something like: ''Cannot get shared lock on db.lock''
 …
 See also [http://subversion.tigris.org/faq.html#reposperms]
 === FreeBSD issues ===
+==== FreeBSD issues ====
 Pay attention to the version of the installed mod_python and sqlite packages. Ports have both the new and old ones, but earlier versions of pysqlite and mod_python won't integrate as the former requires threaded support in python, and the latter requires a threadless install.
 …
 export LD_PRELOAD=/usr/lib/libc_r.so
 }}}
+==== Fedora 7 Issues ====
+Make sure you install the 'python-sqlite2' package as it seems to be required for TracModPython but not for tracd
 === Subversion issues ===
 …
 }}}
-=== Fedora 7 Issues ===
-Make sure you install the 'python-sqlite2' package as it seems to be required for TracModPython but not for tracd
 === Segmentation fault with php5-mhash or other php5 modules ===