1 | | = Trac を FastCGI で使用する = #TracwithFastCGI |
2 | | |
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 | | |
5 | | '''Windows 向けの Note:''' Trac の FCGI は Windows では使用できません。 `_fcgi.py` が必要とする `Socket.fromfd` が Windows では実装されていないためです。 IIS を使用しているのであれば、 [http://trac.edgewall.org/wiki/TracOnWindowsIisAjp AJP] を使うこともできます。 (訳注: Apache でも mod_proxy_ajp 経由で ajp を使用できます。) |
6 | | |
7 | | == 単純な Apache の設定 == #SimpleApacheconfiguration |
8 | | |
9 | | Apache で利用可能な FastCGI モジュールは 2 種類あります: `mod_fastcgi` と |
10 | | `mod_fcgid` (推奨) です。後者の方がよりメンテナンスされています。 |
11 | | |
12 | | ==== `mod_fastcgi` でのセットアップ ==== #setupwithmod_fastcgi |
13 | | `mod_fastcgi` では `FastCgiIpcDir` と `FastCgiConfig` ディレクティブを使用して Apache の設定ファイルに設定を行います: |
| 1 | [[PageOutline]] |
| 2 | |
| 3 | = Trac with FastCGI = |
| 4 | |
| 5 | [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 much wider variety of web servers. |
| 6 | |
| 7 | Note that unlike mod_python, FastCGI supports [http://httpd.apache.org/docs/suexec.html Apache SuEXEC], i.e. run with different permissions than web server running with (`mod_wsgi` supports the `WSGIDaemonProcess` with user / group parameters to achieve the same effect). |
| 8 | |
| 9 | '''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]. |
| 10 | |
| 11 | [[PageOutline(2-3,Overview,inline)]] |
| 12 | |
| 13 | |
| 14 | == Simple Apache configuration == |
| 15 | |
| 16 | There are two FastCGI modules commonly available for Apache: `mod_fastcgi` and |
| 17 | `mod_fcgid` (preferred). The latter is more up-to-date. |
| 18 | |
| 19 | The following sections focus on the FCGI specific setup, see also [wiki:TracModWSGI#ConfiguringAuthentication] for configuring the authentication in Apache. |
| 20 | |
| 21 | 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) |
| 22 | |
| 23 | === Set up with `mod_fastcgi` === |
| 24 | `mod_fastcgi` uses `FastCgiIpcDir` and `FastCgiConfig` directives that should be added to an appropriate Apache configuration file: |
24 | | デフォルトの設定に問題がなければ、 `FastCgiIpcDir` の設定は必須ではありません。 `LoadModule` の行は `IfModule` グループの後になければいけないことに注意して下さい。 |
25 | | |
26 | | `ScriptAlias` もしくは TracCgi で説明されている類似のオプションを設定しますが、 |
27 | | `trac.cgi` の代わりに `trac.fcgi` を指定してください。 |
28 | | |
29 | | `TRAC_ENV` を以下のように設定することができます: |
| 35 | Setting `FastCgiIpcDir` is optional if the default is suitable. Note that the `LoadModule` line must be after the `IfModule` group. |
| 36 | |
| 37 | Configure `ScriptAlias` or similar options as described in TracCgi, but |
| 38 | calling `trac.fcgi` instead of `trac.cgi`. |
| 39 | |
| 40 | 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: |
46 | | `mod_fcgid` で Trac environment を設定するには `DefaultInitEnv` |
47 | | ディレクティブを使用します。このディレクティブは `Direcotry` や `Location` |
48 | | コンテキストで使用できないので、複数のプロジェクトを設定する場合、 |
49 | | 下に記述する Environment を設定する別の方法を試してください。 |
| 57 | To set up Trac environment for `mod_fcgid` it is necessary to use |
| 58 | `DefaultInitEnv` directive. It cannot be used in `Directory` or |
| 59 | `Location` context, so if you need to support multiple projects, try |
| 60 | alternative environment setup below. |
55 | | ==== Environment を設定する別の方法 ==== #alternativeenvironmentsetup |
56 | | Trac environment へのパスを設定するための、より適した方法は、パスを |
57 | | `trac.fcgi` スクリプト自体に書き込むことです。これによってサーバの環境変数を |
58 | | 設定する必要がなくなり、どちらの !FastCgi モジュール (および |
59 | | [http://www.lighttpd.net/ lighttpd] や CGI など) でも、動作するようになります: |
| 66 | === alternative environment setup === |
| 67 | A better method to specify path to Trac environment is to embed the path |
| 68 | into `trac.fcgi` script itself. That doesn't require configuration of server |
| 69 | environment variables, works for both FastCgi modules |
| 70 | (and for [http://www.lighttpd.net/ lighttpd] and CGI as well): |
78 | | == Cherokee の簡単な設定 == #SimpleCherokeeConfiguration |
79 | | |
80 | | Cherokee 側の設定はとても簡単です。 Trac を SCGI プロセスとして起動できるかどうかのみ知っている必要があります。 |
81 | | Cherokee が起動していないときにはいつでも、 Cherokee が Trac を切り離せるようにすることによって、 Trac を手動で起動することも、いっそのこと自動的に起動することもできます。 |
82 | | 最初に、ローカルのインタプリタである cherokee-admin で information source を設定します。 |
| 89 | == Simple Cherokee Configuration == |
| 90 | |
| 91 | The configuration on Cherokee's side is quite simple. You will only need to know that you can spawn Trac as an SCGI process. |
| 92 | You can either start it manually, or better yet, automatically by letting Cherokee spawn the server whenever it is down. |
| 93 | First set up an information source in cherokee-admin with a local interpreter. |
92 | | もしそのポート番号に到達できなければ、インタプリタコマンドは起動されたことになります。information source の定義において、 ''ローカルインタプリタ'' の代わりに、 ''リモートホスト'' を ''information source'' として使用するならば、 spawner を手動で起動する必要があることを覚えておいてください。 |
93 | | |
94 | | そして、 Trac にアクセスするために SCGI ハンドラによって管理される新しいルールを作成しなければなりません。このルールは例えば、 trac.example.net という新しい仮想サーバ内で作成し、 2 つのルールのみを必要とします。 '''デフォルト''' ルールは以前に作成された information source に関する SCGI ハンドラで使用されます。 |
95 | | 2 つ目のルールは Trac のインタフェースを正しく表示するために必要ないくつかの静的ファイルを扱うために設定します。ルールを ''/chrome/common'' の ''ディレクトリルール'' として作成し、 ''静的ファイル'' のハンドラを適切なファイルをポイントする ''ドキュメントルート'' と共に設定するだけです: ''/usr/share/trac/htdocs/'' |
96 | | |
97 | | == Lighttpd の簡単な設定 == #SimpleLighttpdConfiguration |
98 | | |
99 | | FastCGI フロントエンドは最初 [http://www.lighttpd.net/ lighttpd] のような、 Apache 以外の Web サーバのために開発されました。 |
100 | | |
101 | | lighttpd はセキュアで高速で、規格に準拠したとても柔軟な Web サーバで、高いパフォーマンスの環境で最適化されます。 |
102 | | 他の Web サーバに比べて CPU や、メモリの占有率がとても少ないです。 |
103 | | |
104 | | `trac.fcgi`(0.11 以前) / fcgi_frontend.py (0.11) を lighttpd で使用するためには、 lighttpd.conf に以下の行を追加します: |
| 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:\\ |
| 109 | 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.\\ |
| 110 | Python-flup is a dependency which provides trac with SCGI capability. You can install it on debian based systems with: |
| 111 | {{{ |
| 112 | sudo apt-get install python-flup |
| 113 | }}} |
| 114 | |
| 115 | |
| 116 | == Simple Lighttpd Configuration == |
| 117 | |
| 118 | The FastCGI front-end was developed primarily for use with alternative webservers, such as [http://www.lighttpd.net/ lighttpd]. |
| 119 | |
| 120 | lighttpd is a secure, fast, compliant and very flexible web-server that has been optimized for high-performance |
| 121 | environments. It has a very low memory footprint compared to other web servers and takes care of CPU load. |
| 122 | |
| 123 | For using `trac.fcgi`(prior to 0.11) / fcgi_frontend.py (0.11) with lighttpd add the following to your lighttpd.conf: |
121 | | 動かしたい Trac のインスタンス毎に `fastcgi.server` のエントリを追加する必要があります。別の方法として、上記の `TRAC_ENV` の代わりに `TRAC_ENV_PARENT_DIR` を使用でき、 |
122 | | `lighttpd.conf` に設定する代わりに `trac.fcgi` ファイルに |
123 | | `bin-environment` (上記の Apache の設定 に書かれています) の2つのうちのどちらかを設定します。 |
124 | | |
125 | | Note: 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"` を追加する必要があるでしょう。 |
126 | | |
127 | | lighttpd で2つのプロジェクトを動かすには、 `lighttpd.conf` に以下の設定を追加します: |
| 140 | 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, |
| 141 | and you may set one of the two in `trac.fcgi` instead of in `lighttpd.conf` |
| 142 | using `bin-environment` (as in the section above on Apache configuration). |
| 143 | |
| 144 | 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 should be fixed since lighttpd 1.4.23, and you may need to add `"fix-root-scriptname" => "enable"` as parameter of fastcgi.server. |
| 145 | |
| 146 | For using two projects with lighttpd add the following to your `lighttpd.conf`: |
149 | | Note: 各フィールドの値が異なることに注意して下さい。もし、 |
150 | | `.fcgi` スクリプト内の環境変数を設定する方が好ましいならば、 `trac.fcgi` スクリプトを |
151 | | 例えば、 `first.fcgi` や `second.fcgi` というようにコピー / リネームして、上記設定の中でこれらのスクリプトを参照するようにしてください。 |
152 | | 両方のプロジェクトが同じ `trac.fcgi` スクリプトから起動しているとしても、 |
153 | | 異なるプロセスになることに注意して下さい。 |
| 168 | Note that field values are different. If you prefer setting the environment |
| 169 | variables in the `.fcgi` scripts, then copy/rename `trac.fcgi`, e.g., to |
| 170 | `first.fcgi` and `second.fcgi`, and reference them in the above settings. |
| 171 | Note that the above will result in different processes in any event, even |
| 172 | if both are running from the same `trac.fcgi` script. |
| 173 | |
269 | | 使用言語指定の詳細については [http://trac.lighttpd.net/trac/wiki/TracFaq TracFaq] の 2.13 の質問を参照して下さい。 |
270 | | |
271 | | その他重要な情報、例えば、 [http://trac.lighttpd.net/trac/wiki/TracInstall lighttpd の TracInstall] や、 [wiki:TracCgi#MappingStaticResources TracCgi] などは fast-cgi 固有ではありませんが、インストールの詳細をつかむのに有用でしょう。 |
272 | | |
273 | | trac-0.9 を使用している場合、[http://lists.edgewall.com/archive/trac/2005-November/005311.html 些細なバグ] について読んでください。 |
274 | | |
275 | | lighttpd を再起動し、ブラウザに `http://yourhost.example.org/trac` を入力して、 Trac にアクセスして下さい。 |
276 | | |
277 | | 制限された権限で lighttpd を起動するにあたって気をつけること: |
278 | | |
279 | | もし、 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 を起動するユーザに適宜読み替えてください。) |
280 | | |
281 | | |
282 | | == !LiteSpeed の簡単な設定 == #SimpleLighttpdConfiguration |
283 | | |
284 | | FastCGI フロントエンドは最初 [http://www.litespeedtech.com/ LiteSpeed] のような、 Apache 以外の Web サーバのために開発されました。 |
285 | | |
286 | | !LiteSpeed Web サーバはイベント駆動、非同期型であり、 Apache に代わるものとしてセキュアで拡張可能になるようにゼロからデザインされています。そして、最低限のリソースで操作できます。 !LiteSpeed は Apache の設定ファイルから直接操作でき、ビジネスに不可欠な環境をターゲットにしています。 |
287 | | |
288 | | === セットアップ === |
289 | | |
290 | | 1. 最初に Trac プロジェクトをインストールして動作することを確認して下さい。最初のインストールでは、 "tracd" を使用します。 |
291 | | |
292 | | 2. このセットアップでは仮想ホストを作成します。以下、この仮想ホストのことを !TracVhost と呼びます。このチュートリアルで、先ほど作ったプロジェクトが以下の URL 経由でアクセスできると仮定します: |
| 290 | For details about languages specification see [trac:TracFaq TracFaq] question 2.13. |
| 291 | |
| 292 | Other important information like the [wiki:TracInstall#MappingStaticResources mapping static resources advices] are useful for non-fastcgi specific installation aspects. |
| 293 | ] |
| 294 | |
| 295 | Relaunch lighttpd, and browse to `http://yourhost.example.org/trac` to access Trac. |
| 296 | |
| 297 | Note about running lighttpd with reduced permissions: |
| 298 | |
| 299 | 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. |
| 300 | |
| 301 | |
| 302 | == Simple !LiteSpeed Configuration == |
| 303 | |
| 304 | The FastCGI front-end was developed primarily for use with alternative webservers, such as [http://www.litespeedtech.com/ LiteSpeed]. |
| 305 | |
| 306 | !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. |
| 307 | |
| 308 | 1. Please make sure you have first have a working install of a Trac project. Test install with “tracd” first. |
| 309 | |
| 310 | 2. 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: |
447 | | 上記設定は以下の条件だと仮定します: |
448 | | * trac のインスタンスを実行するためのユーザ名を 'trac' とします。ホームディレクトリに trac Environment をおきます。 |
449 | | * Trac environment は `/home/trac/instance` に配置します。 |
450 | | * `/home/trac/htpasswd` に認証情報が含まれています。 |
451 | | * `/home/trac/run` は nginx を起動しているグループが所有しています。 |
452 | | * Linux を使用しているならば、 `/home/trac/run` に (`chmod g+s run`) を設定します。 |
453 | | * [http://trac.edgewall.org/ticket/7239 本家チケット 7239] のパッチを適用し、ソケットファイルのパーミッションをそのつど修正しなければいけません。 |
454 | | |
455 | | 残念ですが、 nginx は fastcgi_pass ディレクティブ内の変数展開をサポートしていません。 |
456 | | したがって、 1 つのサーバーブロックから複数の trac インスタンスを起動することができません。 |
457 | | |
458 | | セキュリティ面で不安があるならば、 各 Trac インスタンスを別々のユーザで起動してください。 |
459 | | |
460 | | Trac を FCGI の外部アプリケーションとして起動するもう一つの方法は、[http://trac.edgewall.org/ticket/6224 本家チケット 6224] を参照して下さい。 |
| 481 | The above assumes that: |
| 482 | * There is a user named 'trac' for running trac instances and keeping trac environments in its home directory. |
| 483 | * `/home/trac/instance` contains a trac environment |
| 484 | * `/home/trac/htpasswd` contains authentication information |
| 485 | * `/home/trac/run` is owned by the same group the nginx runs under |
| 486 | * and if your system is Linux the `/home/trac/run` has setgid bit set (`chmod g+s run`) |
| 487 | * and patch from ticket #T7239 is applied, or you'll have to fix the socket file permissions every time |
| 488 | |
| 489 | Unfortunately nginx does not support variable expansion in fastcgi_pass directive. |
| 490 | Thus it is not possible to serve multiple trac instances from one server block. |
| 491 | |
| 492 | If you worry enough about security, run trac instances under separate users. |
| 493 | |
| 494 | Another way to run trac as a FCGI external application is offered in ticket #T6224 |