gitea/gitea-docs
1
0
Fork 0
mirror of https://gitea.com/gitea/docs.git synced 2026-07-22 02:37:42 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update LDAP filters to include both username and email address (#24547)

Browse Source 
Since the login form label for user_name unconditionally displays
`Username or Email Address` for the `user_name` field, bring matching
LDAP filters to more prominence in the documentation/placeholders.

Signed-off-by: Gary Moon <gary@garymoon.net>
This commit is contained in:
Gary Moon
2023-05-05 14:18:53 -04:00
committed by GitHub
parent f7d5c42227
commit 7c026d22ca
2 changed files with 6 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
doc/administration/command-line.en-us.md
View File

@@ -225,7 +225,7 @@ Admin operations:
- `--synchronize-users`: Enable user synchronization. - `--synchronize-users`: Enable user synchronization.
- `--page-size value`: Search page size. - `--page-size value`: Search page size.
- Examples: - Examples:
- `gitea admin auth add-ldap --name ldap --security-protocol unencrypted --host mydomain.org --port 389 --user-search-base "ou=Users,dc=mydomain,dc=org" --user-filter "(&(objectClass=posixAccount)(uid=%s))" --email-attribute mail` - `gitea admin auth add-ldap --name ldap --security-protocol unencrypted --host mydomain.org --port 389 --user-search-base "ou=Users,dc=mydomain,dc=org" --user-filter "(&(objectClass=posixAccount)(|(uid=%[1]s)(mail=%[1]s)))" --email-attribute mail`
- `update-ldap`: Update existing LDAP (via Bind DN) authentication source - `update-ldap`: Update existing LDAP (via Bind DN) authentication source
- Options: - Options:
- `--id value`: ID of authentication source. Required. - `--id value`: ID of authentication source. Required.

10
doc/usage/authentication.en-us.md
View File

@@ -100,9 +100,9 @@ Adds the following fields:
- User Filter **(required)** - User Filter **(required)**
- An LDAP filter declaring how to find the user record that is attempting to - An LDAP filter declaring how to find the user record that is attempting to
authenticate. The `%s` matching parameter will be substituted with login authenticate. The `%[1]s` matching parameter will be substituted with login
name given on sign-in form. name given on sign-in form.
- Example: `(&(objectClass=posixAccount)(uid=%s))` - Example: `(&(objectClass=posixAccount)(|(uid=%[1]s)(mail=%[1]s)))`
- Example for Microsoft Active Directory (AD): `(&(objectCategory=Person)(memberOf=CN=user-group,OU=example,DC=example,DC=org)(sAMAccountName=%s)(!(UserAccountControl:1.2.840.113556.1.4.803:=2)))` - Example for Microsoft Active Directory (AD): `(&(objectCategory=Person)(memberOf=CN=user-group,OU=example,DC=example,DC=org)(sAMAccountName=%s)(!(UserAccountControl:1.2.840.113556.1.4.803:=2)))`
- To substitute more than once, `%[1]s` should be used instead, e.g. when - To substitute more than once, `%[1]s` should be used instead, e.g. when
matching supplied login name against multiple attributes such as user matching supplied login name against multiple attributes such as user
@@ -137,11 +137,11 @@ Adds the following fields:
- Example: `ou=Users,dc=mydomain,dc=com` - Example: `ou=Users,dc=mydomain,dc=com`
- User Filter **(required)** - User Filter **(required)**
- An LDAP filter declaring when a user should be allowed to log in. The `%s` - An LDAP filter declaring when a user should be allowed to log in. The `%[1]s`
matching parameter will be substituted with login name given on sign-in matching parameter will be substituted with login name given on sign-in
form. form.
- Example: `(&(objectClass=posixAccount)(cn=%s))` - Example: `(&(objectClass=posixAccount)(|(cn=%[1]s)(mail=%[1]s)))`
- Example: `(&(objectClass=posixAccount)(uid=%s))` - Example: `(&(objectClass=posixAccount)(|(uid=%[1]s)(mail=%[1]s)))`
### Verify group membership in LDAP ### Verify group membership in LDAP