meilisearch / meilisearch/docs-scraper

Keycloak support is broken due to unmaintained library

Open
#475 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

help wanted
Dominant language
Python
Stars
346
Forks
52
PR merge metrics
No merged PRs in 30d

Description

Description

TL;DR: This scraper used to support Keycloak SSO, but now it no longer does (unless you're running a very old Keycloak).

Support for Keycloak SSO was added in #73 by @spahrson and it is a great addition that we're super appreciative of 🎉

Unfortunately, the python-keycloak-client library used to add this functionality is de-facto unmaintained, which is a problem because Keycloak introduced a breaking change in Keycloak v17 which changed the URLs under which to find the OIDC endpoints.

Given that:

  • The Keycloak 17.0 release dates from February 2022
  • Releases prior to 17 (aka pre-Quarkus releases) have been deprecated ever since
  • The latest Keycloak release is 25.0.1

The end result is that this no longer supports keycloak SSO in a meaningful way.

I was hoping we could get that support back.
Ways to do so include:

Other
I'm not familiar with the Python ecosystem, so I cannot really offer to do it myself. But I am happy to help testing, or update docs, or help get this done somehow.

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.

Research direction

The issue names no repository files or tests; start by locating the existing Keycloak SSO integration and its python-keycloak-client dependency. Reproduce the failure against a current Keycloak release, then evaluate the maintained python-keycloak migration and the documented auth/URL-prefix workaround. Done means Keycloak SSO works with supported releases and the relevant setup is covered.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
authentication
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.