summaryrefslogtreecommitdiffstats
path: root/collectors/python.d.plugin/tor/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'collectors/python.d.plugin/tor/README.md')
-rw-r--r--collectors/python.d.plugin/tor/README.md24
1 files changed, 19 insertions, 5 deletions
diff --git a/collectors/python.d.plugin/tor/README.md b/collectors/python.d.plugin/tor/README.md
index 40905a958..192a86a37 100644
--- a/collectors/python.d.plugin/tor/README.md
+++ b/collectors/python.d.plugin/tor/README.md
@@ -1,8 +1,14 @@
-# tor
+<!--
+title: "Tor monitoring with Netdata"
+custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/tor/README.md
+sidebar_label: "Tor"
+-->
-Module connects to tor control port to collect traffic statistics.
+# Tor monitoring with Netdata
-**Requirements:**
+Connects to the Tor control port to collect traffic statistics.
+
+## Requirements
- `tor` program
- `stem` python package
@@ -14,9 +20,17 @@ It produces only one chart:
- read
- write
-## configuration
+## Configuration
+
+Edit the `python.d/tor.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/tor.conf
+```
-Needs only `control_port`
+Needs only `control_port`.
Here is an example for local server: