diff --git a/docbook/auth-server-docs/reference/en/en-US/modules/user-federation.xml b/docbook/auth-server-docs/reference/en/en-US/modules/user-federation.xml index 93ce15e2a2..f44e6ab7fe 100755 --- a/docbook/auth-server-docs/reference/en/en-US/modules/user-federation.xml +++ b/docbook/auth-server-docs/reference/en/en-US/modules/user-federation.xml @@ -135,6 +135,23 @@ +
+ Connect to LDAP over SSL + + When you configure secured connection URL to LDAP (for example ldaps://myhost.com:636 ) the Keycloak will + use SSL for the communication with LDAP server. The important thing is to properly configure truststore on the Keycloak server side, + because SSL won't work if Keycloak can't trust the SSL connection with LDAP (Keycloak acts as the client here, when LDAP acts as server). + + + The global truststore for the Keycloak can be configured with Truststore SPI in the keycloak-server.json file and it's described in the details here. + If you don't configure truststore SPI, the truststore will fallback to the default mechanism provided by Java (either the file provided by system property javax.net.ssl.trustStore or finally + the cacerts file from JDK if even the system property is not set). + + There is configuration property Use Truststore SPI in the LDAP federation provider configuration, where you can choose + whether Truststore SPI is used. By default, the value is ldaps only, which is fine for most of deployments, because attempt + to use Truststore SPI is done just if connection to LDAP starts with ldaps . + +
Sync of LDAP users to Keycloak