pangolin_mirror/newt
1
0
Fork 0
mirror of https://github.com/fosrl/newt.git synced 2026-03-09 12:16:39 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source 
added docker socket mount example
This commit is contained in:
Rob
2025-06-14 15:31:16 +01:00
committed by Owen
parent 95d4cb2758
commit 5f9c041c6b
1 changed files with 16 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@@ -82,10 +82,25 @@ Newt can integrate with the Docker socket to provide remote inspection of Docker
**Configuration:** **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. 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 ### Updown
You can pass in a updown script for Newt to call when it is adding or removing a target: You can pass in a updown script for Newt to call when it is adding or removing a target: