summaryrefslogtreecommitdiffstats
path: root/collectors/python.d.plugin/energid/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'collectors/python.d.plugin/energid/README.md')
-rw-r--r--collectors/python.d.plugin/energid/README.md22
1 files changed, 18 insertions, 4 deletions
diff --git a/collectors/python.d.plugin/energid/README.md b/collectors/python.d.plugin/energid/README.md
index fc5101590..60c829fed 100644
--- a/collectors/python.d.plugin/energid/README.md
+++ b/collectors/python.d.plugin/energid/README.md
@@ -1,9 +1,15 @@
-# energid
+<!--
+title: "Energi Core node monitoring with Netdata"
+custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/energid/README.md
+sidebar_label: "Energi Core"
+-->
-A collector for [Energi Core](https://github.com/energicryptocurrency/energi)
-node instance monitoring.
+# Energi Core node monitoring with Netdata
-As Energi Core Gen 1 & 2 are based on the original Bitcoin code and
+Monitors blockchain, memory, network and unspent transactions statistics.
+
+
+As [Energi Core](https://github.com/energicryptocurrency/energi) Gen 1 & 2 are based on the original Bitcoin code and
supports very similar JSON RPC, there is quite high chance the module works
with many others forks including bitcoind itself.
@@ -42,6 +48,14 @@ long daemon startup.
## Configuration
+Edit the `python.d/energid.conf` configuration file using `edit-config` from the Netdata [config
+directory](/docs/configure/nodes.md), which is typically at `/etc/netdata`.
+
+```bash
+cd /etc/netdata # Replace this path with your Netdata config directory, if different
+sudo ./edit-config python.d/energid.conf
+```
+
Sample:
```yaml