mirror of
https://github.com/librenms/librenms.git
synced 2024-10-07 16:52:45 +00:00
Tony MurrayandGitHub
699aa8a042
* initial db/defaults dump * numeric values * Remove $config['time'] * Use config_definitions.json * try setting definition as a complete array * a little more * fix format * WIP converting dynamic setting pages * rewriting the webui * remove legacy and add translations * finish email section * improve navigation update js a bit * Import the remaining existing settings * Update backend still some wip migration * fix config loading (db not overriding defaults) * some cleanup * more array collapsing * update settings * Settings search * add purge settings to ui, order groups and sections * collapse more arrays * Auth definitions WIP * remove needless slash escapes * add warning to json * moving settings from defaults.inc * remove slow_statistics * Move rrdtool settings to the poller section * Use translations more consistently * removing more settings from defaults.inc.php * show setting name in tooltip * allow help text to be shown on mobile * disable settings that are set in config.php * Implement undo and reset to default. * Vue.js functional * Vue.js WIP * Implement tabs component * accordion WIP * lodash ver update * two items * Accordion somewhat working * hash navigation * Refine Accordion * Fix up tab styling a bit * Cleaner tab selected property Hide html while loading * spinner? * Icon support property for accordion to active * WIP * Tabs/Sections from ajax * Setting Component skeletons * Dynamic Component resolution * Basic functionality * toggle class * Refactor components * translate tabs and accordions * simple array attempt * improve readonly tooltip * array styling * array value editing * organize snmp info * Handle initial tab/section in url * Use Laravel to parse tab/section, dump old * Draggable array entries * v-tooltip, for clickable (and touch) help tooltips disable draggable * Navigation WIP * Navigation WIP * groups computed * filter settings * fix event reference * vue.js i18n initial * missing description = just setting name * en fallback * tidy up the language support and js generation * persist value to db * fix issue with 0 * Delete settings from DB instead of setting them to default * ldap-groups fixup style * Default dashboard selection * fix array of options instead of object * allow custom validation for settings * translate options in SettingSelect * SNMP v3 WIP * fix setting arrays * Split persist out of set * Hook up events for SNMP v3 Auth correct Config::persist behaviour with arrays * dependent settings (primitive for now) actually update the settings values in the LibrenmsSettings component * more complex "when" behaviour * remove un-needed seeder * add poller_modules.cisco-qfp * remove en.json (disable warning) * don't set default for log_dir or log_file, otherwise it won't be processed correctly * Fix module order add some missing settings * more config corrections * correct graphs correct loading values set to null (although it should have no difference) remove project_name_version * Add nfsen settings. Docs are very confusing, so might have flubbed something remove option for array definition of select option as numeric indexes messes it up * Correct more upstream config differences * Config cleanup after a bunch of merges. * Fixes * add version tags to js/css files remove old js * Print out full settings list read-only * Add http_proxy setting fix indents in config_definitions.json * repeaters default is 0 (aka 20) * cleanups * rewrite the dynamic config docs * add language docs * Don't show snmp v3 auth add/remove if disabled by config.php
95 lines
3.2 KiB
Markdown
95 lines
3.2 KiB
Markdown
source: Developing/Dynamic-Config.md
|
|
path: blob/master/doc/
|
|
|
|
# Adding new config settings
|
|
|
|
Adding support for users to update a new config option via the WebUI
|
|
is now a lot easier for general options. This document shows you how
|
|
to add a new config option and even section to the WebUI.
|
|
|
|
Config settings are defined in `misc/config_definitions.json`
|
|
|
|
You should give a little thought to the name of your config setting.
|
|
For example: a good setting for snmp community, would be `snmp.community`.
|
|
The dot notation is path and when the config is hydrated, it is converted to a nested array.
|
|
If the user is overriding the option in config.php it would use the format `$config['snmp']['community']`
|
|
|
|
## Translation
|
|
|
|
The config definition system inherently supports translation. You must add the English names in the
|
|
`resoures/lang/en/settings.php` file (and other languages if you can).
|
|
|
|
Note: Right now the Vue.js translation is a little cumbersome. First you need to update the language
|
|
files, then run `./lnms vue-i18n:generate`, run `npm run development` or `npm run watch`, then hard refresh your web
|
|
page.
|
|
|
|
# Definition Format
|
|
|
|
For snmp.community, this is the definition:
|
|
|
|
```json
|
|
"snmp.community": {
|
|
"group": "poller",
|
|
"section": "snmp",
|
|
"order": 2,
|
|
"type": "array",
|
|
"default": [
|
|
"public"
|
|
]
|
|
}
|
|
```
|
|
|
|
## Fields
|
|
|
|
All fields are optional. To show in the web ui, group and section are required, order is recommended.
|
|
|
|
* `type`: Defines the type, there are a few predefined types and custom
|
|
types can be defined and implemented in a vue.js component
|
|
* `default`: the default value for this setting
|
|
* `options`: the options for the select type. An object with {"value1": "display string", "value2": "display string"}
|
|
* `validate`: Defines more complex validation than the default simple type check. Uses Laravel validation syntax.
|
|
* `group`: The web ui tab this is under
|
|
* `section`: A panel grouping settings in the web ui
|
|
* `order`: The order to display this setting within the section
|
|
|
|
## Predefined Types
|
|
|
|
* `string`: A string
|
|
* `integer`: A number
|
|
* `boolean`: A simple toggle switch
|
|
* `array`: A list of values that can be added, removed, and re-ordered.
|
|
* `select`: A dropdown box with predefined options. Requires the option field.
|
|
* `email`: Will validate the input is the correct format for an email
|
|
* `password`: Will mask the value of the input (but does not keep it fully private)
|
|
|
|
# Custom Types
|
|
|
|
You may set the type field to a custom type and define a Vue.js component to display it to the user.
|
|
|
|
The Vue.js component should be named as "SettingType" where type is the custom type entered with the first
|
|
letter capitalized. Vue.js components exist in the `resources/js/components` directory.
|
|
|
|
Here is an empty component named SettingType (make sure to rename it). It pulls in BaseSetting mixin for
|
|
basic setting code to reuse. You should review the BaseSetting component.
|
|
|
|
```vue
|
|
<template>
|
|
<div></div>
|
|
</template>
|
|
|
|
<script>
|
|
import BaseSetting from "./BaseSetting";
|
|
|
|
export default {
|
|
name: "SettingType",
|
|
mixins: [BaseSetting]
|
|
}
|
|
</script>
|
|
|
|
<style scoped>
|
|
|
|
</style>
|
|
```
|
|
|
|
Using Vue.js is beyond the scope of this document. Documentation can be found at [https://vuejs.org/v2/guide/].
|