From eb271cb54b0e77a85bf25f80ec2fe9b7e1ae76ad Mon Sep 17 00:00:00 2001 From: StevenMcElligott <89483932+StevenMcElligott@users.noreply.github.com> Date: Tue, 22 Aug 2023 03:48:04 -0400 Subject: [PATCH] docs(Zerotier): Update docs (#11757) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit **Description** More updates ⚒️ Fixes # **⚙️ Type of change** - [ ] ⚙️ Feature/App addition - [ ] 🪛 Bugfix - [ ] ⚠️ Breaking change (fix or feature that would cause existing functionality to not work as expected) - [ ] 🔃 Refactor of current code **🧪 How Has This Been Tested?** **📃 Notes:** **✔️ Checklist:** - [ ] ⚖️ My code follows the style guidelines of this project - [ ] 👀 I have performed a self-review of my own code - [ ] #️⃣ I have commented my code, particularly in hard-to-understand areas - [ ] 📄 I have made corresponding changes to the documentation - [ ] ⚠️ My changes generate no new warnings - [ ] 🧪 I have added tests to this description that prove my fix is effective or that my feature works - [ ] ⬆️ I increased versions for any altered app according to semantic versioning **➕ App addition** If this PR is an app addition please make sure you have done the following. - [ ] 🪞 I have opened a PR on [truecharts/containers](https://github.com/truecharts/containers) adding the container to TrueCharts mirror repo. - [ ] 🖼️ I have added an icon in the Chart's root directory called `icon.png` --- _Please don't blindly check all the boxes. Read them and only check those that apply. Those checkboxes are there for the reviewer to see what is this all about and the status of this PR with a quick glance._ --- charts/stable/zerotier/docs/How-To-Guide.md | 23 ++++++++++++--------- 1 file changed, 13 insertions(+), 10 deletions(-) diff --git a/charts/stable/zerotier/docs/How-To-Guide.md b/charts/stable/zerotier/docs/How-To-Guide.md index 3c55e4ee16f..a54059699ee 100644 --- a/charts/stable/zerotier/docs/How-To-Guide.md +++ b/charts/stable/zerotier/docs/How-To-Guide.md @@ -29,14 +29,14 @@ Also prepare your Zerotier Network ID for your setup, easy to create and copy at Ideally name your chart `Zerotier` but you can use any name here and leave defaults for Step 2 -- Extra Args: +### Global Pod Options -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**. +This section is hidden by default for TrueNAS SCALE but if you wish to use `Host-Networking` or create an interface inside TrueNAS SCALE (`zerotier creates a network interface`) -![How-To-Step-1](img/How-To-Step-1.png) +- Click `Expert - Pod Options` +- Click the checkbox for `Host-Networking` if it isn't enabled -- Container Configuration: +### App 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. @@ -44,13 +44,16 @@ If you wish to automatically join a specific Zerotier Network upon startup simpl ![How-To-Step-2](img/How-To-Step-2.png) -Networking and Services: +### 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 and may not always work. + +![How-To-Step-1](img/How-To-Step-1.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