Skip to content

Commit d94312d

Browse files
Fix Authelia configuration documentation (#40)
Cleaned up example configuration to remove obsolete/incorrect configuration values
1 parent e036d65 commit d94312d

1 file changed

Lines changed: 8 additions & 59 deletions

File tree

docs/authentication/authelia.md

Lines changed: 8 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -19,40 +19,11 @@ Here's a complete working configuration. Replace `booklore.example.com` with you
1919
```yaml
2020
identity_providers:
2121
oidc:
22-
lifespans:
23-
access_token: 1h
24-
authorize_code: 1m
25-
id_token: 1h
26-
refresh_token: 90m
27-
28-
enforce_pkce: public_clients_only
29-
30-
cors:
31-
endpoints:
32-
- authorization
33-
- pushed-authorization-request
34-
- token
35-
- revocation
36-
- introspection
37-
- userinfo
38-
allowed_origins_from_client_redirect_uris: true
39-
40-
claims_policies:
41-
booklore:
42-
id_token:
43-
- email
44-
- email_verified
45-
- preferred_username
46-
- name
47-
- groups
48-
4922
clients:
50-
- client_id: booklore
51-
client_name: Booklore
52-
public: true
23+
- client_name: Booklore
24+
client_id: # generate this: https://www.authelia.com/integration/openid-connect/frequently-asked-questions/#how-do-i-generate-a-client-identifier-or-client-secret
25+
client_secret: # generate this: https://www.authelia.com/integration/openid-connect/frequently-asked-questions/#how-do-i-generate-a-client-identifier-or-client-secret
5326
authorization_policy: two_factor
54-
claims_policy: booklore
55-
consent_mode: implicit
5627
require_pkce: true
5728
pkce_challenge_method: S256
5829
scopes:
@@ -63,21 +34,10 @@ identity_providers:
6334
- offline_access
6435
redirect_uris:
6536
- https://booklore.example.com/oauth2-callback
66-
response_types:
67-
- code
68-
grant_types:
69-
- authorization_code
70-
- refresh_token
7137
```
7238
7339
### What Each Section Does
7440
75-
**`claims_policy`** controls which user attributes are included in the ID token. Booklore needs `preferred_username`, `email`, `name`, and `groups` (if you plan to use group mapping).
76-
77-
**`public: true`** means Booklore uses PKCE instead of a client secret. This is the recommended approach for browser-based apps.
78-
79-
**`consent_mode: implicit`** means users won't be prompted to approve access each time they log in.
80-
8141
**`authorization_policy: two_factor`** requires 2FA. Change to `one_factor` if you don't use MFA, or adjust based on your security needs.
8242

8343
**`scopes`** must include `groups` if you want to use Booklore's [Group Mapping](oidc-settings.md#group-mapping) feature. Without it, Authelia won't include group memberships in the token.
@@ -86,10 +46,6 @@ identity_providers:
8646
If you plan to use group mapping, you must include `groups` in both the `scopes` list and the `claims_policy`. Without it, Authelia won't send group information to Booklore, and group mapping will silently do nothing.
8747
:::
8848

89-
:::tip[Generating a random Client ID]
90-
While `booklore` works fine as a client ID, you can use a random string for extra security. It must be 100 characters or fewer and contain only [RFC3986 unreserved characters](https://datatracker.ietf.org/doc/html/rfc3986#section-2.3) (letters, digits, `-`, `.`, `_`, `~`).
91-
:::
92-
9349
Restart Authelia after saving the config.
9450

9551
---
@@ -105,8 +61,8 @@ Fill in the provider configuration:
10561
| Field | Value |
10662
|-------|-------|
10763
| **Provider Name** | `Authelia` (shown on the login button) |
108-
| **Client ID** | `booklore` (or whatever you set as `client_id` in the Authelia config) |
109-
| **Client Secret** | Leave empty (public client) |
64+
| **Client ID** | Whatever you set as `client_id` in the Authelia config |
65+
| **Client Secret** | The client secret you generated and used in the Authelia config |
11066
| **Issuer URI** | Your Authelia URL **without** a trailing slash (e.g., `https://auth.example.com`) |
11167

11268
:::danger[No trailing slash on the Issuer URI]
@@ -126,15 +82,9 @@ Click **Test Connection** to verify Booklore can reach Authelia. All checks shou
12682

12783
Click **Save**, then toggle **OIDC Login** to **ON** in the Login Methods section.
12884

129-
### Optional: Configure Back-Channel Logout
130-
131-
To keep sessions in sync (so logging out of Authelia also ends the Booklore session):
85+
### Back-Channel Logout
13286

133-
1. Copy the **Back-Channel Logout URI** from Booklore's Provider Configuration Reference panel
134-
2. If your Authelia version supports back-channel logout, add it to the client config:
135-
```yaml
136-
backchannel_logout_uri: https://booklore.example.com/api/v1/auth/oidc/backchannel-logout
137-
```
87+
Authelia [does not currently support](https://www.authelia.com/roadmap/active/openid-connect-1.0-provider/#openid-connect-back-channel-logout-10) back-channel logout, so it cannot be used.
13888

13989
---
14090

@@ -172,7 +122,6 @@ Now that basic OIDC is working, you can configure additional features in Booklor
172122
### Login Redirects But Fails
173123

174124
- The **redirect URI** in Authelia's config must match exactly: `https://booklore.example.com/oauth2-callback`
175-
- Make sure `response_types` includes `code` and `grant_types` includes `authorization_code`.
176125
- Check Authelia's logs for a detailed error message.
177126

178127
### "User Not Provisioned" Error
@@ -181,7 +130,7 @@ Auto-provisioning is off by default. Either enable it in [OIDC Settings](oidc-se
181130

182131
### Group Mapping Not Working
183132

184-
- Make sure `groups` is in both the `scopes` list and the `claims_policy` in Authelia's config.
133+
- Make sure `groups` is in the `scopes` list in Authelia's config.
185134
- Verify the **Groups Claim** in Booklore is set to `groups`.
186135
- Check that **Group Sync Mode** in Booklore is not set to Disabled.
187136
- The group names must match exactly (case-sensitive) between Authelia and Booklore's group mappings.

0 commit comments

Comments
 (0)