ヘルプのデプロイ先のサーバーに製品がインストールされていない場合は、Apache Tomcat アプリケーション・サーバーにヘルプをデプロイできます。
始める前に
- ヘルプ・コンテンツを構成するサーバーは、ファイアウォールの背後にいるユーザーがアクセスできるものでなければなりません。
- サーバー上に help.war ファイルがあります。
- ヘルプを構成する対象の製品がサーバーにインストール済みであれば、help.war ファイルは既にインストールされている可能性があります。
- installation_directory/help ディレクトリーで help.war ファイルを探します。
- 製品の略語が含まれているバージョンのファイル (clmhelp.war や ramhelp.war など) を探します。
- インストール・ディレクトリーで *help.war を検索します。
- 製品がサーバーにインストールされていない場合や、製品に help.war ファイルが含まれていなかった場合は、該当バージョンの help.war ファイルをダウンロードします。
- Apache Tomcat をインストールして構成します。
- Java™ ランタイム環境 (JRE) または Java Development Kit (JDK) をインストールします。いずれかの IBM® Developer Kit をインストールできます。
- JRE または JDK のパスの環境変数を設定します。
- JRE をインストールした場合は、JRE_HOME 環境変数を作成し、JRE をインストールしたディレクトリーのパスをその値として設定します。以下に例を示します。
- Windows: C:¥Program
Files¥Java70¥jre
- Linux: /usr/local/java70/jre
- JDK をインストールした場合は、JAVA_HOME 環境変数を作成し、JDK をインストールしたディレクトリーのパスをその値として設定します。以下に例を示します。
- Windows: C:¥Program
Files¥Java70
- Linux: /usr/local/java70/
- Apache Tomcat サーバー・アプリケーションをダウンロードします。
- 圧縮されている Apache Tomcat アーカイブを解凍します。
- 解凍したフォルダーを永久的な場所に移動します。この場所を CATALINA_HOME と呼ぶことにします (例えば、C:¥apache-tomcat-version)。
- CATALINA_HOME 環境変数を作成し、その値として CATALINA_HOME ディレクトリーを設定します (例えば、C:¥apache-tomcat-version)。
- CATALINA_HOME/conf/tomcat-users.xml ファイルにサーバー管理者ユーザーを追加し、変更内容を保存します。以下に例を示します。
<role rolename="manager-gui"/>
<user username="admin" password="admin" roles="manager-gui"/>
- CATALINA_HOME/bin ディレクトリーを開き、スタートアップ・ファイルを実行して、Apache Tomcat サーバーを開始します。このファイルの名前は、オペレーティング・システムによって異なります。
- Windows: startup.bat
- Linux: startup.sh
コマンド・ライン・ユーティリティーで「Server Startup in number ms」という情報メッセージが表示された場合、Apache Tomcat は実行中です。
手順
help.war ファイルをデプロイするには、以下のようにします。
- ブラウザーで http://localhost:8080/manager/html という URL を入力して、Tomcat Manager アプリケーションを開きます。
- ユーザー名とパスワードを入力します。
- セクションで「ファイルの選択 (Choose file)」をクリックします。
- help.war ファイルを選択します。
- 「デプロイ」をクリックします。 help.war ファイルがデプロイされて開始され、「アプリケーション (Applications)」セクションに表示されます。help.war ファイルは、CATALINA_HOME/webapps ディレクトリーにもコピーされます。
- サーバー・アプリケーションの URL の末尾に help/index.jsp を追加して、ヘルプ・システムにアクセスできるかどうかを確認します (help は .war ファイルの名前)。 例えば、http://localhost:8080/help/index.jsp のように指定します。
注: - ヘルプ・システムにヘルプ・コンテンツがまだ含まれていない場合もあります。その場合は、次に資料をヘルプ・システムにインストールします。
- 製品と同じ Apache Tomcat サーバーにヘルプ・システムをデプロイした場合は、製品アプリケーションの開始/停止時にヘルプ・システムも開始/停止します。
次のタスク
- 以下のいずれかのタスクを実行して、ヘルプ・コンテンツをサーバーにインストールします。
- 他のユーザーが、自身のコンピューターにインストールされている製品からこのヘルプ・コンテンツにアクセスする場合、それらのユーザーにヘルプ・システムのサーバー、ポート、およびパスを教えてください。
localhost 以外のサーバーを提供してください。
例:
http://server.ibm.com:8080/help-name/index.jsp- サーバー: server.ibm.com
- ポート: 8080
- パス: /help-name