diff --git a/README.md b/README.md index c6a0119..3575a5a 100644 --- a/README.md +++ b/README.md @@ -110,14 +110,30 @@ Pushing a version tag (e.g. `v1.2.3`) or publishing a release triggers which builds and publishes a multi-arch (`linux/amd64` + `linux/arm64`) image to `git.arnef.de/arnef/nidus`, tagged with the version, `.`, `latest`, and the short commit SHA. It authenticates via the -`REGISTRY_USERNAME`/`REGISTRY_PASSWORD` repository secrets. Point -`docker-compose.yaml`'s `image:` at it instead of `build: .` to use it -directly, e.g.: +`REGISTRY_USERNAME`/`REGISTRY_PASSWORD` repository secrets. + +A minimal standalone `docker-compose.yml` that pulls this image instead of +building from a checkout — just fetch `config.example.yaml`, copy it to +`config.yaml`, and adjust it to your needs: ```yaml services: davserver: image: git.arnef.de/arnef/nidus:latest + ports: + - "8080:8080" + volumes: + - ./config.yaml:/app/config.yaml:ro + - dav-data:/app/data + restart: unless-stopped + healthcheck: + test: ["CMD", "wget", "-qO-", "http://localhost:8080/healthz"] + interval: 30s + timeout: 5s + retries: 3 + +volumes: + dav-data: ``` ---