feat: add mapping options

This commit is contained in:
Yuichi Ohneda
2024-06-20 00:17:05 -07:00
parent 3e1366d00b
commit d00f530337

View File

@@ -11,7 +11,7 @@ You can use a Lightweight Directory Access Protocol (LDAP) authentication server
**Basic Configuration**
- `LDAP_URL`, `LDAP_BIND_DN`, and `LDAP_USER_SEARCH_BASE` are required.
- `LDAP_URL` and `LDAP_USER_SEARCH_BASE` are required.
- `LDAP_SEARCH_FILTER` is optional; if not specified, the `mail` attribute is used by default. If specified, use the literal `{{username}}` to use the given username for the search.
<OptionTable
@@ -29,6 +29,39 @@ You can use a Lightweight Directory Access Protocol (LDAP) authentication server
]}
/>
**Field Mappings**
You can specify a mapping between the attributes of Librechat users and those of LDAP users. Use these settings if the default mappings do not work properly.
<OptionTable
options={[
[
'LDAP_ID',
'string',
'Specify a unique user ID. By default, uid or sAMAccountName, mail is used.',
'LDAP_ID=uid',
],
[
'LDAP_USERNAME',
'string',
'By default, it uses givenName or mail.',
'LDAP_USERNAME=givenName',
],
[
'LDAP_FULL_NAME',
'string',
'By default, it uses a combination of givenName and surname.',
'LDAP_FULL_NAME=givenName,surname',
],
[
'LDAP_STRICT_LOGIN',
'boolean',
"Verify that the user's authentication provider at login is LDAP. The default setting is true.",
'LDAP_STRICT_LOGIN=true',
],
]}
/>
**Active Directory over SSL**
To connect via SSL (ldaps://), such as a company using Windows AD, specify the path to the internal CA certificate.