mirror of
https://github.com/jbowdre/tailscale-docker.git
synced 2024-11-27 03:52:18 +00:00
47 lines
No EOL
3 KiB
Markdown
47 lines
No EOL
3 KiB
Markdown
# Tailscale in Docker with Serve/Funnel Support
|
|
|
|
> [!NOTE]
|
|
> The Tailscale Blog has a [recent post](https://tailscale.com/blog/docker-tailscale-guide) which describes how to use the `TS_SERVE_CONFIG` variable to manage Serve and Funnel with the official image. You should probably use that approach now instead of this weird one-off cobbled together by some rando.
|
|
|
|
This modification of the [official Tailscale Docker image](https://github.com/tailscale/tailscale/pkgs/container/tailscale) makes it easy to [Serve](https://tailscale.com/kb/1312/serve)/[Funnel](https://tailscale.com/kb/1223/funnel) another container without needing interactive configuration.
|
|
|
|
_Read more about this implementation in the [blog post](https://runtimeterror.dev/tailscale-serve-docker-compose-sidecar/)._
|
|
|
|
## Prereqs
|
|
- A [pre-authentication key](https://tailscale.com/kb/1085/auth-keys) so the Tailscale container can log in to your tailnet.
|
|
- [Tailscale Serve setup](https://tailscale.com/kb/1312/serve#setup)
|
|
- [Tailscale Funnel setup](https://tailscale.com/kb/1223/funnel#setup)
|
|
- [Tailscale Funnel ACL](https://tailscale.com/kb/1223/funnel#tailnet-policy-file-requirement)
|
|
|
|
> If you're planning to use Funnel, you may want to build the ACL around a tag (such as `tag:funnel`) and automatically apply that tag when you generate the pre-auth key.
|
|
|
|
## docker-compose
|
|
|
|
See [docker-compose.yml](/docker-compose-example/docker-compose.yml) for an example Compose config.
|
|
|
|
Expected environment variables:
|
|
| Variable Name | Example | Description |
|
|
| --- | --- | --- |
|
|
| `TS_AUTHKEY` | `tskey-auth-somestring-somelongerstring` | used for unattened auth of the new node, get one [here](https://login.tailscale.com/admin/settings/keys) |
|
|
| `TS_HOSTNAME` | `my-app` | optional Tailscale hostname for the new node |
|
|
| `TS_STATE_DIR` | `/var/lib/tailscale/` | required directory for storing Tailscale state, this should be mounted to the container for persistence |
|
|
| `TS_TAILSCALED_EXTRA_ARGS` | `--verbose=1` | optional additional [flags](https://tailscale.com/kb/1278/tailscaled#flags-to-tailscaled) for `tailscaled` |
|
|
| `TS_EXTRA_ARGS` | `--ssh` | optional additional [flags](https://tailscale.com/kb/1241/tailscale-up) for `tailscale up` |
|
|
| `TS_SERVE_PORT` | `8080` | optional application port to expose with [Tailscale Serve](https://tailscale.com/kb/1312/serve) |
|
|
| `TS_FUNNEL` | `1` | if set (to anything), will proxy `TS_SERVE_PORT` **publicly** with [Tailscale Funnel](https://tailscale.com/kb/1223/funnel) |
|
|
|
|
You can drop these in a `.env` file alongside your `docker-compose.yml` to load them automatically - see [.env_template](/docker-compose-example/env_template) for an example.
|
|
|
|
### Usage
|
|
- Copy the example `docker-compose.yml` and modify to suit your needs.
|
|
- Start:
|
|
`docker compose up -d --build`
|
|
- Tail Tailscale logs:
|
|
`docker compose logs tailscale --follow`
|
|
- Access `tailscale`` container for troubleshooting:
|
|
`docker exec -it tailscale ash`
|
|
- Stop:
|
|
`docker compose down`
|
|
|
|
## Credits
|
|
Based on Louis-Philippe Asselin's [tailscale-docker](https://github.com/lpasselin/tailscale-docker). |