mirror of
https://github.com/spantaleev/matrix-docker-ansible-deploy.git
synced 2025-10-16 17:29:42 +02:00
Add matrix-steam-bridge (#4572)
* 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 commit5f399effb9
. * Fix TLS label if playbook TLS is disabled * Match default bridge TLS config * Related to3daf14d69
and60ab08014
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>
This commit is contained in:
@@ -141,6 +141,7 @@ Bridges can be used to connect your Matrix installation with third-party communi
|
|||||||
| [mx-puppet-discord](https://gitlab.com/mx-puppet/discord/mx-puppet-discord) | ❌ | Bridge to [Discord](https://discordapp.com/) | [Link](docs/configuring-playbook-bridge-mx-puppet-discord.md) |
|
| [mx-puppet-discord](https://gitlab.com/mx-puppet/discord/mx-puppet-discord) | ❌ | Bridge to [Discord](https://discordapp.com/) | [Link](docs/configuring-playbook-bridge-mx-puppet-discord.md) |
|
||||||
| [mx-puppet-groupme](https://gitlab.com/xangelix-pub/matrix/mx-puppet-groupme) | ❌ | Bridge to [GroupMe](https://groupme.com/) | [Link](docs/configuring-playbook-bridge-mx-puppet-groupme.md) |
|
| [mx-puppet-groupme](https://gitlab.com/xangelix-pub/matrix/mx-puppet-groupme) | ❌ | Bridge to [GroupMe](https://groupme.com/) | [Link](docs/configuring-playbook-bridge-mx-puppet-groupme.md) |
|
||||||
| [mx-puppet-steam](https://github.com/icewind1991/mx-puppet-steam) | ❌ | Bridge to [Steam](https://steamapp.com/) | [Link](docs/configuring-playbook-bridge-mx-puppet-steam.md) |
|
| [mx-puppet-steam](https://github.com/icewind1991/mx-puppet-steam) | ❌ | Bridge to [Steam](https://steamapp.com/) | [Link](docs/configuring-playbook-bridge-mx-puppet-steam.md) |
|
||||||
|
| [matrix-steam-bridge](https://github.com/jasonlaguidice/matrix-steam-bridge) | ❌ | Bridge to [Steam](https://steampowered.com/) | [Link](docs/configuring-playbook-bridge-steam.md) |
|
||||||
| [Postmoogle](https://github.com/etkecc/postmoogle) | ❌ | Email to Matrix bridge | [Link](docs/configuring-playbook-bridge-postmoogle.md) |
|
| [Postmoogle](https://github.com/etkecc/postmoogle) | ❌ | Email to Matrix bridge | [Link](docs/configuring-playbook-bridge-postmoogle.md) |
|
||||||
|
|
||||||
### Bots
|
### Bots
|
||||||
|
@@ -7,7 +7,9 @@ SPDX-FileCopyrightText: 2024 - 2025 Suguru Hirahara
|
|||||||
SPDX-License-Identifier: AGPL-3.0-or-later
|
SPDX-License-Identifier: AGPL-3.0-or-later
|
||||||
-->
|
-->
|
||||||
|
|
||||||
# Setting up MX Puppet Steam bridging (optional)
|
# Setting up MX Puppet Steam bridging (optional, deprecated)
|
||||||
|
|
||||||
|
**Note**: This bridge has been deprecated in favor of the [matrix-steam-bridge](https://github.com/jasonlaguidice/matrix-steam-bridge) bridge for Steam, which can be [installed using this playbook](configuring-playbook-bridge-steam.md). Consider using that bridge instead of this one.
|
||||||
|
|
||||||
The playbook can install and configure [mx-puppet-steam](https://github.com/icewind1991/mx-puppet-steam) for you.
|
The playbook can install and configure [mx-puppet-steam](https://github.com/icewind1991/mx-puppet-steam) for you.
|
||||||
|
|
||||||
|
48
docs/configuring-playbook-bridge-steam.md
Normal file
48
docs/configuring-playbook-bridge-steam.md
Normal file
@@ -0,0 +1,48 @@
|
|||||||
|
<!--
|
||||||
|
SPDX-FileCopyrightText: 2025 Jason LaGuidice
|
||||||
|
|
||||||
|
SPDX-License-Identifier: AGPL-3.0-or-later
|
||||||
|
-->
|
||||||
|
|
||||||
|
# Setting up Steam bridging (optional)
|
||||||
|
|
||||||
|
The playbook can install and configure [matrix-steam-bridge](https://github.com/jasonlaguidice/matrix-steam-bridge) for you.
|
||||||
|
|
||||||
|
See the project's [documentation](https://github.com/jasonlaguidice/matrix-steam-bridge/blob/main/README.md) to learn what it does and why it might be useful to you.
|
||||||
|
|
||||||
|
## Adjusting the playbook configuration
|
||||||
|
|
||||||
|
To enable the [Steam](https://steampowered.com/) bridge, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
matrix_steam_bridge_enabled: true
|
||||||
|
```
|
||||||
|
|
||||||
|
## Installing
|
||||||
|
|
||||||
|
After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:
|
||||||
|
|
||||||
|
<!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. -->
|
||||||
|
```sh
|
||||||
|
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start
|
||||||
|
```
|
||||||
|
|
||||||
|
The shortcut commands with the [`just` program](just.md) are also available: `just install-all` and `just setup-all`
|
||||||
|
|
||||||
|
`just install-all` is useful for maintaining your setup quickly ([2x-5x faster](../CHANGELOG.md#2x-5x-performance-improvements-in-playbook-runtime) 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.
|
||||||
|
|
||||||
|
The tag for `just` commands for this bridge is `matrix-steam-bridge` - for example: `just install-service matrix-steam-bridge`
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
To use the bridge, you need to start a chat with `Steam bridge bot` with the handle `@steambot:example.com` (where `example.com` is your base domain, not the `matrix.` domain).
|
||||||
|
|
||||||
|
The bridge supports QR code and password-based login as well as SteamGuard codes via app, SMS, or e-mail. See matrix-steam-bridge [documentation](https://github.com/jasonlaguidice/matrix-steam-bridge) for more information about how to configure the bridge.
|
||||||
|
|
||||||
|
To login, send `login [flow ID]` where possible flow IDs are `password` or `qr`
|
||||||
|
|
||||||
|
Once logged in, send `search [name]` to search through recognized Steam friends. You can send a user name, display name, or all forms of Steam ID. Send `start-chat [identifier]` to request the bridge bot to open a chat room with a user.
|
||||||
|
|
||||||
|
Chat rooms will automatically be opened as new messages are received.
|
||||||
|
|
||||||
|
Send `help` to the bot to see the available commands.
|
@@ -184,6 +184,8 @@ Bridges can be used to connect your Matrix installation with third-party communi
|
|||||||
|
|
||||||
- [Setting up MX Puppet GroupMe bridging](configuring-playbook-bridge-mx-puppet-groupme.md)
|
- [Setting up MX Puppet GroupMe bridging](configuring-playbook-bridge-mx-puppet-groupme.md)
|
||||||
|
|
||||||
|
- [Setting up Steam bridging](configuring-playbook-bridge-steam.md)
|
||||||
|
|
||||||
- [Setting up MX Puppet Steam bridging](configuring-playbook-bridge-mx-puppet-steam.md)
|
- [Setting up MX Puppet Steam bridging](configuring-playbook-bridge-mx-puppet-steam.md)
|
||||||
|
|
||||||
- [Setting up Go Skype Bridge bridging](configuring-playbook-bridge-go-skype-bridge.md)
|
- [Setting up Go Skype Bridge bridging](configuring-playbook-bridge-go-skype-bridge.md)
|
||||||
|
@@ -114,6 +114,7 @@ Bridges can be used to connect your Matrix installation with third-party communi
|
|||||||
| [mx-puppet-twitter](configuring-playbook-bridge-mx-puppet-twitter.md) | [sorunome/mx-puppet-twitter](https://hub.docker.com/r/sorunome/mx-puppet-twitter) | ❌ | Bridge for Twitter-DMs ([Twitter](https://twitter.com/)) |
|
| [mx-puppet-twitter](configuring-playbook-bridge-mx-puppet-twitter.md) | [sorunome/mx-puppet-twitter](https://hub.docker.com/r/sorunome/mx-puppet-twitter) | ❌ | Bridge for Twitter-DMs ([Twitter](https://twitter.com/)) |
|
||||||
| [mx-puppet-discord](configuring-playbook-bridge-mx-puppet-discord.md) | [mx-puppet/discord/mx-puppet-discord](https://gitlab.com/mx-puppet/discord/mx-puppet-discord/container_registry) | ❌ | Bridge to [Discord](https://discordapp.com/) |
|
| [mx-puppet-discord](configuring-playbook-bridge-mx-puppet-discord.md) | [mx-puppet/discord/mx-puppet-discord](https://gitlab.com/mx-puppet/discord/mx-puppet-discord/container_registry) | ❌ | Bridge to [Discord](https://discordapp.com/) |
|
||||||
| [mx-puppet-groupme](configuring-playbook-bridge-mx-puppet-groupme.md) | [xangelix/mx-puppet-groupme](https://hub.docker.com/r/xangelix/mx-puppet-groupme) | ❌ | Bridge to [GroupMe](https://groupme.com/) |
|
| [mx-puppet-groupme](configuring-playbook-bridge-mx-puppet-groupme.md) | [xangelix/mx-puppet-groupme](https://hub.docker.com/r/xangelix/mx-puppet-groupme) | ❌ | Bridge to [GroupMe](https://groupme.com/) |
|
||||||
|
| [matrix-steam-bridge](configuring-playbook-bridge-steam.md) | [jasonlaguidice/matrix-steam-bridge](https://github.com/jasonlaguidice/matrix-steam-bridge/pkgs/container/matrix-steam-bridge) | ❌ | Bridge to [Steam](https://steampowered.com/) |
|
||||||
| [mx-puppet-steam](configuring-playbook-bridge-mx-puppet-steam.md) | [icewind1991/mx-puppet-steam](https://hub.docker.com/r/icewind1991/mx-puppet-steam) | ❌ | Bridge to [Steam](https://steamapp.com/) |
|
| [mx-puppet-steam](configuring-playbook-bridge-mx-puppet-steam.md) | [icewind1991/mx-puppet-steam](https://hub.docker.com/r/icewind1991/mx-puppet-steam) | ❌ | Bridge to [Steam](https://steamapp.com/) |
|
||||||
| [Postmoogle](configuring-playbook-bridge-postmoogle.md) | [etke.cc/postmoogle](https://github.com/etkecc/postmoogle/container_registry) | ❌ | Email to Matrix bridge |
|
| [Postmoogle](configuring-playbook-bridge-postmoogle.md) | [etke.cc/postmoogle](https://github.com/etkecc/postmoogle/container_registry) | ❌ | Email to Matrix bridge |
|
||||||
|
|
||||||
|
@@ -162,6 +162,8 @@ matrix_homeserver_container_extra_arguments_auto: |
|
|||||||
+
|
+
|
||||||
(['--mount type=bind,src=' + matrix_sms_bridge_config_path + '/registration.yaml,dst=/matrix-sms-bridge-registration.yaml,ro'] if matrix_sms_bridge_enabled else [])
|
(['--mount type=bind,src=' + matrix_sms_bridge_config_path + '/registration.yaml,dst=/matrix-sms-bridge-registration.yaml,ro'] if matrix_sms_bridge_enabled else [])
|
||||||
+
|
+
|
||||||
|
(['--mount type=bind,src=' + matrix_steam_bridge_config_path + '/registration.yaml,dst=/matrix-steam-bridge-registration.yaml,ro'] if matrix_steam_bridge_enabled else [])
|
||||||
|
+
|
||||||
(['--mount type=bind,src=' + matrix_cactus_comments_app_service_config_file + ',dst=/matrix-cactus-comments.yaml,ro'] if matrix_cactus_comments_enabled else [])
|
(['--mount type=bind,src=' + matrix_cactus_comments_app_service_config_file + ',dst=/matrix-cactus-comments.yaml,ro'] if matrix_cactus_comments_enabled else [])
|
||||||
}}
|
}}
|
||||||
|
|
||||||
@@ -236,6 +238,8 @@ matrix_homeserver_app_service_config_files_auto: |
|
|||||||
(['/matrix-sms-bridge-registration.yaml'] if matrix_sms_bridge_enabled else [])
|
(['/matrix-sms-bridge-registration.yaml'] if matrix_sms_bridge_enabled else [])
|
||||||
+
|
+
|
||||||
(['/matrix-cactus-comments.yaml'] if matrix_cactus_comments_enabled else [])
|
(['/matrix-cactus-comments.yaml'] if matrix_cactus_comments_enabled else [])
|
||||||
|
+
|
||||||
|
(['/matrix-steam-bridge-registration.yaml'] if matrix_steam_bridge_enabled else [])
|
||||||
}}
|
}}
|
||||||
|
|
||||||
matrix_addons_homeserver_container_network: "{{ matrix_playbook_reverse_proxy_container_network if matrix_playbook_internal_matrix_client_api_traefik_entrypoint_enabled else matrix_homeserver_container_network }}"
|
matrix_addons_homeserver_container_network: "{{ matrix_playbook_reverse_proxy_container_network if matrix_playbook_internal_matrix_client_api_traefik_entrypoint_enabled else matrix_homeserver_container_network }}"
|
||||||
@@ -381,6 +385,8 @@ devture_systemd_service_manager_services_list_auto: |
|
|||||||
+
|
+
|
||||||
([{'name': 'matrix-sms-bridge.service', 'priority': 2000, 'groups': ['matrix', 'bridges', 'sms']}] if matrix_sms_bridge_enabled else [])
|
([{'name': 'matrix-sms-bridge.service', 'priority': 2000, 'groups': ['matrix', 'bridges', 'sms']}] if matrix_sms_bridge_enabled else [])
|
||||||
+
|
+
|
||||||
|
([{'name': 'matrix-steam-bridge.service', 'priority': 2000, 'groups': ['matrix', 'bridges', 'matrix-steam-bridge']}] if matrix_steam_bridge_enabled else [])
|
||||||
|
+
|
||||||
([{'name': 'matrix-cactus-comments.service', 'priority': 2000, 'groups': ['matrix', 'cactus-comments']}] if matrix_cactus_comments_enabled else [])
|
([{'name': 'matrix-cactus-comments.service', 'priority': 2000, 'groups': ['matrix', 'cactus-comments']}] if matrix_cactus_comments_enabled else [])
|
||||||
+
|
+
|
||||||
([{'name': 'matrix-cactus-comments-client.service', 'priority': 2000, 'groups': ['matrix', 'cactus-comments-client']}] if matrix_cactus_comments_client_enabled else [])
|
([{'name': 'matrix-cactus-comments-client.service', 'priority': 2000, 'groups': ['matrix', 'cactus-comments-client']}] if matrix_cactus_comments_client_enabled else [])
|
||||||
@@ -2767,6 +2773,82 @@ matrix_postmoogle_container_additional_networks_auto: |-
|
|||||||
#
|
#
|
||||||
######################################################################
|
######################################################################
|
||||||
|
|
||||||
|
######################################################################
|
||||||
|
#
|
||||||
|
# matrix-bridge-steam
|
||||||
|
#
|
||||||
|
######################################################################
|
||||||
|
|
||||||
|
# We don't enable bridges by default.
|
||||||
|
matrix_steam_bridge_enabled: false
|
||||||
|
|
||||||
|
matrix_steam_bridge_systemd_required_services_list_auto: |
|
||||||
|
{{
|
||||||
|
matrix_addons_homeserver_systemd_services_list
|
||||||
|
+
|
||||||
|
([postgres_identifier ~ '.service'] if (postgres_enabled and matrix_steam_bridge_database_hostname == postgres_connection_hostname) else [])
|
||||||
|
}}
|
||||||
|
|
||||||
|
matrix_steam_bridge_docker_image_registry_prefix_upstream: "{{ matrix_container_global_registry_prefix_override if matrix_container_global_registry_prefix_override else matrix_steam_bridge_docker_image_registry_prefix_upstream_default }}"
|
||||||
|
|
||||||
|
matrix_steam_bridge_container_image_self_build: "{{ matrix_architecture not in ['amd64', 'arm64'] }}"
|
||||||
|
|
||||||
|
matrix_steam_bridge_container_network: "{{ matrix_addons_container_network }}"
|
||||||
|
|
||||||
|
matrix_steam_bridge_container_additional_networks_auto: |-
|
||||||
|
{{
|
||||||
|
(
|
||||||
|
([] if matrix_addons_homeserver_container_network == '' else [matrix_addons_homeserver_container_network])
|
||||||
|
+
|
||||||
|
([postgres_container_network] if (postgres_enabled and matrix_steam_bridge_database_hostname == postgres_connection_hostname and matrix_steam_bridge_container_network != postgres_container_network) else [])
|
||||||
|
+
|
||||||
|
([matrix_playbook_reverse_proxyable_services_additional_network] if matrix_playbook_reverse_proxyable_services_additional_network and matrix_steam_bridge_container_labels_traefik_enabled else [])
|
||||||
|
) | unique
|
||||||
|
}}
|
||||||
|
|
||||||
|
matrix_steam_bridge_container_labels_traefik_enabled: "{{ matrix_playbook_reverse_proxy_type in ['playbook-managed-traefik', 'other-traefik-container'] }}"
|
||||||
|
matrix_steam_bridge_container_labels_traefik_docker_network: "{{ matrix_playbook_reverse_proxyable_services_additional_network }}"
|
||||||
|
matrix_steam_bridge_container_labels_traefik_entrypoints: "{{ traefik_entrypoint_primary }}"
|
||||||
|
matrix_steam_bridge_container_labels_traefik_tls_certResolver: "{{ traefik_certResolver_primary }}"
|
||||||
|
|
||||||
|
matrix_steam_bridge_container_labels_metrics_middleware_basic_auth_enabled: "{{ matrix_metrics_exposure_http_basic_auth_enabled }}"
|
||||||
|
matrix_steam_bridge_container_labels_metrics_middleware_basic_auth_users: "{{ matrix_metrics_exposure_http_basic_auth_users }}"
|
||||||
|
|
||||||
|
matrix_steam_bridge_appservice_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'steam.as.token', rounds=655555) | to_uuid }}"
|
||||||
|
|
||||||
|
matrix_steam_bridge_homeserver_address: "{{ matrix_addons_homeserver_client_api_url }}"
|
||||||
|
matrix_steam_bridge_homeserver_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'steam.hs.token', rounds=655555) | to_uuid }}"
|
||||||
|
|
||||||
|
matrix_steam_bridge_homeserver_async_media: "{{ matrix_homeserver_implementation in ['synapse'] }}"
|
||||||
|
|
||||||
|
matrix_steam_bridge_public_media_signing_key: "{{ ('%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'steam.pub.key', rounds=655555) | to_uuid) if matrix_steam_bridge_public_media_enabled else '' }}"
|
||||||
|
|
||||||
|
matrix_steam_bridge_provisioning_shared_secret: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'steam.prov', rounds=655555) | to_uuid }}"
|
||||||
|
|
||||||
|
matrix_steam_bridge_double_puppet_secrets_auto: |-
|
||||||
|
{{
|
||||||
|
({
|
||||||
|
matrix_steam_bridge_homeserver_domain: ("as_token:" + matrix_appservice_double_puppet_registration_as_token)
|
||||||
|
})
|
||||||
|
if matrix_appservice_double_puppet_enabled
|
||||||
|
else {}
|
||||||
|
}}
|
||||||
|
|
||||||
|
matrix_steam_bridge_metrics_enabled: "{{ prometheus_enabled or matrix_metrics_exposure_enabled }}"
|
||||||
|
|
||||||
|
matrix_steam_bridge_metrics_proxying_enabled: "{{ matrix_steam_bridge_metrics_enabled and matrix_metrics_exposure_enabled }}"
|
||||||
|
matrix_steam_bridge_metrics_proxying_hostname: "{{ matrix_metrics_exposure_hostname }}"
|
||||||
|
matrix_steam_bridge_metrics_proxying_path_prefix: "{{ matrix_metrics_exposure_path_prefix }}/matrix-steam-bridge"
|
||||||
|
|
||||||
|
matrix_steam_bridge_database_hostname: "{{ postgres_connection_hostname if postgres_enabled else '' }}"
|
||||||
|
matrix_steam_bridge_database_password: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'mau.twt.db', rounds=655555) | to_uuid if postgres_enabled else '' }}"
|
||||||
|
|
||||||
|
######################################################################
|
||||||
|
#
|
||||||
|
# /matrix-bridge-steam
|
||||||
|
#
|
||||||
|
######################################################################
|
||||||
|
|
||||||
######################################################################
|
######################################################################
|
||||||
#
|
#
|
||||||
# matrix-bot-matrix-reminder-bot
|
# matrix-bot-matrix-reminder-bot
|
||||||
@@ -4396,6 +4478,12 @@ postgres_managed_databases_auto: |
|
|||||||
'password': matrix_mx_puppet_groupme_database_password,
|
'password': matrix_mx_puppet_groupme_database_password,
|
||||||
}] if (matrix_mx_puppet_groupme_enabled and matrix_mx_puppet_groupme_database_engine == 'postgres' and matrix_mx_puppet_groupme_database_hostname == postgres_connection_hostname) else [])
|
}] if (matrix_mx_puppet_groupme_enabled and matrix_mx_puppet_groupme_database_engine == 'postgres' and matrix_mx_puppet_groupme_database_hostname == postgres_connection_hostname) else [])
|
||||||
+
|
+
|
||||||
|
([{
|
||||||
|
'name': matrix_steam_bridge_database_name,
|
||||||
|
'username': matrix_steam_bridge_database_username,
|
||||||
|
'password': matrix_steam_bridge_database_password,
|
||||||
|
}] if (matrix_steam_bridge_enabled and matrix_steam_bridge_database_engine == 'postgres' and matrix_steam_bridge_database_hostname == postgres_connection_hostname) else [])
|
||||||
|
+
|
||||||
([{
|
([{
|
||||||
'name': matrix_dimension_database_name,
|
'name': matrix_dimension_database_name,
|
||||||
'username': matrix_dimension_database_username,
|
'username': matrix_dimension_database_username,
|
||||||
@@ -5313,6 +5401,11 @@ matrix_synapse_admin_config_asManagedUsers_auto: |
|
|||||||
'^@'+(matrix_wechat_appservice_bot_username | default('') | regex_escape)+':'+(matrix_domain | regex_escape)+'$',
|
'^@'+(matrix_wechat_appservice_bot_username | default('') | regex_escape)+':'+(matrix_domain | regex_escape)+'$',
|
||||||
'^@_wechat_[a-zA-Z0-9]+:'+(matrix_domain | regex_escape)+'$',
|
'^@_wechat_[a-zA-Z0-9]+:'+(matrix_domain | regex_escape)+'$',
|
||||||
] if matrix_wechat_enabled else [])
|
] if matrix_wechat_enabled else [])
|
||||||
|
+
|
||||||
|
([
|
||||||
|
'^@'+(matrix_steam_bridge_appservice_bot_username | default('') | regex_escape)+':'+(matrix_domain | regex_escape)+'$',
|
||||||
|
'^@steam_[a-zA-Z0-9]+:'+(matrix_domain | regex_escape)+'$',
|
||||||
|
] if matrix_steam_bridge_enabled else [])
|
||||||
}}
|
}}
|
||||||
|
|
||||||
######################################################################
|
######################################################################
|
||||||
|
242
roles/custom/matrix-bridge-steam/defaults/main.yml
Normal file
242
roles/custom/matrix-bridge-steam/defaults/main.yml
Normal file
@@ -0,0 +1,242 @@
|
|||||||
|
# SPDX-FileCopyrightText: 2025 Jason LaGuidice
|
||||||
|
#
|
||||||
|
# SPDX-License-Identifier: AGPL-3.0-or-later
|
||||||
|
|
||||||
|
---
|
||||||
|
# matrix-steam-bridge is a Matrix <-> Steam bridge
|
||||||
|
# See: https://github.com/jasonlaguidice/matrix-steam-bridge
|
||||||
|
|
||||||
|
matrix_steam_bridge_enabled: true
|
||||||
|
|
||||||
|
matrix_steam_bridge_container_image_self_build: false
|
||||||
|
matrix_steam_bridge_container_image_self_build_repo: "https://github.com/jasonlaguidice/matrix-steam-bridge.git"
|
||||||
|
matrix_steam_bridge_container_image_self_build_repo_version: "{{ 'main' if matrix_steam_bridge_version == 'latest' else matrix_steam_bridge_version }}"
|
||||||
|
|
||||||
|
# renovate: datasource=docker depName=ghcr.io/jasonlaguidice/matrix-steam-bridge
|
||||||
|
matrix_steam_bridge_version: 1.0.3
|
||||||
|
matrix_steam_bridge_docker_image: "{{ matrix_steam_bridge_docker_image_registry_prefix }}jasonlaguidice/matrix-steam-bridge:{{ matrix_steam_bridge_version }}"
|
||||||
|
matrix_steam_bridge_docker_image_registry_prefix: "{{ 'localhost/' if matrix_steam_bridge_container_image_self_build else matrix_steam_bridge_docker_image_registry_prefix_upstream }}"
|
||||||
|
matrix_steam_bridge_docker_image_registry_prefix_upstream: "{{ matrix_steam_bridge_docker_image_registry_prefix_upstream_default }}"
|
||||||
|
matrix_steam_bridge_docker_image_registry_prefix_upstream_default: "ghcr.io/"
|
||||||
|
matrix_steam_bridge_docker_image_tag: "{{ matrix_steam_bridge_version }}"
|
||||||
|
matrix_steam_bridge_docker_image_force_pull: "{{ matrix_steam_bridge_docker_image.endswith(':latest') }}"
|
||||||
|
|
||||||
|
matrix_steam_bridge_base_path: "{{ matrix_base_data_path }}/matrix-steam-bridge"
|
||||||
|
matrix_steam_bridge_config_path: "{{ matrix_steam_bridge_base_path }}/config"
|
||||||
|
matrix_steam_bridge_data_path: "{{ matrix_steam_bridge_base_path }}/data"
|
||||||
|
matrix_steam_bridge_docker_src_files_path: "{{ matrix_steam_bridge_base_path }}/docker-src"
|
||||||
|
|
||||||
|
matrix_steam_bridge_homeserver_address: ""
|
||||||
|
matrix_steam_bridge_homeserver_domain: "{{ matrix_domain }}"
|
||||||
|
matrix_steam_bridge_appservice_address: "http://matrix-steam-bridge:{{ matrix_steam_bridge_appservice_port }}"
|
||||||
|
matrix_steam_bridge_appservice_port: "8080"
|
||||||
|
|
||||||
|
matrix_steam_bridge_msc4190_enabled: "{{ matrix_bridges_msc4190_enabled }}"
|
||||||
|
|
||||||
|
# A public address that external services can use to reach this appservice
|
||||||
|
matrix_steam_bridge_appservice_public_address: "https://{{ matrix_server_fqn_matrix }}"
|
||||||
|
|
||||||
|
# Public media configuration for external access to bridge media
|
||||||
|
matrix_steam_bridge_public_media_enabled: true
|
||||||
|
# A key for signing public media URLs. If set to "generate", a random key will be generated.
|
||||||
|
# This will be auto-generated deterministically if matrix_homeserver_generic_secret_key is set.
|
||||||
|
matrix_steam_bridge_public_media_signing_key: ''
|
||||||
|
# Number of seconds that public media URLs are valid for. If set to 0, URLs will never expire.
|
||||||
|
matrix_steam_bridge_public_media_expiry: 0
|
||||||
|
matrix_steam_bridge_public_media_hash_length: 32
|
||||||
|
|
||||||
|
# Displayname template for Steam users
|
||||||
|
# {{ .DisplayName }} is replaced with the display name of the Steam user
|
||||||
|
# {{ .Username }} is replaced with the username of the Steam user
|
||||||
|
matrix_steam_bridge_network_displayname_template: "{% raw %}{{ .DisplayName }}{% endraw %} (Steam)"
|
||||||
|
|
||||||
|
matrix_steam_bridge_command_prefix: "!steam"
|
||||||
|
|
||||||
|
matrix_steam_bridge_bridge_permissions: |
|
||||||
|
{{
|
||||||
|
{matrix_steam_bridge_homeserver_domain: 'user'}
|
||||||
|
| combine ({matrix_admin: 'admin'} if matrix_admin else {})
|
||||||
|
}}
|
||||||
|
|
||||||
|
# TODO: May need to set network for public media?
|
||||||
|
matrix_steam_bridge_container_network: ""
|
||||||
|
|
||||||
|
matrix_steam_bridge_container_additional_networks: "{{ matrix_steam_bridge_container_additional_networks_auto + matrix_steam_bridge_container_additional_networks_custom }}"
|
||||||
|
matrix_steam_bridge_container_additional_networks_auto: []
|
||||||
|
matrix_steam_bridge_container_additional_networks_custom: []
|
||||||
|
|
||||||
|
# matrix_steam_bridge_container_labels_traefik_enabled controls whether labels to assist a Traefik reverse-proxy will be attached to the container.
|
||||||
|
# See `../templates/labels.j2` for details.
|
||||||
|
#
|
||||||
|
# To inject your own other container labels, see `matrix_steam_bridge_container_labels_additional_labels`.
|
||||||
|
matrix_steam_bridge_container_labels_traefik_enabled: true
|
||||||
|
matrix_steam_bridge_container_labels_traefik_docker_network: "{{ matrix_steam_bridge_container_network }}"
|
||||||
|
matrix_steam_bridge_container_labels_traefik_entrypoints: web-secure
|
||||||
|
matrix_steam_bridge_container_labels_traefik_tls: "{{ matrix_steam_bridge_container_labels_traefik_entrypoints != 'web' }}"
|
||||||
|
matrix_steam_bridge_container_labels_traefik_tls_certResolver: default # noqa var-naming
|
||||||
|
|
||||||
|
# Controls whether labels will be added that expose mautrix-instagram's metrics
|
||||||
|
matrix_steam_bridge_container_labels_metrics_enabled: "{{ matrix_steam_bridge_metrics_enabled and matrix_steam_bridge_metrics_proxying_enabled }}"
|
||||||
|
matrix_steam_bridge_container_labels_metrics_traefik_rule: "Host(`{{ matrix_steam_bridge_metrics_proxying_hostname }}`) && PathPrefix(`{{ matrix_steam_bridge_metrics_proxying_path_prefix }}`)"
|
||||||
|
matrix_steam_bridge_container_labels_metrics_traefik_priority: 0
|
||||||
|
matrix_steam_bridge_container_labels_metrics_traefik_entrypoints: "{{ matrix_steam_bridge_container_labels_traefik_entrypoints }}"
|
||||||
|
matrix_steam_bridge_container_labels_metrics_traefik_tls: "{{ matrix_steam_bridge_container_labels_metrics_traefik_entrypoints != 'web' }}"
|
||||||
|
matrix_steam_bridge_container_labels_metrics_traefik_tls_certResolver: "{{ matrix_steam_bridge_container_labels_traefik_tls_certResolver }}" # noqa var-naming
|
||||||
|
matrix_steam_bridge_container_labels_metrics_middleware_basic_auth_enabled: false
|
||||||
|
# See: https://doc.traefik.io/traefik/middlewares/http/basicauth/#users
|
||||||
|
matrix_steam_bridge_container_labels_metrics_middleware_basic_auth_users: ''
|
||||||
|
|
||||||
|
# matrix_steam_bridge_container_labels_additional_labels contains a multiline string with additional labels to add to the container label file.
|
||||||
|
# See `../templates/labels.j2` for details.
|
||||||
|
#
|
||||||
|
# Example:
|
||||||
|
# matrix_steam_bridge_container_labels_additional_labels: |
|
||||||
|
# my.label=1
|
||||||
|
# another.label="here"
|
||||||
|
matrix_steam_bridge_container_labels_additional_labels: ''
|
||||||
|
|
||||||
|
# A list of extra arguments to pass to the container
|
||||||
|
matrix_steam_bridge_container_extra_arguments: []
|
||||||
|
|
||||||
|
# List of systemd services that matrix_steam_bridge.service depends on.
|
||||||
|
matrix_steam_bridge_systemd_required_services_list: "{{ matrix_steam_bridge_systemd_required_services_list_default + matrix_steam_bridge_systemd_required_services_list_auto + matrix_steam_bridge_systemd_required_services_list_custom }}"
|
||||||
|
matrix_steam_bridge_systemd_required_services_list_default: "{{ [devture_systemd_docker_base_docker_service_name] if devture_systemd_docker_base_docker_service_name else [] }}"
|
||||||
|
matrix_steam_bridge_systemd_required_services_list_auto: []
|
||||||
|
matrix_steam_bridge_systemd_required_services_list_custom: []
|
||||||
|
|
||||||
|
# List of systemd services that matrix_steam_bridge.service wants
|
||||||
|
matrix_steam_bridge_systemd_wanted_services_list: []
|
||||||
|
|
||||||
|
matrix_steam_bridge_appservice_token: ''
|
||||||
|
matrix_steam_bridge_homeserver_token: ''
|
||||||
|
|
||||||
|
# Whether or not created rooms should have federation enabled.
|
||||||
|
# If false, created portal rooms will never be federated.
|
||||||
|
matrix_steam_bridge_matrix_federate_rooms: false
|
||||||
|
|
||||||
|
# Bridge configuration options
|
||||||
|
# Should every user have their own portals rather than sharing them?
|
||||||
|
matrix_steam_bridge_bridge_split_portals: false
|
||||||
|
|
||||||
|
# Cleanup on logout configuration
|
||||||
|
matrix_steam_bridge_bridge_cleanup_on_logout_enabled: false
|
||||||
|
# Valid values for cleanup actions: nothing, kick, unbridge, delete
|
||||||
|
# nothing - Do nothing, let the user stay in the portals
|
||||||
|
# kick - Remove the user from the portal rooms, but don't delete them
|
||||||
|
# unbridge - Remove all ghosts in the room and disassociate it from the remote chat
|
||||||
|
# delete - Remove all ghosts and users from the room (i.e. delete it)
|
||||||
|
matrix_steam_bridge_bridge_cleanup_on_logout_manual_private: nothing
|
||||||
|
matrix_steam_bridge_bridge_cleanup_on_logout_manual_relayed: nothing
|
||||||
|
matrix_steam_bridge_bridge_cleanup_on_logout_manual_shared_no_users: nothing
|
||||||
|
matrix_steam_bridge_bridge_cleanup_on_logout_manual_shared_has_users: nothing
|
||||||
|
matrix_steam_bridge_bridge_cleanup_on_logout_bad_credentials_private: nothing
|
||||||
|
matrix_steam_bridge_bridge_cleanup_on_logout_bad_credentials_relayed: nothing
|
||||||
|
matrix_steam_bridge_bridge_cleanup_on_logout_bad_credentials_shared_no_users: nothing
|
||||||
|
matrix_steam_bridge_bridge_cleanup_on_logout_bad_credentials_shared_has_users: nothing
|
||||||
|
|
||||||
|
# Homeserver configuration options
|
||||||
|
# Does the homeserver support MSC2246 (async media uploads)?
|
||||||
|
matrix_steam_bridge_homeserver_async_media: false
|
||||||
|
|
||||||
|
# Database-related configuration fields.
|
||||||
|
#
|
||||||
|
# To use Postgres:
|
||||||
|
# - adjust your database credentials via the `matrix_steam_bridge_postgres_*` variables
|
||||||
|
matrix_steam_bridge_database_engine: 'postgres'
|
||||||
|
|
||||||
|
matrix_steam_bridge_database_username: 'matrix_steam_bridge'
|
||||||
|
matrix_steam_bridge_database_password: 'some-password'
|
||||||
|
matrix_steam_bridge_database_hostname: ''
|
||||||
|
matrix_steam_bridge_database_port: 5432
|
||||||
|
matrix_steam_bridge_database_name: 'matrix_steam_bridge'
|
||||||
|
matrix_steam_bridge_database_sslmode: disable
|
||||||
|
|
||||||
|
matrix_steam_bridge_database_connection_string: 'postgres://{{ matrix_steam_bridge_database_username }}:{{ matrix_steam_bridge_database_password }}@{{ matrix_steam_bridge_database_hostname }}:{{ matrix_steam_bridge_database_port }}/{{ matrix_steam_bridge_database_name }}?sslmode={{ matrix_steam_bridge_database_sslmode }}'
|
||||||
|
|
||||||
|
matrix_steam_bridge_database_uri: "{{
|
||||||
|
{
|
||||||
|
'postgres': matrix_steam_bridge_database_connection_string,
|
||||||
|
}[matrix_steam_bridge_database_engine]
|
||||||
|
}}"
|
||||||
|
|
||||||
|
matrix_steam_bridge_double_puppet_secrets: "{{ matrix_steam_bridge_double_puppet_secrets_auto | combine(matrix_steam_bridge_double_puppet_secrets_custom) }}"
|
||||||
|
matrix_steam_bridge_double_puppet_secrets_auto: {}
|
||||||
|
matrix_steam_bridge_double_puppet_secrets_custom: {}
|
||||||
|
|
||||||
|
matrix_steam_bridge_appservice_bot_username: steambot
|
||||||
|
matrix_steam_bridge_appservice_bot_displayname: Steam bridge bot
|
||||||
|
matrix_steam_bridge_appservice_bot_avatar: mxc://shadowdrake.org/EeNKAcrmByNubPwoyceQsBaN
|
||||||
|
|
||||||
|
matrix_steam_bridge_backfill_enabled: true
|
||||||
|
# Maximum number of messages to backfill in empty rooms
|
||||||
|
matrix_steam_bridge_backfill_max_initial_messages: 50
|
||||||
|
|
||||||
|
# Maximum number of missed messages to backfill after bridge restarts
|
||||||
|
matrix_steam_bridge_backfill_max_catchup_messages: 500
|
||||||
|
|
||||||
|
# Shared secret for authentication of provisioning API requests.
|
||||||
|
# If set to "disable", the provisioning API will be disabled.
|
||||||
|
matrix_steam_bridge_provisioning_shared_secret: disable
|
||||||
|
|
||||||
|
# Minimum severity of journal log messages.
|
||||||
|
# Valid values: fatal, error, warn, info, debug, trace
|
||||||
|
matrix_steam_bridge_logging_level: 'warn'
|
||||||
|
|
||||||
|
# Whether or not metrics endpoint should be enabled.
|
||||||
|
# Enabling them is usually enough for a local (in-container) Prometheus to consume them.
|
||||||
|
# If metrics need to be consumed by another (external) Prometheus server, consider exposing them via `matrix_steam_bridge_metrics_proxying_enabled`.
|
||||||
|
matrix_steam_bridge_metrics_enabled: false
|
||||||
|
|
||||||
|
# Controls whether metrics should be exposed on a public URL.
|
||||||
|
matrix_steam_bridge_metrics_proxying_enabled: false
|
||||||
|
matrix_steam_bridge_metrics_proxying_hostname: ''
|
||||||
|
matrix_steam_bridge_metrics_proxying_path_prefix: ''
|
||||||
|
|
||||||
|
# Default configuration template which covers the generic use case.
|
||||||
|
# You can customize it by controlling the various variables inside it.
|
||||||
|
#
|
||||||
|
# For a more advanced customization, you can extend the default (see `matrix_steam_bridge_configuration_extension_yaml`)
|
||||||
|
# or completely replace this variable with your own template.
|
||||||
|
matrix_steam_bridge_configuration_yaml: "{{ lookup('template', 'templates/config.yaml.j2') }}"
|
||||||
|
|
||||||
|
matrix_steam_bridge_configuration_extension_yaml: |
|
||||||
|
# Your custom YAML configuration goes here.
|
||||||
|
# This configuration extends the default starting configuration (`matrix_steam_bridge_configuration_yaml`).
|
||||||
|
#
|
||||||
|
# You can override individual variables from the default configuration, or introduce new ones.
|
||||||
|
#
|
||||||
|
# If you need something more special, you can take full control by
|
||||||
|
# completely redefining `matrix_steam_bridge_configuration_yaml`.
|
||||||
|
|
||||||
|
matrix_steam_bridge_configuration_extension: "{{ matrix_steam_bridge_configuration_extension_yaml | from_yaml if matrix_steam_bridge_configuration_extension_yaml | from_yaml is mapping else {} }}"
|
||||||
|
|
||||||
|
# Holds the final configuration (a combination of the default and its extension).
|
||||||
|
# You most likely don't need to touch this variable. Instead, see `matrix_steam_bridge_configuration_yaml`.
|
||||||
|
matrix_steam_bridge_configuration: "{{ matrix_steam_bridge_configuration_yaml | from_yaml | combine(matrix_steam_bridge_configuration_extension, recursive=True) }}"
|
||||||
|
|
||||||
|
matrix_steam_bridge_registration_yaml: |
|
||||||
|
id: steam
|
||||||
|
as_token: "{{ matrix_steam_bridge_appservice_token }}"
|
||||||
|
hs_token: "{{ matrix_steam_bridge_homeserver_token }}"
|
||||||
|
namespaces:
|
||||||
|
users:
|
||||||
|
- exclusive: true
|
||||||
|
regex: '^@steam_.+:{{ matrix_steam_bridge_homeserver_domain | regex_escape }}$'
|
||||||
|
- exclusive: true
|
||||||
|
regex: '^@{{ matrix_steam_bridge_appservice_bot_username | regex_escape }}:{{ matrix_steam_bridge_homeserver_domain | regex_escape }}$'
|
||||||
|
url: {{ matrix_steam_bridge_appservice_address }}
|
||||||
|
sender_localpart: _bot_{{ matrix_steam_bridge_appservice_bot_username }}
|
||||||
|
rate_limited: false
|
||||||
|
de.sorunome.msc2409.push_ephemeral: true
|
||||||
|
receive_ephemeral: true
|
||||||
|
io.element.msc4190: {{ matrix_steam_bridge_msc4190_enabled | to_json }}
|
||||||
|
|
||||||
|
matrix_steam_bridge_registration: "{{ matrix_steam_bridge_registration_yaml | from_yaml }}"
|
||||||
|
|
||||||
|
# Enable End-to-bridge encryption
|
||||||
|
matrix_steam_bridge_bridge_encryption_allow: "{{ matrix_bridges_encryption_enabled }}"
|
||||||
|
matrix_steam_bridge_bridge_encryption_default: "{{ matrix_bridges_encryption_default }}"
|
||||||
|
matrix_steam_bridge_bridge_encryption_require: false
|
||||||
|
matrix_steam_bridge_bridge_encryption_appservice: false
|
||||||
|
matrix_steam_bridge_bridge_encryption_key_sharing_allow: "{{ matrix_steam_bridge_bridge_encryption_allow }}"
|
||||||
|
matrix_steam_bridge_bridge_encryption_pickle_key: mautrix.bridge.e2ee
|
24
roles/custom/matrix-bridge-steam/tasks/main.yml
Normal file
24
roles/custom/matrix-bridge-steam/tasks/main.yml
Normal file
@@ -0,0 +1,24 @@
|
|||||||
|
# SPDX-FileCopyrightText: 2025 MDAD project contributors
|
||||||
|
#
|
||||||
|
# SPDX-License-Identifier: AGPL-3.0-or-later
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
- tags:
|
||||||
|
- setup-all
|
||||||
|
- setup-matrix-steam-bridge
|
||||||
|
- install-all
|
||||||
|
- install-matrix-steam-bridge
|
||||||
|
block:
|
||||||
|
- when: matrix_steam_bridge_enabled | bool
|
||||||
|
ansible.builtin.include_tasks: "{{ role_path }}/tasks/validate_config.yml"
|
||||||
|
|
||||||
|
- when: matrix_steam_bridge_enabled | bool
|
||||||
|
ansible.builtin.include_tasks: "{{ role_path }}/tasks/setup_install.yml"
|
||||||
|
|
||||||
|
- tags:
|
||||||
|
- setup-all
|
||||||
|
- setup-matrix-steam-bridge
|
||||||
|
block:
|
||||||
|
- when: not matrix_steam_bridge_enabled | bool
|
||||||
|
ansible.builtin.include_tasks: "{{ role_path }}/tasks/setup_uninstall.yml"
|
102
roles/custom/matrix-bridge-steam/tasks/setup_install.yml
Normal file
102
roles/custom/matrix-bridge-steam/tasks/setup_install.yml
Normal file
@@ -0,0 +1,102 @@
|
|||||||
|
# SPDX-FileCopyrightText: 2025 MDAD project contributors
|
||||||
|
#
|
||||||
|
# SPDX-License-Identifier: AGPL-3.0-or-later
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
- ansible.builtin.set_fact:
|
||||||
|
matrix_steam_bridge_requires_restart: false
|
||||||
|
|
||||||
|
- name: Ensure Steam bridge image is pulled
|
||||||
|
community.docker.docker_image:
|
||||||
|
name: "{{ matrix_steam_bridge_docker_image }}"
|
||||||
|
source: "{{ 'pull' if ansible_version.major > 2 or ansible_version.minor > 7 else omit }}"
|
||||||
|
force_source: "{{ matrix_steam_bridge_docker_image_force_pull if ansible_version.major > 2 or ansible_version.minor >= 8 else omit }}"
|
||||||
|
force: "{{ omit if ansible_version.major > 2 or ansible_version.minor >= 8 else matrix_steam_bridge_docker_image_force_pull }}"
|
||||||
|
when: matrix_steam_bridge_enabled | bool and not matrix_steam_bridge_container_image_self_build
|
||||||
|
register: result
|
||||||
|
retries: "{{ devture_playbook_help_container_retries_count }}"
|
||||||
|
delay: "{{ devture_playbook_help_container_retries_delay }}"
|
||||||
|
until: result is not failed
|
||||||
|
|
||||||
|
- name: Ensure Steam bridge paths exist
|
||||||
|
ansible.builtin.file:
|
||||||
|
path: "{{ item.path }}"
|
||||||
|
state: directory
|
||||||
|
mode: 0750
|
||||||
|
owner: "{{ matrix_user_name }}"
|
||||||
|
group: "{{ matrix_group_name }}"
|
||||||
|
with_items:
|
||||||
|
- {path: "{{ matrix_steam_bridge_base_path }}", when: true}
|
||||||
|
- {path: "{{ matrix_steam_bridge_config_path }}", when: true}
|
||||||
|
- {path: "{{ matrix_steam_bridge_data_path }}", when: true}
|
||||||
|
- {path: "{{ matrix_steam_bridge_docker_src_files_path }}", when: "{{ matrix_steam_bridge_container_image_self_build }}"}
|
||||||
|
when: item.when | bool
|
||||||
|
|
||||||
|
- name: Ensure Steam bridge repository is present on self-build
|
||||||
|
ansible.builtin.git:
|
||||||
|
repo: "{{ matrix_steam_bridge_container_image_self_build_repo }}"
|
||||||
|
version: "{{ matrix_steam_bridge_container_image_self_build_repo_version }}"
|
||||||
|
dest: "{{ matrix_steam_bridge_docker_src_files_path }}"
|
||||||
|
force: "yes"
|
||||||
|
become: true
|
||||||
|
become_user: "{{ matrix_user_name }}"
|
||||||
|
register: matrix_steam_bridge_git_pull_results
|
||||||
|
when: "matrix_steam_bridge_enabled | bool and matrix_steam_bridge_container_image_self_build"
|
||||||
|
|
||||||
|
- name: Ensure Steam bridge Docker image is built
|
||||||
|
community.docker.docker_image:
|
||||||
|
name: "{{ matrix_steam_bridge_docker_image }}"
|
||||||
|
source: build
|
||||||
|
force_source: "{{ matrix_steam_bridge_git_pull_results.changed }}"
|
||||||
|
build:
|
||||||
|
dockerfile: Dockerfile
|
||||||
|
path: "{{ matrix_steam_bridge_docker_src_files_path }}"
|
||||||
|
pull: true
|
||||||
|
when: "matrix_steam_bridge_enabled | bool and matrix_steam_bridge_container_image_self_build | bool"
|
||||||
|
|
||||||
|
- name: Ensure matrix-steam-bridge config.yaml installed
|
||||||
|
ansible.builtin.copy:
|
||||||
|
content: "{{ matrix_steam_bridge_configuration | to_nice_yaml(indent=2, width=999999) }}"
|
||||||
|
dest: "{{ matrix_steam_bridge_config_path }}/config.yaml"
|
||||||
|
mode: 0644
|
||||||
|
owner: "{{ matrix_user_name }}"
|
||||||
|
group: "{{ matrix_group_name }}"
|
||||||
|
|
||||||
|
- name: Ensure matrix-steam-bridge registration.yaml installed
|
||||||
|
ansible.builtin.copy:
|
||||||
|
content: "{{ matrix_steam_bridge_registration | to_nice_yaml(indent=2, width=999999) }}"
|
||||||
|
dest: "{{ matrix_steam_bridge_config_path }}/registration.yaml"
|
||||||
|
mode: 0644
|
||||||
|
owner: "{{ matrix_user_name }}"
|
||||||
|
group: "{{ matrix_group_name }}"
|
||||||
|
|
||||||
|
- name: Ensure matrix-steam-bridge support files installed
|
||||||
|
ansible.builtin.template:
|
||||||
|
src: "{{ role_path }}/templates/{{ item }}.j2"
|
||||||
|
dest: "{{ matrix_steam_bridge_base_path }}/{{ item }}"
|
||||||
|
mode: 0640
|
||||||
|
owner: "{{ matrix_user_name }}"
|
||||||
|
group: "{{ matrix_group_name }}"
|
||||||
|
with_items:
|
||||||
|
- labels
|
||||||
|
|
||||||
|
- name: Ensure matrix-steam-bridge container network is created
|
||||||
|
community.general.docker_network:
|
||||||
|
enable_ipv6: "{{ devture_systemd_docker_base_ipv6_enabled }}"
|
||||||
|
name: "{{ matrix_steam_bridge_container_network }}"
|
||||||
|
driver: bridge
|
||||||
|
driver_options: "{{ devture_systemd_docker_base_container_networks_driver_options }}"
|
||||||
|
|
||||||
|
- name: Ensure matrix-steam-bridge.service installed
|
||||||
|
ansible.builtin.template:
|
||||||
|
src: "{{ role_path }}/templates/systemd/matrix-steam-bridge.service.j2"
|
||||||
|
dest: "{{ devture_systemd_docker_base_systemd_path }}/matrix-steam-bridge.service"
|
||||||
|
mode: 0644
|
||||||
|
|
||||||
|
- name: Ensure matrix-steam-bridge.service restarted, if necessary
|
||||||
|
ansible.builtin.service:
|
||||||
|
name: "matrix-steam-bridge.service"
|
||||||
|
state: restarted
|
||||||
|
daemon_reload: true
|
||||||
|
when: "matrix_steam_bridge_requires_restart | bool"
|
23
roles/custom/matrix-bridge-steam/tasks/setup_uninstall.yml
Normal file
23
roles/custom/matrix-bridge-steam/tasks/setup_uninstall.yml
Normal file
@@ -0,0 +1,23 @@
|
|||||||
|
# SPDX-FileCopyrightText: 2025 MDAD project contributors
|
||||||
|
#
|
||||||
|
# SPDX-License-Identifier: AGPL-3.0-or-later
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
- name: Check existence of matrix-steam-bridge service
|
||||||
|
ansible.builtin.stat:
|
||||||
|
path: "{{ devture_systemd_docker_base_systemd_path }}/matrix-steam-bridge.service"
|
||||||
|
register: matrix_steam_bridge_service_stat
|
||||||
|
|
||||||
|
- when: matrix_steam_bridge_service_stat.stat.exists | bool
|
||||||
|
block:
|
||||||
|
- name: Ensure matrix-steam-bridge is stopped
|
||||||
|
ansible.builtin.service:
|
||||||
|
name: matrix-steam-bridge
|
||||||
|
state: stopped
|
||||||
|
daemon_reload: true
|
||||||
|
|
||||||
|
- name: Ensure matrix-steam-bridge.service doesn't exist
|
||||||
|
ansible.builtin.file:
|
||||||
|
path: "{{ devture_systemd_docker_base_systemd_path }}/matrix-steam-bridge.service"
|
||||||
|
state: absent
|
29
roles/custom/matrix-bridge-steam/tasks/validate_config.yml
Normal file
29
roles/custom/matrix-bridge-steam/tasks/validate_config.yml
Normal file
@@ -0,0 +1,29 @@
|
|||||||
|
# SPDX-FileCopyrightText: 2025 MDAD project contributors
|
||||||
|
#
|
||||||
|
# SPDX-License-Identifier: AGPL-3.0-or-later
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
- name: Fail if required matrix_steam_bridge settings not defined
|
||||||
|
ansible.builtin.fail:
|
||||||
|
msg: >-
|
||||||
|
You need to define a required configuration setting (`{{ item.name }}`).
|
||||||
|
when: "item.when | bool and lookup('vars', item.name, default='') | string | length == 0"
|
||||||
|
with_items:
|
||||||
|
- {'name': 'matrix_steam_bridge_appservice_token', when: true}
|
||||||
|
- {'name': 'matrix_steam_bridge_homeserver_address', when: true}
|
||||||
|
- {'name': 'matrix_steam_bridge_homeserver_token', when: true}
|
||||||
|
- {'name': 'matrix_steam_bridge_database_hostname', when: "{{ matrix_steam_bridge_database_engine == 'postgres' }}"}
|
||||||
|
- {'name': 'matrix_steam_bridge_container_network', when: true}
|
||||||
|
- {'name': 'matrix_steam_bridge_metrics_proxying_hostname', when: "{{ matrix_steam_bridge_metrics_proxying_enabled }}"}
|
||||||
|
- {'name': 'matrix_steam_bridge_metrics_proxying_path_prefix', when: "{{ matrix_steam_bridge_metrics_proxying_enabled }}"}
|
||||||
|
# TODO: Confirm additional config isn't mandatory for public_media
|
||||||
|
|
||||||
|
- name: (Deprecation) Catch and report renamed matrix-steam-bridge variables
|
||||||
|
ansible.builtin.fail:
|
||||||
|
msg: >-
|
||||||
|
Your configuration contains a variable, which now has a different name.
|
||||||
|
Please rename the variable (`{{ item.old }}` -> `{{ item.new }}`) on your configuration file (vars.yml).
|
||||||
|
when: "lookup('ansible.builtin.varnames', ('^' + item.old + '$'), wantlist=True) | length > 0"
|
||||||
|
with_items:
|
||||||
|
- {'old': 'matrix_steam_bridge_docker_image_name_prefix', 'new': 'matrix_steam_bridge_docker_image_registry_prefix'}
|
450
roles/custom/matrix-bridge-steam/templates/config.yaml.j2
Normal file
450
roles/custom/matrix-bridge-steam/templates/config.yaml.j2
Normal file
@@ -0,0 +1,450 @@
|
|||||||
|
#jinja2: lstrip_blocks: True
|
||||||
|
# Network-specific config options
|
||||||
|
network:
|
||||||
|
# Proxy to use for all Steam connections.
|
||||||
|
proxy: null
|
||||||
|
# Alternative to proxy: an HTTP endpoint that returns the proxy URL to use for Steam connections.
|
||||||
|
get_proxy_url: null
|
||||||
|
|
||||||
|
# Displayname template for Steam users.
|
||||||
|
# {% raw %}
|
||||||
|
# {{ .DisplayName }} is replaced with the display name of the Steam user.
|
||||||
|
# {{ .Username }} is replaced with the username of the Steam user.
|
||||||
|
# {% endraw %}
|
||||||
|
displayname_template: {{ matrix_steam_bridge_network_displayname_template | to_json }}
|
||||||
|
|
||||||
|
# Maximum number of conversations to sync on startup
|
||||||
|
conversation_sync_limit: 20
|
||||||
|
|
||||||
|
steam_bridge_path: ./
|
||||||
|
steam_bridge_address: localhost:50051
|
||||||
|
steam_bridge_auto_start: true
|
||||||
|
steam_bridge_startup_timeout: 30
|
||||||
|
|
||||||
|
# Config options that affect the central bridge module.
|
||||||
|
bridge:
|
||||||
|
# The prefix for commands. Only required in non-management rooms.
|
||||||
|
command_prefix: {{ matrix_steam_bridge_command_prefix | to_json }}
|
||||||
|
# Should the bridge create a space for each login containing the rooms that account is in?
|
||||||
|
personal_filtering_spaces: true
|
||||||
|
# Whether the bridge should set names and avatars explicitly for DM portals.
|
||||||
|
# This is only necessary when using clients that don't support MSC4171.
|
||||||
|
private_chat_portal_meta: true
|
||||||
|
# Should events be handled asynchronously within portal rooms?
|
||||||
|
# If true, events may end up being out of order, but slow events won't block other ones.
|
||||||
|
# This is not yet safe to use.
|
||||||
|
async_events: false
|
||||||
|
# Should every user have their own portals rather than sharing them?
|
||||||
|
# By default, users who are in the same group on the remote network will be
|
||||||
|
# in the same Matrix room bridged to that group. If this is set to true,
|
||||||
|
# every user will get their own Matrix room instead.
|
||||||
|
split_portals: {{ matrix_steam_bridge_bridge_split_portals | to_json }}
|
||||||
|
# Should the bridge resend `m.bridge` events to all portals on startup?
|
||||||
|
resend_bridge_info: false
|
||||||
|
# Should `m.bridge` events be sent without a state key?
|
||||||
|
# By default, the bridge uses a unique key that won't conflict with other bridges.
|
||||||
|
no_bridge_info_state_key: false
|
||||||
|
# Should bridge connection status be sent to the management room as `m.notice` events?
|
||||||
|
# These contain the same data that can be posted to an external HTTP server using homeserver -> status_endpoint.
|
||||||
|
# Allowed values: none, errors, all
|
||||||
|
bridge_status_notices: errors
|
||||||
|
# How long after an unknown error should the bridge attempt a full reconnect?
|
||||||
|
# Must be at least 1 minute. The bridge will add an extra ±20% jitter to this value.
|
||||||
|
unknown_error_auto_reconnect: null
|
||||||
|
|
||||||
|
# Should leaving Matrix rooms be bridged as leaving groups on the remote network?
|
||||||
|
bridge_matrix_leave: false
|
||||||
|
# Should room tags only be synced when creating the portal? Tags mean things like favorite/pin and archive/low priority.
|
||||||
|
# Tags currently can't be synced back to the remote network, so a continuous sync means tagging from Matrix will be undone.
|
||||||
|
tag_only_on_create: true
|
||||||
|
# List of tags to allow bridging. If empty, no tags will be bridged.
|
||||||
|
only_bridge_tags: [m.favourite, m.lowpriority]
|
||||||
|
# Should room mute status only be synced when creating the portal?
|
||||||
|
# Like tags, mutes can't currently be synced back to the remote network.
|
||||||
|
mute_only_on_create: true
|
||||||
|
# Should the bridge check the db to ensure that incoming events haven't been handled before
|
||||||
|
deduplicate_matrix_messages: false
|
||||||
|
# Should cross-room reply metadata be bridged?
|
||||||
|
# Most Matrix clients don't support this and servers may reject such messages too.
|
||||||
|
cross_room_replies: false
|
||||||
|
|
||||||
|
|
||||||
|
# What should be done to portal rooms when a user logs out or is logged out?
|
||||||
|
# Permitted values:
|
||||||
|
# nothing - Do nothing, let the user stay in the portals
|
||||||
|
# kick - Remove the user from the portal rooms, but don't delete them
|
||||||
|
# unbridge - Remove all ghosts in the room and disassociate it from the remote chat
|
||||||
|
# delete - Remove all ghosts and users from the room (i.e. delete it)
|
||||||
|
cleanup_on_logout:
|
||||||
|
# Should cleanup on logout be enabled at all?
|
||||||
|
enabled: {{ matrix_steam_bridge_bridge_cleanup_on_logout_enabled | to_json }}
|
||||||
|
# Settings for manual logouts (explicitly initiated by the Matrix user)
|
||||||
|
manual:
|
||||||
|
# Action for private portals which will never be shared with other Matrix users.
|
||||||
|
private: {{ matrix_steam_bridge_bridge_cleanup_on_logout_manual_private | to_json }}
|
||||||
|
# Action for portals with a relay user configured.
|
||||||
|
relayed: {{ matrix_steam_bridge_bridge_cleanup_on_logout_manual_relayed | to_json }}
|
||||||
|
# Action for portals which may be shared, but don't currently have any other Matrix users.
|
||||||
|
shared_no_users: {{ matrix_steam_bridge_bridge_cleanup_on_logout_manual_shared_no_users | to_json }}
|
||||||
|
# Action for portals which have other logged-in Matrix users.
|
||||||
|
shared_has_users: {{ matrix_steam_bridge_bridge_cleanup_on_logout_manual_shared_has_users | to_json }}
|
||||||
|
# Settings for credentials being invalidated (initiated by the remote network, possibly through user action).
|
||||||
|
# Keys have the same meanings as in the manual section.
|
||||||
|
bad_credentials:
|
||||||
|
private: {{ matrix_steam_bridge_bridge_cleanup_on_logout_bad_credentials_private | to_json }}
|
||||||
|
relayed: {{ matrix_steam_bridge_bridge_cleanup_on_logout_bad_credentials_relayed | to_json }}
|
||||||
|
shared_no_users: {{ matrix_steam_bridge_bridge_cleanup_on_logout_bad_credentials_shared_no_users | to_json }}
|
||||||
|
shared_has_users: {{ matrix_steam_bridge_bridge_cleanup_on_logout_bad_credentials_shared_has_users | to_json }}
|
||||||
|
|
||||||
|
# Settings for relay mode
|
||||||
|
relay:
|
||||||
|
# Whether relay mode should be allowed. If allowed, the set-relay command can be used to turn any
|
||||||
|
# authenticated user into a relaybot for that chat.
|
||||||
|
enabled: false
|
||||||
|
# Should only admins be allowed to set themselves as relay users?
|
||||||
|
# If true, non-admins can only set users listed in default_relays as relays in a room.
|
||||||
|
admin_only: true
|
||||||
|
# List of user login IDs which anyone can set as a relay, as long as the relay user is in the room.
|
||||||
|
default_relays: []
|
||||||
|
# The formats to use when sending messages via the relaybot.
|
||||||
|
# Available variables:
|
||||||
|
# .Sender.UserID - The Matrix user ID of the sender.
|
||||||
|
# .Sender.Displayname - The display name of the sender (if set).
|
||||||
|
# .Sender.RequiresDisambiguation - Whether the sender's name may be confused with the name of another user in the room.
|
||||||
|
# .Sender.DisambiguatedName - The disambiguated name of the sender. This will be the displayname if set,
|
||||||
|
# plus the user ID in parentheses if the displayname is not unique.
|
||||||
|
# If the displayname is not set, this is just the user ID.
|
||||||
|
# .Message - The `formatted_body` field of the message.
|
||||||
|
# .Caption - The `formatted_body` field of the message, if it's a caption. Otherwise an empty string.
|
||||||
|
# .FileName - The name of the file being sent.
|
||||||
|
message_formats:
|
||||||
|
m.text: "{% raw %}<b>{{ .Sender.DisambiguatedName }}</b>: {{ .Message }}{% endraw %}"
|
||||||
|
m.notice: "{% raw %}<b>{{ .Sender.DisambiguatedName }}</b>: {{ .Message }}{% endraw %}"
|
||||||
|
m.emote: "{% raw %}* <b>{{ .Sender.DisambiguatedName }}</b> {{ .Message }}{% endraw %}"
|
||||||
|
m.file: "{% raw %}<b>{{ .Sender.DisambiguatedName }}</b> sent a file{{ if .Caption }}: {{ .Caption }}{{ end }}{% endraw %}"
|
||||||
|
m.image: "{% raw %}<b>{{ .Sender.DisambiguatedName }}</b> sent an image{{ if .Caption }}: {{ .Caption }}{{ end }}{% endraw %}"
|
||||||
|
m.audio: "{% raw %}<b>{{ .Sender.DisambiguatedName }}</b> sent an audio file{{ if .Caption }}: {{ .Caption }}{{ end }}{% endraw %}"
|
||||||
|
m.video: "{% raw %}<b>{{ .Sender.DisambiguatedName }}</b> sent a video{{ if .Caption }}: {{ .Caption }}{{ end }}{% endraw %}"
|
||||||
|
m.location: "{% raw %}<b>{{ .Sender.DisambiguatedName }}</b> sent a location{{ if .Caption }}: {{ .Caption }}{{ end }}{% endraw %}"
|
||||||
|
# For networks that support per-message displaynames (i.e. Slack and Discord), the template for those names.
|
||||||
|
# This has all the Sender variables available under message_formats (but without the .Sender prefix).
|
||||||
|
# Note that you need to manually remove the displayname from message_formats above.
|
||||||
|
displayname_format: "{% raw %}{{ .DisambiguatedName }}{% endraw %}"
|
||||||
|
|
||||||
|
# Permissions for using the bridge.
|
||||||
|
# Permitted values:
|
||||||
|
# relay - Talk through the relaybot (if enabled), no access otherwise
|
||||||
|
# commands - Access to use commands in the bridge, but not login.
|
||||||
|
# user - Access to use the bridge with puppeting.
|
||||||
|
# admin - Full access, user level with some additional administration tools.
|
||||||
|
# Permitted keys:
|
||||||
|
# * - All Matrix users
|
||||||
|
# domain - All users on that homeserver
|
||||||
|
# mxid - Specific user
|
||||||
|
permissions: {{ matrix_steam_bridge_bridge_permissions | to_json }}
|
||||||
|
|
||||||
|
# Config for the bridge's database.
|
||||||
|
database:
|
||||||
|
# The database type. "sqlite3-fk-wal" and "postgres" are supported.
|
||||||
|
type: postgres
|
||||||
|
# The database URI.
|
||||||
|
# SQLite: A raw file path is supported, but `file:<path>?_txlock=immediate` is recommended.
|
||||||
|
# https://github.com/mattn/go-sqlite3#connection-string
|
||||||
|
# Postgres: Connection string. For example, postgres://user:password@host/database?sslmode=disable
|
||||||
|
# To connect via Unix socket, use something like postgres:///dbname?host=/var/run/postgresql
|
||||||
|
uri: {{ matrix_steam_bridge_database_uri | to_json }}
|
||||||
|
# Maximum number of connections.
|
||||||
|
max_open_conns: 5
|
||||||
|
max_idle_conns: 2
|
||||||
|
# Maximum connection idle time and lifetime before they're closed. Disabled if null.
|
||||||
|
# Parsed with https://pkg.go.dev/time#ParseDuration
|
||||||
|
max_conn_idle_time: null
|
||||||
|
max_conn_lifetime: null
|
||||||
|
|
||||||
|
# Homeserver details.
|
||||||
|
homeserver:
|
||||||
|
# The address that this appservice can use to connect to the homeserver.
|
||||||
|
# Local addresses without HTTPS are generally recommended when the bridge is running on the same machine,
|
||||||
|
# but https also works if they run on different machines.
|
||||||
|
address: {{ matrix_steam_bridge_homeserver_address | to_json }}
|
||||||
|
# The domain of the homeserver (also known as server_name, used for MXIDs, etc).
|
||||||
|
domain: {{ matrix_steam_bridge_homeserver_domain | to_json }}
|
||||||
|
|
||||||
|
# What software is the homeserver running?
|
||||||
|
# Standard Matrix homeservers like Synapse, Dendrite and Conduit should just use "standard" here.
|
||||||
|
software: standard
|
||||||
|
# The URL to push real-time bridge status to.
|
||||||
|
# If set, the bridge will make POST requests to this URL whenever a user's remote network connection state changes.
|
||||||
|
# The bridge will use the appservice as_token to authorize requests.
|
||||||
|
status_endpoint:
|
||||||
|
# Endpoint for reporting per-message status.
|
||||||
|
# If set, the bridge will make POST requests to this URL when processing a message from Matrix.
|
||||||
|
# It will make one request when receiving the message (step BRIDGE), one after decrypting if applicable
|
||||||
|
# (step DECRYPTED) and one after sending to the remote network (step REMOTE). Errors will also be reported.
|
||||||
|
# The bridge will use the appservice as_token to authorize requests.
|
||||||
|
message_send_checkpoint_endpoint:
|
||||||
|
# Does the homeserver support https://github.com/matrix-org/matrix-spec-proposals/pull/2246?
|
||||||
|
async_media: {{ matrix_steam_bridge_homeserver_async_media | to_json }}
|
||||||
|
|
||||||
|
# Should the bridge use a websocket for connecting to the homeserver?
|
||||||
|
# The server side is currently not documented anywhere and is only implemented by mautrix-wsproxy,
|
||||||
|
# mautrix-asmux (deprecated), and hungryserv (proprietary).
|
||||||
|
websocket: false
|
||||||
|
# How often should the websocket be pinged? Pinging will be disabled if this is zero.
|
||||||
|
ping_interval_seconds: 0
|
||||||
|
|
||||||
|
# Application service host/registration related details.
|
||||||
|
# Changing these values requires regeneration of the registration (except when noted otherwise)
|
||||||
|
appservice:
|
||||||
|
# The address that the homeserver can use to connect to this appservice.
|
||||||
|
# Like the homeserver address, a local non-https address is recommended when the bridge is on the same machine.
|
||||||
|
# If the bridge is elsewhere, you must secure the connection yourself (e.g. with https or wireguard)
|
||||||
|
# If you want to use https, you need to use a reverse proxy. The bridge does not have TLS support built in.
|
||||||
|
address: {{ matrix_steam_bridge_appservice_address | to_json }}
|
||||||
|
# A public address that external services can use to reach this appservice.
|
||||||
|
# This is only needed for things like public media. A reverse proxy is generally necessary when using this field.
|
||||||
|
# This value doesn't affect the registration file.
|
||||||
|
public_address: {{ matrix_steam_bridge_appservice_public_address | to_json }}
|
||||||
|
|
||||||
|
# The hostname and port where this appservice should listen.
|
||||||
|
# For Docker, you generally have to change the hostname to 0.0.0.0.
|
||||||
|
hostname: 0.0.0.0
|
||||||
|
port: {{ matrix_steam_bridge_appservice_port }}
|
||||||
|
|
||||||
|
# The unique ID of this appservice.
|
||||||
|
id: steam
|
||||||
|
# Appservice bot details.
|
||||||
|
bot:
|
||||||
|
# Username of the appservice bot.
|
||||||
|
username: {{ matrix_steam_bridge_appservice_bot_username | to_json }}
|
||||||
|
# Display name and avatar for bot. Set to "remove" to remove display name/avatar, leave empty
|
||||||
|
# to leave display name/avatar as-is.
|
||||||
|
displayname: {{ matrix_steam_bridge_appservice_bot_displayname | to_json(ensure_ascii=False) }}
|
||||||
|
avatar: {{ matrix_steam_bridge_appservice_bot_avatar | to_json }}
|
||||||
|
|
||||||
|
# Whether to receive ephemeral events via appservice transactions.
|
||||||
|
ephemeral_events: true
|
||||||
|
# Should incoming events be handled asynchronously?
|
||||||
|
# This may be necessary for large public instances with lots of messages going through.
|
||||||
|
# However, messages will not be guaranteed to be bridged in the same order they were sent in.
|
||||||
|
# This value doesn't affect the registration file.
|
||||||
|
async_transactions: false
|
||||||
|
|
||||||
|
# Authentication tokens for AS <-> HS communication. Autogenerated; do not modify.
|
||||||
|
as_token: {{ matrix_steam_bridge_appservice_token | to_json }}
|
||||||
|
hs_token: {{ matrix_steam_bridge_homeserver_token | to_json }}
|
||||||
|
|
||||||
|
# Localpart template of MXIDs for remote users.
|
||||||
|
# {% raw %}{{.}}{% endraw %} is replaced with the internal ID of the user.
|
||||||
|
username_template: "{% raw %}steam_{{.}}{% endraw %}"
|
||||||
|
|
||||||
|
# Config options that affect the Matrix connector of the bridge.
|
||||||
|
matrix:
|
||||||
|
# Whether the bridge should send the message status as a custom com.beeper.message_send_status event.
|
||||||
|
message_status_events: false
|
||||||
|
# Whether the bridge should send a read receipt after successfully bridging a message.
|
||||||
|
delivery_receipts: false
|
||||||
|
# Whether the bridge should send error notices via m.notice events when a message fails to bridge.
|
||||||
|
message_error_notices: true
|
||||||
|
# Whether the bridge should update the m.direct account data event when double puppeting is enabled.
|
||||||
|
sync_direct_chat_list: true
|
||||||
|
# Whether created rooms should have federation enabled. If false, created portal rooms
|
||||||
|
# will never be federated. Changing this option requires recreating rooms.
|
||||||
|
federate_rooms: {{ matrix_steam_bridge_matrix_federate_rooms | to_json }}
|
||||||
|
# The threshold as bytes after which the bridge should roundtrip uploads via the disk
|
||||||
|
# rather than keeping the whole file in memory.
|
||||||
|
upload_file_threshold: 5242880
|
||||||
|
|
||||||
|
# Segment-compatible analytics endpoint for tracking some events, like provisioning API login and encryption errors.
|
||||||
|
analytics:
|
||||||
|
# API key to send with tracking requests. Tracking is disabled if this is null.
|
||||||
|
token: null
|
||||||
|
# Address to send tracking requests to.
|
||||||
|
url: https://api.segment.io/v1/track
|
||||||
|
# Optional user ID for tracking events. If null, defaults to using Matrix user ID.
|
||||||
|
user_id: null
|
||||||
|
|
||||||
|
# Settings for provisioning API
|
||||||
|
provisioning:
|
||||||
|
# Prefix for the provisioning API paths.
|
||||||
|
prefix: /_matrix/provision
|
||||||
|
# Shared secret for authentication. If set to "generate" or null, a random secret will be generated,
|
||||||
|
# or if set to "disable", the provisioning API will be disabled.
|
||||||
|
shared_secret: {{ matrix_steam_bridge_provisioning_shared_secret | to_json }}
|
||||||
|
# Whether to allow provisioning API requests to be authed using Matrix access tokens.
|
||||||
|
# This follows the same rules as double puppeting to determine which server to contact to check the token,
|
||||||
|
# which means that by default, it only works for users on the same server as the bridge.
|
||||||
|
allow_matrix_auth: true
|
||||||
|
# Enable debug API at /debug with provisioning authentication.
|
||||||
|
debug_endpoints: false
|
||||||
|
|
||||||
|
# Some networks require publicly accessible media download links (e.g. for user avatars when using Discord webhooks).
|
||||||
|
# These settings control whether the bridge will provide such public media access.
|
||||||
|
# TODO: Update with public_media config once it's figured out
|
||||||
|
public_media:
|
||||||
|
# Should public media be enabled at all?
|
||||||
|
# The public_address field under the appservice section MUST be set when enabling public media.
|
||||||
|
enabled: {{ matrix_steam_bridge_public_media_enabled | to_json }}
|
||||||
|
# A key for signing public media URLs.
|
||||||
|
# If set to "generate", a random key will be generated.
|
||||||
|
signing_key: {{ matrix_steam_bridge_public_media_signing_key | to_json }}
|
||||||
|
# Number of seconds that public media URLs are valid for.
|
||||||
|
# If set to 0, URLs will never expire.
|
||||||
|
expiry: {{ matrix_steam_bridge_public_media_expiry | to_json }}
|
||||||
|
# Length of hash to use for public media URLs. Must be between 0 and 32.
|
||||||
|
hash_length: {{ matrix_steam_bridge_public_media_hash_length | to_json }}
|
||||||
|
|
||||||
|
# Settings for converting remote media to custom mxc:// URIs instead of reuploading.
|
||||||
|
# More details can be found at https://docs.mau.fi/bridges/go/discord/direct-media.html
|
||||||
|
direct_media:
|
||||||
|
# Should custom mxc:// URIs be used instead of reuploading media?
|
||||||
|
enabled: false
|
||||||
|
# The server name to use for the custom mxc:// URIs.
|
||||||
|
# This server name will effectively be a real Matrix server, it just won't implement anything other than media.
|
||||||
|
# You must either set up .well-known delegation from this domain to the bridge, or proxy the domain directly to the bridge.
|
||||||
|
server_name: media.example.com
|
||||||
|
# Optionally a custom .well-known response. This defaults to `server_name:443`
|
||||||
|
well_known_response:
|
||||||
|
# Optionally specify a custom prefix for the media ID part of the MXC URI.
|
||||||
|
media_id_prefix:
|
||||||
|
# If the remote network supports media downloads over HTTP, then the bridge will use MSC3860/MSC3916
|
||||||
|
# media download redirects if the requester supports it. Optionally, you can force redirects
|
||||||
|
# and not allow proxying at all by setting this to false.
|
||||||
|
# This option does nothing if the remote network does not support media downloads over HTTP.
|
||||||
|
allow_proxy: true
|
||||||
|
# Matrix server signing key to make the federation tester pass, same format as synapse's .signing.key file.
|
||||||
|
# This key is also used to sign the mxc:// URIs to ensure only the bridge can generate them.
|
||||||
|
server_key: ""
|
||||||
|
|
||||||
|
# Settings for backfilling messages.
|
||||||
|
# Note that the exact way settings are applied depends on the network connector.
|
||||||
|
# See https://docs.mau.fi/bridges/general/backfill.html for more details.
|
||||||
|
backfill:
|
||||||
|
# Whether to do backfilling at all.
|
||||||
|
enabled: {{ matrix_steam_bridge_backfill_enabled | to_json }}
|
||||||
|
# Maximum number of messages to backfill in empty rooms.
|
||||||
|
max_initial_messages: {{ matrix_steam_bridge_backfill_max_initial_messages | to_json }}
|
||||||
|
# Maximum number of missed messages to backfill after bridge restarts.
|
||||||
|
max_catchup_messages: {{ matrix_steam_bridge_backfill_max_catchup_messages | to_json }}
|
||||||
|
# If a backfilled chat is older than this number of hours,
|
||||||
|
# mark it as read even if it's unread on the remote network.
|
||||||
|
unread_hours_threshold: 720
|
||||||
|
# Settings for backfilling threads within other backfills.
|
||||||
|
threads:
|
||||||
|
# Maximum number of messages to backfill in a new thread.
|
||||||
|
max_initial_messages: 50
|
||||||
|
# Settings for the backwards backfill queue. This only applies when connecting to
|
||||||
|
# Beeper as standard Matrix servers don't support inserting messages into history.
|
||||||
|
queue:
|
||||||
|
# Should the backfill queue be enabled?
|
||||||
|
enabled: false
|
||||||
|
# Number of messages to backfill in one batch.
|
||||||
|
batch_size: 100
|
||||||
|
# Delay between batches in seconds.
|
||||||
|
batch_delay: 20
|
||||||
|
# Maximum number of batches to backfill per portal.
|
||||||
|
# If set to -1, all available messages will be backfilled.
|
||||||
|
max_batches: -1
|
||||||
|
# Optional network-specific overrides for max batches.
|
||||||
|
# Interpretation of this field depends on the network connector.
|
||||||
|
max_batches_override: {}
|
||||||
|
|
||||||
|
# Settings for enabling double puppeting
|
||||||
|
double_puppet:
|
||||||
|
# Servers to always allow double puppeting from.
|
||||||
|
# This is only for other servers and should NOT contain the server the bridge is on.
|
||||||
|
servers: {}
|
||||||
|
# Whether to allow client API URL discovery for other servers. When using this option,
|
||||||
|
# users on other servers can use double puppeting even if their server URLs aren't
|
||||||
|
# explicitly added to the servers map above.
|
||||||
|
allow_discovery: false
|
||||||
|
# Shared secrets for automatic double puppeting.
|
||||||
|
# See https://docs.mau.fi/bridges/general/double-puppeting.html for instructions.
|
||||||
|
secrets: {{ matrix_steam_bridge_double_puppet_secrets | to_json }}
|
||||||
|
|
||||||
|
# End-to-bridge encryption support options.
|
||||||
|
#
|
||||||
|
# See https://docs.mau.fi/bridges/general/end-to-bridge-encryption.html for more info.
|
||||||
|
encryption:
|
||||||
|
# Whether to enable encryption at all. If false, the bridge will not function in encrypted rooms.
|
||||||
|
allow: {{ matrix_steam_bridge_bridge_encryption_allow | to_json }}
|
||||||
|
# Whether to force-enable encryption in all bridged rooms.
|
||||||
|
default: {{ matrix_steam_bridge_bridge_encryption_default | to_json }}
|
||||||
|
# Whether to require all messages to be encrypted and drop any unencrypted messages.
|
||||||
|
require: {{ matrix_steam_bridge_bridge_encryption_require | to_json }}
|
||||||
|
# Whether to use MSC2409/MSC3202 instead of /sync long polling for receiving encryption-related data.
|
||||||
|
# This option is not yet compatible with standard Matrix servers like Synapse and should not be used.
|
||||||
|
appservice: {{ matrix_steam_bridge_bridge_encryption_appservice | to_json }}
|
||||||
|
# Whether to use MSC4190 instead of appservice login to create the bridge bot device.
|
||||||
|
# Requires the homeserver to support MSC4190 and the device masquerading parts of MSC3202.
|
||||||
|
# Only relevant when using end-to-bridge encryption, required when using encryption with next-gen auth (MSC3861).
|
||||||
|
# Changing this option requires updating the appservice registration file.
|
||||||
|
msc4190: {{ matrix_steam_bridge_msc4190_enabled | to_json }}
|
||||||
|
# Enable key sharing? If enabled, key requests for rooms where users are in will be fulfilled.
|
||||||
|
# You must use a client that supports requesting keys from other users to use this feature.
|
||||||
|
allow_key_sharing: {{ matrix_steam_bridge_bridge_encryption_key_sharing_allow | to_json }}
|
||||||
|
# Pickle key for encrypting encryption keys in the bridge database.
|
||||||
|
# If set to generate, a random key will be generated.
|
||||||
|
pickle_key: {{ matrix_steam_bridge_bridge_encryption_pickle_key | to_json }}
|
||||||
|
# Options for deleting megolm sessions from the bridge.
|
||||||
|
delete_keys:
|
||||||
|
# Beeper-specific: delete outbound sessions when hungryserv confirms
|
||||||
|
# that the user has uploaded the key to key backup.
|
||||||
|
delete_outbound_on_ack: false
|
||||||
|
# Don't store outbound sessions in the inbound table.
|
||||||
|
dont_store_outbound: false
|
||||||
|
# Ratchet megolm sessions forward after decrypting messages.
|
||||||
|
ratchet_on_decrypt: false
|
||||||
|
# Delete fully used keys (index >= max_messages) after decrypting messages.
|
||||||
|
delete_fully_used_on_decrypt: false
|
||||||
|
# Delete previous megolm sessions from same device when receiving a new one.
|
||||||
|
delete_prev_on_new_session: false
|
||||||
|
# Delete megolm sessions received from a device when the device is deleted.
|
||||||
|
delete_on_device_delete: false
|
||||||
|
# Periodically delete megolm sessions when 2x max_age has passed since receiving the session.
|
||||||
|
periodically_delete_expired: false
|
||||||
|
# Delete inbound megolm sessions that don't have the received_at field used for
|
||||||
|
# automatic ratcheting and expired session deletion. This is meant as a migration
|
||||||
|
# to delete old keys prior to the bridge update.
|
||||||
|
delete_outdated_inbound: false
|
||||||
|
# What level of device verification should be required from users?
|
||||||
|
#
|
||||||
|
# Valid levels:
|
||||||
|
# unverified - Send keys to all device in the room.
|
||||||
|
# cross-signed-untrusted - Require valid cross-signing, but trust all cross-signing keys.
|
||||||
|
# cross-signed-tofu - Require valid cross-signing, trust cross-signing keys on first use (and reject changes).
|
||||||
|
# cross-signed-verified - Require valid cross-signing, plus a valid user signature from the bridge bot.
|
||||||
|
# Note that creating user signatures from the bridge bot is not currently possible.
|
||||||
|
# verified - Require manual per-device verification
|
||||||
|
# (currently only possible by modifying the `trust` column in the `crypto_device` database table).
|
||||||
|
verification_levels:
|
||||||
|
# Minimum level for which the bridge should send keys to when bridging messages from the remote network to Matrix.
|
||||||
|
receive: unverified
|
||||||
|
# Minimum level that the bridge should accept for incoming Matrix messages.
|
||||||
|
send: unverified
|
||||||
|
# Minimum level that the bridge should require for accepting key requests.
|
||||||
|
share: cross-signed-tofu
|
||||||
|
# Options for Megolm room key rotation. These options allow you to configure the m.room.encryption event content.
|
||||||
|
# See https://spec.matrix.org/v1.10/client-server-api/#mroomencryption for more information about that event.
|
||||||
|
rotation:
|
||||||
|
# Enable custom Megolm room key rotation settings. Note that these
|
||||||
|
# settings will only apply to rooms created after this option is set.
|
||||||
|
enable_custom: false
|
||||||
|
# The maximum number of milliseconds a session should be used
|
||||||
|
# before changing it. The Matrix spec recommends 604800000 (a week)
|
||||||
|
# as the default.
|
||||||
|
milliseconds: 604800000
|
||||||
|
# The maximum number of messages that should be sent with a given a
|
||||||
|
# session before changing it. The Matrix spec recommends 100 as the
|
||||||
|
# default.
|
||||||
|
messages: 100
|
||||||
|
# Disable rotating keys when a user's devices change?
|
||||||
|
# You should not enable this option unless you understand all the implications.
|
||||||
|
disable_device_change_key_rotation: false
|
||||||
|
|
||||||
|
# Logging config. See https://github.com/tulir/zeroconfig for details.
|
||||||
|
logging:
|
||||||
|
min_level: {{ matrix_steam_bridge_logging_level | to_json }}
|
||||||
|
writers:
|
||||||
|
- type: stdout
|
||||||
|
format: pretty-colored
|
@@ -0,0 +1,3 @@
|
|||||||
|
SPDX-FileCopyrightText: 2025 MDAD project contributors
|
||||||
|
|
||||||
|
SPDX-License-Identifier: AGPL-3.0-or-later
|
78
roles/custom/matrix-bridge-steam/templates/labels.j2
Normal file
78
roles/custom/matrix-bridge-steam/templates/labels.j2
Normal file
@@ -0,0 +1,78 @@
|
|||||||
|
{#
|
||||||
|
SPDX-FileCopyrightText: 2025 MDAD project contributors
|
||||||
|
|
||||||
|
SPDX-License-Identifier: AGPL-3.0-or-later
|
||||||
|
#}
|
||||||
|
|
||||||
|
{% if matrix_steam_bridge_container_labels_traefik_enabled %}
|
||||||
|
traefik.enable=true
|
||||||
|
|
||||||
|
{% if matrix_steam_bridge_container_labels_traefik_docker_network %}
|
||||||
|
traefik.docker.network={{ matrix_steam_bridge_container_labels_traefik_docker_network }}
|
||||||
|
{% endif %}
|
||||||
|
|
||||||
|
traefik.http.services.matrix-steam-bridge.loadbalancer.server.port={{ matrix_steam_bridge_appservice_port }}
|
||||||
|
traefik.http.services.matrix-steam-bridge-metrics.loadbalancer.server.port=8000
|
||||||
|
|
||||||
|
{% if matrix_steam_bridge_container_labels_metrics_enabled %}
|
||||||
|
############################################################
|
||||||
|
# #
|
||||||
|
# Metrics #
|
||||||
|
# #
|
||||||
|
############################################################
|
||||||
|
|
||||||
|
{% if matrix_steam_bridge_container_labels_metrics_middleware_basic_auth_enabled %}
|
||||||
|
traefik.http.middlewares.matrix-steam-bridge-metrics-basic-auth.basicauth.users={{ matrix_steam_bridge_container_labels_metrics_middleware_basic_auth_users }}
|
||||||
|
traefik.http.routers.matrix-steam-bridge-metrics.middlewares=matrix-steam-bridge-metrics-basic-auth
|
||||||
|
{% endif %}
|
||||||
|
|
||||||
|
traefik.http.routers.matrix-steam-bridge-metrics.rule={{ matrix_steam_bridge_container_labels_metrics_traefik_rule }}
|
||||||
|
|
||||||
|
{% if matrix_steam_bridge_container_labels_metrics_traefik_priority | int > 0 %}
|
||||||
|
traefik.http.routers.matrix-steam-bridge-metrics.priority={{ matrix_steam_bridge_container_labels_metrics_traefik_priority }}
|
||||||
|
{% endif %}
|
||||||
|
|
||||||
|
traefik.http.routers.matrix-steam-bridge-metrics.service=matrix-steam-bridge-metrics
|
||||||
|
traefik.http.routers.matrix-steam-bridge-metrics.entrypoints={{ matrix_steam_bridge_container_labels_metrics_traefik_entrypoints }}
|
||||||
|
|
||||||
|
traefik.http.routers.matrix-steam-bridge-metrics.tls={{ matrix_steam_bridge_container_labels_metrics_traefik_tls | to_json }}
|
||||||
|
{% if matrix_steam_bridge_container_labels_metrics_traefik_tls %}
|
||||||
|
traefik.http.routers.matrix-steam-bridge-metrics.tls.certResolver={{ matrix_steam_bridge_container_labels_metrics_traefik_tls_certResolver }}
|
||||||
|
{% endif %}
|
||||||
|
|
||||||
|
############################################################
|
||||||
|
# #
|
||||||
|
# /Metrics #
|
||||||
|
# #
|
||||||
|
############################################################
|
||||||
|
{% endif %}
|
||||||
|
|
||||||
|
|
||||||
|
{% if matrix_steam_bridge_public_media_enabled %}
|
||||||
|
############################################################
|
||||||
|
# #
|
||||||
|
# Public Media #
|
||||||
|
# #
|
||||||
|
############################################################
|
||||||
|
|
||||||
|
# Router for public media
|
||||||
|
traefik.http.routers.matrix-steam-bridge-public-media.rule=Host(`{{ matrix_server_fqn_matrix }}`) && PathPrefix(`/_mautrix/publicmedia/{{ matrix_domain }}/`)
|
||||||
|
traefik.http.routers.matrix-steam-bridge-public-media.service=matrix-steam-bridge
|
||||||
|
traefik.http.routers.matrix-steam-bridge-public-media.entrypoints={{ matrix_steam_bridge_container_labels_traefik_entrypoints }}
|
||||||
|
traefik.http.routers.matrix-steam-bridge-public-media.tls={{ matrix_steam_bridge_container_labels_traefik_tls | to_json }}
|
||||||
|
{% if matrix_steam_bridge_container_labels_traefik_tls %}
|
||||||
|
traefik.http.routers.matrix-steam-bridge-public-media.tls.certResolver={{ matrix_steam_bridge_container_labels_traefik_tls_certResolver }}
|
||||||
|
{% endif %}
|
||||||
|
|
||||||
|
|
||||||
|
############################################################
|
||||||
|
# #
|
||||||
|
# /Public Media #
|
||||||
|
# #
|
||||||
|
############################################################
|
||||||
|
{% endif %}
|
||||||
|
|
||||||
|
|
||||||
|
{% endif %}
|
||||||
|
|
||||||
|
{{ matrix_steam_bridge_container_labels_additional_labels }}
|
@@ -0,0 +1,48 @@
|
|||||||
|
#jinja2: lstrip_blocks: True
|
||||||
|
[Unit]
|
||||||
|
Description=Matrix Steam bridge
|
||||||
|
{% for service in matrix_steam_bridge_systemd_required_services_list %}
|
||||||
|
Requires={{ service }}
|
||||||
|
After={{ service }}
|
||||||
|
{% endfor %}
|
||||||
|
{% for service in matrix_steam_bridge_systemd_wanted_services_list %}
|
||||||
|
Wants={{ service }}
|
||||||
|
{% endfor %}
|
||||||
|
DefaultDependencies=no
|
||||||
|
|
||||||
|
[Service]
|
||||||
|
Type=simple
|
||||||
|
Environment="HOME={{ devture_systemd_docker_base_systemd_unit_home_path }}"
|
||||||
|
ExecStartPre=-{{ devture_systemd_docker_base_host_command_sh }} -c '{{ devture_systemd_docker_base_host_command_docker }} stop -t {{ devture_systemd_docker_base_container_stop_grace_time_seconds }} matrix-steam-bridge 2>/dev/null || true'
|
||||||
|
ExecStartPre=-{{ devture_systemd_docker_base_host_command_sh }} -c '{{ devture_systemd_docker_base_host_command_docker }} rm matrix-steam-bridge 2>/dev/null || true'
|
||||||
|
|
||||||
|
ExecStartPre={{ devture_systemd_docker_base_host_command_docker }} create \
|
||||||
|
--rm \
|
||||||
|
--name=matrix-steam-bridge \
|
||||||
|
--log-driver=none \
|
||||||
|
--user={{ matrix_user_uid }}:{{ matrix_user_gid }} \
|
||||||
|
--cap-drop=ALL \
|
||||||
|
--network={{ matrix_steam_bridge_container_network }} \
|
||||||
|
--mount type=bind,src={{ matrix_steam_bridge_config_path }},dst=/app/config,ro \
|
||||||
|
--mount type=bind,src={{ matrix_steam_bridge_data_path }},dst=/app/data \
|
||||||
|
--label-file={{ matrix_steam_bridge_base_path }}/labels \
|
||||||
|
{% for arg in matrix_steam_bridge_container_extra_arguments %}
|
||||||
|
{{ arg }} \
|
||||||
|
{% endfor %}
|
||||||
|
{{ matrix_steam_bridge_docker_image }} \
|
||||||
|
/usr/bin/steam -c /app/config/config.yaml -r /app/config/registration.yaml --no-update
|
||||||
|
|
||||||
|
{% for network in matrix_steam_bridge_container_additional_networks %}
|
||||||
|
ExecStartPre={{ devture_systemd_docker_base_host_command_docker }} network connect {{ network }} matrix-steam-bridge
|
||||||
|
{% endfor %}
|
||||||
|
|
||||||
|
ExecStart={{ devture_systemd_docker_base_host_command_docker }} start --attach matrix-steam-bridge
|
||||||
|
|
||||||
|
ExecStop=-{{ devture_systemd_docker_base_host_command_sh }} -c '{{ devture_systemd_docker_base_host_command_docker }} stop -t {{ devture_systemd_docker_base_container_stop_grace_time_seconds }} matrix-steam-bridge 2>/dev/null || true'
|
||||||
|
ExecStop=-{{ devture_systemd_docker_base_host_command_sh }} -c '{{ devture_systemd_docker_base_host_command_docker }} rm matrix-steam-bridge 2>/dev/null || true'
|
||||||
|
Restart=always
|
||||||
|
RestartSec=30
|
||||||
|
SyslogIdentifier=matrix-steam-bridge
|
||||||
|
|
||||||
|
[Install]
|
||||||
|
WantedBy=multi-user.target
|
@@ -0,0 +1,3 @@
|
|||||||
|
SPDX-FileCopyrightText: 2025 MDAD project contributors
|
||||||
|
|
||||||
|
SPDX-License-Identifier: AGPL-3.0-or-later
|
@@ -84,6 +84,7 @@
|
|||||||
- custom/matrix-bridge-mx-puppet-instagram
|
- custom/matrix-bridge-mx-puppet-instagram
|
||||||
- custom/matrix-bridge-postmoogle
|
- custom/matrix-bridge-postmoogle
|
||||||
- custom/matrix-bridge-sms
|
- custom/matrix-bridge-sms
|
||||||
|
- custom/matrix-bridge-steam
|
||||||
- custom/matrix-bridge-heisenbridge
|
- custom/matrix-bridge-heisenbridge
|
||||||
- custom/matrix-bridge-hookshot
|
- custom/matrix-bridge-hookshot
|
||||||
- custom/matrix-bot-matrix-reminder-bot
|
- custom/matrix-bot-matrix-reminder-bot
|
||||||
|
Reference in New Issue
Block a user