Fess Configuration Guide

This is a comprehensive guide for configuring Fess. Each section is organized by purpose.

Introduction

Introduction

• Target Audience
• Before You Read
• Online Access
• Technical Support Contact
• Third-Party Website References
• How to Submit Comments and Suggestions

Basic Setup

Port and Network Settings

• Overview
• Port Configuration
• Proxy Configuration
• HTTP Communication Settings
• Virtual Host Configuration
• Reverse Proxy Integration
• Firewall Configuration
• Troubleshooting
• References

Memory Configuration

• Overview
• Fess Web Application Memory Configuration
• Crawler Memory Configuration
• OpenSearch Memory Configuration
• Suggest and Thumbnail Processing Memory Configuration
• Memory Monitoring and Tuning
• Troubleshooting
• References

Windows Service Registration

• Registering as a Windows Service

Crawler Configuration

Basic Crawler Configuration

• Overview
• Basic Crawler Concepts
• Creating Crawl Configurations
• Running Crawls
• Basic Configuration Items
• File Size Configuration
• Word Length Restrictions
• Proxy Configuration
• robots.txt Configuration
• User-Agent Configuration
• Encoding Configuration
• Crawl Troubleshooting
• Best Practices
• References

Advanced Crawler Configuration

• Overview
• General Settings
• Document Processing Settings
• Protocol Settings
• robots.txt Settings
• Error Handling Settings
• System Monitoring Settings
• Metadata Settings
• HTML Crawler Settings
• File Crawler Settings
• Cache Settings
• JVM Options
• Performance Tuning
• Troubleshooting
• Best Practices
• S3/GCS Crawler Configuration
• References

Thumbnail Configuration

• Overview
• Supported File Formats
• Required External Tools
• HTML File Thumbnail Images
• Configuration
• generate-thumbnail Script
• Thumbnail Storage Location
• Disabling Thumbnail Job
• Troubleshooting
• Platform Support

Search Features

Search Features

• Overview
• Search Result Count Display
• Search Options
• Search Result Sorting
• Faceted Search
• Search Result Highlighting
• Suggest Feature
• Search Logs
• Performance Tuning
• Troubleshooting

Search-Related Settings

• Fuzzy Search
• Search Timeout Value
• Maximum Query Length
• Search Timeout Logging
• Hit Count Display
• Index Name for Geolocation Search
• Request Parameter Language Specification
• Prefix Query Specification
• Highlight String
• Highlight Fragment
• Highlight Generation Method
• Highlight Tags
• Values Passed to OpenSearch Highlighter
• Field Names to Add to Response
• Adding Field Names
• Settings for Retrieving Search Results in GSA-Compatible XML Format

Geolocation Search

• Overview
• Use Cases
• Configuration
• Search Examples
• Field Name Customization
• Implementation Examples
• Performance Optimization
• Troubleshooting
• References

Bulk Retrieval of Search Results

• Overview
• Use Cases
• Configuration
• Usage
• Response Format
• Data Processing Examples
• Performance and Best Practices
• Security Considerations
• Troubleshooting
• References

Search Form Integration

• Search Form Integration Method

Security Settings

Role-Based Search Configuration

• About Role-Based Search
• Role-Based Search Configuration

Virtual Host

• About Virtual Host

SSO Settings

SAML Authentication SSO Setup

• Overview
• Prerequisites
• Basic Configuration
• IdP Side Configuration
• User Attribute Mapping
• Security Configuration
• Configuration Examples
• Troubleshooting
• Reference

SSO Configuration with OpenID Connect

• Overview
• Prerequisites
• Basic Configuration
• OP-Side Configuration
• Configuration Examples
• Troubleshooting
• Reference

SSO Configuration with Entra ID

• Overview
• Prerequisites
• Basic Configuration
• Entra ID Side Configuration
• Group and Role Mapping
• Configuration Examples
• Troubleshooting
• Reference

SSO Configuration with Windows Integrated Auth

• Overview
• Prerequisites
• Active Directory Side Configuration
• Basic Configuration
• LDAP Configuration
• Browser Settings
• Configuration Examples
• Troubleshooting
• Reference

System Administration

Log Configuration

• Overview
• Log File Types
• Log Level Configuration
• Crawler Log Configuration
• Log Rotation
• Log Monitoring
• Log Format
• Performance Impact
• Troubleshooting
• References

Index Management

• Overview
• Index Structure
• Index Backup and Restore
• Configuration File Backup
• Data Migration
• Troubleshooting
• References

Analyzer Configuration

• About Analyzer

Search Log Visualization Configuration

• About Search Log Visualization
• Data Visualization Configuration with OpenSearch Dashboards