From 1e545b34ac7e6f0b80ea4202aa02b1a4bd344cc1 Mon Sep 17 00:00:00 2001
From: Giovanni Harting <539@idlegandalf.com>
Date: Tue, 5 Jul 2022 12:29:45 +0200
Subject: [PATCH] added doc to config

---
 config.yaml        | 12 ------------
 config_sample.yaml | 20 ++++++++++++++++++++
 2 files changed, 20 insertions(+), 12 deletions(-)
 delete mode 100644 config.yaml
 create mode 100644 config_sample.yaml

diff --git a/config.yaml b/config.yaml
deleted file mode 100644
index 60b9f84..0000000
--- a/config.yaml
+++ /dev/null
@@ -1,12 +0,0 @@
-bandwidth:
-  min: 2
-  max: 45
-  step: 1
-interval: 30
-host: "itsh.dev"
-ppp: 5
-conformation_ppp: 30
-log_level: DEBUG
-upload_interface: "enp1s0f1"
-throttle_ping_threshold: 50
-try_restoring_after: 30
\ No newline at end of file
diff --git a/config_sample.yaml b/config_sample.yaml
new file mode 100644
index 0000000..abeccf7
--- /dev/null
+++ b/config_sample.yaml
@@ -0,0 +1,20 @@
+log_level: DEBUG
+# bandwidth limits in MBit
+bandwidth:
+  min: 2
+  max: 45
+  step: 1
+# interval in seconds to check ping
+interval: 30
+# host to ping to
+host: "google.com"
+# packages per ping (short)
+ppp: 5
+# packages per ping (long)
+conformation_ppp: 30
+# interface to change qdisc on
+upload_interface: "enp1s0f1"
+# ping threshold (anything above this causes throttling)
+throttle_ping_threshold: 50
+# minutes delay from an above-threshold moment to try increasing bandwidth again
+try_restoring_after: 30
\ No newline at end of file