Changes between Version 2 and Version 3 of TracModPython


Ignore:
Timestamp:
07/07/13 01:26:40 (6 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 
    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]. 
    7  
    8 == Simple configuration == 
     6{{{#!div class="important" 
     7** A Word of Warning ** 
     8 
     9As 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 
     13These 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 
    918 
    1019If you just installed mod_python, you may have to add a line to load the module in the Apache configuration: 
     
    1322}}} 
    1423 
    15  ''Note: The exact path to the module depends on how the HTTPD installation is laid out.'' 
     24''Note: The exact path to the module depends on how the HTTPD installation is laid out.'' 
     25 
    1626On Debian using apt-get 
    1727{{{ 
     
    2030(Still on Debian) after you have installed mod_python, you must enable the modules in apache2 (equivalent of the above Load Module directive): 
    2131{{{ 
    22 a2enmod mod_python 
     32a2enmod python 
    2333}}} 
    2434On Fedora use, using yum: 
     
    3343   PythonInterpreter main_interpreter 
    3444   PythonHandler mod_python.testhandler 
     45   Order allow,deny 
     46   Allow from all 
    3547</Location> 
    3648}}} 
     
    4557   PythonOption TracEnv /var/trac/myproject 
    4658   PythonOption TracUriRoot /projects/myproject 
     59   Order allow,deny 
     60   Allow from all 
    4761</Location> 
    4862}}} 
     
    5064The 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. 
    5165 
     66The options available are 
     67{{{ 
     68    # For a single project 
     69    PythonOption TracEnv /var/trac/myproject 
     70 
     71    # For multiple projects 
     72    PythonOption TracEnvParentDir /var/trac/myprojects 
     73 
     74    # For the index of multiple projects 
     75    PythonOption TracEnvIndexTemplate /srv/www/htdocs/trac/project_list_template.html 
     76 
     77    # A space delimitted list, with a "," between key and value pairs. 
     78    PythonOption TracTemplateVars key1,val1 key2,val2 
     79 
     80    # Useful to get the date in the wanted order 
     81    PythonOption TracLocale en_GB.UTF8 
     82 
     83    # See description above         
     84    PythonOption TracUriRoot /projects/myproject 
     85}}} 
     86 
     87=== Python Egg Cache === 
     88 
     89Compressed 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{{{ 
     91PythonOption PYTHON_EGG_CACHE /var/trac/myprojects/egg-cache 
     92}}} 
     93 
     94or you can uncompress the Genshi egg to resolve problems extracting from it. 
     95 
    5296=== Configuring Authentication === 
    5397 
    54 Creating password files and configuring authentication works similar to the process for [wiki:TracCgi#AddingAuthentication CGI]: 
    55 {{{ 
    56 #!xml 
    57 <Location /projects/myproject/login> 
    58   AuthType Basic 
    59   AuthName "myproject" 
    60   AuthUserFile /var/trac/myproject/.htpasswd 
    61   Require valid-user 
    62 </Location> 
    63 }}} 
    64  
    65 Configuration for mod_ldap authentication in Apache is a bit tricky (httpd 2.2.x and OpenLDAP: slapd 2.3.19) 
    66  
    67 1. You need to load the following modules in Apache httpd.conf 
    68 {{{ 
    69 LoadModule ldap_module modules/mod_ldap.so 
    70 LoadModule authnz_ldap_module modules/mod_authnz_ldap.so 
    71 }}} 
    72  
    73 2. 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  
    95 Or 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  
    120 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. 
    121  
    122 Note 2: Active Directory requires an authenticating user/password to access records (AuthLDAPBindDN and AuthLDAPBindPassword). 
    123  
    124 Note 3: The directive "require ldap-group ..."  specifies an AD group whose members are allowed access. 
    125  
     98See corresponding section in the [wiki:TracModWSGI#ConfiguringAuthentication] page. 
     99 
     100 
     101== Advanced Configuration 
     102 
     103=== Setting the Python Egg Cache === 
     104 
     105If 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}}} 
    126115 
    127116 
     
    140129Be careful about using the !PythonPath directive, and ''not'' `SetEnv PYTHONPATH`, as the latter won't work. 
    141130 
    142 == Setting up multiple projects == 
     131=== Setting up multiple projects === 
    143132 
    144133The Trac mod_python handler supports a configuration option similar to Subversion's `SvnParentPath`, called `TracEnvParentDir`: 
     
    175164}}} 
    176165 
    177 == Virtual Host Configuration == 
     166=== Virtual Host Configuration === 
    178167 
    179168Below is the sample configuration required to set up your trac as a virtual server (i.e. when you access it at the URLs like 
     
    201190}}} 
    202191 
    203 if you have issues with login try using `<LocationMatch>` instead of `<Location>` 
     192This 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 *>`. 
    204196 
    205197For a virtual host that supports multiple projects replace "`TracEnv`" /var/trac/myproject with "`TracEnvParentDir`" /var/trac/ 
    206198 
     199Note: !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". 
     200 
    207201== Troubleshooting == 
    208202 
     
    218212For multiple projects, try restarting the server as well. 
    219213 
     214=== Login Not Working === 
     215If you've used `<Location />` directive, it will override any other directives, as well as `<Location /login>`. 
     216The 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}}} 
     245 
    220246=== Expat-related segmentation faults === #expat 
    221247 
    222 This problem will most certainly hit you on Unix when using python 2.4. 
     248This problem will most certainly hit you on Unix when using Python 2.4. 
    223249In Python 2.4, some version of Expat (an XML parser library written in C) is used,  
    224250and if Apache is using another version, this results in segmentation faults. 
    225 As Trac 0.11 is using Genshi, which will use indirectly use Expat, that problem 
     251As Trac 0.11 is using Genshi, which will indirectly use Expat, that problem 
    226252can now hit you even if everything was working fine before with Trac 0.10. 
    227253 
     
    238264Using <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. 
    239265 
     266=== Problem with zipped egg === 
     267 
     268It'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{{{ 
     271easy_install --always-unzip Trac-0.12b1.zip 
     272}}} 
     273 
    240274=== Using .htaccess === 
    241275 
     
    244278It 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. :) 
    245279 
    246 === Win32 Issues === 
     280A success story: For me it worked out-of-box, with following trivial config: 
     281{{{#!xml 
     282SetHandler mod_python 
     283PythonInterpreter main_interpreter 
     284PythonHandler trac.web.modpython_frontend  
     285PythonOption TracEnv /system/path/to/this/directory 
     286PythonOption TracUriRoot /path/on/apache 
     287 
     288AuthType Basic 
     289AuthName "ProjectName" 
     290AuthUserFile /path/to/.htpasswd 
     291Require valid-user 
     292}}} 
     293 
     294The `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 
     298If 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 ==== 
    247308If 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. 
    248309 
    249310 
    250 === OS X issues === 
     311==== OS X issues ==== 
    251312 
    252313When 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]. 
    253314 
    254 === SELinux issues === 
     315==== SELinux issues ==== 
    255316 
    256317If Trac reports something like: ''Cannot get shared lock on db.lock'' 
     
    261322}}} 
    262323 
    263 See also [[http://subversion.tigris.org/faq.html#reposperms]] 
    264  
    265 === FreeBSD issues === 
     324See also [http://subversion.tigris.org/faq.html#reposperms] 
     325 
     326==== FreeBSD issues ==== 
    266327Pay 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. 
    267328 
    268 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 recomendable. 
    269 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  
     329If 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. 
     330The best option [http://modpython.org/pipermail/mod_python/2006-September/021983.html seems to be] adding to /usr/local/apache2/bin/ennvars the line  
    270331 
    271332{{{ 
     
    273334}}} 
    274335 
     336 
     337==== Fedora 7 Issues ==== 
     338Make sure you install the 'python-sqlite2' package as it seems to be required for TracModPython but not for tracd 
     339 
     340 
    275341=== Subversion issues === 
    276342 
     
    279345If 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`). 
    280346 
    281 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: 
     347You 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: 
    282348{{{ 
    283349PythonInterpreter main_interpreter 
    284350}}} 
    285 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. 
     351This 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. 
    286352 
    287353=== Page layout issues === 
     
    297363 
    298364Note: 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 
     366Also, 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`. 
    299367 
    300368=== HTTPS issues === 
     
    311379}}} 
    312380 
    313 === Fedora 7 Issues === 
    314 Make sure you install the 'python-sqlite2' package as it seems to be required for TracModPython but not for tracd 
    315  
    316381 
    317382=== Segmentation fault with php5-mhash or other php5 modules === 
    318 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]] 
    319  
    320 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]] 
     383You 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 
     385Some 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] 
    321386 
    322387---- 
    323 See also TracGuide, TracInstall, TracCgi, TracFastCgi 
     388See also:  TracGuide, TracInstall, [wiki:TracModWSGI ModWSGI], [wiki:TracFastCgi FastCGI],  [trac:TracNginxRecipe TracNginxRecipe]