From 6d7e7e7a9324ef0640c62dcd0b7fc275e0aacec2 Mon Sep 17 00:00:00 2001 From: Rob Date: Sat, 14 Jun 2025 15:31:16 +0100 Subject: [PATCH] Update README.md added docker socket mount example --- README.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 9cd2768..b551e80 100644 --- a/README.md +++ b/README.md @@ -82,10 +82,25 @@ Newt can integrate with the Docker socket to provide remote inspection of Docker **Configuration:** -You can specify the Docker socket path using the `--docker-socket` CLI argument or by setting the `DOCKER_SOCKET` environment variable. On most linux systems the socket is `/var/run/docker.sock` +You can specify the Docker socket path using the `--docker-socket` CLI argument or by setting the `DOCKER_SOCKET` environment variable. On most linux systems the socket is `/var/run/docker.sock`. You need to mount the host socket as a volume for the newt container to access it. If the Docker socket is not available or accessible, Newt will gracefully disable Docker integration and continue normal operation. +```yaml +services: + newt: + image: fosrl/newt + container_name: newt + restart: unless-stopped + volumes: + - /var/run/docker.sock:/var/run/docker.sock:ro + environment: + - PANGOLIN_ENDPOINT=https://example.com + - NEWT_ID=2ix2t8xk22ubpfy + - NEWT_SECRET=nnisrfsdfc7prqsp9ewo1dvtvci50j5uiqotez00dgap0ii2 + - DOCKER_SOCKET=/var/run/docker.sock +``` + ### Updown You can pass in a updown script for Newt to call when it is adding or removing a target: