Installation
Requirements
fess can be used in the following environments:
OS: Operating system that can run Java or Docker (such as Windows or Linux)
Java 17 (for installing the TAR.GZ/ZIP/RPM/DEB version)
Docker (for installing the Docker version)
Using fess in a production environment or for load testing is not recommended with the embedded OpenSearch.
For the TAR.GZ/ZIP/RPM/DEB version, you must install the correct version of OpenSearch.
Download
Download fess from the Download Site.
Using TAR.GZ Package
Install OpenSearch
Refer to Download & Get Started and download the TAR.GZ version of OpenSearch.
The OpenSearch plugins need to match the version of OpenSearch. The following explains the installation for OpenSearch 2.17.0.
Install the OpenSearch plugins in the plugins directory. Assume that OpenSearch is installed in $OPENSEARCH_HOME.
$ $OPENSEARCH_HOME/bin/opensearch-plugin install org.codelibs.opensearch:opensearch-analysis-fess:2.17.0
$ $OPENSEARCH_HOME/bin/opensearch-plugin install org.codelibs.opensearch:opensearch-analysis-extension:2.17.0
$ $OPENSEARCH_HOME/bin/opensearch-plugin install org.codelibs.opensearch:opensearch-minhash:2.17.0
$ $OPENSEARCH_HOME/bin/opensearch-plugin install org.codelibs.opensearch:opensearch-configsync:2.17.0
Note that these plugins depend on the version of OpenSearch.
Add the following settings to $OPENSEARCH_HOME/config/opensearch.yml. If there are existing settings, overwrite them.
Specify the absolute path of $OPENSEARCH_HOME/data/config in configsync.config_path.
configsync.config_path: [absolute path of $OPENSEARCH_HOME]/data/config/
plugins.security.disabled: true
Install fess
Extract the fess zip file to $fess_HOME. To connect fess to the OpenSearch cluster, specify the following startup options. Modify $fess_HOME/bin/fess.in.sh.
SEARCH_ENGINE_HTTP_URL=http://localhost:9200
fess_DICTIONARY_PATH=[absolute path of $SEARCH_ENGINE_HOME]/data/config/
Using ZIP Package
Install OpenSearch
For Windows environments, use the ZIP version for installation.
Refer to Download & Get Started and download the ZIP version of OpenSearch.
OpenSearch plugins must be compatible with the version of OpenSearch being installed. Here’s an explanation for installing OpenSearch version 2.17.0.
Install the OpenSearch plugins in the plugins directory. Let’s assume OpenSearch is installed at $OPENSEARCH_HOME.
$ $OPENSEARCH_HOME\bin\opensearch-plugin install org.codelibs.opensearch:opensearch-analysis-fess:2.17.0
$ $OPENSEARCH_HOME\bin\opensearch-plugin install org.codelibs.opensearch:opensearch-analysis-extension:2.17.0
$ $OPENSEARCH_HOME\bin\opensearch-plugin install org.codelibs.opensearch:opensearch-minhash:2.17.0
$ $OPENSEARCH_HOME\bin\opensearch-plugin install org.codelibs.opensearch:opensearch-configsync:2.17.0
Please note that these plugins are version-dependent, so ensure compatibility with your OpenSearch version.
Add the following settings to $OPENSEARCH_HOME\config\opensearch.yml. If there are existing settings, modify them accordingly.
Specify the absolute path of $OPENSEARCH_HOME\data\config for configsync.config_path.
configsync.config_path: [$absolute path of $OPENSEARCH_HOME]/data/config/
plugins.security.disabled: true
Install fess
Extract the ZIP file of fess to $fess_HOME. To connect fess to the OpenSearch cluster, specify the following startup options in $fess_HOME\bin\fess.in.bat.
SEARCH_ENGINE_HTTP_URL=http://localhost:9200
fess_DICTIONARY_PATH=[$absolute path of $SEARCH_ENGINE_HOME]/data/config/
Using with RPM/DEB Package
Install OpenSearch
Please download the RPM/DEB version of OpenSearch from Download & Get Started and install it by following the instructions on Installing OpenSearch.
Do not perform any OpenSearch configuration or startup as we will perform the OpenSearch configuration in the following steps.
Please note that the OpenSearch plugins should match the version of OpenSearch that you installed. The following describes the installation process for OpenSearch 2.17.0.
Install the OpenSearch plugins in the plugins directory:
$ sudo /usr/share/opensearch/bin/opensearch-plugin install org.codelibs.opensearch:opensearch-analysis-fess:2.17.0
$ sudo /usr/share/opensearch/bin/opensearch-plugin install org.codelibs.opensearch:opensearch-analysis-extension:2.17.0
$ sudo /usr/share/opensearch/bin/opensearch-plugin install org.codelibs.opensearch:opensearch-minhash:2.17.0
$ sudo /usr/share/opensearch/bin/opensearch-plugin install org.codelibs.opensearch:opensearch-configsync:2.17.0
Please note that these plugins depend on the version of OpenSearch.
Add the following settings to /etc/opensearch/opensearch.yml (common for RPM/DEB). If there are existing settings, please overwrite them:
configsync.config_path: /var/lib/opensearch/data/config/
plugins.security.disabled: true
Install fess
Next, install the RPM/DEB package of fess.
For RPM package:
$ sudo rpm -ivh fess-<version>.rpm
For DEB package:
$ sudo dpkg -i fess-<version>.deb
To register as a service, enter the following commands. For RPM with chkconfig:
$ sudo /sbin/chkconfig --add OpenSearch
$ sudo /sbin/chkconfig --add fess
For RPM/DEB with systemd:
$ sudo /bin/systemctl daemon-reload
$ sudo /bin/systemctl enable opensearch.service
$ sudo /bin/systemctl enable fess.service
To connect fess to the OpenSearch cluster, specify the following startup options in /usr/share/fess/bin/fess.in.sh:
SEARCH_ENGINE_HTTP_URL=http://localhost:9200
fess_DICTIONARY_PATH=/var/lib/opensearch/data/config/
Using Docker images
For the installation, refer the following files from https://github.com/codelibs/docker-fess/compose: