Ref: -33f3ccd6ae/CHANGELOG.md (L134-L136)
-7165d3fa58/appservice/registration.go (L30)
Intentionally not removing the old configuration setting yet, as some bridges may/do not support the new setting name. It's likely just bridgev2 mautrix bridges that have been updated and support both right now.
139 lines
7.7 KiB
YAML
139 lines
7.7 KiB
YAML
# SPDX-FileCopyrightText: 2021 - 2025 Slavi Pantaleev
|
|
# SPDX-FileCopyrightText: 2021 Ahmad Haghighi
|
|
# SPDX-FileCopyrightText: 2021 Cody Neiman
|
|
# SPDX-FileCopyrightText: 2021 MDAD project contributors
|
|
# SPDX-FileCopyrightText: 2022 Cody Wyatt Neiman
|
|
# SPDX-FileCopyrightText: 2022 Marko Weltzer
|
|
# SPDX-FileCopyrightText: 2022 Nikita Chernyi
|
|
# SPDX-FileCopyrightText: 2024 Suguru Hirahara
|
|
#
|
|
# SPDX-License-Identifier: AGPL-3.0-or-later
|
|
|
|
---
|
|
# Mx Puppet GroupMe is a Matrix <-> GroupMe bridge
|
|
# Project source code URL: https://gitlab.com/xangelix-pub/matrix/mx-puppet-groupme
|
|
|
|
matrix_mx_puppet_groupme_enabled: true
|
|
|
|
matrix_mx_puppet_groupme_container_image_self_build: false
|
|
matrix_mx_puppet_groupme_container_image_self_build_repo: "https://gitlab.com/xangelix-pub/matrix/mx-puppet-groupme"
|
|
matrix_mx_puppet_groupme_container_image_self_build_repo_version: "{{ 'main' if matrix_mx_puppet_groupme_version == 'latest' else matrix_mx_puppet_groupme_version }}"
|
|
|
|
# Controls whether the mx-puppet-groupme container exposes its HTTP port (tcp/8437 in the container).
|
|
#
|
|
# Takes an "<ip>:<port>" or "<port>" value (e.g. "127.0.0.1:8437"), or empty string to not expose.
|
|
matrix_mx_puppet_groupme_container_http_host_bind_port: ''
|
|
|
|
matrix_mx_puppet_groupme_version: 533cccc8
|
|
matrix_mx_puppet_groupme_docker_image: "{{ matrix_mx_puppet_groupme_docker_image_registry_prefix }}xangelix-pub/matrix/mx-puppet-groupme:{{ matrix_mx_puppet_groupme_version }}"
|
|
matrix_mx_puppet_groupme_docker_image_registry_prefix: "{{ 'localhost/' if matrix_mx_puppet_groupme_container_image_self_build else matrix_mx_puppet_groupme_docker_image_registry_prefix_upstream }}"
|
|
matrix_mx_puppet_groupme_docker_image_registry_prefix_upstream: "{{ matrix_mx_puppet_groupme_docker_image_registry_prefix_upstream_default }}"
|
|
matrix_mx_puppet_groupme_docker_image_registry_prefix_upstream_default: "registry.gitlab.com/"
|
|
matrix_mx_puppet_groupme_docker_image_force_pull: "{{ matrix_mx_puppet_groupme_docker_image.endswith(':latest') }}"
|
|
|
|
matrix_mx_puppet_groupme_base_path: "{{ matrix_base_data_path }}/mx-puppet-groupme"
|
|
matrix_mx_puppet_groupme_config_path: "{{ matrix_mx_puppet_groupme_base_path }}/config"
|
|
matrix_mx_puppet_groupme_data_path: "{{ matrix_mx_puppet_groupme_base_path }}/data"
|
|
matrix_mx_puppet_groupme_docker_src_files_path: "{{ matrix_mx_puppet_groupme_base_path }}/docker-src"
|
|
|
|
matrix_mx_puppet_groupme_appservice_port: "8437"
|
|
|
|
matrix_mx_puppet_groupme_homeserver_address: ""
|
|
matrix_mx_puppet_groupme_homeserver_domain: '{{ matrix_domain }}'
|
|
matrix_mx_puppet_groupme_appservice_address: 'http://matrix-mx-puppet-groupme:{{ matrix_mx_puppet_groupme_appservice_port }}'
|
|
|
|
# "@alice:example.com" to allow a specific user
|
|
# "@.*:example.com" to allow users on a specific homeserver
|
|
# "@.*" to allow anyone
|
|
matrix_mx_puppet_groupme_provisioning_whitelist:
|
|
- "@.*:{{ matrix_domain | regex_escape }}"
|
|
|
|
# Leave empty to disable blacklist
|
|
# "@bob:example.com" to disallow a specific user
|
|
# "@.*:example.com" to disallow users on a specific homeserver
|
|
matrix_mx_puppet_groupme_provisioning_blacklist: []
|
|
|
|
matrix_mx_puppet_groupme_container_network: ""
|
|
|
|
matrix_mx_puppet_groupme_container_additional_networks: "{{ matrix_mx_puppet_groupme_container_additional_networks_auto + matrix_mx_puppet_groupme_container_additional_networks_custom }}"
|
|
matrix_mx_puppet_groupme_container_additional_networks_auto: []
|
|
matrix_mx_puppet_groupme_container_additional_networks_custom: []
|
|
|
|
# A list of extra arguments to pass to the container
|
|
matrix_mx_puppet_groupme_container_extra_arguments: []
|
|
|
|
# List of systemd services that matrix-puppet-groupme.service depends on.
|
|
matrix_mx_puppet_groupme_systemd_required_services_list: "{{ matrix_mx_puppet_groupme_systemd_required_services_list_default + matrix_mx_puppet_groupme_systemd_required_services_list_auto + matrix_mx_puppet_groupme_systemd_required_services_list_custom }}"
|
|
matrix_mx_puppet_groupme_systemd_required_services_list_default: "{{ [devture_systemd_docker_base_docker_service_name] if devture_systemd_docker_base_docker_service_name else [] }}"
|
|
matrix_mx_puppet_groupme_systemd_required_services_list_auto: []
|
|
matrix_mx_puppet_groupme_systemd_required_services_list_custom: []
|
|
|
|
# List of systemd services that matrix-puppet-groupme.service wants
|
|
matrix_mx_puppet_groupme_systemd_wanted_services_list: []
|
|
|
|
matrix_mx_puppet_groupme_appservice_token: ''
|
|
matrix_mx_puppet_groupme_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_groupme_login_shared_secret: ''
|
|
|
|
matrix_mx_puppet_groupme_presence_enabled: true
|
|
matrix_mx_puppet_groupme_presence_interval: 5000
|
|
|
|
matrix_mx_puppet_groupme_database_engine: sqlite
|
|
|
|
matrix_mx_puppet_groupme_sqlite_database_path_local: "{{ matrix_mx_puppet_groupme_data_path }}/database.db"
|
|
matrix_mx_puppet_groupme_sqlite_database_path_in_container: "/data/database.db"
|
|
|
|
matrix_mx_puppet_groupme_database_username: matrix_mx_puppet_groupme
|
|
matrix_mx_puppet_groupme_database_password: ~
|
|
matrix_mx_puppet_groupme_database_hostname: ''
|
|
matrix_mx_puppet_groupme_database_port: 5432
|
|
matrix_mx_puppet_groupme_database_name: matrix_mx_puppet_groupme
|
|
matrix_mx_puppet_groupme_database_sslmode: disable
|
|
|
|
matrix_mx_puppet_groupme_database_connection_string: 'postgresql://{{ matrix_mx_puppet_groupme_database_username }}:{{ matrix_mx_puppet_groupme_database_password }}@{{ matrix_mx_puppet_groupme_database_hostname }}:{{ matrix_mx_puppet_groupme_database_port }}/{{ matrix_mx_puppet_groupme_database_name }}?sslmode={{ matrix_mx_puppet_groupme_database_sslmode }}'
|
|
|
|
# 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_groupme_configuration_extension_yaml`)
|
|
# or completely replace this variable with your own template.
|
|
matrix_mx_puppet_groupme_configuration_yaml: "{{ lookup('template', 'templates/config.yaml.j2') }}"
|
|
|
|
matrix_mx_puppet_groupme_configuration_extension_yaml: |
|
|
# Your custom YAML configuration goes here.
|
|
# This configuration extends the default starting configuration (`matrix_mx_puppet_groupme_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_groupme_configuration_yaml`.
|
|
|
|
matrix_mx_puppet_groupme_configuration_extension: "{{ matrix_mx_puppet_groupme_configuration_extension_yaml | from_yaml if matrix_mx_puppet_groupme_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_groupme_configuration_yaml`.
|
|
matrix_mx_puppet_groupme_configuration: "{{ matrix_mx_puppet_groupme_configuration_yaml | from_yaml | combine(matrix_mx_puppet_groupme_configuration_extension, recursive=True) }}"
|
|
|
|
matrix_mx_puppet_groupme_registration_yaml: |
|
|
as_token: "{{ matrix_mx_puppet_groupme_appservice_token }}"
|
|
hs_token: "{{ matrix_mx_puppet_groupme_homeserver_token }}"
|
|
id: groupme-puppet
|
|
namespaces:
|
|
users:
|
|
- exclusive: true
|
|
regex: '@_groupmepuppet_.*:{{ matrix_mx_puppet_groupme_homeserver_domain | regex_escape }}'
|
|
rooms: []
|
|
aliases:
|
|
- exclusive: true
|
|
regex: '#_groupmepuppet_.*:{{ matrix_mx_puppet_groupme_homeserver_domain | regex_escape }}'
|
|
protocols: []
|
|
rate_limited: false
|
|
sender_localpart: _groupmepuppet_bot
|
|
url: {{ matrix_mx_puppet_groupme_appservice_address }}
|
|
de.sorunome.msc2409.push_ephemeral: true
|
|
receive_ephemeral: true
|
|
|
|
matrix_mx_puppet_groupme_registration: "{{ matrix_mx_puppet_groupme_registration_yaml | from_yaml }}"
|