Skip to content
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.

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

docs(tailscale) Update How To Guide & remove TrueNAS references #32925

Merged
merged 14 commits into from
Mar 6, 2025
2 changes: 1 addition & 1 deletion charts/stable/tailscale/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -33,4 +33,4 @@ sources:
- https://github.com/truecharts/charts/tree/master/charts/stable/tailscale
- https://hub.docker.com/r/tailscale/tailscale
type: application
version: 10.12.0
version: 10.12.1
25 changes: 4 additions & 21 deletions charts/stable/tailscale/docs/How-To-Guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ title: How-To
---

This is a quick how-to or setup-guide to use Tailscale on Talos.
This can be applied to other systems but this specific guide is Talos on TrueNAS specific with the prerequisites.

:::caution

Expand All @@ -17,20 +16,8 @@ This guide doesn't cover using Tailscale with individual applications. While the
- Tailscale Truecharts Chart
- Tailscale DNS setup for Talos Cluster Domain

## Prerequisites (LAN access only)

For proper access to your local network (LAN), this chart requires two `sysctl` values set on your TrueNAS or system.
For TrueNAS SCALE the way to change these values are inside `System Settings` then `Advanced`.
On that screen you add the following two values:

- `net.ipv4.ip_forward`
- `net.ipv4.conf.all.src_valid_mark`

Set them to `1` and `Enabled`

![sysctl](./img/Sysctl.png)

Also prepare your Tailscale Auth Key for your setup, easy to generate on the page below
Generate a Tailscale Auth Key for your setup, easy to generate on the page below

![tailscale-auth-key](./img/How-To-Image-1.png)

Expand All @@ -43,20 +30,16 @@ Ideally use `tailscale` but you can use any name here.
### App Configuration

- `Auth Key`: The key you received from tailscale in prerequisites above
- `Userspace`: Now enabled by default, as it is _required_ when using local routes and as an exit node (see below). Userspace restricts clients to only accessing the GUI and Samba. This needs to be _unchecked_ if you need to give Tailscale full access to all the features inside TrueNAS SCALE (not just GUI/SMB, but RSYNC, PING and directly connect to other Tailscale IPs, etc). More info in the [Tailscale Userspace Guide](https://tailscale.com/kb/1112/userspace-networking/).
- `Userspace`: Now enabled by default, as it is _required_ when using local routes and as an exit node (see below). Userspace restricts clients to only accessing the GUI and Samba. More info in the [Tailscale Userspace Guide](https://tailscale.com/kb/1112/userspace-networking/).
- `Accept DNS`: Enabling it will pass your Global Nameservers from Tailscale to your local install.
- `Routes`: Change to the routes you wish Tailscale to have access to on the devices it's connected, such as my LAN in the example. Required if you want to access APPS over Tailscale using TrueNASIP:Port from any Tailscale connected client.
- `Routes`: Change to the routes you wish Tailscale to have access to on the devices it's connected, ie your LAN.
- `Extra Args` passes arguments/flags to the `tailscale up` command.
- `Hostname` You can specify a specific hostname for use inside Tailscale (see image below). (Passes `--hostname HOSTNAME` to `Extra args`)
- `Hostname` You can specify a specific hostname for use inside Tailscale. This is recommended as otherwise it will utilise the tailscale kubernetes podname as the machine name in the console, over time when the chart is upgraded it will add additional machines into Tailscale portal. (Passes `--hostname HOSTNAME` to `Extra args`)
- `Advertise as exit node` This is used to pass traffic through tailscale like a private VPN. (Passes `--advertise-exit-node` to `Extra args`)

For more Extra Args and their usage please check the [Tailscale Knowledge Base](https://tailscale.com/kb/1080/cli/#up)
since we consider these advanced features and these may/not be compatible with everyone's exact setup.

**Hostname example**

![hostname-example](./img/Hostname.png)

## Namespace Privileges Required for Talos Cluster

In your namespace.yaml file add
Expand Down
Binary file removed charts/stable/tailscale/docs/img/Hostname.png
Binary file not shown.
Binary file removed charts/stable/tailscale/docs/img/Sysctl.png
Binary file not shown.
Loading