Requirements
Requirements
What Heimnull needs from your server, its software, your network and your routers, in one checklist.
Heimnull runs on one Linux server as three Docker containers: Heimnull itself (flow collector, detection, mitigation, BGP speaker, web interface), PostgreSQL and ClickHouse. Check these before you install.
| Needs | Details | |
|---|---|---|
| CPU | amd64 with AVX2 (x86-64-v3), or arm64. 8 cores recommended, 4 for smaller networks | Server |
| Memory | 16 GB recommended, 8 GB for smaller networks | Server |
| Storage | SSD or NVMe. 500 GB holds 30 days of raw flows for a busy network | Server |
| Operating system | Linux. The guides use Debian 13; Ubuntu 22.04 or later works too | Software |
| Docker | Docker Engine with the compose plugin 2.23 or later. Not Docker Desktop | Software |
| Inbound | The web port, the flow ports from your routers, and BGP if you’ll mitigate | Network |
| Outbound | HTTPS to registry.heimnull.com, license.heimnull.com, Docker Hub and the dataset publishers |
Network |
| Routers | NetFlow v9, IPFIX or sFlow v5 export. For mitigation, a BGP session, and FlowSpec support if you want FlowSpec | Routers |