Web ゲートウェイでの Web サーバ構成の拡張

Web ゲートウェイ・ファイル

Web ゲートウェイ・ファイルは、次のいずれかの場所にインストールされます。

• UNIX®/Linux/macOS 上の /opt/webgateway/bin。InterSystems IRIS インストールへの変更に影響されないために、InterSystems IRIS のインストール・ディレクトリではなく、この共通の場所で Web ゲートウェイ・ファイルを使用することをお勧めします。

• Windows 上の C:\Inetpub\ (インターネット･インフォメーション･サービス (IIS) が構成されている場合)。InterSystems IRIS インストールへの変更に影響されないために、InterSystems IRIS のインストール・ディレクトリではなく、この共通の場所で Web ゲートウェイ・ファイルを使用することをお勧めします。

• 以下の場合は、<installDir>/csp/bin または <installDir>/bin ：

  • <installDir> に InterSystems IRIS インスタンスがインストールされている

  • Web サーバが構成されていない。

• 以下の場合は、<installDir> または <installDir>/bin ：

  • <installDir> にスタンドアロン Web ゲートウェイがインストールされている

  • Web サーバが構成されていない。

一般に、インターシステムズでは Web ゲートウェイをバイナリ・ファイルのペアとして実装します。1 つのファイルはランタイム機能を実装し、もう 1 つのファイルは Web ゲートウェイ管理ページを実装します。管理バイナリはファイル名の末尾に Sys を追加することで、ランタイム・バイナリと区別されます。

Web サーバ・ファイル

Web サーバのインストール場所は、Web サーバやオペレーティング・システムによって異なります。Web サーバがインストールされている場所を見つけるには、Web サーバのドキュメントを参照してください。

• Apache ： https://httpd.apache.org/docs/2.4/Opens in a new tab

• IIS ： https://learn.microsoft.com/en-us/iis/get-started/introduction-to-iis/iis-web-server-overviewOpens in a new tab

• Nginx ： http://nginx.org/en/docs/Opens in a new tab

静的ファイル

必要なすべてのファイル・タイプについて、Web ゲートウェイがアプリケーションの相対 URL パスに送信される要求を処理できるように Web サーバが構成されている場合、InterSystems IRIS インスタンスは Web アプリケーション応答の一部として静的ファイルを処理できます。

InterSystems IRIS CSP Web アプリケーションが処理する静的ファイルは、Web アプリケーションに対応する <installDir>/csp/ ディレクトリに配置されます。<installDir> は、InterSystems IRIS インスタンスのインストール・ディレクトリです。

以下に例を示します。

• <installDir>/csp/broker には、複数の組み込みのシステム・アプリケーションで共有されるファイルが含まれます。

• <installDir>/csp/sys には、管理ポータルで使用するファイルが含まれます。

既定では、InterSystems IRIS CSP Web アプリケーションは、関連するディレクトリから静的ファイル自体を処理するように構成されています。

ただし、Web アプリケーションは、Web サーバが代わりにこれらの静的ファイルを処理できるようにすることもできます。例えば、1 つの Web サーバで複数のリモート InterSystems IRIS インスタンスを処理しているシステムがある場合、この Web サーバ マシンにとってローカルな共通の場所からこれらのファイルを提供する方が適切な可能性があります。ただし、これにより問題が生じる可能性があることに注意してください。例えば、共通の Web サーバが異なるバージョンの InterSystems IRIS を提供する場合、同じファイルの 2 つの異なるバージョン間で競合が発生する可能性があります。

InterSystems IRIS Web アプリケーションの静的ファイルを処理およびキャッシュするように Web サーバを構成するには、アプリケーションのパス (アプリケーションの静的ファイルの要求の送信先) と、Web サーバが適切なアクセス権を持っており、静的ファイルが保存されているローカル・ファイル・システムの場所との間にマッピングを作成する必要があります。

Web サーバごとのこのオプションのマッピング作成方法については、Web ゲートウェイのドキュメントの各所で説明しています。Web サーバが自ら管理するローカル・ファイル・システムの場所の静的ファイルを処理するように Web サーバを構成する方法の詳細は、お使いの Web サーバのドキュメントを参照してください。

Apache が共有オブジェクト・モジュールを管理できることの確認

Apache 独自の API を使用して Apache 構成に Web ゲートウェイを追加する前に、Apache のビルドに共有オブジェクトを管理するための組み込みのモジュール (mod_so) が含まれていることを確認します。

Red Hat Linux でこのチェックを実行するには、コマンド行から以下のコマンドを発行します (オペレーティング・システムに対応するコマンドを選択します)。

RHEL Ubuntu/SUSE

httpd -l

apache2 -l

