Fess Installation Guide

How to install and run Fess on Linux, Windows, or Docker, with the prerequisites, security settings, upgrading, and troubleshooting.

Table of Contents

Introduction to Installation

• About This Document
• Target Audience
• Before You Begin
• Document Structure
• Online Access
• Technical Support Contact
• How to Submit Comments and Suggestions

System Requirements

• Hardware Requirements
• Software Requirements
• Network Requirements
• Browser Requirements
• Prerequisites Checklist
• Next Steps

Choosing an Installation Method

• Verify Prerequisites
• Installation Method Comparison
• Features of Each Installation Method
• Basic Installation Flow
• Required Components
• Next Steps
• Frequently Asked Questions
• Download
• Version Information

Linux Installation (Detailed Procedure)

• Prerequisites
• Choosing an Installation Method
• System Configuration for Running OpenSearch
• Installation with TAR.GZ Version
• Installation with RPM Version
• Installation with DEB Version
• Post-Installation Verification
• Next Steps
• Frequently Asked Questions

Windows Installation (Detailed Procedure)

• Prerequisites
• Verify Java Installation
• Environment Variable Configuration
• Step 1: Install OpenSearch
• Step 2: Install Fess
• Step 3: Startup
• Register as Windows Service (Optional)
• Firewall Configuration
• Troubleshooting
• Next Steps
• Frequently Asked Questions

Docker Installation (Detailed Guide)

• Prerequisites
• Verify Docker Installation
• About Docker Images
• Step 1: Obtain Docker Compose Files
• Step 2: Review Docker Compose Files
• Step 3: Start Docker Containers
• Step 4: Access via Browser
• Enabling AI Search Mode (LLM Plugin)
• Data Persistence
• Stop Docker Containers
• Advanced Configuration
• Production Operation with Docker Compose
• Troubleshooting
• Next Steps
• Frequently Asked Questions

Startup, Shutdown, and Initial Setup

• Startup Methods
• Verify Startup
• Access via Browser
• Initial Setup
• Other Recommended Settings
• Shutdown Methods
• Restart Methods
• Troubleshooting
• Next Steps

Security Configuration

• Essential Security Configurations
• Recommended Security Configurations
• Data Protection
• Security Best Practices
• Security Checklist
• Security Incident Response
• Reference Information

Upgrade Procedure

• Supported Versions
• Pre-Upgrade Preparation
• Step 1: Data Backup
• Step 2: Stop Current Version
• Step 3: Install New Version
• Step 4: Upgrade OpenSearch (If Necessary)
• Step 5: Start New Version
• Step 6: Verify Operation
• Step 7: Recreate Index (Recommended)
• Rollback Procedure
• Frequently Asked Questions
• Next Steps

Uninstallation Procedure

• Preparation Before Uninstallation
• Uninstalling the TAR.GZ/ZIP Version
• Uninstalling the RPM Version
• Uninstalling the DEB Version
• Uninstalling the Docker Version
• Verifying the Uninstallation
• Partial Uninstallation
• Troubleshooting
• Preparing for Reinstallation
• Next Steps

Troubleshooting

• Installation Issues
• Startup Issues
• Connection Issues
• Performance Issues
• Data Issues
• Docker-Specific Issues
• Windows-Specific Issues
• Other Issues
• Support Information
• Collecting Debug Information