pub-solar/matrix-docker-ansible-deploy
5
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

Find/replace Facebook with Twitter

Browse source 
find roles/matrix-bridge-mautrix-twitter -type f -exec sed -i \
  -e 's/facebook/twitter/g' \
  -e 's/Facebook/Twitter/g' \
  -e 's/FB/Twitter/g' \
  -e 's/fb/twitter/g' {} +
This commit is contained in:
Matthew Cengia 2021-04-11 16:18:31 +10:00
parent e9e4d8f250
commit 7afe8103da
8 changed files with 187 additions and 187 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

122
roles/matrix-bridge-mautrix-twitter/defaults/main.yml
View file

@ -1,115 +1,115 @@
# mautrix-facebook is a Matrix <-> Facebook bridge # mautrix-twitter is a Matrix <-> Twitter bridge
# See: https://github.com/tulir/mautrix-facebook # See: https://github.com/tulir/mautrix-twitter
matrix_mautrix_facebook_enabled: true matrix_mautrix_twitter_enabled: true
matrix_mautrix_facebook_container_image_self_build: false matrix_mautrix_twitter_container_image_self_build: false
matrix_mautrix_facebook_container_image_self_build_repo: "https://github.com/tulir/mautrix-facebook.git" matrix_mautrix_twitter_container_image_self_build_repo: "https://github.com/tulir/mautrix-twitter.git"
matrix_mautrix_facebook_version: latest matrix_mautrix_twitter_version: latest
# See: https://mau.dev/tulir/mautrix-facebook/container_registry # See: https://mau.dev/tulir/mautrix-twitter/container_registry
matrix_mautrix_facebook_docker_image: "{{ matrix_mautrix_facebook_docker_image_name_prefix }}tulir/mautrix-facebook:{{ matrix_mautrix_facebook_version }}" matrix_mautrix_twitter_docker_image: "{{ matrix_mautrix_twitter_docker_image_name_prefix }}tulir/mautrix-twitter:{{ matrix_mautrix_twitter_version }}"
matrix_mautrix_facebook_docker_image_name_prefix: "{{ 'localhost/' if matrix_mautrix_facebook_container_image_self_build else 'dock.mau.dev/' }}" matrix_mautrix_twitter_docker_image_name_prefix: "{{ 'localhost/' if matrix_mautrix_twitter_container_image_self_build else 'dock.mau.dev/' }}"
matrix_mautrix_facebook_docker_image_force_pull: "{{ matrix_mautrix_facebook_docker_image.endswith(':latest') }}" matrix_mautrix_twitter_docker_image_force_pull: "{{ matrix_mautrix_twitter_docker_image.endswith(':latest') }}"
matrix_mautrix_facebook_base_path: "{{ matrix_base_data_path }}/mautrix-facebook" matrix_mautrix_twitter_base_path: "{{ matrix_base_data_path }}/mautrix-twitter"
matrix_mautrix_facebook_config_path: "{{ matrix_mautrix_facebook_base_path }}/config" matrix_mautrix_twitter_config_path: "{{ matrix_mautrix_twitter_base_path }}/config"
matrix_mautrix_facebook_data_path: "{{ matrix_mautrix_facebook_base_path }}/data" matrix_mautrix_twitter_data_path: "{{ matrix_mautrix_twitter_base_path }}/data"
matrix_mautrix_facebook_docker_src_files_path: "{{ matrix_mautrix_facebook_base_path }}/docker-src" matrix_mautrix_twitter_docker_src_files_path: "{{ matrix_mautrix_twitter_base_path }}/docker-src"
matrix_mautrix_facebook_homeserver_address: "{{ matrix_homeserver_container_url }}" matrix_mautrix_twitter_homeserver_address: "{{ matrix_homeserver_container_url }}"
matrix_mautrix_facebook_homeserver_domain: '{{ matrix_domain }}' matrix_mautrix_twitter_homeserver_domain: '{{ matrix_domain }}'
matrix_mautrix_facebook_appservice_address: 'http://matrix-mautrix-facebook:29319' matrix_mautrix_twitter_appservice_address: 'http://matrix-mautrix-twitter:29319'
# A list of extra arguments to pass to the container # A list of extra arguments to pass to the container
matrix_mautrix_facebook_container_extra_arguments: [] matrix_mautrix_twitter_container_extra_arguments: []
# List of systemd services that matrix-mautrix-facebook.service depends on. # List of systemd services that matrix-mautrix-twitter.service depends on.
matrix_mautrix_facebook_systemd_required_services_list: ['docker.service'] matrix_mautrix_twitter_systemd_required_services_list: ['docker.service']
# List of systemd services that matrix-mautrix-facebook.service wants # List of systemd services that matrix-mautrix-twitter.service wants
matrix_mautrix_facebook_systemd_wanted_services_list: [] matrix_mautrix_twitter_systemd_wanted_services_list: []
matrix_mautrix_facebook_appservice_token: '' matrix_mautrix_twitter_appservice_token: ''
matrix_mautrix_facebook_homeserver_token: '' matrix_mautrix_twitter_homeserver_token: ''
# Database-related configuration fields. # Database-related configuration fields.
# #
# To use SQLite: # To use SQLite:
# - change the engine (`matrix_mautrix_facebook_database_engine: 'sqlite'`) # - change the engine (`matrix_mautrix_twitter_database_engine: 'sqlite'`)
# - change to the last bridge version that supported 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"` # `matrix_mautrix_twitter_docker_image: "{{ matrix_mautrix_twitter_docker_image_name_prefix }}tulir/mautrix-twitter:da1b4ec596e334325a1589e70829dea46e73064b"`
# - plan your migration to Postgres, as this bridge does not support SQLite anymore (and neither will the playbook in the future). # - plan your migration to Postgres, as this bridge does not support SQLite anymore (and neither will the playbook in the future).
# #
# To use Postgres: # To use Postgres:
# - adjust your database credentials via the `matrix_mautrix_facebook_postgres_*` variables # - adjust your database credentials via the `matrix_mautrix_twitter_postgres_*` variables
matrix_mautrix_facebook_database_engine: 'postgres' matrix_mautrix_twitter_database_engine: 'postgres'
matrix_mautrix_facebook_sqlite_database_path_local: "{{ matrix_mautrix_facebook_data_path }}/mautrix-facebook.db" matrix_mautrix_twitter_sqlite_database_path_local: "{{ matrix_mautrix_twitter_data_path }}/mautrix-twitter.db"
matrix_mautrix_facebook_sqlite_database_path_in_container: "/data/mautrix-facebook.db" matrix_mautrix_twitter_sqlite_database_path_in_container: "/data/mautrix-twitter.db"
matrix_mautrix_facebook_database_username: 'matrix_mautrix_facebook' matrix_mautrix_twitter_database_username: 'matrix_mautrix_twitter'
matrix_mautrix_facebook_database_password: 'some-password' matrix_mautrix_twitter_database_password: 'some-password'
matrix_mautrix_facebook_database_hostname: 'matrix-postgres' matrix_mautrix_twitter_database_hostname: 'matrix-postgres'
matrix_mautrix_facebook_database_port: 5432 matrix_mautrix_twitter_database_port: 5432
matrix_mautrix_facebook_database_name: 'matrix_mautrix_facebook' matrix_mautrix_twitter_database_name: 'matrix_mautrix_twitter'
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_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 }}'
matrix_mautrix_facebook_appservice_database: "{{ matrix_mautrix_twitter_appservice_database: "{{
{ {
'sqlite': ('sqlite:///' + matrix_mautrix_facebook_sqlite_database_path_in_container), 'sqlite': ('sqlite:///' + matrix_mautrix_twitter_sqlite_database_path_in_container),
'postgres': matrix_mautrix_facebook_database_connection_string, 'postgres': matrix_mautrix_twitter_database_connection_string,
}[matrix_mautrix_facebook_database_engine] }[matrix_mautrix_twitter_database_engine]
}}" }}"
# Can be set to enable automatic double-puppeting via Shared Secret Auth (https://github.com/devture/matrix-synapse-shared-secret-auth). # 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_twitter_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 {} }}" 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 {} }}"
matrix_mautrix_facebook_appservice_bot_username: facebookbot matrix_mautrix_twitter_appservice_bot_username: twitterbot
matrix_mautrix_facebook_bridge_presence: true matrix_mautrix_twitter_bridge_presence: true
# Default configuration template which covers the generic use case. # Default configuration template which covers the generic use case.
# You can customize it by controlling the various variables inside it. # 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`) # For a more advanced customization, you can extend the default (see `matrix_mautrix_twitter_configuration_extension_yaml`)
# or completely replace this variable with your own template. # or completely replace this variable with your own template.
matrix_mautrix_facebook_configuration_yaml: "{{ lookup('template', 'templates/config.yaml.j2') }}" matrix_mautrix_twitter_configuration_yaml: "{{ lookup('template', 'templates/config.yaml.j2') }}"
matrix_mautrix_facebook_configuration_extension_yaml: | matrix_mautrix_twitter_configuration_extension_yaml: |
# Your custom YAML configuration goes here. # Your custom YAML configuration goes here.
# This configuration extends the default starting configuration (`matrix_mautrix_facebook_configuration_yaml`). # This configuration extends the default starting configuration (`matrix_mautrix_twitter_configuration_yaml`).
# #
# You can override individual variables from the default configuration, or introduce new ones. # 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 # If you need something more special, you can take full control by
# completely redefining `matrix_mautrix_facebook_configuration_yaml`. # completely redefining `matrix_mautrix_twitter_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 {} }}" 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 {} }}"
# Holds the final configuration (a combination of the default and its extension). # 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`. # You most likely don't need to touch this variable. Instead, see `matrix_mautrix_twitter_configuration_yaml`.
matrix_mautrix_facebook_configuration: "{{ matrix_mautrix_facebook_configuration_yaml|from_yaml|combine(matrix_mautrix_facebook_configuration_extension, recursive=True) }}" matrix_mautrix_twitter_configuration: "{{ matrix_mautrix_twitter_configuration_yaml|from_yaml|combine(matrix_mautrix_twitter_configuration_extension, recursive=True) }}"
matrix_mautrix_facebook_registration_yaml: | matrix_mautrix_twitter_registration_yaml: |
id: facebook id: twitter
as_token: "{{ matrix_mautrix_facebook_appservice_token }}" as_token: "{{ matrix_mautrix_twitter_appservice_token }}"
hs_token: "{{ matrix_mautrix_facebook_homeserver_token }}" hs_token: "{{ matrix_mautrix_twitter_homeserver_token }}"
namespaces: namespaces:
users: users:
- exclusive: true - exclusive: true
regex: '^@facebook_.+:{{ matrix_mautrix_facebook_homeserver_domain|regex_escape }}$' regex: '^@twitter_.+:{{ matrix_mautrix_twitter_homeserver_domain|regex_escape }}$'
- exclusive: true - exclusive: true
regex: '^@{{ matrix_mautrix_facebook_appservice_bot_username|regex_escape }}:{{ matrix_mautrix_facebook_homeserver_domain|regex_escape }}$' regex: '^@{{ matrix_mautrix_twitter_appservice_bot_username|regex_escape }}:{{ matrix_mautrix_twitter_homeserver_domain|regex_escape }}$'
url: {{ matrix_mautrix_facebook_appservice_address }} url: {{ matrix_mautrix_twitter_appservice_address }}
# See https://github.com/tulir/mautrix-signal/issues/43 # See https://github.com/tulir/mautrix-signal/issues/43
sender_localpart: _bot_{{ matrix_mautrix_facebook_appservice_bot_username }} sender_localpart: _bot_{{ matrix_mautrix_twitter_appservice_bot_username }}
rate_limited: false rate_limited: false
de.sorunome.msc2409.push_ephemeral: true de.sorunome.msc2409.push_ephemeral: true
matrix_mautrix_facebook_registration: "{{ matrix_mautrix_facebook_registration_yaml|from_yaml }}" matrix_mautrix_twitter_registration: "{{ matrix_mautrix_twitter_registration_yaml|from_yaml }}"

