From a60feb7fc95f029e1fa9cfbd0f43a93893f8d7d4 Mon Sep 17 00:00:00 2001 From: Christoph Date: Sat, 19 Apr 2025 12:21:45 +0200 Subject: [PATCH] fix incorrect documentation for ldap providers (#408) --- config.yml.sample | 1 - docs/documentation/configuration/examples.md | 1 - docs/documentation/configuration/overview.md | 4 ++++ 3 files changed, 4 insertions(+), 2 deletions(-) diff --git a/config.yml.sample b/config.yml.sample index 043d361..2fe4c69 100644 --- a/config.yml.sample +++ b/config.yml.sample @@ -17,7 +17,6 @@ auth: ldap: - id: ldap1 provider_name: company ldap - display_name: Login with
LDAP url: ldap://ldap.yourcompany.local:389 bind_user: ldap_wireguard@yourcompany.local bind_pass: super_Secret_PASSWORD diff --git a/docs/documentation/configuration/examples.md b/docs/documentation/configuration/examples.md index bf008ad..5912e34 100644 --- a/docs/documentation/configuration/examples.md +++ b/docs/documentation/configuration/examples.md @@ -43,7 +43,6 @@ auth: # a sample LDAP provider with user sync enabled - id: ldap provider_name: Active Directory - display_name: Login with
AD url: ldap://srv-ad1.company.local:389 bind_user: ldap_wireguard@company.local bind_pass: super-s3cr3t-ldap diff --git a/docs/documentation/configuration/overview.md b/docs/documentation/configuration/overview.md index fb14054..6413861 100644 --- a/docs/documentation/configuration/overview.md +++ b/docs/documentation/configuration/overview.md @@ -456,6 +456,10 @@ Below are the properties for each OAuth provider entry inside `auth.oauth`: The `ldap` array contains a list of LDAP authentication providers. Below are the properties for each LDAP provider entry inside `auth.ldap`: +#### `provider_name` +- **Default:** *(empty)* +- **Description:** A **unique** name for this provider. Must not conflict with other providers. + #### `url` - **Default:** *(empty)* - **Description:** The LDAP server URL (e.g., `ldap://srv-ad01.company.local:389`).