2019-05-15 02:34:31 +02:00
# mautrix-facebook is a Matrix <-> Facebook bridge
# See: https://github.com/tulir/mautrix-facebook
matrix_mautrix_facebook_enabled : true
2020-03-15 09:10:41 +01:00
2020-03-15 09:15:27 +01:00
matrix_mautrix_facebook_container_image_self_build : false
2020-11-28 20:34:14 +01:00
matrix_mautrix_facebook_container_image_self_build_repo : "https://github.com/tulir/mautrix-facebook.git"
2019-05-15 02:34:31 +02:00
2021-02-28 15:21:40 +01:00
matrix_mautrix_facebook_version : latest
2019-07-28 17:40:55 +02:00
# See: https://mau.dev/tulir/mautrix-facebook/container_registry
2021-02-28 15:21:40 +01:00
matrix_mautrix_facebook_docker_image : "{{ matrix_mautrix_facebook_docker_image_name_prefix }}tulir/mautrix-facebook:{{ matrix_mautrix_facebook_version }}"
2020-11-14 21:47:14 +01:00
matrix_mautrix_facebook_docker_image_name_prefix : "{{ 'localhost/' if matrix_mautrix_facebook_container_image_self_build else 'dock.mau.dev/' }}"
2019-06-10 13:23:51 +02:00
matrix_mautrix_facebook_docker_image_force_pull : "{{ matrix_mautrix_facebook_docker_image.endswith(':latest') }}"
2019-05-15 02:34:31 +02:00
matrix_mautrix_facebook_base_path : "{{ matrix_base_data_path }}/mautrix-facebook"
2019-06-07 13:50:55 +02: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-08 00:28:14 +01:00
matrix_mautrix_facebook_docker_src_files_path : "{{ matrix_mautrix_facebook_base_path }}/docker-src"
2019-05-15 02:34:31 +02:00
2021-01-25 12:55:08 +01:00
matrix_mautrix_facebook_homeserver_address : "{{ matrix_homeserver_container_url }}"
2019-05-15 02:34:31 +02:00
matrix_mautrix_facebook_homeserver_domain : '{{ matrix_domain }}'
2019-07-28 17:42:30 +02:00
matrix_mautrix_facebook_appservice_address : 'http://matrix-mautrix-facebook:29319'
2019-05-15 02:34:31 +02: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 13:04:59 +02:00
matrix_mautrix_facebook_appservice_token : ''
matrix_mautrix_facebook_homeserver_token : ''
2020-12-14 10:50:42 +01:00
# Database-related configuration fields.
#
2021-01-20 09:12:51 +01: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 10:50:42 +01:00
#
# To use Postgres:
# - adjust your database credentials via the `matrix_mautrix_facebook_postgres_*` variables
2021-01-20 09:12:51 +01:00
matrix_mautrix_facebook_database_engine : 'postgres'
2020-12-14 10:50:42 +01: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 12:02:47 +01:00
matrix_mautrix_facebook_database_username : 'matrix_mautrix_facebook'
matrix_mautrix_facebook_database_password : 'some-password'
2020-12-14 13:42:18 +01:00
matrix_mautrix_facebook_database_hostname : 'matrix-postgres'
2020-12-14 12:02:47 +01:00
matrix_mautrix_facebook_database_port : 5432
2020-12-22 16:10:02 +01:00
matrix_mautrix_facebook_database_name : 'matrix_mautrix_facebook'
2020-12-14 10:50:42 +01:00
2020-12-23 14:39:12 +01: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 10:50:42 +01:00
matrix_mautrix_facebook_appservice_database : "{{
{
2020-12-23 12:33:25 +01:00
'sqlite' : ('sqlite:///' + matrix_mautrix_facebook_sqlite_database_path_in_container),
2020-12-14 13:42:18 +01:00
'postgres' : matrix_mautrix_facebook_database_connection_string,
2020-12-14 10:50:42 +01:00
}[ matrix_mautrix_facebook_database_engine]
}}"
2020-12-14 11:04:47 +01:00
2020-01-12 19:28:36 +01: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 10:55:18 +01: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 {} }}"
2021-01-27 14:43:33 +01:00
matrix_mautrix_facebook_appservice_bot_username : facebookbot
2020-12-01 10:55:18 +01:00
matrix_mautrix_facebook_bridge_presence : true
2020-01-08 22:36:48 +01:00
# Default configuration template which covers the generic use case.
2019-06-07 13:04:59 +02: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 08:33:28 +02:00
matrix_mautrix_facebook_configuration_yaml : "{{ lookup('template', 'templates/config.yaml.j2') }}"
2019-06-07 13:04:59 +02: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`.
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
2019-06-24 06:50:47 +02:00
regex : '^@facebook_.+:{{ matrix_mautrix_facebook_homeserver_domain|regex_escape }}$'
2021-01-27 14:43:33 +01:00
- exclusive : true
regex : '^@{{ matrix_mautrix_facebook_appservice_bot_username|regex_escape }}:{{ matrix_mautrix_facebook_homeserver_domain|regex_escape }}$'
2019-06-07 13:04:59 +02:00
url : {{ matrix_mautrix_facebook_appservice_address }}
2021-01-27 14:43:33 +01:00
# See https://github.com/tulir/mautrix-signal/issues/43
2021-01-27 14:48:35 +01:00
sender_localpart : _bot_{{ matrix_mautrix_facebook_appservice_bot_username }}
2019-06-07 13:04:59 +02:00
rate_limited : false
matrix_mautrix_facebook_registration : "{{ matrix_mautrix_facebook_registration_yaml|from_yaml }}"