2022-02-05 22:32:54 +02:00
---
2020-07-01 13:46:58 +02:00
# Mx Puppet Steam is a Matrix <-> Steam bridge
2022-07-16 22:59:21 +02:00
# Project source code URL: https://github.com/icewind1991/mx-puppet-steam
2020-07-01 13:46:58 +02:00
matrix_mx_puppet_steam_enabled : true
matrix_mx_puppet_steam_container_image_self_build : false
2022-07-16 22:59:21 +02:00
matrix_mx_puppet_steam_container_image_self_build_repo : "https://github.com/icewind1991/mx-puppet-steam.git"
2020-07-01 13:46:58 +02: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 : ''
2021-02-20 19:08:28 +02: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 14:39:16 +02: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 13:46:58 +02: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"
2021-01-25 13:55:08 +02:00
matrix_mx_puppet_steam_homeserver_address : "{{ matrix_homeserver_container_url }}"
2020-07-01 13:46:58 +02: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 }}'
# "@user:server.com" to allow specific user
# "@.*:yourserver.com" to allow users on a specific homeserver
# "@.*" to allow anyone
matrix_mx_puppet_steam_provisioning_whitelist :
- "@.*:{{ matrix_domain|regex_escape }}"
# Leave empty to disable blacklist
# "@user:server.com" disallow a specific user
# "@.*:yourserver.com" disallow users on a specific homeserver
matrix_mx_puppet_steam_provisioning_blacklist : [ ]
# 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.
matrix_mx_puppet_steam_systemd_required_services_list : [ 'docker.service' ]
# 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 : ''
2020-12-14 13:38:51 +02:00
matrix_mx_puppet_steam_database_engine : sqlite
2020-12-22 16:51:59 +02: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 13:38:51 +02:00
matrix_mx_puppet_steam_database_username : matrix_mx_puppet_steam
matrix_mx_puppet_steam_database_password : ~
matrix_mx_puppet_steam_database_hostname : 'matrix-postgres'
matrix_mx_puppet_steam_database_port : 5432
2020-12-22 17:10:02 +02:00
matrix_mx_puppet_steam_database_name : matrix_mx_puppet_steam
2020-12-22 16:51:59 +02:00
2020-12-22 17:10:02 +02: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=disable'
2020-12-14 13:38:51 +02:00
2020-07-01 13:46:58 +02: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`.
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 {} }}"
# 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`.
matrix_mx_puppet_steam_configuration : "{{ matrix_mx_puppet_steam_configuration_yaml|from_yaml|combine(matrix_mx_puppet_steam_configuration_extension, recursive=True) }}"
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
regex : '@_steampuppet_.*:{{ matrix_mx_puppet_steam_homeserver_domain|regex_escape }}'
rooms : [ ]
aliases :
- exclusive : true
regex : '#_steampuppet_.*:{{ matrix_mx_puppet_steam_homeserver_domain|regex_escape }}'
protocols : [ ]
rate_limited : false
sender_localpart : _steampuppet_bot
url : {{ matrix_mx_puppet_steam_appservice_address }}
2021-03-25 19:49:43 +02:00
de.sorunome.msc2409.push_ephemeral : true
2020-07-01 13:46:58 +02:00
matrix_mx_puppet_steam_registration : "{{ matrix_mx_puppet_steam_registration_yaml|from_yaml }}"