Налаштування
Внутрішньо модуль OIDC в Overleaf використовує бібліотеку passport-openidconnect. Якщо у вас виникають проблеми з налаштуванням OpenID Connect, варто прочитати README дляpassport-openidconnect, щоб зрозуміти, яку конфігурацію вона очікує.
Для ввімкнення модуля автентифікації OIDC потрібна змінна середовища EXTERNAL_AUTH. Ця змінна середовища визначає, які методи зовнішньої автентифікації активовано. Значенням цієї змінної є список. Якщо список містить oidc, автентифікацію OIDC буде активовано.
Наприклад: EXTERNAL_AUTH=ldap oidc
Під час використання методу автентифікації OIDC користувача перенаправляють на сайт автентифікації постачальника ідентичності (IdP). Якщо IdP успішно автентифікує користувача, у базі даних користувачів Overleaf шукається запис, що містить поле thirdPartyIdentifiers такої структури:
externalUserId має збігатися з ID користувача в профілі, який повертає сервер IdP (див. змінну середовища OVERLEAF_OIDC_USER_ID_FIELD), а providerId має збігатися з ID постачальника OIDC (див. OVERLEAF_OIDC_PROVIDER_ID).
Якщо відповідного запису не знайдено, у базі даних шукається користувач, чия основна адреса електронної пошти збігається з адресою в профілі користувача IdP:
- Якщо такого користувача знайдено, поле
thirdPartyIdentifiersоновлюється. - Якщо відповідного користувача не знайдено, а створення облікових записів JIT не вимкнено, створюється новий користувач з адресою електронної пошти та
thirdPartyIdentifiersз профілю IdP.
/user/settings.
Пошук значень за допомогою документа виявлення
Кожен постачальник OpenID (OP) публікує документ виявлення (discovery document) за адресою<issuer>/.well-known/openid-configuration. Копіюйте значення з нього, а не вводьте їх вручну: одного неправильного символу достатньо, щоб вхід перестав працювати.
Знайдіть URL виявлення

Authentik: URL виявлення та issuer постачальника (тестовий екземпляр)
- Keycloak:
https://keycloak.example.com/realms/<realm>/.well-known/openid-configuration - Authentik:
https://authentik.example.com/application/o/<application-slug>/.well-known/openid-configuration
Прочитайте значення

