Documentation
Heimnull documentation
Everything you need to run Heimnull on your own server, from what it needs to how each page and setting works.
01RequirementsThe server, the software, the firewall and your routers: what to check before you install.02GuidesStep by step: install on a fresh host, first setup, router configuration, HTTPS, upgrades, backups and licensing.03ReferenceEvery page and setting, how detection and mitigation work, the license states,
.env, ports and the API.Start here
Section titled “Start here”- Check the requirements. The two that catch people out: the CPU needs AVX2 (on Proxmox, set the VM’s CPU type to
hostorx86-64-v3), and Heimnull needs Docker Engine, not Docker Desktop. - Install Heimnull on a fresh Linux host. It takes about ten minutes.
- Do the first-time setup: your networks, your routers, hostgroups and notifications.
- Point your routers at it: Juniper MX, Juniper EX (sFlow), Juniper SRX or MikroTik.
A new installation runs a 30-day trial with every feature. After that, it keeps running in Free mode (flow analytics up to 500 Mb/s, with attacks detected and notified) unless you enter a license key. See Licensing.
Getting help
Section titled “Getting help”If something doesn’t look right, check Common problems first. If that doesn’t answer it, generate a support file and send it to info@heimnull.com with a description of what you see.