الإعداد
داخليًا، تستخدم وحدة OIDC في Overleaf مكتبة passport-openidconnect. إذا واجهت مشكلات في إعداد OpenID Connect، فمن المفيد قراءة ملف README الخاص بـpassport-openidconnect لتكوين فكرة عن الإعدادات التي تتوقعها.
متغير البيئة EXTERNAL_AUTH مطلوب لتفعيل وحدة مصادقة OIDC. يحدد هذا المتغير طرق المصادقة الخارجية المفعّلة. قيمة هذا المتغير عبارة عن قائمة. إذا تضمنت القائمة oidc، فسيتم تفعيل مصادقة OIDC.
على سبيل المثال: EXTERNAL_AUTH=ldap oidc
عند استخدام طريقة مصادقة OIDC، تتم إعادة توجيه المستخدم إلى موقع المصادقة الخاص بمزوّد الهوية (IdP). إذا نجح مزوّد الهوية في مصادقة المستخدم، يتم البحث في قاعدة بيانات مستخدمي Overleaf عن سجل يحتوي على حقل thirdPartyIdentifiers بالبنية التالية:
externalUserId معرّف المستخدم في الملف الشخصي الذي يعيده خادم مزوّد الهوية (راجع متغير البيئة OVERLEAF_OIDC_USER_ID_FIELD)، ويجب أن يطابق providerId معرّف مزوّد OIDC (راجع OVERLEAF_OIDC_PROVIDER_ID).
إذا لم يُعثر على سجل مطابق، يتم البحث في قاعدة البيانات عن مستخدم يطابق عنوان بريده الإلكتروني الأساسي البريد الإلكتروني الموجود في الملف الشخصي للمستخدم لدى مزوّد الهوية:
- إذا عُثر على مثل هذا المستخدم، يتم تحديث الحقل
thirdPartyIdentifiers. - إذا لم يُعثر على مستخدم مطابق ولم يكن إنشاء الحسابات الفوري (JIT) معطّلًا، يتم إنشاء مستخدم جديد بعنوان البريد الإلكتروني و
thirdPartyIdentifiersمن الملف الشخصي لدى مزوّد الهوية.
/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- معرّف اختياري لمزوّد OpenID، والقيمة الافتراضية هي
oidc.
- معرّف اختياري لمزوّد OpenID، والقيمة الافتراضية هي
OVERLEAF_OIDC_PROVIDER_NAME- اسم مزوّد OpenID، ويُستخدم في قسم
Linked Accountsفي صفحة/user/settings، والقيمة الافتراضية هيOIDC Provider.
- اسم مزوّد OpenID، ويُستخدم في قسم
OVERLEAF_OIDC_IDENTITY_SERVICE_NAME- الاسم المعروض لخدمة الهوية، ويُستخدم في صفحة تسجيل الدخول (الافتراضي:
Log in with $OVERLEAF_OIDC_PROVIDER_NAME).
- الاسم المعروض لخدمة الهوية، ويُستخدم في صفحة تسجيل الدخول (الافتراضي:
OVERLEAF_OIDC_PROVIDER_DESCRIPTION- وصف مزوّد OpenID، ويُستخدم في قسم
Linked Accounts(الافتراضي:Log in with $OVERLEAF_OIDC_PROVIDER_NAME).
- وصف مزوّد OpenID، ويُستخدم في قسم
OVERLEAF_OIDC_PROVIDER_INFO_LINK- رابط URL لـ
Learn moreفي وصف مزوّد OpenID، والافتراضي: لا يوجد رابطLearn moreفي الوصف.
- رابط URL لـ
OVERLEAF_OIDC_PROVIDER_HIDE_NOT_LINKED- عدم إظهار مزوّد OpenID في صفحة
/user/settingsإذا لم يكن حساب المستخدم مرتبطًا به، والافتراضيfalse.
- عدم إظهار مزوّد OpenID في صفحة
OVERLEAF_OIDC_USER_ID_FIELD- ستستخدم Overleaf قيمة هذه السمة كمعرّف المستخدم الخارجي، والقيمة الافتراضية هي
id. من القيم المعقولة الأخرى الممكنةemailوusername(المقابلة لمطالبة OIDC preferred_username).
- ستستخدم Overleaf قيمة هذه السمة كمعرّف المستخدم الخارجي، والقيمة الافتراضية هي
OVERLEAF_OIDC_ALLOWED_EMAIL_DOMAINS- يقيّد إنشاء الحسابات الفوري (JIT) للمستخدمين الذين يصادقون عبر OIDC. إذا عُيّن إلى قائمة أسماء نطاقات مفصولة بفواصل، فلن يُنشأ حساب جديد إلا إذا تطابق نطاق عنوان البريد الإلكتروني للمستخدم مع أحد النطاقات المدرجة. إذا لم يتطابق النطاق، فيجب على المسؤول إنشاء حساب المستخدم يدويًا باستخدام عنوان البريد الإلكتروني لمستخدم OIDC، إما بكلمة مرور عشوائية قوية أو، وهو الأفضل، بدون الحقل
hashedPasswordعلى الإطلاق. يمكن أن تتضمن أسماء النطاقات حرف بدل*.في بدايتها لمطابقة النطاقات الفرعية.- مثال: للسماح بإنشاء الحسابات الفوري للمستخدمين ذوي عناوين بريد إلكتروني مثل
name@example.comوname@math.example.com:
OVERLEAF_OIDC_ALLOWED_EMAIL_DOMAINS=example.com, *.example.com - مثال: لتعطيل إنشاء الحسابات الفوري تمامًا:
OVERLEAF_OIDC_ALLOWED_EMAIL_DOMAINS=
- مثال: للسماح بإنشاء الحسابات الفوري للمستخدمين ذوي عناوين بريد إلكتروني مثل
- يقيّد إنشاء الحسابات الفوري (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إذا كان الملف الشخصي الذي يعيده مزوّد OpenID يحتوي على السمة المحددة فيOVERLEAF_OIDC_IS_ADMIN_FIELDوكانت قيمتها إما تطابقOVERLEAF_OIDC_IS_ADMIN_FIELD_VALUEأو مصفوفة تحتوي علىOVERLEAF_OIDC_IS_ADMIN_FIELD_VALUE(على سبيل المثال المطالبةgroups)، وإلا فسيتم تعيين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
أسئلة وأجوبة
مطالبة المسؤول (admin claim) مضبوطة، لكن المستخدمين لا يصبحون مسؤولين
مطالبة المسؤول (admin claim) مضبوطة، لكن المستخدمين لا يصبحون مسؤولين
- الإصدار. قبل الإصدار v6.3.0، لم يكن Overleaf يقرأ المطالبات المخصصة مثل
groups، لذا كانOVERLEAF_OIDC_IS_ADMIN_FIELD=emailفقط هو ما يعمل. قم بالترقية إلى الإصدار v6.3.0 أو أحدث. - يجب أن تكون المطالبة في استجابة UserInfo. يقرأ Overleaf المطالبة من
OVERLEAF_OIDC_USER_INFO_URL، وليس من رمز الهوية (ID token). إذا كان مزوّد OpenID لديك يضيف المطالبة إلى رمز الهوية فقط، فأضفها أيضًا إلى UserInfo، على سبيل المثال باستخدام Add to userinfo في أحد مُعيِّنات (mappers) 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، بدون شرطة مائلة في النهاية.
