Stavros KoisandGitHub
12b5c56b24
**Description** <!-- Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change. --> ⚒️ Fixes # <!--(issue)--> front matter is supported by all doc sites (including github markdown rendering and is easier to add extra metadata later on, if we want to. ``` --- title: sometitle --- ``` **⚙️ 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?** <!-- Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration --> **📃 Notes:** <!-- Please enter any other relevant information here --> **✔️ 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._
2.3 KiB
title
| title |
|---|
| Installation instructions |
:::warning
Ingress for this chart is required
:::
In both Native Helm and TrueNAS Scale, keys that start with _ are unset.
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 both0and-1is 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:
"settings": {
"sms": {
"provider": "twillio"
}
}
Set like this:
- Key:
settigns.sms.provider - Value:
twillio
For lists:
"domains": {
"": {
"newAccoutnsRights": [
"item1",
"item2"
]
}
}
Set like this:
- Key:
domains."".newAccountsRights - Value:
[ "item1", "item2" ]
::: warning
Please use the exact casing as in the MeshCentral's json schema.
:::
Native Helm
Native Helm users won't be affected with the above.
Hardcoded values
We hardcoded some values, so the chart/app can work correctly based on how it's written. Those values are:
{
"$schema": "http://info.meshcentral.com/downloads/meshcentral-config-schema.json",
"settings": {
"mongoDB": "actual-generated-mongodb-url",
"mongoDbName": "actual-mongodb-name",
"sessionKey": "32char-long-random-generated-key",
"port": "to-the-same-port-as-your-main-service",
"selfUpdate": false,
"cleanNpmCacheOnUpdate": false
},
"domains": {
// This applies to ALL domains
"": {
"myServer": {
"Upgrade": false
}
}
}
}