Changes between Version 1 and Version 2 of TracModWSGI
- Timestamp:
- Dec 3, 2016, 9:48:27 PM (8 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracModWSGI
v1 v2 1 = Trac and mod_wsgi =2 3 [http ://code.google.com/p/modwsgi/mod_wsgi] is an Apache module for running WSGI-compatible Python applications directly on top of the Apache webserver. The mod_wsgi adapter is written completely in C and provides very good performance.1 = Trac and mod_wsgi 2 3 [https://github.com/GrahamDumpleton/mod_wsgi mod_wsgi] is an Apache module for running WSGI-compatible Python applications directly on top of the Apache webserver. The mod_wsgi adapter is written completely in C and provides very good performance. 4 4 5 5 [[PageOutline(2-3,Overview,inline)]] … … 7 7 == The `trac.wsgi` script 8 8 9 Trac can be run on top of mod_wsgi with the help of the following application script, which is just a Python file, though usually 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 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]. 12 13 If you are using Trac with multiple projects, you can specify their common parent directory using the `TRAC_ENV_PARENT_DIR` in trac.wsgi: 14 {{{#!python 15 def application(environ, start_request): 16 # Add this to config when you have multiple projects 17 environ.setdefault('trac.env_parent_dir', '/usr/share/trac/projects') 18 .. 19 }}} 10 20 11 21 === A very basic script 22 12 23 In its simplest form, the script could be: 13 24 … … 61 72 Change it according to the path you installed the Trac libs at. 62 73 63 === Recommended `trac.wsgi` script64 65 A somewhat 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.66 67 If you are using Trac with multiple projects, you can specify their common parent directory using the `TRAC_ENV_PARENT_DIR` in the trac.wsgi in trac.wsgi: ''68 69 {{{#!python70 def application(environ, start_request):71 Add this to config when you have multiple projects72 environ.setdefault('trac.env_parent_dir', '/usr/share/trac/projects')73 ..74 ..75 }}}76 77 74 == Mapping requests to the script 78 75 79 76 After preparing your .wsgi script, add the following to your Apache configuration file, typically `httpd.conf`: 80 77 81 {{{ 78 {{{#!apache 82 79 WSGIScriptAlias /trac /usr/local/trac/mysite/apache/mysite.wsgi 83 80 84 81 <Directory /usr/local/trac/mysite/apache> 85 82 WSGIApplicationGroup %{GLOBAL} 86 Order deny,allow 87 Allow from all 83 # For Apache 2.2 84 <IfModule !mod_authz_core.c> 85 Order deny,allow 86 Allow from all 87 </IfModule> 88 # For Apache 2.4 89 <IfModule mod_authz_core.c> 90 Require all granted 91 </IfModule> 88 92 </Directory> 89 93 }}} … … 93 97 If you followed the directions [TracInstall#cgi-bin Generating the Trac cgi-bin directory], your Apache configuration file should look like following: 94 98 95 {{{ 99 {{{#!apache 96 100 WSGIScriptAlias /trac /usr/share/trac/cgi-bin/trac.wsgi 97 101 98 102 <Directory /usr/share/trac/cgi-bin> 99 103 WSGIApplicationGroup %{GLOBAL} 100 Order deny,allow 101 Allow from all 104 # For Apache 2.2 105 <IfModule !mod_authz_core.c> 106 Order deny,allow 107 Allow from all 108 </IfModule> 109 # For Apache 2.4 110 <IfModule mod_authz_core.c> 111 Require all granted 112 </IfModule> 102 113 </Directory> 103 114 }}} … … 105 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. 106 117 107 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): 108 119 109 120 {{{#!python … … 113 124 }}} 114 125 115 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. 116 127 117 128 == Configuring Authentication 118 129 119 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.120 121 === Using Basic Authentication ===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. 131 132 === Using Basic Authentication 122 133 123 134 The simplest way to enable authentication with Apache is to create a password file. Use the `htpasswd` program as follows: 124 {{{ 135 {{{#!sh 125 136 $ htpasswd -c /somewhere/trac.htpasswd admin 126 137 New password: <type password> … … 130 141 131 142 After the first user, you don't need the "-c" option anymore: 132 {{{ 143 {{{#!sh 133 144 $ htpasswd /somewhere/trac.htpasswd john 134 145 New password: <type password> … … 137 148 }}} 138 149 139 ''See the man page for `htpasswd` for full documentation.'' 150 See the man page for `htpasswd` for full documentation. 140 151 141 152 After you've created the users, you can set their permissions using TracPermissions. 142 153 143 154 Now, you need to enable authentication against the password file in the Apache configuration: 144 {{{ 155 {{{#!apache 145 156 <Location "/trac/login"> 146 157 AuthType Basic … … 152 163 153 164 If you are hosting multiple projects, you can use the same password file for all of them: 154 {{{ 165 {{{#!apache 155 166 <LocationMatch "/trac/[^/]+/login"> 156 167 AuthType Basic … … 160 171 </LocationMatch> 161 172 }}} 162 Note that neither a file nor a directory named 'login' needs to exist.[[BR]] 163 See also the [http://httpd.apache.org/docs/2.2/mod/mod_auth_basic.html mod_auth_basic] documentation.164 165 === Using Digest Authentication ===166 167 For better security, it is recommended that you either enable SSL or at least use the “digest” authentication scheme instead of “Basic”.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. 175 176 === Using Digest Authentication 177 178 For better security, it is recommended that you either enable SSL or at least use the "digest" authentication scheme instead of "Basic". 168 179 169 180 You have to create your `.htpasswd` file with the `htdigest` command instead of `htpasswd`, as follows: 170 {{{ 171 #htdigest -c /somewhere/trac.htpasswd trac admin181 {{{#!sh 182 $ htdigest -c /somewhere/trac.htpasswd trac admin 172 183 }}} 173 184 174 185 The "trac" parameter above is the "realm", and will have to be reused in the Apache configuration in the !AuthName directive: 175 186 176 {{{ 187 {{{#!apache 177 188 <Location "/trac/login"> 178 179 AuthType Digest 180 AuthName "trac" 181 AuthDigestDomain /trac 182 AuthUserFile /somewhere/trac.htpasswd 183 Require valid-user 189 AuthType Digest 190 AuthName "trac" 191 AuthDigestDomain /trac 192 AuthUserFile /somewhere/trac.htpasswd 193 Require valid-user 184 194 </Location> 185 195 }}} … … 187 197 For multiple environments, you can use the same `LocationMatch` as described with the previous method. 188 198 189 '''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. 190 200 191 201 Don't forget to activate the mod_auth_digest. For example, on a Debian 4.0r1 (etch) system: 192 {{{ 193 194 }}} 195 196 See also the [http ://httpd.apache.org/docs/2.2/mod/mod_auth_digest.html mod_auth_digest] documentation.202 {{{#!apache 203 LoadModule auth_digest_module /usr/lib/apache2/modules/mod_auth_digest.so 204 }}} 205 206 See also the [https://httpd.apache.org/docs/2.4/mod/mod_auth_basic.html mod_auth_digest] documentation. 197 207 198 208 === Using LDAP Authentication 199 209 200 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). 201 211 202 212 1. You need to load the following modules in Apache httpd.conf: 203 {{{ 204 LoadModule ldap_module modules/mod_ldap.so 205 LoadModule authnz_ldap_module modules/mod_authnz_ldap.so 206 }}} 207 208 2. Your httpd.conf also needs to look something like: 209 210 {{{ 213 {{{#!apache 214 LoadModule ldap_module modules/mod_ldap.so 215 LoadModule authnz_ldap_module modules/mod_authnz_ldap.so 216 }}} 217 1. Your httpd.conf also needs to look something like: 218 {{{#!apache 211 219 <Location /trac/> 212 220 # (if you're using it, mod_python specific settings go here) … … 222 230 </Location> 223 231 }}} 224 225 3. You can use the LDAP interface as a way to authenticate to a Microsoft Active Directory: 226 227 Use the following as your LDAP URL: 228 {{{ 229 AuthLDAPURL "ldap://directory.example.com:3268/DC=example,DC=com?sAMAccountName?sub?(objectClass=user)" 230 }}} 231 232 You will also need to provide an account for Apache to use when checking credentials. As this password will be listed in plaintext in the config, you need to use an account specifically for this task: 233 {{{ 234 AuthLDAPBindDN ldap-auth-user@example.com 235 AuthLDAPBindPassword "password" 236 }}} 237 238 The whole section looks like: 239 {{{ 232 1. You can use the LDAP interface as a way to authenticate to a Microsoft Active Directory. Use the following as your LDAP URL: 233 {{{#!apache 234 AuthLDAPURL "ldap://directory.example.com:3268/DC=example,DC=com?sAMAccountName?sub?(objectClass=user)" 235 }}} 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: 237 {{{#!apache 238 AuthLDAPBindDN ldap-auth-user@example.com 239 AuthLDAPBindPassword "password" 240 }}} 241 The whole section looks like: 242 {{{#!apache 240 243 <Location /trac/> 241 244 # (if you're using it, mod_python specific settings go here) … … 251 254 authzldapauthoritative Off 252 255 # require valid-user 253 require ldap-group CN=Trac Users,CN=Users,DC=company,DC=com256 Require ldap-group CN=Trac Users,CN=Users,DC=company,DC=com 254 257 </Location> 255 258 }}} … … 258 261 259 262 Note 2: You can also require the user be a member of a certain LDAP group, instead of just having a valid login: 260 {{{ 261 263 {{{#!apache 264 Require ldap-group CN=Trac Users,CN=Users,DC=example,DC=com 262 265 }}} 263 266 264 267 See also: 265 - [http ://httpd.apache.org/docs/2.2/mod/mod_authnz_ldap.html mod_authnz_ldap], documentation for mod_authnz_ldap.266 - [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.267 - [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. 268 271 269 272 === Using SSPI Authentication 270 273 271 274 If you are using Apache on Windows, you can use mod_auth_sspi to provide single-sign-on. Download the module from the !SourceForge [http://sourceforge.net/projects/mod-auth-sspi/ mod-auth-sspi project] and then add the following to your !VirtualHost: 272 {{{ 273 274 275 276 277 278 279 280 281 282 283 275 {{{#!apache 276 <Location /trac/login> 277 AuthType SSPI 278 AuthName "Trac Login" 279 SSPIAuth On 280 SSPIAuthoritative On 281 SSPIDomain MyLocalDomain 282 SSPIOfferBasic On 283 SSPIOmitDomain Off 284 SSPIBasicPreferred On 285 Require valid-user 286 </Location> 284 287 }}} 285 288 … … 290 293 See also [trac:TracOnWindows/Advanced]. 291 294 292 === Using Apache authentication with the Account Manager plugin's Login form === 293 294 To begin with, see the basic instructions for using the Account Manager plugin's [http://trac-hacks.org/wiki/AccountManagerPlugin/Modules#LoginModule Login module] and its [http://trac-hacks.org/wiki/AccountManagerPlugin/AuthStores#HttpAuthStore HttpAuthStore authentication module]. 295 296 '''Note:''' If is difficult to get !HttpAuthStore to work with WSGI when using any Account Manager version prior to acct_mgr-0.4. Upgrading is recommended. 297 298 Here is an example (from the !HttpAuthStore link) using acct_mgr-0.4 for hosting a single project: 299 {{{ 300 [components] 301 ; be sure to enable the component 302 acct_mgr.http.HttpAuthStore = enabled 303 304 [account-manager] 305 ; configure the plugin to use a page that is secured with http authentication 306 authentication_url = /authFile 307 password_store = HttpAuthStore 308 }}} 309 This will generally be matched with an Apache config like: 310 {{{ 311 <Location /authFile> 312 …HTTP authentication configuration… 313 Require valid-user 314 </Location> 315 }}} 316 Note that '''authFile''' need not exist (unless you are using Account Manager older than 0.4). See the !HttpAuthStore link above for examples where multiple Trac projects are hosted on a server. 295 === Using CA !SiteMinder Authentication 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`: 298 {{{#!apache 299 RemoteUserVar="WHATEVER_IT_SHOULD_BE" 300 SetRemoteUser="YES" 301 }}} 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`. 306 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`: 308 309 {{{#!python 310 def application(environ, start_request): 311 # Set authenticated username on CA SiteMinder to REMOTE_USER variable 312 # strip() is used to remove any spaces on the end of the string 313 if 'HTTP_SM_USER' in environ: 314 environ['REMOTE_USER'] = environ['HTTP_REMOTE_USER'].strip() 315 ... 316 }}} 317 318 You do not need any Apache "Location" directives. 317 319 318 320 === Example: Apache/mod_wsgi with Basic Authentication, Trac being at the root of a virtual host … … 322 324 - uses Apache basic authentication for Trac authentication. 323 325 324 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: 325 327 326 328 Create the htpasswd file: 327 {{{ 329 {{{#!sh 328 330 cd /home/trac-for-my-proj/the-env 329 331 htpasswd -c htpasswd firstuser … … 331 333 htpasswd htpasswd seconduser 332 334 }}} 335 333 336 Keep the file above your document root for security reasons. 334 337 335 Create this file e.g. (ubuntu) `/etc/apache2/sites-enabled/trac.my-proj.my-site.org.conf`with the following content:336 337 {{{ 338 Create this file for example `/etc/apache2/sites-enabled/trac.my-proj.my-site.org.conf` on Ubuntu with the following content: 339 340 {{{#!apache 338 341 <Directory /home/trac-for-my-proj/the-deploy/cgi-bin/trac.wsgi> 339 342 WSGIApplicationGroup %{GLOBAL} … … 356 359 }}} 357 360 358 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. 359 362 360 363 == Troubleshooting … … 362 365 === Use a recent version 363 366 364 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].365 366 '' 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 368 If you plan to use `mod_wsgi` in embedded mode on Windows or with the MPM worker on Linux, then you will need version 0.3.4 or greater. See [trac:#10675] for details.369 370 === Getting Trac to work nicely with SSPI and 'Require Group' ===371 372 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'.373 374 This WSGI script 'fixes'that: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 370 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. 372 373 === Getting Trac to work nicely with SSPI and 'Require Group' 374 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: 375 378 {{{#!python 376 379 import os … … 386 389 }}} 387 390 388 === Trac with PostgreSQL ===391 === Trac with PostgreSQL 389 392 390 393 When using the mod_wsgi adapter with multiple Trac instances and PostgreSQL (or MySQL?) as the database, the server ''may'' create a lot of open database connections and thus PostgreSQL processes. … … 408 411 Now Trac drops the connection after serving a page and the connection count on the database will be kept low. 409 412 410 //This is not a recommended approach though. See also the notes at the bottom of the [http://code.google.com/p/modwsgi/wiki/IntegrationWithTrac mod_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.// 414 415 === Missing Headers and Footers 416 417 If python optimizations are enabled, then headers and footers will not be rendered. An error will be raised in Trac 1.0.11 and later when optimizations are enabled. 418 419 In your WSGI configuration file, the `WSGIPythonOptimize` setting must be set to `0` (`1` or `2` will not work): 420 421 {{{#!apache 422 WSGIPythonOptimize 0 423 }}} 424 425 On Ubuntu, the WSGI mod configuration is at `/etc/apache2/mods-enabled/wsgi.conf`. 426 427 The same issue is seen with `PythonOptimize On` in [TracModPython#Pagelayoutissues ModPython]. 411 428 412 429 === Other resources 413 430 414 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. 415 432 416 433 ----