| @@ -32,6 +32,35 @@ matrix_mautrix_facebook_systemd_wanted_services_list: [] | |||||
| matrix_mautrix_facebook_appservice_token: '' | matrix_mautrix_facebook_appservice_token: '' | ||||
| matrix_mautrix_facebook_homeserver_token: '' | matrix_mautrix_facebook_homeserver_token: '' | ||||
| # Database-related configuration fields. | |||||
| # | |||||
| # To use SQLite, stick to these defaults. | |||||
| # | |||||
| # To use Postgres: | |||||
| # - change the engine (`matrix_mautrix_facebook_database_engine: 'postgres'`) | |||||
| # - adjust your database credentials via the `matrix_mautrix_facebook_postgres_*` variables | |||||
| matrix_mautrix_facebook_database_engine: 'sqlite' | |||||
| 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" | |||||
| matrix_mautrix_facebook_postgres_username: 'matrix_mautrix_facebook' | |||||
| matrix_mautrix_facebook_postgres_password: 'some-password' | |||||
| matrix_mautrix_facebook_postgres_hostname: 'matrix-postgres' | |||||
| matrix_mautrix_facebook_postgres_port: 5432 | |||||
| matrix_mautrix_facebook_postgres_db_name: 'matrix_mautrix_facebook' | |||||
| matrix_mautrix_facebook_postgres_connection_string: 'postgresql://{{ matrix_mautrix_facebook_postgres_username }}:{{ matrix_mautrix_facebook_postgres_password }}@{{ matrix_mautrix_facebook_postgres_hostname }}:{{ matrix_mautrix_facebook_postgres_port }}/{{ matrix_mautrix_facebook_postgres_db_name }}' | |||||
| matrix_mautrix_facebook_appservice_database: "{{ | |||||
| { | |||||
| 'sqlite': matrix_mautrix_facebook_sqlite_database_path_in_container, | |||||
| 'postgres': matrix_mautrix_facebook_postgres_connection_string, | |||||
| }[matrix_mautrix_facebook_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_facebook_login_shared_secret: '' | ||||
| @@ -1,5 +1,26 @@ | |||||
| --- | --- | ||||
| - block: | |||||
| - name: Check if an SQLite database already exists | |||||
| stat: | |||||
| path: "{{ matrix_mautrix_facebook_sqlite_database_path_local }}" | |||||
| register: matrix_mautrix_facebook_sqlite_database_path_local_stat_result | |||||
| - name: Fail if an SQLite database already exists when using Postgres | |||||
| fail: | |||||
| msg: >- | |||||
| matrix_mautrix_facebook_database_engine has been set to `postgres` (which is our new default now). | |||||
| However, we've discovered an existing SQLite database in {{ matrix_mautrix_facebook_sqlite_database_path_local }}. | |||||
| It appears that you've been using this bridge with the SQLite engine until now. | |||||
| To continue using SQLite, opt into it explicitly: add `matrix_mautrix_facebook_database_engine: sqlite` to your vars.yml file and re-run this same command. | |||||
| Alternatively, to migrate your existing SQLite database to Postgres: | |||||
| 1. Stop all services (`ansible-playbook -i inventory/hosts setup.yml --tags=stop`) | |||||
| 2. Import the SQLite database into Postgres (`ansible-playbook -v -i inventory/hosts setup.yml --tags=import-generic-sqlite-db --extra-vars='sqlite_database_path={{ matrix_mautrix_facebook_sqlite_database_path_local }} postgres_connection_string_variable_name=matrix_mautrix_facebook_postgres_connection_string'`) | |||||
| 3. Re-run the playbook (`ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start`) | |||||
| when: "matrix_mautrix_facebook_sqlite_database_path_local_stat_result.stat.exists" | |||||
| when: "matrix_mautrix_facebook_database_engine == 'postgres'" | |||||
| # If the matrix-synapse role is not used, `matrix_synapse_role_executed` won't exist. | # If the matrix-synapse role is not used, `matrix_synapse_role_executed` won't exist. | ||||
| # We don't want to fail in such cases. | # We don't want to fail in such cases. | ||||
| - name: Fail if matrix-synapse role already executed | - name: Fail if matrix-synapse role already executed | ||||
| @@ -27,7 +27,7 @@ appservice: | |||||
| # Format examples: | # Format examples: | ||||
| # SQLite: sqlite:///filename.db | # SQLite: sqlite:///filename.db | ||||
| # Postgres: postgres://username:password@hostname/dbname | # Postgres: postgres://username:password@hostname/dbname | ||||
| database: sqlite://matrix_bridge_facebook:{{ matrix_additional_databases | selectattr('name', 'equalto', 'matrix_bridge_facebook') | map(attribute='pass') | first }}@{{ matrix_postgres_connection_hostname }}/matrix_bridge_facebook | |||||
| database: {{ matrix_mautrix_facebook_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: | ||||
| @@ -18,6 +18,7 @@ ExecStartPre={{ matrix_host_command_docker }} run --rm --name matrix-mautrix-fac | |||||
| --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 }} \ | |||||
| -v {{ matrix_mautrix_facebook_config_path }}:/config:z \ | -v {{ matrix_mautrix_facebook_config_path }}:/config:z \ | ||||
| -v {{ matrix_mautrix_facebook_data_path }}:/data:z \ | -v {{ matrix_mautrix_facebook_data_path }}:/data:z \ | ||||
| {{ matrix_mautrix_facebook_docker_image }} \ | {{ matrix_mautrix_facebook_docker_image }} \ | ||||