Web サーバを使用した管理ポータルおよび他の組み込みの Web アプリケーションへのアクセス

自動構成が可能な場合

InterSystems IRIS インスタンスのインストール時に Web ゲートウェイを含むセットアップ・タイプを選択する場合は、以下のリストで示す条件下で、Web ゲートウェイを介してインスタンスに要求を提供するように Web サーバを自動的に構成できます。これらの条件が適用される場合は、Web ゲートウェイをスタンドアロン・コンポーネントとしてインストールするすべての方法で、Web ゲートウェイを含めて Web サーバを構成することもできます。ただし、各 InterSystems IRIS アプリケーション・サーバへの接続は、手動で構成する必要があります。

Web サーバの自動構成が可能な場合を以下に示します。

1. 以下を使用している。

   • UNIX®、Linux、または macOS 上の Apache httpd

   • Microsoft Windows 上の Microsoft インターネット･インフォメーション･サービス (IIS)。

2. インストールを実行する前に、ローカル・ファイル・システム内に Web サーバが既にインストールされている (IIS の場合は、これを有効化している)。UNIX® または Linux システムに Apache をインストールする方法については、次の Developer Community の記事を参照してください ： https://community.intersystems.com/post/how-install-apache-iris-supported-operating-systemsOpens in a new tab

   Note:

   macOS システムでは、Homebrew パッケージ・マネージャ (https://brew.sh/Opens in a new tab) を使用して Apache httpd のコピーをインストールしておく必要があります。インストーラは、macOS と共に配布される Apache httpd インストールでの自動構成はサポートしません。他のすべてのプラットフォームについては、インストーラはプラットフォームで提供される Web サーバをサポートします。

3. 既定のインストール場所に Web サーバがインストールされている。

4. Web サーバが実行されている。

自動構成動作

特に明記されていない限り、インストーラの自動構成手順では以下が行われます。

1. Web ゲートウェイ・モジュールが Web サーバ構成に含まれていない場合、インストーラはこれを追加し、Web ゲートウェイ・バイナリを含むディレクトリに対する適切な権限を設定します。

2. Web サーバ構成で、以下の相対 URL パスのハンドラとして Web ゲートウェイを有効にします。

   • /<instanceName>

   <instanceName> は、インストールまたはアップグレードするインスタンスの名前 (すべて小文字) です。

   Important:

   インストーラが Apache Web サーバの自動構成手順を実行するインスタンスの名前が、以前にその Web サーバを使用するように構成されていたインスタンスと同じである場合、構成ファイル (httpd.conf) に追加される ApacheCSP-SECTION-<instanceName> セクションに手動で加えた編集内容は上書きされ、セクションの元の内容がリストアされ、カスタマイズした内容がすべて削除されます。コメントでこのセクションの開始と終了が示されます。

3. Web サーバ構成で、以下の相対 URL パスのハンドラを有効にします。

   • /api

   • /csp

   • /isc

   • /oauth2

   • /ui

   Important:

   インストーラが Apache Web サーバの自動構成手順を実行するたびに、構成ファイル (httpd.conf) に追加される ApacheCSP-SECTION-<instanceName> に手動で加えた編集内容は上書きされ、セクションの元の内容がリストアされます。コメントでこのセクションの開始と終了が示されます。Apache 構成をカスタマイズする場合は、ファイルの他の場所に指示文を追加してこれを行う必要があります。

   Note:

   Windows システムの場合、VS Code への接続を完全に機能させるには、追加の IIS 構成を実行する必要があります (インスタンスの /api/atelier アプリケーションによって促進されます)。

4. UNIX®、Linux、macOS システム上のカスタム・インストールの場合、Apache Web サーバ構成にリストされているポート番号を、インストール・ウィザードで指定したポート番号に更新します。

5. UNIX®、Linux、macOS システムで、相対パス /csp/docbook/ 内の要求を InterSystems ドキュメント・サイトの対応するページにリダイレクトする指示文を、Apache Web サーバ構成に追加します。これは、管理ポータルからドキュメントへのリンクに必要になります。

   Note:

   Windows システムで、要求を /csp/docbook/ から InterSystems ドキュメント・サイトに手動でリダイレクトするように IIS を構成する必要があります。

6. SELinux を搭載した RHEL システムで、Web ゲートウェイ構成とログ・ファイルへの適切な読み取り/書き込みアクセス権を構成して、Apache Web サーバからの送信ネットワーク接続を可能にします。

7. Web ゲートウェイ構成で、指定したスーパーサーバ・ポートと CSPSystem アカウント認証情報を使用して、インストールまたはアップグレードしている InterSystems IRIS インスタンスのサーバ・アクセス・プロファイルを作成します。このサーバ・アクセス・プロファイルにより、Web ゲートウェイは新規インスタンスに接続できます。サーバ・アクセス・プロファイルのサーバ名は、すべて小文字のインスタンス名です。

   Note:

   以前に Web サーバを構成せずに InterSystems IRIS 2023.2 のインスタンスをインストールし、その後インストーラの変更オプションを実行して、インストーラが自動構成手順を実行できるようにする場合は、サーバ・アクセス・プロファイル内で手動でインスタンスに CSPSystem アカウント認証情報を設定する必要があります。その後、IIS を再起動します。

8. Web ゲートウェイ構成で、次の相対アプリケーション・パスのアプリケーション・アクセス・プロファイルを作成します。

   • /<instanceName>

   <instanceName> は、インストールまたはアップグレードするインスタンスに指定した名前 (すべて小文字) です。

   アプリケーション・アクセス・プロファイルは、新しいサーバ・アクセス・プロファイルを、このアプリケーション・パスに送信されるすべての要求の既定のサーバとして指定します。

9. Web ゲートウェイ構成で、次の相対アプリケーション・パスのアプリケーション・アクセス・プロファイルを作成します (まだない場合)。

   • / (root)

   • /csp

   これらのアプリケーション・アクセス・プロファイルは、新しいサーバ・アクセス・プロファイルを、これらのアプリケーション・パスに送信されるすべての要求の既定のサーバとして指定します。

   Web ゲートウェイ構成内にこれらのアプリケーション・アクセス・プロファイルが既に存在する場合、インストーラはそれらを更新して、新しいサーバ・アクセス・プロファイルをこれらのアプリケーション・パスへのすべての要求の既定のサーバとして指定します。

10. InterSystems IRIS インスタンスの WebServerPort パラメータの値を 80 (macOS では 8080) に設定し、WebServerURLPrefix の値をすべて小文字のインスタンス名に設定します。(インストール時にカスタム・ポート番号を指定する場合、インストーラは代わりに WebServerPort パラメータをその番号に設定します。)InterSystems IRIS インスタンスはこれらのパラメータを使用して、InterSystems スタジオに接続します。

    Note:

    Community Edition をインストールする場合は、WebServerPort パラメータを Web サーバのポート番号に合わせて手動で更新する必要があります。

    既存の InterSystems IRIS インスタンスを更新または変更していて、そのインスタンスが以前に別のポートを使用して Web アプリケーションを提供していた (または Web アプリケーションをまったく提供していなかった) 場合も、WebServerPort パラメータを手動で更新する必要があります。

11. InterSystems IRIS インスタンスの WebServer パラメータの値を false (0) に設定し、インスタンスの起動時にインスタンスがプライベート Web サーバを起動しないようにします。この変更により、プライベート Web サーバは事実上無効になります。

    Important:

    Community Edition をインストールする場合、インストーラは WebServer パラメータを設定しません。インスタンスのプライベート Web サーバを手動で無効にする必要があります。

12. Windows システムで、InterSystems IRIS ランチャーが、ランチャーを使用する Web アプリケーション・ユーティリティ (つまり、管理ポータル、クラス・リファレンス、ドキュメント) の有効な URL を構成するために必要な、関連する InterSystems IRIS サーバ・マネージャのパラメータを構成します。これらのパラメータは、InterSystems スタジオに接続するためにも必要です。インストーラは、サーバ・マネージャのウェブサーバポート・パラメータを 80 (macOS では 8080) に設定します。

    Note:

    既存の InterSystems IRIS インスタンスをアップグレードまたは変更していて、そのインスタンスが以前に別のポートを使用して Web アプリケーションを提供していた (または Web アプリケーションをまったく提供していなかった) 場合、サーバ・マネージャの [ウェブサーバポート]・パラメータを Web サーバのポート番号に合わせて手動で更新する必要があります。

自動構成手順では、アプリケーション・パスの前にすべて小文字のインスタンス名を接頭語として含む URL で、特定の InterSystems IRIS インスタンスの組み込みのアプリケーションにアクセスできるようにします。インスタンスの指定に使用する接頭語は、簡単に構成できます。

さらに、自動構成手順では、インスタンス接頭語を省略した URL で、最近構成された InterSystems IRIS インスタンスの組み込みのアプリケーションを利用できるようにします。つまり、1 つのインスタンスのみが構成されている場合、簡略化された URL <protocol>://<hostname>/csp/sys/UtilHome.csp でそのインスタンスの管理ポータルを利用できます。

自動構成例

Apache httpd が実行されている Linux システムに IRISserv1 という名前の単一の InterSystems IRIS インスタンスをインストールした場合、自動構成手順により以下の指示文が Apache httpd.conf ファイルに追加されます。

#### BEGIN-ApacheCSP-SECTION ####
LoadModule csp_module_sa "/opt/webgateway/bin/CSPa24.so"
CSPModulePath "/opt/webgateway/bin/"
CSPConfigPath "/opt/webgateway/bin/"

<Location "/csp/">
     CSP On
</Location>
<Location "/api/">
     CSP On
</Location>
<Location "/oauth2/">
     CSP On
</Location>
<Location "/isc/">
     CSP On
</Location>
<Location "/ui/">
     CSP On
</Location>

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

Redirect /csp/docbook/ http://docs.intersystems.com/irislatest/csp/docbook/
#### END-ApacheCSP-SECTION ####
#### BEGIN-ApacheCSP-SECTION-IRISSERV1 ####
# Note: IRISSERV1 reinstallation or upgrade may replace this section.
<Location /irisserv1>
     CSP On
</Location>
Redirect /irisserv1/csp/docbook/ http://docs.intersystems.com/irislatest/csp/docbook/
#### END-ApacheCSP-SECTION-IRISSERV1 ####

Web ゲートウェイ構成には、IRISSERV1 サーバ・アクセス・プロファイルと、パス / (root)、/csp、/irisserv1 のアプリケーション・アクセス・プロファイルが含まれます。3 つのアプリケーション・アクセス・プロファイルはすべて、IRISSERV1 を既定のアプリケーション・サーバとして指定します。

この構成の結果、IRISSERV1 の管理ポータルのホーム・ページが http://localhost/irisserv1/csp/sys/UtilHome.csp またはより簡易な http://localhost/csp/sys/UtilHome.csp で利用できるようになります。

その後、IRISserv2 という名前の 2 番目の InterSystems IRIS インスタンスを同じシステムにインストールすると、インストーラは手動による変更を上書きして、httpd.conf ファイルの ApacheCSP-SECTION の内容をリストアします。その後、ApacheCSP-SECTION-IRISSERV1 コード・ブロックの後に以下の指示文を追加します。

#### BEGIN-ApacheCSP-SECTION-IRISSERV2 ####
# Note: IRISSERV2 reinstallation or upgrade may replace this section.
<Location /irisserv2>
     CSP On
</Location>
Redirect /irisserv2/csp/docbook/ http://docs.intersystems.com/irislatest/csp/docbook/
#### END-ApacheCSP-SECTION-IRISSERV2 ####

自動構成手順により、IRISSERV2 サーバ・アクセス・プロファイルが Web ゲートウェイ構成に追加されます。パス /irisserv2 のアプリケーション・アクセス・プロファイルも追加されます。/irisserv2、/ (root)、/csp のアプリケーション・アクセス・プロファイルは IRISSERV2 を既定のアプリケーション・サーバとして指定します。パス /irisserv1 のアプリケーション・アクセス・プロファイルは変更されません。

これらの変更の結果、IRISSERV1 の管理ポータルのホーム・ページは http://localhost/irisserv1/csp/sys/UtilHome.csp でのみ利用できるようになります。IRISserv2 の管理ポータルのホーム・ページは http://localhost/irisserv2/csp/sys/UtilHome.csp または http://localhost/csp/sys/UtilHome.csp で利用できます。

必要なアプリケーション・パスの指定

有効化する InterSystems IRIS システム・アプリケーションに対して、以下を行う必要があります。

1. Web ゲートウェイを呼び出して、対応するアプリケーション・パスとそのアプリケーション・パス内の下位パスに予期されるすべての要求を処理するように、Web サーバを構成します。

2. InterSystems IRIS インスタンスの Web ゲートウェイのサーバ・アクセス・プロファイルを構成します。

3. Web ゲートウェイのサーバ・アクセス・プロファイルを構成し、そのアプリケーション･アクセス･プロファイルをそのアプリケーション・パス (とその下位パス) に送信される要求の既定のアプリケーション・サーバとして指定します。

InterSystems IRIS と共にインストールされているシステム Web アプリケーションのリストは、"組み込みアプリケーション" を参照してください。これらすべての組み込みの Web ユーティリティの要求を処理するように、Web サーバと Web ゲートウェイを構成することを強くお勧めします。これらの Web アプリケーションは、以下のベース・パスを持つエンドポイントを使用します。

• /api

• /csp

• /isc

• /ui

• /oauth2

Web サーバ構成とアプリケーション・アクセス構成はどちらも継承ルールを適用するため、これら 5 つのベース・パスへの要求を構成することが最適なアプローチになります。これが、インストーラの自動構成手順で採用されるアプローチです。

1 つの Web ゲートウェイから複数の InterSystems IRIS インスタンスを処理する際、インスタンスの組み込みユーティリティに個別にアクセスする場合は、各インスタンスの CSPConfigName パラメータで始まるパスに送信された要求がそのインスタンスにルーティングされるように、Web サーバと Web ゲートウェイを構成する必要があります。インスタンスにこのパラメータを構成して、カスタム文字列をこのインスタンス接頭語として機能させることができます。既定では、このパラメータはすべて小文字のインスタンス名です。そのため、各インスタンスにパス /<instanceName> への要求を構成することが最適なアプローチになります。<instanceName> は、すべて小文字のインスタンス名です。これが、インストーラの自動構成手順で採用されるアプローチです。

各パスの必要なすべての要求のルーティング

Web ゲートウェイを呼び出して、特定のパスに送信されるすべての要求を処理するように、または特定のファイル・タイプ拡張子を持つファイルの要求のみを処理するように、Web サーバを構成できます。

以下のファイル・タイプの要求のみをルーティングすることで、管理ポータルを提供できます。

.csp .cls .zen .cxw .jpg .gif .png .svg .css .js

ただし、REST API は、ファイルを指定しない (したがって、ファイル・タイプを指定しない) エンドポイントでの要求の受信をサポートする必要があります。このようなアプリケーションの場合、ファイル・タイプに基づいて要求に対して Web ゲートウェイを呼び出すことができないため、Web ゲートウェイをパス・レベルですべての要求のハンドラとして使用できるようにする必要があります。

ドキュメント・リンクのリダイレクト

管理ポータル内のページに関連するドキュメントへのリンクが含まれる場合、それらのリンクはインスタンスのパス <instancePrefix>/csp/docbook 内のリソースを参照します。<instancePrefix> は、すべて小文字のインスタンス名です。Windows では、InterSystems IRIS ランチャーのドキュメント・リンクもこのパスにルーティングされます。

これらのリンクを機能させるには、Web サーバが要求をこのパスにリダイレクトして、InterSystems ドキュメントの Web サイト上の対応する URL に送信する必要があります。

ドキュメント・リンクの宛先 URL は、使用しているインターシステムズ製品によって異なります。インスタンスの正しい製品識別子を探すには、使用しているインターシステムズ製品およびバージョンのドキュメント・ページにアクセスして、ブラウザのアドレス・バーを確認します。製品の最新バージョンを指定する URL (irislatest、healthconnectlatest など) は、常にその製品の最新リリース・バージョンのドキュメントを提供します。

以下のセクションでは、Apache httpd と Microsoft IIS のドキュメント・リンクをリダイレクトする方法について説明します。お使いのシステムに最適な方法は異なることがあります。利用できるオプションについては、Web サーバのドキュメントを参照してください。

Redirect /irisinst2/csp/docbook/ http://docs.intersystems.com/irislatest/csp/docbook/

Windows のみ ： InterSystems IRIS サーバ・マネージャの更新

Windows システムでは、InterSystems IRIS ランチャーは InterSystems IRIS サーバ・マネージャ内で指定されたサーバ接続の詳細を使用して、ユーザをインスタンスの Web ベースのユーティリティに誘導します。インスタンスに対して InterSystems IRIS ランチャーを有効にするには、InterSystems IRIS サーバ・マネージャで、新しい Web サーバ構成に合わせてサーバ接続の詳細を変更します。"リモート・サーバ接続の定義" を参照してください。

Windows のみ ： VS Code を有効にするように IIS を構成

IIS を使用する Windows システムでは、VS Code が InterSystems IRIS インスタンスに接続できるように IIS を構成する必要があります。必要な IIS 構成については、以降のセクションで説明します。IIS の構成の詳しい手順は、IIS のドキュメントを参照してください (https://learn.microsoft.com/ja-jp/iis/get-started/introduction-to-iis/iis-web-server-overviewOpens in a new tab)。

<location path="{path}">
  <system.webServer>
    <modules>
      <remove name="WebDAVModule" />
    </modules>
    <handlers>
      <remove name="WebDAV" />
    </handlers>
  </system.webServer>
</location>