| 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. |
| 16 | | {{{ |
| | 18 | ''Note: The exact path to the module depends on how the HTTPD installation is laid out.'' |
| | 19 | |
| | 20 | On Debian using apt-get: |
| | 21 | {{{ |
| | 22 | apt-get install libapache2-mod-python libapache2-mod-python-doc |
| | 23 | }}} |
| | 24 | Still on Debian, after you have installed mod_python, you must enable the modules in apache2, equivalent to the above Load Module directive: |
| | 25 | {{{ |
| | 26 | a2enmod python |
| | 27 | }}} |
| | 28 | On Fedora use, using yum: |
| | 29 | {{{ |
| | 30 | yum install mod_python |
| | 31 | }}} |
| | 32 | 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. Note: mod_python.testhandler is only available in mod_python 3.2+. |
| | 33 | {{{ |
| | 34 | #!xml |
| 30 | | </Location> |
| 31 | | }}} |
| 32 | | |
| 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 === |
| | 53 | Order allow,deny |
| | 54 | Allow from all |
| | 55 | </Location> |
| | 56 | }}} |
| | 57 | |
| | 58 | The 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. |
| | 59 | |
| | 60 | The options available are: |
| | 61 | {{{ |
| | 62 | # For a single project |
| | 63 | PythonOption TracEnv /var/trac/myproject |
| | 64 | |
| | 65 | # For multiple projects |
| | 66 | PythonOption TracEnvParentDir /var/trac/myprojects |
| | 67 | |
| | 68 | # For the index of multiple projects |
| | 69 | PythonOption TracEnvIndexTemplate /srv/www/htdocs/trac/project_list_template.html |
| | 70 | |
| | 71 | # A space delimitted list, with a "," between key and value pairs. |
| | 72 | PythonOption TracTemplateVars key1,val1 key2,val2 |
| | 73 | |
| | 74 | # Useful to get the date in the wanted order |
| | 75 | PythonOption TracLocale en_GB.UTF8 |
| | 76 | |
| | 77 | # See description above |
| | 78 | PythonOption TracUriRoot /projects/myproject |
| | 79 | }}} |
| | 80 | |
| | 81 | === Python Egg Cache |
| | 82 | |
| | 83 | Compressed python eggs like Genshi are normally extracted into a directory named `.python-eggs` in the users home directory. Since apache's home usually is not writable, an alternate egg cache directory can be specified like this: |
| | 84 | {{{ |
| | 85 | PythonOption PYTHON_EGG_CACHE /var/trac/myprojects/egg-cache |
| | 86 | }}} |
| | 87 | |
| | 88 | or you can uncompress the Genshi egg to resolve problems extracting from it. |
| | 89 | |
| | 90 | === Configuring Authentication |
| | 91 | |
| | 92 | See corresponding section in the [wiki:TracModWSGI#ConfiguringAuthentication] page. |
| | 93 | |
| | 94 | == Advanced Configuration |
| | 95 | |
| | 96 | === Setting the Python Egg Cache |
| | 97 | |
| | 98 | If the Egg Cache isn't writeable by your Web server, you'll either have to change the permissions, or point Python to a location where Apache can write. This can manifest itself as a ''500 internal server error'' and/or a complaint in the syslog. |
| | 99 | |
| | 100 | {{{ |
| | 101 | #!xml |
| | 102 | <Location /projects/myproject> |
| | 103 | ... |
| | 104 | PythonOption PYTHON_EGG_CACHE /tmp |
| | 105 | ... |
| | 106 | </Location> |
| | 107 | }}} |
| | 108 | |
| | 109 | === Setting the !PythonPath |
| 127 | | === Form submission problems === |
| | 204 | For multiple projects, try restarting the server as well. |
| | 205 | |
| | 206 | === Login Not Working |
| | 207 | |
| | 208 | If you've used `<Location />` directive, it will override any other directives, as well as `<Location /login>`. |
| | 209 | The workaround is to use negation expression as follows (for multi project setups): |
| | 210 | {{{ |
| | 211 | #!xml |
| | 212 | #this one for other pages |
| | 213 | <Location ~ "/*(?!login)"> |
| | 214 | SetHandler mod_python |
| | 215 | PythonHandler trac.web.modpython_frontend |
| | 216 | PythonOption TracEnvParentDir /projects |
| | 217 | PythonOption TracUriRoot / |
| | 218 | |
| | 219 | </Location> |
| | 220 | #this one for login page |
| | 221 | <Location ~ "/[^/]+/login"> |
| | 222 | SetHandler mod_python |
| | 223 | PythonHandler trac.web.modpython_frontend |
| | 224 | PythonOption TracEnvParentDir /projects |
| | 225 | PythonOption TracUriRoot / |
| | 226 | |
| | 227 | #remove these if you don't want to force SSL |
| | 228 | RewriteEngine On |
| | 229 | RewriteCond %{HTTPS} off |
| | 230 | RewriteRule (.*) https://%{HTTP_HOST}%{REQUEST_URI} |
| | 231 | |
| | 232 | AuthType Basic |
| | 233 | AuthName "Trac" |
| | 234 | AuthUserFile /projects/.htpasswd |
| | 235 | Require valid-user |
| | 236 | </Location> |
| | 237 | }}} |
| | 238 | |
| | 239 | === Expat-related segmentation faults === #expat |
| | 240 | |
| | 241 | This problem will most certainly hit you on Unix when using Python 2.4. |
| | 242 | In Python 2.4, some version of [http://expat.sourceforge.net/ Expat] (an XML parser library written in C) is used and if Apache is using another version, this results in segmentation faults. |
| | 243 | As Trac 0.11 is using Genshi, which will indirectly use Expat, that problem can now hit you even if everything was working fine before with Trac 0.10. This problem has not been reported for Python 2.5+, so best to upgrade. |
| | 244 | |
| | 245 | === Form submission problems |
| 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 === |
| | 249 | === Problem with virtual host configuration |
| | 250 | |
| | 251 | 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. |
| | 252 | |
| | 253 | Using <Location /> together with `SetHandler` resulted in having everything handled by mod_python, which leads to not being able to download any CSS or images/icons. Use <Location /trac> `SetHandler None` </Location> to circumvent the problem, though this may not be the most elegant solution. |
| | 254 | |
| | 255 | === Problem with zipped egg |
| | 256 | |
| | 257 | It's possible that your version of mod_python will not import modules from zipped eggs. If you encounter an `ImportError: No module named trac` in your Apache logs but you think everything is where it should be, this might be your problem. Look in your site-packages directory; if the Trac module appears as a ''file'' rather than a ''directory'', then this might be your problem. To rectify, try installing Trac using the `--always-unzip` option, like this: |
| | 258 | |
| | 259 | {{{ |
| | 260 | easy_install --always-unzip Trac-0.12b1.zip |
| | 261 | }}} |
| | 262 | |
| | 263 | === Using .htaccess |
| 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 | | |
| 143 | | === Win32 Issues === |
| | 267 | 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. |
| | 268 | |
| | 269 | This also works out-of-box, with following trivial config: |
| | 270 | {{{#!xml |
| | 271 | SetHandler mod_python |
| | 272 | PythonInterpreter main_interpreter |
| | 273 | PythonHandler trac.web.modpython_frontend |
| | 274 | PythonOption TracEnv /system/path/to/this/directory |
| | 275 | PythonOption TracUriRoot /path/on/apache |
| | 276 | |
| | 277 | AuthType Basic |
| | 278 | AuthName "ProjectName" |
| | 279 | AuthUserFile /path/to/.htpasswd |
| | 280 | Require valid-user |
| | 281 | }}} |
| | 282 | |
| | 283 | The `TracUriRoot` is obviously the path you need to enter to the browser to get to Trac, eg domain.tld/projects/trac. |
| | 284 | |
| | 285 | === Additional .htaccess help |
| | 286 | |
| | 287 | If you are using the .htaccess method you may have additional problems if your trac directory is inheriting .htaccess directives from another. This may also help to add to your .htaccess file: |
| | 288 | |
| | 289 | {{{ |
| | 290 | <IfModule mod_rewrite.c> |
| | 291 | RewriteEngine Off |
| | 292 | </IfModule> |
| | 293 | }}} |
| | 294 | |
| | 295 | === Platform specific issues |
| | 296 | ==== Win32 Issues |
| | 297 | |
| 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`). |
| | 313 | See also [http://subversion.apache.org/faq.html#reposperms How do I set repository permissions correctly?] |
| | 314 | |
| | 315 | ==== FreeBSD issues |
| | 316 | |
| | 317 | The FreeBSD ports have both the new and old versions of mod_python and SQLite, 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. |
| | 318 | |
| | 319 | If you compiled and installed apache2, threads are not automatically supported on FreeBSD. You could force thread support when running `./configure` for Apache, using `--enable-threads`, but this isn´t recommended. |
| | 320 | The best option [http://modpython.org/pipermail/mod_python/2006-September/021983.html seems to be] adding to /usr/local/apache2/bin/ennvars the line: |
| | 321 | |
| | 322 | {{{ |
| | 323 | export LD_PRELOAD=/usr/lib/libc_r.so |
| | 324 | }}} |
| | 325 | |
| | 326 | ==== Fedora 7 Issues |
| | 327 | |
| | 328 | Make sure you install the 'python-sqlite2' package as it seems to be required for TracModPython but not for tracd. |
| | 329 | |
| | 330 | === Subversion issues |
| | 331 | |
| | 332 | 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. |
| | 333 | |
| | 334 | If this is not the case, it's possible that you're using Subversion libraries that are binary incompatible with the Apache ones and 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`). |
| | 335 | |
| | 336 | You 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. Version 3.2.8 ''should'' work, though it's probably better to use the workaround described in [trac:#3371 #3371], in order to force the use of the main interpreter: |
| | 337 | {{{ |
| | 338 | PythonInterpreter main_interpreter |
| | 339 | }}} |
| | 340 | |
| | 341 | This is anyway the recommended workaround for other well-known issues seen when using the Python bindings for Subversion within mod_python ([trac:#2611 #2611], [trac:#3455 #3455]). See in particular Graham Dumpleton's comment in [trac:comment:9:ticket:3455 #3455] explaining the issue. |
| | 342 | |
| | 343 | === Page layout issues |
| | 344 | |
| | 345 | If 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: |
| | 346 | {{{ |
| | 347 | #!xml |
| | 348 | Alias /myproject/css "/usr/share/trac/htdocs/css" |
| | 349 | <Location /myproject/css> |
| | 350 | SetHandler None |
| | 351 | </Location> |
| | 352 | }}} |
| | 353 | |
| | 354 | Note: For the above configuration to have any effect it must be put after the configuration of your project root location, i.e. {{{<Location /myproject />}}}. |
| | 355 | |
| | 356 | Also, setting `PythonOptimize On` seems to mess up the page headers and footers, in addition to hiding the documentation for macros and plugins (see #Trac8956). Considering how little effect the option has, leave it `Off`. |
| | 357 | |
| | 358 | === HTTPS issues |
| | 359 | |
| | 360 | If 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: |
| | 361 | {{{ |
| | 362 | #!xml |
| | 363 | <VirtualHost * > |
| | 364 | DocumentRoot /var/www/myproject |
| | 365 | ServerName trac.mycompany.com |
| | 366 | SetEnv HTTPS 1 |
| | 367 | .... |
| | 368 | </VirtualHost> |
| | 369 | }}} |
| | 370 | |
| | 371 | === Segmentation fault with php5-mhash or other php5 modules |
| | 372 | |
| | 373 | You 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 [http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=411487 Debian bug report]. |
| | 374 | |
| | 375 | Some people also have troubles when using php5 compiled with its own 3rd party libraries instead of system libraries. Check [http://www.djangoproject.com/documentation/modpython/#if-you-get-a-segmentation-fault Django segmentation fault]. |
