Changes between Version 1 and Version 2 of TracModPython


Ignore:
Timestamp:
Jul 17, 2008 10:45:00 AM (12 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 
    6 {{{#!div class="important" 
    7 ** A Word of Warning ** 
    8  
    9 As 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. 
    10 }}} 
    11  
    12  
    13 These 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], but you'll be totally on your own. 
    14  
    15 [[PageOutline(2-3,Overview,inline)]] 
    16  
    17 == Simple configuration: single project == #Simpleconfiguration 
     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 
     8== Simple configuration == 
    189 
    1910If you just installed mod_python, you may have to add a line to load the module in the Apache configuration: 
     
    2213}}} 
    2314 
    24 ''Note: The exact path to the module depends on how the HTTPD installation is laid out.'' 
    25  
     15 ''Note: The exact path to the module depends on how the HTTPD installation is laid out.'' 
    2616On Debian using apt-get 
    2717{{{ 
     
    3020(Still on Debian) after you have installed mod_python, you must enable the modules in apache2 (equivalent of the above Load Module directive): 
    3121{{{ 
    32 a2enmod python 
     22a2enmod mod_python 
    3323}}} 
    3424On Fedora use, using yum: 
     
    4333   PythonInterpreter main_interpreter 
    4434   PythonHandler mod_python.testhandler 
    45    Order allow,deny 
    46    Allow from all 
    4735</Location> 
    4836}}} 
     
    5745   PythonOption TracEnv /var/trac/myproject 
    5846   PythonOption TracUriRoot /projects/myproject 
    59    Order allow,deny 
    60    Allow from all 
    6147</Location> 
    6248}}} 
     
    6854    # For a single project 
    6955    PythonOption TracEnv /var/trac/myproject 
    70  
    7156    # For multiple projects 
    7257    PythonOption TracEnvParentDir /var/trac/myprojects 
    73  
    7458    # For the index of multiple projects 
    75     PythonOption TracEnvIndexTemplate /srv/www/htdocs/trac/project_list_template.html 
    76  
     59    PythonOption TracEnvIndexTemplate /srv/www/htdocs/trac/project_list_tepmlate.html 
    7760    # A space delimitted list, with a "," between key and value pairs. 
    7861    PythonOption TracTemplateVars key1,val1 key2,val2 
    79  
    8062    # Useful to get the date in the wanted order 
    8163    PythonOption TracLocale en_GB.UTF8 
    82  
    8364    # See description above         
    8465    PythonOption TracUriRoot /projects/myproject 
    8566}}} 
    8667 
    87 === Python Egg Cache === 
    88  
    89 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: 
    90 {{{ 
    91 PythonOption PYTHON_EGG_CACHE /var/trac/myprojects/egg-cache 
    92 }}} 
    93  
    94 or you can uncompress the Genshi egg to resolve problems extracting from it. 
    95  
    9668=== Configuring Authentication === 
    9769 
    98 See corresponding section in the [wiki:TracModWSGI#ConfiguringAuthentication] page. 
    99  
    100  
    101 == Advanced Configuration 
    102  
    103 === Setting the Python Egg Cache === 
    104  
    105 If 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.  
    106  
    107 {{{ 
    108 #!xml 
    109 <Location /projects/myproject> 
    110   ... 
    111   PythonOption PYTHON_EGG_CACHE /tmp  
    112   ... 
    113 </Location> 
    114 }}} 
     70Creating password files and configuring authentication works similar to the process for [wiki:TracCgi#AddingAuthentication CGI]: 
     71{{{ 
     72#!xml 
     73<Location /projects/myproject/login> 
     74  AuthType Basic 
     75  AuthName "myproject" 
     76  AuthUserFile /var/trac/myproject/.htpasswd 
     77  Require valid-user 
     78</Location> 
     79}}} 
     80 
     81Configuration for mod_ldap authentication in Apache is a bit tricky (httpd 2.2.x and OpenLDAP: slapd 2.3.19) 
     82 
     831. You need to load the following modules in Apache httpd.conf 
     84{{{ 
     85LoadModule ldap_module modules/mod_ldap.so 
     86LoadModule authnz_ldap_module modules/mod_authnz_ldap.so 
     87}}} 
     88 
     892. Your httpd.conf also needs to look something like: 
     90 
     91{{{ 
     92#!xml 
     93<Location /trac/> 
     94  SetHandler mod_python 
     95  PythonInterpreter main_interpreter 
     96  PythonHandler trac.web.modpython_frontend 
     97  PythonOption TracEnv /home/trac/ 
     98  PythonOption TracUriRoot /trac/ 
     99  Order deny,allow 
     100  Deny from all 
     101  Allow from 192.168.11.0/24 
     102  AuthType Basic 
     103  AuthName "Trac" 
     104  AuthBasicProvider "ldap" 
     105  AuthLDAPURL "ldap://127.0.0.1/dc=example,dc=co,dc=ke?uid?sub?(objectClass=inetOrgPerson)" 
     106  authzldapauthoritative Off 
     107  require valid-user 
     108</Location> 
     109}}} 
     110 
     111Or the LDAP interface to a Microsoft Active Directory: 
     112 
     113{{{ 
     114#!xml 
     115<Location /trac/> 
     116  SetHandler mod_python 
     117  PythonInterpreter main_interpreter 
     118  PythonHandler trac.web.modpython_frontend 
     119  PythonOption TracEnv /home/trac/ 
     120  PythonOption TracUriRoot /trac/ 
     121  Order deny,allow 
     122  Deny from all 
     123  Allow from 192.168.11.0/24 
     124  AuthType Basic 
     125  AuthName "Trac" 
     126  AuthBasicProvider "ldap" 
     127  AuthLDAPURL "ldap://adserver.company.com:3268/DC=company,DC=com?sAMAccountName?sub?(objectClass=user)" 
     128  AuthLDAPBindDN       ldap-auth-user@company.com 
     129  AuthLDAPBindPassword "the_password" 
     130  authzldapauthoritative Off 
     131  # require valid-user 
     132  require ldap-group CN=Trac Users,CN=Users,DC=company,DC=com 
     133</Location> 
     134}}} 
     135 
     136Note 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. 
     137 
     138Note 2: Active Directory requires an authenticating user/password to access records (AuthLDAPBindDN and AuthLDAPBindPassword). 
     139 
     140Note 3: The directive "require ldap-group ..."  specifies an AD group whose members are allowed access. 
     141 
    115142 
    116143 
     
    129156Be careful about using the !PythonPath directive, and ''not'' `SetEnv PYTHONPATH`, as the latter won't work. 
    130157 
    131 === Setting up multiple projects === 
     158== Setting up multiple projects == 
    132159 
    133160The Trac mod_python handler supports a configuration option similar to Subversion's `SvnParentPath`, called `TracEnvParentDir`: 
     
    164191}}} 
    165192 
    166 === Virtual Host Configuration === 
     193== Virtual Host Configuration == 
    167194 
    168195Below is the sample configuration required to set up your trac as a virtual server (i.e. when you access it at the URLs like 
     
    190217}}} 
    191218 
    192 This does not seem to work in all cases. What you can do if it does not: 
    193  * Try using `<LocationMatch>` instead of `<Location>` 
    194  * <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). 
    195  * Depending on apache's `NameVirtualHost` configuration, you may need to use `<VirtualHost *:80>` instead of `<VirtualHost *>`. 
     219if you have issues with login try using `<LocationMatch>` instead of `<Location>` 
    196220 
    197221For a virtual host that supports multiple projects replace "`TracEnv`" /var/trac/myproject with "`TracEnvParentDir`" /var/trac/ 
    198222 
    199 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". 
     223Note: !DocumentRoot should not point to your Trac project env. As Asmodai wrote on #trac: "suppose there's a webserer bug that allows disclosure of !DocumentRoot they could then leech the entire Trac environment". 
    200224 
    201225== Troubleshooting == 
     
    211235 
    212236For multiple projects, try restarting the server as well. 
    213  
    214 === Login Not Working === 
    215 If you've used `<Location />` directive, it will override any other directives, as well as `<Location /login>`. 
    216 The workaround is to use negation expression as follows (for multi project setups): 
    217 {{{ 
    218 #!xml 
    219 #this one for other pages 
    220 <Location ~ "/*(?!login)"> 
    221    SetHandler mod_python 
    222    PythonHandler trac.web.modpython_frontend 
    223    PythonOption TracEnvParentDir /projects 
    224    PythonOption TracUriRoot / 
    225  
    226 </Location> 
    227 #this one for login page 
    228 <Location ~ "/[^/]+/login"> 
    229    SetHandler mod_python 
    230    PythonHandler trac.web.modpython_frontend 
    231    PythonOption TracEnvParentDir /projects 
    232    PythonOption TracUriRoot / 
    233  
    234    #remove these if you don't want to force SSL 
    235    RewriteEngine On  
    236    RewriteCond %{HTTPS} off 
    237    RewriteRule (.*) https://%{HTTP_HOST}%{REQUEST_URI} 
    238  
    239    AuthType Basic 
    240    AuthName "Trac" 
    241    AuthUserFile /projects/.htpasswd 
    242    Require valid-user 
    243 </Location> 
    244 }}} 
    245237 
    246238=== Expat-related segmentation faults === #expat 
     
    264256Using <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. 
    265257 
    266 === Problem with zipped egg === 
    267  
    268 It'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: 
    269  
    270 {{{ 
    271 easy_install --always-unzip Trac-0.12b1.zip 
    272 }}} 
    273  
    274258=== Using .htaccess === 
    275259 
     
    278262It 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. :) 
    279263 
    280 A success story: For me it worked out-of-box, with following trivial config: 
    281 {{{#!xml 
    282 SetHandler mod_python 
    283 PythonInterpreter main_interpreter 
    284 PythonHandler trac.web.modpython_frontend  
    285 PythonOption TracEnv /system/path/to/this/directory 
    286 PythonOption TracUriRoot /path/on/apache 
    287  
    288 AuthType Basic 
    289 AuthName "ProjectName" 
    290 AuthUserFile /path/to/.htpasswd 
    291 Require valid-user 
    292 }}} 
    293  
    294 The `TracUriRoot` is obviously the path you need to enter to the browser to get to the trac (e.g. domain.tld/projects/trac) 
    295  
    296 === Additional .htaccess help === 
    297  
    298 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: 
    299  
    300 {{{ 
    301 <IfModule mod_rewrite.c> 
    302   RewriteEngine Off 
    303 </IfModule> 
    304 }}} 
    305  
    306 === Platform specific issues 
    307 ==== Win32 Issues ==== 
     264=== Win32 Issues === 
    308265If 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. 
    309266 
    310267 
    311 ==== OS X issues ==== 
     268=== OS X issues === 
    312269 
    313270When using mod_python on OS X you will not be able to restart Apache using `apachectl restart`. This is apparently fixed in mod_python 3.2, but there's also a patch available for earlier versions [http://www.dscpl.com.au/projects/vampire/patches.html here]. 
    314271 
    315 ==== SELinux issues ==== 
     272=== SELinux issues === 
    316273 
    317274If Trac reports something like: ''Cannot get shared lock on db.lock'' 
     
    322279}}} 
    323280 
    324 See also [http://subversion.tigris.org/faq.html#reposperms] 
    325  
    326 ==== FreeBSD issues ==== 
     281See also [[http://subversion.tigris.org/faq.html#reposperms]] 
     282 
     283=== FreeBSD issues === 
    327284Pay 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. 
    328285 
    329286If 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. 
    330 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  
     287The best option [[http://modpython.org/pipermail/mod_python/2006-September/021983.html seems to be]] adding to /usr/local/apache2/bin/ennvars the line  
    331288 
    332289{{{ 
     
    334291}}} 
    335292 
    336  
    337 ==== Fedora 7 Issues ==== 
    338 Make sure you install the 'python-sqlite2' package as it seems to be required for TracModPython but not for tracd 
    339  
    340  
    341293=== Subversion issues === 
    342294 
     
    345297If 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`). 
    346298 
    347 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 [trac:#3371 #3371], in order to force the use of the main interpreter: 
     299You 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: 
    348300{{{ 
    349301PythonInterpreter main_interpreter 
    350302}}} 
    351 This 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. 
     303This 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. 
    352304 
    353305=== Page layout issues === 
     
    363315 
    364316Note: For the above configuration to have any effect it must be put after the configuration of your project root location, i.e. {{{<Location /myproject />}}}. 
    365  
    366 Also, 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`. 
    367317 
    368318=== HTTPS issues === 
     
    379329}}} 
    380330 
     331=== Fedora 7 Issues === 
     332Make sure you install the 'python-sqlite2' package as it seems to be required for TracModPython but not for tracd 
     333 
    381334 
    382335=== Segmentation fault with php5-mhash or other php5 modules === 
    383 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] 
    384  
    385 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] 
     336You 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]] 
     337 
     338Some 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]] 
    386339 
    387340---- 
    388 See also:  TracGuide, TracInstall, [wiki:TracModWSGI ModWSGI], [wiki:TracFastCgi FastCGI],  [trac:TracNginxRecipe TracNginxRecipe] 
     341See also TracGuide, TracInstall, TracCgi, TracFastCgi