matrix-docker-ansible-deploy/docs/configuring-playbook-bridge-mautrix-telegram.md

# Setting up Mautrix Telegram (optional)

The playbook can install and configure [mautrix-telegram](https://github.com/tulir/mautrix-telegram) for you.

See the project's [documentation](https://github.com/tulir/mautrix-telegram/wiki#usage) to learn what it does and why it might be useful to you.

You'll need to obtain API keys from `https://my.telegram.org/apps` and then use the following playbook configuration:

```yaml
matrix_mautrix_telegram_enabled: true
matrix_mautrix_telegram_api_id: YOUR_TELEGRAM_APP_ID
matrix_mautrix_telegram_api_hash: YOUR_TELEGRAM_API_HASH
```

You then need to start a chat with `@telegrambot:YOUR_DOMAIN` (where `YOUR_DOMAIN` is your base domain, not the `matrix.` domain).

If you want to use the relay-bot feature ([relay bot documentation](https://github.com/tulir/mautrix-telegram/wiki/Relay-bot)), which allows anonymous user to chat with telegram users, use the following additional playbook configuration:

```yaml
matrix_mautrix_telegram_bot_token: YOUT_TELEGRAM_BOT_TOKEN
```
Annotate certain features as optional/advanced We've had some people get confused into installing Matrix Corporal and having pain with that. With this documentation change, we try to make it clearer that it's an advanced feature not to be touched unless you know what you're doing. On a similar note, we also make sure other things are properly labeled as "(optional)" and/or "(advanced)". 2018-11-26 05:23:42 +00:00			`# Setting up Mautrix Telegram (optional)`
Add small doc on Mautrix Telegram 2018-09-02 14:14:14 +00:00
			`The playbook can install and configure [mautrix-telegram](https://github.com/tulir/mautrix-telegram) for you.`

Add documentation and fix templates 2018-10-24 16:12:24 +00:00			`See the project's [documentation](https://github.com/tulir/mautrix-telegram/wiki#usage) to learn what it does and why it might be useful to you.`
Mautrix telegram minimum config variable requirement 2018-09-03 08:27:26 +00:00
			You'll need to obtain API keys from `https://my.telegram.org/apps` and then use the following playbook configuration:
Annotate certain features as optional/advanced We've had some people get confused into installing Matrix Corporal and having pain with that. With this documentation change, we try to make it clearer that it's an advanced feature not to be touched unless you know what you're doing. On a similar note, we also make sure other things are properly labeled as "(optional)" and/or "(advanced)". 2018-11-26 05:23:42 +00:00
			```yaml
Mautrix telegram minimum config variable requirement 2018-09-03 08:27:26 +00:00			`matrix_mautrix_telegram_enabled: true`
			`matrix_mautrix_telegram_api_id: YOUR_TELEGRAM_APP_ID`
			`matrix_mautrix_telegram_api_hash: YOUR_TELEGRAM_API_HASH`
			```
Add documentation and fix templates 2018-10-24 16:12:24 +00:00
Rename some variables 2019-02-28 09:51:09 +00:00			You then need to start a chat with `@telegrambot:YOUR_DOMAIN` (where `YOUR_DOMAIN` is your base domain, not the `matrix.` domain).
added documentation for telegram relay bot feature 2019-11-30 07:36:53 +00:00
fixed typo 2019-12-02 07:50:26 +00:00			`If you want to use the relay-bot feature ([relay bot documentation](https://github.com/tulir/mautrix-telegram/wiki/Relay-bot)), which allows anonymous user to chat with telegram users, use the following additional playbook configuration:`
added documentation for telegram relay bot feature 2019-11-30 07:36:53 +00:00
			```yaml
			`matrix_mautrix_telegram_bot_token: YOUT_TELEGRAM_BOT_TOKEN`
			```