diff --git a/charts/incubator/tailscale/.helmignore b/charts/stable/tailscale/.helmignore similarity index 100% rename from charts/incubator/tailscale/.helmignore rename to charts/stable/tailscale/.helmignore diff --git a/charts/incubator/tailscale/CHANGELOG.md b/charts/stable/tailscale/CHANGELOG.md similarity index 100% rename from charts/incubator/tailscale/CHANGELOG.md rename to charts/stable/tailscale/CHANGELOG.md diff --git a/charts/incubator/tailscale/Chart.yaml b/charts/stable/tailscale/Chart.yaml similarity index 98% rename from charts/incubator/tailscale/Chart.yaml rename to charts/stable/tailscale/Chart.yaml index 69b23418663..b192c5b443e 100644 --- a/charts/incubator/tailscale/Chart.yaml +++ b/charts/stable/tailscale/Chart.yaml @@ -20,7 +20,7 @@ sources: - https://github.com/truecharts/charts/tree/master/charts/incubator/tailscale - https://hub.docker.com/r/tailscale/tailscale - https://github.com/tailscale/tailscale/blob/main/docs/k8s/run.sh -version: 0.0.9 +version: 1.0.0 annotations: truecharts.org/catagories: | - network diff --git a/charts/incubator/tailscale/README.md b/charts/stable/tailscale/README.md similarity index 100% rename from charts/incubator/tailscale/README.md rename to charts/stable/tailscale/README.md diff --git a/charts/stable/tailscale/docs/How-To-Guide.md b/charts/stable/tailscale/docs/How-To-Guide.md new file mode 100644 index 00000000000..c70c4928d59 --- /dev/null +++ b/charts/stable/tailscale/docs/How-To-Guide.md @@ -0,0 +1,55 @@ +# 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 + +- Tailscale Account (Free accounts available at https://www.tailscale.com) +- Tailscale Truecharts Chart + +## Prerequisites + +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: + +- `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 + +![tailscale-auth-key](img/How-To-Image-1.png) + +## 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 prerequistes 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. 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) + +![tailscale-step-3](img/How-To-Image-2.png) + +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](img/How-To-Image-3.png) + +Steps 5-9: Adjust as necessary but defaults are fine. + +## Support + +- You can also reach us using [Discord](https://discord.gg/tVsPTHWTtr) for real-time feedback and support +- If you found a bug in our chart, open a Github [issue](https://github.com/truecharts/apps/issues/new/choose) + +--- + +All Rights Reserved - The TrueCharts Project diff --git a/charts/stable/tailscale/docs/img/How-To-Image-1.png b/charts/stable/tailscale/docs/img/How-To-Image-1.png new file mode 100644 index 00000000000..912aea380da Binary files /dev/null and b/charts/stable/tailscale/docs/img/How-To-Image-1.png differ diff --git a/charts/stable/tailscale/docs/img/How-To-Image-2.png b/charts/stable/tailscale/docs/img/How-To-Image-2.png new file mode 100644 index 00000000000..113cd140e99 Binary files /dev/null and b/charts/stable/tailscale/docs/img/How-To-Image-2.png differ diff --git a/charts/stable/tailscale/docs/img/How-To-Image-3.png b/charts/stable/tailscale/docs/img/How-To-Image-3.png new file mode 100644 index 00000000000..aa9c893ca03 Binary files /dev/null and b/charts/stable/tailscale/docs/img/How-To-Image-3.png differ diff --git a/charts/stable/tailscale/docs/img/Sysctl.png b/charts/stable/tailscale/docs/img/Sysctl.png new file mode 100644 index 00000000000..3e04a3cf992 Binary files /dev/null and b/charts/stable/tailscale/docs/img/Sysctl.png differ diff --git a/charts/incubator/tailscale/icon.png b/charts/stable/tailscale/icon.png similarity index 100% rename from charts/incubator/tailscale/icon.png rename to charts/stable/tailscale/icon.png diff --git a/charts/incubator/tailscale/questions.yaml b/charts/stable/tailscale/questions.yaml similarity index 98% rename from charts/incubator/tailscale/questions.yaml rename to charts/stable/tailscale/questions.yaml index 0181aacb7ed..0c2805fec42 100644 --- a/charts/incubator/tailscale/questions.yaml +++ b/charts/stable/tailscale/questions.yaml @@ -55,6 +55,7 @@ questions: default: "" - variable: extra_args label: "Extra Args" + description: UP_ARGS or flags to pass along to Tailscale, such as --advertise-exit-node schema: type: string default: "" diff --git a/charts/incubator/tailscale/templates/_configmap.tpl b/charts/stable/tailscale/templates/_configmap.tpl similarity index 100% rename from charts/incubator/tailscale/templates/_configmap.tpl rename to charts/stable/tailscale/templates/_configmap.tpl diff --git a/charts/incubator/tailscale/templates/_secret.tpl b/charts/stable/tailscale/templates/_secret.tpl similarity index 100% rename from charts/incubator/tailscale/templates/_secret.tpl rename to charts/stable/tailscale/templates/_secret.tpl diff --git a/charts/incubator/tailscale/templates/common.yaml b/charts/stable/tailscale/templates/common.yaml similarity index 100% rename from charts/incubator/tailscale/templates/common.yaml rename to charts/stable/tailscale/templates/common.yaml diff --git a/charts/incubator/tailscale/values.yaml b/charts/stable/tailscale/values.yaml similarity index 100% rename from charts/incubator/tailscale/values.yaml rename to charts/stable/tailscale/values.yaml