Changes between Version 2 and Version 3 of TracModPython


Ignore:
Timestamp:
Apr 22, 2008, 10:08:45 AM (17 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracModPython

    v2 v3  
    11= Trac and mod_python =
     2[[TracGuideToc]]
    23
    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.
     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.
    45
    56== Simple configuration ==
    … …  
    89{{{
    910LoadModule python_module modules/mod_python.so
     11}}}
     12
     13 ''Note: The exact path to the module depends on how the HTTPD installation is laid out.''
     14
     15You 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.
     16{{{
     17<Location /mpinfo>
     18   SetHandler mod_python
     19   PythonHandler mod_python.testhandler
     20</Location>
    1021}}}
    1122
    … …  
    2031}}}
    2132
    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.
     33The option '''`TracUriRoot`''' may or may not be necessary in your setup. Try your configuration with out it, and if the URLs produced by Trac look wrong or if Trac does not seem to recognize the URLs correctly, add the '''`TracUriRoot`''' option.  You will notice that the `Location` and '''`TracUriRoot`''' have the same path.
    2334
    24 Configuring authentication works the same as for [wiki:TracCgi#AddingAuthentication CGI]:
     35=== Configuring Authentication ===
     36
     37Configuring authentication works just like for [wiki:TracCgi#AddingAuthentication CGI]:
    2538{{{
    2639<Location "/projects/myproject/login">
    2740  AuthType Basic
    2841  AuthName "myproject"
    29   AuthUserFile /var/trac/myproject/.htaccess
     42  AuthUserFile /var/trac/myproject/.htpasswd
    3043  Require valid-user
    3144</Location>
    3245}}}
     46
     47=== Setting the !PythonPath ===
    3348
    3449If 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:
    … …  
    4156}}}
    4257
     58Be careful about using the !PythonPath directive, and ''not'' `SetEnv PYTHONPATH`, as the latter won't work.
    4359
    4460== Setting up multiple projects ==
    4561
    46 The Trac mod_python handler handler supports a configuration option similar to Subversion's `SvnParentPath`, called `TracEnvParentDir`:
     62The Trac mod_python handler supports a configuration option similar to Subversion's `SvnParentPath`, called `TracEnvParentDir`:
    4763{{{
    4864<Location /projects>
    … …  
    5470}}}
    5571
    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.
     72When 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.
    5773
    5874If you don't want to have the subdirectory listing as your projects home page you can use a
    … …  
    6581You can also use the same authentication realm for all of the projects using a `<LocationMatch>` directive:
    6682{{{
    67 <LocationMatch "/[^/]+/login">
     83<LocationMatch "/projects/[^/]+/login">
    6884  AuthType Basic
    6985  AuthName "Trac"
    70   AuthUserFile /var/trac/.htaccess
     86  AuthUserFile /var/trac/.htpasswd
    7187  Require valid-user
    7288</LocationMatch>
    … …  
    8298    DocumentRoot /var/trac/myproject
    8399    ServerName trac.mycompany.com
    84     <Directory />
     100    <Location />
    85101        SetHandler mod_python
    86102        PythonHandler trac.web.modpython_frontend
    87103        PythonOption TracEnv /var/trac/myproject
    88104        PythonOption TracUriRoot /
    89     </Directory>
     105    </Location>
    90106    <Location /login>
    91107        AuthType Basic
    92108        AuthName "MyCompany Trac Server"
    93         AuthUserFile /var/trac/myproject/.htusers
     109        AuthUserFile /var/trac/myproject/.htpasswd
    94110        Require valid-user
    95111    </Location>
    … …  
    97113}}}
    98114
     115For a virtual host that supports multiple projects replace "`TracEnv`" /var/trac/myproject with "`TracEnvParentDir`" /var/trac/
     116
    99117== Troubleshooting ==
     118
     119In general, if you get server error pages, you can either check the Apache error log, or enable the `PythonDebug` option:
     120{{{
     121<Location /projects/myproject>
     122  ...
     123  PythonDebug on
     124</Location>
     125}}}
    100126
    101127=== Form submission problems ===
    102128
    103129If 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.
     130
     131=== Problem with virtual host configuration ===
     132
     133If 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).
     134
     135Using <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.
    104136
    105137=== Using .htaccess ===
    … …  
    110142
    111143=== 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).
     144If 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.
    123145
    124146=== OS X issues ===
    … …  
    126148When 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].
    127149
     150=== SELinux issues ===
     151
     152If Trac reports something like: ''Cannot get shared lock on db.lock''
     153The security context on the repository may need to be set:
     154
     155{{{
     156chcon -R -h -t httpd_sys_content_t PATH_TO_REPOSITORY
     157}}}
     158
     159See also [[http://subversion.tigris.org/faq.html#reposperms]]
     160
     161=== FreeBSD issues ===
     162Pay 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.
     163
     164=== Subversion issues ===
     165
     166If 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.)
     167
     168If 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`).
     169
    128170----
    129171See also TracGuide, TracInstall, TracCgi, TracFastCgi