diff --git a/README.md b/README.md index f5299a4..096c044 100644 --- a/README.md +++ b/README.md @@ -4,13 +4,16 @@ See associated blog post: **Set the TAILSCALE_AUTH_KEY with your own ephemeral auth key**: -The `Makefile` contains all commands to launch the various examples. Refer to it to understand which commands are used. - ## docker-compose +The examples detailed below are in the docker-compose folder. + By default, no state is saved. The nodes are removed from the network when the tailscale container is terminated. This means the ip address is never the same. The `stateful-example` does save the tailscale node state to a docker volume. +Requirements: +- [docker-compose](https://docs.docker.com/compose/install/) + Usage: ````bash export TAILSCALE_AUTH_KEY="your-key"