From 64199492d20a9cce9f0d3104f0a9ef04de2e6a92 Mon Sep 17 00:00:00 2001 From: Michael Diamond Date: Sat, 28 Jun 2025 17:21:13 -0700 Subject: [PATCH] Add docker compose instructions Signed-off-by: Michael Diamond --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/README.md b/README.md index 69dd244..ee675d9 100644 --- a/README.md +++ b/README.md @@ -57,6 +57,27 @@ As long as this is on a persistent volume, the auth key only needs to be provide [tag]: https://tailscale.com/kb/1068/acl-tags/ [os.UserConfigDir]: https://pkg.go.dev/os#UserConfigDir +## Docker Compose + +To run golink via Docker Compose: + +```yaml +volumes: + data: + +services: + golink: + image: ghcr.io/tailscale/golink:main + container_name: golink + restart: unless-stopped + volumes: + - 'data:/home/nonroot' +``` + +To initialize the container with an auth key run: + + docker compose run --rm --env 'TS_AUTHKEY=tskey-auth-' golink + ## MagicDNS When golink joins your tailnet, it will attempt to use "go" as its node name,