Heavy improvements. Version 1.2

base-config.yaml

@@ -2,8 +2,11 @@
 # DO NOT CHANGE THIS UNLESS YOU KNOW WHAT YOU ARE DOING
 command_prefix: report
 
-# Which regions the bot should pay attention to
-# Additionally, optionally whitelist specific accounts for each region
+# Which regions the bot should pay attention to.
+# Pass through empty list to allow all senders for a region.
+# Add a list of MatrixIDs to whitelist senders for a region.
+# Use __global__ to refer to all regions.
+# Code looks to see if a sender is allowed for either a specific region or __global__.
 allowed_regions:
     foo:
         - "@reports:fiftyfiftyonerarizona.org"
@@ -14,6 +17,9 @@ allowed_regions:
     aaa:
 
 # Bot-specific configurations per region
+# Code will assume no authentication if either username or password are missing.
+# Use __global__ to specify an endpoint for all regions.
+# Code will push to both __global__ and region-specific endpoint.
 region_configs:
     arizona:
         # Where and how the plugin will send the data to
@@ -21,10 +27,11 @@ region_configs:
         server_topic: "changeme"
 
         # If the plugin should use a username and password to send notifications
-        server_use_authentication: true
-        server_username: "no"
-        server_password: "way"
+        username: "no"
+        password: "way"
 
 # If this bot should send a reaction to the message
-# if the notification was successful
+# Will send 👍 on successful POST to NTFY, and 👎 on failiure.
+# Failiure to post to either the region specific, or __global__ endpoint is
+# considered complete failiure.
 send_reaction: true