Changes between Version 1 and Version 2 of TracModPython


Ignore:
Timestamp:
10 Jun 2010 13:36:28 (10 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
     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].
     7
    68== Simple configuration ==
    79
     
    1113}}}
    1214
    13  ''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 {{{
     15''Note: The exact path to the module depends on how the HTTPD installation is laid out.''
     16
     17On Debian using apt-get
     18{{{
     19apt-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{{{
     23a2enmod mod_python
     24}}}
     25On Fedora use, using yum:
     26{{{
     27yum install mod_python
     28}}}
     29You 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
    1732<Location /mpinfo>
    1833   SetHandler mod_python
     34   PythonInterpreter main_interpreter
    1935   PythonHandler mod_python.testhandler
    2036</Location>
     
    2339A simple setup of Trac on mod_python looks like this:
    2440{{{
     41#!xml
    2542<Location /projects/myproject>
    2643   SetHandler mod_python
     44   PythonInterpreter main_interpreter
    2745   PythonHandler trac.web.modpython_frontend
    2846   PythonOption TracEnv /var/trac/myproject
     
    3149}}}
    3250
    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.
    34 
     51The 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
     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.
    3577=== Configuring Authentication ===
    3678
    37 Configuring authentication works just like for [wiki:TracCgi#AddingAuthentication CGI]:
    38 {{{
    39 <Location "/projects/myproject/login">
     79Creating password files and configuring authentication works similar to the process for [wiki:TracCgi#AddingAuthentication CGI]:
     80{{{
     81#!xml
     82<Location /projects/myproject/login>
    4083  AuthType Basic
    4184  AuthName "myproject"
     
    4588}}}
    4689
     90Configuration for mod_ldap authentication in Apache is a bit tricky (httpd 2.2.x and OpenLDAP: slapd 2.3.19)
     91
     921. You need to load the following modules in Apache httpd.conf
     93{{{
     94LoadModule ldap_module modules/mod_ldap.so
     95LoadModule authnz_ldap_module modules/mod_authnz_ldap.so
     96}}}
     97
     982. Your httpd.conf also needs to look something like:
     99
     100{{{
     101#!xml
     102<Location /trac/>
     103  SetHandler mod_python
     104  PythonInterpreter main_interpreter
     105  PythonHandler trac.web.modpython_frontend
     106  PythonOption TracEnv /home/trac/
     107  PythonOption TracUriRoot /trac/
     108  Order deny,allow
     109  Deny from all
     110  Allow from 192.168.11.0/24
     111  AuthType Basic
     112  AuthName "Trac"
     113  AuthBasicProvider "ldap"
     114  AuthLDAPURL "ldap://127.0.0.1/dc=example,dc=co,dc=ke?uid?sub?(objectClass=inetOrgPerson)"
     115  authzldapauthoritative Off
     116  require valid-user
     117</Location>
     118}}}
     119
     120Or the LDAP interface to a Microsoft Active Directory:
     121
     122{{{
     123#!xml
     124<Location /trac/>
     125  SetHandler mod_python
     126  PythonInterpreter main_interpreter
     127  PythonHandler trac.web.modpython_frontend
     128  PythonOption TracEnv /home/trac/
     129  PythonOption TracUriRoot /trac/
     130  Order deny,allow
     131  Deny from all
     132  Allow from 192.168.11.0/24
     133  AuthType Basic
     134  AuthName "Trac"
     135  AuthBasicProvider "ldap"
     136  AuthLDAPURL "ldap://adserver.company.com:3268/DC=company,DC=com?sAMAccountName?sub?(objectClass=user)"
     137  AuthLDAPBindDN       ldap-auth-user@company.com
     138  AuthLDAPBindPassword "the_password"
     139  authzldapauthoritative Off
     140  # require valid-user
     141  require ldap-group CN=Trac Users,CN=Users,DC=company,DC=com
     142</Location>
     143}}}
     144
     145Note 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.
     146
     147Note 2: Active Directory requires an authenticating user/password to access records (AuthLDAPBindDN and AuthLDAPBindPassword).
     148
     149Note 3: The directive "require ldap-group ..."  specifies an AD group whose members are allowed access.
     150
     151
     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
     165
    47166=== Setting the !PythonPath ===
    48167
    49168If 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:
    50169{{{
     170#!xml
    51171<Location /projects/myproject>
    52172  ...
     
    62182The Trac mod_python handler supports a configuration option similar to Subversion's `SvnParentPath`, called `TracEnvParentDir`:
    63183{{{
     184#!xml
    64185<Location /projects>
    65186  SetHandler mod_python
     187  PythonInterpreter main_interpreter
    66188  PythonHandler trac.web.modpython_frontend
    67189  PythonOption TracEnvParentDir /var/trac
     
    74196If you don't want to have the subdirectory listing as your projects home page you can use a
    75197{{{
     198#!xml
    76199<LocationMatch "/.+/">
    77200}}}
     
    81204You can also use the same authentication realm for all of the projects using a `<LocationMatch>` directive:
    82205{{{
     206#!xml
    83207<LocationMatch "/projects/[^/]+/login">
    84208  AuthType Basic
     
    95219
    96220{{{
     221#!xml
    97222<VirtualHost * >
    98     DocumentRoot /var/trac/myproject
     223    DocumentRoot /var/www/myproject
    99224    ServerName trac.mycompany.com
    100225    <Location />
    101226        SetHandler mod_python
     227        PythonInterpreter main_interpreter
    102228        PythonHandler trac.web.modpython_frontend
    103229        PythonOption TracEnv /var/trac/myproject
     
    113239}}}
    114240
     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 *>`.
     245
    115246For a virtual host that supports multiple projects replace "`TracEnv`" /var/trac/myproject with "`TracEnvParentDir`" /var/trac/
    116247
     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".
     249
    117250== Troubleshooting ==
    118251
    119252In general, if you get server error pages, you can either check the Apache error log, or enable the `PythonDebug` option:
    120253{{{
     254#!xml
    121255<Location /projects/myproject>
    122256  ...
     
    125259}}}
    126260
     261For multiple projects, try restarting the server as well.
     262
     263=== Expat-related segmentation faults === #expat
     264
     265This problem will most certainly hit you on Unix when using Python 2.4.
     266In Python 2.4, some version of Expat (an XML parser library written in C) is used,
     267and if Apache is using another version, this results in segmentation faults.
     268As Trac 0.11 is using Genshi, which will indirectly use Expat, that problem
     269can now hit you even if everything was working fine before with Trac 0.10.
     270
     271See Graham Dumpleton's detailed [http://www.dscpl.com.au/wiki/ModPython/Articles/ExpatCausingApacheCrash explanation and workarounds] for the issue.
     272
    127273=== Form submission problems ===
    128274
     
    140286
    141287It 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. :)
     288
     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
    142315
    143316=== Win32 Issues ===
    144317If 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.
    145318
     319
    146320=== OS X issues ===
    147321
     
    157331}}}
    158332
    159 See also [[http://subversion.tigris.org/faq.html#reposperms]]
     333See also [http://subversion.tigris.org/faq.html#reposperms]
    160334
    161335=== FreeBSD issues ===
    162336Pay 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.
    163337
     338If 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.
     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
     340
     341{{{
     342export LD_PRELOAD=/usr/lib/libc_r.so
     343}}}
     344
    164345=== Subversion issues ===
    165346
     
    168349If 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`).
    169350
     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:
     352{{{
     353PythonInterpreter main_interpreter
     354}}}
     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.
     356
     357=== Page layout issues ===
     358
     359If 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:
     360{{{
     361#!xml
     362Alias /myproject/css "/usr/share/trac/htdocs/css"
     363<Location /myproject/css>
     364    SetHandler None
     365</Location>
     366}}}
     367
     368Note: 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
     370=== HTTPS issues ===
     371
     372If 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:
     373{{{
     374#!xml
     375<VirtualHost * >
     376    DocumentRoot /var/www/myproject
     377    ServerName trac.mycompany.com
     378    SetEnv HTTPS 1
     379    ....
     380</VirtualHost>
     381}}}
     382
     383=== Fedora 7 Issues ===
     384Make sure you install the 'python-sqlite2' package as it seems to be required for TracModPython but not for tracd
     385
     386
     387=== Segmentation fault with php5-mhash or other php5 modules ===
     388You 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]
     389
     390Some 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]
     391
    170392----
    171 See also TracGuide, TracInstall, TracCgi, TracFastCgi
     393See also:  TracGuide, TracInstall, [wiki:TracModWSGI ModWSGI], [wiki:TracFastCgi FastCGI], [wiki:TracModPython ModPython], [trac:TracNginxRecipe TracNginxRecipe]