fess
starsforks
How to install fess?
codelibs/fess
$git clone https://github.com/codelibs/fessFess is an enterprise search server that you can install and run on any platform with a Java runtime. It is built on OpenSearch, but prior OpenSearch knowledge is not required: Fess is configured through a browser-based administ
README.md
| 1 | # Fess: Enterprise Search Server |
| 2 | [](https://github.com/codelibs/fess/actions/workflows/maven.yml) |
| 3 | [](https://github.com/codelibs/fess/blob/master/LICENSE) |
| 4 |  |
| 5 | |
| 6 | ## Overview |
| 7 | |
| 8 | Fess is an enterprise search server that you can install and run on any platform with a Java runtime. It is built on [OpenSearch](https://github.com/opensearch-project/OpenSearch), but prior OpenSearch knowledge is not required: Fess is configured through a browser-based administration UI. |
| 9 | |
| 10 | A built-in crawler collects documents from [web sites](https://fess.codelibs.org/15.7/admin/webconfig-guide.html), [file systems](https://fess.codelibs.org/15.7/admin/fileconfig-guide.html), and [data stores](https://fess.codelibs.org/15.7/admin/dataconfig-guide.html) such as databases and CSV files. Many file formats are supported, including Microsoft Office, PDF, and ZIP archives. |
| 11 | |
| 12 | [Fess Site Search](https://github.com/codelibs/fess-site-search) is a free alternative to Google Site Search that you can embed in your own website. For details, see the [FSS JS Generator documentation](https://fss-generator.codelibs.org/docs/manual). |
| 13 | |
| 14 | ## Features |
| 15 | |
| 16 | - Full-text search with faceting, sorting, and search suggestions |
| 17 | - Crawlers for web sites, file systems, and data stores (databases, cloud storage, and SaaS) |
| 18 | - Support for many document formats, including Microsoft Office, PDF, and archives |
| 19 | - Browser-based administration UI and a REST API |
| 20 | - Role- and permission-based filtering of search results |
| 21 | - Single sign-on with LDAP, OpenID Connect, SAML, SPNEGO, and Microsoft Entra ID |
| 22 | - Multilingual user interface and text analysis (20+ languages) |
| 23 | - Extensible through data store, ingest, script, and theme plugins |
| 24 | |
| 25 | ## Requirements |
| 26 | |
| 27 | - Java 21 or later, for the TAR.GZ, ZIP, RPM, and DEB packages |
| 28 | - OpenSearch as the search engine backend. The Docker images bundle it; for other installations you set it up separately. |
| 29 | |
| 30 | See the [Installation Guide](https://fess.codelibs.org/15.7/install/index.html) for supported versions and setup details. |
| 31 | |
| 32 | ## Getting Started |
| 33 | |
| 34 | There are two ways to try Fess: download and install it yourself, or run it with [Docker](https://www.docker.com/products/docker-engine). |
| 35 | |
| 36 | ### Download and Install/Run |
| 37 | |
| 38 | Fess 15.7 can be downloaded from the [Releases page](https://github.com/codelibs/fess/releases). Downloads are available in three formats: DEB, RPM, and ZIP. |
| 39 | |
| 40 | The following commands show how to use the ZIP download: |
| 41 | |
| 42 | $ unzip fess-15.7.x.zip |
| 43 | $ cd fess-15.7.x |
| 44 | $ ./bin/fess |
| 45 | |
| 46 | For more details, see the [Installation Guide](https://fess.codelibs.org/15.7/install/index.html). |
| 47 | |
| 48 | ### Docker |
| 49 | |
| 50 | Docker images are published on [ghcr.io](https://github.com/orgs/codelibs/packages). A Docker Compose file is available in the [docker-fess repository](https://github.com/codelibs/docker-fess/tree/master/compose). |
| 51 | |
| 52 | ### Browser UI |
| 53 | |
| 54 | - Search UI: http://localhost:8080/ |
| 55 | |
| 56 |  |
| 57 | |
| 58 | - Admin UI: http://localhost:8080/admin/ (default username/password is admin/admin) |
| 59 | |
| 60 |  |
| 61 | |
| 62 | Register crawling targets on the Web, File, or Data Store configuration pages in the Admin UI, then start the crawler from the [Scheduler page](https://fess.codelibs.org/15.7/admin/scheduler-guide.html). |
| 63 | |
| 64 | ## Migration from Another Search Provider |
| 65 | |
| 66 | See [MIGRATION.md](MIGRATION.md). |
| 67 | |
| 68 | ## Data Store |
| 69 | |
| 70 | Fess can crawl the following [storage locations and APIs](https://fess.codelibs.org/15.7/admin/dataconfig-guide.html): |
| 71 | |
| 72 | - [Confluence/Jira](https://github.com/codelibs/fess-ds-atlassian) |
| 73 | - [Box](https://github.com/codelibs/fess-ds-box) |
| 74 | - [CSV](https://github.com/codelibs/fess-ds-csv) |
| 75 | - [Database](https://github.com/codelibs/fess-ds-db) |
| 76 | - [Dropbox](https://github.com/codelib |
People who liked this also viewed
6 picksType
- ddgsA metasearch library that aggregates results from diverse web search servicesMCP ServersMay 2026
- firecrawl-mcp-server🔥 Official Firecrawl MCP Server - Adds powerful web scraping and search to Cursor, Claude and any other LLM clients.MCP ServersJul 2026
- fliGoogle Flights MCP, CLI and Python LibraryMCP ServersJul 2026
- sembleFast and Accurate Code Search for Agents. Uses ~98% fewer tokens than grep+readMCP ServersJul 2026
- duckduckgo-mcp-serverA Model Context Protocol (MCP) server that provides web search capabilities through DuckDuckGo, with additional features for content fetching and parsing.MCP ServersJul 2026
- wikipedia-mcpA Model Context Protocol (MCP) server that retrieves information from Wikipedia to provide context to LLMs.MCP ServersMay 2026
