Windows へのインストール (詳細手順)

このページでは、Windows 環境への Fess のインストール手順を説明します。 ZIP パッケージを使用したインストール方法について記載しています。

警告

本番環境では、組み込み OpenSearch での稼働は推奨しません。必ず外部の OpenSearch サーバーを構築してください。

前提条件

システム要件に記載されているシステム要件を満たしていること
Java 21 がインストールされていること
OpenSearch 3.4.0 を利用可能な状態にすること（または新規インストール）
Windows の環境変数 JAVA_HOME が適切に設定されていること

Java のインストール確認

コマンドプロンプトまたは PowerShell を開き、以下のコマンドで Java のバージョンを確認します。

コマンドプロンプトの場合:

PowerShell の場合:

Java 21 以降が表示されることを確認してください。

環境変数の設定

JAVA_HOME 環境変数の設定

Java がインストールされているディレクトリを JAVA_HOME として設定します。

例:
```
JAVA_HOME=C:\Program Files\Eclipse Adoptium\jdk-21.0.1.12-hotspot
```
PATH 環境変数への追加

%JAVA_HOME%\bin を PATH 環境変数に追加します。

Tip

環境変数の設定方法：

「スタート」メニューから「設定」を開く
「システム」→「バージョン情報」→「システムの詳細設定」をクリック
「環境変数」ボタンをクリック
「システム環境変数」または「ユーザー環境変数」で設定

ステップ 1: OpenSearch のインストール

OpenSearch のダウンロード

Download OpenSearch から Windows 用の ZIP パッケージをダウンロードします。
ダウンロードした ZIP ファイルを任意のディレクトリに展開します。

例:
```
C:\opensearch-3.4.0
```
注釈

パスに日本語や空白文字が含まれないディレクトリを選択することを推奨します。

OpenSearch プラグインのインストール

コマンドプロンプトを**管理者権限で**開き、以下のコマンドを実行します。

C:\> cd C:\opensearch-3.4.0
C:\opensearch-3.4.0> bin\opensearch-plugin install org.codelibs.opensearch:opensearch-analysis-fess:3.4.0
C:\opensearch-3.4.0> bin\opensearch-plugin install org.codelibs.opensearch:opensearch-analysis-extension:3.4.0
C:\opensearch-3.4.0> bin\opensearch-plugin install org.codelibs.opensearch:opensearch-minhash:3.4.0
C:\opensearch-3.4.0> bin\opensearch-plugin install org.codelibs.opensearch:opensearch-configsync:3.4.0

重要

プラグインのバージョンは OpenSearch のバージョンと一致させる必要があります。上記の例では、すべて 3.4.0 を指定しています。

OpenSearch の設定

config\opensearch.yml をテキストエディタで開き、以下の設定を追加します。

# 設定同期用のパス（絶対パスで指定）
configsync.config_path: C:/opensearch-3.4.0/data/config/

# セキュリティプラグインの無効化（開発環境のみ）
plugins.security.disabled: true

警告

セキュリティに関する重要な注意

plugins.security.disabled: true は、開発環境やテスト環境でのみ使用してください。本番環境では、OpenSearch のセキュリティプラグインを有効にし、適切な認証・認可設定を行ってください。詳細はセキュリティ設定を参照してください。

注釈

Windows の場合、パスの区切り文字は \ ではなく / を使用してください。 C:\opensearch-3.4.0\data\config\ ではなく C:/opensearch-3.4.0/data/config/ と記述します。

Tip

その他の推奨設定:

ステップ 2: Fess のインストール

Fess のダウンロード

ダウンロードサイトから Windows 用の ZIP パッケージをダウンロードします。
ダウンロードした ZIP ファイルを任意のディレクトリに展開します。

例:
```
C:\fess-15.4.0
```
注釈

パスに日本語や空白文字が含まれないディレクトリを選択することを推奨します。

Fess の設定

bin\fess.in.bat をテキストエディタで開き、以下の設定を追加または変更します。

注釈

OpenSearch を別のホストで実行している場合は、fess.search_engine.http_address を適切なホスト名または IP アドレスに変更してください。
パスの区切り文字は / を使用してください。

インストールの確認

設定ファイルが正しく編集されたことを確認します。

コマンドプロンプトで:

ステップ 3: 起動

起動手順については、起動、停止、初期設定を参照してください。

Windows サービスとしての登録（オプション）

Fess と OpenSearch を Windows サービスとして登録することで、システム起動時に自動的に起動するように設定できます。

注釈

Windows サービスとして登録するには、サードパーティツール（NSSM など）を使用する必要があります。詳細な手順は、各ツールのドキュメントを参照してください。

NSSM を使用した例

NSSM (Non-Sucking Service Manager) をダウンロードして展開します。

OpenSearch をサービスとして登録:

Fess をサービスとして登録:

サービスの依存関係を設定（Fess は OpenSearch に依存）:
```
C:\> sc config Fess depend= OpenSearch
```

サービスの起動:

ファイアウォール設定

Windows Defender ファイアウォールで、必要なポートを開放します。

「コントロールパネル」→「Windows Defender ファイアウォール」→「詳細設定」を開く
「受信の規則」で新しい規則を作成
- 規則の種類: ポート
- プロトコルおよびポート: TCP、8080
- 操作: 接続を許可する
- 名前: Fess Web Interface

または、PowerShell で実行:

トラブルシューティング

ポート番号の競合

ポート 8080 または 9200 が既に使用されている場合、以下のコマンドで確認できます:

使用中のポート番号を変更するか、競合しているプロセスを停止してください。

パスの長さ制限

Windows では、パスの長さに制限があります。可能な限り短いパスにインストールすることを推奨します。

例:

Java が認識されない

java -version コマンドでエラーが表示される場合：

JAVA_HOME 環境変数が正しく設定されているか確認
PATH 環境変数に %JAVA_HOME%\bin が含まれているか確認
コマンドプロンプトを再起動して設定を反映

次のステップ

インストールが完了したら、以下のドキュメントを参照してください：

起動、停止、初期設定 - Fess の起動と初回セットアップ
セキュリティ設定 - 本番環境でのセキュリティ設定
トラブルシューティング - トラブルシューティング

よくある質問

Q: Windows Server での運用は推奨されますか？

A: はい、Windows Server での運用は可能です。 Windows Server で運用する場合は、Windows サービスとして登録し、適切な監視を設定してください。

Q: 64 ビット版と 32 ビット版の違いは？

A: Fess および OpenSearch は 64 ビット版のみをサポートしています。 32 ビット版の Windows では動作しません。

Q: パスに日本語が含まれる場合の対処法は？

A: 可能な限り、日本語や空白文字が含まれないパスにインストールしてください。どうしても日本語パスを使用する必要がある場合は、設定ファイルでパスを適切にエスケープする必要があります。