summaryrefslogtreecommitdiffstats
path: root/collectors/python.d.plugin/ipfs/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'collectors/python.d.plugin/ipfs/README.md')
-rw-r--r--collectors/python.d.plugin/ipfs/README.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/collectors/python.d.plugin/ipfs/README.md b/collectors/python.d.plugin/ipfs/README.md
new file mode 100644
index 000000000..a30649a5f
--- /dev/null
+++ b/collectors/python.d.plugin/ipfs/README.md
@@ -0,0 +1,25 @@
+# ipfs
+
+Module monitors [IPFS](https://ipfs.io) basic information.
+
+1. **Bandwidth** in kbits/s
+ * in
+ * out
+
+2. **Peers**
+ * peers
+
+### configuration
+
+Only url to IPFS server is needed.
+
+Sample:
+
+```yaml
+localhost:
+ name : 'local'
+ url : 'http://localhost:5001'
+```
+
+---
+