14
roles/matrix-bridge-mautrix-twitter/tasks/init.yml
View file

@ -1,23 +1,23 @@
- set_fact: - set_fact:
matrix_systemd_services_list: "{{ matrix_systemd_services_list + ['matrix-mautrix-facebook.service'] }}" matrix_systemd_services_list: "{{ matrix_systemd_services_list + ['matrix-mautrix-twitter.service'] }}"
when: matrix_mautrix_facebook_enabled|bool when: matrix_mautrix_twitter_enabled|bool
# If the matrix-synapse role is not used, these variables may not exist. # If the matrix-synapse role is not used, these variables may not exist.
- set_fact: - set_fact:
matrix_synapse_container_extra_arguments: > matrix_synapse_container_extra_arguments: >
{{ matrix_synapse_container_extra_arguments|default([]) }} {{ matrix_synapse_container_extra_arguments|default([]) }}
+ +
["--mount type=bind,src={{ matrix_mautrix_facebook_config_path }}/registration.yaml,dst=/matrix-mautrix-facebook-registration.yaml,ro"] ["--mount type=bind,src={{ matrix_mautrix_twitter_config_path }}/registration.yaml,dst=/matrix-mautrix-twitter-registration.yaml,ro"]
matrix_synapse_app_service_config_files: > matrix_synapse_app_service_config_files: >
{{ matrix_synapse_app_service_config_files|default([]) }} {{ matrix_synapse_app_service_config_files|default([]) }}
+ +
{{ ["/matrix-mautrix-facebook-registration.yaml"] }} {{ ["/matrix-mautrix-twitter-registration.yaml"] }}
when: matrix_mautrix_facebook_enabled|bool when: matrix_mautrix_twitter_enabled|bool
# ansible lower than 2.8, does not support docker_image build parameters # ansible lower than 2.8, does not support docker_image build parameters
# for self buildig it is explicitly needed, so we rather fail here # for self buildig it is explicitly needed, so we rather fail here
- name: Fail if running on Ansible lower than 2.8 and trying self building - name: Fail if running on Ansible lower than 2.8 and trying self building
fail: fail:
msg: "To self build Mautrix Facebook image, you should usa ansible 2.8 or higher. E.g. pip contains such packages." msg: "To self build Mautrix Twitter image, you should usa ansible 2.8 or higher. E.g. pip contains such packages."
when: "ansible_version.major == 2 and ansible_version.minor < 8 and matrix_mautrix_facebook_container_image_self_build" when: "ansible_version.major == 2 and ansible_version.minor < 8 and matrix_mautrix_twitter_container_image_self_build"

