Setting up WeChat bridging (optional)

The playbook can install and configure matrix-wechat for you, for bridging to WeChat.

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

Adjusting the playbook configuration

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

matrix_wechat_enabled: true

After configuring the playbook, run it with playbook tags as below:

ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start

Notes:

The ensure-matrix-users-created playbook tag makes the playbook automatically create the bot’s user account.
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.

To use the bridge, you need to start a chat with @wechatbot:example.com (where example.com is your base domain, not the matrix. domain).

Send help to the bot to see the available commands.