Skip to content
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.

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

Add documentation for password escaping $ character. #113

Merged
merged 2 commits into from
Aug 30, 2024
Merged
Changes from all commits
Commits
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
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,10 @@ sudo dnf install python2-devel python3-devel openldap-devel
| cache_user_groups_ttl | no | `120` | How long (in seconds) |
| base_ou_group | no | `None` | Base OU to search for group entries. If not specified will default to None and take value of base_ou |

### Escaping Password Characters

Passwords that contain the `$` character are required to be escaped in the form `$$` because the underlying modules that process the backend configuration uses [Python Template Strings](https://docs.python.org/3/library/string.html#template-strings).

## Implementation Overview

The LDAP backend attempts a few different LDAP operations to authenticate users against an LDAP server:
Expand Down
Loading