Skip to content

Update ldap.md #89

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update ldap.md #89

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions src/administration-guide/ldap.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@ All SSO provider options:

| Parameter | Environment Variables | Description |
| --------------------- | --------------------- | ----------------------------------------------------------------------------------------------------------- |
| `ldap_binddn` | `SEMAPHORE_LDAP_BIND_DN` | |
| `ldap_bindpassword` | `SEMAPHORE_LDAP_BIND_PASSWORD` | Password of LDAP user which used as Bind DN. |
| `ldap_binddn` | `SEMAPHORE_LDAP_BIND_DN` | Name of LDAP user object to bind. |
| `ldap_bindpassword` | `SEMAPHORE_LDAP_BIND_PASSWORD` | Password of LDAP user defined in Bind DN. |
| `ldap_server` | `SEMAPHORE_LDAP_SERVER` | LDAP server host including port. For example: `localhost:389`. |
| `ldap_searchdn` | `SEMAPHORE_LDAP_SEARCH_DN` | Scope where users will be searched. For example: `ou=users,dc=example,dc=org`. |
| `ldap_searchfilter` | `SEMAPHORE_LDAP_SEARCH_FILTER` | Users search expression. Default: `(&(objectClass=inetOrgPerson)(uid=%s))`, where `%s` will replaced to entered login. |
Expand Down Expand Up @@ -54,6 +54,7 @@ Semaphore is attempting to claim the email field first. If it is empty, the expr
### Troubleshooting

Use `ldapwhoami` tool to check if your **BindDN** works:
This tool is provided by the **openldap-clients** package.

```bash
ldapwhoami\
Expand All @@ -66,7 +67,7 @@ ldapwhoami\
It will ask interactively for the password, and should return code **0** and echo out the **DN** as specified.

<div class="warning">
Please read <a href="./administration-guide/troubleshooting#unable-to-read-ldap-response-packet-unexpected-eof">Troubleshooting</a> section if you have issues with LDAP.
Please read <a href="../faq/troubleshooting.html#6-unable-to-read-ldap-response-packet-unexpected-eof">Troubleshooting</a> section if you have issues with LDAP.
</div>


Expand Down Expand Up @@ -144,4 +145,4 @@ docker run -d -p 3000:3000 --name semaphore \
-e 'SEMAPHORE_LDAP_MAPPING_MAIL={{ .cn }}@ldap.semaphore.run' \
-e 'SEMAPHORE_LDAP_MAPPING_UID=|' \
-e 'SEMAPHORE_LDAP_MAPPING_CN=cn' \
semaphoreui/semaphore:latest -->
semaphoreui/semaphore:latest -->