12
roles/matrix-bridge-mautrix-twitter/tasks/main.yml
View file

@ -3,19 +3,19 @@
- always - always
- import_tasks: "{{ role_path }}/tasks/validate_config.yml" - import_tasks: "{{ role_path }}/tasks/validate_config.yml"
when: "run_setup|bool and matrix_mautrix_facebook_enabled|bool" when: "run_setup|bool and matrix_mautrix_twitter_enabled|bool"
tags: tags:
- setup-all - setup-all
- setup-mautrix-facebook - setup-mautrix-twitter
- import_tasks: "{{ role_path }}/tasks/setup_install.yml" - import_tasks: "{{ role_path }}/tasks/setup_install.yml"
when: "run_setup|bool and matrix_mautrix_facebook_enabled|bool" when: "run_setup|bool and matrix_mautrix_twitter_enabled|bool"
tags: tags:
- setup-all - setup-all
- setup-mautrix-facebook - setup-mautrix-twitter
- import_tasks: "{{ role_path }}/tasks/setup_uninstall.yml" - import_tasks: "{{ role_path }}/tasks/setup_uninstall.yml"
when: "run_setup|bool and not matrix_mautrix_facebook_enabled|bool" when: "run_setup|bool and not matrix_mautrix_twitter_enabled|bool"
tags: tags:
- setup-all - setup-all
- setup-mautrix-facebook - setup-mautrix-twitter

108
roles/matrix-bridge-mautrix-twitter/tasks/setup_install.yml
View file

