aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDaniel Schadt <kingdread@gmx.de>2020-06-08 16:19:45 +0200
committerDaniel Schadt <kingdread@gmx.de>2020-06-08 16:19:45 +0200
commit0922d9fe9a439b3451d0f5de86499c10bff17cb5 (patch)
tree404f22f252b2a4e8824e46176df0eed704f6dcd8
parentf33195967f0d483e4006441fb68a5fbd26d87f66 (diff)
downloadezau-0922d9fe9a439b3451d0f5de86499c10bff17cb5.tar.gz
ezau-0922d9fe9a439b3451d0f5de86499c10bff17cb5.tar.bz2
ezau-0922d9fe9a439b3451d0f5de86499c10bff17cb5.zip
add sample configuration as separate file
-rw-r--r--README.md2
-rw-r--r--ezau-sample.toml21
2 files changed, 22 insertions, 1 deletions
diff --git a/README.md b/README.md
index 8a48ef2..7d6d1cc 100644
--- a/README.md
+++ b/README.md
@@ -37,7 +37,7 @@ Configuration
By default, `ezau` looks for `ezau.toml` in the current directory.
You can use `-c` to specify a different configuration file.
-A full example configuration is provided here:
+A full example configuration is provided here or alternatively as `ezau-sample.toml`:
```toml
# Whether logs should be uploaded.
diff --git a/ezau-sample.toml b/ezau-sample.toml
new file mode 100644
index 0000000..a18d6ad
--- /dev/null
+++ b/ezau-sample.toml
@@ -0,0 +1,21 @@
+# Whether logs should be uploaded.
+# If this is false, ezau will only zip new logs and do no further processing.
+# (mandatory)
+upload = false
+
+# Whether logs with an unknown boss should be uploaded.
+# By default, ezau only uploads logs with bosses known to evtclib.
+# (optional)
+upload_unknown = false
+
+# Discord messaging section.
+# If this section is missing, ezau will not do Discord notifications for log uploads.
+# Mandatory keys in this section are only mandatory if the section is present, as the whole Discord functionality is optional.
+# (optional)
+[discord]
+# Auth token for a bot account.
+# (mandatory)
+auth_token = "foobar"
+# Channel ID of the channel to which the message should be posted.
+# (mandatory)
+channel_id = 123