summaryrefslogtreecommitdiffstats
path: root/config.yml.example
diff options
context:
space:
mode:
Diffstat (limited to 'config.yml.example')
-rw-r--r--config.yml.example28
1 files changed, 28 insertions, 0 deletions
diff --git a/config.yml.example b/config.yml.example
new file mode 100644
index 0000000..8687db7
--- /dev/null
+++ b/config.yml.example
@@ -0,0 +1,28 @@
+# bot credentials
+login:
+ jid: "james2@example.tld"
+ password: "5up3r 53cr37"
+ nick: "James2"
+
+rooms:
+# "join this room": "redirect to this room"
+ "home@conference.example.tld": "nursing_home@conference.example.tld"
+
+messages:
+ # reply to direct messages
+ # {nick}: bot's nickname
+ direct_msg: "I am {nick} only tasked to redirect people. I am a Bot Ding Ding don't reply."
+
+ # replay to group messages
+ # {user_nick}: joined user's nickname
+ # {new_room}: the configured room the bot points to
+ grp_msg: "{user_nick}, this room is retired please join xmpp:{new_room}?join."
+
+# features -- currently todo and not implemented
+features:
+ # utilize xep 249 direct muc invite
+ direct_invite: false
+
+ # what to do with the user in the retired room
+ #kick_user: false
+ ban_user: false