Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,6 +123,26 @@ own file to not leak secrets into your configuration:

Please note that every trailing `\n` in the password file will be stripped automatically.

### Simple vs search mode, and attribute mapping

The module behaves quite differently depending on the configured `mode`:

- If `mode` is omitted (or set to `simple`), the module simply builds a DN from
`attributes.uid`, binds as the authenticating user, and stops there. No LDAP
search is performed, meaning `attributes.name` and `attributes.mail` are never
queried. When a Matrix user is created in this mode their display name is the
username they logged in with and their email address is left blank.
- To fetch attribute values from LDAP you **must** run in `mode: search`. You can
optionally supply `bind_dn`/`bind_password` so the module performs the search
with a service account. If they are omitted, an anonymous bind is attempted
and succeeds only if your LDAP server allows anonymous reads.

Also note that attribute data (`name`, `mail`) is fetched only when a Matrix
user is created. During each authentication, the module re-checks LDAP
credentials, but existing Matrix accounts keep the profile data stored in
Synapse. Therefore logging in again will not refresh the display name or email
address.

## Active Directory forest support

If the ``active_directory`` flag is set to `true`, an Active Directory forest will be
Expand Down
Loading