diff --git a/docs/docs_configuration.md b/docs/docs_configuration.md index aedb41d..04490c6 100644 --- a/docs/docs_configuration.md +++ b/docs/docs_configuration.md @@ -18,6 +18,12 @@ collect_interval = "1m" #[respondd.sites.example] #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]] ifname = "br-ffhb" #ip_address = "fe80::..." @@ -148,6 +154,24 @@ port = 10001 ``` {% 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] {% method %}