Fess Developer Documentation

Documentation for extending Fess.

Overview

Developer Documentation Overview

• Overview
• Target Audience
• Development Environment
• Architecture Overview
• Directory Structure
• Extension Points
• Plugin Development
• Theme Development
• Best Practices
• Resources

Plugin Development

Plugin Architecture

• Overview
• Plugin Types
• Plugin Structure
• Plugin Registration
• Plugin Lifecycle
• Dependencies
• Configuration Retrieval
• Build and Installation
• Debugging
• Published Plugins
• Reference

DataStore Plugin Development

• Overview
• Basic Structure
• AbstractDataStore
• Implementation Examples
• Authentication Implementation
• Error Handling
• Testing
• Configuration Example
• Reference

Script Engine Plugin

• Overview
• Basic Implementation
• Registration
• Usage Example
• Reference

Web App Plugin

• Overview
• Basic Structure
• Action Implementation
• JSP Template
• API Extension
• Reference

Ingest Plugin

• Overview
• Use Cases
• Basic Implementation
• Registration
• Configuration
• Reference

Customization

Theme Development Guide

• Overview
• Theme Structure
• Basic Theme Creation
• Theme Registration
• Installation
• Existing Theme Examples
• Reference