Changes between Version 1 and Version 2 of TracModPython


Ignore:
Timestamp:
06/11/10 09:31:01 (4 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracModPython

    v1 v2  
    44Trac 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. 
    55 
    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]. 
     6These 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]. 
    77 
    88== Simple configuration == 
     
    1313}}} 
    1414 
    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 
    1617On Debian using apt-get 
    1718{{{ 
     
    5758    PythonOption TracEnvParentDir /var/trac/myprojects 
    5859    # For the index of multiple projects 
    59     PythonOption TracEnvIndexTemplate /srv/www/htdocs/trac/project_list_tepmlate.html 
     60    PythonOption TracEnvIndexTemplate /srv/www/htdocs/trac/project_list_template.html 
    6061    # A space delimitted list, with a "," between key and value pairs. 
    6162    PythonOption TracTemplateVars key1,val1 key2,val2 
     
    6465    # See description above         
    6566    PythonOption TracUriRoot /projects/myproject 
    66     # Override default python egg cache location 
    67     PythonOption PYTHON_EGG_CACHE /var/trac/myprojects/egg-cache 
    68 }}} 
    69  
     67}}} 
     68 
     69=== Python Egg Cache === 
     70 
     71Compressed 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{{{ 
     73PythonOption PYTHON_EGG_CACHE /var/trac/myprojects/egg-cache 
     74}}} 
     75 
     76or you can uncompress the Genshi egg to resolve problems extracting from it. 
    7077=== Configuring Authentication === 
    7178 
     
    143150 
    144151 
     152=== Setting the Python Egg Cache === 
     153 
     154If 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 
    145165 
    146166=== Setting the !PythonPath === 
     
    219239}}} 
    220240 
    221 if you have issues with login try using `<LocationMatch>` instead of `<Location>` 
     241This 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 *>`. 
    222245 
    223246For a virtual host that supports multiple projects replace "`TracEnv`" /var/trac/myproject with "`TracEnvParentDir`" /var/trac/ 
    224247 
    225 Note: !DocumentRoot should not point to your Trac project env. As Asmodai wrote on #trac: "suppose there's a webserer bug that allows disclosure of !DocumentRoot they could then leech the entire Trac environment". 
     248Note: !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". 
    226249 
    227250== Troubleshooting == 
     
    264287It 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. :) 
    265288 
     289A success story: For me it worked out-of-box, with following trivial config: 
     290{{{ 
     291SetHandler mod_python 
     292PythonInterpreter main_interpreter 
     293PythonHandler trac.web.modpython_frontend  
     294PythonOption TracEnv /system/path/to/this/directory 
     295PythonOption TracUriRoot /path/on/apache 
     296 
     297AuthType Basic 
     298AuthName "ProjectName" 
     299AuthUserFile /path/to/.htpasswd 
     300Require valid-user 
     301}}} 
     302 
     303The `TracUriRoot` is obviously the path you need to enter to the browser to get to the trac (e.g. domain.tld/projects/trac) 
     304 
     305=== Additional .htaccess help === 
     306 
     307If 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: 
     308 
     309{{{ 
     310<IfModule mod_rewrite.c> 
     311  RewriteEngine Off 
     312</IfModule> 
     313}}} 
     314 
     315 
    266316=== Win32 Issues === 
    267317If 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. 
     
    281331}}} 
    282332 
    283 See also [[http://subversion.tigris.org/faq.html#reposperms]] 
     333See also [http://subversion.tigris.org/faq.html#reposperms] 
    284334 
    285335=== FreeBSD issues === 
     
    287337 
    288338If 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. 
    289 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  
     339The best option [http://modpython.org/pipermail/mod_python/2006-September/021983.html seems to be] adding to /usr/local/apache2/bin/ennvars the line  
    290340 
    291341{{{ 
     
    299349If 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`). 
    300350 
    301 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: 
     351You 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: 
    302352{{{ 
    303353PythonInterpreter main_interpreter 
    304354}}} 
    305 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. 
     355This 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. 
    306356 
    307357=== Page layout issues === 
     
    317367 
    318368Note: For the above configuration to have any effect it must be put after the configuration of your project root location, i.e. {{{<Location /myproject />}}}. 
     369 
     370Also, 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`. 
    319371 
    320372=== HTTPS issues === 
     
    336388 
    337389=== Segmentation fault with php5-mhash or other php5 modules === 
    338 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]] 
    339  
    340 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]] 
     390You 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] 
     391 
     392Some 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] 
    341393 
    342394---- 
    343 See also TracGuide, TracInstall, TracCgi, TracFastCgi 
     395See also:  TracGuide, TracInstall, [wiki:TracModWSGI ModWSGI], [wiki:TracFastCgi FastCGI],  [trac:TracNginxRecipe TracNginxRecipe]