matrix-docker-ansible-deploy/docs/configuring-playbook-shared-secret-auth.md

# Setting up the Shared Secret Auth password provider module (optional, advanced)

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.

If you decide that you'd like to let this playbook install it for you, you need some configuration like this:

```yaml
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
```


## 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
```
Annotate certain features as optional/advanced We've had some people get confused into installing Matrix Corporal and having pain with that. With this documentation change, we try to make it clearer that it's an advanced feature not to be touched unless you know what you're doing. On a similar note, we also make sure other things are properly labeled as "(optional)" and/or "(advanced)". 2018-11-26 13:23:42 +08:00			`# Setting up the Shared Secret Auth password provider module (optional, advanced)`
Add support for matrix-synapse-shared-secret-auth 2018-08-20 22:11:55 +08: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.`

			`If you decide that you'd like to let this playbook install it for you, you need some configuration like this:`

			```yaml
			`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`
Add support for disabling Synapse's local database for user auth This is a new feature of Synapse v1.1.0. Discussed in #145 (Github Pull Request). 2019-07-04 22:11:51 +08: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`
			```