From c934bedd443fc3de94a17d68312ac4ed10a0ccfe Mon Sep 17 00:00:00 2001
From: Trysdyn Black <trysdyn@voidfox.com>
Date: Sun, 16 Feb 2025 13:44:33 -0800
Subject: [PATCH] Comment config files a bit more

---
 example/ome_management_auth.conf | 2 ++
 example/ome_webhook.conf         | 8 ++++++++
 2 files changed, 10 insertions(+)

diff --git a/example/ome_management_auth.conf b/example/ome_management_auth.conf
index 768e920..ba7ae4c 100644
--- a/example/ome_management_auth.conf
+++ b/example/ome_management_auth.conf
@@ -1,3 +1,5 @@
 [Service]
+# These are the api user and password configured in your OvenMediaEngine
+# Server.xml
 Environment="OVENMONITOR_API_USER=apiuser"
 Environment="OVENMONITOR_API_PASSWORD=apipassword"
diff --git a/example/ome_webhook.conf b/example/ome_webhook.conf
index c87e1ef..3e2e516 100644
--- a/example/ome_webhook.conf
+++ b/example/ome_webhook.conf
@@ -1,7 +1,15 @@
 [Service]
+# These variables are for a Discord webhook, to do stream online/offline
+# announcements.
 Environment="OVENMONITOR_WEBHOOK_URL=FULL WEBHOOK URL"
 Environment="OVENMONITOR_WEBHOOK_ONLINE=TEXT WHEN STREAM GOES ONLINE"
 Environment="OVENMONITOR_WEBHOOK_OFFLINE=TEXT WHEN STREAM GOES OFFLINE"
 Environment="OVENMONITOR_WEBHOOK_NAME=NAME TO ASSIGN TO WEBHOOK BOT"
+
+# These variables attempt to set the webhook bot above to use a specific avatar
+# for each given announcement, based on the stream key that invokes the hook.
+# AVATARPATH will be searched for an image named {app}/{stream}.png and use it.
+# Otherwise it will use default.png.
+# When going offline, offline.png will be used.
 Environment="OVENMONITOR_WEBHOOK_AVATARPATH=/srv/http/example.com/assets/webhook_avatars"
 Environment="OVENMONITOR_WEBHOOK_AVATARURL=https://example.com/assets/webhook_avatars"