feat(Zerotier): Add How-To guide (#3698)

* feat(Zerotier): Add How-To guide

* lint

* few visual changes

Co-authored-by: Stavros kois <s.kois@outlook.com>

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

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

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