Documentation
This is the manual built into LiteBlox under Help.
- Quick start
- From two fresh Debian servers to a forward zone (example.com) and its reverse zone (0.168.192.in-addr.arpa, for 192.168.0.0/24): ns1 is the primary and…
- How LiteBlox works
- LiteBlox runs your BIND servers for you. Give it a few Debian machines with a sudo account and it takes over their BIND configuration: zones, server…
- Modules: what to run
- LiteBlox is four modules. Run all of them, or only the ones you need:
- The Dashboard
- The Dashboard shows what LiteBlox knows about your servers right now, and what needs you. Everything on it comes from LiteBlox's own database, which the…
- Search
- The search box in the top bar (press / to get to it) looks through everything LiteBlox knows at once: every zone's records, the DHCP reservations and…
- Installing and upgrading
- Installing and upgrading: LiteBlox documentation.
- Preparing a node
- A node is a server LiteBlox runs BIND on (or Kea, chrony, or only the agent: see Nodes without BIND). LiteBlox installs BIND if it's missing and writes…
- Bringing in existing servers
- A BIND server that already has zones and options of its own can be taken over too. LiteBlox imports its configuration, shows you exactly what it would…
- Editing and publishing
- This page is about static zones: you edit a draft, review it and publish it. A dynamic zone uses the same grid, but each edit applies at once.
- Zones and their settings
- LiteBlox declares every zone itself, in /etc/bind/liteblox/zones.conf on each node that serves it. A forward or reverse zone's file lives on the primary…
- Dynamic zones and TSIG keys
- A dynamic zone accepts DNS updates (RFC 2136): a DHCP server registers its clients' names, an ACME client proves it owns a name with a TXT record…
- Server settings and ACLs
- Each node's options { … } (recursion, forwarders, DNSSEC, who may query it) is edited on its Server settings page, reached from the node's page. Named…
- DHCP (Kea)
- LiteBlox runs ISC Kea as the DHCP server on its nodes, alongside BIND. A node can run both: DNS for everyone, and DHCP on the network interfaces you pick.
- Time (NTP)
- Clocks matter to LiteBlox more than they might seem: - signed zone transfers and DNS updates (DHCP's, ACME's, LiteBlox's own) fail once two clocks are 5…
- IPAM (addresses)
- IPAM shows what uses each address in your networks: the DNS names pointing at it, its DHCP reservation, the lease a client holds on it, what the nodes…
- Tools (subnet calculators)
- The Tools menu in the top bar holds two small network calculators. Each opens in a new tab, so it can sit beside the page you're working on. Any…
- Primary, failover and drift
- One node is the primary for every forward and reverse zone; every other node LiteBlox has taken over is its secondary. LiteBlox publishes static zones to…
- Backups and restore
- LiteBlox's zone history covers every zone's records, and its database holds each node's settings, ACLs and keys. Node backups are the files themselves…
- Security model
- Further attempts are refused with Too many failed logins; try again in N minutes, even with the right password, and the audit log records one Refused a…
- Troubleshooting
- The health check asks every node once a minute, so the status corrects itself within a minute of the node coming back.
- The API
- LiteBlox has a JSON API under /api/v1. Scripts, monitoring and other tools use it to read nodes, zones, records and DHCP leases, and to change records…
- Command line and settings
- Command line and settings: LiteBlox documentation.