Skip to content

Commit 135da3b

Browse files
fix: final version of DORIS documentation
1 parent 794e6a0 commit 135da3b

File tree

3 files changed

+39
-5
lines changed
  • docs/admin-manual/auth/authentication
  • versioned_docs
    • version-3.x/admin-manual/auth/authentication
    • version-4.x/admin-manual/auth/authentication

3 files changed

+39
-5
lines changed

docs/admin-manual/auth/authentication/ldap.md

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,13 +49,28 @@ In LDAP, data is organized in a tree structure. Here's an example of a typical L
4949
```
5050
ldap_authentication_enabled = true
5151
ldap_host = ladp-host
52-
ldap_port = 389
52+
# change ldap_port value if ldap_use_ssl specified to true as different port (636) is used for LDAPS
53+
ldap_port = 389
5354
ldap_admin_name = uid=admin,o=emr
5455
ldap_user_basedn = ou=people,o=emr
5556
ldap_user_filter = (&(uid={login}))
5657
ldap_group_basedn = ou=group,o=emr
58+
# specify ldap_use_ssl to use to switch to secured LDAPS protocol, specify false or comment property to use default behavior with plain LDAP
59+
ldap_use_ssl = true
5760
```
5861
62+
> Important for LDAPS:
63+
>
64+
> When `ldap_use_ssl = true`, ensure your LDAP server certificate is trusted by the Doris FE JVM.
65+
>
66+
> If using a custom or self-signed Certificate Authority (CA), you must configure the Java trustStore.
67+
>
68+
> Add the following parameters to JAVA_OPTS in `fe/conf/fe.conf` (adjust the path to your cacerts file):
69+
> ```
70+
> # Example for JDK 17
71+
> JAVA_OPTS_FOR_JDK_17 = "-Djavax.net.ssl.trustStore=/path/to/your/cacerts -Djavax.net.ssl.trustStorePassword=changeit ..."
72+
> ```
73+
5974
3. After starting `fe`, log in to Doris with `root` or `admin` account and set the LDAP admin password:
6075
6176
```sql
@@ -250,7 +265,9 @@ You can refresh the cache with the `refresh ldap` statement. See [REFRESH-LDAP](
250265

251266
## Known Limitations
252267

253-
- Currently, Doris's LDAP functionality only supports cleartext password verification, meaning that when users log in, passwords are transmitted in plaintext between `client` and `fe`, and between `fe` and LDAP service.
268+
- Currently, Doris's LDAP functionality only supports cleartext password verification, meaning that when users log in, passwords are transmitted in plaintext between `client` and `fe`, but connection between `fe` and LDAP service can be secured optionally.
269+
- **For `ldap_use_ssl = false` (default behavior)**: Passwords are transmitted in plain text between the Doris FE and the LDAP server.
270+
- **To secure the connection**: Set `ldap_use_ssl = true` to encrypt traffic between Doris FE and the LDAP server. Note that SSL/TLS encryption between the **client and Doris FE** must be configured separately.
254271

255272
## FAQ
256273

versioned_docs/version-3.x/admin-manual/auth/authentication/ldap.md

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,13 +49,28 @@ In LDAP, data is organized in a tree structure. Here's an example of a typical L
4949
```
5050
ldap_authentication_enabled = true
5151
ldap_host = ladp-host
52-
ldap_port = 389
52+
# change ldap_port value if ldap_use_ssl specified to true as different port (636) is used for LDAPS
53+
ldap_port = 389
5354
ldap_admin_name = uid=admin,o=emr
5455
ldap_user_basedn = ou=people,o=emr
5556
ldap_user_filter = (&(uid={login}))
5657
ldap_group_basedn = ou=group,o=emr
58+
# specify ldap_use_ssl to true to use to secured LDAPS protocol, specify false or comment property to use default behavior with plain LDAP
59+
ldap_use_ssl = true
5760
```
5861
62+
> Important for LDAPS:
63+
>
64+
> When `ldap_use_ssl = true`, ensure your LDAP server certificate is trusted by the Doris FE JVM.
65+
>
66+
> If using a custom or self-signed Certificate Authority (CA), you must configure the Java trustStore.
67+
>
68+
> Add the following parameters to JAVA_OPTS in `fe/conf/fe.conf` (adjust the path to your cacerts file):
69+
> ```
70+
> # Example for JDK 17
71+
> JAVA_OPTS_FOR_JDK_17 = "-Djavax.net.ssl.trustStore=/path/to/your/cacerts -Djavax.net.ssl.trustStorePassword=changeit ..."
72+
> ```
73+
5974
3. After starting `fe`, log in to Doris with `root` or `admin` account and set the LDAP admin password:
6075
6176
```sql
@@ -250,7 +265,9 @@ You can refresh the cache with the `refresh ldap` statement. See [REFRESH-LDAP](
250265

251266
## Known Limitations
252267

253-
- Currently, Doris's LDAP functionality only supports cleartext password verification, meaning that when users log in, passwords are transmitted in plaintext between `client` and `fe`, and between `fe` and LDAP service.
268+
- Currently, Doris's LDAP functionality only supports cleartext password verification, meaning that when users log in, passwords are transmitted in plaintext between `client` and `fe`, but connection between `fe` and LDAP service can be secured optionally.
269+
- **For `ldap_use_ssl = false` (default behavior)**: Passwords are transmitted in plain text between the Doris FE and the LDAP server.
270+
- **To secure the connection**: Set `ldap_use_ssl = true` to encrypt traffic between Doris FE and the LDAP server. Note that SSL/TLS encryption between the **client and Doris FE** must be configured separately.
254271

255272
## FAQ
256273

versioned_docs/version-4.x/admin-manual/auth/authentication/ldap.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ In LDAP, data is organized in a tree structure. Here's an example of a typical L
5555
ldap_user_basedn = ou=people,o=emr
5656
ldap_user_filter = (&(uid={login}))
5757
ldap_group_basedn = ou=group,o=emr
58-
# specify ldap_use_ssl to true to switch to secured LDAPS protocol, specify false or comment property to use default behavior with plain LDAP
58+
# specify ldap_use_ssl to true to use to secured LDAPS protocol, specify false or comment property to use default behavior with plain LDAP
5959
ldap_use_ssl = true
6060
```
6161

0 commit comments

Comments
 (0)