アーカイブ

fess の過去バージョンのインストール、検索、管理、API、設定に関するドキュメントをバージョンごとに掲載したアーカイブです。参照したいバージョンを以下から選んでください。

15.6

fess インストールガイド

fess ユーザーガイド

fess APIガイド

fess 管理者ガイド

fess 設定ガイド

はじめに
- 対象読者
- お読みになる前に
- 前提条件
- オンラインでのアクセス
- 技術的なサポートの連絡先
  - 商用サポート
- 関連サードパーティー Web サイトの参照
- コメントおよび提案の送付方法
ポートとネットワーク設定
- 概要
- 使用ポートの設定
- プロキシ設定
- HTTP通信設定
- 仮想ホスト設定
  - 概要
  - 基本設定
- リバースプロキシとの連携
- ファイアウォール設定
  - 必要なポートの開放
  - セキュリティグループの設定(クラウド環境)
- トラブルシューティング
- 参考情報
メモリ設定
- 概要
- fess ウェブアプリケーションのメモリ設定
- クローラーのメモリ設定
- OpenSearch のメモリ設定
- サジェスト・サムネイル処理のメモリ設定
  - サジェスト生成プロセス
  - サムネイル生成プロセス
- メモリ監視とチューニング
- トラブルシューティング
- 参考情報
Windowsサービスへの登録
- Windowsサービスとしての登録
クローラー基本設定
- 概要
- クローラーの基本概念
  - クローラーとは
  - クローラーの種類
- クロール設定の作成
- クロールの実行
- 基本的な設定項目
- ファイルサイズの設定
  - 取得するファイルサイズの上限
  - インデックスするファイルサイズの上限
- 単語の長さ制限
  - 概要
  - 設定方法
- プロキシの設定
- robots.txt の設定
  - 概要
  - 設定方法
- User-Agent の設定
  - 管理画面での設定
- エンコーディング設定
  - クロールデータのエンコーディング
  - ファイル名のエンコーディング
- クロールのトラブルシューティング
- ベストプラクティス
  - クロール設定の推奨事項
  - スケジュール設定の推奨事項
- 参考情報
クローラー詳細設定
- 概要
- 全般設定
- ドキュメント処理設定
- プロトコル設定
- robots.txt 設定
- エラー処理設定
- システム監視設定
  - ホットスレッド設定
    - 設定例
- メタデータ設定
- HTML クローラー設定
- ファイルクローラー設定
- キャッシュ設定
  - ドキュメントキャッシュ
    - 設定例
- JVM オプション
- パフォーマンスチューニング
- トラブルシューティング
- ベストプラクティス
- S3/GCSクローラー設定
  - S3クローラー
    - 設定例
  - GCSクローラー
    - 設定例
- 参考情報
サムネイル画像の設定
- 概要
- サポートしているファイル形式
- 必要な外部ツール
- HTMLファイルのサムネイル画像
- 設定
  - 設定ファイル
  - 主な設定項目（fess_config.properties）
- generate-thumbnail スクリプト
- サムネイル保存先
  - デフォルトパス
  - ディレクトリ構造
- サムネイルジョブの無効化
- トラブルシューティング
- プラットフォーム対応
データストアコネクタガイド
- データストアコネクタの概要
- Boxコネクタ
- Dropboxコネクタ
- Google Workspaceコネクタ
- Microsoft 365コネクタ
- Atlassianコネクタ
- Slackコネクタ
- Gitコネクタ
- Elasticsearch/OpenSearchコネクタ
- Salesforceコネクタ
- データベースコネクタ
- CSVコネクタ
- JSONコネクタ
検索機能
- 概要
- 検索結果件数の表示
  - デフォルトの動作
  - 正確なヒット件数の表示
- 検索オプション
- 検索結果のソート
- ファセット検索
- 検索結果のハイライト
- サジェスト機能
- 検索ログ
- パフォーマンスチューニング
- トラブルシューティング
検索関連の設定
- ファジー検索
- 検索時のタイムアウト値
- 検索時の最大文字数
- 検索時のタイムアウトのログ出力
- ヒット件数表示
- 位置情報検索時のインデックス名
- リクエストパラメータの言語指定
- 前方一致検索の指定
- ハイライトの文字列
- ハイライトのフラグメント
- ハイライト生成方法
- ハイライト対象のタグ
- OpenSearchのハイライターに渡す値
- ハイライトの高度な設定
- レスポンスに追加するフィールド名
- フィールド名の追加
- 検索結果をGSA互換のXML形式で取得する際の設定
位置情報検索
- 概要
- ユースケース
- 設定方法
  - インデックス生成時の設定
  - 検索時の設定
    - リクエストパラメータ
    - 距離の単位
- 検索例
- フィールド名のカスタマイズ
  - デフォルトのフィールド名変更
- 実装例
  - Webアプリケーションでの実装
  - Googleマップとの連携
- パフォーマンス最適化
  - インデックス設定の最適化
  - 検索範囲の制限
- トラブルシューティング
- 参考情報
検索結果の一括取得
- 概要
- ユースケース
- 設定方法
- 使用方法
- レスポンス形式
  - NDJSON形式
  - レスポンスフィールド
