Documentation

Abridged from the manuals our own operators work from. Where a behaviour is a default you can change, it says so; where something is not promised, it says that too.

Five pages, in the order you will need them. Start at the installation guide, and read the report-only section before you install on a host with paying customers on it.

Installation

Requirements, signed packages, the capability probe, Full and Lite profiles, systemd units and the report-only start that belongs on any host with customers on it.

Configuration

The per-domain policy model, the keys you can set, the local API and CLI, and the health and metrics you should alert on.

CyberPanel plugin

Installing, upgrading and repairing the Shelltrap plugin for CyberPanel, the pages it adds, and the role model for administrators, resellers and customers.

Signature feeds

How rule generations are built, licence-filtered, signed, verified, gated against a corpus and activated — and how a false-positive storm rolls them back automatically.

Licensing

How a Shelltrap licence key works, what activation binds to, how the offline token is verified, and exactly what the daemon does when a licence is missing or expired.

Derived from the Shelltrap product manuals (architecture, installation, feeds, plugin, API, licensing), revision 2026-09-04. The manuals shipped with your version are authoritative.