Changes between Version 2 and Version 3 of TracModPython
- Timestamp:
- 02/13/13 20:18:40 (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]. 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 8 == A Word of Warning == 9 10 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. 7 11 8 12 == Simple configuration == … … 13 17 }}} 14 18 15 ''Note: The exact path to the module depends on how the HTTPD installation is laid out.'' 19 ''Note: The exact path to the module depends on how the HTTPD installation is laid out.'' 20 16 21 On Debian using apt-get 17 22 {{{ … … 20 25 (Still on Debian) after you have installed mod_python, you must enable the modules in apache2 (equivalent of the above Load Module directive): 21 26 {{{ 22 a2enmod mod_python27 a2enmod python 23 28 }}} 24 29 On Fedora use, using yum: … … 33 38 PythonInterpreter main_interpreter 34 39 PythonHandler mod_python.testhandler 40 Order allow,deny 41 Allow from all 35 42 </Location> 36 43 }}} … … 45 52 PythonOption TracEnv /var/trac/myproject 46 53 PythonOption TracUriRoot /projects/myproject 54 Order allow,deny 55 Allow from all 47 56 </Location> 48 57 }}} … … 57 66 PythonOption TracEnvParentDir /var/trac/myprojects 58 67 # For the index of multiple projects 59 PythonOption TracEnvIndexTemplate /srv/www/htdocs/trac/project_list_te pmlate.html68 PythonOption TracEnvIndexTemplate /srv/www/htdocs/trac/project_list_template.html 60 69 # A space delimitted list, with a "," between key and value pairs. 61 70 PythonOption TracTemplateVars key1,val1 key2,val2 … … 66 75 }}} 67 76 77 === Python Egg Cache === 78 79 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: 80 {{{ 81 PythonOption PYTHON_EGG_CACHE /var/trac/myprojects/egg-cache 82 }}} 83 84 or you can uncompress the Genshi egg to resolve problems extracting from it. 68 85 === Configuring Authentication === 69 86 … … 141 158 142 159 160 === Setting the Python Egg Cache === 161 162 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. 163 164 {{{ 165 #!xml 166 <Location /projects/myproject> 167 ... 168 PythonOption PYTHON_EGG_CACHE /tmp 169 ... 170 </Location> 171 }}} 172 143 173 144 174 === Setting the !PythonPath === … … 217 247 }}} 218 248 219 if you have issues with login try using `<LocationMatch>` instead of `<Location>` 249 This does not seem to work in all cases. What you can do if it does not: 250 * Try using `<LocationMatch>` instead of `<Location>` 251 * <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). 252 * Depending on apache's `NameVirtualHost` configuration, you may need to use `<VirtualHost *:80>` instead of `<VirtualHost *>`. 220 253 221 254 For a virtual host that supports multiple projects replace "`TracEnv`" /var/trac/myproject with "`TracEnvParentDir`" /var/trac/ 222 255 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".256 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 257 225 258 == Troubleshooting == … … 256 289 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 290 291 === Problem with zipped egg === 292 293 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: 294 295 {{{ 296 easy_install --always-unzip Trac-0.12b1.zip 297 }}} 298 258 299 === Using .htaccess === 259 300 … … 261 302 262 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. :) 304 305 A success story: For me it worked out-of-box, with following trivial config: 306 {{{ 307 SetHandler mod_python 308 PythonInterpreter main_interpreter 309 PythonHandler trac.web.modpython_frontend 310 PythonOption TracEnv /system/path/to/this/directory 311 PythonOption TracUriRoot /path/on/apache 312 313 AuthType Basic 314 AuthName "ProjectName" 315 AuthUserFile /path/to/.htpasswd 316 Require valid-user 317 }}} 318 319 The `TracUriRoot` is obviously the path you need to enter to the browser to get to the trac (e.g. domain.tld/projects/trac) 320 321 === Additional .htaccess help === 322 323 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: 324 325 {{{ 326 <IfModule mod_rewrite.c> 327 RewriteEngine Off 328 </IfModule> 329 }}} 330 263 331 264 332 === Win32 Issues === … … 279 347 }}} 280 348 281 See also [ [http://subversion.tigris.org/faq.html#reposperms]]349 See also [http://subversion.tigris.org/faq.html#reposperms] 282 350 283 351 === FreeBSD issues === … … 285 353 286 354 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 line355 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 356 289 357 {{{ … … 297 365 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 366 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:367 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 368 {{{ 301 369 PythonInterpreter main_interpreter 302 370 }}} 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.371 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 372 305 373 === Page layout issues === … … 315 383 316 384 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 />}}}. 385 386 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 387 318 388 === HTTPS issues === … … 334 404 335 405 === 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]]406 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] 407 408 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 409 340 410 ---- 341 See also TracGuide, TracInstall, TracCgi, TracFastCgi411 See also: TracGuide, TracInstall, [wiki:TracModWSGI ModWSGI], [wiki:TracFastCgi FastCGI], [trac:TracNginxRecipe TracNginxRecipe]
