mirror of
https://github.com/librenms/librenms.git
synced 2024-10-07 16:52:45 +00:00
1ee2e8e0e0
* Updated to use new theme for docs site * Updated theme location * Removed librenms.css * Updated index page + re-added librenms.css * Use built in theme modification * flexbox grid, dump bootstrap * tidy up things * Added path and updated deploy script + mkdocs config * Removed db schmea changes * Updated to install python/pip 3 * Removed pip3 install * Pip3 install * Updated deploy-docs * Updated deploy-docs
53 lines
1.6 KiB
Markdown
53 lines
1.6 KiB
Markdown
source: Developing/Dynamic-Config.md
|
|
path: blob/master/doc/
|
|
# Adding new config options to WebUI
|
|
|
|
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.
|
|
|
|
#### Update DB
|
|
|
|
Firstly you will need to add the config option to the database. Here's an example:
|
|
|
|
```sql
|
|
insert into config (config_name,config_value,config_default,config_descr,config_group,config_group_order,config_sub_group,config_sub_group_order,config_hidden,config_disabled) values ('alert.tolerance_window','','','Tolerance window in seconds','alerting',0,'general',0,'0','0');
|
|
```
|
|
|
|
This will determine the default config option for `$config['alert']['tolerance_window']`.
|
|
|
|
#### Update WebUI
|
|
|
|
If the sub-section you want to add the new config option already exists then update the relevant file within
|
|
`html/pages/settings/` otherwise you will need to create the new sub-section page. Here's an example of this:
|
|
|
|
[Commit example](https://github.com/librenms/librenms/commit/c5998f9ee27acdac0c0f7d3092fc830c51ff684c)
|
|
|
|
```php
|
|
<?php
|
|
|
|
$no_refresh = true;
|
|
|
|
$config_groups = get_config_by_group('alerting');
|
|
|
|
$mail_conf = array(
|
|
array('name' => 'alert.tolerance_window',
|
|
'descr' => 'Tolerance window for cron',
|
|
'type' => 'text',
|
|
),
|
|
);
|
|
|
|
echo '
|
|
<div class="panel-group" id="accordion">
|
|
<form class="form-horizontal" role="form" action="" method="post">
|
|
';
|
|
|
|
echo generate_dynamic_config_panel('Email transport',$config_groups,$mail_conf,'mail');
|
|
|
|
echo '
|
|
</form>
|
|
</div>
|
|
';
|
|
```
|
|
|
|
And that should be it!
|