4.2 KiB
Setting up Mautrix wsproxy for bridging Android SMS or Apple iMessage (optional)
Refer the common guide for configuring mautrix bridges: Setting up a Generic Mautrix Bridge
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.
Adjusting DNS records
By default, this playbook installs wsproxy on the wsproxy. subdomain (wsproxy.example.com) and requires you to create a CNAME record for wsproxy, which targets matrix.example.com.
When setting, replace example.com with your own.
Adjusting the playbook configuration
To enable the bridge, add the following configuration to your inventory/host_vars/matrix.example.com/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.
Adjusting the wsproxy URL (optional)
By tweaking the matrix_mautrix_wsproxy_hostname variable, you can easily make the service available at a different hostname than the default one.
Example additional configuration for your vars.yml file:
# Change the default hostname
matrix_mautrix_wsproxy_hostname: ws.example.com
After changing the domain, you may need to adjust your DNS records to point the wsproxy domain to the Matrix server.
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, relay mode, bot’s username, etc.
Installing
After configuring the playbook and potentially adjusting your DNS records, run the playbook with playbook tags as below:
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start
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. Note these shortcuts run the ensure-matrix-users-created tag too.
Usage
Follow the mautrix-imessage documentation for running android-sms and/or matrix-imessage on your device(s).
Troubleshooting
As with all other services, you can find the logs in systemd-journald by logging in to the server with SSH and running journalctl -fu matrix-mautrix-wsproxy.