Skip to content

docker.md

Latest commit

 

History

History
84 lines (61 loc) · 2.21 KB

docker.md

File metadata and controls

84 lines (61 loc) · 2.21 KB
Raw

Docker

StatLite publishes one multi-platform image for linux/amd64 and linux/arm64:

ghcr.io/pvrlabs/statlite:latest

Run the demo

docker run --rm \
  -p 127.0.0.1:9090:9090 \
  ghcr.io/pvrlabs/statlite:latest

Open http://127.0.0.1:9090. The image includes a default configuration that monitors StatLite itself through statlite-metrics; no configuration file is required.

Note

The bundled configuration polls every 30 seconds, a production-sensible default that limits HTTP requests, SQLite writes, and database growth. The first metrics sample may take up to one polling interval to appear.

The container stores SQLite data at /data/statlite.sqlite. Data is ephemeral unless /data is mounted to persistent storage.

Access and metrics

StatLite has no built-in dashboard or API authentication. The example publishes port 9090 only on host loopback so the dashboard is not exposed directly to the network. Use appropriate external access controls before publishing it more broadly.

Container resource metrics describe the environment visible inside the container, not the physical macOS host.

The image runs as the non-root statlite user and includes CA certificates for HTTPS targets. Dashboard assets and the SQLite schema are embedded in the binary.

Build locally

From the repository root:

docker build \
  --build-arg VERSION=dev \
  -t statlite:local \
  .

Check the embedded version:

docker run --rm statlite:local --version

For local development, the bundled image configuration listens on 0.0.0.0:9090 inside the container and the example above restricts access at the host port.

Application examples are available under examples/, including the Spring Boot and Python FastAPI demos.

Maintainer pre-release image

Maintainers may publish a temporary :dev image for pre-release verification. Build and inspect it from the repository root:

docker buildx build \
  --platform linux/amd64,linux/arm64 \
  --build-arg VERSION=dev \
  --tag ghcr.io/pvrlabs/statlite:dev \
  --push \
  .

docker buildx imagetools inspect ghcr.io/pvrlabs/statlite:dev

See Releasing StatLite for publishing versioned and :latest images.