Changes between Version 1 and Version 2 of TracModPython
- Timestamp:
- 01/23/07 01:33:03 (18 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracModPython
v1 v2 1 1 = Trac and mod_python = 2 [[TracGuideToc]] 2 3 3 Trac 0.7.1 and later 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 tracd/mod_proxy.4 Trac 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. 4 5 5 6 == Simple configuration == 6 7 7 Here's a typical Trac CGI/Apache setup: 8 If you just installed mod_python, you may have to add a line to load the module in the Apache configuration: 9 {{{ 10 LoadModule python_module modules/mod_python.so 11 }}} 8 12 13 ''Note: The exact path to the module depends on how the HTTPD installation is laid out.'' 14 15 You 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. 9 16 {{{ 10 ScriptAlias /projects/myproject /path/to/python/share/trac/cgi-bin/trac.cgi 11 <Location /projects/myproject> 12 SetEnv TRAC_ENV /var/trac/myproject17 <Location /mpinfo> 18 SetHandler mod_python 19 PythonHandler mod_python.testhandler 13 20 </Location> 14 21 }}} 15 22 16 The equivalent mod_python setup is: 17 23 A simple setup of Trac on mod_python looks like this: 18 24 {{{ 19 25 <Location /projects/myproject> 20 26 SetHandler mod_python 21 PythonHandler trac.ModPythonHandler 22 PythonOption TracUriRoot "/projects/myproject" 27 PythonHandler trac.web.modpython_frontend 23 28 PythonOption TracEnv /var/trac/myproject 29 PythonOption TracUriRoot /projects/myproject 24 30 </Location> 25 31 }}} 26 32 27 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, add the ''TracUriRoot'' option. 33 The 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. 34 35 === Configuring Authentication === 36 37 Configuring authentication works just like for [wiki:TracCgi#AddingAuthentication CGI]: 38 {{{ 39 <Location "/projects/myproject/login"> 40 AuthType Basic 41 AuthName "myproject" 42 AuthUserFile /var/trac/myproject/.htpasswd 43 Require valid-user 44 </Location> 45 }}} 46 47 === Setting the !PythonPath === 48 49 If 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: 50 {{{ 51 <Location /projects/myproject> 52 ... 53 PythonPath "sys.path + ['/path/to/trac']" 54 ... 55 </Location> 56 }}} 57 58 Be careful about using the !PythonPath directive, and ''not'' `SetEnv PYTHONPATH`, as the latter won't work. 28 59 29 60 == Setting up multiple projects == 30 61 31 The Trac mod_python handler handler supports a configuration option similar to Subversion's {{{SvnParentPath}}}, called {{{TracEnvParentDir}}}: 32 62 The Trac mod_python handler supports a configuration option similar to Subversion's `SvnParentPath`, called `TracEnvParentDir`: 33 63 {{{ 34 64 <Location /projects> 35 65 SetHandler mod_python 36 PythonHandler trac.ModPythonHandler 66 PythonHandler trac.web.modpython_frontend 67 PythonOption TracEnvParentDir /var/trac 37 68 PythonOption TracUriRoot /projects 38 PythonOption TracEnvParentDir "/var/trac" 39 </LocationMatch> 69 </Location> 40 70 }}} 41 71 42 When you request the {{{/projects}}} URL, you will get a (currently very simple) listing of all subdirectories of the directory you set as {{{TracEnvParentDir}}}. Selecting any project in the list will bring you to the corresponding Trac instance. You should make sure that the configured directory only contains Trac environment directories that match the currently installed Trac version, because that is not checked prior the the generation of the project list.72 When 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. 43 73 74 If you don't want to have the subdirectory listing as your projects home page you can use a 75 {{{ 76 <LocationMatch "/.+/"> 77 }}} 44 78 45 === Adding authentication === 79 This will instruct Apache to use mod_python for all locations different from root while having the possibility of placing a custom home page for root in your !DocumentRoot folder. 46 80 47 Adding authentication is straightforward in both cases. For example: 48 81 You can also use the same authentication realm for all of the projects using a `<LocationMatch>` directive: 49 82 {{{ 50 <LocationMatch /projects/[[:alnum:]]+/login>83 <LocationMatch "/projects/[^/]+/login"> 51 84 AuthType Basic 52 85 AuthName "Trac" 53 AuthUserFile /var/ www/passwd86 AuthUserFile /var/trac/.htpasswd 54 87 Require valid-user 55 88 </LocationMatch> 56 89 }}} 57 90 91 == Virtual Host Configuration == 92 93 Below is the sample configuration required to set up your trac as a virtual server (i.e. when you access it at the URLs like 94 !http://trac.mycompany.com): 95 96 {{{ 97 <VirtualHost * > 98 DocumentRoot /var/trac/myproject 99 ServerName trac.mycompany.com 100 <Location /> 101 SetHandler mod_python 102 PythonHandler trac.web.modpython_frontend 103 PythonOption TracEnv /var/trac/myproject 104 PythonOption TracUriRoot / 105 </Location> 106 <Location /login> 107 AuthType Basic 108 AuthName "MyCompany Trac Server" 109 AuthUserFile /var/trac/myproject/.htpasswd 110 Require valid-user 111 </Location> 112 </VirtualHost> 113 }}} 114 115 For a virtual host that supports multiple projects replace "`TracEnv`" /var/trac/myproject with "`TracEnvParentDir`" /var/trac/ 116 117 == Troubleshooting == 118 119 In 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 }}} 126 127 === Form submission problems === 128 129 If 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 133 If 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 135 Using <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. 136 137 === Using .htaccess === 138 139 Although it may seem trivial to rewrite the above configuration as a directory in your document root with a `.htaccess` file, this does not work. Apache will append a "/" to any Trac URLs, which interferes with its correct operation. 140 141 It may be possible to work around this with mod_rewrite, but I failed to get this working. In all, it is more hassle than it is worth. Stick to the provided instructions. :) 142 58 143 === Win32 Issues === 144 If 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. 59 145 60 If you run trac with mod_python on Windows, attachments will not work. 146 === OS X issues === 61 147 62 There is a (simple) workaround for this which is to apply the patch attached to 63 ticket [http://projects.edgewall.com/trac/ticket/554 #554]. 148 When 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]. 64 149 150 === SELinux issues === 151 152 If Trac reports something like: ''Cannot get shared lock on db.lock'' 153 The security context on the repository may need to be set: 154 155 {{{ 156 chcon -R -h -t httpd_sys_content_t PATH_TO_REPOSITORY 157 }}} 158 159 See also [[http://subversion.tigris.org/faq.html#reposperms]] 160 161 === FreeBSD issues === 162 Pay 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 166 If 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 168 If 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`). 65 169 66 170 ---- 67 See also TracGuide, TracInstall, Trac MultipleProjects171 See also TracGuide, TracInstall, TracCgi, TracFastCgi