Changes between Version 2 and Version 3 of TracFastCgi


Ignore:
Timestamp:
2012/06/16 22:07:38 (9 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracFastCgi

    v2 v3  
    11= Trac を FastCGI で使用する = #TracwithFastCGI 
    22 
    3 バージョン 0.9 以降、 Trac は [http://www.fastcgi.com/ FastCGI] インタフェースに対応するようになりました。 [wiki:TracModPython mod_python] 同様、 Trac を常駐させるため、外部の各リクエストに対して新しいプロセスを生成する CGI インタフェースよりも処理速度が速いです。その上 `mod_python` とは異なり [http://httpd.apache.org/docs/suexec.html SuEXEC] に対応することも可能です。また、より多くの種類の Web サーバにサポートされています。 
    4  
    5 '''Note for Windows:''' Trac's FCGI does not run under Windows, as Windows does not implement `Socket.fromfd`, which is used by `_fcgi.py`. If you want to connect to IIS, your choice may be [trac:TracOnWindowsIisAjp AJP]. 
     3[http://www.fastcgi.com/ FastCGI] インタフェースを使用すると [wiki:TracModPython mod_python] 同様に Trac を常駐させることができます。そのため、外部からのリクエストごとに新しいプロセスを生成する CGI インタフェースよりも処理速度は速くなるうえ、 mod_python では実現出来ない [http://httpd.apache.org/docs/suexec.html Apache の SuEXEC] に対応させることができます (例えば、 Web サーバとは異なる権限で起動させることができます)。また、 mod_python より多くの種類の Web サーバでサポートされています。 
     4 
    65'''Windows 向けの Note:''' Trac の FCGI は Windows では使用できません。 `_fcgi.py` が必要とする `Socket.fromfd` が Windows では実装されていないためです。 IIS を使用しているのであれば、 [http://trac.edgewall.org/wiki/TracOnWindowsIisAjp AJP] を使うこともできます。 (訳注: Apache でも mod_proxy_ajp 経由で ajp を使用できます。) 
    76 
    87== 単純な Apache の設定 == #SimpleApacheconfiguration 
    98 
    10 Apache で利用可能な FastCGI モジュールは 2 種類あります: `mod_fastcgi` と  
    11 `mod_fcgid` です。これ以降に書かれている `FastCgiIpcDir` と `FastCgiConfig` ディレクティブ 
    12 は `mod_fastcgi` のディレクティブです; `DefaultInitEnv` は `mod_fcgid`  
    13 のディレクティブです。 
    14  
    15 `mod_fastcgi` では、 Apache の設定ファイルに以下の設定を追記します。 
    16 ファイル: 
     9Apache で利用可能な FastCGI モジュールは 2 種類あります: `mod_fastcgi` と 
     10`mod_fcgid` (推奨) です。後者の方がよりメンテナンスされています。 
     11 
     12==== `mod_fastcgi` でのセットアップ ==== #setupwithmod_fastcgi 
     13`mod_fastcgi` では `FastCgiIpcDir` と `FastCgiConfig` ディレクティブを使用して Apache の設定ファイルに設定を行います: 
    1714{{{ 
    1815# Enable fastcgi for .fcgi files 
     
    2724デフォルトの設定に問題がなければ、 `FastCgiIpcDir` の設定は必須ではありません。 `LoadModule` の行は `IfModule` グループの後になければいけないことに注意して下さい。 
    2825 
    29 `ScriptAlias` を設定するもしくは似たオプションが TracCgi で説明されていますが、  
    30 `trac.cgi` の代わりに `trac.fcgi` を呼びます 
     26`ScriptAlias` もしくは TracCgi で説明されている類似のオプションを設定しますが、 
     27`trac.cgi` の代わりに `trac.fcgi` を指定してください 
    3128 
    3229`TRAC_ENV` を以下のように設定することができます: 
     
    3532}}} 
    3633 
    37 もしくは複数の Trac プロジェクトを扱っているときは、このように設定します: 
     34複数の Trac プロジェクトを扱っているときは、このように設定します: 
    3835{{{ 
    3936FastCgiConfig -initial-env TRAC_ENV_PARENT_DIR=/parent/dir/of/projects 
    4037}}} 
    4138 
    42 これらの設定は、 `mod_fcgid` では動きません。似ていますが  
    43 `mod_fcgid` での部分的な解決策は以下の通りになります: 
     39==== `mod_fcgid` でのセットアップ ==== #setupwithmod_fcgid 
     40`ScriptAlias` を設定します。 (詳細は TracCgi を参照してください)、 ただし 
     41`trac.cgi` の代わりに `trac.fcgi` を呼び出します。 Note: 最後のスラッシュを忘れずに。とても重要です。 
     42{{{ 
     43ScriptAlias /trac /path/to/www/trac/cgi-bin/trac.fcgi/ 
     44}}} 
     45 
     46`mod_fcgid` で Trac environment を設定するには `DefaultInitEnv` 
     47ディレクティブを使用します。このディレクティブは `Direcotry` や `Location` 
     48コンテキストで使用できないので、複数のプロジェクトを設定する場合、 
     49下に記述する Environment を設定する別の方法を試してください。 
     50 
    4451{{{ 
    4552DefaultInitEnv TRAC_ENV /path/to/env/trac/ 
    4653}}} 
    47 しかし、これは `Directory` や `Location` コンテキストで使用することができません。 
    48 よって、複数のプロジェクトに対応するのは難しくなります。 
    49  
    50 これらのモジュールの両方 (同様に [http://www.lighttpd.net/ lighttpd] と CGI も) で動かすよりよい方法は、  
    51 `trac.fcgi` に以下の値を設定することです。  
    52 Web サーバに環境変数を設定する必要がなくなります。例: 
     54 
     55==== Environment を設定する別の方法 ==== #alternativeenvironmentsetup 
     56Trac environment へのパスを設定するための、より適した方法は、パスを 
     57`trac.fcgi` スクリプト自体に書き込むことです。これによってサーバの環境変数を 
     58設定する必要がなくなり、どちらの !FastCgi モジュール (および 
     59[http://www.lighttpd.net/ lighttpd] や CGI など) でも、動作するようになります: 
    5360{{{ 
    5461import os 
    5562os.environ['TRAC_ENV'] = "/path/to/projectenv" 
    5663}}} 
    57 or 
     64または 
    5865{{{ 
    5966import os 
     
    6168}}} 
    6269 
    63 プロジェクトごとの `ScriptAliases` と `.fcgi` スクリプトを設定すれば、 
    64 この方法を使用して複数のプロジェクトに対応することができます。  
    65 `trac.fcgi` をコピーして、ファイル名を適切に変更し、上記のコードをそれぞれのスクリプトに追記します。 
    66  
    67 この [https://coderanger.net/~coderanger/httpd/fcgi_example.conf fcgid 設定例] を見たところ、 !ScriptAlias ディレクティブでは末尾の / も含めて、このように設定する: 
     70プロジェクトごとの `ScriptAlias` と `.fcgi` スクリプトを設定すれば、 
     71起動スクリプトに `TRAC_ENV` 等を設定する方法を使用して複数のプロジェクトに対応することができます。 
     72 
     73この [https://coderanger.net/~coderanger/httpd/fcgi_example.conf fcgid 設定例] の通り、 !ScriptAlias ディレクティブでは末尾の / も含めて設定してください: 
    6874{{{ 
    6975ScriptAlias / /srv/tracsite/cgi-bin/trac.fcgi/ 
    7076}}} 
    7177 
    72 == Simple Cherokee Configuration == 
    73  
    74 The configuration on Cherokee's side is quite simple. You will only need to know that you can spawn Trac as an SCGI process. 
    75 You can either start it manually, or better yet, automatically by letting Cherokee spawn the server whenever it is down. 
    76 First set up an information source in cherokee-admin with a local interpreter. 
     78== Cherokee の簡単な設定 == #SimpleCherokeeConfiguration 
     79 
     80Cherokee 側の設定はとても簡単です。 Trac を SCGI プロセスとして起動できるかどうかのみ知っている必要があります。 
     81Cherokee が起動していないときにはいつでも、 Cherokee が Trac を切り離せるようにすることによって、 Trac を手動で起動することも、いっそのこと自動的に起動することもできます。 
     82最初に、ローカルのインタプリタである cherokee-admin で information source を設定します。 
    7783 
    7884{{{ 
     
    8490}}} 
    8591 
    86 If the port was not reachable, the interpreter command would be launched. Note that, in the definition of the information source, you will have to manually launch the spawner if you use a ''Remote host'' as ''Information source'' instead of a ''Local interpreter''. 
    87  
    88 After doing this, we will just have to create a new rule managed by the SCGI handler to access Trac. It can be created in a new virtual server, trac.example.net for instance, and will only need two rules. The '''default''' one will use the SCGI handler associated to the previously created information source. 
    89 The second rule will be there to serve the few static files needed to correctly display the Trac interface. Create it as ''Directory rule'' for ''/chrome/common'' and just set it to the ''Static files'' handler and with a ''Document root'' that points to the appropriate files: ''/usr/share/trac/htdocs/'' 
    90  
    91 == 単純な Lighttpd の設定 == #SimpleLighttpdConfiguration 
     92もしそのポート番号に到達できなければ、インタプリタコマンドは起動されたことになります。information source の定義において、 ''ローカルインタプリタ'' の代わりに、 ''リモートホスト'' を ''information source'' として使用するならば、 spawner を手動で起動する必要があることを覚えておいてください。 
     93 
     94そして、 Trac にアクセスするために SCGI ハンドラによって管理される新しいルールを作成しなければなりません。このルールは例えば、 trac.example.net という新しい仮想サーバ内で作成し、 2 つのルールのみを必要とします。 '''デフォルト''' ルールは以前に作成された information source に関する SCGI ハンドラで使用されます。 
     952 つ目のルールは Trac のインタフェースを正しく表示するために必要ないくつかの静的ファイルを扱うために設定します。ルールを ''/chrome/common'' の ''ディレクトリルール'' として作成し、 ''静的ファイル'' のハンドラを適切なファイルをポイントする ''ドキュメントルート'' と共に設定するだけです: ''/usr/share/trac/htdocs/'' 
     96 
     97Note:\\ 
     98tracd プロセスが起動しない場合や cherokee が 503 エラーページを表示する場合、 [http://trac.saddi.com/flup python-flup] がインストールされていない可能性があります。\\ 
     99Python-flup は SCGI の能力を trac に与える従属関係にあります。 debian 基本システムからインストールできます: 
     100{{{ 
     101sudo apt-get install python-flup 
     102}}} 
     103 
     104== Lighttpd の簡単な設定 == #SimpleLighttpdConfiguration 
    92105 
    93106FastCGI フロントエンドは最初 [http://www.lighttpd.net/ lighttpd] のような、 Apache 以外の Web サーバのために開発されました。 
     
    96109他の Web サーバに比べて CPU や、メモリの占有率がとても少ないです。 
    97110 
    98 `trac.fcgi` (0.11 より前) もしくは fcgi_frontend.py (0.11) を lighttpd で使用するためには、 lighttpd.conf に以下の行を追加します: 
    99 {{{ 
    100 #var.fcgi_binary="/path/to/fcgi_frontend.py" # 0.11 if installed with easy_setup, it is inside the egg directory 
     111`trac.fcgi`(0.11 以前) / fcgi_frontend.py (0.11) を lighttpd で使用するためには、 lighttpd.conf に以下の行を追加します: 
     112{{{ 
     113#var.fcgi_binary="/usr/bin/python /path/to/fcgi_frontend.py" # 0.11 if installed with easy_setup, it is inside the egg directory 
    101114var.fcgi_binary="/path/to/cgi-bin/trac.fcgi" # 0.10 name of prior fcgi executable 
    102115fastcgi.server = ("/trac" => 
     
    113126}}} 
    114127 
    115 動かしたい Trac のインスタンス毎に `fastcgi.server` のエントリを追加する必要があります。別の方法として、上記の `TRAC_ENV` の代わりに `TRAC_ENV_PARENT_DIR` を使用でき、  
     128動かしたい Trac のインスタンス毎に `fastcgi.server` のエントリを追加する必要があります。別の方法として、上記の `TRAC_ENV` の代わりに `TRAC_ENV_PARENT_DIR` を使用でき、  
    116129`lighttpd.conf` に設定する代わりに `trac.fcgi` ファイルに  
    117130`bin-environment` (上記の Apache の設定 に書かれています) の2つのうちのどちらかを設定します。 
     131 
     132Note: lighttpd には fastcgi.server の uri が例えばこの例では、 '/trac' とするところを '/' としてしまう 'SCRIPT_NAME' と 'PATH_INFO' に関するバグがあります。詳細については、 [http://trac.edgewall.org/ticket/2418 本家チケット 2418] を参照して下さい。 このバグは lighttpd 1.4.23 以降で修正されています。 fastcgi.server のパラメータとして、 `"fix-root-scriptname" => "enable"` を追加する必要があるでしょう。 
    118133 
    119134lighttpd で2つのプロジェクトを動かすには、 `lighttpd.conf` に以下の設定を追加します: 
     
    139154                ) 
    140155}}} 
    141 各フィールドの値が異なることに注意して下さい。もし `.fcgi` スクリプトに 
    142 環境変数を設定するほうが好ましい場合は、 `trac.fcgi` をコピー/名前変更をして下さい。例として、 
    143 `first.fcgi` と `second.fcgi` が上記の設定では参照されるようにします 
    144 上記の設定で、両方のプロジェクトが 同じ `trac.fcgi` スクリプトで起動していても、 
     156Note: 各フィールドの値が異なることに注意して下さい。もし、  
     157`.fcgi` スクリプト内の環境変数を設定する方が好ましいならば、 `trac.fcgi` スクリプトを 
     158例えば、 `first.fcgi` や `second.fcgi` というようにコピー / リネームして、上記設定の中でこれらのスクリプトを参照するようにしてください 
     159両方のプロジェクトが同じ `trac.fcgi` スクリプトから起動しているとしても、 
    145160異なるプロセスになることに注意して下さい。 
    146161{{{ 
    147162#!div class=important 
    148 '''Note''' server.modules をロードする順番はとても重要です。 mod_auth が mod_fastcgi より '''先に''' ロードされる設定になっていない場合、サーバはユーザの認証に失敗します。 
     163'''Note''': server.modules をロードする順番はとても重要です。もし、 mod_auth が mod_fastcgi より '''先に''' mod_auth がロードされない設定になっていない場合、サーバはユーザ認証に失敗します。 
    149164}}} 
    150165認証のために lighttpd.conf の 'server.modules' 中で mod_auth を有効にして、 auth.backend と認証方法を選択して下さい: 
     
    186201 
    187202}}} 
    188 パスワードファイルがない場合、 lighttpd (確認したバージョンは 1.4.3) が停止するので注意して下さい。 
    189  
    190 バージョン 1.3.16 以前では lighttpd は 'valid-user' をサポートしていないので注意してください。 
     203Note: パスワードファイルがない場合、 lighttpd (確認したバージョンは 1.4.3) が停止するので注意して下さい。 
     204 
     205Note: バージョン 1.3.16 以前では lighttpd は 'valid-user' をサポートしていないので注意してください。 
    191206 
    192207条件付の設定は静的リソースをマッピングするときに便利です。例として FastCGI を経由せずに直接イメージファイルや CSS を参照するときなどです。: 
     
    261276使用言語指定の詳細については [http://trac.lighttpd.net/trac/wiki/TracFaq TracFaq] の 2.13 の質問を参照して下さい。 
    262277 
    263 その他重要な情報、例えば、 [http://trac.lighttpd.net/trac/wiki/TracInstall lighttpd の TracInstall] や、 [wiki:TracCgi#静的なリソースをマッピングする TracCgi] などは fast-cgi 固有ではありませんが、インストールの詳細をつかむのに有用でしょう。 
     278その他重要な情報、例えば、 [http://trac.lighttpd.net/trac/wiki/TracInstall lighttpd の TracInstall] や、 [wiki:TracCgi#MappingStaticResources TracCgi] などは fast-cgi 固有ではありませんが、インストールの詳細をつかむのに有用でしょう。 
    264279 
    265280trac-0.9 を使用している場合、[http://lists.edgewall.com/archive/trac/2005-November/005311.html 些細なバグ] について読んでください。 
     
    269284制限された権限で lighttpd を起動するにあたって気をつけること: 
    270285 
    271   もし、 trac.fcgi が lighttpd の設定で __server.username = "www-data"__ や __server.groupname = "www-data"__ を設定しても起動せずどうしようもないときは、 `bin-environment` セクションの `PYTHON_EGG_CACHE` を `www-data` のホームディレクトリまたは `www-data` アカウントで書き込みが可能なディレクトリに設定して下さい。 (訳注: debian 系 Linux に限定した話だと思われます。 `www-data` は lighttpd を起動するユーザに適宜読み替えてください。) 
    272  
    273  
    274 == 簡単な !LiteSpeeed の設定 == #SimpleLiteSpeedConfiguration 
    275  
    276 FastCGI フロントエンドは [http://www.litespeedtech.com/ LiteSpeed] のような、 Apache 以外の Web サーバのために開発されました。 
    277  
    278 !LiteSpeed Web サーバはイベント駆動、非同期型であり、Apache に代わるものとしてセキュアで拡張可能になるようにゼロからデザインされています。そして、最低限のリソースで操作できます。 !LiteSpeed は Apache の設定ファイルから直接操作でき、ビジネスに不可欠な環境をターゲットにしています。 
    279  
    280 セットアップ 
    281  
    282 1) 最初に Trac プロジェクトをインストールして動作することを確認して下さい。最初のインストールでは、 "tracd" を使用します。 
    283  
    284 2) このセットアップでは仮想ホストを作成します。以下、この仮想ホストのことを !TracVhost と呼びます。このチュートリアルで、先ほど作ったプロジェクトが以下の URL 経由でアクセスできると仮定します: 
     286  もし、 trac.fcgi が lighttpd の設定で `server.username = "www-data"` や `server.groupname = "www-data"` を設定しても起動せずどうしようもないときは、 `bin-environment` セクションの `PYTHON_EGG_CACHE` を `www-data` のホームディレクトリまたは `www-data` アカウントで書き込みが可能なディレクトリに設定して下さい。 (訳注: debian 系 Linux に限定した話だと思われます。 `www-data` は lighttpd を起動するユーザに適宜読み替えてください。) 
     287 
     288 
     289== !LiteSpeed の簡単な設定 == #SimpleLighttpdConfiguration 
     290 
     291FastCGI フロントエンドは最初 [http://www.litespeedtech.com/ LiteSpeed] のような、 Apache 以外の Web サーバのために開発されました。 
     292 
     293!LiteSpeed Web サーバはイベント駆動、非同期型であり、 Apache に代わるものとしてセキュアで拡張可能になるようにゼロからデザインされています。そして、最低限のリソースで操作できます。 !LiteSpeed は Apache の設定ファイルから直接操作でき、ビジネスに不可欠な環境をターゲットにしています。 
     294 
     295=== セットアップ === 
     296 
     297 1. 最初に Trac プロジェクトをインストールして動作することを確認して下さい。最初のインストールでは、 "tracd" を使用します。 
     298 
     299 2. このセットアップでは仮想ホストを作成します。以下、この仮想ホストのことを !TracVhost と呼びます。このチュートリアルで、先ほど作ったプロジェクトが以下の URL 経由でアクセスできると仮定します: 
    285300 
    286301{{{ 
     
    288303}}} 
    289304 
    290 3) "!TracVhost → External AApps" タブへ移動し、新しい "External Application" を作成します。 
     305 3. "!TracVhost → External Apps" タブへ移動し、新しい "External Application" を作成します。 
    291306 
    292307{{{ 
     
    306321}}} 
    307322 
    308 4) (非必須) "!TracVhost → Security" タブへ移動し、新しいセキュリティ "Realm" を作成することができます。 
     323 4. (非必須) htpasswd ベースの認証を使用するならば、 "!TracVhost → Security" タブへ移動し、新しいセキュリティ "Realm" を作成することができます。 
    309324 
    310325{{{ 
     
    316331もし、 htpasswd ファイルを持っていない、もしくは作り方を知らない場合は、 http://sherylcanter.com/encrypt.php にアクセスし、ユーザ名:パスワード の一対を生成して下さい。 
    317332 
    318 5) "!PythonVhost → Contexts" へ移動し、新しい "FCGI Context" を作成します。 
     333 5. "!PythonVhost → Contexts" へ移動し、新しい "FCGI Context" を作成します。 
    319334 
    320335{{{ 
     
    324339}}} 
    325340 
    326 6) /fullpathto/mytracproject/conf/trac.ini を修正します。 
     341 6. /fullpathto/mytracproject/conf/trac.ini を修正します。 
    327342 
    328343{{{ 
     
    333348}}} 
    334349 
    335 7) !LiteSpeed を "lswsctrl restart" で再起動し、新しい Trac プロジェクトに以下の URL でアクセスします: 
    336  
     350 7. !LiteSpeed を "lswsctrl restart" で再起動し、新しい Trac プロジェクトに以下の URL でアクセスします:  
    337351 
    338352{{{ 
     
    340354}}} 
    341355 
    342 === Simple Nginx Configuration === 
    343  
    344 1) Nginx configuration snippet - confirmed to work on 0.6.32 
     356== Nginx 簡単な設定 == 
     357 
     358 1. Nginx 設定のスニペット - 0.6.32 で動作することを確認しました。 
    345359{{{ 
    346360    server { 
     
    389403            fastcgi_param  SERVER_PORT        $server_port; 
    390404            fastcgi_param  SERVER_PROTOCOL    $server_protocol; 
     405            fastcgi_param  QUERY_STRING     $query_string; 
    391406 
    392407            # for authentication to work 
     
    397412}}} 
    398413 
    399 2) Modified trac.fcgi: 
     414 2. trac.fcgi の変更: 
    400415 
    401416{{{ 
     
    431446}}} 
    432447 
    433 3) reload nginx and launch trac.fcgi like that: 
     448 3. nginx をリロードし、 trac.fcgi をこのように起動します: 
    434449 
    435450{{{ 
     
    437452}}} 
    438453 
    439 The above assumes that: 
    440  * There is a user named 'trac' for running trac instances and keeping trac environments in its home directory. 
    441  * /home/trac/instance contains a trac environment 
    442  * /home/trac/htpasswd contains authentication information 
    443  * /home/trac/run is owned by the same group the nginx runs under 
    444   * and if your system is Linux the /home/trac/run has setgid bit set (chmod g+s run) 
    445   * and patch from ticket #T7239 is applied, or you'll have to fix the socket file permissions every time 
    446  
    447 Unfortunately nginx does not support variable expansion in fastcgi_pass directive.  
    448 Thus it is not possible to serve multiple trac instances from one server block.  
    449  
    450 If you worry enough about security, run trac instances under separate users.  
    451  
    452 Another way to run trac as a FCGI external application is offered in ticket #T6224 
     454上記設定は以下の条件だと仮定します: 
     455 * trac のインスタンスを実行するためのユーザ名を 'trac' とします。ホームディレクトリに trac Environment をおきます。 
     456 * Trac environment は `/home/trac/instance` に配置します。 
     457 * `/home/trac/htpasswd` に認証情報が含まれています。 
     458 * `/home/trac/run` は nginx を起動しているグループが所有しています。 
     459  * Linux を使用しているならば、 `/home/trac/run` に (`chmod g+s run`) を設定します。 
     460  * [http://trac.edgewall.org/ticket/7239 本家チケット 7239] のパッチを適用し、ソケットファイルのパーミッションをそのつど修正しなければいけません。 
     461 
     462残念ですが、 nginx は fastcgi_pass ディレクティブ内の変数展開をサポートしていません。  
     463したがって、 1 つのサーバーブロックから複数の trac インスタンスを起動することができません。  
     464 
     465セキュリティ面で不安があるならば、 各 Trac インスタンスを別々のユーザで起動してください。 
     466 
     467Trac を FCGI の外部アプリケーションとして起動するもう一つの方法は、[http://trac.edgewall.org/ticket/6224 本家チケット 6224] を参照して下さい。 
    453468 
    454469----