Skip to content

Commit

Permalink
fix(docs): readability for Tailscale docs
Browse files Browse the repository at this point in the history
use list to highlight env vars

Signed-off-by: Caleb Woodbine <calebwoodbine.public@gmail.com>
  • Loading branch information
BobyMCbobs authored and frezbo committed Aug 3, 2023
1 parent 45ef4c0 commit 7ca8a0f
Showing 1 changed file with 15 additions and 15 deletions.
30 changes: 15 additions & 15 deletions network/tailscale/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Simplest install
machine:
install:
extensions:
- image: docker.io/btrepp/tailscale:1.40.0
- image: ghcr.io/siderolabs/tailscale:1.44.0
files:
- content: |
TS_AUTHKEY=<your auth key>
Expand All @@ -33,20 +33,20 @@ Extra tailscale specific environment vars can be configured as needed in `/var/e

Current known env vars are:

TS_AUTHKEY: the authkey to use for login.
TS_HOSTNAME: the hostname to request for the node.
TS_ROUTES: subnet routes to advertise.
TS_DEST_IP: proxy all incoming Tailscale traffic to the given destination.
TS_TAILSCALED_EXTRA_ARGS: extra arguments to 'tailscaled'.
TS_EXTRA_ARGS: extra arguments to 'tailscale up'.
TS_USERSPACE: run with userspace networking (the default) instead of kernel networking.
TS_STATE_DIR: the directory in which to store tailscaled state. The data should persist across container restarts.
TS_ACCEPT_DNS: whether to use the tailnet's DNS configuration.
TS_KUBE_SECRET: the name of the Kubernetes secret in which to store tailscaled state.
TS_SOCKS5_SERVER: the address on which to listen for SOCKS5 proxying into the tailnet.
TS_OUTBOUND_HTTP_PROXY_LISTEN: the address on which to listen for HTTP proxying into the tailnet.
TS_SOCKET: the path where the tailscaled LocalAPI socket should be created.
TS_AUTH_ONCE: if true, only attempt to log in if not already logged in. If false (the default, for backwards compatibility), forcibly log in every time the container starts.
- TS_AUTHKEY: the authkey to use for login.
- TS_HOSTNAME: the hostname to request for the node.
- TS_ROUTES: subnet routes to advertise.
- TS_DEST_IP: proxy all incoming Tailscale traffic to the given destination.
- TS_TAILSCALED_EXTRA_ARGS: extra arguments to 'tailscaled'.
- TS_EXTRA_ARGS: extra arguments to 'tailscale up'.
- TS_USERSPACE: run with userspace networking (the default) instead of kernel networking.
- TS_STATE_DIR: the directory in which to store tailscaled state. The data should persist across container restarts.
- TS_ACCEPT_DNS: whether to use the tailnet's DNS configuration.
- TS_KUBE_SECRET: the name of the Kubernetes secret in which to store tailscaled state.
- TS_SOCKS5_SERVER: the address on which to listen for SOCKS5 proxying into the tailnet.
- TS_OUTBOUND_HTTP_PROXY_LISTEN: the address on which to listen for HTTP proxying into the tailnet.
- TS_SOCKET: the path where the tailscaled LocalAPI socket should be created.
- TS_AUTH_ONCE: if true, only attempt to log in if not already logged in. If false (the default, for backwards compatibility), forcibly log in every time the container starts.

### Subnet routing

Expand Down

0 comments on commit 7ca8a0f

Please sign in to comment.