Konfigurace
Modul OIDC v Overleaf interně používá knihovnu passport-openidconnect. Pokud máte potíže s konfigurací OpenID Connect, vyplatí se přečíst si README knihovnypassport-openidconnect, abyste získali představu o konfiguraci, kterou očekává.
K zapnutí ověřovacího modulu OIDC je vyžadována proměnná prostředí EXTERNAL_AUTH. Tato proměnná prostředí určuje, které externí metody ověřování jsou aktivovány. Hodnotou této proměnné je seznam. Pokud seznam obsahuje oidc, bude aktivováno ověřování OIDC.
Například: EXTERNAL_AUTH=ldap oidc
Při použití metody ověřování OIDC je uživatel přesměrován na ověřovací stránku poskytovatele identity (IdP). Pokud IdP uživatele úspěšně ověří, v databázi uživatelů Overleaf se vyhledá záznam obsahující pole thirdPartyIdentifiers s následující strukturou:
externalUserId se musí shodovat s ID uživatele v profilu vráceném serverem IdP (viz proměnná prostředí OVERLEAF_OIDC_USER_ID_FIELD) a providerId se musí shodovat s ID poskytovatele OIDC (viz OVERLEAF_OIDC_PROVIDER_ID).
Pokud není nalezen žádný odpovídající záznam, v databázi se vyhledá uživatel, jehož primární e-mailová adresa odpovídá e-mailu v uživatelském profilu IdP:
- Pokud je takový uživatel nalezen, pole
thirdPartyIdentifiersse aktualizuje. - Pokud není nalezen žádný odpovídající uživatel a vytváření účtů JIT není vypnuto, vytvoří se nový uživatel s e-mailovou adresou a
thirdPartyIdentifiersz profilu IdP.
/user/settings.
Zjištění hodnot pomocí discovery dokumentu
Každý poskytovatel OpenID (OP) zveřejňuje discovery dokument na adrese<issuer>/.well-known/openid-configuration. Hodnoty z něj zkopírujte, místo abyste je psali ručně; k selhání přihlášení stačí jediný chybný znak.
Najděte discovery URL

Authentik: discovery URL a issuer poskytovatele (testovací instance)
- Keycloak:
https://keycloak.example.com/realms/<realm>/.well-known/openid-configuration - Authentik:
https://authentik.example.com/application/o/<application-slug>/.well-known/openid-configuration
Přečtěte hodnoty

