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

# Setting up the REST authentication password provider module (optional, advanced)

The playbook can install and configure [matrix-synapse-rest-auth](https://github.com/kamax-io/matrix-synapse-rest-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_rest_auth_enabled: true
matrix_synapse_ext_password_provider_rest_auth_endpoint: "http://change.me.example.com:12345"
matrix_synapse_ext_password_provider_rest_auth_registration_enforce_lowercase: false
matrix_synapse_ext_password_provider_rest_auth_registration_profile_name_autofill: true
matrix_synapse_ext_password_provider_rest_auth_login_profile_name_autofill: 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 REST authentication password provider module (optional, advanced)`
Add matrix-synapse-rest-auth support 2018-08-17 14:02:12 +08:00
Add support for matrix-synapse-shared-secret-auth 2018-08-20 22:11:55 +08:00			`The playbook can install and configure [matrix-synapse-rest-auth](https://github.com/kamax-io/matrix-synapse-rest-auth) for you.`
Add matrix-synapse-rest-auth support 2018-08-17 14:02:12 +08:00
			`See that project's documentation to learn what it does and why it might be useful to you.`

Fix typo 2018-08-17 14:04:20 +08:00			`If you decide that you'd like to let this playbook install it for you, you need some configuration like this:`
Add matrix-synapse-rest-auth support 2018-08-17 14:02:12 +08:00
			```yaml
			`matrix_synapse_ext_password_provider_rest_auth_enabled: true`
			`matrix_synapse_ext_password_provider_rest_auth_endpoint: "http://change.me.example.com:12345"`
			`matrix_synapse_ext_password_provider_rest_auth_registration_enforce_lowercase: false`
			`matrix_synapse_ext_password_provider_rest_auth_registration_profile_name_autofill: true`
			`matrix_synapse_ext_password_provider_rest_auth_login_profile_name_autofill: false`
			```