Signed-off-by: Suguru Hirahara <did🔑z6MkvVZk1A3KBApWJXv2Ju4H14ErDfRGxh8zxdXSZ4vACDg5>
pull/4943/head
| @@ -16,14 +16,6 @@ See the project's [documentation](https://github.com/matrix-org/synapse-auto-acc | |||||
| **Note**: Synapse [v1.109.0](https://github.com/element-hq/synapse/releases/tag/v1.109.0), the same feature [has been merged](https://github.com/element-hq/synapse/pull/17147) into Synapse (see the [Native alternative](#native-alternative) section below). You'd better use the native feature, instead of the [synapse-auto-invite-accept](https://github.com/matrix-org/synapse-auto-accept-invite) 3rd party module. | **Note**: Synapse [v1.109.0](https://github.com/element-hq/synapse/releases/tag/v1.109.0), the same feature [has been merged](https://github.com/element-hq/synapse/pull/17147) into Synapse (see the [Native alternative](#native-alternative) section below). You'd better use the native feature, instead of the [synapse-auto-invite-accept](https://github.com/matrix-org/synapse-auto-accept-invite) 3rd party module. | ||||
| ## Adjusting the playbook configuration | |||||
| If you decide that you'd like to let this playbook install the [synapse-auto-invite-accept](https://github.com/matrix-org/synapse-auto-accept-invite module for you, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file: | |||||
| ```yaml | |||||
| matrix_synapse_ext_synapse_auto_accept_invite_enabled: true | |||||
| ``` | |||||
| ## Native alternative | ## Native alternative | ||||
| Since Synapse [v1.109.0](https://github.com/element-hq/synapse/releases/tag/v1.109.0), the functionality provided by the [synapse-auto-invite-accept](https://github.com/matrix-org/synapse-auto-accept-invite) 3rd party module [has been made](https://github.com/element-hq/synapse/pull/17147) part of Synapse. | Since Synapse [v1.109.0](https://github.com/element-hq/synapse/releases/tag/v1.109.0), the functionality provided by the [synapse-auto-invite-accept](https://github.com/matrix-org/synapse-auto-accept-invite) 3rd party module [has been made](https://github.com/element-hq/synapse/pull/17147) part of Synapse. | ||||
| @@ -50,7 +50,7 @@ matrix_synapse_container_image_customizations_s3_storage_provider_installation_e | |||||
| # Controls whether custom build steps will be added to the Dockerfile for installing auto-accept-invite module. | # Controls whether custom build steps will be added to the Dockerfile for installing auto-accept-invite module. | ||||
| # The version that will be installed is specified in `matrix_synapse_ext_synapse_auto_accept_invite_version`. | # The version that will be installed is specified in `matrix_synapse_ext_synapse_auto_accept_invite_version`. | ||||
| matrix_synapse_container_image_customizations_auto_accept_invite_installation_enabled: "{{ matrix_synapse_ext_synapse_auto_accept_invite_enabled }}" | |||||
| matrix_synapse_container_image_customizations_auto_accept_invite_installation_enabled: "" | |||||
| # Controls whether custom build steps will be added to the Dockerfile for customizing the email templates used by Synapse. | # Controls whether custom build steps will be added to the Dockerfile for customizing the email templates used by Synapse. | ||||
| # | # | ||||
| @@ -665,7 +665,6 @@ matrix_synapse_auto_join_mxid_localpart: '' | |||||
| # Controls whether room invites will be accepted on behalf of users. | # Controls whether room invites will be accepted on behalf of users. | ||||
| # See: https://element-hq.github.io/synapse/latest/usage/configuration/config_documentation.html#auto-accept-invites | # See: https://element-hq.github.io/synapse/latest/usage/configuration/config_documentation.html#auto-accept-invites | ||||
| # This should not be used together with the `synapse_auto_accept_invite` module (see `matrix_synapse_ext_synapse_auto_accept_invite_enabled`). | |||||
| # Also see: | # Also see: | ||||
| # - `matrix_synapse_auto_accept_invites_only_for_direct_messages` | # - `matrix_synapse_auto_accept_invites_only_for_direct_messages` | ||||
| # - `matrix_synapse_auto_accept_invites_only_from_local_users` | # - `matrix_synapse_auto_accept_invites_only_from_local_users` | ||||
| @@ -1558,7 +1557,6 @@ matrix_synapse_ext_synapse_s3_storage_provider_migrate_systemd_wanted_services_l | |||||
| # See: https://github.com/matrix-org/synapse-auto-accept-invite | # See: https://github.com/matrix-org/synapse-auto-accept-invite | ||||
| # Installing it requires building a customized Docker image for Synapse (see `matrix_synapse_container_image_customizations_enabled`). | # Installing it requires building a customized Docker image for Synapse (see `matrix_synapse_container_image_customizations_enabled`). | ||||
| # Enabling this will enable customizations and inject the appropriate Dockerfile clauses for installing synapse-auto-accept-invite. | # Enabling this will enable customizations and inject the appropriate Dockerfile clauses for installing synapse-auto-accept-invite. | ||||
| matrix_synapse_ext_synapse_auto_accept_invite_enabled: false | |||||
| matrix_synapse_ext_synapse_auto_accept_invite_version: 1.1.3 | matrix_synapse_ext_synapse_auto_accept_invite_version: 1.1.3 | ||||
| # Specifies whether only invites from local users will be auto accepted. | # Specifies whether only invites from local users will be auto accepted. | ||||
| matrix_synapse_ext_synapse_auto_accept_invite_accept_invites_only_from_local_users: false | matrix_synapse_ext_synapse_auto_accept_invite_accept_invites_only_from_local_users: false | ||||
| @@ -91,13 +91,3 @@ | |||||
| - when: matrix_synapse_ext_synapse_s3_storage_provider_enabled | bool | - when: matrix_synapse_ext_synapse_s3_storage_provider_enabled | bool | ||||
| ansible.builtin.include_tasks: "{{ role_path }}/tasks/ext/s3-storage-provider/setup_install.yml" | ansible.builtin.include_tasks: "{{ role_path }}/tasks/ext/s3-storage-provider/setup_install.yml" | ||||
| # synapse-auto-accept-invite | |||||
| - tags: | |||||
| - setup-all | |||||
| - setup-synapse | |||||
| - install-all | |||||
| - install-synapse | |||||
| block: | |||||
| - when: matrix_synapse_ext_synapse_auto_accept_invite_enabled | bool | |||||
| ansible.builtin.include_tasks: "{{ role_path }}/tasks/ext/synapse-auto-accept-invite/setup_install.yml" | |||||
| @@ -151,18 +151,6 @@ | |||||
| with_items: | with_items: | ||||
| - matrix_synapse_container_image_customizations_templates_git_repository_keyscan_hostname | - matrix_synapse_container_image_customizations_templates_git_repository_keyscan_hostname | ||||
| - name: Fail when auto-accept-invite enabled as a native feature and a module at the same time | |||||
| ansible.builtin.fail: | |||||
| msg: >- | |||||
| Your configuration enables the auto-accept invites feature both as a native Synapse feature (`matrix_synapse_auto_accept_invites_enabled`) and a 3rd party module (`matrix_synapse_ext_synapse_auto_accept_invite_enabled`). | |||||
| This is unnecessary, since they both do the same and the native feature is built on top of the 3rd party module anyway. | |||||
| Enabling both at the same time will lead to issues. | |||||
| We recommend leaving `matrix_synapse_auto_accept_invites_enabled` in your configuration and removing `matrix_synapse_ext_synapse_auto_accept_invite_enabled`. | |||||
| when: | |||||
| - matrix_synapse_auto_accept_invites_enabled | |||||
| - matrix_synapse_ext_synapse_auto_accept_invite_enabled | |||||
| - name: Fail if known Synapse password provider modules are enabled when auth is delegated to Matrix Authentication Service | - name: Fail if known Synapse password provider modules are enabled when auth is delegated to Matrix Authentication Service | ||||
| ansible.builtin.fail: | ansible.builtin.fail: | ||||
| msg: "When Synapse is delegating authentication to Matrix Authentication Service (`matrix_synapse_matrix_authentication_service_enabled: true`), it does not make sense to enable password provider modules, because it is not Synapse that is handling authentication. Please disable {{ item }} before enabling Matrix Authentication Service integration for Synapse. Synapse will refuse to start otherwise." | msg: "When Synapse is delegating authentication to Matrix Authentication Service (`matrix_synapse_matrix_authentication_service_enabled: true`), it does not make sense to enable password provider modules, because it is not Synapse that is handling authentication. Please disable {{ item }} before enabling Matrix Authentication Service integration for Synapse. Synapse will refuse to start otherwise." | ||||