Skip to content

Commit 6b857a3

Browse files
authored
Add docker compose instructions (#189)
Signed-off-by: Michael Diamond <[email protected]>
1 parent a98f4c4 commit 6b857a3

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,27 @@ As long as this is on a persistent volume, the auth key only needs to be provide
5757
[tag]: https://tailscale.com/kb/1068/acl-tags/
5858
[os.UserConfigDir]: https://pkg.go.dev/os#UserConfigDir
5959

60+
## Docker Compose
61+
62+
To run golink via Docker Compose:
63+
64+
```yaml
65+
volumes:
66+
data:
67+
68+
services:
69+
golink:
70+
image: ghcr.io/tailscale/golink:main
71+
container_name: golink
72+
restart: unless-stopped
73+
volumes:
74+
- 'data:/home/nonroot'
75+
```
76+
77+
To initialize the container with an auth key run:
78+
79+
docker compose run --rm --env 'TS_AUTHKEY=tskey-auth-<key>' golink
80+
6081
## MagicDNS
6182
6283
When golink joins your tailnet, it will attempt to use "go" as its node name,

0 commit comments

Comments
 (0)