Document multiple LDAP hosts (#635)

Documents https://github.com/go-gitea/gitea/pull/40201 for main, which lets the LDAP Host field list several servers as hosts or `ldap://`, `ldaps://` and `ldap+starttls://` URLs. WIP until that PR merges.

_Written by Claude (Opus 5.5)._

---------

Co-authored-by: Lunny Xiao <[email protected]>
Reviewed-on: https://gitea.com/gitea/docs/pulls/635
Reviewed-by: Lunny Xiao <[email protected]>
Co-authored-by: silverwind <[email protected]>
This commit is contained in:
silverwindandLunny Xiao authored and Lunny Xiao committed 2026-11-15 23:55:57 +00:00
1 parent cfd22c91bd
commit 01c8000cfd
6 files changed
+36 -33

No files matched your search

+4 -3
View File
@@ -18,12 +18,13 @@ Both the LDAP via BindDN and the simple auth LDAP share the following fields:
- Host **(required)**
- The address where the LDAP server can be reached.
- Example: `mydomain.com`
- Comma-separated LDAP servers. Each is a host using the Port and Security Protocol fields, or an `ldap://`, `ldaps://` or `ldap+starttls://` URL with an optional port. `ldap://` requires the Unencrypted Security Protocol, the other URLs require an encrypted one.
- The next server is tried when the previous one fails or takes over 250 ms to connect. Bind and search failures do not move on to it.
- Example: `ldap1.mydomain.com, ldaps://ldap2.mydomain.com:636`
- Port **(required)**
- The port to use when connecting to the server.
- The port to use when connecting to hosts given without a URL.
- Example: `389` for LDAP or `636` for LDAP SSL
- Enable TLS Encryption (optional)
+8 -8
View File
@@ -205,8 +205,8 @@ Admin operations:
- `--not-active`: Deactivate the authentication source.
- `--security-protocol value`: Security protocol name. Required.
- `--skip-tls-verify`: Disable TLS verification.
- `--host value`: The address where the LDAP server can be reached. Required.
- `--port value`: The port to use when connecting to the LDAP server. Required.
- `--host value`: Comma-separated LDAP hosts or `ldap://`, `ldaps://` or `ldap+starttls://` URLs, tried in order. Required.
- `--port value`: The port to use when connecting to hosts given without a URL. Required.
- `--user-search-base value`: The LDAP base at which user accounts will be searched for. Required.
- `--user-filter value`: An LDAP filter declaring how to find the user record that is attempting to authenticate. Required.
- `--admin-filter value`: An LDAP filter specifying if a user should be given administrator privileges.
@@ -231,8 +231,8 @@ Admin operations:
- `--not-active`: Deactivate the authentication source.
- `--security-protocol value`: Security protocol name.
- `--skip-tls-verify`: Disable TLS verification.
- `--host value`: The address where the LDAP server can be reached.
- `--port value`: The port to use when connecting to the LDAP server.
- `--host value`: Comma-separated LDAP hosts or `ldap://`, `ldaps://` or `ldap+starttls://` URLs, tried in order.
- `--port value`: The port to use when connecting to hosts given without a URL.
- `--user-search-base value`: The LDAP base at which user accounts will be searched for.
- `--user-filter value`: An LDAP filter declaring how to find the user record that is attempting to authenticate.
- `--admin-filter value`: An LDAP filter specifying if a user should be given administrator privileges.
@@ -257,8 +257,8 @@ Admin operations:
- `--not-active`: Deactivate the authentication source.
- `--security-protocol value`: Security protocol name. Required.
- `--skip-tls-verify`: Disable TLS verification.
- `--host value`: The address where the LDAP server can be reached. Required.
- `--port value`: The port to use when connecting to the LDAP server. Required.
- `--host value`: Comma-separated LDAP hosts or `ldap://`, `ldaps://` or `ldap+starttls://` URLs, tried in order. Required.
- `--port value`: The port to use when connecting to hosts given without a URL. Required.
- `--user-search-base value`: The LDAP base at which user accounts will be searched for.
- `--user-filter value`: An LDAP filter declaring how to find the user record that is attempting to authenticate. Required.
- `--admin-filter value`: An LDAP filter specifying if a user should be given administrator privileges.
@@ -279,8 +279,8 @@ Admin operations:
- `--not-active`: Deactivate the authentication source.
- `--security-protocol value`: Security protocol name.
- `--skip-tls-verify`: Disable TLS verification.
- `--host value`: The address where the LDAP server can be reached.
- `--port value`: The port to use when connecting to the LDAP server.
- `--host value`: Comma-separated LDAP hosts or `ldap://`, `ldaps://` or `ldap+starttls://` URLs, tried in order.
- `--port value`: The port to use when connecting to hosts given without a URL.
- `--user-search-base value`: The LDAP base at which user accounts will be searched for.
- `--user-filter value`: An LDAP filter declaring how to find the user record that is attempting to authenticate.
- `--admin-filter value`: An LDAP filter specifying if a user should be given administrator privileges.
@@ -18,12 +18,13 @@ aliases:
- 主机名 **(必选)**
- LDAP 服务的主机地址.
- 例如:`mydomain.com`
- 以逗号分隔的 LDAP 服务地址。每一项可以是使用端口号和安全协议设置的主机名,也可以是带可选端口的 `ldap://`、`ldaps://` 或 `ldap+starttls://` URL。`ldap://` 仅可用于未加密的安全协议,其他 URL 仅可用于加密的安全协议。
- 前一个服务连接失败或超过 250 毫秒仍未连上时,会尝试下一个服务。绑定或搜索失败不会切换到下一个服务。
- 例如:`ldap1.mydomain.com, ldaps://ldap2.mydomain.com:636`
- 端口号 **(必选)**
- LDAP 服务的端口号.
- 未以 URL 形式给出的主机所使用的端口号.
- 例如: LDAP `389`/ LDAPs `636`
- 安全协议 (可选)
@@ -189,8 +189,8 @@ aliases:
- `--not-active`:停用认证源。
- `--security-protocol value`:安全协议名称。必填。
- `--skip-tls-verify`:禁用 TLS 验证。
- `--host value`:LDAP 服务器的地址。必填。
- `--port value`:连接到 LDAP 服务器时使用的端口。必填。
- `--host value`:以逗号分隔的 LDAP 主机或 `ldap://`、`ldaps://`、`ldap+starttls://` URL,按顺序尝试。必填。
- `--port value`:连接未以 URL 形式给出的主机时使用的端口。必填。
- `--user-search-base value`:用户帐户将在其中搜索的 LDAP 基础路径。必填。
- `--user-filter value`:声明如何查找试图进行身份验证的用户记录的 LDAP 过滤器。必填。
- `--admin-filter value`:指定是否应授予用户管理员特权的 LDAP 过滤器。
@@ -215,8 +215,8 @@ aliases:
- `--not-active`:停用认证源。
- `--security-protocol value`:安全协议名称。
- `--skip-tls-verify`:禁用 TLS 验证。
- `--host value`:LDAP 服务器的地址。
- `--port value`:连接到 LDAP 服务器时使用的端口。
- `--host value`:以逗号分隔的 LDAP 主机或 `ldap://`、`ldaps://`、`ldap+starttls://` URL,按顺序尝试。
- `--port value`:连接未以 URL 形式给出的主机时使用的端口。
- `--user-search-base value`:用户帐户将在其中搜索的 LDAP 基础路径。
- `--user-filter value`:声明如何查找试图进行身份验证的用户记录的 LDAP 过滤器。
- `--admin-filter value`:指定是否应授予用户管理员特权的 LDAP 过滤器。
@@ -241,8 +241,8 @@ aliases:
- `--not-active`:停用认证源。
- `--security-protocol value`:安全协议名称。必填。
- `--skip-tls-verify`:禁用 TLS 验证。
- `--host value`:LDAP 服务器的地址。必填。
- `--port value`:连接到 LDAP 服务器时使用的端口。必填。
- `--host value`:以逗号分隔的 LDAP 主机或 `ldap://`、`ldaps://`、`ldap+starttls://` URL,按顺序尝试。必填。
- `--port value`:连接未以 URL 形式给出的主机时使用的端口。必填。
- `--user-search-base value`:用户帐户将在其中搜索的 LDAP 基础路径。
- `--user-filter value`:声明如何查找试图进行身份验证的用户记录的 LDAP 过滤器。必填。
- `--admin-filter value`:指定是否应授予用户管理员特权的 LDAP 过滤器。
@@ -263,8 +263,8 @@ aliases:
- `--not-active`:停用认证源。
- `--security-protocol value`:安全协议名称。
- `--skip-tls-verify`:禁用 TLS 验证。
- `--host value`:LDAP 服务器的地址。
- `--port value`:连接到 LDAP 服务器时使用的端口。
- `--host value`:以逗号分隔的 LDAP 主机或 `ldap://`、`ldaps://`、`ldap+starttls://` URL,按顺序尝试。
- `--port value`:连接未以 URL 形式给出的主机时使用的端口。
- `--user-search-base value`:用户帐户将在其中搜索的 LDAP 基础路径。
- `--user-filter value`:声明如何查找试图进行身份验证的用户记录的 LDAP 过滤器。
- `--admin-filter value`:指定是否应授予用户管理员特权的 LDAP 过滤器。
@@ -18,12 +18,13 @@ aliases:
- 主機名 **(必選)**
- LDAP 服務的主機地址.
- 例如:`mydomain.com`
- 以逗號分隔的 LDAP 服務地址。每一項可以是使用端口號和安全協議設定的主機名,也可以是帶可選端口的 `ldap://`、`ldaps://` 或 `ldap+starttls://` URL。`ldap://` 僅可用於未加密的安全協議,其他 URL 僅可用於加密的安全協議。
- 前一個服務連線失敗或超過 250 毫秒仍未連上時,會嘗試下一個服務。綁定或搜尋失敗不會切換到下一個服務。
- 例如:`ldap1.mydomain.com, ldaps://ldap2.mydomain.com:636`
- 端口號 **(必選)**
- LDAP 服務的端口號.
- 未以 URL 形式給出的主機所使用的端口號.
- 例如: LDAP `389`/ LDAPs `636`
- 安全協議 (可選)
@@ -189,8 +189,8 @@ aliases:
- `--not-active`:停用認證源。
- `--security-protocol value`:安全協議名稱。必填。
- `--skip-tls-verify`:禁用 TLS 驗證。
- `--host value`:LDAP 伺服器的地址。必填。
- `--port value`:連接到 LDAP 伺服器時使用的端口。必填。
- `--host value`:以逗號分隔的 LDAP 主機或 `ldap://`、`ldaps://`、`ldap+starttls://` URL,依序嘗試。必填。
- `--port value`:連接未以 URL 形式給出的主機時使用的端口。必填。
- `--user-search-base value`:使用者帳戶將在其中搜索的 LDAP 基礎路徑。必填。
- `--user-filter value`:聲明如何查找試圖進行身份驗證的使用者記錄的 LDAP 過濾器。必填。
- `--admin-filter value`:指定是否應授予使用者管理員特權的 LDAP 過濾器。
@@ -215,8 +215,8 @@ aliases:
- `--not-active`:停用認證源。
- `--security-protocol value`:安全協議名稱。
- `--skip-tls-verify`:禁用 TLS 驗證。
- `--host value`:LDAP 伺服器的地址。
- `--port value`:連接到 LDAP 伺服器時使用的端口。
- `--host value`:以逗號分隔的 LDAP 主機或 `ldap://`、`ldaps://`、`ldap+starttls://` URL,依序嘗試。
- `--port value`:連接未以 URL 形式給出的主機時使用的端口。
- `--user-search-base value`:使用者帳戶將在其中搜索的 LDAP 基礎路徑。
- `--user-filter value`:聲明如何查找試圖進行身份驗證的使用者記錄的 LDAP 過濾器。
- `--admin-filter value`:指定是否應授予使用者管理員特權的 LDAP 過濾器。
@@ -241,8 +241,8 @@ aliases:
- `--not-active`:停用認證源。
- `--security-protocol value`:安全協議名稱。必填。
- `--skip-tls-verify`:禁用 TLS 驗證。
- `--host value`:LDAP 伺服器的地址。必填。
- `--port value`:連接到 LDAP 伺服器時使用的端口。必填。
- `--host value`:以逗號分隔的 LDAP 主機或 `ldap://`、`ldaps://`、`ldap+starttls://` URL,依序嘗試。必填。
- `--port value`:連接未以 URL 形式給出的主機時使用的端口。必填。
- `--user-search-base value`:使用者帳戶將在其中搜索的 LDAP 基礎路徑。
- `--user-filter value`:聲明如何查找試圖進行身份驗證的使用者記錄的 LDAP 過濾器。必填。
- `--admin-filter value`:指定是否應授予使用者管理員特權的 LDAP 過濾器。
@@ -263,8 +263,8 @@ aliases:
- `--not-active`:停用認證源。
- `--security-protocol value`:安全協議名稱。
- `--skip-tls-verify`:禁用 TLS 驗證。
- `--host value`:LDAP 伺服器的地址。
- `--port value`:連接到 LDAP 伺服器時使用的端口。
- `--host value`:以逗號分隔的 LDAP 主機或 `ldap://`、`ldaps://`、`ldap+starttls://` URL,依序嘗試。
- `--port value`:連接未以 URL 形式給出的主機時使用的端口。
- `--user-search-base value`:使用者帳戶將在其中搜索的 LDAP 基礎路徑。
- `--user-filter value`:聲明如何查找試圖進行身份驗證的使用者記錄的 LDAP 過濾器。
- `--admin-filter value`:指定是否應授予使用者管理員特權的 LDAP 過濾器。