Overview

# CFM Project Overview

## Purpose
CFM is a Security - Firewall Management project designed to manage spam detection, blocklists, feed processing, and admin control using a web interface.

## Layers
- Models: Handle data and relationships
- Controllers: Process web/API requests
- Commands: Automate backend tasks
- Filament: Admin UI for managing keywords, feeds, and settings
- Routes: Web and API access
- Cron Jobs: Scheduled feed updates and maintenance

## Key Features
- Spam keyword detection (loose & strict modes)
- Blocklist/whitelist management (IP and domain-based)
- Feed processing system (with logging and rule generation)
- Central API for querying blocklists
- Admin UI for managing everything
- Clamav Rule generation
- Phishlist database
- RBLDNS database
- Hash Management (MD5 / SHA1 / SHA2) for Clamav signatures
- Mail filters
- Synchronizing files to server through agents
- Updating lists through agents
- Manage global user unblocking

This documentation is organized by feature and component to help understand and extend the system.