@ -5,44 +5,44 @@
- name: Fail if matrix-synapse role already executed - name: Fail if matrix-synapse role already executed
fail: fail:
msg: >- msg: >-
The matrix-bridge-mautrix-facebook role needs to execute before the matrix-synapse role. The matrix-bridge-mautrix-twitter role needs to execute before the matrix-synapse role.
when: "matrix_synapse_role_executed|default(False)" when: "matrix_synapse_role_executed|default(False)"
- set_fact: - set_fact:
matrix_mautrix_facebook_requires_restart: false matrix_mautrix_twitter_requires_restart: false
- block: - block:
- name: Check if an SQLite database already exists - name: Check if an SQLite database already exists
stat: stat:
path: "{{ matrix_mautrix_facebook_sqlite_database_path_local }}" path: "{{ matrix_mautrix_twitter_sqlite_database_path_local }}"
register: matrix_mautrix_facebook_sqlite_database_path_local_stat_result register: matrix_mautrix_twitter_sqlite_database_path_local_stat_result
- block: - block:
- set_fact: - set_fact:
matrix_postgres_db_migration_request: matrix_postgres_db_migration_request:
src: "{{ matrix_mautrix_facebook_sqlite_database_path_local }}" src: "{{ matrix_mautrix_twitter_sqlite_database_path_local }}"
dst: "{{ matrix_mautrix_facebook_database_connection_string }}" dst: "{{ matrix_mautrix_twitter_database_connection_string }}"
caller: "{{ role_path|basename }}" caller: "{{ role_path|basename }}"
engine_variable_name: 'matrix_mautrix_facebook_database_engine' engine_variable_name: 'matrix_mautrix_twitter_database_engine'
engine_old: 'sqlite' engine_old: 'sqlite'
systemd_services_to_stop: ['matrix-mautrix-facebook.service'] systemd_services_to_stop: ['matrix-mautrix-twitter.service']
- import_tasks: "{{ role_path }}/../matrix-postgres/tasks/util/migrate_db_to_postgres.yml" - import_tasks: "{{ role_path }}/../matrix-postgres/tasks/util/migrate_db_to_postgres.yml"
- set_fact: - set_fact:
matrix_mautrix_facebook_requires_restart: true matrix_mautrix_twitter_requires_restart: true
when: "matrix_mautrix_facebook_sqlite_database_path_local_stat_result.stat.exists|bool" when: "matrix_mautrix_twitter_sqlite_database_path_local_stat_result.stat.exists|bool"
when: "matrix_mautrix_facebook_database_engine == 'postgres'" when: "matrix_mautrix_twitter_database_engine == 'postgres'"
- name: Ensure Mautrix Facebook image is pulled - name: Ensure Mautrix Twitter image is pulled
docker_image: docker_image:
name: "{{ matrix_mautrix_facebook_docker_image }}" name: "{{ matrix_mautrix_twitter_docker_image }}"
source: "{{ 'pull' if ansible_version.major > 2 or ansible_version.minor > 7 else omit }}" source: "{{ 'pull' if ansible_version.major > 2 or ansible_version.minor > 7 else omit }}"
force_source: "{{ matrix_mautrix_facebook_docker_image_force_pull if ansible_version.major > 2 or ansible_version.minor >= 8 else omit }}" force_source: "{{ matrix_mautrix_twitter_docker_image_force_pull if ansible_version.major > 2 or ansible_version.minor >= 8 else omit }}"
force: "{{ omit if ansible_version.major > 2 or ansible_version.minor >= 8 else matrix_mautrix_facebook_docker_image_force_pull }}" force: "{{ omit if ansible_version.major > 2 or ansible_version.minor >= 8 else matrix_mautrix_twitter_docker_image_force_pull }}"
when: matrix_mautrix_facebook_enabled|bool and not matrix_mautrix_facebook_container_image_self_build when: matrix_mautrix_twitter_enabled|bool and not matrix_mautrix_twitter_container_image_self_build
- name: Ensure Mautrix Facebook paths exist - name: Ensure Mautrix Twitter paths exist
file: file:
path: "{{ item.path }}" path: "{{ item.path }}"
state: directory state: directory
@ -50,79 +50,79 @@
owner: "{{ matrix_user_username }}" owner: "{{ matrix_user_username }}"
group: "{{ matrix_user_groupname }}" group: "{{ matrix_user_groupname }}"
with_items: with_items:
- { path: "{{ matrix_mautrix_facebook_base_path }}", when: true } - { path: "{{ matrix_mautrix_twitter_base_path }}", when: true }
- { path: "{{ matrix_mautrix_facebook_config_path }}", when: true } - { path: "{{ matrix_mautrix_twitter_config_path }}", when: true }
- { path: "{{ matrix_mautrix_facebook_data_path }}", when: true } - { path: "{{ matrix_mautrix_twitter_data_path }}", when: true }
- { path: "{{ matrix_mautrix_facebook_docker_src_files_path }}", when: "{{ matrix_mautrix_facebook_container_image_self_build }}" } - { path: "{{ matrix_mautrix_twitter_docker_src_files_path }}", when: "{{ matrix_mautrix_twitter_container_image_self_build }}" }
when: item.when|bool when: item.when|bool
- name: Ensure Mautrix Facebook repository is present on self-build - name: Ensure Mautrix Twitter repository is present on self-build
git: git:
repo: "{{ matrix_mautrix_facebook_container_image_self_build_repo }}" repo: "{{ matrix_mautrix_twitter_container_image_self_build_repo }}"
dest: "{{ matrix_mautrix_facebook_docker_src_files_path }}" dest: "{{ matrix_mautrix_twitter_docker_src_files_path }}"
# version: "{{ matrix_coturn_docker_image.split(':')[1] }}" # version: "{{ matrix_coturn_docker_image.split(':')[1] }}"
force: "yes" force: "yes"
register: matrix_mautrix_facebook_git_pull_results register: matrix_mautrix_twitter_git_pull_results
when: "matrix_mautrix_facebook_enabled|bool and matrix_mautrix_facebook_container_image_self_build" when: "matrix_mautrix_twitter_enabled|bool and matrix_mautrix_twitter_container_image_self_build"
- name: Ensure Mautrix Facebook Docker image is built - name: Ensure Mautrix Twitter Docker image is built
docker_image: docker_image:
name: "{{ matrix_mautrix_facebook_docker_image }}" name: "{{ matrix_mautrix_twitter_docker_image }}"
source: build source: build
force_source: "{{ matrix_mautrix_facebook_git_pull_results.changed }}" force_source: "{{ matrix_mautrix_twitter_git_pull_results.changed }}"
build: build:
dockerfile: Dockerfile dockerfile: Dockerfile
path: "{{ matrix_mautrix_facebook_docker_src_files_path }}" path: "{{ matrix_mautrix_twitter_docker_src_files_path }}"
pull: yes pull: yes
when: "matrix_mautrix_facebook_enabled|bool and matrix_mautrix_facebook_container_image_self_build|bool" when: "matrix_mautrix_twitter_enabled|bool and matrix_mautrix_twitter_container_image_self_build|bool"
- name: Check if an old database file already exists - name: Check if an old database file already exists
stat: stat:
path: "{{ matrix_mautrix_facebook_base_path }}/mautrix-facebook.db" path: "{{ matrix_mautrix_twitter_base_path }}/mautrix-twitter.db"
register: matrix_mautrix_facebook_stat_database register: matrix_mautrix_twitter_stat_database
- name: (Data relocation) Ensure matrix-mautrix-facebook.service is stopped - name: (Data relocation) Ensure matrix-mautrix-twitter.service is stopped
service: service:
name: matrix-mautrix-facebook name: matrix-mautrix-twitter
state: stopped state: stopped
daemon_reload: yes daemon_reload: yes
failed_when: false failed_when: false
when: "matrix_mautrix_facebook_stat_database.stat.exists" when: "matrix_mautrix_twitter_stat_database.stat.exists"
- name: (Data relocation) Move mautrix-facebook database file to ./data directory - name: (Data relocation) Move mautrix-twitter database file to ./data directory
command: "mv {{ matrix_mautrix_facebook_base_path }}/mautrix-facebook.db {{ matrix_mautrix_facebook_data_path }}/mautrix-facebook.db" command: "mv {{ matrix_mautrix_twitter_base_path }}/mautrix-twitter.db {{ matrix_mautrix_twitter_data_path }}/mautrix-twitter.db"
when: "matrix_mautrix_facebook_stat_database.stat.exists" when: "matrix_mautrix_twitter_stat_database.stat.exists"
- name: Ensure mautrix-facebook config.yaml installed - name: Ensure mautrix-twitter config.yaml installed
copy: copy:
content: "{{ matrix_mautrix_facebook_configuration|to_nice_yaml }}" content: "{{ matrix_mautrix_twitter_configuration|to_nice_yaml }}"
dest: "{{ matrix_mautrix_facebook_config_path }}/config.yaml" dest: "{{ matrix_mautrix_twitter_config_path }}/config.yaml"
mode: 0644 mode: 0644
owner: "{{ matrix_user_username }}" owner: "{{ matrix_user_username }}"
group: "{{ matrix_user_groupname }}" group: "{{ matrix_user_groupname }}"
- name: Ensure mautrix-facebook registration.yaml installed - name: Ensure mautrix-twitter registration.yaml installed
copy: copy:
content: "{{ matrix_mautrix_facebook_registration|to_nice_yaml }}" content: "{{ matrix_mautrix_twitter_registration|to_nice_yaml }}"
dest: "{{ matrix_mautrix_facebook_config_path }}/registration.yaml" dest: "{{ matrix_mautrix_twitter_config_path }}/registration.yaml"
mode: 0644 mode: 0644
owner: "{{ matrix_user_username }}" owner: "{{ matrix_user_username }}"
group: "{{ matrix_user_groupname }}" group: "{{ matrix_user_groupname }}"
- name: Ensure matrix-mautrix-facebook.service installed - name: Ensure matrix-mautrix-twitter.service installed
template: template:
src: "{{ role_path }}/templates/systemd/matrix-mautrix-facebook.service.j2" src: "{{ role_path }}/templates/systemd/matrix-mautrix-twitter.service.j2"
dest: "{{ matrix_systemd_path }}/matrix-mautrix-facebook.service" dest: "{{ matrix_systemd_path }}/matrix-mautrix-twitter.service"
mode: 0644 mode: 0644
register: matrix_mautrix_facebook_systemd_service_result register: matrix_mautrix_twitter_systemd_service_result
- name: Ensure systemd reloaded after matrix-mautrix-facebook.service installation - name: Ensure systemd reloaded after matrix-mautrix-twitter.service installation
service: service:
daemon_reload: yes daemon_reload: yes
when: "matrix_mautrix_facebook_systemd_service_result.changed" when: "matrix_mautrix_twitter_systemd_service_result.changed"
- name: Ensure matrix-mautrix-facebook.service restarted, if necessary - name: Ensure matrix-mautrix-twitter.service restarted, if necessary
service: service:
name: "matrix-mautrix-facebook.service" name: "matrix-mautrix-twitter.service"
state: restarted state: restarted
when: "matrix_mautrix_facebook_requires_restart|bool" when: "matrix_mautrix_twitter_requires_restart|bool"

