Tutorial

Step-by-step articles that walk through installing Fess, using its API, and setting it up as a site search server.

Installation Guide

• Introduction
• Target Audience
• Required Environment
• What is Fess
  • Features of Fess
    • Java-based Search System
    • Using OpenSearch as the Search Engine
    • Using Fess Crawler as the Crawling Engine
• Installation and Startup
  • Download and Installation
  • Configuration
  • Startup
  • Shutdown
  • Directory Structure
• From Index Creation to Search
  • Logging into the Administration Page
  • Registering Crawl Targets
  • Starting the Crawl
  • Search Example
• Customizing the Search Screen
• Summary
• References

API Guide

• Introduction
• Target Audience
• Required Environment
• JSON API
• Building a Search Site Using the JSON API
  • JSON and CORS
  • Files to Create
  • Creating the HTML File
  • Creating the JS File
  • Search Processing Function doSearch
  • Execution
• Summary
• References

FSS Guide

• Introduction
• Target Audience
• What is Fess Site Search (FSS)?
• What is FSS JS?
• Integrating into Your Site
• Summary
• References