98e4f369b7
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.
225 lines
13 KiB
YAML
225 lines
13 KiB
YAML
# SPDX-FileCopyrightText: 2019 - 2024 Slavi Pantaleev
|
|
# SPDX-FileCopyrightText: 2020 Horvath Gergely
|
|
# SPDX-FileCopyrightText: 2020 Marcel Partap
|
|
# SPDX-FileCopyrightText: 2021 - 2024 MDAD project contributors
|
|
# SPDX-FileCopyrightText: 2021 Aaron Raimist
|
|
# SPDX-FileCopyrightText: 2021 Arthur Brugière
|
|
# SPDX-FileCopyrightText: 2022 - 2023 Nikita Chernyi
|
|
# SPDX-FileCopyrightText: 2022 László Várady
|
|
# SPDX-FileCopyrightText: 2022 Marko Weltzer
|
|
# SPDX-FileCopyrightText: 2023 Adrien le Maire
|
|
# SPDX-FileCopyrightText: 2023 Samuel Meenzen
|
|
#
|
|
# SPDX-License-Identifier: AGPL-3.0-or-later
|
|
|
|
---
|
|
# mautrix-facebook is a Matrix <-> Facebook bridge
|
|
# Project source code URL: https://github.com/mautrix/facebook
|
|
|
|
matrix_mautrix_facebook_enabled: true
|
|
|
|
matrix_mautrix_facebook_container_image_self_build: false
|
|
matrix_mautrix_facebook_container_image_self_build_repo: "https://mau.dev/mautrix/facebook.git"
|
|
|
|
# renovate: datasource=docker depName=dock.mau.dev/mautrix/facebook
|
|
matrix_mautrix_facebook_version: v0.5.1
|
|
matrix_mautrix_facebook_docker_image: "{{ matrix_mautrix_facebook_docker_image_registry_prefix }}mautrix/facebook:{{ matrix_mautrix_facebook_version }}"
|
|
matrix_mautrix_facebook_docker_image_registry_prefix: "{{ 'localhost/' if matrix_mautrix_facebook_container_image_self_build else matrix_mautrix_facebook_docker_image_registry_prefix_upstream }}"
|
|
matrix_mautrix_facebook_docker_image_registry_prefix_upstream: "{{ matrix_mautrix_facebook_docker_image_registry_prefix_upstream_default }}"
|
|
matrix_mautrix_facebook_docker_image_registry_prefix_upstream_default: "dock.mau.dev/"
|
|
matrix_mautrix_facebook_docker_image_force_pull: "{{ matrix_mautrix_facebook_docker_image.endswith(':latest') }}"
|
|
|
|
matrix_mautrix_facebook_base_path: "{{ matrix_base_data_path }}/mautrix-facebook"
|
|
matrix_mautrix_facebook_config_path: "{{ matrix_mautrix_facebook_base_path }}/config"
|
|
matrix_mautrix_facebook_data_path: "{{ matrix_mautrix_facebook_base_path }}/data"
|
|
matrix_mautrix_facebook_docker_src_files_path: "{{ matrix_mautrix_facebook_base_path }}/docker-src"
|
|
|
|
matrix_mautrix_facebook_command_prefix: "!fb"
|
|
|
|
matrix_mautrix_facebook_homeserver_address: ""
|
|
matrix_mautrix_facebook_homeserver_domain: '{{ matrix_domain }}'
|
|
|
|
# Whether or not the public-facing endpoints should be enabled (web-based login)
|
|
matrix_mautrix_facebook_appservice_public_enabled: false
|
|
# Mautrix Facebook public endpoint to log in to Facebook
|
|
matrix_mautrix_facebook_appservice_public_prefix: ''
|
|
matrix_mautrix_facebook_appservice_public_hostname: ''
|
|
matrix_mautrix_facebook_appservice_public_external: "{{ ('https://' + matrix_mautrix_facebook_appservice_public_hostname + matrix_mautrix_facebook_appservice_public_prefix) if matrix_mautrix_facebook_appservice_public_enabled else '' }}"
|
|
|
|
matrix_mautrix_facebook_appservice_address: 'http://matrix-mautrix-facebook:29319'
|
|
|
|
matrix_mautrix_facebook_container_network: ""
|
|
|
|
matrix_mautrix_facebook_container_additional_networks: "{{ matrix_mautrix_facebook_container_additional_networks_auto + matrix_mautrix_facebook_container_additional_networks_custom }}"
|
|
matrix_mautrix_facebook_container_additional_networks_auto: []
|
|
matrix_mautrix_facebook_container_additional_networks_custom: []
|
|
|
|
# matrix_mautrix_facebook_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_mautrix_facebook_container_labels_additional_labels`.
|
|
matrix_mautrix_facebook_container_labels_traefik_enabled: true
|
|
matrix_mautrix_facebook_container_labels_traefik_docker_network: "{{ matrix_mautrix_facebook_container_network }}"
|
|
matrix_mautrix_facebook_container_labels_traefik_entrypoints: web-secure
|
|
matrix_mautrix_facebook_container_labels_traefik_tls_certResolver: default # noqa var-naming
|
|
|
|
# Controls whether labels will be added that expose mautrix-facebook's public endpoint
|
|
matrix_mautrix_facebook_container_labels_public_endpoint_enabled: "{{ matrix_mautrix_facebook_appservice_public_enabled }}"
|
|
matrix_mautrix_facebook_container_labels_public_endpoint_traefik_rule: "Host(`{{ matrix_mautrix_facebook_appservice_public_hostname }}`) && PathPrefix(`{{ matrix_mautrix_facebook_appservice_public_prefix }}`)"
|
|
matrix_mautrix_facebook_container_labels_public_endpoint_traefik_priority: 0
|
|
matrix_mautrix_facebook_container_labels_public_endpoint_traefik_entrypoints: "{{ matrix_mautrix_facebook_container_labels_traefik_entrypoints }}"
|
|
matrix_mautrix_facebook_container_labels_public_endpoint_traefik_tls: "{{ matrix_mautrix_facebook_container_labels_public_endpoint_traefik_entrypoints != 'web' }}"
|
|
matrix_mautrix_facebook_container_labels_public_endpoint_traefik_tls_certResolver: "{{ matrix_mautrix_facebook_container_labels_traefik_tls_certResolver }}" # noqa var-naming
|
|
|
|
# Controls whether labels will be added that expose mautrix-facebook's metrics
|
|
matrix_mautrix_facebook_container_labels_metrics_enabled: "{{ matrix_mautrix_facebook_metrics_enabled and matrix_mautrix_facebook_metrics_proxying_enabled }}"
|
|
matrix_mautrix_facebook_container_labels_metrics_traefik_rule: "Host(`{{ matrix_mautrix_facebook_metrics_proxying_hostname }}`) && PathPrefix(`{{ matrix_mautrix_facebook_metrics_proxying_path_prefix }}`)"
|
|
matrix_mautrix_facebook_container_labels_metrics_traefik_priority: 0
|
|
matrix_mautrix_facebook_container_labels_metrics_traefik_entrypoints: "{{ matrix_mautrix_facebook_container_labels_traefik_entrypoints }}"
|
|
matrix_mautrix_facebook_container_labels_metrics_traefik_tls: "{{ matrix_mautrix_facebook_container_labels_metrics_traefik_entrypoints != 'web' }}"
|
|
matrix_mautrix_facebook_container_labels_metrics_traefik_tls_certResolver: "{{ matrix_mautrix_facebook_container_labels_traefik_tls_certResolver }}" # noqa var-naming
|
|
matrix_mautrix_facebook_container_labels_metrics_middleware_basic_auth_enabled: false
|
|
# See: https://doc.traefik.io/traefik/middlewares/http/basicauth/#users
|
|
matrix_mautrix_facebook_container_labels_metrics_middleware_basic_auth_users: ''
|
|
|
|
# matrix_mautrix_facebook_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_mautrix_facebook_container_labels_additional_labels: |
|
|
# my.label=1
|
|
# another.label="here"
|
|
matrix_mautrix_facebook_container_labels_additional_labels: ''
|
|
|
|
# A list of extra arguments to pass to the container
|
|
matrix_mautrix_facebook_container_extra_arguments: []
|
|
|
|
# List of systemd services that matrix-mautrix-facebook.service depends on.
|
|
matrix_mautrix_facebook_systemd_required_services_list: "{{ matrix_mautrix_facebook_systemd_required_services_list_default + matrix_mautrix_facebook_systemd_required_services_list_auto + matrix_mautrix_facebook_systemd_required_services_list_custom }}"
|
|
matrix_mautrix_facebook_systemd_required_services_list_default: "{{ [devture_systemd_docker_base_docker_service_name] if devture_systemd_docker_base_docker_service_name else [] }}"
|
|
matrix_mautrix_facebook_systemd_required_services_list_auto: []
|
|
matrix_mautrix_facebook_systemd_required_services_list_custom: []
|
|
|
|
# List of systemd services that matrix-mautrix-facebook.service wants
|
|
matrix_mautrix_facebook_systemd_wanted_services_list: []
|
|
|
|
matrix_mautrix_facebook_appservice_token: ''
|
|
matrix_mautrix_facebook_homeserver_token: ''
|
|
|
|
# Whether or not created rooms should have federation enabled.
|
|
# If false, created portal rooms will never be federated.
|
|
matrix_mautrix_facebook_federate_rooms: true
|
|
|
|
# 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_mautrix_facebook_metrics_proxying_enabled`.
|
|
matrix_mautrix_facebook_metrics_enabled: false
|
|
|
|
# Controls whether metrics should be exposed on a public URL.
|
|
matrix_mautrix_facebook_metrics_proxying_enabled: false
|
|
matrix_mautrix_facebook_metrics_proxying_hostname: ''
|
|
matrix_mautrix_facebook_metrics_proxying_path_prefix: ''
|
|
|
|
matrix_mautrix_facebook_bridge_permissions: |
|
|
{{
|
|
{'*': 'relay', matrix_mautrix_facebook_homeserver_domain: 'user'}
|
|
| combine({matrix_admin: 'admin'} if matrix_admin else {})
|
|
}}
|
|
|
|
# Controls whether the matrix-mautrix-facebook container exposes its HTTP port.
|
|
#
|
|
# Takes an "<ip>:<port>" or "<port>" value (e.g. "127.0.0.1:9008"), or empty string to not expose.
|
|
matrix_mautrix_facebook_container_http_host_bind_port: ''
|
|
|
|
# Database-related configuration fields.
|
|
#
|
|
# To use SQLite:
|
|
# - change the engine (`matrix_mautrix_facebook_database_engine: 'sqlite'`)
|
|
# - change to the last bridge version that supported SQLite:
|
|
# `matrix_mautrix_facebook_docker_image: "{{ matrix_mautrix_facebook_docker_image_name_prefix }}tulir/mautrix-facebook:da1b4ec596e334325a1589e70829dea46e73064b"`
|
|
# - plan your migration to Postgres, as this bridge does not support SQLite anymore (and neither will the playbook in the future).
|
|
#
|
|
# To use Postgres:
|
|
# - adjust your database credentials via the `matrix_mautrix_facebook_database_*` variables
|
|
matrix_mautrix_facebook_database_engine: 'postgres'
|
|
|
|
matrix_mautrix_facebook_sqlite_database_path_local: "{{ matrix_mautrix_facebook_data_path }}/mautrix-facebook.db"
|
|
matrix_mautrix_facebook_sqlite_database_path_in_container: "/data/mautrix-facebook.db"
|
|
|
|
matrix_mautrix_facebook_database_username: 'matrix_mautrix_facebook'
|
|
matrix_mautrix_facebook_database_password: 'some-password'
|
|
matrix_mautrix_facebook_database_hostname: ''
|
|
matrix_mautrix_facebook_database_port: 5432
|
|
matrix_mautrix_facebook_database_name: 'matrix_mautrix_facebook'
|
|
|
|
matrix_mautrix_facebook_database_connection_string: 'postgres://{{ matrix_mautrix_facebook_database_username }}:{{ matrix_mautrix_facebook_database_password }}@{{ matrix_mautrix_facebook_database_hostname }}:{{ matrix_mautrix_facebook_database_port }}/{{ matrix_mautrix_facebook_database_name }}'
|
|
|
|
matrix_mautrix_facebook_appservice_database: "{{
|
|
{
|
|
'sqlite': ('sqlite:///' + matrix_mautrix_facebook_sqlite_database_path_in_container),
|
|
'postgres': matrix_mautrix_facebook_database_connection_string,
|
|
}[matrix_mautrix_facebook_database_engine]
|
|
}}"
|
|
|
|
|
|
# Can be set to enable automatic double-puppeting via Shared Secret Auth (https://github.com/devture/matrix-synapse-shared-secret-auth).
|
|
matrix_mautrix_facebook_login_shared_secret: ''
|
|
|
|
matrix_mautrix_facebook_bridge_login_shared_secret_map: "{{ {matrix_mautrix_facebook_homeserver_domain: matrix_mautrix_facebook_login_shared_secret} if matrix_mautrix_facebook_login_shared_secret else {} }}"
|
|
|
|
# Enable bridge relay bot functionality
|
|
matrix_mautrix_facebook_relay_enabled: "{{ matrix_bridges_relay_enabled }}"
|
|
|
|
matrix_mautrix_facebook_appservice_bot_username: facebookbot
|
|
|
|
matrix_mautrix_facebook_bridge_presence: true
|
|
|
|
# Specifies the default log level for all bridge loggers.
|
|
matrix_mautrix_facebook_logging_level: WARNING
|
|
|
|
# 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_mautrix_facebook_configuration_extension_yaml`)
|
|
# or completely replace this variable with your own template.
|
|
matrix_mautrix_facebook_configuration_yaml: "{{ lookup('template', 'templates/config.yaml.j2') }}"
|
|
|
|
matrix_mautrix_facebook_configuration_extension_yaml: |
|
|
# Your custom YAML configuration goes here.
|
|
# This configuration extends the default starting configuration (`matrix_mautrix_facebook_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_mautrix_facebook_configuration_yaml`.
|
|
|
|
matrix_mautrix_facebook_configuration_extension: "{{ matrix_mautrix_facebook_configuration_extension_yaml | from_yaml if matrix_mautrix_facebook_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_mautrix_facebook_configuration_yaml`.
|
|
matrix_mautrix_facebook_configuration: "{{ matrix_mautrix_facebook_configuration_yaml | from_yaml | combine(matrix_mautrix_facebook_configuration_extension, recursive=True) }}"
|
|
|
|
matrix_mautrix_facebook_registration_yaml: |
|
|
id: facebook
|
|
as_token: "{{ matrix_mautrix_facebook_appservice_token }}"
|
|
hs_token: "{{ matrix_mautrix_facebook_homeserver_token }}"
|
|
namespaces:
|
|
users:
|
|
- exclusive: true
|
|
regex: '^@facebook_.+:{{ matrix_mautrix_facebook_homeserver_domain | regex_escape }}$'
|
|
- exclusive: true
|
|
regex: '^@{{ matrix_mautrix_facebook_appservice_bot_username | regex_escape }}:{{ matrix_mautrix_facebook_homeserver_domain | regex_escape }}$'
|
|
url: {{ matrix_mautrix_facebook_appservice_address }}
|
|
# See https://github.com/mautrix/signal/issues/43
|
|
sender_localpart: _bot_{{ matrix_mautrix_facebook_appservice_bot_username }}
|
|
rate_limited: false
|
|
de.sorunome.msc2409.push_ephemeral: true
|
|
receive_ephemeral: true
|
|
|
|
matrix_mautrix_facebook_registration: "{{ matrix_mautrix_facebook_registration_yaml | from_yaml }}"
|
|
|
|
# Enable End-to-bridge encryption
|
|
matrix_mautrix_facebook_bridge_encryption_allow: "{{ matrix_bridges_encryption_enabled }}"
|
|
matrix_mautrix_facebook_bridge_encryption_default: "{{ matrix_bridges_encryption_default }}"
|
|
matrix_mautrix_facebook_bridge_encryption_key_sharing_allow: "{{ matrix_mautrix_facebook_bridge_encryption_allow }}"
|