Apparently ensure-matrix-users-created is relevant only for components registered to "matrix_user_creator_users_auto" on group_vars/matrix_servers. Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2.3 KiB
Setting up MX Puppet Steam bridging (optional)
The playbook can install and configure mx-puppet-steam for you.
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 Steam bridge, add the following configuration to your inventory/host_vars/matrix.example.com/vars.yml
file:
matrix_mx_puppet_steam_enabled: true
Installing
After configuring the playbook, run it 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
To use the bridge, you need to start a chat with Steam Puppet Bridge
with the handle @_steampuppet_bot:example.com
(where example.com
is your base domain, not the matrix.
domain).
Three authentication methods are available, Legacy Token, OAuth and xoxc token. See mx-puppet-steam documentation for more information about how to configure the bridge.
Once logged in, send list
to the bot user to list the available rooms.
Clicking rooms in the list will result in you receiving an invitation to the bridged room.
Send help
to the bot to see the available commands.