diff --git a/docs/features/authentication.md b/docs/features/authentication.md index 5d3d196..d82e8e7 100644 --- a/docs/features/authentication.md +++ b/docs/features/authentication.md @@ -27,22 +27,27 @@ It allows to use Identity stores configured in mxisd to authenticate users on yo Performed on [synapse with REST auth module](https://github.com/kamax-io/matrix-synapse-rest-auth/blob/master/README.md) ## Getting started +Authentication is possible by linking synapse and mxisd together using the REST auth module +(also known as password provider). + ### Synapse -You will need: +- Install the [REST auth module](https://github.com/kamax-io/matrix-synapse-rest-auth). +- Edit your synapse configuration: + - As described by the auth module documentation + - Set `endpoint` to `http://mxisdAddress:8090` - Replace `mxisdAddress` by an IP/host name that provides a direct + connection to mxisd. + This **MUST NOT** be a public address, and SHOULD NOT go through a reverse proxy. +- Restart synapse + +### mxisd - Configure and enable at least one [Identity store](../backends/) -- Install the [REST auth module](https://github.com/kamax-io/matrix-synapse-rest-auth) +- Restart mxisd -Once installed, edit your synapse configuration as described for the auth module: -- Set `endpoint` to `http://mxisdAddress:8090` - Replace `mxisdAddress` to an internal IP/Hostname. -- If you want to avoid [known issues](https://github.com/matrix-org/matrix-doc/issues/586) with lower/upper case -usernames, set `enforceLowercase` in the REST config to `true`. +### Validate +Login on the Homeserver using credentials present in your backend. -**IMPORTANT**: if this is a new installation, it is highly recommended to enforce lowercase, as it is not possible to -workaround the bug at a later date and will cause issues with invites, searches, authentication. - -Restart synapse and login on the Homeserver using credentials present in your backend. - -## Profile auto-fill +## Next steps +### Profile auto-fill Auto-filling user profile depends on two conditions: - The REST auth module is configured for it, which is the case by default - Your Identity store is configured to provide profile data. See your Identity store [documentation](../backends/) on