aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md32
1 files changed, 32 insertions, 0 deletions
diff --git a/README.md b/README.md
index 0ea9f73..ae80f4a 100644
--- a/README.md
+++ b/README.md
@@ -75,6 +75,7 @@ It is good idea to obtain Telegram API ID from [**https://my.telegram.org**](htt
* `--profiling-port=xxxx`: start the pprof server on port `xxxx`. Access is limited to localhost.
* `--config=/bla/bla/config.yml`: set the config file path (default: `config.yml`).
* `--schema=/bla/bla/schema.json`: set the schema file path (default: `./config_schema.json`).
+* `--ids=/bla/bla/ids`: set the folder for ids database (default: `ids`).
### How to receive files from Telegram ###
@@ -142,3 +143,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";
+ },
+ }
+```