Преглед изворни кода

Update docs for mautrix bridges: add descriptions for each mautrix bridge about the bridges behavior after logging in

Based on d33701428d

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
pull/3924/head
Suguru Hirahara пре 1 година
родитељ
комит
b7faae939b
No known key found for this signature in database GPG Key ID: E4F9743DAB4B7B75
10 измењених фајлова са 20 додато и 2 уклоњено
  1. +1
    -1
      docs/configuring-playbook-bridge-mautrix-discord.md
  2. +2
    -0
      docs/configuring-playbook-bridge-mautrix-gmessages.md
  3. +2
    -0
      docs/configuring-playbook-bridge-mautrix-googlechat.md
  4. +2
    -0
      docs/configuring-playbook-bridge-mautrix-meta-instagram.md
  5. +2
    -0
      docs/configuring-playbook-bridge-mautrix-meta-messenger.md
  6. +4
    -0
      docs/configuring-playbook-bridge-mautrix-signal.md
  7. +1
    -1
      docs/configuring-playbook-bridge-mautrix-slack.md
  8. +2
    -0
      docs/configuring-playbook-bridge-mautrix-telegram.md
  9. +2
    -0
      docs/configuring-playbook-bridge-mautrix-twitter.md
  10. +2
    -0
      docs/configuring-playbook-bridge-mautrix-whatsapp.md

+ 1
- 1
docs/configuring-playbook-bridge-mautrix-discord.md Прегледај датотеку

