Separate Facebook bridge configuration and data
Using a separate directory allows easier backups (only need to back up the Ansible playbook configuration and the bridge's `./data` directory). The playbook takes care of migrating an existing database file from the base directory into the `./data` directory. In the future, we can also mount the configuration read-only, to ensure the bridge won't touch it. For now, mautrix-facebook is keen on rebuilding the `config.yaml` file on startup though, so this will have to wait.
This commit is contained in:
		| @@ -6,6 +6,8 @@ matrix_mautrix_facebook_enabled: true | |||||||
| matrix_mautrix_facebook_docker_image: "tulir/mautrix-facebook:latest" | matrix_mautrix_facebook_docker_image: "tulir/mautrix-facebook:latest" | ||||||
|  |  | ||||||
| matrix_mautrix_facebook_base_path: "{{ matrix_base_data_path }}/mautrix-facebook" | 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_homeserver_address: 'http://matrix-synapse:8008' | matrix_mautrix_facebook_homeserver_address: 'http://matrix-synapse:8008' | ||||||
| matrix_mautrix_facebook_homeserver_domain: '{{ matrix_domain }}' | matrix_mautrix_facebook_homeserver_domain: '{{ matrix_domain }}' | ||||||
|   | |||||||
| @@ -13,18 +13,45 @@ | |||||||
|     name: "{{ matrix_mautrix_facebook_docker_image }}" |     name: "{{ matrix_mautrix_facebook_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 }}" | ||||||
|  |  | ||||||
| - name: Ensure Mautrix Facebook base directory exists | - name: Ensure Mautrix Facebook paths exist | ||||||
|   file: |   file: | ||||||
|     path: "{{ matrix_mautrix_facebook_base_path }}" |     path: "{{ item }}" | ||||||
|     state: directory |     state: directory | ||||||
|     mode: 0750 |     mode: 0750 | ||||||
|     owner: "{{ matrix_user_username }}" |     owner: "{{ matrix_user_username }}" | ||||||
|     group: "{{ matrix_user_username }}" |     group: "{{ matrix_user_username }}" | ||||||
|  |     recurse: true | ||||||
|  |   with_items: | ||||||
|  |     - "{{ matrix_mautrix_facebook_base_path }}" | ||||||
|  |     - "{{ matrix_mautrix_facebook_config_path }}" | ||||||
|  |     - "{{ matrix_mautrix_facebook_data_path }}" | ||||||
|  |  | ||||||
|  | - name: Check if an old database file already exists | ||||||
|  |   stat: | ||||||
|  |     path: "{{ matrix_mautrix_facebook_base_path }}/mautrix-facebook.db" | ||||||
|  |   register: matrix_mautrix_facebook_stat_database | ||||||
|  |  | ||||||
|  | - name: (Data relocation) Ensure matrix-mautrix-facebook.service is stopped | ||||||
|  |   service: | ||||||
|  |     name: matrix-mautrix-facebook | ||||||
|  |     state: stopped | ||||||
|  |     daemon_reload: yes | ||||||
|  |   register: stopping_result | ||||||
|  |   failed_when: false | ||||||
|  |   when: "matrix_mautrix_facebook_stat_database.stat.exists" | ||||||
|  |  | ||||||
|  | - name: (Data relocation) Move mautrix-facebook database file to ./data directory | ||||||
|  |   command: "mv {{ matrix_mautrix_facebook_base_path }}/mautrix-facebook.db {{ matrix_mautrix_facebook_data_path }}/mautrix-facebook.db" | ||||||
|  |   when: "matrix_mautrix_facebook_stat_database.stat.exists" | ||||||
|  |  | ||||||
|  | - name: (Data relocation) Move mautrix-facebook database file to ./data directory | ||||||
|  |   command: "mv {{ matrix_mautrix_facebook_base_path }}/mautrix-facebook.db {{ matrix_mautrix_facebook_data_path }}/mautrix-facebook.db" | ||||||
|  |   when: "matrix_mautrix_facebook_stat_database.stat.exists" | ||||||
|  |  | ||||||
| - name: Ensure mautrix-facebook config.yaml installed | - name: Ensure mautrix-facebook config.yaml installed | ||||||
|   copy: |   copy: | ||||||
|     content: "{{ matrix_mautrix_facebook_configuration|to_nice_yaml }}" |     content: "{{ matrix_mautrix_facebook_configuration|to_nice_yaml }}" | ||||||
|     dest: "{{ matrix_mautrix_facebook_base_path }}/config.yaml" |     dest: "{{ matrix_mautrix_facebook_config_path }}/config.yaml" | ||||||
|     mode: 0644 |     mode: 0644 | ||||||
|     owner: "{{ matrix_user_username }}" |     owner: "{{ matrix_user_username }}" | ||||||
|     group: "{{ matrix_user_username }}" |     group: "{{ matrix_user_username }}" | ||||||
| @@ -32,7 +59,7 @@ | |||||||
| - name: Ensure mautrix-facebook registration.yaml installed | - name: Ensure mautrix-facebook registration.yaml installed | ||||||
|   copy: |   copy: | ||||||
|     content: "{{ matrix_mautrix_facebook_registration|to_nice_yaml }}" |     content: "{{ matrix_mautrix_facebook_registration|to_nice_yaml }}" | ||||||
|     dest: "{{ matrix_mautrix_facebook_base_path }}/registration.yaml" |     dest: "{{ matrix_mautrix_facebook_config_path }}/registration.yaml" | ||||||
|     mode: 0644 |     mode: 0644 | ||||||
|     owner: "{{ matrix_user_username }}" |     owner: "{{ matrix_user_username }}" | ||||||
|     group: "{{ matrix_user_username }}" |     group: "{{ matrix_user_username }}" | ||||||
| @@ -54,7 +81,7 @@ | |||||||
|     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_base_path }}/registration.yaml,dst=/matrix-mautrix-facebook-registration.yaml,ro"] }} |       {{ ["--mount type=bind,src={{ matrix_mautrix_facebook_config_path }}/registration.yaml,dst=/matrix-mautrix-facebook-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([]) }} | ||||||
|   | |||||||
| @@ -17,9 +17,10 @@ ExecStartPre=/usr/bin/docker run --rm --name matrix-mautrix-facebook-db \ | |||||||
| 			--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 \ | ||||||
| 			-v {{ matrix_mautrix_facebook_base_path }}:/data:z \ | 			-v {{ matrix_mautrix_facebook_data_path }}:/data:z \ | ||||||
|  | 			-v {{ matrix_mautrix_facebook_config_path }}:/config:z \ | ||||||
| 			{{ matrix_mautrix_facebook_docker_image }} \ | 			{{ matrix_mautrix_facebook_docker_image }} \ | ||||||
| 			alembic -x config=/data/config.yaml upgrade head | 			alembic -x config=/config/config.yaml upgrade head | ||||||
|  |  | ||||||
| # 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=/bin/sleep 5 | ExecStartPre=/bin/sleep 5 | ||||||
| @@ -29,12 +30,13 @@ ExecStart=/usr/bin/docker run --rm --name matrix-mautrix-facebook \ | |||||||
| 			--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_base_path }}:/data:z \ | 			-v {{ matrix_mautrix_facebook_data_path }}:/data:z \ | ||||||
|  | 			-v {{ matrix_mautrix_facebook_config_path }}:/config:z \ | ||||||
| 			{% for arg in matrix_mautrix_facebook_container_extra_arguments %} | 			{% for arg in matrix_mautrix_facebook_container_extra_arguments %} | ||||||
| 			{{ arg }} \ | 			{{ arg }} \ | ||||||
| 			{% endfor %} | 			{% endfor %} | ||||||
| 			{{ matrix_mautrix_facebook_docker_image }} \ | 			{{ matrix_mautrix_facebook_docker_image }} \ | ||||||
| 			python3 -m mautrix_facebook -c /data/config.yaml | 			python3 -m mautrix_facebook -c /config/config.yaml | ||||||
|  |  | ||||||
| ExecStop=-/usr/bin/docker kill matrix-mautrix-facebook | ExecStop=-/usr/bin/docker kill matrix-mautrix-facebook | ||||||
| ExecStop=-/usr/bin/docker rm matrix-mautrix-facebook | ExecStop=-/usr/bin/docker rm matrix-mautrix-facebook | ||||||
|   | |||||||
		Reference in New Issue
	
	Block a user