docs: add custom fields

This commit is contained in:
nrbffs 2019-11-17 10:55:39 +01:00 committed by genofire
parent 9a70560cfb
commit 39e8f37eaa
1 changed files with 24 additions and 0 deletions

View File

@ -18,6 +18,12 @@ collect_interval = "1m"
#[respondd.sites.example] #[respondd.sites.example]
#domains = ["city"] #domains = ["city"]
#[[respondd.custom_field]]
#name = zip
# You can use arbitrary GJSON expressions here, see https://github.com/tidwall/gjson
# We expect this expression to return a string.
#path = nodeinfo.location.zip
[[respondd.interfaces]] [[respondd.interfaces]]
ifname = "br-ffhb" ifname = "br-ffhb"
#ip_address = "fe80::..." #ip_address = "fe80::..."
@ -148,6 +154,24 @@ port = 10001
``` ```
{% endmethod %} {% endmethod %}
### [[respondd.custom_fields]]
{% method %}
If you have custom respondd fields, you can ask Yanic to also collect these.
NOTE: This does not automatically include these fields in the output.
The meshviewer-ffrgb output module will include them under "custom_fields",
but other modules may simply ignore them.
{% sample lang="toml" %}
```toml
name = zip
# You can use arbitrary GJSON expressions here, see https://github.com/tidwall/gjson
# We expect this expression to return a string.
path = nodeinfo.location.zip
```
{% endmethod %}
## [webserver] ## [webserver]
{% method %} {% method %}