Manage a VM'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.
The agent stores configuration in the persistent /data volume. Follow logs or stop it with:
docker compose logs -f
docker compose downFor optional host SSH key management, follow the SSH setup guide.
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.