Konfiguration
Internt bruger Overleafs OIDC-modul biblioteket passport-openidconnect. Hvis du har problemer med at konfigurere OpenID Connect, er det en god idé at læse README-filen forpassport-openidconnect for at få en fornemmelse af den konfiguration, det forventer.
Miljøvariablen EXTERNAL_AUTH er påkrævet for at aktivere OIDC-godkendelsesmodulet. Denne miljøvariabel angiver, hvilke eksterne godkendelsesmetoder der er aktiveret. Variablens værdi er en liste. Hvis listen indeholder oidc, aktiveres OIDC-godkendelse.
For eksempel: EXTERNAL_AUTH=ldap oidc
Når OIDC-godkendelsesmetoden bruges, omdirigeres brugeren til identitetsudbyderens (IdP) godkendelsesside. Hvis IdP’en godkender brugeren, kontrolleres Overleafs brugerdatabase for en post, der indeholder et thirdPartyIdentifiers-felt med følgende struktur:
externalUserId skal matche bruger-ID’et i den profil, som IdP-serveren returnerer (se miljøvariablen OVERLEAF_OIDC_USER_ID_FIELD), og providerId skal matche ID’et for OIDC-udbyderen (se OVERLEAF_OIDC_PROVIDER_ID).
Hvis der ikke findes en matchende post, søges der i databasen efter en bruger, hvis primære e-mailadresse matcher e-mailadressen i IdP-brugerprofilen:
- Hvis en sådan bruger findes, opdateres feltet
thirdPartyIdentifiers. - Hvis der ikke findes en matchende bruger, og JIT-kontooprettelse ikke er deaktiveret, oprettes en ny bruger med e-mailadressen og
thirdPartyIdentifiersfra IdP-profilen.
/user/settings.
Find værdierne med discovery-dokumentet
Alle OpenID-udbydere (OP) offentliggør et discovery-dokument på<issuer>/.well-known/openid-configuration. Kopiér værdierne derfra i stedet for at skrive dem i hånden; ét forkert tegn er nok til at ødelægge login.
Find discovery-URL'en

Authentik: discovery-URL'en og issueren for en udbyder (testinstans)
- Keycloak:
https://keycloak.example.com/realms/<realm>/.well-known/openid-configuration - Authentik:
https://authentik.example.com/application/o/<application-slug>/.well-known/openid-configuration
Aflæs værdierne

