Choosing an Installation Method
This page provides an overview of Fess installation methods. Select the appropriate installation method based on your environment.
Warning
Important Notice for Production Environments
Running with the embedded OpenSearch is not recommended for production environments or load testing. Always set up an external OpenSearch server.
Verify Prerequisites
Before starting the installation, verify the system requirements.
For details, refer to System Requirements.
Installation Method Comparison
Fess can be installed using the following methods. Choose according to your environment and use case.
| Method | Target OS | Recommended Use | Detailed Documentation |
|---|---|---|---|
| Docker | Linux, Windows, macOS | Development/evaluation environments, rapid setup | Docker Installation (Detailed Guide) |
| TAR.GZ | Linux, macOS | Environments requiring customization | Linux Installation (Detailed Procedure) |
| RPM | RHEL, CentOS, Fedora | Production environments (RPM-based) | Linux Installation (Detailed Procedure) |
| DEB | Debian, Ubuntu | Production environments (DEB-based) | Linux Installation (Detailed Procedure) |
| ZIP | Windows | Development/production on Windows | Windows Installation (Detailed Procedure) |
Features of Each Installation Method
Docker Version
Advantages:
Fastest setup possible
No need to manage dependencies
Ideal for development environments
Easy to start and stop containers
Disadvantages:
Requires Docker knowledge
Recommended Environments: Development environments, evaluation environments, POC, production environments
Details: Docker Installation (Detailed Guide)
Linux Package Versions (TAR.GZ/RPM/DEB)
Advantages:
High performance in native environments
Can be managed as system services (RPM/DEB)
Allows detailed customization
Disadvantages:
Requires manual installation of Java and OpenSearch
Configuration requires more effort
Recommended Environments: Production environments, environments requiring customization
Windows Version (ZIP)
Advantages:
Runs in Windows native environments
No installer required
Disadvantages:
Requires manual installation of Java and OpenSearch
Configuration requires more effort
Recommended Environments: Development/evaluation on Windows, production operation on Windows Server
Basic Installation Flow
The basic flow is the same for all installation methods.
Verify System Requirements
Refer to System Requirements to ensure system requirements are met.
Download Software
Download Fess from the download site.
For the Docker version, obtain the Docker Compose file.
Set Up OpenSearch
For non-Docker versions, OpenSearch must be set up separately.
Install OpenSearch 3.3.0
Install required plugins
Edit configuration files
Set Up Fess
Install Fess
Edit configuration files (connection information to OpenSearch, etc.)
Start and Verify
Start services
Verify operation by accessing through a browser
For details, refer to Startup, Shutdown, and Initial Setup.
Required Components
The following components are required to run Fess.
Fess Main System
The main full-text search system. Provides functionality such as web interface, crawler, and indexer.
OpenSearch
OpenSearch is used as the search engine.
Supported Version: OpenSearch 3.3.0
Required Plugins:
opensearch-analysis-fess
opensearch-analysis-extension
opensearch-minhash
opensearch-configsync
Important
The OpenSearch version and plugin versions must match. Version mismatches can cause startup errors or unexpected behavior.
Java (Non-Docker Versions)
For TAR.GZ/ZIP/RPM/DEB versions, Java 21 or later is required.
Recommended: Eclipse Temurin
OpenJDK 21 or later can also be used
Note
For the Docker version, Java is included in the Docker image and does not need to be installed separately.
Next Steps
Verify the system requirements and select the appropriate installation method.
System Requirements - Verify system requirements
Choose an installation method:
Docker Installation (Detailed Guide) - Docker installation
Linux Installation (Detailed Procedure) - Linux installation
Windows Installation (Detailed Procedure) - Windows installation
Startup, Shutdown, and Initial Setup - Starting Fess and initial setup
Security Configuration - Security configuration (for production environments)
Frequently Asked Questions
Q: Is OpenSearch required?
A: Yes, it is required. Fess uses OpenSearch as its search engine. For the Docker version, it is automatically set up, but for other methods, manual installation is necessary.
Q: Can I upgrade from a previous version?
A: Yes, you can. For details, refer to Upgrade Procedure.
Q: Can I configure with multiple servers?
A: Yes, you can. Fess and OpenSearch can run on separate servers. Additionally, by configuring OpenSearch as a cluster, high availability and improved performance can be achieved.
Download
Fess and related components can be downloaded from:
Fess: Download Site
OpenSearch: Download OpenSearch
Java (Adoptium): Adoptium
Docker: Get Docker
Version Information
This document covers the following versions:
Fess: 15.3.0
OpenSearch: 3.3.0
Java: 21 or later
Docker: 20.10 or later
Docker Compose: 2.0 or later
For documentation on previous versions, please refer to the documentation for each version.