Changes between Version 2 and Version 3 of TracModWSGI


Ignore:
Timestamp:
May 2, 2019, 9:45:05 AM (14 months ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracModWSGI

    v2 v3  
    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 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 just 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].
     
    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 
    2322In its simplest form, the script could be:
    2423
     
    8180<Directory /usr/local/trac/mysite/apache>
    8281    WSGIApplicationGroup %{GLOBAL}
    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>
     82    Order deny,allow
     83    Allow from all
    9284</Directory>
    9385}}}
     
    10294<Directory /usr/share/trac/cgi-bin>
    10395    WSGIApplicationGroup %{GLOBAL}
    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>
     96    Order deny,allow
     97    Allow from all
    11398</Directory>
    11499}}}
     
    116101In 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.
    117102
    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):
     103To 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):
    119104
    120105{{{#!python
     
    124109}}}
    125110
    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.
     111For 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.
    127112
    128113== Configuring Authentication
    129114
    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.
     115The 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.
    131116
    132117=== Using Basic Authentication
     
    148133}}}
    149134
    150 See the man page for `htpasswd` for full documentation.
     135  ''See the man page for `htpasswd` for full documentation.''
    151136
    152137After you've created the users, you can set their permissions using TracPermissions.
     
    171156</LocationMatch>
    172157}}}
    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.
     158Note that neither a file nor a directory named 'login' needs to exist.[[BR]]
     159See also the [http://httpd.apache.org/docs/2.2/mod/mod_auth_basic.html mod_auth_basic] documentation.
    175160
    176161=== Using Digest Authentication
    177162
    178 For better security, it is recommended that you either enable SSL or at least use the "digest" authentication scheme instead of "Basic".
     163For better security, it is recommended that you either enable SSL or at least use the “digest” authentication scheme instead of “Basic”.
    179164
    180165You have to create your `.htpasswd` file with the `htdigest` command instead of `htpasswd`, as follows:
     
    197182For multiple environments, you can use the same `LocationMatch` as described with the previous method.
    198183
    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.
     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. '''
    200185
    201186Don't forget to activate the mod_auth_digest. For example, on a Debian 4.0r1 (etch) system:
     
    204189}}}
    205190
    206 See also the [https://httpd.apache.org/docs/2.4/mod/mod_auth_basic.html mod_auth_digest] documentation.
     191See also the [http://httpd.apache.org/docs/2.2/mod/mod_auth_digest.html mod_auth_digest] documentation.
    207192
    208193=== Using LDAP Authentication
    209194
    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).
     195Configuration 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).
    211196
    2121971. You need to load the following modules in Apache httpd.conf:
     
    234219  AuthLDAPURL "ldap://directory.example.com:3268/DC=example,DC=com?sAMAccountName?sub?(objectClass=user)"
    235220}}}
    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:
     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:
    237222{{{#!apache
    238223  AuthLDAPBindDN ldap-auth-user@example.com
     
    266251
    267252See also:
    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.
     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.
    271256
    272257=== Using SSPI Authentication
     
    293278See also [trac:TracOnWindows/Advanced].
    294279
    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.
     280=== Using Apache authentication with the Account Manager plugin's Login form ===
     281
     282To 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
     286Here 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
     290acct_mgr.http.HttpAuthStore = enabled
     291
     292[account-manager]
     293; configure the plugin to use a page that is secured with http authentication
     294authentication_url = /authFile
     295password_store = HttpAuthStore
     296}}}
     297This 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}}}
     304Note 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.
    319305
    320306=== Example: Apache/mod_wsgi with Basic Authentication, Trac being at the root of a virtual host
     
    324310 - uses Apache basic authentication for Trac authentication.
    325311
    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:
     312If 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:
    327313
    328314Create the htpasswd file:
     
    333319htpasswd htpasswd seconduser
    334320}}}
    335 
    336321Keep the file above your document root for security reasons.
    337322
    338 Create this file for example `/etc/apache2/sites-enabled/trac.my-proj.my-site.org.conf` on Ubuntu with the following content:
     323Create this file e.g. (ubuntu) `/etc/apache2/sites-enabled/trac.my-proj.my-site.org.conf` with the following content:
    339324
    340325{{{#!apache
     
    359344}}}
    360345
    361 For subdomains to work you would probably also need to alter `/etc/hosts` and add A-Records to your host's DNS.
     346Note: for subdomains to work you would probably also need to alter `/etc/hosts` and add A-Records to your host's DNS.
    362347
    363348== Troubleshooting
     
    365350=== Use a recent version
    366351
    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
     352Please 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''
    370355
    371356If 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.
     
    373358=== Getting Trac to work nicely with SSPI and 'Require Group'
    374359
    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:
     360If 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
     362This WSGI script 'fixes' that:
    378363{{{#!python
    379364import os
     
    411396Now Trac drops the connection after serving a page and the connection count on the database will be kept low.
    412397
    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].
     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.//
    428399
    429400=== Other resources
    430401
    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.
     402For 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.
    432403
    433404----