From 9c3fdd14f0d3f4d041266c7bedc4dbd787591339 Mon Sep 17 00:00:00 2001 From: Boemeltrein <130394941+Boemeltrein@users.noreply.github.com> Date: Sun, 2 Mar 2025 10:21:10 +0100 Subject: [PATCH] docs(meshcentral): helmify docs (#32756) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit **Description** ⚒️ 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 - [x] 📜 Documentation Changes **🧪 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 - [x] 📄 I have made changes to the documentation - [ ] 🧪 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 - [x] I made sure the title starts with `feat(chart-name):`, `fix(chart-name):`, `chore(chart-name):`, `docs(chart-name):` or `fix(docs):` **➕ App addition** If this PR is an app addition please make sure you have done the following. - [ ] 🖼️ 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._ --- .../docs/installation-instructions.md | 81 +------------------ 1 file changed, 3 insertions(+), 78 deletions(-) diff --git a/charts/stable/meshcentral/docs/installation-instructions.md b/charts/stable/meshcentral/docs/installation-instructions.md index 380c34438eb..483d89cf4c9 100644 --- a/charts/stable/meshcentral/docs/installation-instructions.md +++ b/charts/stable/meshcentral/docs/installation-instructions.md @@ -8,88 +8,13 @@ Ingress for this chart is **required** ::: -In both Native Helm and TrueNAS Scale, keys that start with `_` are **unset**. +## Unset Keys -## Configuration - -### TrueNAS Scale - -In order to be able to expose some options in the GUI, -but also give users the option to users to **unset** those values, -instead of using our defaults. We decided to do the following. - -We will **unset** every option (key) that has: - -- Stings: Empty (`"`) value. -- Arrays: Empty (`[]`) arrays. -- Int: Value of `-99`. - (That's because both `0` and `-1` is valid values on some options - and empty int are not possible (at least now) in TrueNAS Scale GUI) - -The above will only be applied when installed in TrueNAS Scale as an App - -:::note - -When you make a change in the UI, you need to manually stop and re-start the app -for the change to take effect. - -::: - -For SCALE users, you can add additional configuration options that are not exposed in the UI -by using the `Additional MeshCentral Configuration` section. - -:::tip - -However, if you think an option would be used by a lot of users, it would be best to ask us to expose it. - -::: - -For example to set this: - -```json -"settings": { - "sms": { - "provider": "twillio" - } -} -``` - -Set like this: - -- Key: `settigns.sms.provider` -- Value: `twillio` - -For lists: - -```json -"domains": { - "": { - "newAccoutnsRights": [ - "item1", - "item2" - ] - } -} -``` - -Set like this: - -- Key: `domains."".newAccountsRights` -- Value: `[ "item1", "item2" ]` - -:::caution - -Please use the exact casing as in the [MeshCentral's json schema](https://github.com/Ylianst/MeshCentral/blob/master/meshcentral-config-schema.json). - -::: - -### Native Helm - -Native Helm users won't be affected with the above. +Keys that start with `_` are **unset**. ## Hardcoded values -We hardcoded some values, so the chart/app can work correctly based on how it's written. +We hardcoded some values, so the chart can work correctly based on how it's written. Those values are: ```json