22
roles/matrix-bridge-mautrix-twitter/tasks/setup_uninstall.yml
View file

@ -1,24 +1,24 @@
--- ---
- name: Check existence of matrix-mautrix-facebook service - name: Check existence of matrix-mautrix-twitter service
stat: stat:
path: "{{ matrix_systemd_path }}/matrix-mautrix-facebook.service" path: "{{ matrix_systemd_path }}/matrix-mautrix-twitter.service"
register: matrix_mautrix_facebook_service_stat register: matrix_mautrix_twitter_service_stat
- name: Ensure matrix-mautrix-facebook is stopped - name: Ensure matrix-mautrix-twitter is stopped
service: service:
name: matrix-mautrix-facebook name: matrix-mautrix-twitter
state: stopped state: stopped
daemon_reload: yes daemon_reload: yes
when: "matrix_mautrix_facebook_service_stat.stat.exists" when: "matrix_mautrix_twitter_service_stat.stat.exists"
- name: Ensure matrix-mautrix-facebook.service doesn't exist - name: Ensure matrix-mautrix-twitter.service doesn't exist
file: file:
path: "{{ matrix_systemd_path }}/matrix-mautrix-facebook.service" path: "{{ matrix_systemd_path }}/matrix-mautrix-twitter.service"
state: absent state: absent
when: "matrix_mautrix_facebook_service_stat.stat.exists" when: "matrix_mautrix_twitter_service_stat.stat.exists"
- name: Ensure systemd reloaded after matrix-mautrix-facebook.service removal - name: Ensure systemd reloaded after matrix-mautrix-twitter.service removal
service: service:
daemon_reload: yes daemon_reload: yes
when: "matrix_mautrix_facebook_service_stat.stat.exists" when: "matrix_mautrix_twitter_service_stat.stat.exists"