Authentik: ендпоінти постачальника (тестовий екземпляр)
Скопіюйте їх у variables.env
Перевірте, що Overleaf може дістатися до OP
200.Змінні середовища
Значення наведених нижче п’яти обов’язкових змінних можна знайти за допомогою ендпоінта.well-known/openid-configuration вашого постачальника OpenID (OP), див. вище.
OVERLEAF_OIDC_ISSUER(обов’язково)OVERLEAF_OIDC_AUTHORIZATION_URL(обов’язково)OVERLEAF_OIDC_TOKEN_URL(обов’язково)OVERLEAF_OIDC_USER_INFO_URL(обов’язково)OVERLEAF_OIDC_LOGOUT_URL(обов’язково)
OVERLEAF_OIDC_CLIENT_ID(обов’язково)OVERLEAF_OIDC_CLIENT_SECRET(обов’язково)OVERLEAF_OIDC_SCOPE- За замовчуванням:
openid profile email
- За замовчуванням:
OVERLEAF_OIDC_PROVIDER_ID- Довільний ID OP, за замовчуванням
oidc.
- Довільний ID OP, за замовчуванням
OVERLEAF_OIDC_PROVIDER_NAME- Назва OP, що використовується в розділі
Linked Accountsна сторінці/user/settings, за замовчуваннямOIDC Provider.
- Назва OP, що використовується в розділі
OVERLEAF_OIDC_IDENTITY_SERVICE_NAME- Відображувана назва сервісу ідентифікації, що використовується на сторінці входу (за замовчуванням:
Log in with $OVERLEAF_OIDC_PROVIDER_NAME).
- Відображувана назва сервісу ідентифікації, що використовується на сторінці входу (за замовчуванням:
OVERLEAF_OIDC_PROVIDER_DESCRIPTION- Опис OP, що використовується в розділі
Linked Accounts(за замовчуванням:Log in with $OVERLEAF_OIDC_PROVIDER_NAME).
- Опис OP, що використовується в розділі
OVERLEAF_OIDC_PROVIDER_INFO_LINK- URL
Learn moreв описі OP; за замовчуванням посиланняLearn moreв описі немає.
- URL
OVERLEAF_OIDC_PROVIDER_HIDE_NOT_LINKED- Не показувати OP на сторінці
/user/settings, якщо обліковий запис користувача не пов’язано з OP; за замовчуваннямfalse.
- Не показувати OP на сторінці
OVERLEAF_OIDC_USER_ID_FIELD- Значення цього атрибута Overleaf використовуватиме як зовнішній ID користувача; за замовчуванням
id. Інші можливі доречні значення —emailіusername(відповідає claim OIDCpreferred_username).
- Значення цього атрибута Overleaf використовуватиме як зовнішній ID користувача; за замовчуванням
OVERLEAF_OIDC_ALLOWED_EMAIL_DOMAINS- Обмежує створення облікових записів Just-in-Time (JIT) для користувачів, які автентифікуються через OIDC. Якщо задано список доменних імен, розділених комами, новий обліковий запис буде створено лише тоді, коли домен адреси електронної пошти користувача збігається з одним із доменів у списку. Якщо домен не збігається, адміністратор має вручну створити обліковий запис користувача з адресою електронної пошти користувача OIDC, з надійним випадковим паролем або, що краще, взагалі без поля
hashedPassword. Доменні імена можуть містити на початку символ підстановки*.для відповідності піддоменам.- Приклад: щоб дозволити створення облікових записів JIT для користувачів з адресами на кшталт
name@example.comіname@math.example.com:
OVERLEAF_OIDC_ALLOWED_EMAIL_DOMAINS=example.com, *.example.com - Приклад: щоб повністю вимкнути створення облікових записів JIT:
OVERLEAF_OIDC_ALLOWED_EMAIL_DOMAINS=
- Приклад: щоб дозволити створення облікових записів JIT для користувачів з адресами на кшталт
- Обмежує створення облікових записів Just-in-Time (JIT) для користувачів, які автентифікуються через OIDC. Якщо задано список доменних імен, розділених комами, новий обліковий запис буде створено лише тоді, коли домен адреси електронної пошти користувача збігається з одним із доменів у списку. Якщо домен не збігається, адміністратор має вручну створити обліковий запис користувача з адресою електронної пошти користувача OIDC, з надійним випадковим паролем або, що краще, взагалі без поля
OVERLEAF_OIDC_UPDATE_USER_DETAILS_ON_LOGIN- Якщо встановлено
true, під час входу оновлюються поля користувачаfirst_nameіlast_name, а форма даних користувача на сторінці/user/settingsвимикається.
- Якщо встановлено
OVERLEAF_OIDC_IS_ADMIN_FIELDіOVERLEAF_OIDC_IS_ADMIN_FIELD_VALUE- Коли задано обидві змінні середовища, процес входу встановлює
user.isAdmin = true, якщо профіль, повернутий OP, містить атрибут, вказаний уOVERLEAF_OIDC_IS_ADMIN_FIELD, і його значення або збігається зOVERLEAF_OIDC_IS_ADMIN_FIELD_VALUE, або є масивом, що міститьOVERLEAF_OIDC_IS_ADMIN_FIELD_VALUE(наприклад, claimgroups); інакшеuser.isAdminвстановлюється вfalse. ЯкщоOVERLEAF_OIDC_IS_ADMIN_FIELDмає значенняemail, для перевірки збігу використовується значення атрибутаemails[0].value.
- Коли задано обидві змінні середовища, процес входу встановлює
https://my-overleaf-instance.com/oidc/login/callback.
Приклад файлу variables.env
Приклад файлу variables.env
Покрокова інструкція: goauthentik
Тут описано налаштування, протестоване з goauthentik. Замінітьhttps://overleaf.example.com на ваш OVERLEAF_SITE_URL, а https://authentik.example.com — на адресу вашого Authentik.
Створіть постачальника
- Client Type:
Confidential. - Redirect URIs (у розділі Protocol settings): додайте
https://overleaf.example.com/oidc/login/callbackз режимом зіставленняStrict. - Одразу скопіюйте Client ID і Client Secret у
OVERLEAF_OIDC_CLIENT_IDіOVERLEAF_OIDC_CLIENT_SECRET.

Authentik: Client ID і Client Secret нового постачальника
Створіть застосунок
overleaf, і виберіть постачальника. Slug стає частиною issuer: https://authentik.example.com/application/o/overleaf/.Скопіюйте URL
Зіставте адміністраторів (необов'язково)
groups — масив. Щоб члени групи Authentik Admins стали адміністраторами Overleaf:Протестований variables.env для goauthentik
Протестований variables.env для goauthentik
Питання та відповіді
Claim адміністратора задано, але користувачі не стають адміністраторами
Claim адміністратора задано, але користувачі не стають адміністраторами
- Версія. До v6.3.0 Overleaf не зчитував власні claims, як-от
groups, тож працювало лишеOVERLEAF_OIDC_IS_ADMIN_FIELD=email. Оновіться до v6.3.0 або новішої версії. - Claim має бути у відповіді UserInfo. Overleaf зчитує claim з
OVERLEAF_OIDC_USER_INFO_URL, а не з ID-токена. Якщо ваш OP додає claim лише до ID-токена, додайте його також до UserInfo, наприклад за допомогою Add to userinfo у mapper Keycloak. - Значення має збігатися точно, включно з регістром, наприклад
Admins.
Чи можна використовувати GitHub як постачальника OIDC?
Чи можна використовувати GitHub як постачальника OIDC?
ID token not present in token response.Щоб користувачі могли входити через свій обліковий запис GitHub, використовуйте постачальника ідентичності, як-от goauthentik або Keycloak, з GitHub як джерелом входу, і підключіть Overleaf до цього постачальника через OIDC.Чи можна використовувати GitLab як постачальника OIDC?
Чи можна використовувати GitLab як постачальника OIDC?
- Redirect URI:
https://my-overleaf-instance.com/oidc/login/callback - Scopes:
openid,profileіemail
https://gitlab.com/.well-known/openid-configuration або з того самого шляху на вашому GitLab, як описано в розділі Пошук значень за допомогою документа виявлення. Для gitlab.com issuer — це https://gitlab.com, без кінцевої скісної риски.
