From e8739b700bca1fffede2db40a54d126d34e6c303 Mon Sep 17 00:00:00 2001 From: Owen Schwartz Date: Sat, 4 Jan 2025 17:41:18 -0500 Subject: [PATCH] Add example compose to readme --- README.md | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 9067e41..6b3cb39 100644 --- a/README.md +++ b/README.md @@ -53,7 +53,25 @@ Example: --reportBandwidthTo=http://pangolin:3001/api/v1/gerbil/receive-bandwidth ``` -Note: CLI args can be passed as "command" fields when using the Docker container. +```yaml +services: + gerbil: + image: fosrl/gerbil + container_name: gerbil + restart: unless-stopped + command: + - --reachableAt=http://gerbil:3003 + - --generateAndSaveKeyTo=/var/config/key + - --remoteConfig=http://pangolin:3001/api/v1/gerbil/get-config + - --reportBandwidthTo=http://pangolin:3001/api/v1/gerbil/receive-bandwidth + volumes: + - ./config/:/var/config + cap_add: + - NET_ADMIN + - SYS_MODULE + ports: + - 51820:51820/udp +``` ## Build