Skip to content

Commit 02ef53c

Browse files
authored
[DOCS] Standardize docs for url setting (#41117)
1 parent b4e7008 commit 02ef53c

File tree

1 file changed

+19
-9
lines changed

1 file changed

+19
-9
lines changed

docs/reference/settings/security-settings.asciidoc

Lines changed: 19 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -278,10 +278,13 @@ Defaults to `true`.
278278
The `type` setting must be set to `ldap`. In addition to the
279279
<<ref-realm-settings>>, you can specify the following settings:
280280

281-
`url`:: Specifies one or more LDAP URLs in the format
282-
`ldap[s]://<server>:<port>`. Multiple URLs can be defined using a comma
283-
separated value or array syntax: `[ "ldaps://server1:636", "ldaps://server2:636" ]`.
284-
`ldaps` and `ldap` URL protocols cannot be mixed in the same realm. Required.
281+
`url`::
282+
One or more LDAP URLs in the `ldap[s]://<server>:<port>` format. Required.
283+
+
284+
To provide multiple URLs, use a YAML array (`["ldap://server1:636", "ldap://server2:636"]`)
285+
or comma-separated string (`"ldap://server1:636, ldap://server2:636"`).
286+
+
287+
While both are supported, you can't mix the `ldap` and `ldaps` protocols.
285288

286289
`load_balance.type`::
287290
The behavior to use when there are multiple LDAP URLs defined. For supported
@@ -547,11 +550,18 @@ The `type` setting must be set to `active_directory`. In addition to the
547550
the following settings:
548551

549552
`url`::
550-
An LDAP URL of the form `ldap[s]://<server>:<port>`. {es} attempts to
551-
authenticate against this URL. If the URL is not specified, it is derived from
552-
the `domain_name` setting and assumes an unencrypted connection to port 389.
553-
Defaults to `ldap://<domain_name>:389`. This setting is required when connecting
554-
using SSL/TLS or when using a custom port.
553+
One or more LDAP URLs in the `ldap[s]://<server>:<port>` format. Defaults to
554+
`ldap://<domain_name>:389`. This setting is required when connecting using
555+
SSL/TLS or when using a custom port.
556+
+
557+
To provide multiple URLs, use a YAML array (`["ldap://server1:636", "ldap://server2:636"]`)
558+
or comma-separated string (`"ldap://server1:636, ldap://server2:636"`).
559+
+
560+
While both are supported, you can't mix the `ldap` and `ldaps` protocols.
561+
+
562+
If no URL is provided, {es} uses a default of `ldap://<domain_name>:389`. This
563+
default uses the `domain_name` setting value and assumes an unencrypted
564+
connection to port 389.
555565

556566
`load_balance.type`::
557567
The behavior to use when there are multiple LDAP URLs defined. For supported

0 commit comments

Comments
 (0)