Changes between Version 80 and Version 81 of TracModWSGI
- Timestamp:
- Jun 21, 2016, 10:07:03 PM (8 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracModWSGI
v80 v81 7 7 == The `trac.wsgi` script 8 8 9 Trac can be run on top of mod_wsgi with the help of an application script, which is justa Python file saved with a `.wsgi` extension.9 Trac can be run on top of mod_wsgi with the help of an application script, which is a Python file saved with a `.wsgi` extension. 10 10 11 11 A robust and generic version of this file can be created using the `trac-admin <env> deploy <dir>` command which automatically substitutes the required paths, see TracInstall#cgi-bin. The script should be sufficient for most installations and users not wanting more information can proceed to [#Mappingrequeststothescript configuring Apache]. … … 14 14 {{{#!python 15 15 def application(environ, start_request): 16 # Add this to config when you have multiple projects 16 # Add this to config when you have multiple projects 17 17 environ.setdefault('trac.env_parent_dir', '/usr/share/trac/projects') 18 18 .. … … 20 20 21 21 === A very basic script 22 22 23 In its simplest form, the script could be: 23 24 … … 115 116 In order to let Apache run the script, access to the directory in which the script resides is opened up to all of Apache. Additionally, the `WSGIApplicationGroup` directive ensures that Trac is always run in the first Python interpreter created by mod_wsgi. This is necessary because the Subversion Python bindings, which are used by Trac, don't always work in other sub-interpreters and may cause requests to hang or cause Apache to crash. After adding this configuration, restart Apache, and then it should work. 116 117 117 To test the setup of Apache, mod_wsgi and Python itself (ie .without involving Trac and dependencies), this simple wsgi application can be used to make sure that requests gets served (use as only content in your `.wsgi` script):118 To test the setup of Apache, mod_wsgi and Python itself (ie without involving Trac and dependencies), this simple wsgi application can be used to make sure that requests gets served (use as only content in your `.wsgi` script): 118 119 119 120 {{{#!python … … 123 124 }}} 124 125 125 For more information about using the mod_wsgi specific directives, see the [http ://code.google.com/p/modwsgi/wiki/ mod_wsgi's wiki] and more specifically the [http://code.google.com/p/modwsgi/wiki/IntegrationWithTracIntegrationWithTrac] page.126 For more information about using the mod_wsgi specific directives, see the [https://code.google.com/archive/p/modwsgi/wikis mod_wsgi's wiki] and more specifically the [https://code.google.com/archive/p/modwsgi/wikis/IntegrationWithTrac.wiki IntegrationWithTrac] page. 126 127 127 128 == Configuring Authentication 128 129 129 The following sections describe different methods for setting up authentication. See also [http://httpd.apache.org/docs/2. 2/howto/auth.html Authentication, Authorization and Access Control] in the Apache guide.130 The following sections describe different methods for setting up authentication. See also [http://httpd.apache.org/docs/2.4/howto/auth.html Authentication, Authorization and Access Control] in the Apache guide. 130 131 131 132 === Using Basic Authentication … … 147 148 }}} 148 149 149 ''See the man page for `htpasswd` for full documentation.'' 150 See the man page for `htpasswd` for full documentation. 150 151 151 152 After you've created the users, you can set their permissions using TracPermissions. … … 170 171 </LocationMatch> 171 172 }}} 172 Note that neither a file nor a directory named 'login' needs to exist.[[BR]] 173 See also the [http://httpd.apache.org/docs/2.2/mod/mod_auth_basic.html mod_auth_basic] documentation.173 174 Note that neither a file nor a directory named 'login' needs to exist. See also the [https://httpd.apache.org/docs/2.4/mod/mod_auth_basic.html mod_auth_basic] documentation. 174 175 175 176 === Using Digest Authentication 176 177 177 For better security, it is recommended that you either enable SSL or at least use the “digest” authentication scheme instead of “Basic”.178 For better security, it is recommended that you either enable SSL or at least use the "digest" authentication scheme instead of "Basic". 178 179 179 180 You have to create your `.htpasswd` file with the `htdigest` command instead of `htpasswd`, as follows: … … 196 197 For multiple environments, you can use the same `LocationMatch` as described with the previous method. 197 198 198 '''Note : `Location` cannot be used inside .htaccess files, but must instead live within the main httpd.conf file. If you are on a shared server, you therefore will not be able to provide this level of granularity. '''199 '''Note''': `Location` cannot be used inside .htaccess files, but must instead live within the main httpd.conf file. If you are on a shared server, you therefore will not be able to provide this level of granularity. 199 200 200 201 Don't forget to activate the mod_auth_digest. For example, on a Debian 4.0r1 (etch) system: … … 203 204 }}} 204 205 205 See also the [http ://httpd.apache.org/docs/2.2/mod/mod_auth_digest.html mod_auth_digest] documentation.206 See also the [https://httpd.apache.org/docs/2.4/mod/mod_auth_basic.html mod_auth_digest] documentation. 206 207 207 208 === Using LDAP Authentication 208 209 209 Configuration for [http ://httpd.apache.org/docs/2.2/mod/mod_ldap.html mod_ldap] authentication in Apache is more involved (httpd 2.2.xand OpenLDAP: slapd 2.3.19).210 Configuration for [https://httpd.apache.org/docs/2.4/mod/mod_ldap.html mod_ldap] authentication in Apache is more involved (httpd 2.2+ and OpenLDAP: slapd 2.3.19). 210 211 211 212 1. You need to load the following modules in Apache httpd.conf: … … 233 234 AuthLDAPURL "ldap://directory.example.com:3268/DC=example,DC=com?sAMAccountName?sub?(objectClass=user)" 234 235 }}} 235 You will also need to provide an account for Apache to use when checking credentials. As this password will be listed in plain text in the config, you need to use an account specifically for this task:236 You will also need to provide an account for Apache to use when checking credentials. As this password will be listed in plain text in the configuration, you need to use an account specifically for this task: 236 237 {{{#!apache 237 238 AuthLDAPBindDN ldap-auth-user@example.com … … 265 266 266 267 See also: 267 - [http ://httpd.apache.org/docs/2.2/mod/mod_authnz_ldap.html mod_authnz_ldap], documentation for mod_authnz_ldap.268 - [http ://httpd.apache.org/docs/2.2/mod/mod_ldap.html mod_ldap], documentation for mod_ldap, which provides connection pooling and a shared cache.269 - [http ://trac-hacks.org/wiki/LdapPlugin TracHacks:LdapPlugin] for storing TracPermissions in LDAP.268 - [https://httpd.apache.org/docs/2.4/mod/mod_authnz_ldap.html mod_authnz_ldap], documentation for mod_authnz_ldap. 269 - [https://httpd.apache.org/docs/2.4/mod/mod_ldap.html mod_ldap], documentation for mod_ldap, which provides connection pooling and a shared cache. 270 - [https://trac-hacks.org/wiki/LdapPlugin TracHacks:LdapPlugin] for storing TracPermissions in LDAP. 270 271 271 272 === Using SSPI Authentication … … 293 294 294 295 === Using CA !SiteMinder Authentication 295 Setup CA !SiteMinder to protect your Trac login URL (e.g. `/trac/login`). Also, make sure the policy is set to include the HTTP_REMOTE_USER variable. If your site allows it, you can set this in `LocalConfig.conf`: 296 297 Setup CA !SiteMinder to protect your Trac login URL, for example `/trac/login`. Also, make sure the policy is set to include the HTTP_REMOTE_USER variable. If your site allows it, you can set this in `LocalConfig.conf`: 296 298 {{{#!apache 297 299 RemoteUserVar="WHATEVER_IT_SHOULD_BE" 298 300 SetRemoteUser="YES" 299 301 }}} 300 The specific variable is site-dependent. Ask your site administrator. If your site does not allow the use of `LocalConfig.conf` for security reasons, have your site administrator set the policy on the server to set REMOTE_USER. 301 302 Also add a !LogOffUri parameter to the agent configuration (e.g. `/trac/logout`). 302 303 The specific variable is site-dependent. Ask your site administrator. If your site does not allow the use of `LocalConfig.conf` for security reasons, have your site administrator set the policy on the server to set REMOTE_USER. 304 305 Also add a !LogOffUri parameter to the agent configuration, for example `/trac/logout`. 303 306 304 307 Then modify the trac.wsgi script generated using `trac-admin <env> deploy <dir>` to add the following lines, which extract the `HTTP_REMOTE_USER` variable and set it to `REMOTE_USER`: … … 313 316 }}} 314 317 315 Note: you do not need any Apache "Location" directives.318 You do not need any Apache "Location" directives. 316 319 317 320 === Example: Apache/mod_wsgi with Basic Authentication, Trac being at the root of a virtual host … … 321 324 - uses Apache basic authentication for Trac authentication. 322 325 323 If you want your Trac to be served from e .g. !http://trac.my-proj.my-site.org, then from the folder e.g.`/home/trac-for-my-proj`, if you used the command `trac-admin the-env initenv` to create a folder `the-env`, and you used `trac-admin the-env deploy the-deploy` to create a folder `the-deploy`, then first:326 If you want your Trac to be served from eg !http://trac.my-proj.my-site.org, then from the folder eg `/home/trac-for-my-proj`, if you used the command `trac-admin the-env initenv` to create a folder `the-env`, and you used `trac-admin the-env deploy the-deploy` to create a folder `the-deploy`, then first: 324 327 325 328 Create the htpasswd file: … … 330 333 htpasswd htpasswd seconduser 331 334 }}} 335 332 336 Keep the file above your document root for security reasons. 333 337 334 Create this file e.g. (ubuntu) `/etc/apache2/sites-enabled/trac.my-proj.my-site.org.conf`with the following content:338 Create this file for example `/etc/apache2/sites-enabled/trac.my-proj.my-site.org.conf` on Ubuntu with the following content: 335 339 336 340 {{{#!apache … … 355 359 }}} 356 360 357 Note: for subdomains to work you would probably also need to alter `/etc/hosts` and add A-Records to your host's DNS.361 For subdomains to work you would probably also need to alter `/etc/hosts` and add A-Records to your host's DNS. 358 362 359 363 == Troubleshooting … … 361 365 === Use a recent version 362 366 363 Please use either version 1.6, 2.4 or later of `mod_wsgi`. Versions prior to 2.4 in the 2.X branch have problems with some Apache configurations that use WSGI file wrapper extension. This extension is used in Trac to serve up attachments and static media files such as style sheets. If you are affected by this problem, attachments will appear to be empty and formatting of HTML pages will appear not to work due to style sheet files not loading properly. Another frequent symptom is that binary attachment downloads are truncated. See mod_wsgi tickets [http ://code.google.com/p/modwsgi/issues/detail?id=100 #100] and [http://code.google.com/p/modwsgi/issues/detail?id=132 #132].364 365 '' Note: using mod_wsgi 2.5 and Python 2.6.1 gave an Internal Server Error on my system (Apache 2.2.11 and Trac 0.11.2.1). Upgrading to Python 2.6.2 (as suggested [http://www.mail-archive.com/modwsgi@googlegroups.com/msg01917.html here]) solved this for me[[BR]]-- Graham Shanks''367 Please use either version 1.6, 2.4 or later of `mod_wsgi`. Versions prior to 2.4 in the 2.X branch have problems with some Apache configurations that use WSGI file wrapper extension. This extension is used in Trac to serve up attachments and static media files such as style sheets. If you are affected by this problem, attachments will appear to be empty and formatting of HTML pages will appear not to work due to style sheet files not loading properly. Another frequent symptom is that binary attachment downloads are truncated. See mod_wsgi tickets [https://code.google.com/archive/p/modwsgi/issues/100 #100] and [https://code.google.com/archive/p/modwsgi/issues/132 #132]. 368 369 '''Note''': using mod_wsgi 2.5 and Python 2.6.1 gave an Internal Server Error on my system (Apache 2.2.11 and Trac 0.11.2.1). Upgrading to Python 2.6.2 (as suggested [http://www.mail-archive.com/modwsgi@googlegroups.com/msg01917.html here]) solved this for me[[BR]]-- Graham Shanks 366 370 367 371 If you plan to use `mod_wsgi` in embedded mode on Windows or with the MPM worker on Linux, then you will need version 3.4 or greater. See [trac:#10675] for details. … … 369 373 === Getting Trac to work nicely with SSPI and 'Require Group' 370 374 371 If you have set Trac up on Apache, Win32 and configured SSPI, but added a 'Require group' option to your apache configuration, then the SSPIOmitDomain option is probably not working. If it is not working, your usernames in Trac probably look like 'DOMAIN\user' rather than 'user'.372 373 This WSGI script 'fixes'that:375 If you have set Trac up on Apache, Win32 and configured SSPI, but added a 'Require group' option to your Apache configuration, then the SSPIOmitDomain option is probably not working. If it is not working, your usernames in Trac probably look like 'DOMAIN\user' rather than 'user'. 376 377 This WSGI script fixes that: 374 378 {{{#!python 375 379 import os … … 407 411 Now Trac drops the connection after serving a page and the connection count on the database will be kept low. 408 412 409 //This is not a recommended approach though. See also the notes at the bottom of the [http ://code.google.com/p/modwsgi/wiki/IntegrationWithTracmod_wsgi's IntegrationWithTrac] wiki page.//413 //This is not a recommended approach though. See also the notes at the bottom of the [https://code.google.com/archive/p/modwsgi/wikis/IntegrationWithTrac.wiki mod_wsgi's IntegrationWithTrac] wiki page.// 410 414 411 415 === Missing Headers and Footers … … 425 429 === Other resources 426 430 427 For more troubleshooting tips, see also the [TracModPython#Troubleshooting mod_python troubleshooting] section, as most Apache-related issues are quite similar, plus discussion of potential [http ://code.google.com/p/modwsgi/wiki/ApplicationIssues application issues] when using mod_wsgi. The wsgi page also has a [http://code.google.com/p/modwsgi/wiki/IntegrationWithTracIntegration With Trac] document.431 For more troubleshooting tips, see also the [TracModPython#Troubleshooting mod_python troubleshooting] section, as most Apache-related issues are quite similar, plus discussion of potential [https://code.google.com/archive/p/modwsgi/wikis/ApplicationIssues.wiki application issues] when using mod_wsgi. The wsgi page also has a [https://code.google.com/archive/p/modwsgi/wikis/IntegrationWithTrac.wiki Integration With Trac] document. 428 432 429 433 ----