Changes between Version 6 and Version 7 of TracModPython


Ignore:
Timestamp:
2013-05-22T09:31:17+02:00 (16 months ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracModPython

    v6 v7  
    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 [trac: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: 
     
    2130(Still on Debian) after you have installed mod_python, you must enable the modules in apache2 (equivalent of the above Load Module directive): 
    2231{{{ 
    23 a2enmod mod_python 
     32a2enmod python 
    2433}}} 
    2534On Fedora use, using yum: 
     
    3443   PythonInterpreter main_interpreter 
    3544   PythonHandler mod_python.testhandler 
     45   Order allow,deny 
     46   Allow from all 
    3647</Location> 
    3748}}} 
     
    4657   PythonOption TracEnv /var/trac/myproject 
    4758   PythonOption TracUriRoot /projects/myproject 
     59   Order allow,deny 
     60   Allow from all 
    4861</Location> 
    4962}}} 
     
    5568    # For a single project 
    5669    PythonOption TracEnv /var/trac/myproject 
     70 
    5771    # For multiple projects 
    5872    PythonOption TracEnvParentDir /var/trac/myprojects 
     73 
    5974    # For the index of multiple projects 
    6075    PythonOption TracEnvIndexTemplate /srv/www/htdocs/trac/project_list_template.html 
     76 
    6177    # A space delimitted list, with a "," between key and value pairs. 
    6278    PythonOption TracTemplateVars key1,val1 key2,val2 
     79 
    6380    # Useful to get the date in the wanted order 
    6481    PythonOption TracLocale en_GB.UTF8 
     82 
    6583    # See description above         
    6684    PythonOption TracUriRoot /projects/myproject 
     
    7593 
    7694or you can uncompress the Genshi egg to resolve problems extracting from it. 
     95 
    7796=== Configuring Authentication === 
    7897 
    79 Creating password files and configuring authentication works similar to the process for [wiki:TracCgi#AddingAuthentication CGI]: 
    80 {{{ 
    81 #!xml 
    82 <Location /projects/myproject/login> 
    83   AuthType Basic 
    84   AuthName "myproject" 
    85   AuthUserFile /var/trac/myproject/.htpasswd 
    86   Require valid-user 
    87 </Location> 
    88 }}} 
    89  
    90 Configuration for mod_ldap authentication in Apache is a bit tricky (httpd 2.2.x and OpenLDAP: slapd 2.3.19) 
    91  
    92 1. You need to load the following modules in Apache httpd.conf 
    93 {{{ 
    94 LoadModule ldap_module modules/mod_ldap.so 
    95 LoadModule authnz_ldap_module modules/mod_authnz_ldap.so 
    96 }}} 
    97  
    98 2. 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  
    120 Or 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  
    145 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. 
    146  
    147 Note 2: Active Directory requires an authenticating user/password to access records (AuthLDAPBindDN and AuthLDAPBindPassword). 
    148  
    149 Note 3: The directive "require ldap-group ..."  specifies an AD group whose members are allowed access. 
    150  
     98See corresponding section in the [wiki:TracModWSGI#ConfiguringAuthentication] page. 
     99 
     100 
     101== Advanced Configuration 
    151102 
    152103=== Setting the Python Egg Cache === 
     
    178129Be careful about using the !PythonPath directive, and ''not'' `SetEnv PYTHONPATH`, as the latter won't work. 
    179130 
    180 == Setting up multiple projects == 
     131=== Setting up multiple projects === 
    181132 
    182133The Trac mod_python handler supports a configuration option similar to Subversion's `SvnParentPath`, called `TracEnvParentDir`: 
     
    213164}}} 
    214165 
    215 == Virtual Host Configuration == 
     166=== Virtual Host Configuration === 
    216167 
    217168Below is the sample configuration required to set up your trac as a virtual server (i.e. when you access it at the URLs like 
     
    261212For multiple projects, try restarting the server as well. 
    262213 
     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 
    263246=== Expat-related segmentation faults === #expat 
    264247 
     
    281264Using <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. 
    282265 
     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 
    283274=== Using .htaccess === 
    284275 
     
    288279 
    289280A success story: For me it worked out-of-box, with following trivial config: 
    290 {{{ 
     281{{{#!xml 
    291282SetHandler mod_python 
    292283PythonInterpreter main_interpreter 
     
    313304}}} 
    314305 
    315  
    316 === Win32 Issues === 
     306=== Platform specific issues 
     307==== Win32 Issues ==== 
    317308If 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. 
    318309 
    319310 
    320 === OS X issues === 
     311==== OS X issues ==== 
    321312 
    322313When 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]. 
    323314 
    324 === SELinux issues === 
     315==== SELinux issues ==== 
    325316 
    326317If Trac reports something like: ''Cannot get shared lock on db.lock'' 
     
    333324See also [http://subversion.tigris.org/faq.html#reposperms] 
    334325 
    335 === FreeBSD issues === 
     326==== FreeBSD issues ==== 
    336327Pay 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. 
    337328 
     
    342333export LD_PRELOAD=/usr/lib/libc_r.so 
    343334}}} 
     335 
     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 
    344340 
    345341=== Subversion issues === 
     
    367363 
    368364Note: 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`. 
    369367 
    370368=== HTTPS issues === 
     
    381379}}} 
    382380 
    383 === Fedora 7 Issues === 
    384 Make sure you install the 'python-sqlite2' package as it seems to be required for TracModPython but not for tracd 
    385  
    386381 
    387382=== Segmentation fault with php5-mhash or other php5 modules === 
     
    391386 
    392387---- 
    393 See also:  TracGuide, TracInstall, [wiki:TracModWSGI ModWSGI], [wiki:TracFastCgi FastCGI], [wiki:TracModPython ModPython], [trac:TracNginxRecipe TracNginxRecipe] 
     388See also:  TracGuide, TracInstall, [wiki:TracModWSGI ModWSGI], [wiki:TracFastCgi FastCGI], [trac:TracNginxRecipe TracNginxRecipe]