Diff

mod_muc_defaults/README.md @ 6003:fe081789f7b5

All community modules: Unify file extention of Markdown files to .md
author Menel <menel@snikket.de>
date Tue, 22 Oct 2024 10:26:01 +0200
parent 5563:a1f8cc591b66
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_muc_defaults/README.md	Tue Oct 22 10:26:01 2024 +0200
@@ -0,0 +1,39 @@
+# mod_muc_defaults
+
+Creates MUCs with default configuration settings upon Prosody startup.
+
+## Configuration
+
+Under your MUC component, add a `default_mucs` option with the relevant settings.
+
+```
+Component "conference.example.org" "muc"
+   modules_enabled = {
+            "muc_defaults";
+   }
+
+   default_mucs = {
+      {
+         jid_node = "trollbox",
+         affiliations = {
+                  admin = { "admin@example.org", "superuser@example.org" },
+                  owner = { "owner@example.org" },
+                  visitors = { "visitor@example.org" }
+         },
+         config = {
+                  name = "General Chat",
+                  description = "Public chatroom with no particular topic",
+                  allow_member_invites = false,
+                  change_subject = false,
+                  history_length = 40,
+                  lang = "en",
+                  logging = true,
+                  members_only = false,
+                  moderated = false,
+                  persistent = true,
+                  public = true,
+                  public_jids = true
+         }
+      }
+   };
+```