40813784c1
* Documentation update
* New files for role
* Update existing files to add support for matrix-steam-bridge
* Typos and misc fixes
* Change docker tag to latest until version # is stable
* Align bridge permissions
* Correct user localpart
* Remove trailing +
* Fix syslog identifier
* Actually enable the service correctly
* One more typo fix
* Third time's the charm
* Fix config file paths
* Fix config after bridge repo changes
* Add default appservice public address - set public_media to false by default for testing
* Fix default config for steamkit-service path
* Fix bluesky reference
* Fix default container path
* Fix appservice connection to http for internal, change port to standard 8080
* Fix appservice port
* Enable public_media by default, add labels
* Enable public_media by default, add labels
* Allow bridge to update its own config and generate public_media signing key
* Add deterministic public_media_signing_key, expose portal cleanup
* Change default public_media path to omit `matrix.` from the path as it has been found that URLs generated by the bridge will only match {{ matrix_domain }}
* Remove domain re-write
* Revert "Change default public_media path to omit `matrix.` from the path as it has been found that URLs generated by the bridge will only match {{ matrix_domain }}"
This reverts commit 5f399effb9.
* Fix TLS label if playbook TLS is disabled
* Match default bridge TLS config
* Related to 3daf14d69 and 60ab08014 which enable async media by default for mautrix-go bridges
* Adjust matrix-bridge-steam files to add new line at the end of files
* Pin matrix-bridge-steam (latest -> 1.0.3)
---------
Co-authored-by: Slavi Pantaleev <slavi@devture.com>
2.6 KiB
Setting up MX Puppet Steam bridging (optional, deprecated)
Note: This bridge has been deprecated in favor of the matrix-steam-bridge bridge for Steam, which can be installed using this playbook. Consider using that bridge instead of this one.
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.