- データ処理例
- パフォーマンスとベストプラクティス
  - 効率的な使用方法
  - メモリ使用量の最適化
- セキュリティ考慮事項
  - アクセス制限
  - レート制限
- トラブルシューティング
- 参考情報
検索フォームの配置
- 検索フォームの配置方法
  - 検索フォーム
  - サジェスト
Rank fusion設定
- 概要
- Rank fusionとは
- 対応アルゴリズム
  - RRf (Reciprocal Rank fusion)
- 設定
  - fess_config.properties
  - JVMシステムプロパティ
- ハイブリッド検索との連携
- 使用例
  - 基本的なハイブリッド検索
- パフォーマンス考慮事項
  - メモリ使用量
  - 処理時間
- トラブルシューティング
- 参考情報
ロールベース検索の設定
- ロールベース検索について
- ロールベース検索の設定
仮想ホスト
- 仮想ホストについて
  - システム設定
  - クロール設定
LDAP統合ガイド
- 概要
- 対応LDAPサーバー
- 前提条件
- 基本設定
- Active Directory設定
  - 基本設定
  - Active Directory固有の設定
- OpenLDAP設定
- セキュリティ設定
  - LDAPS（SSL/TLS）
  - パスワードの保護
- フェイルオーバー
- トラブルシューティング
- 参考情報
マルチテナンシー設定
- 概要
- 仮想ホスト機能
  - 仕組み
- 仮想ホストヘッダーの設定
  - 設定形式
  - 仮想ホストキーの制約
- 管理画面での設定
  - クロール設定
- アクセス制御
  - 仮想ホストとロールの組み合わせ
  - ロールベース検索
- UIカスタマイズ
- API認証
  - アクセストークン
  - APIリクエスト
- DNS設定
  - 同一サーバーへのサブドメイン
  - リバースプロキシ設定
- データ分離
  - インデックスレベルの分離
- ベストプラクティス
- 制限事項
- 参考情報
SAML認証によるSSO設定
- 概要
  - SAML認証の仕組み
- 前提条件
- 基本設定
- IdP側での設定
  - IdPから取得する情報
- ユーザー属性マッピング
  - グループ属性の設定
  - ロール属性の設定
- セキュリティ設定
- 設定例
  - 最小構成（検証環境向け）
  - 推奨構成（本番環境向け）
- トラブルシューティング
  - よくある問題と解決方法
  - デバッグ設定
- 参考情報
OpenID ConnectによるSSO設定
- 概要
  - OpenID Connect認証の仕組み
- 前提条件
- 基本設定
- OP側での設定
  - OPから取得する情報
- 設定例
  - 最小構成（検証環境向け）
  - 推奨構成（本番環境向け）
- トラブルシューティング
  - よくある問題と解決方法
  - デバッグ設定
- 参考情報
Microsoft Entra IDによるSSO設定
- 概要
  - Entra ID認証の仕組み
- 前提条件
- 基本設定
- Entra ID側での設定
- グループ・ロールマッピング
  - ネストされたグループ
  - デフォルトグループの設定
- 設定例
- トラブルシューティング
  - よくある問題と解決方法
  - デバッグ設定
- 参考情報
Windows統合認証によるSSO設定
- 概要
  - Windows統合認証の仕組み
- 前提条件
- Active Directory側の設定
  - サービスプリンシパル名（SPN）の登録
- 基本設定
- LDAP設定
- ブラウザ設定
- 設定例
  - 最小構成（検証用）
  - 推奨構成（本番用）
- トラブルシューティング
  - よくある問題と解決方法
  - デバッグ設定
- 参考情報
LLM統合の概要
- 概要
- 対応プロバイダー
- プラグイン導入
- アーキテクチャ
- 基本設定
  - 管理画面の全般設定 / system.properties
  - fess_config.properties
- 共通設定
- セッション管理
- 同時実行制御
- 評価設定
- プロンプトタイプ別設定
  - プロンプトタイプ一覧
  - 設定パターン
- 次のステップ
Ollamaの設定
- 概要
  - 主な特徴
  - 対応モデル
- 前提条件
  - Ollamaのインストール
  - モデルのダウンロード
- プラグインのインストール
- 基本設定
  - 最小構成
  - 推奨構成（本番環境）
- 設定項目
  - 詳細設定
  - 同時実行制御
- プロンプトタイプ別設定
- Ollamaモデルオプション
- 思考モデル対応
- ネットワーク構成
  - Dockerでの構成
  - リモートOllamaサーバー
- HTTPプロキシ経由の利用
- モデルの選択ガイド
  - GPU対応
- トラブルシューティング
- 参考情報
OpenAIの設定
- 概要
  - 主な特徴
  - 対応モデル
- 前提条件
  - APIキーの取得
- プラグインのインストール
- 基本設定
  - 最小構成
  - 推奨構成（本番環境）
- 設定項目
- プロンプトタイプ別設定
- リトライ動作
- ストリーミングと使用量情報
- ログ出力と異常検出
  - URLログ内の認証情報マスキング
- 推論モデル対応
  - 推論モデル向け追加パラメータ
  - 設定例
- JVMオプションでの設定
  - Docker環境
  - systemd環境
- HTTPプロキシ経由の利用
- Azure OpenAIの使用
- モデルの選択ガイド
  - コストの目安
- 同時リクエスト制御
  - OpenAIのTier別制限
- トラブルシューティング
- セキュリティに関する注意
- 参考情報
Google Geminiの設定
- 概要
  - 主な特徴
  - 対応モデル
- 前提条件
  - APIキーの取得
- プラグインのインストール
- 基本設定
  - fess_config.propertiesの設定
  - LLMプロバイダーの設定
    - 最小構成
    - 推奨構成（本番環境）
- 設定項目
- 認証方式
- リトライ動作
- プロンプトタイプ別設定
- 思考モデル対応
  - モデル世代によるマッピング
- JVMオプションでの設定
  - Docker環境
  - systemd環境
- HTTPプロキシ経由の利用
- Vertex AI経由の使用
- モデルの選択ガイド
  - コンテキストウィンドウ
  - コストの目安
- 同時リクエスト制御
  - 無料枠の制限（参考）
- トラブルシューティング
- セキュリティに関する注意
- 参考情報
AI検索モード機能の設定
- 概要
- AI検索モードの仕組み
- 基本設定
  - コア設定 (fess_config.properties)
  - プロバイダー設定 (system.properties / 管理画面)
- 設定経路の早見表
- コア設定一覧
- 生成パラメーター
- コンテキスト設定
- システムプロンプト
  - プロンプトのカスタマイズ
- セッション管理
  - セッションの動作
- 同時実行制御
  - 同時実行制御の考慮事項
- 会話履歴モード
- クエリ再生成
- Markdownレンダリング
- APIの使用
  - 非ストリーミングAPI
  - ストリーミングAPI
- Webインターフェース
- トラブルシューティング
- 参考情報
スクリプティング概要
- 概要
- 対応スクリプト言語
- スクリプトの使用場面
- 基本的な構文
- 利用可能なオブジェクト
- セキュリティ
- パフォーマンス
- デバッグ
- 参考情報
Groovyスクリプトガイド
- 概要
- 基本構文
- データストアスクリプト
- 利用可能なオブジェクト
- スケジュールジョブスクリプト
- Javaクラスの使用
- fessコンポーネントへのアクセス
- エラーハンドリング
- デバッグとログ出力
  - ログ出力
  - デバッグ用の出力
- ベストプラクティス
- 参考情報
レート制限の設定
- 概要
- HTTPリクエストのレート制限
  - 設定
  - 動作
- AI検索モードのレート制限
- クローラーのレート制限
  - Webクロール設定
  - robots.txtの尊重
- レート制限の全設定項目
- 高度なレート制限設定
  - カスタムレート制限
- 除外設定
- 監視とアラート
  - ログ出力
- トラブルシューティング
- 参考情報
負荷制御の設定
- 概要
- HTTPリクエスト負荷制御の設定
- 動作の仕組み
  - 監視の仕組み
  - リクエスト制御
- 設定例
  - Web リクエストのみ制限する
  - Web と API の両方を制限する
- レート制限との違い
- 適応型負荷制御
  - 設定
  - 動作
- トラブルシューティング
- 参考情報
ログ設定
- 概要
- ログファイルの種類
- ログレベルの設定
- クローラーログの設定
  - スケジューラーでの設定
- ログローテーション
- ログ監視
- ログフォーマット
  - デフォルトフォーマット
  - カスタムフォーマット例
    - JSON形式でログ出力
    - より詳細な情報を含める
- パフォーマンスへの影響
  - ベストプラクティス
  - パフォーマンス測定
- トラブルシューティング
- 参考情報
ログ通知
- 概要
- 仕組み
- セットアップ
  - 有効化
    - 管理画面からの有効化
    - システムプロパティによる有効化
  - 通知先の設定
- 設定プロパティ
- 通知メッセージの形式
  - メール通知
  - Slack / Google Chat 通知
- 運用ガイド
  - 推奨設定
  - OpenSearch インデックス
- トラブルシューティング
- 参考情報
インデックスの管理
- 概要
- インデックスの構成
- インデックスのバックアップとリストア
- 設定ファイルのバックアップ
  - バックアップ対象のファイル
  - 設定ファイルのバックアップ例
- データ移行
  - 別環境への移行手順
  - バージョンアップ時の注意事項
- トラブルシューティング
- 参考情報
インデックスエクスポート機能
- 概要
- 動作の仕組み
- 設定プロパティ
- ジョブの有効化
- カスタムクエリフィルタリング
- エクスポートされたファイル構造
- ベストプラクティス
- トラブルシューティング
- 関連トピック
Analyzerの設定
- Analyzerについて
検索ログ可視化の設定
- 検索ログの可視化について
  - 可視化できる情報
- OpenSearch Dashboards によるデータ可視化の設定

アーカイブ

15.6

15.5

15.4

15.3

15.2

15.1

15.0

14.19

14.18

14.17

14.16

14.15

14.14

14.13

14.12

14.11

14.10

14.9

14.8

14.7

14.6

14.5

14.4

14.3

14.2