Changes between Version 2 and Version 3 of TracModPython
- Timestamp:
- 02/27/2013 04:35:50 PM (12 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracModPython
v2 v3 4 4 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. 5 5 6 These instructions are for Apache 2; if you are still using Apache 1.3, you may have some luck with [wiki:TracModPython2.7 TracModPython2.7]. 7 8 == Simple configuration == 6 {{{#!div class="important" 7 ** A Word of Warning ** 8 9 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. 10 }}} 11 12 13 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. 14 15 [[PageOutline(2-3,Overview,inline)]] 16 17 == Simple configuration: single project == #Simpleconfiguration 9 18 10 19 If you just installed mod_python, you may have to add a line to load the module in the Apache configuration: … … 21 30 (Still on Debian) after you have installed mod_python, you must enable the modules in apache2 (equivalent of the above Load Module directive): 22 31 {{{ 23 a2enmod mod_python32 a2enmod python 24 33 }}} 25 34 On Fedora use, using yum: … … 34 43 PythonInterpreter main_interpreter 35 44 PythonHandler mod_python.testhandler 45 Order allow,deny 46 Allow from all 36 47 </Location> 37 48 }}} … … 46 57 PythonOption TracEnv /var/trac/myproject 47 58 PythonOption TracUriRoot /projects/myproject 59 Order allow,deny 60 Allow from all 48 61 </Location> 49 62 }}} … … 55 68 # For a single project 56 69 PythonOption TracEnv /var/trac/myproject 70 57 71 # For multiple projects 58 72 PythonOption TracEnvParentDir /var/trac/myprojects 73 59 74 # For the index of multiple projects 60 75 PythonOption TracEnvIndexTemplate /srv/www/htdocs/trac/project_list_template.html 76 61 77 # A space delimitted list, with a "," between key and value pairs. 62 78 PythonOption TracTemplateVars key1,val1 key2,val2 79 63 80 # Useful to get the date in the wanted order 64 81 PythonOption TracLocale en_GB.UTF8 82 65 83 # See description above 66 84 PythonOption TracUriRoot /projects/myproject … … 74 92 }}} 75 93 94 or you can uncompress the Genshi egg to resolve problems extracting from it. 95 76 96 === Configuring Authentication === 77 97 78 Creating password files and configuring authentication works similar to the process for [wiki:TracCgi#AddingAuthentication CGI]: 79 {{{ 80 #!xml 81 <Location /projects/myproject/login> 82 AuthType Basic 83 AuthName "myproject" 84 AuthUserFile /var/trac/myproject/.htpasswd 85 Require valid-user 86 </Location> 87 }}} 88 89 Configuration for mod_ldap authentication in Apache is a bit tricky (httpd 2.2.x and OpenLDAP: slapd 2.3.19) 90 91 1. You need to load the following modules in Apache httpd.conf 92 {{{ 93 LoadModule ldap_module modules/mod_ldap.so 94 LoadModule authnz_ldap_module modules/mod_authnz_ldap.so 95 }}} 96 97 2. Your httpd.conf also needs to look something like: 98 99 {{{ 100 #!xml 101 <Location /trac/> 102 SetHandler mod_python 103 PythonInterpreter main_interpreter 104 PythonHandler trac.web.modpython_frontend 105 PythonOption TracEnv /home/trac/ 106 PythonOption TracUriRoot /trac/ 107 Order deny,allow 108 Deny from all 109 Allow from 192.168.11.0/24 110 AuthType Basic 111 AuthName "Trac" 112 AuthBasicProvider "ldap" 113 AuthLDAPURL "ldap://127.0.0.1/dc=example,dc=co,dc=ke?uid?sub?(objectClass=inetOrgPerson)" 114 authzldapauthoritative Off 115 require valid-user 116 </Location> 117 }}} 118 119 Or the LDAP interface to a Microsoft Active Directory: 120 121 {{{ 122 #!xml 123 <Location /trac/> 124 SetHandler mod_python 125 PythonInterpreter main_interpreter 126 PythonHandler trac.web.modpython_frontend 127 PythonOption TracEnv /home/trac/ 128 PythonOption TracUriRoot /trac/ 129 Order deny,allow 130 Deny from all 131 Allow from 192.168.11.0/24 132 AuthType Basic 133 AuthName "Trac" 134 AuthBasicProvider "ldap" 135 AuthLDAPURL "ldap://adserver.company.com:3268/DC=company,DC=com?sAMAccountName?sub?(objectClass=user)" 136 AuthLDAPBindDN ldap-auth-user@company.com 137 AuthLDAPBindPassword "the_password" 138 authzldapauthoritative Off 139 # require valid-user 140 require ldap-group CN=Trac Users,CN=Users,DC=company,DC=com 141 </Location> 142 }}} 143 144 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. 145 146 Note 2: Active Directory requires an authenticating user/password to access records (AuthLDAPBindDN and AuthLDAPBindPassword). 147 148 Note 3: The directive "require ldap-group ..." specifies an AD group whose members are allowed access. 149 98 See corresponding section in the [wiki:TracModWSGI#ConfiguringAuthentication] page. 99 100 101 == Advanced Configuration 102 103 === Setting the Python Egg Cache === 104 105 If the Egg Cache isn't writeable by your Web server, you'll either have to change the permissions, or point Python to a location where Apache can write. This can manifest itself as a ''500 internal server error'' and/or a complaint in the syslog. 106 107 {{{ 108 #!xml 109 <Location /projects/myproject> 110 ... 111 PythonOption PYTHON_EGG_CACHE /tmp 112 ... 113 </Location> 114 }}} 150 115 151 116 … … 164 129 Be careful about using the !PythonPath directive, and ''not'' `SetEnv PYTHONPATH`, as the latter won't work. 165 130 166 == Setting up multiple projects==131 === Setting up multiple projects === 167 132 168 133 The Trac mod_python handler supports a configuration option similar to Subversion's `SvnParentPath`, called `TracEnvParentDir`: … … 199 164 }}} 200 165 201 == Virtual Host Configuration==166 === Virtual Host Configuration === 202 167 203 168 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 … … 228 193 * Try using `<LocationMatch>` instead of `<Location>` 229 194 * <Location /> may, in your server setup, refer to the complete host instead of simple the root of the server. This means that everything (including the login directory referenced below) will be sent to python and authentication does not work (i.e. you get the infamous Authentication information missing error). If this applies to you, try using a sub-directory for trac instead of the root (i.e. /web/ and /web/login instead of / and /login). 195 * Depending on apache's `NameVirtualHost` configuration, you may need to use `<VirtualHost *:80>` instead of `<VirtualHost *>`. 230 196 231 197 For a virtual host that supports multiple projects replace "`TracEnv`" /var/trac/myproject with "`TracEnvParentDir`" /var/trac/ … … 245 211 246 212 For multiple projects, try restarting the server as well. 213 214 ===Login Not Working=== 215 If you've used <Location /> directive, it will override any other directives, as well as <Location /Login>. 216 The workaround is to use negation expression as follows (for multi project setups): 217 {{{ 218 #!xml 219 #this one for other pages 220 <Location ~ "/*(?!login)"> 221 SetHandler mod_python 222 PythonHandler trac.web.modpython_frontend 223 PythonOption TracEnvParentDir /projects 224 PythonOption TracUriRoot / 225 226 </Location> 227 #this one for login page 228 <Location ~ "/[^/]+/login"> 229 SetHandler mod_python 230 PythonHandler trac.web.modpython_frontend 231 PythonOption TracEnvParentDir /projects 232 PythonOption TracUriRoot / 233 234 #remove these if you don't want to force SSL 235 RewriteEngine On 236 RewriteCond %{HTTPS} off 237 RewriteRule (.*) https://%{HTTP_HOST}%{REQUEST_URI} 238 239 AuthType Basic 240 AuthName "Trac" 241 AuthUserFile /projects/.htpasswd 242 Require valid-user 243 </Location> 244 }}} 247 245 248 246 === Expat-related segmentation faults === #expat … … 266 264 Using <Location /> together with `SetHandler` resulted in having everything handled by mod_python, which leads to not being able download any CSS or images/icons. I used <Location /trac> `SetHandler None` </Location> to circumvent the problem, though I do not know if this is the most elegant solution. 267 265 266 === Problem with zipped egg === 267 268 It's possible that your version of mod_python will not import modules from zipped eggs. If you encounter an `ImportError: No module named trac` in your Apache logs but you think everything is where it should be, this might be your problem. Look in your site-packages directory; if the Trac module appears as a ''file'' rather than a ''directory'', then this might be your problem. To rectify, try installing Trac using the `--always-unzip` option, like this: 269 270 {{{ 271 easy_install --always-unzip Trac-0.12b1.zip 272 }}} 273 268 274 === Using .htaccess === 269 275 … … 273 279 274 280 A success story: For me it worked out-of-box, with following trivial config: 275 {{{ 281 {{{#!xml 276 282 SetHandler mod_python 277 283 PythonInterpreter main_interpreter … … 286 292 }}} 287 293 288 The TracUriRoot is obviously the path you need to enter to the browser to get to the trac (e.g. domain.tld/projects/trac) 289 290 === Win32 Issues === 294 The `TracUriRoot` is obviously the path you need to enter to the browser to get to the trac (e.g. domain.tld/projects/trac) 295 296 === Additional .htaccess help === 297 298 If you are using the .htaccess method you may have additional problems if your trac directory is inheriting .htaccess directives from another. This may also help to add to your .htaccess file: 299 300 {{{ 301 <IfModule mod_rewrite.c> 302 RewriteEngine Off 303 </IfModule> 304 }}} 305 306 === Platform specific issues 307 ==== Win32 Issues ==== 291 308 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. 292 309 293 310 294 === OS X issues===311 ==== OS X issues ==== 295 312 296 313 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]. 297 314 298 === SELinux issues===315 ==== SELinux issues ==== 299 316 300 317 If Trac reports something like: ''Cannot get shared lock on db.lock'' … … 305 322 }}} 306 323 307 See also [ [http://subversion.tigris.org/faq.html#reposperms]]308 309 === FreeBSD issues===324 See also [http://subversion.tigris.org/faq.html#reposperms] 325 326 ==== FreeBSD issues ==== 310 327 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. 311 328 312 329 If you compiled and installed apache2, apache wouldn´t support threads (cause it doesn´t work very well on FreeBSD). You could force thread support when running ./configure for apache, using --enable-threads, but this isn´t recommendable. 313 The best option [ [http://modpython.org/pipermail/mod_python/2006-September/021983.html seems to be]] adding to /usr/local/apache2/bin/ennvars the line330 The best option [http://modpython.org/pipermail/mod_python/2006-September/021983.html seems to be] adding to /usr/local/apache2/bin/ennvars the line 314 331 315 332 {{{ … … 317 334 }}} 318 335 336 337 ==== Fedora 7 Issues ==== 338 Make sure you install the 'python-sqlite2' package as it seems to be required for TracModPython but not for tracd 339 340 319 341 === Subversion issues === 320 342 … … 323 345 If this is not the case, it's possible that you're using Subversion libraries that are binary incompatible with the apache ones (an incompatibility of the `apr` libraries is usually the cause). In that case, you also won't be able to use the svn modules for Apache (`mod_dav_svn`). 324 346 325 You also need a recent version of `mod_python` in order to avoid a runtime error ({{{argument number 2: a 'apr_pool_t *' is expected}}}) due to the default usage of multiple sub-interpreters. 3.2.8 ''should'' work, though it's probably better to use the workaround described in #3371, in order to force the use of the main interpreter:347 You also need a recent version of `mod_python` in order to avoid a runtime error ({{{argument number 2: a 'apr_pool_t *' is expected}}}) due to the default usage of multiple sub-interpreters. 3.2.8 ''should'' work, though it's probably better to use the workaround described in [trac:#3371 #3371], in order to force the use of the main interpreter: 326 348 {{{ 327 349 PythonInterpreter main_interpreter 328 350 }}} 329 This is anyway the recommended workaround for other well-known issues seen when using the Python bindings for Subversion within mod_python ( #2611, #3455). See in particular Graham Dumpleton's comment in [comment:ticket:3455:9#3455] explaining the issue.351 This is anyway the recommended workaround for other well-known issues seen when using the Python bindings for Subversion within mod_python ([trac:#2611 #2611], [trac:#3455 #3455]). See in particular Graham Dumpleton's comment in [trac:comment:9:ticket:3455 #3455] explaining the issue. 330 352 331 353 === Page layout issues === … … 341 363 342 364 Note: For the above configuration to have any effect it must be put after the configuration of your project root location, i.e. {{{<Location /myproject />}}}. 365 366 Also, setting `PythonOptimize On` seems to mess up the page headers and footers, in addition to hiding the documentation for macros and plugins (see #Trac8956). Considering how little effect the option has, it is probably a good idea to leave it `Off`. 343 367 344 368 === HTTPS issues === … … 355 379 }}} 356 380 357 === Fedora 7 Issues ===358 Make sure you install the 'python-sqlite2' package as it seems to be required for TracModPython but not for tracd359 360 381 361 382 === Segmentation fault with php5-mhash or other php5 modules === 362 You may encounter segfaults (reported on debian etch) if php5-mhash module is installed. Try to remove it to see if this solves the problem. See debian bug report [ [http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=411487]]363 364 Some people also have troubles when using php5 compiled with its own 3rd party libraries instead of system libraries. Check here [ [http://www.djangoproject.com/documentation/modpython/#if-you-get-a-segmentation-fault]]383 You may encounter segfaults (reported on debian etch) if php5-mhash module is installed. Try to remove it to see if this solves the problem. See debian bug report [http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=411487] 384 385 Some people also have troubles when using php5 compiled with its own 3rd party libraries instead of system libraries. Check here [http://www.djangoproject.com/documentation/modpython/#if-you-get-a-segmentation-fault] 365 386 366 387 ---- 367 See also TracGuide, TracInstall, TracCgi, TracFastCgi388 See also: TracGuide, TracInstall, [wiki:TracModWSGI ModWSGI], [wiki:TracFastCgi FastCGI], [trac:TracNginxRecipe TracNginxRecipe]
