2022-02-05 22:32:54 +02:00
---
2021-04-11 08:18:31 +02:00
# mautrix-twitter is a Matrix <-> Twitter bridge
2022-01-03 02:59:52 +02:00
# See: https://github.com/mautrix/twitter
2021-04-11 08:11:45 +02:00
2021-04-11 08:18:31 +02:00
matrix_mautrix_twitter_enabled : true
2021-04-11 08:11:45 +02:00
2021-04-11 08:18:31 +02:00
matrix_mautrix_twitter_container_image_self_build : false
2022-01-03 02:59:52 +02:00
matrix_mautrix_twitter_container_image_self_build_repo : "https://github.com/mautrix/twitter.git"
2021-04-11 08:11:45 +02:00
2022-01-17 11:02:16 +02:00
matrix_mautrix_twitter_version : v0.1.3
2021-04-11 08:18:31 +02:00
# See: https://mau.dev/tulir/mautrix-twitter/container_registry
2021-11-09 05:47:02 +02:00
matrix_mautrix_twitter_docker_image : "{{ matrix_mautrix_twitter_docker_image_name_prefix }}mautrix/twitter:{{ matrix_mautrix_twitter_version }}"
2021-04-11 08:18:31 +02:00
matrix_mautrix_twitter_docker_image_name_prefix : "{{ 'localhost/' if matrix_mautrix_twitter_container_image_self_build else 'dock.mau.dev/' }}"
matrix_mautrix_twitter_docker_image_force_pull : "{{ matrix_mautrix_twitter_docker_image.endswith(':latest') }}"
2021-04-11 08:11:45 +02:00
2021-04-11 08:18:31 +02:00
matrix_mautrix_twitter_base_path : "{{ matrix_base_data_path }}/mautrix-twitter"
matrix_mautrix_twitter_config_path : "{{ matrix_mautrix_twitter_base_path }}/config"
matrix_mautrix_twitter_data_path : "{{ matrix_mautrix_twitter_base_path }}/data"
matrix_mautrix_twitter_docker_src_files_path : "{{ matrix_mautrix_twitter_base_path }}/docker-src"
2021-04-11 08:11:45 +02:00
2021-04-11 08:18:31 +02:00
matrix_mautrix_twitter_homeserver_address : "{{ matrix_homeserver_container_url }}"
matrix_mautrix_twitter_homeserver_domain : '{{ matrix_domain }}'
2021-04-11 08:29:12 +02:00
matrix_mautrix_twitter_appservice_address : 'http://matrix-mautrix-twitter:29327'
2021-04-11 08:11:45 +02:00
# A list of extra arguments to pass to the container
2021-04-11 08:18:31 +02:00
matrix_mautrix_twitter_container_extra_arguments : [ ]
2021-04-11 08:11:45 +02:00
2021-04-11 08:18:31 +02:00
# List of systemd services that matrix-mautrix-twitter.service depends on.
matrix_mautrix_twitter_systemd_required_services_list : [ 'docker.service' ]
2021-04-11 08:11:45 +02:00
2021-04-11 08:18:31 +02:00
# List of systemd services that matrix-mautrix-twitter.service wants
matrix_mautrix_twitter_systemd_wanted_services_list : [ ]
2021-04-11 08:11:45 +02:00
2021-04-11 08:18:31 +02:00
matrix_mautrix_twitter_appservice_token : ''
matrix_mautrix_twitter_homeserver_token : ''
2021-04-11 08:11:45 +02:00
# Database-related configuration fields.
#
# To use Postgres:
2021-04-11 08:18:31 +02:00
# - adjust your database credentials via the `matrix_mautrix_twitter_postgres_*` variables
matrix_mautrix_twitter_database_engine : 'postgres'
2021-04-11 08:11:45 +02:00
2021-04-11 08:18:31 +02:00
matrix_mautrix_twitter_database_username : 'matrix_mautrix_twitter'
matrix_mautrix_twitter_database_password : 'some-password'
matrix_mautrix_twitter_database_hostname : 'matrix-postgres'
matrix_mautrix_twitter_database_port : 5432
matrix_mautrix_twitter_database_name : 'matrix_mautrix_twitter'
2021-04-11 08:11:45 +02:00
2021-04-11 08:18:31 +02:00
matrix_mautrix_twitter_database_connection_string : 'postgres://{{ matrix_mautrix_twitter_database_username }}:{{ matrix_mautrix_twitter_database_password }}@{{ matrix_mautrix_twitter_database_hostname }}:{{ matrix_mautrix_twitter_database_port }}/{{ matrix_mautrix_twitter_database_name }}'
2021-04-11 08:11:45 +02:00
2021-04-11 08:18:31 +02:00
matrix_mautrix_twitter_appservice_database : "{{
2021-04-11 08:11:45 +02:00
{
2021-04-11 08:18:31 +02:00
'postgres' : matrix_mautrix_twitter_database_connection_string,
}[ matrix_mautrix_twitter_database_engine]
2021-04-11 08:11:45 +02:00
}}"
# Can be set to enable automatic double-puppeting via Shared Secret Auth (https://github.com/devture/matrix-synapse-shared-secret-auth).
2021-04-11 08:18:31 +02:00
matrix_mautrix_twitter_login_shared_secret : ''
2021-04-11 08:11:45 +02:00
2021-04-11 08:18:31 +02:00
matrix_mautrix_twitter_bridge_login_shared_secret_map : "{{ {matrix_mautrix_twitter_homeserver_domain: matrix_mautrix_twitter_login_shared_secret} if matrix_mautrix_twitter_login_shared_secret else {} }}"
2021-04-11 08:11:45 +02:00
2021-04-11 08:18:31 +02:00
matrix_mautrix_twitter_appservice_bot_username : twitterbot
2021-04-11 08:11:45 +02:00
# Default configuration template which covers the generic use case.
# You can customize it by controlling the various variables inside it.
#
2021-04-11 08:18:31 +02:00
# For a more advanced customization, you can extend the default (see `matrix_mautrix_twitter_configuration_extension_yaml`)
2021-04-11 08:11:45 +02:00
# or completely replace this variable with your own template.
2021-04-11 08:18:31 +02:00
matrix_mautrix_twitter_configuration_yaml : "{{ lookup('template', 'templates/config.yaml.j2') }}"
2021-04-11 08:11:45 +02:00
2021-04-11 08:18:31 +02:00
matrix_mautrix_twitter_configuration_extension_yaml : |
2021-04-11 08:11:45 +02:00
# Your custom YAML configuration goes here.
2021-04-11 08:18:31 +02:00
# This configuration extends the default starting configuration (`matrix_mautrix_twitter_configuration_yaml`).
2021-04-11 08:11:45 +02:00
#
# 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
2021-04-11 08:18:31 +02:00
# completely redefining `matrix_mautrix_twitter_configuration_yaml`.
2021-04-11 08:11:45 +02:00
2021-04-11 08:18:31 +02:00
matrix_mautrix_twitter_configuration_extension : "{{ matrix_mautrix_twitter_configuration_extension_yaml|from_yaml if matrix_mautrix_twitter_configuration_extension_yaml|from_yaml is mapping else {} }}"
2021-04-11 08:11:45 +02:00
# Holds the final configuration (a combination of the default and its extension).
2021-04-11 08:18:31 +02:00
# You most likely don't need to touch this variable. Instead, see `matrix_mautrix_twitter_configuration_yaml`.
matrix_mautrix_twitter_configuration : "{{ matrix_mautrix_twitter_configuration_yaml|from_yaml|combine(matrix_mautrix_twitter_configuration_extension, recursive=True) }}"
2021-04-11 08:11:45 +02:00
2021-04-11 08:18:31 +02:00
matrix_mautrix_twitter_registration_yaml : |
id : twitter
as_token : "{{ matrix_mautrix_twitter_appservice_token }}"
hs_token : "{{ matrix_mautrix_twitter_homeserver_token }}"
2021-04-11 08:11:45 +02:00
namespaces :
users :
- exclusive : true
2021-04-11 08:18:31 +02:00
regex : '^@twitter_.+:{{ matrix_mautrix_twitter_homeserver_domain|regex_escape }}$'
2021-04-11 08:11:45 +02:00
- exclusive : true
2021-04-11 08:18:31 +02:00
regex : '^@{{ matrix_mautrix_twitter_appservice_bot_username|regex_escape }}:{{ matrix_mautrix_twitter_homeserver_domain|regex_escape }}$'
url : {{ matrix_mautrix_twitter_appservice_address }}
2021-04-11 08:11:45 +02:00
# See https://github.com/tulir/mautrix-signal/issues/43
2021-04-11 08:18:31 +02:00
sender_localpart : _bot_{{ matrix_mautrix_twitter_appservice_bot_username }}
2021-04-11 08:11:45 +02:00
rate_limited : false
de.sorunome.msc2409.push_ephemeral : true
2021-04-11 08:18:31 +02:00
matrix_mautrix_twitter_registration : "{{ matrix_mautrix_twitter_registration_yaml|from_yaml }}"