python.d/retroshare: add readme (#7849)
Ilya Mashchenko committed
Jan 24, 2020 at 23:34 UTC
6672a3e4ce50c8081feb466ec45670fb61dc276d
1 file changed
+30
collectors/python.d.plugin/retroshare/README.md
+30
@@ -1,3 +1,33 @@
1
# retroshare
2
3
+[RetroShare](https://retroshare.cc/) is a free and open-source peer-to-peer communication and file sharing app based on a friend-to-friend network.
4
+
5
+This module will monitor one or more `RetroShare` applications, depending on your configuration.
6
+
7
+## Charts
8
+
9
+This module produces the following charts:
10
+
11
+- Bandwidth in `kilobits/s`
12
+- Peers in `peers`
13
+- DHT in `peers`
14
+
15
+
16
+## Configuration
17
+
18
+Here is an example for 2 servers:
19
+
20
+```yaml
21
+localhost:
22
+ url : 'http://localhost:9090'
23
+ user : "user"
24
+ password : "pass"
25
+
26
+remote:
27
+ url : 'http://203.0.113.1:9090'
28
+ user : "user"
29
+ password : "pass"
30
+```
31
+---
32
+
33
[](<>)