Fess 設定ガイド

Fess の設定に関する包括的なガイドです。各セクションは目的別に整理されています。

はじめに

はじめに

• 対象読者
• お読みになる前に
• 前提条件
• オンラインでのアクセス
• 技術的なサポートの連絡先
• 関連サードパーティー Web サイトの参照
• コメントおよび提案の送付方法

基本設定

ポートとネットワーク設定

• 概要
• 使用ポートの設定
• プロキシ設定
• HTTP通信設定
• 仮想ホスト設定
• リバースプロキシとの連携
• ファイアウォール設定
• トラブルシューティング
• 参考情報

メモリ設定

• 概要
• Fess ウェブアプリケーションのメモリ設定
• クローラーのメモリ設定
• OpenSearch のメモリ設定
• サジェスト・サムネイル処理のメモリ設定
• メモリ監視とチューニング
• トラブルシューティング
• 参考情報

Windowsサービスへの登録

• Windowsサービスとしての登録

クローラー設定

クローラー基本設定

• 概要
• クローラーの基本概念
• クロール設定の作成
• クロールの実行
• 基本的な設定項目
• ファイルサイズの設定
• 単語の長さ制限
• プロキシの設定
• robots.txt の設定
• User-Agent の設定
• エンコーディング設定
• クロールのトラブルシューティング
• ベストプラクティス
• 参考情報

クローラー詳細設定

• 概要
• 全般設定
• ドキュメント処理設定
• プロトコル設定
• robots.txt 設定
• エラー処理設定
• システム監視設定
• メタデータ設定
• HTML クローラー設定
• ファイルクローラー設定
• キャッシュ設定
• JVM オプション
• パフォーマンスチューニング
• トラブルシューティング
• ベストプラクティス
• S3/GCSクローラー設定
• 参考情報

サムネイル画像の設定

• 概要
• サポートしているファイル形式
• 必要な外部ツール
• HTMLファイルのサムネイル画像
• 設定
• generate-thumbnail スクリプト
• サムネイル保存先
• サムネイルジョブの無効化
• トラブルシューティング
• プラットフォーム対応

データストアコネクタ

データストアコネクタガイド

• データストアコネクタの概要
• Boxコネクタ
• Dropboxコネクタ
• Google Workspaceコネクタ
• Microsoft 365コネクタ
• Atlassianコネクタ
• Slackコネクタ
• Gitコネクタ
• Elasticsearch/OpenSearchコネクタ
• Salesforceコネクタ
• データベースコネクタ
• CSVコネクタ
• JSONコネクタ

検索機能設定

検索機能

• 概要
• 検索結果件数の表示
• 検索オプション
• 検索結果のソート
• ファセット検索
• 検索結果のハイライト
• サジェスト機能
• 検索ログ
• パフォーマンスチューニング
• トラブルシューティング

検索関連の設定

• ファジー検索
• 検索時のタイムアウト値
• 検索時の最大文字数
• 検索時のタイムアウトのログ出力
• ヒット件数表示
• 位置情報検索時のインデックス名
• リクエストパラメータの言語指定
• 前方一致検索の指定
• ハイライトの文字列
• ハイライトのフラグメント
• ハイライト生成方法
• ハイライト対象のタグ
• OpenSearchのハイライターに渡す値
• ハイライトの高度な設定
• レスポンスに追加するフィールド名
• フィールド名の追加
• 検索結果をGSA互換のXML形式で取得する際の設定

位置情報検索

• 概要
• ユースケース
• 設定方法
• 検索例
• フィールド名のカスタマイズ
• 実装例
• パフォーマンス最適化
• トラブルシューティング
• 参考情報

検索結果の一括取得

• 概要
• ユースケース
• 設定方法
• 使用方法
• レスポンス形式
• データ処理例
• パフォーマンスとベストプラクティス
• セキュリティ考慮事項
• トラブルシューティング
• 参考情報

検索フォームの配置

• 検索フォームの配置方法

Rank Fusion設定

• 概要
• Rank Fusionとは
• 対応アルゴリズム
• 設定
• ハイブリッド検索との連携
• 使用例
• パフォーマンス考慮事項
• トラブルシューティング
• 参考情報

セキュリティ設定

ロールベース検索の設定

• ロールベース検索について
• ロールベース検索の設定

仮想ホスト

• 仮想ホストについて

LDAP統合ガイド

• 概要
• 対応LDAPサーバー
• 前提条件
• 基本設定
• Active Directory設定
• OpenLDAP設定
• セキュリティ設定
• フェイルオーバー
• トラブルシューティング
• 参考情報

マルチテナンシー設定

• 概要
• 仮想ホスト機能
• 仮想ホストヘッダーの設定
• 管理画面での設定
• アクセス制御
• UIカスタマイズ
• API認証
• DNS設定
• データ分離
• ベストプラクティス
• 制限事項
• 参考情報

SSO設定

SAML認証によるSSO設定

