Changes between Version 1 and Version 2 of Trac Mod Python
- Timestamp:
- Jul 25, 2010, 3:04:54 PM (14 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
Trac Mod Python
v1 v2 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].6 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]. 7 7 8 8 == Simple configuration == … … 13 13 }}} 14 14 15 ''Note: The exact path to the module depends on how the HTTPD installation is laid out.'' 15 ''Note: The exact path to the module depends on how the HTTPD installation is laid out.'' 16 16 17 On Debian using apt-get 17 18 {{{ … … 57 58 PythonOption TracEnvParentDir /var/trac/myprojects 58 59 # For the index of multiple projects 59 PythonOption TracEnvIndexTemplate /srv/www/htdocs/trac/project_list_te pmlate.html60 PythonOption TracEnvIndexTemplate /srv/www/htdocs/trac/project_list_template.html 60 61 # A space delimitted list, with a "," between key and value pairs. 61 62 PythonOption TracTemplateVars key1,val1 key2,val2 … … 66 67 }}} 67 68 69 === Python Egg Cache === 70 71 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: 72 {{{ 73 PythonOption PYTHON_EGG_CACHE /var/trac/myprojects/egg-cache 74 }}} 75 76 or you can uncompress the Genshi egg to resolve problems extracting from it. 68 77 === Configuring Authentication === 69 78 … … 141 150 142 151 152 === Setting the Python Egg Cache === 153 154 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. 155 156 {{{ 157 #!xml 158 <Location /projects/myproject> 159 ... 160 PythonOption PYTHON_EGG_CACHE /tmp 161 ... 162 </Location> 163 }}} 164 143 165 144 166 === Setting the !PythonPath === … … 217 239 }}} 218 240 219 if you have issues with login try using `<LocationMatch>` instead of `<Location>` 241 This does not seem to work in all cases. What you can do if it does not: 242 * Try using `<LocationMatch>` instead of `<Location>` 243 * <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). 244 * Depending on apache's `NameVirtualHost` configuration, you may need to use `<VirtualHost *:80>` instead of `<VirtualHost *>`. 220 245 221 246 For a virtual host that supports multiple projects replace "`TracEnv`" /var/trac/myproject with "`TracEnvParentDir`" /var/trac/ 222 247 223 Note: !DocumentRoot should not point to your Trac project env. As Asmodai wrote on #trac: "suppose there's a webser er bug that allows disclosure of !DocumentRoot they could then leech the entire Trac environment".248 Note: !DocumentRoot should not point to your Trac project env. As Asmodai wrote on #trac: "suppose there's a webserver bug that allows disclosure of !DocumentRoot they could then leech the entire Trac environment". 224 249 225 250 == Troubleshooting == … … 256 281 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. 257 282 283 === Problem with zipped egg === 284 285 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: 286 287 {{{ 288 easy_install --always-unzip Trac-0.12b1.zip 289 }}} 290 258 291 === Using .htaccess === 259 292 … … 261 294 262 295 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. :) 296 297 A success story: For me it worked out-of-box, with following trivial config: 298 {{{ 299 SetHandler mod_python 300 PythonInterpreter main_interpreter 301 PythonHandler trac.web.modpython_frontend 302 PythonOption TracEnv /system/path/to/this/directory 303 PythonOption TracUriRoot /path/on/apache 304 305 AuthType Basic 306 AuthName "ProjectName" 307 AuthUserFile /path/to/.htpasswd 308 Require valid-user 309 }}} 310 311 The `TracUriRoot` is obviously the path you need to enter to the browser to get to the trac (e.g. domain.tld/projects/trac) 312 313 === Additional .htaccess help === 314 315 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: 316 317 {{{ 318 <IfModule mod_rewrite.c> 319 RewriteEngine Off 320 </IfModule> 321 }}} 322 263 323 264 324 === Win32 Issues === … … 279 339 }}} 280 340 281 See also [ [http://subversion.tigris.org/faq.html#reposperms]]341 See also [http://subversion.tigris.org/faq.html#reposperms] 282 342 283 343 === FreeBSD issues === … … 285 345 286 346 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. 287 The best option [ [http://modpython.org/pipermail/mod_python/2006-September/021983.html seems to be]] adding to /usr/local/apache2/bin/ennvars the line347 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 288 348 289 349 {{{ … … 297 357 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`). 298 358 299 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:359 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: 300 360 {{{ 301 361 PythonInterpreter main_interpreter 302 362 }}} 303 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.363 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. 304 364 305 365 === Page layout issues === … … 315 375 316 376 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 />}}}. 377 378 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`. 317 379 318 380 === HTTPS issues === … … 334 396 335 397 === Segmentation fault with php5-mhash or other php5 modules === 336 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]]337 338 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]]398 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] 399 400 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] 339 401 340 402 ---- 341 See also TracGuide, TracInstall, TracCgi, TracFastCgi403 See also: TracGuide, TracInstall, [wiki:TracModWSGI ModWSGI], [wiki:TracFastCgi FastCGI], [trac:TracNginxRecipe TracNginxRecipe]