Matrix/matrix-docker-ansible-deploy
1
0
Fork 0
mirror of https://github.com/spantaleev/matrix-docker-ansible-deploy.git synced 2024-11-14 10:04:46 +08:00
Code Issues Packages Projects Releases Wiki Activity
5268df9a8b
matrix-docker-ansible-deploy/docs/configuring-playbook-bridge-mautrix-wsproxy.md
Suguru Hirahara bf5373479b
Use common expression on documentation regarding playbook configuration 
Overall the playbook uses the expression "Add the following configuration to your `inventory/host_vars/matrix.DOMAIN/vars.yml` file:" with the heading "Adjusting the playbook configuration" for sections to explain what to be added as variables

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-12 20:59:15 +09:00

1.4 KiB
Raw Blame History

Setting up Mautrix wsproxy (optional)

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

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

DNS

You need to create a wsproxy.DOMAIN DNS record pointing to your Matrix server (a CNAME pointing to matrix.DOMAIN) to use wsproxy. The hostname is configurable via a matrix_mautrix_wsproxy_hostname variable.

Adjusting the playbook configuration

To enable the bridge, add the following configuration to your inventory/host_vars/matrix.DOMAIN/vars.yml file:

matrix_mautrix_wsproxy_enabled: true

matrix_mautrix_androidsms_appservice_token: 'secret token from bridge'
matrix_mautrix_androidsms_homeserver_token: 'secret token from bridge'
matrix_mautrix_imessage_appservice_token: 'secret token from bridge'
matrix_mautrix_imessage_homeserver_token: 'secret token from bridge'
matrix_mautrix_wsproxy_syncproxy_shared_secret: 'secret token from bridge'

Note that the tokens must match what is compiled into the mautrix-imessage bridge running on your Mac or Android device.

Usage

Follow the matrix-imessage documenation for running android-sms and/or matrix-imessage on your device(s).