14
roles/matrix-bridge-mautrix-twitter/tasks/validate_config.yml
View file

@ -6,17 +6,17 @@
You need to define a required configuration setting (`{{ item }}`). You need to define a required configuration setting (`{{ item }}`).
when: "vars[item] == ''" when: "vars[item] == ''"
with_items: with_items:
- "matrix_mautrix_facebook_appservice_token" - "matrix_mautrix_twitter_appservice_token"
- "matrix_mautrix_facebook_homeserver_token" - "matrix_mautrix_twitter_homeserver_token"
- block: - block:
- name: Fail if on SQLite, unless on the last version supporting SQLite - name: Fail if on SQLite, unless on the last version supporting SQLite
fail: fail:
msg: >- msg: >-
You're trying to use the mautrix-facebook bridge with an SQLite database. You're trying to use the mautrix-twitter bridge with an SQLite database.
Going forward, this bridge only supports Postgres. Going forward, this bridge only supports Postgres.
To learn more about this, see our changelog: https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/master/CHANGELOG.md#breaking-change-the-mautrix-facebook-bridge-now-requires-a-postgres-database To learn more about this, see our changelog: https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/master/CHANGELOG.md#breaking-change-the-mautrix-twitter-bridge-now-requires-a-postgres-database
when: "not matrix_mautrix_facebook_docker_image.endswith(':da1b4ec596e334325a1589e70829dea46e73064b')" when: "not matrix_mautrix_twitter_docker_image.endswith(':da1b4ec596e334325a1589e70829dea46e73064b')"
- name: Inject warning if still on SQLite - name: Inject warning if still on SQLite
set_fact: set_fact:
@ -25,7 +25,7 @@
matrix_playbook_runtime_results|default([]) matrix_playbook_runtime_results|default([])
+ +
[ [
"NOTE: Your mautrix-facebook bridge setup is still on SQLite. Your bridge is not getting any updates and will likely stop working at some point. To learn more about this, see our changelog: https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/master/CHANGELOG.md#breaking-change-the-mautrix-facebook-bridge-now-requires-a-postgres-database" "NOTE: Your mautrix-twitter bridge setup is still on SQLite. Your bridge is not getting any updates and will likely stop working at some point. To learn more about this, see our changelog: https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/master/CHANGELOG.md#breaking-change-the-mautrix-twitter-bridge-now-requires-a-postgres-database"
] ]
}} }}
when: "matrix_mautrix_facebook_database_engine == 'sqlite'" when: "matrix_mautrix_twitter_database_engine == 'sqlite'"

54
roles/matrix-bridge-mautrix-twitter/templates/config.yaml.j2
View file

