Version 1 から Version 2 における更新: TracCgi

Timestamp:

Nov 29, 2010, 3:25:28 PM (13 years 前)

Author:

trac (IP: 127.0.0.1)

Comment:

--

TracCgi

@@ -1 @@
-= CGI として Trac をインストールする = #InstallingTracasCGI
+= Installing Trac as CGI =
 
-Trac を CGI スクリプトとしてインストールするために、 Web サーバが `trac.cgi` を CGI として実行できるようにする必要があります。
-
-  ''Trac を CGI 経由で使用するのは、他のメソッド [TracModPython mod_python] や [TracFastCgi FastCGI] よりも極めて遅いということに注意して下さい。''
-
-[http://httpd.apache.org/ Apache HTTPD] を使用している場合、設定方法は 2 通りあります:
-
- 1. `ScriptAlias` を使用し、 `trac.cgi` スクリプトを URL にマップする。
- 2. CGI プログラムが実行可能な、 Web サーバ上のディレクトリ (通常は `cgi-bin` が使用される) に `trac.cgi` ファイルをコピーする。シンボリックリンクでも代用できますが、その場合 `cgi-bin` ディレクトリでは `FollowSymLinks` オプションを有効にして下さい。
-
-CGI を分かりやすい URL にマッピングできるので、 1 番目のオプションを推奨します。
-
-それでは、 Apache の設定ファイルに以下のブロックを追記し、ファイル名とロケーションを変更してください:
 {{{
-ScriptAlias /trac /usr/share/trac/cgi-bin/trac.cgi
+#!div class=important
+  ''Please note that using Trac via CGI is the slowest deployment method available. It is slower than [TracModPython mod_python], [TracFastCgi FastCGI] and even [trac:TracOnWindowsIisAjp IIS/AJP] on Windows.''
 }}}
 
- ''このディレクティブを使用するには `mod_alias` モジュールをインストールし、有効にしておく必要があります。''
+CGI script is the entrypoint that web-server calls when a web-request to an application is made. To generate the `trac.cgi` script run:
+{{{
+trac-admin /path/to/env deploy /path/to/www/trac
+}}}
+`trac.cgi` will be in the `cgi-bin` folder inside the given path. Make sure it is executable by your web server. This command also copies `static resource` files to a `htdocs` directory of a given destination.
 
-Trac のプロジェクトが 1 つの場合、 `TRAC_ENV` 環境変数を使用してプロジェクトへのパスを指定する必要があります:
+== Apache web-server configuration ==
+
+In [http://httpd.apache.org/ Apache] there are two ways to run Trac as CGI:
+
+ 1. Use a `ScriptAlias` directive that maps an URL to the `trac.cgi` script (recommended)
+ 2. Copy the `trac.cgi` file into the directory for CGI executables used by your web server (commonly named `cgi-bin`). You can also create a symbolic link, but in that case make sure that the `FollowSymLinks` option is enabled for the `cgi-bin` directory.
+
+To make Trac available at `http://yourhost.example.org/trac` add `ScriptAlias` directive to Apache configuration file, changing `trac.cgi` path to match your installation:
+{{{
+ScriptAlias /trac /path/to/www/trac/cgi-bin/trac.cgi
+}}}
+
+ ''Note that this directive requires enabled `mod_alias` module.''
+
+If you're using Trac with a single project you need to set its location using the `TRAC_ENV` environment variable:
 {{{
 <Location "/trac">
@@ -26 +33 @@
 }}}
 
-もしくは、複数のプロジェクトを扱うために、それらの親ディレクトリを `TRAC_ENV_PARENT_DIR` を使用して設定することができます。
+Or to use multiple projects you can specify their common parent directory using the `TRAC_ENV_PARENT_DIR` variable:
 {{{
 <Location "/trac">
@@ -33 +40 @@
 }}}
 
- ''`SetEnv` ディレクティブを使用するには `mod_env` モジュールをインストールし有効にしておく必要があります。そうでなければ、 trac.cgi に TRAC_ENV を設定することができます。 "try" と "from trac.web ..." の間に以下のコードを加えてください:''
+ ''Note that the `SetEnv` directive requires enabled `mod_env` module. It is also possible to set TRAC_ENV in trac.cgi. Just add the following code between "try:" and "from trac.web ...":''
 
 {{{
@@ -40 +47 @@
 }}}
 
- '' もしくは、 TRAC_ENV_PARENT_DIR を設定します: ''
+ '' Or for TRAC_ENV_PARENT_DIR: ''
 
 {{{
@@ -47 +54 @@
 }}}
 
-`http://yourhost.example.org/trac` のような URL で Trac が使用できるようになります。
+If you are using the [http://httpd.apache.org/docs/suexec.html Apache suEXEC] feature please see [http://trac.edgewall.org/wiki/ApacheSuexec].
 
-[http://httpd.apache.org/docs/suexec.html Apache suEXEC] 機能を使用している場合、 [http://trac.edgewall.org/wiki/ApacheSuexec ApacheSuexec] を参照して下さい。
+On some systems, you ''may'' need to edit the shebang line in the `trac.cgi` file to point to your real Python installation path. On a Windows system you may need to configure Windows to know how to execute a .cgi file (Explorer -> Tools -> Folder Options -> File Types -> CGI).
 
-システムによっては、`trac.cgi` ファイルの shebang 行を編集して、実際に Python がインストールされているパスを指すように修正する必要がある ''かもしれません''。 Windows システム上では、 Windowsが .cgi ファイルを実行できるように設定する必要があるでしょう。 (エクスプローラ -> ツール -> フォルダオプション -> ファイルの種類 -> CGI を Python と関連付ける)
+== Mapping Static Resources ==
 
-== 静的なリソースをマッピングする == #MappingStaticResources
+Out of the box, Trac will pass static resources such as style sheets or images through itself. For a CGI setup this is '''highly undesirable''', because this way CGI script is invoked for documents that could be much more efficiently served directly by web server.
 
-このままでも Trac はスタイルシートや画像ファイルなどの静的なリソースを扱えますが、 CGI のセットアップとしては妥当な設定とは言えません。 Web サーバ自身がはるかに効率良くに直接扱うことができるドキュメントまで、 CGI スクリプトとして呼び出してしまうという結果になるからです。
+Web servers such as [http://httpd.apache.org/ Apache] allow you to create “Aliases” to resources, giving them a virtual URL that doesn't necessarily reflect the layout of the servers file system. We already used this capability by defining a `ScriptAlias` for the CGI script. We also can map requests for static resources directly to the directory on the file system, avoiding processing these requests by CGI script.
 
-[http://httpd.apache.org/ Apache HTTPD] のような Web サーバはリソースに対して "Alias" を設定することで仮想の URL を与え、サーバのファイルシステムのレイアウトとは異なる位置にマップすることができます。すでに CGI スクリプトに対して `ScriptAlias` を定義していますので、ファイルシステム上の静的リソースを含んだコンテンツをマッピングすることで CGI スクリプトの要求を回避します。
+There are two primary URL paths for static resources - `/chrome/common` and `/chrome/site`. Plugins can add their own resources usually accessible by `/chrome/plugin` path, so its important to override only known paths and not try to make universal `/chrome` alias for everything.
 
-Apacheの設定ファイルを再び編集して、 CGI スクリプトの `ScriptAlias` を追記したブロックより '''上に''' 以下のブロックを追記します。ファイル名とロケーションは適宜変更してください (訳注: 0.11 以降は、静的リソースは Trac をインストールした場所の `trac/htdocs` になります):
+Add the following snippet to Apache configuration '''before''' the `ScriptAlias` for the CGI script, changing paths to match your deployment:
 {{{
-Alias /trac/chrome/common /usr/share/trac/htdocs
-<Directory "/usr/share/trac/htdocs">
+Alias /trac/chrome/common /path/to/trac/htdocs
+<Directory "/path/to/www/trac/htdocs">
   Order allow,deny
   Allow from all
@@ -68 +75 @@
 }}}
 
-`trac.cgi` スクリプトにどんな URL をマッピングしたとしても、 `/chrome/common` というパスでは静的リソースのロケーションを使用するようになります。
+Note that we mapped `/trac` part of the URL to the `trac.cgi` script, and the path `/chrome/common` is the path you have to append to that location to intercept requests to the static resources. 
 
-例えば、Trac が `/cgi-bin/trac.cgi` にマッピングされているとしたら、 Alias の URL は `cgi-bin/trac.cgi/chrome/common` となります。
+For example, if Trac is mapped to `/cgi-bin/trac.cgi` on your server, the URL of the Alias should be `/cgi-bin/trac.cgi/chrome/common`.
 
-同様に、静的なリソースを使用している場合、 プロジェクトディレクトリの htdocs に Apache の設定を行うことが出来ます (再度、 CGI スクリプトの `ScriptAlias` を追記したブロックより '''上に'''、以下のブロックを追記します。ファイル名とロケーションは適宜変更してください):
+Similarly, if you have static resources in a project's htdocs directory (which is referenced by /chrome/site URL in themes), you can configure Apache to serve those resources (again, put this '''before''' the `ScriptAlias` for the CGI script, and adjust names and locations to match your installation):
 
 {{{
@@ -82 +89 @@
 }}}
 
-あるいは、[wiki:TracIni trac.ini] に `htdocs_location` のオプションを設定することができます。
+Alternatively to hacking `/trac/chrome/site`, you can directly specify path to static resources using `htdocs_location` configuration option in [wiki:TracIni trac.ini]:
 {{{
 [trac]
-htdocs_location = /trac-htdocs
+htdocs_location = http://yourhost.example.org/trac-htdocs
 }}}
 
-Trac は HTML ページに静的リソースを組み込むときに、この URL を使用するようになります。もちろん、それでも、特定の URL が指定されたときに 例えば、 Web サーバーのドキュメントルートにディレクトリをコピーするなり、シンボリックリンクを張るなりして、Web サーバ経由で、 Trac が `htdocs` ディレクトリを利用できるようにしておく必要があります:
+Trac will then use this URL when embedding static resources into HTML pages. Of course, you still need to make the Trac `htdocs` directory available through the web server at the specified URL, for example by copying (or linking) the directory into the document root of the web server:
 {{{
-$ ln -s /usr/share/trac/htdocs /var/www/your_site.com/htdocs/trac-htdocs
+$ ln -s /path/to/www/trac/htdocs /var/www/yourhost.example.org/trac-htdocs
 }}}
 
-Note: `htdocs` ディレクトリの内容を取得するには、最初に TracAdmin の `deploy` コマンドを使用して、対応する Trac リソースを展開する必要があります。
+Note that in order to get this `htdocs` directory, you need first to extract the relevant Trac resources using the `deploy` command of TracAdmin:
 [[TracAdminHelp(deploy)]]
 
 
-== 認証を追加する == #AddingAuthentication
+== Adding Authentication ==
 
-Apache で認証を追加する最も単純な方法はパスワードファイルを作ることです。 `htpasswd` プログラムを使用してパスワードファイルを作成します:
+The simplest way to enable authentication with Apache is to create a password file. Use the `htpasswd` program to create the password file:
 {{{
 $ htpasswd -c /somewhere/trac.htpasswd admin
@@ -107 +114 @@
 }}}
 
-一番最初のユーザ以外は "-c" オプションは必要ありません:
+After the first user, you dont need the "-c" option anymore:
 {{{
 $ htpasswd /somewhere/trac.htpasswd john
@@ -115 +122 @@
 }}}
 
-  ''`htpasswd` についての詳細は man を見てください。''
+  ''See the man page for `htpasswd` for full documentation.''
 
-ユーザを作成した後、 TracPermissions の記述通りユーザに権限を設定することができます。
+After you've created the users, you can set their permissions using TracPermissions.
 
-Apache の設定ファイルの中にパスワードファイル名を記述し、認証を有効にする必要があります:
+Now, you'll need to enable authentication against the password file in the Apache configuration:
 {{{
 <Location "/trac/login">
@@ -129 +136 @@
 }}}
 
-複数のプロジェクトを持っている場合でも、パスワードファイルはプロジェクトで共通なものを使用することができます:
+If you're hosting multiple projects you can use the same password file for all of them:
 {{{
 <LocationMatch "/trac/[^/]+/login">
@@ -139 +146 @@
 }}}
 
-より堅固なセキュリティのために、 SSL を有効にするか、少なくとも "基本認証" の代わりに "ダイジェスト認証" を使用することを推奨します。より詳しい情報については [http://httpd.apache.org/docs/2.0/ Apache HTTPD documentation] を参照して下さい。例えば、Dian 4.0r1 (etch) システムの上では、Apache 構成における関連セクションは下記のように記述できます。
+For better security, it is recommended that you either enable SSL or at least use the “digest” authentication scheme instead of “Basic”. Please read the [http://httpd.apache.org/docs/2.0/ Apache HTTPD documentation] to find out more. For example, on a Debian 4.0r1 (etch) system the relevant section  in apache configuration can look like this:
 {{{
 <Location "/trac/login">
@@ -146 +153 @@
     AuthName "trac"
     AuthDigestDomain /trac
-    AuthDigestFile /somewhere/trac.htpasswd
+    AuthUserFile /somewhere/trac.htpasswd
     Require valid-user
 </Location>
 }}}
-.htpasswd ファイルは htpasswd の代わりに htdigest を使って、以下の通りに作成する必要があります:
+and you'll have to create your .htpasswd file with htdigest instead of htpasswd as follows:
 {{{
 # htdigest /somewhere/trac.htpasswd trac admin
 }}}
-上記の "trac" パラメータは 上の !AuthName と同じ値にします (apache-docs の "Realm")。
+where the "trac" parameter above is the same as !AuthName above  ("Realm" in apache-docs). 
 
 ----
-See also:  TracGuide, TracInstall, TracFastCgi, TracModPython
+See also:  TracGuide, TracInstall, [wiki:TracModWSGI], TracFastCgi, TracModPython