Changes between Version 4 and Version 5 of TracModPython


Ignore:
Timestamp:
Feb 26, 2008 5:40:00 PM (8 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracModPython

    v4 v5  
    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
     6These instructions are for Apache 2; if you are still using Apache 1.3, you may have some luck with [wiki:TracModPython2.7 TracModPython2.7].
     7
    68== Simple configuration ==
    79
     
    1214
    1315 ''Note: The exact path to the module depends on how the HTTPD installation is laid out.''
    14 
    15 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.
    16 {{{
     16On Debian using apt-get
     17{{{
     18apt-get install libapache2-mod-python libapache2-mod-python-doc
     19}}}
     20(Still on Debian) after you have installed mod_python, you must enable the modules in apache2 (equivalent of the above Load Module directive):
     21{{{
     22a2enmod mod_python
     23}}}
     24On Fedora use, using yum:
     25{{{
     26yum install mod_python
     27}}}
     28You 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+.
     29{{{
     30#!xml
    1731<Location /mpinfo>
    1832   SetHandler mod_python
     33   PythonInterpreter main_interpreter
    1934   PythonHandler mod_python.testhandler
    2035</Location>
     
    2338A simple setup of Trac on mod_python looks like this:
    2439{{{
     40#!xml
    2541<Location /projects/myproject>
    2642   SetHandler mod_python
     43   PythonInterpreter main_interpreter
    2744   PythonHandler trac.web.modpython_frontend
    2845   PythonOption TracEnv /var/trac/myproject
     
    3148}}}
    3249
    33 The 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.
     50The 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.
    3451
    3552=== Configuring Authentication ===
    3653
    37 Configuring authentication works just like for [wiki:TracCgi#AddingAuthentication CGI]:
    38 {{{
    39 <Location "/projects/myproject/login">
     54Creating password files and configuring authentication works similar to the process for [wiki:TracCgi#AddingAuthentication CGI]:
     55{{{
     56#!xml
     57<Location /projects/myproject/login>
    4058  AuthType Basic
    4159  AuthName "myproject"
     
    4563}}}
    4664
     65Configuration for mod_ldap authentication in Apache is a bit tricky (httpd 2.2.x and OpenLDAP: slapd 2.3.19)
     66
     671. You need to load the following modules in Apache httpd.conf
     68{{{
     69LoadModule ldap_module modules/mod_ldap.so
     70LoadModule authnz_ldap_module modules/mod_authnz_ldap.so
     71}}}
     72
     732. Your httpd.conf also needs to look something like:
     74
     75{{{
     76#!xml
     77<Location /trac/>
     78  SetHandler mod_python
     79  PythonInterpreter main_interpreter
     80  PythonHandler trac.web.modpython_frontend
     81  PythonOption TracEnv /home/trac/
     82  PythonOption TracUriRoot /trac/
     83  Order deny,allow
     84  Deny from all
     85  Allow from 192.168.11.0/24
     86  AuthType Basic
     87  AuthName "Trac"
     88  AuthBasicProvider "ldap"
     89  AuthLDAPURL "ldap://127.0.0.1/dc=example,dc=co,dc=ke?uid?sub?(objectClass=inetOrgPerson)"
     90  authzldapauthoritative Off
     91  require valid-user
     92</Location>
     93}}}
     94
     95Or the LDAP interface to a Microsoft Active Directory:
     96
     97{{{
     98#!xml
     99<Location /trac/>
     100  SetHandler mod_python
     101  PythonInterpreter main_interpreter
     102  PythonHandler trac.web.modpython_frontend
     103  PythonOption TracEnv /home/trac/
     104  PythonOption TracUriRoot /trac/
     105  Order deny,allow
     106  Deny from all
     107  Allow from 192.168.11.0/24
     108  AuthType Basic
     109  AuthName "Trac"
     110  AuthBasicProvider "ldap"
     111  AuthLDAPURL "ldap://adserver.company.com:3268/DC=company,DC=com?sAMAccountName?sub?(objectClass=user)"
     112  AuthLDAPBindDN       ldap-auth-user@company.com
     113  AuthLDAPBindPassword "the_password"
     114  authzldapauthoritative Off
     115  # require valid-user
     116  require ldap-group CN=Trac Users,CN=Users,DC=company,DC=com
     117</Location>
     118}}}
     119
     120Note 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.
     121
     122Note 2: Active Directory requires an authenticating user/password to access records (AuthLDAPBindDN and AuthLDAPBindPassword).
     123
     124Note 3: The directive "require ldap-group ..."  specifies an AD group whose members are allowed access.
     125
     126
     127
    47128=== Setting the !PythonPath ===
    48129
    49130If 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:
    50131{{{
     132#!xml
    51133<Location /projects/myproject>
    52134  ...
     
    62144The Trac mod_python handler supports a configuration option similar to Subversion's `SvnParentPath`, called `TracEnvParentDir`:
    63145{{{
     146#!xml
    64147<Location /projects>
    65148  SetHandler mod_python
     149  PythonInterpreter main_interpreter
    66150  PythonHandler trac.web.modpython_frontend
    67151  PythonOption TracEnvParentDir /var/trac
     
    74158If you don't want to have the subdirectory listing as your projects home page you can use a
    75159{{{
     160#!xml
    76161<LocationMatch "/.+/">
    77162}}}
     
    81166You can also use the same authentication realm for all of the projects using a `<LocationMatch>` directive:
    82167{{{
     168#!xml
    83169<LocationMatch "/projects/[^/]+/login">
    84170  AuthType Basic
     
    95181
    96182{{{
     183#!xml
    97184<VirtualHost * >
    98     DocumentRoot /var/trac/myproject
     185    DocumentRoot /var/www/myproject
    99186    ServerName trac.mycompany.com
    100187    <Location />
    101188        SetHandler mod_python
     189        PythonInterpreter main_interpreter
    102190        PythonHandler trac.web.modpython_frontend
    103191        PythonOption TracEnv /var/trac/myproject
     
    113201}}}
    114202
     203if you have issues with login try using `<LocationMatch>` instead of `<Location>`
     204
    115205For a virtual host that supports multiple projects replace "`TracEnv`" /var/trac/myproject with "`TracEnvParentDir`" /var/trac/
    116206
     
    119209In general, if you get server error pages, you can either check the Apache error log, or enable the `PythonDebug` option:
    120210{{{
     211#!xml
    121212<Location /projects/myproject>
    122213  ...
     
    125216}}}
    126217
     218For multiple projects, try restarting the server as well.
     219
     220=== Expat-related segmentation faults === #expat
     221
     222This problem will most certainly hit you on Unix when using python 2.4.
     223In Python 2.4, some version of Expat (an XML parser library written in C) is used,
     224and if Apache is using another version, this results in segmentation faults.
     225As Trac 0.11 is using Genshi, which will use indirectly use Expat, that problem
     226can now hit you even if everything was working fine before with Trac 0.10.
     227
     228See Graham Dumpleton's detailed [http://www.dscpl.com.au/wiki/ModPython/Articles/ExpatCausingApacheCrash explanation and workarounds] for the issue.
     229
    127230=== Form submission problems ===
    128231
     
    144247If 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.
    145248
     249
    146250=== OS X issues ===
    147251
     
    162266Pay 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.
    163267
     268If 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.
     269The best option [[http://modpython.org/pipermail/mod_python/2006-September/021983.html seems to be]] adding to /usr/local/apache2/bin/ennvars the line
     270
     271{{{
     272export LD_PRELOAD=/usr/lib/libc_r.so
     273}}}
     274
    164275=== Subversion issues ===
    165276
     
    167278
    168279If 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`).
     280
     281You 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:
     282{{{
     283PythonInterpreter main_interpreter
     284}}}
     285This 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.
     286
     287=== Page layout issues ===
     288
     289If 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:
     290{{{
     291#!xml
     292Alias /myproject/css "/usr/share/trac/htdocs/css"
     293<Location /myproject/css>
     294    SetHandler None
     295</Location>
     296}}}
     297
     298Note: For the above configuration to have any effect it must be put after the configuration of your project root location, i.e. {{{<Location /myproject />}}}.
     299
     300=== HTTPS issues ===
     301
     302If 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:
     303{{{
     304#!xml
     305<VirtualHost * >
     306    DocumentRoot /var/www/myproject
     307    ServerName trac.mycompany.com
     308    SetEnv HTTPS 1
     309    ....
     310</VirtualHost>
     311}}}
     312
     313=== Fedora 7 Issues ===
     314Make sure you install the 'python-sqlite2' package as it seems to be required for TracModPython but not for tracd
     315
     316
     317=== Segmentation fault with php5-mhash or other php5 modules ===
     318You 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
     320Some 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]]
    169321
    170322----