Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>pull/3914/head
| @@ -34,7 +34,8 @@ matrix_mautrix_discord_enabled: true | |||||
| There are some additional things you may wish to configure about the bridge. | There are some additional things you may wish to configure about the bridge. | ||||
| See [this section](configuring-playbook-bridge-mautrix-bridges.md#extending-the-configuration) on the [common guide for configuring mautrix bridges](configuring-playbook-bridge-mautrix-bridges.md) for details about variables that you can customize and the bridge's default configuration, including [bridge permissions](configuring-playbook-bridge-mautrix-bridges.md#configure-bridge-permissions-optional), [encryption support](configuring-playbook-bridge-mautrix-bridges.md#enable-encryption-optional), [relay mode](configuring-playbook-bridge-mautrix-bridges.md#enable-relay-mode-optional), [bot's username](configuring-playbook-bridge-mautrix-bridges.md#setting-the-bot-s-username-optional), etc. | |||||
| <!-- NOTE: common relay mode is not supported for this bridge --> | |||||
| See [this section](configuring-playbook-bridge-mautrix-bridges.md#extending-the-configuration) on the [common guide for configuring mautrix bridges](configuring-playbook-bridge-mautrix-bridges.md) for details about variables that you can customize and the bridge's default configuration, including [bridge permissions](configuring-playbook-bridge-mautrix-bridges.md#configure-bridge-permissions-optional), [encryption support](configuring-playbook-bridge-mautrix-bridges.md#enable-encryption-optional), [bot's username](configuring-playbook-bridge-mautrix-bridges.md#setting-the-bot-s-username-optional), etc. | |||||
| ## Installing | ## Installing | ||||
| @@ -79,3 +80,7 @@ To acquire the token, open Discord in a private browser window. Then open the de | |||||
| - send `guilds status` to see the list of guilds | - send `guilds status` to see the list of guilds | ||||
| - for each guild that you'd like bridged, send `guilds bridge GUILD_ID --entire` | - for each guild that you'd like bridged, send `guilds bridge GUILD_ID --entire` | ||||
| 8. You may wish to uninstall the Discord app from your phone now. It's not needed for the bridge to function. | 8. You may wish to uninstall the Discord app from your phone now. It's not needed for the bridge to function. | ||||
| ### Relaying | |||||
| The bridge supports using Discord's webhook feature to relay messages from Matrix users who haven't logged into the bridge. See [the official documentation](https://docs.mau.fi/bridges/go/discord/relay.html#setup) for setting up webhook relaying. | |||||
| @@ -24,7 +24,8 @@ matrix_mautrix_gmessages_enabled: true | |||||
| There are some additional things you may wish to configure about the bridge. | There are some additional things you may wish to configure about the bridge. | ||||
| See [this section](configuring-playbook-bridge-mautrix-bridges.md#extending-the-configuration) on the [common guide for configuring mautrix bridges](configuring-playbook-bridge-mautrix-bridges.md) for details about variables that you can customize and the bridge's default configuration, including [bridge permissions](configuring-playbook-bridge-mautrix-bridges.md#configure-bridge-permissions-optional), [encryption support](configuring-playbook-bridge-mautrix-bridges.md#enable-encryption-optional), [relay mode](configuring-playbook-bridge-mautrix-bridges.md#enable-relay-mode-optional), [bot's username](configuring-playbook-bridge-mautrix-bridges.md#setting-the-bot-s-username-optional), etc. | |||||
| <!-- NOTE: relay mode is not supported for this bridge --> | |||||
| See [this section](configuring-playbook-bridge-mautrix-bridges.md#extending-the-configuration) on the [common guide for configuring mautrix bridges](configuring-playbook-bridge-mautrix-bridges.md) for details about variables that you can customize and the bridge's default configuration, including [bridge permissions](configuring-playbook-bridge-mautrix-bridges.md#configure-bridge-permissions-optional), [encryption support](configuring-playbook-bridge-mautrix-bridges.md#enable-encryption-optional), [bot's username](configuring-playbook-bridge-mautrix-bridges.md#setting-the-bot-s-username-optional), etc. | |||||
| ## Installing | ## Installing | ||||
| @@ -26,7 +26,8 @@ matrix_mautrix_googlechat_enabled: true | |||||
| There are some additional things you may wish to configure about the bridge. | There are some additional things you may wish to configure about the bridge. | ||||
| See [this section](configuring-playbook-bridge-mautrix-bridges.md#extending-the-configuration) on the [common guide for configuring mautrix bridges](configuring-playbook-bridge-mautrix-bridges.md) for details about variables that you can customize and the bridge's default configuration, including [bridge permissions](configuring-playbook-bridge-mautrix-bridges.md#configure-bridge-permissions-optional), [encryption support](configuring-playbook-bridge-mautrix-bridges.md#enable-encryption-optional), [relay mode](configuring-playbook-bridge-mautrix-bridges.md#enable-relay-mode-optional), [bot's username](configuring-playbook-bridge-mautrix-bridges.md#setting-the-bot-s-username-optional), etc. | |||||
| <!-- NOTE: relay mode is not supported for this bridge --> | |||||
| See [this section](configuring-playbook-bridge-mautrix-bridges.md#extending-the-configuration) on the [common guide for configuring mautrix bridges](configuring-playbook-bridge-mautrix-bridges.md) for details about variables that you can customize and the bridge's default configuration, including [bridge permissions](configuring-playbook-bridge-mautrix-bridges.md#configure-bridge-permissions-optional), [encryption support](configuring-playbook-bridge-mautrix-bridges.md#enable-encryption-optional), [bot's username](configuring-playbook-bridge-mautrix-bridges.md#setting-the-bot-s-username-optional), etc. | |||||
| ## Installing | ## Installing | ||||
| @@ -34,7 +34,8 @@ matrix_mautrix_slack_enabled: true | |||||
| There are some additional things you may wish to configure about the bridge. | There are some additional things you may wish to configure about the bridge. | ||||
| See [this section](configuring-playbook-bridge-mautrix-bridges.md#extending-the-configuration) on the [common guide for configuring mautrix bridges](configuring-playbook-bridge-mautrix-bridges.md) for details about variables that you can customize and the bridge's default configuration, including [bridge permissions](configuring-playbook-bridge-mautrix-bridges.md#configure-bridge-permissions-optional), [encryption support](configuring-playbook-bridge-mautrix-bridges.md#enable-encryption-optional), [relay mode](configuring-playbook-bridge-mautrix-bridges.md#enable-relay-mode-optional), [bot's username](configuring-playbook-bridge-mautrix-bridges.md#setting-the-bot-s-username-optional), etc. | |||||
| <!-- NOTE: relay mode is not supported for this bridge --> | |||||
| See [this section](configuring-playbook-bridge-mautrix-bridges.md#extending-the-configuration) on the [common guide for configuring mautrix bridges](configuring-playbook-bridge-mautrix-bridges.md) for details about variables that you can customize and the bridge's default configuration, including [bridge permissions](configuring-playbook-bridge-mautrix-bridges.md#configure-bridge-permissions-optional), [encryption support](configuring-playbook-bridge-mautrix-bridges.md#enable-encryption-optional), [bot's username](configuring-playbook-bridge-mautrix-bridges.md#setting-the-bot-s-username-optional), etc. | |||||
| ## Installing | ## Installing | ||||
| @@ -32,11 +32,35 @@ matrix_mautrix_telegram_api_id: YOUR_TELEGRAM_APP_ID | |||||
| matrix_mautrix_telegram_api_hash: YOUR_TELEGRAM_API_HASH | matrix_mautrix_telegram_api_hash: YOUR_TELEGRAM_API_HASH | ||||
| ``` | ``` | ||||
| ### Relaying | |||||
| If you want to use the relay-bot feature ([relay bot documentation](https://docs.mau.fi/bridges/python/telegram/relay-bot.html)), which allows anonymous user to chat with telegram users, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file: | |||||
| ```yaml | |||||
| matrix_mautrix_telegram_bot_token: YOUR_TELEGRAM_BOT_TOKEN | |||||
| matrix_mautrix_telegram_configuration_extension_yaml: | | |||||
| bridge: | |||||
| permissions: | |||||
| '*': relaybot | |||||
| ``` | |||||
| You might also want to give permissions to administrate the bot: | |||||
| ```yaml | |||||
| matrix_mautrix_telegram_configuration_extension_yaml: | | |||||
| bridge: | |||||
| permissions: | |||||
| '@alice:{{ matrix_domain }}': admin | |||||
| ``` | |||||
| More details about permissions in this example: https://github.com/mautrix/telegram/blob/master/mautrix_telegram/example-config.yaml#L410 | |||||
| ### Extending the configuration | ### Extending the configuration | ||||
| There are some additional things you may wish to configure about the bridge. | There are some additional things you may wish to configure about the bridge. | ||||
| See [this section](configuring-playbook-bridge-mautrix-bridges.md#extending-the-configuration) on the [common guide for configuring mautrix bridges](configuring-playbook-bridge-mautrix-bridges.md) for details about variables that you can customize and the bridge's default configuration, including [bridge permissions](configuring-playbook-bridge-mautrix-bridges.md#configure-bridge-permissions-optional), [encryption support](configuring-playbook-bridge-mautrix-bridges.md#enable-encryption-optional), [relay mode](configuring-playbook-bridge-mautrix-bridges.md#enable-relay-mode-optional), [bot's username](configuring-playbook-bridge-mautrix-bridges.md#setting-the-bot-s-username-optional), etc. | |||||
| <!-- NOTE: common relay mode is not supported for this bridge --> | |||||
| See [this section](configuring-playbook-bridge-mautrix-bridges.md#extending-the-configuration) on the [common guide for configuring mautrix bridges](configuring-playbook-bridge-mautrix-bridges.md) for details about variables that you can customize and the bridge's default configuration, including [bridge permissions](configuring-playbook-bridge-mautrix-bridges.md#configure-bridge-permissions-optional), [encryption support](configuring-playbook-bridge-mautrix-bridges.md#enable-encryption-optional), [bot's username](configuring-playbook-bridge-mautrix-bridges.md#setting-the-bot-s-username-optional), etc. | |||||
| ## Installing | ## Installing | ||||
| @@ -59,27 +83,6 @@ 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). | ||||
| If you want to use the relay-bot feature ([relay bot documentation](https://docs.mau.fi/bridges/python/telegram/relay-bot.html)), which allows anonymous user to chat with telegram users, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file: | |||||
| ```yaml | |||||
| matrix_mautrix_telegram_bot_token: YOUR_TELEGRAM_BOT_TOKEN | |||||
| matrix_mautrix_telegram_configuration_extension_yaml: | | |||||
| bridge: | |||||
| permissions: | |||||
| '*': relaybot | |||||
| ``` | |||||
| You might also want to give permissions to administrate the bot: | |||||
| ```yaml | |||||
| matrix_mautrix_telegram_configuration_extension_yaml: | | |||||
| bridge: | |||||
| permissions: | |||||
| '@alice:{{ matrix_domain }}': admin | |||||
| ``` | |||||
| More details about permissions in this example: https://github.com/mautrix/telegram/blob/master/mautrix_telegram/example-config.yaml#L410 | |||||
| If you like to exclude all groups from syncing and use the Telgeram-Bridge only for direct chats, you can add the following additional playbook configuration: | If you like to exclude all groups from syncing and use the Telgeram-Bridge only for direct chats, you can add the following additional playbook configuration: | ||||
| ```yaml | ```yaml | ||||
| @@ -26,7 +26,8 @@ matrix_mautrix_twitter_enabled: true | |||||
| There are some additional things you may wish to configure about the bridge. | There are some additional things you may wish to configure about the bridge. | ||||
| See [this section](configuring-playbook-bridge-mautrix-bridges.md#extending-the-configuration) on the [common guide for configuring mautrix bridges](configuring-playbook-bridge-mautrix-bridges.md) for details about variables that you can customize and the bridge's default configuration, including [bridge permissions](configuring-playbook-bridge-mautrix-bridges.md#configure-bridge-permissions-optional), [encryption support](configuring-playbook-bridge-mautrix-bridges.md#enable-encryption-optional), [relay mode](configuring-playbook-bridge-mautrix-bridges.md#enable-relay-mode-optional), [bot's username](configuring-playbook-bridge-mautrix-bridges.md#setting-the-bot-s-username-optional), etc. | |||||
| <!-- NOTE: relay mode is not supported for this bridge --> | |||||
| See [this section](configuring-playbook-bridge-mautrix-bridges.md#extending-the-configuration) on the [common guide for configuring mautrix bridges](configuring-playbook-bridge-mautrix-bridges.md) for details about variables that you can customize and the bridge's default configuration, including [bridge permissions](configuring-playbook-bridge-mautrix-bridges.md#configure-bridge-permissions-optional), [encryption support](configuring-playbook-bridge-mautrix-bridges.md#enable-encryption-optional), [bot's username](configuring-playbook-bridge-mautrix-bridges.md#setting-the-bot-s-username-optional), etc. | |||||
| ## Installing | ## Installing | ||||