summaryrefslogtreecommitdiffstats
path: root/remote/lib/README.txt
diff options
context:
space:
mode:
Diffstat (limited to 'remote/lib/README.txt')
-rw-r--r--remote/lib/README.txt21
1 files changed, 21 insertions, 0 deletions
diff --git a/remote/lib/README.txt b/remote/lib/README.txt
new file mode 100644
index 0000000..f023131
--- /dev/null
+++ b/remote/lib/README.txt
@@ -0,0 +1,21 @@
+conky format
+============
+ - Server status
+ * ping works
+ * no output from 'check_server_status.sh' and additional listed checks
+ [*] Checks for additional listed services 'check_<service>_status.sh'.
+ - The optional status is in the beginning of first line (0 - red, 1 - green, 2 - yellow). Otherwise, 'red' if any output (also if first word is non-number on the first string).
+ - If first line starts from the status, the rest of the line is considered a header and reported on the status line. Everything else goes to textual section bellow.
+ [headers]
+
+ ... Textual information reported by 'check_server_status.sh' and check_*_status.sh scripts. The format
+ server:port[:service] text....
+
+ - Extra info for DarkSoft servers
+ * VPN to the server is working (checked with the ping). This not included in the scripted version, instead server traffic reported directly here.
+ # # Traffic on VPN interface from/to
+
+ - Server traffic
+ in/out/forw. Yellow/Red if above specified threshold. No additional errors are reported here.
+
+ \ No newline at end of file