Install LiteBlox
Requirements
- The LiteBlox host: Docker with the compose plugin, or podman. Any small machine or VM. Its only trip to the internet is IPAM's weekly MAC vendor list.
- The servers (nodes): Debian (13 is what it's tested on; a scanner also ran on Ubuntu 24.04) with a fixed address, a sudo account for setup, and Python 3.9 or newer. A VM with 2 cores and 1 GB of RAM is plenty: running BIND, Kea and chrony together uses about 330 MB.
- Internet access on the servers: they install BIND, Kea and chrony from Debian's APT repositories when you set up each module, so they need to reach them.
- LiteBlox needs to reach each server on TCP 22 (setup) and TCP 8530 (the agent), and DNS servers on port 53. Your browser reaches LiteBlox on TCP 53530.
Downloads
Version 4.1.1. Older versions are in all downloads.
| File | Size | What it is |
|---|---|---|
| liteblox-image-v4.1.1.tar.gz | 112 MB | The ready-built container image. Load it with docker load. Start here. |
| liteblox-src-v4.1.1.tgz | 1.8 MB | The source, with its Dockerfile, to build the image yourself. |
| INSTALL-WITHOUT-REGISTRY.txt | 4 KB | The install and upgrade steps below, as a text file. |
SHA-256 checksums:
9e73e6fd029adbed3537fedfc0659a8e04ead4015c6f91394ad60f9ebcd1ae97 liteblox-image-v4.1.1.tar.gz
a593755732ac18c0002579599498f58425a3f1b98bd90bd8a7b453eb127bfb3e liteblox-src-v4.1.1.tgz
Install
docker load -i liteblox-image-v4.1.1.tar.gz # Loaded image: localhost/liteblox:4.1.1
mkdir -p /srv/liteblox && cd /srv/liteblox
mkdir -p data backups && sudo chown 1000:1000 data backups
Save this as /srv/liteblox/docker-compose.yaml:
services:
liteblox:
image: localhost/liteblox:4.1.1
container_name: liteblox
restart: unless-stopped
user: "1000:1000"
environment:
- TZ=America/Detroit # your time zone
volumes:
- ./data:/data
- ./backups:/backups
ports:
- "53530:53530"
healthcheck:
test: liteblox healthcheck
interval: 30s
timeout: 3s
docker compose up -d
docker compose exec liteblox liteblox user add admin
Browse to http://HOST:53530 and log in. A new install first asks which modules to run. Then follow the Quick start: prepare a server, add it as a node, and LiteBlox sets it up. Anywhere beyond a trusted home network, put it behind an HTTPS reverse proxy (Installing and upgrading).
Upgrading
Back up /srv/liteblox/data, docker load the new image, change the image: line to the new version, and docker compose up -d. If the Nodes page marks a node upgrade, run Repair / upgrade agent on it. Skipping versions is fine: every database change in between is applied on start. The text file above has the details, including how to go back.
See the changelog for what each version changed.