第 2 章概要

この章では、設定ファイルの基礎知識、テキスト編集のガイドライン、設定ファイルの構文など、設定ファイルの編集を始める前に知っておく必要がある情報について説明します。

設定ファイルについての基礎知識

Helix Universal Proxy を起動すると、デフォルトの設定ファイルである rmproxy.cfg を読み取ります。このセクションでは、設定ファイルについて知っておくと役立つ予備知識を提供します。

設定ファイルの要素

設定ファイルでは、Helix Universal Proxy のさまざまな機能に関する設定が同種のものをまとめたカテゴリにグループ化されています。リストに含まれない変数は設定ファイル内の任意の位置に記述できますが、ここでは分かりやすくするためにグループ化されています。

ほとんどの設定ファイル変数は、Helix Administrator で使用されている名前とほぼ一致しています。異なる場合は必要に応じて注記されています。

代替設定ファイル

Helix Universal Proxy の起動に関するセクションで説明したとおり、起動時に rmproxy.cfg 以外の設定ファイルを指定することができます。代わりに指定するファイルは、rmproxy.cfg を元に手動で編集したファイルでもかまいません。代替ファイルの使用手順については、『Helix Universal Proxy Administration Guide (Helix Universal Proxy アドミニストレーションガイド)』のインストールに関する章の Helix Universal Proxy の起動について説明しているセクションを参照してください。

セキュリティ

設定ファイルは、必ず許可されたユーザだけが変更できる場所に保存してください。デフォルトの保存場所は、Helix Universal Proxy のメインインストールディレクトリです。

バックアップ設定ファイル

Helix Universal Proxy のインストールディレクトリには、default.cfg という名前で、設定ファイルのバックアップコピーがあります。このファイルは、インストール中に作成された、デフォルトの rmproxy.cfg ファイルのミラーイメージです。変更した内容を元に戻す場合や、メインコピーを誤って削除してしまった場合などに、設定ファイルをバックアップから復元できます。

設定ファイルのテキスト編集についてのガイドライン

設定ファイルを任意のテキストエディタで開いて Helix Universal Proxy の設定を変更することができます。また、初期ファイルには含まれていないけれどもこのマニュアルには記述されている変数を追加することができます。そのほかに、サードパーティーのプラグインが独自のパラメータや変数を必要とする可能性もあります。そのような変数やパラメータを設定ファイルに追加するには、テキストエディタを使用します。

設定ファイルの既存の設定を変更するのは簡単です。このセクションでは、その方法を説明します。ただし、新しいセクションを追加する場合は、事前にファイル全体の構文を理解する必要があります。設定ファイルは複数のセクションで構成されます。必ずそのように構成しなければならないわけではありませんが、そうすることでわかりやすくなります。設定ファイルの構成の詳細については、「設定ファイルの構文」セクションを参照してください。

ヒント : まず Helix Administrator を使って変更を行い、設定ファイルがどのように変更されたのかを調べてみることを推奨します。特に、リストがどのように作成、変更されているかを理解することが重要です。

Helix Administrator の終了

Helix Administrator は、使用中の Helix Universal Proxy 設定ファイルの設定内容を表示します。テキストエディタで設定ファイルを開く前に、Helix Administrator を終了してください。そうしないと、予想外の変更が発生する可能性があります。

複数のプロキシ

設定ファイルのデフォルト名は rmproxy.cfg ですが、複数のプロキシを使用する場合は、使用しているプロキシを簡単に特定できるように各設定ファイルの名前を変更することもできます。

正しい構文

設定ファイルを手動で編集する場合、必ず正しい構文を使用するようにしてください。これは、Helix Universal Proxy が、スペルが正確であり適切に山かっこが使用されている設定ファイルを用いることを前提としているためです。Helix Universal Proxy は構文エラーに関連するメッセージを表示しません。解釈できない設定は無視されます。

Helix Universal Proxy の再起動

