Konfiguration
Internt använder Overleafs OIDC-modul biblioteket passport-openidconnect. Om du har problem med att konfigurera OpenID Connect är det värt att läsa README-filen förpassport-openidconnect för att få en känsla för vilken konfiguration den förväntar sig.
Miljövariabeln EXTERNAL_AUTH krävs för att aktivera OIDC-autentiseringsmodulen. Den här miljövariabeln anger vilka externa autentiseringsmetoder som aktiveras. Variabelns värde är en lista. Om listan innehåller oidc aktiveras OIDC-autentisering.
Till exempel: EXTERNAL_AUTH=ldap oidc
När OIDC-autentiseringsmetoden används omdirigeras användaren till identitetsleverantörens (IdP) autentiseringssida. Om IdP:n autentiserar användaren kontrolleras Overleafs användardatabas efter en post som innehåller ett thirdPartyIdentifiers-fält med följande struktur:
externalUserId måste matcha användar-ID:t i profilen som returneras av IdP-servern (se miljövariabeln OVERLEAF_OIDC_USER_ID_FIELD), och providerId måste matcha OIDC-leverantörens ID (se OVERLEAF_OIDC_PROVIDER_ID).
Om ingen matchande post hittas söks databasen igenom efter en användare vars primära e-postadress matchar e-postadressen i IdP:ns användarprofil:
- Om en sådan användare hittas uppdateras fältet
thirdPartyIdentifiers. - Om ingen matchande användare hittas och JIT-kontoskapande inte är inaktiverat skapas en ny användare med e-postadressen och
thirdPartyIdentifiersfrån IdP-profilen.
/user/settings.
Hitta värdena med discovery-dokumentet
Varje OpenID-leverantör (OP) publicerar ett discovery-dokument på<issuer>/.well-known/openid-configuration. Kopiera värdena därifrån i stället för att skriva in dem för hand; ett enda felaktigt tecken räcker för att inloggningen ska sluta fungera.
Hitta discovery-URL:en

