Port Igniter
Get Started

Reef

Documentation for Reef, a Linux host security-monitoring tool: agent-based scans, findings, notifications, and the Django dashboard that ties them together.

Product Support

Reef is a Linux host security-monitoring tool. A lean Django web UI is the reporting and notifications hub; a privileged agent container runs the actual scans against the host and ships raw output back through an authenticated API; a Celery worker parses that output into findings and raises notifications.

How it fits together

Reef architecture: the agent talks to web over HTTP with an API key; web enqueues jobs to redis for worker and beat, and reads/writes SQLite directly; worker and beat share the same SQLite database.

The agent has no database access and no application code — it authenticates with an API key, self-identifies by hostname, runs scans against the host (mounted read-only at /host), and only sends raw tool output back. All parsing happens server-side. See Architecture for the full breakdown of each service.

Seven scan types, one findings pipeline

Reef ships seven scan types: File Integrity Monitoring, AuditD Log Parsing, Lynis, ClamAV, OpenSCAP, Grype, and a YARA scanner. Each scanner has its own raw-output parser, but all of them land in the same Finding model, the same dashboard, and follow the same notification rules. See Scans for what each one does and how to tune it.

Where to start

Top