pub-solar/matrix-docker-ansible-deploy
5
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

Add documentation and fix templates

Browse source
This commit is contained in:
Hugues Morisset 2018-10-24 18:12:24 +02:00
parent 7a94fc0e24
commit b3fcc641c4
3 changed files with 18 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
docs/configuring-playbook-bridge-mautrix-telegram.md
View file

@ -2,7 +2,7 @@
The playbook can install and configure [mautrix-telegram](https://github.com/tulir/mautrix-telegram) for you.
See that project's [documentation](https://github.com/tulir/mautrix-telegram/wiki#usage) to learn what it does and why it might be useful to 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:
```
@ -10,3 +10,5 @@ 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:{{ hostname_identity }}`

12
docs/configuring-playbook-bridge-mautrix-whatsapp.md Normal file
View file

@ -0,0 +1,12 @@
# Setting up Mautrix Whatsapp
The playbook can install and configure [mautrix-whatsapp](https://github.com/tulir/mautrix-whatsapp) for you.
See the project's [documentation](https://github.com/tulir/mautrix-whatsapp/wiki) to learn what it does and why it might be useful to you.
Use the following playbook configuration:
```
matrix_mautrix_whatsapp_enabled: true
```
You then need to start a chat with `@whatsappbot:{{ hostname_identity }}`

5
roles/matrix-server/templates/mautrix-whatsapp/config.yaml.j2
View file

@ -33,7 +33,7 @@ appservice:
# Display name and avatar for bot. Set to "remove" to remove display name/avatar, leave empty
# to leave display name/avatar as-is.
displayname: WhatsApp bridge bot
avatar: mxc://maunium.net/NeXNQarUbrlYBiPCpprYsRqr
avatar: remove
# Authentication tokens for AS <-> HS communication. Autogenerated; do not modify.
as_token: "This value is generated when generating the registration"
@ -42,6 +42,7 @@ appservice:
# Bridge config. Currently unused.
bridge:
# {% raw %}
# protecting the go templates inside the raw section.
# Localpart template of MXIDs for WhatsApp users.
# {{.}} is replaced with the phone number of the WhatsApp user.
username_template: whatsapp_{{.}}
@ -51,8 +52,8 @@ bridge:
# The following variables are also available, but will cause problems on multi-user instances:
# {{.Name}} - display name from contact list
# {{.Short}} - short display name from contact list
displayname_template: "{{if .Notify}}{{.Notify}}{{else}}{{.Jid}}{{end}} (WA)"
# {% endraw %}
displayname_template: {% raw %}"{{if .Notify}}{{.Notify}}{{else}}{{.Jid}}{{end}} (WA)"{% endraw %}
# The prefix for commands. Only required in non-management rooms.
command_prefix: "!wa"