Hop til hovedindhold

Single sign-on

Libre WebUI understøtter OAuth-login med GitHub og Hugging Face samt enhver OpenID Connect-udbyder via den generelle OIDC-integration. OAuth-brugere gemmes stadig som lokale Libre WebUI-brugere og får rollen user som standard. OIDC kan valgfrit tilknytte roller og grupper fra claims.

GitHub OAuth​

Opret en OAuth-app i GitHub Developer Settings.

Lokal callback-URL:

http://localhost:3001/api/auth/oauth/github/callback

Callback-URL i produktion:

https://your-domain.example/api/auth/oauth/github/callback

Backend-.env:

GITHUB_CLIENT_ID=...
GITHUB_CLIENT_SECRET=...
GITHUB_CALLBACK_URL=https://your-domain.example/api/auth/oauth/github/callback

GitHub OAuth anmoder om scopet user:email. Nye brugere oprettes med brugernavne med præfikset gh_.

Hugging Face OAuth​

Opret en OAuth-app i Hugging Face-indstillingerne.

Lokal callback-URL:

http://localhost:3001/api/auth/oauth/huggingface/callback

Callback-URL i produktion:

https://your-domain.example/api/auth/oauth/huggingface/callback

Backend-.env:

HUGGINGFACE_CLIENT_ID=...
HUGGINGFACE_CLIENT_SECRET=...
HUGGINGFACE_CALLBACK_URL=https://your-domain.example/api/auth/oauth/huggingface/callback

Nye brugere oprettes med brugernavne med præfikset hf_.

Generel OIDC​

Alle udbydere med et OpenID Connect-discoverydokument fungerer, eksempelvis Keycloak, Authentik, Authelia, Okta, Entra ID og Google Workspace. Flowet bruger PKCE (S256), CSRF-state og en nonce, der verificeres i det signaturkontrollerede ID-token; signeringsnøgler hentes fra udbyderens JWKS.

Registrér en fortrolig klient med denne callback-URL:

https://your-domain.example/api/auth/oauth/oidc/callback

Backend-.env:

OIDC_ISSUER_URL=https://id.example.com/realms/main
OIDC_CLIENT_ID=libre-webui
OIDC_CLIENT_SECRET=...
OIDC_DISPLAY_NAME=Example SSO

Valgfrie regler:

# Require a verified email in one of these domains
OIDC_ALLOWED_EMAIL_DOMAINS=example.com,example.org

# Grant/remove the admin role based on a group claim on every login
OIDC_GROUP_CLAIM=groups
OIDC_ADMIN_GROUPS=libre-admins

# Reconcile Libre group memberships with the group claim on every login
OIDC_SYNC_GROUPS=true

Identiteter knyttes til den stabile claim sub, så en navneændring hos udbyderen bevarer Libre-kontoen. Nye brugere får brugernavne med præfikset oidc_, når registrering er tilladt. En e-mailadresse, der allerede ejes af en lokal konto uden tilknytning, afvises i stedet for at blive slået sammen uden varsel. Med OIDC_SYNC_GROUPS=true styres OIDC-brugeres medlemskab af hver Libre-gruppe, hvis navn matcher en claim-værdi, af claims; opret først de tilsvarende grupper via Indstillinger → Brugeradministration → Grupper.

Fælles indstillinger​

Angiv den offentlige backend-URL:

BASE_URL=https://your-domain.example
CORS_ORIGIN=https://your-domain.example

Hvis callback-URL'er ikke angives eksplicit, danner Libre WebUI standardværdier ud fra BASE_URL.

Begrænsninger​

Libre WebUI tilbyder i øjeblikket ikke SAML eller SCIM-provisionering. Lister over tilladte domæner og tilknytning af roller og grupper findes kun for den generelle OIDC-udbyder; GitHub- og Hugging Face-brugere oprettes altid med rollen user og administreres fra administratorgrænsefladen.

Fejlfinding​

OAuth-knappen gør intet

Kontrollér, at udbyderens client ID og secret er angivet, og at backend er genstartet.

Udbyderen afviser callback

Callback-URL'en i udbyderens kontrolpanel skal svare præcis til den URL, som Libre WebUI bruger.

Brugeren får almindelige rettigheder

OAuth-brugere oprettes som standard som user. Forfrem brugere fra administratorgrænsefladen efter behov.

Relaterede dokumenter​