vh/NetAlertX
1
0
Fork 0
mirror of https://github.com/jokob-sk/NetAlertX.git synced 2025-12-07 01:26:11 -08:00
Code Issues Actions 3 Packages Projects Releases Wiki Activity

docs + template setting override work

Browse Source
This commit is contained in:
Jokob-sk
2023-08-05 15:05:10 +10:00
parent e68a04ee5b
commit 88301c97eb
7 changed files with 119 additions and 34 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/SETTINGS_SYSTEM.md
View File

@@ -22,14 +22,14 @@ The json file is also cached on the client-side local storage of the browser.
#### pialert.conf
> [!INFO]
> [!NOTE]
> This is the source of truth for settings. User-defined values in this files always override default values specified in the Plugin definition.
The App generates two `pialert.conf` entries for every setting (Since version 23.8+). One entry is the setting value, the second is the `__metadata` associated with the setting. This `__metadata` entry contains the full setting definition in JSON format. This should helps the future extensibility of the Settings system.
#### Plugin settings
> [!INFO]
> [!NOTE]
> This is the preferred way adding settings going forward. I'll be likely migrating all app settings into plugin-based settings.
Plugin settings are loaded dynamically from the `config.json` of individual plugins. If a setting isn't defined in the `pialert.conf` file, it is initialized via the `default_value` property of a setting from the `config.json` file. Check the [Plugins documentation](/front/plugins/README.md), section `⚙ Setting object structure` for details on the structure of the setting.