README.md

Enterprise Search Server: Fess

Overview

Fess is very powerful and easily deployable Enterprise Search Server. You can install and run Fess quickly on any platforms, which have Java runtime environment. Fess is provided under Apache license.

Fess is Elasticsearch based search server, but knowledge/experience about Elasticsearch is NOT needed because of All-in-One Enterprise Search Server. Fess provides Administration GUI to configure the system on your browser. Fess also contains a crawler, which can crawl documents on Web/FileSystem/DB and supports many file formats, such as MS Office, pdf and zip.

For Site Search feature, see FSS JS Genertor. Fess Site Search is Google Site Search alternative.

Web Sites

fess.codelibs.org

Issues/Questions

Please check filed questions, and then file an issue if not filed.

Getting Started

Download

Fess 12.0 is available. The release page is HERE.

Install/Run Fess

$ unzip fess-12.0.x.zip
$ cd fess-12.0.x
$ ./bin/fess

For the details, see Installation Guide.

Access Fess

• Search UI: http://localhost:8080/

• Admin UI: http://localhost:8080/admin/ (username/password is admin/admin)

You can register crawling targets on Web/File System/Data Store of admin pages, and then start Crawler on Scheduler page manually.

Fess on Docker Hub

We provide Docker image on Docker Hub. For more details, see Public Repository.

Migration from Other Systems

Please see MIGRATION.md.

Localization

Japanese

• Web Site

Korean

• PDF Document
• Forum

Development Information

Get Source Code

First of all, clone Fess's repository:

$ cd ~/workspace
$ git clone https://github.com/codelibs/fess.git

and then import it as Maven project on Eclipse or other IDE.

Setup for Elasticsearch Plugins

Run antrun:run to download plugins into plugins directory:

$ mvn antrun:run

Run Fess

Run or debug org.codelibs.fess.FessBoot on IDE, and then access http://localhost:8080/

Build Package

Run package goal and then the release file is created in target/releases.

$ mvn package
$ mvn rpm:rpm   # .rpm package
$ mvn jdeb:jdeb # .deb package

Generate Source Code

$ mvn dbflute:download # (one time command)
$ mvn dbflute:freegen
$ mvn license:format

Integration Tests

Launch Fess Server and run the following command:

$ mvn test -P integrationTests -Dtest.fess.url="http://localhost:8080" -Dtest.es.url="http://localhost:9201"

Translate In Your Language

Fess is internationalized software.

If you want to add labels/messages for your language, please translate properties file and then rename to fess_*_[lang].properties.

• fess_label_en.properties
• fess_message_en.properties

For search/index analyzer, if doc.json contains lang_[lang] for your language, please modify analyzer for your language. For more details about elasticsearch's analyzer, see Analyzers.

We are waiting for pull requests of your language.

Powered By

• Lasta Di: DI Container
• LastaFlute: Web Framework
• Lasta Job: Job Scheduler
• Fess Crawler: Web Crawler
• Elasticsearch: Search Engine