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.

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

Clarify documentation about registration and database authentication #944

Merged
merged 1 commit into from
Feb 24, 2025
Merged

Clarify documentation about registration and database authentication #944

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
8 changes: 5 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -162,21 +162,23 @@ The signing key should be at least 256 bits long (since Suricate v2.8.0) and sho

#### Database

You can log in to Suricate using the database after the sign-up step.
After signing up, you can log in to Suricate using database authentication.

You can choose this authentication mode using the following YAML property:
To enable this authentication mode, set the following YAML property:

```yml
application:
authentication:
provider: 'database'
```

When this mode is activated, a "**Register now**" button will appear on the login page, allowing users to create an account.

#### LDAP

You can log in to Suricate an LDAP.

You can choose this authentication mode using the following YAML property:
To enable this authentication mode, set the following YAML property:

```yml
---
Expand Down