feat(Tailscale): More info in How-To (#6968)
* feat(Tailscale): More info in How-To * Apply suggestions from code review Signed-off-by: Stavros Kois <47820033+stavros-k@users.noreply.github.com> --------- Signed-off-by: Stavros Kois <47820033+stavros-k@users.noreply.github.com> Co-authored-by: Stavros Kois <47820033+stavros-k@users.noreply.github.com>
This commit is contained in:
parent
471781a9b0
commit
d48cb2e146
|
@ -20,7 +20,7 @@ sources:
|
||||||
- https://github.com/truecharts/charts/tree/master/charts/stable/tailscale
|
- https://github.com/truecharts/charts/tree/master/charts/stable/tailscale
|
||||||
- https://hub.docker.com/tailscale/tailscale
|
- https://hub.docker.com/tailscale/tailscale
|
||||||
- https://github.com/tailscale/tailscale/blob/main/docs/k8s/run.sh
|
- https://github.com/tailscale/tailscale/blob/main/docs/k8s/run.sh
|
||||||
version: 3.0.13
|
version: 3.0.14
|
||||||
annotations:
|
annotations:
|
||||||
truecharts.org/catagories: |
|
truecharts.org/catagories: |
|
||||||
- network
|
- network
|
||||||
|
|
|
@ -3,6 +3,12 @@
|
||||||
This is a quick how-to or setup-guide to use Tailscale using on your TrueNAS box.
|
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.
|
This can be applied to other systems but this specific guide is SCALE specific with the prerequisites.
|
||||||
|
|
||||||
|
:::caution
|
||||||
|
|
||||||
|
This guide doesn't cover using Tailscale with individual applications. While there are methods to use Tailscale (as an app) with other individual apps this requires `Host-Networking` and beyond the scope of this guide and may not work for all apps. The suggested use in the future will be the Tailscale Add-On
|
||||||
|
|
||||||
|
:::
|
||||||
|
|
||||||
## Requirements
|
## Requirements
|
||||||
|
|
||||||
- Tailscale Account (Free accounts available at [Tailscale's Official website](https://www.tailscale.com))
|
- Tailscale Account (Free accounts available at [Tailscale's Official website](https://www.tailscale.com))
|
||||||
|
@ -38,9 +44,9 @@ Leave defaults here.
|
||||||
### Container Configuration
|
### Container Configuration
|
||||||
|
|
||||||
- `Auth Key`: The key you received from tailscale in prerequisites above
|
- `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). However may need to be _unchecked_ if you need give Tailscale full access to all the features inside scale (not just GUI/SMB, but Rsync, ping 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. 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/).
|
||||||
- `Accept DNS`: Enabling it will pass your Global Nameservers from Tailscale to your local install.
|
- `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.
|
- `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.
|
||||||
- `Extra Args` passes arguments/flags to the `tailscale up` command.
|
- `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 (see image below). (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`)
|
- `Advertise as exit node` This is used to pass traffic through tailscale like a private VPN. (Passes `--advertise-exit-node` to `Extra args`)
|
||||||
|
@ -59,13 +65,6 @@ TODO: Update image with the new fields
|
||||||
|
|
||||||
The default ports are fine for this chart, you shouldn't need to port forward or open ports on your router.
|
The default ports are fine for this chart, you shouldn't need to port forward or open ports on your router.
|
||||||
|
|
||||||
:::caution
|
|
||||||
|
|
||||||
In case you want to access their SMB shares or TrueNAS GUI via Tailscale.
|
|
||||||
You will have to ensure that `Host Networking` is enabled and `Userspace` is disabled.
|
|
||||||
|
|
||||||
:::
|
|
||||||
|
|
||||||
![tailscale-step-4](img/How-To-Image-3.png)
|
![tailscale-step-4](img/How-To-Image-3.png)
|
||||||
|
|
||||||
### Storage and Persistence
|
### Storage and Persistence
|
||||||
|
|
Loading…
Reference in New Issue