public_git
/
wg-portal
mirror of https://github.com/h44z/wg-portal.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

fix incorrect documentation for ldap providers (#408)

This commit is contained in:
Christoph 2025-04-19 12:21:45 +02:00
parent 37904f96fb
commit a60feb7fc9
3 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
config.yml.sample
View File

@ -17,7 +17,6 @@ auth:
ldap: ldap:
- id: ldap1 - id: ldap1
provider_name: company ldap provider_name: company ldap
display_name: Login with</br>LDAP
url: ldap://ldap.yourcompany.local:389 url: ldap://ldap.yourcompany.local:389
bind_user: ldap_wireguard@yourcompany.local bind_user: ldap_wireguard@yourcompany.local
bind_pass: super_Secret_PASSWORD bind_pass: super_Secret_PASSWORD

1
docs/documentation/configuration/examples.md
View File

@ -43,7 +43,6 @@ auth:
# a sample LDAP provider with user sync enabled # a sample LDAP provider with user sync enabled
- id: ldap - id: ldap
provider_name: Active Directory provider_name: Active Directory
display_name: Login with</br>AD
url: ldap://srv-ad1.company.local:389 url: ldap://srv-ad1.company.local:389
bind_user: ldap_wireguard@company.local bind_user: ldap_wireguard@company.local
bind_pass: super-s3cr3t-ldap bind_pass: super-s3cr3t-ldap

4
docs/documentation/configuration/overview.md
View File

@ -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. The `ldap` array contains a list of LDAP authentication providers.
Below are the properties for each LDAP provider entry inside `auth.ldap`: 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` #### `url`
- **Default:** *(empty)* - **Default:** *(empty)*
- **Description:** The LDAP server URL (e.g., `ldap://srv-ad01.company.local:389`). - **Description:** The LDAP server URL (e.g., `ldap://srv-ad01.company.local:389`).