ホストマネージャーアプリケーション -- HTMLインターフェース

目次

はじめに

Tomcat ホストマネージャーアプリケーションを使用すると、Tomcat 内で仮想ホストを作成、削除、およびその他の管理を行うことができます。このハウツーガイドは、以下のドキュメントと併せて参照することをお勧めします。

Tomcat ホストマネージャーアプリケーションはTomcatのインストールの一部であり、デフォルトでは次のコンテキスト/host-managerを使用して利用できます。ホストマネージャーは以下の方法で使用できます。

  • {server}:{port}/host-manager/htmlでアクセスできるグラフィカルユーザーインターフェースを利用する。
  • スクリプトに適した最小限のHTTPリクエストセットを利用する。このモードは{server}:{port}/host-manager/textでアクセスできます。

どちらの方法でも、仮想ホストの追加、削除、起動、停止が可能です。変更はpersistコマンドを使用して永続化できます。このドキュメントではHTMLインターフェースに焦点を当てています。グラフィカルインターフェースに関する詳細については、ホストマネージャーアプリケーション -- テキストインターフェースを参照してください。

マネージャーアプリケーションアクセスの設定

以下の説明では、Tomcatのベースディレクトリを指すために$CATALINA_HOMEを使用しています。これは、Tomcatをインストールしたディレクトリです（例：C:\tomcat9、/usr/share/tomcat9）。

ホストマネージャーアプリケーションには、以下のいずれかのロールを持つユーザーが必要です。

  • admin-gui - グラフィカルなウェブインターフェースにはこのロールを使用します。
  • admin-script - スクリプト用のウェブインターフェースにはこのロールを使用します。

ホストマネージャーアプリケーションのHTMLインターフェースへのアクセスを有効にするには、Tomcatユーザーに適切なロールを付与するか、正しいロールを持つ新しいユーザーを作成してください。例えば、${CATALINA_BASE}/conf/tomcat-users.xmlを開いて以下を入力します。

<user username="test" password="chang3m3N#w" roles="admin-gui"/>

これ以上の設定は不要です。{server}:{port}/host-manager/htmlにアクセスすると、作成した認証情報でログインできるようになります。

別のレルムを使用している場合は、そのレルムの標準的なユーザー管理ツールを使用して、適切なユーザーに必要なロールを追加する必要があります。

インターフェースの説明

インターフェースは6つのセクションに分かれています。

  • メッセージ - 成功および失敗メッセージを表示します。
  • ホストマネージャー - リスト表示やヘルプなど、基本的なホストマネージャー操作を提供します。
  • ホスト名 - 仮想ホスト名の一覧を提供し、それらを操作することができます。
  • 仮想ホストの追加 - 新しい仮想ホストを追加できます。
  • 設定の永続化 - 現在の仮想ホストを永続化できます。
  • サーバー情報 - Tomcatサーバーに関する情報です。

メッセージ

最後に実行したホストマネージャーコマンドの成功または失敗に関する情報を表示します。

  • 成功時: OKが表示され、その後に成功メッセージが続く場合があります。
  • 失敗時: FAILが表示され、その後にエラーメッセージが続きます。

各コマンドに関するより詳しい情報は、Tomcatサーバーのコンソールで確認できる場合があります。

ホストマネージャー

ホストマネージャーセクションでは、以下のことができます。

  • 仮想ホストの一覧表示 - 現在設定されている仮想ホストの一覧を更新します。
  • HTMLホストマネージャーヘルプ - ドキュメントへのリンク。
  • ホストマネージャーヘルプ - ドキュメントへのリンク。
  • サーバー状態 - マネージャーアプリケーションへのリンク。このアプリケーションにアクセスするには、ユーザーに十分な権限が必要です。

ホスト名

ホスト名セクションには、現在設定されている仮想ホスト名の一覧が含まれています。これにより、以下のことが可能です。

  • ホスト名の表示
  • ホスト名のエイリアスの表示
  • 基本的なコマンド（開始、停止、削除）を実行します。

仮想ホストの追加

仮想ホストの追加セクションでは、グラフィカルインターフェースを使用して仮想ホストを追加できます。各プロパティの説明については、ホストマネージャーアプリケーション -- テキストインターフェースのドキュメントを参照してください。このインターフェースを介して追加された設定は永続化されないことに注意してください。

設定の永続化

設定の永続化セクションでは、現在の設定をserver.xmlファイルに永続化できます。

この機能はデフォルトで無効になっています。このオプションを有効にするには、まずStoreConfigLifecycleListenerリスナーを設定する必要があります。これを行うには、以下のリスナーをserver.xmlに追加します。

<Listener className="org.apache.catalina.storeconfig.StoreConfigLifecycleListener"/>

リスナーを設定したら、すべてをクリックして設定を永続化します。

サーバー情報

現在実行中のTomcatインスタンス、JVM、および基盤となるオペレーティングシステムに関する基本情報を提供します。