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>
This commit is contained in:
co-authored by
Stavros Kois
parent
6d816fd44d
commit
937ff0f8b5
@@ -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/r/tailscale/tailscale
|
- https://hub.docker.com/r/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: 1.0.0
|
version: 1.0.1
|
||||||
annotations:
|
annotations:
|
||||||
truecharts.org/catagories: |
|
truecharts.org/catagories: |
|
||||||
- network
|
- network
|
||||||
|
|||||||
@@ -5,12 +5,14 @@ This can be applied to other systems but this specific guide is SCALE specific w
|
|||||||
|
|
||||||
## Requirements
|
## Requirements
|
||||||
|
|
||||||
- Tailscale Account (Free accounts available at https://www.tailscale.com)
|
- Tailscale Account (Free accounts available at [Tailscale's Official website](https://www.tailscale.com))
|
||||||
- Tailscale Truecharts Chart
|
- Tailscale Truecharts Chart
|
||||||
|
|
||||||
## Prerequisites
|
## 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` then `Advanced`. On that screen you add the following two values:
|
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.ip_forward`
|
||||||
- `net.ipv4.conf.all.src_valid_mark`
|
- `net.ipv4.conf.all.src_valid_mark`
|
||||||
@@ -29,14 +31,27 @@ Step 1-2: Ideally use `tailscale` but you can use any name here and leave defaul
|
|||||||
|
|
||||||
Step 3:
|
Step 3:
|
||||||
|
|
||||||
- Enter `Auth Key` you received from tailscale in prerequistes above
|
- Enter `Auth Key` you received from tailscale in prerequisites above
|
||||||
- Keep `Userspace` checked (default) unless you wish to create your own Wireguard tunnels,
|
- 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
|
- 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
|
- 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. The most common one is `--advertise-exit-node` to pass traffic through tailscale like a private VPN. For more Extra Args please check the [Tailscale Knowledge Base](https://tailscale.com/kb/1080/cli/#up)
|
- `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](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
|
||||||
|

|
||||||
|
|
||||||
Step 4:
|
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.
|
- 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.
|
||||||
|
|||||||
Binary file not shown.
|
After Width: | Height: | Size: 281 KiB |
Reference in New Issue
Block a user