アーカイブ

15.6

Fess インストールガイド

• はじめに
  • 本ドキュメントについて
  • 対象読者
  • お読みになる前に
  • ドキュメント構成
  • オンラインでのアクセス
  • 技術的なサポートの連絡先
    • 商用サポート
  • コメントおよび提案の送付方法
• システム要件
  • ハードウェア要件
    • 最小要件
    • 推奨要件
  • ソフトウェア要件
    • オペレーティングシステム
    • 必須ソフトウェア
      • TAR.GZ/ZIP/RPM/DEB 版
      • Docker 版
  • ネットワーク要件
    • 必要なポート
    • ファイアウォール設定
  • ブラウザー要件
  • 前提条件チェックリスト
  • 次のステップ
• インストール方法の選択
  • 前提条件の確認
  • インストール方法の比較
  • 各インストール方法の特徴
    • Docker 版
    • Linux パッケージ版 (TAR.GZ/RPM/DEB)
    • Windows 版 (ZIP)
  • インストールの基本的な流れ
  • 必要なコンポーネント
    • Fess 本体
    • OpenSearch
    • Java (Docker 版以外)
  • 次のステップ
  • よくある質問
    • Q: OpenSearch は必須ですか？
    • Q: 以前のバージョンからアップグレードできますか？
    • Q: 複数のサーバーで構成できますか？
  • ダウンロード
  • バージョン情報
• Linux へのインストール (詳細手順)
  • 前提条件
  • インストール方法の選択
  • TAR.GZ 版でのインストール
    • ステップ 1: OpenSearch のインストール
    • ステップ 2: Fess のインストール
    • ステップ 3: 起動
  • RPM 版でのインストール
    • ステップ 1: OpenSearch のインストール
    • ステップ 2: Fess のインストール
    • ステップ 3: 起動
  • DEB 版でのインストール
    • ステップ 1: OpenSearch のインストール
    • ステップ 2: Fess のインストール
    • ステップ 3: 起動
  • インストール後の確認
  • 次のステップ
  • よくある質問
    • Q: OpenSearch のバージョンは他のバージョンでも動作しますか？
    • Q: 複数の Fess インスタンスで同じ OpenSearch を共有できますか？
    • Q: OpenSearch をクラスター構成にする方法は？
• Windows へのインストール (詳細手順)
  • 前提条件
  • Java のインストール確認
  • 環境変数の設定
  • ステップ 1: OpenSearch のインストール
    • OpenSearch のダウンロード
    • OpenSearch プラグインのインストール
    • OpenSearch の設定
  • ステップ 2: Fess のインストール
    • Fess のダウンロード
    • Fess の設定
    • インストールの確認
  • ステップ 3: 起動
  • Windows サービスとしての登録（オプション）
    • NSSM を使用した例
  • ファイアウォール設定
  • トラブルシューティング
    • ポート番号の競合
    • パスの長さ制限
    • Java が認識されない
  • 次のステップ
  • よくある質問
    • Q: Windows Server での運用は推奨されますか？
    • Q: 64 ビット版と 32 ビット版の違いは？
    • Q: パスに日本語が含まれる場合の対処法は？
• Docker でのインストール (詳細)
  • 前提条件
  • Docker のインストール確認
  • Docker イメージについて
  • ステップ 1: Docker Compose ファイルの取得
    • 方法 1: ファイルを個別にダウンロード
    • 方法 2: Git でリポジトリをクローン
  • ステップ 2: Docker Compose ファイルの確認
    • compose.yaml の内容
    • compose-opensearch3.yaml の内容
    • 設定のカスタマイズ（オプション）
  • ステップ 3: Docker コンテナの起動
    • 基本的な起動
    • 起動の確認
  • ステップ 4: ブラウザーでアクセス
  • AI検索モード（LLMプラグイン）の有効化
  • データの永続化
  • Docker コンテナの停止
  • 高度な設定
    • 環境変数のカスタマイズ
    • 設定ファイルの反映方法
      • 方法 1: 設定ファイルのマウント
      • 方法 2: システムプロパティによる設定
    • 外部の OpenSearch への接続
    • Docker ネットワークの設定
  • Docker Compose での本番運用
  • トラブルシューティング
    • コンテナが起動しない
    • メモリ不足エラー
    • データの初期化
  • 次のステップ
  • よくある質問
    • Q: Docker イメージのサイズはどのくらいですか？
    • Q: Kubernetes での運用は可能ですか？
    • Q: コンテナのアップデートはどのように行いますか？
    • Q: マルチノード構成は可能ですか？
• 起動、停止、初期設定
  • 起動方法
    • TAR.GZ 版の場合
      • OpenSearch の起動
      • Fess の起動
    • ZIP 版の場合（Windows）
      • OpenSearch の起動
      • Fess の起動
    • RPM/DEB 版の場合 (chkconfig)
    • RPM/DEB 版の場合 (systemd)
    • Docker 版の場合
  • 起動の確認
    • ヘルスチェック
    • ログの確認
  • ブラウザーでのアクセス
    • 検索画面
    • 管理画面
  • 初回セットアップ
    • ステップ 1: 管理者パスワードの変更
    • ステップ 2: クロール設定の作成
    • ステップ 3: クロールの実行
    • ステップ 4: 検索の確認
  • その他の推奨設定
    • メールサーバーの設定
    • タイムゾーンの設定
    • ログレベルの調整
  • 停止方法
    • TAR.GZ/ZIP 版の場合
      • Fess の停止
    • RPM/DEB 版の場合 (chkconfig)
    • RPM/DEB 版の場合 (systemd)
    • Docker 版の場合
  • 再起動方法
    • TAR.GZ/ZIP 版の場合
    • RPM/DEB 版の場合
    • Docker 版の場合
  • トラブルシューティング
    • 起動しない場合
  • 次のステップ
• セキュリティ設定
  • 必須のセキュリティ設定
    • 管理者パスワードの変更
    • OpenSearch のセキュリティプラグイン有効化
    • HTTPS の有効化
  • 推奨のセキュリティ設定
    • ファイアウォール設定
    • アクセス制御の設定
    • ロールベースアクセス制御 (RBAC)
    • 監査ログの有効化
    • 定期的なセキュリティアップデート
  • データ保護
    • バックアップの暗号化
  • セキュリティベストプラクティス
    • 最小権限の原則
    • ネットワーク分離
    • 定期的なセキュリティ監査
    • セキュリティヘッダーの設定
  • セキュリティチェックリスト
    • 基本設定
    • ネットワークセキュリティ
    • アクセス制御
    • 監視とログ
    • バックアップとリカバリ
    • アップデートとパッチ管理
  • セキュリティインシデント対応
  • 参考情報
• アップグレード手順
  • 対応バージョン
  • アップグレード前の準備
    • バージョン互換性の確認
    • ダウンタイムの計画
  • ステップ 1: データのバックアップ
    • 設定データのバックアップ
    • インデックスデータのバックアップ
      • 方法 1: スナップショット機能を使用（推奨）
      • 方法 2: ディレクトリごとバックアップ
    • Docker 版のバックアップ
  • ステップ 2: 現在のバージョンの停止
  • ステップ 3: 新しいバージョンのインストール
    • TAR.GZ/ZIP 版
    • RPM/DEB 版
    • Docker 版
  • ステップ 4: OpenSearch のアップグレード（必要な場合）
  • ステップ 5: 新しいバージョンの起動
  • ステップ 6: 動作確認
  • ステップ 7: インデックスの再作成（推奨）
  • ロールバック手順
    • ステップ 1: 新しいバージョンの停止
    • ステップ 2: 古いバージョンの復元
    • ステップ 3: データの復元
    • ステップ 4: サービスの起動と確認
  • よくある質問
    • Q: ダウンタイムなしでアップグレードできますか？
    • Q: OpenSearch もアップグレードする必要がありますか？
    • Q: インデックスを再作成する必要がありますか？
    • Q: アップグレード後、検索結果が表示されません
  • 次のステップ
• アンインストール手順
  • アンインストール前の準備
    • バックアップの取得
    • サービスの停止
  • TAR.GZ/ZIP 版のアンインストール
    • ステップ 1: Fess の削除
    • ステップ 2: OpenSearch の削除
    • ステップ 3: データディレクトリの削除（オプション）
    • ステップ 4: ログディレクトリの削除（オプション）
  • RPM 版のアンインストール
    • ステップ 1: Fess のアンインストール
    • ステップ 2: OpenSearch のアンインストール
    • ステップ 3: サービスの無効化と削除
    • ステップ 4: データディレクトリの削除
    • ステップ 5: 設定ファイルの削除
    • ステップ 6: ログファイルの削除
    • ステップ 7: ユーザーとグループの削除（オプション）
  • DEB 版のアンインストール
    • ステップ 1: Fess のアンインストール
    • ステップ 2: OpenSearch のアンインストール
    • ステップ 3: サービスの無効化
    • ステップ 4: データディレクトリの削除
    • ステップ 5: 設定ファイルの削除（dpkg -P を使用しなかった場合）
    • ステップ 6: ログファイルの削除
    • ステップ 7: ユーザーとグループの削除（オプション）
  • Docker 版のアンインストール
    • ステップ 1: コンテナとネットワークの削除
    • ステップ 2: ボリュームの削除
    • ステップ 3: イメージの削除（オプション）
    • ステップ 4: ネットワークの削除（オプション）
    • ステップ 5: Compose ファイルの削除
  • アンインストールの確認
    • プロセスの確認
    • ポートの確認
    • ファイルの確認
    • パッケージの確認
  • 部分的なアンインストール
    • Fess のみを削除して OpenSearch を残す
    • OpenSearch のみを削除して Fess を残す
  • トラブルシューティング
    • パッケージが削除できない
    • ディレクトリが削除できない
  • 再インストールの準備
  • 次のステップ
• トラブルシューティング
  • インストール時の問題
    • Java が認識されない
    • プラグインのインストールに失敗する
  • 起動時の問題
    • Fess が起動しない
    • OpenSearch が起動しない
    • ポート番号の競合
  • 接続の問題
    • Fess が OpenSearch に接続できない
    • ブラウザーから Fess にアクセスできない
  • パフォーマンスの問題
    • 検索が遅い
    • クロールが遅い
  • データの問題
    • 検索結果が表示されない
    • インデックスが破損している
  • Docker 固有の問題
    • コンテナが起動しない
    • コンテナは起動するが Fess にアクセスできない
  • Windows 固有の問題
    • パスの問題
    • サービスとして登録できない
  • その他の問題
    • ログレベルの変更
    • データベースのリセット
  • サポート情報
    • コミュニティサポート
    • 商用サポート
  • デバッグ情報の収集

Fess ユーザーガイド

• はじめに
  • 対象読者
  • お読みになる前に
  • オンラインでのアクセス
  • 技術的なサポートの連絡先
    • 商用サポート
  • 関連サードパーティー Web サイトの参照
  • コメントおよび提案の送付方法
• AND 検索
  • 利用方法
• OR 検索
  • 利用方法
• NOT 検索
  • 利用方法
• ラベル指定検索
  • ラベル指定検索 (カテゴリ検索)
    • 利用方法
• 検索フィールド指定検索
  • フィールド指定検索
    • 利用可能なフィールド
    • 利用方法
• ソート検索
  • ソート対象フィールド
  • 利用方法
• ワイルドカード検索
  • 利用方法
  • 利用条件
• 範囲指定検索
  • 利用方法
• ブースト検索
  • ブースト検索(重み付け検索)
    • 利用方法
• 曖昧検索
  • 曖昧検索(ファジー検索)
    • 利用方法
• 位置情報検索
  • 利用方法
• 非表示検索条件
  • 利用方法
• ロール検索
  • 検索方法
  • パスワードの変更
  • ログアウト
• 特殊文字
  • 利用方法
• 詳細検索
  • 利用方法
  • 項目一覧
    • すべての単語を含む
    • 語順も含めた完全一致
    • いずれかの単語を含む
    • 含めない単語
    • 表示件数
    • ソート
    • 優先する言語
    • ラベル
    • 更新日時
    • ファイル形式
    • 検索対象
    • サイトまたはドメイン
• AI検索モード
  • 概要
  • AI検索モードの特徴
    • 対話形式での検索
    • 文脈を理解した回答
    • 出典の明示
    • 会話の継続
  • チャット検索の使い方
    • チャットを開始する
    • 質問を入力する
    • 回答を確認する
    • 会話を続ける
    • 新しい会話を始める
  • 効果的な質問のコツ
    • 具体的に質問する
    • 背景情報を含める
    • 段階的に質問する
  • よくある質問
    • Q: チャット機能が表示されません
    • Q: 回答が表示されるまで時間がかかります
    • Q: 回答の出典が間違っているように見えます
    • Q: 前の会話を忘れてしまったようです
    • Q: 特定の質問に対して回答が得られません
    • Q: 日本語以外で質問できますか？
  • 注意事項
    • AIの回答について
    • プライバシーについて
  • 参考情報

Fess APIガイド

• はじめに
  • 対象読者
  • お読みになる前に
  • API利用の前提条件
  • オンラインでのアクセス
  • 技術的なサポートの連絡先
    • 商用サポート
  • 関連サードパーティー Web サイトの参照
  • コメントおよび提案の送付方法
• APIクイックスタート
  • 5分で始めるAPI
    • 前提条件
    • 検索APIを試す
    • サジェストAPIを試す
    • ラベルAPIを試す
    • ヘルスチェックAPIを試す
  • Postman での利用
    • コレクションのセットアップ
    • 環境変数の設定
  • プログラミング言語別サンプル
    • Python
    • JavaScript (Node.js)
    • JavaScript (ブラウザ)
    • Java
  • APIバージョン対応表
  • トラブルシューティング
    • APIが動作しない場合
  • 次のステップ
• APIの概要
  • Fess の提供するAPI
  • ベースURL
  • 認証
  • HTTPメソッド
  • レスポンスフォーマット
  • エラーハンドリング
  • APIの種類
• 検索API
  • 検索結果の取得
    • リクエスト
    • リクエストパラメーター
    • レスポンス
  • 全てのドキュメントを検索
    • リクエストパラメーター
  • エラーレスポンス
• ラベルAPI
  • ラベルの取得
    • リクエスト
    • リクエストパラメーター
    • レスポンス
  • 使用例
  • エラーレスポンス
• 人気ワードAPI
  • 人気ワード一覧の取得
    • リクエスト
    • リクエストパラメーター
    • レスポンス
  • エラーレスポンス
• サジェストAPI
  • サジェストワード一覧の取得
    • リクエスト
    • リクエストパラメーター
    • レスポンス
  • エラーレスポンス
• Health API
  • 状態の取得
    • リクエスト
    • リクエストパラメーター
    • レスポンス
  • エラーレスポンス
• Chat API
  • 概要
  • 前提条件
  • 非ストリーミングAPI
    • エンドポイント
    • リクエストパラメーター
    • レスポンス
    • HTTPステータスコード
    • 使用例
      • cURL
      • JavaScript
      • Python
  • ストリーミングAPI
    • エンドポイント
    • リクエストパラメーター
    • レスポンス形式
    • SSEイベント
    • 使用例
      • cURL
      • JavaScript（EventSource）
      • Python
  • エラーハンドリング
  • レート制限
  • セキュリティ
  • 参考情報
• Admin API リファレンス
  • Admin API 概要
    • 概要
    • ベースURL
    • 認証
      • アクセストークンの取得
      • トークンの使用
        • cURL例
      • 必要な権限
    • 共通パターン
      • 一覧取得（GET/PUT /settings）
        • リクエスト
        • レスポンス
      • 単一設定取得（GET /setting/{id}）
        • リクエスト
        • レスポンス
      • 新規作成（POST /setting）
        • リクエスト
        • レスポンス
      • 更新（PUT /setting）
        • リクエスト
        • レスポンス
      • 削除（DELETE /setting/{id}）
        • リクエスト
        • レスポンス
    • レスポンス形式
      • 成功レスポンス
      • エラーレスポンス
      • HTTPステータスコード
    • 利用可能なAPI
      • クロール設定
      • インデックス管理
      • スケジューラー
      • ユーザー・権限管理
      • 検索チューニング
      • システム
      • 辞書
    • 使用例
      • Webクロール設定の作成
      • スケジュールジョブの開始
      • ユーザーの一覧取得
    • 参考情報
  • WebConfig API
    • 概要
    • ベースURL
    • エンドポイント一覧
    • Webクロール設定一覧取得
      • リクエスト
        • パラメーター
      • レスポンス
    • Webクロール設定取得
      • リクエスト
      • レスポンス
    • Webクロール設定作成
      • リクエスト
        • リクエストボディ
        • フィールド説明
      • レスポンス
    • Webクロール設定更新
      • リクエスト
        • リクエストボディ
      • レスポンス
    • Webクロール設定削除
      • リクエスト
      • レスポンス
    • URLパターンの例
      • includedUrls / excludedUrls
    • 使用例
      • 企業サイトのクロール設定
      • ドキュメントサイトのクロール設定
    • 参考情報
  • FileConfig API
    • 概要
    • ベースURL
    • エンドポイント一覧
    • ファイルクロール設定一覧取得
      • リクエスト
        • パラメーター
      • レスポンス
    • ファイルクロール設定取得
      • リクエスト
      • レスポンス
    • ファイルクロール設定作成
      • リクエスト
        • リクエストボディ
        • フィールド説明
      • レスポンス
    • ファイルクロール設定更新
      • リクエスト
        • リクエストボディ
      • レスポンス
    • ファイルクロール設定削除
      • リクエスト
      • レスポンス
    • パスの形式
    • 使用例
      • SMB共有のクロール設定
    • 参考情報
  • DataConfig API
    • 概要
    • ベースURL
    • エンドポイント一覧
    • データストア設定一覧取得
      • リクエスト
        • パラメーター
      • レスポンス
    • データストア設定取得
      • リクエスト
      • レスポンス
    • データストア設定作成
      • リクエスト
        • リクエストボディ
        • フィールド説明
      • レスポンス
    • データストア設定更新
      • リクエスト
        • リクエストボディ
      • レスポンス
    • データストア設定削除
      • リクエスト
      • レスポンス
    • ハンドラータイプ
    • 使用例
      • データベースクロール設定
    • 参考情報
  • Documents API
    • 概要
    • ベースURL
    • エンドポイント一覧
    • クエリ指定でのドキュメント削除
      • リクエスト
        • パラメーター
      • レスポンス
        • 使用例
    • ID指定でのドキュメント削除
      • リクエスト
        • パラメーター
      • レスポンス
        • 使用例
    • クエリ構文
      • 基本的なクエリ
      • 日付範囲クエリ
      • 複合クエリ
    • 注意事項
      • 削除操作の注意
      • 推奨プラクティス
    • 使用例
      • サイト全体の再クロール準備
      • 古いドキュメントのクリーンアップ
    • 参考情報
  • CrawlingInfo API
    • 概要
    • ベースURL
    • エンドポイント一覧
    • クロール情報一覧取得
      • リクエスト
        • パラメーター
      • レスポンス
        • レスポンスフィールド
    • クロールセッション詳細取得
      • リクエスト
      • レスポンス
    • クロールセッション削除
      • リクエスト
      • レスポンス
    • 使用例
      • クロール情報一覧の取得
      • 実行中のクロールセッション取得
      • 特定セッションの詳細取得
      • 古いセッションの削除
      • 進捗状況の監視
    • 参考情報
  • FailureUrl API
    • 概要
    • ベースURL
    • エンドポイント一覧
    • 障害URL一覧取得
      • リクエスト
        • パラメーター
      • レスポンス
        • レスポンスフィールド
    • 障害URL削除
      • リクエスト
      • レスポンス
    • 全障害URL削除
      • リクエスト
        • パラメーター
      • レスポンス
    • エラータイプ
    • 使用例
      • 障害URL一覧の取得
      • エラー回数でフィルター
      • 特定設定の障害URL取得
      • 障害URLの削除
      • 全障害URLの削除
      • エラータイプ別の集計
    • 参考情報
  • Backup API
    • 概要
    • ベースURL
    • エンドポイント一覧
    • 設定データエクスポート
      • リクエスト
        • パラメーター
        • エクスポート対象タイプ
      • レスポンス
        • ZIPファイル内容
    • 設定データインポート
      • リクエスト
        • リクエストボディ
        • フィールド説明
      • レスポンス
    • 使用例
      • 全設定のエクスポート
      • 特定設定のエクスポート
      • 設定のインポート
      • 既存設定を上書きしてインポート
      • 特定設定のみインポート
      • バックアップの自動化
    • 注意事項
    • 参考情報
  • Scheduler API
    • 概要
    • ベースURL
    • エンドポイント一覧
    • スケジュールジョブ一覧取得
      • リクエスト
        • パラメーター
      • レスポンス
    • スケジュールジョブ取得
      • リクエスト
      • レスポンス
    • スケジュールジョブ作成
      • リクエスト
        • リクエストボディ
        • フィールド説明
      • レスポンス
        • Cron式の例
    • スケジュールジョブ更新
      • リクエスト
        • リクエストボディ
      • レスポンス
    • スケジュールジョブ削除
      • リクエスト
      • レスポンス
    • ジョブ開始
      • リクエスト
      • レスポンス
      • 注意事項
    • ジョブ停止
      • リクエスト
      • レスポンス
    • 使用例
      • クロールジョブの作成と実行
      • ジョブの状態確認
    • 参考情報
  • JobLog API
    • 概要
    • ベースURL
    • エンドポイント一覧
    • ジョブログ一覧取得
      • リクエスト
        • パラメーター
      • レスポンス
        • レスポンスフィールド
    • ジョブログ詳細取得
      • リクエスト
      • レスポンス
    • ジョブログ削除
      • リクエスト
      • レスポンス
    • 全ジョブログ削除
      • リクエスト
        • パラメーター
      • レスポンス
    • 使用例
      • ジョブログ一覧の取得
      • 失敗したジョブのみ取得
      • 特定期間のジョブログ
      • ジョブログ詳細の取得
      • 古いジョブログの削除
      • 失敗したジョブログのみ削除
      • 実行時間が長いジョブの検出
      • ジョブ成功率の計算
    • 参考情報
  • User API
    • 概要
    • ベースURL
    • エンドポイント一覧
    • ユーザー一覧取得
      • リクエスト
        • パラメーター
      • レスポンス
    • ユーザー取得
      • リクエスト
      • レスポンス
    • ユーザー作成
      • リクエスト
        • リクエストボディ
        • フィールド説明
      • レスポンス
    • ユーザー更新
      • リクエスト
        • リクエストボディ
      • レスポンス
    • ユーザー削除
      • リクエスト
      • レスポンス
    • 使用例
      • 新規ユーザー作成
      • ユーザーのロール変更
    • 参考情報
  • Role API
    • 概要
    • ベースURL
    • エンドポイント一覧
    • ロール一覧取得
      • リクエスト
        • パラメーター
      • レスポンス
    • ロール取得
      • リクエスト
      • レスポンス
    • ロール作成
      • リクエスト
        • リクエストボディ
        • フィールド説明
      • レスポンス
    • ロール更新
      • リクエスト
        • リクエストボディ
      • レスポンス
    • ロール削除
      • リクエスト
      • レスポンス
    • 使用例
      • 新規ロール作成
      • ロール一覧取得
    • 参考情報
  • Group API
    • 概要
    • ベースURL
    • エンドポイント一覧
    • グループ一覧取得
      • リクエスト
        • パラメーター
      • レスポンス
    • グループ取得
      • リクエスト
      • レスポンス
    • グループ作成
      • リクエスト
        • リクエストボディ
        • フィールド説明
      • レスポンス
    • グループ更新
      • リクエスト
        • リクエストボディ
      • レスポンス
    • グループ削除
      • リクエスト
      • レスポンス
    • 使用例
      • 新規グループ作成
      • グループ一覧取得
    • 参考情報
  • AccessToken API
    • 概要
    • ベースURL
    • エンドポイント一覧
    • アクセストークン一覧取得
      • リクエスト
        • パラメーター
      • レスポンス
    • アクセストークン取得
      • リクエスト
      • レスポンス
    • アクセストークン作成
      • リクエスト
        • リクエストボディ
        • フィールド説明
      • レスポンス
    • アクセストークン更新
      • リクエスト
        • リクエストボディ
      • レスポンス
    • アクセストークン削除
      • リクエスト
      • レスポンス
    • 使用例
      • APIトークン作成
      • トークンを使用したAPI呼び出し
    • 参考情報
  • LabelType API
    • 概要
    • ベースURL
    • エンドポイント一覧
    • ラベルタイプ一覧取得
      • リクエスト
        • パラメーター
      • レスポンス
    • ラベルタイプ取得
      • リクエスト
      • レスポンス
    • ラベルタイプ作成
      • リクエスト
        • リクエストボディ
        • フィールド説明
      • レスポンス
    • ラベルタイプ更新
      • リクエスト
        • リクエストボディ
      • レスポンス
    • ラベルタイプ削除
      • リクエスト
      • レスポンス
    • 使用例
      • ドキュメント用ラベル作成
      • ラベルを使用した検索
    • 参考情報
  • KeyMatch API
    • 概要
    • ベースURL
    • エンドポイント一覧
    • キーマッチ一覧取得
      • リクエスト
        • パラメーター
      • レスポンス
    • キーマッチ取得
      • リクエスト
      • レスポンス
    • キーマッチ作成
      • リクエスト
        • リクエストボディ
        • フィールド説明
      • レスポンス
    • キーマッチ更新
      • リクエスト
        • リクエストボディ
      • レスポンス
    • キーマッチ削除
      • リクエスト
      • レスポンス
    • 使用例
      • 製品ページのキーマッチ作成
      • サポートページのキーマッチ
    • 参考情報
  • BoostDoc API
    • 概要
    • ベースURL
    • エンドポイント一覧
    • ドキュメントブースト一覧取得
      • リクエスト
        • パラメーター
      • レスポンス
    • ドキュメントブースト取得
      • リクエスト
      • レスポンス
    • ドキュメントブースト作成
      • リクエスト
        • リクエストボディ
        • フィールド説明
      • レスポンス
    • ドキュメントブースト更新
      • リクエスト
        • リクエストボディ
      • レスポンス
    • ドキュメントブースト削除
      • リクエスト
      • レスポンス
    • ブースト式の例
    • 使用例
      • ドキュメントサイトのブースト
      • 新しいコンテンツのブースト
    • 参考情報
  • ElevateWord API
    • 概要
    • ベースURL
    • エンドポイント一覧
    • エレベートワード一覧取得
      • リクエスト
        • パラメーター
      • レスポンス
    • エレベートワード取得
      • リクエスト
      • レスポンス
    • エレベートワード作成
      • リクエスト
        • リクエストボディ
        • フィールド説明
      • レスポンス
    • エレベートワード更新
      • リクエスト
        • リクエストボディ
      • レスポンス
    • エレベートワード削除
      • リクエスト
      • レスポンス
    • 使用例
      • 製品名のエレベート
      • 特定ラベルへのエレベート
    • 参考情報
  • BadWord API
    • 概要
    • ベースURL
    • エンドポイント一覧
    • NGワード一覧取得
      • リクエスト
        • パラメーター
      • レスポンス
    • NGワード取得
      • リクエスト
      • レスポンス
    • NGワード作成
      • リクエスト
        • リクエストボディ
        • フィールド説明
      • レスポンス
    • NGワード更新
      • リクエスト
        • リクエストボディ
      • レスポンス
    • NGワード削除
      • リクエスト
      • レスポンス
    • 使用例
      • スパムキーワードの除外
      • 特定ロール向けのNGワード
    • 参考情報
  • RelatedContent API
    • 概要
    • ベースURL
    • エンドポイント一覧
    • 関連コンテンツ一覧取得
      • リクエスト
        • パラメーター
      • レスポンス
    • 関連コンテンツ取得
      • リクエスト
      • レスポンス
    • 関連コンテンツ作成
      • リクエスト
        • リクエストボディ
        • フィールド説明
      • レスポンス
    • 関連コンテンツ更新
      • リクエスト
        • リクエストボディ
      • レスポンス
    • 関連コンテンツ削除
      • リクエスト
      • レスポンス
    • 使用例
      • 製品情報の関連コンテンツ
      • サポート情報の関連コンテンツ
    • 参考情報
  • RelatedQuery API
    • 概要
    • ベースURL
    • エンドポイント一覧
    • 関連クエリ一覧取得
      • リクエスト
        • パラメーター
      • レスポンス
    • 関連クエリ取得
      • リクエスト
      • レスポンス
    • 関連クエリ作成
      • リクエスト
        • リクエストボディ
        • フィールド説明
      • レスポンス
    • 関連クエリ更新
      • リクエスト
        • リクエストボディ
      • レスポンス
    • 関連クエリ削除
      • リクエスト
      • レスポンス
    • 使用例
      • 製品関連のクエリ
      • ヘルプ関連のクエリ
    • 参考情報
  • Suggest API
    • 概要
    • ベースURL
    • エンドポイント一覧
    • サジェストワード一覧取得
      • リクエスト
        • パラメーター
      • レスポンス
    • サジェストワード取得
      • リクエスト
      • レスポンス
    • サジェストワード作成
      • リクエスト
        • リクエストボディ
        • フィールド説明
      • レスポンス
    • サジェストワード更新
      • リクエスト
        • リクエストボディ
      • レスポンス
    • サジェストワード削除
      • リクエスト
      • レスポンス
    • 全サジェストワード削除
      • リクエスト
      • レスポンス
    • 使用例
      • 人気キーワードの追加
      • サジェストの一括削除
    • 参考情報
  • General API
    • 概要
    • ベースURL
    • エンドポイント一覧
    • 一般設定取得
      • リクエスト
      • レスポンス
    • 一般設定更新
      • リクエスト
        • リクエストボディ
        • フィールド説明
      • レスポンス
    • 使用例
      • クローラー設定の更新
      • 検索設定の更新
      • サジェスト設定の更新
    • 参考情報
  • SystemInfo API
    • 概要
    • ベースURL
    • エンドポイント一覧
    • システム情報取得
      • リクエスト
      • レスポンス
        • レスポンスフィールド
    • 使用例
      • システム情報の取得
      • バージョン確認
      • メモリ使用状況の確認
    • 参考情報
  • Stats API
    • 概要
    • ベースURL
    • エンドポイント一覧
    • 統計情報取得
      • リクエスト
        • パラメーター
      • レスポンス
        • レスポンスフィールド
    • 検索クエリ統計
      • リクエスト
      • レスポンス
    • クリック統計
      • リクエスト
      • レスポンス
    • 使用例
      • 全統計情報の取得
      • 期間指定での統計取得
      • 検索クエリ統計の取得
      • 人気クエリTOP10の取得
    • 参考情報
  • Log API
    • 概要
    • ベースURL
    • エンドポイント一覧
    • 検索ログ取得
      • リクエスト
        • パラメーター
      • レスポンス
    • クリックログ取得
      • リクエスト
        • パラメーター
      • レスポンス
    • お気に入りログ取得
      • リクエスト
        • パラメーター
      • レスポンス
    • 検索ログ削除
      • リクエスト
        • パラメーター
      • レスポンス
    • 使用例
      • 最近の検索ログ取得
      • 特定期間の検索ログ
      • 特定クエリの検索ログ
      • クリックログ取得
      • 古い検索ログの削除
    • 参考情報
  • SearchLog API
    • 概要
    • ベースURL
    • エンドポイント一覧
    • 検索ログ一覧取得
      • リクエスト
        • パラメーター
      • レスポンス
        • レスポンスフィールド
    • 検索ログ詳細取得
      • リクエスト
      • レスポンス
    • 検索ログ削除
      • リクエスト
      • レスポンス
    • 検索ログ一括削除
      • リクエスト
        • パラメーター
      • レスポンス
    • 検索統計取得
      • リクエスト
        • パラメーター
      • レスポンス
    • 使用例
      • 検索ログ一覧の取得
      • 期間を指定して取得
      • 特定ユーザーの検索ログ
      • 特定キーワードの検索ログ
      • 検索統計の取得
      • 古い検索ログの削除
      • 人気検索キーワードの抽出
      • 検索品質の分析
      • 日別検索数の推移
    • 参考情報
  • Storage API
    • 概要
    • ベースURL
    • エンドポイント一覧
    • ストレージ情報取得
      • リクエスト
      • レスポンス
        • レスポンスフィールド
    • インデックス最適化
      • リクエスト
        • リクエストボディ
        • フィールド説明
      • レスポンス
    • インデックスフラッシュ
      • リクエスト
        • リクエストボディ
        • フィールド説明
      • レスポンス
    • 使用例
      • ストレージ情報の取得
      • 全インデックスの最適化
      • 特定インデックスの最適化
      • 削除済みドキュメントの削除
      • インデックスのフラッシュ
    • 参考情報
  • Plugin API
    • 概要
    • ベースURL
    • エンドポイント一覧
    • プラグイン一覧取得
      • リクエスト
      • レスポンス
        • レスポンスフィールド
    • プラグインインストール
      • リクエスト
        • リクエストボディ
        • フィールド説明
      • レスポンス
    • プラグイン削除
      • リクエスト
      • レスポンス
    • 使用例
      • プラグイン一覧の取得
      • プラグインのインストール
      • プラグインの削除
    • 注意事項
    • 参考情報
  • Dict API
    • 概要
    • ベースURL
    • エンドポイント一覧
    • 辞書一覧取得
      • リクエスト
      • レスポンス
    • 辞書内容取得
      • リクエスト
      • レスポンス
    • 辞書内容更新
      • リクエスト
        • リクエストボディ
        • フィールド説明
      • レスポンス
    • 辞書ファイルアップロード
      • リクエスト
        • リクエストボディ
        • フィールド説明
      • レスポンス
    • 辞書タイプ
    • 辞書形式の例
      • 同義語辞書
      • マッピング辞書
      • 保護語辞書
    • 使用例
      • 辞書一覧の取得
      • 同義語辞書の内容取得
      • 同義語辞書の更新
      • 辞書ファイルのアップロード
    • 注意事項
    • 参考情報

Fess 管理者ガイド

• はじめに
  • 対象読者
  • お読みになる前に
  • オンラインでのアクセス
  • 技術的なサポートの連絡先
    • 商用サポート
• ダッシュボード
  • 概要
  • インデックスされているドキュメント数の確認
• 構成ウィザード
  • 概要
    • 簡易セットアップ
    • クロールの設定
    • 設定項目
      • 名前
      • クロールパス
      • 最大アクセス数
      • 深さ
    • クローラ
• 全般
  • 概要
  • 設定内容
    • システム
      • JSONレスポンス
      • ログインが必要
      • ログインリンク表示
      • 重複結果の折り畳み
      • サムネイル表示
      • システムプロパティ
      • デフォルトのラベル値
      • デフォルトのソート値
      • 仮想ホスト
      • 人気ワードのレスポンス
      • CSVファイルのエンコード
      • 検索パラメーターの追加
      • 検索ファイルプロキシ
      • ブラウザロケールを使用
      • SSOタイプ
    • クローラー
      • 最終更新日時の確認
      • 同時クローラー設定
      • ユーザーエージェント
      • 以前のドキュメントを削除
      • 除外するエラーの種別
      • 障害数のしきい値
    • ロギング
      • 検索ログ
      • ユーザログ
      • お気に入りログ
      • 以前の検索ログを削除
      • 以前のジョブログを削除
      • 以前のユーザーログを削除
      • ログを削除するボット名
      • ログレベル
    • サジェスト
      • 検索語でサジェスト
      • ドキュメントでサジェスト
      • 以前のサジェスト情報を削除
    • LDAP
      • LDAP URL
      • Base DN
      • Bind DN
      • パスワード
      • User DN
      • アカウントフィルター
      • グループフィルター
      • memberOf属性
      • セキュリティ認証
      • 初期コンテキストファクトリ
    • OpenID Connect
      • クライアントID
      • クライアントシークレット
      • 認証サーバーURL
      • トークンサーバーURL
      • リダイレクトURL
      • スコープ
      • ベースURL
      • デフォルトグループ
      • デフォルトロール
    • SAML
      • IdPエンティティID
      • IdP SSO URL
      • IdP SLO URL
      • IdP X.509証明書
      • SPベースURL
      • SPエンティティID
      • SP ACS URL
      • SP SLO URL
      • SP NameIDフォーマット
      • グループ属性名
      • ロール属性名
      • デフォルトグループ
      • デフォルトロール
    • SPNEGO
      • Krb5設定
      • ログイン設定
      • ログインクライアントモジュール
      • ログインサーバーモジュール
      • 事前認証ユーザー名
      • 事前認証パスワード
      • Basic認証許可
      • 非セキュアBasic認証許可
      • NTLMプロンプト
      • ローカルホスト許可
      • 委任許可
      • 除外ディレクトリ
      • ロガーレベル
    • Entra ID
      • テナント (IDまたはドメイン)
      • 認証局
      • クライアントID
      • クライアントシークレット
      • 応答URL
      • ステートTTL
      • パーミッションフィールド
      • デフォルトグループ
      • デフォルトロール
      • ドメインサービス使用
    • お知らせ表示
      • ログインページ
      • 検索トップページ
      • 詳細検索ページ
    • 通知
      • 通知メール
      • Slack Webhook URL
      • Google Chat Webhook URL
      • ログ通知
      • ログ通知レベル
    • ストレージ
      • 種別
      • バケット
      • エンドポイント
      • アクセスキー
      • シークレットキー
      • リージョン
      • プロジェクトID
      • 認証情報パス
  • 例
    • LDAPの設定例
• スケジューラ
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
      • 対象
      • スケジュール
      • 実行方法
      • スクリプト
      • ロギング
      • クローラージョブ
      • 状態
      • 表示順序
    • 設定の削除
  • 手動クロール方法
• ページのデザイン
  • 概要
  • 設定方法
    • 表示方法
    • ファイルマネージャー
    • ページファイルの表示
    • アップロードするファイル
      • ファイルのアップロード
      • ファイル名(オプション)
• 辞書
  • 概要
  • 一覧
  • Kuromoji
  • 同義語
  • マッピング
  • Protwords
  • ストップワード
  • Stemmer上書き
• Kuromoji辞書
  • 概要
  • 管理方法
    • 表示方法
    • 設定方法
    • 設定項目
      • トークン
      • 分割
      • 読み
      • 品詞
  • ダウンロード
  • アップロード
• 同義語辞書
  • 概要
  • 管理方法
    • 表示方法
    • 設定方法
    • 設定項目
      • 変換元
      • 変換後
  • ダウンロード
  • アップロード
• マッピング辞書
  • 概要
  • 管理方法
    • 表示方法
    • 設定方法
    • 設定項目
      • 変換元
      • 変換後
  • ダウンロード
  • アップロード
• Protwords辞書
  • 概要
  • 管理方法
    • 表示方法
    • 設定方法
    • 設定項目
      • 単語情報
  • ダウンロード
  • アップロード
• ストップワード辞書
  • 概要
  • 管理方法
    • 表示方法
    • 設定方法
    • 設定項目
      • 変換元
      • 変換後
  • ダウンロード
  • アップロード
• Stemmer上書き辞書
  • 概要
  • 管理方法
    • 表示方法
    • 設定方法
    • 設定項目
      • 変換元
      • 変換後
  • ダウンロード
  • アップロード
• アクセストークン
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
      • パーミッション
      • パラメーター名
      • 有効期限
    • 設定の削除
• プラグイン
  • 概要
  • 管理方法
    • 表示方法
    • インストール
• ストレージ
  • 概要
  • 管理方法
    • オブジェクトストレージサーバーの設定
      • 共通設定
      • S3の設定
      • GCSの設定
      • MinIO（S3互換）の設定
    • 表示方法
    • ダウンロード
    • 削除
    • アップロード
    • フォルダーの作成
• ウェブクロール
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
      • URL
      • クロール対象とするURL
      • クロール対象から除外するURL
      • 検索対象とするURL
      • 検索対象から除外するURL
      • 設定パラメーター
      • 深さ
      • 最大アクセス数
      • ユーザーエージェント
      • スレッド数
      • 間隔
      • ブースト値
      • パーミッション
      • 仮想ホスト
      • 状態
      • 説明
    • 設定の削除
  • 例
    • fess.codelibs.org をクロールする
    • ウェブ認証サイトのウェブクロール
      • Redmine
      • XWiki
• ファイルクロール
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
      • パス
      • クロール対象とするパス
      • クロール対象から除外するパス
      • 検索対象とするパス
      • 検索対象から除外するパス
      • 設定パラメーター
      • 深さ
      • 最大アクセス数
      • スレッド数
      • 間隔
      • ブースト値
      • パーミッション
      • 仮想ホスト
      • 状態
      • 説明
    • 設定の削除
  • 例
    • ローカルファイルをクロール
    • Windowsの共有フォルダーをクロール
    • Amazon S3バケットをクロール
    • Google Cloud Storageバケットをクロール
• データストアクロール
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
      • ハンドラー名
      • パラメーター
      • スクリプト
      • ブースト値
      • パーミッション
      • 仮想ホスト
      • 状態
      • 説明
    • 設定の削除
  • 例
    • DatabaseDataStore
      • パラメーター
      • スクリプト
      • ドライバー
    • CsvDataStore
      • パラメーター
      • スクリプト
    • EsDataStore
      • パラメーター
      • スクリプト
    • CsvListDataStore
      • パラメーター
      • スクリプト
• ラベル
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
      • 値
      • 対象とするパス
      • 除外するパス
      • パーミッション
      • 仮想ホスト
      • 表示順序
    • 設定の削除
• キーマッチ
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 検索語
      • クエリー
      • サイズ
      • ブースト値
      • 仮想ホスト
    • 設定の削除
• ドキュメントブースト
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 条件
      • ブースト値式
      • ソート順
    • 設定の削除
• 関連コンテンツ
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 検索語
      • コンテンツ
      • 仮想ホスト
    • 設定の削除
• 関連クエリー
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 検索語
      • クエリー
      • 仮想ホスト
    • 設定の削除
• パスマッピング
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 正規表現
      • 置換
      • 処理の種別
      • 表示順序
      • ユーザーエージェント
    • 設定の削除
  • 例
    • ファイルサーバーをWebサーバー経由でアクセス
    • 表示時のみURLを変換
    • サーバー移行時のリンク変換
  • 注意事項
    • 抽出URL変換について
    • 正規表現について
    • ソート順について
• ウェブ認証
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • ホスト名
      • ポート
      • レルム
      • スキーム
      • ユーザー名
      • パスワード
      • パラメーター
      • ウェブ設定
    • 設定の削除
• ファイル認証
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • ホスト名
      • ポート
      • スキーム
      • ユーザー名
      • パスワード
      • パラメーター
      • ファイルクロール設定
    • 設定の削除
• リクエストヘッダー
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
      • 値
      • ウェブ設定
    • 設定の削除
• 重複ホスト
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 正規名
      • 重複名
    • 設定の削除
• ユーザー
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • ユーザー名
      • ロール
      • グループ
    • 設定の削除
• ロール
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
    • 設定の削除
• グループ
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
    • 削除の方法
• サジェストワード
  • 概要
  • 管理方法
    • 表示方法
      • 単語種別
      • 単語数
• 追加ワード
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 単語
      • 読み
      • パーミッション
      • ラベル
      • ブースト値
    • 設定の削除
  • ダウンロード
    • CSVの内容
  • アップロード
    • CSVの内容
• 除外ワード
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • サジェスト候補
    • 設定の削除
  • ダウンロード
    • CSVの内容
  • アップロード
    • CSVの内容
• システム情報
  • 概要
  • 管理方法
    • 表示方法
    • 表示項目
      • 環境変数のプロパティ
      • システムのプロパティ
      • アプリのプロパティ
      • バグレポートのプロパティ
• 検索ログ
  • 概要
  • 管理方法
  • 一覧
  • 詳細
• ジョブログ
  • 概要
  • 管理方法
    • 表示方法
    • ジョブログ詳細
      • 名前
      • 状態
      • 対象
      • 開始時間
      • 終了時間
      • 実行方法
      • スクリプト
      • 結果
• クロール情報
  • 概要
  • 管理方法
  • 一覧
  • 詳細
    • 項目一覧
      • セッションID
      • クローラーの開始時間
      • クロールの開始時間 (ウェブ/ファイル)
      • クロールの開始時間 (データストア)
      • クロールの終了時間 (ウェブ/ファイル)
      • クロールの実行時間 (データストア)
      • インデクシングの実行時間 (データストア)
      • インデックスのサイズ (データストア)
      • クロールの終了時間 (データストア)
      • クローラーの状態
      • クローラーの終了時間
      • クローラーの実行時間
• ログファイル
  • 概要
  • 設定方法
    • 表示方法
    • ダウンロード
      • server_*.log
      • fess.log
      • fess-crawler.log
      • audit.log
      • fess-thumbnail.log
      • fess-suggest.log
      • fess-urls.log
      • search.log
      • gc-crawler.log
• 障害URL
  • 概要
  • 管理方法
    • 表示方法
  • 障害URLの詳細
    • 詳細の内容
      • URL
      • スレッド名
      • 種別
      • ログ
      • エラー回数
      • 最終アクセス日時
• 検索
  • 概要
  • 管理方法
    • 表示方法
    • 検索一覧
    • 一括削除
• バックアップ
  • 概要
    • ダウンロード
      • fess_config.bulk
      • fess_basic_config.bulk
      • fess_user.bulk
      • system.properties
      • fess.json
      • doc.json
      • click_log.ndjson
      • favorite_log.ndjson
      • search_log.ndjson
      • user_info.ndjson
    • アップロード
• メンテナンス
  • 概要
  • 操作方法
    • 再インデクシング
    • 設定項目
      • エイリアスの更新
      • 辞書の初期化
      • シャード数
      • 最大レプリカ数
    • 設定インデックスの再構築
      • 対象インデックス
      • デフォルトデータの読み込み
    • ドキュメントインデックスのリロード
    • Crawlerインデックス
    • 診断
• クエリーリクエスト
  • 概要
  • 操作方法
    • リクエストの送信
    • 設定項目
      • リクエストファイル

Fess 設定ガイド

• はじめに
  • 対象読者
  • お読みになる前に
  • 前提条件
  • オンラインでのアクセス
  • 技術的なサポートの連絡先
    • 商用サポート
  • 関連サードパーティー Web サイトの参照
  • コメントおよび提案の送付方法
• ポートとネットワーク設定
  • 概要
  • 使用ポートの設定
    • デフォルトポート
    • Fess ウェブアプリケーションのポート変更
      • Linux環境での設定
      • 環境変数による設定
      • RPM/DEBパッケージの場合
      • Windows環境での設定
      • Windowsサービスとして登録する場合
    • コンテキストパスの設定
  • プロキシ設定
    • 概要
    • クローラー用プロキシの設定
      • 基本設定
      • 認証が必要なプロキシの設定
      • 特定のホストをプロキシから除外
    • クローラーのデフォルトプロキシ設定
      • 環境変数によるプロキシ設定
  • HTTP通信設定
    • ファイルアップロードの制限
    • 接続タイムアウト設定
    • OpenSearchの接続先変更
      • 複数ノードへの接続
    • SSL/TLS接続の設定
  • 仮想ホスト設定
    • 概要
    • 基本設定
  • リバースプロキシとの連携
    • Nginx の設定例
    • Apache の設定例
    • SSL/TLS終端
  • ファイアウォール設定
    • 必要なポートの開放
    • セキュリティグループの設定(クラウド環境)
  • トラブルシューティング
    • ポート変更後にアクセスできない
    • プロキシ経由でクロールできない
    • OpenSearchに接続できない
    • リバースプロキシ経由でアクセスすると正常に動作しない
  • 参考情報
• メモリ設定
  • 概要
  • Fess ウェブアプリケーションのメモリ設定
    • 設定が必要な場合
    • 環境変数による設定
      • 詳細なメモリ制御
    • RPM/DEBパッケージの場合
    • 推奨メモリサイズ
  • クローラーのメモリ設定
    • 設定が必要な場合
    • 設定方法
    • 推奨設定
    • 詳細なJVMオプション
  • OpenSearch のメモリ設定
    • 重要な考慮事項
    • 設定方法
      • Linux環境
      • Windows環境
    • 推奨メモリサイズ
    • ベストプラクティス
  • サジェスト・サムネイル処理のメモリ設定
    • サジェスト生成プロセス
    • サムネイル生成プロセス
  • メモリ監視とチューニング
    • メモリ使用状況の確認
      • Fess のメモリ使用状況
      • OpenSearchのメモリ使用状況
    • メモリ不足の兆候
    • チューニング手順
    • メモリリーク対策
  • トラブルシューティング
    • OutOfMemoryError が発生する
    • GCによる停止時間が長い
    • メモリ設定後も性能が改善しない
  • 参考情報
• Windowsサービスへの登録
  • Windowsサービスとしての登録
    • 事前準備
    • OpenSearchをサービスとして登録
    • 設定
    • 登録方法
    • サービスの設定
• クローラー基本設定
  • 概要
  • クローラーの基本概念
    • クローラーとは
    • クローラーの種類
  • クロール設定の作成
    • 基本的なクロール設定の追加
    • Webクローラーの設定例
      • 社内イントラネットサイトのクロール
      • 公開Webサイトのクロール
    • ファイルクローラーの設定例
      • ローカルファイルシステム
      • SMB/CIFS(Windowsファイル共有)
    • 認証情報の設定
  • クロールの実行
    • 手動実行
    • スケジュール実行
    • クロール状況の確認
  • 基本的な設定項目
    • クロール対象の制限
      • URLパターンによる制限
      • 深さの制限
      • 最大アクセス数
    • 並列クロール数(スレッド数)
    • クロール間隔
  • ファイルサイズの設定
    • 取得するファイルサイズの上限
    • インデックスするファイルサイズの上限
  • 単語の長さ制限
    • 概要
    • 設定方法
  • プロキシの設定
    • 概要
    • 設定方法
    • システム全体のプロキシ設定
  • robots.txt の設定
    • 概要
    • 設定方法
  • User-Agent の設定
    • 管理画面での設定
  • エンコーディング設定
    • クロールデータのエンコーディング
    • ファイル名のエンコーディング
  • クロールのトラブルシューティング
    • クロールが開始されない
    • クロールが途中で停止する
    • 特定のページがクロールされない
    • クロールが遅い
  • ベストプラクティス
    • クロール設定の推奨事項
    • スケジュール設定の推奨事項
  • 参考情報
• クローラー詳細設定
  • 概要
  • 全般設定
    • 設定ファイルの場所
    • デフォルトスクリプト
    • HTTPスレッドプール
  • ドキュメント処理設定
    • 基本設定
      • 設定例
    • 単語処理設定
      • 設定例
    • 文字処理設定
      • 設定例
  • プロトコル設定
    • 対応プロトコル
      • 設定例
    • 環境変数パラメーター
    • データシリアライザー
  • robots.txt 設定
  • エラー処理設定
  • システム監視設定
    • ホットスレッド設定
      • 設定例
  • メタデータ設定
  • HTML クローラー設定
    • XPath 設定
      • 設定例
      • カスタム XPath の例
    • HTML タグ処理
      • 設定例
    • URLパターンフィルター
      • 設定例
  • ファイルクローラー設定
    • 基本設定
      • 設定例
    • コンテンツ処理
      • 設定例
    • ファイルURLパターンフィルター
      • 設定例
    • MIMEタイプ検出オーバーライド
      • 設定例
  • キャッシュ設定
    • ドキュメントキャッシュ
      • 設定例
  • JVM オプション
    • デフォルト設定
    • 主要なオプションの説明
    • カスタム設定例
  • パフォーマンスチューニング
    • クロール速度の最適化
    • メモリ使用量の最適化
    • インデックス品質の向上
  • トラブルシューティング
    • メモリ不足
    • クロールが遅い
    • 特定のコンテンツが抽出できない
    • 文字化けが発生する
  • ベストプラクティス
  • S3/GCSクローラー設定
    • S3クローラー
      • 設定例
    • GCSクローラー
      • 設定例
  • 参考情報
• サムネイル画像の設定
  • 概要
  • サポートしているファイル形式
    • 画像ファイル
    • ドキュメントファイル
    • HTMLコンテンツ
  • 必要な外部ツール
    • 基本ツール（必須）
    • SVGサポート
    • PDFサポート
    • MS Officeサポート
    • PostScriptサポート
  • HTMLファイルのサムネイル画像
  • 設定
    • 設定ファイル
    • 主な設定項目（fess_config.properties）
  • generate-thumbnail スクリプト
    • 概要
    • 使用方法
    • 引数
    • サポートするタイプ
    • 使用例
  • サムネイル保存先
    • デフォルトパス
    • ディレクトリ構造
  • サムネイルジョブの無効化
  • トラブルシューティング
    • サムネイルが生成されない
    • GIF/TIFFでエラーが発生する
    • SVGのサムネイルが生成されない
    • 権限エラー
  • プラットフォーム対応
• データストアコネクタガイド
  • データストアコネクタの概要
    • 概要
    • 利用可能なコネクタ
      • クラウドストレージ
      • コラボレーションツール
      • 開発・運用ツール
      • データベース・ファイル
      • その他
    • コネクタのインストール
      • プラグインのインストール
        • 管理画面から
    • データストア設定の基本
      • 共通設定項目
      • パラメーター設定
      • スクリプト設定
    • 認証設定
    • 共通パラメーター
    • トラブルシューティング
      • コネクタが表示されない
      • 認証エラー
      • データが取得できない
      • デバッグ設定
    • 参考情報
  • Boxコネクタ
    • 概要
    • 前提条件
      • プラグインのインストール
    • 設定方法
      • 基本設定
      • パラメーター設定
        • パラメーター一覧
          • 認証パラメーター（必須）
          • クロールパラメーター（任意）
          • 接続パラメーター（任意）
      • スクリプト設定
        • 利用可能なフィールド
          • 主要フィールド
          • メタデータフィールド
    • Box認証の設定
      • JWT認証の設定手順
        • 1. Box Developer Consoleでアプリケーションを作成
        • 2. アプリケーションの設定
        • 3. エンタープライズで承認
        • 4. 認証情報の取得
        • 秘密鍵の形式
    • 使用例
      • 企業のBoxストレージ全体をクロール
      • 特定のフォルダのみをクロール
      • PDFファイルのみをクロール
    • トラブルシューティング
      • 認証エラー
      • 秘密鍵のフォーマットエラー
      • ファイルが取得できない
      • 大量のファイルがある場合
    • 権限とアクセス制御
      • Boxのファイル権限を反映
    • 参考情報
  • Dropboxコネクタ
    • 概要
    • 対応サービス
    • 前提条件
      • プラグインのインストール
    • 設定方法
      • 基本設定
      • パラメーター設定
        • パラメーター一覧
      • スクリプト設定
        • Dropboxファイルの場合
        • Dropbox Paperの場合
    • Dropbox認証の設定
      • アクセストークンの取得手順
        • 1. Dropbox App Consoleでアプリを作成
        • 2. 権限の設定
        • 3. アクセストークンの生成
        • 4. トークンの設定
    • 個人アカウントの設定
      • 個人アカウントでの利用
    • 使用例
      • Dropboxファイル全体のクロール
      • Dropbox Paperドキュメントのクロール
      • 権限付きクロール
      • 特定のファイルタイプのみクロール
    • トラブルシューティング
      • 認証エラー
      • ファイルが取得できない
      • APIレート制限エラー
      • Paperドキュメントが取得できない
      • 大量のファイルがある場合
    • 権限とアクセス制御
      • Dropboxの共有権限を反映
    • 参考情報
  • Google Workspaceコネクタ
    • 概要
    • 対応サービス
    • 前提条件
      • プラグインのインストール
    • 設定方法
      • 基本設定
      • パラメーター設定
        • パラメーター一覧
      • スクリプト設定
        • 利用可能なフィールド
    • Google Cloud Platform設定
      • 1. プロジェクトの作成
      • 2. Google Drive APIの有効化
      • 3. サービスアカウントの作成
      • 4. サービスアカウントキーの作成
      • 5. Domain全体への委任を有効化
      • 6. Google Workspace管理コンソールで承認
    • 認証情報の設定
      • JSONファイルから情報を取得
        • 秘密鍵の形式
    • 使用例
      • Google Drive全体のクロール
      • 権限付きクロール
      • 特定のファイルタイプのみクロール
    • トラブルシューティング
      • 認証エラー
      • Domain全体への委任エラー
      • ファイルが取得できない
      • APIクォータエラー
      • 秘密鍵のフォーマットエラー
      • 共有ドライブのクロール
      • 大量のファイルがある場合
    • 権限とアクセス制御
      • Google Driveの共有権限を反映
    • 参考情報
  • Microsoft 365コネクタ
    • 概要
    • 対応サービス
    • 前提条件
      • プラグインのインストール
    • 設定方法
      • 基本設定
      • パラメーター設定（共通）
        • 共通パラメーター一覧
    • Azure ADアプリケーション登録
      • 1. Azure Portalでアプリケーションを登録
      • 2. クライアントシークレットの作成
      • 3. API権限の追加
    • データストア別の必要な権限
      • OneDriveDataStore
      • OneNoteDataStore
      • TeamsDataStore
      • SharePointDocLibDataStore
      • SharePointListDataStore / SharePointPageDataStore
    • スクリプト設定
      • OneDrive
      • OneNote
      • Teams
      • SharePoint Document Libraries
      • SharePoint Lists
      • SharePoint Pages
    • データストア別の追加パラメーター
      • OneDrive
      • OneNote
      • Teams
      • SharePoint Document Libraries
      • SharePoint Lists
      • SharePoint Pages
    • 使用例
      • OneDrive全ドライブのクロール
      • 特定チームのTeamsメッセージをクロール
      • SharePointリストのクロール
    • トラブルシューティング
      • 認証エラー
      • APIレート制限エラー
      • データが取得できない
      • SharePointサイトIDの確認方法
      • 大量データのクロール
    • 参考情報
  • Atlassianコネクタ
    • 概要
    • 対応製品
    • 前提条件
      • プラグインのインストール
    • 設定方法
      • 基本設定
      • パラメーター設定
        • パラメーター一覧
      • スクリプト設定
        • Jiraの場合
        • Confluenceの場合
    • OAuth 2.0認証の設定
      • Cloud版の場合（推奨）
    • OAuth 1.0a認証の設定
      • Server版の場合
    • Basic認証の設定
      • Server版のシンプルな設定
    • JQLによる高度な検索
      • Jiraの課題をJQLで絞り込む
    • 使用例
      • Jira Cloudのクロール
      • Confluence Serverのクロール
    • トラブルシューティング
      • 認証エラー
      • 接続エラー
      • データが取得できない
      • OAuth 2.0トークンの更新
    • 参考情報
  • Slackコネクタ
    • 概要
    • 対応コンテンツ
    • 前提条件
      • プラグインのインストール
    • 設定方法
      • 基本設定
      • パラメーター設定
        • パラメーター一覧
      • スクリプト設定
        • 利用可能なフィールド
    • Slack App設定
      • 1. Slack Appの作成
      • 2. OAuth & Permissionsの設定
      • 3. アプリのインストール
      • 4. チャンネルへの追加
    • 使用例
      • 特定のチャンネルをクロール
      • すべてのチャンネルをクロール
      • プライベートチャンネルを含めてクロール
      • ファイルも含めてクロール
      • 詳細なメッセージ情報を含める
    • トラブルシューティング
      • 認証エラー
      • チャンネルが見つからない
      • メッセージが取得できない
      • 権限不足エラー
      • ファイルがクロールできない
      • APIレート制限
      • 大量のメッセージがある場合
    • スクリプトの応用例
      • メッセージの加工
    • 参考情報
  • Gitコネクタ
    • 概要
    • 対応リポジトリ
    • 前提条件
      • プラグインのインストール
    • 設定方法
      • 基本設定
      • パラメーター設定
        • パラメーター一覧
      • スクリプト設定
        • 利用可能なフィールド
    • Gitリポジトリの認証
      • GitHub Personal Access Token
        • 1. GitHubでPersonal Access Tokenを生成
        • 2. URIに認証情報を含める
      • GitLab Private Token
        • 1. GitLabでAccess Tokenを生成
        • 2. URIに認証情報を含める
      • SSH認証
    • 抽出器の設定
      • MIMEタイプ別の抽出器
        • デフォルトの抽出器
        • テキストファイルのみクロール
        • すべてのファイルをクロール
        • 特定のファイルタイプのみ
    • 差分クロール
      • 前回のコミットからの変更のみクロール
      • 削除されたファイルの処理
    • 使用例
      • GitHubパブリックリポジトリ
      • GitHubプライベートリポジトリ
      • GitLab（セルフホスト）
      • ドキュメントのみクロール（Markdownファイル）
      • 特定のディレクトリのみクロール
    • トラブルシューティング
      • 認証エラー
      • リポジトリが見つからない
      • ファイルが取得できない
      • MIMEタイプエラー
      • 大きなリポジトリ
      • ブランチの指定
    • URLの生成
      • base_urlの設定パターン
      • スクリプトでのURL生成
    • 参考情報
  • Elasticsearch/OpenSearchコネクタ
    • 概要
    • 対応バージョン
    • 前提条件
      • プラグインのインストール
    • 設定方法
      • 基本設定
      • パラメーター設定
        • パラメーター一覧
      • スクリプト設定
        • 利用可能なフィールド
    • クエリの設定
      • 全ドキュメントの取得
      • 特定の条件でフィルタリング
    • 特定のフィールドのみ取得
      • fieldsパラメーターで取得フィールドを限定
    • 使用例
      • 基本的なインデックスのクロール
      • 認証付きクラスタからのクロール
      • 複数インデックスからのクロール
      • OpenSearchクラスタのクロール
      • フィールドを限定してクロール
      • 複数ホストでの負荷分散
    • トラブルシューティング
      • 接続エラー
      • 認証エラー
      • インデックスが見つからない
      • クエリエラー
      • スクロールタイムアウト
      • 大量データのクロール
      • メモリ不足
    • SSL/TLS接続
      • 自己署名証明書の場合
      • クライアント証明書認証
    • 高度なクエリ例
      • 集約を含むクエリ
      • スクリプトフィールド
    • 参考情報
  • Salesforceコネクタ
    • 概要
    • 対応オブジェクト
    • 前提条件
      • プラグインのインストール
    • 設定方法
      • 基本設定
      • パラメーター設定
        • パラメーター一覧
      • スクリプト設定
        • 利用可能なフィールド
    • Salesforce接続アプリケーションの設定
      • 1. 接続アプリケーションの作成
      • 2. OAuth Token認証の設定（推奨）
      • 3. OAuth Password認証の設定
      • 4. 接続アプリケーションの承認
    • カスタムオブジェクトの設定
      • カスタムオブジェクトのクロール
        • フィールドマッピングのルール
    • 使用例
      • 標準オブジェクトのクロール
      • カスタムオブジェクトのクロール
      • Sandbox環境のクロール
    • トラブルシューティング
      • 認証エラー
      • オブジェクトが取得できない
      • カスタムオブジェクトの名前
      • フィールド名の確認
      • APIレート制限
      • 大量のデータがある場合
      • 秘密鍵のフォーマットエラー
    • 参考情報
  • データベースコネクタ
    • 概要
    • 対応データベース
    • 前提条件
      • JDBCドライバーのインストール
    • 設定方法
      • 基本設定
      • パラメーター設定
        • パラメーター一覧
      • スクリプト設定
    • SQLクエリの設計
      • 効率的なクエリ
      • 差分クロール
      • URLの生成
    • マルチバイト文字対応
      • MySQL
      • PostgreSQL
    • セキュリティ
      • データベース認証情報の保護
      • 最小権限の原則
    • 使用例
      • 製品カタログの検索
      • ナレッジベース記事
    • トラブルシューティング
      • JDBCドライバーが見つからない
      • 接続エラー
      • クエリエラー
    • 参考情報
  • CSVコネクタ
    • 概要
    • 前提条件
      • プラグインのインストール
    • 設定方法
      • 基本設定
      • パラメーター設定
        • パラメーター一覧
        • 高度なパラメーター
      • スクリプト設定
        • 利用可能なフィールド
    • CSV形式の詳細
      • 標準CSV（RFC 4180準拠）
      • セパレーターの変更
      • カスタム引用符
      • エンコーディング
    • 使用例
      • 製品カタログのCSV
      • 社員名簿のCSV
      • ヘッダーなしのCSV
      • 複数CSVファイルの統合
      • タブ区切り（TSV）ファイル
    • トラブルシューティング
      • ファイルが見つからない
      • 文字化けが発生する
      • 列が正しく認識されない
      • ヘッダー行の扱い
      • データが取得できない
      • 大きなCSVファイル
      • 改行を含むフィールド
    • CsvListDataStore
      • 基本設定
      • 追加パラメーター
    • スクリプトの高度な使用例
      • データの加工
      • 条件付きインデックス
      • 複数列の結合
      • 日付のフォーマット
    • 参考情報
  • JSONコネクタ
    • 概要
    • 前提条件
      • プラグインのインストール
    • 設定方法
      • 基本設定
      • パラメーター設定
        • パラメーター一覧
      • スクリプト設定
        • 利用可能なフィールド
    • JSON形式の詳細
      • JSONファイル形式
    • 使用例
      • 製品カタログ
      • 複数JSONファイルの統合
    • トラブルシューティング
      • ファイルが見つからない
      • JSON解析エラー
      • データが取得できない
      • 大きなJSONファイル
    • スクリプトの高度な使用例
      • 条件付き処理
      • 配列の結合
      • デフォルト値の設定
      • 日付のフォーマット
      • 数値の処理
    • 参考情報
• 検索機能
  • 概要
  • 検索結果件数の表示
    • デフォルトの動作
    • 正確なヒット件数の表示
  • 検索オプション
    • 基本的な検索
    • OR検索
    • NOT検索
    • フレーズ検索
    • フィールド指定検索
    • ワイルドカード検索
    • ファジー検索
  • 検索結果のソート
  • ファセット検索
  • 検索結果のハイライト
  • サジェスト機能
  • 検索ログ
  • パフォーマンスチューニング
    • 検索タイムアウトの設定
    • 検索クエリの最大文字数
    • キャッシュの利用
  • トラブルシューティング
    • 検索結果が表示されない
    • 検索速度が遅い
    • 関連性の低い結果が表示される
• 検索関連の設定
  • ファジー検索
  • 検索時のタイムアウト値
  • 検索時の最大文字数
  • 検索時のタイムアウトのログ出力
  • ヒット件数表示
  • 位置情報検索時のインデックス名
  • リクエストパラメータの言語指定
  • 前方一致検索の指定
  • ハイライトの文字列
  • ハイライトのフラグメント
  • ハイライト生成方法
  • ハイライト対象のタグ
  • OpenSearchのハイライターに渡す値
  • ハイライトの高度な設定
  • レスポンスに追加するフィールド名
  • フィールド名の追加
  • 検索結果をGSA互換のXML形式で取得する際の設定
• 位置情報検索
  • 概要
  • ユースケース
  • 設定方法
    • インデックス生成時の設定
      • 位置情報フィールドの定義
      • 位置情報の登録形式
      • データストアクロールでの設定例
      • スクリプトでの位置情報追加
    • 検索時の設定
      • リクエストパラメータ
      • 距離の単位
  • 検索例
    • 基本的な検索
    • 現在地周辺の検索
    • APIでの使用
  • フィールド名のカスタマイズ
    • デフォルトのフィールド名変更
  • 実装例
    • Webアプリケーションでの実装
    • Googleマップとの連携
  • パフォーマンス最適化
    • インデックス設定の最適化
    • 検索範囲の制限
  • トラブルシューティング
    • 位置情報検索が動作しない
    • 検索結果が返ってこない
    • 位置情報が正しく表示されない
  • 参考情報
• 検索結果の一括取得
  • 概要
  • ユースケース
  • 設定方法
    • スクロール検索の有効化
    • スクロールタイムアウトの設定
    • レスポンスフィールドの設定
  • 使用方法
    • 基本的な使用方法
    • リクエストパラメータ
    • 検索クエリの指定
    • 取得件数の指定
    • ラベルによるフィルタリング
    • 認証について
  • レスポンス形式
    • NDJSON形式
    • レスポンスフィールド
  • データ処理例
    • Pythonでの処理例
    • ファイルへの保存
    • CSVへの変換
    • データ分析
  • パフォーマンスとベストプラクティス
    • 効率的な使用方法
    • メモリ使用量の最適化
  • セキュリティ考慮事項
    • アクセス制限
    • レート制限
  • トラブルシューティング
    • スクロール検索が利用できない
    • タイムアウトエラーが発生する
    • メモリ不足エラー
    • レスポンスが空になる
  • 参考情報
• 検索フォームの配置
  • 検索フォームの配置方法
    • 検索フォーム
    • サジェスト
• Rank Fusion設定
  • 概要
  • Rank Fusionとは
  • 対応アルゴリズム
    • RRF (Reciprocal Rank Fusion)
  • 設定
    • fess_config.properties
    • JVMシステムプロパティ
  • ハイブリッド検索との連携
  • 使用例
    • 基本的なハイブリッド検索
  • パフォーマンス考慮事項
    • メモリ使用量
    • 処理時間
  • トラブルシューティング
    • 検索結果が期待と異なる
    • 検索が遅い
    • メモリ不足
  • 参考情報
• ロールベース検索の設定
  • ロールベース検索について
  • ロールベース検索の設定
    • Fess の管理画面での設定
    • ログイン
    • ログアウト
• 仮想ホスト
  • 仮想ホストについて
    • システム設定
    • クロール設定
• LDAP統合ガイド
  • 概要
  • 対応LDAPサーバー
  • 前提条件
  • 基本設定
    • LDAP接続設定
    • アカウントフィルター設定
    • LDAP管理用ベースDN設定
    • グループフィルター設定
  • Active Directory設定
    • 基本設定
    • Active Directory固有の設定
  • OpenLDAP設定
  • セキュリティ設定
    • LDAPS（SSL/TLS）
    • パスワードの保護
  • フェイルオーバー
  • トラブルシューティング
    • 接続エラー
    • 認証エラー
    • グループが取得できない
    • デバッグ設定
  • 参考情報
• マルチテナンシー設定
  • 概要
  • 仮想ホスト機能
    • 仕組み
  • 仮想ホストヘッダーの設定
    • 設定形式
    • 仮想ホストキーの制約
  • 管理画面での設定
    • クロール設定
  • アクセス制御
    • 仮想ホストとロールの組み合わせ
    • ロールベース検索
  • UIカスタマイズ
    • テーマの適用
    • カスタムCSS
    • ラベル設定
  • API認証
    • アクセストークン
    • APIリクエスト
  • DNS設定
    • 同一サーバーへのサブドメイン
    • リバースプロキシ設定
  • データ分離
    • インデックスレベルの分離
  • ベストプラクティス
  • 制限事項
  • 参考情報
• SAML認証によるSSO設定
  • 概要
    • SAML認証の仕組み
  • 前提条件
  • 基本設定
    • SSO機能の有効化
    • SP（Service Provider）設定
      • 個別URL設定
    • IdP（Identity Provider）設定
    • SPメタデータの取得
  • IdP側での設定
    • IdPから取得する情報
  • ユーザー属性マッピング
    • グループ属性の設定
    • ロール属性の設定
  • セキュリティ設定
    • 署名の設定
    • 暗号化の設定
    • その他のセキュリティ設定
  • 設定例
    • 最小構成（検証環境向け）
    • 推奨構成（本番環境向け）
  • トラブルシューティング
    • よくある問題と解決方法
      • 認証後に Fess に戻れない
      • 署名検証エラー
      • ユーザーのグループ・ロールが反映されない
    • デバッグ設定
  • 参考情報
• OpenID ConnectによるSSO設定
  • 概要
    • OpenID Connect認証の仕組み
  • 前提条件
  • 基本設定
    • SSO機能の有効化
    • プロバイダー設定
    • クライアント設定
    • リダイレクトURL設定
    • ユーザー属性設定
  • OP側での設定
    • OPから取得する情報
  • 設定例
    • 最小構成（検証環境向け）
    • 推奨構成（本番環境向け）
  • トラブルシューティング
    • よくある問題と解決方法
      • 認証後に Fess に戻れない
      • 認証エラーが発生する
      • ユーザー情報が取得できない
    • デバッグ設定
  • 参考情報
• Microsoft Entra IDによるSSO設定
  • 概要
    • Entra ID認証の仕組み
  • 前提条件
  • 基本設定
    • SSO機能の有効化
    • 必須設定
    • オプション設定
  • Entra ID側での設定
    • Azure Portalでのアプリ登録
    • クライアントシークレットの作成
    • APIアクセス許可の設定
    • 取得する情報
  • グループ・ロールマッピング
    • ネストされたグループ
    • デフォルトグループの設定
  • 設定例
    • 最小構成（検証環境向け）
    • 推奨構成（本番環境向け）
    • レガシー設定（後方互換性）
  • トラブルシューティング
    • よくある問題と解決方法
      • 認証後にFessに戻れない
      • 認証エラーが発生する
      • グループ情報が取得できない
    • デバッグ設定
  • 参考情報
• Windows統合認証によるSSO設定
  • 概要
    • Windows統合認証の仕組み
  • 前提条件
  • Active Directory側の設定
    • サービスプリンシパル名（SPN）の登録
  • 基本設定
    • SSOの有効化
    • Kerberos設定ファイル
    • ログイン設定ファイル
    • 必須設定
    • オプション設定
  • LDAP設定
  • ブラウザ設定
    • Internet Explorer / Microsoft Edge
    • Google Chrome
    • Mozilla Firefox
  • 設定例
    • 最小構成（検証用）
    • 推奨構成（本番用）
  • トラブルシューティング
    • よくある問題と解決方法
      • 認証ダイアログが表示される
      • 認証エラーが発生する
      • グループ情報が取得できない
    • デバッグ設定
  • 参考情報
• LLM統合の概要
  • 概要
  • 対応プロバイダー
  • プラグイン導入
  • アーキテクチャ
  • 基本設定
    • 管理画面の全般設定 / system.properties
    • fess_config.properties
  • 共通設定
    • コンテキスト設定
    • システムプロンプト
    • 可用性チェック
  • セッション管理
  • 同時実行制御
  • 評価設定
  • プロンプトタイプ別設定
    • プロンプトタイプ一覧
    • 設定パターン
  • 次のステップ
• Ollamaの設定
  • 概要
    • 主な特徴
    • 対応モデル
  • 前提条件
    • Ollamaのインストール
      • Linux/macOS
      • Windows
      • Docker
    • モデルのダウンロード
  • プラグインのインストール
  • 基本設定
    • 最小構成
    • 推奨構成（本番環境）
  • 設定項目
    • 詳細設定
    • 同時実行制御
  • プロンプトタイプ別設定
  • 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インターフェース
    • チャットの開始
    • チャットの使用
    • 会話の継続
  • トラブルシューティング
    • AI検索モードボタンが検索画面に表示されない
    • AI検索モードが有効にならない
    • 回答の品質が低い
    • レスポンスが遅い
    • セッションが維持されない
    • デバッグ設定
    • 検索ログとアクセスタイプ
  • 参考情報
• スクリプティング概要
  • 概要
  • 対応スクリプト言語
  • スクリプトの使用場面
    • データストア設定
    • パスマッピング
    • スケジュールジョブ
  • 基本的な構文
    • 変数アクセス
    • 文字列操作
    • 条件分岐
    • 日付操作
  • 利用可能なオブジェクト
  • セキュリティ
  • パフォーマンス
  • デバッグ
  • 参考情報
• Groovyスクリプトガイド
  • 概要
  • 基本構文
    • 変数宣言
    • 文字列操作
    • コレクション操作
    • 条件分岐
    • ループ処理
  • データストアスクリプト
    • 基本的なマッピング
    • URLの生成
    • コンテンツの加工
    • 日付の処理
  • 利用可能なオブジェクト
  • スケジュールジョブスクリプト
    • クロールジョブの実行
    • 条件付きクロール
    • 複数のジョブを順番に実行
  • Javaクラスの使用
    • 日付・時刻
    • ファイル操作
    • HTTP通信
  • Fessコンポーネントへのアクセス
    • システムヘルパー
    • 設定値の取得
    • 検索の実行
  • エラーハンドリング
  • デバッグとログ出力
    • ログ出力
    • デバッグ用の出力
  • ベストプラクティス
  • 参考情報
• レート制限の設定
  • 概要
  • HTTPリクエストのレート制限
    • 設定
    • 動作
  • AI検索モードのレート制限
  • クローラーのレート制限
    • Webクロール設定
    • robots.txtの尊重
  • レート制限の全設定項目
  • 高度なレート制限設定
    • カスタムレート制限
  • 除外設定
  • 監視とアラート
    • ログ出力
  • トラブルシューティング
    • 正当なリクエストがブロックされる
    • レート制限が効かない
    • パフォーマンスへの影響
  • 参考情報
• 負荷制御の設定
  • 概要
  • HTTPリクエスト負荷制御の設定
  • 動作の仕組み
    • 監視の仕組み
    • リクエスト制御
  • 設定例
    • Web リクエストのみ制限する
    • Web と API の両方を制限する
  • レート制限との違い
  • 適応型負荷制御
    • 設定
    • 動作
  • トラブルシューティング
    • 負荷制御が有効にならない
    • 正常なリクエストが拒否される
    • クローリングが遅い
  • 参考情報
• ログ設定
  • 概要
  • ログファイルの種類
    • 主要なログファイル
    • ログファイルの場所
    • トラブルシューティング時のログ確認
  • ログレベルの設定
    • ログレベルとは
    • 推奨ログレベル
    • 管理画面からの変更
    • 設定ファイルによる変更
      • 設定ファイルの場所
      • 基本的な設定例
      • 環境変数による設定
  • クローラーログの設定
    • スケジューラーでの設定
  • ログローテーション
    • 概要
    • Log4j2による自動ローテーション
      • デフォルトの設定
      • 日次ローテーションの設定
      • 圧縮設定
    • logrotateによるローテーション
  • ログ監視
    • 監視すべきログパターン
      • 重要なエラーパターン
      • 警告すべきパターン
    • リアルタイム監視
    • 監視ツールの例
    • アラート設定
  • ログフォーマット
    • デフォルトフォーマット
    • カスタムフォーマット例
      • JSON形式でログ出力
      • より詳細な情報を含める
  • パフォーマンスへの影響
    • ベストプラクティス
    • パフォーマンス測定
  • トラブルシューティング
    • ログが出力されない
    • ログファイルが大きくなりすぎる
    • 特定のログが見つからない
    • ログに文字化けが発生する
  • 参考情報
• ログ通知
  • 概要
  • 仕組み
  • セットアップ
    • 有効化
      • 管理画面からの有効化
      • システムプロパティによる有効化
    • 通知先の設定
      • メール通知
      • Slack 通知
      • Google Chat 通知
  • 設定プロパティ
  • 通知メッセージの形式
    • メール通知
    • Slack / Google Chat 通知
  • 運用ガイド
    • 推奨設定
    • OpenSearch インデックス
  • トラブルシューティング
    • 通知が送信されない
    • 通知が多すぎる
    • 通知内容が切り詰められる
  • 参考情報
• インデックスの管理
  • 概要
  • インデックスの構成
  • インデックスのバックアップとリストア
    • スナップショットリポジトリの設定
    • スナップショットの作成(バックアップ)
      • 全インデックスのバックアップ
      • 特定のインデックスのバックアップ
      • 定期的な自動バックアップ
    • スナップショットの確認
    • スナップショットからのリストア
      • 全インデックスのリストア
      • 特定のインデックスのリストア
      • インデックス名を変更してリストア
    • スナップショットの削除
  • 設定ファイルのバックアップ
    • バックアップ対象のファイル
    • 設定ファイルのバックアップ例
  • データ移行
    • 別環境への移行手順
    • バージョンアップ時の注意事項
  • トラブルシューティング
    • スナップショットの作成に失敗する
    • リストアに失敗する
    • リストア後に検索できない
  • 参考情報
• インデックスエクスポート機能
  • 概要
  • 動作の仕組み
  • 設定プロパティ
  • ジョブの有効化
  • カスタムクエリフィルタリング
  • エクスポートされたファイル構造
  • ベストプラクティス
    • ストレージの考慮事項
    • パフォーマンスのヒント
    • セキュリティの推奨事項
  • トラブルシューティング
    • エクスポートジョブが実行されない
    • エクスポートディレクトリが空
    • エクスポートが途中で失敗する
    • ファイルにアクセスできない
  • 関連トピック
• Analyzerの設定
  • Analyzerについて
• 検索ログ可視化の設定
  • 検索ログの可視化について
    • 可視化できる情報
  • OpenSearch Dashboards によるデータ可視化の設定
    • OpenSearch Dashboards のインストール
    • 設定ファイルの編集
    • OpenSearch Dashboards の起動
    • インデックスパターンの設定
    • 可視化とダッシュボードの作成
      • 基本的な可視化の作成
      • ダッシュボードの作成
    • タイムゾーンの設定
    • ログデータの確認
    • 主な検索ログフィールド
    • トラブルシューティング
      • データが表示されない場合
      • 接続エラーが発生する場合

JavaDocs

XRef

I/F Doc

15.5

Fess インストールガイド

• はじめに
  • 本ドキュメントについて
  • 対象読者
  • お読みになる前に
  • ドキュメント構成
  • オンラインでのアクセス
  • 技術的なサポートの連絡先
    • 商用サポート
  • コメントおよび提案の送付方法
• システム要件
  • ハードウェア要件
    • 最小要件
    • 推奨要件
  • ソフトウェア要件
    • オペレーティングシステム
    • 必須ソフトウェア
      • TAR.GZ/ZIP/RPM/DEB 版
      • Docker 版
  • ネットワーク要件
    • 必要なポート
    • ファイアウォール設定
  • ブラウザー要件
  • 前提条件チェックリスト
  • 次のステップ
• インストール方法の選択
  • 前提条件の確認
  • インストール方法の比較
  • 各インストール方法の特徴
    • Docker 版
    • Linux パッケージ版 (TAR.GZ/RPM/DEB)
    • Windows 版 (ZIP)
  • インストールの基本的な流れ
  • 必要なコンポーネント
    • Fess 本体
    • OpenSearch
    • Java (Docker 版以外)
  • 次のステップ
  • よくある質問
    • Q: OpenSearch は必須ですか？
    • Q: 以前のバージョンからアップグレードできますか？
    • Q: 複数のサーバーで構成できますか？
  • ダウンロード
  • バージョン情報
• Linux へのインストール (詳細手順)
  • 前提条件
  • インストール方法の選択
  • TAR.GZ 版でのインストール
    • ステップ 1: OpenSearch のインストール
    • ステップ 2: Fess のインストール
    • ステップ 3: 起動
  • RPM 版でのインストール
    • ステップ 1: OpenSearch のインストール
    • ステップ 2: Fess のインストール
    • ステップ 3: 起動
  • DEB 版でのインストール
    • ステップ 1: OpenSearch のインストール
    • ステップ 2: Fess のインストール
    • ステップ 3: 起動
  • インストール後の確認
  • 次のステップ
  • よくある質問
    • Q: OpenSearch のバージョンは他のバージョンでも動作しますか？
    • Q: 複数の Fess インスタンスで同じ OpenSearch を共有できますか？
    • Q: OpenSearch をクラスター構成にする方法は？
• Windows へのインストール (詳細手順)
  • 前提条件
  • Java のインストール確認
  • 環境変数の設定
  • ステップ 1: OpenSearch のインストール
    • OpenSearch のダウンロード
    • OpenSearch プラグインのインストール
    • OpenSearch の設定
  • ステップ 2: Fess のインストール
    • Fess のダウンロード
    • Fess の設定
    • インストールの確認
  • ステップ 3: 起動
  • Windows サービスとしての登録（オプション）
    • NSSM を使用した例
  • ファイアウォール設定
  • トラブルシューティング
    • ポート番号の競合
    • パスの長さ制限
    • Java が認識されない
  • 次のステップ
  • よくある質問
    • Q: Windows Server での運用は推奨されますか？
    • Q: 64 ビット版と 32 ビット版の違いは？
    • Q: パスに日本語が含まれる場合の対処法は？
• Docker でのインストール (詳細)
  • 前提条件
  • Docker のインストール確認
  • Docker イメージについて
  • ステップ 1: Docker Compose ファイルの取得
    • 方法 1: ファイルを個別にダウンロード
    • 方法 2: Git でリポジトリをクローン
  • ステップ 2: Docker Compose ファイルの確認
    • compose.yaml の内容
    • compose-opensearch3.yaml の内容
    • 設定のカスタマイズ（オプション）
  • ステップ 3: Docker コンテナの起動
    • 基本的な起動
    • 起動の確認
  • ステップ 4: ブラウザーでアクセス
  • データの永続化
  • Docker コンテナの停止
  • 高度な設定
    • 環境変数のカスタマイズ
    • 設定ファイルの反映方法
      • 方法 1: 設定ファイルのマウント
      • 方法 2: システムプロパティによる設定
    • 外部の OpenSearch への接続
    • Docker ネットワークの設定
  • Docker Compose での本番運用
  • トラブルシューティング
    • コンテナが起動しない
    • メモリ不足エラー
    • データの初期化
  • 次のステップ
  • よくある質問
    • Q: Docker イメージのサイズはどのくらいですか？
    • Q: Kubernetes での運用は可能ですか？
    • Q: コンテナのアップデートはどのように行いますか？
    • Q: マルチノード構成は可能ですか？
• 起動、停止、初期設定
  • 起動方法
    • TAR.GZ 版の場合
      • OpenSearch の起動
      • Fess の起動
    • ZIP 版の場合（Windows）
      • OpenSearch の起動
      • Fess の起動
    • RPM/DEB 版の場合 (chkconfig)
    • RPM/DEB 版の場合 (systemd)
    • Docker 版の場合
  • 起動の確認
    • ヘルスチェック
    • ログの確認
  • ブラウザーでのアクセス
    • 検索画面
    • 管理画面
  • 初回セットアップ
    • ステップ 1: 管理者パスワードの変更
    • ステップ 2: クロール設定の作成
    • ステップ 3: クロールの実行
    • ステップ 4: 検索の確認
  • その他の推奨設定
    • メールサーバーの設定
    • タイムゾーンの設定
    • ログレベルの調整
  • 停止方法
    • TAR.GZ/ZIP 版の場合
      • Fess の停止
    • RPM/DEB 版の場合 (chkconfig)
    • RPM/DEB 版の場合 (systemd)
    • Docker 版の場合
  • 再起動方法
    • TAR.GZ/ZIP 版の場合
    • RPM/DEB 版の場合
    • Docker 版の場合
  • トラブルシューティング
    • 起動しない場合
  • 次のステップ
• セキュリティ設定
  • 必須のセキュリティ設定
    • 管理者パスワードの変更
    • OpenSearch のセキュリティプラグイン有効化
    • HTTPS の有効化
  • 推奨のセキュリティ設定
    • ファイアウォール設定
    • アクセス制御の設定
    • ロールベースアクセス制御 (RBAC)
    • 監査ログの有効化
    • 定期的なセキュリティアップデート
  • データ保護
    • バックアップの暗号化
  • セキュリティベストプラクティス
    • 最小権限の原則
    • ネットワーク分離
    • 定期的なセキュリティ監査
    • セキュリティヘッダーの設定
  • セキュリティチェックリスト
    • 基本設定
    • ネットワークセキュリティ
    • アクセス制御
    • 監視とログ
    • バックアップとリカバリ
    • アップデートとパッチ管理
  • セキュリティインシデント対応
  • 参考情報
• アップグレード手順
  • 対応バージョン
  • アップグレード前の準備
    • バージョン互換性の確認
    • ダウンタイムの計画
  • ステップ 1: データのバックアップ
    • 設定データのバックアップ
    • インデックスデータのバックアップ
      • 方法 1: スナップショット機能を使用（推奨）
      • 方法 2: ディレクトリごとバックアップ
    • Docker 版のバックアップ
  • ステップ 2: 現在のバージョンの停止
  • ステップ 3: 新しいバージョンのインストール
    • TAR.GZ/ZIP 版
    • RPM/DEB 版
    • Docker 版
  • ステップ 4: OpenSearch のアップグレード（必要な場合）
  • ステップ 5: 新しいバージョンの起動
  • ステップ 6: 動作確認
  • ステップ 7: インデックスの再作成（推奨）
  • ロールバック手順
    • ステップ 1: 新しいバージョンの停止
    • ステップ 2: 古いバージョンの復元
    • ステップ 3: データの復元
    • ステップ 4: サービスの起動と確認
  • よくある質問
    • Q: ダウンタイムなしでアップグレードできますか？
    • Q: OpenSearch もアップグレードする必要がありますか？
    • Q: インデックスを再作成する必要がありますか？
    • Q: アップグレード後、検索結果が表示されません
  • 次のステップ
• アンインストール手順
  • アンインストール前の準備
    • バックアップの取得
    • サービスの停止
  • TAR.GZ/ZIP 版のアンインストール
    • ステップ 1: Fess の削除
    • ステップ 2: OpenSearch の削除
    • ステップ 3: データディレクトリの削除（オプション）
    • ステップ 4: ログディレクトリの削除（オプション）
  • RPM 版のアンインストール
    • ステップ 1: Fess のアンインストール
    • ステップ 2: OpenSearch のアンインストール
    • ステップ 3: サービスの無効化と削除
    • ステップ 4: データディレクトリの削除
    • ステップ 5: 設定ファイルの削除
    • ステップ 6: ログファイルの削除
    • ステップ 7: ユーザーとグループの削除（オプション）
  • DEB 版のアンインストール
    • ステップ 1: Fess のアンインストール
    • ステップ 2: OpenSearch のアンインストール
    • ステップ 3: サービスの無効化
    • ステップ 4: データディレクトリの削除
    • ステップ 5: 設定ファイルの削除（dpkg -P を使用しなかった場合）
    • ステップ 6: ログファイルの削除
    • ステップ 7: ユーザーとグループの削除（オプション）
  • Docker 版のアンインストール
    • ステップ 1: コンテナとネットワークの削除
    • ステップ 2: ボリュームの削除
    • ステップ 3: イメージの削除（オプション）
    • ステップ 4: ネットワークの削除（オプション）
    • ステップ 5: Compose ファイルの削除
  • アンインストールの確認
    • プロセスの確認
    • ポートの確認
    • ファイルの確認
    • パッケージの確認
  • 部分的なアンインストール
    • Fess のみを削除して OpenSearch を残す
    • OpenSearch のみを削除して Fess を残す
  • トラブルシューティング
    • パッケージが削除できない
    • ディレクトリが削除できない
  • 再インストールの準備
  • 次のステップ
• トラブルシューティング
  • インストール時の問題
    • Java が認識されない
    • プラグインのインストールに失敗する
  • 起動時の問題
    • Fess が起動しない
    • OpenSearch が起動しない
    • ポート番号の競合
  • 接続の問題
    • Fess が OpenSearch に接続できない
    • ブラウザーから Fess にアクセスできない
  • パフォーマンスの問題
    • 検索が遅い
    • クロールが遅い
  • データの問題
    • 検索結果が表示されない
    • インデックスが破損している
  • Docker 固有の問題
    • コンテナが起動しない
    • コンテナは起動するが Fess にアクセスできない
  • Windows 固有の問題
    • パスの問題
    • サービスとして登録できない
  • その他の問題
    • ログレベルの変更
    • データベースのリセット
  • サポート情報
    • コミュニティサポート
    • 商用サポート
  • デバッグ情報の収集

Fess ユーザーガイド

• はじめに
  • 対象読者
  • お読みになる前に
  • オンラインでのアクセス
  • 技術的なサポートの連絡先
    • 商用サポート
  • 関連サードパーティー Web サイトの参照
  • コメントおよび提案の送付方法
• AND 検索
  • 利用方法
• OR 検索
  • 利用方法
• NOT 検索
  • 利用方法
• ラベル指定検索
  • ラベル指定検索 (カテゴリ検索)
    • 利用方法
• 検索フィールド指定検索
  • フィールド指定検索
    • 利用可能なフィールド
    • 利用方法
• ソート検索
  • ソート対象フィールド
  • 利用方法
• ワイルドカード検索
  • 利用方法
  • 利用条件
• 範囲指定検索
  • 利用方法
• ブースト検索
  • ブースト検索(重み付け検索)
    • 利用方法
• 曖昧検索
  • 曖昧検索(ファジー検索)
    • 利用方法
• 位置情報検索
  • 利用方法
• 非表示検索条件
  • 利用方法
• ロール検索
  • 検索方法
  • パスワードの変更
  • ログアウト
• 特殊文字
  • 利用方法
• 詳細検索
  • 利用方法
  • 項目一覧
    • すべての単語を含む
    • 語順も含めた完全一致
    • いずれかの単語を含む
    • 含めない単語
    • 表示件数
    • ソート
    • 優先する言語
    • ラベル
    • 更新日時
    • ファイル形式
    • 検索対象
    • サイトまたはドメイン
• AI検索モード
  • 概要
  • AI検索モードの特徴
    • 対話形式での検索
    • 文脈を理解した回答
    • 出典の明示
    • 会話の継続
  • チャット検索の使い方
    • チャットを開始する
    • 質問を入力する
    • 回答を確認する
    • 会話を続ける
    • 新しい会話を始める
  • 効果的な質問のコツ
    • 具体的に質問する
    • 背景情報を含める
    • 段階的に質問する
  • よくある質問
    • Q: チャット機能が表示されません
    • Q: 回答が表示されるまで時間がかかります
    • Q: 回答の出典が間違っているように見えます
    • Q: 前の会話を忘れてしまったようです
    • Q: 特定の質問に対して回答が得られません
    • Q: 日本語以外で質問できますか？
  • 注意事項
    • AIの回答について
    • プライバシーについて
  • 参考情報

Fess APIガイド

• はじめに
  • 対象読者
  • お読みになる前に
  • API利用の前提条件
  • オンラインでのアクセス
  • 技術的なサポートの連絡先
    • 商用サポート
  • 関連サードパーティー Web サイトの参照
  • コメントおよび提案の送付方法
• APIクイックスタート
  • 5分で始めるAPI
    • 前提条件
    • 検索APIを試す
    • サジェストAPIを試す
    • ラベルAPIを試す
    • ヘルスチェックAPIを試す
  • Postman での利用
    • コレクションのセットアップ
    • 環境変数の設定
  • プログラミング言語別サンプル
    • Python
    • JavaScript (Node.js)
    • JavaScript (ブラウザ)
    • Java
  • APIバージョン対応表
  • トラブルシューティング
    • APIが動作しない場合
  • 次のステップ
• APIの概要
  • Fess の提供するAPI
  • ベースURL
  • 認証
  • HTTPメソッド
  • レスポンスフォーマット
  • エラーハンドリング
  • APIの種類
• 検索API
  • 検索結果の取得
    • リクエスト
    • リクエストパラメーター
    • レスポンス
  • 全てのドキュメントを検索
    • リクエストパラメーター
  • エラーレスポンス
• ラベルAPI
  • ラベルの取得
    • リクエスト
    • リクエストパラメーター
    • レスポンス
  • 使用例
  • エラーレスポンス
• 人気ワードAPI
  • 人気ワード一覧の取得
    • リクエスト
    • リクエストパラメーター
    • レスポンス
  • エラーレスポンス
• サジェストAPI
  • サジェストワード一覧の取得
    • リクエスト
    • リクエストパラメーター
    • レスポンス
  • エラーレスポンス
• Health API
  • 状態の取得
    • リクエスト
    • リクエストパラメーター
    • レスポンス
  • エラーレスポンス
• Chat API
  • 概要
  • 前提条件
  • 非ストリーミングAPI
    • エンドポイント
    • リクエストパラメーター
    • レスポンス
    • HTTPステータスコード
    • 使用例
      • cURL
      • JavaScript
      • Python
  • ストリーミングAPI
    • エンドポイント
    • リクエストパラメーター
    • レスポンス形式
    • SSEイベント
    • 使用例
      • cURL
      • JavaScript（EventSource）
      • Python
  • エラーハンドリング
  • レート制限
  • セキュリティ
  • 参考情報
• Admin API リファレンス
  • Admin API 概要
    • 概要
    • ベースURL
    • 認証
      • アクセストークンの取得
      • トークンの使用
        • cURL例
      • 必要な権限
    • 共通パターン
      • 一覧取得（GET/PUT /settings）
        • リクエスト
        • レスポンス
      • 単一設定取得（GET /setting/{id}）
        • リクエスト
        • レスポンス
      • 新規作成（POST /setting）
        • リクエスト
        • レスポンス
      • 更新（PUT /setting）
        • リクエスト
        • レスポンス
      • 削除（DELETE /setting/{id}）
        • リクエスト
        • レスポンス
    • レスポンス形式
      • 成功レスポンス
      • エラーレスポンス
      • HTTPステータスコード
    • 利用可能なAPI
      • クロール設定
      • インデックス管理
      • スケジューラー
      • ユーザー・権限管理
      • 検索チューニング
      • システム
      • 辞書
    • 使用例
      • Webクロール設定の作成
      • スケジュールジョブの開始
      • ユーザーの一覧取得
    • 参考情報
  • WebConfig API
    • 概要
    • ベースURL
    • エンドポイント一覧
    • Webクロール設定一覧取得
      • リクエスト
        • パラメーター
      • レスポンス
    • Webクロール設定取得
      • リクエスト
      • レスポンス
    • Webクロール設定作成
      • リクエスト
        • リクエストボディ
        • フィールド説明
      • レスポンス
    • Webクロール設定更新
      • リクエスト
        • リクエストボディ
      • レスポンス
    • Webクロール設定削除
      • リクエスト
      • レスポンス
    • URLパターンの例
      • includedUrls / excludedUrls
    • 使用例
      • 企業サイトのクロール設定
      • ドキュメントサイトのクロール設定
    • 参考情報
  • FileConfig API
    • 概要
    • ベースURL
    • エンドポイント一覧
    • ファイルクロール設定一覧取得
      • リクエスト
        • パラメーター
      • レスポンス
    • ファイルクロール設定取得
      • リクエスト
      • レスポンス
    • ファイルクロール設定作成
      • リクエスト
        • リクエストボディ
        • フィールド説明
      • レスポンス
    • ファイルクロール設定更新
      • リクエスト
        • リクエストボディ
      • レスポンス
    • ファイルクロール設定削除
      • リクエスト
      • レスポンス
    • パスの形式
    • 使用例
      • SMB共有のクロール設定
    • 参考情報
  • DataConfig API
    • 概要
    • ベースURL
    • エンドポイント一覧
    • データストア設定一覧取得
      • リクエスト
        • パラメーター
      • レスポンス
    • データストア設定取得
      • リクエスト
      • レスポンス
    • データストア設定作成
      • リクエスト
        • リクエストボディ
        • フィールド説明
      • レスポンス
    • データストア設定更新
      • リクエスト
        • リクエストボディ
      • レスポンス
    • データストア設定削除
      • リクエスト
      • レスポンス
    • ハンドラータイプ
    • 使用例
      • データベースクロール設定
    • 参考情報
  • Documents API
    • 概要
    • ベースURL
    • エンドポイント一覧
    • クエリ指定でのドキュメント削除
      • リクエスト
        • パラメーター
      • レスポンス
        • 使用例
    • ID指定でのドキュメント削除
      • リクエスト
        • パラメーター
      • レスポンス
        • 使用例
    • クエリ構文
      • 基本的なクエリ
      • 日付範囲クエリ
      • 複合クエリ
    • 注意事項
      • 削除操作の注意
      • 推奨プラクティス
    • 使用例
      • サイト全体の再クロール準備
      • 古いドキュメントのクリーンアップ
    • 参考情報
  • CrawlingInfo API
    • 概要
    • ベースURL
    • エンドポイント一覧
    • クロール情報一覧取得
      • リクエスト
        • パラメーター
      • レスポンス
        • レスポンスフィールド
    • クロールセッション詳細取得
      • リクエスト
      • レスポンス
    • クロールセッション削除
      • リクエスト
      • レスポンス
    • 使用例
      • クロール情報一覧の取得
      • 実行中のクロールセッション取得
      • 特定セッションの詳細取得
      • 古いセッションの削除
      • 進捗状況の監視
    • 参考情報
  • FailureUrl API
    • 概要
    • ベースURL
    • エンドポイント一覧
    • 失敗URL一覧取得
      • リクエスト
        • パラメーター
      • レスポンス
        • レスポンスフィールド
    • 失敗URL削除
      • リクエスト
      • レスポンス
    • 全失敗URL削除
      • リクエスト
        • パラメーター
      • レスポンス
    • エラータイプ
    • 使用例
      • 失敗URL一覧の取得
      • エラー回数でフィルター
      • 特定設定の失敗URL取得
      • 失敗URLの削除
      • 全失敗URLの削除
      • エラータイプ別の集計
    • 参考情報
  • Backup API
    • 概要
    • ベースURL
    • エンドポイント一覧
    • 設定データエクスポート
      • リクエスト
        • パラメーター
        • エクスポート対象タイプ
      • レスポンス
        • ZIPファイル内容
    • 設定データインポート
      • リクエスト
        • リクエストボディ
        • フィールド説明
      • レスポンス
    • 使用例
      • 全設定のエクスポート
      • 特定設定のエクスポート
      • 設定のインポート
      • 既存設定を上書きしてインポート
      • 特定設定のみインポート
      • バックアップの自動化
    • 注意事項
    • 参考情報
  • Scheduler API
    • 概要
    • ベースURL
    • エンドポイント一覧
    • スケジュールジョブ一覧取得
      • リクエスト
        • パラメーター
      • レスポンス
    • スケジュールジョブ取得
      • リクエスト
      • レスポンス
    • スケジュールジョブ作成
      • リクエスト
        • リクエストボディ
        • フィールド説明
      • レスポンス
        • Cron式の例
    • スケジュールジョブ更新
      • リクエスト
        • リクエストボディ
      • レスポンス
    • スケジュールジョブ削除
      • リクエスト
      • レスポンス
    • ジョブ開始
      • リクエスト
      • レスポンス
      • 注意事項
    • ジョブ停止
      • リクエスト
      • レスポンス
    • 使用例
      • クロールジョブの作成と実行
      • ジョブの状態確認
    • 参考情報
  • JobLog API
    • 概要
    • ベースURL
    • エンドポイント一覧
    • ジョブログ一覧取得
      • リクエスト
        • パラメーター
      • レスポンス
        • レスポンスフィールド
    • ジョブログ詳細取得
      • リクエスト
      • レスポンス
    • ジョブログ削除
      • リクエスト
      • レスポンス
    • 全ジョブログ削除
      • リクエスト
        • パラメーター
      • レスポンス
    • 使用例
      • ジョブログ一覧の取得
      • 失敗したジョブのみ取得
      • 特定期間のジョブログ
      • ジョブログ詳細の取得
      • 古いジョブログの削除
      • 失敗したジョブログのみ削除
      • 実行時間が長いジョブの検出
      • ジョブ成功率の計算
    • 参考情報
  • User API
    • 概要
    • ベースURL
    • エンドポイント一覧
    • ユーザー一覧取得
      • リクエスト
        • パラメーター
      • レスポンス
    • ユーザー取得
      • リクエスト
      • レスポンス
    • ユーザー作成
      • リクエスト
        • リクエストボディ
        • フィールド説明
      • レスポンス
    • ユーザー更新
      • リクエスト
        • リクエストボディ
      • レスポンス
    • ユーザー削除
      • リクエスト
      • レスポンス
    • 使用例
      • 新規ユーザー作成
      • ユーザーのロール変更
    • 参考情報
  • Role API
    • 概要
    • ベースURL
    • エンドポイント一覧
    • ロール一覧取得
      • リクエスト
        • パラメーター
      • レスポンス
    • ロール取得
      • リクエスト
      • レスポンス
    • ロール作成
      • リクエスト
        • リクエストボディ
        • フィールド説明
      • レスポンス
    • ロール更新
      • リクエスト
        • リクエストボディ
      • レスポンス
    • ロール削除
      • リクエスト
      • レスポンス
    • 使用例
      • 新規ロール作成
      • ロール一覧取得
    • 参考情報
  • Group API
    • 概要
    • ベースURL
    • エンドポイント一覧
    • グループ一覧取得
      • リクエスト
        • パラメーター
      • レスポンス
    • グループ取得
      • リクエスト
      • レスポンス
    • グループ作成
      • リクエスト
        • リクエストボディ
        • フィールド説明
      • レスポンス
    • グループ更新
      • リクエスト
        • リクエストボディ
      • レスポンス
    • グループ削除
      • リクエスト
      • レスポンス
    • 使用例
      • 新規グループ作成
      • グループ一覧取得
    • 参考情報
  • AccessToken API
    • 概要
    • ベースURL
    • エンドポイント一覧
    • アクセストークン一覧取得
      • リクエスト
        • パラメーター
      • レスポンス
    • アクセストークン取得
      • リクエスト
      • レスポンス
    • アクセストークン作成
      • リクエスト
        • リクエストボディ
        • フィールド説明
      • レスポンス
    • アクセストークン更新
      • リクエスト
        • リクエストボディ
      • レスポンス
    • アクセストークン削除
      • リクエスト
      • レスポンス
    • 使用例
      • APIトークン作成
      • トークンを使用したAPI呼び出し
    • 参考情報
  • LabelType API
    • 概要
    • ベースURL
    • エンドポイント一覧
    • ラベルタイプ一覧取得
      • リクエスト
        • パラメーター
      • レスポンス
    • ラベルタイプ取得
      • リクエスト
      • レスポンス
    • ラベルタイプ作成
      • リクエスト
        • リクエストボディ
        • フィールド説明
      • レスポンス
    • ラベルタイプ更新
      • リクエスト
        • リクエストボディ
      • レスポンス
    • ラベルタイプ削除
      • リクエスト
      • レスポンス
    • 使用例
      • ドキュメント用ラベル作成
      • ラベルを使用した検索
    • 参考情報
  • KeyMatch API
    • 概要
    • ベースURL
    • エンドポイント一覧
    • キーマッチ一覧取得
      • リクエスト
        • パラメーター
      • レスポンス
    • キーマッチ取得
      • リクエスト
      • レスポンス
    • キーマッチ作成
      • リクエスト
        • リクエストボディ
        • フィールド説明
      • レスポンス
    • キーマッチ更新
      • リクエスト
        • リクエストボディ
      • レスポンス
    • キーマッチ削除
      • リクエスト
      • レスポンス
    • 使用例
      • 製品ページのキーマッチ作成
      • サポートページのキーマッチ
    • 参考情報
  • BoostDoc API
    • 概要
    • ベースURL
    • エンドポイント一覧
    • ドキュメントブースト一覧取得
      • リクエスト
        • パラメーター
      • レスポンス
    • ドキュメントブースト取得
      • リクエスト
      • レスポンス
    • ドキュメントブースト作成
      • リクエスト
        • リクエストボディ
        • フィールド説明
      • レスポンス
    • ドキュメントブースト更新
      • リクエスト
        • リクエストボディ
      • レスポンス
    • ドキュメントブースト削除
      • リクエスト
      • レスポンス
    • ブースト式の例
    • 使用例
      • ドキュメントサイトのブースト
      • 新しいコンテンツのブースト
    • 参考情報
  • ElevateWord API
    • 概要
    • ベースURL
    • エンドポイント一覧
    • エレベートワード一覧取得
      • リクエスト
        • パラメーター
      • レスポンス
    • エレベートワード取得
      • リクエスト
      • レスポンス
    • エレベートワード作成
      • リクエスト
        • リクエストボディ
        • フィールド説明
      • レスポンス
    • エレベートワード更新
      • リクエスト
        • リクエストボディ
      • レスポンス
    • エレベートワード削除
      • リクエスト
      • レスポンス
    • 使用例
      • 製品名のエレベート
      • 特定ラベルへのエレベート
    • 参考情報
  • BadWord API
    • 概要
    • ベースURL
    • エンドポイント一覧
    • NGワード一覧取得
      • リクエスト
        • パラメーター
      • レスポンス
    • NGワード取得
      • リクエスト
      • レスポンス
    • NGワード作成
      • リクエスト
        • リクエストボディ
        • フィールド説明
      • レスポンス
    • NGワード更新
      • リクエスト
        • リクエストボディ
      • レスポンス
    • NGワード削除
      • リクエスト
      • レスポンス
    • 使用例
      • スパムキーワードの除外
      • 特定ロール向けのNGワード
    • 参考情報
  • RelatedContent API
    • 概要
    • ベースURL
    • エンドポイント一覧
    • 関連コンテンツ一覧取得
      • リクエスト
        • パラメーター
      • レスポンス
    • 関連コンテンツ取得
      • リクエスト
      • レスポンス
    • 関連コンテンツ作成
      • リクエスト
        • リクエストボディ
        • フィールド説明
      • レスポンス
    • 関連コンテンツ更新
      • リクエスト
        • リクエストボディ
      • レスポンス
    • 関連コンテンツ削除
      • リクエスト
      • レスポンス
    • 使用例
      • 製品情報の関連コンテンツ
      • サポート情報の関連コンテンツ
    • 参考情報
  • RelatedQuery API
    • 概要
    • ベースURL
    • エンドポイント一覧
    • 関連クエリ一覧取得
      • リクエスト
        • パラメーター
      • レスポンス
    • 関連クエリ取得
      • リクエスト
      • レスポンス
    • 関連クエリ作成
      • リクエスト
        • リクエストボディ
        • フィールド説明
      • レスポンス
    • 関連クエリ更新
      • リクエスト
        • リクエストボディ
      • レスポンス
    • 関連クエリ削除
      • リクエスト
      • レスポンス
    • 使用例
      • 製品関連のクエリ
      • ヘルプ関連のクエリ
    • 参考情報
  • Suggest API
    • 概要
    • ベースURL
    • エンドポイント一覧
    • サジェストワード一覧取得
      • リクエスト
        • パラメーター
      • レスポンス
    • サジェストワード取得
      • リクエスト
      • レスポンス
    • サジェストワード作成
      • リクエスト
        • リクエストボディ
        • フィールド説明
      • レスポンス
    • サジェストワード更新
      • リクエスト
        • リクエストボディ
      • レスポンス
    • サジェストワード削除
      • リクエスト
      • レスポンス
    • 全サジェストワード削除
      • リクエスト
      • レスポンス
    • 使用例
      • 人気キーワードの追加
      • サジェストの一括削除
    • 参考情報
  • General API
    • 概要
    • ベースURL
    • エンドポイント一覧
    • 一般設定取得
      • リクエスト
      • レスポンス
    • 一般設定更新
      • リクエスト
        • リクエストボディ
        • フィールド説明
      • レスポンス
    • 使用例
      • クローラー設定の更新
      • 検索設定の更新
      • サジェスト設定の更新
    • 参考情報
  • SystemInfo API
    • 概要
    • ベースURL
    • エンドポイント一覧
    • システム情報取得
      • リクエスト
      • レスポンス
        • レスポンスフィールド
    • 使用例
      • システム情報の取得
      • バージョン確認
      • メモリ使用状況の確認
    • 参考情報
  • Stats API
    • 概要
    • ベースURL
    • エンドポイント一覧
    • 統計情報取得
      • リクエスト
        • パラメーター
      • レスポンス
        • レスポンスフィールド
    • 検索クエリ統計
      • リクエスト
      • レスポンス
    • クリック統計
      • リクエスト
      • レスポンス
    • 使用例
      • 全統計情報の取得
      • 期間指定での統計取得
      • 検索クエリ統計の取得
      • 人気クエリTOP10の取得
    • 参考情報
  • Log API
    • 概要
    • ベースURL
    • エンドポイント一覧
    • 検索ログ取得
      • リクエスト
        • パラメーター
      • レスポンス
    • クリックログ取得
      • リクエスト
        • パラメーター
      • レスポンス
    • お気に入りログ取得
      • リクエスト
        • パラメーター
      • レスポンス
    • 検索ログ削除
      • リクエスト
        • パラメーター
      • レスポンス
    • 使用例
      • 最近の検索ログ取得
      • 特定期間の検索ログ
      • 特定クエリの検索ログ
      • クリックログ取得
      • 古い検索ログの削除
    • 参考情報
  • SearchLog API
    • 概要
    • ベースURL
    • エンドポイント一覧
    • 検索ログ一覧取得
      • リクエスト
        • パラメーター
      • レスポンス
        • レスポンスフィールド
    • 検索ログ詳細取得
      • リクエスト
      • レスポンス
    • 検索ログ削除
      • リクエスト
      • レスポンス
    • 検索ログ一括削除
      • リクエスト
        • パラメーター
      • レスポンス
    • 検索統計取得
      • リクエスト
        • パラメーター
      • レスポンス
    • 使用例
      • 検索ログ一覧の取得
      • 期間を指定して取得
      • 特定ユーザーの検索ログ
      • 特定キーワードの検索ログ
      • 検索統計の取得
      • 古い検索ログの削除
      • 人気検索キーワードの抽出
      • 検索品質の分析
      • 日別検索数の推移
    • 参考情報
  • Storage API
    • 概要
    • ベースURL
    • エンドポイント一覧
    • ストレージ情報取得
      • リクエスト
      • レスポンス
        • レスポンスフィールド
    • インデックス最適化
      • リクエスト
        • リクエストボディ
        • フィールド説明
      • レスポンス
    • インデックスフラッシュ
      • リクエスト
        • リクエストボディ
        • フィールド説明
      • レスポンス
    • 使用例
      • ストレージ情報の取得
      • 全インデックスの最適化
      • 特定インデックスの最適化
      • 削除済みドキュメントの削除
      • インデックスのフラッシュ
    • 参考情報
  • Plugin API
    • 概要
    • ベースURL
    • エンドポイント一覧
    • プラグイン一覧取得
      • リクエスト
      • レスポンス
        • レスポンスフィールド
    • プラグインインストール
      • リクエスト
        • リクエストボディ
        • フィールド説明
      • レスポンス
    • プラグイン削除
      • リクエスト
      • レスポンス
    • 使用例
      • プラグイン一覧の取得
      • プラグインのインストール
      • プラグインの削除
    • 注意事項
    • 参考情報
  • Dict API
    • 概要
    • ベースURL
    • エンドポイント一覧
    • 辞書一覧取得
      • リクエスト
      • レスポンス
    • 辞書内容取得
      • リクエスト
      • レスポンス
    • 辞書内容更新
      • リクエスト
        • リクエストボディ
        • フィールド説明
      • レスポンス
    • 辞書ファイルアップロード
      • リクエスト
        • リクエストボディ
        • フィールド説明
      • レスポンス
    • 辞書タイプ
    • 辞書形式の例
      • 同義語辞書
      • マッピング辞書
      • 保護語辞書
    • 使用例
      • 辞書一覧の取得
      • 同義語辞書の内容取得
      • 同義語辞書の更新
      • 辞書ファイルのアップロード
    • 注意事項
    • 参考情報

Fess 管理者ガイド

• はじめに
  • 対象読者
  • お読みになる前に
  • オンラインでのアクセス
  • 技術的なサポートの連絡先
    • 商用サポート
• ダッシュボード
  • 概要
  • インデックスされているドキュメント数の確認
• 構成ウィザード
  • 概要
    • 簡易セットアップ
    • クロールの設定
    • 設定項目
      • 名前
      • クロールパス
      • 最大アクセス数
      • 深さ
    • クローラ
• 全般
  • 概要
  • 設定内容
    • システム
      • JSONレスポンス
      • ログインが必要
      • ログインリンク表示
      • 重複結果の折り畳み
      • サムネイル表示
      • デフォルトのラベル値
      • デフォルトのソート値
      • 仮想ホスト
      • 人気ワードのレスポンス
      • CSVファイルのエンコード
      • 検索パラメーターの追加
      • 通知メール
    • クローラー
      • 最終更新日時の確認
      • 同時クローラー設定
      • 以前のドキュメントを削除
      • 除外するエラーの種類
      • 障害数のしきい値
    • ロギング
      • 検索ログ
      • ユーザログ
      • お気に入りログ
      • 以前の検索ログを削除
      • 以前のジョブログを削除
      • 以前のユーザーログを削除
      • ログを削除するボット名
      • ログレベル
    • サジェスト
      • 検索語でサジェスト
      • ドキュメントでサジェスト
      • 以前のサジェスト情報を削除
    • LDAP
      • LDAP URL
      • Base DN
      • Bind DN
      • パスワード
      • User DN
      • アカウントフィルター
      • グループフィルター
      • memberOf属性
    • お知らせ表示
      • ログインページ
      • 検索トップページ
    • ストレージ
      • タイプ
      • バケット
      • エンドポイント
      • アクセスキー
      • シークレットキー
      • リージョン
      • プロジェクトID
      • 認証情報パス
  • 例
    • LDAPの設定例
• スケジューラ
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
      • 対象
      • スケジュール
      • 実行方法
      • スクリプト
      • ロギング
      • クローラージョブ
      • 状態
      • 表示順序
    • 設定の削除
  • 手動クロール方法
• ページのデザイン
  • 概要
  • 設定方法
    • 表示方法
    • ファイルマネージャー
    • ページファイルの表示
    • アップロードするファイル
      • ファイルのアップロード
      • ファイル名(オプション)
• 辞書
  • 概要
  • 一覧
  • Kuromoji
  • 同義語
  • マッピング
  • Protwords
  • ストップワード
  • Stemmer上書き
• Kuromoji辞書
  • 概要
  • 管理方法
    • 表示方法
    • 設定方法
    • 設定項目
      • トークン
      • 分割
      • 読み
      • 品詞
  • ダウンロード
  • アップロード
• 同義語辞書
  • 概要
  • 管理方法
    • 表示方法
    • 設定方法
    • 設定項目
      • 変換元
      • 変換後
  • ダウンロード
  • アップロード
• マッピング辞書
  • 概要
  • 管理方法
    • 表示方法
    • 設定方法
    • 設定項目
      • 変換元
      • 変換後
  • ダウンロード
  • アップロード
• Protwords辞書
  • 概要
  • 管理方法
    • 表示方法
    • 設定方法
    • 設定項目
      • 単語情報
  • ダウンロード
  • アップロード
• ストップワード辞書
  • 概要
  • 管理方法
    • 表示方法
    • 設定方法
    • 設定項目
      • 変換元
      • 変換後
  • ダウンロード
  • アップロード
• Stemmer上書き辞書
  • 概要
  • 管理方法
    • 表示方法
    • 設定方法
    • 設定項目
      • 変換元
      • 変換後
  • ダウンロード
  • アップロード
• アクセストークン
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
      • パーミッション
      • パラメーター名
      • 有効期限
    • 設定の削除
• プラグイン
  • 概要
  • 管理方法
    • 表示方法
    • インストール
• ストレージ
  • 概要
  • 管理方法
    • オブジェクトストレージサーバーの設定
      • 共通設定
      • S3の設定
      • GCSの設定
      • MinIO（S3互換）の設定
    • 表示方法
    • ダウンロード
    • 削除
    • アップロード
    • フォルダーの作成
• ウェブクロール
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
      • URL
      • クロール対象とするURL
      • クロール対象から除外するURL
      • 検索対象とするURL
      • 検索対象から除外するURL
      • 設定パラメーター
      • 深さ
      • 最大アクセス数
      • ユーザーエージェント
      • スレッド数
      • 間隔
      • ブースト値
      • パーミッション
      • 仮想ホスト
      • 状態
      • 説明
    • 設定の削除
  • 例
    • fess.codelibs.org をクロールする
    • ウェブ認証サイトのウェブクロール
      • Redmine
      • XWiki
• ファイルクロール
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
      • パス
      • クロール対象とするパス
      • クロール対象から除外するパス
      • 検索対象とするパス
      • 検索対象から除外するパス
      • 設定パラメーター
      • 深さ
      • 最大アクセス数
      • スレッド数
      • 間隔
      • ブースト値
      • パーミッション
      • 仮想ホスト
      • 状態
      • 説明
    • 設定の削除
  • 例
    • ローカルファイルをクロール
    • Windowsの共有フォルダーをクロール
    • Amazon S3バケットをクロール
    • Google Cloud Storageバケットをクロール
• データストアクロール
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
      • ハンドラー名
      • パラメーター
      • スクリプト
      • ブースト値
      • パーミッション
      • 仮想ホスト
      • 状態
      • 説明
    • 設定の削除
  • 例
    • DatabaseDataStore
      • パラメーター
      • スクリプト
      • ドライバー
    • CsvDataStore
      • パラメーター
      • スクリプト
    • EsDataStore
      • パラメーター
      • スクリプト
    • CsvListDataStore
      • パラメーター
      • スクリプト
• ラベル
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
      • 値
      • 対象とするパス
      • 除外するパス
      • パーミッション
      • 仮想ホスト
      • 表示順序
    • 設定の削除
• キーマッチ
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 検索語
      • クエリー
      • サイズ
      • ブースト値
      • 仮想ホスト
    • 設定の削除
• ドキュメントブースト
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 条件
      • ブースト値式
      • ソート順
    • 設定の削除
• 関連コンテンツ
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 検索語
      • コンテンツ
      • 仮想ホスト
    • 設定の削除
• 関連クエリー
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 検索語
      • クエリー
      • 仮想ホスト
    • 設定の削除
• パスマッピング
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 正規表現
      • 置換
      • 処理の種類
      • 表示順序
      • ユーザーエージェント
    • 設定の削除
  • 例
    • ファイルサーバーをWebサーバー経由でアクセス
    • 表示時のみURLを変換
    • サーバー移行時のリンク変換
  • 注意事項
    • 抽出URL変換について
    • 正規表現について
    • ソート順について
• ウェブ認証
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • ホスト名
      • ポート
      • レルム
      • スキーム
      • ユーザー名
      • パスワード
      • パラメーター
      • ウェブ設定
    • 設定の削除
• ファイル認証
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • ホスト名
      • ポート
      • スキーム
      • ユーザー名
      • パスワード
      • パラメーター
      • ファイルクロール設定
    • 設定の削除
• リクエストヘッダー
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
      • 値
      • ウェブ設定
    • 設定の削除
• 重複ホスト
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 正規名
      • 重複名
    • 設定の削除
• ユーザー
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • ユーザー名
      • ロール
      • グループ
    • 設定の削除
• ロール
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
    • 設定の削除
• グループ
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
    • 削除の方法
• サジェストワード
  • 概要
  • 管理方法
    • 表示方法
      • 単語種別
      • 単語数
• 追加ワード
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 単語
      • 読み
      • パーミッション
      • ラベル
      • ブースト値
    • 設定の削除
  • ダウンロード
    • CSVの内容
  • アップロード
    • CSVの内容
• 除外ワード
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • サジェスト候補
    • 設定の削除
  • ダウンロード
    • CSVの内容
  • アップロード
    • CSVの内容
• システム情報
  • 概要
  • 管理方法
    • 表示方法
    • 表示項目
      • 環境変数のプロパティ
      • システムのプロパティ
      • アプリのプロパティ
      • バグレポートのプロパティ
• 検索ログ
  • 概要
  • 管理方法
  • 一覧
  • 詳細
• ジョブログ
  • 概要
  • 管理方法
    • 表示方法
    • ジョブログ詳細
      • 名前
      • 状態
      • 対象
      • 開始時間
      • 終了時間
      • 実行方法
      • スクリプト
      • 結果
• クロール情報
  • 概要
  • 管理方法
  • 一覧
  • 詳細
    • 項目一覧
      • セッションID
      • クローラーの開始時間
      • クロールの開始時間 (ウェブ/ファイル)
      • クロールの開始時間 (データストア)
      • クロールの終了時間 (ウェブ/ファイル)
      • クロールの実行時間 (データストア)
      • インデクシングの実行時間 (データストア)
      • インデックスのサイズ (データストア)
      • クロールの終了時間 (データストア)
      • クローラーの状態
      • クローラーの終了時間
      • クローラーの実行時間
• ログファイル
  • 概要
  • 設定方法
    • 表示方法
    • ダウンロード
      • server_*.log
      • fess.log
      • fess-crawler.log
      • audit.log
      • fess-thumbnail.log
      • fess-suggest.log
      • fess-urls.log
      • search.log
      • gc-crawler.log
• 障害URL
  • 概要
  • 管理方法
    • 表示方法
  • 障害URLの詳細
    • 詳細の内容
      • URL
      • スレッド名
      • 種類
      • ログ
      • エラー回数
      • 最終アクセス日時
• 検索
  • 概要
  • 管理方法
    • 表示方法
    • 検索一覧
    • 一括削除
• バックアップ
  • 概要
    • ダウンロード
      • fess_config.bulk
      • fess_basic_config.bulk
      • fess_user.bulk
      • system.properties
      • fess.json
      • doc.json
      • click_log.ndjson
      • favorite_log.ndjson
      • search_log.ndjson
      • user_info.ndjson
    • アップロード
• メンテナンス
  • 概要
  • 操作方法
    • 再インデクシング
    • 設定項目
      • エイリアスの更新
      • 辞書の初期化
      • シャード数
      • 最大レプリカ数
    • ドキュメントインデックスのリロード
    • Crawlerインデックス
    • 診断
• クエリーリクエスト
  • 概要
  • 操作方法
    • リクエストの送信
    • 設定項目
      • リクエストファイル

Fess 設定ガイド

• はじめに
  • 対象読者
  • お読みになる前に
  • オンラインでのアクセス
  • 技術的なサポートの連絡先
    • 商用サポート
  • 関連サードパーティー Web サイトの参照
  • コメントおよび提案の送付方法
• ポートとネットワーク設定
  • 概要
  • 使用ポートの設定
    • デフォルトポート
    • Fess ウェブアプリケーションのポート変更
      • Linux環境での設定
      • 環境変数による設定
      • RPM/DEBパッケージの場合
      • Windows環境での設定
      • Windowsサービスとして登録する場合
    • コンテキストパスの設定
  • プロキシ設定
    • 概要
    • クローラー用プロキシの設定
      • 基本設定
      • 認証が必要なプロキシの設定
      • 特定のホストをプロキシから除外
    • システム全体のHTTPプロキシ設定
      • 環境変数によるプロキシ設定
  • HTTP通信設定
    • ファイルアップロードの制限
    • 接続タイムアウト設定
    • OpenSearchの接続先変更
      • 複数ノードへの接続
    • SSL/TLS接続の設定
  • 仮想ホスト設定
    • 概要
    • 基本設定
  • リバースプロキシとの連携
    • Nginx の設定例
    • Apache の設定例
    • SSL/TLS終端
  • ファイアウォール設定
    • 必要なポートの開放
    • セキュリティグループの設定(クラウド環境)
  • トラブルシューティング
    • ポート変更後にアクセスできない
    • プロキシ経由でクロールできない
    • OpenSearchに接続できない
    • リバースプロキシ経由でアクセスすると正常に動作しない
  • 参考情報
• メモリ設定
  • 概要
  • Fess ウェブアプリケーションのメモリ設定
    • 設定が必要な場合
    • 環境変数による設定
    • RPM/DEBパッケージの場合
    • 推奨メモリサイズ
  • クローラーのメモリ設定
    • 設定が必要な場合
    • 設定方法
    • 推奨設定
    • 詳細なJVMオプション
  • OpenSearch のメモリ設定
    • 重要な考慮事項
    • 設定方法
      • Linux環境
      • Windows環境
    • 推奨メモリサイズ
    • ベストプラクティス
  • サジェスト・サムネイル処理のメモリ設定
    • サジェスト生成プロセス
    • サムネイル生成プロセス
  • メモリ監視とチューニング
    • メモリ使用状況の確認
      • Fess のメモリ使用状況
      • OpenSearchのメモリ使用状況
    • メモリ不足の兆候
    • チューニング手順
    • メモリリーク対策
  • トラブルシューティング
    • OutOfMemoryError が発生する
    • GCによる停止時間が長い
    • メモリ設定後も性能が改善しない
  • 参考情報
• Windowsサービスへの登録
  • Windowsサービスとしての登録
    • 事前準備
    • OpenSearchをサービスとして登録
    • 設定
    • 登録方法
    • サービスの設定
• クローラー基本設定
  • 概要
  • クローラーの基本概念
    • クローラーとは
    • クローラーの種類
  • クロール設定の作成
    • 基本的なクロール設定の追加
    • Webクローラーの設定例
      • 社内イントラネットサイトのクロール
      • 公開Webサイトのクロール
    • ファイルクローラーの設定例
      • ローカルファイルシステム
      • SMB/CIFS(Windowsファイル共有)
    • 認証情報の設定
  • クロールの実行
    • 手動実行
    • スケジュール実行
    • クロール状況の確認
  • 基本的な設定項目
    • クロール対象の制限
      • URLパターンによる制限
      • 深さの制限
      • 最大アクセス数
    • 並列クロール数(スレッド数)
    • クロール間隔
  • ファイルサイズの設定
    • 取得するファイルサイズの上限
    • インデックスするファイルサイズの上限
  • 単語の長さ制限
    • 概要
    • 設定方法
  • プロキシの設定
    • 概要
    • 設定方法
    • システム全体のプロキシ設定
  • robots.txt の設定
    • 概要
    • 設定方法
  • User-Agent の設定
    • 管理画面での設定
  • エンコーディング設定
    • クロールデータのエンコーディング
    • ファイル名のエンコーディング
  • クロールのトラブルシューティング
    • クロールが開始されない
    • クロールが途中で停止する
    • 特定のページがクロールされない
    • クロールが遅い
  • ベストプラクティス
    • クロール設定の推奨事項
    • スケジュール設定の推奨事項
  • 参考情報
• クローラー詳細設定
  • 概要
  • 全般設定
    • 設定ファイルの場所
    • デフォルトスクリプト
    • HTTPスレッドプール
  • ドキュメント処理設定
    • 基本設定
      • 設定例
    • 単語処理設定
      • 設定例
    • 文字処理設定
      • 設定例
  • プロトコル設定
    • 対応プロトコル
      • 設定例
    • 環境変数パラメーター
  • robots.txt 設定
  • エラー処理設定
  • システム監視設定
    • ホットスレッド設定
      • 設定例
  • メタデータ設定
  • HTML クローラー設定
    • XPath 設定
      • 設定例
      • カスタム XPath の例
    • HTML タグ処理
      • 設定例
    • URLパターンフィルター
      • 設定例
  • ファイルクローラー設定
    • 基本設定
      • 設定例
    • コンテンツ処理
      • 設定例
    • ファイルURLパターンフィルター
      • 設定例
    • MIMEタイプ検出オーバーライド
      • 設定例
  • キャッシュ設定
    • ドキュメントキャッシュ
      • 設定例
  • JVM オプション
    • デフォルト設定
    • 主要なオプションの説明
    • カスタム設定例
  • パフォーマンスチューニング
    • クロール速度の最適化
    • メモリ使用量の最適化
    • インデックス品質の向上
  • トラブルシューティング
    • メモリ不足
    • クロールが遅い
    • 特定のコンテンツが抽出できない
    • 文字化けが発生する
  • ベストプラクティス
  • S3/GCSクローラー設定
    • S3クローラー
      • 設定例
    • GCSクローラー
      • 設定例
  • 参考情報
• サムネイル画像の設定
  • 概要
  • サポートしているファイル形式
    • 画像ファイル
    • ドキュメントファイル
    • HTMLコンテンツ
  • 必要な外部ツール
    • 基本ツール（必須）
    • SVGサポート
    • PDFサポート
    • MS Officeサポート
    • PostScriptサポート
  • HTMLファイルのサムネイル画像
  • 設定
    • 設定ファイル
    • 主な設定項目（fess_config.properties）
  • generate-thumbnail スクリプト
    • 概要
    • 使用方法
    • 引数
    • サポートするタイプ
    • 使用例
  • サムネイル保存先
    • デフォルトパス
    • ディレクトリ構造
  • サムネイルジョブの無効化
  • トラブルシューティング
    • サムネイルが生成されない
    • GIF/TIFFでエラーが発生する
    • SVGのサムネイルが生成されない
    • 権限エラー
  • プラットフォーム対応
• データストアコネクタガイド
  • データストアコネクタの概要
    • 概要
    • 利用可能なコネクタ
      • クラウドストレージ
      • コラボレーションツール
      • 開発・運用ツール
      • データベース・ファイル
    • コネクタのインストール
      • プラグインのインストール
        • 管理画面から
        • コマンドライン
        • Docker環境
    • データストア設定の基本
      • 共通設定項目
      • パラメーター設定
      • スクリプト設定
    • 認証設定
      • OAuth 2.0認証
      • APIキー認証
      • サービスアカウント認証
    • パフォーマンスチューニング
    • トラブルシューティング
      • コネクタが表示されない
      • 認証エラー
      • データが取得できない
      • デバッグ設定
    • 参考情報
  • Boxコネクタ
    • 概要
    • 前提条件
      • プラグインのインストール
    • 設定方法
      • 基本設定
      • パラメーター設定
        • パラメーター一覧
      • スクリプト設定
        • 利用可能なフィールド
    • Box認証の設定
      • JWT認証の設定手順
        • 1. Box Developer Consoleでアプリケーションを作成
        • 2. アプリケーションの設定
        • 3. エンタープライズで承認
        • 4. 認証情報の取得
        • 秘密鍵の形式
    • 使用例
      • 企業のBoxストレージ全体をクロール
      • 特定のフォルダのみをクロール
      • PDFファイルのみをクロール
    • トラブルシューティング
      • 認証エラー
      • 秘密鍵のフォーマットエラー
      • ファイルが取得できない
      • 大量のファイルがある場合
    • 権限とアクセス制御
      • Boxのファイル権限を反映
    • 参考情報
  • Dropboxコネクタ
    • 概要
    • 対応サービス
    • 前提条件
      • プラグインのインストール
    • 設定方法
      • 基本設定
      • パラメーター設定
        • パラメーター一覧
      • スクリプト設定
        • Dropboxファイルの場合
        • Dropbox Paperの場合
    • Dropbox認証の設定
      • アクセストークンの取得手順
        • 1. Dropbox App Consoleでアプリを作成
        • 2. 権限の設定
        • 3. アクセストークンの生成
        • 4. トークンの設定
    • Basicプランの設定
      • Dropbox Basicプランの制限
    • 使用例
      • Dropboxファイル全体のクロール
      • Dropbox Paperドキュメントのクロール
      • 権限付きクロール
      • 特定のファイルタイプのみクロール
    • トラブルシューティング
      • 認証エラー
      • ファイルが取得できない
      • APIレート制限エラー
      • Paperドキュメントが取得できない
      • 大量のファイルがある場合
    • 権限とアクセス制御
      • Dropboxの共有権限を反映
    • 参考情報
  • Google Workspaceコネクタ
    • 概要
    • 対応サービス
    • 前提条件
      • プラグインのインストール
    • 設定方法
      • 基本設定
      • パラメーター設定
        • パラメーター一覧
      • スクリプト設定
        • 利用可能なフィールド
    • Google Cloud Platform設定
      • 1. プロジェクトの作成
      • 2. Google Drive APIの有効化
      • 3. サービスアカウントの作成
      • 4. サービスアカウントキーの作成
      • 5. Domain全体への委任を有効化
      • 6. Google Workspace管理コンソールで承認
    • 認証情報の設定
      • JSONファイルから情報を取得
        • 秘密鍵の形式
    • 使用例
      • Google Drive全体のクロール
      • 権限付きクロール
      • 特定のファイルタイプのみクロール
    • トラブルシューティング
      • 認証エラー
      • Domain全体への委任エラー
      • ファイルが取得できない
      • APIクォータエラー
      • 秘密鍵のフォーマットエラー
      • 共有ドライブのクロール
      • 大量のファイルがある場合
    • 権限とアクセス制御
      • Google Driveの共有権限を反映
    • 参考情報
  • Microsoft 365コネクタ
    • 概要
    • 対応サービス
    • 前提条件
      • プラグインのインストール
    • 設定方法
      • 基本設定
      • パラメーター設定（共通）
        • 共通パラメーター一覧
    • Azure ADアプリケーション登録
      • 1. Azure Portalでアプリケーションを登録
      • 2. クライアントシークレットの作成
      • 3. API権限の追加
    • データストア別の必要な権限
      • OneDriveDataStore
      • OneNoteDataStore
      • TeamsDataStore
      • SharePointDocLibDataStore
      • SharePointListDataStore / SharePointPageDataStore
    • スクリプト設定
      • OneDrive
      • OneNote
      • Teams
      • SharePoint Document Libraries
      • SharePoint Lists
      • SharePoint Pages
    • データストア別の追加パラメーター
      • OneDrive
      • OneNote
      • Teams
      • SharePoint Document Libraries
      • SharePoint Lists
      • SharePoint Pages
    • 使用例
      • OneDrive全ドライブのクロール
      • 特定チームのTeamsメッセージをクロール
      • SharePointリストのクロール
    • トラブルシューティング
      • 認証エラー
      • APIレート制限エラー
      • データが取得できない
      • SharePointサイトIDの確認方法
      • 大量データのクロール
    • 参考情報
  • Atlassianコネクタ
    • 概要
    • 対応製品
    • 前提条件
      • プラグインのインストール
    • 設定方法
      • 基本設定
      • パラメーター設定
        • パラメーター一覧
      • スクリプト設定
        • Jiraの場合
        • Confluenceの場合
    • OAuth 2.0認証の設定
      • Cloud版の場合（推奨）
    • OAuth 1.0a認証の設定
      • Server版の場合
    • Basic認証の設定
      • Server版のシンプルな設定
    • JQLによる高度な検索
      • Jiraの課題をJQLで絞り込む
    • 使用例
      • Jira Cloudのクロール
      • Confluence Serverのクロール
    • トラブルシューティング
      • 認証エラー
      • 接続エラー
      • データが取得できない
      • OAuth 2.0トークンの更新
    • 参考情報
  • Slackコネクタ
    • 概要
    • 対応コンテンツ
    • 前提条件
      • プラグインのインストール
    • 設定方法
      • 基本設定
      • パラメーター設定
        • パラメーター一覧
      • スクリプト設定
        • 利用可能なフィールド
    • Slack App設定
      • 1. Slack Appの作成
      • 2. OAuth & Permissionsの設定
      • 3. アプリのインストール
      • 4. チャンネルへの追加
    • 使用例
      • 特定のチャンネルをクロール
      • すべてのチャンネルをクロール
      • プライベートチャンネルを含めてクロール
      • ファイルも含めてクロール
      • 詳細なメッセージ情報を含める
    • トラブルシューティング
      • 認証エラー
      • チャンネルが見つからない
      • メッセージが取得できない
      • 権限不足エラー
      • ファイルがクロールできない
      • APIレート制限
      • 大量のメッセージがある場合
    • スクリプトの高度な使用例
      • メッセージのフィルタリング
      • メッセージの加工
    • 参考情報
  • Gitコネクタ
    • 概要
    • 対応リポジトリ
    • 前提条件
      • プラグインのインストール
    • 設定方法
      • 基本設定
      • パラメーター設定
        • パラメーター一覧
      • スクリプト設定
        • 利用可能なフィールド
    • Gitリポジトリの認証
      • GitHub Personal Access Token
        • 1. GitHubでPersonal Access Tokenを生成
        • 2. URIに認証情報を含める
      • GitLab Private Token
        • 1. GitLabでAccess Tokenを生成
        • 2. URIに認証情報を含める
      • SSH認証
    • 抽出器の設定
      • MIMEタイプ別の抽出器
        • デフォルトの抽出器
        • テキストファイルのみクロール
        • すべてのファイルをクロール
        • 特定のファイルタイプのみ
    • 差分クロール
      • 前回のコミットからの変更のみクロール
      • 削除されたファイルの処理
    • 使用例
      • GitHubパブリックリポジトリ
      • GitHubプライベートリポジトリ
      • GitLab（セルフホスト）
      • ドキュメントのみクロール（Markdownファイル）
      • 特定のディレクトリのみクロール
    • トラブルシューティング
      • 認証エラー
      • リポジトリが見つからない
      • ファイルが取得できない
      • MIMEタイプエラー
      • 大きなリポジトリ
      • ブランチの指定
    • URLの生成
      • base_urlの設定パターン
      • スクリプトでのURL生成
    • 参考情報
  • Elasticsearch/OpenSearchコネクタ
    • 概要
    • 対応バージョン
    • 前提条件
      • プラグインのインストール
    • 設定方法
      • 基本設定
      • パラメーター設定
        • パラメーター一覧
      • スクリプト設定
        • 利用可能なフィールド
    • クエリの設定
      • 全ドキュメントの取得
      • 特定の条件でフィルタリング
    • 特定のフィールドのみ取得
      • fieldsパラメーターで取得フィールドを限定
    • 使用例
      • 基本的なインデックスのクロール
      • 認証付きクラスタからのクロール
      • 複数インデックスからのクロール
      • OpenSearchクラスタのクロール
      • フィールドを限定してクロール
      • 複数ホストでの負荷分散
    • トラブルシューティング
      • 接続エラー
      • 認証エラー
      • インデックスが見つからない
      • クエリエラー
      • スクロールタイムアウト
      • 大量データのクロール
      • メモリ不足
    • SSL/TLS接続
      • 自己署名証明書の場合
      • クライアント証明書認証
    • 高度なクエリ例
      • 集約を含むクエリ
      • スクリプトフィールド
    • 参考情報
  • Salesforceコネクタ
    • 概要
    • 対応オブジェクト
    • 前提条件
      • プラグインのインストール
    • 設定方法
      • 基本設定
      • パラメーター設定
        • パラメーター一覧
      • スクリプト設定
        • 利用可能なフィールド
    • Salesforce接続アプリケーションの設定
      • 1. 接続アプリケーションの作成
      • 2. OAuth Token認証の設定（推奨）
      • 3. OAuth Password認証の設定
      • 4. 接続アプリケーションの承認
    • カスタムオブジェクトの設定
      • カスタムオブジェクトのクロール
        • フィールドマッピングのルール
    • 使用例
      • 標準オブジェクトのクロール
      • カスタムオブジェクトのクロール
      • Sandbox環境のクロール
    • トラブルシューティング
      • 認証エラー
      • オブジェクトが取得できない
      • カスタムオブジェクトの名前
      • フィールド名の確認
      • APIレート制限
      • 大量のデータがある場合
      • 秘密鍵のフォーマットエラー
    • 参考情報
  • データベースコネクタ
    • 概要
    • 対応データベース
    • 前提条件
      • JDBCドライバーのインストール
    • 設定方法
      • 基本設定
      • パラメーター設定
        • パラメーター一覧
      • スクリプト設定
    • SQLクエリの設計
      • 効率的なクエリ
      • 差分クロール
      • URLの生成
    • マルチバイト文字対応
      • MySQL
      • PostgreSQL
    • 接続プーリング
    • セキュリティ
      • データベース認証情報の保護
      • 最小権限の原則
    • 使用例
      • 製品カタログの検索
      • ナレッジベース記事
    • トラブルシューティング
      • JDBCドライバーが見つからない
      • 接続エラー
      • クエリエラー
    • 参考情報
  • CSVコネクタ
    • 概要
    • 前提条件
      • プラグインのインストール
    • 設定方法
      • 基本設定
      • パラメーター設定
        • パラメーター一覧
      • スクリプト設定
        • 利用可能なフィールド
    • CSV形式の詳細
      • 標準CSV（RFC 4180準拠）
      • セパレーターの変更
      • カスタム引用符
      • エンコーディング
    • 使用例
      • 製品カタログのCSV
      • 社員名簿のCSV
      • ヘッダーなしのCSV
      • 複数CSVファイルの統合
      • タブ区切り（TSV）ファイル
    • トラブルシューティング
      • ファイルが見つからない
      • 文字化けが発生する
      • 列が正しく認識されない
      • ヘッダー行の扱い
      • データが取得できない
      • 大きなCSVファイル
      • 改行を含むフィールド
    • スクリプトの高度な使用例
      • データの加工
      • 条件付きインデックス
      • 複数列の結合
      • 日付のフォーマット
    • 参考情報
  • JSONコネクタ
    • 概要
    • 前提条件
      • プラグインのインストール
    • 設定方法
      • 基本設定
      • パラメーター設定
        • パラメーター一覧
      • スクリプト設定
        • 利用可能なフィールド
    • JSON形式の詳細
      • 単純な配列
      • ネストした構造
      • 複雑な配列
    • 使用例
      • 複数JSONファイルの統合
    • トラブルシューティング
      • ファイルが見つからない
      • JSON解析エラー
      • データが取得できない
      • 大きなJSONファイル
    • スクリプトの高度な使用例
      • 条件付き処理
      • 配列の結合
      • デフォルト値の設定
      • 日付のフォーマット
      • 数値の処理
    • 参考情報
• 検索機能
  • 概要
  • 検索結果件数の表示
    • デフォルトの動作
    • 正確なヒット件数の表示
  • 検索オプション
    • 基本的な検索
    • OR検索
    • NOT検索
    • フレーズ検索
    • フィールド指定検索
    • ワイルドカード検索
    • ファジー検索
  • 検索結果のソート
  • ファセット検索
  • 検索結果のハイライト
  • サジェスト機能
  • 検索ログ
  • パフォーマンスチューニング
    • 検索タイムアウトの設定
    • 検索クエリの最大文字数
    • キャッシュの利用
  • トラブルシューティング
    • 検索結果が表示されない
    • 検索速度が遅い
    • 関連性の低い結果が表示される
• 検索関連の設定
  • ファジー検索
  • 検索時のタイムアウト値
  • 検索時の最大文字数
  • 検索時のタイムアウトのログ出力
  • ヒット件数表示
  • 位置情報検索時のインデックス名
  • リクエストパラメータの言語指定
  • 前方一致検索の指定
  • ハイライトの文字列
  • ハイライトのフラグメント
  • ハイライト生成方法
  • ハイライト対象のタグ
  • OpenSearchのハイライターに渡す値
  • レスポンスに追加するフィールド名
  • フィールド名の追加
  • 検索結果をGSA互換のXML形式で取得する際の設定
• 位置情報検索
  • 概要
  • ユースケース
  • 設定方法
    • インデックス生成時の設定
      • 位置情報フィールドの定義
      • 位置情報の登録形式
      • データストアクロールでの設定例
      • スクリプトでの位置情報追加
    • 検索時の設定
      • リクエストパラメータ
      • 距離の単位
  • 検索例
    • 基本的な検索
    • 現在地周辺の検索
    • 距離によるソート
    • APIでの使用
  • フィールド名のカスタマイズ
    • デフォルトのフィールド名変更
  • 実装例
    • Webアプリケーションでの実装
    • Googleマップとの連携
  • パフォーマンス最適化
    • インデックス設定の最適化
    • 検索範囲の制限
  • トラブルシューティング
    • 位置情報検索が動作しない
    • 検索結果が返ってこない
    • 位置情報が正しく表示されない
  • 参考情報
• 検索結果の一括取得
  • 概要
  • ユースケース
  • 設定方法
    • スクロール検索の有効化
    • レスポンスフィールドの設定
  • 使用方法
    • 基本的な使用方法
    • リクエストパラメータ
    • 検索クエリの指定
    • 取得件数の指定
    • ラベルによるフィルタリング
    • 認証が必要な場合
  • レスポンス形式
    • NDJSON形式
    • レスポンスフィールド
  • データ処理例
    • Pythonでの処理例
    • ファイルへの保存
    • CSVへの変換
    • データ分析
  • パフォーマンスとベストプラクティス
    • 効率的な使用方法
    • メモリ使用量の最適化
  • セキュリティ考慮事項
    • アクセス制限
    • レート制限
  • トラブルシューティング
    • スクロール検索が利用できない
    • タイムアウトエラーが発生する
    • メモリ不足エラー
    • レスポンスが空になる
  • 参考情報
• 検索フォームの配置
  • 検索フォームの配置方法
    • 検索フォーム
    • サジェスト
• Rank Fusion設定
  • 概要
  • Rank Fusionとは
  • 対応アルゴリズム
    • RRF (Reciprocal Rank Fusion)
  • 設定
    • fess_config.properties
    • 設定プロパティ一覧
  • ハイブリッド検索との連携
  • 使用例
    • 基本的なハイブリッド検索
  • トラブルシューティング
    • 検索結果が期待と異なる
    • 検索が遅い
    • メモリ不足
  • 参考情報
• ロールベース検索の設定
  • ロールベース検索について
  • ロールベース検索の設定
    • Fess の管理画面での設定
    • ログイン
    • ログアウト
• 仮想ホスト
  • 仮想ホストについて
    • システム設定
    • クロール設定
• LDAP統合ガイド
  • 概要
  • 対応LDAPサーバー
  • 前提条件
  • 基本設定
    • LDAP接続設定
    • ユーザー検索設定
    • グループ検索設定
  • Active Directory設定
    • 基本設定
    • Active Directory固有の設定
  • OpenLDAP設定
  • セキュリティ設定
    • LDAPS（SSL/TLS）
    • パスワードの保護
  • フェイルオーバー
  • トラブルシューティング
    • 接続エラー
    • 認証エラー
    • グループが取得できない
    • デバッグ設定
  • 参考情報
• マルチテナンシー設定
  • 概要
  • 仮想ホスト機能
    • 仕組み
  • 仮想ホストの設定
    • 管理画面での設定
    • クロール設定との連携
  • アクセス制御
    • 仮想ホストとロールの組み合わせ
    • ロールベース検索
  • UIカスタマイズ
    • テーマの適用
    • カスタムCSS
    • ラベル設定
  • API認証
    • アクセストークン
    • APIリクエスト
  • DNS設定
    • 同一サーバーへのサブドメイン
    • リバースプロキシ設定
  • データ分離
    • インデックスレベルの分離
  • ベストプラクティス
  • 制限事項
  • 参考情報
• SAML認証によるSSO設定
  • 概要
    • SAML認証の仕組み
  • 前提条件
  • 基本設定
    • SSO機能の有効化
    • SP（Service Provider）設定
      • 個別URL設定
    • IdP（Identity Provider）設定
    • SPメタデータの取得
  • IdP側での設定
    • IdPから取得する情報
  • ユーザー属性マッピング
    • グループ属性の設定
    • ロール属性の設定
  • セキュリティ設定
    • 署名の設定
    • 暗号化の設定
    • その他のセキュリティ設定
  • 設定例
    • 最小構成（検証環境向け）
    • 推奨構成（本番環境向け）
  • トラブルシューティング
    • よくある問題と解決方法
      • 認証後に Fess に戻れない
      • 署名検証エラー
      • ユーザーのグループ・ロールが反映されない
    • デバッグ設定
  • 参考情報
• OpenID ConnectによるSSO設定
  • 概要
    • OpenID Connect認証の仕組み
  • 前提条件
  • 基本設定
    • SSO機能の有効化
    • プロバイダー設定
    • クライアント設定
    • リダイレクトURL設定
  • OP側での設定
    • OPから取得する情報
  • 設定例
    • 最小構成（検証環境向け）
    • 推奨構成（本番環境向け）
  • トラブルシューティング
    • よくある問題と解決方法
      • 認証後に Fess に戻れない
      • 認証エラーが発生する
      • ユーザー情報が取得できない
    • デバッグ設定
  • 参考情報
• Microsoft Entra IDによるSSO設定
  • 概要
    • Entra ID認証の仕組み
  • 前提条件
  • 基本設定
    • SSO機能の有効化
    • 必須設定
    • オプション設定
  • Entra ID側での設定
    • Azure Portalでのアプリ登録
    • クライアントシークレットの作成
    • APIアクセス許可の設定
    • 取得する情報
  • グループ・ロールマッピング
    • ネストされたグループ
    • デフォルトグループの設定
  • 設定例
    • 最小構成（検証環境向け）
    • 推奨構成（本番環境向け）
    • レガシー設定（後方互換性）
  • トラブルシューティング
    • よくある問題と解決方法
      • 認証後にFessに戻れない
      • 認証エラーが発生する
      • グループ情報が取得できない
    • デバッグ設定
  • 参考情報
• Windows統合認証によるSSO設定
  • 概要
    • Windows統合認証の仕組み
  • 前提条件
  • Active Directory側の設定
    • サービスプリンシパル名（SPN）の登録
  • 基本設定
    • SSOの有効化
    • Kerberos設定ファイル
    • ログイン設定ファイル
    • 必須設定
    • オプション設定
  • LDAP設定
  • ブラウザ設定
    • Internet Explorer / Microsoft Edge
    • Google Chrome
    • Mozilla Firefox
  • 設定例
    • 最小構成（検証用）
    • 推奨構成（本番用）
  • トラブルシューティング
    • よくある問題と解決方法
      • 認証ダイアログが表示される
      • 認証エラーが発生する
      • グループ情報が取得できない
    • デバッグ設定
  • 参考情報
• LLM統合の概要
  • 概要
  • 対応プロバイダー
  • アーキテクチャ
  • 基本設定
    • AI検索モードの有効化
    • LLMプロバイダーの選択
  • 共通設定
    • 生成パラメーター
    • コンテキスト設定
    • システムプロンプト
    • 可用性チェック
  • セッション管理
  • レート制限
  • 評価設定
  • 次のステップ
• Ollamaの設定
  • 概要
    • 主な特徴
    • 対応モデル
  • 前提条件
    • Ollamaのインストール
      • Linux/macOS
      • Windows
      • Docker
    • モデルのダウンロード
  • 基本設定
    • 最小構成
    • 推奨構成（本番環境）
  • 設定項目
  • ネットワーク構成
    • Dockerでの構成
    • リモートOllamaサーバー
  • モデルの選択ガイド
    • GPU対応
  • トラブルシューティング
    • 接続エラー
    • モデルが見つからない
    • タイムアウト
    • デバッグ設定
  • 参考情報
• OpenAIの設定
  • 概要
    • 主な特徴
    • 対応モデル
  • 前提条件
    • APIキーの取得
  • 基本設定
    • 最小構成
    • 推奨構成（本番環境）
  • 設定項目
  • 環境変数での設定
    • Docker環境
      • docker-compose.yml
    • systemd環境
  • Azure OpenAIの使用
  • モデルの選択ガイド
    • コストの目安
  • レート制限
    • OpenAIのTier別制限
  • トラブルシューティング
    • 認証エラー
    • レート制限エラー
    • クォータ超過
    • タイムアウト
    • デバッグ設定
  • セキュリティに関する注意
  • 参考情報
• Google Geminiの設定
  • 概要
    • 主な特徴
    • 対応モデル
  • 前提条件
    • APIキーの取得
  • 基本設定
    • 最小構成
    • 推奨構成（本番環境）
  • 設定項目
  • 環境変数での設定
    • Docker環境
      • docker-compose.yml
    • systemd環境
  • Vertex AI経由の使用
  • モデルの選択ガイド
    • コンテキストウィンドウ
    • コストの目安
  • レート制限
    • 無料枠の制限
  • トラブルシューティング
    • 認証エラー
    • レート制限エラー
    • リージョン制限
    • タイムアウト
    • デバッグ設定
  • セキュリティに関する注意
  • 参考情報
• AI検索モード機能の設定
  • 概要
  • AI検索モードの仕組み
  • 基本設定
  • 生成パラメーター
    • temperature設定
  • コンテキスト設定
    • コンテンツフィールド
  • システムプロンプト
    • デフォルト設定
    • カスタマイズ例
  • セッション管理
    • セッションの動作
  • レート制限
    • レート制限の考慮事項
  • APIの使用
    • 非ストリーミングAPI
    • ストリーミングAPI
  • Webインターフェース
    • チャットの開始
    • チャットの使用
    • 会話の継続
  • トラブルシューティング
    • AI検索モードが有効にならない
    • 回答の品質が低い
    • レスポンスが遅い
    • セッションが維持されない
    • デバッグ設定
  • 参考情報
• スクリプティング概要
  • 概要
  • 対応スクリプト言語
  • スクリプトの使用場面
    • データストア設定
    • パスマッピング
    • スケジュールジョブ
  • 基本的な構文
    • 変数アクセス
    • 文字列操作
    • 条件分岐
    • 日付操作
  • 利用可能なオブジェクト
  • セキュリティ
  • パフォーマンス
  • デバッグ
  • 参考情報
• Groovyスクリプトガイド
  • 概要
  • 基本構文
    • 変数宣言
    • 文字列操作
    • コレクション操作
    • 条件分岐
    • ループ処理
  • データストアスクリプト
    • 基本的なマッピング
    • URLの生成
    • コンテンツの加工
    • 日付の処理
  • スケジュールジョブスクリプト
    • クロールジョブの実行
    • 条件付きクロール
    • 複数のジョブを順番に実行
  • Javaクラスの使用
    • 日付・時刻
    • ファイル操作
    • HTTP通信
  • Fessコンポーネントへのアクセス
    • システムヘルパー
    • 設定値の取得
    • 検索の実行
  • エラーハンドリング
  • デバッグとログ出力
    • ログ出力
    • デバッグ用の出力
  • ベストプラクティス
  • 参考情報
• レート制限の設定
  • 概要
  • HTTPリクエストのレート制限
    • 設定
    • 動作
  • AI検索モードのレート制限
  • クローラーのレート制限
    • Webクロール設定
    • robots.txtの尊重
  • レート制限の全設定項目
  • 高度なレート制限設定
    • カスタムレート制限
  • 除外設定
  • 監視とアラート
    • ログ出力
  • トラブルシューティング
    • 正当なリクエストがブロックされる
    • レート制限が効かない
    • パフォーマンスへの影響
  • 参考情報
• 負荷制御の設定
  • 概要
  • HTTPリクエスト負荷制御の設定
  • 動作の仕組み
    • 監視の仕組み
    • リクエスト制御
  • 設定例
    • Web リクエストのみ制限する
    • Web と API の両方を制限する
  • レート制限との違い
  • 適応型負荷制御
    • 設定
    • 動作
  • トラブルシューティング
    • 負荷制御が有効にならない
    • 正常なリクエストが拒否される
    • クローリングが遅い
  • 参考情報
• ログ設定
  • 概要
  • ログファイルの種類
    • 主要なログファイル
    • ログファイルの場所
    • トラブルシューティング時のログ確認
  • ログレベルの設定
    • ログレベルとは
    • 推奨ログレベル
    • 管理画面からの変更
    • 設定ファイルによる変更
      • 設定ファイルの場所
      • 基本的な設定例
      • 環境変数による設定
  • クローラーログの設定
    • 管理画面での設定
      • 特定のURLパターンのみログレベルを変更
  • ログローテーション
    • 概要
    • Log4j2による自動ローテーション
      • デフォルトの設定
      • 日次ローテーションの設定
      • 圧縮設定
    • logrotateによるローテーション
  • ログ監視
    • 監視すべきログパターン
      • 重要なエラーパターン
      • 警告すべきパターン
    • リアルタイム監視
    • 監視ツールの例
    • アラート設定
  • ログフォーマット
    • デフォルトフォーマット
    • カスタムフォーマット例
      • JSON形式でログ出力
      • より詳細な情報を含める
  • パフォーマンスへの影響
    • ベストプラクティス
    • パフォーマンス測定
  • トラブルシューティング
    • ログが出力されない
    • ログファイルが大きくなりすぎる
    • 特定のログが見つからない
    • ログに文字化けが発生する
  • 参考情報
• インデックスの管理
  • 概要
  • インデックスの構成
  • インデックスのバックアップとリストア
    • スナップショットリポジトリの設定
    • スナップショットの作成(バックアップ)
      • 全インデックスのバックアップ
      • 特定のインデックスのバックアップ
      • 定期的な自動バックアップ
    • スナップショットの確認
    • スナップショットからのリストア
      • 全インデックスのリストア
      • 特定のインデックスのリストア
      • インデックス名を変更してリストア
    • スナップショットの削除
  • 設定ファイルのバックアップ
    • バックアップ対象のファイル
    • 設定ファイルのバックアップ例
  • データ移行
    • 別環境への移行手順
    • バージョンアップ時の注意事項
  • トラブルシューティング
    • スナップショットの作成に失敗する
    • リストアに失敗する
    • リストア後に検索できない
  • 参考情報
• インデックスエクスポート機能
  • 概要
  • 動作の仕組み
  • 設定プロパティ
  • ジョブの有効化
  • カスタムクエリフィルタリング
  • エクスポートされたファイル構造
  • ベストプラクティス
    • ストレージの考慮事項
    • パフォーマンスのヒント
    • セキュリティの推奨事項
  • トラブルシューティング
    • エクスポートジョブが実行されない
    • エクスポートディレクトリが空
    • エクスポートが途中で失敗する
    • ファイルにアクセスできない
  • 関連トピック
• Analyzerの設定
  • Analyzerについて
• 検索ログ可視化の設定
  • 検索ログの可視化について
    • 可視化できる情報
  • OpenSearch Dashboards によるデータ可視化の設定
    • OpenSearch Dashboards のインストール
    • 設定ファイルの編集
    • OpenSearch Dashboards の起動
    • インデックスパターンの設定
    • 可視化とダッシュボードの作成
      • 基本的な可視化の作成
      • ダッシュボードの作成
    • タイムゾーンの設定
    • ログデータの確認
    • 主な検索ログフィールド
    • トラブルシューティング
      • データが表示されない場合
      • 接続エラーが発生する場合

JavaDocs

XRef

I/F Doc

15.4

Fess インストールガイド

• はじめに
  • 本ドキュメントについて
  • 対象読者
  • お読みになる前に
  • ドキュメント構成
  • オンラインでのアクセス
  • 技術的なサポートの連絡先
    • 商用サポート
  • コメントおよび提案の送付方法
• システム要件
  • ハードウェア要件
    • 最小要件
    • 推奨要件
  • ソフトウェア要件
    • オペレーティングシステム
    • 必須ソフトウェア
      • TAR.GZ/ZIP/RPM/DEB 版
      • Docker 版
  • ネットワーク要件
    • 必要なポート
    • ファイアウォール設定
  • ブラウザー要件
  • 前提条件チェックリスト
  • 次のステップ
• インストール方法の選択
  • 前提条件の確認
  • インストール方法の比較
  • 各インストール方法の特徴
    • Docker 版
    • Linux パッケージ版 (TAR.GZ/RPM/DEB)
    • Windows 版 (ZIP)
  • インストールの基本的な流れ
  • 必要なコンポーネント
    • Fess 本体
    • OpenSearch
    • Java (Docker 版以外)
  • 次のステップ
  • よくある質問
    • Q: OpenSearch は必須ですか？
    • Q: 以前のバージョンからアップグレードできますか？
    • Q: 複数のサーバーで構成できますか？
  • ダウンロード
  • バージョン情報
• Linux へのインストール (詳細手順)
  • 前提条件
  • インストール方法の選択
  • TAR.GZ 版でのインストール
    • ステップ 1: OpenSearch のインストール
    • ステップ 2: Fess のインストール
    • ステップ 3: 起動
  • RPM 版でのインストール
    • ステップ 1: OpenSearch のインストール
    • ステップ 2: Fess のインストール
    • ステップ 3: 起動
  • DEB 版でのインストール
    • ステップ 1: OpenSearch のインストール
    • ステップ 2: Fess のインストール
    • ステップ 3: 起動
  • インストール後の確認
  • 次のステップ
  • よくある質問
    • Q: OpenSearch のバージョンは他のバージョンでも動作しますか？
    • Q: 複数の Fess インスタンスで同じ OpenSearch を共有できますか？
    • Q: OpenSearch をクラスター構成にする方法は？
• Windows へのインストール (詳細手順)
  • 前提条件
  • Java のインストール確認
  • 環境変数の設定
  • ステップ 1: OpenSearch のインストール
    • OpenSearch のダウンロード
    • OpenSearch プラグインのインストール
    • OpenSearch の設定
  • ステップ 2: Fess のインストール
    • Fess のダウンロード
    • Fess の設定
    • インストールの確認
  • ステップ 3: 起動
  • Windows サービスとしての登録（オプション）
    • NSSM を使用した例
  • ファイアウォール設定
  • トラブルシューティング
    • ポート番号の競合
    • パスの長さ制限
    • Java が認識されない
  • 次のステップ
  • よくある質問
    • Q: Windows Server での運用は推奨されますか？
    • Q: 64 ビット版と 32 ビット版の違いは？
    • Q: パスに日本語が含まれる場合の対処法は？
• Docker でのインストール (詳細)
  • 前提条件
  • Docker のインストール確認
  • Docker イメージについて
  • ステップ 1: Docker Compose ファイルの取得
    • 方法 1: ファイルを個別にダウンロード
    • 方法 2: Git でリポジトリをクローン
  • ステップ 2: Docker Compose ファイルの確認
    • compose.yaml の内容
    • compose-opensearch3.yaml の内容
    • 設定のカスタマイズ（オプション）
  • ステップ 3: Docker コンテナの起動
    • 基本的な起動
    • 起動の確認
  • ステップ 4: ブラウザーでアクセス
  • データの永続化
  • Docker コンテナの停止
  • 高度な設定
    • 環境変数のカスタマイズ
    • 設定ファイルの反映方法
      • 方法 1: 設定ファイルのマウント
      • 方法 2: システムプロパティによる設定
    • 外部の OpenSearch への接続
    • Docker ネットワークの設定
  • Docker Compose での本番運用
  • トラブルシューティング
    • コンテナが起動しない
    • メモリ不足エラー
    • データの初期化
  • 次のステップ
  • よくある質問
    • Q: Docker イメージのサイズはどのくらいですか？
    • Q: Kubernetes での運用は可能ですか？
    • Q: コンテナのアップデートはどのように行いますか？
    • Q: マルチノード構成は可能ですか？
• 起動、停止、初期設定
  • 起動方法
    • TAR.GZ 版の場合
      • OpenSearch の起動
      • Fess の起動
    • ZIP 版の場合（Windows）
      • OpenSearch の起動
      • Fess の起動
    • RPM/DEB 版の場合 (chkconfig)
    • RPM/DEB 版の場合 (systemd)
    • Docker 版の場合
  • 起動の確認
    • ヘルスチェック
    • ログの確認
  • ブラウザーでのアクセス
    • 検索画面
    • 管理画面
  • 初回セットアップ
    • ステップ 1: 管理者パスワードの変更
    • ステップ 2: クロール設定の作成
    • ステップ 3: クロールの実行
    • ステップ 4: 検索の確認
  • その他の推奨設定
    • メールサーバーの設定
    • タイムゾーンの設定
    • ログレベルの調整
  • 停止方法
    • TAR.GZ/ZIP 版の場合
      • Fess の停止
    • RPM/DEB 版の場合 (chkconfig)
    • RPM/DEB 版の場合 (systemd)
    • Docker 版の場合
  • 再起動方法
    • TAR.GZ/ZIP 版の場合
    • RPM/DEB 版の場合
    • Docker 版の場合
  • トラブルシューティング
    • 起動しない場合
  • 次のステップ
• セキュリティ設定
  • 必須のセキュリティ設定
    • 管理者パスワードの変更
    • OpenSearch のセキュリティプラグイン有効化
    • HTTPS の有効化
  • 推奨のセキュリティ設定
    • ファイアウォール設定
    • アクセス制御の設定
    • ロールベースアクセス制御 (RBAC)
    • 監査ログの有効化
    • 定期的なセキュリティアップデート
  • データ保護
    • バックアップの暗号化
  • セキュリティベストプラクティス
    • 最小権限の原則
    • ネットワーク分離
    • 定期的なセキュリティ監査
    • セキュリティヘッダーの設定
  • セキュリティチェックリスト
    • 基本設定
    • ネットワークセキュリティ
    • アクセス制御
    • 監視とログ
    • バックアップとリカバリ
    • アップデートとパッチ管理
  • セキュリティインシデント対応
  • 参考情報
• アップグレード手順
  • 対応バージョン
  • アップグレード前の準備
    • バージョン互換性の確認
    • ダウンタイムの計画
  • ステップ 1: データのバックアップ
    • 設定データのバックアップ
    • インデックスデータのバックアップ
      • 方法 1: スナップショット機能を使用（推奨）
      • 方法 2: ディレクトリごとバックアップ
    • Docker 版のバックアップ
  • ステップ 2: 現在のバージョンの停止
  • ステップ 3: 新しいバージョンのインストール
    • TAR.GZ/ZIP 版
    • RPM/DEB 版
    • Docker 版
  • ステップ 4: OpenSearch のアップグレード（必要な場合）
  • ステップ 5: 新しいバージョンの起動
  • ステップ 6: 動作確認
  • ステップ 7: インデックスの再作成（推奨）
  • ロールバック手順
    • ステップ 1: 新しいバージョンの停止
    • ステップ 2: 古いバージョンの復元
    • ステップ 3: データの復元
    • ステップ 4: サービスの起動と確認
  • よくある質問
    • Q: ダウンタイムなしでアップグレードできますか？
    • Q: OpenSearch もアップグレードする必要がありますか？
    • Q: インデックスを再作成する必要がありますか？
    • Q: アップグレード後、検索結果が表示されません
  • 次のステップ
• アンインストール手順
  • アンインストール前の準備
    • バックアップの取得
    • サービスの停止
  • TAR.GZ/ZIP 版のアンインストール
    • ステップ 1: Fess の削除
    • ステップ 2: OpenSearch の削除
    • ステップ 3: データディレクトリの削除（オプション）
    • ステップ 4: ログディレクトリの削除（オプション）
  • RPM 版のアンインストール
    • ステップ 1: Fess のアンインストール
    • ステップ 2: OpenSearch のアンインストール
    • ステップ 3: サービスの無効化と削除
    • ステップ 4: データディレクトリの削除
    • ステップ 5: 設定ファイルの削除
    • ステップ 6: ログファイルの削除
    • ステップ 7: ユーザーとグループの削除（オプション）
  • DEB 版のアンインストール
    • ステップ 1: Fess のアンインストール
    • ステップ 2: OpenSearch のアンインストール
    • ステップ 3: サービスの無効化
    • ステップ 4: データディレクトリの削除
    • ステップ 5: 設定ファイルの削除（dpkg -P を使用しなかった場合）
    • ステップ 6: ログファイルの削除
    • ステップ 7: ユーザーとグループの削除（オプション）
  • Docker 版のアンインストール
    • ステップ 1: コンテナとネットワークの削除
    • ステップ 2: ボリュームの削除
    • ステップ 3: イメージの削除（オプション）
    • ステップ 4: ネットワークの削除（オプション）
    • ステップ 5: Compose ファイルの削除
  • アンインストールの確認
    • プロセスの確認
    • ポートの確認
    • ファイルの確認
    • パッケージの確認
  • 部分的なアンインストール
    • Fess のみを削除して OpenSearch を残す
    • OpenSearch のみを削除して Fess を残す
  • トラブルシューティング
    • パッケージが削除できない
    • ディレクトリが削除できない
  • 再インストールの準備
  • 次のステップ
• トラブルシューティング
  • インストール時の問題
    • Java が認識されない
    • プラグインのインストールに失敗する
  • 起動時の問題
    • Fess が起動しない
    • OpenSearch が起動しない
    • ポート番号の競合
  • 接続の問題
    • Fess が OpenSearch に接続できない
    • ブラウザーから Fess にアクセスできない
  • パフォーマンスの問題
    • 検索が遅い
    • クロールが遅い
  • データの問題
    • 検索結果が表示されない
    • インデックスが破損している
  • Docker 固有の問題
    • コンテナが起動しない
    • コンテナは起動するが Fess にアクセスできない
  • Windows 固有の問題
    • パスの問題
    • サービスとして登録できない
  • その他の問題
    • ログレベルの変更
    • データベースのリセット
  • サポート情報
    • コミュニティサポート
    • 商用サポート
  • デバッグ情報の収集

Fess ユーザーガイド

• はじめに
  • 対象読者
  • お読みになる前に
  • オンラインでのアクセス
  • 技術的なサポートの連絡先
    • 商用サポート
  • 関連サードパーティー Web サイトの参照
  • コメントおよび提案の送付方法
• AND 検索
  • 利用方法
• OR 検索
  • 利用方法
• NOT 検索
  • 利用方法
• ラベル指定検索
  • ラベル指定検索 (カテゴリ検索)
    • 利用方法
• 検索フィールド指定検索
  • フィールド指定検索
    • 利用可能なフィールド
    • 利用方法
• ソート検索
  • ソート対象フィールド
  • 利用方法
• ワイルドカード検索
  • 利用方法
  • 利用条件
• 範囲指定検索
  • 利用方法
• ブースト検索
  • ブースト検索(重み付け検索)
    • 利用方法
• 曖昧検索
  • 曖昧検索(ファジー検索)
    • 利用方法
• 位置情報検索
  • 利用方法
• 非表示検索条件
  • 利用方法
• ロール検索
  • 検索方法
  • パスワードの変更
  • ログアウト
• 特殊文字
  • 利用方法
• 詳細検索
  • 利用方法
  • 項目一覧
    • すべての単語を含む
    • 語順も含めた完全一致
    • いずれかの単語を含む
    • 含めない単語
    • 表示件数
    • ソート
    • 優先する言語
    • ラベル
    • 更新日時
    • ファイル形式
    • 検索対象
    • サイトまたはドメイン

Fess APIガイド

• はじめに
  • 対象読者
  • お読みになる前に
  • API利用の前提条件
  • オンラインでのアクセス
  • 技術的なサポートの連絡先
    • 商用サポート
  • 関連サードパーティー Web サイトの参照
  • コメントおよび提案の送付方法
• APIの概要
  • Fess の提供するAPI
  • ベースURL
  • 認証
  • HTTPメソッド
  • レスポンスフォーマット
  • エラーハンドリング
  • APIの種類
• 検索API
  • 検索結果の取得
    • リクエスト
    • リクエストパラメーター
    • レスポンス
  • 全てのドキュメントを検索
    • リクエストパラメーター
  • エラーレスポンス
• ラベルAPI
  • ラベルの取得
    • リクエスト
    • リクエストパラメーター
    • レスポンス
  • 使用例
  • エラーレスポンス
• 人気ワードAPI
  • 人気ワード一覧の取得
    • リクエスト
    • リクエストパラメーター
    • レスポンス
  • エラーレスポンス
• サジェストAPI
  • サジェストワード一覧の取得
    • リクエスト
    • リクエストパラメーター
    • レスポンス
  • エラーレスポンス
• Health API
  • 状態の取得
    • リクエスト
    • リクエストパラメーター
    • レスポンス
  • エラーレスポンス

Fess 管理者ガイド

• はじめに
  • 対象読者
  • お読みになる前に
  • オンラインでのアクセス
  • 技術的なサポートの連絡先
    • 商用サポート
• ダッシュボード
  • 概要
  • インデックスされているドキュメント数の確認
• 構成ウィザード
  • 概要
    • 簡易セットアップ
    • クロールの設定
    • 設定項目
      • 名前
      • クロールパス
      • 最大アクセス数
      • 深さ
    • クローラ
• 全般
  • 概要
  • 設定内容
    • システム
      • JSONレスポンス
      • ログインが必要
      • ログインリンク表示
      • 重複結果の折り畳み
      • サムネイル表示
      • デフォルトのラベル値
      • デフォルトのソート値
      • 仮想ホスト
      • 人気ワードのレスポンス
      • CSVファイルのエンコード
      • 検索パラメーターの追加
      • 通知メール
    • クローラー
      • 最終更新日時の確認
      • 同時クローラー設定
      • 以前のドキュメントを削除
      • 除外するエラーの種類
      • 障害数のしきい値
    • ロギング
      • 検索ログ
      • ユーザログ
      • お気に入りログ
      • 以前の検索ログを削除
      • 以前のジョブログを削除
      • 以前のユーザーログを削除
      • ログを削除するボット名
      • ログレベル
    • サジェスト
      • 検索語でサジェスト
      • ドキュメントでサジェスト
      • 以前のサジェスト情報を削除
    • LDAP
      • LDAP URL
      • Base DN
      • Bind DN
      • パスワード
      • User DN
      • アカウントフィルター
      • グループフィルター
      • memberOf属性
    • お知らせ表示
      • ログインページ
      • 検索トップページ
    • ストレージ
      • タイプ
      • バケット
      • エンドポイント
      • アクセスキー
      • シークレットキー
      • リージョン
      • プロジェクトID
      • 認証情報パス
  • 例
    • LDAPの設定例
• スケジューラ
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
      • 対象
      • スケジュール
      • 実行方法
      • スクリプト
      • ロギング
      • クローラージョブ
      • 状態
      • 表示順序
    • 設定の削除
  • 手動クロール方法
• ページのデザイン
  • 概要
  • 設定方法
    • 表示方法
    • ファイルマネージャー
    • ページファイルの表示
    • アップロードするファイル
      • ファイルのアップロード
      • ファイル名(オプション)
• 辞書
  • 概要
  • 一覧
  • Kuromoji
  • 同義語
  • マッピング
  • Protwords
  • ストップワード
  • Stemmer上書き
• Kuromoji辞書
  • 概要
  • 管理方法
    • 表示方法
    • 設定方法
    • 設定項目
      • トークン
      • 分割
      • 読み
      • 品詞
  • ダウンロード
  • アップロード
• 同義語辞書
  • 概要
  • 管理方法
    • 表示方法
    • 設定方法
    • 設定項目
      • 変換元
      • 変換後
  • ダウンロード
  • アップロード
• マッピング辞書
  • 概要
  • 管理方法
    • 表示方法
    • 設定方法
    • 設定項目
      • 変換元
      • 変換後
  • ダウンロード
  • アップロード
• Protwords辞書
  • 概要
  • 管理方法
    • 表示方法
    • 設定方法
    • 設定項目
      • 単語情報
  • ダウンロード
  • アップロード
• ストップワード辞書
  • 概要
  • 管理方法
    • 表示方法
    • 設定方法
    • 設定項目
      • 変換元
      • 変換後
  • ダウンロード
  • アップロード
• Stemmer上書き辞書
  • 概要
  • 管理方法
    • 表示方法
    • 設定方法
    • 設定項目
      • 変換元
      • 変換後
  • ダウンロード
  • アップロード
• アクセストークン
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
      • パーミッション
      • パラメーター名
      • 有効期限
    • 設定の削除
• プラグイン
  • 概要
  • 管理方法
    • 表示方法
    • インストール
• ストレージ
  • 概要
  • 管理方法
    • オブジェクトストレージサーバーの設定
      • 共通設定
      • S3の設定
      • GCSの設定
      • MinIO（S3互換）の設定
    • 表示方法
    • ダウンロード
    • 削除
    • アップロード
    • フォルダーの作成
• ウェブクロール
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
      • URL
      • クロール対象とするURL
      • クロール対象から除外するURL
      • 検索対象とするURL
      • 検索対象から除外するURL
      • 設定パラメーター
      • 深さ
      • 最大アクセス数
      • ユーザーエージェント
      • スレッド数
      • 間隔
      • ブースト値
      • パーミッション
      • 仮想ホスト
      • 状態
      • 説明
    • 設定の削除
  • 例
    • fess.codelibs.org をクロールする
    • ウェブ認証サイトのウェブクロール
      • Redmine
      • XWiki
• ファイルクロール
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
      • パス
      • クロール対象とするパス
      • クロール対象から除外するパス
      • 検索対象とするパス
      • 検索対象から除外するパス
      • 設定パラメーター
      • 深さ
      • 最大アクセス数
      • スレッド数
      • 間隔
      • ブースト値
      • パーミッション
      • 仮想ホスト
      • 状態
      • 説明
    • 設定の削除
  • 例
    • ローカルファイルをクロール
    • Windowsの共有フォルダーをクロール
    • Amazon S3バケットをクロール
    • Google Cloud Storageバケットをクロール
• データストアクロール
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
      • ハンドラー名
      • パラメーター
      • スクリプト
      • ブースト値
      • パーミッション
      • 仮想ホスト
      • 状態
      • 説明
    • 設定の削除
  • 例
    • DatabaseDataStore
      • パラメーター
      • スクリプト
      • ドライバー
    • CsvDataStore
      • パラメーター
      • スクリプト
    • EsDataStore
      • パラメーター
      • スクリプト
    • CsvListDataStore
      • パラメーター
      • スクリプト
• ラベル
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
      • 値
      • 対象とするパス
      • 除外するパス
      • パーミッション
      • 仮想ホスト
      • 表示順序
    • 設定の削除
• キーマッチ
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 検索語
      • クエリー
      • サイズ
      • ブースト値
      • 仮想ホスト
    • 設定の削除
• ドキュメントブースト
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 条件
      • ブースト値式
      • ソート順
    • 設定の削除
• 関連コンテンツ
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 検索語
      • コンテンツ
      • 仮想ホスト
    • 設定の削除
• 関連クエリー
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 検索語
      • クエリー
      • 仮想ホスト
    • 設定の削除
• パスマッピング
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 正規表現
      • 置換
      • 処理の種類
      • 表示順序
      • ユーザーエージェント
    • 設定の削除
  • 例
    • ファイルサーバーをWebサーバー経由でアクセス
    • 表示時のみURLを変換
    • サーバー移行時のリンク変換
  • 注意事項
    • 抽出URL変換について
    • 正規表現について
    • ソート順について
• ウェブ認証
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • ホスト名
      • ポート
      • レルム
      • スキーム
      • ユーザー名
      • パスワード
      • パラメーター
      • ウェブ設定
    • 設定の削除
• ファイル認証
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • ホスト名
      • ポート
      • スキーム
      • ユーザー名
      • パスワード
      • パラメーター
      • ファイルクロール設定
    • 設定の削除
• リクエストヘッダー
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
      • 値
      • ウェブ設定
    • 設定の削除
• 重複ホスト
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 正規名
      • 重複名
    • 設定の削除
• ユーザー
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • ユーザー名
      • ロール
      • グループ
    • 設定の削除
• ロール
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
    • 設定の削除
• グループ
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
    • 削除の方法
• サジェストワード
  • 概要
  • 管理方法
    • 表示方法
      • 単語種別
      • 単語数
• 追加ワード
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 単語
      • 読み
      • パーミッション
      • ラベル
      • ブースト値
    • 設定の削除
  • ダウンロード
    • CSVの内容
  • アップロード
    • CSVの内容
• 除外ワード
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • サジェスト候補
    • 設定の削除
  • ダウンロード
    • CSVの内容
  • アップロード
    • CSVの内容
• システム情報
  • 概要
  • 管理方法
    • 表示方法
    • 表示項目
      • 環境変数のプロパティ
      • システムのプロパティ
      • アプリのプロパティ
      • バグレポートのプロパティ
• 検索ログ
  • 概要
  • 管理方法
  • 一覧
  • 詳細
• ジョブログ
  • 概要
  • 管理方法
    • 表示方法
    • ジョブログ詳細
      • 名前
      • 状態
      • 対象
      • 開始時間
      • 終了時間
      • 実行方法
      • スクリプト
      • 結果
• クロール情報
  • 概要
  • 管理方法
  • 一覧
  • 詳細
    • 項目一覧
      • セッションID
      • クローラーの開始時間
      • クロールの開始時間 (ウェブ/ファイル)
      • クロールの開始時間 (データストア)
      • クロールの終了時間 (ウェブ/ファイル)
      • クロールの実行時間 (データストア)
      • インデクシングの実行時間 (データストア)
      • インデックスのサイズ (データストア)
      • クロールの終了時間 (データストア)
      • クローラーの状態
      • クローラーの終了時間
      • クローラーの実行時間
• ログファイル
  • 概要
  • 設定方法
    • 表示方法
    • ダウンロード
      • server_*.log
      • fess.log
      • fess-crawler.log
      • audit.log
      • fess-thumbnail.log
      • fess-suggest.log
      • fess-urls.log
      • search.log
      • gc-crawler.log
• 障害URL
  • 概要
  • 管理方法
    • 表示方法
  • 障害URLの詳細
    • 詳細の内容
      • URL
      • スレッド名
      • 種類
      • ログ
      • エラー回数
      • 最終アクセス日時
• 検索
  • 概要
  • 管理方法
    • 表示方法
    • 検索一覧
    • 一括削除
• バックアップ
  • 概要
    • ダウンロード
      • fess_config.bulk
      • fess_basic_config.bulk
      • fess_user.bulk
      • system.properties
      • fess.json
      • doc.json
      • click_log.ndjson
      • favorite_log.ndjson
      • search_log.ndjson
      • user_info.ndjson
    • アップロード
• メンテナンス
  • 概要
  • 操作方法
    • 再インデクシング
    • 設定項目
      • エイリアスの更新
      • 辞書の初期化
      • シャード数
      • 最大レプリカ数
    • ドキュメントインデックスのリロード
    • Crawlerインデックス
    • 診断
• クエリーリクエスト
  • 概要
  • 操作方法
    • リクエストの送信
    • 設定項目
      • リクエストファイル

Fess 設定ガイド

• はじめに
  • 対象読者
  • お読みになる前に
  • オンラインでのアクセス
  • 技術的なサポートの連絡先
    • 商用サポート
  • 関連サードパーティー Web サイトの参照
  • コメントおよび提案の送付方法
• ポートとネットワーク設定
  • 概要
  • 使用ポートの設定
    • デフォルトポート
    • Fess ウェブアプリケーションのポート変更
      • Linux環境での設定
      • 環境変数による設定
      • RPM/DEBパッケージの場合
      • Windows環境での設定
      • Windowsサービスとして登録する場合
    • コンテキストパスの設定
  • プロキシ設定
    • 概要
    • クローラー用プロキシの設定
      • 基本設定
      • 認証が必要なプロキシの設定
      • 特定のホストをプロキシから除外
    • システム全体のHTTPプロキシ設定
      • 環境変数によるプロキシ設定
  • HTTP通信設定
    • ファイルアップロードの制限
    • 接続タイムアウト設定
    • OpenSearchの接続先変更
      • 複数ノードへの接続
    • SSL/TLS接続の設定
  • 仮想ホスト設定
    • 概要
    • 基本設定
  • リバースプロキシとの連携
    • Nginx の設定例
    • Apache の設定例
    • SSL/TLS終端
  • ファイアウォール設定
    • 必要なポートの開放
    • セキュリティグループの設定(クラウド環境)
  • トラブルシューティング
    • ポート変更後にアクセスできない
    • プロキシ経由でクロールできない
    • OpenSearchに接続できない
    • リバースプロキシ経由でアクセスすると正常に動作しない
  • 参考情報
• メモリ設定
  • 概要
  • Fess ウェブアプリケーションのメモリ設定
    • 設定が必要な場合
    • 環境変数による設定
    • RPM/DEBパッケージの場合
    • 推奨メモリサイズ
  • クローラーのメモリ設定
    • 設定が必要な場合
    • 設定方法
    • 推奨設定
    • 詳細なJVMオプション
  • OpenSearch のメモリ設定
    • 重要な考慮事項
    • 設定方法
      • Linux環境
      • Windows環境
    • 推奨メモリサイズ
    • ベストプラクティス
  • サジェスト・サムネイル処理のメモリ設定
    • サジェスト生成プロセス
    • サムネイル生成プロセス
  • メモリ監視とチューニング
    • メモリ使用状況の確認
      • Fess のメモリ使用状況
      • OpenSearchのメモリ使用状況
    • メモリ不足の兆候
    • チューニング手順
    • メモリリーク対策
  • トラブルシューティング
    • OutOfMemoryError が発生する
    • GCによる停止時間が長い
    • メモリ設定後も性能が改善しない
  • 参考情報
• Windowsサービスへの登録
  • Windowsサービスとしての登録
    • 事前準備
    • OpenSearchをサービスとして登録
    • 設定
    • 登録方法
    • サービスの設定
• クローラー基本設定
  • 概要
  • クローラーの基本概念
    • クローラーとは
    • クローラーの種類
  • クロール設定の作成
    • 基本的なクロール設定の追加
    • Webクローラーの設定例
      • 社内イントラネットサイトのクロール
      • 公開Webサイトのクロール
    • ファイルクローラーの設定例
      • ローカルファイルシステム
      • SMB/CIFS(Windowsファイル共有)
    • 認証情報の設定
  • クロールの実行
    • 手動実行
    • スケジュール実行
    • クロール状況の確認
  • 基本的な設定項目
    • クロール対象の制限
      • URLパターンによる制限
      • 深さの制限
      • 最大アクセス数
    • 並列クロール数(スレッド数)
    • クロール間隔
  • ファイルサイズの設定
    • 取得するファイルサイズの上限
    • インデックスするファイルサイズの上限
  • 単語の長さ制限
    • 概要
    • 設定方法
  • プロキシの設定
    • 概要
    • 設定方法
    • システム全体のプロキシ設定
  • robots.txt の設定
    • 概要
    • 設定方法
  • User-Agent の設定
    • 管理画面での設定
    • システム全体の設定
  • エンコーディング設定
    • クロールデータのエンコーディング
    • ファイル名のエンコーディング
  • クロールのトラブルシューティング
    • クロールが開始されない
    • クロールが途中で停止する
    • 特定のページがクロールされない
    • クロールが遅い
  • ベストプラクティス
    • クロール設定の推奨事項
    • スケジュール設定の推奨事項
  • 参考情報
• クローラー詳細設定
  • 概要
  • 全般設定
    • 設定ファイルの場所
    • デフォルトスクリプト
    • HTTPスレッドプール
  • ドキュメント処理設定
    • 基本設定
      • 設定例
    • 単語処理設定
      • 設定例
    • 文字処理設定
      • 設定例
  • プロトコル設定
    • 対応プロトコル
      • 設定例
    • 環境変数パラメーター
  • robots.txt 設定
  • エラー処理設定
  • システム監視設定
    • ホットスレッド設定
      • 設定例
  • メタデータ設定
  • HTML クローラー設定
    • XPath 設定
      • 設定例
      • カスタム XPath の例
    • HTML タグ処理
      • 設定例
    • URLパターンフィルター
      • 設定例
  • ファイルクローラー設定
    • 基本設定
      • 設定例
    • コンテンツ処理
      • 設定例
    • ファイルURLパターンフィルター
      • 設定例
  • キャッシュ設定
    • ドキュメントキャッシュ
      • 設定例
  • JVM オプション
    • デフォルト設定
    • 主要なオプションの説明
    • カスタム設定例
  • パフォーマンスチューニング
    • クロール速度の最適化
    • メモリ使用量の最適化
    • インデックス品質の向上
  • トラブルシューティング
    • メモリ不足
    • クロールが遅い
    • 特定のコンテンツが抽出できない
    • 文字化けが発生する
  • ベストプラクティス
  • S3/GCSクローラー設定
    • S3クローラー
      • 設定例
    • GCSクローラー
      • 設定例
  • 参考情報
• サムネイル画像の設定
  • 概要
  • サポートしているファイル形式
    • 画像ファイル
    • ドキュメントファイル
    • HTMLコンテンツ
  • 必要な外部ツール
    • 基本ツール（必須）
    • SVGサポート
    • PDFサポート
    • MS Officeサポート
    • PostScriptサポート
  • HTMLファイルのサムネイル画像
  • 設定
    • 設定ファイル
    • 主な設定項目（fess_config.properties）
  • generate-thumbnail スクリプト
    • 概要
    • 使用方法
    • 引数
    • サポートするタイプ
    • 使用例
  • サムネイル保存先
    • デフォルトパス
    • ディレクトリ構造
  • サムネイルジョブの無効化
  • トラブルシューティング
    • サムネイルが生成されない
    • GIF/TIFFでエラーが発生する
    • SVGのサムネイルが生成されない
    • 権限エラー
  • プラットフォーム対応
• 検索機能
  • 概要
  • 検索結果件数の表示
    • デフォルトの動作
    • 正確なヒット件数の表示
  • 検索オプション
    • 基本的な検索
    • OR検索
    • NOT検索
    • フレーズ検索
    • フィールド指定検索
    • ワイルドカード検索
    • ファジー検索
  • 検索結果のソート
  • ファセット検索
  • 検索結果のハイライト
  • サジェスト機能
  • 検索ログ
  • パフォーマンスチューニング
    • 検索タイムアウトの設定
    • 検索クエリの最大文字数
    • キャッシュの利用
  • トラブルシューティング
    • 検索結果が表示されない
    • 検索速度が遅い
    • 関連性の低い結果が表示される
• 検索関連の設定
  • ファジー検索
  • 検索時のタイムアウト値
  • 検索時の最大文字数
  • 検索時のタイムアウトのログ出力
  • ヒット件数表示
  • 位置情報検索時のインデックス名
  • リクエストパラメータの言語指定
  • 前方一致検索の指定
  • ハイライトの文字列
  • ハイライトのフラグメント
  • ハイライト生成方法
  • ハイライト対象のタグ
  • OpenSearchのハイライターに渡す値
  • レスポンスに追加するフィールド名
  • フィールド名の追加
  • 検索結果をGSA互換のXML形式で取得する際の設定
• 位置情報検索
  • 概要
  • ユースケース
  • 設定方法
    • インデックス生成時の設定
      • 位置情報フィールドの定義
      • 位置情報の登録形式
      • データストアクロールでの設定例
      • スクリプトでの位置情報追加
    • 検索時の設定
      • リクエストパラメータ
      • 距離の単位
  • 検索例
    • 基本的な検索
    • 現在地周辺の検索
    • 距離によるソート
    • APIでの使用
  • フィールド名のカスタマイズ
    • デフォルトのフィールド名変更
  • 実装例
    • Webアプリケーションでの実装
    • Googleマップとの連携
  • パフォーマンス最適化
    • インデックス設定の最適化
    • 検索範囲の制限
  • トラブルシューティング
    • 位置情報検索が動作しない
    • 検索結果が返ってこない
    • 位置情報が正しく表示されない
  • 参考情報
• 検索結果の一括取得
  • 概要
  • ユースケース
  • 設定方法
    • スクロール検索の有効化
    • レスポンスフィールドの設定
    • スクロールのタイムアウト設定
  • 使用方法
    • 基本的な使用方法
    • リクエストパラメータ
    • 検索クエリの指定
    • 取得件数の指定
    • ラベルによるフィルタリング
    • 認証が必要な場合
  • レスポンス形式
    • NDJSON形式
    • レスポンスフィールド
  • データ処理例
    • Pythonでの処理例
    • ファイルへの保存
    • CSVへの変換
    • データ分析
  • パフォーマンスとベストプラクティス
    • 効率的な使用方法
    • メモリ使用量の最適化
  • セキュリティ考慮事項
    • アクセス制限
    • レート制限
  • トラブルシューティング
    • スクロール検索が利用できない
    • タイムアウトエラーが発生する
    • メモリ不足エラー
    • レスポンスが空になる
  • 参考情報
• 検索フォームの配置
  • 検索フォームの配置方法
    • 検索フォーム
    • サジェスト
• ロールベース検索の設定
  • ロールベース検索について
  • ロールベース検索の設定
    • Fess の管理画面での設定
    • ログイン
    • ログアウト
• 仮想ホスト
  • 仮想ホストについて
    • システム設定
    • クロール設定
• SAML認証によるSSO設定
  • 概要
    • SAML認証の仕組み
  • 前提条件
  • 基本設定
    • SSO機能の有効化
    • SP（Service Provider）設定
      • 個別URL設定
    • IdP（Identity Provider）設定
    • SPメタデータの取得
  • IdP側での設定
    • IdPから取得する情報
  • ユーザー属性マッピング
    • グループ属性の設定
    • ロール属性の設定
  • セキュリティ設定
    • 署名の設定
    • 暗号化の設定
    • その他のセキュリティ設定
  • 設定例
    • 最小構成（検証環境向け）
    • 推奨構成（本番環境向け）
  • トラブルシューティング
    • よくある問題と解決方法
      • 認証後に Fess に戻れない
      • 署名検証エラー
      • ユーザーのグループ・ロールが反映されない
    • デバッグ設定
  • 参考情報
• OpenID ConnectによるSSO設定
  • 概要
    • OpenID Connect認証の仕組み
  • 前提条件
  • 基本設定
    • SSO機能の有効化
    • プロバイダー設定
    • クライアント設定
    • リダイレクトURL設定
  • OP側での設定
    • OPから取得する情報
  • 設定例
    • 最小構成（検証環境向け）
    • 推奨構成（本番環境向け）
  • トラブルシューティング
    • よくある問題と解決方法
      • 認証後に Fess に戻れない
      • 認証エラーが発生する
      • ユーザー情報が取得できない
    • デバッグ設定
  • 参考情報
• Microsoft Entra IDによるSSO設定
  • 概要
    • Entra ID認証の仕組み
  • 前提条件
  • 基本設定
    • SSO機能の有効化
    • 必須設定
    • オプション設定
  • Entra ID側での設定
    • Azure Portalでのアプリ登録
    • クライアントシークレットの作成
    • APIアクセス許可の設定
    • 取得する情報
  • グループ・ロールマッピング
    • ネストされたグループ
    • デフォルトグループの設定
  • 設定例
    • 最小構成（検証環境向け）
    • 推奨構成（本番環境向け）
    • レガシー設定（後方互換性）
  • トラブルシューティング
    • よくある問題と解決方法
      • 認証後にFessに戻れない
      • 認証エラーが発生する
      • グループ情報が取得できない
    • デバッグ設定
  • 参考情報
• Windows統合認証によるSSO設定
  • 概要
    • Windows統合認証の仕組み
  • 前提条件
  • Active Directory側の設定
    • サービスプリンシパル名（SPN）の登録
  • 基本設定
    • SSOの有効化
    • Kerberos設定ファイル
    • ログイン設定ファイル
    • 必須設定
    • オプション設定
  • LDAP設定
  • ブラウザ設定
    • Internet Explorer / Microsoft Edge
    • Google Chrome
    • Mozilla Firefox
  • 設定例
    • 最小構成（検証用）
    • 推奨構成（本番用）
  • トラブルシューティング
    • よくある問題と解決方法
      • 認証ダイアログが表示される
      • 認証エラーが発生する
      • グループ情報が取得できない
    • デバッグ設定
  • 参考情報
• ログ設定
  • 概要
  • ログファイルの種類
    • 主要なログファイル
    • ログファイルの場所
    • トラブルシューティング時のログ確認
  • ログレベルの設定
    • ログレベルとは
    • 推奨ログレベル
    • 管理画面からの変更
    • 設定ファイルによる変更
      • 設定ファイルの場所
      • 基本的な設定例
      • 環境変数による設定
  • クローラーログの設定
    • 管理画面での設定
      • 特定のURLパターンのみログレベルを変更
      • クローラープロセス全体のログレベル変更
  • ログローテーション
    • 概要
    • Log4j2による自動ローテーション
      • デフォルトの設定
      • 日次ローテーションの設定
      • 圧縮設定
    • logrotateによるローテーション
  • ログ監視
    • 監視すべきログパターン
      • 重要なエラーパターン
      • 警告すべきパターン
    • リアルタイム監視
    • 監視ツールの例
    • アラート設定
  • ログフォーマット
    • デフォルトフォーマット
    • カスタムフォーマット例
      • JSON形式でログ出力
      • より詳細な情報を含める
  • パフォーマンスへの影響
    • ベストプラクティス
    • パフォーマンス測定
  • トラブルシューティング
    • ログが出力されない
    • ログファイルが大きくなりすぎる
    • 特定のログが見つからない
    • ログに文字化けが発生する
  • 参考情報
• インデックスの管理
  • 概要
  • インデックスの構成
  • インデックスのバックアップとリストア
    • スナップショットリポジトリの設定
    • スナップショットの作成(バックアップ)
      • 全インデックスのバックアップ
      • 特定のインデックスのバックアップ
      • 定期的な自動バックアップ
    • スナップショットの確認
    • スナップショットからのリストア
      • 全インデックスのリストア
      • 特定のインデックスのリストア
      • インデックス名を変更してリストア
    • スナップショットの削除
  • 設定ファイルのバックアップ
    • バックアップ対象のファイル
    • 設定ファイルのバックアップ例
  • データ移行
    • 別環境への移行手順
    • バージョンアップ時の注意事項
  • トラブルシューティング
    • スナップショットの作成に失敗する
    • リストアに失敗する
    • リストア後に検索できない
  • 参考情報
• Analyzerの設定
  • Analyzerについて
• 検索ログ可視化の設定
  • 検索ログの可視化について
    • 可視化できる情報
  • OpenSearch Dashboards によるデータ可視化の設定
    • OpenSearch Dashboards のインストール
    • 設定ファイルの編集
    • OpenSearch Dashboards の起動
    • インデックスパターンの設定
    • 可視化とダッシュボードの作成
      • 基本的な可視化の作成
      • ダッシュボードの作成
    • タイムゾーンの設定
    • ログデータの確認
    • 主な検索ログフィールド
    • トラブルシューティング
      • データが表示されない場合
      • 接続エラーが発生する場合

JavaDocs

XRef

I/F Doc

15.3

Fess インストールガイド

• はじめに
  • 本ドキュメントについて
  • 対象読者
  • お読みになる前に
  • ドキュメント構成
  • オンラインでのアクセス
  • 技術的なサポートの連絡先
    • 商用サポート
  • コメントおよび提案の送付方法
• システム要件
  • ハードウェア要件
    • 最小要件
    • 推奨要件
  • ソフトウェア要件
    • オペレーティングシステム
    • 必須ソフトウェア
      • TAR.GZ/ZIP/RPM/DEB 版
      • Docker 版
  • ネットワーク要件
    • 必要なポート
    • ファイアウォール設定
  • ブラウザー要件
  • 前提条件チェックリスト
  • 次のステップ
• インストール方法の選択
  • 前提条件の確認
  • インストール方法の比較
  • 各インストール方法の特徴
    • Docker 版
    • Linux パッケージ版 (TAR.GZ/RPM/DEB)
    • Windows 版 (ZIP)
  • インストールの基本的な流れ
  • 必要なコンポーネント
    • Fess 本体
    • OpenSearch
    • Java (Docker 版以外)
  • 次のステップ
  • よくある質問
    • Q: OpenSearch は必須ですか？
    • Q: 以前のバージョンからアップグレードできますか？
    • Q: 複数のサーバーで構成できますか？
  • ダウンロード
  • バージョン情報
• Linux へのインストール (詳細手順)
  • 前提条件
  • インストール方法の選択
  • TAR.GZ 版でのインストール
    • ステップ 1: OpenSearch のインストール
    • ステップ 2: Fess のインストール
    • ステップ 3: 起動
  • RPM 版でのインストール
    • ステップ 1: OpenSearch のインストール
    • ステップ 2: Fess のインストール
    • ステップ 3: 起動
  • DEB 版でのインストール
    • ステップ 1: OpenSearch のインストール
    • ステップ 2: Fess のインストール
    • ステップ 3: 起動
  • インストール後の確認
  • 次のステップ
  • よくある質問
    • Q: OpenSearch のバージョンは他のバージョンでも動作しますか？
    • Q: 複数の Fess インスタンスで同じ OpenSearch を共有できますか？
    • Q: OpenSearch をクラスター構成にする方法は？
• Windows へのインストール (詳細手順)
  • 前提条件
  • Java のインストール確認
  • 環境変数の設定
  • ステップ 1: OpenSearch のインストール
    • OpenSearch のダウンロード
    • OpenSearch プラグインのインストール
    • OpenSearch の設定
  • ステップ 2: Fess のインストール
    • Fess のダウンロード
    • Fess の設定
    • インストールの確認
  • ステップ 3: 起動
  • Windows サービスとしての登録（オプション）
    • NSSM を使用した例
  • ファイアウォール設定
  • トラブルシューティング
    • ポート番号の競合
    • パスの長さ制限
    • Java が認識されない
  • 次のステップ
  • よくある質問
    • Q: Windows Server での運用は推奨されますか？
    • Q: 64 ビット版と 32 ビット版の違いは？
    • Q: パスに日本語が含まれる場合の対処法は？
• Docker でのインストール (詳細)
  • 前提条件
  • Docker のインストール確認
  • Docker イメージについて
  • ステップ 1: Docker Compose ファイルの取得
    • 方法 1: ファイルを個別にダウンロード
    • 方法 2: Git でリポジトリをクローン
  • ステップ 2: Docker Compose ファイルの確認
    • compose.yaml の内容
    • compose-opensearch3.yaml の内容
    • 設定のカスタマイズ（オプション）
  • ステップ 3: Docker コンテナの起動
    • 基本的な起動
    • 起動の確認
  • ステップ 4: ブラウザーでアクセス
  • データの永続化
  • Docker コンテナの停止
  • 高度な設定
    • 環境変数のカスタマイズ
    • 設定ファイルの反映方法
      • 方法 1: 設定ファイルのマウント
      • 方法 2: システムプロパティによる設定
    • 外部の OpenSearch への接続
    • Docker ネットワークの設定
  • Docker Compose での本番運用
  • トラブルシューティング
    • コンテナが起動しない
    • メモリ不足エラー
    • データの初期化
  • 次のステップ
  • よくある質問
    • Q: Docker イメージのサイズはどのくらいですか？
    • Q: Kubernetes での運用は可能ですか？
    • Q: コンテナのアップデートはどのように行いますか？
    • Q: マルチノード構成は可能ですか？
• 起動、停止、初期設定
  • 起動方法
    • TAR.GZ 版の場合
      • OpenSearch の起動
      • Fess の起動
    • ZIP 版の場合（Windows）
      • OpenSearch の起動
      • Fess の起動
    • RPM/DEB 版の場合 (chkconfig)
    • RPM/DEB 版の場合 (systemd)
    • Docker 版の場合
  • 起動の確認
    • ヘルスチェック
    • ログの確認
  • ブラウザーでのアクセス
    • 検索画面
    • 管理画面
  • 初回セットアップ
    • ステップ 1: 管理者パスワードの変更
    • ステップ 2: クロール設定の作成
    • ステップ 3: クロールの実行
    • ステップ 4: 検索の確認
  • その他の推奨設定
    • メールサーバーの設定
    • タイムゾーンの設定
    • ログレベルの調整
  • 停止方法
    • TAR.GZ/ZIP 版の場合
      • Fess の停止
    • RPM/DEB 版の場合 (chkconfig)
    • RPM/DEB 版の場合 (systemd)
    • Docker 版の場合
  • 再起動方法
    • TAR.GZ/ZIP 版の場合
    • RPM/DEB 版の場合
    • Docker 版の場合
  • トラブルシューティング
    • 起動しない場合
  • 次のステップ
• セキュリティ設定
  • 必須のセキュリティ設定
    • 管理者パスワードの変更
    • OpenSearch のセキュリティプラグイン有効化
    • HTTPS の有効化
  • 推奨のセキュリティ設定
    • ファイアウォール設定
    • アクセス制御の設定
    • ロールベースアクセス制御 (RBAC)
    • 監査ログの有効化
    • 定期的なセキュリティアップデート
  • データ保護
    • バックアップの暗号化
  • セキュリティベストプラクティス
    • 最小権限の原則
    • ネットワーク分離
    • 定期的なセキュリティ監査
    • セキュリティヘッダーの設定
  • セキュリティチェックリスト
    • 基本設定
    • ネットワークセキュリティ
    • アクセス制御
    • 監視とログ
    • バックアップとリカバリ
    • アップデートとパッチ管理
  • セキュリティインシデント対応
  • 参考情報
• アップグレード手順
  • 対応バージョン
  • アップグレード前の準備
    • バージョン互換性の確認
    • ダウンタイムの計画
  • ステップ 1: データのバックアップ
    • 設定データのバックアップ
    • インデックスデータのバックアップ
      • 方法 1: スナップショット機能を使用（推奨）
      • 方法 2: ディレクトリごとバックアップ
    • Docker 版のバックアップ
  • ステップ 2: 現在のバージョンの停止
  • ステップ 3: 新しいバージョンのインストール
    • TAR.GZ/ZIP 版
    • RPM/DEB 版
    • Docker 版
  • ステップ 4: OpenSearch のアップグレード（必要な場合）
  • ステップ 5: 新しいバージョンの起動
  • ステップ 6: 動作確認
  • ステップ 7: インデックスの再作成（推奨）
  • ロールバック手順
    • ステップ 1: 新しいバージョンの停止
    • ステップ 2: 古いバージョンの復元
    • ステップ 3: データの復元
    • ステップ 4: サービスの起動と確認
  • よくある質問
    • Q: ダウンタイムなしでアップグレードできますか？
    • Q: OpenSearch もアップグレードする必要がありますか？
    • Q: インデックスを再作成する必要がありますか？
    • Q: アップグレード後、検索結果が表示されません
  • 次のステップ
• アンインストール手順
  • アンインストール前の準備
    • バックアップの取得
    • サービスの停止
  • TAR.GZ/ZIP 版のアンインストール
    • ステップ 1: Fess の削除
    • ステップ 2: OpenSearch の削除
    • ステップ 3: データディレクトリの削除（オプション）
    • ステップ 4: ログディレクトリの削除（オプション）
  • RPM 版のアンインストール
    • ステップ 1: Fess のアンインストール
    • ステップ 2: OpenSearch のアンインストール
    • ステップ 3: サービスの無効化と削除
    • ステップ 4: データディレクトリの削除
    • ステップ 5: 設定ファイルの削除
    • ステップ 6: ログファイルの削除
    • ステップ 7: ユーザーとグループの削除（オプション）
  • DEB 版のアンインストール
    • ステップ 1: Fess のアンインストール
    • ステップ 2: OpenSearch のアンインストール
    • ステップ 3: サービスの無効化
    • ステップ 4: データディレクトリの削除
    • ステップ 5: 設定ファイルの削除（dpkg -P を使用しなかった場合）
    • ステップ 6: ログファイルの削除
    • ステップ 7: ユーザーとグループの削除（オプション）
  • Docker 版のアンインストール
    • ステップ 1: コンテナとネットワークの削除
    • ステップ 2: ボリュームの削除
    • ステップ 3: イメージの削除（オプション）
    • ステップ 4: ネットワークの削除（オプション）
    • ステップ 5: Compose ファイルの削除
  • アンインストールの確認
    • プロセスの確認
    • ポートの確認
    • ファイルの確認
    • パッケージの確認
  • 部分的なアンインストール
    • Fess のみを削除して OpenSearch を残す
    • OpenSearch のみを削除して Fess を残す
  • トラブルシューティング
    • パッケージが削除できない
    • ディレクトリが削除できない
  • 再インストールの準備
  • 次のステップ
• トラブルシューティング
  • インストール時の問題
    • Java が認識されない
    • プラグインのインストールに失敗する
  • 起動時の問題
    • Fess が起動しない
    • OpenSearch が起動しない
    • ポート番号の競合
  • 接続の問題
    • Fess が OpenSearch に接続できない
    • ブラウザーから Fess にアクセスできない
  • パフォーマンスの問題
    • 検索が遅い
    • クロールが遅い
  • データの問題
    • 検索結果が表示されない
    • インデックスが破損している
  • Docker 固有の問題
    • コンテナが起動しない
    • コンテナは起動するが Fess にアクセスできない
  • Windows 固有の問題
    • パスの問題
    • サービスとして登録できない
  • その他の問題
    • ログレベルの変更
    • データベースのリセット
  • サポート情報
    • コミュニティサポート
    • 商用サポート
  • デバッグ情報の収集

Fess ユーザーガイド

• はじめに
  • 対象読者
  • お読みになる前に
  • オンラインでのアクセス
  • 技術的なサポートの連絡先
    • 商用サポート
  • 関連サードパーティー Web サイトの参照
  • コメントおよび提案の送付方法
• AND 検索
  • 利用方法
• OR 検索
  • 利用方法
• NOT 検索
  • 利用方法
• ラベル指定検索
  • ラベル指定検索 (カテゴリ検索)
    • 利用方法
• 検索フィールド指定検索
  • フィールド指定検索
    • 利用可能なフィールド
    • 利用方法
• ソート検索
  • ソート対象フィールド
  • 利用方法
• ワイルドカード検索
  • 利用方法
  • 利用条件
• 範囲指定検索
  • 利用方法
• ブースト検索
  • ブースト検索(重み付け検索)
    • 利用方法
• 曖昧検索
  • 曖昧検索(ファジー検索)
    • 利用方法
• 位置情報検索
  • 利用方法
• 非表示検索条件
  • 利用方法
• ロール検索
  • 検索方法
  • パスワードの変更
  • ログアウト
• 特殊文字
  • 利用方法
• 詳細検索
  • 利用方法
  • 項目一覧
    • すべての単語を含む
    • 語順も含めた完全一致
    • いずれかの単語を含む
    • 含めない単語
    • 表示件数
    • ソート
    • 優先する言語
    • ラベル
    • 更新日時
    • ファイル形式
    • 検索対象
    • サイトまたはドメイン

Fess APIガイド

• はじめに
  • 対象読者
  • お読みになる前に
  • API利用の前提条件
  • オンラインでのアクセス
  • 技術的なサポートの連絡先
    • 商用サポート
  • 関連サードパーティー Web サイトの参照
  • コメントおよび提案の送付方法
• APIの概要
  • Fess の提供するAPI
  • ベースURL
  • 認証
  • HTTPメソッド
  • レスポンスフォーマット
  • エラーハンドリング
  • APIの種類
• 検索API
  • 検索結果の取得
    • リクエスト
    • リクエストパラメーター
    • レスポンス
  • 全てのドキュメントを検索
    • リクエストパラメーター
  • エラーレスポンス
• ラベルAPI
  • ラベルの取得
    • リクエスト
    • リクエストパラメーター
    • レスポンス
  • 使用例
  • エラーレスポンス
• 人気ワードAPI
  • 人気ワード一覧の取得
    • リクエスト
    • リクエストパラメーター
    • レスポンス
  • エラーレスポンス
• サジェストAPI
  • サジェストワード一覧の取得
    • リクエスト
    • リクエストパラメーター
    • レスポンス
  • エラーレスポンス
• Health API
  • 状態の取得
    • リクエスト
    • リクエストパラメーター
    • レスポンス
  • エラーレスポンス

Fess 管理者ガイド

• はじめに
  • 対象読者
  • お読みになる前に
  • オンラインでのアクセス
  • 技術的なサポートの連絡先
    • 商用サポート
• ダッシュボード
  • 概要
  • インデックスされているドキュメント数の確認
• 構成ウィザード
  • 概要
    • 簡易セットアップ
    • クロールの設定
    • 設定項目
      • 名前
      • クロールパス
      • 最大アクセス数
      • 深さ
    • クローラ
• 全般
  • 概要
  • 設定内容
    • システム
      • JSONレスポンス
      • ログインが必要
      • ログインリンク表示
      • 重複結果の折り畳み
      • サムネイル表示
      • デフォルトのラベル値
      • デフォルトのソート値
      • 仮想ホスト
      • 人気ワードのレスポンス
      • CSVファイルのエンコード
      • 検索パラメーターの追加
      • 通知メール
    • クローラー
      • 最終更新日時の確認
      • 同時クローラー設定
      • 以前のドキュメントを削除
      • 除外するエラーの種類
      • 障害数のしきい値
    • ロギング
      • 検索ログ
      • ユーザログ
      • お気に入りログ
      • 以前の検索ログを削除
      • 以前のジョブログを削除
      • 以前のユーザーログを削除
      • ログを削除するボット名
      • ログレベル
    • サジェスト
      • 検索語でサジェスト
      • ドキュメントでサジェスト
      • 以前のサジェスト情報を削除
    • LDAP
      • LDAP URL
      • Base DN
      • Bind DN
      • パスワード
      • User DN
      • アカウントフィルター
      • グループフィルター
      • memberOf属性
    • お知らせ表示
      • ログインページ
      • 検索トップページ
    • ストレージ
      • エンドポイント
      • アクセスキー
      • シークレットキー
      • バケット
  • 例
    • LDAPの設定例
• スケジューラ
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
      • 対象
      • スケジュール
      • 実行方法
      • スクリプト
      • ロギング
      • クローラージョブ
      • 状態
      • 表示順序
    • 設定の削除
  • 手動クロール方法
• ページのデザイン
  • 概要
  • 設定方法
    • 表示方法
    • ファイルマネージャー
    • ページファイルの表示
    • アップロードするファイル
      • ファイルのアップロード
      • ファイル名(オプション)
• 辞書
  • 概要
  • 一覧
  • Kuromoji
  • 同義語
  • マッピング
  • Protwords
  • ストップワード
  • Stemmer上書き
• Kuromoji辞書
  • 概要
  • 管理方法
    • 表示方法
    • 設定方法
    • 設定項目
      • トークン
      • 分割
      • 読み
      • 品詞
  • ダウンロード
  • アップロード
• 同義語辞書
  • 概要
  • 管理方法
    • 表示方法
    • 設定方法
    • 設定項目
      • 変換元
      • 変換後
  • ダウンロード
  • アップロード
• マッピング辞書
  • 概要
  • 管理方法
    • 表示方法
    • 設定方法
    • 設定項目
      • 変換元
      • 変換後
  • ダウンロード
  • アップロード
• Protwords辞書
  • 概要
  • 管理方法
    • 表示方法
    • 設定方法
    • 設定項目
      • 単語情報
  • ダウンロード
  • アップロード
• ストップワード辞書
  • 概要
  • 管理方法
    • 表示方法
    • 設定方法
    • 設定項目
      • 変換元
      • 変換後
  • ダウンロード
  • アップロード
• Stemmer上書き辞書
  • 概要
  • 管理方法
    • 表示方法
    • 設定方法
    • 設定項目
      • 変換元
      • 変換後
  • ダウンロード
  • アップロード
• アクセストークン
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
      • パーミッション
      • パラメーター名
      • 有効期限
    • 設定の削除
• プラグイン
  • 概要
  • 管理方法
    • 表示方法
    • インストール
• ストレージ
  • 概要
  • 管理方法
    • オブジェクトストレージサーバーの設定
    • 表示方法
      • 名前
      • サイズ
      • 最終更新日時
    • ダウンロード
    • 削除
    • アップロード
    • フォルダーの作成
• ウェブクロール
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
      • URL
      • クロール対象とするURL
      • クロール対象から除外するURL
      • 検索対象とするURL
      • 検索対象から除外するURL
      • 設定パラメーター
      • 深さ
      • 最大アクセス数
      • ユーザーエージェント
      • スレッド数
      • 間隔
      • ブースト値
      • パーミッション
      • 仮想ホスト
      • 状態
      • 説明
    • 設定の削除
  • 例
    • fess.codelibs.org をクロールする
    • ウェブ認証サイトのウェブクロール
      • Redmine
      • XWiki
• ファイルクロール
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
      • パス
      • クロール対象とするパス
      • クロール対象から除外するパス
      • 検索対象とするパス
      • 検索対象から除外するパス
      • 設定パラメーター
      • 深さ
      • 最大アクセス数
      • スレッド数
      • 間隔
      • ブースト値
      • パーミッション
      • 仮想ホスト
      • 状態
      • 説明
    • 設定の削除
  • 例
    • ローカルファイルをクロール
    • Windowsの共有フォルダーをクロール
• データストアクロール
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
      • ハンドラー名
      • パラメーター
      • スクリプト
      • ブースト値
      • パーミッション
      • 仮想ホスト
      • 状態
      • 説明
    • 設定の削除
  • 例
    • DatabaseDataStore
      • パラメーター
      • スクリプト
      • ドライバー
    • CsvDataStore
      • パラメーター
      • スクリプト
    • EsDataStore
      • パラメーター
      • スクリプト
    • CsvListDataStore
      • パラメーター
      • スクリプト
• ラベル
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
      • 値
      • 対象とするパス
      • 除外するパス
      • パーミッション
      • 仮想ホスト
      • 表示順序
    • 設定の削除
• キーマッチ
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 検索語
      • クエリー
      • サイズ
      • ブースト値
      • 仮想ホスト
    • 設定の削除
• ドキュメントブースト
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 条件
      • ブースト値式
      • ソート順
    • 設定の削除
• 関連コンテンツ
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 検索語
      • コンテンツ
      • 仮想ホスト
    • 設定の削除
• 関連クエリー
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 検索語
      • クエリー
      • 仮想ホスト
    • 設定の削除
• パスマッピング
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 正規表現
      • 置換
      • 処理の種類
      • 表示順序
    • 設定の削除
• ウェブ認証
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • ホスト名
      • ポート
      • レルム
      • スキーム
      • ユーザー名
      • パスワード
      • パラメーター
      • ウェブ設定
    • 設定の削除
• ファイル認証
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • ホスト名
      • ポート
      • スキーム
      • ユーザー名
      • パスワード
      • パラメーター
      • ファイルクロール設定
    • 設定の削除
• リクエストヘッダー
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
      • 値
      • ウェブ設定
    • 設定の削除
• 重複ホスト
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 正規名
      • 重複名
    • 設定の削除
• ユーザー
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • ユーザー名
      • ロール
      • グループ
    • 設定の削除
• ロール
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
    • 設定の削除
• グループ
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
    • 削除の方法
• サジェストワード
  • 概要
  • 管理方法
    • 表示方法
      • 単語種別
      • 単語数
• 追加ワード
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 単語
      • 読み
      • パーミッション
      • ラベル
      • ブースト値
    • 設定の削除
  • ダウンロード
    • CSVの内容
  • アップロード
    • CSVの内容
• 除外ワード
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • サジェスト候補
    • 設定の削除
  • ダウンロード
    • CSVの内容
  • アップロード
    • CSVの内容
• システム情報
  • 概要
  • 管理方法
    • 表示方法
    • 表示項目
      • 環境変数のプロパティ
      • システムのプロパティ
      • アプリのプロパティ
      • バグレポートのプロパティ
• 検索ログ
  • 概要
  • 管理方法
  • 一覧
  • 詳細
• ジョブログ
  • 概要
  • 管理方法
    • 表示方法
    • ジョブログ詳細
      • 名前
      • 状態
      • 対象
      • 開始時間
      • 終了時間
      • 実行方法
      • スクリプト
      • 結果
• クロール情報
  • 概要
  • 管理方法
  • 一覧
  • 詳細
    • 項目一覧
      • セッションID
      • クローラーの開始時間
      • クロールの開始時間 (ウェブ/ファイル)
      • クロールの開始時間 (データストア)
      • クロールの終了時間 (ウェブ/ファイル)
      • クロールの実行時間 (データストア)
      • インデクシングの実行時間 (データストア)
      • インデックスのサイズ (データストア)
      • クロールの終了時間 (データストア)
      • クローラーの状態
      • クローラーの終了時間
      • クローラーの実行時間
• ログファイル
  • 概要
  • 設定方法
    • 表示方法
    • ダウンロード
      • server_*.log
      • fess.log
      • fess-crawler.log
      • audit.log
      • fess-thumbnail.log
      • fess-suggest.log
      • fess-urls.log
      • search.log
      • gc-crawler.log
• 障害URL
  • 概要
  • 管理方法
    • 表示方法
  • 障害URLの詳細
    • 詳細の内容
      • URL
      • スレッド名
      • 種類
      • ログ
      • エラー回数
      • 最終アクセス日時
• 検索
  • 概要
  • 管理方法
    • 表示方法
    • 検索一覧
    • 一括削除
• バックアップ
  • 概要
    • ダウンロード
      • fess_config.bulk
      • fess_basic_config.bulk
      • fess_user.bulk
      • system.properties
      • fess.json
      • doc.json
      • click_log.ndjson
      • favorite_log.ndjson
      • search_log.ndjson
      • user_info.ndjson
    • アップロード
• メンテナンス
  • 概要
  • 操作方法
    • 再インデクシング
    • 設定項目
      • エイリアスの更新
      • 辞書の初期化
      • シャード数
      • 最大レプリカ数
    • ドキュメントインデックスのリロード
    • Crawlerインデックス
    • 診断
• クエリーリクエスト
  • 概要
  • 操作方法
    • リクエストの送信
    • 設定項目
      • リクエストファイル

Fess 設定ガイド

• はじめに
  • 対象読者
  • お読みになる前に
  • オンラインでのアクセス
  • 技術的なサポートの連絡先
    • 商用サポート
  • 関連サードパーティー Web サイトの参照
  • コメントおよび提案の送付方法
• ポートとネットワーク設定
  • 概要
  • 使用ポートの設定
    • デフォルトポート
    • Fess ウェブアプリケーションのポート変更
      • Linux環境での設定
      • 環境変数による設定
      • RPM/DEBパッケージの場合
      • Windows環境での設定
      • Windowsサービスとして登録する場合
    • コンテキストパスの設定
  • プロキシ設定
    • 概要
    • クローラー用プロキシの設定
      • 基本設定
      • 認証が必要なプロキシの設定
      • 特定のホストをプロキシから除外
    • システム全体のHTTPプロキシ設定
  • HTTP通信設定
    • ファイルアップロードの制限
    • 接続タイムアウト設定
    • OpenSearchの接続先変更
      • 複数ノードへの接続
    • SSL/TLS接続の設定
  • 仮想ホスト設定
    • 概要
    • 基本設定
  • リバースプロキシとの連携
    • Nginx の設定例
    • Apache の設定例
    • SSL/TLS終端
  • ファイアウォール設定
    • 必要なポートの開放
    • セキュリティグループの設定(クラウド環境)
  • トラブルシューティング
    • ポート変更後にアクセスできない
    • プロキシ経由でクロールできない
    • OpenSearchに接続できない
    • リバースプロキシ経由でアクセスすると正常に動作しない
  • 参考情報
• メモリ設定
  • 概要
  • Fess ウェブアプリケーションのメモリ設定
    • 設定が必要な場合
    • 環境変数による設定
    • RPM/DEBパッケージの場合
    • 推奨メモリサイズ
  • クローラーのメモリ設定
    • 設定が必要な場合
    • 設定方法
    • 推奨設定
    • 詳細なJVMオプション
  • OpenSearch のメモリ設定
    • 重要な考慮事項
    • 設定方法
      • Linux環境
      • Windows環境
    • 推奨メモリサイズ
    • ベストプラクティス
  • サジェスト・サムネイル処理のメモリ設定
    • サジェスト生成プロセス
    • サムネイル生成プロセス
  • メモリ監視とチューニング
    • メモリ使用状況の確認
      • Fess のメモリ使用状況
      • OpenSearchのメモリ使用状況
    • メモリ不足の兆候
    • チューニング手順
    • メモリリーク対策
  • トラブルシューティング
    • OutOfMemoryError が発生する
    • GCによる停止時間が長い
    • メモリ設定後も性能が改善しない
  • 参考情報
• Windowsサービスへの登録
  • Windowsサービスとしての登録
    • 事前準備
    • OpenSearchをサービスとして登録
    • 設定
    • 登録方法
    • サービスの設定
• クローラー基本設定
  • 概要
  • クローラーの基本概念
    • クローラーとは
    • クローラーの種類
  • クロール設定の作成
    • 基本的なクロール設定の追加
    • Webクローラーの設定例
      • 社内イントラネットサイトのクロール
      • 公開Webサイトのクロール
    • ファイルクローラーの設定例
      • ローカルファイルシステム
      • SMB/CIFS(Windowsファイル共有)
    • 認証情報の設定
  • クロールの実行
    • 手動実行
    • スケジュール実行
    • クロール状況の確認
  • 基本的な設定項目
    • クロール対象の制限
      • URLパターンによる制限
      • 深さの制限
      • 最大アクセス数
    • 並列クロール数(スレッド数)
    • クロール間隔
  • ファイルサイズの設定
    • 取得するファイルサイズの上限
    • インデックスするファイルサイズの上限
  • 単語の長さ制限
    • 概要
    • 設定方法
  • プロキシの設定
    • 概要
    • 設定方法
    • システム全体のプロキシ設定
  • robots.txt の設定
    • 概要
    • 設定方法
  • User-Agent の設定
    • 管理画面での設定
    • システム全体の設定
  • エンコーディング設定
    • クロールデータのエンコーディング
    • ファイル名のエンコーディング
  • クロールのトラブルシューティング
    • クロールが開始されない
    • クロールが途中で停止する
    • 特定のページがクロールされない
    • クロールが遅い
  • ベストプラクティス
    • クロール設定の推奨事項
    • スケジュール設定の推奨事項
  • 参考情報
• クローラー詳細設定
  • 概要
  • 全般設定
    • 設定ファイルの場所
    • デフォルトスクリプト
    • HTTPスレッドプール
  • ドキュメント処理設定
    • 基本設定
      • 設定例
    • 単語処理設定
      • 設定例
    • 文字処理設定
      • 設定例
  • プロトコル設定
    • 対応プロトコル
      • 設定例
    • 環境変数パラメーター
  • robots.txt 設定
  • エラー処理設定
  • システム監視設定
    • ホットスレッド設定
      • 設定例
  • メタデータ設定
  • HTML クローラー設定
    • XPath 設定
      • 設定例
      • カスタム XPath の例
    • HTML タグ処理
      • 設定例
    • URLパターンフィルター
      • 設定例
  • ファイルクローラー設定
    • 基本設定
      • 設定例
    • コンテンツ処理
      • 設定例
    • ファイルURLパターンフィルター
      • 設定例
  • キャッシュ設定
    • ドキュメントキャッシュ
      • 設定例
  • JVM オプション
    • デフォルト設定
    • 主要なオプションの説明
    • カスタム設定例
  • パフォーマンスチューニング
    • クロール速度の最適化
    • メモリ使用量の最適化
    • インデックス品質の向上
  • トラブルシューティング
    • メモリ不足
    • クロールが遅い
    • 特定のコンテンツが抽出できない
    • 文字化けが発生する
  • ベストプラクティス
  • 参考情報
• サムネイル画像の設定
  • サムネイル画像の表示
  • HTMLファイルのサムネイル画像
  • MS Officeファイルのサムネイル画像
    • パッケージのインストール
    • 生成スクリプト
  • PDFファイルのサムネイル画像
  • サムネイルジョブの無効化
• 検索機能
  • 概要
  • 検索結果件数の表示
    • デフォルトの動作
    • 正確なヒット件数の表示
  • 検索オプション
    • 基本的な検索
    • OR検索
    • NOT検索
    • フレーズ検索
    • フィールド指定検索
    • ワイルドカード検索
    • ファジー検索
  • 検索結果のソート
  • ファセット検索
  • 検索結果のハイライト
  • サジェスト機能
  • 検索ログ
  • パフォーマンスチューニング
    • 検索タイムアウトの設定
    • 検索クエリの最大文字数
    • キャッシュの利用
  • トラブルシューティング
    • 検索結果が表示されない
    • 検索速度が遅い
    • 関連性の低い結果が表示される
• 検索関連の設定
  • ファジー検索
  • 検索時のタイムアウト値
  • 検索時の最大文字数
  • 検索時のタイムアウトのログ出力
  • ヒット件数表示
  • 位置情報検索時のインデックス名
  • リクエストパラメータの言語指定
  • 前方一致検索の指定
  • ハイライトの文字列
  • ハイライトのフラグメント
  • ハイライト生成方法
  • ハイライト対象のタグ
  • OpenSearchのハイライターに渡す値
  • レスポンスに追加するフィールド名
  • フィールド名の追加
  • 検索結果をGSA互換のXML形式で取得する際の設定
• 位置情報検索
  • 概要
  • ユースケース
  • 設定方法
    • インデックス生成時の設定
      • 位置情報フィールドの定義
      • 位置情報の登録形式
      • データストアクロールでの設定例
      • スクリプトでの位置情報追加
    • 検索時の設定
      • リクエストパラメータ
      • 距離の単位
  • 検索例
    • 基本的な検索
    • 現在地周辺の検索
    • 距離によるソート
    • APIでの使用
  • フィールド名のカスタマイズ
    • デフォルトのフィールド名変更
  • 実装例
    • Webアプリケーションでの実装
    • Googleマップとの連携
  • パフォーマンス最適化
    • インデックス設定の最適化
    • 検索範囲の制限
  • トラブルシューティング
    • 位置情報検索が動作しない
    • 検索結果が返ってこない
    • 位置情報が正しく表示されない
  • 参考情報
• 検索結果の一括取得
  • 概要
  • ユースケース
  • 設定方法
    • スクロール検索の有効化
    • レスポンスフィールドの設定
    • スクロールのタイムアウト設定
  • 使用方法
    • 基本的な使用方法
    • リクエストパラメータ
    • 検索クエリの指定
    • 取得件数の指定
    • ラベルによるフィルタリング
    • 認証が必要な場合
  • レスポンス形式
    • NDJSON形式
    • レスポンスフィールド
  • データ処理例
    • Pythonでの処理例
    • ファイルへの保存
    • CSVへの変換
    • データ分析
  • パフォーマンスとベストプラクティス
    • 効率的な使用方法
    • メモリ使用量の最適化
  • セキュリティ考慮事項
    • アクセス制限
    • レート制限
  • トラブルシューティング
    • スクロール検索が利用できない
    • タイムアウトエラーが発生する
    • メモリ不足エラー
    • レスポンスが空になる
  • 参考情報
• 検索フォームの配置
  • 検索フォームの配置方法
    • 検索フォーム
    • サジェスト
• ロールベース検索の設定
  • ロールベース検索について
  • ロールベース検索の設定
    • Fess の管理画面での設定
    • ログイン
    • ログアウト
• 仮想ホスト
  • 仮想ホストについて
    • システム設定
    • クロール設定
• ログ設定
  • 概要
  • ログファイルの種類
    • 主要なログファイル
    • ログファイルの場所
    • トラブルシューティング時のログ確認
  • ログレベルの設定
    • ログレベルとは
    • 推奨ログレベル
    • 管理画面からの変更
    • 設定ファイルによる変更
      • 設定ファイルの場所
      • 基本的な設定例
      • 環境変数による設定
  • クローラーログの設定
    • 管理画面での設定
      • 特定のURLパターンのみログレベルを変更
      • クローラープロセス全体のログレベル変更
  • ログローテーション
    • 概要
    • Log4j2による自動ローテーション
      • デフォルトの設定
      • 日次ローテーションの設定
      • 圧縮設定
    • logrotateによるローテーション
  • ログ監視
    • 監視すべきログパターン
      • 重要なエラーパターン
      • 警告すべきパターン
    • リアルタイム監視
    • 監視ツールの例
    • アラート設定
  • ログフォーマット
    • デフォルトフォーマット
    • カスタムフォーマット例
      • JSON形式でログ出力
      • より詳細な情報を含める
  • パフォーマンスへの影響
    • ベストプラクティス
    • パフォーマンス測定
  • トラブルシューティング
    • ログが出力されない
    • ログファイルが大きくなりすぎる
    • 特定のログが見つからない
    • ログに文字化けが発生する
  • 参考情報
• インデックスの管理
  • 概要
  • インデックスの構成
  • インデックスのバックアップとリストア
    • スナップショットリポジトリの設定
    • スナップショットの作成(バックアップ)
      • 全インデックスのバックアップ
      • 特定のインデックスのバックアップ
      • 定期的な自動バックアップ
    • スナップショットの確認
    • スナップショットからのリストア
      • 全インデックスのリストア
      • 特定のインデックスのリストア
      • インデックス名を変更してリストア
    • スナップショットの削除
  • 設定ファイルのバックアップ
    • バックアップ対象のファイル
    • 設定ファイルのバックアップ例
  • データ移行
    • 別環境への移行手順
    • バージョンアップ時の注意事項
  • トラブルシューティング
    • スナップショットの作成に失敗する
    • リストアに失敗する
    • リストア後に検索できない
  • 参考情報
• Analyzerの設定
  • Analyzerについて
• 検索ログ可視化の設定
  • 検索ログの可視化について
    • 可視化できる情報
  • OpenSearch Dashboards によるデータ可視化の設定
    • OpenSearch Dashboards のインストール
    • 設定ファイルの編集
    • OpenSearch Dashboards の起動
    • インデックスパターンの設定
    • 可視化とダッシュボードの作成
      • 基本的な可視化の作成
      • ダッシュボードの作成
    • タイムゾーンの設定
    • ログデータの確認
    • 主な検索ログフィールド
    • トラブルシューティング
      • データが表示されない場合
      • 接続エラーが発生する場合

JavaDocs

XRef

I/F Doc

15.2

Fess インストールガイド

• はじめに
  • 対象読者
  • お読みになる前に
  • オンラインでのアクセス
  • 技術的なサポートの連絡先
    • 商用サポート
  • コメントおよび提案の送付方法
• インストール
  • インストール要件
  • ダウンロード
  • TAR.GZ版でのインストール
    • OpenSearchのインストール
    • Fessのインストール
  • ZIP版でのインストール
    • OpenSearchのインストール
    • Fessのインストール
  • RPM/DEB版でのインストール
    • OpenSearchのインストール
    • Fessのインストール
  • Docker版でのインストール
• 起動および停止方法
  • 起動方法
    • TAR.GZ版の場合
    • ZIP版の場合
    • RPM/DEB版の場合 (chkconfig)
    • RPM/DEB版の場合 (systemd)
    • Docker版の場合
  • ブラウザー UI へのアクセス
  • 停止方法
    • TAR.GZ/ZIP版の場合
    • RPM/DEB版の場合 (chkconfig)
    • RPM/DEB版の場合 (systemd)
    • Docker版の場合
• アンインストール
  • アンインストール
    • TAR.GZ/ZIP版の場合
    • RPM/DEB版の場合
• アップグレード
  • Fess のアップグレード
    • データのバックアップ
    • パッケージの更新
    • 設定のリストア
    • クローラーの起動

Fess ユーザーガイド

• はじめに
  • 対象読者
  • お読みになる前に
  • オンラインでのアクセス
  • 技術的なサポートの連絡先
    • 商用サポート
  • 関連サードパーティー Web サイトの参照
  • コメントおよび提案の送付方法
• AND 検索
  • AND 検索
    • 利用方法
• OR 検索
  • OR 検索
    • 利用方法
• NOT 検索
  • NOT 検索
    • 利用方法
• ラベル指定検索
  • ラベル指定検索 (カテゴリ検索)
    • 利用方法
• 検索フィールド指定検索
  • フィールド指定検索
    • 利用可能なフィールド
    • 利用方法
• ソート検索
  • ソート検索
    • ソート対象フィールド
    • 利用方法
• ワイルドカード検索
  • ワイルドカード検索
    • 利用方法
    • 利用条件
• 範囲指定検索
  • 範囲指定検索
    • 利用方法
• ブースト検索
  • ブースト検索(重み付け検索)
    • 利用方法
• 曖昧検索
  • 曖昧検索(ファジー検索)
    • 利用方法
• 位置情報検索
  • 位置情報検索
    • 利用方法
• 非表示検索条件
  • 非表示検索条件
    • 利用方法
• ロール検索
  • ロール検索
    • 検索方法
    • パスワードの変更
    • ログアウト
• 特殊文字
  • 特殊文字
    • 利用方法
• 詳細検索
  • 詳細検索
    • 利用方法
    • 項目一覧
      • すべての単語を含む
      • 語順も含めた完全一致
      • いずれかの単語を含む
      • 含めない単語
      • 表示件数
      • ソート
      • 優先する言語
      • ラベル
      • 更新日時
      • ファイル形式
      • 検索対象
      • サイトまたはドメイン

Fess APIガイド

• はじめに
  • 対象読者
  • お読みになる前に
  • オンラインでのアクセス
  • 技術的なサポートの連絡先
    • 商用サポート
  • 関連サードパーティー Web サイトの参照
  • コメントおよび提案の送付方法
• APIの概要
  • Fess の提供するAPI
  • APIの種類
• 検索API
  • 検索結果の取得
    • リクエストパラメーター
    • レスポンス
  • 全てのドキュメントを検索
    • リクエストパラメーター
• ラベルAPI
  • ラベルの取得
    • リクエストパラメーター
    • レスポンス
• 人気ワードAPI
  • 人気ワード一覧の取得
    • リクエストパラメーター
    • レスポンス
• サジェストAPI
  • サジェストワード一覧の取得
    • リクエストパラメーター
    • レスポンス
• Health API
  • 状態の取得
    • リクエストパラメーター
    • レスポンス

Fess 管理者ガイド

• はじめに
  • 対象読者
  • お読みになる前に
  • オンラインでのアクセス
  • 技術的なサポートの連絡先
    • 商用サポート
• ダッシュボード
  • 概要
  • インデックスされているドキュメント数の確認
• 構成ウィザード
  • 概要
    • 簡易セットアップ
    • クロールの設定
    • 設定項目
      • 名前
      • クロールパス
      • 最大アクセス数
      • 深さ
    • クローラ
• 全般
  • 概要
  • 設定内容
    • システム
      • JSONレスポンス
      • ログインが必要
      • ログインリンク表示
      • 重複結果の折り畳み
      • サムネイル表示
      • デフォルトのラベル値
      • デフォルトのソート値
      • 仮想ホスト
      • 人気ワードのレスポンス
      • CSVファイルのエンコード
      • 検索パラメーターの追加
      • 通知メール
    • クローラー
      • 最終更新日時の確認
      • 同時クローラー設定
      • 以前のドキュメントを削除
      • 除外するエラーの種類
      • 障害数のしきい値
    • ロギング
      • 検索ログ
      • ユーザログ
      • お気に入りログ
      • 以前の検索ログを削除
      • 以前のジョブログを削除
      • 以前のユーザーログを削除
      • ログを削除するボット名
      • ログレベル
    • サジェスト
      • 検索語でサジェスト
      • ドキュメントでサジェスト
      • 以前のサジェスト情報を削除
    • LDAP
      • LDAP URL
      • Base DN
      • Bind DN
      • パスワード
      • User DN
      • アカウントフィルター
      • グループフィルター
      • memberOf属性
    • お知らせ表示
      • ログインページ
      • 検索トップページ
    • ストレージ
      • エンドポイント
      • アクセスキー
      • シークレットキー
      • バケット
  • 例
    • LDAPの設定例
• スケジューラ
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
      • 対象
      • スケジュール
      • 実行方法
      • スクリプト
      • ロギング
      • クローラージョブ
      • 状態
      • 表示順序
    • 設定の削除
  • 手動クロール方法
• ページのデザイン
  • 概要
  • 設定方法
    • 表示方法
    • ファイルマネージャー
    • ページファイルの表示
    • アップロードするファイル
      • ファイルのアップロード
      • フィイル名(オプション)
• 辞書
  • 概要
  • 一覧
  • Kuromoji
  • 同義語
  • マッピング
  • Protwords
  • ストップワード
  • Stemmer上書き
• Kuromoji辞書
  • 概要
  • 管理方法
    • 表示方法
    • 設定方法
    • 設定項目
      • トークン
      • 分割
      • 読み
      • 品詞
  • ダウンロード
  • アップロード
• 同義語辞書
  • 概要
  • 管理方法
    • 表示方法
    • 設定方法
    • 設定項目
      • 変換元
      • 変換後
  • ダウンロード
  • アップロード
• マッピング辞書
  • 概要
  • 管理方法
    • 表示方法
    • 設定方法
    • 設定項目
      • 変換元
      • 変換後
  • ダウンロード
  • アップロード
• Protwords辞書
  • 概要
  • 管理方法
    • 表示方法
    • 設定方法
    • 設定項目
      • 単語情報
  • ダウンロード
  • アップロード
• ストップワード辞書
  • 概要
  • 管理方法
    • 表示方法
    • 設定方法
    • 設定項目
      • 変換元
      • 変換後
  • ダウンロード
  • アップロード
• Stemmer上書き辞書
  • 概要
  • 管理方法
    • 表示方法
    • 設定方法
    • 設定項目
      • 変換元
      • 変換後
  • ダウンロード
  • アップロード
• アクセストークン
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
      • パーミッション
      • パラメーター名
      • 有効期限
    • 設定の削除
• プラグイン
  • 概要
  • 管理方法
    • 表示方法
    • インストール
• ストレージ
  • 概要
  • 管理方法
    • オブジェクトストレージサーバーの設定
    • 表示方法
      • 名前
      • サイズ
      • 最終更新日時
    • ダウンロード
    • 削除
    • アップロード
    • フォルダーの作成
• ウェブクロール
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
      • URL
      • クロール対象とするURL
      • クロール対象から除外するURL
      • 検索対象とするURL
      • 検索対象から除外するURL
      • 設定パラメーター
      • 深さ
      • 最大アクセス数
      • ユーザーエージェント
      • スレッド数
      • 間隔
      • ブースト値
      • パーミッション
      • 仮想ホスト
      • 状態
      • 説明
    • 設定の削除
  • 例
    • fess.codelibs.org をクロールする
    • ウェブ認証サイトのウェブクロール
      • Redmine
      • XWiki
• ファイルクロール
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
      • パス
      • クロール対象とするパス
      • クロール対象から除外するパス
      • 検索対象とするパス
      • 検索対象から除外するパス
      • 設定パラメーター
      • 深さ
      • 最大アクセス数
      • スレッド数
      • 間隔
      • ブースト値
      • パーミッション
      • 仮想ホスト
      • 状態
      • 説明
    • 設定の削除
  • 例
    • ローカルファイルをクロール
    • Windowsの共有フォルダーをクロール
• データストアクロール
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
      • ハンドラー名
      • パラメーター
      • スクリプト
      • ブースト値
      • パーミッション
      • 仮想ホスト
      • 状態
      • 説明
    • 設定の削除
  • 例
    • DatabaseDataStore
      • パラメーター
      • スクリプト
      • ドライバー
    • CsvDataStore
      • パラメーター
      • スクリプト
    • EsDataStore
      • パラメーター
      • スクリプト
    • CsvListDataStore
      • パラメーター
      • スクリプト
• ラベル
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
      • 値
      • 対象とするパス
      • 除外するパス
      • パーミッション
      • 仮想ホスト
      • 表示順序
    • 設定の削除
• キーマッチ
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 検索語
      • クエリー
      • サイズ
      • ブースト値
      • 仮想ホスト
    • 設定の削除
• ドキュメントブースト
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 条件
      • ブースト値式
      • ソート順
    • 設定の削除
• 関連コンテンツ
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 検索語
      • コンテンツ
      • 仮想ホスト
    • 設定の削除
• 関連クエリー
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 検索語
      • クエリー
      • 仮想ホスト
    • 設定の削除
• パスマッピング
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 正規表現
      • 置換
      • 処理の種類
      • 表示順序
    • 設定の削除
• ウェブ認証
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • ホスト名
      • ポート
      • レルム
      • スキーム
      • ユーザー名
      • パスワード
      • パラメーター
      • ウェブ設定
    • 設定の削除
• ファイル認証
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • ホスト名
      • ポート
      • スキーム
      • ユーザー名
      • パスワード
      • パラメーター
      • ファイルクロール設定
    • 設定の削除
• リクエストヘッダー
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
      • 値
      • ウェブ設定
    • 設定の削除
• 重複ホスト
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 正規名
      • 重複名
    • 設定の削除
• ユーザー
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • ユーザー名
      • ロール
      • グループ
    • 設定の削除
• ロール
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
    • 設定の削除
• グループ
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
    • 削除の方法
• サジェストワード
  • 概要
  • 管理方法
    • 表示方法
      • 単語種別
      • 単語数
• 追加ワード
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 単語
      • 読み
      • パーミッション
      • ラベル
      • ブースト値
    • 設定の削除
  • ダウンロード
    • CSVの内容
  • アップロード
    • CSVの内容
• 除外ワード
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • サジェスト候補
    • 設定の削除
  • ダウンロード
    • CSVの内容
  • アップロード
    • CSVの内容
• システム情報
  • 概要
  • 管理方法
    • 表示方法
    • 表示項目
      • 環境変数のプロパティ
      • システムのプロパティ
      • アプリのプロパティ
      • バグレポートのプロパティ
• 検索ログ
  • 概要
  • 管理方法
  • 一覧
  • 詳細
• ジョブログ
  • 概要
  • 管理方法
    • 表示方法
    • ジョブログ詳細
      • 名前
      • 状態
      • 対象
      • 開始時間
      • 終了時間
      • 実行方法
      • スクリプト
      • 結果
• クロール情報
  • 概要
  • 管理方法
  • 一覧
  • 詳細
    • 項目一覧
      • セッションID
      • クローラーの開始時間
      • クロールの開始時間 (ウェブ/ファイル)
      • クロールの開始時間 (データストア)
      • クロールの終了時間 (ウェブ/ファイル)
      • クロールの実行時間 (データストア)
      • インデクシングの実行時間 (データストア)
      • インデックスのサイズ (データストア)
      • クロールの終了時間 (データストア)
      • クローラーの状態
      • クローラーの終了時間
      • クローラーの実行時間
• ログファイル
  • 概要
  • 設定方法
    • 表示方法
    • ダウンロード
      • server_*.log
      • fess.log
      • fess-crawler.log
      • audit.log
      • fess-thumbnail.log
      • fess-suggest.log
      • fess-urls.log
      • search.log
      • gc-crawler.log
• 障害URL
  • 概要
  • 管理方法
    • 表示方法
  • 障害URLの詳細
    • 詳細の内容
      • URL
      • スレッド名
      • 種類
      • ログ
      • エラー回数
      • 最終アクセス日時
• 検索
  • 概要
  • 管理方法
    • 表示方法
    • 検索一覧
    • 一括削除
• バックアップ
  • 概要
    • ダウンロード
      • fess_config.bulk
      • fess_basic_config.bulk
      • fess_user.bulk
      • system.properties
      • fess.json
      • doc.json
      • click_log.ndjson
      • favorite_log.ndjson
      • search_log.ndjson
      • user_info.ndjson
    • アップロード
• メンテナンス
  • 概要
  • 操作方法
    • 再インデクシング
    • 設定項目
      • エイリアスの更新
      • 辞書の初期化
      • シャード数
      • 最大レプリカ数
    • ドキュメントインデックスのリロード
    • Crawlerインデックス
    • 診断
• クエリーリクエスト
  • 概要
  • 操作方法
    • リクエストの送信
    • 設定項目
      • リクエストファイル

Fess 設定ガイド

• はじめに
  • 対象読者
  • お読みになる前に
  • オンラインでのアクセス
  • 技術的なサポートの連絡先
    • 商用サポート
  • 関連サードパーティー Web サイトの参照
  • コメントおよび提案の送付方法
• システム関連の設定
  • 使用ポートの設定
  • 使用メモリーの設定
    • ウェブアプリのメモリー設定
    • クローラーのメモリー設定
    • OpenSearchのメモリー設定
  • ログの設定
    • ログのファイル
    • ログレベルの変更
• クローラー関連の設定
  • 単語の長さの上限の設定
  • ファイルサイズの設定
  • プロキシの設定
    • 設定方法
• 検索関連の設定
  • ファジー検索
  • 検索時のタイムアウト値
  • 検索時の最大文字数
  • 検索時のタイムアウトのログ出力
  • ヒット件数表示
  • 位置情報検索時のインデックス名
  • リクエストパラメータの言語指定
  • 前方一致検索の指定
  • ハイライトの文字列
  • ハイライトのフラグメント
  • ハイライト生成方法
  • ハイライト対象のタグ
  • OpenSearchのハイライターに渡す値
  • レスポンスに追加するフィールド名
  • フィールド名の追加
  • 検索結果をGSA互換のXML形式で取得する際の設定
• 検索フォームの配置
  • 検索フォームの配置方法
    • 検索フォーム
    • サジェスト
• 仮想ホスト
  • 仮想ホストについて
    • システム設定
    • クロール設定
• Windowsサービスへの登録
  • Windowsサービスとしての登録
    • 事前準備
    • OpenSearchをサービスとして登録
    • 設定
    • 登録方法
    • サービスの設定
• ロールベース検索の設定
  • ロールベース検索について
  • ロールベース検索の設定
    • Fess の管理画面での設定
    • ログイン
    • ログアウト
• インデックスの管理
  • インデックスのバックアップとリストア
• Analyzerの設定
  • Analyzerについて
• 位置情報検索
  • 概要
  • 設定
    • インデックス生成時
    • 検索時
• サムネイル画像の設定
  • サムネイル画像の表示
  • HTMLファイルのサムネイル画像
  • MS Officeファイルのサムネイル画像
    • パッケージのインストール
    • 生成スクリプト
  • PDFファイルのサムネイル画像
  • サムネイルジョブの無効化
• 検索結果の一括取得
  • 検索結果の一括取得について
  • 利用方法
    • スクロール検索の設定
    • スクロール検索の利用
• 検索機能
  • 検索結果件数の表示

JavaDocs

XRef

I/F Doc

15.1

Fess インストールガイド

• はじめに
  • 対象読者
  • お読みになる前に
  • オンラインでのアクセス
  • 技術的なサポートの連絡先
    • 商用サポート
  • コメントおよび提案の送付方法
• インストール
  • インストール要件
  • ダウンロード
  • TAR.GZ版でのインストール
    • OpenSearchのインストール
    • Fessのインストール
  • ZIP版でのインストール
    • OpenSearchのインストール
    • Fessのインストール
  • RPM/DEB版でのインストール
    • OpenSearchのインストール
    • Fessのインストール
  • Docker版でのインストール
• 起動および停止方法
  • 起動方法
    • TAR.GZ版の場合
    • ZIP版の場合
    • RPM/DEB版の場合 (chkconfig)
    • RPM/DEB版の場合 (systemd)
    • Docker版の場合
  • ブラウザー UI へのアクセス
  • 停止方法
    • TAR.GZ/ZIP版の場合
    • RPM/DEB版の場合 (chkconfig)
    • RPM/DEB版の場合 (systemd)
    • Docker版の場合
• アンインストール
  • アンインストール
    • TAR.GZ/ZIP版の場合
    • RPM/DEB版の場合
• アップグレード
  • Fess のアップグレード
    • データのバックアップ
    • パッケージの更新
    • 設定のリストア
    • クローラーの起動

Fess ユーザーガイド

• はじめに
  • 対象読者
  • お読みになる前に
  • オンラインでのアクセス
  • 技術的なサポートの連絡先
    • 商用サポート
  • 関連サードパーティー Web サイトの参照
  • コメントおよび提案の送付方法
• AND 検索
  • AND 検索
    • 利用方法
• OR 検索
  • OR 検索
    • 利用方法
• NOT 検索
  • NOT 検索
    • 利用方法
• ラベル指定検索
  • ラベル指定検索 (カテゴリ検索)
    • 利用方法
• 検索フィールド指定検索
  • フィールド指定検索
    • 利用可能なフィールド
    • 利用方法
• ソート検索
  • ソート検索
    • ソート対象フィールド
    • 利用方法
• ワイルドカード検索
  • ワイルドカード検索
    • 利用方法
    • 利用条件
• 範囲指定検索
  • 範囲指定検索
    • 利用方法
• ブースト検索
  • ブースト検索(重み付け検索)
    • 利用方法
• 曖昧検索
  • 曖昧検索(ファジー検索)
    • 利用方法
• 位置情報検索
  • 位置情報検索
    • 利用方法
• 非表示検索条件
  • 非表示検索条件
    • 利用方法
• ロール検索
  • ロール検索
    • 検索方法
    • パスワードの変更
    • ログアウト
• 特殊文字
  • 特殊文字
    • 利用方法
• 詳細検索
  • 詳細検索
    • 利用方法
    • 項目一覧
      • すべての単語を含む
      • 語順も含めた完全一致
      • いずれかの単語を含む
      • 含めない単語
      • 表示件数
      • ソート
      • 優先する言語
      • ラベル
      • 更新日時
      • ファイル形式
      • 検索対象
      • サイトまたはドメイン

Fess APIガイド

• はじめに
  • 対象読者
  • お読みになる前に
  • オンラインでのアクセス
  • 技術的なサポートの連絡先
    • 商用サポート
  • 関連サードパーティー Web サイトの参照
  • コメントおよび提案の送付方法
• APIの概要
  • Fess の提供するAPI
  • APIの種類
• 検索API
  • 検索結果の取得
    • リクエストパラメーター
    • レスポンス
  • 全てのドキュメントを検索
    • リクエストパラメーター
• ラベルAPI
  • ラベルの取得
    • リクエストパラメーター
    • レスポンス
• 人気ワードAPI
  • 人気ワード一覧の取得
    • リクエストパラメーター
    • レスポンス
• サジェストAPI
  • サジェストワード一覧の取得
    • リクエストパラメーター
    • レスポンス
• Health API
  • 状態の取得
    • リクエストパラメーター
    • レスポンス

Fess 管理者ガイド

• はじめに
  • 対象読者
  • お読みになる前に
  • オンラインでのアクセス
  • 技術的なサポートの連絡先
    • 商用サポート
• ダッシュボード
  • 概要
  • インデックスされているドキュメント数の確認
• 構成ウィザード
  • 概要
    • 簡易セットアップ
    • クロールの設定
    • 設定項目
      • 名前
      • クロールパス
      • 最大アクセス数
      • 深さ
    • クローラ
• 全般
  • 概要
  • 設定内容
    • システム
      • JSONレスポンス
      • ログインが必要
      • ログインリンク表示
      • 重複結果の折り畳み
      • サムネイル表示
      • デフォルトのラベル値
      • デフォルトのソート値
      • 仮想ホスト
      • 人気ワードのレスポンス
      • CSVファイルのエンコード
      • 検索パラメーターの追加
      • 通知メール
    • クローラー
      • 最終更新日時の確認
      • 同時クローラー設定
      • 以前のドキュメントを削除
      • 除外するエラーの種類
      • 障害数のしきい値
    • ロギング
      • 検索ログ
      • ユーザログ
      • お気に入りログ
      • 以前の検索ログを削除
      • 以前のジョブログを削除
      • 以前のユーザーログを削除
      • ログを削除するボット名
      • ログレベル
    • サジェスト
      • 検索語でサジェスト
      • ドキュメントでサジェスト
      • 以前のサジェスト情報を削除
    • LDAP
      • LDAP URL
      • Base DN
      • Bind DN
      • パスワード
      • User DN
      • アカウントフィルター
      • グループフィルター
      • memberOf属性
    • お知らせ表示
      • ログインページ
      • 検索トップページ
    • ストレージ
      • エンドポイント
      • アクセスキー
      • シークレットキー
      • バケット
  • 例
    • LDAPの設定例
• スケジューラ
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
      • 対象
      • スケジュール
      • 実行方法
      • スクリプト
      • ロギング
      • クローラージョブ
      • 状態
      • 表示順序
    • 設定の削除
  • 手動クロール方法
• ページのデザイン
  • 概要
  • 設定方法
    • 表示方法
    • ファイルマネージャー
    • ページファイルの表示
    • アップロードするファイル
      • ファイルのアップロード
      • フィイル名(オプション)
• 辞書
  • 概要
  • 一覧
  • Kuromoji
  • 同義語
  • マッピング
  • Protwords
  • ストップワード
  • Stemmer上書き
• Kuromoji辞書
  • 概要
  • 管理方法
    • 表示方法
    • 設定方法
    • 設定項目
      • トークン
      • 分割
      • 読み
      • 品詞
  • ダウンロード
  • アップロード
• 同義語辞書
  • 概要
  • 管理方法
    • 表示方法
    • 設定方法
    • 設定項目
      • 変換元
      • 変換後
  • ダウンロード
  • アップロード
• マッピング辞書
  • 概要
  • 管理方法
    • 表示方法
    • 設定方法
    • 設定項目
      • 変換元
      • 変換後
  • ダウンロード
  • アップロード
• Protwords辞書
  • 概要
  • 管理方法
    • 表示方法
    • 設定方法
    • 設定項目
      • 単語情報
  • ダウンロード
  • アップロード
• ストップワード辞書
  • 概要
  • 管理方法
    • 表示方法
    • 設定方法
    • 設定項目
      • 変換元
      • 変換後
  • ダウンロード
  • アップロード
• Stemmer上書き辞書
  • 概要
  • 管理方法
    • 表示方法
    • 設定方法
    • 設定項目
      • 変換元
      • 変換後
  • ダウンロード
  • アップロード
• アクセストークン
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
      • パーミッション
      • パラメーター名
      • 有効期限
    • 設定の削除
• プラグイン
  • 概要
  • 管理方法
    • 表示方法
    • インストール
• ストレージ
  • 概要
  • 管理方法
    • オブジェクトストレージサーバーの設定
    • 表示方法
      • 名前
      • サイズ
      • 最終更新日時
    • ダウンロード
    • 削除
    • アップロード
    • フォルダーの作成
• ウェブクロール
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
      • URL
      • クロール対象とするURL
      • クロール対象から除外するURL
      • 検索対象とするURL
      • 検索対象から除外するURL
      • 設定パラメーター
      • 深さ
      • 最大アクセス数
      • ユーザーエージェント
      • スレッド数
      • 間隔
      • ブースト値
      • パーミッション
      • 仮想ホスト
      • 状態
      • 説明
    • 設定の削除
  • 例
    • fess.codelibs.org をクロールする
    • ウェブ認証サイトのウェブクロール
      • Redmine
      • XWiki
• ファイルクロール
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
      • パス
      • クロール対象とするパス
      • クロール対象から除外するパス
      • 検索対象とするパス
      • 検索対象から除外するパス
      • 設定パラメーター
      • 深さ
      • 最大アクセス数
      • スレッド数
      • 間隔
      • ブースト値
      • パーミッション
      • 仮想ホスト
      • 状態
      • 説明
    • 設定の削除
  • 例
    • ローカルファイルをクロール
    • Windowsの共有フォルダーをクロール
• データストアクロール
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
      • ハンドラー名
      • パラメーター
      • スクリプト
      • ブースト値
      • パーミッション
      • 仮想ホスト
      • 状態
      • 説明
    • 設定の削除
  • 例
    • DatabaseDataStore
      • パラメーター
      • スクリプト
      • ドライバー
    • CsvDataStore
      • パラメーター
      • スクリプト
    • EsDataStore
      • パラメーター
      • スクリプト
    • CsvListDataStore
      • パラメーター
      • スクリプト
• ラベル
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
      • 値
      • 対象とするパス
      • 除外するパス
      • パーミッション
      • 仮想ホスト
      • 表示順序
    • 設定の削除
• キーマッチ
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 検索語
      • クエリー
      • サイズ
      • ブースト値
      • 仮想ホスト
    • 設定の削除
• ドキュメントブースト
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 条件
      • ブースト値式
      • ソート順
    • 設定の削除
• 関連コンテンツ
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 検索語
      • コンテンツ
      • 仮想ホスト
    • 設定の削除
• 関連クエリー
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 検索語
      • クエリー
      • 仮想ホスト
    • 設定の削除
• パスマッピング
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 正規表現
      • 置換
      • 処理の種類
      • 表示順序
    • 設定の削除
• ウェブ認証
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • ホスト名
      • ポート
      • レルム
      • スキーム
      • ユーザー名
      • パスワード
      • パラメーター
      • ウェブ設定
    • 設定の削除
• ファイル認証
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • ホスト名
      • ポート
      • スキーム
      • ユーザー名
      • パスワード
      • パラメーター
      • ファイルクロール設定
    • 設定の削除
• リクエストヘッダー
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
      • 値
      • ウェブ設定
    • 設定の削除
• 重複ホスト
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 正規名
      • 重複名
    • 設定の削除
• ユーザー
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • ユーザー名
      • ロール
      • グループ
    • 設定の削除
• ロール
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
    • 設定の削除
• グループ
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
    • 削除の方法
• サジェストワード
  • 概要
  • 管理方法
    • 表示方法
      • 単語種別
      • 単語数
• 追加ワード
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 単語
      • 読み
      • パーミッション
      • ラベル
      • ブースト値
    • 設定の削除
  • ダウンロード
    • CSVの内容
  • アップロード
    • CSVの内容
• 除外ワード
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • サジェスト候補
    • 設定の削除
  • ダウンロード
    • CSVの内容
  • アップロード
    • CSVの内容
• システム情報
  • 概要
  • 管理方法
    • 表示方法
    • 表示項目
      • 環境変数のプロパティ
      • システムのプロパティ
      • アプリのプロパティ
      • バグレポートのプロパティ
• 検索ログ
  • 概要
  • 管理方法
  • 一覧
  • 詳細
• ジョブログ
  • 概要
  • 管理方法
    • 表示方法
    • ジョブログ詳細
      • 名前
      • 状態
      • 対象
      • 開始時間
      • 終了時間
      • 実行方法
      • スクリプト
      • 結果
• クロール情報
  • 概要
  • 管理方法
  • 一覧
  • 詳細
    • 項目一覧
      • セッションID
      • クローラーの開始時間
      • クロールの開始時間 (ウェブ/ファイル)
      • クロールの開始時間 (データストア)
      • クロールの終了時間 (ウェブ/ファイル)
      • クロールの実行時間 (データストア)
      • インデクシングの実行時間 (データストア)
      • インデックスのサイズ (データストア)
      • クロールの終了時間 (データストア)
      • クローラーの状態
      • クローラーの終了時間
      • クローラーの実行時間
• ログファイル
  • 概要
  • 設定方法
    • 表示方法
    • ダウンロード
      • server_*.log
      • fess.log
      • fess-crawler.log
      • audit.log
      • fess-thumbnail.log
      • fess-suggest.log
      • fess-urls.log
      • search.log
      • gc-crawler.log
• 障害URL
  • 概要
  • 管理方法
    • 表示方法
  • 障害URLの詳細
    • 詳細の内容
      • URL
      • スレッド名
      • 種類
      • ログ
      • エラー回数
      • 最終アクセス日時
• 検索
  • 概要
  • 管理方法
    • 表示方法
    • 検索一覧
    • 一括削除
• バックアップ
  • 概要
    • ダウンロード
      • fess_config.bulk
      • fess_basic_config.bulk
      • fess_user.bulk
      • system.properties
      • fess.json
      • doc.json
      • click_log.ndjson
      • favorite_log.ndjson
      • search_log.ndjson
      • user_info.ndjson
    • アップロード
• メンテナンス
  • 概要
  • 操作方法
    • 再インデクシング
    • 設定項目
      • エイリアスの更新
      • 辞書の初期化
      • シャード数
      • 最大レプリカ数
    • ドキュメントインデックスのリロード
    • Crawlerインデックス
    • 診断
• クエリーリクエスト
  • 概要
  • 操作方法
    • リクエストの送信
    • 設定項目
      • リクエストファイル

Fess 設定ガイド

• はじめに
  • 対象読者
  • お読みになる前に
  • オンラインでのアクセス
  • 技術的なサポートの連絡先
    • 商用サポート
  • 関連サードパーティー Web サイトの参照
  • コメントおよび提案の送付方法
• システム関連の設定
  • 使用ポートの設定
  • 使用メモリーの設定
    • ウェブアプリのメモリー設定
    • クローラーのメモリー設定
    • OpenSearchのメモリー設定
  • ログの設定
    • ログのファイル
    • ログレベルの変更
• クローラー関連の設定
  • 単語の長さの上限の設定
  • ファイルサイズの設定
  • プロキシの設定
    • 設定方法
• 検索関連の設定
  • ファジー検索
  • 検索時のタイムアウト値
  • 検索時の最大文字数
  • 検索時のタイムアウトのログ出力
  • ヒット件数表示
  • 位置情報検索時のインデックス名
  • リクエストパラメータの言語指定
  • 前方一致検索の指定
  • ハイライトの文字列
  • ハイライトのフラグメント
  • ハイライト生成方法
  • ハイライト対象のタグ
  • OpenSearchのハイライターに渡す値
  • レスポンスに追加するフィールド名
  • フィールド名の追加
  • 検索結果をGSA互換のXML形式で取得する際の設定
• 検索フォームの配置
  • 検索フォームの配置方法
    • 検索フォーム
    • サジェスト
• 仮想ホスト
  • 仮想ホストについて
    • システム設定
    • クロール設定
• Windowsサービスへの登録
  • Windowsサービスとしての登録
    • 事前準備
    • OpenSearchをサービスとして登録
    • 設定
    • 登録方法
    • サービスの設定
• ロールベース検索の設定
  • ロールベース検索について
  • ロールベース検索の設定
    • Fess の管理画面での設定
    • ログイン
    • ログアウト
• インデックスの管理
  • インデックスのバックアップとリストア
• Analyzerの設定
  • Analyzerについて
• 位置情報検索
  • 概要
  • 設定
    • インデックス生成時
    • 検索時
• サムネイル画像の設定
  • サムネイル画像の表示
  • HTMLファイルのサムネイル画像
  • MS Officeファイルのサムネイル画像
    • パッケージのインストール
    • 生成スクリプト
  • PDFファイルのサムネイル画像
  • サムネイルジョブの無効化
• 検索結果の一括取得
  • 検索結果の一括取得について
  • 利用方法
    • スクロール検索の設定
    • スクロール検索の利用
• 検索機能
  • 検索結果件数の表示

JavaDocs

XRef

I/F Doc

15.0

Fess インストールガイド

• はじめに
  • 対象読者
  • お読みになる前に
  • オンラインでのアクセス
  • 技術的なサポートの連絡先
    • 商用サポート
  • コメントおよび提案の送付方法
• インストール
  • インストール要件
  • ダウンロード
  • TAR.GZ版でのインストール
    • OpenSearchのインストール
    • Fessのインストール
  • ZIP版でのインストール
    • OpenSearchのインストール
    • Fessのインストール
  • RPM/DEB版でのインストール
    • OpenSearchのインストール
    • Fessのインストール
  • Docker版でのインストール
• 起動および停止方法
  • 起動方法
    • TAR.GZ版の場合
    • ZIP版の場合
    • RPM/DEB版の場合 (chkconfig)
    • RPM/DEB版の場合 (systemd)
    • Docker版の場合
  • ブラウザー UI へのアクセス
  • 停止方法
    • TAR.GZ/ZIP版の場合
    • RPM/DEB版の場合 (chkconfig)
    • RPM/DEB版の場合 (systemd)
    • Docker版の場合
• アンインストール
  • アンインストール
    • TAR.GZ/ZIP版の場合
    • RPM/DEB版の場合
• アップグレード
  • Fess のアップグレード
    • データのバックアップ
    • パッケージの更新
    • 設定のリストア
    • クローラーの起動

Fess ユーザーガイド

• はじめに
  • 対象読者
  • お読みになる前に
  • オンラインでのアクセス
  • 技術的なサポートの連絡先
    • 商用サポート
  • 関連サードパーティー Web サイトの参照
  • コメントおよび提案の送付方法
• AND 検索
  • AND 検索
    • 利用方法
• OR 検索
  • OR 検索
    • 利用方法
• NOT 検索
  • NOT 検索
    • 利用方法
• ラベル指定検索
  • ラベル指定検索 (カテゴリ検索)
    • 利用方法
• 検索フィールド指定検索
  • フィールド指定検索
    • 利用可能なフィールド
    • 利用方法
• ソート検索
  • ソート検索
    • ソート対象フィールド
    • 利用方法
• ワイルドカード検索
  • ワイルドカード検索
    • 利用方法
    • 利用条件
• 範囲指定検索
  • 範囲指定検索
    • 利用方法
• ブースト検索
  • ブースト検索(重み付け検索)
    • 利用方法
• 曖昧検索
  • 曖昧検索(ファジー検索)
    • 利用方法
• 位置情報検索
  • 位置情報検索
    • 利用方法
• 非表示検索条件
  • 非表示検索条件
    • 利用方法
• ロール検索
  • ロール検索
    • 検索方法
    • パスワードの変更
    • ログアウト
• 特殊文字
  • 特殊文字
    • 利用方法
• 詳細検索
  • 詳細検索
    • 利用方法
    • 項目一覧
      • すべての単語を含む
      • 語順も含めた完全一致
      • いずれかの単語を含む
      • 含めない単語
      • 表示件数
      • ソート
      • 優先する言語
      • ラベル
      • 更新日時
      • ファイル形式
      • 検索対象
      • サイトまたはドメイン

Fess APIガイド

• はじめに
  • 対象読者
  • お読みになる前に
  • オンラインでのアクセス
  • 技術的なサポートの連絡先
    • 商用サポート
  • 関連サードパーティー Web サイトの参照
  • コメントおよび提案の送付方法
• APIの概要
  • Fess の提供するAPI
  • APIの種類
• 検索API
  • 検索結果の取得
    • リクエストパラメーター
    • レスポンス
  • 全てのドキュメントを検索
    • リクエストパラメーター
• ラベルAPI
  • ラベルの取得
    • リクエストパラメーター
    • レスポンス
• 人気ワードAPI
  • 人気ワード一覧の取得
    • リクエストパラメーター
    • レスポンス
• サジェストAPI
  • サジェストワード一覧の取得
    • リクエストパラメーター
    • レスポンス
• Health API
  • 状態の取得
    • リクエストパラメーター
    • レスポンス

Fess 管理者ガイド

• はじめに
  • 対象読者
  • お読みになる前に
  • オンラインでのアクセス
  • 技術的なサポートの連絡先
    • 商用サポート
• ダッシュボード
  • 概要
  • インデックスされているドキュメント数の確認
• 構成ウィザード
  • 概要
    • 簡易セットアップ
    • クロールの設定
    • 設定項目
      • 名前
      • クロールパス
      • 最大アクセス数
      • 深さ
    • クローラ
• 全般
  • 概要
  • 設定内容
    • システム
      • JSONレスポンス
      • ログインが必要
      • ログインリンク表示
      • 重複結果の折り畳み
      • サムネイル表示
      • デフォルトのラベル値
      • デフォルトのソート値
      • 仮想ホスト
      • 人気ワードのレスポンス
      • CSVファイルのエンコード
      • 検索パラメーターの追加
      • 通知メール
    • クローラー
      • 最終更新日時の確認
      • 同時クローラー設定
      • 以前のドキュメントを削除
      • 除外するエラーの種類
      • 障害数のしきい値
    • ロギング
      • 検索ログ
      • ユーザログ
      • お気に入りログ
      • 以前の検索ログを削除
      • 以前のジョブログを削除
      • 以前のユーザーログを削除
      • ログを削除するボット名
      • ログレベル
    • サジェスト
      • 検索語でサジェスト
      • ドキュメントでサジェスト
      • 以前のサジェスト情報を削除
    • LDAP
      • LDAP URL
      • Base DN
      • Bind DN
      • パスワード
      • User DN
      • アカウントフィルター
      • グループフィルター
      • memberOf属性
    • お知らせ表示
      • ログインページ
      • 検索トップページ
    • ストレージ
      • エンドポイント
      • アクセスキー
      • シークレットキー
      • バケット
  • 例
    • LDAPの設定例
• スケジューラ
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
      • 対象
      • スケジュール
      • 実行方法
      • スクリプト
      • ロギング
      • クローラージョブ
      • 状態
      • 表示順序
    • 設定の削除
  • 手動クロール方法
• ページのデザイン
  • 概要
  • 設定方法
    • 表示方法
    • ファイルマネージャー
    • ページファイルの表示
    • アップロードするファイル
      • ファイルのアップロード
      • フィイル名(オプション)
• 辞書
  • 概要
  • 一覧
  • Kuromoji
  • 同義語
  • マッピング
  • Protwords
  • ストップワード
  • Stemmer上書き
• Kuromoji辞書
  • 概要
  • 管理方法
    • 表示方法
    • 設定方法
    • 設定項目
      • トークン
      • 分割
      • 読み
      • 品詞
  • ダウンロード
  • アップロード
• 同義語辞書
  • 概要
  • 管理方法
    • 表示方法
    • 設定方法
    • 設定項目
      • 変換元
      • 変換後
  • ダウンロード
  • アップロード
• マッピング辞書
  • 概要
  • 管理方法
    • 表示方法
    • 設定方法
    • 設定項目
      • 変換元
      • 変換後
  • ダウンロード
  • アップロード
• Protwords辞書
  • 概要
  • 管理方法
    • 表示方法
    • 設定方法
    • 設定項目
      • 単語情報
  • ダウンロード
  • アップロード
• ストップワード辞書
  • 概要
  • 管理方法
    • 表示方法
    • 設定方法
    • 設定項目
      • 変換元
      • 変換後
  • ダウンロード
  • アップロード
• Stemmer上書き辞書
  • 概要
  • 管理方法
    • 表示方法
    • 設定方法
    • 設定項目
      • 変換元
      • 変換後
  • ダウンロード
  • アップロード
• アクセストークン
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
      • パーミッション
      • パラメーター名
      • 有効期限
    • 設定の削除
• プラグイン
  • 概要
  • 管理方法
    • 表示方法
    • インストール
• ストレージ
  • 概要
  • 管理方法
    • オブジェクトストレージサーバーの設定
    • 表示方法
      • 名前
      • サイズ
      • 最終更新日時
    • ダウンロード
    • 削除
    • アップロード
    • フォルダーの作成
• ウェブクロール
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
      • URL
      • クロール対象とするURL
      • クロール対象から除外するURL
      • 検索対象とするURL
      • 検索対象から除外するURL
      • 設定パラメーター
      • 深さ
      • 最大アクセス数
      • ユーザーエージェント
      • スレッド数
      • 間隔
      • ブースト値
      • パーミッション
      • 仮想ホスト
      • 状態
      • 説明
    • 設定の削除
  • 例
    • fess.codelibs.org をクロールする
    • ウェブ認証サイトのウェブクロール
      • Redmine
      • XWiki
• ファイルクロール
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
      • パス
      • クロール対象とするパス
      • クロール対象から除外するパス
      • 検索対象とするパス
      • 検索対象から除外するパス
      • 設定パラメーター
      • 深さ
      • 最大アクセス数
      • スレッド数
      • 間隔
      • ブースト値
      • パーミッション
      • 仮想ホスト
      • 状態
      • 説明
    • 設定の削除
  • 例
    • ローカルファイルをクロール
    • Windowsの共有フォルダーをクロール
• データストアクロール
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
      • ハンドラー名
      • パラメーター
      • スクリプト
      • ブースト値
      • パーミッション
      • 仮想ホスト
      • 状態
      • 説明
    • 設定の削除
  • 例
    • DatabaseDataStore
      • パラメーター
      • スクリプト
      • ドライバー
    • CsvDataStore
      • パラメーター
      • スクリプト
    • EsDataStore
      • パラメーター
      • スクリプト
    • CsvListDataStore
      • パラメーター
      • スクリプト
• ラベル
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
      • 値
      • 対象とするパス
      • 除外するパス
      • パーミッション
      • 仮想ホスト
      • 表示順序
    • 設定の削除
• キーマッチ
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 検索語
      • クエリー
      • サイズ
      • ブースト値
      • 仮想ホスト
    • 設定の削除
• ドキュメントブースト
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 条件
      • ブースト値式
      • ソート順
    • 設定の削除
• 関連コンテンツ
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 検索語
      • コンテンツ
      • 仮想ホスト
    • 設定の削除
• 関連クエリー
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 検索語
      • クエリー
      • 仮想ホスト
    • 設定の削除
• パスマッピング
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 正規表現
      • 置換
      • 処理の種類
      • 表示順序
    • 設定の削除
• ウェブ認証
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • ホスト名
      • ポート
      • レルム
      • スキーム
      • ユーザー名
      • パスワード
      • パラメーター
      • ウェブ設定
    • 設定の削除
• ファイル認証
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • ホスト名
      • ポート
      • スキーム
      • ユーザー名
      • パスワード
      • パラメーター
      • ファイルクロール設定
    • 設定の削除
• リクエストヘッダー
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
      • 値
      • ウェブ設定
    • 設定の削除
• 重複ホスト
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 正規名
      • 重複名
    • 設定の削除
• ユーザー
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • ユーザー名
      • ロール
      • グループ
    • 設定の削除
• ロール
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
    • 設定の削除
• グループ
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
    • 削除の方法
• サジェストワード
  • 概要
  • 管理方法
    • 表示方法
      • 単語種別
      • 単語数
• 追加ワード
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 単語
      • 読み
      • パーミッション
      • ラベル
      • ブースト値
    • 設定の削除
  • ダウンロード
    • CSVの内容
  • アップロード
    • CSVの内容
• 除外ワード
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • サジェスト候補
    • 設定の削除
  • ダウンロード
    • CSVの内容
  • アップロード
    • CSVの内容
• システム情報
  • 概要
  • 管理方法
    • 表示方法
    • 表示項目
      • 環境変数のプロパティ
      • システムのプロパティ
      • アプリのプロパティ
      • バグレポートのプロパティ
• 検索ログ
  • 概要
  • 管理方法
  • 一覧
  • 詳細
• ジョブログ
  • 概要
  • 管理方法
    • 表示方法
    • ジョブログ詳細
      • 名前
      • 状態
      • 対象
      • 開始時間
      • 終了時間
      • 実行方法
      • スクリプト
      • 結果
• クロール情報
  • 概要
  • 管理方法
  • 一覧
  • 詳細
    • 項目一覧
      • セッションID
      • クローラーの開始時間
      • クロールの開始時間 (ウェブ/ファイル)
      • クロールの開始時間 (データストア)
      • クロールの終了時間 (ウェブ/ファイル)
      • クロールの実行時間 (データストア)
      • インデクシングの実行時間 (データストア)
      • インデックスのサイズ (データストア)
      • クロールの終了時間 (データストア)
      • クローラーの状態
      • クローラーの終了時間
      • クローラーの実行時間
• ログファイル
  • 概要
  • 設定方法
    • 表示方法
    • ダウンロード
      • server_*.log
      • fess.log
      • fess-crawler.log
      • audit.log
      • fess-thumbnail.log
      • fess-suggest.log
      • fess-urls.log
      • search.log
      • gc-crawler.log
• 障害URL
  • 概要
  • 管理方法
    • 表示方法
  • 障害URLの詳細
    • 詳細の内容
      • URL
      • スレッド名
      • 種類
      • ログ
      • エラー回数
      • 最終アクセス日時
• 検索
  • 概要
  • 管理方法
    • 表示方法
    • 検索一覧
    • 一括削除
• バックアップ
  • 概要
    • ダウンロード
      • fess_config.bulk
      • fess_basic_config.bulk
      • fess_user.bulk
      • system.properties
      • fess.json
      • doc.json
      • click_log.ndjson
      • favorite_log.ndjson
      • search_log.ndjson
      • user_info.ndjson
    • アップロード
• メンテナンス
  • 概要
  • 操作方法
    • 再インデクシング
    • 設定項目
      • エイリアスの更新
      • 辞書の初期化
      • シャード数
      • 最大レプリカ数
    • ドキュメントインデックスのリロード
    • Crawlerインデックス
    • 診断
• クエリーリクエスト
  • 概要
  • 操作方法
    • リクエストの送信
    • 設定項目
      • リクエストファイル

Fess 設定ガイド

• はじめに
  • 対象読者
  • お読みになる前に
  • オンラインでのアクセス
  • 技術的なサポートの連絡先
    • 商用サポート
  • 関連サードパーティー Web サイトの参照
  • コメントおよび提案の送付方法
• システム関連の設定
  • 使用ポートの設定
  • 使用メモリーの設定
    • ウェブアプリのメモリー設定
    • クローラーのメモリー設定
    • OpenSearchのメモリー設定
  • ログの設定
    • ログのファイル
    • ログレベルの変更
• クローラー関連の設定
  • 単語の長さの上限の設定
  • ファイルサイズの設定
  • プロキシの設定
    • 設定方法
• 検索関連の設定
  • ファジー検索
  • 検索時のタイムアウト値
  • 検索時の最大文字数
  • 検索時のタイムアウトのログ出力
  • ヒット件数表示
  • 位置情報検索時のインデックス名
  • リクエストパラメータの言語指定
  • 前方一致検索の指定
  • ハイライトの文字列
  • ハイライトのフラグメント
  • ハイライト生成方法
  • ハイライト対象のタグ
  • OpenSearchのハイライターに渡す値
  • レスポンスに追加するフィールド名
  • フィールド名の追加
  • 検索結果をGSA互換のXML形式で取得する際の設定
• 検索フォームの配置
  • 検索フォームの配置方法
    • 検索フォーム
    • サジェスト
• 仮想ホスト
  • 仮想ホストについて
    • システム設定
    • クロール設定
• Windowsサービスへの登録
  • Windowsサービスとしての登録
    • 事前準備
    • OpenSearchをサービスとして登録
    • 設定
    • 登録方法
    • サービスの設定
• ロールベース検索の設定
  • ロールベース検索について
  • ロールベース検索の設定
    • Fess の管理画面での設定
    • ログイン
    • ログアウト
• インデックスの管理
  • インデックスのバックアップとリストア
• Analyzerの設定
  • Analyzerについて
• 位置情報検索
  • 概要
  • 設定
    • インデックス生成時
    • 検索時
• サムネイル画像の設定
  • サムネイル画像の表示
  • HTMLファイルのサムネイル画像
  • MS Officeファイルのサムネイル画像
    • パッケージのインストール
    • 生成スクリプト
  • PDFファイルのサムネイル画像
  • サムネイルジョブの無効化
• 検索結果の一括取得
  • 検索結果の一括取得について
  • 利用方法
    • スクロール検索の設定
    • スクロール検索の利用
• 検索機能
  • 検索結果件数の表示

JavaDocs

XRef

I/F Doc

14.19

Fess インストールガイド

• はじめに
  • 対象読者
  • お読みになる前に
  • オンラインでのアクセス
  • 技術的なサポートの連絡先
    • 商用サポート
  • コメントおよび提案の送付方法
• インストール
  • インストール要件
  • ダウンロード
  • TAR.GZ版でのインストール
    • OpenSearchのインストール
    • Fessのインストール
  • ZIP版でのインストール
    • OpenSearchのインストール
    • Fessのインストール
  • RPM/DEB版でのインストール
    • OpenSearchのインストール
    • Fessのインストール
  • Docker版でのインストール
• 起動および停止方法
  • 起動方法
    • TAR.GZ版の場合
    • ZIP版の場合
    • RPM/DEB版の場合 (chkconfig)
    • RPM/DEB版の場合 (systemd)
    • Docker版の場合
  • ブラウザー UI へのアクセス
  • 停止方法
    • TAR.GZ/ZIP版の場合
    • RPM/DEB版の場合 (chkconfig)
    • RPM/DEB版の場合 (systemd)
    • Docker版の場合
• アンインストール
  • アンインストール
    • TAR.GZ/ZIP版の場合
    • RPM/DEB版の場合
• アップグレード
  • Fess のアップグレード
    • データのバックアップ
    • パッケージの更新
    • 設定のリストア
    • クローラーの起動

Fess ユーザーガイド

• はじめに
  • 対象読者
  • お読みになる前に
  • オンラインでのアクセス
  • 技術的なサポートの連絡先
    • 商用サポート
  • 関連サードパーティー Web サイトの参照
  • コメントおよび提案の送付方法
• AND 検索
  • AND 検索
    • 利用方法
• OR 検索
  • OR 検索
    • 利用方法
• NOT 検索
  • NOT 検索
    • 利用方法
• ラベル指定検索
  • ラベル指定検索 (カテゴリ検索)
    • 利用方法
• 検索フィールド指定検索
  • フィールド指定検索
    • 利用可能なフィールド
    • 利用方法
• ソート検索
  • ソート検索
    • ソート対象フィールド
    • 利用方法
• ワイルドカード検索
  • ワイルドカード検索
    • 利用方法
    • 利用条件
• 範囲指定検索
  • 範囲指定検索
    • 利用方法
• ブースト検索
  • ブースト検索(重み付け検索)
    • 利用方法
• 曖昧検索
  • 曖昧検索(ファジー検索)
    • 利用方法
• 位置情報検索
  • 位置情報検索
    • 利用方法
• 非表示検索条件
  • 非表示検索条件
    • 利用方法
• ロール検索
  • ロール検索
    • 検索方法
    • パスワードの変更
    • ログアウト
• 特殊文字
  • 特殊文字
    • 利用方法
• 詳細検索
  • 詳細検索
    • 利用方法
    • 項目一覧
      • すべての単語を含む
      • 語順も含めた完全一致
      • いずれかの単語を含む
      • 含めない単語
      • 表示件数
      • ソート
      • 優先する言語
      • ラベル
      • 更新日時
      • ファイル形式
      • 検索対象
      • サイトまたはドメイン

Fess APIガイド

• はじめに
  • 対象読者
  • お読みになる前に
  • オンラインでのアクセス
  • 技術的なサポートの連絡先
    • 商用サポート
  • 関連サードパーティー Web サイトの参照
  • コメントおよび提案の送付方法
• APIの概要
  • Fess の提供するAPI
  • APIの種類
• 検索API
  • 検索結果の取得
    • リクエストパラメーター
    • レスポンス
  • 全てのドキュメントを検索
    • リクエストパラメーター
• ラベルAPI
  • ラベルの取得
    • リクエストパラメーター
    • レスポンス
• 人気ワードAPI
  • 人気ワード一覧の取得
    • リクエストパラメーター
    • レスポンス
• サジェストAPI
  • サジェストワード一覧の取得
    • リクエストパラメーター
    • レスポンス
• Health API
  • 状態の取得
    • リクエストパラメーター
    • レスポンス

Fess 管理者ガイド

• はじめに
  • 対象読者
  • お読みになる前に
  • オンラインでのアクセス
  • 技術的なサポートの連絡先
    • 商用サポート
• ダッシュボード
  • 概要
  • インデックスされているドキュメント数の確認
• 構成ウィザード
  • 概要
    • 簡易セットアップ
    • クロールの設定
    • 設定項目
      • 名前
      • クロールパス
      • 最大アクセス数
      • 深さ
    • クローラ
• 全般
  • 概要
  • 設定内容
    • システム
      • JSONレスポンス
      • ログインが必要
      • ログインリンク表示
      • 重複結果の折り畳み
      • サムネイル表示
      • デフォルトのラベル値
      • デフォルトのソート値
      • 仮想ホスト
      • 人気ワードのレスポンス
      • CSVファイルのエンコード
      • 検索パラメーターの追加
      • 通知メール
    • クローラー
      • 最終更新日時の確認
      • 同時クローラー設定
      • 以前のドキュメントを削除
      • 除外するエラーの種類
      • 障害数のしきい値
    • ロギング
      • 検索ログ
      • ユーザログ
      • お気に入りログ
      • 以前の検索ログを削除
      • 以前のジョブログを削除
      • 以前のユーザーログを削除
      • ログを削除するボット名
      • ログレベル
    • サジェスト
      • 検索語でサジェスト
      • ドキュメントでサジェスト
      • 以前のサジェスト情報を削除
    • LDAP
      • LDAP URL
      • Base DN
      • Bind DN
      • パスワード
      • User DN
      • アカウントフィルター
      • グループフィルター
      • memberOf属性
    • お知らせ表示
      • ログインページ
      • 検索トップページ
    • ストレージ
      • エンドポイント
      • アクセスキー
      • シークレットキー
      • バケット
  • 例
    • LDAPの設定例
• スケジューラ
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
      • 対象
      • スケジュール
      • 実行方法
      • スクリプト
      • ロギング
      • クローラージョブ
      • 状態
      • 表示順序
    • 設定の削除
  • 手動クロール方法
• ページのデザイン
  • 概要
  • 設定方法
    • 表示方法
    • ファイルマネージャー
    • ページファイルの表示
    • アップロードするファイル
      • ファイルのアップロード
      • フィイル名(オプション)
• 辞書
  • 概要
  • 一覧
  • Kuromoji
  • 同義語
  • マッピング
  • Protwords
  • ストップワード
  • Stemmer上書き
• Kuromoji辞書
  • 概要
  • 管理方法
    • 表示方法
    • 設定方法
    • 設定項目
      • トークン
      • 分割
      • 読み
      • 品詞
  • ダウンロード
  • アップロード
• 同義語辞書
  • 概要
  • 管理方法
    • 表示方法
    • 設定方法
    • 設定項目
      • 変換元
      • 変換後
  • ダウンロード
  • アップロード
• マッピング辞書
  • 概要
  • 管理方法
    • 表示方法
    • 設定方法
    • 設定項目
      • 変換元
      • 変換後
  • ダウンロード
  • アップロード
• Protwords辞書
  • 概要
  • 管理方法
    • 表示方法
    • 設定方法
    • 設定項目
      • 単語情報
  • ダウンロード
  • アップロード
• ストップワード辞書
  • 概要
  • 管理方法
    • 表示方法
    • 設定方法
    • 設定項目
      • 変換元
      • 変換後
  • ダウンロード
  • アップロード
• Stemmer上書き辞書
  • 概要
  • 管理方法
    • 表示方法
    • 設定方法
    • 設定項目
      • 変換元
      • 変換後
  • ダウンロード
  • アップロード
• アクセストークン
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
      • パーミッション
      • パラメーター名
      • 有効期限
    • 設定の削除
• プラグイン
  • 概要
  • 管理方法
    • 表示方法
    • インストール
• ストレージ
  • 概要
  • 管理方法
    • オブジェクトストレージサーバーの設定
    • 表示方法
      • 名前
      • サイズ
      • 最終更新日時
    • ダウンロード
    • 削除
    • アップロード
    • フォルダーの作成
• ウェブクロール
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
      • URL
      • クロール対象とするURL
      • クロール対象から除外するURL
      • 検索対象とするURL
      • 検索対象から除外するURL
      • 設定パラメーター
      • 深さ
      • 最大アクセス数
      • ユーザーエージェント
      • スレッド数
      • 間隔
      • ブースト値
      • パーミッション
      • 仮想ホスト
      • 状態
      • 説明
    • 設定の削除
  • 例
    • fess.codelibs.org をクロールする
    • ウェブ認証サイトのウェブクロール
      • Redmine
      • XWiki
• ファイルクロール
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
      • パス
      • クロール対象とするパス
      • クロール対象から除外するパス
      • 検索対象とするパス
      • 検索対象から除外するパス
      • 設定パラメーター
      • 深さ
      • 最大アクセス数
      • スレッド数
      • 間隔
      • ブースト値
      • パーミッション
      • 仮想ホスト
      • 状態
      • 説明
    • 設定の削除
  • 例
    • ローカルファイルをクロール
    • Windowsの共有フォルダーをクロール
• データストアクロール
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
      • ハンドラー名
      • パラメーター
      • スクリプト
      • ブースト値
      • パーミッション
      • 仮想ホスト
      • 状態
      • 説明
    • 設定の削除
  • 例
    • DatabaseDataStore
      • パラメーター
      • スクリプト
      • ドライバー
    • CsvDataStore
      • パラメーター
      • スクリプト
    • EsDataStore
      • パラメーター
      • スクリプト
    • CsvListDataStore
      • パラメーター
      • スクリプト
• ラベル
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
      • 値
      • 対象とするパス
      • 除外するパス
      • パーミッション
      • 仮想ホスト
      • 表示順序
    • 設定の削除
• キーマッチ
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 検索語
      • クエリー
      • サイズ
      • ブースト値
      • 仮想ホスト
    • 設定の削除
• ドキュメントブースト
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 条件
      • ブースト値式
      • ソート順
    • 設定の削除
• 関連コンテンツ
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 検索語
      • コンテンツ
      • 仮想ホスト
    • 設定の削除
• 関連クエリー
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 検索語
      • クエリー
      • 仮想ホスト
    • 設定の削除
• パスマッピング
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 正規表現
      • 置換
      • 処理の種類
      • 表示順序
    • 設定の削除
• ウェブ認証
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • ホスト名
      • ポート
      • レルム
      • スキーム
      • ユーザー名
      • パスワード
      • パラメーター
      • ウェブ設定
    • 設定の削除
• ファイル認証
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • ホスト名
      • ポート
      • スキーム
      • ユーザー名
      • パスワード
      • パラメーター
      • ファイルクロール設定
    • 設定の削除
• リクエストヘッダー
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
      • 値
      • ウェブ設定
    • 設定の削除
• 重複ホスト
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 正規名
      • 重複名
    • 設定の削除
• ユーザー
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • ユーザー名
      • ロール
      • グループ
    • 設定の削除
• ロール
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
    • 設定の削除
• グループ
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
    • 削除の方法
• サジェストワード
  • 概要
  • 管理方法
    • 表示方法
      • 単語種別
      • 単語数
• 追加ワード
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 単語
      • 読み
      • パーミッション
      • ラベル
      • ブースト値
    • 設定の削除
  • ダウンロード
    • CSVの内容
  • アップロード
    • CSVの内容
• 除外ワード
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • サジェスト候補
    • 設定の削除
  • ダウンロード
    • CSVの内容
  • アップロード
    • CSVの内容
• システム情報
  • 概要
  • 管理方法
    • 表示方法
    • 表示項目
      • 環境変数のプロパティ
      • システムのプロパティ
      • アプリのプロパティ
      • バグレポートのプロパティ
• 検索ログ
  • 概要
  • 管理方法
  • 一覧
  • 詳細
• ジョブログ
  • 概要
  • 管理方法
    • 表示方法
    • ジョブログ詳細
      • 名前
      • 状態
      • 対象
      • 開始時間
      • 終了時間
      • 実行方法
      • スクリプト
      • 結果
• クロール情報
  • 概要
  • 管理方法
  • 一覧
  • 詳細
    • 項目一覧
      • セッションID
      • クローラーの開始時間
      • クロールの開始時間 (ウェブ/ファイル)
      • クロールの開始時間 (データストア)
      • クロールの終了時間 (ウェブ/ファイル)
      • クロールの実行時間 (データストア)
      • インデクシングの実行時間 (データストア)
      • インデックスのサイズ (データストア)
      • クロールの終了時間 (データストア)
      • クローラーの状態
      • クローラーの終了時間
      • クローラーの実行時間
• ログファイル
  • 概要
  • 設定方法
    • 表示方法
    • ダウンロード
      • server_*.log
      • fess.log
      • fess-crawler.log
      • audit.log
      • fess-thumbnail.log
      • fess-suggest.log
      • fess-urls.log
      • search.log
      • gc-crawler.log
• 障害URL
  • 概要
  • 管理方法
    • 表示方法
  • 障害URLの詳細
    • 詳細の内容
      • URL
      • スレッド名
      • 種類
      • ログ
      • エラー回数
      • 最終アクセス日時
• 検索
  • 概要
  • 管理方法
    • 表示方法
    • 検索一覧
    • 一括削除
• バックアップ
  • 概要
    • ダウンロード
      • fess_config.bulk
      • fess_basic_config.bulk
      • fess_user.bulk
      • system.properties
      • fess.json
      • doc.json
      • click_log.ndjson
      • favorite_log.ndjson
      • search_log.ndjson
      • user_info.ndjson
    • アップロード
• メンテナンス
  • 概要
  • 操作方法
    • 再インデクシング
    • 設定項目
      • エイリアスの更新
      • 辞書の初期化
      • シャード数
      • 最大レプリカ数
    • ドキュメントインデックスのリロード
    • Crawlerインデックス
    • 診断
• アップグレード
  • 概要
  • 操作方法
    • バックアップ
    • データ移行
    • 設定項目
      • 対象バージョン
• クエリーリクエスト
  • 概要
  • 操作方法
    • リクエストの送信
    • 設定項目
      • リクエストファイル

Fess 設定ガイド

• はじめに
  • 対象読者
  • お読みになる前に
  • オンラインでのアクセス
  • 技術的なサポートの連絡先
    • 商用サポート
  • 関連サードパーティー Web サイトの参照
  • コメントおよび提案の送付方法
• システム関連の設定
  • 使用ポートの設定
  • 使用メモリーの設定
    • ウェブアプリのメモリー設定
    • クローラーのメモリー設定
    • OpenSearchのメモリー設定
  • ログの設定
    • ログのファイル
    • ログレベルの変更
• クローラー関連の設定
  • 単語の長さの上限の設定
  • ファイルサイズの設定
  • プロキシの設定
    • 設定方法
• 検索関連の設定
  • ファジー検索
  • 検索時のタイムアウト値
  • 検索時の最大文字数
  • 検索時のタイムアウトのログ出力
  • ヒット件数表示
  • 位置情報検索時のインデックス名
  • リクエストパラメータの言語指定
  • 前方一致検索の指定
  • ハイライトの文字列
  • ハイライトのフラグメント
  • ハイライト生成方法
  • ハイライト対象のタグ
  • OpenSearchのハイライターに渡す値
  • レスポンスに追加するフィールド名
  • フィールド名の追加
  • 検索結果をGSA互換のXML形式で取得する際の設定
• 検索フォームの配置
  • 検索フォームの配置方法
    • 検索フォーム
    • サジェスト
• 仮想ホスト
  • 仮想ホストについて
    • システム設定
    • クロール設定
• Windowsサービスへの登録
  • Windowsサービスとしての登録
    • 事前準備
    • OpenSearchをサービスとして登録
    • 設定
    • 登録方法
    • サービスの設定
• ロールベース検索の設定
  • ロールベース検索について
  • ロールベース検索の設定
    • Fess の管理画面での設定
    • ログイン
    • ログアウト
• インデックスの管理
  • インデックスのバックアップとリストア
• Analyzerの設定
  • Analyzerについて
• 位置情報検索
  • 概要
  • 設定
    • インデックス生成時
    • 検索時
• サムネイル画像の設定
  • サムネイル画像の表示
  • HTMLファイルのサムネイル画像
  • MS Officeファイルのサムネイル画像
    • パッケージのインストール
    • 生成スクリプト
  • PDFファイルのサムネイル画像
  • サムネイルジョブの無効化
• 検索結果の一括取得
  • 検索結果の一括取得について
  • 利用方法
    • スクロール検索の設定
    • スクロール検索の利用
• 検索機能
  • 検索結果件数の表示

JavaDocs

XRef

I/F Doc

14.18

Fess インストールガイド

• はじめに
  • 対象読者
  • お読みになる前に
  • オンラインでのアクセス
  • 技術的なサポートの連絡先
    • 商用サポート
  • コメントおよび提案の送付方法
• インストール
  • インストール要件
  • ダウンロード
  • TAR.GZ版でのインストール
    • OpenSearchのインストール
    • Fessのインストール
  • ZIP版でのインストール
    • OpenSearchのインストール
    • Fessのインストール
  • RPM/DEB版でのインストール
    • OpenSearchのインストール
    • Fessのインストール
  • Docker版でのインストール
• 起動および停止方法
  • 起動方法
    • TAR.GZ版の場合
    • ZIP版の場合
    • RPM/DEB版の場合 (chkconfig)
    • RPM/DEB版の場合 (systemd)
    • Docker版の場合
  • ブラウザー UI へのアクセス
  • 停止方法
    • TAR.GZ/ZIP版の場合
    • RPM/DEB版の場合 (chkconfig)
    • RPM/DEB版の場合 (systemd)
    • Docker版の場合
• アンインストール
  • アンインストール
    • TAR.GZ/ZIP版の場合
    • RPM/DEB版の場合
• アップグレード
  • Fess のアップグレード
    • データのバックアップ
    • パッケージの更新
    • 設定のリストア
    • クローラーの起動

Fess ユーザーガイド

• はじめに
  • 対象読者
  • お読みになる前に
  • オンラインでのアクセス
  • 技術的なサポートの連絡先
    • 商用サポート
  • 関連サードパーティー Web サイトの参照
  • コメントおよび提案の送付方法
• AND 検索
  • AND 検索
    • 利用方法
• OR 検索
  • OR 検索
    • 利用方法
• NOT 検索
  • NOT 検索
    • 利用方法
• ラベル指定検索
  • ラベル指定検索 (カテゴリ検索)
    • 利用方法
• 検索フィールド指定検索
  • フィールド指定検索
    • 利用可能なフィールド
    • 利用方法
• ソート検索
  • ソート検索
    • ソート対象フィールド
    • 利用方法
• ワイルドカード検索
  • ワイルドカード検索
    • 利用方法
    • 利用条件
• 範囲指定検索
  • 範囲指定検索
    • 利用方法
• ブースト検索
  • ブースト検索(重み付け検索)
    • 利用方法
• 曖昧検索
  • 曖昧検索(ファジー検索)
    • 利用方法
• 位置情報検索
  • 位置情報検索
    • 利用方法
• 非表示検索条件
  • 非表示検索条件
    • 利用方法
• ロール検索
  • ロール検索
    • 検索方法
    • パスワードの変更
    • ログアウト
• 特殊文字
  • 特殊文字
    • 利用方法
• 詳細検索
  • 詳細検索
    • 利用方法
    • 項目一覧
      • すべての単語を含む
      • 語順も含めた完全一致
      • いずれかの単語を含む
      • 含めない単語
      • 表示件数
      • ソート
      • 優先する言語
      • ラベル
      • 更新日時
      • ファイル形式
      • 検索対象
      • サイトまたはドメイン

Fess APIガイド

• はじめに
  • 対象読者
  • お読みになる前に
  • オンラインでのアクセス
  • 技術的なサポートの連絡先
    • 商用サポート
  • 関連サードパーティー Web サイトの参照
  • コメントおよび提案の送付方法
• APIの概要
  • Fess の提供するAPI
  • APIの種類
• 検索API
  • 検索結果の取得
    • リクエストパラメーター
    • レスポンス
  • 全てのドキュメントを検索
    • リクエストパラメーター
• ラベルAPI
  • ラベルの取得
    • リクエストパラメーター
    • レスポンス
• 人気ワードAPI
  • 人気ワード一覧の取得
    • リクエストパラメーター
    • レスポンス
• サジェストAPI
  • サジェストワード一覧の取得
    • リクエストパラメーター
    • レスポンス
• Health API
  • 状態の取得
    • リクエストパラメーター
    • レスポンス

Fess 管理者ガイド

• はじめに
  • 対象読者
  • お読みになる前に
  • オンラインでのアクセス
  • 技術的なサポートの連絡先
    • 商用サポート
• ダッシュボード
  • 概要
  • インデックスされているドキュメント数の確認
• 構成ウィザード
  • 概要
    • 簡易セットアップ
    • クロールの設定
    • 設定項目
      • 名前
      • クロールパス
      • 最大アクセス数
      • 深さ
    • クローラ
• 全般
  • 概要
  • 設定内容
    • システム
      • JSONレスポンス
      • ログインが必要
      • ログインリンク表示
      • 重複結果の折り畳み
      • サムネイル表示
      • デフォルトのラベル値
      • デフォルトのソート値
      • 仮想ホスト
      • 人気ワードのレスポンス
      • CSVファイルのエンコード
      • 検索パラメーターの追加
      • 通知メール
    • クローラー
      • 最終更新日時の確認
      • 同時クローラー設定
      • 以前のドキュメントを削除
      • 除外するエラーの種類
      • 障害数のしきい値
    • ロギング
      • 検索ログ
      • ユーザログ
      • お気に入りログ
      • 以前の検索ログを削除
      • 以前のジョブログを削除
      • 以前のユーザーログを削除
      • ログを削除するボット名
      • ログレベル
    • サジェスト
      • 検索語でサジェスト
      • ドキュメントでサジェスト
      • 以前のサジェスト情報を削除
    • LDAP
      • LDAP URL
      • Base DN
      • Bind DN
      • パスワード
      • User DN
      • アカウントフィルター
      • グループフィルター
      • memberOf属性
    • お知らせ表示
      • ログインページ
      • 検索トップページ
    • ストレージ
      • エンドポイント
      • アクセスキー
      • シークレットキー
      • バケット
  • 例
    • LDAPの設定例
• スケジューラ
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
      • 対象
      • スケジュール
      • 実行方法
      • スクリプト
      • ロギング
      • クローラージョブ
      • 状態
      • 表示順序
    • 設定の削除
  • 手動クロール方法
• ページのデザイン
  • 概要
  • 設定方法
    • 表示方法
    • ファイルマネージャー
    • ページファイルの表示
    • アップロードするファイル
      • ファイルのアップロード
      • フィイル名(オプション)
• 辞書
  • 概要
  • 一覧
  • Kuromoji
  • 同義語
  • マッピング
  • Protwords
  • ストップワード
  • Stemmer上書き
• Kuromoji辞書
  • 概要
  • 管理方法
    • 表示方法
    • 設定方法
    • 設定項目
      • トークン
      • 分割
      • 読み
      • 品詞
  • ダウンロード
  • アップロード
• 同義語辞書
  • 概要
  • 管理方法
    • 表示方法
    • 設定方法
    • 設定項目
      • 変換元
      • 変換後
  • ダウンロード
  • アップロード
• マッピング辞書
  • 概要
  • 管理方法
    • 表示方法
    • 設定方法
    • 設定項目
      • 変換元
      • 変換後
  • ダウンロード
  • アップロード
• Protwords辞書
  • 概要
  • 管理方法
    • 表示方法
    • 設定方法
    • 設定項目
      • 単語情報
  • ダウンロード
  • アップロード
• ストップワード辞書
  • 概要
  • 管理方法
    • 表示方法
    • 設定方法
    • 設定項目
      • 変換元
      • 変換後
  • ダウンロード
  • アップロード
• Stemmer上書き辞書
  • 概要
  • 管理方法
    • 表示方法
    • 設定方法
    • 設定項目
      • 変換元
      • 変換後
  • ダウンロード
  • アップロード
• アクセストークン
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
      • パーミッション
      • パラメーター名
      • 有効期限
    • 設定の削除
• プラグイン
  • 概要
  • 管理方法
    • 表示方法
    • インストール
• ストレージ
  • 概要
  • 管理方法
    • オブジェクトストレージサーバーの設定
    • 表示方法
      • 名前
      • サイズ
      • 最終更新日時
    • ダウンロード
    • 削除
    • アップロード
    • フォルダーの作成
• ウェブクロール
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
      • URL
      • クロール対象とするURL
      • クロール対象から除外するURL
      • 検索対象とするURL
      • 検索対象から除外するURL
      • 設定パラメーター
      • 深さ
      • 最大アクセス数
      • ユーザーエージェント
      • スレッド数
      • 間隔
      • ブースト値
      • パーミッション
      • 仮想ホスト
      • 状態
      • 説明
    • 設定の削除
  • 例
    • fess.codelibs.org をクロールする
    • ウェブ認証サイトのウェブクロール
      • Redmine
      • XWiki
• ファイルクロール
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
      • パス
      • クロール対象とするパス
      • クロール対象から除外するパス
      • 検索対象とするパス
      • 検索対象から除外するパス
      • 設定パラメーター
      • 深さ
      • 最大アクセス数
      • スレッド数
      • 間隔
      • ブースト値
      • パーミッション
      • 仮想ホスト
      • 状態
      • 説明
    • 設定の削除
  • 例
    • ローカルファイルをクロール
    • Windowsの共有フォルダーをクロール
• データストアクロール
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
      • ハンドラー名
      • パラメーター
      • スクリプト
      • ブースト値
      • パーミッション
      • 仮想ホスト
      • 状態
      • 説明
    • 設定の削除
  • 例
    • DatabaseDataStore
      • パラメーター
      • スクリプト
      • ドライバー
    • CsvDataStore
      • パラメーター
      • スクリプト
    • EsDataStore
      • パラメーター
      • スクリプト
    • CsvListDataStore
      • パラメーター
      • スクリプト
• ラベル
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
      • 値
      • 対象とするパス
      • 除外するパス
      • パーミッション
      • 仮想ホスト
      • 表示順序
    • 設定の削除
• キーマッチ
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 検索語
      • クエリー
      • サイズ
      • ブースト値
      • 仮想ホスト
    • 設定の削除
• ドキュメントブースト
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 条件
      • ブースト値式
      • ソート順
    • 設定の削除
• 関連コンテンツ
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 検索語
      • コンテンツ
      • 仮想ホスト
    • 設定の削除
• 関連クエリー
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 検索語
      • クエリー
      • 仮想ホスト
    • 設定の削除
• パスマッピング
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 正規表現
      • 置換
      • 処理の種類
      • 表示順序
    • 設定の削除
• ウェブ認証
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • ホスト名
      • ポート
      • レルム
      • スキーム
      • ユーザー名
      • パスワード
      • パラメーター
      • ウェブ設定
    • 設定の削除
• ファイル認証
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • ホスト名
      • ポート
      • スキーム
      • ユーザー名
      • パスワード
      • パラメーター
      • ファイルクロール設定
    • 設定の削除
• リクエストヘッダー
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
      • 値
      • ウェブ設定
    • 設定の削除
• 重複ホスト
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 正規名
      • 重複名
    • 設定の削除
• ユーザー
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • ユーザー名
      • ロール
      • グループ
    • 設定の削除
• ロール
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
    • 設定の削除
• グループ
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
    • 削除の方法
• サジェストワード
  • 概要
  • 管理方法
    • 表示方法
      • 単語種別
      • 単語数
• 追加ワード
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 単語
      • 読み
      • パーミッション
      • ラベル
      • ブースト値
    • 設定の削除
  • ダウンロード
    • CSVの内容
  • アップロード
    • CSVの内容
• 除外ワード
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • サジェスト候補
    • 設定の削除
  • ダウンロード
    • CSVの内容
  • アップロード
    • CSVの内容
• システム情報
  • 概要
  • 管理方法
    • 表示方法
    • 表示項目
      • 環境変数のプロパティ
      • システムのプロパティ
      • アプリのプロパティ
      • バグレポートのプロパティ
• 検索ログ
  • 概要
  • 管理方法
  • 一覧
  • 詳細
• ジョブログ
  • 概要
  • 管理方法
    • 表示方法
    • ジョブログ詳細
      • 名前
      • 状態
      • 対象
      • 開始時間
      • 終了時間
      • 実行方法
      • スクリプト
      • 結果
• クロール情報
  • 概要
  • 管理方法
  • 一覧
  • 詳細
    • 項目一覧
      • セッションID
      • クローラーの開始時間
      • クロールの開始時間 (ウェブ/ファイル)
      • クロールの開始時間 (データストア)
      • クロールの終了時間 (ウェブ/ファイル)
      • クロールの実行時間 (データストア)
      • インデクシングの実行時間 (データストア)
      • インデックスのサイズ (データストア)
      • クロールの終了時間 (データストア)
      • クローラーの状態
      • クローラーの終了時間
      • クローラーの実行時間
• ログファイル
  • 概要
  • 設定方法
    • 表示方法
    • ダウンロード
      • server_*.log
      • fess.log
      • fess-crawler.log
      • audit.log
      • fess-thumbnail.log
      • fess-suggest.log
      • fess-urls.log
      • search.log
      • gc-crawler.log
• 障害URL
  • 概要
  • 管理方法
    • 表示方法
  • 障害URLの詳細
    • 詳細の内容
      • URL
      • スレッド名
      • 種類
      • ログ
      • エラー回数
      • 最終アクセス日時
• 検索
  • 概要
  • 管理方法
    • 表示方法
    • 検索一覧
    • 一括削除
• バックアップ
  • 概要
    • ダウンロード
      • fess_config.bulk
      • fess_basic_config.bulk
      • fess_user.bulk
      • system.properties
      • fess.json
      • doc.json
      • click_log.ndjson
      • favorite_log.ndjson
      • search_log.ndjson
      • user_info.ndjson
    • アップロード
• メンテナンス
  • 概要
  • 操作方法
    • 再インデクシング
    • 設定項目
      • エイリアスの更新
      • 辞書の初期化
      • シャード数
      • 最大レプリカ数
    • ドキュメントインデックスのリロード
    • Crawlerインデックス
    • 診断
• アップグレード
  • 概要
  • 操作方法
    • バックアップ
    • データ移行
    • 設定項目
      • 対象バージョン
• クエリーリクエスト
  • 概要
  • 操作方法
    • リクエストの送信
    • 設定項目
      • リクエストファイル

Fess 設定ガイド

• はじめに
  • 対象読者
  • お読みになる前に
  • オンラインでのアクセス
  • 技術的なサポートの連絡先
    • 商用サポート
  • 関連サードパーティー Web サイトの参照
  • コメントおよび提案の送付方法
• システム関連の設定
  • 使用ポートの設定
  • 使用メモリーの設定
    • ウェブアプリのメモリー設定
    • クローラーのメモリー設定
    • OpenSearchのメモリー設定
  • ログの設定
    • ログのファイル
    • ログレベルの変更
• クローラー関連の設定
  • 単語の長さの上限の設定
  • ファイルサイズの設定
  • プロキシの設定
    • 設定方法
• 検索関連の設定
  • ファジー検索
  • 検索時のタイムアウト値
  • 検索時の最大文字数
  • 検索時のタイムアウトのログ出力
  • ヒット件数表示
  • 位置情報検索時のインデックス名
  • リクエストパラメータの言語指定
  • 前方一致検索の指定
  • ハイライトの文字列
  • ハイライトのフラグメント
  • ハイライト生成方法
  • ハイライト対象のタグ
  • OpenSearchのハイライターに渡す値
  • レスポンスに追加するフィールド名
  • フィールド名の追加
  • 検索結果をGSA互換のXML形式で取得する際の設定
• 検索フォームの配置
  • 検索フォームの配置方法
    • 検索フォーム
    • サジェスト
• 仮想ホスト
  • 仮想ホストについて
    • システム設定
    • クロール設定
• Windowsサービスへの登録
  • Windowsサービスとしての登録
    • 事前準備
    • OpenSearchをサービスとして登録
    • 設定
    • 登録方法
    • サービスの設定
• ロールベース検索の設定
  • ロールベース検索について
  • ロールベース検索の設定
    • Fess の管理画面での設定
    • ログイン
    • ログアウト
• インデックスの管理
  • インデックスのバックアップとリストア
• Analyzerの設定
  • Analyzerについて
• 位置情報検索
  • 概要
  • 設定
    • インデックス生成時
    • 検索時
• サムネイル画像の設定
  • サムネイル画像の表示
  • HTMLファイルのサムネイル画像
  • MS Officeファイルのサムネイル画像
    • パッケージのインストール
    • 生成スクリプト
  • PDFファイルのサムネイル画像
  • サムネイルジョブの無効化
• 検索結果の一括取得
  • 検索結果の一括取得について
  • 利用方法
    • スクロール検索の設定
    • スクロール検索の利用
• 検索機能
  • 検索結果件数の表示

JavaDocs

XRef

I/F Doc

14.17

Fess インストールガイド

• はじめに
  • 対象読者
  • お読みになる前に
  • オンラインでのアクセス
  • 技術的なサポートの連絡先
    • 商用サポート
  • コメントおよび提案の送付方法
• インストール
  • インストール要件
  • ダウンロード
  • TAR.GZ版でのインストール
    • OpenSearchのインストール
    • Fessのインストール
  • ZIP版でのインストール
    • OpenSearchのインストール
    • Fessのインストール
  • RPM/DEB版でのインストール
    • OpenSearchのインストール
    • Fessのインストール
  • Docker版でのインストール
• 起動および停止方法
  • 起動方法
    • TAR.GZ版の場合
    • ZIP版の場合
    • RPM/DEB版の場合 (chkconfig)
    • RPM/DEB版の場合 (systemd)
    • Docker版の場合
  • ブラウザー UI へのアクセス
  • 停止方法
    • TAR.GZ/ZIP版の場合
    • RPM/DEB版の場合 (chkconfig)
    • RPM/DEB版の場合 (systemd)
    • Docker版の場合
• アンインストール
  • アンインストール
    • TAR.GZ/ZIP版の場合
    • RPM/DEB版の場合
• アップグレード
  • Fess のアップグレード
    • データのバックアップ
    • パッケージの更新
    • 設定のリストア
    • クローラーの起動

Fess ユーザーガイド

• はじめに
  • 対象読者
  • お読みになる前に
  • オンラインでのアクセス
  • 技術的なサポートの連絡先
    • 商用サポート
  • 関連サードパーティー Web サイトの参照
  • コメントおよび提案の送付方法
• AND 検索
  • AND 検索
    • 利用方法
• OR 検索
  • OR 検索
    • 利用方法
• NOT 検索
  • NOT 検索
    • 利用方法
• ラベル指定検索
  • ラベル指定検索 (カテゴリ検索)
    • 利用方法
• 検索フィールド指定検索
  • フィールド指定検索
    • 利用可能なフィールド
    • 利用方法
• ソート検索
  • ソート検索
    • ソート対象フィールド
    • 利用方法
• ワイルドカード検索
  • ワイルドカード検索
    • 利用方法
    • 利用条件
• 範囲指定検索
  • 範囲指定検索
    • 利用方法
• ブースト検索
  • ブースト検索(重み付け検索)
    • 利用方法
• 曖昧検索
  • 曖昧検索(ファジー検索)
    • 利用方法
• 位置情報検索
  • 位置情報検索
    • 利用方法
• 非表示検索条件
  • 非表示検索条件
    • 利用方法
• ロール検索
  • ロール検索
    • 検索方法
    • パスワードの変更
    • ログアウト
• 特殊文字
  • 特殊文字
    • 利用方法
• 詳細検索
  • 詳細検索
    • 利用方法
    • 項目一覧
      • すべての単語を含む
      • 語順も含めた完全一致
      • いずれかの単語を含む
      • 含めない単語
      • 表示件数
      • ソート
      • 優先する言語
      • ラベル
      • 更新日時
      • ファイル形式
      • 検索対象
      • サイトまたはドメイン

Fess APIガイド

• はじめに
  • 対象読者
  • お読みになる前に
  • オンラインでのアクセス
  • 技術的なサポートの連絡先
    • 商用サポート
  • 関連サードパーティー Web サイトの参照
  • コメントおよび提案の送付方法
• APIの概要
  • Fess の提供するAPI
  • APIの種類
• 検索API
  • 検索結果の取得
    • リクエストパラメーター
    • レスポンス
  • 全てのドキュメントを検索
    • リクエストパラメーター
• ラベルAPI
  • ラベルの取得
    • リクエストパラメーター
    • レスポンス
• 人気ワードAPI
  • 人気ワード一覧の取得
    • リクエストパラメーター
    • レスポンス
• サジェストAPI
  • サジェストワード一覧の取得
    • リクエストパラメーター
    • レスポンス
• Health API
  • 状態の取得
    • リクエストパラメーター
    • レスポンス

Fess 管理者ガイド

• はじめに
  • 対象読者
  • お読みになる前に
  • オンラインでのアクセス
  • 技術的なサポートの連絡先
    • 商用サポート
• ダッシュボード
  • 概要
  • インデックスされているドキュメント数の確認
• 構成ウィザード
  • 概要
    • 簡易セットアップ
    • クロールの設定
    • 設定項目
      • 名前
      • クロールパス
      • 最大アクセス数
      • 深さ
    • クローラ
• 全般
  • 概要
  • 設定内容
    • システム
      • JSONレスポンス
      • ログインが必要
      • ログインリンク表示
      • 重複結果の折り畳み
      • サムネイル表示
      • デフォルトのラベル値
      • デフォルトのソート値
      • 仮想ホスト
      • 人気ワードのレスポンス
      • CSVファイルのエンコード
      • 検索パラメーターの追加
      • 通知メール
    • クローラー
      • 最終更新日時の確認
      • 同時クローラー設定
      • 以前のドキュメントを削除
      • 除外するエラーの種類
      • 障害数のしきい値
    • ロギング
      • 検索ログ
      • ユーザログ
      • お気に入りログ
      • 以前の検索ログを削除
      • 以前のジョブログを削除
      • 以前のユーザーログを削除
      • ログを削除するボット名
      • ログレベル
    • サジェスト
      • 検索語でサジェスト
      • ドキュメントでサジェスト
      • 以前のサジェスト情報を削除
    • LDAP
      • LDAP URL
      • Base DN
      • Bind DN
      • パスワード
      • User DN
      • アカウントフィルター
      • グループフィルター
      • memberOf属性
    • お知らせ表示
      • ログインページ
      • 検索トップページ
    • ストレージ
      • エンドポイント
      • アクセスキー
      • シークレットキー
      • バケット
  • 例
    • LDAPの設定例
• スケジューラ
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
      • 対象
      • スケジュール
      • 実行方法
      • スクリプト
      • ロギング
      • クローラージョブ
      • 状態
      • 表示順序
    • 設定の削除
  • 手動クロール方法
• ページのデザイン
  • 概要
  • 設定方法
    • 表示方法
    • ファイルマネージャー
    • ページファイルの表示
    • アップロードするファイル
      • ファイルのアップロード
      • フィイル名(オプション)
• 辞書
  • 概要
  • 一覧
  • Kuromoji
  • 同義語
  • マッピング
  • Protwords
  • ストップワード
  • Stemmer上書き
• Kuromoji辞書
  • 概要
  • 管理方法
    • 表示方法
    • 設定方法
    • 設定項目
      • トークン
      • 分割
      • 読み
      • 品詞
  • ダウンロード
  • アップロード
• 同義語辞書
  • 概要
  • 管理方法
    • 表示方法
    • 設定方法
    • 設定項目
      • 変換元
      • 変換後
  • ダウンロード
  • アップロード
• マッピング辞書
  • 概要
  • 管理方法
    • 表示方法
    • 設定方法
    • 設定項目
      • 変換元
      • 変換後
  • ダウンロード
  • アップロード
• Protwords辞書
  • 概要
  • 管理方法
    • 表示方法
    • 設定方法
    • 設定項目
      • 単語情報
  • ダウンロード
  • アップロード
• ストップワード辞書
  • 概要
  • 管理方法
    • 表示方法
    • 設定方法
    • 設定項目
      • 変換元
      • 変換後
  • ダウンロード
  • アップロード
• Stemmer上書き辞書
  • 概要
  • 管理方法
    • 表示方法
    • 設定方法
    • 設定項目
      • 変換元
      • 変換後
  • ダウンロード
  • アップロード
• アクセストークン
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
      • パーミッション
      • パラメーター名
      • 有効期限
    • 設定の削除
• プラグイン
  • 概要
  • 管理方法
    • 表示方法
    • インストール
• ストレージ
  • 概要
  • 管理方法
    • オブジェクトストレージサーバーの設定
    • 表示方法
      • 名前
      • サイズ
      • 最終更新日時
    • ダウンロード
    • 削除
    • アップロード
    • フォルダーの作成
• ウェブクロール
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
      • URL
      • クロール対象とするURL
      • クロール対象から除外するURL
      • 検索対象とするURL
      • 検索対象から除外するURL
      • 設定パラメーター
      • 深さ
      • 最大アクセス数
      • ユーザーエージェント
      • スレッド数
      • 間隔
      • ブースト値
      • パーミッション
      • 仮想ホスト
      • 状態
      • 説明
    • 設定の削除
  • 例
    • fess.codelibs.org をクロールする
    • ウェブ認証サイトのウェブクロール
      • Redmine
      • XWiki
• ファイルクロール
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
      • パス
      • クロール対象とするパス
      • クロール対象から除外するパス
      • 検索対象とするパス
      • 検索対象から除外するパス
      • 設定パラメーター
      • 深さ
      • 最大アクセス数
      • スレッド数
      • 間隔
      • ブースト値
      • パーミッション
      • 仮想ホスト
      • 状態
      • 説明
    • 設定の削除
  • 例
    • ローカルファイルをクロール
    • Windowsの共有フォルダーをクロール
• データストアクロール
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
      • ハンドラー名
      • パラメーター
      • スクリプト
      • ブースト値
      • パーミッション
      • 仮想ホスト
      • 状態
      • 説明
    • 設定の削除
  • 例
    • DatabaseDataStore
      • パラメーター
      • スクリプト
      • ドライバー
    • CsvDataStore
      • パラメーター
      • スクリプト
    • EsDataStore
      • パラメーター
      • スクリプト
    • CsvListDataStore
      • パラメーター
      • スクリプト
• ラベル
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
      • 値
      • 対象とするパス
      • 除外するパス
      • パーミッション
      • 仮想ホスト
      • 表示順序
    • 設定の削除
• キーマッチ
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 検索語
      • クエリー
      • サイズ
      • ブースト値
      • 仮想ホスト
    • 設定の削除
• ドキュメントブースト
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 条件
      • ブースト値式
      • ソート順
    • 設定の削除
• 関連コンテンツ
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 検索語
      • コンテンツ
      • 仮想ホスト
    • 設定の削除
• 関連クエリー
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 検索語
      • クエリー
      • 仮想ホスト
    • 設定の削除
• パスマッピング
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 正規表現
      • 置換
      • 処理の種類
      • 表示順序
    • 設定の削除
• ウェブ認証
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • ホスト名
      • ポート
      • レルム
      • スキーム
      • ユーザー名
      • パスワード
      • パラメーター
      • ウェブ設定
    • 設定の削除
• ファイル認証
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • ホスト名
      • ポート
      • スキーム
      • ユーザー名
      • パスワード
      • パラメーター
      • ファイルクロール設定
    • 設定の削除
• リクエストヘッダー
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
      • 値
      • ウェブ設定
    • 設定の削除
• 重複ホスト
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 正規名
      • 重複名
    • 設定の削除
• ユーザー
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • ユーザー名
      • ロール
      • グループ
    • 設定の削除
• ロール
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
    • 設定の削除
• グループ
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
    • 削除の方法
• サジェストワード
  • 概要
  • 管理方法
    • 表示方法
      • 単語種別
      • 単語数
• 追加ワード
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 単語
      • 読み
      • パーミッション
      • ラベル
      • ブースト値
    • 設定の削除
  • ダウンロード
    • CSVの内容
  • アップロード
    • CSVの内容
• 除外ワード
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • サジェスト候補
    • 設定の削除
  • ダウンロード
    • CSVの内容
  • アップロード
    • CSVの内容
• システム情報
  • 概要
  • 管理方法
    • 表示方法
    • 表示項目
      • 環境変数のプロパティ
      • システムのプロパティ
      • アプリのプロパティ
      • バグレポートのプロパティ
• 検索ログ
  • 概要
  • 管理方法
  • 一覧
  • 詳細
• ジョブログ
  • 概要
  • 管理方法
    • 表示方法
    • ジョブログ詳細
      • 名前
      • 状態
      • 対象
      • 開始時間
      • 終了時間
      • 実行方法
      • スクリプト
      • 結果
• クロール情報
  • 概要
  • 管理方法
  • 一覧
  • 詳細
    • 項目一覧
      • セッションID
      • クローラーの開始時間
      • クロールの開始時間 (ウェブ/ファイル)
      • クロールの開始時間 (データストア)
      • クロールの終了時間 (ウェブ/ファイル)
      • クロールの実行時間 (データストア)
      • インデクシングの実行時間 (データストア)
      • インデックスのサイズ (データストア)
      • クロールの終了時間 (データストア)
      • クローラーの状態
      • クローラーの終了時間
      • クローラーの実行時間
• ログファイル
  • 概要
  • 設定方法
    • 表示方法
    • ダウンロード
      • server_*.log
      • fess.log
      • fess-crawler.log
      • audit.log
      • fess-thumbnail.log
      • fess-suggest.log
      • fess-urls.log
      • search.log
      • gc-crawler.log
• 障害URL
  • 概要
  • 管理方法
    • 表示方法
  • 障害URLの詳細
    • 詳細の内容
      • URL
      • スレッド名
      • 種類
      • ログ
      • エラー回数
      • 最終アクセス日時
• 検索
  • 概要
  • 管理方法
    • 表示方法
    • 検索一覧
    • 一括削除
• バックアップ
  • 概要
    • ダウンロード
      • fess_config.bulk
      • fess_basic_config.bulk
      • fess_user.bulk
      • system.properties
      • fess.json
      • doc.json
      • click_log.ndjson
      • favorite_log.ndjson
      • search_log.ndjson
      • user_info.ndjson
    • アップロード
• メンテナンス
  • 概要
  • 操作方法
    • 再インデクシング
    • 設定項目
      • エイリアスの更新
      • 辞書の初期化
      • シャード数
      • 最大レプリカ数
    • ドキュメントインデックスのリロード
    • Crawlerインデックス
    • 診断
• アップグレード
  • 概要
  • 操作方法
    • バックアップ
    • データ移行
    • 設定項目
      • 対象バージョン
• クエリーリクエスト
  • 概要
  • 操作方法
    • リクエストの送信
    • 設定項目
      • リクエストファイル

Fess 設定ガイド

• はじめに
  • 対象読者
  • お読みになる前に
  • オンラインでのアクセス
  • 技術的なサポートの連絡先
    • 商用サポート
  • 関連サードパーティー Web サイトの参照
  • コメントおよび提案の送付方法
• システム関連の設定
  • 使用ポートの設定
  • 使用メモリーの設定
    • ウェブアプリのメモリー設定
    • クローラーのメモリー設定
    • OpenSearchのメモリー設定
  • ログの設定
    • ログのファイル
    • ログレベルの変更
• クローラー関連の設定
  • 単語の長さの上限の設定
  • ファイルサイズの設定
  • プロキシの設定
    • 設定方法
• 検索関連の設定
  • ファジー検索
  • 検索時のタイムアウト値
  • 検索時の最大文字数
  • 検索時のタイムアウトのログ出力
  • ヒット件数表示
  • 位置情報検索時のインデックス名
  • リクエストパラメータの言語指定
  • 前方一致検索の指定
  • ハイライトの文字列
  • ハイライトのフラグメント
  • ハイライト生成方法
  • ハイライト対象のタグ
  • OpenSearchのハイライターに渡す値
  • レスポンスに追加するフィールド名
  • フィールド名の追加
  • 検索結果をGSA互換のXML形式で取得する際の設定
• 検索フォームの配置
  • 検索フォームの配置方法
    • 検索フォーム
    • サジェスト
• 仮想ホスト
  • 仮想ホストについて
    • システム設定
    • クロール設定
• Windowsサービスへの登録
  • Windowsサービスとしての登録
    • 事前準備
    • OpenSearchをサービスとして登録
    • 設定
    • 登録方法
    • サービスの設定
• ロールベース検索の設定
  • ロールベース検索について
  • ロールベース検索の設定
    • Fess の管理画面での設定
    • ログイン
    • ログアウト
• インデックスの管理
  • インデックスのバックアップとリストア
• Analyzerの設定
  • Analyzerについて
• 位置情報検索
  • 概要
  • 設定
    • インデックス生成時
    • 検索時
• サムネイル画像の設定
  • サムネイル画像の表示
  • HTMLファイルのサムネイル画像
  • MS Officeファイルのサムネイル画像
    • パッケージのインストール
    • 生成スクリプト
  • PDFファイルのサムネイル画像
  • サムネイルジョブの無効化
• 検索結果の一括取得
  • 検索結果の一括取得について
  • 利用方法
    • スクロール検索の設定
    • スクロール検索の利用
• 検索機能
  • 検索結果件数の表示

JavaDocs

XRef

I/F Doc

14.16

Fess インストールガイド

• はじめに
  • 対象読者
  • お読みになる前に
  • オンラインでのアクセス
  • 技術的なサポートの連絡先
    • 商用サポート
  • コメントおよび提案の送付方法
• インストール
  • インストール要件
  • ダウンロード
  • TAR.GZ版でのインストール
    • OpenSearchのインストール
    • Fessのインストール
  • ZIP版でのインストール
    • OpenSearchのインストール
    • Fessのインストール
  • RPM/DEB版でのインストール
    • OpenSearchのインストール
    • Fessのインストール
  • Docker版でのインストール
• 起動および停止方法
  • 起動方法
    • TAR.GZ版の場合
    • ZIP版の場合
    • RPM/DEB版の場合 (chkconfig)
    • RPM/DEB版の場合 (systemd)
    • Docker版の場合
  • ブラウザー UI へのアクセス
  • 停止方法
    • TAR.GZ/ZIP版の場合
    • RPM/DEB版の場合 (chkconfig)
    • RPM/DEB版の場合 (systemd)
    • Docker版の場合
• アンインストール
  • アンインストール
    • TAR.GZ/ZIP版の場合
    • RPM/DEB版の場合
• アップグレード
  • Fess のアップグレード
    • データのバックアップ
    • パッケージの更新
    • 設定のリストア
    • クローラーの起動

Fess ユーザーガイド

• はじめに
  • 対象読者
  • お読みになる前に
  • オンラインでのアクセス
  • 技術的なサポートの連絡先
    • 商用サポート
  • 関連サードパーティー Web サイトの参照
  • コメントおよび提案の送付方法
• AND 検索
  • AND 検索
    • 利用方法
• OR 検索
  • OR 検索
    • 利用方法
• NOT 検索
  • NOT 検索
    • 利用方法
• ラベル指定検索
  • ラベル指定検索 (カテゴリ検索)
    • 利用方法
• 検索フィールド指定検索
  • フィールド指定検索
    • 利用可能なフィールド
    • 利用方法
• ソート検索
  • ソート検索
    • ソート対象フィールド
    • 利用方法
• ワイルドカード検索
  • ワイルドカード検索
    • 利用方法
    • 利用条件
• 範囲指定検索
  • 範囲指定検索
    • 利用方法
• ブースト検索
  • ブースト検索(重み付け検索)
    • 利用方法
• 曖昧検索
  • 曖昧検索(ファジー検索)
    • 利用方法
• 位置情報検索
  • 位置情報検索
    • 利用方法
• 非表示検索条件
  • 非表示検索条件
    • 利用方法
• ロール検索
  • ロール検索
    • 検索方法
    • パスワードの変更
    • ログアウト
• 特殊文字
  • 特殊文字
    • 利用方法
• 詳細検索
  • 詳細検索
    • 利用方法
    • 項目一覧
      • すべての単語を含む
      • 語順も含めた完全一致
      • いずれかの単語を含む
      • 含めない単語
      • 表示件数
      • ソート
      • 優先する言語
      • ラベル
      • 更新日時
      • ファイル形式
      • 検索対象
      • サイトまたはドメイン

Fess APIガイド

• はじめに
  • 対象読者
  • お読みになる前に
  • オンラインでのアクセス
  • 技術的なサポートの連絡先
    • 商用サポート
  • 関連サードパーティー Web サイトの参照
  • コメントおよび提案の送付方法
• APIの概要
  • Fess の提供するAPI
  • APIの種類
• 検索API
  • 検索結果の取得
    • リクエストパラメーター
    • レスポンス
  • 全てのドキュメントを検索
    • リクエストパラメーター
• ラベルAPI
  • ラベルの取得
    • リクエストパラメーター
    • レスポンス
• 人気ワードAPI
  • 人気ワード一覧の取得
    • リクエストパラメーター
    • レスポンス
• サジェストAPI
  • サジェストワード一覧の取得
    • リクエストパラメーター
    • レスポンス
• Health API
  • 状態の取得
    • リクエストパラメーター
    • レスポンス

Fess 管理者ガイド

• はじめに
  • 対象読者
  • お読みになる前に
  • オンラインでのアクセス
  • 技術的なサポートの連絡先
    • 商用サポート
• ダッシュボード
  • 概要
  • インデックスされているドキュメント数の確認
• 構成ウィザード
  • 概要
    • 簡易セットアップ
    • クロールの設定
    • 設定項目
      • 名前
      • クロールパス
      • 最大アクセス数
      • 深さ
    • クローラ
• 全般
  • 概要
  • 設定内容
    • システム
      • JSONレスポンス
      • ログインが必要
      • ログインリンク表示
      • 重複結果の折り畳み
      • サムネイル表示
      • デフォルトのラベル値
      • デフォルトのソート値
      • 仮想ホスト
      • 人気ワードのレスポンス
      • CSVファイルのエンコード
      • 検索パラメーターの追加
      • 通知メール
    • クローラー
      • 最終更新日時の確認
      • 同時クローラー設定
      • 以前のドキュメントを削除
      • 除外するエラーの種類
      • 障害数のしきい値
    • ロギング
      • 検索ログ
      • ユーザログ
      • お気に入りログ
      • 以前の検索ログを削除
      • 以前のジョブログを削除
      • 以前のユーザーログを削除
      • ログを削除するボット名
      • ログレベル
    • サジェスト
      • 検索語でサジェスト
      • ドキュメントでサジェスト
      • 以前のサジェスト情報を削除
    • LDAP
      • LDAP URL
      • Base DN
      • Bind DN
      • パスワード
      • User DN
      • アカウントフィルター
      • グループフィルター
      • memberOf属性
    • お知らせ表示
      • ログインページ
      • 検索トップページ
    • ストレージ
      • エンドポイント
      • アクセスキー
      • シークレットキー
      • バケット
  • 例
    • LDAPの設定例
• スケジューラ
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
      • 対象
      • スケジュール
      • 実行方法
      • スクリプト
      • ロギング
      • クローラージョブ
      • 状態
      • 表示順序
    • 設定の削除
  • 手動クロール方法
• ページのデザイン
  • 概要
  • 設定方法
    • 表示方法
    • ファイルマネージャー
    • ページファイルの表示
    • アップロードするファイル
      • ファイルのアップロード
      • フィイル名(オプション)
• 辞書
  • 概要
  • 一覧
  • Kuromoji
  • 同義語
  • マッピング
  • Protwords
  • ストップワード
  • Stemmer上書き
• Kuromoji辞書
  • 概要
  • 管理方法
    • 表示方法
    • 設定方法
    • 設定項目
      • トークン
      • 分割
      • 読み
      • 品詞
  • ダウンロード
  • アップロード
• 同義語辞書
  • 概要
  • 管理方法
    • 表示方法
    • 設定方法
    • 設定項目
      • 変換元
      • 変換後
  • ダウンロード
  • アップロード
• マッピング辞書
  • 概要
  • 管理方法
    • 表示方法
    • 設定方法
    • 設定項目
      • 変換元
      • 変換後
  • ダウンロード
  • アップロード
• Protwords辞書
  • 概要
  • 管理方法
    • 表示方法
    • 設定方法
    • 設定項目
      • 単語情報
  • ダウンロード
  • アップロード
• ストップワード辞書
  • 概要
  • 管理方法
    • 表示方法
    • 設定方法
    • 設定項目
      • 変換元
      • 変換後
  • ダウンロード
  • アップロード
• Stemmer上書き辞書
  • 概要
  • 管理方法
    • 表示方法
    • 設定方法
    • 設定項目
      • 変換元
      • 変換後
  • ダウンロード
  • アップロード
• アクセストークン
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
      • パーミッション
      • パラメーター名
      • 有効期限
    • 設定の削除
• プラグイン
  • 概要
  • 管理方法
    • 表示方法
    • インストール
• ストレージ
  • 概要
  • 管理方法
    • オブジェクトストレージサーバーの設定
    • 表示方法
      • 名前
      • サイズ
      • 最終更新日時
    • ダウンロード
    • 削除
    • アップロード
    • フォルダーの作成
• ウェブクロール
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
      • URL
      • クロール対象とするURL
      • クロール対象から除外するURL
      • 検索対象とするURL
      • 検索対象から除外するURL
      • 設定パラメーター
      • 深さ
      • 最大アクセス数
      • ユーザーエージェント
      • スレッド数
      • 間隔
      • ブースト値
      • パーミッション
      • 仮想ホスト
      • 状態
      • 説明
    • 設定の削除
  • 例
    • fess.codelibs.org をクロールする
    • ウェブ認証サイトのウェブクロール
      • Redmine
      • XWiki
• ファイルクロール
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
      • パス
      • クロール対象とするパス
      • クロール対象から除外するパス
      • 検索対象とするパス
      • 検索対象から除外するパス
      • 設定パラメーター
      • 深さ
      • 最大アクセス数
      • スレッド数
      • 間隔
      • ブースト値
      • パーミッション
      • 仮想ホスト
      • 状態
      • 説明
    • 設定の削除
  • 例
    • ローカルファイルをクロール
    • Windowsの共有フォルダーをクロール
• データストアクロール
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
      • ハンドラー名
      • パラメーター
      • スクリプト
      • ブースト値
      • パーミッション
      • 仮想ホスト
      • 状態
      • 説明
    • 設定の削除
  • 例
    • DatabaseDataStore
      • パラメーター
      • スクリプト
      • ドライバー
    • CsvDataStore
      • パラメーター
      • スクリプト
    • EsDataStore
      • パラメーター
      • スクリプト
    • CsvListDataStore
      • パラメーター
      • スクリプト
• ラベル
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
      • 値
      • 対象とするパス
      • 除外するパス
      • パーミッション
      • 仮想ホスト
      • 表示順序
    • 設定の削除
• キーマッチ
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 検索語
      • クエリー
      • サイズ
      • ブースト値
      • 仮想ホスト
    • 設定の削除
• ドキュメントブースト
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 条件
      • ブースト値式
      • ソート順
    • 設定の削除
• 関連コンテンツ
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 検索語
      • コンテンツ
      • 仮想ホスト
    • 設定の削除
• 関連クエリー
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 検索語
      • クエリー
      • 仮想ホスト
    • 設定の削除
• パスマッピング
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 正規表現
      • 置換
      • 処理の種類
      • 表示順序
    • 設定の削除
• ウェブ認証
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • ホスト名
      • ポート
      • レルム
      • スキーム
      • ユーザー名
      • パスワード
      • パラメーター
      • ウェブ設定
    • 設定の削除
• ファイル認証
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • ホスト名
      • ポート
      • スキーム
      • ユーザー名
      • パスワード
      • パラメーター
      • ファイルクロール設定
    • 設定の削除
• リクエストヘッダー
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
      • 値
      • ウェブ設定
    • 設定の削除
• 重複ホスト
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 正規名
      • 重複名
    • 設定の削除
• ユーザー
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • ユーザー名
      • ロール
      • グループ
    • 設定の削除
• ロール
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
    • 設定の削除
• グループ
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
    • 削除の方法
• サジェストワード
  • 概要
  • 管理方法
    • 表示方法
      • 単語種別
      • 単語数
• 追加ワード
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 単語
      • 読み
      • パーミッション
      • ラベル
      • ブースト値
    • 設定の削除
  • ダウンロード
    • CSVの内容
  • アップロード
    • CSVの内容
• 除外ワード
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • サジェスト候補
    • 設定の削除
  • ダウンロード
    • CSVの内容
  • アップロード
    • CSVの内容
• システム情報
  • 概要
  • 管理方法
    • 表示方法
    • 表示項目
      • 環境変数のプロパティ
      • システムのプロパティ
      • アプリのプロパティ
      • バグレポートのプロパティ
• 検索ログ
  • 概要
  • 管理方法
  • 一覧
  • 詳細
• ジョブログ
  • 概要
  • 管理方法
    • 表示方法
    • ジョブログ詳細
      • 名前
      • 状態
      • 対象
      • 開始時間
      • 終了時間
      • 実行方法
      • スクリプト
      • 結果
• クロール情報
  • 概要
  • 管理方法
  • 一覧
  • 詳細
    • 項目一覧
      • セッションID
      • クローラーの開始時間
      • クロールの開始時間 (ウェブ/ファイル)
      • クロールの開始時間 (データストア)
      • クロールの終了時間 (ウェブ/ファイル)
      • クロールの実行時間 (データストア)
      • インデクシングの実行時間 (データストア)
      • インデックスのサイズ (データストア)
      • クロールの終了時間 (データストア)
      • クローラーの状態
      • クローラーの終了時間
      • クローラーの実行時間
• ログファイル
  • 概要
  • 設定方法
    • 表示方法
    • ダウンロード
      • server_*.log
      • fess.log
      • fess-crawler.log
      • audit.log
      • fess-thumbnail.log
      • fess-suggest.log
      • fess-urls.log
      • search.log
      • gc-crawler.log
• 障害URL
  • 概要
  • 管理方法
    • 表示方法
  • 障害URLの詳細
    • 詳細の内容
      • URL
      • スレッド名
      • 種類
      • ログ
      • エラー回数
      • 最終アクセス日時
• 検索
  • 概要
  • 管理方法
    • 表示方法
    • 検索一覧
    • 一括削除
• バックアップ
  • 概要
    • ダウンロード
      • fess_config.bulk
      • fess_basic_config.bulk
      • fess_user.bulk
      • system.properties
      • fess.json
      • doc.json
      • click_log.ndjson
      • favorite_log.ndjson
      • search_log.ndjson
      • user_info.ndjson
    • アップロード
• メンテナンス
  • 概要
  • 操作方法
    • 再インデクシング
    • 設定項目
      • エイリアスの更新
      • 辞書の初期化
      • シャード数
      • 最大レプリカ数
    • ドキュメントインデックスのリロード
    • Crawlerインデックス
    • 診断
• アップグレード
  • 概要
  • 操作方法
    • バックアップ
    • データ移行
    • 設定項目
      • 対象バージョン
• クエリーリクエスト
  • 概要
  • 操作方法
    • リクエストの送信
    • 設定項目
      • リクエストファイル

Fess 設定ガイド

• はじめに
  • 対象読者
  • お読みになる前に
  • オンラインでのアクセス
  • 技術的なサポートの連絡先
    • 商用サポート
  • 関連サードパーティー Web サイトの参照
  • コメントおよび提案の送付方法
• システム関連の設定
  • 使用ポートの設定
  • 使用メモリーの設定
    • ウェブアプリのメモリー設定
    • クローラーのメモリー設定
    • OpenSearchのメモリー設定
  • ログの設定
    • ログのファイル
    • ログレベルの変更
• クローラー関連の設定
  • 単語の長さの上限の設定
  • ファイルサイズの設定
  • プロキシの設定
    • 設定方法
• 検索関連の設定
  • ファジー検索
  • 検索時のタイムアウト値
  • 検索時の最大文字数
  • 検索時のタイムアウトのログ出力
  • ヒット件数表示
  • 位置情報検索時のインデックス名
  • リクエストパラメータの言語指定
  • 前方一致検索の指定
  • ハイライトの文字列
  • ハイライトのフラグメント
  • ハイライト生成方法
  • ハイライト対象のタグ
  • OpenSearchのハイライターに渡す値
  • レスポンスに追加するフィールド名
  • フィールド名の追加
  • 検索結果をGSA互換のXML形式で取得する際の設定
• 検索フォームの配置
  • 検索フォームの配置方法
    • 検索フォーム
    • サジェスト
• 仮想ホスト
  • 仮想ホストについて
    • システム設定
    • クロール設定
• Windowsサービスへの登録
  • Windowsサービスとしての登録
    • 事前準備
    • OpenSearchをサービスとして登録
    • 設定
    • 登録方法
    • サービスの設定
• ロールベース検索の設定
  • ロールベース検索について
  • ロールベース検索の設定
    • Fess の管理画面での設定
    • ログイン
    • ログアウト
• インデックスの管理
  • インデックスのバックアップとリストア
• Analyzerの設定
  • Analyzerについて
• 位置情報検索
  • 概要
  • 設定
    • インデックス生成時
    • 検索時
• サムネイル画像の設定
  • サムネイル画像の表示
  • HTMLファイルのサムネイル画像
  • MS Officeファイルのサムネイル画像
    • パッケージのインストール
    • 生成スクリプト
  • PDFファイルのサムネイル画像
  • サムネイルジョブの無効化
• 検索結果の一括取得
  • 検索結果の一括取得について
  • 利用方法
    • スクロール検索の設定
    • スクロール検索の利用
• 検索機能
  • 検索結果件数の表示

JavaDocs

XRef

I/F Doc

14.15

Fess インストールガイド

• はじめに
  • 対象読者
  • お読みになる前に
  • オンラインでのアクセス
  • 技術的なサポートの連絡先
    • 商用サポート
  • コメントおよび提案の送付方法
• インストール
  • インストール要件
  • ダウンロード
  • TAR.GZ版でのインストール
    • OpenSearchのインストール
    • Fessのインストール
  • ZIP版でのインストール
    • OpenSearchのインストール
    • Fessのインストール
  • RPM/DEB版でのインストール
    • OpenSearchのインストール
    • Fessのインストール
  • Docker版でのインストール
• 起動および停止方法
  • 起動方法
    • TAR.GZ版の場合
    • ZIP版の場合
    • RPM/DEB版の場合 (chkconfig)
    • RPM/DEB版の場合 (systemd)
    • Docker版の場合
  • ブラウザー UI へのアクセス
  • 停止方法
    • TAR.GZ/ZIP版の場合
    • RPM/DEB版の場合 (chkconfig)
    • RPM/DEB版の場合 (systemd)
    • Docker版の場合
• アンインストール
  • アンインストール
    • TAR.GZ/ZIP版の場合
    • RPM/DEB版の場合
• アップグレード
  • Fess のアップグレード
    • データのバックアップ
    • パッケージの更新
    • 設定のリストア
    • クローラーの起動

Fess ユーザーガイド

• はじめに
  • 対象読者
  • お読みになる前に
  • オンラインでのアクセス
  • 技術的なサポートの連絡先
    • 商用サポート
  • 関連サードパーティー Web サイトの参照
  • コメントおよび提案の送付方法
• AND 検索
  • AND 検索
    • 利用方法
• OR 検索
  • OR 検索
    • 利用方法
• NOT 検索
  • NOT 検索
    • 利用方法
• ラベル指定検索
  • ラベル指定検索 (カテゴリ検索)
    • 利用方法
• 検索フィールド指定検索
  • フィールド指定検索
    • 利用可能なフィールド
    • 利用方法
• ソート検索
  • ソート検索
    • ソート対象フィールド
    • 利用方法
• ワイルドカード検索
  • ワイルドカード検索
    • 利用方法
    • 利用条件
• 範囲指定検索
  • 範囲指定検索
    • 利用方法
• ブースト検索
  • ブースト検索(重み付け検索)
    • 利用方法
• 曖昧検索
  • 曖昧検索(ファジー検索)
    • 利用方法
• 位置情報検索
  • 位置情報検索
    • 利用方法
• 非表示検索条件
  • 非表示検索条件
    • 利用方法
• ロール検索
  • ロール検索
    • 検索方法
    • パスワードの変更
    • ログアウト
• 特殊文字
  • 特殊文字
    • 利用方法
• 詳細検索
  • 詳細検索
    • 利用方法
    • 項目一覧
      • すべての単語を含む
      • 語順も含めた完全一致
      • いずれかの単語を含む
      • 含めない単語
      • 表示件数
      • ソート
      • 優先する言語
      • ラベル
      • 更新日時
      • ファイル形式
      • 検索対象
      • サイトまたはドメイン

Fess APIガイド

• はじめに
  • 対象読者
  • お読みになる前に
  • オンラインでのアクセス
  • 技術的なサポートの連絡先
    • 商用サポート
  • 関連サードパーティー Web サイトの参照
  • コメントおよび提案の送付方法
• APIの概要
  • Fess の提供するAPI
  • APIの種類
• 検索API
  • 検索結果の取得
    • リクエストパラメーター
    • レスポンス
  • 全てのドキュメントを検索
    • リクエストパラメーター
• ラベルAPI
  • ラベルの取得
    • リクエストパラメーター
    • レスポンス
• 人気ワードAPI
  • 人気ワード一覧の取得
    • リクエストパラメーター
    • レスポンス
• サジェストAPI
  • サジェストワード一覧の取得
    • リクエストパラメーター
    • レスポンス
• Health API
  • 状態の取得
    • リクエストパラメーター
    • レスポンス

Fess 管理者ガイド

• はじめに
  • 対象読者
  • お読みになる前に
  • オンラインでのアクセス
  • 技術的なサポートの連絡先
    • 商用サポート
• ダッシュボード
  • 概要
  • インデックスされているドキュメント数の確認
• 構成ウィザード
  • 概要
    • 簡易セットアップ
    • クロールの設定
    • 設定項目
      • 名前
      • クロールパス
      • 最大アクセス数
      • 深さ
    • クローラ
• 全般
  • 概要
  • 設定内容
    • システム
      • JSONレスポンス
      • ログインが必要
      • ログインリンク表示
      • 重複結果の折り畳み
      • サムネイル表示
      • デフォルトのラベル値
      • デフォルトのソート値
      • 仮想ホスト
      • 人気ワードのレスポンス
      • CSVファイルのエンコード
      • 検索パラメーターの追加
      • 通知メール
    • クローラー
      • 最終更新日時の確認
      • 同時クローラー設定
      • 以前のドキュメントを削除
      • 除外するエラーの種類
      • 障害数のしきい値
    • ロギング
      • 検索ログ
      • ユーザログ
      • お気に入りログ
      • 以前の検索ログを削除
      • 以前のジョブログを削除
      • 以前のユーザーログを削除
      • ログを削除するボット名
      • ログレベル
    • サジェスト
      • 検索語でサジェスト
      • ドキュメントでサジェスト
      • 以前のサジェスト情報を削除
    • LDAP
      • LDAP URL
      • Base DN
      • Bind DN
      • パスワード
      • User DN
      • アカウントフィルター
      • グループフィルター
      • memberOf属性
    • お知らせ表示
      • ログインページ
      • 検索トップページ
    • ストレージ
      • エンドポイント
      • アクセスキー
      • シークレットキー
      • バケット
  • 例
    • LDAPの設定例
• スケジューラ
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
      • 対象
      • スケジュール
      • 実行方法
      • スクリプト
      • ロギング
      • クローラージョブ
      • 状態
      • 表示順序
    • 設定の削除
  • 手動クロール方法
• ページのデザイン
  • 概要
  • 設定方法
    • 表示方法
    • ファイルマネージャー
    • ページファイルの表示
    • アップロードするファイル
      • ファイルのアップロード
      • フィイル名(オプション)
• 辞書
  • 概要
  • 一覧
  • Kuromoji
  • 同義語
  • マッピング
  • Protwords
  • ストップワード
  • Stemmer上書き
• Kuromoji辞書
  • 概要
  • 管理方法
    • 表示方法
    • 設定方法
    • 設定項目
      • トークン
      • 分割
      • 読み
      • 品詞
  • ダウンロード
  • アップロード
• 同義語辞書
  • 概要
  • 管理方法
    • 表示方法
    • 設定方法
    • 設定項目
      • 変換元
      • 変換後
  • ダウンロード
  • アップロード
• マッピング辞書
  • 概要
  • 管理方法
    • 表示方法
    • 設定方法
    • 設定項目
      • 変換元
      • 変換後
  • ダウンロード
  • アップロード
• Protwords辞書
  • 概要
  • 管理方法
    • 表示方法
    • 設定方法
    • 設定項目
      • 単語情報
  • ダウンロード
  • アップロード
• ストップワード辞書
  • 概要
  • 管理方法
    • 表示方法
    • 設定方法
    • 設定項目
      • 変換元
      • 変換後
  • ダウンロード
  • アップロード
• Stemmer上書き辞書
  • 概要
  • 管理方法
    • 表示方法
    • 設定方法
    • 設定項目
      • 変換元
      • 変換後
  • ダウンロード
  • アップロード
• アクセストークン
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
      • パーミッション
      • パラメーター名
      • 有効期限
    • 設定の削除
• プラグイン
  • 概要
  • 管理方法
    • 表示方法
    • インストール
• ストレージ
  • 概要
  • 管理方法
    • オブジェクトストレージサーバーの設定
    • 表示方法
      • 名前
      • サイズ
      • 最終更新日時
    • ダウンロード
    • 削除
    • アップロード
    • フォルダーの作成
• ウェブクロール
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
      • URL
      • クロール対象とするURL
      • クロール対象から除外するURL
      • 検索対象とするURL
      • 検索対象から除外するURL
      • 設定パラメーター
      • 深さ
      • 最大アクセス数
      • ユーザーエージェント
      • スレッド数
      • 間隔
      • ブースト値
      • パーミッション
      • 仮想ホスト
      • 状態
      • 説明
    • 設定の削除
  • 例
    • fess.codelibs.org をクロールする
    • ウェブ認証サイトのウェブクロール
      • Redmine
      • XWiki
• ファイルクロール
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
      • パス
      • クロール対象とするパス
      • クロール対象から除外するパス
      • 検索対象とするパス
      • 検索対象から除外するパス
      • 設定パラメーター
      • 深さ
      • 最大アクセス数
      • スレッド数
      • 間隔
      • ブースト値
      • パーミッション
      • 仮想ホスト
      • 状態
      • 説明
    • 設定の削除
  • 例
    • ローカルファイルをクロール
    • Windowsの共有フォルダーをクロール
• データストアクロール
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
      • ハンドラー名
      • パラメーター
      • スクリプト
      • ブースト値
      • パーミッション
      • 仮想ホスト
      • 状態
      • 説明
    • 設定の削除
  • 例
    • DatabaseDataStore
      • パラメーター
      • スクリプト
      • ドライバー
    • CsvDataStore
      • パラメーター
      • スクリプト
    • EsDataStore
      • パラメーター
      • スクリプト
    • CsvListDataStore
      • パラメーター
      • スクリプト
• ラベル
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
      • 値
      • 対象とするパス
      • 除外するパス
      • パーミッション
      • 仮想ホスト
      • 表示順序
    • 設定の削除
• キーマッチ
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 検索語
      • クエリー
      • サイズ
      • ブースト値
      • 仮想ホスト
    • 設定の削除
• ドキュメントブースト
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 条件
      • ブースト値式
      • ソート順
    • 設定の削除
• 関連コンテンツ
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 検索語
      • コンテンツ
      • 仮想ホスト
    • 設定の削除
• 関連クエリー
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 検索語
      • クエリー
      • 仮想ホスト
    • 設定の削除
• パスマッピング
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 正規表現
      • 置換
      • 処理の種類
      • 表示順序
    • 設定の削除
• ウェブ認証
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • ホスト名
      • ポート
      • レルム
      • スキーム
      • ユーザー名
      • パスワード
      • パラメーター
      • ウェブ設定
    • 設定の削除
• ファイル認証
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • ホスト名
      • ポート
      • スキーム
      • ユーザー名
      • パスワード
      • パラメーター
      • ファイルクロール設定
    • 設定の削除
• リクエストヘッダー
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
      • 値
      • ウェブ設定
    • 設定の削除
• 重複ホスト
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 正規名
      • 重複名
    • 設定の削除
• ユーザー
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • ユーザー名
      • ロール
      • グループ
    • 設定の削除
• ロール
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
    • 設定の削除
• グループ
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
    • 削除の方法
• サジェストワード
  • 概要
  • 管理方法
    • 表示方法
      • 単語種別
      • 単語数
• 追加ワード
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 単語
      • 読み
      • パーミッション
      • ラベル
      • ブースト値
    • 設定の削除
  • ダウンロード
    • CSVの内容
  • アップロード
    • CSVの内容
• 除外ワード
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • サジェスト候補
    • 設定の削除
  • ダウンロード
    • CSVの内容
  • アップロード
    • CSVの内容
• システム情報
  • 概要
  • 管理方法
    • 表示方法
    • 表示項目
      • 環境変数のプロパティ
      • システムのプロパティ
      • アプリのプロパティ
      • バグレポートのプロパティ
• 検索ログ
  • 概要
  • 管理方法
  • 一覧
  • 詳細
• ジョブログ
  • 概要
  • 管理方法
    • 表示方法
    • ジョブログ詳細
      • 名前
      • 状態
      • 対象
      • 開始時間
      • 終了時間
      • 実行方法
      • スクリプト
      • 結果
• クロール情報
  • 概要
  • 管理方法
  • 一覧
  • 詳細
    • 項目一覧
      • セッションID
      • クローラーの開始時間
      • クロールの開始時間 (ウェブ/ファイル)
      • クロールの開始時間 (データストア)
      • クロールの終了時間 (ウェブ/ファイル)
      • クロールの実行時間 (データストア)
      • インデクシングの実行時間 (データストア)
      • インデックスのサイズ (データストア)
      • クロールの終了時間 (データストア)
      • クローラーの状態
      • クローラーの終了時間
      • クローラーの実行時間
• ログファイル
  • 概要
  • 設定方法
    • 表示方法
    • ダウンロード
      • server_*.log
      • fess.log
      • fess-crawler.log
      • audit.log
      • fess-thumbnail.log
      • fess-suggest.log
      • fess-urls.log
      • search.log
      • gc-crawler.log
• 障害URL
  • 概要
  • 管理方法
    • 表示方法
  • 障害URLの詳細
    • 詳細の内容
      • URL
      • スレッド名
      • 種類
      • ログ
      • エラー回数
      • 最終アクセス日時
• 検索
  • 概要
  • 管理方法
    • 表示方法
    • 検索一覧
    • 一括削除
• バックアップ
  • 概要
    • ダウンロード
      • fess_config.bulk
      • fess_basic_config.bulk
      • fess_user.bulk
      • system.properties
      • fess.json
      • doc.json
      • click_log.ndjson
      • favorite_log.ndjson
      • search_log.ndjson
      • user_info.ndjson
    • アップロード
• メンテナンス
  • 概要
  • 操作方法
    • 再インデクシング
    • 設定項目
      • エイリアスの更新
      • 辞書の初期化
      • シャード数
      • 最大レプリカ数
    • ドキュメントインデックスのリロード
    • Crawlerインデックス
    • 診断
• アップグレード
  • 概要
  • 操作方法
    • バックアップ
    • データ移行
    • 設定項目
      • 対象バージョン
• クエリーリクエスト
  • 概要
  • 操作方法
    • リクエストの送信
    • 設定項目
      • リクエストファイル

Fess 設定ガイド

• はじめに
  • 対象読者
  • お読みになる前に
  • オンラインでのアクセス
  • 技術的なサポートの連絡先
    • 商用サポート
  • 関連サードパーティー Web サイトの参照
  • コメントおよび提案の送付方法
• システム関連の設定
  • 使用ポートの設定
  • 使用メモリーの設定
    • ウェブアプリのメモリー設定
    • クローラーのメモリー設定
    • OpenSearchのメモリー設定
  • ログの設定
    • ログのファイル
    • ログレベルの変更
• クローラー関連の設定
  • 単語の長さの上限の設定
  • ファイルサイズの設定
  • プロキシの設定
    • 設定方法
• 検索関連の設定
  • ファジー検索
  • 検索時のタイムアウト値
  • 検索時の最大文字数
  • 検索時のタイムアウトのログ出力
  • ヒット件数表示
  • 位置情報検索時のインデックス名
  • リクエストパラメータの言語指定
  • 前方一致検索の指定
  • ハイライトの文字列
  • ハイライトのフラグメント
  • ハイライト生成方法
  • ハイライト対象のタグ
  • OpenSearchのハイライターに渡す値
  • レスポンスに追加するフィールド名
  • フィールド名の追加
  • 検索結果をGSA互換のXML形式で取得する際の設定
• 検索フォームの配置
  • 検索フォームの配置方法
    • 検索フォーム
    • サジェスト
• 仮想ホスト
  • 仮想ホストについて
    • システム設定
    • クロール設定
• Windowsサービスへの登録
  • Windowsサービスとしての登録
    • 事前準備
    • OpenSearchをサービスとして登録
    • 設定
    • 登録方法
    • サービスの設定
• ロールベース検索の設定
  • ロールベース検索について
  • ロールベース検索の設定
    • Fess の管理画面での設定
    • ログイン
    • ログアウト
• インデックスの管理
  • インデックスのバックアップとリストア
• Analyzerの設定
  • Analyzerについて
• 位置情報検索
  • 概要
  • 設定
    • インデックス生成時
    • 検索時
• サムネイル画像の設定
  • サムネイル画像の表示
  • HTMLファイルのサムネイル画像
  • MS Officeファイルのサムネイル画像
    • パッケージのインストール
    • 生成スクリプト
  • PDFファイルのサムネイル画像
  • サムネイルジョブの無効化
• 検索結果の一括取得
  • 検索結果の一括取得について
  • 利用方法
    • スクロール検索の設定
    • スクロール検索の利用
• 検索機能
  • 検索結果件数の表示

JavaDocs

XRef

I/F Doc

14.14

Fess インストールガイド

• はじめに
  • 対象読者
  • お読みになる前に
  • オンラインでのアクセス
  • 技術的なサポートの連絡先
    • 商用サポート
  • コメントおよび提案の送付方法
• インストール
  • インストール要件
  • ダウンロード
  • TAR.GZ版でのインストール
    • OpenSearchのインストール
    • Fessのインストール
  • ZIP版でのインストール
    • OpenSearchのインストール
    • Fessのインストール
  • RPM/DEB版でのインストール
    • OpenSearchのインストール
    • Fessのインストール
  • Docker版でのインストール
• 起動および停止方法
  • 起動方法
    • TAR.GZ版の場合
    • ZIP版の場合
    • RPM/DEB版の場合 (chkconfig)
    • RPM/DEB版の場合 (systemd)
    • Docker版の場合
  • ブラウザー UI へのアクセス
  • 停止方法
    • TAR.GZ/ZIP版の場合
    • RPM/DEB版の場合 (chkconfig)
    • RPM/DEB版の場合 (systemd)
    • Docker版の場合
• アンインストール
  • アンインストール
    • TAR.GZ/ZIP版の場合
    • RPM/DEB版の場合
• アップグレード
  • Fess のアップグレード
    • データのバックアップ
    • パッケージの更新
    • 設定のリストア
    • クローラーの起動

Fess ユーザーガイド

• はじめに
  • 対象読者
  • お読みになる前に
  • オンラインでのアクセス
  • 技術的なサポートの連絡先
    • 商用サポート
  • 関連サードパーティー Web サイトの参照
  • コメントおよび提案の送付方法
• AND 検索
  • AND 検索
    • 利用方法
• OR 検索
  • OR 検索
    • 利用方法
• NOT 検索
  • NOT 検索
    • 利用方法
• ラベル指定検索
  • ラベル指定検索 (カテゴリ検索)
    • 利用方法
• 検索フィールド指定検索
  • フィールド指定検索
    • 利用可能なフィールド
    • 利用方法
• ソート検索
  • ソート検索
    • ソート対象フィールド
    • 利用方法
• ワイルドカード検索
  • ワイルドカード検索
    • 利用方法
    • 利用条件
• 範囲指定検索
  • 範囲指定検索
    • 利用方法
• ブースト検索
  • ブースト検索(重み付け検索)
    • 利用方法
• 曖昧検索
  • 曖昧検索(ファジー検索)
    • 利用方法
• 位置情報検索
  • 位置情報検索
    • 利用方法
• 非表示検索条件
  • 非表示検索条件
    • 利用方法
• ロール検索
  • ロール検索
    • 検索方法
    • パスワードの変更
    • ログアウト
• 特殊文字
  • 特殊文字
    • 利用方法
• 詳細検索
  • 詳細検索
    • 利用方法
    • 項目一覧
      • すべての単語を含む
      • 語順も含めた完全一致
      • いずれかの単語を含む
      • 含めない単語
      • 表示件数
      • ソート
      • 優先する言語
      • ラベル
      • 更新日時
      • ファイル形式
      • 検索対象
      • サイトまたはドメイン

Fess APIガイド

• はじめに
  • 対象読者
  • お読みになる前に
  • オンラインでのアクセス
  • 技術的なサポートの連絡先
    • 商用サポート
  • 関連サードパーティー Web サイトの参照
  • コメントおよび提案の送付方法
• APIの概要
  • Fess の提供するAPI
  • APIの種類
• 検索API
  • 検索結果の取得
    • リクエストパラメーター
    • レスポンス
  • 全てのドキュメントを検索
    • リクエストパラメーター
• ラベルAPI
  • ラベルの取得
    • リクエストパラメーター
    • レスポンス
• 人気ワードAPI
  • 人気ワード一覧の取得
    • リクエストパラメーター
    • レスポンス
• サジェストAPI
  • サジェストワード一覧の取得
    • リクエストパラメーター
    • レスポンス
• Health API
  • 状態の取得
    • リクエストパラメーター
    • レスポンス

Fess 管理者ガイド

• はじめに
  • 対象読者
  • お読みになる前に
  • オンラインでのアクセス
  • 技術的なサポートの連絡先
    • 商用サポート
• ダッシュボード
  • 概要
  • インデックスされているドキュメント数の確認
• 構成ウィザード
  • 概要
    • 簡易セットアップ
    • クロールの設定
    • 設定項目
      • 名前
      • クロールパス
      • 最大アクセス数
      • 深さ
    • クローラ
• 全般
  • 概要
  • 設定内容
    • システム
      • JSONレスポンス
      • ログインが必要
      • ログインリンク表示
      • 重複結果の折り畳み
      • サムネイル表示
      • デフォルトのラベル値
      • デフォルトのソート値
      • 仮想ホスト
      • 人気ワードのレスポンス
      • CSVファイルのエンコード
      • 検索パラメーターの追加
      • 通知メール
    • クローラー
      • 最終更新日時の確認
      • 同時クローラー設定
      • 以前のドキュメントを削除
      • 除外するエラーの種類
      • 障害数のしきい値
    • ロギング
      • 検索ログ
      • ユーザログ
      • お気に入りログ
      • 以前の検索ログを削除
      • 以前のジョブログを削除
      • 以前のユーザーログを削除
      • ログを削除するボット名
      • ログレベル
    • サジェスト
      • 検索語でサジェスト
      • ドキュメントでサジェスト
      • 以前のサジェスト情報を削除
    • LDAP
      • LDAP URL
      • Base DN
      • Bind DN
      • パスワード
      • User DN
      • アカウントフィルター
      • グループフィルター
      • memberOf属性
    • お知らせ表示
      • ログインページ
      • 検索トップページ
    • ストレージ
      • エンドポイント
      • アクセスキー
      • シークレットキー
      • バケット
  • 例
    • LDAPの設定例
• スケジューラ
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
      • 対象
      • スケジュール
      • 実行方法
      • スクリプト
      • ロギング
      • クローラージョブ
      • 状態
      • 表示順序
    • 設定の削除
  • 手動クロール方法
• ページのデザイン
  • 概要
  • 設定方法
    • 表示方法
    • ファイルマネージャー
    • ページファイルの表示
    • アップロードするファイル
      • ファイルのアップロード
      • フィイル名(オプション)
• 辞書
  • 概要
  • 一覧
  • Kuromoji
  • 同義語
  • マッピング
  • Protwords
  • ストップワード
  • Stemmer上書き
• Kuromoji辞書
  • 概要
  • 管理方法
    • 表示方法
    • 設定方法
    • 設定項目
      • トークン
      • 分割
      • 読み
      • 品詞
  • ダウンロード
  • アップロード
• 同義語辞書
  • 概要
  • 管理方法
    • 表示方法
    • 設定方法
    • 設定項目
      • 変換元
      • 変換後
  • ダウンロード
  • アップロード
• マッピング辞書
  • 概要
  • 管理方法
    • 表示方法
    • 設定方法
    • 設定項目
      • 変換元
      • 変換後
  • ダウンロード
  • アップロード
• Protwords辞書
  • 概要
  • 管理方法
    • 表示方法
    • 設定方法
    • 設定項目
      • 単語情報
  • ダウンロード
  • アップロード
• ストップワード辞書
  • 概要
  • 管理方法
    • 表示方法
    • 設定方法
    • 設定項目
      • 変換元
      • 変換後
  • ダウンロード
  • アップロード
• Stemmer上書き辞書
  • 概要
  • 管理方法
    • 表示方法
    • 設定方法
    • 設定項目
      • 変換元
      • 変換後
  • ダウンロード
  • アップロード
• アクセストークン
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
      • パーミッション
      • パラメーター名
      • 有効期限
    • 設定の削除
• プラグイン
  • 概要
  • 管理方法
    • 表示方法
    • インストール
• ストレージ
  • 概要
  • 管理方法
    • オブジェクトストレージサーバーの設定
    • 表示方法
      • 名前
      • サイズ
      • 最終更新日時
    • ダウンロード
    • 削除
    • アップロード
    • フォルダーの作成
• ウェブクロール
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
      • URL
      • クロール対象とするURL
      • クロール対象から除外するURL
      • 検索対象とするURL
      • 検索対象から除外するURL
      • 設定パラメーター
      • 深さ
      • 最大アクセス数
      • ユーザーエージェント
      • スレッド数
      • 間隔
      • ブースト値
      • パーミッション
      • 仮想ホスト
      • 状態
      • 説明
    • 設定の削除
  • 例
    • fess.codelibs.org をクロールする
    • ウェブ認証サイトのウェブクロール
      • Redmine
      • XWiki
• ファイルクロール
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
      • パス
      • クロール対象とするパス
      • クロール対象から除外するパス
      • 検索対象とするパス
      • 検索対象から除外するパス
      • 設定パラメーター
      • 深さ
      • 最大アクセス数
      • スレッド数
      • 間隔
      • ブースト値
      • パーミッション
      • 仮想ホスト
      • 状態
      • 説明
    • 設定の削除
  • 例
    • ローカルファイルをクロール
    • Windowsの共有フォルダーをクロール
• データストアクロール
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
      • ハンドラー名
      • パラメーター
      • スクリプト
      • ブースト値
      • パーミッション
      • 仮想ホスト
      • 状態
      • 説明
    • 設定の削除
  • 例
    • DatabaseDataStore
      • パラメーター
      • スクリプト
      • ドライバー
    • CsvDataStore
      • パラメーター
      • スクリプト
    • EsDataStore
      • パラメーター
      • スクリプト
    • CsvListDataStore
      • パラメーター
      • スクリプト
• ラベル
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
      • 値
      • 対象とするパス
      • 除外するパス
      • パーミッション
      • 仮想ホスト
      • 表示順序
    • 設定の削除
• キーマッチ
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 検索語
      • クエリー
      • サイズ
      • ブースト値
      • 仮想ホスト
    • 設定の削除
• ドキュメントブースト
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 条件
      • ブースト値式
      • ソート順
    • 設定の削除
• 関連コンテンツ
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 検索語
      • コンテンツ
      • 仮想ホスト
    • 設定の削除
• 関連クエリー
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 検索語
      • クエリー
      • 仮想ホスト
    • 設定の削除
• パスマッピング
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 正規表現
      • 置換
      • 処理の種類
      • 表示順序
    • 設定の削除
• ウェブ認証
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • ホスト名
      • ポート
      • レルム
      • スキーム
      • ユーザー名
      • パスワード
      • パラメーター
      • ウェブ設定
    • 設定の削除
• ファイル認証
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • ホスト名
      • ポート
      • スキーム
      • ユーザー名
      • パスワード
      • パラメーター
      • ファイルクロール設定
    • 設定の削除
• リクエストヘッダー
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
      • 値
      • ウェブ設定
    • 設定の削除
• 重複ホスト
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 正規名
      • 重複名
    • 設定の削除
• ユーザー
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • ユーザー名
      • ロール
      • グループ
    • 設定の削除
• ロール
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
    • 設定の削除
• グループ
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
    • 削除の方法
• サジェストワード
  • 概要
  • 管理方法
    • 表示方法
      • 単語種別
      • 単語数
• 追加ワード
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 単語
      • 読み
      • パーミッション
      • ラベル
      • ブースト値
    • 設定の削除
  • ダウンロード
    • CSVの内容
  • アップロード
    • CSVの内容
• 除外ワード
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • サジェスト候補
    • 設定の削除
  • ダウンロード
    • CSVの内容
  • アップロード
    • CSVの内容
• システム情報
  • 概要
  • 管理方法
    • 表示方法
    • 表示項目
      • 環境変数のプロパティ
      • システムのプロパティ
      • アプリのプロパティ
      • バグレポートのプロパティ
• 検索ログ
  • 概要
  • 管理方法
  • 一覧
  • 詳細
• ジョブログ
  • 概要
  • 管理方法
    • 表示方法
    • ジョブログ詳細
      • 名前
      • 状態
      • 対象
      • 開始時間
      • 終了時間
      • 実行方法
      • スクリプト
      • 結果
• クロール情報
  • 概要
  • 管理方法
  • 一覧
  • 詳細
    • 項目一覧
      • セッションID
      • クローラーの開始時間
      • クロールの開始時間 (ウェブ/ファイル)
      • クロールの開始時間 (データストア)
      • クロールの終了時間 (ウェブ/ファイル)
      • クロールの実行時間 (データストア)
      • インデクシングの実行時間 (データストア)
      • インデックスのサイズ (データストア)
      • クロールの終了時間 (データストア)
      • クローラーの状態
      • クローラーの終了時間
      • クローラーの実行時間
• ログファイル
  • 概要
  • 設定方法
    • 表示方法
    • ダウンロード
      • server_*.log
      • fess.log
      • fess-crawler.log
      • audit.log
      • fess-thumbnail.log
      • fess-suggest.log
      • fess-urls.log
      • search.log
      • gc-crawler.log
• 障害URL
  • 概要
  • 管理方法
    • 表示方法
  • 障害URLの詳細
    • 詳細の内容
      • URL
      • スレッド名
      • 種類
      • ログ
      • エラー回数
      • 最終アクセス日時
• 検索
  • 概要
  • 管理方法
    • 表示方法
    • 検索一覧
    • 一括削除
• バックアップ
  • 概要
    • ダウンロード
      • fess_config.bulk
      • fess_basic_config.bulk
      • fess_user.bulk
      • system.properties
      • fess.json
      • doc.json
      • click_log.ndjson
      • favorite_log.ndjson
      • search_log.ndjson
      • user_info.ndjson
    • アップロード
• メンテナンス
  • 概要
  • 操作方法
    • 再インデクシング
    • 設定項目
      • エイリアスの更新
      • 辞書の初期化
      • シャード数
      • 最大レプリカ数
    • ドキュメントインデックスのリロード
    • Crawlerインデックス
    • 診断
• アップグレード
  • 概要
  • 操作方法
    • バックアップ
    • データ移行
    • 設定項目
      • 対象バージョン
• クエリーリクエスト
  • 概要
  • 操作方法
    • リクエストの送信
    • 設定項目
      • リクエストファイル

Fess 設定ガイド

• はじめに
  • 対象読者
  • お読みになる前に
  • オンラインでのアクセス
  • 技術的なサポートの連絡先
    • 商用サポート
  • 関連サードパーティー Web サイトの参照
  • コメントおよび提案の送付方法
• システム関連の設定
  • 使用ポートの設定
  • 使用メモリーの設定
    • ウェブアプリのメモリー設定
    • クローラーのメモリー設定
    • OpenSearchのメモリー設定
  • ログの設定
    • ログのファイル
    • ログレベルの変更
• クローラー関連の設定
  • 単語の長さの上限の設定
  • ファイルサイズの設定
  • プロキシの設定
    • 設定方法
• 検索関連の設定
  • ファジー検索
  • 検索時のタイムアウト値
  • 検索時の最大文字数
  • 検索時のタイムアウトのログ出力
  • ヒット件数表示
  • 位置情報検索時のインデックス名
  • リクエストパラメータの言語指定
  • 前方一致検索の指定
  • ハイライトの文字列
  • ハイライトのフラグメント
  • ハイライト生成方法
  • ハイライト対象のタグ
  • OpenSearchのハイライターに渡す値
  • レスポンスに追加するフィールド名
  • フィールド名の追加
  • 検索結果をGSA互換のXML形式で取得する際の設定
• 検索フォームの配置
  • 検索フォームの配置方法
    • 検索フォーム
    • サジェスト
• 仮想ホスト
  • 仮想ホストについて
    • システム設定
    • クロール設定
• Windowsサービスへの登録
  • Windowsサービスとしての登録
    • 事前準備
    • OpenSearchをサービスとして登録
    • 設定
    • 登録方法
    • サービスの設定
• ロールベース検索の設定
  • ロールベース検索について
  • ロールベース検索の設定
    • Fess の管理画面での設定
    • ログイン
    • ログアウト
• インデックスの管理
  • インデックスのバックアップとリストア
• Analyzerの設定
  • Analyzerについて
• 位置情報検索
  • 概要
  • 設定
    • インデックス生成時
    • 検索時
• サムネイル画像の設定
  • サムネイル画像の表示
  • HTMLファイルのサムネイル画像
  • MS Officeファイルのサムネイル画像
    • パッケージのインストール
    • 生成スクリプト
  • PDFファイルのサムネイル画像
  • サムネイルジョブの無効化
• 検索結果の一括取得
  • 検索結果の一括取得について
  • 利用方法
    • スクロール検索の設定
    • スクロール検索の利用
• 検索機能
  • 検索結果件数の表示

JavaDocs

XRef

I/F Doc

14.13

Fess インストールガイド

• はじめに
  • 対象読者
  • お読みになる前に
  • オンラインでのアクセス
  • 技術的なサポートの連絡先
    • 商用サポート
  • コメントおよび提案の送付方法
• インストール
  • インストール要件
  • ダウンロード
  • TAR.GZ版でのインストール
    • OpenSearchのインストール
    • Fessのインストール
  • ZIP版でのインストール
    • OpenSearchのインストール
    • Fessのインストール
  • RPM/DEB版でのインストール
    • OpenSearchのインストール
    • Fessのインストール
  • Docker版でのインストール
• 起動および停止方法
  • 起動方法
    • TAR.GZ版の場合
    • ZIP版の場合
    • RPM/DEB版の場合 (chkconfig)
    • RPM/DEB版の場合 (systemd)
    • Docker版の場合
  • ブラウザー UI へのアクセス
  • 停止方法
    • TAR.GZ/ZIP版の場合
    • RPM/DEB版の場合 (chkconfig)
    • RPM/DEB版の場合 (systemd)
    • Docker版の場合
• アンインストール
  • アンインストール
    • TAR.GZ/ZIP版の場合
    • RPM/DEB版の場合
• アップグレード
  • Fess のアップグレード
    • データのバックアップ
    • パッケージの更新
    • 設定のリストア
    • クローラーの起動

Fess ユーザーガイド

• はじめに
  • 対象読者
  • お読みになる前に
  • オンラインでのアクセス
  • 技術的なサポートの連絡先
    • 商用サポート
  • 関連サードパーティー Web サイトの参照
  • コメントおよび提案の送付方法
• AND 検索
  • AND 検索
    • 利用方法
• OR 検索
  • OR 検索
    • 利用方法
• NOT 検索
  • NOT 検索
    • 利用方法
• ラベル指定検索
  • ラベル指定検索 (カテゴリ検索)
    • 利用方法
• 検索フィールド指定検索
  • フィールド指定検索
    • 利用可能なフィールド
    • 利用方法
• ソート検索
  • ソート検索
    • ソート対象フィールド
    • 利用方法
• ワイルドカード検索
  • ワイルドカード検索
    • 利用方法
    • 利用条件
• 範囲指定検索
  • 範囲指定検索
    • 利用方法
• ブースト検索
  • ブースト検索(重み付け検索)
    • 利用方法
• 曖昧検索
  • 曖昧検索(ファジー検索)
    • 利用方法
• 位置情報検索
  • 位置情報検索
    • 利用方法
• 非表示検索条件
  • 非表示検索条件
    • 利用方法
• ロール検索
  • ロール検索
    • 検索方法
    • パスワードの変更
    • ログアウト
• 特殊文字
  • 特殊文字
    • 利用方法
• 詳細検索
  • 詳細検索
    • 利用方法
    • 項目一覧
      • すべての単語を含む
      • 語順も含めた完全一致
      • いずれかの単語を含む
      • 含めない単語
      • 表示件数
      • ソート
      • 優先する言語
      • ラベル
      • 更新日時
      • ファイル形式
      • 検索対象
      • サイトまたはドメイン

Fess APIガイド

• はじめに
  • 対象読者
  • お読みになる前に
  • オンラインでのアクセス
  • 技術的なサポートの連絡先
    • 商用サポート
  • 関連サードパーティー Web サイトの参照
  • コメントおよび提案の送付方法
• APIの概要
  • Fess の提供するAPI
  • APIの種類
• 検索API
  • 検索結果の取得
    • リクエストパラメーター
    • レスポンス
  • 全てのドキュメントを検索
    • リクエストパラメーター
• ラベルAPI
  • ラベルの取得
    • リクエストパラメーター
    • レスポンス
• 人気ワードAPI
  • 人気ワード一覧の取得
    • リクエストパラメーター
    • レスポンス
• サジェストAPI
  • サジェストワード一覧の取得
    • リクエストパラメーター
    • レスポンス
• Health API
  • 状態の取得
    • リクエストパラメーター
    • レスポンス

Fess 管理者ガイド

• はじめに
  • 対象読者
  • お読みになる前に
  • オンラインでのアクセス
  • 技術的なサポートの連絡先
    • 商用サポート
• ダッシュボード
  • 概要
  • インデックスされているドキュメント数の確認
• 構成ウィザード
  • 概要
    • 簡易セットアップ
    • クロールの設定
    • 設定項目
      • 名前
      • クロールパス
      • 最大アクセス数
      • 深さ
    • クローラ
• 全般
  • 概要
  • 設定内容
    • システム
      • JSONレスポンス
      • ログインが必要
      • ログインリンク表示
      • 重複結果の折り畳み
      • サムネイル表示
      • デフォルトのラベル値
      • デフォルトのソート値
      • 仮想ホスト
      • 人気ワードのレスポンス
      • CSVファイルのエンコード
      • 検索パラメーターの追加
      • 通知メール
    • クローラー
      • 最終更新日時の確認
      • 同時クローラー設定
      • 以前のドキュメントを削除
      • 除外するエラーの種類
      • 障害数のしきい値
    • ロギング
      • 検索ログ
      • ユーザログ
      • お気に入りログ
      • 以前の検索ログを削除
      • 以前のジョブログを削除
      • 以前のユーザーログを削除
      • ログを削除するボット名
      • ログレベル
    • サジェスト
      • 検索語でサジェスト
      • ドキュメントでサジェスト
      • 以前のサジェスト情報を削除
    • LDAP
      • LDAP URL
      • Base DN
      • Bind DN
      • パスワード
      • User DN
      • アカウントフィルター
      • グループフィルター
      • memberOf属性
    • お知らせ表示
      • ログインページ
      • 検索トップページ
    • ストレージ
      • エンドポイント
      • アクセスキー
      • シークレットキー
      • バケット
  • 例
    • LDAPの設定例
• スケジューラ
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
      • 対象
      • スケジュール
      • 実行方法
      • スクリプト
      • ロギング
      • クローラージョブ
      • 状態
      • 表示順序
    • 設定の削除
  • 手動クロール方法
• ページのデザイン
  • 概要
  • 設定方法
    • 表示方法
    • ファイルマネージャー
    • ページファイルの表示
    • アップロードするファイル
      • ファイルのアップロード
      • フィイル名(オプション)
• 辞書
  • 概要
  • 一覧
  • Kuromoji
  • 同義語
  • マッピング
  • Protwords
  • ストップワード
  • Stemmer上書き
• Kuromoji辞書
  • 概要
  • 管理方法
    • 表示方法
    • 設定方法
    • 設定項目
      • トークン
      • 分割
      • 読み
      • 品詞
  • ダウンロード
  • アップロード
• 同義語辞書
  • 概要
  • 管理方法
    • 表示方法
    • 設定方法
    • 設定項目
      • 変換元
      • 変換後
  • ダウンロード
  • アップロード
• マッピング辞書
  • 概要
  • 管理方法
    • 表示方法
    • 設定方法
    • 設定項目
      • 変換元
      • 変換後
  • ダウンロード
  • アップロード
• Protwords辞書
  • 概要
  • 管理方法
    • 表示方法
    • 設定方法
    • 設定項目
      • 単語情報
  • ダウンロード
  • アップロード
• ストップワード辞書
  • 概要
  • 管理方法
    • 表示方法
    • 設定方法
    • 設定項目
      • 変換元
      • 変換後
  • ダウンロード
  • アップロード
• Stemmer上書き辞書
  • 概要
  • 管理方法
    • 表示方法
    • 設定方法
    • 設定項目
      • 変換元
      • 変換後
  • ダウンロード
  • アップロード
• アクセストークン
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
      • パーミッション
      • パラメーター名
      • 有効期限
    • 設定の削除
• プラグイン
  • 概要
  • 管理方法
    • 表示方法
    • インストール
• ストレージ
  • 概要
  • 管理方法
    • オブジェクトストレージサーバーの設定
    • 表示方法
      • 名前
      • サイズ
      • 最終更新日時
    • ダウンロード
    • 削除
    • アップロード
    • フォルダーの作成
• ウェブクロール
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
      • URL
      • クロール対象とするURL
      • クロール対象から除外するURL
      • 検索対象とするURL
      • 検索対象から除外するURL
      • 設定パラメーター
      • 深さ
      • 最大アクセス数
      • ユーザーエージェント
      • スレッド数
      • 間隔
      • ブースト値
      • パーミッション
      • 仮想ホスト
      • 状態
      • 説明
    • 設定の削除
  • 例
    • fess.codelibs.org をクロールする
    • ウェブ認証サイトのウェブクロール
      • Redmine
      • XWiki
• ファイルクロール
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
      • パス
      • クロール対象とするパス
      • クロール対象から除外するパス
      • 検索対象とするパス
      • 検索対象から除外するパス
      • 設定パラメーター
      • 深さ
      • 最大アクセス数
      • スレッド数
      • 間隔
      • ブースト値
      • パーミッション
      • 仮想ホスト
      • 状態
      • 説明
    • 設定の削除
  • 例
    • ローカルファイルをクロール
    • Windowsの共有フォルダーをクロール
• データストアクロール
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
      • ハンドラー名
      • パラメーター
      • スクリプト
      • ブースト値
      • パーミッション
      • 仮想ホスト
      • 状態
      • 説明
    • 設定の削除
  • 例
    • DatabaseDataStore
      • パラメーター
      • スクリプト
      • ドライバー
    • CsvDataStore
      • パラメーター
      • スクリプト
    • EsDataStore
      • パラメーター
      • スクリプト
    • CsvListDataStore
      • パラメーター
      • スクリプト
• ラベル
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
      • 値
      • 対象とするパス
      • 除外するパス
      • パーミッション
      • 仮想ホスト
      • 表示順序
    • 設定の削除
• キーマッチ
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 検索語
      • クエリー
      • サイズ
      • ブースト値
      • 仮想ホスト
    • 設定の削除
• ドキュメントブースト
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 条件
      • ブースト値式
      • ソート順
    • 設定の削除
• 関連コンテンツ
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 検索語
      • コンテンツ
      • 仮想ホスト
    • 設定の削除
• 関連クエリー
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 検索語
      • クエリー
      • 仮想ホスト
    • 設定の削除
• パスマッピング
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 正規表現
      • 置換
      • 処理の種類
      • 表示順序
    • 設定の削除
• ウェブ認証
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • ホスト名
      • ポート
      • レルム
      • スキーム
      • ユーザー名
      • パスワード
      • パラメーター
      • ウェブ設定
    • 設定の削除
• ファイル認証
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • ホスト名
      • ポート
      • スキーム
      • ユーザー名
      • パスワード
      • パラメーター
      • ファイルクロール設定
    • 設定の削除
• リクエストヘッダー
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
      • 値
      • ウェブ設定
    • 設定の削除
• 重複ホスト
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 正規名
      • 重複名
    • 設定の削除
• ユーザー
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • ユーザー名
      • ロール
      • グループ
    • 設定の削除
• ロール
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
    • 設定の削除
• グループ
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
    • 削除の方法
• サジェストワード
  • 概要
  • 管理方法
    • 表示方法
      • 単語種別
      • 単語数
• 追加ワード
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 単語
      • 読み
      • パーミッション
      • ラベル
      • ブースト値
    • 設定の削除
  • ダウンロード
    • CSVの内容
  • アップロード
    • CSVの内容
• 除外ワード
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • サジェスト候補
    • 設定の削除
  • ダウンロード
    • CSVの内容
  • アップロード
    • CSVの内容
• システム情報
  • 概要
  • 管理方法
    • 表示方法
    • 表示項目
      • 環境変数のプロパティ
      • システムのプロパティ
      • アプリのプロパティ
      • バグレポートのプロパティ
• 検索ログ
  • 概要
  • 管理方法
  • 一覧
  • 詳細
• ジョブログ
  • 概要
  • 管理方法
    • 表示方法
    • ジョブログ詳細
      • 名前
      • 状態
      • 対象
      • 開始時間
      • 終了時間
      • 実行方法
      • スクリプト
      • 結果
• クロール情報
  • 概要
  • 管理方法
  • 一覧
  • 詳細
    • 項目一覧
      • セッションID
      • クローラーの開始時間
      • クロールの開始時間 (ウェブ/ファイル)
      • クロールの開始時間 (データストア)
      • クロールの終了時間 (ウェブ/ファイル)
      • クロールの実行時間 (データストア)
      • インデクシングの実行時間 (データストア)
      • インデックスのサイズ (データストア)
      • クロールの終了時間 (データストア)
      • クローラーの状態
      • クローラーの終了時間
      • クローラーの実行時間
• ログファイル
  • 概要
  • 設定方法
    • 表示方法
    • ダウンロード
      • server_*.log
      • fess.log
      • fess-crawler.log
      • audit.log
      • fess-thumbnail.log
      • fess-suggest.log
      • fess-urls.log
      • search.log
      • gc-crawler.log
• 障害URL
  • 概要
  • 管理方法
    • 表示方法
  • 障害URLの詳細
    • 詳細の内容
      • URL
      • スレッド名
      • 種類
      • ログ
      • エラー回数
      • 最終アクセス日時
• 検索
  • 概要
  • 管理方法
    • 表示方法
    • 検索一覧
    • 一括削除
• バックアップ
  • 概要
    • ダウンロード
      • fess_config.bulk
      • fess_basic_config.bulk
      • fess_user.bulk
      • system.properties
      • fess.json
      • doc.json
      • click_log.ndjson
      • favorite_log.ndjson
      • search_log.ndjson
      • user_info.ndjson
    • アップロード
• メンテナンス
  • 概要
  • 操作方法
    • 再インデクシング
    • 設定項目
      • エイリアスの更新
      • 辞書の初期化
      • シャード数
      • 最大レプリカ数
    • ドキュメントインデックスのリロード
    • Crawlerインデックス
    • 診断
• アップグレード
  • 概要
  • 操作方法
    • バックアップ
    • データ移行
    • 設定項目
      • 対象バージョン
• クエリーリクエスト
  • 概要
  • 操作方法
    • リクエストの送信
    • 設定項目
      • リクエストファイル

Fess 設定ガイド

• はじめに
  • 対象読者
  • お読みになる前に
  • オンラインでのアクセス
  • 技術的なサポートの連絡先
    • 商用サポート
  • 関連サードパーティー Web サイトの参照
  • コメントおよび提案の送付方法
• システム関連の設定
  • 使用ポートの設定
  • 使用メモリーの設定
    • ウェブアプリのメモリー設定
    • クローラーのメモリー設定
    • OpenSearchのメモリー設定
  • ログの設定
    • ログのファイル
    • ログレベルの変更
• クローラー関連の設定
  • 単語の長さの上限の設定
  • ファイルサイズの設定
  • プロキシの設定
    • 設定方法
• 検索関連の設定
  • ファジー検索
  • 検索時のタイムアウト値
  • 検索時の最大文字数
  • 検索時のタイムアウトのログ出力
  • ヒット件数表示
  • 位置情報検索時のインデックス名
  • リクエストパラメータの言語指定
  • 前方一致検索の指定
  • ハイライトの文字列
  • ハイライトのフラグメント
  • ハイライト生成方法
  • ハイライト対象のタグ
  • OpenSearchのハイライターに渡す値
  • レスポンスに追加するフィールド名
  • フィールド名の追加
  • 検索結果をGSA互換のXML形式で取得する際の設定
• 検索フォームの配置
  • 検索フォームの配置方法
    • 検索フォーム
    • サジェスト
• 仮想ホスト
  • 仮想ホストについて
    • システム設定
    • クロール設定
• Windowsサービスへの登録
  • Windowsサービスとしての登録
    • 事前準備
    • OpenSearchをサービスとして登録
    • 設定
    • 登録方法
    • サービスの設定
• ロールベース検索の設定
  • ロールベース検索について
  • ロールベース検索の設定
    • Fess の管理画面での設定
    • ログイン
    • ログアウト
• インデックスの管理
  • インデックスのバックアップとリストア
• Analyzerの設定
  • Analyzerについて
• 位置情報検索
  • 概要
  • 設定
    • インデックス生成時
    • 検索時
• サムネイル画像の設定
  • サムネイル画像の表示
  • HTMLファイルのサムネイル画像
  • MS Officeファイルのサムネイル画像
    • パッケージのインストール
    • 生成スクリプト
  • PDFファイルのサムネイル画像
  • サムネイルジョブの無効化
• 検索結果の一括取得
  • 検索結果の一括取得について
  • 利用方法
    • スクロール検索の設定
    • スクロール検索の利用
• 検索機能
  • 検索結果件数の表示

JavaDocs

XRef

I/F Doc

14.12

Fess インストールガイド

• はじめに
  • 対象読者
  • お読みになる前に
  • オンラインでのアクセス
  • 技術的なサポートの連絡先
    • 商用サポート
  • コメントおよび提案の送付方法
• インストール
  • インストール要件
  • ダウンロード
  • TAR.GZ版でのインストール
    • OpenSearchのインストール
    • Fessのインストール
  • ZIP版でのインストール
    • OpenSearchのインストール
    • Fessのインストール
  • RPM/DEB版でのインストール
    • OpenSearchのインストール
    • Fessのインストール
  • Docker版でのインストール
• 起動および停止方法
  • 起動方法
    • TAR.GZ版の場合
    • ZIP版の場合
    • RPM/DEB版の場合 (chkconfig)
    • RPM/DEB版の場合 (systemd)
    • Docker版の場合
  • ブラウザー UI へのアクセス
  • 停止方法
    • TAR.GZ/ZIP版の場合
    • RPM/DEB版の場合 (chkconfig)
    • RPM/DEB版の場合 (systemd)
    • Docker版の場合
• アンインストール
  • アンインストール
    • TAR.GZ/ZIP版の場合
    • RPM/DEB版の場合
• アップグレード
  • Fess のアップグレード
    • データのバックアップ
    • パッケージの更新
    • 設定のリストア
    • クローラーの起動

Fess ユーザーガイド

• はじめに
  • 対象読者
  • お読みになる前に
  • オンラインでのアクセス
  • 技術的なサポートの連絡先
    • 商用サポート
  • 関連サードパーティー Web サイトの参照
  • コメントおよび提案の送付方法
• AND 検索
  • AND 検索
    • 利用方法
• OR 検索
  • OR 検索
    • 利用方法
• NOT 検索
  • NOT 検索
    • 利用方法
• ラベル指定検索
  • ラベル指定検索 (カテゴリ検索)
    • 利用方法
• 検索フィールド指定検索
  • フィールド指定検索
    • 利用可能なフィールド
    • 利用方法
• ソート検索
  • ソート検索
    • ソート対象フィールド
    • 利用方法
• ワイルドカード検索
  • ワイルドカード検索
    • 利用方法
    • 利用条件
• 範囲指定検索
  • 範囲指定検索
    • 利用方法
• ブースト検索
  • ブースト検索(重み付け検索)
    • 利用方法
• 曖昧検索
  • 曖昧検索(ファジー検索)
    • 利用方法
• 位置情報検索
  • 位置情報検索
    • 利用方法
• 非表示検索条件
  • 非表示検索条件
    • 利用方法
• ロール検索
  • ロール検索
    • 検索方法
    • パスワードの変更
    • ログアウト
• 特殊文字
  • 特殊文字
    • 利用方法
• 詳細検索
  • 詳細検索
    • 利用方法
    • 項目一覧
      • すべての単語を含む
      • 語順も含めた完全一致
      • いずれかの単語を含む
      • 含めない単語
      • 表示件数
      • ソート
      • 優先する言語
      • ラベル
      • 更新日時
      • ファイル形式
      • 検索対象
      • サイトまたはドメイン

Fess APIガイド

• はじめに
  • 対象読者
  • お読みになる前に
  • オンラインでのアクセス
  • 技術的なサポートの連絡先
    • 商用サポート
  • 関連サードパーティー Web サイトの参照
  • コメントおよび提案の送付方法
• APIの概要
  • Fess の提供するAPI
  • APIの種類
• 検索API
  • 検索結果の取得
    • リクエストパラメーター
    • レスポンス
  • 全てのドキュメントを検索
    • リクエストパラメーター
• ラベルAPI
  • ラベルの取得
    • リクエストパラメーター
    • レスポンス
• 人気ワードAPI
  • 人気ワード一覧の取得
    • リクエストパラメーター
    • レスポンス
• サジェストAPI
  • サジェストワード一覧の取得
    • リクエストパラメーター
    • レスポンス
• Health API
  • 状態の取得
    • リクエストパラメーター
    • レスポンス

Fess 管理者ガイド

• はじめに
  • 対象読者
  • お読みになる前に
  • オンラインでのアクセス
  • 技術的なサポートの連絡先
    • 商用サポート
• ダッシュボード
  • 概要
  • インデックスされているドキュメント数の確認
• 構成ウィザード
  • 概要
    • 簡易セットアップ
    • クロールの設定
    • 設定項目
      • 名前
      • クロールパス
      • 最大アクセス数
      • 深さ
    • クローラ
• 全般
  • 概要
  • 設定内容
    • システム
      • JSONレスポンス
      • ログインが必要
      • ログインリンク表示
      • 重複結果の折り畳み
      • サムネイル表示
      • デフォルトのラベル値
      • デフォルトのソート値
      • 仮想ホスト
      • 人気ワードのレスポンス
      • CSVファイルのエンコード
      • 検索パラメーターの追加
      • 通知メール
    • クローラー
      • 最終更新日時の確認
      • 同時クローラー設定
      • 以前のドキュメントを削除
      • 除外するエラーの種類
      • 障害数のしきい値
    • ロギング
      • 検索ログ
      • ユーザログ
      • お気に入りログ
      • 以前の検索ログを削除
      • 以前のジョブログを削除
      • 以前のユーザーログを削除
      • ログを削除するボット名
      • ログレベル
    • サジェスト
      • 検索語でサジェスト
      • ドキュメントでサジェスト
      • 以前のサジェスト情報を削除
    • LDAP
      • LDAP URL
      • Base DN
      • Bind DN
      • パスワード
      • User DN
      • アカウントフィルター
      • グループフィルター
      • memberOf属性
    • お知らせ表示
      • ログインページ
      • 検索トップページ
    • ストレージ
      • エンドポイント
      • アクセスキー
      • シークレットキー
      • バケット
  • 例
    • LDAPの設定例
• スケジューラ
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
      • 対象
      • スケジュール
      • 実行方法
      • スクリプト
      • ロギング
      • クローラージョブ
      • 状態
      • 表示順序
    • 設定の削除
  • 手動クロール方法
• ページのデザイン
  • 概要
  • 設定方法
    • 表示方法
    • ファイルマネージャー
    • ページファイルの表示
    • アップロードするファイル
      • ファイルのアップロード
      • フィイル名(オプション)
• 辞書
  • 概要
  • 一覧
  • Kuromoji
  • 同義語
  • マッピング
  • Protwords
  • ストップワード
  • Stemmer上書き
• Kuromoji辞書
  • 概要
  • 管理方法
    • 表示方法
    • 設定方法
    • 設定項目
      • トークン
      • 分割
      • 読み
      • 品詞
  • ダウンロード
  • アップロード
• 同義語辞書
  • 概要
  • 管理方法
    • 表示方法
    • 設定方法
    • 設定項目
      • 変換元
      • 変換後
  • ダウンロード
  • アップロード
• マッピング辞書
  • 概要
  • 管理方法
    • 表示方法
    • 設定方法
    • 設定項目
      • 変換元
      • 変換後
  • ダウンロード
  • アップロード
• Protwords辞書
  • 概要
  • 管理方法
    • 表示方法
    • 設定方法
    • 設定項目
      • 単語情報
  • ダウンロード
  • アップロード
• ストップワード辞書
  • 概要
  • 管理方法
    • 表示方法
    • 設定方法
    • 設定項目
      • 変換元
      • 変換後
  • ダウンロード
  • アップロード
• Stemmer上書き辞書
  • 概要
  • 管理方法
    • 表示方法
    • 設定方法
    • 設定項目
      • 変換元
      • 変換後
  • ダウンロード
  • アップロード
• アクセストークン
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
      • パーミッション
      • パラメーター名
      • 有効期限
    • 設定の削除
• プラグイン
  • 概要
  • 管理方法
    • 表示方法
    • インストール
• ストレージ
  • 概要
  • 管理方法
    • オブジェクトストレージサーバーの設定
    • 表示方法
      • 名前
      • サイズ
      • 最終更新日時
    • ダウンロード
    • 削除
    • アップロード
    • フォルダーの作成
• ウェブクロール
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
      • URL
      • クロール対象とするURL
      • クロール対象から除外するURL
      • 検索対象とするURL
      • 検索対象から除外するURL
      • 設定パラメーター
      • 深さ
      • 最大アクセス数
      • ユーザーエージェント
      • スレッド数
      • 間隔
      • ブースト値
      • パーミッション
      • 仮想ホスト
      • 状態
      • 説明
    • 設定の削除
  • 例
    • fess.codelibs.org をクロールする
    • ウェブ認証サイトのウェブクロール
      • Redmine
      • XWiki
• ファイルクロール
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
      • パス
      • クロール対象とするパス
      • クロール対象から除外するパス
      • 検索対象とするパス
      • 検索対象から除外するパス
      • 設定パラメーター
      • 深さ
      • 最大アクセス数
      • スレッド数
      • 間隔
      • ブースト値
      • パーミッション
      • 仮想ホスト
      • 状態
      • 説明
    • 設定の削除
  • 例
    • ローカルファイルをクロール
    • Windowsの共有フォルダーをクロール
• データストアクロール
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
      • ハンドラー名
      • パラメーター
      • スクリプト
      • ブースト値
      • パーミッション
      • 仮想ホスト
      • 状態
      • 説明
    • 設定の削除
  • 例
    • DatabaseDataStore
      • パラメーター
      • スクリプト
      • ドライバー
    • CsvDataStore
      • パラメーター
      • スクリプト
    • EsDataStore
      • パラメーター
      • スクリプト
    • CsvListDataStore
      • パラメーター
      • スクリプト
• ラベル
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
      • 値
      • 対象とするパス
      • 除外するパス
      • パーミッション
      • 仮想ホスト
      • 表示順序
    • 設定の削除
• キーマッチ
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 検索語
      • クエリー
      • サイズ
      • ブースト値
      • 仮想ホスト
    • 設定の削除
• ドキュメントブースト
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 条件
      • ブースト値式
      • ソート順
    • 設定の削除
• 関連コンテンツ
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 検索語
      • コンテンツ
      • 仮想ホスト
    • 設定の削除
• 関連クエリー
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 検索語
      • クエリー
      • 仮想ホスト
    • 設定の削除
• パスマッピング
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 正規表現
      • 置換
      • 処理の種類
      • 表示順序
    • 設定の削除
• ウェブ認証
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • ホスト名
      • ポート
      • レルム
      • スキーム
      • ユーザー名
      • パスワード
      • パラメーター
      • ウェブ設定
    • 設定の削除
• ファイル認証
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • ホスト名
      • ポート
      • スキーム
      • ユーザー名
      • パスワード
      • パラメーター
      • ファイルクロール設定
    • 設定の削除
• リクエストヘッダー
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
      • 値
      • ウェブ設定
    • 設定の削除
• 重複ホスト
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 正規名
      • 重複名
    • 設定の削除
• ユーザー
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • ユーザー名
      • ロール
      • グループ
    • 設定の削除
• ロール
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
    • 設定の削除
• グループ
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
    • 削除の方法
• サジェストワード
  • 概要
  • 管理方法
    • 表示方法
      • 単語種別
      • 単語数
• 追加ワード
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 単語
      • 読み
      • パーミッション
      • ラベル
      • ブースト値
    • 設定の削除
  • ダウンロード
    • CSVの内容
  • アップロード
    • CSVの内容
• 除外ワード
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • サジェスト候補
    • 設定の削除
  • ダウンロード
    • CSVの内容
  • アップロード
    • CSVの内容
• システム情報
  • 概要
  • 管理方法
    • 表示方法
    • 表示項目
      • 環境変数のプロパティ
      • システムのプロパティ
      • アプリのプロパティ
      • バグレポートのプロパティ
• 検索ログ
  • 概要
  • 管理方法
  • 一覧
  • 詳細
• ジョブログ
  • 概要
  • 管理方法
    • 表示方法
    • ジョブログ詳細
      • 名前
      • 状態
      • 対象
      • 開始時間
      • 終了時間
      • 実行方法
      • スクリプト
      • 結果
• クロール情報
  • 概要
  • 管理方法
  • 一覧
  • 詳細
    • 項目一覧
      • セッションID
      • クローラーの開始時間
      • クロールの開始時間 (ウェブ/ファイル)
      • クロールの開始時間 (データストア)
      • クロールの終了時間 (ウェブ/ファイル)
      • クロールの実行時間 (データストア)
      • インデクシングの実行時間 (データストア)
      • インデックスのサイズ (データストア)
      • クロールの終了時間 (データストア)
      • クローラーの状態
      • クローラーの終了時間
      • クローラーの実行時間
• ログファイル
  • 概要
  • 設定方法
    • 表示方法
    • ダウンロード
      • server_*.log
      • fess.log
      • fess-crawler.log
      • audit.log
      • fess-thumbnail.log
      • fess-suggest.log
      • fess-urls.log
      • search.log
      • gc-crawler.log
• 障害URL
  • 概要
  • 管理方法
    • 表示方法
  • 障害URLの詳細
    • 詳細の内容
      • URL
      • スレッド名
      • 種類
      • ログ
      • エラー回数
      • 最終アクセス日時
• 検索
  • 概要
  • 管理方法
    • 表示方法
    • 検索一覧
    • 一括削除
• バックアップ
  • 概要
    • ダウンロード
      • fess_config.bulk
      • fess_basic_config.bulk
      • fess_user.bulk
      • system.properties
      • fess.json
      • doc.json
      • click_log.ndjson
      • favorite_log.ndjson
      • search_log.ndjson
      • user_info.ndjson
    • アップロード
• メンテナンス
  • 概要
  • 操作方法
    • 再インデクシング
    • 設定項目
      • エイリアスの更新
      • 辞書の初期化
      • シャード数
      • 最大レプリカ数
    • ドキュメントインデックスのリロード
    • Crawlerインデックス
    • 診断
• アップグレード
  • 概要
  • 操作方法
    • バックアップ
    • データ移行
    • 設定項目
      • 対象バージョン
• クエリーリクエスト
  • 概要
  • 操作方法
    • リクエストの送信
    • 設定項目
      • リクエストファイル

Fess 設定ガイド

• はじめに
  • 対象読者
  • お読みになる前に
  • オンラインでのアクセス
  • 技術的なサポートの連絡先
    • 商用サポート
  • 関連サードパーティー Web サイトの参照
  • コメントおよび提案の送付方法
• システム関連の設定
  • 使用ポートの設定
  • 使用メモリーの設定
    • ウェブアプリのメモリー設定
    • クローラーのメモリー設定
    • OpenSearchのメモリー設定
  • ログの設定
    • ログのファイル
    • ログレベルの変更
• クローラー関連の設定
  • 単語の長さの上限の設定
  • ファイルサイズの設定
  • プロキシの設定
    • 設定方法
• 検索関連の設定
  • ファジー検索
  • 検索時のタイムアウト値
  • 検索時の最大文字数
  • 検索時のタイムアウトのログ出力
  • ヒット件数表示
  • 位置情報検索時のインデックス名
  • リクエストパラメータの言語指定
  • 前方一致検索の指定
  • ハイライトの文字列
  • ハイライトのフラグメント
  • ハイライト生成方法
  • ハイライト対象のタグ
  • OpenSearchのハイライターに渡す値
  • レスポンスに追加するフィールド名
  • フィールド名の追加
  • 検索結果をGSA互換のXML形式で取得する際の設定
• 検索フォームの配置
  • 検索フォームの配置方法
    • 検索フォーム
    • サジェスト
• 仮想ホスト
  • 仮想ホストについて
    • システム設定
    • クロール設定
• Windowsサービスへの登録
  • Windowsサービスとしての登録
    • 事前準備
    • OpenSearchをサービスとして登録
    • 設定
    • 登録方法
    • サービスの設定
• ロールベース検索の設定
  • ロールベース検索について
  • ロールベース検索の設定
    • Fess の管理画面での設定
    • ログイン
    • ログアウト
• インデックスの管理
  • インデックスのバックアップとリストア
• Analyzerの設定
  • Analyzerについて
• 位置情報検索
  • 概要
  • 設定
    • インデックス生成時
    • 検索時
• サムネイル画像の設定
  • サムネイル画像の表示
  • HTMLファイルのサムネイル画像
  • MS Officeファイルのサムネイル画像
    • パッケージのインストール
    • 生成スクリプト
  • PDFファイルのサムネイル画像
  • サムネイルジョブの無効化
• 検索結果の一括取得
  • 検索結果の一括取得について
  • 利用方法
    • スクロール検索の設定
    • スクロール検索の利用
• 検索機能
  • 検索結果件数の表示

JavaDocs

XRef

I/F Doc

14.11

JavaDocs

XRef

I/F Doc

14.10

JavaDocs

XRef

I/F Doc

14.9

JavaDocs

XRef

I/F Doc

14.8

JavaDocs

XRef

I/F Doc

14.7

JavaDocs

XRef

I/F Doc

14.6

JavaDocs

XRef

I/F Doc

14.5

JavaDocs

XRef

I/F Doc

14.4

JavaDocs

XRef

I/F Doc

14.3

JavaDocs

XRef

I/F Doc

14.2

JavaDocs

XRef

I/F Doc

14.1

JavaDocs

XRef

I/F Doc

14.0

JavaDocs

XRef

I/F Doc

13.16

Fess インストールガイド

• はじめに
  • 対象読者
  • お読みになる前に
  • オンラインでのアクセス
  • 技術的なサポートの連絡先
    • 商用サポート
  • コメントおよび提案の送付方法
• インストール
  • インストール要件
  • ダウンロード
  • インストール
    • Elasticsearchのインストール
    • ZIP パッケージを利用する場合
    • ZIP パッケージを利用する場合（Windows）
    • RPM/DEB パッケージを利用する場合
• 起動および停止方法
  • 起動方法
    • ZIP パッケージの場合
    • RPM/DEB パッケージの場合(chkconfig)
    • RPM/DEB パッケージの場合(systemd)
  • ブラウザー UI へのアクセス
  • 停止方法
    • ZIP パッケージの場合
    • RPM/DEB パッケージの場合(chkconfig)
    • RPM/DEB パッケージの場合(systemd)
• アンインストール
  • アンインストール
• アップグレード
  • Fess のアップグレード
    • データのバックアップ
    • パッケージの更新
    • 設定のリストア
    • クローラの起動

Fess ユーザーガイド

• はじめに
  • 対象読者
  • お読みになる前に
  • オンラインでのアクセス
  • 技術的なサポートの連絡先
    • 商用サポート
  • 関連サードパーティー Web サイトの参照
  • コメントおよび提案の送付方法
• AND 検索
  • AND 検索
    • 利用方法
• OR 検索
  • OR 検索
    • 利用方法
• NOT 検索
  • NOT 検索
    • 利用方法
• ラベル指定検索
  • ラベル指定検索 (カテゴリ検索)
    • 利用方法
• 検索フィールド指定検索
  • フィールド指定検索
    • 利用可能なフィールド
    • 利用方法
• ソート検索
  • ソート検索
    • ソート対象フィールド
    • 利用方法
• ワイルドカード検索
  • ワイルドカード検索
    • 利用方法
    • 利用条件
• 範囲指定検索
  • 範囲指定検索
    • 利用方法
• ブースト検索
  • ブースト検索(重み付け検索)
    • 利用方法
• 曖昧検索
  • 曖昧検索(ファジー検索)
    • 利用方法
• 位置情報検索
  • 位置情報検索
    • 利用方法
• 非表示検索条件
  • 非表示検索条件
    • 利用方法
• ロール検索
  • ロール検索
    • 検索方法
    • パスワードの変更
    • ログアウト
• 特殊文字
  • 特殊文字
    • 利用方法
• 詳細検索
  • 詳細検索
    • 利用方法
    • 項目一覧
      • すべての単語を含む
      • 語順も含めた完全一致
      • いずれかの単語を含む
      • 含めない単語
      • 表示件数
      • ソート
      • 優先する言語
      • ラベル
      • 更新日時
      • ファイル形式
      • 検索対象
      • サイトまたはドメイン

Fess APIガイド

• はじめに
  • 対象読者
  • お読みになる前に
  • オンラインでのアクセス
  • 技術的なサポートの連絡先
    • 商用サポート
  • 関連サードパーティー Web サイトの参照
  • コメントおよび提案の送付方法
• APIの概要
  • Fess の提供するAPI
  • APIの種類
• 検索API
  • 検索結果の取得
    • リクエストパラメータ
    • レスポンス
• ラベルAPI
  • ラベルの取得
    • リクエストパラメータ
    • レスポンス
• 人気ワードAPI
  • 人気ワード一覧の取得
    • リクエストパラメータ
    • レスポンス
• Ping API
  • 状態の取得
    • リクエストパラメータ
    • レスポンス
• Google Search Appliance 互換 API
  • 設定
  • リクエスト

Fess 管理者ガイド

• はじめに
  • 対象読者
  • お読みになる前に
  • オンラインでのアクセス
  • 技術的なサポートの連絡先
    • 商用サポート
• ダッシュボード
  • 概要
  • インデックスされているドキュメント数の確認
• 構成ウィザード
  • 概要
    • 簡易セットアップ
    • クロールの設定
    • 設定項目
      • 名前
      • クロールパス
      • 最大アクセス数
      • 深さ
    • クローラ
• 全般
  • 概要
  • 設定内容
    • システム
      • JSONレスポンス
      • ログインが必要
      • ログインリンク表示
      • 重複結果の折り畳み
      • サムネイル表示
      • デフォルトのラベル値
      • デフォルトのソート値
      • 仮想ホスト
      • 人気ワードのレスポンス
      • CSVファイルのエンコード
      • 検索パラメータの追加
      • 通知メール
    • クローラ
      • 最終更新日時の確認
      • 同時クローラ設定
      • 以前のドキュメントを削除
      • 除外するエラーの種類
      • 障害数のしきい値
    • ロギング
      • 検索ログ
      • ユーザログ
      • お気に入りログ
      • 以前の検索ログを削除
      • 以前のジョブログを削除
      • 以前のユーザーログを削除
      • ログを削除するボット名
      • ログレベル
    • サジェスト
      • 検索語でサジェスト
      • ドキュメントでサジェスト
      • 以前のサジェスト情報を削除
    • LDAP
      • LDAP URL
      • Base DN
      • Bind DN
      • パスワード
      • User DN
      • アカウントフィルタ
      • グループフィルタ
      • memberOf属性
    • お知らせ表示
      • ログインページ
      • 検索トップページ
  • 例
    • LDAPの設定例
• スケジューラ
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
      • 対象
      • スケジュール
      • 実行方法
      • スクリプト
      • ロギング
      • クローラージョブ
      • 状態
      • 表示順序
    • 設定の削除
  • 手動クロール方法
• ページのデザイン
  • 概要
  • 設定方法
    • 表示方法
    • ファイルマネージャー
    • ページファイルの表示
    • アップロードするファイル
      • ファイルのアップロード
      • フィイル名(オプション)
• 辞書
  • 概要
  • 一覧
  • Kuromoji
  • 同義語
  • マッピング
  • Protwords
  • ストップワード
  • Stemmer上書き
• Kuromoji辞書
  • 概要
  • 管理方法
    • 表示方法
    • 設定方法
    • 設定項目
      • トークン
      • 分割
      • 読み
      • 品詞
  • ダウンロード
  • アップロード
• 同義語辞書
  • 概要
  • 管理方法
    • 表示方法
    • 設定方法
    • 設定項目
      • 変換元
      • 変換後
  • ダウンロード
  • アップロード
• マッピング辞書
  • 概要
  • 管理方法
    • 表示方法
    • 設定方法
    • 設定項目
      • 変換元
      • 変換後
  • ダウンロード
  • アップロード
• Protwords辞書
  • 概要
  • 管理方法
    • 表示方法
    • 設定方法
    • 設定項目
      • 単語情報
  • ダウンロード
  • アップロード
• ストップワード辞書
  • 概要
  • 管理方法
    • 表示方法
    • 設定方法
    • 設定項目
      • 変換元
      • 変換後
  • ダウンロード
  • アップロード
• Stemmer上書き辞書
  • 概要
  • 管理方法
    • 表示方法
    • 設定方法
    • 設定項目
      • 変換元
      • 変換後
  • ダウンロード
  • アップロード
• アクセストークン
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
      • パーミッション
      • パラメーター名
      • 有効期限
    • 設定の削除
• プラグイン
  • 概要
  • 管理方法
    • 表示方法
    • インストール
• ストレージ
  • 概要
  • 管理方法
    • オブジェクトストレージサーバーの設定
    • 表示方法
      • 名前
      • サイズ
      • 最終更新日時
    • ダウンロード
    • 削除
    • アップロード
    • フォルダの作成
• ウェブクロール
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
      • URL
      • クロール対象とするURL
      • クロール対象から除外するURL
      • 検索対象とするURL
      • 検索対象から除外するURL
      • 設定パラメータ
      • 深さ
      • 最大アクセス数
      • ユーザーエージェント
      • スレッド数
      • 間隔
      • ブースト値
      • パーミッション
      • 仮想ホスト
      • 状態
      • 説明
    • 設定の削除
  • 例
    • fess.codelibs.org をクロールする
    • ウェブ認証サイトのウェブクロール
      • Redmine
      • XWiki
• ファイルクロール
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
      • パス
      • クロール対象とするパス
      • クロール対象から除外するパス
      • 検索対象とするパス
      • 検索対象から除外するパス
      • 設定パラメータ
      • 深さ
      • 最大アクセス数
      • スレッド数
      • 間隔
      • ブースト値
      • パーミッション
      • 仮想ホスト
      • 状態
      • 説明
    • 設定の削除
  • 例
    • ローカルファイルをクロール
    • Windowsの共有フォルダをクロール
• データストアクロール
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
      • ハンドラ名
      • パラメータ
      • スクリプト
      • ブースト値
      • パーミッション
      • 仮想ホスト
      • 状態
      • 説明
    • 設定の削除
  • 例
    • DatabaseDataStore
      • パラメータ
      • スクリプト
      • ドライバ
    • CsvDataStore
      • パラメータ
      • スクリプト
    • EsDataStore
      • パラメータ
      • スクリプト
    • CsvListDataStore
      • パラメータ
      • スクリプト
• ラベル
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
      • 値
      • 対象とするパス
      • 除外するパス
      • パーミッション
      • 仮想ホスト
      • 表示順序
    • 設定の削除
• キーマッチ
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 検索語
      • クエリー
      • サイズ
      • ブースト値
      • 仮想ホスト
    • 設定の削除
• ドキュメントブースト
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 条件
      • ブースト値式
      • ソート順
    • 設定の削除
• 関連コンテンツ
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 検索語
      • コンテンツ
      • 仮想ホスト
    • 設定の削除
• 関連クエリー
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 検索語
      • クエリー
      • 仮想ホスト
    • 設定の削除
• パスマッピング
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 正規表現
      • 置換
      • 処理の種類
      • 表示順序
    • 設定の削除
• ウェブ認証
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • ホスト名
      • ポート
      • レルム
      • スキーム
      • ユーザー名
      • パスワード
      • パラメーター
      • ウェブ設定
    • 設定の削除
• ファイル認証
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • ホスト名
      • ポート
      • スキーム
      • ユーザー名
      • パスワード
      • パラメータ
      • ファイルクロール設定
    • 設定の削除
• リクエストヘッダー
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
      • 値
      • ウェブ設定
    • 設定の削除
• 重複ホスト
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 正規名
      • 重複名
    • 設定の削除
• ユーザー
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • ユーザー名
      • ロール
      • グループ
    • 設定の削除
• ロール
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
    • 設定の削除
• グループ
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 名前
    • 削除の方法
• サジェストワード
  • 概要
  • 管理方法
    • 表示方法
      • 単語種別
      • 単語数
• 追加ワード
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • 単語
      • 読み
      • パーミッション
      • ラベル
      • ブースト値
    • 設定の削除
  • ダウンロード
    • CSVの内容
  • アップロード
    • CSVの内容
• 除外ワード
  • 概要
  • 管理方法
    • 表示方法
    • 設定の作成
    • 設定項目
      • サジェスト候補
    • 設定の削除
  • ダウンロード
    • CSVの内容
  • アップロード
    • CSVの内容
• システム情報
  • 概要
  • 管理方法
    • 表示方法
    • 表示項目
      • 環境変数のプロパティ
      • システムのプロパティ
      • アプリのプロパティ
      • バグレポートのプロパティ
• 検索ログ
  • 概要
  • 管理方法
  • 一覧
  • 詳細
• ジョブログ
  • 概要
  • 管理方法
    • 表示方法
    • ジョブログ詳細
      • 名前
      • 状態
      • 対象
      • 開始時間
      • 終了時間
      • 実行方法
      • スクリプト
      • 結果
• クロール情報
  • 概要
  • 管理方法
  • 一覧
  • 詳細
    • 項目一覧
      • セッションID
      • クロールの開始時間 (ウェブ/ファイル)
      • クロールの終了時間 (ウェブ/ファイル)
      • クロールの実行時間 (ウェブ/ファイル)
      • クロールの開始時間 (データストア)
      • クロールの終了時間 (データストア)
      • クロールの実行時間 (データストア)
      • クローラーの開始時間
      • クローラーの終了時間
      • インデクシングの実行時間 (ウェブ/ファイル)
      • インデックスのサイズ (ウェブ/ファイル)
      • クローラーの状態
• ログファイル
  • 概要
  • 設定方法
    • 表示方法
    • ダウンロード
      • server_*.log
      • fess.log
      • fess-crawler.log
      • audit.log
      • fess-thumbnail.log
      • fess-suggest.log
• 障害URL
  • 概要
  • 管理方法
    • 表示方法
  • 障害URLの詳細
    • 詳細の内容
      • URL
      • スレッド名
      • 種類
      • ログ
      • エラー回数
      • 最終アクセス日時
• 検索
  • 概要
  • 管理方法
    • 表示方法
    • 検索一覧
    • 一括削除
• バックアップ
  • 概要
    • ダウンロード
      • .fess_config
      • .fess_basic_config
      • .fess_user
      • system.properties
      • click_log.ndjson
      • favorite_log.ndjson
      • search_log.ndjson
      • user_info.ndjson
    • アップロード
• メンテナンス
  • 概要
  • 操作方法
    • 再インデクシング
    • 設定項目
      • エイリアスの更新
      • 辞書の初期化
      • シャード数
      • 最大レプリカ数
    • ドキュメントインデックスのリロード
    • Crawlerインデックス
    • 診断
• アップグレード
  • 概要
  • 操作方法
    • バックアップ
    • データ移行
    • 設定項目
      • 対象バージョン
• クエリーリクエスト
  • 概要
  • 操作方法
    • リクエストの送信
    • 設定項目
      • リクエストファイル

Fess 設定ガイド

• はじめに
  • 対象読者
  • お読みになる前に
  • オンラインでのアクセス
  • 技術的なサポートの連絡先
    • 商用サポート
  • 関連サードパーティー Web サイトの参照
  • コメントおよび提案の送付方法
• システム関連の設定
  • 使用ポートの設定
  • 使用メモリーの設定
    • ヒープメモリーの最大値変更
    • クローラ側のヒープメモリー最大値変更
  • ログの設定
    • ログのファイル
    • ログレベルの変更
• クローラ関連の設定
  • 単語の長さの上限の設定
  • ファイルサイズの設定
  • プロキシの設定
    • 設定方法
• 検索フォームの配置
  • 検索フォームの配置方法
    • 検索フォーム
    • サジェスト
• 仮想ホスト
  • 仮想ホストについて
    • システム設定
    • クロール設定
• Windowsサービスへの登録
  • Windowsサービスとしての登録
    • 事前準備
    • Elasticsearchをサービスとして登録
    • 設定
    • 登録方法
    • サービスの設定
• ロールベース検索の設定
  • ロールベース検索について
  • ロールベース検索の設定
    • Fess の管理画面での設定
    • ログイン
    • ログアウト
• インデックスの管理
  • インデックスのバックアップとリストア
• Analyzerの設定
  • Analyzerについて
• 位置情報検索
  • 概要
  • 設定
    • インデックス生成時
    • 検索時
• サムネイル画像の設定
  • サムネイル画像の表示
  • HTMLファイルのサムネイル画像
  • MS Officeファイルのサムネイル画像
    • パッケージのインストール
    • 生成スクリプト
  • PDFファイルのサムネイル画像
  • サムネイルジョブの無効化
• 検索結果の一括取得
  • 検索結果の一括取得について
  • 利用方法
    • スクロール検索の設定
    • スクロール検索の利用
• 検索機能
  • 検索結果件数の表示

JavaDocs

XRef

I/F Doc

13.15

JavaDocs

XRef

I/F Doc

13.14

JavaDocs

XRef

I/F Doc

13.13

JavaDocs

XRef

I/F Doc

13.12

JavaDocs

XRef

I/F Doc

13.11

JavaDocs

XRef

I/F Doc

13.10

JavaDocs

XRef

I/F Doc

13.9

JavaDocs

XRef

I/F Doc

13.8

JavaDocs

XRef

I/F Doc

13.7

JavaDocs

XRef

I/F Doc

13.6

JavaDocs

XRef

I/F Doc

13.5

JavaDocs

XRef

I/F Doc

13.4

JavaDocs

XRef

I/F Doc

13.3

JavaDocs

XRef

I/F Doc

13.2

JavaDocs

XRef

I/F Doc

13.1

JavaDocs

XRef

I/F Doc

13.0

JavaDocs

XRef

I/F Doc

12.7

JavaDocs

XRef

I/F Doc

12.6

JavaDocs

XRef

I/F Doc

12.5

JavaDocs

XRef

I/F Doc

12.4

JavaDocs

XRef

I/F Doc

12.3

JavaDocs

XRef

I/F Doc

12.2

JavaDocs

XRef

I/F Doc

12.1

JavaDocs

XRef

I/F Doc

12.0

JavaDocs

XRef

I/F Doc

11.4

JavaDocs

XRef

I/F Doc

11.3

JavaDocs

XRef

I/F Doc

11.2

11.1

11.0

10.3

10.2

10.1

10.0

9.4

9.3

9.2

9.1

9.0

8.0

7.0

6.0

5.0

4.0

3.0

2.0

チュートリアル