Files
truecharts/charts/stable/tailscale/docs/How-To-Guide.md
T
StevenMcElligott 937ff0f8b5 docs(Tailscale): Add more info to How-To guide and another example of Extra Args (#3564)
* fix(Tailscale): Updated How-To guide with more info

* more info on Extra args

* restructure list a bit

* lint

* lint

Co-authored-by: Stavros Kois <47820033+stavros-k@users.noreply.github.com>
2022-08-25 08:56:41 +02:00

2.7 KiB

How-To

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

Requirements

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

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

tailscale-auth-key

Tailscale Chart Setup

Step 1-2: Ideally use tailscale but you can use any name here and leave defaults for Step 2

Step 3:

  • Enter Auth Key you received from tailscale in prerequisites above

  • Keep Userspace checked (default) unless you wish to create your own Wireguard tunnels,

  • The default for Accept DNS is unchecked but enabling it will pass your Global Nameservers from Tailscale to your local install

  • Change Routes to the routes you wish Tailscale to have access to on the devices it's connected, such as my LAN in the example

  • Extra Args passes arguments/flags to the tailscale up command.

    Common flags/arguments:

    • --advertise-exit-node This is used to pass traffic through tailscale like a private VPN.
    • --hostname=<name> You can specify a specific hostname for use inside Tailscale (see image below).

For more Extra Args and their usage please check the Tailscale Knowledge Base since we consider these advanced features and these may/not be compatible with everyone's exact setup.

tailscale-step-3

Hostname example hostname-example

Step 4:

  • The default ports are fine for this chart, you shouldn't need to port forward or open ports on your router. However many people will want to access their SMB shares or TrueNAS GUI via Tailscale. In order to do so you will have to ensure the screen is setup as below.

tailscale-step-4

Steps 5-9: Adjust as necessary but defaults are fine.

Support

  • You can also reach us using Discord for real-time feedback and support
  • If you found a bug in our chart, open a Github issue

All Rights Reserved - The TrueCharts Project