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

Update README.md #68

Merged
merged 1 commit into from
Dec 4, 2023
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
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,10 @@ Before proceeding with installation, the following system dependencies must be m

- A running Celery instance
- A running Redis database
- A running PostgreSQL database (if not using SQLite)

The following system dependencies are optional:

- A running PostgreSQL database (if using PostgreSQL instead of SQLite)
- LDAP development binaries (if using LDAP authentication)

In keeping with best practice, it is recommended to install packages into a dedicated virtual environment:
Expand Down Expand Up @@ -104,8 +107,8 @@ To enable LDAP, set the `AUTH_LDAP_SERVER_URI` value to the desired LDAP endpoin

| Setting Name | Default Value | Description |
|---------------------------|--------------------------|---------------------------------------------------------------|
| `AUTH_LDAP_START_TLS` | `True` | Whether to use TLS when connecting to the LDAP server. |
| `AUTH_LDAP_SERVER_URI` | | The URI of the LDAP server. |
| `AUTH_LDAP_START_TLS` | `True` | Whether to use TLS when connecting to the LDAP server. |
| `AUTH_LDAP_BIND_DN` | | Optionally bind LDAP queries to the given DN. |
| `AUTH_LDAP_BIND_PASSWORD` | | The password to use when binding to the LDAP server. |
| `AUTH_LDAP_USER_SEARCH` | `(uid=%(user)s)` | The search query for finding a user in the LDAP server. |
Expand Down
Loading