Authentik: endpoints for en udbyder (testinstans)
Kopiér dem ind i variables.env
Kontrollér, at Overleaf kan nå OP'en
200.Miljøvariabler
Værdierne for de følgende fem påkrævede variabler kan findes via endpointet.well-known/openid-configuration hos din OpenID-udbyder (OP), se ovenfor.
OVERLEAF_OIDC_ISSUER(påkrævet)OVERLEAF_OIDC_AUTHORIZATION_URL(påkrævet)OVERLEAF_OIDC_TOKEN_URL(påkrævet)OVERLEAF_OIDC_USER_INFO_URL(påkrævet)OVERLEAF_OIDC_LOGOUT_URL(påkrævet)
OVERLEAF_OIDC_CLIENT_ID(påkrævet)OVERLEAF_OIDC_CLIENT_SECRET(påkrævet)OVERLEAF_OIDC_SCOPE- Standard:
openid profile email
- Standard:
OVERLEAF_OIDC_PROVIDER_ID- Vilkårligt ID for OP’en, standard er
oidc.
- Vilkårligt ID for OP’en, standard er
OVERLEAF_OIDC_PROVIDER_NAME- Navnet på OP’en, der bruges i afsnittet
Linked Accountspå siden/user/settings, standard erOIDC Provider.
- Navnet på OP’en, der bruges i afsnittet
OVERLEAF_OIDC_IDENTITY_SERVICE_NAME- Visningsnavn for identitetstjenesten, der bruges på login-siden (standard:
Log in with $OVERLEAF_OIDC_PROVIDER_NAME).
- Visningsnavn for identitetstjenesten, der bruges på login-siden (standard:
OVERLEAF_OIDC_PROVIDER_DESCRIPTION- Beskrivelse af OP’en, der bruges i afsnittet
Linked Accounts(standard:Log in with $OVERLEAF_OIDC_PROVIDER_NAME).
- Beskrivelse af OP’en, der bruges i afsnittet
OVERLEAF_OIDC_PROVIDER_INFO_LINKLearn more-URL i beskrivelsen af OP’en, standard: intetLearn more-link i beskrivelsen.
OVERLEAF_OIDC_PROVIDER_HIDE_NOT_LINKED- Vis ikke OP’en på siden
/user/settings, hvis brugerens konto ikke er linket til OP’en, standardfalse.
- Vis ikke OP’en på siden
OVERLEAF_OIDC_USER_ID_FIELD- Værdien af denne attribut bruges af Overleaf som eksternt bruger-ID, standard er
id. Andre mulige fornuftige værdier eremailogusername(svarende til OIDC-claimetpreferred_username).
- Værdien af denne attribut bruges af Overleaf som eksternt bruger-ID, standard er
OVERLEAF_OIDC_ALLOWED_EMAIL_DOMAINS- Begrænser Just-in-Time-kontooprettelse (JIT) for brugere, der godkendes via OIDC. Hvis variablen sættes til en kommasepareret liste over domænenavne, oprettes en ny konto kun, hvis domænet i brugerens e-mailadresse matcher et af de angivne domæner. Hvis domænet ikke matcher, skal en administrator manuelt oprette brugerkontoen med OIDC-brugerens e-mailadresse, enten med en stærk tilfældig adgangskode eller helst helt uden feltet
hashedPassword. Domænenavne kan indeholde et foranstillet*.-jokertegn for at matche underdomæner.- Eksempel: For at tillade JIT-kontooprettelse for brugere med e-mailadresser som
name@example.comogname@math.example.com:
OVERLEAF_OIDC_ALLOWED_EMAIL_DOMAINS=example.com, *.example.com - Eksempel: For helt at deaktivere JIT-kontooprettelse:
OVERLEAF_OIDC_ALLOWED_EMAIL_DOMAINS=
- Eksempel: For at tillade JIT-kontooprettelse for brugere med e-mailadresser som
- Begrænser Just-in-Time-kontooprettelse (JIT) for brugere, der godkendes via OIDC. Hvis variablen sættes til en kommasepareret liste over domænenavne, oprettes en ny konto kun, hvis domænet i brugerens e-mailadresse matcher et af de angivne domæner. Hvis domænet ikke matcher, skal en administrator manuelt oprette brugerkontoen med OIDC-brugerens e-mailadresse, enten med en stærk tilfældig adgangskode eller helst helt uden feltet
OVERLEAF_OIDC_UPDATE_USER_DETAILS_ON_LOGIN- Hvis den er sat til
true, opdateres brugerens felterfirst_nameoglast_nameved login, og formularen med brugeroplysninger på siden/user/settingsdeaktiveres.
- Hvis den er sat til
OVERLEAF_OIDC_IS_ADMIN_FIELDogOVERLEAF_OIDC_IS_ADMIN_FIELD_VALUE- Når begge miljøvariabler er sat, opdaterer login-processen
user.isAdmin = true, hvis den profil, OP’en returnerer, indeholder den attribut, der er angivet medOVERLEAF_OIDC_IS_ADMIN_FIELD, og dens værdi enten matcherOVERLEAF_OIDC_IS_ADMIN_FIELD_VALUEeller er et array, der indeholderOVERLEAF_OIDC_IS_ADMIN_FIELD_VALUE(for eksempel claimetgroups); ellers sættesuser.isAdmintilfalse. HvisOVERLEAF_OIDC_IS_ADMIN_FIELDeremail, bruges værdien af attributtenemails[0].valuetil matchkontrollen.
- Når begge miljøvariabler er sat, opdaterer login-processen
https://my-overleaf-instance.com/oidc/login/callback.
Eksempel på variables.env-fil
Eksempel på variables.env-fil
Trin for trin: goauthentik
Denne vejledning gennemgår en opsætning, der er testet mod goauthentik. Erstathttps://overleaf.example.com med din OVERLEAF_SITE_URL og https://authentik.example.com med adressen på din Authentik.
Opret udbyderen
- Client Type:
Confidential. - Redirect URIs (under Protocol settings): tilføj
https://overleaf.example.com/oidc/login/callbackmed matchtilstandenStrict. - Kopiér Client ID og Client Secret nu, ind i
OVERLEAF_OIDC_CLIENT_IDogOVERLEAF_OIDC_CLIENT_SECRET.

Authentik: Client ID og Client Secret for en ny udbyder
Opret applikationen
overleaf, og vælg udbyderen. Sluggen bliver en del af issueren: https://authentik.example.com/application/o/overleaf/.Kopiér URL'erne
Tilknyt administratorerne (valgfrit)
groups, et array. Sådan gør du medlemmerne af Authentik-gruppen Admins til administratorer i Overleaf:Testet variables.env til goauthentik
Testet variables.env til goauthentik
Spørgsmål og svar
Admin-claimet er sat, men brugerne bliver ikke administratorer
Admin-claimet er sat, men brugerne bliver ikke administratorer
- Version. Før v6.3.0 læste Overleaf ikke brugerdefinerede claims som
groups, så kunOVERLEAF_OIDC_IS_ADMIN_FIELD=emailvirkede. Opgrader til v6.3.0 eller nyere. - Claimet skal være i UserInfo-svaret. Overleaf læser claimet fra
OVERLEAF_OIDC_USER_INFO_URL, ikke fra ID-tokenet. Hvis din OP kun tilføjer claimet til ID-tokenet, skal du også tilføje det til UserInfo, for eksempel med Add to userinfo på en Keycloak-mapper. - Værdien skal matche præcist, inklusive store og små bogstaver, for eksempel
Admins.
Kan jeg bruge GitHub som OIDC-udbyder?
Kan jeg bruge GitHub som OIDC-udbyder?
ID token not present in token response.For at lade brugere logge ind med deres GitHub-konto skal du bruge en identitetsudbyder som goauthentik eller Keycloak med GitHub som loginkilde og forbinde Overleaf til den udbyder med OIDC.Kan jeg bruge GitLab som OIDC-udbyder?
Kan jeg bruge GitLab som OIDC-udbyder?
- Redirect URI:
https://my-overleaf-instance.com/oidc/login/callback - Scopes:
openid,profileogemail
https://gitlab.com/.well-known/openid-configuration eller fra samme sti på din GitLab, som beskrevet i Find værdierne med discovery-dokumentet. For gitlab.com er issueren https://gitlab.com uden afsluttende skråstreg.
