2022-02-05 20:32:54 +00:00
|
|
|
---
|
2020-07-01 11:46:58 +00:00
|
|
|
# Mx Puppet Steam is a Matrix <-> Steam bridge
|
2022-07-16 20:59:21 +00:00
|
|
|
# Project source code URL: https://github.com/icewind1991/mx-puppet-steam
|
2020-07-01 11:46:58 +00:00
|
|
|
|
|
|
|
matrix_mx_puppet_steam_enabled: true
|
|
|
|
|
|
|
|
matrix_mx_puppet_steam_container_image_self_build: false
|
2022-07-16 20:59:21 +00:00
|
|
|
matrix_mx_puppet_steam_container_image_self_build_repo: "https://github.com/icewind1991/mx-puppet-steam.git"
|
2022-07-18 11:43:52 +00:00
|
|
|
matrix_mx_puppet_steam_container_image_self_build_repo_version: "{{ 'master' if matrix_mx_puppet_steam_version == 'latest' else matrix_mx_puppet_steam_version }}"
|
2020-07-01 11:46:58 +00:00
|
|
|
|
|
|
|
# Controls whether the mx-puppet-steam container exposes its HTTP port (tcp/8432 in the container).
|
|
|
|
#
|
|
|
|
# Takes an "<ip>:<port>" or "<port>" value (e.g. "127.0.0.1:8432"), or empty string to not expose.
|
|
|
|
matrix_mx_puppet_steam_container_http_host_bind_port: ''
|
|
|
|
|
2023-10-06 12:14:03 +00:00
|
|
|
# renovate: datasource=docker depName=icewind1991/mx-puppet-steam
|
2021-02-20 17:08:28 +00:00
|
|
|
matrix_mx_puppet_steam_version: latest
|
|
|
|
matrix_mx_puppet_steam_docker_image: "{{ matrix_mx_puppet_steam_docker_image_name_prefix }}icewind1991/mx-puppet-steam:{{ matrix_mx_puppet_steam_version }}"
|
2021-04-12 12:39:16 +00:00
|
|
|
matrix_mx_puppet_steam_docker_image_name_prefix: "{{ 'localhost/' if matrix_mx_puppet_steam_container_image_self_build else matrix_container_global_registry_prefix }}"
|
2020-07-01 11:46:58 +00:00
|
|
|
matrix_mx_puppet_steam_docker_image_force_pull: "{{ matrix_mx_puppet_steam_docker_image.endswith(':latest') }}"
|
|
|
|
|
|
|
|
matrix_mx_puppet_steam_base_path: "{{ matrix_base_data_path }}/mx-puppet-steam"
|
|
|
|
matrix_mx_puppet_steam_config_path: "{{ matrix_mx_puppet_steam_base_path }}/config"
|
|
|
|
matrix_mx_puppet_steam_data_path: "{{ matrix_mx_puppet_steam_base_path }}/data"
|
|
|
|
matrix_mx_puppet_steam_docker_src_files_path: "{{ matrix_mx_puppet_steam_base_path }}/docker-src"
|
|
|
|
|
|
|
|
matrix_mx_puppet_steam_appservice_port: "8432"
|
|
|
|
|
2024-01-07 15:04:23 +00:00
|
|
|
matrix_mx_puppet_steam_homeserver_address: ""
|
2020-07-01 11:46:58 +00:00
|
|
|
matrix_mx_puppet_steam_homeserver_domain: '{{ matrix_domain }}'
|
|
|
|
matrix_mx_puppet_steam_appservice_address: 'http://matrix-mx-puppet-steam:{{ matrix_mx_puppet_steam_appservice_port }}'
|
|
|
|
|
2024-10-19 05:01:08 +00:00
|
|
|
# "@user:example.com" to allow a specific user
|
2024-10-17 17:32:31 +00:00
|
|
|
# "@.*:example.com" to allow users on a specific homeserver
|
2020-07-01 11:46:58 +00:00
|
|
|
# "@.*" to allow anyone
|
|
|
|
matrix_mx_puppet_steam_provisioning_whitelist:
|
2022-07-18 09:28:39 +00:00
|
|
|
- "@.*:{{ matrix_domain | regex_escape }}"
|
2020-07-01 11:46:58 +00:00
|
|
|
|
|
|
|
# Leave empty to disable blacklist
|
2024-10-19 05:01:08 +00:00
|
|
|
# "@user:example.com" to disallow a specific user
|
|
|
|
# "@.*:example.com" to disallow users on a specific homeserver
|
2020-07-01 11:46:58 +00:00
|
|
|
matrix_mx_puppet_steam_provisioning_blacklist: []
|
|
|
|
|
2024-01-08 15:45:19 +00:00
|
|
|
matrix_mx_puppet_steam_container_network: ""
|
|
|
|
|
|
|
|
matrix_mx_puppet_steam_container_additional_networks: "{{ matrix_mx_puppet_steam_container_additional_networks_auto + matrix_mx_puppet_steam_container_additional_networks_custom }}"
|
|
|
|
matrix_mx_puppet_steam_container_additional_networks_auto: []
|
|
|
|
matrix_mx_puppet_steam_container_additional_networks_custom: []
|
|
|
|
|
2020-07-01 11:46:58 +00:00
|
|
|
# A list of extra arguments to pass to the container
|
|
|
|
matrix_mx_puppet_steam_container_extra_arguments: []
|
|
|
|
|
|
|
|
# List of systemd services that matrix-puppet-steam.service depends on.
|
2024-01-08 15:45:19 +00:00
|
|
|
matrix_mx_puppet_steam_systemd_required_services_list: "{{ matrix_mx_puppet_steam_systemd_required_services_list_default + matrix_mx_puppet_steam_systemd_required_services_list_auto + matrix_mx_puppet_steam_systemd_required_services_list_custom }}"
|
2024-06-04 10:14:34 +00:00
|
|
|
matrix_mx_puppet_steam_systemd_required_services_list_default: "{{ [devture_systemd_docker_base_docker_service_name] if devture_systemd_docker_base_docker_service_name else [] }}"
|
2024-01-08 15:45:19 +00:00
|
|
|
matrix_mx_puppet_steam_systemd_required_services_list_auto: []
|
|
|
|
matrix_mx_puppet_steam_systemd_required_services_list_custom: []
|
2020-07-01 11:46:58 +00:00
|
|
|
|
|
|
|
# List of systemd services that matrix-puppet-steam.service wants
|
|
|
|
matrix_mx_puppet_steam_systemd_wanted_services_list: []
|
|
|
|
|
|
|
|
matrix_mx_puppet_steam_appservice_token: ''
|
|
|
|
matrix_mx_puppet_steam_homeserver_token: ''
|
|
|
|
|
|
|
|
# Can be set to enable automatic double-puppeting via Shared Secret Auth (https://github.com/devture/matrix-synapse-shared-secret-auth).
|
|
|
|
matrix_mx_puppet_steam_login_shared_secret: ''
|
|
|
|
|
2024-01-08 15:45:19 +00:00
|
|
|
matrix_mx_puppet_steam_presence_enabled: true
|
|
|
|
matrix_mx_puppet_steam_presence_interval: 5000
|
|
|
|
|
2020-12-14 11:38:51 +00:00
|
|
|
matrix_mx_puppet_steam_database_engine: sqlite
|
2020-12-22 14:51:59 +00:00
|
|
|
|
|
|
|
matrix_mx_puppet_steam_sqlite_database_path_local: "{{ matrix_mx_puppet_steam_data_path }}/database.db"
|
|
|
|
matrix_mx_puppet_steam_sqlite_database_path_in_container: "/data/database.db"
|
|
|
|
|
2020-12-14 11:38:51 +00:00
|
|
|
matrix_mx_puppet_steam_database_username: matrix_mx_puppet_steam
|
|
|
|
matrix_mx_puppet_steam_database_password: ~
|
2022-11-27 06:23:43 +00:00
|
|
|
matrix_mx_puppet_steam_database_hostname: ''
|
2020-12-14 11:38:51 +00:00
|
|
|
matrix_mx_puppet_steam_database_port: 5432
|
2020-12-22 15:10:02 +00:00
|
|
|
matrix_mx_puppet_steam_database_name: matrix_mx_puppet_steam
|
2023-08-22 16:38:11 +00:00
|
|
|
matrix_mx_puppet_steam_database_sslmode: disable
|
2020-12-22 14:51:59 +00:00
|
|
|
|
2023-08-22 16:38:11 +00:00
|
|
|
matrix_mx_puppet_steam_database_connection_string: 'postgresql://{{ matrix_mx_puppet_steam_database_username }}:{{ matrix_mx_puppet_steam_database_password }}@{{ matrix_mx_puppet_steam_database_hostname }}:{{ matrix_mx_puppet_steam_database_port }}/{{ matrix_mx_puppet_steam_database_name }}?sslmode={{ matrix_mx_puppet_steam_database_sslmode }}'
|
2020-12-14 11:38:51 +00:00
|
|
|
|
2020-07-01 11:46:58 +00:00
|
|
|
# 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_mx_puppet_steam_configuration_extension_yaml`)
|
|
|
|
# or completely replace this variable with your own template.
|
|
|
|
matrix_mx_puppet_steam_configuration_yaml: "{{ lookup('template', 'templates/config.yaml.j2') }}"
|
|
|
|
|
|
|
|
matrix_mx_puppet_steam_configuration_extension_yaml: |
|
|
|
|
# Your custom YAML configuration goes here.
|
|
|
|
# This configuration extends the default starting configuration (`matrix_mx_puppet_steam_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_mx_puppet_steam_configuration_yaml`.
|
|
|
|
|
2022-07-18 08:22:05 +00:00
|
|
|
matrix_mx_puppet_steam_configuration_extension: "{{ matrix_mx_puppet_steam_configuration_extension_yaml | from_yaml if matrix_mx_puppet_steam_configuration_extension_yaml | from_yaml is mapping else {} }}"
|
2020-07-01 11:46:58 +00:00
|
|
|
|
|
|
|
# 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_mx_puppet_steam_configuration_yaml`.
|
2022-07-18 09:28:39 +00:00
|
|
|
matrix_mx_puppet_steam_configuration: "{{ matrix_mx_puppet_steam_configuration_yaml | from_yaml | combine(matrix_mx_puppet_steam_configuration_extension, recursive=True) }}"
|
2020-07-01 11:46:58 +00:00
|
|
|
|
|
|
|
matrix_mx_puppet_steam_registration_yaml: |
|
|
|
|
as_token: "{{ matrix_mx_puppet_steam_appservice_token }}"
|
|
|
|
hs_token: "{{ matrix_mx_puppet_steam_homeserver_token }}"
|
|
|
|
id: steam-puppet
|
|
|
|
namespaces:
|
|
|
|
users:
|
|
|
|
- exclusive: true
|
2022-07-18 09:28:39 +00:00
|
|
|
regex: '@_steampuppet_.*:{{ matrix_mx_puppet_steam_homeserver_domain | regex_escape }}'
|
2020-07-01 11:46:58 +00:00
|
|
|
rooms: []
|
|
|
|
aliases:
|
|
|
|
- exclusive: true
|
2022-07-18 09:28:39 +00:00
|
|
|
regex: '#_steampuppet_.*:{{ matrix_mx_puppet_steam_homeserver_domain | regex_escape }}'
|
2020-07-01 11:46:58 +00:00
|
|
|
protocols: []
|
|
|
|
rate_limited: false
|
|
|
|
sender_localpart: _steampuppet_bot
|
|
|
|
url: {{ matrix_mx_puppet_steam_appservice_address }}
|
2021-03-25 17:49:43 +00:00
|
|
|
de.sorunome.msc2409.push_ephemeral: true
|
2020-07-01 11:46:58 +00:00
|
|
|
|
2022-07-18 08:22:05 +00:00
|
|
|
matrix_mx_puppet_steam_registration: "{{ matrix_mx_puppet_steam_registration_yaml | from_yaml }}"
|