gate-conf(5)

名前

ファイル

説明

gate.conf ファイルは gate-toroku-system(1) の設定ファイルで、 gate-toroku-system の各プログラムはこのファイルを参照するように なっています。 gate.conf は以下の 3 つのファイルを読み込みます。 また、gate.conf 自身にも、インストール後に必要となる、 ユーザーモードにも IP モードにも必要な設定が記述されます。

gate-sys.conf

インストール時に必要な情報を記述したファイルです。
ユーザーモードにも IP モードにも必要な設定を記述してあります。

gate-user.conf

ユーザーモードだけに必要な設定を記述したファイルです。
ユーザーモードが on の場合のみ意味を持ちます。

gate-ip.conf

IP モードだけに必要な設定を記述したファイルです。
IP モードが on の場合のみ意味を持ちます。

本ドキュメントは未完成です。まだ記述されていないパラメタについては install.html を参照してください。

gate.conf ファイルは perl(1) プログラムであり、主に文字列定数の代入文から成り立っています。

perl 言語の代入文はたとえば

	$CONSTANT = 'somestring';


	$VARIABLE = "$CONSTANT/suffix";

のようなものです。変数名はドル記号 ($) ではじまり、等号、値、セミコロンからなります。 値については数値と文字列定数が使えることを知っておけばよいでしょう。 文字列定数は任意の文字列を単引用符 (') または二重引用符 (") で囲むことによって作ることができます。 二重引用符を用いた場合は改行文字 (\n) などのエスケープシーケンスや他の文字列の参照 を用いることができます。 たとえば $CONSTANT/suffix とすることによって変数 $CONSTANT と 文字列 '/suffix' を連結した文字列定数を作ることができます。

perl の変数は真偽値として解釈されるときには 以下のように理解してください。 値がまだ設定されていない変数は偽です。 空文字列すなわち長さゼロの文字列は偽です。 数値ゼロまたはゼロ (0) 一文字からなる文字列は偽です。 それ以外のものはすべて真です。 ただし、意図的に真にするためには数値 1 を用いるのが慣例です。

以下では gate.conf ファイルで設定されるべき変数について、 それがどのような効果をもつか逐次解説します。

変数

$DBSERVER

登録サーバの FQDN (Full Qualified Domain Name; 完全なドメイン名) です。 登録サーバは gate-toroku-system の CGI インターフェイスにもなります。 したがって登録サーバでは CGI が動作することが必要です。

$GATEPORT

正の整数定数で、 gate-syncd(8) が使用する TCP ポート番号を指定します。 すでに他のプログラムが使用していないポート番号を使ってください。 1023 以下の数値を用いる場合は /etc/services ファイル (services(5) 参照) が参考になるでしょう。

$CGIUSER

HTTP サーバが動作するユーザ権限です。例えば Apache で HTTP サービスを 提供している場合には、Apache の設定ファイル (例えば /etc/apache/httpd.conf) の中の User の設定と同じにします。

$SERVER_ORGANIZATION

サーバを管理する組織名です。 gate-toroku-system/html ディレクトリ内の Makefile を用い make すると、 gate-toroku-system が提供するドキュメント (HTML) の中に この組織名が埋め込まれます。

$SERVER_NICKNAME

サーバの呼び名です。 gate-toroku-system/html ディレクトリ内の Makefile を用い make すると、 gate-toroku-system が提供するドキュメント (HTML) の中に この呼び名が埋め込まれます。

$GATE_ORGANIZATION

gate-toroku-system が管理する組織の組織名を設定します。 gate system を運用する組織名。ここに設定された文字列がユーザー・保証人に 送られるメールの signature 欄に書かれます。

$MAILHOST

ユーザのメールアドレスのホスト部です。

$MAILADDR

gate ユーザのメールアドレスです。

$GATECC

gate-toroku-system は申請や認証などの操作を受け付けた際に ユーザおよび保証人に対してメールを送信しますが、その際に 上記 MAILADDR に対してもメールを CC するかどうかです。 1 ならば CC します。

%DB_SHARE_HOSTS

データベースを共有するホストのリストとそのホストに対する オプションです。wheel:red とあるのはスーパーユーザになれるユーザ が red グループであることを意味します。 ホストごとのオプションは空白で区切られた語の集まりです。 語のうち % で始まるものがあれば、それはアカウント作成をある グループユーザのメンバに制限するオプションです。 たとえばオプション %wheel が指定されているホストでは、グループユーザ wheel が存在する場合にそのメンバだけに一般ユーザアカウント作成が 制限されます。 % で始まるグループ名のオプションがある場合は % で始まるグループに 所属するユーザだけがそのホストにログインできます。 奇数個目の文字列がホスト名、その次の文字列がホストに対する オプションをあらわします。複数のオプションは空白で区切られます。 特別なことがない限りオプションは空文字列にします。
%yellow yellow グループのメンバだけにアカウント作成を限定
wheel:green $WHEELUSER の設定にかかわらず green グループメンバが
スーパーユーザに sudo できるようにする %DB_SHARE_HOSTS は perl の連想配列(ハッシュ)になっており, 例えば 書式は次のとおりです。
%DB_SHARE_HOSTS = (
'dennou-k.kugi.kyoto-u.ac.jp','wheel:dcstaff',
'dennou-h.ees.hokudai.ac.jp','wheel:dcstaff',
'dennou-q.geo.kyushu-u.ac.jp','wheel:dcstaff'
); オプション指定の後にコンマ (,) を入れ忘れないようにしてください。

$HTTP

gate-toroku-system の CGI にアクセスする際のプロトコルを 指定します。 http または https として下さい。

$GATEURL

HTML ファイル置場です。ブラウザからアクセスする場合の URL を指定します。

$TOP_PAGE

gate 登録システムを利用するユーザ側が準備する gate 登録システム利用・ 接続受付窓口の URL をここに指定してください。gate-toroku-system/html ディレクトリ内の Makefile を用い make すると、 gate-toroku-system が提供するドキュメント (HTML) の中に このアドレスへのリンクができます。

$GATEDVLOPURL

gate 開発者向け文書置き場の URL です。

$DBSERVERURL

データベースサーバの URL です。gate-touroku-system からの 通知メールに記述されます。

$CGIBINURL

CGI 置き場の URL (相対パス) です。

$CGIBINFULLURL

CGI 置き場の URL (フルパス) です。

参照

バグ

perl の文法を知らない人には難解かもしれません。

変更しないほうがよいものまで変更できるようになっています。

gate-toroku-system(1) のアップデートによって新しい gate.conf を書かねばならない ことがあります。 バージョン番号を検知するメカニズムがあるべきです。