• 概要
• 前提条件
• 基本設定
• IdP側での設定
• ユーザー属性マッピング
• セキュリティ設定
• 設定例
• トラブルシューティング
• 参考情報

OpenID ConnectによるSSO設定

• 概要
• 前提条件
• 基本設定
• OP側での設定
• 設定例
• トラブルシューティング
• 参考情報

Microsoft Entra IDによるSSO設定

• 概要
• 前提条件
• 基本設定
• Entra ID側での設定
• グループ・ロールマッピング
• 設定例
• トラブルシューティング
• 参考情報

Windows統合認証によるSSO設定

• 概要
• 前提条件
• Active Directory側の設定
• 基本設定
• LDAP設定
• ブラウザ設定
• 設定例
• トラブルシューティング
• 参考情報

LLM/AI検索モード設定

LLM統合の概要

• 概要
• 対応プロバイダー
• プラグイン導入
• アーキテクチャ
• 基本設定
• 共通設定
• セッション管理
• 同時実行制御
• 評価設定
• プロンプトタイプ別設定
• 次のステップ

Ollamaの設定

• 概要
• 前提条件
• プラグインのインストール
• 基本設定
• 設定項目
• プロンプトタイプ別設定
• Ollamaモデルオプション
• 思考モデル対応
• ネットワーク構成
• HTTPプロキシ経由の利用
• モデルの選択ガイド
• トラブルシューティング
• 参考情報

OpenAIの設定

• 概要
• 前提条件
• プラグインのインストール
• 基本設定
• 設定項目
• プロンプトタイプ別設定
• リトライ動作
• ストリーミングと使用量情報
• ログ出力と異常検出
• 推論モデル対応
• JVMオプションでの設定
• HTTPプロキシ経由の利用
• Azure OpenAIの使用
• モデルの選択ガイド
• 同時リクエスト制御
• トラブルシューティング
• セキュリティに関する注意
• 参考情報

Google Geminiの設定

• 概要
• 前提条件
• プラグインのインストール
• 基本設定
• 設定項目
• 認証方式
• リトライ動作
• プロンプトタイプ別設定
• 思考モデル対応
• JVMオプションでの設定
• HTTPプロキシ経由の利用
• Vertex AI経由の使用
• モデルの選択ガイド
• 同時リクエスト制御
• トラブルシューティング
• セキュリティに関する注意
• 参考情報

AI検索モード機能の設定

• 概要
• AI検索モードの仕組み
• 基本設定
• 設定経路の早見表
• コア設定一覧
• 生成パラメーター
• コンテキスト設定
• システムプロンプト
• セッション管理
• 同時実行制御
• 会話履歴モード
• クエリ再生成
• Markdownレンダリング
• APIの使用
• Webインターフェース
• トラブルシューティング
• 参考情報

スクリプティング

スクリプティング概要

• 概要
• 対応スクリプト言語
• スクリプトの使用場面
• 基本的な構文
• 利用可能なオブジェクト
• セキュリティ
• パフォーマンス
• デバッグ
• 参考情報

Groovyスクリプトガイド

• 概要
• 基本構文
• データストアスクリプト
• 利用可能なオブジェクト
• スケジュールジョブスクリプト
• Javaクラスの使用
• Fessコンポーネントへのアクセス
• エラーハンドリング
• デバッグとログ出力
• ベストプラクティス
• 参考情報

パフォーマンス・運用

レート制限の設定

• 概要
• HTTPリクエストのレート制限
• AI検索モードのレート制限
• クローラーのレート制限
• レート制限の全設定項目
• 高度なレート制限設定
• 除外設定
• 監視とアラート
• トラブルシューティング
• 参考情報

負荷制御の設定

• 概要
• HTTPリクエスト負荷制御の設定
• 動作の仕組み
• 設定例
• レート制限との違い
• 適応型負荷制御
• トラブルシューティング
• 参考情報

システム管理

ログ設定

• 概要
• ログファイルの種類
• ログレベルの設定
• クローラーログの設定
• ログローテーション
• ログ監視
• ログフォーマット
• パフォーマンスへの影響
• トラブルシューティング
• 参考情報

ログ通知

• 概要
• 仕組み
• セットアップ
• 設定プロパティ
• 通知メッセージの形式
• 運用ガイド
• トラブルシューティング
• 参考情報

インデックスの管理

• 概要
• インデックスの構成
• インデックスのバックアップとリストア
• 設定ファイルのバックアップ
• データ移行
• トラブルシューティング
• 参考情報

インデックスエクスポート機能

• 概要
• 動作の仕組み
• 設定プロパティ
• ジョブの有効化
• カスタムクエリフィルタリング
• エクスポートされたファイル構造
• ベストプラクティス
• トラブルシューティング
• 関連トピック

Analyzerの設定

• Analyzerについて

検索ログ可視化の設定

• 検索ログの可視化について
• OpenSearch Dashboards によるデータ可視化の設定