@@ -62,7 +62,7 @@ To use the bridge, you need to start a chat with `@discordbot:example.com` (wher


You can then follow instructions on the bridge's [official documentation on Authentication](https://docs.mau.fi/bridges/go/discord/authentication.html). You can then follow instructions on the bridge's [official documentation on Authentication](https://docs.mau.fi/bridges/go/discord/authentication.html).


After successfully logged in, direct messages from Discord should start syncing automatically.
After logging in, the bridge will create portal rooms for some recent direct messages.


Send `help` to the bot to see the available commands. Send `help` to the bot to see the available commands.




+ 2
- 0
docs/configuring-playbook-bridge-mautrix-gmessages.md Прегледај датотеку

@@ -51,3 +51,5 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-use
To use the bridge, you need to start a chat with `@gmessagesbot:example.com` (where `example.com` is your base domain, not the `matrix.` domain). To use the bridge, you need to start a chat with `@gmessagesbot:example.com` (where `example.com` is your base domain, not the `matrix.` domain).


You can then follow instructions on the bridge's [official documentation on Authentication](https://docs.mau.fi/bridges/go/gmessages/authentication.html). You can then follow instructions on the bridge's [official documentation on Authentication](https://docs.mau.fi/bridges/go/gmessages/authentication.html).

After logging in, the bridge will create portal rooms for recent chats.

+ 2
- 0
docs/configuring-playbook-bridge-mautrix-googlechat.md Прегледај датотеку

@@ -53,3 +53,5 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-use
To use the bridge, you need to start a chat with `@googlechatbot:example.com` (where `example.com` is your base domain, not the `matrix.` domain). To use the bridge, you need to start a chat with `@googlechatbot:example.com` (where `example.com` is your base domain, not the `matrix.` domain).


You can then follow instructions on the bridge's [official documentation on Authentication](https://docs.mau.fi/bridges/python/googlechat/authentication.html). You can then follow instructions on the bridge's [official documentation on Authentication](https://docs.mau.fi/bridges/python/googlechat/authentication.html).

After logging in, the bridge will create portal rooms for some recent chats. Portal rooms for other chats will be created as you receive messages.

+ 2
- 0
docs/configuring-playbook-bridge-mautrix-meta-instagram.md Прегледај датотеку

@@ -67,3 +67,5 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-use
To use the bridge, you need to start a chat with `@instagrambot:example.com` (where `example.com` is your base domain, not the `matrix.` domain). To use the bridge, you need to start a chat with `@instagrambot:example.com` (where `example.com` is your base domain, not the `matrix.` domain).


You can then follow instructions on the bridge's [official documentation on Authentication](https://docs.mau.fi/bridges/go/meta/authentication.html). You can then follow instructions on the bridge's [official documentation on Authentication](https://docs.mau.fi/bridges/go/meta/authentication.html).

After logging in, the bridge will sync recent chats.

+ 2
- 0
docs/configuring-playbook-bridge-mautrix-meta-messenger.md Прегледај датотеку

@@ -81,4 +81,6 @@ To use the bridge, you need to start a chat with `@messengerbot:example.com` (wh


You can then follow instructions on the bridge's [official documentation on Authentication](https://docs.mau.fi/bridges/go/meta/authentication.html). You can then follow instructions on the bridge's [official documentation on Authentication](https://docs.mau.fi/bridges/go/meta/authentication.html).


After logging in, the bridge will sync recent chats.

**Note**: given that the bot is configured in `messenger` [bridge mode](#bridge-mode) by default, you will need to log in to [messenger.com](https://messenger.com/) (not `facebook.com`!) and obtain the cookies from there. **Note**: given that the bot is configured in `messenger` [bridge mode](#bridge-mode) by default, you will need to log in to [messenger.com](https://messenger.com/) (not `facebook.com`!) and obtain the cookies from there.

+ 4
- 0
docs/configuring-playbook-bridge-mautrix-signal.md Прегледај датотеку

@@ -56,3 +56,7 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-use
To use the bridge, you need to start a chat with `@signalbot:example.com` (where `example.com` is your base domain, not the `matrix.` domain). To use the bridge, you need to start a chat with `@signalbot:example.com` (where `example.com` is your base domain, not the `matrix.` domain).


You can then follow instructions on the bridge's [official documentation on Authentication](https://docs.mau.fi/bridges/go/signal/authentication.html). You can then follow instructions on the bridge's [official documentation on Authentication](https://docs.mau.fi/bridges/go/signal/authentication.html).

After logging in, the bridge will bridge chats as you receive messages.

**Note**: Signal does not support any kind of message history (even on official apps), so the bridge won't backfill any messages.

+ 1
- 1
docs/configuring-playbook-bridge-mautrix-slack.md Прегледај датотеку

@@ -62,6 +62,6 @@ To use the bridge, you need to start a chat with `@slackbot:example.com` (where


You can then follow instructions on the bridge's [official documentation on Authentication](https://docs.mau.fi/bridges/go/slack/authentication.html). You can then follow instructions on the bridge's [official documentation on Authentication](https://docs.mau.fi/bridges/go/slack/authentication.html).


If you authenticated using a token, the recent chats will be bridged automatically (depending on the `conversation_count` setting). Otherwise (i.e. with App login), the chats the bot is in will be bridged automatically.
If you authenticated using a token, the recent chats will be bridged automatically (depending on the `conversation_count` setting). Otherwise (i.e. logging with the Discord application), the chats the bot is in will be bridged automatically.


Send `help` to the bot to see the available commands. Send `help` to the bot to see the available commands.

+ 2
- 0
docs/configuring-playbook-bridge-mautrix-telegram.md Прегледај датотеку

@@ -91,3 +91,5 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-use
To use the bridge, you need to start a chat with `@telegrambot:example.com` (where `example.com` is your base domain, not the `matrix.` domain). To use the bridge, you need to start a chat with `@telegrambot:example.com` (where `example.com` is your base domain, not the `matrix.` domain).


You can then follow instructions on the bridge's [official documentation on Authentication](https://docs.mau.fi/bridges/python/telegram/authentication.html). You can then follow instructions on the bridge's [official documentation on Authentication](https://docs.mau.fi/bridges/python/telegram/authentication.html).

After logging in, the bridge will create portal rooms for all of your Telegram groups and invite you to them. Note that the bridge won't automatically create rooms for private chats.

+ 2
- 0
docs/configuring-playbook-bridge-mautrix-twitter.md Прегледај датотеку

@@ -53,3 +53,5 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-use
To use the bridge, you need to start a chat with `@twitterbot:example.com` (where `example.com` is your base domain, not the `matrix.` domain). To use the bridge, you need to start a chat with `@twitterbot:example.com` (where `example.com` is your base domain, not the `matrix.` domain).


You can then follow instructions on the bridge's [official documentation on Authentication](https://docs.mau.fi/bridges/go/twitter/authentication.html). You can then follow instructions on the bridge's [official documentation on Authentication](https://docs.mau.fi/bridges/go/twitter/authentication.html).

After logging in, the bridge will create portal rooms for some recent chats. Portal rooms for other chats will be created as you receive messages.

+ 2
- 0
docs/configuring-playbook-bridge-mautrix-whatsapp.md Прегледај датотеку

@@ -54,3 +54,5 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-use
To use the bridge, you need to start a chat with `@whatsappbot:example.com` (where `example.com` is your base domain, not the `matrix.` domain). To use the bridge, you need to start a chat with `@whatsappbot:example.com` (where `example.com` is your base domain, not the `matrix.` domain).


You can learn more here about authentication from the bridge's [official documentation on Authentication](https://docs.mau.fi/bridges/go/whatsapp/authentication.html). You can learn more here about authentication from the bridge's [official documentation on Authentication](https://docs.mau.fi/bridges/go/whatsapp/authentication.html).

Approximately in a minute after logging in, the bridge will create portal rooms for recent chats.

Loading…
Откажи
Сачувај