Changes between Version 2 and Version 3 of TracModWSGI


Ignore:
Timestamp:
Jun 28, 2019, 2:20:16 PM (5 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracModWSGI

    v2 v3  
    1 = Trac と mod_wsgi = #Tracandmod_wsgi
    2 
    3 
    4 [http://code.google.com/p/modwsgi/ mod_wsgi] は WSGI 互換の Python アプリケーションを Apache 上で直接起動させることができる Apache のモジュールです。 mod_wsgi アダプターは完全に C 言語で書かれており、すばらしいパフォーマンスを提供します。
     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.
    54
    65[[PageOutline(2-3,Overview,inline)]]
    76
    8 == `trac.wsgi` スクリプト == #trac.wsgiscript
    9 
    10 Trac は以下に記すスクリプトによって mod_wsgi のトップで実行されます。これらスクリプトは単なる Python ファイルで、通常は `.wsgi` という拡張子で保存されます。
    11 
    12 === 基本的なスクリプト === #Averybasicscript
    13 もっともシンプルな形式:
     7== The `trac.wsgi` script
     8
     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.
     10
     11A 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
     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):
     14{{{#!python
     15def application(environ, start_request):
     16    # Add this when you have multiple projects
     17    environ.setdefault('trac.env_parent_dir', '/usr/share/trac/projects') 
     18    ..
     19}}}
     20
     21=== A very basic script
     22
     23In its simplest form, the script could be:
    1424
    1525{{{#!python
    … …  
    2333}}}
    2434
    25 環境変数 `TRAC_ENV` は通常通り Trac environment のディレクトリを指定します (複数の Trac environment を含むディレクトリであれば `TRAC_ENV_PARENT_DIR` を使うこともできます)。 `PYTHON_EGG_CACHE` は Python eggs を一時的に展開するのに使用するディレクトリを指定します。
    26 
    27 === 複雑なスクリプト === #Amoreelaboratescript
    28 
    29 複数の `.wsgi` ファイルを使用する場合 (それぞれのファイルに別個の Trac environment を設定するケースなど) は、 `os.environ['TRAC_ENV']` に Trac environment のパスを ''設定しない'' でください。この方法を使うと、別の Trac environment のコンテンツが読み込まれたり、直前に表示した Trac environment のパスが使われてしまうことがあります。
    30 
    31 この問題は `.wsgi` ファイルの内容を下記の通り変更することで回避できます:
     35The `TRAC_ENV` variable should naturally be the directory for your Trac environment, and the `PYTHON_EGG_CACHE` should be a directory where Python can temporarily extract Python eggs. If you have several Trac environments in a directory, you can also use `TRAC_ENV_PARENT_DIR` instead of `TRAC_ENV`.
     36
     37On Windows:
     38 - If run under the user's session, the Python Egg cache can be found in `%AppData%\Roaming`, for example:
     39{{{#!python
     40os.environ['PYTHON_EGG_CACHE'] = r'C:\Users\Administrator\AppData\Roaming\Python-Eggs'
     41}}}
     42 - If run under a Window service, you should create a directory for Python Egg cache:
     43{{{#!python
     44os.environ['PYTHON_EGG_CACHE'] = r'C:\Trac-Python-Eggs'
     45}}}
     46
     47=== A more elaborate script
     48
     49If you are using multiple `.wsgi` files (for example one per Trac environment) you must ''not'' use `os.environ['TRAC_ENV']` to set the path to the Trac environment. Using this method may lead to Trac delivering the content of another Trac environment, as the variable may be filled with the path of a previously viewed Trac environment.
     50
     51To solve this problem, use the following `.wsgi` file instead:
    3252{{{#!python
    3353import os
    … …  
    3757import trac.web.main
    3858def application(environ, start_response):
    39   environ['trac.env_path'] = '/usr/local/trac/mysite'
     59  environ['trac.env_path'] = '/usr/local/trac/mysite' 
    4060  return trac.web.main.dispatch_request(environ, start_response)
    4161}}}
    4262
    43 分かりやすくするために、このファイルの拡張子は `.wsgi` とすべきです。 Apache にアクセス権を開放できるのであれば、このファイルは自分が所有権を持つディレクトリに置くこともできます。
    44 
    45 Trac と egg ファイルをインストールしたパスが通常と異なる場合、それらのパスを以下の要領で wsgi スクリプトの先頭に記述する必要があります:
     63For clarity, you should give this file a `.wsgi` extension. You should probably put the file in its own directory, since you will expose it to Apache.
     64
     65If you have installed Trac and Python eggs in a path different from the standard one, you should add that path by adding the following code at the top of the wsgi script:
    4666
    4767{{{#!python
    … …  
    5070}}}
    5171
    52 パスはインストールした Trac のライブラリに一致するように変更してください。
    53 
    54 === 推奨される `trac.wsgi` スクリプト === #Recommendedtrac.wsgiscript
    55 
    56 比較的堅牢で汎用的なファイルを生成するためには `trac-admin <env> deploy <dir>` コマンドを使用します。コマンドを実行すると必要となるパスが自動的に設定されます (TracInstall#cgi-bin 参照) 。
    57 
    58 
    59 == スクリプトのリクエストをマッピングする == #Mappingrequeststothescript
    60 
    61 .wsgi スクリプトを作成したら、Apache の設定ファイル (例えば `httpd.conf`) に以下を追記してください。
    62 
    63 {{{
     72Change it according to the path you installed the Trac libs at.
     73
     74== Mapping requests to the script
     75
     76After preparing your .wsgi script, add the following to your Apache configuration file, typically `httpd.conf`:
     77
     78{{{#!apache
    6479WSGIScriptAlias /trac /usr/local/trac/mysite/apache/mysite.wsgi
    6580
    6681<Directory /usr/local/trac/mysite/apache>
    6782    WSGIApplicationGroup %{GLOBAL}
    68     Order deny,allow
    69     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>
    7092</Directory>
    7193}}}
    7294
    73 スクリプトは Trac environment のサブディレクトリにあります。
    74 
    75 [trac:TracInstall#cgi-bin Trac cgi-bin ディレクトリを生成する] のならば、Apache の設定ファイルには以下のように記述してください:
    76 
    77 {{{
     95Here, the script is in a subdirectory of the Trac environment.
     96
     97If you followed the directions [TracInstall#cgi-bin Generating the Trac cgi-bin directory], your Apache configuration file should look like following:
     98
     99{{{#!apache
    78100WSGIScriptAlias /trac /usr/share/trac/cgi-bin/trac.wsgi
    79101
    80102<Directory /usr/share/trac/cgi-bin>
    81103    WSGIApplicationGroup %{GLOBAL}
    82     Order deny,allow
    83     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>
    84113</Directory>
    85114}}}
    86115
    87 Apache がスクリプトを起動する為には、スクリプトが含まれるディレクトリまで完全に Apache がアクセスできなければなりません。 `WSGIApplicationGroup` ディレクティブを使用すると、常に mod_wsgi が作成した最初の Python インタプリタ内で Trac が起動することが保証されます。これは Trac で使用している Subversion の Python バインディングがサブインタプリタでは動作しないことがあるため必要になります。リクエストがハングし、 Apache がクラッシュしたような結果が返ります。この設定を行った後は Apache を再起動しないと反映されません。
    88 
    89 Apache, mod_wsgi, Python 本体 (Trac とその依存ライブラリを除く) の設定をテストしたい場合、簡単な wsgi アプリケーションを使用するとリクエストが処理されているか確認することができます (以下に示す内容だけを持つ `.wsgi` スクリプトを使用してください):
     116In 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.
     117
     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):
    90119
    91120{{{#!python
    … …  
    95124}}}
    96125
    97 mod_wsgi の特定ディレクティブの使用方法についての詳細は、 [http://code.google.com/p/modwsgi/wiki/ mod_wsgi's wiki] または [http://code.google.com/p/modwsgi/wiki/IntegrationWithTrac インストール例] を参照してください。
    98 
    99 
    100 == 認証の設定 == #ConfiguringAuthentication
    101 
    102 このセクション内では認証の設定方法をいくつか記述します。
    103 
    104 Apache ガイドの [http://httpd.apache.org/docs/2.2/howto/auth.html 認証、許可、アクセスコントロール] も参照してください。
    105 
    106 === 基本認証 === #UsingBasicAuthentication
    107 
    108 Apache で認証を追加する最も簡単な方法は、パスワードファイルを作成することです。 `htpasswd` プログラムを使用してパスワードファイルを作成します:
    109 {{{
     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.
     127
     128== Configuring Authentication
     129
     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.
     131
     132=== Using Basic Authentication
     133
     134The simplest way to enable authentication with Apache is to create a password file. Use the `htpasswd` program as follows:
     135{{{#!sh
    110136$ htpasswd -c /somewhere/trac.htpasswd admin
    111137New password: <type password>
    … …  
    114140}}}
    115141
    116 一番最初のユーザ以外は "-c" オプションは必要ありません:
    117 {{{
     142After the first user, you don't need the "-c" option anymore:
     143{{{#!sh
    118144$ htpasswd /somewhere/trac.htpasswd john
    119145New password: <type password>
    … …  
    122148}}}
    123149
    124   '' `htpasswd` についての詳細は man を参照してください。''
    125 
    126 ユーザを作成した後、TracPermissions の記述通りユーザに権限を設定することができます。
    127 
    128 Apache の設定ファイルの中にパスワードファイルを記述し、認証を有効にする必要があります:
    129 {{{
     150See the man page for `htpasswd` for full documentation.
     151
     152After you've created the users, you can set their permissions using TracPermissions.
     153
     154Now, you need to enable authentication against the password file in the Apache configuration:
     155{{{#!apache
    130156<Location "/trac/login">
    131157  AuthType Basic
    … …  
    136162}}}
    137163
    138 複数のプロジェクトを持っている場合でも、共通のパスワードファイルを使用することができます:
    139 {{{
     164If you are hosting multiple projects, you can use the same password file for all of them:
     165{{{#!apache
    140166<LocationMatch "/trac/[^/]+/login">
    141167  AuthType Basic
    … …  
    145171</LocationMatch>
    146172}}}
    147 Note: 'login'  という名のファイルやディレクトリが必要なわけではありません。[[BR]]
    148 [http://httpd.apache.org/docs/2.2/mod/mod_auth_basic.html mod_auth_basic] も参照してください。
    149 
    150 === ダイジェスト認証 === #UsingDigestAuthentication
    151 
    152 セキュリティ強化のために、SSL を有効にするか、少なくとも "基本認証" の代わりに "ダイジェスト認証" を使用することを推奨します。
    153 
    154 以下のように、`htpasswd` の代わりに `htdigest` コマンドを使用して `.htpasswd` ファイルを作成してください:
    155 {{{
    156 # htdigest -c /somewhere/trac.htpasswd trac admin
    157 }}}
    158 
    159 上記の "trac" パラメータは "realm" です。Apache の設定ファイルの !AuthName ディレクティブで再度指定してください:
    160 
    161 {{{
     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.
     175
     176=== Using Digest Authentication
     177
     178For better security, it is recommended that you either enable SSL or at least use the "digest" authentication scheme instead of "Basic".
     179
     180You have to create your `.htpasswd` file with the `htdigest` command instead of `htpasswd`, as follows:
     181{{{#!sh
     182$ htdigest -c /somewhere/trac.htpasswd trac admin
     183}}}
     184
     185The "trac" parameter above is the "realm", and will have to be reused in the Apache configuration in the !AuthName directive:
     186
     187{{{#!apache
    162188<Location "/trac/login">
    163 
    164     AuthType Digest
    165     AuthName "trac"
    166     AuthDigestDomain /trac
    167     AuthUserFile /somewhere/trac.htpasswd
    168     Require valid-user
     189  AuthType Digest
     190  AuthName "trac"
     191  AuthDigestDomain /trac
     192  AuthUserFile /somewhere/trac.htpasswd
     193  Require valid-user
    169194</Location>
    170195}}}
    171196
    172 複数の environment を持っている場合、上記に記述した方法で、同じ `LocationMatch` を使用することができます。
    173 
    174 必ず mod_auth_digest をアクティブにしてください。 Debian 4.0r1 (etch) の例:
    175 {{{
    176     LoadModule auth_digest_module /usr/lib/apache2/modules/mod_auth_digest.so
    177 }}}
    178 
    179 
    180 [http://httpd.apache.org/docs/2.2/mod/mod_auth_digest.html mod_auth_digest] も参照してください。
    181 
    182 === LDAP 認証 === #UsingLDAPAuthentication
    183 
    184 Apache の [http://httpd.apache.org/docs/2.2/mod/mod_ldap.html mod_ldap] 認証の設定ファイルは少し扱いにくいです。(httpd 2.2.x  OpenLDAP: slapd 2.3.19)
    185 
    186 1. Apache の httpd.conf に以下のモジュールをロードする必要があります
    187 {{{
    188 LoadModule ldap_module modules/mod_ldap.so
    189 LoadModule authnz_ldap_module modules/mod_authnz_ldap.so
    190 }}}
    191 
    192 2. httpd.conf は以下のようになります:
    193 
    194 {{{
     197For multiple environments, you can use the same `LocationMatch` as described with the previous method.
     198
     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.
     200
     201Don't forget to activate the mod_auth_digest. For example, on a Debian 4.0r1 (etch) system:
     202{{{#!apache
     203  LoadModule auth_digest_module /usr/lib/apache2/modules/mod_auth_digest.so
     204}}}
     205
     206See also the [https://httpd.apache.org/docs/2.4/mod/mod_auth_basic.html mod_auth_digest] documentation.
     207
     208=== Using LDAP Authentication
     209
     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).
     211
     2121. You need to load the following modules in Apache httpd.conf:
     213{{{#!apache
     214  LoadModule ldap_module modules/mod_ldap.so
     215  LoadModule authnz_ldap_module modules/mod_authnz_ldap.so
     216}}}
     2171. Your httpd.conf also needs to look something like:
     218{{{#!apache
    195219<Location /trac/>
    196220  # (if you're using it, mod_python specific settings go here)
    … …  
    206230</Location>
    207231}}}
    208 
    209 
    210 3. Microsoft Active Directory の LDAP インターフェースを使用することもできます:
    211 
    212 
    213 以下を LDAP URL に使用します:
    214 {{{
    215     AuthLDAPURL "ldap://directory.example.com:3268/DC=example,DC=com?sAMAccountName?sub?(objectClass=user)"
    216 }}}
    217 
    218 認証情報をチェックするために Apache にアカウントを提供する必要があります。
    219 このパスワードは設定ファイル内のプレーンテキストにリストアップされるので、
    220 このタスク専用のアカウントを使用すべきです:
    221 {{{
    222     AuthLDAPBindDN ldap-auth-user@example.com
    223     AuthLDAPBindPassword "password"
    224 }}}
    225 
    226 セクション全体はこのようになります:
    227 {{{
     2321. 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
    228243<Location /trac/>
    229244  # (if you're using it, mod_python specific settings go here)
    … …  
    239254  authzldapauthoritative Off
    240255  # require valid-user
    241   require ldap-group CN=Trac Users,CN=Users,DC=company,DC=com
     256  Require ldap-group CN=Trac Users,CN=Users,DC=company,DC=com
    242257</Location>
    243258}}}
    244259
    245 Note 1: このケースでは LDAP 検索で複数の OU をまとめて取得するために、 AD のグローバルカタログサーバ (Global Catalog Server) に接続しています (ポート番号が通常 LDAP で使用される 389 ではなく 3268 であることに注意してください) 。 GCS は基本的に "平らな" ツリーであり、ユーザが、どの OU に属するか不明な場合でも検索することができます。
    246 
    247 Note 2: 有効なログインを持っているかの代わりに、
    248 LDAP グループに所属しているかを要求することができます:
    249 {{{
    250     Require ldap-group CN=Trac Users,CN=Users,DC=example,DC=com
    251 }}}
    252 
    253 関連ページ:
    254   - [http://httpd.apache.org/docs/2.2/mod/mod_authnz_ldap.html mod_authnz_ldap],  mod_authnz_ldap に関するドキュメンテーション
    255 
    256  - [http://httpd.apache.org/docs/2.2/mod/mod_ldap.html mod_ldap], mod_ldap に関するドキュメンテーション。コネクションプールや共有のキャッシュを提供します
    257  - [http://trac-hacks.org/wiki/LdapPlugin TracHacks:LdapPlugin], LDAP の TracPermissions を格納するプラグイン
    258 
    259 === SSPI 認証 === #UsingSSPIAuthentication
    260 
    261 Windows 上で Apache を使用しているのであれば、シングルサインオン機能を提供する mod_auth_sspi を使用することができます。
    262 !SourceForge の [http://sourceforge.net/projects/mod-auth-sspi/ mod-auth-sspi プロジェクト] からモジュールをダウンロードし、
    263 バーチャルホストに以下を追記してください。
    264 {{{
    265     <Location /trac/login>
    266         AuthType SSPI
    267         AuthName "Trac Login"
    268         SSPIAuth On
    269         SSPIAuthoritative On
    270         SSPIDomain MyLocalDomain
    271         SSPIOfferBasic On
    272         SSPIOmitDomain Off
    273         SSPIBasicPreferred On
    274         Require valid-user
    275     </Location>
    276 }}}
    277 
    278 SSPI 認証を使用すると、Trac のユーザ名が `DOMAIN\username` という形式になるので、
    279 パーミッションなどを追加しなおす必要があります。ユーザ名にドメインを入れたくない場合は、
    280 `SSPIOmitDomain On` と代わりに設定してください。
    281 
    282 SSPI 認証に関する共通の問題: [trac:#1055 本家チケット 1055], [trac:#1168 本家チケット 1168], [trac:#3338 本家チケット 3338] 。
    283 
    284 [trac:TracOnWindows/Advanced] も参照してください。
    285 
    286 === !AccountManagerPlugin のログインフォームを使用した Apache 認証 === #UsingApacheauthenticationwiththeAccountManagerplugin'sLoginform
    287 
    288 まず、!AccountManagerPlugin の [http://trac-hacks.org/wiki/AccountManagerPlugin/Modules#LoginModule Login モジュール] と [http://trac-hacks.org/wiki/AccountManagerPlugin/AuthStores#HttpAuthStore HttpAuthStore authentication モジュール] の基本的な仕様を参照してください。
    289 
    290 '''Note:''' acct_mgr-0.4 より前のバージョンの !AccountManager を使用していると、WSGI で !HttpAuthStore を動かすことは難しいです。アップグレードを推奨します。
    291 
    292 単一のプロジェクトに acct_mgr-0.4 を使用した例:
    293 {{{
    294 [components]
    295 ; be sure to enable the component
    296 acct_mgr.http.HttpAuthStore = enabled
    297 
    298 [account-manager]
    299 ; configure the plugin to use a page that is secured with http authentication
    300 authentication_url = /authFile
    301 password_store = HttpAuthStore
    302 }}}
    303 Apache の設定ファイルはこのようになります:
    304 {{{
    305 <Location /authFile>
    306    …HTTP authentication configuration…
    307    Require valid-user
     260Note 1: This is the case where the LDAP search will get around the multiple OUs, conecting to the Global Catalog Server portion of AD. Note 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.
     261
     262Note 2: You can also require the user be a member of a certain LDAP group, instead of just having a valid login:
     263{{{#!apache
     264  Require ldap-group CN=Trac Users,CN=Users,DC=example,DC=com
     265}}}
     266
     267See 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.
     271
     272=== Using SSPI Authentication
     273
     274If 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:
     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
    308286</Location>
    309287}}}
    310 '''authFile''' が存在する必要はありません。前述の !HttpAuthStore へのリンク先から、複数の Trac プロジェクトをサーバー上でホスティングした場合を説明する箇所などを参照してください。
    311 
    312 === 例: バーチャルホストのルートが Trac である Apache/mod_wsgi 基本認証 === #Example:Apache/mod_wsgiwithBasicAuthentication,Trac beingattherootofavirtual host
    313 
    314 上記の mod_wsgi のドキュメントには、 Apache の設定例 a) Trac のインスタンスをバーチャルホストでサブドメインを作成して動かす例と b) Trac の認証として、 Apache の基本認証を設定する例が記載されています。
    315 
    316 
    317 例えば、 trac を !http://trac.my-proj.my-site.org としてホストし、`/home/trac-for-my-proj` フォルダから起動する場合で、 `the-env` を作成するために、 `trac-admin the-env initenv` コマンドを使用し、 `the-deploy` フォルダを作成するために、 `trac-admin the-env deploy the-deploy` コマンドを使用した場合です:
    318 
    319 htpasswd ファイルを作成します:
    320 {{{
     288
     289Using the above, usernames in Trac will be of the form `DOMAIN\username`, so you may have to re-add permissions and such. If you do not want the domain to be part of the username, set `SSPIOmitDomain On` instead.
     290
     291Some common problems with SSPI authentication: [trac:#1055], [trac:#1168] and [trac:#3338].
     292
     293See also [trac:TracOnWindows/Advanced].
     294
     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.
     319
     320=== Example: Apache/mod_wsgi with Basic Authentication, Trac being at the root of a virtual host
     321
     322Per the mod_wsgi documentation linked to above, here is an example Apache configuration that:
     323 - serves the Trac instance from a virtualhost subdomain
     324 - uses Apache basic authentication for Trac authentication.
     325
     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:
     327
     328Create the htpasswd file:
     329{{{#!sh
    321330cd /home/trac-for-my-proj/the-env
    322331htpasswd -c htpasswd firstuser
    … …  
    324333htpasswd htpasswd seconduser
    325334}}}
    326 (セキュリティのため、このファイルはドキュメントルートにおきます)
    327 
    328 以下の設定を含んだファイルを作成します。例 `/etc/apache2/sites-enabled/trac.my-proj.my-site.org.conf` (ubuntu):
    329 
    330 {{{
     335
     336Keep the file above your document root for security reasons.
     337
     338Create this file for example `/etc/apache2/sites-enabled/trac.my-proj.my-site.org.conf` on Ubuntu with the following content:
     339
     340{{{#!apache
    331341<Directory /home/trac-for-my-proj/the-deploy/cgi-bin/trac.wsgi>
    332342  WSGIApplicationGroup %{GLOBAL}
    … …  
    349359}}}
    350360
    351 Note: サブドメインが適切に動くにようにするには、 /etc/hosts ファイルの変更や、ホストサーバの DNS の A レコードにサブドメインを追加する必要があります。
    352 
    353 
    354 == トラブルシューティング == #Troubleshooting
    355 
    356 === 最新バージョンを使う === #Usearecentversion
    357 
    358 `mod_wsgi` のバージョンは 1.6 か 2.4 かそれより新しいものを使用してください。2.4 以前のバージョン 2.X のブランチは WSGI ファイルラッパー拡張機能を使用する Apache の設定にいくつか問題があります。この拡張機能は Trac 内でスタイルシートのような添付ファイルや静的メディアファイルを提供するのに使用します。この問題の影響を受けると、添付ファイルは何もないように見えてしまったり、スタイルシートがうまくロードできなくなることで HTML ページのフォーマットが機能していないように見えてしまったりします。他に 2 進数の添付ファイルが省略されてしまうといった問題も頻繁に起こります。mod_wsgi に関するチケット [http://code.google.com/p/modwsgi/issues/detail?id=100 #100] と [http://code.google.com/p/modwsgi/issues/detail?id=132 #132] を参照してください。
    359 
    360 ''Note: mod_wsgi 2.5 と Python 2.6.1 を使用していると、システム上 (Apache 2.2.11 と Trac 0.11.2.1) で Internal Server Error が発生しました。Python 2.6.2 にアップグレードすることで([http://www.mail-archive.com/modwsgi@googlegroups.com/msg01917.html こちら] で勧められています) 私の場合は解決しました。[[BR]]-- Graham Shanks''
    361 
    362 もし 'mod_wsgi' を Windows の組み込みモードでの使用や Linux 上で MPM worker と併用することを予定している場合, バージョン 0.3.4 以上が必要です。 (詳細については、 [trac:#10675] を参照してください)
    363 
    364 === SSPI および 'Require Group' 使用時に Trac を動かす方法 === #GettingTractoworknicelywithSSPIandRequireGroup
    365 Trac を Win32 上の Apache で起動し、 SSPI 設定して 'Require group' オプションを構成している場合、 'SSPIOmitDomain' オプションはおそらく動作しません。 Trac にユーザ名が認識されない場合は、 'user' が 'DOMAIN\user' のように見えている可能性があります。
    366 
    367 このような場合、以下のように WSGI スクリプトを修正すると解決すると思います:
     361For subdomains to work you would probably also need to alter `/etc/hosts` and add A-Records to your host's DNS.
     362
     363== Troubleshooting
     364
     365=== Use a recent version
     366
     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.
     372
     373=== Getting Trac to work nicely with SSPI and 'Require Group'
     374
     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:
    368378{{{#!python
    369379import os
    … …  
    379389}}}
    380390
    381 
    382 === Trac と PostgreSQL === #TracwithPostgreSQL
    383 
    384 mod_wsgi アダプタを使用し、 Trac のインスタンスを複数ホストしている場合に、 PostgreSQL (もしかすると MySQL も?)をデータベースバックエンドとして使用していると、大量のデータベース接続が生成され、PostgreSQL のプロセスも大量に発生してしまう''かも''しれません。
    385 
    386 荒々しい方法ですが解決策として、Trac が持つコネクションプールを無効化する方法があります。これは `trac.db.postgres_backend` の `PostgreSQLConnection` クラスに `poolable = False` と設定することで適用できます。
    387 
    388 この方法を適用するために、 Trac のソースを変更する必要はありません。以下に示す行を `trac.wsgi` に追加してください:
    389 
    390 {{{
     391=== Trac with PostgreSQL
     392
     393When 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.
     394
     395A somewhat brutal workaround is to disable connection pooling in Trac. This is done by setting `poolable = False` in `trac.db.postgres_backend` on the `PostgreSQLConnection` class.
     396
     397But it is not necessary to edit the source of Trac. The following lines in `trac.wsgi` will also work:
     398
     399{{{#!python
    391400import trac.db.postgres_backend
    392401trac.db.postgres_backend.PostgreSQLConnection.poolable = False
    393402}}}
    394403
    395 または
    396 
    397 {{{
     404or
     405
     406{{{#!python
    398407import trac.db.mysql_backend
    399408trac.db.mysql_backend.MySQLConnection.poolable = False
    400409}}}
    401410
    402 この設定で Trac ページを生成した後にコネクションを捨てるようになり、データベースへの接続数は最小に保たれます。
    403 
    404 //この方法は推奨されたものではありません。[http://code.google.com/p/modwsgi/wiki/IntegrationWithTrac mod_wsgi の IntegrationWithTrac] ページの最後も参照してください。//
    405 
    406 === その他の資料 === #Otherresources
    407 
    408 [TracModPython#Troubleshooting mod_python のトラブルシューティング] セクションも参照してください。 Apache に関連する問題の多くは似通っていて、多くの場合 mod_wsgi を使用する [http://code.google.com/p/modwsgi/wiki/ApplicationIssues アプリケーション側の問題] です。 wsgi ページにも [http://code.google.com/p/modwsgi/wiki/IntegrationWithTrac Integration With Trac] ドキュメントがあります。
    409 
     411Now Trac drops the connection after serving a page and the connection count on the database will be kept low.
     412
     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].
     428
     429=== Other resources
     430
     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.
    410432
    411433----
    412 See also:  TracGuide, TracInstall, [wiki:TracFastCgi FastCGI], [wiki:TracModPython ModPython], [trac:TracNginxRecipe TracNginxRecipe]
     434See also: TracGuide, TracInstall, [wiki:TracFastCgi FastCGI], [wiki:TracModPython ModPython], [trac:TracNginxRecipe TracNginxRecipe]