whodb v0.1.0

Dev tools

WhoDB — a fast, lightweight database explorer with a graph-based schema view and natural-language querying, supporting Postgres, MySQL, SQLite, MongoDB, Redis and more. Deployed as a single host-networked Nomad service.

nomad-pack run whodb --registry nomploy

…or one line (add registry + run)

curl -fsSL https://packs.nomploy.com/install.sh | sh -s -- whodb

Needs nomad-pack on PATH. The script only adds the nomploy registry and runs this pack.

Source ↗ Project ↗ ★ 5k ⚑ Report an issue

1 task http 8080 1 volume image clidey/whodb:latest tracks :latest image bumped today

Variables 9

values.hcl

Save as values.hcl, edit, then run:

nomad-pack run whodb -f values.hcl --registry nomploy

# The name of the Nomad job.
job_name = "whodb"

# The Nomad namespace to deploy into.
namespace = "default"

# The datacenters to deploy to.
datacenters = ["*"]

# The WhoDB container image. Pin a tag in production.
image = "clidey/whodb:latest"

# Host port for the WhoDB web UI.
port = 8080

# 64-char hex key to encrypt stored login sessions (openssl rand -hex 32). CHANGE THIS.
encryption_key = "0000000000000000000000000000000000000000000000000000000000000000"

# Named volume for persisted (encrypted) login sessions (/data).
data_volume = "whodb_data"

# Placement constraints. On a nomploy cluster: attribute = "$${meta.nomploy_control_plane}", operator = "=", value = "true".
constraints = []

# The task resources.
resources = {
    cpu    = 300
    memory = 256
  }

Name	Type	Default	Description
job_name	string	"whodb"	The name of the Nomad job.
namespace	string	"default"	The Nomad namespace to deploy into.
datacenters	list	["*"]	The datacenters to deploy to.
image	string	"clidey/whodb:latest"	The WhoDB container image. Pin a tag in production.
port	number	8080	Host port for the WhoDB web UI.
encryption_key key	string	"0000000000000000000000000000000000000000000000000000000000000000"	64-char hex key to encrypt stored login sessions (openssl rand -hex 32). CHANGE THIS.
data_volume	string	"whodb_data"	Named volume for persisted (encrypted) login sessions (/data).
constraints	list	[]	Placement constraints. On a nomploy cluster: attribute = "$${meta.nomploy_control_plane}", operator = "=", value = "true".
resources	object	{ cpu = 300 memory = 256 }	The task resources.

Back up this pack

This pack stores data in one Docker named volume: whodb_data

restic

# Run on the node hosting this pack. Point restic at your repo first:
#   export RESTIC_REPOSITORY="s3:https://<account>.r2.cloudflarestorage.com/<bucket>"
#   export RESTIC_PASSWORD="<repo-password>"
#   export AWS_ACCESS_KEY_ID=<key>  AWS_SECRET_ACCESS_KEY=<secret>
restic backup \
  /var/lib/docker/volumes/whodb_data/_data

rclone (sync to S3/R2)

rclone sync /var/lib/docker/volumes/whodb_data/_data backup:<bucket>/whodb_data

Paths assume the default Docker volume location (/var/lib/docker/volumes). Restore by stopping the job, restoring files into the same volume, and re-running the pack.

Readme

whodb

WhoDB is a fast, lightweight database explorer with a clean UI, an interactive graph-based schema view and natural-language querying (via an LLM of your choice). It connects to PostgreSQL, MySQL/MariaDB, SQLite, MongoDB, Redis, ClickHouse, ElasticSearch and more — a friendly alternative to Adminer or phpMyAdmin.

This pack runs WhoDB as a single host-networked Nomad service.

Deploy

nomad-pack run whodb --registry=nomploy \
  --var encryption_key=$(openssl rand -hex 32)

Open http://<node-ip>:8080 and enter your database connection details.

Configuration

Variable	Default	Description
`image`	`clidey/whodb:latest`	Container image (pin a tag in production).
`port`	`8080`	Host port for the web UI.
`encryption_key`	placeholder (64 hex)	Encrypts saved login sessions — change this.
`data_volume`	`whodb_data`	Volume for persisted sessions (`/data`).
`resources`	300 MHz / 256 MB	CPU and memory for the task.

WhoDB is a client that connects to your existing databases; connection details are entered in the UI and (optionally) persisted, encrypted, in data_volume. Set WHODB_SECURE=true when serving over HTTPS.