@ -2,9 +2,9 @@
# Homeserver details # Homeserver details
homeserver: homeserver:
# The address that this appservice can use to connect to the homeserver. # The address that this appservice can use to connect to the homeserver.
address: {{ matrix_mautrix_facebook_homeserver_address }} address: {{ matrix_mautrix_twitter_homeserver_address }}
# The domain of the homeserver (for MXIDs, etc). # The domain of the homeserver (for MXIDs, etc).
domain: {{ matrix_mautrix_facebook_homeserver_domain }} domain: {{ matrix_mautrix_twitter_homeserver_domain }}
# Whether or not to verify the SSL certificate of the homeserver. # Whether or not to verify the SSL certificate of the homeserver.
# Only applies if address starts with https:// # Only applies if address starts with https://
verify_ssl: true verify_ssl: true
@ -17,7 +17,7 @@ homeserver:
# Changing these values requires regeneration of the registration. # Changing these values requires regeneration of the registration.
appservice: appservice:
# The address that the homeserver can use to connect to this appservice. # The address that the homeserver can use to connect to this appservice.
address: {{ matrix_mautrix_facebook_appservice_address }} address: {{ matrix_mautrix_twitter_appservice_address }}
# The hostname and port where this appservice should listen. # The hostname and port where this appservice should listen.
hostname: 0.0.0.0 hostname: 0.0.0.0
@ -27,7 +27,7 @@ appservice:
max_body_size: 1 max_body_size: 1
# The full URI to the database. Only Postgres is currently supported. # The full URI to the database. Only Postgres is currently supported.
database: {{ matrix_mautrix_facebook_appservice_database|to_json }} database: {{ matrix_mautrix_twitter_appservice_database|to_json }}
# Public part of web server for out-of-Matrix interaction with the bridge. # Public part of web server for out-of-Matrix interaction with the bridge.
public: public:
@ -44,17 +44,17 @@ appservice:
shared_secret: generate shared_secret: generate
# The unique ID of this appservice. # The unique ID of this appservice.
id: facebook id: twitter
# Username of the appservice bot. # Username of the appservice bot.
bot_username: {{ matrix_mautrix_facebook_appservice_bot_username|to_json }} bot_username: {{ matrix_mautrix_twitter_appservice_bot_username|to_json }}
# Display name and avatar for bot. Set to "remove" to remove display name/avatar, leave empty # Display name and avatar for bot. Set to "remove" to remove display name/avatar, leave empty
# to leave display name/avatar as-is. # to leave display name/avatar as-is.
bot_displayname: Facebook bridge bot bot_displayname: Twitter bridge bot
bot_avatar: mxc://maunium.net/ygtkteZsXnGJLJHRchUwYWak bot_avatar: mxc://maunium.net/ygtkteZsXnGJLJHRchUwYWak
# Authentication tokens for AS <-> HS communication. # Authentication tokens for AS <-> HS communication.
as_token: "{{ matrix_mautrix_facebook_appservice_token }}" as_token: "{{ matrix_mautrix_twitter_appservice_token }}"
hs_token: "{{ matrix_mautrix_facebook_homeserver_token }}" hs_token: "{{ matrix_mautrix_twitter_homeserver_token }}"
# Prometheus telemetry config. Requires prometheus-client to be installed. # Prometheus telemetry config. Requires prometheus-client to be installed.
metrics: metrics:
@ -63,20 +63,20 @@ metrics:
# Bridge config # Bridge config
bridge: bridge:
# Localpart template of MXIDs for Facebook users. # Localpart template of MXIDs for Twitter users.
# {userid} is replaced with the user ID of the Facebook user. # {userid} is replaced with the user ID of the Twitter user.
username_template: "facebook_{userid}" username_template: "twitter_{userid}"
# Localpart template for per-user room grouping community IDs. # Localpart template for per-user room grouping community IDs.
# The bridge will create these communities and add all of the specific user's portals to the community. # The bridge will create these communities and add all of the specific user's portals to the community.
# {localpart} is the MXID localpart and {server} is the MXID server part of the user. # {localpart} is the MXID localpart and {server} is the MXID server part of the user.
# #
# `facebook_{localpart}={server}` is a good value. # `twitter_{localpart}={server}` is a good value.
community_template: null community_template: null
# Displayname template for Facebook users. # Displayname template for Twitter users.
# {displayname} is replaced with the display name of the Facebook user # {displayname} is replaced with the display name of the Twitter user
# as defined below in displayname_preference. # as defined below in displayname_preference.
# Keys available for displayname_preference are also available here. # Keys available for displayname_preference are also available here.
displayname_template: '{displayname} (FB)' displayname_template: '{displayname} (Twitter)'
# Available keys: # Available keys:
# "name" (full name) # "name" (full name)
# "first_name" # "first_name"
@ -88,12 +88,12 @@ bridge:
- first_name - first_name
# The prefix for commands. Only required in non-management rooms. # The prefix for commands. Only required in non-management rooms.
command_prefix: "!fb" command_prefix: "!twitter"
# Number of chats to sync (and create portals for) on startup/login. # Number of chats to sync (and create portals for) on startup/login.
# Set 0 to disable automatic syncing. # Set 0 to disable automatic syncing.
initial_chat_sync: 10 initial_chat_sync: 10
# Whether or not the Facebook users of logged in Matrix users should be # Whether or not the Twitter users of logged in Matrix users should be
# invited to private chats when the user sends a message from another client. # invited to private chats when the user sends a message from another client.
invite_own_puppet_to_pm: false invite_own_puppet_to_pm: false
# Whether or not to use /sync to get presence, read receipts and typing notifications # Whether or not to use /sync to get presence, read receipts and typing notifications
@ -115,8 +115,8 @@ bridge:
# manually. # manually.
# If using this for other servers than the bridge's server, # If using this for other servers than the bridge's server,
# you must also set the URL in the double_puppet_server_map. # you must also set the URL in the double_puppet_server_map.
login_shared_secret_map: {{ matrix_mautrix_facebook_bridge_login_shared_secret_map|to_json }} login_shared_secret_map: {{ matrix_mautrix_twitter_bridge_login_shared_secret_map|to_json }}
presence: {{ matrix_mautrix_facebook_bridge_presence|to_json }} presence: {{ matrix_mautrix_twitter_bridge_presence|to_json }}
# Whether or not to update avatars when syncing all contacts at startup. # Whether or not to update avatars when syncing all contacts at startup.
update_avatar_initial_sync: true update_avatar_initial_sync: true
# End-to-bridge encryption support options. These require matrix-nio to be installed with pip # End-to-bridge encryption support options. These require matrix-nio to be installed with pip
@ -143,14 +143,14 @@ bridge:
# Verification by the bridge is not yet implemented. # Verification by the bridge is not yet implemented.
require_verification: true require_verification: true
# Whether or not the bridge should send a read receipt from the bridge bot when a message has # Whether or not the bridge should send a read receipt from the bridge bot when a message has
# been sent to Facebook. # been sent to Twitter.
delivery_receipts: false delivery_receipts: false
# Whether to allow inviting arbitrary mxids to portal rooms # Whether to allow inviting arbitrary mxids to portal rooms
allow_invites: false allow_invites: false
# Settings for backfilling messages from Facebook. # Settings for backfilling messages from Twitter.
backfill: backfill:
# Whether or not the Facebook users of logged in Matrix users should be # Whether or not the Twitter users of logged in Matrix users should be
# invited to private chats when backfilling history from Facebook. This is # invited to private chats when backfilling history from Twitter. This is
# usually needed to prevent rate limits and to allow timestamp massaging. # usually needed to prevent rate limits and to allow timestamp massaging.
invite_own_puppet: true invite_own_puppet: true
# Maximum number of messages to backfill initially. # Maximum number of messages to backfill initially.
@ -165,7 +165,7 @@ bridge:
disable_notifications: false disable_notifications: false
periodic_reconnect: periodic_reconnect:
# Interval in seconds in which to automatically reconnect all users. # Interval in seconds in which to automatically reconnect all users.
# This can be used to automatically mitigate the bug where Facebook stops sending messages. # This can be used to automatically mitigate the bug where Twitter stops sending messages.
# Set to -1 to disable periodic reconnections entirely. # Set to -1 to disable periodic reconnections entirely.
interval: -1 interval: -1
# What to do in periodic reconnects. Either "refresh" or "reconnect" # What to do in periodic reconnects. Either "refresh" or "reconnect"
@ -197,7 +197,7 @@ bridge:
# domain - All users on that homeserver # domain - All users on that homeserver
# mxid - Specific user # mxid - Specific user
permissions: permissions:
'{{ matrix_mautrix_facebook_homeserver_domain }}': user '{{ matrix_mautrix_twitter_homeserver_domain }}': user
# Python logging configuration. # Python logging configuration.
# #
@ -207,7 +207,7 @@ logging:
version: 1 version: 1
formatters: formatters:
colored: colored:
(): mautrix_facebook.util.ColorFormatter (): mautrix_twitter.util.ColorFormatter
format: "[%(asctime)s] [%(levelname)s@%(name)s] %(message)s" format: "[%(asctime)s] [%(levelname)s@%(name)s] %(message)s"
normal: normal:
format: "[%(asctime)s] [%(levelname)s@%(name)s] %(message)s" format: "[%(asctime)s] [%(levelname)s@%(name)s] %(message)s"

