Changes between Version 1 and Version 2 of TracModPython


Ignore:
Timestamp:
Mar 27, 2008, 7:31:47 AM (12 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
     52=== Configuring Authentication ===
     53
     54Creating password files and configuring authentication works similar to the process for [wiki:TracCgi#AddingAuthentication CGI]:
     55{{{
     56#!xml
     57<Location /projects/myproject/login>
    2758  AuthType Basic
    2859  AuthName "myproject"
    29   AuthUserFile /var/trac/myproject/.htaccess
     60  AuthUserFile /var/trac/myproject/.htpasswd
    3061  Require valid-user
    3162</Location>
    3263}}}
    3364
     65Configuration for mod_ldap authentication in Apache is a bit tricky (httpd 2.2.x and OpenLDAP: slapd 2.3.19)
     66
     671. You need to load the following modules in Apache httpd.conf
     68{{{
     69LoadModule ldap_module modules/mod_ldap.so
     70LoadModule authnz_ldap_module modules/mod_authnz_ldap.so
     71}}}
     72
     732. 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
     95Or 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
     120Note 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
     122Note 2: Active Directory requires an authenticating user/password to access records (AuthLDAPBindDN and AuthLDAPBindPassword).
     123
     124Note 3: The directive "require ldap-group ..."  specifies an AD group whose members are allowed access.
     125
     126
     127
     128=== Setting the !PythonPath ===
     129
    34130If 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:
    35131{{{
     132#!xml
    36133<Location /projects/myproject>
    37134  ...
     
    41138}}}
    42139
     140Be careful about using the !PythonPath directive, and ''not'' `SetEnv PYTHONPATH`, as the latter won't work.
    43141
    44142== Setting up multiple projects ==
    45143
    46 The Trac mod_python handler handler supports a configuration option similar to Subversion's `SvnParentPath`, called `TracEnvParentDir`:
    47 {{{
     144The Trac mod_python handler supports a configuration option similar to Subversion's `SvnParentPath`, called `TracEnvParentDir`:
     145{{{
     146#!xml
    48147<Location /projects>
    49148  SetHandler mod_python
     149  PythonInterpreter main_interpreter
    50150  PythonHandler trac.web.modpython_frontend
    51151  PythonOption TracEnvParentDir /var/trac
     
    54154}}}
    55155
    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.
     156When 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.
    57157
    58158If you don't want to have the subdirectory listing as your projects home page you can use a
    59159{{{
     160#!xml
    60161<LocationMatch "/.+/">
    61162}}}
     
    65166You can also use the same authentication realm for all of the projects using a `<LocationMatch>` directive:
    66167{{{
    67 <LocationMatch "/[^/]+/login">
     168#!xml
     169<LocationMatch "/projects/[^/]+/login">
    68170  AuthType Basic
    69171  AuthName "Trac"
    70   AuthUserFile /var/trac/.htaccess
     172  AuthUserFile /var/trac/.htpasswd
    71173  Require valid-user
    72174</LocationMatch>
     
    79181
    80182{{{
     183#!xml
    81184<VirtualHost * >
    82     DocumentRoot /var/trac/myproject
     185    DocumentRoot /var/www/myproject
    83186    ServerName trac.mycompany.com
    84     <Directory />
     187    <Location />
    85188        SetHandler mod_python
     189        PythonInterpreter main_interpreter
    86190        PythonHandler trac.web.modpython_frontend
    87191        PythonOption TracEnv /var/trac/myproject
    88192        PythonOption TracUriRoot /
    89     </Directory>
     193    </Location>
    90194    <Location /login>
    91195        AuthType Basic
    92196        AuthName "MyCompany Trac Server"
    93         AuthUserFile /var/trac/myproject/.htusers
     197        AuthUserFile /var/trac/myproject/.htpasswd
    94198        Require valid-user
    95199    </Location>
     
    97201}}}
    98202
     203if you have issues with login try using `<LocationMatch>` instead of `<Location>`
     204
     205For a virtual host that supports multiple projects replace "`TracEnv`" /var/trac/myproject with "`TracEnvParentDir`" /var/trac/
     206
    99207== Troubleshooting ==
    100208
     209In general, if you get server error pages, you can either check the Apache error log, or enable the `PythonDebug` option:
     210{{{
     211#!xml
     212<Location /projects/myproject>
     213  ...
     214  PythonDebug on
     215</Location>
     216}}}
     217
     218For multiple projects, try restarting the server as well.
     219
     220=== Expat-related segmentation faults === #expat
     221
     222This problem will most certainly hit you on Unix when using python 2.4.
     223In Python 2.4, some version of Expat (an XML parser library written in C) is used,
     224and if Apache is using another version, this results in segmentation faults.
     225As Trac 0.11 is using Genshi, which will use indirectly use Expat, that problem
     226can now hit you even if everything was working fine before with Trac 0.10.
     227
     228See Graham Dumpleton's detailed [http://www.dscpl.com.au/wiki/ModPython/Articles/ExpatCausingApacheCrash explanation and workarounds] for the issue.
     229
    101230=== Form submission problems ===
    102231
    103232If 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.
    104233
     234=== Problem with virtual host configuration ===
     235
     236If 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).
     237
     238Using <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.
     239
    105240=== Using .htaccess ===
    106241
     
    110245
    111246=== 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).
     247If 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.
     248
    123249
    124250=== OS X issues ===
    125251
    126252When 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].
     253
     254=== SELinux issues ===
     255
     256If Trac reports something like: ''Cannot get shared lock on db.lock''
     257The security context on the repository may need to be set:
     258
     259{{{
     260chcon -R -h -t httpd_sys_content_t PATH_TO_REPOSITORY
     261}}}
     262
     263See also [[http://subversion.tigris.org/faq.html#reposperms]]
     264
     265=== FreeBSD issues ===
     266Pay 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.
     267
     268If 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.
     269The best option [[http://modpython.org/pipermail/mod_python/2006-September/021983.html seems to be]] adding to /usr/local/apache2/bin/ennvars the line
     270
     271{{{
     272export LD_PRELOAD=/usr/lib/libc_r.so
     273}}}
     274
     275=== Subversion issues ===
     276
     277If 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.)
     278
     279If 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`).
     280
     281You 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:
     282{{{
     283PythonInterpreter main_interpreter
     284}}}
     285This 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.
     286
     287=== Page layout issues ===
     288
     289If 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:
     290{{{
     291#!xml
     292Alias /myproject/css "/usr/share/trac/htdocs/css"
     293<Location /myproject/css>
     294    SetHandler None
     295</Location>
     296}}}
     297
     298Note: For the above configuration to have any effect it must be put after the configuration of your project root location, i.e. {{{<Location /myproject />}}}.
     299
     300=== HTTPS issues ===
     301
     302If 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:
     303{{{
     304#!xml
     305<VirtualHost * >
     306    DocumentRoot /var/www/myproject
     307    ServerName trac.mycompany.com
     308    SetEnv HTTPS 1
     309    ....
     310</VirtualHost>
     311}}}
     312
     313=== Fedora 7 Issues ===
     314Make sure you install the 'python-sqlite2' package as it seems to be required for TracModPython but not for tracd
     315
     316
     317=== Segmentation fault with php5-mhash or other php5 modules ===
     318You 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
     320Some 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]]
    127321
    128322----