Run the UI in Docker
The image is ghcr.io/thadeu/ndb-ui (linux amd64 and arm64). It listens on 0.0.0.0:4321 inside the container, so publish the port on 127.0.0.1 only: the console has no login. Expose it only behind authentication (a VPN, an SSH tunnel, or a proxy with a login). It answers only for IP addresses, localhost, and the names in NDB_UI_ALLOWED_HOSTS (for example -e NDB_UI_ALLOWED_HOSTS=ndb.example.com behind a proxy). See Protection.
For development, ghcr.io/thadeu/ndb-stack has the daemon and the console in one image, with no parameters: docker run -p 7070:7070 -p 4321:4321 ghcr.io/thadeu/ndb-stack. See ndb-stack (development). ndb-stack is for development only, never production.
A daemon over TCP
docker run -d --name ndb-ui -p 127.0.0.1:4321:4321 \
-e NDB_URL=tcp://10.10.0.1:7070 -e NDB_TOKEN=... \
ghcr.io/thadeu/ndb-uiA daemon on the same host (unix socket)
Mount the folder of the socket. The console then opens it like a local file:
docker run -d --name ndb-ui -p 127.0.0.1:4321:4321 \
-v /run/ndb:/run/ndb \
-e NDB_URL=unix:///run/ndb/ndb.sock \
ghcr.io/thadeu/ndb-uiThe console runs as nonroot (uid 65532), like the ndb image. With the default socket mode 0660, it can open a socket made by the ndb image. For a daemon that runs as another user (systemd), set listen.unix_mode or run the container with that user's group (--group-add).
Compose, next to ndb
volumes_from shares the socket volume of the ndb container (the image declares /run/ndb as a volume):
services:
ndb:
image: ghcr.io/thadeu/ndb:0.3.1
ndb-ui:
image: ghcr.io/thadeu/ndb-ui:0.3.1
volumes_from: [ndb]
environment:
NDB_URL: unix:///run/ndb/ndb.sock
ports:
- 127.0.0.1:4321:4321Many daemons
Without NDB_URL, the console keeps a list of connections in /home/nonroot/.config/ndb/console.json. Mount a volume there to keep the list:
docker run -d -p 127.0.0.1:4321:4321 \
-v ndb-ui-config:/home/nonroot/.config/ndb \
ghcr.io/thadeu/ndb-uiIn a container, Discover only sees the sockets that are mounted, and the hosts that the container can reach.