Changes between Version 1 and Version 2 of TracModWSGI


Ignore:
Timestamp:
09/14/17 14:49:44 (7 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracModWSGI

    v1 v2  
    77== The `trac.wsgi` script
    88
    9 Trac can be run on top of mod_wsgi with the help of an application script, which is just a Python file saved with a `.wsgi` extension.
     9Trac 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.
    1010
    1111A 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].
    1212
    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:
     13If you are using Trac with multiple projects, you can specify their common parent directory using the `TRAC_ENV_PARENT_DIR` in trac.wsgi (note that this directory should contain //only// Trac environments, no other sub-directories):
    1414{{{#!python
    1515def application(environ, start_request):
    16     # Add this to config when you have multiple projects                                             
     16    # Add this to config when you have multiple projects
    1717    environ.setdefault('trac.env_parent_dir', '/usr/share/trac/projects') 
    1818    ..
    … …  
    2020
    2121=== A very basic script
     22
    2223In its simplest form, the script could be:
    2324
    … …  
    8081<Directory /usr/local/trac/mysite/apache>
    8182    WSGIApplicationGroup %{GLOBAL}
    82     Order deny,allow
    83     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>
    8492</Directory>
    8593}}}
    … …  
    94102<Directory /usr/share/trac/cgi-bin>
    95103    WSGIApplicationGroup %{GLOBAL}
    96     Order deny,allow
    97     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>
    98113</Directory>
    99114}}}
    … …  
    101116In 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.
    102117
    103 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):
     118To 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):
    104119
    105120{{{#!python
    … …  
    109124}}}
    110125
    111 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/IntegrationWithTrac IntegrationWithTrac] page.
     126For 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.
    112127
    113128== Configuring Authentication
    114129
    115 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.
     130The 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.
    116131
    117132=== Using Basic Authentication
    … …  
    133148}}}
    134149
    135   ''See the man page for `htpasswd` for full documentation.''
     150See the man page for `htpasswd` for full documentation.
    136151
    137152After you've created the users, you can set their permissions using TracPermissions.
    … …  
    156171</LocationMatch>
    157172}}}
    158 Note that neither a file nor a directory named 'login' needs to exist.[[BR]]
    159 See also the [http://httpd.apache.org/docs/2.2/mod/mod_auth_basic.html mod_auth_basic] documentation.
     173
     174Note 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.
    160175
    161176=== Using Digest Authentication
    162177
    163 For better security, it is recommended that you either enable SSL or at least use the “digest” authentication scheme instead of “Basic”.
     178For better security, it is recommended that you either enable SSL or at least use the "digest" authentication scheme instead of "Basic".
    164179
    165180You have to create your `.htpasswd` file with the `htdigest` command instead of `htpasswd`, as follows:
    … …  
    182197For multiple environments, you can use the same `LocationMatch` as described with the previous method.
    183198
    184 '''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.
    185200
    186201Don't forget to activate the mod_auth_digest. For example, on a Debian 4.0r1 (etch) system:
    … …  
    189204}}}
    190205
    191 See also the [http://httpd.apache.org/docs/2.2/mod/mod_auth_digest.html mod_auth_digest] documentation.
     206See also the [https://httpd.apache.org/docs/2.4/mod/mod_auth_basic.html mod_auth_digest] documentation.
    192207
    193208=== Using LDAP Authentication
    194209
    195 Configuration for [http://httpd.apache.org/docs/2.2/mod/mod_ldap.html mod_ldap] authentication in Apache is more involved (httpd 2.2.x and OpenLDAP: slapd 2.3.19).
     210Configuration 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).
    196211
    1972121. You need to load the following modules in Apache httpd.conf:
    … …  
    219234  AuthLDAPURL "ldap://directory.example.com:3268/DC=example,DC=com?sAMAccountName?sub?(objectClass=user)"
    220235}}}
    221  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:
     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:
    222237{{{#!apache
    223238  AuthLDAPBindDN ldap-auth-user@example.com
    … …  
    251266
    252267See also:
    253  - [http://httpd.apache.org/docs/2.2/mod/mod_authnz_ldap.html mod_authnz_ldap], documentation for mod_authnz_ldap.   
    254  - [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.
    255  - [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.
    256271
    257272=== Using SSPI Authentication
    … …  
    278293See also [trac:TracOnWindows/Advanced].
    279294
    280 === Using Apache authentication with the Account Manager plugin's Login form ===
    281 
    282 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].
    283 
    284 '''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.
    285 
    286 Here is an example (from the !HttpAuthStore link) using acct_mgr-0.4 for hosting a single project:
    287 {{{#!ini
    288 [components]
    289 ; be sure to enable the component
    290 acct_mgr.http.HttpAuthStore = enabled
    291 
    292 [account-manager]
    293 ; configure the plugin to use a page that is secured with http authentication
    294 authentication_url = /authFile
    295 password_store = HttpAuthStore
    296 }}}
    297 This will generally be matched with an Apache config like:
    298 {{{#!apache
    299 <Location /authFile>
    300    …HTTP authentication configuration…
    301    Require valid-user
    302 </Location>
    303 }}}
    304 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
     297Setup 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
     299RemoteUserVar="WHATEVER_IT_SHOULD_BE"
     300SetRemoteUser="YES"
     301}}}
     302
     303The 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
     305Also add a !LogOffUri parameter to the agent configuration, for example `/trac/logout`.
     306
     307Then 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
     310def 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
     318You do not need any Apache "Location" directives.
    305319
    306320=== Example: Apache/mod_wsgi with Basic Authentication, Trac being at the root of a virtual host
    … …  
    310324 - uses Apache basic authentication for Trac authentication.
    311325
    312 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:
     326If 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:
    313327
    314328Create the htpasswd file:
    … …  
    319333htpasswd htpasswd seconduser
    320334}}}
     335
    321336Keep the file above your document root for security reasons.
    322337
    323 Create this file e.g. (ubuntu) `/etc/apache2/sites-enabled/trac.my-proj.my-site.org.conf` with the following content:
     338Create this file for example `/etc/apache2/sites-enabled/trac.my-proj.my-site.org.conf` on Ubuntu with the following content:
    324339
    325340{{{#!apache
    … …  
    344359}}}
    345360
    346 Note: for subdomains to work you would probably also need to alter `/etc/hosts` and add A-Records to your host's DNS.
     361For subdomains to work you would probably also need to alter `/etc/hosts` and add A-Records to your host's DNS.
    347362
    348363== Troubleshooting
    … …  
    350365=== Use a recent version
    351366
    352 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].
    353 
    354 ''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''
    355 
    356 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.
     367Please 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
     371If 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.
    357372
    358373=== Getting Trac to work nicely with SSPI and 'Require Group'
    359374
    360 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'.
    361 
    362 This WSGI script 'fixes' that:
     375If 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
     377This WSGI script fixes that:
    363378{{{#!python
    364379import os
    … …  
    396411Now Trac drops the connection after serving a page and the connection count on the database will be kept low.
    397412
    398 //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
     417If 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
     419In 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
     425On Ubuntu, the WSGI mod configuration is at `/etc/apache2/mods-enabled/wsgi.conf`.
     426
     427The same issue is seen with `PythonOptimize On` in [TracModPython#Pagelayoutissues ModPython].
    399428
    400429=== Other resources
    401430
    402 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/IntegrationWithTrac Integration With Trac] document.
     431For 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.
    403432
    404433----