Simulate carbons

1 files changed, 31 insertions, 0 deletions

diff --git a/README.md b/README.md
index 0ea9f73..36aa7ca 100644
--- a/README.md
+++ b/README.md
@@ -142,3 +142,34 @@ server {
 ```
 
 Finally, update `:upload:` in your config.yml to match `server_name` in nginx config.
+
+### Carbons ###
+
+Telegabber needs special privileges according to XEP-0356 to simulate message carbons from the users (to display messages they have sent earlier or via other clients). Example configuration for Prosody:
+
+```
+modules_enabled = {
+        [...]
+
+        "privilege";
+}
+
+[...]
+
+Component "telegabber.yourdomain.tld"
+    component_secret = "yourpassword"
+    modules_enabled = {"privilege"}
+
+[...]
+
+VirtualHost "yourdomain.tld"
+    [...]
+
+    privileged_entities = {
+        [...]
+
+        ["telegabber.yourdomain.tld"] = {
+            message = "outgoing";
+        },
+    }
+```