summaryrefslogtreecommitdiffstats
path: root/conf.d/node.d/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'conf.d/node.d/README.md')
-rw-r--r--conf.d/node.d/README.md7
1 files changed, 7 insertions, 0 deletions
diff --git a/conf.d/node.d/README.md b/conf.d/node.d/README.md
new file mode 100644
index 000000000..45e3d02a6
--- /dev/null
+++ b/conf.d/node.d/README.md
@@ -0,0 +1,7 @@
+`node.d.plugin` modules accept configuration in JSON format.
+
+Unfortunately, JSON files do not accept comments. So, the best way to describe them is to have markdown text files with instructions.
+
+JSON has a very strict formatting. If you get errors from netdata at `/var/log/netdata/error.log` that a certain configuration file cannot be loaded, we suggest to verify it at [http://jsonlint.com/](http://jsonlint.com/).
+
+The files in this directory, provide usable examples for configuring each `node.d.plugin` module.