2022-02-05 20:32:54 +00:00
---
2019-05-15 00:34:31 +00:00
# mautrix-facebook is a Matrix <-> Facebook bridge
2022-07-16 20:59:21 +00:00
# Project source code URL: https://github.com/mautrix/facebook
2019-05-15 00:34:31 +00:00
matrix_mautrix_facebook_enabled : true
2020-03-15 08:10:41 +00:00
2020-03-15 08:15:27 +00:00
matrix_mautrix_facebook_container_image_self_build : false
2021-08-17 08:21:53 +00:00
matrix_mautrix_facebook_container_image_self_build_repo : "https://mau.dev/mautrix/facebook.git"
2019-05-15 00:34:31 +00:00
2023-10-06 12:14:03 +00:00
# renovate: datasource=docker depName=dock.mau.dev/mautrix/facebook
2023-09-19 18:59:49 +00:00
matrix_mautrix_facebook_version : v0.5.1
2021-08-17 08:21:53 +00:00
matrix_mautrix_facebook_docker_image : "{{ matrix_mautrix_facebook_docker_image_name_prefix }}mautrix/facebook:{{ matrix_mautrix_facebook_version }}"
2020-11-14 20:47:14 +00:00
matrix_mautrix_facebook_docker_image_name_prefix : "{{ 'localhost/' if matrix_mautrix_facebook_container_image_self_build else 'dock.mau.dev/' }}"
2019-06-10 11:23:51 +00:00
matrix_mautrix_facebook_docker_image_force_pull : "{{ matrix_mautrix_facebook_docker_image.endswith(':latest') }}"
2019-05-15 00:34:31 +00:00
matrix_mautrix_facebook_base_path : "{{ matrix_base_data_path }}/mautrix-facebook"
2019-06-07 11:50:55 +00:00
matrix_mautrix_facebook_config_path : "{{ matrix_mautrix_facebook_base_path }}/config"
matrix_mautrix_facebook_data_path : "{{ matrix_mautrix_facebook_base_path }}/data"
2020-03-07 23:28:14 +00:00
matrix_mautrix_facebook_docker_src_files_path : "{{ matrix_mautrix_facebook_base_path }}/docker-src"
2019-05-15 00:34:31 +00:00
2022-07-04 20:53:43 +00:00
matrix_mautrix_facebook_command_prefix : "!fb"
2022-03-08 17:19:28 +00:00
# Whether or not the public-facing endpoints should be enabled (web-based login)
matrix_mautrix_facebook_appservice_public_enabled : true
# Mautrix Facebook public endpoint to log in to Facebook
matrix_mautrix_facebook_public_endpoint : ''
2021-01-25 11:55:08 +00:00
matrix_mautrix_facebook_homeserver_address : "{{ matrix_homeserver_container_url }}"
2019-05-15 00:34:31 +00:00
matrix_mautrix_facebook_homeserver_domain : '{{ matrix_domain }}'
2019-07-28 15:42:30 +00:00
matrix_mautrix_facebook_appservice_address : 'http://matrix-mautrix-facebook:29319'
2022-03-08 17:19:28 +00:00
matrix_mautrix_facebook_appservice_public_external : 'https://{{ matrix_server_fqn_matrix }}{{ matrix_mautrix_facebook_public_endpoint }}'
2019-05-15 00:34:31 +00:00
# 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 : [ 'docker.service' ]
# List of systemd services that matrix-mautrix-facebook.service wants
matrix_mautrix_facebook_systemd_wanted_services_list : [ ]
2019-06-07 11:04:59 +00:00
matrix_mautrix_facebook_appservice_token : ''
matrix_mautrix_facebook_homeserver_token : ''
2022-03-05 20:07:43 +00:00
# Whether or not created rooms should have federation enabled.
# If false, created portal rooms will never be federated.
matrix_mautrix_facebook_federate_rooms : true
2020-12-14 09:50:42 +00:00
2023-01-29 08:45:52 +00:00
# Whether or not metrics endpoint should be enabled.
2023-01-30 06:50:57 +00:00
# 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`.
2023-01-29 08:45:52 +00:00
matrix_mautrix_facebook_metrics_enabled : false
2023-01-30 06:50:57 +00:00
# Controls whether metrics should be proxied (exposed) on `matrix.DOMAIN/metrics/mautrix-facebook`.
# This will only work take effect if `matrix_nginx_proxy_proxy_matrix_metrics_enabled: true`.
# See the `matrix-nginx-proxy` role for details about enabling `matrix_nginx_proxy_proxy_matrix_metrics_enabled`.
matrix_mautrix_facebook_metrics_proxying_enabled : false
2022-07-25 12:55:16 +00:00
matrix_mautrix_facebook_bridge_permissions : |
{{
2023-11-29 11:32:14 +00:00
{'*': 'relay', matrix_mautrix_facebook_homeserver_domain : 'user' }
2022-07-25 12:55:16 +00:00
| combine({matrix_admin: 'admin'} if matrix_admin else {})
}}
2022-03-08 17:19:28 +00:00
# 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 : ''
2020-12-14 09:50:42 +00:00
# Database-related configuration fields.
#
2021-01-20 08:12:51 +00:00
# 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).
2020-12-14 09:50:42 +00:00
#
# To use Postgres:
2021-12-08 10:13:12 +00:00
# - adjust your database credentials via the `matrix_mautrix_facebook_database_*` variables
2021-01-20 08:12:51 +00:00
matrix_mautrix_facebook_database_engine : 'postgres'
2020-12-14 09:50:42 +00:00
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"
2020-12-14 11:02:47 +00:00
matrix_mautrix_facebook_database_username : 'matrix_mautrix_facebook'
matrix_mautrix_facebook_database_password : 'some-password'
2022-11-27 07:16:18 +00:00
matrix_mautrix_facebook_database_hostname : ''
2020-12-14 11:02:47 +00:00
matrix_mautrix_facebook_database_port : 5432
2020-12-22 15:10:02 +00:00
matrix_mautrix_facebook_database_name : 'matrix_mautrix_facebook'
2020-12-14 09:50:42 +00:00
2020-12-23 13:39:12 +00:00
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 }}'
2020-12-14 09:50:42 +00:00
matrix_mautrix_facebook_appservice_database : "{{
{
2020-12-23 11:33:25 +00:00
'sqlite' : ('sqlite:///' + matrix_mautrix_facebook_sqlite_database_path_in_container),
2020-12-14 12:42:18 +00:00
'postgres' : matrix_mautrix_facebook_database_connection_string,
2020-12-14 09:50:42 +00:00
}[ matrix_mautrix_facebook_database_engine]
}}"
2020-12-14 10:04:47 +00:00
2020-01-12 18:28:36 +00:00
# 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 : ''
2020-12-01 09:55:18 +00:00
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 {} }}"
2023-07-21 10:22:05 +00:00
# Enable bridge relay bot functionality
matrix_mautrix_facebook_relay_enabled : "{{ matrix_bridges_relay_enabled }}"
2021-01-27 13:43:33 +00:00
matrix_mautrix_facebook_appservice_bot_username : facebookbot
2020-12-01 09:55:18 +00:00
matrix_mautrix_facebook_bridge_presence : true
2022-07-01 11:32:42 +00:00
# Specifies the default log level for all bridge loggers.
matrix_mautrix_facebook_logging_level : WARNING
2020-01-08 21:36:48 +00:00
# Default configuration template which covers the generic use case.
2019-06-07 11:04:59 +00:00
# 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.
2020-06-03 06:33:28 +00:00
matrix_mautrix_facebook_configuration_yaml : "{{ lookup('template', 'templates/config.yaml.j2') }}"
2019-06-07 11:04:59 +00:00
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`.
2022-07-18 08:22:05 +00:00
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 {} }}"
2019-06-07 11:04:59 +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_mautrix_facebook_configuration_yaml`.
2022-07-18 09:28:39 +00:00
matrix_mautrix_facebook_configuration : "{{ matrix_mautrix_facebook_configuration_yaml | from_yaml | combine(matrix_mautrix_facebook_configuration_extension, recursive=True) }}"
2019-06-07 11:04:59 +00:00
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
2022-07-18 09:28:39 +00:00
regex : '^@facebook_.+:{{ matrix_mautrix_facebook_homeserver_domain | regex_escape }}$'
2021-01-27 13:43:33 +00:00
- exclusive : true
2022-07-18 09:28:39 +00:00
regex : '^@{{ matrix_mautrix_facebook_appservice_bot_username | regex_escape }}:{{ matrix_mautrix_facebook_homeserver_domain | regex_escape }}$'
2019-06-07 11:04:59 +00:00
url : {{ matrix_mautrix_facebook_appservice_address }}
2021-08-18 15:14:18 +00:00
# See https://github.com/mautrix/signal/issues/43
2021-01-27 13:48:35 +00:00
sender_localpart : _bot_{{ matrix_mautrix_facebook_appservice_bot_username }}
2019-06-07 11:04:59 +00:00
rate_limited : false
2021-03-25 17:49:43 +00:00
de.sorunome.msc2409.push_ephemeral : true
2019-06-07 11:04:59 +00:00
2022-07-18 08:22:05 +00:00
matrix_mautrix_facebook_registration : "{{ matrix_mautrix_facebook_registration_yaml | from_yaml }}"
2023-04-05 11:59:48 +00:00
# Enable End-to-bridge encryption
matrix_mautrix_facebook_bridge_encryption_allow : "{{ matrix_bridges_encryption_enabled }}"
matrix_mautrix_facebook_bridge_encryption_default : "{{ matrix_mautrix_facebook_bridge_encryption_allow }}"
matrix_mautrix_facebook_bridge_encryption_key_sharing_allow : "{{ matrix_mautrix_facebook_bridge_encryption_allow }}"