Skip to content

Commit 6aaf381

Browse files
committed
Fix Keycloak docs
1 parent ac2d08e commit 6aaf381

File tree

2 files changed

+11
-1
lines changed

2 files changed

+11
-1
lines changed

.github/workflows/translate.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,6 @@ jobs:
129129
fi
130130
131131
- name: Deploy docs
132-
if: steps.check-changes.outputs.has_changes == 'true' || github.event_name == 'workflow_dispatch'
133132
uses: mhausenblas/mkdocs-deploy-gh-pages@master
134133
env:
135134
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

docs/en/install_setup/oidc.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -203,3 +203,14 @@ OIDC_GITHUB_CLIENT_SECRET="your-github-client-secret"
203203
### Authelia
204204

205205
A community-made OIDC setup guide for Gramps Web is available on the [official Authelia documentation website](https://www.authelia.com/integration/openid-connect/clients/gramps/).
206+
207+
### Keycloak
208+
209+
Most of the configuration for Keycloak can be left at its defaults (*Client → Create client → Client authentication ON*).
210+
There are a few exceptions:
211+
212+
1. **OpenID scope** – The `openid` scope isn't included by default in all Keycloak versions. To avoid issues, add it manually: *Client → [Gramps client] → Client scopes → Add scope → Name: `openid` → Set as default.*
213+
2. **Roles** – Roles can be assigned either at the client level or globally per realm.
214+
215+
* If you're using client roles, set the `OIDC_ROLE_CLAIM` config option to: `resource_access.[gramps-client-name].roles`
216+
* To make roles visible to Gramps, navigate to *Client Scopes* (the top‑level section, not under the specific client), then: *Roles → Mappers → client roles → Add to userinfo → ON.*

0 commit comments

Comments
 (0)