Changes between Version 1 and Version 2 of TracModPython


Ignore:
Timestamp:
09/10/09 19:34:28 (15 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracModPython

    v1 v2  
    33
    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.
    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].
    75
    86== Simple configuration ==
     
    1311}}}
    1412
    15 ''Note: The exact path to the module depends on how the HTTPD installation is laid out.''
     13 ''Note: The exact path to the module depends on how the HTTPD installation is laid out.''
    1614
    17 On Debian using apt-get
     15You can test your mod_python installation by adding the following to your httpd.conf.  You should remove this when you are done testing for security reasons.
    1816{{{
    19 apt-get install libapache2-mod-python libapache2-mod-python-doc
    20 }}}
    21 (Still on Debian) after you have installed mod_python, you must enable the modules in apache2 (equivalent of the above Load Module directive):
    22 {{{
    23 a2enmod mod_python
    24 }}}
    25 On Fedora use, using yum:
    26 {{{
    27 yum install mod_python
    28 }}}
    29 You can test your mod_python installation by adding the following to your httpd.conf.  You should remove this when you are done testing for security reasons. Note: mod_python.testhandler is only available in mod_python 3.2+.
    30 {{{
    31 #!xml
    3217<Location /mpinfo>
    3318   SetHandler mod_python
    34    PythonInterpreter main_interpreter
    3519   PythonHandler mod_python.testhandler
    3620</Location>
     
    3923A simple setup of Trac on mod_python looks like this:
    4024{{{
    41 #!xml
    4225<Location /projects/myproject>
    4326   SetHandler mod_python
    44    PythonInterpreter main_interpreter
    4527   PythonHandler trac.web.modpython_frontend
    4628   PythonOption TracEnv /var/trac/myproject
     
    4931}}}
    5032
    51 The 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.
    52 
    53 The 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 
    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 }}}
     33The option '''`TracUriRoot`''' may or may not be necessary in your setup. Try your configuration with out it, and if the URLs produced by Trac look wrong or if Trac does not seem to recognize the URLs correctly, add the '''`TracUriRoot`''' option.  You will notice that the `Location` and '''`TracUriRoot`''' have the same path.
    7534
    7635=== Configuring Authentication ===
    7736
    78 Creating password files and configuring authentication works similar to the process for [wiki:TracCgi#AddingAuthentication CGI]:
     37Configuring authentication works just like for [wiki:TracCgi#AddingAuthentication CGI]:
    7938{{{
    80 #!xml
    81 <Location /projects/myproject/login>
     39<Location "/projects/myproject/login">
    8240  AuthType Basic
    8341  AuthName "myproject"
     
    8745}}}
    8846
    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 
    150 
    151 
    15247=== Setting the !PythonPath ===
    15348
    15449If the Trac installation isn't installed in your Python path, you'll have to tell Apache where to find the Trac mod_python handler  using the `PythonPath` directive:
    15550{{{
    156 #!xml
    15751<Location /projects/myproject>
    15852  ...
     
    16862The Trac mod_python handler supports a configuration option similar to Subversion's `SvnParentPath`, called `TracEnvParentDir`:
    16963{{{
    170 #!xml
    17164<Location /projects>
    17265  SetHandler mod_python
    173   PythonInterpreter main_interpreter
    17466  PythonHandler trac.web.modpython_frontend
    17567  PythonOption TracEnvParentDir /var/trac
     
    18274If you don't want to have the subdirectory listing as your projects home page you can use a
    18375{{{
    184 #!xml
    18576<LocationMatch "/.+/">
    18677}}}
     
    19081You can also use the same authentication realm for all of the projects using a `<LocationMatch>` directive:
    19182{{{
    192 #!xml
    19383<LocationMatch "/projects/[^/]+/login">
    19484  AuthType Basic
     
    20595
    20696{{{
    207 #!xml
    20897<VirtualHost * >
    209     DocumentRoot /var/www/myproject
     98    DocumentRoot /var/trac/myproject
    21099    ServerName trac.mycompany.com
    211100    <Location />
    212101        SetHandler mod_python
    213         PythonInterpreter main_interpreter
    214102        PythonHandler trac.web.modpython_frontend
    215103        PythonOption TracEnv /var/trac/myproject
     
    225113}}}
    226114
    227 This does not seem to work in all cases. What you can do if it does not:
    228  * Try using `<LocationMatch>` instead of `<Location>`
    229  * <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).
    230 
    231115For a virtual host that supports multiple projects replace "`TracEnv`" /var/trac/myproject with "`TracEnvParentDir`" /var/trac/
    232 
    233 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".
    234116
    235117== Troubleshooting ==
     
    237119In general, if you get server error pages, you can either check the Apache error log, or enable the `PythonDebug` option:
    238120{{{
    239 #!xml
    240121<Location /projects/myproject>
    241122  ...
     
    243124</Location>
    244125}}}
    245 
    246 For multiple projects, try restarting the server as well.
    247 
    248 === Expat-related segmentation faults === #expat
    249 
    250 This problem will most certainly hit you on Unix when using Python 2.4.
    251 In Python 2.4, some version of Expat (an XML parser library written in C) is used,
    252 and if Apache is using another version, this results in segmentation faults.
    253 As Trac 0.11 is using Genshi, which will indirectly use Expat, that problem
    254 can now hit you even if everything was working fine before with Trac 0.10.
    255 
    256 See Graham Dumpleton's detailed [http://www.dscpl.com.au/wiki/ModPython/Articles/ExpatCausingApacheCrash explanation and workarounds] for the issue.
    257126
    258127=== Form submission problems ===
     
    272141It 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. :)
    273142
    274 A success story: For me it worked out-of-box, with following trivial config:
    275 {{{
    276 SetHandler mod_python
    277 PythonInterpreter main_interpreter
    278 PythonHandler trac.web.modpython_frontend
    279 PythonOption TracEnv /system/path/to/this/directory
    280 PythonOption TracUriRoot /path/on/apache
    281 
    282 AuthType Basic
    283 AuthName "ProjectName"
    284 AuthUserFile /path/to/.htpasswd
    285 Require valid-user
    286 }}}
    287 
    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 === Additional .htaccess help ===
    291 
    292 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:
    293 
    294 {{{
    295 <IfModule mod_rewrite.c>
    296   RewriteEngine Off
    297 </IfModule>
    298 }}}
    299 
    300 
    301143=== Win32 Issues ===
    302144If 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.
    303 
    304145
    305146=== OS X issues ===
     
    321162Pay 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.
    322163
    323 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.
    324 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
    325 
    326 {{{
    327 export LD_PRELOAD=/usr/lib/libc_r.so
    328 }}}
    329 
    330164=== Subversion issues ===
    331165
     
    334168If 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`).
    335169
    336 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:
    337 {{{
    338 PythonInterpreter main_interpreter
    339 }}}
    340 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.
    341 
    342 === Page layout issues ===
    343 
    344 If the formatting of the Trac pages look weird chances are that the style sheets governing the page layout are not handled properly by the web server. Try adding the following lines to your apache configuration:
    345 {{{
    346 #!xml
    347 Alias /myproject/css "/usr/share/trac/htdocs/css"
    348 <Location /myproject/css>
    349     SetHandler None
    350 </Location>
    351 }}}
    352 
    353 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 />}}}.
    354 
    355 === HTTPS issues ===
    356 
    357 If you want to run Trac fully under https you might find that it tries to redirect to plain http. In this case just add the following line to your apache configuration:
    358 {{{
    359 #!xml
    360 <VirtualHost * >
    361     DocumentRoot /var/www/myproject
    362     ServerName trac.mycompany.com
    363     SetEnv HTTPS 1
    364     ....
    365 </VirtualHost>
    366 }}}
    367 
    368 === Fedora 7 Issues ===
    369 Make sure you install the 'python-sqlite2' package as it seems to be required for TracModPython but not for tracd
    370 
    371 
    372 === Segmentation fault with php5-mhash or other php5 modules ===
    373 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]]
    374 
    375 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]]
    376 
    377170----
    378 See also:  TracGuide, TracInstall, [wiki:TracModWSGI ModWSGI], [wiki:TracFastCgi FastCGI], [wiki:TracModPython ModPython], [trac:TracNginxRecipe TracNginxRecipe]
     171See also TracGuide, TracInstall, TracCgi, TracFastCgi