From 39e8f37eaab68fc1510edefcd6d6016de4e1f45b Mon Sep 17 00:00:00 2001
From: nrbffs <38812627+nrbffs@users.noreply.github.com>
Date: Sun, 17 Nov 2019 10:55:39 +0100
Subject: [PATCH] docs: add custom fields

---
 docs/docs_configuration.md | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)

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 %}