Updated LDAP AD Simple Auth (markdown)

Lauri Ojansivu 2021-07-24 19:11:55 +03:00
parent bc65d00d48
commit 276d58b846

@ -12,40 +12,34 @@ Uncomment settings lines this wasy at [docker-compose.yml](https://github.com/we
# #
# Set to true, if you want to connect with Active Directory by Simple Authentication. # Set to true, if you want to connect with Active Directory by Simple Authentication.
# When using AD Simple Auth, LDAP_BASEDN is not needed. # When using AD Simple Auth, LDAP_BASEDN is not needed.
- LDAP_AD_SIMPLE_AUTH=true
#
# Option to login to the LDAP server with the user's own username and password, instead of
# an administrator key. Default: false (use administrator key). When using AD Simple Auth, set to true.
# Set to true, if the login user is used for binding. Used with AD Simple Auth.
# When using AD Simple Auth, LDAP_BASEDN is not needed.
- LDAP_USER_AUTHENTICATION=true
#
# Which field is used to find the user for the user authentication. Default: uid.
- LDAP_USER_AUTHENTICATION_FIELD=uid
#
#
# === LDAP Default Domain: 2 different use cases, a/b ===
#
# a) The default domain of the ldap it is used to create email if the field is not map correctly with the LDAP_SYNC_USER_DATA_FIELDMAP
#
# b) In case AD SimpleAuth is configured, the default domain is appended to the given loginname for creating the correct username for the bind request to AD.
# #
# Example: # Example:
- LDAP_DEFAULT_DOMAIN=mydomain.com #- LDAP_AD_SIMPLE_AUTH=true
# #
# === LDAP Sync other settings === # === LDAP User Authentication ===
# #
#- LDAP_SYNC_USER_DATA=false # a) Option to login to the LDAP server with the user's own username and password, instead of
# an administrator key. Default: false (use administrator key).
# #
#- LDAP_SYNC_USER_DATA_FIELDMAP={"cn":"name", "mail":"email"} # b) When using AD Simple Auth, set to true, when login user is used for binding,
# and LDAP_BASEDN is not needed.
# #
#- LDAP_SYNC_GROUP_ROLES= # Example:
#- LDAP_USER_AUTHENTICATION=true
# #
# Enable/Disable syncing of admin status based on ldap groups: # Which field is used to find the user for the user authentication. Default: uid.
#- LDAP_SYNC_ADMIN_STATUS=true #- LDAP_USER_AUTHENTICATION_FIELD=uid
# #
# Comma separated list of admin group names to sync. # === LDAP Default Domain ===
#- LDAP_SYNC_ADMIN_GROUPS=group1,group2 #
# a) In case AD SimpleAuth is configured, the default domain is appended to the given
# loginname for creating the correct username for the bind request to AD.
#
# b) The default domain of the ldap it is used to create email if the field is not map
# correctly with the LDAP_SYNC_USER_DATA_FIELDMAP
#
# Example :
#- LDAP_DEFAULT_DOMAIN=mydomain.com
# #
#----------------------------------------------------------------- #-----------------------------------------------------------------
``` ```