SSO
الدخول الموحّد (عبر SAML2) متاح فقط في إصدار OpenReplay Enterprise Edition.
إعداد موفّر الهوية (IDP)
Section titled إعداد موفّر الهوية (IDP)في لوحة تحكم موفّر الهوية الخاص بك، أنشئ تطبيقًا جديدًا باسم openreplay (يمكنك استخدام هذه الأيقونة). في صفحة الإعداد، تأكّد من ضبط القيم التالية (يُرجى التأكّد من استبدال YOUR_DOMAIN بالقيمة الصحيحة، على سبيل المثال https://openreplay.mycompany.com):
| المتغيّر | القيمة |
|---|---|
| عنوان ACS URL (ويُسمّى أيضًا Single Sign On URL أو Consumer URL) | |
| Entity ID (ويُسمّى أيضًا Audience) | |
| عنوان تسجيل الخروج الموحّد (ويُسمّى أيضًا SLO URL) | (اختياري) |
| Name ID (يكون أحيانًا قابلًا للتهيئة في قسم ‘Attribute Statements’ أو ‘Parameters’) | Email أو EmailAddress أو urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress، حسب موفّر الهوية الخاص بك |
| مُهيِّئ SAML | اضبطه على Service Provider (اختياري) |
في قسم ‘Attribute Statements’ أو قسم ‘Parameters’، يُرجى التأكّد من تعريف الحقول التالية:
| الحقل | القيمة |
|---|---|
| tenantKey | يمكن العثور على قيمته في Dashboard، ضمن ‘Preferences’ > ‘Account’ (يجب عدم إضافة هذه السمة إذا كنت تستخدم خطّة Cloud Dedicated الخاصة بنا) |
| firstName | user.firstName |
| lastName | user.lastName |
| internalId | المعرّف الداخلي أو user.email (معرّف المستخدم في نظام إدارة الهوية الخاص بك) (اختياري) |
| role | دور المستخدم؛ وحسب موفّر الهوية الخاص بك قد يكون user.role أو group وما إلى ذلك. (اختياري، القيمة الافتراضية = member) |
| adminPrivileges | ما إذا كان المستخدم يملك صلاحيات المسؤول أم لا؛ إذا احتوى هذا الحقل على أي قيمة مختلفة عن false، فسيُعتبر true. (اختياري، القيمة الافتراضية = false) |
ينبغي الآن أن تكون لديك جميع القيم المطلوبة للخطوة/القسم التالي.
إعداد SSO (SAML2)
Section titled إعداد SSO (SAML2)إذا كنت تستخدم خطّة Cloud dedicated الخاصة بنا، انتقل إلى Console ثم انقر على الخادم (instance) واضبط المتغيّرات ضمن قسم SSO.
وإلّا، إذا كنت تشغّل إصدار Enterprise Edition الخاص بنا، فشغّل openreplay -e وأزل التعليق ثم حدّث متغيّرات البيئة أدناه في قسم chalice:
| المتغيّر | الوصف |
|---|---|
| idp_entityId | الـ entityId الخاص بموفّر الهوية لديك، ويُشار إليه أيضًا بـ Issuer URL |
| idp_sso_url | الـ singleSignOnService الخاص بموفّر الهوية لديك، ويُشار إليه أيضًا بـ SAML 2.0 Endpoint (HTTP) |
| idp_x509cert | الـ x509cert، يجب أن يكون سلسلة نصّية في سطر واحد، دون فواصل أسطر. يمكنك استخدام هذه الأداة لتنسيق قيمتك |
| idp_name | اسم موفّر الهوية (اختياري) |
| idp_sls_url | الـ singleLogoutService الخاص بموفّر الهوية لديك، ويُشار إليه أيضًا بـ SLO Endpoint (HTTP) (اختياري) |
| enforce_SSO | إذا ضُبط على true، فستُحظَر جميع عمليات الاتصال باسم المستخدم وكلمة المرور (اختياري، القيمة الافتراضية=false) |
ثم احفظ واخرج باستخدام :wq لكي تدخل التغييرات حيّز التنفيذ:
شهادة OpenReplay
Section titled شهادة OpenReplayهذا اختياري؛ يمكنك إضافة شهادة x509 لمزيد من الأمان في SSO:
- شغّل هذا الأمر في خادمك أو في جهازك الآمن (يمكنك تغيير مدّة صلاحية شهادتك وفقًا لاحتياجاتك):
openssl req -x509 -nodes -days 365 -newkey rsa:2048 -keyout openreplay-sso.key -out openreplay-sso.crt
- في خادمك، شغّل
openreplay -e - ضمن قسم
chalice، أضف متغيّرات البيئة التالية:
- sp_crt: يجب أن يكون سلسلة نصّية في سطر واحد، دون فواصل أسطر، من ملف ‘openreplay-sso.crt’ الذي تمّ إنشاؤه (يمكنك استخدام هذه الأداة لتنسيق قيمتك)
- sp_key: يجب أن يكون سلسلة نصّية في سطر واحد، دون فواصل أسطر، من ملف ‘openreplay-sso.key’ الذي تمّ إنشاؤه
- احفظ واخرج باستخدام
:wqلكي تدخل التغييرات حيّز التنفيذ - أضف ملف ‘openreplay-sso.crt’ الذي تمّ إنشاؤه إلى إعداد تطبيق موفّر الهوية الخاص بك
مثال باستخدام Okta
Section titled مثال باستخدام Okta- سجّل الدخول إلى لوحة تحكم إدارة Okta الخاصة بك وانتقل إلى ‘Applications’ > ‘Applications’
- اضغط ‘Create new app integration’، ثم اختر SAML 2.0 واضغط ‘Next’
- اضبط ‘App Name’ على OpenReplay (يمكنك رفع هذه الأيقونة) لتطبيقك) ثم اضغط ‘Next’
- اضبط:
- Single sign on URL على
/api/sso/saml2/acs/YOUR_DOMAIN - Audience URI (SP Entity ID) على
/api/sso/saml2/metadata/YOUR_DOMAIN - Name ID format على
EmailAddress
- عرّف الحقول أدناه في ‘Attribute Statements’:
- tenantKey: التنسيق
Basicواضبط القيمة على، الموجودة في لوحة تحكم OpenReplay ضمن ‘Preferences’ > ‘Account’ (يجب عدم إضافة هذه السمة إذا كنت تستخدم خطّة Cloud Dedicated الخاصة بنا)TENANT_KEY - firstName: التنسيق
Basicواضبط القيمة علىuser.firstName - lastName: التنسيق
Basicواضبط القيمة علىuser.lastName - internalId: التنسيق
Basicواضبط القيمة علىuser.email
- عرّف الحقل أدناه في ‘Group Attribute Statements’:
- role: التنسيق
Basic، المرشّحMatch Regex، القيمة.*(أو يمكنك تحديد مرشّح وتعبير نمطي مختلفَين وفقًا لاحتياجاتك) - adminPrivileges: التنسيق
Basic، المرشّحMatch Regex، القيمةadmin(سيحصل المستخدم الحالي علىadmin privilegesإذا كان جزءًا من مجموعة admin)
- اضغط Next، اختر ‘I’m an Okta customer adding an internal app’ و ‘This is an internal app that we have created’ ثم اضغط ‘Finish’
- في علامة التبويب Sign On، مرّر للأسفل واضغط ‘View Setup Instructions’ لرؤية إعداد SAML2 الخاص بك
إذا كنت تستخدم خطّة Cloud dedicated الخاصة بنا، انتقل إلى Console ثم انقر على الخادم (instance) واضبط المتغيّرات ضمن قسم SSO.
وإلّا، إذا كنت تشغّل إصدار Enterprise Edition الخاص بنا:
- اتّصل عبر SSH بتثبيت OpenReplay الخاص بك وشغّل
openreplay -e - ضمن قسم
chalice، أزل التعليق ثم اضبط متغيّرات البيئة التالية:
- idp_entityId: Identity Provider Issuer
- idp_sso_url: Identity Provider Single Sign-On URL
- idp_x509cert: X.509 Certificate، يجب أن يكون سلسلة نصّية في سطر واحد، دون فواصل أسطر (يمكنك استخدام هذه الأداة لتنسيق قيمتك)
- idp_name: Okta
- أخيرًا، احفظ واخرج باستخدام
:wqلكي تدخل التغييرات حيّز التنفيذ
مثال باستخدام Azure Active Directory
Section titled مثال باستخدام Azure Active Directory- سجّل الدخول إلى بوّابة Azure الخاصة بك وانتقل إلى ‘Azure Active Directory’
- اضغط ’+ Add’، اختر ‘Enterprise application’ ثم انقر ‘Create your own application’
- اضبط ‘App Name’ على OpenReplay ثم اختر ‘Integrate any other application you don’t find in the gallery (Non-gallery)’ واضغط ‘Create’
- انتقل إلى ‘Single sign-on’ في القائمة الجانبية اليسرى واضبط القيم أدناه في كتلة ‘Basic SAML Configuration’:
- Identifier (Entity ID) على
/api/sso/saml2/metadata/YOUR_DOMAIN - Reply URL (Assertion Consumer Service URL) على
/api/sso/saml2/acs/YOUR_DOMAIN - Logout URL على
/api/sso/saml2/sls/YOUR_DOMAIN
- أضف المطالبات (claims) أدناه في كتلة ‘Attribute & Claims’ وتأكّد من ترك حقل ‘Namespace’ فارغًا لكلٍّ منها:
- tenantKey: اضبط القيمة على
، الموجودة في لوحة تحكم OpenReplay ضمن ‘Preferences’ > ‘Account’ (يجب عدم إضافة هذه السمة/المطالبة إذا كنت تستخدم خطّة Cloud Dedicated الخاصة بنا)TENANT_KEY - firstName: اضبط القيمة على
user.givenname - lastName: اضبط القيمة على
user.surname - internalId: اضبط القيمة على
user.mail
- انتقل إلى ‘Users and groups’ وعيّن المستخدمين الذين تختارهم للتطبيق
إذا كنت تستخدم خطّة Cloud dedicated الخاصة بنا، انتقل إلى Console ثم انقر على الخادم (instance) واضبط المتغيّرات ضمن قسم SSO (توجد القيم في ‘Azure Active Directory’ > ‘OpenReplay’ > ‘Single sign-on’).
وإلّا، إذا كنت تشغّل إصدار Enterprise Edition الخاص بنا:
- اتّصل عبر SSH بتثبيت OpenReplay الخاص بك وشغّل
openreplay -e - ضمن قسم
chalice، أزل التعليق ثم اضبط متغيّرات البيئة التالية (توجد القيم في ‘Azure Active Directory’ > ‘OpenReplay’ > ‘Single sign-on’):- idp_entityId: Azure AD Identifier
- idp_sso_url: Login URL
- idp_sls_url: Logout URL
- idp_x509cert: X.509 Certificate، يجب أن يكون سلسلة نصّية في سطر واحد، دون فواصل أسطر (يمكنك استخدام هذه الأداة لتنسيق قيمتك)
- idp_name: Active Directory
- أخيرًا، احفظ واخرج باستخدام
:wqلكي تدخل التغييرات حيّز التنفيذ
مثال باستخدام Google Workspace (المعروف سابقًا باسم G Suite)
Section titled مثال باستخدام Google Workspace (المعروف سابقًا باسم G Suite)إضافة سمات مخصّصة:
Section titled إضافة سمات مخصّصة:- في وحدة تحكم مسؤول Google، انتقل إلى ‘Directory’ > ‘Users’ > ‘More options’ > ‘Manage custom attributes’.
- انقر ‘Add Custom Attribute’.
- اضبط الحقول التالية:
- Category: ‘OpenReplay’
- Custom fields:
- Name: ‘role’
- Info type: ‘Text’
- Visibility: ‘Visible to user and admin’
- No. of values: ‘Single-value’
- Custom fields:
- Name: ‘adminPrivileges’
- Info type: ‘Yes or No’
- Visibility: ‘Visible to user and admin’
- No. of values: ‘Single-value’
- انقر ‘Add’
- لإضافة قيم إلى السمات المخصّصة الجديدة، انتقل إلى ‘Users’
- اختر المستخدم (أو المستخدمين) المطلوب
- انقر ‘User information’ ثم حرّر قسم ‘OpenReplay’
- غيّر قيمة role إلى الدور المطلوب في ‘OpenReplay’ (يجب أن يتطابق الدور مع الدور الذي تمّ إنشاؤه في لوحة تحكم OpenReplay ضمن ‘Preferences’ > ‘Roles’)
- غيّر قيمة adminPrivileges إلى ‘Yes’ إذا كان المستخدم مسموحًا له بامتلاك صلاحيات المسؤول في OpenReplay
- انقر ‘Save’
الإعداد:
Section titled الإعداد:- سجّل الدخول إلى وحدة تحكم مسؤول Google الخاصة بك وانتقل إلى ‘Apps’
- اضغط ‘Web and mobile apps’ ثم انقر ‘Add app’ > ‘Add custom SAML app’
- اضبط ‘App name’ على OpenReplay (يمكنك رفع هذه الأيقونة لـ ‘App icon”) ثم اضغط ‘Continue’
- انسخ ‘SSO URL’ و ‘Entity ID’ و ‘Certificate’ ثم انقر ‘Continue’ (سنستخدم هذه القيم في الخطوة 11)
- اضبط:
- ACS URL على
(توجد /api/sso/saml2/acs/YOUR_DOMAIN /TENANT_KEYTENANT_KEYفي لوحة تحكم OpenReplay ضمن ‘Preferences’ > ‘Account’، لكن إذا كنت تستخدم خطّة Cloud Dedicated الخاصة بنا، اترك قيمة tenantKey فارغة) - Entity ID على
/api/sso/saml2/metadata/YOUR_DOMAIN - Name ID format على
Email - Name ID على
Basic information > Primary Email
- انقر ‘Continue’ ثم اضغط ‘Add Mapping’ لإضافة السمات أدناه:
Basic information > First Name-> firstNameBasic information > Last Name-> lastNameBasic information > Primary Email-> internalIdOpenReplay > role-> roleOpenReplay > adminPrivileges-> adminPrivileges
- انقر ‘Finish’
- في وحدة تحكم مسؤول Google، انتقل إلى ‘Apps’ > ‘Web and mobile apps’ واختر ‘OpenReplay’
- انقر ‘User access’، اختر ‘ON for everyone’ ثم اضغط ‘Save’
إذا كنت تستخدم خطّة Cloud dedicated الخاصة بنا، انتقل إلى Console ثم انقر على الخادم (instance) واضبط المتغيّرات ضمن قسم SSO.
وإلّا، إذا كنت تشغّل إصدار Enterprise Edition الخاص بنا:
- اتّصل عبر SSH بتثبيت OpenReplay الخاص بك وشغّل
openreplay -e - ضمن قسم
chalice > env، أزل التعليق واضبط السمات التالية باستخدام القيم من الخطوة 4:
- idp_sso_url: الصق قيمة ‘SSO URL’
- idp_entityId: الصق قيمة ‘Entity ID’
- idp_x509cert: استخدم هذه الأداة لتنسيق الشهادة المنسوخة/المُنزَّلة
- idp_name: اضبط القيمة على
G-Suite - idp_tenantKey:
الموجودة في لوحة تحكم OpenReplay ضمن ‘Preferences’ > ‘Account’TENANT_KEY
- أخيرًا، احفظ واخرج باستخدام
:wqلكي تدخل التغييرات حيّز التنفيذ
مثال باستخدام JumpCloud
Section titled مثال باستخدام JumpCloud- سجّل الدخول إلى لوحة تحكم إدارة JumpCloud الخاصة بك وفي القائمة اليسرى، انتقل إلى ‘SSO’
- اضغط ’+ Add New Application’، ثم اختر ‘Custom SAML App’
- اضبط ‘Display Label’ على OpenReplay (يمكنك رفع هذه الأيقونة لتطبيقك) ثم انتقل إلى علامة التبويب ‘SSO’
- اضبط:
- IdP Entity ID على
openreplay/(توجدTENANT_KEYTENANT_KEYفي لوحة تحكم OpenReplay ضمن ‘Preferences’ > ‘Account’، لكن إذا كنت تستخدم خطّة Cloud Dedicated الخاصة بنا، اترك قيمة tenantKey فارغة) - SP Entity ID على
/api/sso/saml2/metadata/YOUR_DOMAIN - ACS URL على
/api/sso/saml2/acs/YOUR_DOMAIN - SAMLSubject NameID على
email - SAMLSubject NameID Format: على
urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress - Signature Algorithm على
RSA-SHA256 - حدّد Sign Assertion
- IDP URL بحيث ينتهي بـ
openreplay-(لا يمكن تغيير هذه القيمة لاحقًا؛ إذا كنت تستخدم خطّة Cloud Dedicated الخاصة بنا، اترك جزء tenantKey فارغًا)TENANT_KEY
- إذا اتبعت تعليمات OpenReplay-Certificate، يمكنك رفع ملف ‘openreplay-sso.crt’ الذي تمّ إنشاؤه بالضغط على ‘Upload SP Certificate’، وإلّا تجاهل هذه الخطوة
- عرّف الحقول أدناه في ‘USER ATTRIBUTE MAPPING’ بالضغط على زرّ ‘add attribute’:
- firstName: اضبط القيمة على
firstname - lastName: اضبط القيمة على
lastname - internalId: اضبط القيمة على
email - role: اختياري، دور المستخدم في OpenReplay؛ إذا كان قيمة ثابتة لجميع المستخدمين، فعليك تعريفه في الخطوة التالية،
وإلّا فعليك إضافة سمة نصّية (string) جديدة إلى مجموعة JumpCloud، وتسميتها
OpenReplayRoleوضبط القيمة على اسم الدور، ثم في إعداد SSO، اختر ‘Custom User or Group Attribute’ واضبط القيمة علىOpenReplayRole. - adminPrivileges: اختياري، إذا كان قيمة ثابتة لجميع المستخدمين، فعليك تعريفه في الخطوة التالية، وإلّا فعليك إضافة سمة منطقية (boolean) جديدة إلى مجموعة JumpCloud، وتسميتها
OpenReplayAdminPrivilegesوضبط القيمة على اسم الدور، ثم في إعداد SSO، اختر ‘Custom User or Group Attribute’ واضبط القيمة علىOpenReplayAdminPrivileges.
- عرّف الحقول أدناه في ‘CONSTANT ATTRIBUTES’ بالضغط على زرّ ‘add attribute’:
- tenantKey: اضبط القيمة على
، الموجودة في لوحة تحكم OpenReplay ضمن ‘Preferences’ > ‘Account’ (يجب عدم إضافة هذه السمة إذا كنت تستخدم خطّة Cloud Dedicated الخاصة بنا)TENANT_KEY - role: اختياري، تجاهله إذا تمّ تعريفه في الخطوة السابقة، دور المستخدم في OpenReplay، يجب أن يتطابق مع اسم دور مُعرَّف مسبقًا في OpenReplay (القيمة الافتراضية =
member) - adminPrivileges: اختياري، تجاهله إذا تمّ تعريفه في الخطوة السابقة، اضبط القيمة على
trueإذا كنت تريد منح المستخدمين الجدد صلاحية المسؤول، وfalseإذا لم تكن تريد ذلك (القيمة الافتراضية =false)
- في هذه المرحلة، يمكنك الانتقال إلى علامة التبويب ‘User Groups’، واختيار مجموعة المستخدمين الذين سيكون لديهم وصول إلى OpenReplay، أو يمكنك فعل ذلك لاحقًا
- اضغط ‘activate’ و ‘continue’ في النافذة المنبثقة للتأكيد
- اضغط على أيقونة تطبيق OpenReplay الجديد، ثم في القائمة المنسدلة اليسرى ‘IDP Certificate Valid’ اختر ‘Download certificate’
إذا كنت تستخدم خطّة Cloud dedicated الخاصة بنا، انتقل إلى Console ثم انقر على الخادم (instance) واضبط المتغيّرات ضمن قسم SSO.
وإلّا، إذا كنت تشغّل إصدار Enterprise Edition الخاص بنا:
- اتّصل عبر SSH بتثبيت OpenReplay الخاص بك وشغّل
openreplay -e - ضمن قسم
chalice، أزل التعليق ثم اضبط متغيّرات البيئة التالية:
- idp_entityId:
openreplay/TENANT_KEY - idp_sso_url:
https://sso.jumpcloud.com/saml2/openreplay-TENANT_KEY - idp_x509cert: الشهادة المُنزَّلة، يجب أن تكون سلسلة نصّية في سطر واحد، دون فواصل أسطر (يمكنك استخدام هذه الأداة لتنسيق قيمتك)
- idp_name: JumpCloud
- أخيرًا، احفظ واخرج باستخدام
:wqلكي تدخل التغييرات حيّز التنفيذ
الأخطاء
Section titled الأخطاءThe response was received at http instead of http
Section titled The response was received at http instead of httpهذا أمر شائع جدًّا، ويعود إلى عدم وجود ترويسة ‘X-Forwarded-Proto’ في الطلب. ولحلّ ذلك، تأكّد من أنّ موازن التحميل (Load Balancer) يقوم بإعادة توجيه الترويسة بشكل صحيح إلى الواجهة الخلفية (backend) لـ OpenReplay.