OpenEFA Documentation

Comprehensive guides, technical documentation, and resources for deploying and managing OpenEFA and OpenSpacy AI-powered email filtering.

Getting Started

Installation Requirements Reference

Complete technical requirements and design decisions for OpenEFA installation. Covers hardware specs, network architecture, database design, and deployment considerations.

Read Guide
Quick Start Guide Coming Soon

Step-by-step installation guide for deploying OpenEFA on Ubuntu 24.04 LTS. Get up and running in minutes with the automated installer script.

In Development

Understanding OpenEFA

Spam Filtering Effectiveness Metrics New

Learn how to measure and evaluate email filtering performance using industry-standard metrics: F1 Score, Detection Rate, Precision, False Positive Rate, and more.

Read Documentation
Learning System Overview New

Discover how OpenEFA's adaptive AI learns from legitimate emails to improve spam detection. Privacy-preserving machine learning that gets smarter over time.

Read Documentation
OpenSpacy Architecture New

Deep dive into OpenSpacy's three-tier AI filtering system: Tier 1 (Core), Tier 2 (Standard), and Tier 3 (Advanced) modules and how they work together.

Read Documentation

Configuration & Administration

Web Interface Guide New

Complete guide to using SpacyWeb for monitoring email traffic, managing quarantine, configuring filtering rules, training the AI system, and viewing detection statistics.

Read Documentation
Network Integration Coming Soon

How to integrate OpenEFA into your existing mail infrastructure as a front-end relay. Covers DNS configuration, relay settings, and failover strategies.

In Development
API Reference Coming Soon

Complete API documentation for OpenSpacy filtering services (ports 5001, 5002, 5003). Examples for custom integrations and automation.

In Development
Troubleshooting Guide Coming Soon

Common issues and their solutions. Debugging mail flow, checking service status, analyzing logs, and performance tuning tips.

In Development

Advanced Topics

Machine Learning Model Training Coming Soon

How to train and refine OpenSpacy's AI models with your organization's mail patterns for improved accuracy and reduced false positives.

In Development
Custom Module Development Coming Soon

Developer guide for creating custom OpenSpacy filtering modules. API hooks, module structure, and contribution guidelines.

In Development

Community Resources

Need Help?

Can't find what you're looking for? Join our community forum to ask questions, share experiences, and get support from OpenEFA users and developers.

Visit Forum Read Blog
Contribute to Documentation

OpenEFA is an open-source project, and we welcome documentation contributions! Found a typo? Have a tutorial to share? Join us on GitHub or post in the forum.

GitHub repository coming soon | License: GPL (GNU General Public License)