Authentik: discovery-URL:en och utfärdaren för en leverantör (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
Läs av värdena

Authentik: endpointerna för en leverantör (testinstans)
Kopiera in dem i variables.env
Kontrollera att Overleaf kan nå OP:n
200.Miljövariabler
Värdena för följande fem obligatoriska variabler kan hittas via endpointen.well-known/openid-configuration hos din OpenID-leverantör (OP), se ovan.
OVERLEAF_OIDC_ISSUER(obligatorisk)OVERLEAF_OIDC_AUTHORIZATION_URL(obligatorisk)OVERLEAF_OIDC_TOKEN_URL(obligatorisk)OVERLEAF_OIDC_USER_INFO_URL(obligatorisk)OVERLEAF_OIDC_LOGOUT_URL(obligatorisk)
OVERLEAF_OIDC_CLIENT_ID(obligatorisk)OVERLEAF_OIDC_CLIENT_SECRET(obligatorisk)OVERLEAF_OIDC_SCOPE- Standard:
openid profile email
- Standard:
OVERLEAF_OIDC_PROVIDER_ID- Godtyckligt ID för OP:n, standardvärdet är
oidc.
- Godtyckligt ID för OP:n, standardvärdet är
OVERLEAF_OIDC_PROVIDER_NAME- Namnet på OP:n, som används i avsnittet
Linked Accountspå sidan/user/settings, standardvärdet ärOIDC Provider.
- Namnet på OP:n, som används i avsnittet
OVERLEAF_OIDC_IDENTITY_SERVICE_NAME- Visningsnamn för identitetstjänsten, som används på inloggningssidan (standard:
Log in with $OVERLEAF_OIDC_PROVIDER_NAME).
- Visningsnamn för identitetstjänsten, som används på inloggningssidan (standard:
OVERLEAF_OIDC_PROVIDER_DESCRIPTION- Beskrivning av OP:n, som används i avsnittet
Linked Accounts(standard:Log in with $OVERLEAF_OIDC_PROVIDER_NAME).
- Beskrivning av OP:n, som används i avsnittet
OVERLEAF_OIDC_PROVIDER_INFO_LINK- URL för
Learn morei OP-beskrivningen; som standard finns ingenLearn more-länk i beskrivningen.
- URL för
OVERLEAF_OIDC_PROVIDER_HIDE_NOT_LINKED- Visa inte OP:n på sidan
/user/settingsom användarens konto inte är länkat till OP:n, standardfalse.
- Visa inte OP:n på sidan
OVERLEAF_OIDC_USER_ID_FIELD- Värdet på det här attributet används av Overleaf som externt användar-ID, standardvärdet är
id. Andra rimliga värden äremailochusername(motsvarar OIDC-anspråketpreferred_username).
- Värdet på det här attributet används av Overleaf som externt användar-ID, standardvärdet är
OVERLEAF_OIDC_ALLOWED_EMAIL_DOMAINS- Begränsar Just-in-Time-kontoskapande (JIT) för användare som autentiseras via OIDC. Om variabeln sätts till en kommaseparerad lista med domännamn skapas ett nytt konto endast om domänen i användarens e-postadress matchar någon av de listade domänerna. Om domänen inte matchar måste en administratör manuellt skapa användarkontot med OIDC-användarens e-postadress, antingen med ett starkt slumpmässigt lösenord eller, helst, helt utan fältet
hashedPassword. Domännamn kan inledas med jokertecknet*.för att matcha underdomäner.- Exempel: För att tillåta JIT-kontoskapande för användare med e-postadresser som
name@example.comochname@math.example.com:
OVERLEAF_OIDC_ALLOWED_EMAIL_DOMAINS=example.com, *.example.com - Exempel: För att helt inaktivera JIT-kontoskapande:
OVERLEAF_OIDC_ALLOWED_EMAIL_DOMAINS=
- Exempel: För att tillåta JIT-kontoskapande för användare med e-postadresser som
- Begränsar Just-in-Time-kontoskapande (JIT) för användare som autentiseras via OIDC. Om variabeln sätts till en kommaseparerad lista med domännamn skapas ett nytt konto endast om domänen i användarens e-postadress matchar någon av de listade domänerna. Om domänen inte matchar måste en administratör manuellt skapa användarkontot med OIDC-användarens e-postadress, antingen med ett starkt slumpmässigt lösenord eller, helst, helt utan fältet
OVERLEAF_OIDC_UPDATE_USER_DETAILS_ON_LOGIN- Om den sätts till
trueuppdateras användarens fältfirst_nameochlast_namevid inloggning, och formuläret för användaruppgifter på sidan/user/settingsinaktiveras.
- Om den sätts till
OVERLEAF_OIDC_IS_ADMIN_FIELDochOVERLEAF_OIDC_IS_ADMIN_FIELD_VALUE- När båda miljövariablerna är satta uppdaterar inloggningsprocessen
user.isAdmin = trueom profilen som returneras av OP:n innehåller attributet som anges avOVERLEAF_OIDC_IS_ADMIN_FIELDoch dess värde antingen matcharOVERLEAF_OIDC_IS_ADMIN_FIELD_VALUEeller är en array som innehållerOVERLEAF_OIDC_IS_ADMIN_FIELD_VALUE(till exempel claimetgroups); annars sättsuser.isAdmintillfalse. OmOVERLEAF_OIDC_IS_ADMIN_FIELDäremailanvänds värdet av attributetemails[0].valuevid matchningskontrollen.
- När båda miljövariablerna är satta uppdaterar inloggningsprocessen
https://my-overleaf-instance.com/oidc/login/callback.
Exempel på variables.env-fil
Exempel på variables.env-fil
Steg för steg: goauthentik
Här går vi igenom en konfiguration som har testats mot goauthentik. Ersätthttps://overleaf.example.com med din OVERLEAF_SITE_URL och https://authentik.example.com med adressen till din Authentik.
Skapa leverantören
- Client Type:
Confidential. - Redirect URIs (under Protocol settings): lägg till
https://overleaf.example.com/oidc/login/callbackmed matchningslägetStrict. - Kopiera Client ID och Client Secret nu, till
OVERLEAF_OIDC_CLIENT_IDochOVERLEAF_OIDC_CLIENT_SECRET.

Authentik: Client ID och Client Secret för en ny leverantör
Skapa applikationen
overleaf, och välj leverantören. Slugen blir en del av utfärdaren: https://authentik.example.com/application/o/overleaf/.Kopiera URL:erna
Mappa administratörerna (valfritt)
groups, en array. Så här gör du medlemmarna i Authentik-gruppen Admins till administratörer i Overleaf:Testad variables.env för goauthentik
Testad variables.env för goauthentik
Frågor och svar
Admin-claimet är satt, men användarna blir inte administratörer
Admin-claimet är satt, men användarna blir inte administratörer
- Version. Före v6.3.0 läste Overleaf inte anpassade claims som
groups, så endastOVERLEAF_OIDC_IS_ADMIN_FIELD=emailfungerade. Uppgradera till v6.3.0 eller senare. - Claimet måste finnas i UserInfo-svaret. Overleaf läser claimet från
OVERLEAF_OIDC_USER_INFO_URL, inte från ID-token. Om din OP bara lägger till claimet i ID-token måste du även lägga till det i UserInfo, till exempel med Add to userinfo på en Keycloak-mapper. - Värdet måste matcha exakt, inklusive skiftläge, till exempel
Admins.
Kan jag använda GitHub som OIDC-leverantör?
Kan jag använda GitHub som OIDC-leverantör?
ID token not present in token response.Om du vill låta användare logga in med sitt GitHub-konto använder du en identitetsleverantör som goauthentik eller Keycloak, med GitHub som inloggningskälla, och ansluter Overleaf till den leverantören med OIDC.Kan jag använda GitLab som OIDC-leverantör?
Kan jag använda GitLab som OIDC-leverantör?
- Redirect URI:
https://my-overleaf-instance.com/oidc/login/callback - Scopes:
openid,profileochemail
https://gitlab.com/.well-known/openid-configuration, eller från samma sökväg på din GitLab, enligt beskrivningen i Hitta värdena med discovery-dokumentet. För gitlab.com är utfärdaren https://gitlab.com, utan avslutande snedstreck.
