finallycoffee/matrix-docker-ansible-deploy
5
1
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Annotate certain features as optional/advanced

Browse Source 
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)".
This commit is contained in:
Slavi Pantaleev
2018-11-26 07:23:42 +02:00
parent 529b5b222d
commit 733b806833
9 changed files with 24 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
docs/configuring-playbook-bridge-mautrix-telegram.md
View File

@ -1,11 +1,12 @@
# Setting up Mautrix Telegram
# 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