Changes between Version 1 and Version 2 of TracModPython


Ignore:
Timestamp:
02/08/11 21:48:17 (9 years ago)
Author:
trac (IP: 127.0.0.1)
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{{{
     
    5051The option '''`TracUriRoot`''' may or may not be necessary in your setup. Try your configuration without it; if the URLs produced by Trac look wrong, if Trac does not seem to recognize URLs correctly, or you get an odd "No handler matched request to..." error, add the '''`TracUriRoot`''' option.  You will notice that the `Location` and '''`TracUriRoot`''' have the same path.
    5152
     53The options available are
     54{{{
     55    # For a single project
     56    PythonOption TracEnv /var/trac/myproject
     57    # For multiple projects
     58    PythonOption TracEnvParentDir /var/trac/myprojects
     59    # For the index of multiple projects
     60    PythonOption TracEnvIndexTemplate /srv/www/htdocs/trac/project_list_template.html
     61    # A space delimitted list, with a "," between key and value pairs.
     62    PythonOption TracTemplateVars key1,val1 key2,val2
     63    # Useful to get the date in the wanted order
     64    PythonOption TracLocale en_GB.UTF8
     65    # See description above       
     66    PythonOption TracUriRoot /projects/myproject
     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.
    5277=== Configuring Authentication ===
    5378
     
    125150
    126151
     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
    127165
    128166=== Setting the !PythonPath ===
     
    201239}}}
    202240
    203 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 *>`.
    204245
    205246For a virtual host that supports multiple projects replace "`TracEnv`" /var/trac/myproject with "`TracEnvParentDir`" /var/trac/
     247
     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".
    206249
    207250== Troubleshooting ==
     
    220263=== Expat-related segmentation faults === #expat
    221264
    222 This problem will most certainly hit you on Unix when using python 2.4.
     265This problem will most certainly hit you on Unix when using Python 2.4.
    223266In Python 2.4, some version of Expat (an XML parser library written in C) is used,
    224267and if Apache is using another version, this results in segmentation faults.
    225 As Trac 0.11 is using Genshi, which will use indirectly use Expat, that problem
     268As Trac 0.11 is using Genshi, which will indirectly use Expat, that problem
    226269can now hit you even if everything was working fine before with Trac 0.10.
    227270
     
    238281Using <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.
    239282
     283=== Problem with zipped egg ===
     284
     285It'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{{{
     288easy_install --always-unzip Trac-0.12b1.zip
     289}}}
     290
    240291=== Using .htaccess ===
    241292
     
    243294
    244295It 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
     297A success story: For me it worked out-of-box, with following trivial config:
     298{{{
     299SetHandler mod_python
     300PythonInterpreter main_interpreter
     301PythonHandler trac.web.modpython_frontend
     302PythonOption TracEnv /system/path/to/this/directory
     303PythonOption TracUriRoot /path/on/apache
     304
     305AuthType Basic
     306AuthName "ProjectName"
     307AuthUserFile /path/to/.htpasswd
     308Require valid-user
     309}}}
     310
     311The `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
     315If 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
    245323
    246324=== Win32 Issues ===
     
    261339}}}
    262340
    263 See also [[http://subversion.tigris.org/faq.html#reposperms]]
     341See also [http://subversion.tigris.org/faq.html#reposperms]
    264342
    265343=== FreeBSD issues ===
    266344Pay 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.
    267345
    268 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 recomendable.
    269 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
     346If 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.
     347The best option [http://modpython.org/pipermail/mod_python/2006-September/021983.html seems to be] adding to /usr/local/apache2/bin/ennvars the line
    270348
    271349{{{
     
    279357If 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`).
    280358
    281 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:
     359You 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:
    282360{{{
    283361PythonInterpreter main_interpreter
    284362}}}
    285 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.
     363This 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.
    286364
    287365=== Page layout issues ===
     
    297375
    298376Note: 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
     378Also, 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`.
    299379
    300380=== HTTPS issues ===
     
    316396
    317397=== Segmentation fault with php5-mhash or other php5 modules ===
    318 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]]
    319 
    320 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]]
     398You 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
     400Some 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]
    321401
    322402----
    323 See also TracGuide, TracInstall, TracCgi, TracFastCgi
     403See also:  TracGuide, TracInstall, [wiki:TracModWSGI ModWSGI], [wiki:TracFastCgi FastCGI],  [trac:TracNginxRecipe TracNginxRecipe]