テキストエディタを使用して設定ファイルの設定内容を変更した後は必ず Helix Universal Proxy を再起動してください。

設定ファイルの構文

設定ファイルは XML (eXtensible Markup Language) に基づくタグでフォーマットされているテキストファイルです。このファイルによって高度な柔軟性が実現されており、サードパーティがHelix Universal Proxy の機能を拡張できるようになっています。Helix Universal Proxy のほかにサードパーティを使用する場合、機能を有効にするには設定ファイルを手動で編集しなければならないことがあります。

設定ファイルは、全体的にタグで構成されています。このファイルの中で使用されるタグには 4 種類あります。XML 宣言タグ、オプションコメントタグ、リストタグ、および変数タグです。

これら 4 種類のタグのうち、Helix Universal Proxy に命令を与えるのは、リストタグと変数タグの 2 種類だけです。リストタグは、MIME タイプやマルチキャスト命令など、いくつかのパーツに分かれる命令に使用されます。リストタグの後ろには、1 つ以上のリストタグまたは変数タグが続きます。

リストタグと変数タグにあるすべての値は、二重引用符で囲みます。

XML 宣言タグ

XML 宣言タグは、使用している XML のバージョンを示します。Helix Universal Proxy 9 では、XML バージョン 1.0 を使用しています。宣言タグの形式は、以下のとおりです。

<?XML Version="1.0" ?>

コメントタグ

コメントタグは、設定ファイル内でタグの機能を識別するのに使用されますが、コメントは必須ではありません。XML コメントタグはちょうど HTML のコメントタグに似ています。最初に  がきます。これらのタグは便宜上使用できるもので、Helix Universal Proxy では無視されます。

たとえば、以下のコメントタグにより、管理者はそのタグの後ろにあるパラメータでパスの設定が参照されていることがわかります。

<!-- P A T H S -->

ヒント : ある機能を無効にする場合、その機能のタグをコメントに置き換えてください。各タグをコメントに置き換えるのではなく、その機能の最初の開始タグと最後の終了タグだけを編集します。

コメントタグを別のコメントタグの入れ子にしないでください。

リストタグ

リストタグでは、以下の構文を使用します。

<List Name="name">

...

</List>

name の部分には、リストのタイトルが入ります。name では、大文字と小文字を正しく使い分けることが重要です。

リストの後ろには、別のリストや変数が続きます。リストの終わりは </List> タグで示します。元のリスト内に別のリストが挿入されている場合は、そのリストも </List> タグで閉じる必要があります。別のリストを入れ子にする例としては、MIMETypes リストがあります。

ヒント : 必須ではありませんが、分かりやすくなるため、リスト項目のインデント (字下げ) をお勧めします。

変数タグ

変数タグの構文は、以下のとおりです。

<Var name="value"/>

name の部分には変数のタイトルが入り、value の部分には、文字列または数値が入ります。どちらになるかは、変数によって異なります。name と value の両方とも、大文字と小文字を正しく使い分けることが重要です。

リストタグとは違い、変数に終了タグはありません。その代わり、閉じのかぎかっこ (>) の前にフォワードスラッシュ記号 (/) が表示されます。

ヒント : Helix Universal Proxy を再起動しても、変数への変更が反映されていない場合、変数に終わりを示すフォワードスラッシュ記号があるか、変数とフォワードスラッシュ記号の間にスペースがないかを確認します。

変数は独立した要素 (LogPath など) となる場合と、リストタグの中に記述される場合があります。変数がリスト内にある場合、その意味はリスト名の値により決まります。ただし、リストの外側にある変数と同じ構文になります。1 つのリスト内に同じ機能を持つ変数が複数ある場合、それらの名前は一意であることが必要です。たとえば、各 MIMETypes リスト内の Extension 変数は別々の名前を持つ必要があります。固有の名前にするには、Extension_01、Extension_02 というように、各変数の最後に数字をつけます。

第 2 章 概要