1 | | [[PageOutline]] |
2 | | |
3 | | = Trac を FastCGI で使用する = #TracwithFastCGI |
4 | | |
5 | | [http://www.fastcgi.com/ FastCGI] インターフェースを使用すると [wiki:TracModPython mod_python] や [wiki:TracModWSGI mod_wsgi] と同様に Trac を常駐させることができます。リクエスト毎に新しいプロセスを開始しなければならない CGI インターフェースよりも処理速度は速くなります。加えて、多種多様の Web サーバでサポートされています。 |
6 | | |
7 | | Note: mod_python とは異なり、FastCGI では [http://httpd.apache.org/docs/suexec.html Apache SuEXEC] をサポートしています。つまり、Web サーバを実行しているユーザとは、異なる権限でプログラムを実行することができます。(`mod_wsgi` でサポートしている `WSGIDaemonProcess` におけるユーザ / グループと同じ効果を得ることができます) |
8 | | |
9 | | '''Windows 向け:''' Trac の FastCGI は Windows 環境下で動作しません。これは、`_fcgi.py` で用いられる `Socket.fromfd` が Windows では実行されないからです。もし IIS へ接続したい場合は、[trac:TracOnWindowsIisAjp AJP]/[trac:TracOnWindowsIisAjp ISAPI] に挑戦してみて下さい。 |
10 | | |
11 | | [[PageOutline(2-3,Overview,inline)]] |
12 | | |
13 | | |
14 | | == 単純な Apache の設定 == #SimpleApacheconfiguration |
15 | | |
16 | | Apache で利用可能な FastCGI モジュールは 2 種類あります: `mod_fastcgi` と |
17 | | `mod_fcgid` (推奨) です。後者の方がよりメンテナンスされています。 |
18 | | |
19 | | 次の項目では、FCGI の特定のセットアップに焦点を合わせています。Apache の認証の設定方法については [wiki:TracModWSGI#ConfiguringAuthentication] を参照してください。 |
20 | | |
21 | | CGI モジュールを使用する場合は注意してください。また、必ず Web サーバに cgi-bin フォルダの実行権限を持たせてください。 FastCGI では詳細な権限に関するエラーが出力されますが、mod_fcgid ではこの処理が行われていない場合には、不明瞭なエラーしか出力されません。(Connection reset by peer: mod_fcgid: error reading data from FastCGI server の様な) |
22 | | |
23 | | === `mod_fastcgi` でのセットアップ === #setupwithmod_fastcgi |
24 | | `mod_fastcgi` では `FastCgiIpcDir` と `FastCgiConfig` ディレクティブを使用して Apache の設定ファイルに設定を行います: |
25 | | {{{ |
| 1 | = Trac with FastCGI |
| 2 | |
| 3 | [[TracGuideToc]] |
| 4 | [[PageOutline(2-5, Contents, floated)]] |
| 5 | |
| 6 | [http://www.fastcgi.com/ FastCGI] interface allows Trac to remain resident much like with [wiki:TracModPython mod_python] or [wiki:TracModWSGI mod_wsgi]. It is faster than external CGI interfaces which must start a new process for each request. Additionally, it is supported by a much wider variety of web servers. |
| 7 | |
| 8 | Note that unlike mod_python, FastCGI supports [http://httpd.apache.org/docs/suexec.html Apache SuEXEC], ie run with different permissions than the web server runs with. `mod_wsgi` supports the `WSGIDaemonProcess` with user / group parameters to achieve the same effect. |
| 9 | |
| 10 | '''Note for Windows:''' Trac's FastCGI 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, you may want to try [trac:TracOnWindowsIisAjp AJP]/[trac:TracOnWindowsIisAjp ISAPI]. |
| 11 | |
| 12 | == Apache configuration |
| 13 | |
| 14 | There are two FastCGI modules commonly available for Apache: `mod_fastcgi` and `mod_fcgid` (preferred). The latter is more up-to-date. |
| 15 | |
| 16 | The following sections focus on the FCGI specific setup, see also [wiki:TracModWSGI#ConfiguringAuthentication] for configuring the authentication in Apache. |
| 17 | |
| 18 | Regardless of which cgi module is used, be sure the web server has executable permissions on the cgi-bin folder. While FastCGI will throw specific permissions errors, mod_fcgid will throw an ambiguous error if this has not been done: `Connection reset by peer: mod_fcgid: error reading data from FastCGI server`. |
| 19 | |
| 20 | === Set up with `mod_fastcgi` |
| 21 | |
| 22 | `mod_fastcgi` uses `FastCgiIpcDir` and `FastCgiConfig` directives that should be added to an appropriate Apache configuration file: |
| 23 | {{{#!apache |
35 | | デフォルトの設定に問題がなければ、 `FastCgiIpcDir` の設定は必須ではありません。 `LoadModule` の行は `IfModule` グループの後になければいけないことに注意して下さい。 |
36 | | |
37 | | `ScriptAlias` もしくは TracCgi で説明されている類似のオプションを設定しますが、 |
38 | | `trac.cgi` の代わりに `trac.fcgi` を指定してください。 |
39 | | |
40 | | すべてデフォルトで `TRAC_ENV` をセットアップするつもりならば、Apache の設定ファイルに以下を追加します (`FastCgiIpcDir` より下に): |
41 | | {{{ |
| 33 | |
| 34 | Setting `FastCgiIpcDir` is optional if the default is suitable. Note that the `LoadModule` line must be after the `IfModule` group. |
| 35 | |
| 36 | Configure `ScriptAlias` or similar options as described in TracCgi, but calling `trac.fcgi` instead of `trac.cgi`. |
| 37 | |
| 38 | Add the following to the Apache configuration file (below the `FastCgiIpcDir` line) if you intend to set up the `TRAC_ENV` as an overall default: |
| 39 | {{{#!apache |
50 | | === `mod_fcgid` でのセットアップ === #Setupwithmod_fcgid |
51 | | `ScriptAlias` を設定します。 (詳細は TracCgi を参照してください)、 ただし |
52 | | trac.cgi` の代わりに `trac.fcgi` を呼び出します。 Note: 最後のスラッシュを忘れずに。とても重要です。 |
53 | | {{{ |
| 48 | You can also specify the `PYTHON_EGG_CACHE` environment variable using a second `-initial-env` directive: |
| 49 | {{{#!apache |
| 50 | FastCgiConfig -initial-env TRAC_ENV=/var/lib/trac \ |
| 51 | -initial-env PYTHON_EGG_CACHE=/var/lib/trac/plugin-cache |
| 52 | }}} |
| 53 | |
| 54 | === Set up with `mod_fcgid` |
| 55 | |
| 56 | Configure `ScriptAlias` (see TracCgi for details), but call `trac.fcgi` instead of `trac.cgi`: |
| 57 | {{{#!apache |
66 | | === Environment を設定する別の方法 === #alternativeenvironmentsetup |
67 | | Trac environment へのパスを設定するための、より適した方法は、パスを |
68 | | `trac.fcgi` スクリプト自体に書き込むことです。これによってサーバの環境変数を |
69 | | 設定する必要がなくなり、どちらの !FastCgi モジュール (および |
70 | | [http://www.lighttpd.net/ lighttpd] や CGI など) でも、動作するようになります: |
71 | | {{{ |
| 68 | === Alternative environment setup |
| 69 | |
| 70 | A better method to specify the path to the Trac environment is to embed the path into `trac.fcgi` script itself. That doesn't require configuration of the server environment variables, works for both [trac:FastCgi] modules as well as for [http://www.lighttpd.net/ lighttpd] and CGI: |
| 71 | {{{#!python |
89 | | == Cherokee の簡単な設定 == #SimpleCherokeeConfiguration |
90 | | |
91 | | Cherokee 側の設定はとても簡単です。 Trac を SCGI プロセスとして起動できるかどうかのみ知っている必要があります。 |
92 | | Cherokee が起動していないときにはいつでも、 Cherokee が Trac を切り離せるようにすることによって、 Trac を手動で起動することも、いっそのこと自動的に起動することもできます。 |
93 | | 最初に、ローカルのインタプリタである cherokee-admin で information source を設定します。 |
| 89 | == Cherokee Configuration |
| 90 | |
| 91 | Configuring [http://cherokee-project.com/ Cherokee] with Trac is straightforward, if you spawn Trac as an SCGI process. You can either start it manually, or better yet, automatically by letting Cherokee spawn the server whenever it is down. |
| 92 | |
| 93 | First set up an information source in cherokee-admin with a local interpreter: |
103 | | もしそのポート番号に到達できなければ、インタプリタコマンドは起動されたことになります。information source の定義において、 ''ローカルインタプリタ'' の代わりに、 ''リモートホスト'' を ''information source'' として使用するならば、 spawner を手動で起動する必要があることを覚えておいてください。 |
104 | | |
105 | | そして、 Trac にアクセスするために SCGI ハンドラによって管理される新しいルールを作成しなければなりません。このルールは例えば、 trac.example.net という新しい仮想サーバ内で作成し、 2 つのルールのみを必要とします。 '''デフォルト''' ルールは以前に作成された information source に関する SCGI ハンドラで使用されます。 |
106 | | 2 つ目のルールは Trac のインタフェースを正しく表示するために必要ないくつかの静的ファイルを扱うために設定します。ルールを ''/common'' の ''ディレクトリルール'' として作成し、 ''静的ファイル'' のハンドラを適切なファイルをポイントする ''ドキュメントルート'' と共に設定するだけです: ''$TRAC_LOCAL/htdocs/'' ($TRAC_LOCAL はユーザ又はローカル Trac リソース を置いたシステム管理者により定義されたディレクトリです) |
107 | | |
108 | | Note:\\ |
109 | | tracd プロセスが起動しない場合や cherokee が 503 エラーページを表示する場合、 [http://trac.saddi.com/flup python-flup] がインストールされていない可能性があります。\\ |
110 | | Python-flup は SCGI の能力を trac に与える従属関係にあります。 debian 基本システムからインストールできます: |
111 | | {{{ |
| 103 | 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''. |
| 104 | |
| 105 | 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. |
| 106 | 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 ''/common'' and just set it to the ''Static files'' handler and with a ''Document root'' that points to the appropriate files: ''$TRAC_LOCAL/htdocs/'' (where $TRAC_LOCAL is a directory defined by the user or the system administrator to place local Trac resources). |
| 107 | |
| 108 | '''Note:''' If the tracd process fails to start up, and Cherokee displays a 503 error page, you might be missing the [http://trac.saddi.com/flup python-flup] package ([trac:#9903]). Python-flup is a dependency which provides Trac with SCGI capability. You can install it on Debian based systems with: |
| 109 | {{{#!sh |
115 | | |
116 | | == Lighttpd の簡単な設定 == #SimpleLighttpdConfiguration |
117 | | |
118 | | FastCGI フロントエンドは最初 [http://www.lighttpd.net/ lighttpd] のような、 Apache 以外の Web サーバのために開発されました。 |
119 | | |
120 | | lighttpd はセキュアで高速で、規格に準拠したとても柔軟な Web サーバで、高いパフォーマンスの環境で最適化されます。 |
121 | | 他の Web サーバに比べて CPU や、メモリの占有率がとても少ないです。 |
122 | | |
123 | | `trac.fcgi`(0.11 以前) / fcgi_frontend.py (0.11) を lighttpd で使用するためには、 lighttpd.conf に以下の行を追加します: |
| 113 | == Lighttpd Configuration |
| 114 | |
| 115 | The FastCGI front-end was developed primarily for use with alternative webservers, such as [http://www.lighttpd.net/ Lighttpd]. |
| 116 | |
| 117 | Lighttpd is a secure, fast, compliant and very flexible web-server that has been optimized for high-performance environments. It has a very low memory footprint compared to other web servers and takes care of CPU load. |
| 118 | |
| 119 | For using `trac.fcgi`(prior to 0.11) / fcgi_frontend.py (0.11) with Lighttpd add the following to your lighttpd.conf: |
140 | | 動かしたい Trac のインスタンス毎に `fastcgi.server` のエントリを追加する必要があります。別の方法として、上記の `TRAC_ENV` の代わりに `TRAC_ENV_PARENT_DIR` を使用でき、 |
141 | | `lighttpd.conf` に設定する代わりに `trac.fcgi` ファイルに |
142 | | `bin-environment` (上記の Apache の設定 に書かれています) の2つのうちのどちらかを設定します。 |
143 | | |
144 | | Note: lighttpd には 'SCRIPT_NAME' と 'PATH_INFO' に関するバグがあります。例として、 fastcgi.server の uri が '/trac' とするところを '/' としてしまいます。 ([trac:#2418 本家チケット 2418] 参照) このバグは lighttpd 1.4.23 以降で修正されています。 fastcgi.server のパラメータとして、 `"fix-root-scriptname" => "enable"` を追加する必要があるでしょう。 |
145 | | |
146 | | lighttpd で2つのプロジェクトを動かすには、 `lighttpd.conf` に以下の設定を追加します: |
| 136 | Note that you will need to add a new entry to `fastcgi.server` for each separate Trac instance that you wish to run. Alternatively, you may use the `TRAC_ENV_PARENT_DIR` variable instead of `TRAC_ENV` as described above, and you may set one of the two in `trac.fcgi` instead of in `lighttpd.conf` using `bin-environment`, as in the section above on Apache configuration. |
| 137 | |
| 138 | Note that Lighttpd has a bug related to 'SCRIPT_NAME' and 'PATH_INFO' when the uri of fastcgi.server is '/' instead of '/trac' in this example (see [trac:#2418]). This is fixed in Lighttpd 1.5, and under Lighttpd 1.4.23 or later the workaround is to add `"fix-root-scriptname" => "enable"` as a parameter of fastcgi.server. |
| 139 | |
| 140 | For using two projects with lighttpd add the following to your `lighttpd.conf`: |
168 | | Note: 各フィールドの値が異なることに注意して下さい。もし、 |
169 | | `.fcgi` スクリプト内の環境変数を設定する方が好ましいならば、 `trac.fcgi` スクリプトを |
170 | | 例えば、 `first.fcgi` や `second.fcgi` というようにコピー / リネームして、上記設定の中でこれらのスクリプトを参照するようにしてください。 |
171 | | 両方のプロジェクトが同じ `trac.fcgi` スクリプトから起動しているとしても、 |
172 | | 異なるプロセスになることに注意して下さい。 |
173 | | |
174 | | {{{ |
175 | | #!div class=important |
176 | | '''Note''': server.modules をロードする順番はとても重要です。もし、 mod_auth が mod_fastcgi より '''先に''' mod_auth がロードされない設定になっていない場合、サーバはユーザ認証に失敗します。 |
177 | | }}} |
178 | | |
179 | | 認証のために lighttpd.conf の 'server.modules' 中で mod_auth を有効にして、 auth.backend と認証方法を選択して下さい: |
| 162 | |
| 163 | Note that the field values are different. If you prefer setting the environment variables in the `.fcgi` scripts, then copy/rename `trac.fcgi`, eg to `first.fcgi` and `second.fcgi`, and reference them in the above settings. |
| 164 | Note that the above will result in different processes in any event, even if both are running from the same `trac.fcgi` script. |
| 165 | |
| 166 | {{{#!div class=important |
| 167 | '''Note:''' The order in which the server.modules are loaded is very important: if mod_auth is not loaded '''before''' mod_fastcgi, then the server will fail to authenticate the user. |
| 168 | }}} |
| 169 | |
| 170 | For authentication you should enable mod_auth in lighttpd.conf 'server.modules', select auth.backend and auth rules: |
290 | | 使用言語指定の詳細については [http://trac.lighttpd.net/trac/wiki/TracFaq TracFaq] の 2.13 の質問を参照して下さい。 |
291 | | |
292 | | [wiki:TracInstall#MappingStaticResources 静的なリソースのマッピングに関する事] の様な他の重要な情報は、fastcgi 以外でもインストールの詳細をつかむのに有効です。 |
293 | | ] |
294 | | |
295 | | lighttpd を再起動し、ブラウザに `http://yourhost.example.org/trac` を入力して、 Trac にアクセスして下さい。 |
296 | | |
297 | | 制限された権限で lighttpd を起動するにあたって気をつけること: |
298 | | |
299 | | もし、 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 を起動するユーザに適宜読み替えてください。) |
300 | | |
301 | | |
302 | | == !LiteSpeed の簡単な設定 == #SimpleLighttpdConfiguration |
303 | | |
304 | | FastCGI フロントエンドは最初 [http://www.litespeedtech.com/ LiteSpeed] のような、 Apache 以外の Web サーバのために開発されました。 |
305 | | |
306 | | !LiteSpeed Web サーバはイベント駆動、非同期型であり、 Apache に代わるものとしてセキュアで拡張可能になるようにゼロからデザインされています。そして、最低限のリソースで操作できます。 !LiteSpeed は Apache の設定ファイルから直接操作でき、ビジネスに不可欠な環境をターゲットにしています。 |
307 | | |
308 | | 1. 最初に Trac プロジェクトをインストールして動作することを確認して下さい。最初のインストールでは、 "tracd" を使用します |
309 | | |
310 | | 2. このセットアップでは仮想ホストを作成します。以下、この仮想ホストのことを !TracVhost と呼びます。このチュートリアルで、先ほど作ったプロジェクトが以下の URL 経由でアクセスできると仮定します: |
311 | | |
| 283 | |
| 284 | For details about languages specification see [trac:TracFaq TracFaq] question 2.13. |
| 285 | |
| 286 | Other important information like the [wiki:TracInstall#MappingStaticResources mapping static resources advices] are useful for non-fastcgi specific installation aspects. |
| 287 | |
| 288 | Relaunch Lighttpd and browse to `http://yourhost.example.org/trac` to access Trac. |
| 289 | |
| 290 | Note about running Lighttpd with reduced permissions: If nothing else helps and trac.fcgi doesn't start with Lighttpd settings `server.username = "www-data"`, `server.groupname = "www-data"`, then in the `bin-environment` section set `PYTHON_EGG_CACHE` to the home directory of `www-data` or some other directory accessible to this account for writing. |
| 291 | |
| 292 | == !LiteSpeed Configuration |
| 293 | |
| 294 | The FastCGI front-end was developed primarily for use with alternative webservers, such as [http://www.litespeedtech.com/ LiteSpeed]. |
| 295 | |
| 296 | !LiteSpeed web server is an event-driven asynchronous Apache replacement designed from the ground-up to be secure, scalable, and operate with minimal resources. !LiteSpeed can operate directly from an Apache config file and is targeted for business-critical environments. |
| 297 | |
| 298 | 1. Please make sure you have a working install of a Trac project. Test install with "tracd" first. |
| 299 | 1. Create a Virtual Host for this setup. From now on we will refer to this vhost as !TracVhost. For this tutorial we will be assuming that your Trac project will be accessible via: |
341 | | |
342 | | もし、 htpasswd ファイルを持っていない、もしくは作り方を知らない場合は、 http://sherylcanter.com/encrypt.php にアクセスし、ユーザ名:パスワード の一対を生成して下さい。 |
343 | | |
344 | | 5. "!PythonVhost → Contexts" へ移動し、新しい "FCGI Context" を作成します |
345 | | |
346 | | {{{ |
347 | | URI: /trac/ <--- URI path to bind to python fcgi app we created |
348 | | Fast CGI App: [VHost Level] MyTractFCGI <--- select the trac fcgi extapp we just created |
| 325 | If you don’t have a htpasswd file or don’t know how to create the entries within one, go to http://sherylcanter.com/encrypt.php, to generate the user:password combos. |
| 326 | 1. Go to "!PythonVhost → Contexts" and create a new FCGI Context: |
| 327 | {{{ |
| 328 | URI: /trac/ <--- URI path to bind to python fcgi app we created |
| 329 | Fast CGI App: [VHost Level] MyTractFCGI <--- select the Trac fcgi extapp we just created |
360 | | |
361 | | 7. !LiteSpeed を "lswsctrl restart" で再起動し、新しい Trac プロジェクトに以下の URL でアクセスします: |
362 | | |
363 | | {{{ |
364 | | http://yourdomain.com/trac/ |
365 | | }}} |
366 | | |
367 | | |
368 | | == Nginx 簡単な設定 == #SimpleNginxConfiguration |
369 | | |
370 | | Nginx は FastCGI プロセスを生成することはできませんが、伝達することができます。そのため、 Trac を独立して FastCGI サーバを開始する必要があります。 |
371 | | |
372 | | 1. 基本認証を行う Nginx の設定 - 0.6.32 で動作することを確認しました |
373 | | {{{ |
| 339 | 1. Restart !LiteSpeed: `lswsctrl restart`, and access your new Trac project at {{{http://yourdomain.com/trac/}}}. |
| 340 | |
| 341 | == Nginx Configuration |
| 342 | |
| 343 | [http://nginx.org/en/ Nginx] is able to communicate with FastCGI processes, but can not spawn them. So you need to start FastCGI server for Trac separately. |
| 344 | |
| 345 | 1. Nginx configuration with basic authentication handled by Nginx - confirmed to work on 0.6.32 |
| 346 | {{{#!nginx |
474 | | |
475 | | 3. nginx をリロードし、 trac.fcgi をこのように起動します: |
476 | | |
477 | | {{{ |
478 | | trac@trac.example ~ $ ./trac-standalone-fcgi.py |
479 | | }}} |
480 | | |
481 | | 上記設定は以下の条件だと仮定します: |
482 | | * trac のインスタンスを実行するためのユーザ名を 'trac' とします。ホームディレクトリに trac Environment をおきます |
483 | | * Trac environment は `/home/trac/instance` に配置します |
484 | | * `/home/trac/htpasswd` に認証情報が含まれています |
485 | | * `/home/trac/run` は nginx を起動しているグループが所有しています |
486 | | * Linux を使用しているならば、 `/home/trac/run` に (`chmod g+s run`) を設定します |
487 | | * [trac:#7239 本家チケット 7239] のパッチを適用し、ソケットファイルのパーミッションをそのつど修正しなければいけません |
488 | | |
489 | | 残念ですが、 nginx は fastcgi_pass ディレクティブ内の変数展開をサポートしていません。 |
490 | | したがって、 1 つのサーバーブロックから複数の trac インスタンスを起動することができません。 |
491 | | |
492 | | セキュリティ面で不安があるならば、 各 Trac インスタンスを別々のユーザで起動してください。 |
493 | | |
494 | | Trac を FCGI の外部アプリケーションとして起動するもう一つの方法は、[trac:#6224 本家チケット 6224] を参照して下さい。 |
| 440 | 1. Reload nginx and launch trac.fcgi: |
| 441 | {{{#!sh |
| 442 | trac@trac.example ~ $ ./trac-standalone-fcgi.py |
| 443 | }}} |
| 444 | |
| 445 | The above assumes that: |
| 446 | * There is a user named 'trac' for running Trac instances and keeping Trac environments in its home directory |
| 447 | * `/home/trac/instance` contains a Trac environment |
| 448 | * `/home/trac/htpasswd` contains authentication information |
| 449 | * `/home/trac/run` is owned by the same group the Nginx runs under |
| 450 | * and if your system is Linux the `/home/trac/run` has setgid bit set (`chmod g+s run`) |
| 451 | * and patch from [trac:#7239] is applied, or you'll have to fix the socket file permissions every time |
| 452 | |
| 453 | Unfortunately Nginx does not support variable expansion in fastcgi_pass directive. |
| 454 | Thus it is not possible to serve multiple Trac instances from one server block. |
| 455 | |
| 456 | If you worry enough about security, run Trac instances under separate users. |
| 457 | |
| 458 | Another way to run Trac as a FCGI external application is offered in [trac:#6224]. |