Authentik: endpointy poskytovatele (testovací instance)
Zkopírujte je do variables.env
Ověřte, že Overleaf dosáhne na OP
200.Proměnné prostředí
Hodnoty následujících pěti povinných proměnných zjistíte pomocí endpointu.well-known/openid-configuration vašeho poskytovatele OpenID (OP), viz výše.
OVERLEAF_OIDC_ISSUER(povinné)OVERLEAF_OIDC_AUTHORIZATION_URL(povinné)OVERLEAF_OIDC_TOKEN_URL(povinné)OVERLEAF_OIDC_USER_INFO_URL(povinné)OVERLEAF_OIDC_LOGOUT_URL(povinné)
OVERLEAF_OIDC_CLIENT_ID(povinné)OVERLEAF_OIDC_CLIENT_SECRET(povinné)OVERLEAF_OIDC_SCOPE- Výchozí:
openid profile email
- Výchozí:
OVERLEAF_OIDC_PROVIDER_ID- Libovolné ID poskytovatele OP, výchozí hodnota je
oidc.
- Libovolné ID poskytovatele OP, výchozí hodnota je
OVERLEAF_OIDC_PROVIDER_NAME- Název OP, používaný v části
Linked Accountsna stránce/user/settings, výchozí hodnota jeOIDC Provider.
- Název OP, používaný v části
OVERLEAF_OIDC_IDENTITY_SERVICE_NAME- Zobrazovaný název služby identity, používaný na přihlašovací stránce (výchozí:
Log in with $OVERLEAF_OIDC_PROVIDER_NAME).
- Zobrazovaný název služby identity, používaný na přihlašovací stránce (výchozí:
OVERLEAF_OIDC_PROVIDER_DESCRIPTION- Popis OP, používaný v části
Linked Accounts(výchozí:Log in with $OVERLEAF_OIDC_PROVIDER_NAME).
- Popis OP, používaný v části
OVERLEAF_OIDC_PROVIDER_INFO_LINK- URL odkazu
Learn morev popisu OP; ve výchozím nastavení popis neobsahuje odkazLearn more.
- URL odkazu
OVERLEAF_OIDC_PROVIDER_HIDE_NOT_LINKED- Nezobrazovat OP na stránce
/user/settings, pokud účet uživatele není s OP propojen; výchozí hodnotafalse.
- Nezobrazovat OP na stránce
OVERLEAF_OIDC_USER_ID_FIELD- Hodnotu tohoto atributu použije Overleaf jako externí ID uživatele; výchozí hodnota je
id. Další možné rozumné hodnoty jsouemailausername(odpovídá OIDC claimupreferred_username).
- Hodnotu tohoto atributu použije Overleaf jako externí ID uživatele; výchozí hodnota je
OVERLEAF_OIDC_ALLOWED_EMAIL_DOMAINS- Omezuje vytváření účtů Just-in-Time (JIT) pro uživatele ověřované přes OIDC. Pokud je nastavena na seznam doménových jmen oddělených čárkami, nový účet se vytvoří pouze tehdy, když doména e-mailové adresy uživatele odpovídá některé z uvedených domén. Pokud doména neodpovídá, musí administrátor vytvořit uživatelský účet ručně s použitím e-mailové adresy uživatele OIDC, buď se silným náhodným heslem, nebo nejlépe zcela bez pole
hashedPassword. Doménová jména mohou obsahovat úvodní zástupný znak*., který odpovídá subdoménám.- Příklad: Povolení vytváření účtů JIT pro uživatele s e-mailovými adresami jako
name@example.comaname@math.example.com:
OVERLEAF_OIDC_ALLOWED_EMAIL_DOMAINS=example.com, *.example.com - Příklad: Úplné vypnutí vytváření účtů JIT:
OVERLEAF_OIDC_ALLOWED_EMAIL_DOMAINS=
- Příklad: Povolení vytváření účtů JIT pro uživatele s e-mailovými adresami jako
- Omezuje vytváření účtů Just-in-Time (JIT) pro uživatele ověřované přes OIDC. Pokud je nastavena na seznam doménových jmen oddělených čárkami, nový účet se vytvoří pouze tehdy, když doména e-mailové adresy uživatele odpovídá některé z uvedených domén. Pokud doména neodpovídá, musí administrátor vytvořit uživatelský účet ručně s použitím e-mailové adresy uživatele OIDC, buď se silným náhodným heslem, nebo nejlépe zcela bez pole
OVERLEAF_OIDC_UPDATE_USER_DETAILS_ON_LOGIN- Pokud je nastaveno na
true, při přihlášení se aktualizují pole uživatelefirst_namealast_namea formulář s údaji o uživateli na stránce/user/settingsse vypne.
- Pokud je nastaveno na
OVERLEAF_OIDC_IS_ADMIN_FIELDaOVERLEAF_OIDC_IS_ADMIN_FIELD_VALUE- Pokud jsou nastaveny obě proměnné prostředí, proces přihlášení nastaví
user.isAdmin = true, pokud profil vrácený OP obsahuje atribut určený proměnnouOVERLEAF_OIDC_IS_ADMIN_FIELDa jeho hodnota buď odpovídáOVERLEAF_OIDC_IS_ADMIN_FIELD_VALUE, nebo je polem obsahujícímOVERLEAF_OIDC_IS_ADMIN_FIELD_VALUE(například claimgroups); v opačném případě seuser.isAdminnastaví nafalse. Pokud jeOVERLEAF_OIDC_IS_ADMIN_FIELDrovnoemail, pro kontrolu shody se použije hodnota atributuemails[0].value.
- Pokud jsou nastaveny obě proměnné prostředí, proces přihlášení nastaví
https://my-overleaf-instance.com/oidc/login/callback.
Ukázkový soubor variables.env
Ukázkový soubor variables.env
Postup krok za krokem: goauthentik
Tento návod popisuje nastavení otestované s goauthentik. Nahraďtehttps://overleaf.example.com svou hodnotou OVERLEAF_SITE_URL a https://authentik.example.com adresou svého Authentiku.
Vytvořte poskytovatele
- Client Type:
Confidential. - Redirect URIs (v části Protocol settings): přidejte
https://overleaf.example.com/oidc/login/callbacks režimem shodyStrict. - Hned teď zkopírujte Client ID a Client Secret do
OVERLEAF_OIDC_CLIENT_IDaOVERLEAF_OIDC_CLIENT_SECRET.

Authentik: Client ID a Client Secret nového poskytovatele
Vytvořte aplikaci
overleaf, a vyberte poskytovatele. Slug se stane součástí issueru: https://authentik.example.com/application/o/overleaf/.Zkopírujte URL
Namapujte administrátory (volitelné)
groups jako pole. Chcete-li, aby se členové skupiny Authentiku Admins stali administrátory Overleafu:Otestovaný soubor variables.env pro goauthentik
Otestovaný soubor variables.env pro goauthentik
Otázky a odpovědi
Nárok pro administrátora je nastaven, ale uživatelé se administrátory nestávají
Nárok pro administrátora je nastaven, ale uživatelé se administrátory nestávají
- Verze. Před verzí v6.3.0 Overleaf nečetl vlastní nároky (claims), jako je
groups, takže fungovalo pouzeOVERLEAF_OIDC_IS_ADMIN_FIELD=email. Aktualizujte na verzi v6.3.0 nebo novější. - Nárok musí být v odpovědi UserInfo. Overleaf čte nárok z
OVERLEAF_OIDC_USER_INFO_URL, nikoli z ID tokenu. Pokud váš OP přidává nárok pouze do ID tokenu, přidejte jej také do UserInfo, například volbou Add to userinfo u mapperu v Keycloaku. - Hodnota se musí přesně shodovat, včetně velikosti písmen, například
Admins.
Mohu jako poskytovatele OIDC použít GitHub?
Mohu jako poskytovatele OIDC použít GitHub?
ID token not present in token response.Chcete-li uživatelům umožnit přihlášení účtem GitHub, použijte poskytovatele identity, jako je goauthentik nebo Keycloak, s GitHubem jako zdrojem přihlášení, a Overleaf k tomuto poskytovateli připojte přes OIDC.Mohu jako poskytovatele OIDC použít GitLab?
Mohu jako poskytovatele OIDC použít GitLab?
- Redirect URI:
https://my-overleaf-instance.com/oidc/login/callback - Scopes:
openid,profileaemail
https://gitlab.com/.well-known/openid-configuration nebo ze stejné cesty na vašem GitLabu, jak je popsáno v části Zjištění hodnot pomocí discovery dokumentu. Pro gitlab.com je issuer https://gitlab.com, bez koncového lomítka.
