| 47 | | </Location> |
| 48 | | }}} |
| 49 | | |
| 50 | | 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. |
| 51 | | |
| 52 | | The options available are |
| 53 | | {{{ |
| 54 | | # For a single project |
| 55 | | PythonOption TracEnv /var/trac/myproject |
| 56 | | # For multiple projects |
| 57 | | PythonOption TracEnvParentDir /var/trac/myprojects |
| 58 | | # For the index of multiple projects |
| 59 | | PythonOption TracEnvIndexTemplate /srv/www/htdocs/trac/project_list_tepmlate.html |
| 60 | | # A space delimitted list, with a "," between key and value pairs. |
| 61 | | PythonOption TracTemplateVars key1,val1 key2,val2 |
| 62 | | # Useful to get the date in the wanted order |
| 63 | | PythonOption TracLocale en_GB.UTF8 |
| 64 | | # See description above |
| 65 | | PythonOption TracUriRoot /projects/myproject |
| 66 | | # Override default python egg cache location |
| 67 | | PythonOption PYTHON_EGG_CACHE /var/trac/myprojects/egg-cache |
| 68 | | }}} |
| 69 | | |
| 70 | | === Configuring Authentication === |
| 71 | | |
| 72 | | Creating password files and configuring authentication works similar to the process for [wiki:TracCgi#AddingAuthentication CGI]: |
| 73 | | {{{ |
| 74 | | #!xml |
| 75 | | <Location /projects/myproject/login> |
| 76 | | AuthType Basic |
| 77 | | AuthName "myproject" |
| 78 | | AuthUserFile /var/trac/myproject/.htpasswd |
| 79 | | Require valid-user |
| 80 | | </Location> |
| 81 | | }}} |
| 82 | | |
| 83 | | Configuration for mod_ldap authentication in Apache is a bit tricky (httpd 2.2.x and OpenLDAP: slapd 2.3.19) |
| 84 | | |
| 85 | | 1. You need to load the following modules in Apache httpd.conf |
| 86 | | {{{ |
| 87 | | LoadModule ldap_module modules/mod_ldap.so |
| 88 | | LoadModule authnz_ldap_module modules/mod_authnz_ldap.so |
| 89 | | }}} |
| 90 | | |
| 91 | | 2. Your httpd.conf also needs to look something like: |
| 92 | | |
| 93 | | {{{ |
| 94 | | #!xml |
| 95 | | <Location /trac/> |
| 96 | | SetHandler mod_python |
| 97 | | PythonInterpreter main_interpreter |
| 98 | | PythonHandler trac.web.modpython_frontend |
| 99 | | PythonOption TracEnv /home/trac/ |
| 100 | | PythonOption TracUriRoot /trac/ |
| 101 | | Order deny,allow |
| 102 | | Deny from all |
| 103 | | Allow from 192.168.11.0/24 |
| 104 | | AuthType Basic |
| 105 | | AuthName "Trac" |
| 106 | | AuthBasicProvider "ldap" |
| 107 | | AuthLDAPURL "ldap://127.0.0.1/dc=example,dc=co,dc=ke?uid?sub?(objectClass=inetOrgPerson)" |
| 108 | | authzldapauthoritative Off |
| 109 | | require valid-user |
| 110 | | </Location> |
| 111 | | }}} |
| 112 | | |
| 113 | | Or the LDAP interface to a Microsoft Active Directory: |
| 114 | | |
| 115 | | {{{ |
| 116 | | #!xml |
| 117 | | <Location /trac/> |
| 118 | | SetHandler mod_python |
| 119 | | PythonInterpreter main_interpreter |
| 120 | | PythonHandler trac.web.modpython_frontend |
| 121 | | PythonOption TracEnv /home/trac/ |
| 122 | | PythonOption TracUriRoot /trac/ |
| 123 | | Order deny,allow |
| 124 | | Deny from all |
| 125 | | Allow from 192.168.11.0/24 |
| 126 | | AuthType Basic |
| 127 | | AuthName "Trac" |
| 128 | | AuthBasicProvider "ldap" |
| 129 | | AuthLDAPURL "ldap://adserver.company.com:3268/DC=company,DC=com?sAMAccountName?sub?(objectClass=user)" |
| 130 | | AuthLDAPBindDN ldap-auth-user@company.com |
| 131 | | AuthLDAPBindPassword "the_password" |
| 132 | | authzldapauthoritative Off |
| 133 | | # require valid-user |
| 134 | | require ldap-group CN=Trac Users,CN=Users,DC=company,DC=com |
| 135 | | </Location> |
| 136 | | }}} |
| 137 | | |
| 138 | | Note 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. |
| 139 | | |
| 140 | | Note 2: Active Directory requires an authenticating user/password to access records (AuthLDAPBindDN and AuthLDAPBindPassword). |
| 141 | | |
| 142 | | Note 3: The directive "require ldap-group ..." specifies an AD group whose members are allowed access. |
| 143 | | |
| 144 | | |
| 145 | | |
| 146 | | === Setting the !PythonPath === |
| 147 | | |
| 148 | | 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: |
| 149 | | {{{ |
| 150 | | #!xml |
| | 55 | Order allow,deny |
| | 56 | Allow from all |
| | 57 | </Location> |
| | 58 | }}} |
| | 59 | |
| | 60 | 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. |
| | 61 | |
| | 62 | The options available are: |
| | 63 | {{{#!apache |
| | 64 | # For a single project |
| | 65 | PythonOption TracEnv /var/trac/myproject |
| | 66 | |
| | 67 | # For multiple projects |
| | 68 | PythonOption TracEnvParentDir /var/trac/myprojects |
| | 69 | |
| | 70 | # For the index of multiple projects |
| | 71 | PythonOption TracEnvIndexTemplate /srv/www/htdocs/trac/project_list_template.html |
| | 72 | |
| | 73 | # A space delimitted list, with a "," between key and value pairs. |
| | 74 | PythonOption TracTemplateVars key1,val1 key2,val2 |
| | 75 | |
| | 76 | # Useful to get the date in the wanted order |
| | 77 | PythonOption TracLocale en_GB.UTF8 |
| | 78 | |
| | 79 | # See description above |
| | 80 | PythonOption TracUriRoot /projects/myproject |
| | 81 | }}} |
| | 82 | |
| | 83 | === Python Egg Cache |
| | 84 | |
| | 85 | 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: |
| | 86 | {{{#!apache |
| | 87 | PythonOption PYTHON_EGG_CACHE /var/trac/myprojects/egg-cache |
| | 88 | }}} |
| | 89 | |
| | 90 | Or you can uncompress the Genshi egg to resolve problems extracting from it. |
| | 91 | |
| | 92 | === Configuring Authentication |
| | 93 | |
| | 94 | See corresponding section in the [wiki:TracModWSGI#ConfiguringAuthentication] page. |
| | 95 | |
| | 96 | == Advanced Configuration |
| | 97 | |
| | 98 | === Setting the Python Egg Cache |
| | 99 | |
| | 100 | 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. |
| | 101 | |
| | 102 | {{{#!apache |
| 221 | | if you have issues with login try using `<LocationMatch>` instead of `<Location>` |
| 222 | | |
| 223 | | For a virtual host that supports multiple projects replace "`TracEnv`" /var/trac/myproject with "`TracEnvParentDir`" /var/trac/ |
| 224 | | |
| 225 | | Note: !DocumentRoot should not point to your Trac project env. As Asmodai wrote on #trac: "suppose there's a webserer bug that allows disclosure of !DocumentRoot they could then leech the entire Trac environment". |
| 226 | | |
| 227 | | == Troubleshooting == |
| 228 | | |
| 229 | | In general, if you get server error pages, you can either check the Apache error log, or enable the `PythonDebug` option: |
| 230 | | {{{ |
| 231 | | #!xml |
| | 180 | This does not seem to work in all cases. What you can do if it does not: |
| | 181 | * Try using `<LocationMatch>` instead of `<Location>`. |
| | 182 | * `<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. |
| | 183 | * Depending on apache's `NameVirtualHost` configuration, you may need to use `<VirtualHost *:80>` instead of `<VirtualHost *>`. |
| | 184 | |
| | 185 | For a virtual host that supports multiple projects replace `TracEnv /var/trac/myproject` with `TracEnvParentDir /var/trac`. |
| | 186 | |
| | 187 | '''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". |
| | 188 | |
| | 189 | == Troubleshooting |
| | 190 | |
| | 191 | If you get server error pages, you can either check the Apache error log, or enable the `PythonDebug` option: |
| | 192 | {{{#!apache |
| 254 | | === Problem with virtual host configuration === |
| 255 | | |
| 256 | | 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). |
| 257 | | |
| 258 | | 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. |
| 259 | | |
| 260 | | === Using .htaccess === |
| | 243 | === Problem with virtual host configuration |
| | 244 | |
| | 245 | 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. |
| | 246 | |
| | 247 | 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. |
| | 248 | |
| | 249 | === Problem with zipped egg |
| | 250 | |
| | 251 | 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: |
| | 252 | |
| | 253 | {{{#!sh |
| | 254 | easy_install --always-unzip Trac-0.12b1.zip |
| | 255 | }}} |
| | 256 | |
| | 257 | === Using .htaccess |
| 264 | | 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. :) |
| 265 | | |
| 266 | | === Win32 Issues === |
| 267 | | 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. |
| 268 | | |
| 269 | | |
| 270 | | === OS X issues === |
| 271 | | |
| 272 | | 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]. |
| 273 | | |
| 274 | | === SELinux issues === |
| 275 | | |
| 276 | | If Trac reports something like: ''Cannot get shared lock on db.lock'' |
| 277 | | The security context on the repository may need to be set: |
| 278 | | |
| 279 | | {{{ |
| | 261 | 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. |
| | 262 | |
| | 263 | This also works out-of-box, with following trivial config: |
| | 264 | {{{#!apache |
| | 265 | SetHandler mod_python |
| | 266 | PythonInterpreter main_interpreter |
| | 267 | PythonHandler trac.web.modpython_frontend |
| | 268 | PythonOption TracEnv /system/path/to/this/directory |
| | 269 | PythonOption TracUriRoot /path/on/apache |
| | 270 | |
| | 271 | AuthType Basic |
| | 272 | AuthName "ProjectName" |
| | 273 | AuthUserFile /path/to/.htpasswd |
| | 274 | Require valid-user |
| | 275 | }}} |
| | 276 | |
| | 277 | The `TracUriRoot` is obviously the path you need to enter to the browser to get to Trac, eg `domain.tld/projects/trac`. |
| | 278 | |
| | 279 | === Additional .htaccess help |
| | 280 | |
| | 281 | 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: |
| | 282 | |
| | 283 | {{{#!apache |
| | 284 | <IfModule mod_rewrite.c> |
| | 285 | RewriteEngine Off |
| | 286 | </IfModule> |
| | 287 | }}} |
| | 288 | |
| | 289 | === Platform specific issues |
| | 290 | ==== Win32 Issues |
| | 291 | |
| | 292 | 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. |
| | 293 | |
| | 294 | ==== OS X issues |
| | 295 | |
| | 296 | 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. |
| | 297 | |
| | 298 | ==== SELinux issues |
| | 299 | |
| | 300 | If Trac reports something like: `Cannot get shared lock on db.lock`, then the security context on the repository may need to be set: |
| | 301 | |
| | 302 | {{{#!sh |
| 283 | | See also [[http://subversion.tigris.org/faq.html#reposperms]] |
| 284 | | |
| 285 | | === FreeBSD issues === |
| 286 | | 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. |
| 287 | | |
| 288 | | 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. |
| 289 | | 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 |
| 290 | | |
| 291 | | {{{ |
| | 306 | See also [http://subversion.apache.org/faq.html#reposperms How do I set repository permissions correctly?] |
| | 307 | |
| | 308 | ==== FreeBSD issues |
| | 309 | |
| | 310 | 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: |
| | 311 | * pysqlite requires threaded support in Python |
| | 312 | * mod_python requires a threadless install. |
| | 313 | |
| | 314 | 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. |
| | 315 | 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: |
| | 316 | |
| | 317 | {{{#!sh |
| 295 | | === Subversion issues === |
| 296 | | |
| 297 | | 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.) |
| 298 | | |
| 299 | | 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`). |
| 300 | | |
| 301 | | 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 #3371, in order to force the use of the main interpreter: |
| 302 | | {{{ |
| | 321 | ==== Fedora 7 Issues |
| | 322 | |
| | 323 | Make sure you install the 'python-sqlite2' package as it seems to be required for TracModPython, but not for tracd. |
| | 324 | |
| | 325 | === Subversion issues |
| | 326 | |
| | 327 | 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. |
| | 328 | |
| | 329 | 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`). |
| | 330 | |
| | 331 | 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: |
| | 332 | {{{#!apache |
