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

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

警告

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

前提条件

• システム要件 に記載されているシステム要件を満たしていること

• Java 21 がインストールされていること

• OpenSearch 3.7.0 を利用可能な状態にすること（または新規インストール）

• Windows の環境変数 JAVA_HOME が適切に設定されていること

Java のインストール確認

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

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

C:\> java -version

PowerShell の場合:

PS C:\> java -version

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

環境変数の設定

1. JAVA_HOME 環境変数の設定

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

   例:

   JAVA_HOME=C:\Program Files\Eclipse Adoptium\jdk-21.0.1.12-hotspot
   

2. PATH 環境変数への追加

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

Tip

環境変数の設定方法：

1. 「スタート」メニューから「設定」を開く

2. 「システム」→「バージョン情報」→「システムの詳細設定」をクリック

3. 「環境変数」ボタンをクリック

4. 「システム環境変数」または「ユーザー環境変数」で設定

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

OpenSearch のダウンロード

1. Download OpenSearch から Windows 用の ZIP パッケージをダウンロードします。

2. ダウンロードした ZIP ファイルを任意のディレクトリに展開します。

   例:

   C:\opensearch-3.7.0
   

   注釈

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

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

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

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

重要

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

OpenSearch の設定

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

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

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

警告

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

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

注釈

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

Tip

その他の推奨設定:

cluster.name: fess-cluster
node.name: fess-node-1
network.host: 0.0.0.0
discovery.type: single-node

Tip

OpenSearch のヒープサイズは、config\jvm.options の -Xms / -Xmx で設定します。 利用可能な物理メモリの半分以下、かつ 32GB 未満を目安に、-Xms と -Xmx には同じ値を指定することを推奨します。

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

Fess のダウンロード

1. ダウンロードサイト から Windows 用の ZIP パッケージをダウンロードします。

2. ダウンロードした ZIP ファイルを任意のディレクトリに展開します。

   例:

   C:\fess-15.7.0
   

   注釈

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

Fess の設定

bin\fess.in.bat をテキストエディタで開きます。 このファイルの末尾付近には、外部 OpenSearch クラスターへ接続するための設定が、あらかじめコメントアウトされた状態で用意されています。

変更前（既定の状態）:

REM External opensearch cluster
REM set FESS_JAVA_OPTS=%FESS_JAVA_OPTS% -Dfess.search_engine.http_address=http://localhost:9200
REM set FESS_JAVA_OPTS=%FESS_JAVA_OPTS% -Dfess.dictionary.path=%SEARCH_ENGINE_HOME%/config/

下 2 行の先頭にある REM `` を削除してコメントを解除し、``fess.dictionary.path の値を OpenSearch の設定同期用パスに変更します。

変更後:

REM External opensearch cluster
set FESS_JAVA_OPTS=%FESS_JAVA_OPTS% -Dfess.search_engine.http_address=http://localhost:9200
set FESS_JAVA_OPTS=%FESS_JAVA_OPTS% -Dfess.dictionary.path=C:/opensearch-3.7.0/data/config/

注釈

• fess.dictionary.path には、OpenSearch の opensearch.yml で指定した configsync.config_path と同じパスを設定してください。

• OpenSearch を別のホストで実行している場合は、fess.search_engine.http_address のホスト名または IP アドレスを適切な値に変更してください。

• パスの区切り文字は / を使用してください。

• 新たに set FESS_JAVA_OPTS=... の行を追加するのではなく、既存のコメント行を解除して編集してください。同じオプションを重複して指定すると、意図しない動作の原因となる場合があります。

Tip

Fess のヒープサイズを変更するには、bin\fess.in.bat の FESS_MIN_MEM (既定: 256m) と FESS_MAX_MEM (既定: 1g) を編集するか、環境変数 FESS_HEAP_SIZE を設定します。

インストールの確認

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

コマンドプロンプトで:

C:\> findstr "fess.search_engine.http_address" C:\fess-15.7.0\bin\fess.in.bat
C:\> findstr "fess.dictionary.path" C:\fess-15.7.0\bin\fess.in.bat

ステップ 3: 起動

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

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

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

Fess には、Windows サービスを登録するための bin\service.bat が同梱されています。 このスクリプトは Apache Commons Daemon (procrun) を利用しているため、NSSM などのサードパーティ製ツールを別途用意する必要はありません。

注釈

service.bat を実行する前に、環境変数 JAVA_HOME が正しく設定されていることを確認してください。

Fess サービスの登録

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

1. サービスの登録:

   C:\> cd C:\fess-15.7.0
   C:\fess-15.7.0> bin\service.bat install
   

   既定では、64 ビット環境では fess-service-x64、32 ビット環境では fess-service-x86 というサービス ID で登録されます。 サービス ID を明示的に指定する場合は、bin\service.bat install <サービスID> のように引数で指定します。

2. サービスの開始・停止:

   C:\fess-15.7.0> bin\service.bat start
   C:\fess-15.7.0> bin\service.bat stop
   

3. サービス設定の確認・変更 (GUI):

   C:\fess-15.7.0> bin\service.bat manager
   

4. サービスの削除:

   C:\fess-15.7.0> bin\service.bat remove
   

注釈

• service.bat は内部で bin\fess.in.bat を読み込むため、「Fess の設定」で行った外部 OpenSearch への接続設定はサービスにも反映されます。

• 既定のスタートアップの種類は「手動」です。システム起動時に自動的に開始するには、サービス登録前に環境変数 FESS_START_TYPE を auto に設定するか、登録後に「サービス」管理ツール (services.msc) でスタートアップの種類を「自動」に変更してください。

• service.bat で登録できるのは Fess サービスのみです。OpenSearch をサービスとして登録する場合は、OpenSearch が提供する手順を参照してください。

ファイアウォール設定

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

1. 「コントロールパネル」→「Windows Defender ファイアウォール」→「詳細設定」を開く

2. 「受信の規則」で新しい規則を作成

   • 規則の種類: ポート

   • プロトコルおよびポート: TCP、8080

   • 操作: 接続を許可する

   • 名前: Fess Web Interface

または、PowerShell で実行:

PS C:\> New-NetFirewallRule -DisplayName "Fess Web Interface" -Direction Inbound -Protocol TCP -LocalPort 8080 -Action Allow

トラブルシューティング

ポート番号の競合

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

C:\> netstat -ano | findstr :8080
C:\> netstat -ano | findstr :9200

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

パスの長さ制限

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

例:

C:\opensearch  (推奨)
C:\Program Files\opensearch-3.7.0  (非推奨 - パスが長い)

Java が認識されない

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

1. JAVA_HOME 環境変数が正しく設定されているか確認

2. PATH 環境変数に %JAVA_HOME%\bin が含まれているか確認

3. コマンドプロンプトを再起動して設定を反映

次のステップ

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

• 起動、停止、初期設定 - Fess の起動と初回セットアップ

• セキュリティ設定 - 本番環境でのセキュリティ設定

• トラブルシューティング - トラブルシューティング

よくある質問

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

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

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

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

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

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