diff --git a/charts/stable/zerotier/Chart.yaml b/charts/stable/zerotier/Chart.yaml index 521bae8c580..c0f253e3b94 100644 --- a/charts/stable/zerotier/Chart.yaml +++ b/charts/stable/zerotier/Chart.yaml @@ -1,7 +1,7 @@ apiVersion: v2 kubeVersion: ">=1.16.0-0" name: zerotier -version: 2.0.30 +version: 2.0.31 appVersion: "1.10.1" description: ZeroTier is a smart programmable Ethernet switch for planet Earth type: application @@ -18,7 +18,6 @@ dependencies: - name: common repository: https://library-charts.truecharts.org version: 10.5.6 - # condition: maintainers: - email: info@truecharts.org name: TrueCharts diff --git a/charts/stable/zerotier/docs/How-To-Guide.md b/charts/stable/zerotier/docs/How-To-Guide.md new file mode 100644 index 00000000000..3c55e4ee16f --- /dev/null +++ b/charts/stable/zerotier/docs/How-To-Guide.md @@ -0,0 +1,62 @@ +# How-To + +This is a quick how-to or setup-guide to use Zerotier using on your TrueNAS box. +This can be applied to other systems but this specific guide is SCALE specific with the prerequisites. + +## Requirements + +- Zerotier Account (Free accounts available at [Zerotier's Official website](https://www.zerotier.com)) +- Zerotier Truecharts Chart + +## 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 Zerotier Network ID for your setup, easy to create and copy at [https://my.zerotier.com](https://my.zerotier.com) + +![Zerotier Network ID](img/Network-ID.png) + +## Zerotier Chart Setup + +Ideally name your chart `Zerotier` but you can use any name here and leave defaults for Step 2 + +- Extra Args: + +If you wish to automatically join a specific Zerotier Network upon startup simply enter the `Network-ID` in this space. +**Note** This is not required for the chart to run but is **highly recommended**. + +![How-To-Step-1](img/How-To-Step-1.png) + +- Container Configuration: + + - `ZEROTIER_API_SECRET`: Replaces the authtoken.secret before booting and allows you to manage the control socket's authentication key + - `ZEROTIER_IDENTITY_PUBLIC`: The identity.public file for zerotier-one. Use zerotier-idtool to generate one of these for you. + - `ZEROTIER_IDENTITY_SECRET`: The identity.secret file for zerotier-one. Use zerotier-idtool to generate one of these for you. + + ![How-To-Step-2](img/How-To-Step-2.png) + +Networking and Services: + +- 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 Zerotier. + In order to do so you will have to ensure the screen is setup as below and enable `Host-Networking`. + +![Zerotier Host Networking](img/How-To-Step-3.png) + +## 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/zerotier/docs/img/How-To-Step-1.png b/charts/stable/zerotier/docs/img/How-To-Step-1.png new file mode 100644 index 00000000000..c2b49c582b8 Binary files /dev/null and b/charts/stable/zerotier/docs/img/How-To-Step-1.png differ diff --git a/charts/stable/zerotier/docs/img/How-To-Step-2.png b/charts/stable/zerotier/docs/img/How-To-Step-2.png new file mode 100644 index 00000000000..3fdde9765e9 Binary files /dev/null and b/charts/stable/zerotier/docs/img/How-To-Step-2.png differ diff --git a/charts/stable/zerotier/docs/img/How-To-Step-3.png b/charts/stable/zerotier/docs/img/How-To-Step-3.png new file mode 100644 index 00000000000..25c3d4f11f7 Binary files /dev/null and b/charts/stable/zerotier/docs/img/How-To-Step-3.png differ diff --git a/charts/stable/zerotier/docs/img/Network-ID.png b/charts/stable/zerotier/docs/img/Network-ID.png new file mode 100644 index 00000000000..b14bd4b17b3 Binary files /dev/null and b/charts/stable/zerotier/docs/img/Network-ID.png differ diff --git a/charts/stable/zerotier/docs/img/Sysctl.png b/charts/stable/zerotier/docs/img/Sysctl.png new file mode 100644 index 00000000000..3e04a3cf992 Binary files /dev/null and b/charts/stable/zerotier/docs/img/Sysctl.png differ diff --git a/cspell.config.yaml b/cspell.config.yaml index ddcae2496fd..6108ec53765 100644 --- a/cspell.config.yaml +++ b/cspell.config.yaml @@ -9,6 +9,7 @@ words: - Authentik - Authexample - authkey + - authtoken - autoconnect - AUTOSYNC - backupname @@ -49,6 +50,7 @@ words: - hyperconverged - hyperthread - iban + - idtool - ingressclasses - ingressroutes - ingressroutetcps @@ -186,4 +188,5 @@ words: - wger - whisparr - xsystems + - ZEROTIER - zwavejs