このコマンドは、現在の Apache インストールに含まれているモジュールのリストを示します。mod_so がこのリストに含まれていない場合は、Apache のドキュメント (https://httpd.apache.org/docs/2.4/Opens in a new tab) で提供されている手順に従って、このモジュールを含む Apache の新しいビルドをコンパイルします。

Web サーバ構成への Web ゲートウェイ・モジュールの追加

1. Web ゲートウェイ・モジュール・ファイルのファイル・システムの場所を記録しておきます。これらの手順では、最も一般的な場所である /opt/webgateway/bin を使用します。

2. Apache Web サーバ構成ファイル (httpd.conf) をテキスト・エディタで開きます。このファイルは、Apache のインストール・ディレクトリの /conf サブディレクトリ内にあります。最も一般的なインストール場所は次のとおりです。

   RHEL Ubuntu/SUSE

   /etc/httpd/conf
   

   

   /usr/apache2/conf
   

   

3. Web ゲートウェイ・モジュールを追加するファイルの最後に指示文を追加します。これらの指示文では、以下を行います。

   • LoadModule 指示文を使用して、モジュールの名前と Web ゲートウェイのランタイム機能用の .so ファイルの場所を指定し、モジュールをロードします。

   • CSPModulePath 指示文を発行し、Web ゲートウェイのランタイム機能用の .so ファイルを含むディレクトリのフル・パスを指定します。

   • CSPConfigPath 指示文を発行し、Web ゲートウェイの管理機能用の .so ファイルを含むディレクトリのフル・パスを指定します。

   • Web ゲートウェイ・バイナリを含むディレクトリのアクセス設定を構成します。そのためには、以下のようにそのディレクトリに <Directory> 指示文ブロックを追加します (この例では、最も一般的なインストール場所を想定しています)。

     <Directory "/opt/webgateway/bin">
         AllowOverride None
         Options MultiViews FollowSymLinks ExecCGI
         Require all granted
         <FilesMatch "\.(log|ini|pid|exe)$">
             Require all denied 
         </FilesMatch>
     </Directory>
     

4. オプション ： Web サーバで Web アプリケーションの静的ファイルを処理する場合は、該当する /csp パスを Web サーバからアクセスできるファイル・システムの場所にマップする指示文を追加します。Apache Alias 指示文は、そのための方法の 1 つを提供します。

   例えば、アプリケーション /dashboard はリモートの InterSystems IRIS インスタンスによって提供されるが、アプリケーションの静的ファイルは Web サーバ・マシンのディレクトリ C:\iris\csp\dashboard から提供したい場合は、以下の指示文を追加できます。

   Alias /dashboard/ "C:/iris/csp/dashboard"
   

5. Web ゲートウェイを呼び出して、InterSystems IRIS アプリケーションへの要求を処理する指示文を発行します。このために、以下の指示文が用意されています。

   • CSPFileTypes。指定した一連のファイル・タイプの要求に対して Web ゲートウェイを呼び出します。(REST API エンドポイントは通常、ファイルではなくパスであるため、REST アプリケーションの要求を呼び出すには、この指示文では不十分です。)

   • CSP On と CSP Off。Web ゲートウェイをすべての要求のハンドラとして有効または無効にします。

   <Location> ブロック内でこれらの指示文を発行することで、Web サーバを細かく構成し、InterSystems IRIS Web アプリケーションに対応する相対 URL パスに対してのみ Web ゲートウェイを呼び出すことができます。

   以下の場所ブロックは、iris3 という InterSystems IRIS インスタンスの管理ポータル宛ての要求に対してのみ Web ゲートウェイを呼び出します。

   <Location "/iris3/csp/sys/">
       CSP On
   </Location>
   

   Note:

   InterSystems IRIS インスタンスにアクセスせずに、Web ゲートウェイの管理ページにアクセスするには、/csp パスに対して Web ゲートウェイを有効にします。

6. httpd.conf ファイルを保存します。

7. Apache を再起動して、構成の変更を有効にします。

インストーラは、Apache Web サーバを自動構成する際にこの手順を使用します。例については、"自動構成例" を参照してください。

IIS の有効化

IIS を有効にするには、次の手順に従います。

1. [Windows の機能の有効化または無効化] を探すか、[コントロール パネル] を開き、[プログラム]→[プログラムと機能]→[Windows の機能の有効化または無効化] を選択して、[Windows の機能] マネージャを開きます。

2. [インターネット インフォメーション サービス] を選択します。

3. ドキュメント・リンクのリダイレクトを有効にするには、IIS 内で [HTTP リダイレクト] も有効にする必要があります。有効にするには、[インターネット インフォメーション サービス]→[World Wide Web サービス]→[HTTP 共通機能]→[HTTP リダイレクト] が選択されていることを確認します。

4. サポートされている IDE でデバッグ・セッションを有効にするには、IIS 内で [WebSocket プロトコル] も有効にする必要があります。有効にするには、[インターネット インフォメーション サービス]→[World Wide Web サービス]→[アプリケーション開発機能]→[WebSocket プロトコル] が選択されていることを確認します。

5. [OK] をクリックします。

インストーラで、IIS 経由で Web アプリケーションを提供するように新しいまたはアップグレードされた InterSystems IRIS インスタンスを自動構成する場合は、インストールの前に IIS を有効にする必要があります。ただし、IIS の [HTTP リダイレクト] および [WebSocket プロトコル] 機能はいつでも有効にすることができます。

Web ゲートウェイ・コンポーネントに対する許可の設定

既定では、IIS は Web アプリケーションのユーザに対して、Web ドキュメント・ルート・ディレクトリ (通常は C:\Inetpub\wwwroot) 外にあるものへのアクセスを許可しません。以下のユーザ・グループが Web ドキュメント・ルート外のディレクトリにある Web アプリケーション・リソースにアクセスするには、そのディレクトリに対する読み取り、書き込み、実行権限を持っている必要があります。

• [machine_name]\IIS_IUSRS。IIS ワーカ・プロセスおよび IIS で制御されるアプリケーション (Web ゲートウェイなど) が実行されるユーザ・グループ。

• [machine_name]\Users

Web ゲートウェイ・ディレクトリ (通常は C:\Inetpub\CSPGateway) および Web アプリケーションが処理する静的ファイルを含むディレクトリに対するこれらの権限を、手動で設定する必要があります。そのためには、以下の操作を実行します。

1. Windows エクスプローラーで、ディレクトリの親ディレクトリに移動します。例えば、C:\Inetpub\CSPGateway ディレクトリを構成する場合は、C:\Inetpub に移動します。

2. ディレクトリ名を右クリックし、[プロパティ] を選択します。

3. [セキュリティ] タブを選択します。

4. [編集] を選択します。

5. [追加] を選択します。

6. [選択するオブジェクト名を入力してください] テキスト・ボックスに以下のように入力します。

   [machine_name]\IIS_IUSRS

7. [名前の確認]、[OK] の順に選択します。

8. [グループまたはユーザー名] ウィンドウで [[machine_name]\IIS_IUSRS] を選択してから、以下の操作を実行します。

9. [許可] ウィンドウで [読み取りと実行] および [書き込み] 許可を割り当てます。

10. [適用]、[OK] の順に選択します。

11. [[machine_name]\Users] ユーザ・グループについて、上記の処理を繰り返します。

Web ゲートウェイ構成ファイル (CSP.ini) または Web ゲートウェイ・ログ・ファイル (CSP.log) がファイル・システム内の他の場所に配置されている場合は、IIS_IUSRS グループがこれらのファイルに対する完全な読み取りおよび書き込み権限を持っていることも確認する必要があります。

ネイティブ・モジュールの登録

Web ゲートウェイ・ネイティブ・モジュールを使用する前に、それらを IIS に登録する必要があります。そのためには、以下の操作を実行します。

1. [インターネット インフォメーション サービス (IIS) マネージャ] を開きます。

2. [接続] パネルから localhost 接続を選択します。

3. 接続のホーム・ページの [機能ビュー] で、[モジュール] 機能構成項目を開きます (ダブルクリック)。

4. [操作] パネルから [ネイティブ モジュールの構成...] 操作を選択します。

5. [登録] を選択し、[ネイティブ モジュールの登録] ダイアログに以下を入力します。

   名前 ： CSPms (または類似した名前)

   パス ： C:\Inetpub\CSPGateway\CSPms.dll

6. [OK] をクリックします。

7. [接続] パネルで localhost 接続のコンテンツを展開して、[サイト]→[Default Web Site] を選択します。

8. Web ゲートウェイ・モジュールが有効になっていることを確認します。

   1. [Default Web Site ホーム] ページの [機能ビュー] で、[モジュール] 機能構成項目を開きます (ダブルクリック)。

   2. [操作] パネルから [ネイティブ モジュールの構成...] 操作を選択します。

   3. [ネイティブ モジュールの構成] ダイアログで、リストに [CSPms] がある場合はそれを選択し、[OK] を選択します。

Web アプリケーション・パスの構成

提供する InterSystems IRIS Web アプリケーションごとに、その相対パス (/csp または /irisinstance2) を IIS アプリケーションとして構成します。

IIS アプリケーションを構成すると、Web サーバが物理パスにアクセスするための適切な権限を持っている場合、Web サーバが静的ファイルを処理するために必要なパス・マッピングが作成されます。

構成する各アプリケーション・パスに対して、以下の手順を実行します。

1. [インターネット インフォメーション サービス (IIS) マネージャ] を開きます。

2. [接続] パネルで localhost 接続のコンテンツを展開して、[サイト]→[Default Web Site] を選択します。

3. [操作] パネルから [アプリケーションの表示] を選択します。

4. [操作] パネルから [アプリケーションの追加...] を選択します。

5. [アプリケーションの追加] ダイアログに以下の情報を入力します。

   • エイリアス ： アプリケーションの相対ベース URL パス。例えば、インスタンス IRISinstance2 でホストされるアプリケーションの場合は /irisinstance2、アプリケーション /csp/sys とその兄弟アプリケーションの場合は csp です。

   • 物理パス ： アプリケーションに関連付けられている静的ファイルを含むディレクトリ。IIS で、現在構成中のアプリケーション・パスの下位パスを持つアプリケーションの、異なるディレクトリからの静的ファイルを処理する場合は、子ディレクトリの IIS 仮想ディレクトリを定義します。

6. [OK] をクリックします。

7. IIS の構成が完了したら、IIS を再起動して構成の変更を有効にします。

代替オプションに基づく Web ゲートウェイ・ソリューションを使用している場合は、/csp アプリケーションの下に /bin というアプリケーションをセットアップします。Web ゲートウェイ・バイナリを保持している物理ディレクトリにこれをマップします。ほとんどの場合、これはアプリケーション・パス /csp/bin と物理パス C:\Inetpub\CSPGateway 間のマッピングです。

アプリケーション要求のハンドラ・マッピングの設定

構成した IIS アプリケーションごとに、ハンドラ・マッピングを作成して、アプリケーション・パスに送信される一部 (またはすべて) の要求のハンドラとして Web ゲートウェイを呼び出すように IIS に指示します。

アプリケーション・パスに送信されるすべての要求のハンドラとして Web ゲートウェイを呼び出すには、以下の手順に従って要求パス * (ワイルドカード) のハンドラ・マッピングを作成します。

特定のファイル・タイプに対してのみ Web ゲートウェイを呼び出すには、ファイル・タイプごとに、以下の手順に従って *.xxx (xxx はファイル拡張子) を要求パスとして指定します。インターシステムズ固有のファイル・タイプを処理するには、*.csp、*.cls、*.zen、および *.cxw の要求パスのハンドラ・マッピングを作成します。アプリケーションで処理する静的ファイル・タイプのハンドラ・マッピングも作成する必要があります。(REST API エンドポイントは通常、ファイルではなくパスであるため、REST アプリケーションの要求を呼び出すには、このファイル・タイプ固有のアプローチでは不十分です。)

以下の手順を実行して、IIS アプリケーションのハンドラ・マッピングを作成します。

1. [インターネット インフォメーション サービス (IIS) マネージャ] を開きます。

2. [接続] パネルで localhost 接続のコンテンツを展開し、[サイト]→[既定の Web サイト] 内のリストから [アプリケーション] の名前を選択します。

3. 接続のホーム・ページの [機能ビュー] で、[ハンドラー マッピング] 機能構成項目を開きます (ダブルクリック)。

4. [操作] パネルで、[モジュール マップの追加..] を選択します。

   Note:

   Web ゲートウェイをアプリケーション・パスのすべての要求のハンドラとして設定するために、[ワイルドカードスクリプトマップの追加...] 操作を使用しないでください。これを試みると、エラーが発生します。代わりに、ワイルドカード (*) 文字のモジュール・マッピングを追加します。

5. [モジュール マップの追加] ダイアログで以下を指定します。

   • 要求パス — Web ゲートウェイが処理する一連の要求を指定する式を指定します。(有効な式の例は、このセクションの冒頭を参照してください。)

   • モジュール — ドロップダウン・メニューから、Web ゲートウェイ・モジュールに指定した名前を選択します (CSPms)。

   • 名前 — このマッピングにわかりやすい名前を指定します (WebGateway_* など)。

6. [要求の制限] を選択し、[要求のマップ先が次の場合のみハンドラーを呼び出す] の横にあるボックスにチェックが付けられていない (選択されていない) ことを確認します。この操作により、[ハンドラー マッピング] テーブルに示すように、[パスの種類] の値が [指定なし] に設定されます。

7. [OK] を選択して [モジュール マップの追加] ダイアログに戻り、もう一度、[OK] を選択します。

8. 上記のプロセスを繰り返して、IIS アプリケーションに必要なすべてのハンドラ･マッピングを追加します。

9. IIS の構成が完了したら、IIS を再起動して構成の変更を有効にします。

/bin を含む URLの有効化

既定では、IIS はディレクトリ /bin を含む要求パスからはリソースを提供しません。Web ゲートウェイ管理ページを提供するには、このフィルタを無効にする必要があります。

インストーラが Web ゲートウェイを自動構成した場合、この手順は自動的に実行されています。Web ゲートウェイを手動でインストールする場合は、この構成を手動で実行する必要があります。

具体的には、以下の手順によって、IIS で Web ゲートウェイ管理ページを提供できるようにします。

1. テキスト・エディタで、applicationHost.config ファイルを開きます。このファイルは通常、C:\Windows\System32\Inetsrv\Config ディレクトリにあります。お使いのシステムで、このファイルの場所を見つけるには、以下を実行します。

   1. [接続] パネルで、localhost 接続またはその接続内の任意のサイト項目のホーム・ページから、[構成エディター] を選択 (ダブルクリック) します。

   2. [操作] パネルから [構成の検索...] を選択します。

   3. [階層表示] で、[ApplicationHost.config] (またはその子項目) を選択します。この操作によって、[構成検索] ダイアログに ApplicationHost.config ファイルの場所が表示されます。

2. <configuration> ブロックの最後に (ただし、ブロック内) に、以下の <Location> タグを追加します。

   <location path="localhost/csp/bin/Systems/Module.cxw">
       <system.webServer>
           <security>
              <requestFiltering>
                 <hiddenSegments>
                    <remove segment="bin" />                    
                  </hiddenSegments>
              </requestFiltering>
           </security>
        </system.webServer>
    </location>
   
   

   

3. ファイルを保存します。

4. IIS の構成が完了したら、IIS を再起動して構成の変更を有効にします。

リモート Web サーバ接続のランチャーの構成

InterSystems IRIS ランチャーが InterSystems IRIS インスタンスの組み込みの Web の有効な URL を構成できるようにするには、InterSystems IRIS サーバ・マネージャでインスタンスの接続の詳細を指定する必要があります。これらの接続の詳細は、Web サーバ構成と一致する必要があります。"システム管理ガイド" の "リモート・サーバ接続の定義" を参照してください。

SOAP フォルトの詳細を返すための IIS の構成

エラーが発生している InterSystems IRIS Web サービスは、関連する SOAP フォルトの詳細を含めずに HTTP 500 エラーを返すことがあります。既定では、IIS は広範なエラー情報をローカル・クライアントに対してのみ返します。 しかし、構成ファイル web.config 内の <httpErrors> 要素でこの動作を変更できます。変更するには、以下のセクションを追加して、詳細なエラー情報をすべてのクライアントに配信するように IIS に指示します。

<configuration>
    <system.webServer>
       <httpErrors errorMode="Detailed" />
    </system.webServer>
</configuration>

ホスト環境に関する機密情報がクライアントに公開されることがあるため、この方法を使用する場合は注意が必要です。 errorMode="Detailed" の使用に関するセキュリティ上の問題を回避する代わりの方法は、existingResponse="PassThrough" 指示文を使用することです。

<configuration>
    <system.webServer>
       <httpErrors existingResponse="PassThrough" />
    </system.webServer>
</configuration>

構成の変更後に、IIS を再起動します。

これらの変更は、IIS web.config ファイルに対して手動で行うことができます。または、より適切で、エラーの発生が少ない方法を選択するには、IIS マネージャに組み込まれている構成エディタ を使用します。

1. IIS マネージャの左側の [接続] パネルから、Web サービスに対応するパスを選択します。 例 ：[既定の Web サイト] の後に csp を選択。

2. 中央のパネル下部の [管理] という見出しの下で、[構成エディタ] をダブルクリックします。

3. [セクション] のラベルが付いた上部の [構成エディタ] ドロップダウンで、system.webServer を展開し、[httpErrors] をクリックします。

4. [existingResponse] の横にある値をクリックし、ドロップダウンを使用してオプションを表示します。 [PassThrough] を選択します。

5. 右側の [アクション] ペインで、[適用] をクリックします。

6. IIS の構成が完了したら、IIS を再起動して構成の変更を有効にします。

IIS でのエラー処理の詳細は、以下を参照してください。

https://docs.microsoft.com/ja-jp/iis/configuration/system.webServer/httpErrors/Opens in a new tab

IIS の再起動

このセクションでは、各種コントロール・パネル経由で IIS を再起動したときに何が起こるかについて説明します。

アクティブな IIS インストールに対する構成変更の大半はリアルタイムで行うことができます。しかし、[インターネット インフォメーション サービス (IIS) マネージャ] コントロール・パネルには停止、開始、および再起動オプションが用意されています。これらのオプションは Web サーバ構成の更新には便利です。しかし、Web ゲートウェイ・インストールは再初期化されません。

Web ゲートウェイ・インストールに変更を加えた場合は、以下のいずれかの方法で IIS を再起動します。

• Windows サービス・マネージャを開いて、World Wide Web Publishing サービスを再起動します。

• コマンド行から以下のコマンドを実行して、IIS を停止します。

  sc stop W3SVC
  

  

  Web サーバが停止したら、以下のコマンドを実行してこの Web サーバを再起動します。

  sc start W3SVC
  

  

トラブルシューティング

このセクションでは、IIS で使用するためにサードパーティ・モジュール (ネイティブ・モジュールおよび ISAPI モジュールの両方) を構成しているときによく発生する問題について説明します。

最もよく発生する問題は、再構成後、IIS への要求が失敗し、以下のエラーが表示されるというものです。

Service Unavailable

HTTP Error 503. The service is unavailable.

これは通常、既定のアプリケーション・プールが終了していることを示します。

1. [インターネット インフォメーション サービス (IIS) マネージャ] ウィンドウを開きます。

2. 左側のパネルで、最上位レベルを展開します。[アプリケーション プール] セクションが表示されます。

   [MACHINE_NAME] ([machine_name]\[user_name])

   アプリケーション・プール

3. 既定のアプリケーション・プール (DefaultAppPool)、またはサーバで使用が構成されているアプリケーション・プールのステータスが [開始] になっていることを確認します。

4. 必要に応じて、右側のパネルのオプションを使用して、アプリケーション・プールを再開します。

5. それでも問題が解決されない場合は、メインの Windows イベント・ログ ([アプリケーション] セクション内) を見て、ヒントを探してください。特に、次のエラー・メッセージを確認してください。

   Failed to find the RegisterModule entrypoint in the module DLL C:\Inetpub\CSPGateway\CSPms.dll.The data is the error.

   例えば、これは、使用しているバージョンの Web ゲートウェイ DLL が、このネイティブ・モジュール・インタフェースを実装していないことを示します。インターシステムズから最新の DLL を入手するか、または従来の ISAPI インタフェースで動作するように Web ゲートウェイを構成します。

すべてのソフトウェアと同様、一時的な問題が再起動により解決されることはよくあります。IIS を完全に再起動するには、メインの Windows サービス・コントロール・パネルから World Wide Web Publishing サービスを再起動します。

ファイル拡張子をマップするのにワイルドカードスクリプトマップの追加ユーティリティを使用しないでください。使用すると、「このハンドラーに対して指定されたモジュールが、モジュールの一覧にありません。スクリプト マップ ハンドラー マッピングを追加する場合は、モジュールの一覧に IsapiModule または CgiModule が存在している必要があります。」というエラーが発生する可能性があります。 代わりに、モジュールマップの追加を使用し、ワイルドカードを指定してファイル拡張子をマップしてください。

/bin を含む URL が機能しない場合には、/bin を含む URLの有効化の手動手順を参照してください。

概要

ここでは、UNIX®、Linux、または macOS 上の InterSystems Web ゲートウェイで使用するための、Nginx Web サーバの構築および構成方法について説明します。

Nginx はオープン・ソース製品で、ソース・コードは http://nginx.org/Opens in a new tab から無料でダウンロードできます。

Linux 用の一部のビルド済みキットを入手できますが、通常、これは最新の Nginx ビルドよりもいくつか前のバージョンをビルドしたものです。ただし、拡張子を Nginx コアにコンパイルする必要があるため、CSP のサポートを含めるには、Web サーバをソース・コードからローカルにビルドすることが必要です。

このページの手順の後、Web ゲートウェイ管理ページを使用して、さらに Web ゲートウェイを構成できます。

想定

ここでは、以下のように想定しています。

• CSP/Web ゲートウェイの Web サーバ・コンポーネントは /opt/webgateway/bin/ にインストールされている

• InterSystems IRIS はローカルにインストールされている場合は、/opt/iris/ に配置されている

• Web サーバは /opt/nginx/ の下にインストールされている

システムのレイアウトが異なる場合は、必要に応じて、構成指示文を修正してください。

インストール

以下の Web ゲートウェイのコンポーネントおよび CSP 静的ファイルをインストールします。

1. Web ゲートウェイ Network Service Daemon (NSD)

   • CSPnsd

   このバイナリの既定の場所は /opt/webgateway/bin/ です。

2. ハイパーイベントのコンポーネント

   CSPBroker.js

   CSPxmlhttp.js

   これらのファイルの既定の場所は /opt/iris/csp/broker です。

   これらのファイルが静的コンポーネントとして Web サーバによって直接処理される場合は、/opt/nginx/html/csp/broker にコピーしてください。

3. 管理ポータルで使用するその他の静的リソース

   管理ポータルでは、(イメージ・ファイルなど) いくつかの静的な Web リソースが必要になります。 これらのファイルの既定の場所は /opt/iris/csp/sys です。

   これらのファイルが静的コンポーネントとして Web サーバによって直接処理される場合は、/opt/nginx/html/csp/sys にコピーしてください。

CSP のための Nginx Web サーバの構築

Web ゲートウェイ機能のほとんどは、NSD (CSPnsd) によって提供されます。 CSP アクセスのために、小さなコンパイル済みモジュール ngx_http_csp_module.c を介して NSD と通信するように、Nginx を構築および構成することができます。便宜のため、すべての Web ゲートウェイ・インストールにはこのソース・ファイルが含まれています。

ここで説明する構築手順は、UNIX® システム下で Nginx を構築するための公式ドキュメントに基づいています。

http://nginx.org/en/docs/configure.htmlOpens in a new tab

Nginx のドキュメントには、以下のサードパーティのアドオンが必要であると記載されています。

• PCRE

  http://www.pcre.org/Opens in a new tab

• OpenSSL (SSL/TLS の場合)

  https://www.openssl.org/Opens in a new tab

• Zlib

  http://zlib.net/Opens in a new tab

ただし、最終インストールで、上記のコンポーネントによって提供される機能を必要としない場合は、これらのコンポーネントを使用しなくても十分に機能するサーバを作成することは可能です。

上記のオプションのモジュールすべてを含む、Nginx を構築するための一般的な構成スクリプトは、以下のとおりです。

./configure --prefix=/opt/nginx --with-http_ssl_module

これにより、既定の Nginx ビルドが /opt/nginx 下にインストールされます。

構築プロセスを以下のように変更して、オプションのモジュールを除外することもできます。

• OpenSSL - SSL/TLS 機能を削除します。

  指示文の削除：--with-http_ssl_module

• Zlib - GZIP 機能を削除します。

  指示文の追加：--without-http_gzip_module

• PCRE - HTTP 書き換え機能を削除します。

  指示文の追加：--without-http_rewrite_module

Nginx での NSD の使用

InterSystems IRIS アプリケーションが処理する必要のある要求を認識し、それらの要求を NSD に渡すように、Web サーバを構成する必要があります。

そのためには、/opt/nginx/conf にある Web サーバ構成ファイル (nginx.conf) を編集します。

ここでは、CSP 拡張モジュールが Web サーバの構成のために提供するサーバ構成指示文について説明します。location ブロックのコンテキスト内でこれらの指示文を発行すると、その指示文は指定されたパスのトラフィックに適用されます。

location /demo/app {
  CSPFileTypes csp cls;
}

例 ： 特定のパスでのすべてのトラフィックに対する CSP ルーティングを有効にする

適切な server 構成ブロック内に以下のセクションを配置し、/csp パスに送信されるすべてのトラフィックを Web ゲートウェイにルーティングします。

location /csp {
CSP On;
CSPNSD_pass localhost:7038;
}

例 ： InterSystems IRIS のファイル・タイプに対する要求を Web ゲートウェイにルーティングする

適切な server 構成ブロック内に以下のセクションを配置し、/csp パスに送信される InterSystems IRIS のファイル・タイプ (.csp、.cls、.zen、および .cxw)、および管理ポータル・インタフェースの静的要素を処理するのに必要なファイル・タイプに対する要求の CSP ルーティングを有効にします。

location /csp {
CSPFileTypes  csp cls zen cxw .jpg .gif .png .svg .css .js;
CSPNSD_pass localhost:7038;
}

IDE の使用に必要な追加の構成

InterSystems ObjectScript 拡張機能を含む VS CodeOpens in a new tab (または /api/atelier Web アプリケーションを使用する IDE) を ObjectScript IDE として使用するには、Nginx 構成に以下の追加の変更を行う必要があります。

1. /api/atelier Web アプリケーションは、アンダースコアを含む HTTP ヘッダを使用します。既定では、Nginx はこれらのヘッダを通知なしで削除します。これらを含めるように Nginx サーバを構成する必要があります。https://www.nginx.com/resources/wiki/start/topics/tutorials/config_pitfalls/#missing-disappearing-http-headersOpens in a new tab を参照してください。

2. デバッガなどの機能には、WebSocket 接続が必要です。既定では、Nginx は WebSocket をサポートするように構成されていません。WebSocket の有効化に関する情報は、Nginx のドキュメント (http://nginx.org/en/docs/http/websocket.htmlOpens in a new tab) を参照してください。

Nginx と NSD の起動および停止

Nginx を起動する方法は、以下のとおりです。

/opt/nginx/sbin/nginx

Nginx を停止する方法は、以下のとおりです。

/opt/nginx/sbin/nginx –s stop

NSD の操作方法については、"NSD の操作" を参照してください。

非推奨 ： ユニバーサル・モジュールを使用する Nginx の構築

動的にリンクされたユニバーサル・モジュール CSPx.so (実行時) と CSPxSys.so (Web ゲートウェイ・システム管理) と連携するように Nginx を構築できます。ユニバーサル・モジュールと連携するように Nginx を構築および構成する手順は、以下のように NSD ベースの導入とは異なります。

• 手順 3 で、モジュールのソース・コードとして、ngx_http_csp_module.c ではなく ngx_http_csp_module_sa.c、cspapi.h、および ngx_http_csp_common.h を指定のディレクトリにコピーします。

• 手順 4 で、CSP の構成ファイル (/opt/nginx-n.n.n/csp/config) は、以下のようになります。

  ngx_addon_name=ngx_http_csp_module_sa
  HTTP_MODULES="$HTTP_MODULES ngx_http_csp_module_sa"
  NGX_ADDON_SRCS="$NGX_ADDON_SRCS $ngx_addon_dir/ngx_http_csp_module_sa.c"
  

  

• CSPModulePath 指示文を http 構成ブロックから追加して、ユニバーサル・ゲートウェイ・モジュールへのパスを指定します。

  CSPModulePath /opt/webgateway/bin;
  

  

• 以下の指示文はサポートされていません。

  • CSPNSD_pass

  • CSPNSD_response_headers_maxsize

  • CSPNSD_connect_timeout

  • CSPNSD_send_timeout

  • CSPNSD_read_timeout

• 以下の指示文はサポートされています。

  • CSP

  • CSPFileTypes

概要

ここでは、Windows 上の InterSystems Web ゲートウェイで使用するための、Nginx Web サーバの構築および構成方法について説明します。

Nginx はオープン・ソース製品です。ソース・コードは http://nginx.org/Opens in a new tab から無料でダウンロードできます。

Windows 用の一部のビルド済みキットを入手できますが、通常、これは最新の Nginx ビルドよりもいくつか前のバージョンをビルドしたものです。ただし、拡張子を Nginx コアにコンパイルする必要があるため、CSP のサポートを含めるには、Web サーバをソース・コードからローカルにビルドすることが必要です。

このページの手順の後、Web ゲートウェイ管理ページを使用して、さらに Web ゲートウェイを構成できます。

想定

ここでは、以下のように想定しています。

• CSP/Web ゲートウェイ・コンポーネントは install-dir\csp\ にインストールされている。

• Web サーバは C:\nginx\ にインストールされている。

システムのレイアウトが異なる場合は、必要に応じて、構成指示文を修正してください。

インストール

以下の Web ゲートウェイのコンポーネントおよび CSP 静的ファイルをインストールします。

1. Web ゲートウェイ Network Service Daemon (NSD)

   • CSPnsd.exe (メイン・バイナリ)

   • CSPnsdSv.exe (Windows サービス)

   これらのファイルの既定の場所は install-dir\bin です。

   構成ファイルとログ・ファイルは、このディレクトリに書き込まれます。

2. ハイパーイベントのコンポーネント

   • CSPBroker.js

   • CSPxmlhttp.js

   これらのファイルの既定の場所は install-dir\csp\broker です。

   これらのファイルが静的コンポーネントとして Web サーバによって直接処理される場合は、C:\nginx\html\csp\broker にコピーしてください。

3. 管理ポータルで使用するその他の静的リソース

   管理ポータルでは、(イメージ・ファイルなど) いくつかの静的な Web リソースが必要になります。 これらのファイルの既定の場所は install-dir\csp\sys です。

   これらのファイルが Web サーバによって直接処理される場合は、C:\nginx\html\csp\sys にコピーしてください。

CSP のための Nginx Web サーバの構築

Web ゲートウェイ機能のほとんどは、NSD (CSPnsd[Sv].exe) によって提供されます。CSP アクセスのために、小さなコンパイル済みモジュール ngx_http_csp_module.c を介して NSD と通信するように、Nginx を構築および構成することができます。便宜のため、すべての Web ゲートウェイ・インストールにはこのソース・ファイルが含まれています。

Nginx 構築の前提条件 ：

• Microsoft Visual Studio (バージョン 10 以上) ： http://www.microsoft.comOpens in a new tab

• MSYS2 (MinGW より) ： https://www.msys2.org/Opens in a new tab

• Perl (ActivePerl を推奨) ： https://www.activestate.com/products/perl/Opens in a new tab

• Mercurial ソース・コントロール・クライアント ： https://www.mercurial-scm.org/Opens in a new tab

ここで説明する構築手順は、Windows 下で Nginx を構築するための公式ドキュメントに基づいています。

http://nginx.org/en/docs/howto_build_on_win32.htmlOpens in a new tab

Nginx のドキュメントには、以下のサードパーティのアドオンが必要であると記載されています。

• PCRE ： http://www.pcre.org/Opens in a new tab

• OpenSSL (SSL/TLS の場合) ： https://www.openssl.org/Opens in a new tab

• Zlib ： http://zlib.net/Opens in a new tab

ただし、最終インストールで、上記のコンポーネントによって提供される機能を必要としない場合は、これらのコンポーネントを使用しなくても十分に機能するサーバを作成することは可能です。

上記のオプションのモジュールすべてを含む、Nginx を構築するための既定の構成スクリプトは、以下のとおりです。

auto/configure \
 --with-cc=cl \
 --with-debug \
 --prefix= \
 --conf-path=conf/nginx.conf \
 --pid-path=logs/nginx.pid \
 --http-log-path=logs/access.log \
 --error-log-path=logs/error.log \
 --sbin-path=nginx.exe \
 --http-client-body-temp-path=temp/client_body_temp \
 --http-proxy-temp-path=temp/proxy_temp \
 --http-fastcgi-temp-path=temp/fastcgi_temp \
 --http-scgi-temp-path=temp/scgi_temp \
 --http-uwsgi-temp-path=temp/uwsgi_temp \
 --with-cc-opt=-DFD_SETSIZE=1024 \
 --with-pcre=objs/lib/pcre-8.44 \
 --with-zlib=objs/lib/zlib-1.2.12 \
 --with-openssl=objs/lib/openssl-1.1.1k \
 --with-openssl-opt=no-asm \
 --with-http_ssl_module

構築プロセスを以下のように変更して、オプションのモジュールを除外することもできます。

• OpenSSL - SSL/TLS 機能を削除します。

  指示文の削除：--with-http_ssl_module

• Zlib - GZIP 機能を削除します。

  指示文の追加：--without-http_gzip_module

• PCRE - HTTP 書き換え機能を削除します。

  指示文の追加：--without-http_rewrite_module

NSD を呼び出すように Nginx を構成

インターシステムズのファイル・システムの要求を認識し、これらの要求 (および InterSystems IRIS アプリケーションが処理するその他の静的ファイルの要求) を処理のため NSD に渡すよう、Web サーバを構成する必要があります。

そのためには、C:\nginx\conf にある Web サーバ構成ファイル (nginx.conf) を編集します。

ここでは、CSP 拡張モジュールが Web サーバの構成のために提供するサーバ構成指示文について説明します。location ブロックのコンテキスト内でこれらの指示文を発行すると、その指示文は指定されたパスのトラフィックに適用されます。

location /demo/app {
  CSPFileTypes csp cls;
}

例 ： 特定のパスでのすべてのトラフィックに対する CSP ルーティングを有効にする

適切な server 構成ブロック内に以下のセクションを配置し、/csp パスに送信されるすべてのトラフィックを Web ゲートウェイにルーティングします。

location /csp {
CSP On;
CSPNSD_pass localhost:7038;
}

例 ： InterSystems IRIS のファイル・タイプに対する要求を Web ゲートウェイにルーティングする

適切な server 構成ブロック内に以下のセクションを配置し、/csp パスに送信される InterSystems IRIS のファイル・タイプ (.csp、.cls、.zen、および .cxw)、および管理ポータル・インタフェースが使用する静的ファイルのファイル・タイプに対する要求の CSP ルーティングを有効にします。

location /csp {
CSPFileTypes  csp cls zen cxw jpg gif png svg css js;
CSPNSD_pass localhost:7038;
}

Nginx と NSD の起動および停止

Nginx を起動する方法は、以下のとおりです。

C:\nginx\nginx

Nginx を停止する方法は、以下のとおりです。

C:\nginx\nginx –s stop

NSD の操作方法については、"NSD の操作" を参照してください。

VS Code ユーザの場合 ： 必要な追加構成

InterSystems ObjectScript 拡張機能を含む VS Code を、Nginx Web サーバを使用する InterSystems IRIS インスタンスに接続する場合は、Nginx を以下のように構成する必要があります。

1. サポートされている ObjectScript IDE は、/api/atelier Web アプリケーションを使用して InterSystems IRIS に接続します。この Web アプリケーションは、アンダースコアがある HTTP ヘッダを含む要求を送信します。既定では、Nginx はこれらのヘッダを通知なしで削除します。Nginx がアンダースコアを含む HTTP ヘッダを保持できるようにしてください。https://www.nginx.com/resources/wiki/start/topics/tutorials/config_pitfalls/#missing-disappearing-http-headersOpens in a new tab を参照してください。

2. デバッガなどの機能には、WebSocket 接続が必要です。既定では、Nginx は WebSocket をサポートするように構成されていません。Nginx が WebSocket をサポートできるようにしてください。http://nginx.org/en/docs/http/websocket.htmlOpens in a new tab を参照してください。

非推奨 ： ユニバーサル・モジュールを使用する Nginx の構築

NSD の代わりに動的にリンクされたユニバーサル・モジュール CSPx.dll (実行時) と CSPxSys.dll (Web ゲートウェイ・システム管理) と連携するように Nginx を構築できます。ユニバーサル・モジュールと連携するように Nginx を構築および構成する手順は、以下のように NSD ベースの導入とは異なります。

• 手順 4 で、モジュールのソース・コードとして、ngx_http_csp_module.c ではなく ngx_http_csp_module_sa.c および ngx_http_csp_common.h を指定のディレクトリにコピーします。

• 手順 5 で、CSP の構成ファイル (/opt/nginx/objs/lib/csp/config) は、以下のようになります。

  ngx_addon_name=ngx_http_csp_module_sa
  HTTP_MODULES="$HTTP_MODULES ngx_http_csp_module_sa"
  NGX_ADDON_SRCS="$NGX_ADDON_SRCS $ngx_addon_dir/ngx_http_csp_module_sa.c"
  

  

• CSPModulePath 指示文を http 構成ブロックに追加して、ユニバーサル・ゲートウェイ・モジュールへのパスを指定します。

  CSPModulePath install-dir/bin;
  

  

• Windows の場合、スレッド・スタック・サイズを 2MB まで増やす必要があります。以下の指示文を Nginx 構成ファイルの先頭 (http セクションの前) に追加します。

  thread_stack_size 2000000;
  

  

• 以下の指示文はサポートされていません。

  • CSPNSD_pass

  • CSPNSD_response_headers_maxsize

  • CSPNSD_connect_timeout

  • CSPNSD_send_timeout

  • CSPNSD_read_timeout

• 以下の指示文はサポートされています。

  • CSP

  • CSPFileTypes