Installation Methods
Fess provides distributions in ZIP archives, RPM/DEB packages, and Docker images. Using Docker allows you to easily set up Fess on windows, Mac, and other platforms.
For production environments, be sure to refer to Fess Installation Guide.
Warning
Important Notes for Production Environments
Running with the embedded OpenSearch is not recommended for production environments or load testing. Always set up an external OpenSearch server.
Installing Docker Desktop
This guide explains the installation procedure for windows. If Docker Desktop is not already installed, please follow these steps.
The files to download and installation procedures differ by OS, so you need to follow the steps appropriate for your environment. For details, refer to the Docker documentation.
Download
Download the installer for your OS from Docker Desktop.
Running the Installer
Double-click the downloaded installer to start installation.
Confirm that “Install required windows components for WSL 2” or “Install required Enable Hyper-V windows Features” is selected, and click the OK button.
When installation is complete, click the “close” button to close the screen.
Starting Docker Desktop
Click “Docker Desktop” in the windows menu to start it.
After Docker Desktop starts, the terms of service will be displayed. Check “I accept the terms” and click the “Accept” button.
A tutorial start prompt will appear, but here we’ll click “Skip tutorial” to skip it. After clicking “Skip tutorial”, the Dashboard will be displayed.
Configuration
To allow OpenSearch to run as a Docker container, adjust the “vm.max_map_count” value on the OS side. The configuration method differs depending on your environment, so refer to “Set vm.max_map_count to at least 262144” for configuration methods for each environment.
Setting Up Fess
Creating Startup Files
Create a directory and download compose.yaml and compose-opensearch3.yaml.
You can also download them using the curl command as follows:
curl -o compose.yaml https://raw.githubusercontent.com/codelibs/docker-fess/master/compose/compose.yaml
curl -o compose-opensearch3.yaml https://raw.githubusercontent.com/codelibs/docker-fess/master/compose/compose-opensearch3.yaml
Starting Fess
Start Fess with the docker compose command.
Open a command prompt, navigate to the folder containing the compose.yaml file, and execute the following command:
docker compose -f compose.yaml -f compose-opensearch3.yaml up -d
Note
Startup may take several minutes. You can check the logs with the following command:
docker compose -f compose.yaml -f compose-opensearch3.yaml logs -f
You can exit the log display with Ctrl+C.
Verification
Access http://localhost:8080/ to verify that it has started.
The admin UI is at http://localhost:8080/admin/. The default administrator account username/password is admin/admin.
Warning
Important Security Notice
Be sure to change the default password. Especially in production environments, it is strongly recommended to change the password immediately after the first login.
The administrator account is managed by the application server. In Fess’s admin UI, users authenticated with the fess role by the application server are treated as administrators.
Other
Stopping Fess
To stop Fess, execute the following command in the folder where you started Fess:
docker compose -f compose.yaml -f compose-opensearch3.yaml stop
To stop and remove containers:
docker compose -f compose.yaml -f compose-opensearch3.yaml down
Warning
To also remove volumes with the down command, add the -v option. Note that this will delete all data:
docker compose -f compose.yaml -f compose-opensearch3.yaml down -v
Changing Administrator Password
You can change the password on the User edit page in the admin UI.