Skip to content

Latest commit

 

History

History
95 lines (56 loc) · 5.29 KB

configuring-playbook-bridge-mautrix-telegram.md

File metadata and controls

95 lines (56 loc) · 5.29 KB

Setting up Mautrix Telegram bridging (optional)

Refer the common guide for configuring mautrix bridges: Setting up a Generic Mautrix Bridge

The playbook can install and configure mautrix-telegram for you.

See the project's documentation to learn what it does and why it might be useful to you.

Prerequisites

Obtain a Telegram API key

To use the bridge, you'd need to obtain an API key from https://my.telegram.org/apps.

Enable Appservice Double Puppet or Shared Secret Auth (optional)

If you want to set up Double Puppeting (hint: you most likely do) for this bridge automatically, you need to have enabled Appservice Double Puppet or Shared Secret Auth service for this playbook.

See this section on the common guide for configuring mautrix bridges for details about setting up Double Puppeting.

Notes:

  • Double puppeting with the Shared Secret Auth works at the time of writing, but is deprecated and will stop working in the future.

  • If you decided to enable Double Puppeting manually, send login-matrix to the bot in order to receive an instruction about how to send an access token to it.

Adjusting the playbook configuration

To enable the bridge, add the following configuration to your inventory/host_vars/matrix.example.com/vars.yml file. Make sure to replace YOUR_TELEGRAM_APP_ID and YOUR_TELEGRAM_API_HASH.

matrix_mautrix_telegram_enabled: true
matrix_mautrix_telegram_api_id: YOUR_TELEGRAM_APP_ID
matrix_mautrix_telegram_api_hash: YOUR_TELEGRAM_API_HASH

Relaying

Enable relay-bot (optional)

If you want to use the relay-bot feature (relay bot documentation), which allows anonymous user to chat with telegram users, add the following configuration to your vars.yml file:

matrix_mautrix_telegram_bot_token: YOUR_TELEGRAM_BOT_TOKEN
matrix_mautrix_telegram_configuration_extension_yaml: |
  bridge:
    permissions:
      '*': relaybot

Configure a user as an administrator of the bridge (optional)

You might also want to give permissions to a user to administrate the bot. See this section on the common guide for details about it.

More details about permissions in this example: https://github.com/mautrix/telegram/blob/master/mautrix_telegram/example-config.yaml#L410

Use the bridge for direct chats only (optional)

If you want to exclude all groups from syncing and use the Telegram-Bridge only for direct chats, add the following configuration to your vars.yml file:

matrix_mautrix_telegram_filter_mode: whitelist

Extending the configuration

There are some additional things you may wish to configure about the bridge.

See this section on the common guide for configuring mautrix bridges for details about variables that you can customize and the bridge's default configuration, including bridge permissions, encryption support, bot's username, etc.

Installing

After configuring the playbook, run it with playbook tags as below:

ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start

Notes:

  • The ensure-matrix-users-created playbook tag makes the playbook automatically create the bot's user account.

  • The shortcut commands with the just program are also available: just install-all or just setup-all

    just install-all is useful for maintaining your setup quickly (2x-5x faster than just setup-all) when its components remain unchanged. If you adjust your vars.yml to remove other components, you'd need to run just setup-all, or these components will still remain installed.

Usage

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.

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.