Changes between Version 1 and Version 2 of TracModPython


Ignore:
Timestamp:
22/11/16 11:06:43 (3 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 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 == A Word of Warning ==
     6{{{#!div class="important"
     7** A Word of Warning **
    98
    109As 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 
    12 == Simple configuration ==
     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
    1318
    1419If you just installed mod_python, you may have to add a line to load the module in the Apache configuration:
     
    3843   PythonInterpreter main_interpreter
    3944   PythonHandler mod_python.testhandler
     45   Order allow,deny
     46   Allow from all
    4047</Location>
    4148}}}
     
    5057   PythonOption TracEnv /var/trac/myproject
    5158   PythonOption TracUriRoot /projects/myproject
     59   Order allow,deny
     60   Allow from all
    5261</Location>
    5362}}}
     
    5968    # For a single project
    6069    PythonOption TracEnv /var/trac/myproject
     70
    6171    # For multiple projects
    6272    PythonOption TracEnvParentDir /var/trac/myprojects
     73
    6374    # For the index of multiple projects
    6475    PythonOption TracEnvIndexTemplate /srv/www/htdocs/trac/project_list_template.html
     76
    6577    # A space delimitted list, with a "," between key and value pairs.
    6678    PythonOption TracTemplateVars key1,val1 key2,val2
     79
    6780    # Useful to get the date in the wanted order
    6881    PythonOption TracLocale en_GB.UTF8
     82
    6983    # See description above       
    7084    PythonOption TracUriRoot /projects/myproject
     
    7993
    8094or you can uncompress the Genshi egg to resolve problems extracting from it.
     95
    8196=== Configuring Authentication ===
    8297
    83 Creating password files and configuring authentication works similar to the process for [wiki:TracCgi#AddingAuthentication CGI]:
    84 {{{
    85 #!xml
    86 <Location /projects/myproject/login>
    87   AuthType Basic
    88   AuthName "myproject"
    89   AuthUserFile /var/trac/myproject/.htpasswd
    90   Require valid-user
    91 </Location>
    92 }}}
    93 
    94 Configuration for mod_ldap authentication in Apache is a bit tricky (httpd 2.2.x and OpenLDAP: slapd 2.3.19)
    95 
    96 1. You need to load the following modules in Apache httpd.conf
    97 {{{
    98 LoadModule ldap_module modules/mod_ldap.so
    99 LoadModule authnz_ldap_module modules/mod_authnz_ldap.so
    100 }}}
    101 
    102 2. 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 
    124 Or 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 
    149 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.
    150 
    151 Note 2: Active Directory requires an authenticating user/password to access records (AuthLDAPBindDN and AuthLDAPBindPassword).
    152 
    153 Note 3: The directive "require ldap-group ..."  specifies an AD group whose members are allowed access.
    154 
     98See corresponding section in the [wiki:TracModWSGI#ConfiguringAuthentication] page.
     99
     100
     101== Advanced Configuration
    155102
    156103=== Setting the Python Egg Cache ===
     
    182129Be careful about using the !PythonPath directive, and ''not'' `SetEnv PYTHONPATH`, as the latter won't work.
    183130
    184 == Setting up multiple projects ==
     131=== Setting up multiple projects ===
    185132
    186133The Trac mod_python handler supports a configuration option similar to Subversion's `SvnParentPath`, called `TracEnvParentDir`:
     
    217164}}}
    218165
    219 == Virtual Host Configuration ==
     166=== Virtual Host Configuration ===
    220167
    221168Below is the sample configuration required to set up your trac as a virtual server (i.e. when you access it at the URLs like
     
    265212For multiple projects, try restarting the server as well.
    266213
     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
    267246=== Expat-related segmentation faults === #expat
    268247
     
    300279
    301280A success story: For me it worked out-of-box, with following trivial config:
    302 {{{
     281{{{#!xml
    303282SetHandler mod_python
    304283PythonInterpreter main_interpreter
     
    325304}}}
    326305
    327 
    328 === Win32 Issues ===
     306=== Platform specific issues
     307==== Win32 Issues ====
    329308If 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.
    330309
    331310
    332 === OS X issues ===
     311==== OS X issues ====
    333312
    334313When 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].
    335314
    336 === SELinux issues ===
     315==== SELinux issues ====
    337316
    338317If Trac reports something like: ''Cannot get shared lock on db.lock''
     
    345324See also [http://subversion.tigris.org/faq.html#reposperms]
    346325
    347 === FreeBSD issues ===
     326==== FreeBSD issues ====
    348327Pay 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.
    349328
     
    354333export LD_PRELOAD=/usr/lib/libc_r.so
    355334}}}
     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
    356340
    357341=== Subversion issues ===
     
    395379}}}
    396380
    397 === Fedora 7 Issues ===
    398 Make sure you install the 'python-sqlite2' package as it seems to be required for TracModPython but not for tracd
    399 
    400381
    401382=== Segmentation fault with php5-mhash or other php5 modules ===