document config

1 files changed, 25 insertions, 14 deletions

diff --git a/sample-config.toml b/sample-config.toml
index efca391..360e902 100644
--- a/sample-config.toml
+++ b/sample-config.toml
@@ -1,20 +1,31 @@
-domain = "http://localhost:8080"
-dbPath = "bub.db"
+# Communique Config file
 
-[[handlers]]
-name = "sample"
-exec = "sample-cgi-handler.sh"
-summary = "sample bot"
-interval = "1h"
-dedupWindow = "5h"
+# domain to use for URL generation
+# *must* match incoming Host: header or else HTTP signatures will fail verification
+domain = "http://localhost:8080"                   # required
 
-# [[handlers]]
-# name = "autosport"
-# exec = "autosport-handler.sh"
-# interval = "10m"
-# dedupWindow = "900h"
+# path to database directory
+dbPath = "communique.db"                           # required
+
+# each handler has its own [[handlers]] block
+[[handlers]]
+# name of the actor for this handler
+# *must* be only A-Za-z0-9, no special characters or spaces allowed
+name = "sample"                                    # required
+# path to CGI script
+exec = "sample-cgi-handler.sh"                     # required
+# how often to execute CGI script
+interval = "5s"                                    # required
+# actor bio
+summary = "sample bot"                             # optional
+# deduplication window, 0 by default, which is NO deduplication
+dedupWindow = "30s"                                # optional
+# avatar url                     
+avatarUrl = "https://loremflickr.com/320/240/dog"  # optional
+# expected content type of avatar url
+avatarContentType = "image/jpeg"                   # required (if using avatarUrl)
 
 # [[handlers]]
 # name = "another"
 # exec = "another-cgi-handler.sh"
-# intervalSeconds = "10"
+# interval = "10"