Changes between Version 2 and Version 3 of TracModPython


Ignore:
Timestamp:
Feb 22, 2011, 12:40:16 AM (8 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracModPython

    v2 v3  
    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
     8== A Word of Warning ==
     9
     10As of 16^th^ June 2010, the mod_python project is officially dead.  If you are considering using mod_python for a new installation, '''please don't'''!  There are known issues which will not be fixed and there are now better alternatives.  Check out the main TracInstall pages for your target version for more information.
     11
    612== Simple configuration ==
    713
     
    1117}}}
    1218
    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 {{{
     19''Note: The exact path to the module depends on how the HTTPD installation is laid out.''
     20
     21On Debian using apt-get
     22{{{
     23apt-get install libapache2-mod-python libapache2-mod-python-doc
     24}}}
     25(Still on Debian) after you have installed mod_python, you must enable the modules in apache2 (equivalent of the above Load Module directive):
     26{{{
     27a2enmod python
     28}}}
     29On Fedora use, using yum:
     30{{{
     31yum install mod_python
     32}}}
     33You 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+.
     34{{{
     35#!xml
    1736<Location /mpinfo>
    1837   SetHandler mod_python
     38   PythonInterpreter main_interpreter
    1939   PythonHandler mod_python.testhandler
    2040</Location>
     
    2343A simple setup of Trac on mod_python looks like this:
    2444{{{
     45#!xml
    2546<Location /projects/myproject>
    2647   SetHandler mod_python
     48   PythonInterpreter main_interpreter
    2749   PythonHandler trac.web.modpython_frontend
    2850   PythonOption TracEnv /var/trac/myproject
     
    3153}}}
    3254
    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 
     55The 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.
     56
     57The options available are
     58{{{
     59    # For a single project
     60    PythonOption TracEnv /var/trac/myproject
     61    # For multiple projects
     62    PythonOption TracEnvParentDir /var/trac/myprojects
     63    # For the index of multiple projects
     64    PythonOption TracEnvIndexTemplate /srv/www/htdocs/trac/project_list_template.html
     65    # A space delimitted list, with a "," between key and value pairs.
     66    PythonOption TracTemplateVars key1,val1 key2,val2
     67    # Useful to get the date in the wanted order
     68    PythonOption TracLocale en_GB.UTF8
     69    # See description above       
     70    PythonOption TracUriRoot /projects/myproject
     71}}}
     72
     73=== Python Egg Cache ===
     74
     75Compressed 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:
     76{{{
     77PythonOption PYTHON_EGG_CACHE /var/trac/myprojects/egg-cache
     78}}}
     79
     80or you can uncompress the Genshi egg to resolve problems extracting from it.
    3581=== Configuring Authentication ===
    3682
    37 Configuring authentication works just like for [wiki:TracCgi#AddingAuthentication CGI]:
    38 {{{
    39 <Location "/projects/myproject/login">
     83Creating password files and configuring authentication works similar to the process for [wiki:TracCgi#AddingAuthentication CGI]:
     84{{{
     85#!xml
     86<Location /projects/myproject/login>
    4087  AuthType Basic
    4188  AuthName "myproject"
     
    4592}}}
    4693
     94Configuration for mod_ldap authentication in Apache is a bit tricky (httpd 2.2.x and OpenLDAP: slapd 2.3.19)
     95
     961. You need to load the following modules in Apache httpd.conf
     97{{{
     98LoadModule ldap_module modules/mod_ldap.so
     99LoadModule authnz_ldap_module modules/mod_authnz_ldap.so
     100}}}
     101
     1022. Your httpd.conf also needs to look something like:
     103
     104{{{
     105#!xml
     106<Location /trac/>
     107  SetHandler mod_python
     108  PythonInterpreter main_interpreter
     109  PythonHandler trac.web.modpython_frontend
     110  PythonOption TracEnv /home/trac/
     111  PythonOption TracUriRoot /trac/
     112  Order deny,allow
     113  Deny from all
     114  Allow from 192.168.11.0/24
     115  AuthType Basic
     116  AuthName "Trac"
     117  AuthBasicProvider "ldap"
     118  AuthLDAPURL "ldap://127.0.0.1/dc=example,dc=co,dc=ke?uid?sub?(objectClass=inetOrgPerson)"
     119  authzldapauthoritative Off
     120  require valid-user
     121</Location>
     122}}}
     123
     124Or the LDAP interface to a Microsoft Active Directory:
     125
     126{{{
     127#!xml
     128<Location /trac/>
     129  SetHandler mod_python
     130  PythonInterpreter main_interpreter
     131  PythonHandler trac.web.modpython_frontend
     132  PythonOption TracEnv /home/trac/
     133  PythonOption TracUriRoot /trac/
     134  Order deny,allow
     135  Deny from all
     136  Allow from 192.168.11.0/24
     137  AuthType Basic
     138  AuthName "Trac"
     139  AuthBasicProvider "ldap"
     140  AuthLDAPURL "ldap://adserver.company.com:3268/DC=company,DC=com?sAMAccountName?sub?(objectClass=user)"
     141  AuthLDAPBindDN       ldap-auth-user@company.com
     142  AuthLDAPBindPassword "the_password"
     143  authzldapauthoritative Off
     144  # require valid-user
     145  require ldap-group CN=Trac Users,CN=Users,DC=company,DC=com
     146</Location>
     147}}}
     148
     149Note 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.
     150
     151Note 2: Active Directory requires an authenticating user/password to access records (AuthLDAPBindDN and AuthLDAPBindPassword).
     152
     153Note 3: The directive "require ldap-group ..."  specifies an AD group whose members are allowed access.
     154
     155
     156=== Setting the Python Egg Cache ===
     157
     158If 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.
     159
     160{{{
     161#!xml
     162<Location /projects/myproject>
     163  ...
     164  PythonOption PYTHON_EGG_CACHE /tmp
     165  ...
     166</Location>
     167}}}
     168
     169
    47170=== Setting the !PythonPath ===
    48171
    49172If 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:
    50173{{{
     174#!xml
    51175<Location /projects/myproject>
    52176  ...
     
    62186The Trac mod_python handler supports a configuration option similar to Subversion's `SvnParentPath`, called `TracEnvParentDir`:
    63187{{{
     188#!xml
    64189<Location /projects>
    65190  SetHandler mod_python
     191  PythonInterpreter main_interpreter
    66192  PythonHandler trac.web.modpython_frontend
    67193  PythonOption TracEnvParentDir /var/trac
     
    74200If you don't want to have the subdirectory listing as your projects home page you can use a
    75201{{{
     202#!xml
    76203<LocationMatch "/.+/">
    77204}}}
     
    81208You can also use the same authentication realm for all of the projects using a `<LocationMatch>` directive:
    82209{{{
     210#!xml
    83211<LocationMatch "/projects/[^/]+/login">
    84212  AuthType Basic
     
    95223
    96224{{{
     225#!xml
    97226<VirtualHost * >
    98     DocumentRoot /var/trac/myproject
     227    DocumentRoot /var/www/myproject
    99228    ServerName trac.mycompany.com
    100229    <Location />
    101230        SetHandler mod_python
     231        PythonInterpreter main_interpreter
    102232        PythonHandler trac.web.modpython_frontend
    103233        PythonOption TracEnv /var/trac/myproject
     
    113243}}}
    114244
     245This does not seem to work in all cases. What you can do if it does not:
     246 * Try using `<LocationMatch>` instead of `<Location>`
     247 * <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).
     248 * Depending on apache's `NameVirtualHost` configuration, you may need to use `<VirtualHost *:80>` instead of `<VirtualHost *>`.
     249
    115250For a virtual host that supports multiple projects replace "`TracEnv`" /var/trac/myproject with "`TracEnvParentDir`" /var/trac/
    116251
     252Note: !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".
     253
    117254== Troubleshooting ==
    118255
    119256In general, if you get server error pages, you can either check the Apache error log, or enable the `PythonDebug` option:
    120257{{{
     258#!xml
    121259<Location /projects/myproject>
    122260  ...
     
    125263}}}
    126264
     265For multiple projects, try restarting the server as well.
     266
     267=== Expat-related segmentation faults === #expat
     268
     269This problem will most certainly hit you on Unix when using Python 2.4.
     270In Python 2.4, some version of Expat (an XML parser library written in C) is used,
     271and if Apache is using another version, this results in segmentation faults.
     272As Trac 0.11 is using Genshi, which will indirectly use Expat, that problem
     273can now hit you even if everything was working fine before with Trac 0.10.
     274
     275See Graham Dumpleton's detailed [http://www.dscpl.com.au/wiki/ModPython/Articles/ExpatCausingApacheCrash explanation and workarounds] for the issue.
     276
    127277=== Form submission problems ===
    128278
     
    135285Using <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.
    136286
     287=== Problem with zipped egg ===
     288
     289It'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:
     290
     291{{{
     292easy_install --always-unzip Trac-0.12b1.zip
     293}}}
     294
    137295=== Using .htaccess ===
    138296
     
    140298
    141299It 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. :)
     300
     301A success story: For me it worked out-of-box, with following trivial config:
     302{{{
     303SetHandler mod_python
     304PythonInterpreter main_interpreter
     305PythonHandler trac.web.modpython_frontend
     306PythonOption TracEnv /system/path/to/this/directory
     307PythonOption TracUriRoot /path/on/apache
     308
     309AuthType Basic
     310AuthName "ProjectName"
     311AuthUserFile /path/to/.htpasswd
     312Require valid-user
     313}}}
     314
     315The `TracUriRoot` is obviously the path you need to enter to the browser to get to the trac (e.g. domain.tld/projects/trac)
     316
     317=== Additional .htaccess help ===
     318
     319If 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:
     320
     321{{{
     322<IfModule mod_rewrite.c>
     323  RewriteEngine Off
     324</IfModule>
     325}}}
     326
    142327
    143328=== Win32 Issues ===
    144329If 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.
    145330
     331
    146332=== OS X issues ===
    147333
     
    157343}}}
    158344
    159 See also [[http://subversion.tigris.org/faq.html#reposperms]]
     345See also [http://subversion.tigris.org/faq.html#reposperms]
    160346
    161347=== FreeBSD issues ===
    162348Pay 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.
    163349
     350If 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.
     351The best option [http://modpython.org/pipermail/mod_python/2006-September/021983.html seems to be] adding to /usr/local/apache2/bin/ennvars the line
     352
     353{{{
     354export LD_PRELOAD=/usr/lib/libc_r.so
     355}}}
     356
    164357=== Subversion issues ===
    165358
     
    168361If 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`).
    169362
     363You 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:
     364{{{
     365PythonInterpreter main_interpreter
     366}}}
     367This 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.
     368
     369=== Page layout issues ===
     370
     371If 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:
     372{{{
     373#!xml
     374Alias /myproject/css "/usr/share/trac/htdocs/css"
     375<Location /myproject/css>
     376    SetHandler None
     377</Location>
     378}}}
     379
     380Note: For the above configuration to have any effect it must be put after the configuration of your project root location, i.e. {{{<Location /myproject />}}}.
     381
     382Also, 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`.
     383
     384=== HTTPS issues ===
     385
     386If 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:
     387{{{
     388#!xml
     389<VirtualHost * >
     390    DocumentRoot /var/www/myproject
     391    ServerName trac.mycompany.com
     392    SetEnv HTTPS 1
     393    ....
     394</VirtualHost>
     395}}}
     396
     397=== Fedora 7 Issues ===
     398Make sure you install the 'python-sqlite2' package as it seems to be required for TracModPython but not for tracd
     399
     400
     401=== Segmentation fault with php5-mhash or other php5 modules ===
     402You 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]
     403
     404Some 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]
     405
    170406----
    171 See also TracGuide, TracInstall, TracCgi, TracFastCgi
     407See also:  TracGuide, TracInstall, [wiki:TracModWSGI ModWSGI], [wiki:TracFastCgi FastCGI],  [trac:TracNginxRecipe TracNginxRecipe]