2018-11-26 07:23:42 +02:00
# Setting up the Shared Secret Auth password provider module (optional, advanced)
2018-08-20 16:11:55 +02:00
The playbook can install and configure [matrix-synapse-shared-secret-auth ](https://github.com/devture/matrix-synapse-shared-secret-auth ) for you.
See that project's documentation to learn what it does and why it might be useful to you.
2024-10-12 13:48:24 +02:00
## Adjusting the playbook configuration
2024-10-17 15:17:56 +02:00
Add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:
2018-08-20 16:11:55 +02:00
```yaml
matrix_synapse_ext_password_provider_shared_secret_auth_enabled: true
2024-10-11 14:18:03 +02:00
# Generate a strong shared secret here. Consider generating it with `pwgen -s 64 1`
2018-08-20 16:11:55 +02:00
matrix_synapse_ext_password_provider_shared_secret_auth_shared_secret: YOUR_SHARED_SECRET_GOES_HERE
2019-07-04 16:11:51 +02:00
```
## 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:
```yaml
matrix_synapse_password_config_localdb_enabled: false
```
2024-10-12 20:03:46 +02:00
## Installing
After configuring the playbook, run the [installation ](installing.md ) command: `just install-all` or `just setup-all`