28
roles/matrix-bridge-mautrix-twitter/templates/systemd/matrix-mautrix-twitter.service.j2
View file

@ -1,11 +1,11 @@
#jinja2: lstrip_blocks: "True" #jinja2: lstrip_blocks: "True"
[Unit] [Unit]
Description=Matrix Mautrix Facebook bridge Description=Matrix Mautrix Twitter bridge
{% for service in matrix_mautrix_facebook_systemd_required_services_list %} {% for service in matrix_mautrix_twitter_systemd_required_services_list %}
Requires={{ service }} Requires={{ service }}
After={{ service }} After={{ service }}
{% endfor %} {% endfor %}
{% for service in matrix_mautrix_facebook_systemd_wanted_services_list %} {% for service in matrix_mautrix_twitter_systemd_wanted_services_list %}
Wants={{ service }} Wants={{ service }}
{% endfor %} {% endfor %}
DefaultDependencies=no DefaultDependencies=no
@ -13,30 +13,30 @@ DefaultDependencies=no
[Service] [Service]
Type=simple Type=simple
Environment="HOME={{ matrix_systemd_unit_home_path }}" Environment="HOME={{ matrix_systemd_unit_home_path }}"
ExecStartPre=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} kill matrix-mautrix-facebook 2>/dev/null' ExecStartPre=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} kill matrix-mautrix-twitter 2>/dev/null'
ExecStartPre=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} rm matrix-mautrix-facebook 2>/dev/null' ExecStartPre=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} rm matrix-mautrix-twitter 2>/dev/null'
# Intentional delay, so that the homeserver (we likely depend on) can manage to start. # Intentional delay, so that the homeserver (we likely depend on) can manage to start.
ExecStartPre={{ matrix_host_command_sleep }} 5 ExecStartPre={{ matrix_host_command_sleep }} 5
ExecStart={{ matrix_host_command_docker }} run --rm --name matrix-mautrix-facebook \ ExecStart={{ matrix_host_command_docker }} run --rm --name matrix-mautrix-twitter \
--log-driver=none \ --log-driver=none \
--user={{ matrix_user_uid }}:{{ matrix_user_gid }} \ --user={{ matrix_user_uid }}:{{ matrix_user_gid }} \
--cap-drop=ALL \ --cap-drop=ALL \
--network={{ matrix_docker_network }} \ --network={{ matrix_docker_network }} \
-v {{ matrix_mautrix_facebook_config_path }}:/config:z \ -v {{ matrix_mautrix_twitter_config_path }}:/config:z \
-v {{ matrix_mautrix_facebook_data_path }}:/data:z \ -v {{ matrix_mautrix_twitter_data_path }}:/data:z \
{% for arg in matrix_mautrix_facebook_container_extra_arguments %} {% for arg in matrix_mautrix_twitter_container_extra_arguments %}
{{ arg }} \ {{ arg }} \
{% endfor %} {% endfor %}
{{ matrix_mautrix_facebook_docker_image }} \ {{ matrix_mautrix_twitter_docker_image }} \
python3 -m mautrix_facebook -c /config/config.yaml --no-update python3 -m mautrix_twitter -c /config/config.yaml --no-update
ExecStop=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} kill matrix-mautrix-facebook 2>/dev/null' ExecStop=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} kill matrix-mautrix-twitter 2>/dev/null'
ExecStop=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} rm matrix-mautrix-facebook 2>/dev/null' ExecStop=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} rm matrix-mautrix-twitter 2>/dev/null'
Restart=always Restart=always
RestartSec=30 RestartSec=30
SyslogIdentifier=matrix-mautrix-facebook SyslogIdentifier=matrix-mautrix-twitter
[Install] [Install]
WantedBy=multi-user.target WantedBy=multi-user.target