improve example configs

christiankiller · Sep 27, 2020 · 2a925ec · 2a925ec
1 parent 31124ce
commit 2a925ec
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 1 deletion.
diff --git a/nzyme-tracker.conf.example b/nzyme-tracker.conf.example
@@ -1,3 +1,6 @@
+# Configuration reference: https://go.nzyme.org/configuration-reference
+# More details about bandits and trackers: https://go.nzyme.org/bandits-and-trackers
+
 # General nzyme configuration.
 general: {
   role: TRACKER

diff --git a/nzyme.conf.example b/nzyme.conf.example
@@ -1,3 +1,5 @@
+# Configuration reference: https://go.nzyme.org/configuration-reference
+
 # General nzyme configuration.
 general: {
   role: LEADER
@@ -84,6 +86,7 @@ graylog_uplinks: []
 # 802.11/Wifi adapters that are designated to read traffic.
 # The more monitors you have listening on different channels, the more traffic will be picked up and the more
 # traffic will be available as the basis for alerts and analysis.
+# See: https://go.nzyme.org/network-monitoring
 802_11_monitors: [
   {
     # The 802.11/WiFi adapter name. (from `ifconfig` or `ip link`)
@@ -139,5 +142,6 @@ graylog_uplinks: []
 802_11_traps: []
 
 # Optional: A tracker device to track down physical location of bandits. Please read more in the documentation.
-# Please consult the nzyme documentation to find out supported tracker devices. TODO ADD DOCS LINK
+# Please consult the nzyme documentation to find out supported tracker devices.
+# See: https://go.nzyme.org/bandits-and-trackers
 tracker_device {}