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

目次

はじめに

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

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

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

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

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

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

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

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

ホストマネージャーアプリケーションの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 ホストマネージャーヘルプ - ドキュメントへのリンクです。
  • ホストマネージャーヘルプ - ドキュメントへのリンクです。
  • サーバーのステータス - マネージャーアプリケーションへのリンクです。ユーザーがアプリケーションにアクセスするための十分な権限を持っている必要があることに注意してください。

ホスト名

ホスト名セクションには、現在構成されている仮想ホスト名のリストが含まれています。次のことができます。

  • ホスト名の表示
  • ホスト名のエイリアスの表示
  • 基本コマンド（start、stop、およびremove）の実行

仮想ホストの追加

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

設定の永続化

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

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

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

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

サーバー情報

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