Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>pull/4125/head
| @@ -2,7 +2,7 @@ | |||||
| SPDX-FileCopyrightText: 2018 - 2022 Slavi Pantaleev | SPDX-FileCopyrightText: 2018 - 2022 Slavi Pantaleev | ||||
| SPDX-FileCopyrightText: 2019 - 2023 MDAD project contributors | SPDX-FileCopyrightText: 2019 - 2023 MDAD project contributors | ||||
| SPDX-FileCopyrightText: 2020 Marcel Partap | SPDX-FileCopyrightText: 2020 Marcel Partap | ||||
| SPDX-FileCopyrightText: 2024 Suguru Hirahara | |||||
| SPDX-FileCopyrightText: 2024 - 2025 Suguru Hirahara | |||||
| SPDX-License-Identifier: AGPL-3.0-or-later | SPDX-License-Identifier: AGPL-3.0-or-later | ||||
| --> | --> | ||||
| @@ -13,7 +13,9 @@ The playbook can install and configure the [matrix-synapse-ldap3](https://github | |||||
| See the project's [documentation](https://github.com/matrix-org/matrix-synapse-ldap3/blob/main/README.rst) to learn what it does and why it might be useful to you. | See the project's [documentation](https://github.com/matrix-org/matrix-synapse-ldap3/blob/main/README.rst) to learn what it does and why it might be useful to you. | ||||
| If you decide that you'd like to let this playbook install it for you, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file (adapt to your needs): | |||||
| ## Adjusting the playbook configuration | |||||
| Add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file (adapt to your needs): | |||||
| ```yaml | ```yaml | ||||
| matrix_synapse_ext_password_provider_ldap_enabled: true | matrix_synapse_ext_password_provider_ldap_enabled: true | ||||
| @@ -30,9 +32,9 @@ matrix_synapse_ext_password_provider_ldap_bind_password: "" | |||||
| matrix_synapse_ext_password_provider_ldap_filter: "" | matrix_synapse_ext_password_provider_ldap_filter: "" | ||||
| ``` | ``` | ||||
| ## Authenticating only using a password provider | |||||
| ### Authenticating only using a password provider | |||||
| If you wish for users to **authenticate only against configured password providers** (like this one), **without consulting Synapse's local database**, feel free to disable it: | |||||
| If you wish for users to **authenticate only against configured password providers** (like this one), **without consulting Synapse's local database**, you can disable it by adding the following configuration to your `vars.yml` file: | |||||
| ```yaml | ```yaml | ||||
| matrix_synapse_password_config_localdb_enabled: false | matrix_synapse_password_config_localdb_enabled: false | ||||
| @@ -1,7 +1,7 @@ | |||||
| <!-- | <!-- | ||||
| SPDX-FileCopyrightText: 2018 - 2019 Slavi Pantaleev | SPDX-FileCopyrightText: 2018 - 2019 Slavi Pantaleev | ||||
| SPDX-FileCopyrightText: 2019 - 2020 Marcel Partap | SPDX-FileCopyrightText: 2019 - 2020 Marcel Partap | ||||
| SPDX-FileCopyrightText: 2024 Suguru Hirahara | |||||
| SPDX-FileCopyrightText: 2024 - 2025 Suguru Hirahara | |||||
| SPDX-License-Identifier: AGPL-3.0-or-later | SPDX-License-Identifier: AGPL-3.0-or-later | ||||
| --> | --> | ||||
| @@ -24,9 +24,9 @@ matrix_synapse_ext_password_provider_rest_auth_registration_profile_name_autofil | |||||
| matrix_synapse_ext_password_provider_rest_auth_login_profile_name_autofill: false | matrix_synapse_ext_password_provider_rest_auth_login_profile_name_autofill: false | ||||
| ``` | ``` | ||||
| ## Authenticating only using a password provider | |||||
| ### Authenticating only using a password provider | |||||
| If you wish for users to **authenticate only against configured password providers** (like this one), **without consulting Synapse's local database**, feel free to disable it: | |||||
| If you wish for users to **authenticate only against configured password providers** (like this one), **without consulting Synapse's local database**, you can disable it by adding the following configuration to your `vars.yml` file: | |||||
| ```yaml | ```yaml | ||||
| matrix_synapse_password_config_localdb_enabled: false | matrix_synapse_password_config_localdb_enabled: false | ||||
| @@ -1,7 +1,7 @@ | |||||
| <!-- | <!-- | ||||
| SPDX-FileCopyrightText: 2018 - 2020 Slavi Pantaleev | SPDX-FileCopyrightText: 2018 - 2020 Slavi Pantaleev | ||||
| SPDX-FileCopyrightText: 2020 MDAD project contributors | SPDX-FileCopyrightText: 2020 MDAD project contributors | ||||
| SPDX-FileCopyrightText: 2024 Suguru Hirahara | |||||
| SPDX-FileCopyrightText: 2024 - 2025 Suguru Hirahara | |||||
| SPDX-License-Identifier: AGPL-3.0-or-later | SPDX-License-Identifier: AGPL-3.0-or-later | ||||
| --> | --> | ||||
| @@ -23,9 +23,9 @@ matrix_synapse_ext_password_provider_shared_secret_auth_enabled: true | |||||
| matrix_synapse_ext_password_provider_shared_secret_auth_shared_secret: YOUR_SHARED_SECRET_GOES_HERE | matrix_synapse_ext_password_provider_shared_secret_auth_shared_secret: YOUR_SHARED_SECRET_GOES_HERE | ||||
| ``` | ``` | ||||
| ## Authenticating only using a password provider | |||||
| ### Authenticating only using a password provider | |||||
| If you wish for users to **authenticate only against configured password providers** (like this one), **without consulting Synapse's local database**, feel free to disable it: | |||||
| If you wish for users to **authenticate only against configured password providers** (like this one), **without consulting Synapse's local database**, you can disable it by adding the following configuration to your `vars.yml` file: | |||||
| ```yaml | ```yaml | ||||
| matrix_synapse_password_config_localdb_enabled: false | matrix_synapse_password_config_localdb_enabled: false | ||||