Manage a VM's host and it's Docker Engine from Paashup or the NetBox Docker plugin, with a local dashboard and API.
Requires Docker Engine and Docker Compose on the VM. From this checkout:
export DOCKER_GID=$(stat -c '%g' /var/run/docker.sock)
docker compose up -d --buildOpen http://localhost:1880 and sign in with admin / saashup.
Before exposing the agent, set API_USERNAME, API_PASSWORD, and HEALTHCHECK_PASSWORD (the plaintext API password), then recreate the container. Docker socket access grants control of the host; restrict access and use HTTPS through a reverse proxy.
Use Agent settings to connect to Paashup/NetBox, or register the endpoint from the plugin. The dashboard also works standalone. Registry lists stay synchronized with local images.
Container creation and recreation accept optional memory_limit (bytes) and cpu_limit (CPU cores, including fractions). Both default to unlimited when omitted or set to 0. See resource limits and API examples.
The agent stores configuration in the persistent /data volume. Follow logs or stop it with:
docker compose logs -f
docker compose downFor named volumes with 1, 5, or 10 GiB limits (or unlimited), follow the ext4 project quota setup guide.
For optional host SSH key management, follow the SSH setup guide. The build commands select which host features to enable:
| Command | Features |
|---|---|
npm run build |
SSH key management and volume quotas (standard build) |
npm run build:light |
Basic agent |
npm run build:ssh |
Basic agent and SSH key management |
npm run build:quota |
Basic agent and volume quotas |
npm run build:all |
Alias for the standard feature set |
For the standard build, configure the SSH file and host quota prerequisites; see the combined setup.
Requires Node.js 24 or newer and access to a Docker Engine.
npm ci
DATAPATH=./data npm startThe dashboard runs at http://localhost:1880. Open http://localhost:1880/doc for interactive API documentation.
npm run test:unit # unit, integration, and security tests
npm run codeql:install # one-time local CodeQL installation
npm test # also runs CodeQL, Docker compatibility, and browser testsThe full suite requires Docker Compose, privileged containers, and registry network access. See development and testing for individual suites and test setup.