Changes between Version 1 and Version 2 of TracModPython


Ignore:
Timestamp:
10/09/08 11:57:10 (6 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracModPython

    v1 v2  
    11= Trac and mod_python =
    2 
    3 Trac supports [http://www.modpython.org/ mod_python], which speeds up Trac's response times considerably and permits use of many Apache features not possible with [wiki:TracStandalone tracd]/mod_proxy.
     2[[TracGuideToc]]
     3
     4Trac 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.
     5
     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].
    47
    58== Simple configuration ==
     
    1013}}}
    1114
     15 ''Note: The exact path to the module depends on how the HTTPD installation is laid out.''
     16On Debian using apt-get
     17{{{
     18apt-get install libapache2-mod-python libapache2-mod-python-doc
     19}}}
     20(Still on Debian) after you have installed mod_python, you must enable the modules in apache2 (equivalent of the above Load Module directive):
     21{{{
     22a2enmod mod_python
     23}}}
     24On Fedora use, using yum:
     25{{{
     26yum install mod_python
     27}}}
     28You 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+.
     29{{{
     30#!xml
     31<Location /mpinfo>
     32   SetHandler mod_python
     33   PythonInterpreter main_interpreter
     34   PythonHandler mod_python.testhandler
     35</Location>
     36}}}
     37
    1238A simple setup of Trac on mod_python looks like this:
    1339{{{
     40#!xml
    1441<Location /projects/myproject>
    1542   SetHandler mod_python
     43   PythonInterpreter main_interpreter
    1644   PythonHandler trac.web.modpython_frontend
    1745   PythonOption TracEnv /var/trac/myproject
     
    2048}}}
    2149
    22 Note that the option `TracUriRoot` may or may not be necessary in your setup. Try without first, and if the URLs produced by Trac look wrong or if Trac does not seem to recognize the URLs correctly, add the `TracUriRoot` option.
    23 
    24 Configuring authentication works the same as for [wiki:TracCgi#AddingAuthentication CGI]:
    25 {{{
    26 <Location "/projects/myproject/login">
     50The 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.
     51
     52The options available are
     53{{{
     54    # For a single project
     55    PythonOption TracEnv /var/trac/myproject
     56    # For multiple projects
     57    PythonOption TracEnvParentDir /var/trac/myprojects
     58    # For the index of multiple projects
     59    PythonOption TracEnvIndexTemplate /srv/www/htdocs/trac/project_list_tepmlate.html
     60    # A space delimitted list, with a "," between key and value pairs.
     61    PythonOption TracTemplateVars key1,val1 key2,val2
     62    # Useful to get the date in the wanted order
     63    PythonOption TracLocale en_GB.UTF8
     64    # See description above       
     65    PythonOption TracUriRoot /projects/myproject
     66    # Override default python egg cache location
     67    PythonOption PYTHON_EGG_CACHE /var/trac/myprojects/egg-cache
     68}}}
     69
     70=== Configuring Authentication ===
     71
     72Creating password files and configuring authentication works similar to the process for [wiki:TracCgi#AddingAuthentication CGI]:
     73{{{
     74#!xml
     75<Location /projects/myproject/login>
    2776  AuthType Basic
    2877  AuthName "myproject"
    29   AuthUserFile /var/trac/myproject/.htaccess
     78  AuthUserFile /var/trac/myproject/.htpasswd
    3079  Require valid-user
    3180</Location>
    3281}}}
    3382
     83Configuration for mod_ldap authentication in Apache is a bit tricky (httpd 2.2.x and OpenLDAP: slapd 2.3.19)
     84
     851. You need to load the following modules in Apache httpd.conf
     86{{{
     87LoadModule ldap_module modules/mod_ldap.so
     88LoadModule authnz_ldap_module modules/mod_authnz_ldap.so
     89}}}
     90
     912. Your httpd.conf also needs to look something like:
     92
     93{{{
     94#!xml
     95<Location /trac/>
     96  SetHandler mod_python
     97  PythonInterpreter main_interpreter
     98  PythonHandler trac.web.modpython_frontend
     99  PythonOption TracEnv /home/trac/
     100  PythonOption TracUriRoot /trac/
     101  Order deny,allow
     102  Deny from all
     103  Allow from 192.168.11.0/24
     104  AuthType Basic
     105  AuthName "Trac"
     106  AuthBasicProvider "ldap"
     107  AuthLDAPURL "ldap://127.0.0.1/dc=example,dc=co,dc=ke?uid?sub?(objectClass=inetOrgPerson)"
     108  authzldapauthoritative Off
     109  require valid-user
     110</Location>
     111}}}
     112
     113Or the LDAP interface to a Microsoft Active Directory:
     114
     115{{{
     116#!xml
     117<Location /trac/>
     118  SetHandler mod_python
     119  PythonInterpreter main_interpreter
     120  PythonHandler trac.web.modpython_frontend
     121  PythonOption TracEnv /home/trac/
     122  PythonOption TracUriRoot /trac/
     123  Order deny,allow
     124  Deny from all
     125  Allow from 192.168.11.0/24
     126  AuthType Basic
     127  AuthName "Trac"
     128  AuthBasicProvider "ldap"
     129  AuthLDAPURL "ldap://adserver.company.com:3268/DC=company,DC=com?sAMAccountName?sub?(objectClass=user)"
     130  AuthLDAPBindDN       ldap-auth-user@company.com
     131  AuthLDAPBindPassword "the_password"
     132  authzldapauthoritative Off
     133  # require valid-user
     134  require ldap-group CN=Trac Users,CN=Users,DC=company,DC=com
     135</Location>
     136}}}
     137
     138Note 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.
     139
     140Note 2: Active Directory requires an authenticating user/password to access records (AuthLDAPBindDN and AuthLDAPBindPassword).
     141
     142Note 3: The directive "require ldap-group ..."  specifies an AD group whose members are allowed access.
     143
     144
     145
     146=== Setting the !PythonPath ===
     147
    34148If 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:
    35149{{{
     150#!xml
    36151<Location /projects/myproject>
    37152  ...
     
    41156}}}
    42157
     158Be careful about using the !PythonPath directive, and ''not'' `SetEnv PYTHONPATH`, as the latter won't work.
    43159
    44160== Setting up multiple projects ==
    45161
    46 The Trac mod_python handler handler supports a configuration option similar to Subversion's `SvnParentPath`, called `TracEnvParentDir`:
    47 {{{
     162The Trac mod_python handler supports a configuration option similar to Subversion's `SvnParentPath`, called `TracEnvParentDir`:
     163{{{
     164#!xml
    48165<Location /projects>
    49166  SetHandler mod_python
     167  PythonInterpreter main_interpreter
    50168  PythonHandler trac.web.modpython_frontend
    51169  PythonOption TracEnvParentDir /var/trac
     
    54172}}}
    55173
    56 When you request the `/projects` URL, you will get a listing of all subdirectories of the directory you set as `TracEnvParentDir`. Selecting any project in the list will bring you to the corresponding Trac environment.
     174When you request the `/projects` URL, you will get a listing of all subdirectories of the directory you set as `TracEnvParentDir` that look like Trac environment directories. Selecting any project in the list will bring you to the corresponding Trac environment.
    57175
    58176If you don't want to have the subdirectory listing as your projects home page you can use a
    59177{{{
     178#!xml
    60179<LocationMatch "/.+/">
    61180}}}
     
    65184You can also use the same authentication realm for all of the projects using a `<LocationMatch>` directive:
    66185{{{
    67 <LocationMatch "/[^/]+/login">
     186#!xml
     187<LocationMatch "/projects/[^/]+/login">
    68188  AuthType Basic
    69189  AuthName "Trac"
    70   AuthUserFile /var/trac/.htaccess
     190  AuthUserFile /var/trac/.htpasswd
    71191  Require valid-user
    72192</LocationMatch>
     
    79199
    80200{{{
     201#!xml
    81202<VirtualHost * >
    82     DocumentRoot /var/trac/myproject
     203    DocumentRoot /var/www/myproject
    83204    ServerName trac.mycompany.com
    84     <Directory />
     205    <Location />
    85206        SetHandler mod_python
     207        PythonInterpreter main_interpreter
    86208        PythonHandler trac.web.modpython_frontend
    87209        PythonOption TracEnv /var/trac/myproject
    88210        PythonOption TracUriRoot /
    89     </Directory>
     211    </Location>
    90212    <Location /login>
    91213        AuthType Basic
    92214        AuthName "MyCompany Trac Server"
    93         AuthUserFile /var/trac/myproject/.htusers
     215        AuthUserFile /var/trac/myproject/.htpasswd
    94216        Require valid-user
    95217    </Location>
     
    97219}}}
    98220
     221if you have issues with login try using `<LocationMatch>` instead of `<Location>`
     222
     223For a virtual host that supports multiple projects replace "`TracEnv`" /var/trac/myproject with "`TracEnvParentDir`" /var/trac/
     224
     225Note: !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".
     226
    99227== Troubleshooting ==
    100228
     229In general, if you get server error pages, you can either check the Apache error log, or enable the `PythonDebug` option:
     230{{{
     231#!xml
     232<Location /projects/myproject>
     233  ...
     234  PythonDebug on
     235</Location>
     236}}}
     237
     238For multiple projects, try restarting the server as well.
     239
     240=== Expat-related segmentation faults === #expat
     241
     242This problem will most certainly hit you on Unix when using Python 2.4.
     243In Python 2.4, some version of Expat (an XML parser library written in C) is used,
     244and if Apache is using another version, this results in segmentation faults.
     245As Trac 0.11 is using Genshi, which will indirectly use Expat, that problem
     246can now hit you even if everything was working fine before with Trac 0.10.
     247
     248See Graham Dumpleton's detailed [http://www.dscpl.com.au/wiki/ModPython/Articles/ExpatCausingApacheCrash explanation and workarounds] for the issue.
     249
    101250=== Form submission problems ===
    102251
    103252If you're experiencing problems submitting some of the forms in Trac (a common problem is that you get redirected to the start page after submission), check whether your {{{DocumentRoot}}} contains a folder or file with the same path that you mapped the mod_python handler to. For some reason, mod_python gets confused when it is mapped to a location that also matches a static resource.
    104253
     254=== Problem with virtual host configuration ===
     255
     256If the <Location /> directive is used, setting the `DocumentRoot` may result in a ''403 (Forbidden)'' error. Either remove the `DocumentRoot` directive, or make sure that accessing the directory it points is allowed (in a corresponding `<Directory>` block).
     257
     258Using <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.
     259
    105260=== Using .htaccess ===
    106261
     
    110265
    111266=== Win32 Issues ===
    112 
    113 If you run trac with mod_python (3.1.3 or 3.1.4) on Windows,
    114 uploading attachments will '''not''' work.
    115 This is a known problem which we can't solve cleanly at the Trac level.
    116 
    117 However, there is a workaround for this at the mod_python level,
    118 which is to apply the following patch [http://projects.edgewall.com/trac/attachment/ticket/554/util_py.patch attachment:ticket:554:util_py.patch]
    119 to the (Lib/site-packages)/modpython/util.py file.
    120 
    121 If you don't have the `patch` command, that file can be replaced with the [http://svn.apache.org/viewcvs.cgi/httpd/mod_python/trunk/lib/python/mod_python/util.py?rev=103562&view=markup  fixed util.py] (fix which, although done prior to the 3.1.4 release, is ''not''
    122 present in 3.1.4).
     267If 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.
     268
    123269
    124270=== OS X issues ===
    125271
    126272When 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].
     273
     274=== SELinux issues ===
     275
     276If Trac reports something like: ''Cannot get shared lock on db.lock''
     277The security context on the repository may need to be set:
     278
     279{{{
     280chcon -R -h -t httpd_sys_content_t PATH_TO_REPOSITORY
     281}}}
     282
     283See also [[http://subversion.tigris.org/faq.html#reposperms]]
     284
     285=== FreeBSD issues ===
     286Pay 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.
     287
     288If 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.
     289The best option [[http://modpython.org/pipermail/mod_python/2006-September/021983.html seems to be]] adding to /usr/local/apache2/bin/ennvars the line
     290
     291{{{
     292export LD_PRELOAD=/usr/lib/libc_r.so
     293}}}
     294
     295=== Subversion issues ===
     296
     297If you get the following Trac Error `Unsupported version control system "svn"` only under mod_python, though it works well on the command-line and even with TracStandalone, chances are that you forgot to add the path to the Python bindings with the [TracModPython#ConfiguringPythonPath PythonPath] directive. (The better way is to add a link to the bindings in the Python `site-packages` directory, or create a `.pth` file in that directory.)
     298
     299If 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`).
     300
     301You 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:
     302{{{
     303PythonInterpreter main_interpreter
     304}}}
     305This 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.
     306
     307=== Page layout issues ===
     308
     309If 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:
     310{{{
     311#!xml
     312Alias /myproject/css "/usr/share/trac/htdocs/css"
     313<Location /myproject/css>
     314    SetHandler None
     315</Location>
     316}}}
     317
     318Note: For the above configuration to have any effect it must be put after the configuration of your project root location, i.e. {{{<Location /myproject />}}}.
     319
     320=== HTTPS issues ===
     321
     322If 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:
     323{{{
     324#!xml
     325<VirtualHost * >
     326    DocumentRoot /var/www/myproject
     327    ServerName trac.mycompany.com
     328    SetEnv HTTPS 1
     329    ....
     330</VirtualHost>
     331}}}
     332
     333=== Fedora 7 Issues ===
     334Make sure you install the 'python-sqlite2' package as it seems to be required for TracModPython but not for tracd
     335
     336
     337=== Segmentation fault with php5-mhash or other php5 modules ===
     338You 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]]
     339
     340Some 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]]
    127341
    128342----