Skip to content

Add docker compose instructions #189

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 14, 2025
Merged

Add docker compose instructions #189

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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-<key>' golink

## MagicDNS

When golink joins your tailnet, it will attempt to use "go" as its node name,
Expand Down
Loading