[Feature Request] Support for Keycloak / OIDC authentication

Open
#1,601 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
35/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Active
Tech stack
laravel, php

Research direction

No files, tests, or entry points are named. Start by confirming maintainer acceptance and reviewing the existing local authentication flow alongside Laravel's Socialite options for Keycloak/OIDC. Done would mean optional environment-variable configuration, successful authorization and basic user provisioning, with default local authentication unchanged.

Written by the indexing model from the issue text.

Description

Describe the issue
Heimdall currently relies solely on local database authentication (username/password or PIN). In environments that use centralized identity management (such as Keycloak or other OIDC providers), this requires managing separate local credentials rather than leveraging existing Single Sign-On (SSO) infrastructure.

Describe the solution you'd like
Add optional support for OpenID Connect / OAuth2 authentication, focused on Keycloak.

At a high level, the approach would:

  • Be completely optional, activated only via environment variables without affecting default local authentication.
  • Use standard Laravel OAuth tools (such as Socialite) to handle the authorization flow.
  • Handle basic user provisioning upon successful authentication.

Additional context
Before diving deeper into the implementation details, I wanted to check with the maintainers if this is a feature you would consider accepting upstream.

If this aligns with the project's direction, I would be happy to work on the implementation and submit a Pull Request for review.

Dominant language
PHP
Stars
9.3k
Forks
629
Avg merge
1d 12h
Merged PRs (30d)
9

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from linuxserver/Heimdall

All issues in linuxserver/Heimdall

Similar issues

More PHP issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.