| 54 | | SetHandler mod_python |
| 55 | | PythonInterpreter main_interpreter |
| 56 | | PythonHandler trac.web.modpython_frontend |
| 57 | | PythonOption TracEnv /var/trac/myproject |
| 58 | | PythonOption TracUriRoot /projects/myproject |
| 59 | | Order allow,deny |
| 60 | | Allow from all |
| 61 | | </Location> |
| 62 | | }}} |
| 63 | | |
| 64 | | 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. |
| 65 | | |
| 66 | | The options available are |
| 67 | | {{{ |
| 68 | | # For a single project |
| 69 | | PythonOption TracEnv /var/trac/myproject |
| 70 | | |
| 71 | | # For multiple projects |
| 72 | | PythonOption TracEnvParentDir /var/trac/myprojects |
| 73 | | |
| 74 | | # For the index of multiple projects |
| 75 | | PythonOption TracEnvIndexTemplate /srv/www/htdocs/trac/project_list_template.html |
| 76 | | |
| 77 | | # A space delimitted list, with a "," between key and value pairs. |
| 78 | | PythonOption TracTemplateVars key1,val1 key2,val2 |
| 79 | | |
| 80 | | # Useful to get the date in the wanted order |
| 81 | | PythonOption TracLocale en_GB.UTF8 |
| 82 | | |
| 83 | | # See description above |
| 84 | | PythonOption TracUriRoot /projects/myproject |
| 85 | | }}} |
| 86 | | |
| 87 | | === Python Egg Cache === |
| 88 | | |
| 89 | | 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: |
| 90 | | {{{ |
| | 55 | SetHandler mod_python |
| | 56 | PythonInterpreter main_interpreter |
| | 57 | PythonHandler trac.web.modpython_frontend |
| | 58 | PythonOption TracEnv /var/trac/myproject |
| | 59 | PythonOption TracUriRoot /projects/myproject |
| | 60 | # For Apache 2.2 |
| | 61 | <IfModule !mod_authz_core.c> |
| | 62 | Order allow,deny |
| | 63 | Allow from all |
| | 64 | </IfModule> |
| | 65 | # For Apache 2.4 |
| | 66 | <IfModule mod_authz_core.c> |
| | 67 | Require all granted |
| | 68 | </IfModule> |
| | 69 | </Location> |
| | 70 | }}} |
| | 71 | |
| | 72 | 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. |
| | 73 | |
| | 74 | The options available are: |
| | 75 | {{{#!apache |
| | 76 | # For a single project |
| | 77 | PythonOption TracEnv /var/trac/myproject |
| | 78 | |
| | 79 | # For multiple projects |
| | 80 | PythonOption TracEnvParentDir /var/trac/myprojects |
| | 81 | |
| | 82 | # For the index of multiple projects |
| | 83 | PythonOption TracEnvIndexTemplate /srv/www/htdocs/trac/project_list_template.html |
| | 84 | |
| | 85 | # A space delimitted list, with a "," between key and value pairs. |
| | 86 | PythonOption TracTemplateVars key1,val1 key2,val2 |
| | 87 | |
| | 88 | # Useful to get the date in the wanted order |
| | 89 | PythonOption TracLocale en_GB.UTF8 |
| | 90 | |
| | 91 | # See description above |
| | 92 | PythonOption TracUriRoot /projects/myproject |
| | 93 | }}} |
| | 94 | |
| | 95 | === Python Egg Cache |
| | 96 | |
| | 97 | 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 writeable, an alternate egg cache directory can be specified like this: |
| | 98 | {{{#!apache |
| 193 | | * Try using `<LocationMatch>` instead of `<Location>` |
| 194 | | * <Location /> may, in your server setup, refer to the complete host instead of simple the root of the server. This means that everything (including the login directory referenced below) will be sent to python and authentication does not work (i.e. you get the infamous Authentication information missing error). If this applies to you, try using a sub-directory for trac instead of the root (i.e. /web/ and /web/login instead of / and /login). |
| | 193 | * Try using `<LocationMatch>` instead of `<Location>`. |
| | 194 | * `<Location />` may, in your server setup, refer to the complete host instead of simple the root of the server. This means that everything (including the login directory referenced below) will be sent to Python and authentication does not work, ie you get the infamous Authentication information missing error. If this is the case, try using a sub-directory for Trac instead of the root, ie /web/ and /web/login instead of / and /login. |
| 197 | | For a virtual host that supports multiple projects replace "`TracEnv`" /var/trac/myproject with "`TracEnvParentDir`" /var/trac/ |
| 198 | | |
| 199 | | Note: !DocumentRoot should not point to your Trac project env. As Asmodai wrote on #trac: "suppose there's a webserver bug that allows disclosure of !DocumentRoot they could then leech the entire Trac environment". |
| 200 | | |
| 201 | | == Troubleshooting == |
| 202 | | |
| 203 | | In general, if you get server error pages, you can either check the Apache error log, or enable the `PythonDebug` option: |
| 204 | | {{{ |
| 205 | | #!xml |
| | 197 | For a virtual host that supports multiple projects replace `TracEnv /var/trac/myproject` with `TracEnvParentDir /var/trac`. |
| | 198 | |
| | 199 | '''Note''': !DocumentRoot should not point to your Trac project env. As Asmodai wrote on #trac: "suppose there's a webserver bug that allows disclosure of !DocumentRoot they could then leech the entire Trac environment". |
| | 200 | |
| | 201 | == Troubleshooting |
| | 202 | |
| | 203 | If you get server error pages, you can either check the Apache error log, or enable the `PythonDebug` option: |
| | 204 | {{{#!apache |
| 249 | | In Python 2.4, some version of Expat (an XML parser library written in C) is used, |
| 250 | | and if Apache is using another version, this results in segmentation faults. |
| 251 | | As Trac 0.11 is using Genshi, which will indirectly use Expat, that problem |
| 252 | | can now hit you even if everything was working fine before with Trac 0.10. |
| 253 | | |
| 254 | | See Graham Dumpleton's detailed [http://www.dscpl.com.au/wiki/ModPython/Articles/ExpatCausingApacheCrash explanation and workarounds] for the issue. |
| 255 | | |
| 256 | | === Form submission problems === |
| | 248 | 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. |
| | 249 | 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. |
| | 250 | |
| | 251 | === Form submission problems |
| 260 | | === Problem with virtual host configuration === |
| 261 | | |
| 262 | | 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). |
| 263 | | |
| 264 | | 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. |
| 265 | | |
| 266 | | === Problem with zipped egg === |
| 267 | | |
| 268 | | 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: |
| 269 | | |
| 270 | | {{{ |
| | 255 | === Problem with virtual host configuration |
| | 256 | |
| | 257 | 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. |
| | 258 | |
| | 259 | 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. |
| | 260 | |
| | 261 | === Problem with zipped egg |
| | 262 | |
| | 263 | 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 this, try installing Trac using the `--always-unzip` option: |
| | 264 | |
| | 265 | {{{#!sh |
| 307 | | ==== Win32 Issues ==== |
| 308 | | 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. |
| 309 | | |
| 310 | | |
| 311 | | ==== OS X issues ==== |
| 312 | | |
| 313 | | 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]. |
| 314 | | |
| 315 | | ==== SELinux issues ==== |
| 316 | | |
| 317 | | If Trac reports something like: ''Cannot get shared lock on db.lock'' |
| 318 | | The security context on the repository may need to be set: |
| 319 | | |
| 320 | | {{{ |
| | 302 | ==== Win32 Issues |
| | 303 | |
| | 304 | 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. |
| | 305 | |
| | 306 | ==== OS X issues |
| | 307 | |
| | 308 | 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, so please upgrade mod_python to fix this. |
| | 309 | |
| | 310 | ==== SELinux issues |
| | 311 | |
| | 312 | If Trac reports something like: `Cannot get shared lock on db.lock`, then the security context on the repository may need to be set: |
| | 313 | |
| | 314 | {{{#!sh |
| 324 | | See also [http://subversion.tigris.org/faq.html#reposperms] |
| 325 | | |
| 326 | | ==== FreeBSD issues ==== |
| 327 | | 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. |
| 328 | | |
| 329 | | If 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. |
| 330 | | 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 |
| 331 | | |
| 332 | | {{{ |
| | 318 | See also [http://subversion.apache.org/faq.html#reposperms How do I set repository permissions correctly?] |
| | 319 | |
| | 320 | ==== FreeBSD issues |
| | 321 | |
| | 322 | 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: |
| | 323 | * pysqlite requires threaded support in Python |
| | 324 | * mod_python requires a threadless install. |
| | 325 | |
| | 326 | Apache2 does not automatically support threads on FreeBSD. You could force thread support when running `./configure` for Apache, using `--enable-threads`, but this isn´t recommended. |
| | 327 | 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: |
| | 328 | |
| | 329 | {{{#!sh |
| 336 | | |
| 337 | | ==== Fedora 7 Issues ==== |
| 338 | | Make sure you install the 'python-sqlite2' package as it seems to be required for TracModPython but not for tracd |
| 339 | | |
| 340 | | |
| 341 | | === Subversion issues === |
| 342 | | |
| 343 | | 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.) |
| 344 | | |
| 345 | | 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`). |
| 346 | | |
| 347 | | 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. 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: |
| 348 | | {{{ |
| | 333 | ==== Fedora 7 Issues |
| | 334 | |
| | 335 | Make sure you install the 'python-sqlite2' package as it seems to be required for TracModPython, but not for tracd. |
| | 336 | |
| | 337 | === Subversion issues |
| | 338 | |
| | 339 | 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. A better way is to add a link to the bindings in the Python `site-packages` directory, or create a `.pth` file in that directory. |
| | 340 | |
| | 341 | If this is not the case, it's possible that you are 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`). |
| | 342 | |
| | 343 | 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: |
| | 344 | {{{#!apache |
| 351 | | 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. |
| 352 | | |
| 353 | | === Page layout issues === |
| 354 | | |
| 355 | | 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: |
| 356 | | {{{ |
| 357 | | #!xml |
| | 347 | |
| | 348 | This is also the recommended workaround for other 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. |
| | 349 | |
| | 350 | === Page layout issues |
| | 351 | |
| | 352 | 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: |
| | 353 | {{{#!apache |
| 364 | | 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 />}}}. |
| 365 | | |
| 366 | | 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, it is probably a good idea to leave it `Off`. |
| 367 | | |
| 368 | | === HTTPS issues === |
| 369 | | |
| 370 | | 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: |
| 371 | | {{{ |
| 372 | | #!xml |
| 373 | | <VirtualHost * > |
| | 360 | '''Note''': For the above configuration to have any effect it must be put after the configuration of your project root location, ie {{{<Location /myproject />}}}. |
| | 361 | |
| | 362 | **Note:** Do not enable python optimizations using the directive `PythonOptimize On`. When optimizations are enabled the page header/footer and documentation for macros and plugins will be hidden. An error will be raised in Trac 1.0.11 and later when optimizations are enabled. |
| | 363 | |
| | 364 | === HTTPS issues |
| | 365 | |
| | 366 | 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: |
| | 367 | {{{#!apache |
| | 368 | <VirtualHost *> |
| 381 | | |
| 382 | | === Segmentation fault with php5-mhash or other php5 modules === |
| 383 | | 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 debian bug report [http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=411487] |
| 384 | | |
| 385 | | Some 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] |
| | 376 | === Segmentation fault with php5-mhash or other php5 modules |
| | 377 | |
| | 378 | 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]. |
| | 379 | |
| | 380 | Some people also have troubles when using PHP5 compiled with its own third party libraries instead of system libraries. Check [http://www.djangoproject.com/documentation/modpython/#if-you-get-a-segmentation-fault Django segmentation fault]. |
