تخطَّ إلى المحتوى
Oleaflyv0.4.12

تشغيل خادم

تشغيل خادم التعاون

ما الذي يخزّنه Oleafly Server، وما يحتاجه، وكيفية تثبيته بأمر واحد أو تشغيله باستخدام Docker Compose أو Coolify أو Render أو Railway أو خدمة Linux عادية، ثم كيف تصبح أول مسؤول له.

‏Oleafly Server هو خادم التعاون الذي يقف خلف ميزة التعاون المباشر. يقوم مختبرك أو قسمك أو مؤسستك بتشغيله على أجهزته الخاصة أو في حساب السحابة الخاص به. يضيفه الأشخاص في Oleafly ويسجّلون الدخول بحساب يملكونه بالفعل، مثل GitHub أو حساب جامعي. عندما يشارك شخص ما مشروعًا على الخادم، يحصل الأشخاص الذين يضيفهم على نسخة كاملة تبقى متزامنة أثناء تحريرهم. ومع تفعيل الوصول عبر المتصفح، يمكنهم أيضًا فتحه في متصفح ويب.

هذا الدليل موجَّه إلى الشخص الذي يشغّل الخادم لمختبر أو مقرر دراسي أو مجموعة من المؤلفين المشاركين. يجب أن تكون مرتاحًا في التعامل مع الطرفية (terminal). بعض طرق الإعداد تطلب منك أيضًا تحرير ملف إعدادات. لست بحاجة إلى كتابة شيفرات برمجية.

لمراجعتك الأمنية، اقرأ أمان الخادم. يغطي الاستضافة الذاتية، وتسجيل الدخول، ومفاتيح الأجهزة، والتغييرات الموقّعة، وسجلي الأمان والوصول، وصورة الحاوية مع قائمة مكوناتها البرمجية.

يحتفظ الخادم بكل شيء في مجلد بيانات واحد يحدده OLEAFLY_DATA_DIR:

  • الحسابات: اسم العرض لكل عضو، وعنوان صورته الشخصية، وعناوين بريده الإلكتروني الموثقة، ومعرّفه ومعلومات دخوله لدى مزوّد تسجيل الدخول. لا يرى الخادم كلمة مرور أبدًا ولا يخزّنها.
  • الأجهزة: كل حاسوب سجّل الدخول، مع اسمه ونظام التشغيل فيه ومفتاحه العام ووقت آخر ظهور له. تُخزَّن رموز تسجيل الدخول في صورة بصمات تجزئة فقط.
  • سجل الأمان: عمليات تسجيل الدخول والمرفوض منها، والأجهزة المضافة والمسجَّل خروجها، والتغييرات على الأعضاء والأدوار والإعدادات، والمشاريع المشتركة والمؤرشفة والمستعادة، والتغييرات على من يمكنه فتح مشروع، ودعوات الضيوف. لكل قيد الوقت وعنوان IP.
  • إعدادات الخادم التي يغيّرها المسؤولون في Oleafly.
  • سجلات الوصول إلى المشاريع، للمشاريع التي يفعّل مالكها سجلًا لها: من فتح المشروع أو انضم إليه أو نزّل نسخة منه، مع اسم الجهاز والوقت. لا يستطيع قراءة السجل إلا مالك المشروع.
  • دعوات الضيوف: عنوان البريد الإلكتروني للشخص المدعو، والمشروع، والدور، ومَن أرسل الدعوة.
  • المشاريع المشتركة: كل ملف والتاريخ الكامل للتغييرات، مع التعليقات والاقتراحات والدردشة وأسماء الإصدارات التي تخصها.
  • ملفات PDF المجمّعة: لكل مشروع مشترك، أحدث ملف PDF، مع ملف SyncTeX الخاص به، أرسله تطبيق مالك أو محرر بعد تجميع ناجح، مع من جمّعه ومتى.

تُحذف القيود في سجل الأمان وسجلات الوصول، ودعوات الضيوف التي تم الرد عليها أو المنتهية، بعد OLEAFLY_SECURITY_LOG_DAYS يومًا، وهي 365 يومًا افتراضيًا. الملفات التي لم يعد المشروع يستخدمها، مثل النسخة القديمة من شكل تم استبداله، تُحذف بعد 30 يومًا من آخر استخدام المشروع لها. ويحل كل ملف PDF مجمّع محل الذي قبله. عندما يوقف المالك مشاركة مشروع، يبقيه الخادم للقراءة فقط مدة OLEAFLY_ARCHIVE_DAYS يومًا، وهي 30 يومًا افتراضيًا، ثم يحذفه. خلال هذه المدة يستطيع المالك فقط وأي مسؤولين في المشروع تنزيله.

المشاريع غير مشفّرة على الخادم. أي شخص يستطيع قراءة مجلد البيانات أو قرص الجهاز أو نسخك الاحتياطية يستطيع قراءة كل مشروع مخزَّن هناك. يشمل ذلك من يشغّل الجهاز والشركة التي تستضيفه.

داخل Oleafly القواعد أكثر صرامة. لا يمكن لأي دور على الخادم، بما في ذلك المسؤول، فتح مشروع ما لم يضفه مالك المشروع. إذا كان لا بد أن يبقى مشروع بعيدًا عن متناول من يشغّلون الخادم، فشغّل له خادمًا منفصلًا.

كما يحتفظ حاسوب كل عضو بنسخة كاملة من كل مشروع تمت مشاركته معه. اطلب من الأعضاء تفعيل تشفير القرص، مثل FileVault على macOS أو BitLocker على Windows أو LUKS على Linux.

  • جهاز يعمل باستمرار. أي جهاز Linux يفي بالغرض، أو حساب لدى خدمة استضافة مثل Render أو Railway. تكفي آلة افتراضية صغيرة للبداية. راقب ذاكرتها وقرصها مع نمو المشاريع. يعمل الخادم على x86-64 و ARM.
  • اسم نطاق للخادم، مثل collab.example.org، مع سجل DNS يشير إلى الجهاز. تمنحك Render و Railway عنوانًا إن لم يكن لديك واحد. إذا لم يكن للجهاز عنوان عام، اقرأ بدون عنوان عام.
  • طريقة لتسجيل دخول الناس: مزوّد تسجيل دخول واحد على الأقل، مثل تطبيق GitHub OAuth أو حساب الدخول لدى مؤسستك. لن يبدأ الخادم بدونه. حساب بريد إلكتروني يرسل منه الخادم أمر اختياري. معه، يستطيع المسؤول أيضًا السماح للناس بتسجيل الدخول برابط يُرسل بالبريد الإلكتروني. اقرأ تسجيل الدخول والوصول.

يُنشر كل إصدار في صورة حاوية، ghcr.io/oleafly/oleafly-server. المثبِّت وملفات Compose الخاصة به في صفحة إصدارات Oleafly Server (يفتح في علامة تبويب جديدة). الخادم كبرنامج Linux واحد موجود في صفحة إصدارات Oleafly (يفتح في علامة تبويب جديدة).

الخيارمتى تستخدمه
أمر واحدجهاز Linux تتولى رعايته بنفسك. يهيّئ المثبِّت Docker و Caddy و HTTPS، ويطرح بضعة أسئلة. ابدأ من هنا إن لم تكن متأكدًا.
Docker Compose يدويًاإذا كنت تفضّل وضع كل ملف في مكانه وتحريره بنفسك.
Coolifyكنت تشغّل خادم Coolify بالفعل.
Render أو Railwayإذا كنت تفضّل الدفع لخدمة استضافة على تولي رعاية جهاز بنفسك.
Linux بدون Dockerآلة افتراضية جامعية لا يمكنك استخدام Docker فيها.

يقرأ الخادم إعداداته من متغيرات البيئة. تسرد صفحة التخزين والنسخ الاحتياطي والحدود كل واحد منها.

على جهاز Linux تتولى رعايته بنفسك، يهيّئ المثبِّت كل شيء ولا يسأل إلا عمّا يحتاج معرفته.

ما يفعله المثبّتيشغّل المثبّت ست خطوات بالترتيب. يتحقق من أن الجهاز يعمل بنظام Linux على x86-64 أو ARM وأن المنفذين 80 و443 متاحان. ويثبّت Docker إن لم يكن موجودًا، بعد أن يسألك. وينزّل ملفات الإصدار ويتحقق من كل ملف مقابل SHA256SUMS. ويسأل عن النطاق واسم الخادم وطريقة تسجيل دخول الأشخاص، وعن البريد الإلكتروني اختياريًا. ثم يكتب الإعدادات في .env ويبدأ الخادم مع Caddy في /opt/oleafly-server. وعندما يستجيب الخادم عبر HTTPS، يطبع رمز الإعداد للمسؤول الأول.فحص الجهازLinux على x86-64 أو ARMالمنفذان 80 و443 متاحانDockerيُثبَّت إن لم يكن موجودًا،بعد سؤالكتنزيل وتحققملفات الإصدار،تُفحص عبر SHA256SUMSبعض الأسئلةالنطاق، اسم الخادم،تسجيل الدخول، البريد الإلكترونيتشغيلالخادم وCaddyفي /opt/oleafly-serverرمز الإعداديُطبع بمجرد أنيستجيب الخادمما يفعله المثبّتيشغّل المثبّت ست خطوات بالترتيب. يتحقق من أن الجهاز يعمل بنظام Linux على x86-64 أو ARM وأن المنفذين 80 و443 متاحان. ويثبّت Docker إن لم يكن موجودًا، بعد أن يسألك. وينزّل ملفات الإصدار ويتحقق من كل ملف مقابل SHA256SUMS. ويسأل عن النطاق واسم الخادم وطريقة تسجيل دخول الأشخاص، وعن البريد الإلكتروني اختياريًا. ثم يكتب الإعدادات في .env ويبدأ الخادم مع Caddy في /opt/oleafly-server. وعندما يستجيب الخادم عبر HTTPS، يطبع رمز الإعداد للمسؤول الأول.فحص الجهازLinux على x86-64 أو ARMالمنفذان 80 و443 متاحانDockerيُثبَّت إن لم يكن موجودًا،بعد سؤالكتنزيل وتحققملفات الإصدار،تُفحص عبر SHA256SUMSبعض الأسئلةالنطاق، اسم الخادم،تسجيل الدخول، البريد الإلكترونيتشغيلالخادم وCaddyفي /opt/oleafly-serverرمز الإعداديُطبع بمجرد أنيستجيب الخادم
أمر واحد: فحص، وDocker، وتنزيل وتحقق، وبعض الأسئلة، وتشغيل، ثم رمز الإعداد.

قبل تشغيله، تحقق مما يلي:

  • يعمل الجهاز بنظام Linux على x86-64 أو ARM، مثل Ubuntu 24.04 أو Debian 13، ويمكنك استخدام sudo عليه.
  • لا شيء آخر على الجهاز يستخدم المنفذين 80 و 443. افتح منفذَي TCP 80 و 443 ومنفذ UDP 443 في أي جدار حماية أمامه.
  • يشير سجل DNS لنطاقك إلى الجهاز. إن لم يكن كذلك بعد، يكتمل التثبيت على أي حال، ويواصل Caddy محاولة الحصول على شهادة حتى يوضع السجل.
  • لديك تفاصيل مزوّد تسجيل دخول واحد على الأقل، مثل معرّف عميل تطبيق GitHub OAuth وسره. في GitHub، عنوان رد الاتصال هو https:// يليه نطاقك، متبوعًا بـ /auth/callback/github.

ثم شغّل:

نافذة المحطة الطرفية
curl -fsSL https://oleafly.com/server/install.sh | sudo sh

يقوم المثبِّت بما يلي:

  1. يفحص الجهاز، ويتأكد من أن المنفذين 80 و 443 فارغان.
  2. يتحقق من وجود Docker. إن كان مفقودًا، يسأل المثبِّت قبل تثبيته بالسكربت الرسمي من Docker.
  3. ينزّل ملفات أحدث إصدار من إصدارات Oleafly Server (يفتح في علامة تبويب جديدة) ويتحقق من كل ملف مقابل ملف SHA256SUMS الخاص بالإصدار. إذا لم يطابق أحد الملفات، يتوقف دون تغيير أي شيء.
  4. يسأل عن نطاقك، واسم الخادم، وكيفية تسجيل الناس للدخول. كما يعرض إعداد البريد الإلكتروني والاحتفاظ بالملفات في حاوية S3. كلاهما اختياري.
  5. يعرض ملخصًا ويسأل قبل تغيير أي شيء. ثم يكتب ملفاته إلى /opt/oleafly-server، مع إعداداتك في .env الذي لا يستطيع قراءته إلا الجذر (root).
  6. يشغّل الخادم مع Caddy أمامه، وينتظر حتى يجيب نطاقك عبر HTTPS، ثم يطبع العنوان ورمز الإعداد.

ثم كن أول مسؤول.

يمكنك تشغيل المثبِّت مجددًا في أي وقت. عندما يجد خادمًا في /opt/oleafly-server، يُبقي .env كما هو، ويعيد وضع بقية الملفات، ويعيد تشغيل الخادم. ذلك يصلح معظم الإعدادات المعطوبة.

تتواجد بياناتك في وحدة تخزين Docker باسم oleafly-server_oleafly-data. للتثبيت في مكان غير /opt/oleafly-server، اضبط OLEAFLY_DIR، مثلًا curl -fsSL https://oleafly.com/server/install.sh | sudo OLEAFLY_DIR=/srv/oleafly sh، واستخدم ذلك المجلد في الأوامر أدناه.

إذا كانت مؤسستك لا تسمح بتمرير سكربت إلى الصدفة (shell)، فنزّل install.sh و SHA256SUMS من أحدث إصدار (يفتح في علامة تبويب جديدة) إلى مجلد واحد. تحقق من السكربت واقرأه ثم شغّله:

نافذة المحطة الطرفية
sha256sum --check --ignore-missing SHA256SUMS
sudo sh install.sh

لاستخدامه مع سكربت أو أداة تهيئة (provisioning)، أضف --yes ومرِّر الإجابات كمتغيرات بيئة. يتيح OLEAFLY_INSTALL_DOCKER=yes للمثبِّت إضافة Docker إذا كان مفقودًا.

نافذة المحطة الطرفية
curl -fsSL https://oleafly.com/server/install.sh | sudo \
OLEAFLY_DOMAIN=collab.example.org \
OLEAFLY_SERVER_NAME='Smith Lab' \
OLEAFLY_GITHUB_CLIENT_ID=Ov23liExampleClientId \
OLEAFLY_GITHUB_CLIENT_SECRET=example-client-secret \
OLEAFLY_INSTALL_DOCKER=yes \
sh -s -- --yes

يستخدم المثبِّت أي إعداد يجده في البيئة دون سؤال، سواء مع --yes أو بدونه. يسرد الأمر sudo sh /opt/oleafly-server/install.sh --help جميعها، بما في ذلك OpenID Connect والبريد الإلكتروني و S3. القيم المكتوبة في سطر الأوامر قد تنتهي في سجل تاريخ الصدفة، لذا ينبغي لأداة التهيئة أن تمرر الأسرار من مخزن الأسرار الخاص بها.

  • الحالة: يعرض sudo sh /opt/oleafly-server/install.sh status ما إذا كان الخادم يعمل، وما إذا كان نطاقك يجيب عبر HTTPS بشهادة صالحة.

  • التحديث: اعمل نسخة احتياطية أولًا كما يشرح قسم التحديث. ثم شغّل الأمر أدناه. ينزّل ملفات أحدث إصدار وصورته، ويُبقي .env، ويعيد تشغيل الخادم، وينتظر حتى يجيب. يُعاد اتصال المتصلين تلقائيًا. لا ينقل المثبِّت الخادم أبدًا إلى إصدار أقدم.

    نافذة المحطة الطرفية
    curl -fsSL https://oleafly.com/server/install.sh | sudo sh -s -- update
  • إلغاء التثبيت: يوقف sudo sh /opt/oleafly-server/install.sh uninstall الحاويات ويزيلها. تبقى بياناتك وملف .env ما لم تكتب delete عندما يطلب منك ذلك. حذفها يزيل كل مشروع مشترك على الخادم، وكل حساب، وسجل الأمان. يحتفظ الناس بنسخهم الخاصة من المشاريع على حواسيبهم.

إذا توقف المثبِّت عند مشكلة لا يمكنك إصلاحها، أبلغ عنها (يفتح في علامة تبويب جديدة) مع ما طبعه.

يشغّل هذا الإعداد حاويتين. oleafly-server هو الخادم، ولا تستطيع الوصول إليه إلا الحاويات الأخرى. تحصل caddy على شهادة من Let’s Encrypt، وتقدّم HTTPS على المنفذين 80 و 443، وتمرر الطلبات إلى الخادم، بما في ذلك الاتصالات المباشرة.

النشر باستخدام Docker Composeيتصل Oleafly على كل حاسوب عبر HTTPS بـ Caddy على جهازك. يحتفظ Caddy بالشهادة ويمرّر الطلبات عبر HTTP العادي إلى حاوية oleafly-server. ويحتفظ الخادم بقاعدة بياناته وملفاته في وحدة تخزين Docker، ويمكنه الاحتفاظ بالملفات في حاوية تخزين S3 بدلًا من ذلك.جهازك، باستخدام Docker ComposeOleaflyعلى كلحاسوبCaddyHTTPSشهادةoleafly-serverالإعدادات في .envوحدة تخزين البياناتقاعدة البيانات،الملفاتحاوية تخزين S3اختياريالنشر باستخدام Docker Composeيتصل Oleafly على كل حاسوب عبر HTTPS بـ Caddy على جهازك. يحتفظ Caddy بالشهادة ويمرّر الطلبات عبر HTTP العادي إلى حاوية oleafly-server. ويحتفظ الخادم بقاعدة بياناته وملفاته في وحدة تخزين Docker، ويمكنه الاحتفاظ بالملفات في حاوية تخزين S3 بدلًا من ذلك.جهازك، باستخدام Docker ComposeOleaflyعلى كل حاسوبCaddyشهادة HTTPSoleafly-serverالإعدادات في .envوحدة تخزين البياناتقاعدة البيانات، الملفاتحاوية تخزين S3اختياري، الملفاتHTTPSHTTP
Docker Compose: يتولى Caddy أمر HTTPS أمام الخادم، وتحتفظ وحدة تخزين البيانات بقاعدة البيانات والملفات.
  1. ثبِّت Docker Engine وإضافة Compose باتباع تعليمات Docker (يفتح في علامة تبويب جديدة).

  2. وجّه سجل DNS لنطاقك إلى الجهاز. افتح منفذَي TCP 80 و 443 ومنفذ UDP 443 في أي جدار حماية أمامه. يحتاج Caddy إلى المنفذ 80 للحصول على الشهادة.

  3. أنشئ مجلدًا للخادم، ونزّل إليه ملفات أحدث إصدار، وتحقق منها، وأنشئ ملف إعداداتك:

    نافذة المحطة الطرفية
    sudo mkdir -p /opt/oleafly-server && cd /opt/oleafly-server
    base=https://github.com/Oleafly/oleafly-server/releases/latest/download
    for f in docker-compose.yml Caddyfile env.example litestream.yml SHA256SUMS; do sudo curl -fsSLO "$base/$f"; done
    sha256sum --check --ignore-missing SHA256SUMS
    sudo install -m 600 env.example .env
  4. حرّر .env باستخدام sudoedit .env. اضبط OLEAFLY_DOMAIN على نطاقك دون https://، واضبط OLEAFLY_SERVER_NAME، واملأ مزوّد تسجيل دخول واحدًا على الأقل. اترك أسطر المزودين الذين لا تستخدمها فارغة. ضع القيمة بين علامتي اقتباس مفردتين إذا كانت تحتوي على $ أو #.

  5. شغّله. عند أول تشغيل، تُنزَّل صورة الخادم ghcr.io/oleafly/oleafly-server بالإصدار الخاص بهذا الإصدار.

    نافذة المحطة الطرفية
    sudo docker compose up -d
  6. تحقق من أنه يجيب. يطبع هذا الأمر 200:

    نافذة المحطة الطرفية
    curl -sS -o /dev/null -w '%{http_code}\n' https://collab.example.org/healthz
  7. كن أول مسؤول. رمز الإعداد موجود في السجل:

    نافذة المحطة الطرفية
    sudo docker compose logs oleafly-server | grep 'Setup code'

تتواجد بياناتك في وحدة تخزين Docker باسم oleafly-server_oleafly-data. ويحتفظ Caddy بشهاداته في oleafly-server_caddy-data.

يفتح Docker المنفذين 80 و 443 بنفسه، حتى عندما يكون جدار حماية المضيف مثل ufw مفعّلًا. هذا ما يحتاجه Caddy. لا تضف مدخل ports: إلى خدمة oleafly-server. للوصول إلى الخادم من الجهاز نفسه، انشره بالصيغة 127.0.0.1:8080:8080 حتى يبقى بعيدًا عن الشبكة.

إذا غيّرت Caddyfile، فشغّل sudo docker compose up -d --force-recreate caddy. للتحديث لاحقًا، نزّل ملفات الإصدار الجديد بالطريقة نفسها وشغّل sudo docker compose up -d مجددًا.

يمكن لسبعة إعدادات أن تحمل أسرارًا: OLEAFLY_SETUP_CODE، وOLEAFLY_GITHUB_CLIENT_SECRET، وOLEAFLY_OIDC_<NAME>_CLIENT_SECRET، وOLEAFLY_SMTP_URL، وOLEAFLY_BLOB_STORE، وOLEAFLY_S3_ACCESS_KEY_ID، وOLEAFLY_S3_SECRET_ACCESS_KEY. لكل منها أيضًا نسخة تنتهي بـ _FILE تحدد ملفًا يحمل القيمة. اضبط أحدهما لا كليهما.

مثلًا، لتمرير سر عميل GitHub باعتباره سر Docker، احفظه في secrets/github_client_secret بجوار docker-compose.yml، واسمح لمستخدم الخادم (المعرّف 10001) بقراءته، واحذف سطر OLEAFLY_GITHUB_CLIENT_SECRET من .env:

نافذة المحطة الطرفية
sudo chown 10001:10001 secrets/github_client_secret
sudo chmod 400 secrets/github_client_secret

ثم أنشئ docker-compose.override.yml بجوار docker-compose.yml. يقرأه Compose تلقائيًا، ويتركه المثبِّت وشأنه عند تحديث الملفات الأخرى.

services:
oleafly-server:
environment:
OLEAFLY_GITHUB_CLIENT_SECRET_FILE: /run/secrets/github_client_secret
secrets:
- github_client_secret
secrets:
github_client_secret:
file: ./secrets/github_client_secret

شغّل sudo docker compose up -d مجددًا.

يضع Coolify وكيله العكسي الخاص أمام الخادم ويحصل على الشهادة، لذا لا يوجد Caddy في هذا الإعداد. يستطيع Coolify بناء الخادم من مستودع Oleafly، أو تشغيل الصورة المنشورة، وهو ما يتجاوز البناء.

النشر على Coolifyيتصل Oleafly على كل حاسوب، عبر Cloudflare اختياريًا، بالخادم الوكيل في Coolify، الذي يتولى HTTPS ويمرّر الطلبات إلى oleafly-server. ويحتفظ الخادم ببياناته في وحدة تخزين Docker. وعندما يقف Cloudflare أمام الخادم الوكيل في Coolify، يمر كل طلب عبر خادمين وكيلين، لذا اضبط OLEAFLY_PROXY_HOPS على 2.Oleaflyعلى كلحاسوبCloudflareاختياريالخادم الوكيل في CoolifyHTTPSoleafly-serverعلى خادم Coolifyالخاص بكوحدة تخزين البياناتعند وجود كليهما في المقدمة، اضبطOLEAFLY_PROXY_HOPS=2النشر على Coolifyيتصل Oleafly على كل حاسوب، عبر Cloudflare اختياريًا، بالخادم الوكيل في Coolify، الذي يتولى HTTPS ويمرّر الطلبات إلى oleafly-server. ويحتفظ الخادم ببياناته في وحدة تخزين Docker. وعندما يقف Cloudflare أمام الخادم الوكيل في Coolify، يمر كل طلب عبر خادمين وكيلين، لذا اضبط OLEAFLY_PROXY_HOPS على 2.Oleaflyعلى كل حاسوبCloudflareاختياريالخادم الوكيل في CoolifyHTTPSoleafly-serverعلى خادم Coolify الخاص بكوحدة تخزين البياناتعند وجود كليهما في المقدمة، اضبطOLEAFLY_PROXY_HOPS=2
Coolify: يتولى الخادم الوكيل لديه أمر HTTPS. وعند وجود Cloudflare في المقدمة أيضًا، اضبط OLEAFLY_PROXY_HOPS=2.

قبل أن تبدأ، وجّه سجل DNS لنطاقك، مثل collab.example.org، إلى خادم Coolify. ثم أنشئ تطبيق GitHub OAuth كما هو موصوف تحت GitHub، مع عنوان رد الاتصال https://collab.example.org/auth/callback/github. احتفظ بمعرّف العميل والسر في متناول يدك.

  1. في مشروعك على Coolify، اختر + New ثم Public Repository، وأدخل https://github.com/Oleafly/Oleafly. أبقِ الفرع main.
  2. اضبط Build Pack على Docker Compose، وBase Directory على /، وDocker Compose Location على /deploy/server/docker-compose.coolify.yml، ثم اختر Continue.
  3. ضمن Advanced › Build، اضبط Build arguments على Managed manually in Dockerfile. لا تحتاج صورة الخادم إلى وسائط بناء. إذا تُرك الإعداد على الوضع التلقائي، كتب Coolify كل متغير، بما في ذلك الأسرار، في سجل بناء الصورة.
  4. ضمن General، اضبط نطاق oleafly-server على https://collab.example.org:8080 واحفظ. يخبر الجزء :8080 وكيل Coolify بالمنفذ الذي يستمع إليه الخادم. يبقى الناس متصلين عبر منفذ HTTPS المعتاد، ويضبط Coolify OLEAFLY_PUBLIC_URL على https://collab.example.org نيابة عنك.
  5. ضمن Environment Variables، املأ OLEAFLY_SERVER_NAME الذي يعلّمه Coolify بأنه مطلوب، ثم OLEAFLY_GITHUB_CLIENT_ID وOLEAFLY_GITHUB_CLIENT_SECRET. اترك المتغيرات التي لا تستخدمها فارغة.
  6. اختر Deploy. البناء الأول يجمع الخادم برمجيًا ويستغرق بضع دقائق. عند انتهائه، يعرض Coolify المورد بأنه يعمل وسليم.
  7. افتح https://collab.example.org/healthz في متصفح. يعرض {"status":"ok"}.
  8. افتح Logs، واختر حاوية oleafly-server، وانسخ الرمز من أحدث سطر يبدأ بـ Setup code:.
  9. كن أول مسؤول بهذا الرمز.

إذا لم يبدأ الخادم، فإن سجله يذكر اسم الإعداد الذي لا يستطيع استخدامه. عندما يقول إن OLEAFLY_PUBLIC_URL غير مضبوط، فالخطوة 4 ناقصة. يُرفض النطاق الذي يبدأ بـ http://، لأن الخادم يحتاج إلى HTTPS.

إذا كان Cloudflare أمام Coolify، لأن سجل DNS الخاص بك يمر عبر وكيل Cloudflare أو لأن نفقًا يقود إلى وكيل Coolify، فاضبط OLEAFLY_PROXY_HOPS على 2. بدونه، يعرض سجل الأمان عنوان الوكيل للجميع، ويتشارك الجميع حدًا واحدًا لتسجيل الدخول.

يتسع ملف Coolify لـ GitHub ولمزوّد OpenID Connect واحد باسم UNIVERSITY. اضبط OLEAFLY_OIDC_UNIVERSITY_LABEL على النص الذي ينبغي للناس رؤيته، مثل GitLab. ينتهي عنوان رد الاتصال الخاص به بـ /auth/callback/university. لمزيد من المزودين، انشر من نسخة مشتقة (fork) بملفك الخاص من هذا الملف.

تتواجد البيانات في وحدة تخزين Docker ينتهي اسمها بـ oleafly-data. اعثر عليها بـ docker volume ls --filter name=oleafly-data. لا تحتوي الصورة على صدفة، لذا لا يستطيع Terminal في Coolify فتح واحدة في حاوية الخادم. تعمل السجلات وفحص الصحة كالمعتاد.

تشغيل الصورة المنشورة يتجاوز البناء، وهو ما يناسب خادم Coolify صغيرًا. اتبع الخطوات أعلاه مع تغييرين. في الخطوة 2، اضبط Docker Compose Location على /deploy/server/docker-compose.coolify-image.yml. وتخطَّ الخطوة 3، لأنه لا يُبنى فيها شيء. يتبع الملف سلسلة إصدارات واحدة، لذا يسحب كل Redeploy أحدث إصدار ضمنها.

يقرأ النشر إلى Render (يفتح في علامة تبويب جديدة) ملف Blueprint الموجود في مستودع Oleafly. ينشئ خدمة ويب واحدة من الصورة المنشورة، مع قرص بسعة 1 GB لمجلد البيانات. يرفق Render الأقراص بأنواع المثيلات المدفوعة فقط، لذا تبدأ الخدمة على أصغر نوع مدفوع، في منطقة Oregon لدى Render. لمنطقة أخرى، انشر من نسخة مشتقة مع ضبط region في render.yaml.

  1. افتح الرابط وسجّل الدخول إلى Render.
  2. يطلب Render OLEAFLY_SERVER_NAME ومعرّف عميل GitHub وسره. املأ الاسم واترك حقول GitHub فارغة الآن. يعتمد عنوان رد الاتصال على عنوان الخدمة، الذي لا تملكه بعد.
  3. اختر Deploy Blueprint. عندما تصبح الخدمة نشطة، تعرض صفحتها عنوانها، مثل https://oleafly-server.onrender.com. يضبط ملف Blueprint القيمة OLEAFLY_PUBLIC_URL على ذلك العنوان.
  4. أنشئ تطبيق GitHub OAuth كما هو موصوف تحت GitHub، مع ذلك العنوان متبوعًا بـ /auth/callback/github عنوانًا لرد الاتصال. أضف معرّف العميل والسر ضمن Environment الخاصة بالخدمة. يعيد Render تشغيل الخادم بهما.
  5. اعثر على أحدث سطر Setup code: في Logs الخاصة بالخدمة وكن أول مسؤول.

إذا أعطيت الخدمة نطاقك الخاص، فاضبط OLEAFLY_PUBLIC_URL عليه ضمن Environment، وغيّر عنوان رد الاتصال في GitHub ليطابقه.

بسبب القرص، يوقف Render الخادم العامل قبل أن يبدأ الجديد، لذا يجعل كل نشر الخادم غير متاح لبضع ثوانٍ. يعيد Oleafly الاتصال من تلقاء نفسه.

يشغّل Railway الصورة المنشورة، مع وحدة تخزين لمجلد البيانات.

  1. في مشروع على Railway، اختر + New ثم Docker Image، وأدخل ghcr.io/oleafly/oleafly-server:latest. لاختيار وقت الترقية بنفسك، استخدم بدلًا من ذلك وسم الإصدار المعني من صفحة الإصدارات (يفتح في علامة تبويب جديدة). قد يبدأ Railway أول نشر فورًا. يتوقف مع الرسالة OLEAFLY_PUBLIC_URL is not set، وهذا متوقع في هذه المرحلة.

  2. افتح الخدمة. ضمن Settings › Networking، اختر Generate Domain وأدخل المنفذ 8080. يعرض Railway العنوان، مثل oleafly-server-production.up.railway.app.

  3. ضمن Settings › Deploy، اضبط Healthcheck Path على /readyz.

  4. انقر بزر الفأرة الأيمن على لوحة المشروع، وأضف وحدة تخزين، وأرفقها بخدمة الخادم، واضبط مسار التحميل فيها على /data.

  5. ضمن Variables، افتح Raw Editor والصق هذه الأسطر باسم الخادم الخاص بك. لقيم GitHub، اتبع GitHub. عنوان رد الاتصال هو عنوانك من الخطوة 2 مع https:// قبله و/auth/callback/github بعده.

    OLEAFLY_PUBLIC_URL=https://${{RAILWAY_PUBLIC_DOMAIN}}
    OLEAFLY_BIND=0.0.0.0:8080
    OLEAFLY_DATA_DIR=/data
    OLEAFLY_BEHIND_PROXY=true
    OLEAFLY_SERVER_NAME=Smith Lab
    OLEAFLY_GITHUB_CLIENT_ID=Ov23liExampleClientId
    OLEAFLY_GITHUB_CLIENT_SECRET=example-client-secret
    PORT=8080
    RAILWAY_RUN_UID=0

    يحمّل Railway وحدات التخزين بصلاحية الجذر. يشغّل RAILWAY_RUN_UID=0 الخادم جذرًا ليتمكن من الكتابة إلى وحدة التخزين.

  6. انشر التغييرات. اعثر على أحدث سطر Setup code: في Deploy Logs الخاصة بالخدمة وكن أول مسؤول.

على جهاز لا يوجد فيه Docker، يعمل الخادم كبرنامج واحد تحت systemd، مع Caddy أمامه لتوفير HTTPS.

النشر على Linux دون Dockerيتصل Oleafly على كل حاسوب عبر HTTPS بـ Caddy على جهاز Linux الخاص بك. يمرّر Caddy الطلبات إلى oleafly-server، الذي يعمل كخدمة systemd تستمع على 127.0.0.1 عند المنفذ 8080 ويحتفظ ببياناته في /var/lib/oleafly-server.جهاز Linux الخاص بكOleaflyعلى كلحاسوبCaddyHTTPSشهادةoleafly-serverخدمة systemdمجلد البيانات/var/lib/oleafly-serverالنشر على Linux دون Dockerيتصل Oleafly على كل حاسوب عبر HTTPS بـ Caddy على جهاز Linux الخاص بك. يمرّر Caddy الطلبات إلى oleafly-server، الذي يعمل كخدمة systemd تستمع على 127.0.0.1 عند المنفذ 8080 ويحتفظ ببياناته في /var/lib/oleafly-server.جهاز Linux الخاص بكOleaflyعلى كل حاسوبCaddyشهادة HTTPSoleafly-serverخدمة systemdمجلد البيانات/var/lib/oleafly-serverHTTPSHTTP
Linux دون Docker: تشغّل systemd الخادم، ويتولى Caddy في المقدمة أمر HTTPS.

لكل إصدار من إصدارات الخادم في صفحة الإصدارات (يفتح في علامة تبويب جديدة) برنامج جاهز البناء لمعمارية x86-64 وآخر لمعمارية ARM، وملف SHA256SUMS للتحقق منه. لا يحتاج البرنامج إلى تثبيت أي شيء آخر.

نزّل الأرشيف الخاص بجهازك، الذي ينتهي بـ x86_64-unknown-linux-musl.tar.gz أو aarch64-unknown-linux-musl.tar.gz، مع SHA256SUMS إلى مجلد واحد. ثم تحقق منه وثبّته. على جهاز ARM، استخدم aarch64 بدلًا من x86_64:

نافذة المحطة الطرفية
sha256sum --check --ignore-missing SHA256SUMS
tar -xzf oleafly-server-*-x86_64-unknown-linux-musl.tar.gz
sudo install -m 0755 oleafly-server-*-x86_64-unknown-linux-musl/oleafly-server /usr/local/bin/oleafly-server
oleafly-server --version

مع تثبيت GitHub CLI، يتحقق الأمر gh attestation verify oleafly-server-*-x86_64-unknown-linux-musl.tar.gz --repo Oleafly/Oleafly أيضًا من أن GitHub بنى الأرشيف من مستودع Oleafly. يتضمن الأرشيف وحدة systemd، oleafly-server.service.

لبناء البرنامج بنفسك بدلًا من ذلك، شغّل هذا الأمر من نسخة مستنسخة من مستودع Oleafly على أي حاسوب فيه Docker. استخدم --platform linux/arm64 لخادم ARM.

نافذة المحطة الطرفية
docker buildx build --platform linux/amd64 --target binary --output type=local,dest=dist -f crates/oleafly-server/Dockerfile .

يكتب هذا الأمر dist/oleafly-server. انسخه إلى /usr/local/bin/oleafly-server على الخادم واجعله قابلًا للتنفيذ.

  1. أنشئ ملف الإعدادات. لا يستطيع قراءته إلا الجذر:

    نافذة المحطة الطرفية
    sudo install -d -m 0755 /etc/oleafly-server
    sudo install -m 0600 /dev/null /etc/oleafly-server/oleafly-server.env
    sudoedit /etc/oleafly-server/oleafly-server.env

    ضع إعدادًا واحدًا في كل سطر. يُبقي OLEAFLY_BIND=127.0.0.1:8080 الخادم بعيدًا عن الشبكة بحيث لا يصل إليه إلا Caddy. لا تضبط OLEAFLY_DATA_DIR، لأن الوحدة تضبطه.

    OLEAFLY_PUBLIC_URL=https://collab.example.org
    OLEAFLY_BIND=127.0.0.1:8080
    OLEAFLY_BEHIND_PROXY=true
    OLEAFLY_SERVER_NAME=Smith Lab
    OLEAFLY_GITHUB_CLIENT_ID=Ov23liExampleClientId
    OLEAFLY_GITHUB_CLIENT_SECRET=example-client-secret
  2. ثبّت الوحدة وابدأ تشغيلها من الأرشيف المستخرج، أو من deploy/server في نسخة مستنسخة من المستودع. ثم اعثر على رمز الإعداد:

    نافذة المحطة الطرفية
    sudo install -m 0644 oleafly-server.service /etc/systemd/system/oleafly-server.service
    sudo systemctl daemon-reload
    sudo systemctl enable --now oleafly-server
    sudo journalctl -u oleafly-server | grep 'Setup code'

تشغّل الوحدة الخادم بحساب مستخدم ينشئه systemd لها، مع إطلالة للقراءة فقط على بقية النظام. المكان الوحيد الذي يمكنه الكتابة فيه هو /var/lib/oleafly-server، حيث يحتفظ ببياناته. على القرص، هذا المجلد هو /var/lib/private/oleafly-server.

لإبقاء سر العميل خارج ملف الإعدادات، استخدم اعتمادية systemd. احفظ السر في /etc/oleafly-server/github-client-secret بصلاحية 600، واحذف سطر OLEAFLY_GITHUB_CLIENT_SECRET من ملف الإعدادات، وشغّل sudo systemctl edit oleafly-server، وأضف:

[Service]
LoadCredential=github-client-secret:/etc/oleafly-server/github-client-secret
Environment=OLEAFLY_GITHUB_CLIENT_SECRET_FILE=%d/github-client-secret

ثم شغّل sudo systemctl restart oleafly-server.

ثبّت Caddy وفق تعليماته الخاصة بتوزيعتك (يفتح في علامة تبويب جديدة). استبدل /etc/caddy/Caddyfile بهذه الأسطر وشغّل sudo systemctl reload caddy. يحصل Caddy على الشهادة ويمرر الاتصالات المباشرة.

collab.example.org {
reverse_proxy 127.0.0.1:8080
}

لأجل nginx أو Apache، أو خادم ويب تشغّله جامعتك بالفعل، اقرأ خلف وكيل عكسي.

إذا لم يكن للجهاز عنوان عام، مثل حاسوب في مختبرك خلف جدار حماية الجامعة، فيمكن لـ Cloudflare Tunnel أن يجعله قابلًا للوصول. تحتاج إلى حساب Cloudflare عليه نطاقك. يتولى Cloudflare بروتوكول HTTPS لاسم المضيف، لذا تُفك تشفير الطلبات على شبكة Cloudflare قبل وصولها إلى جهازك. احسب Cloudflare ضمن الأطراف التي يمكنها قراءة حركة المرور المتجهة إلى خادمك.

النشر عبر Cloudflare Tunnelيتصل Oleafly على كل حاسوب عبر HTTPS بـ Cloudflare. وتفتح حاوية cloudflared على جهازك نفقًا إلى Cloudflare، فلا يحتاج الجهاز إلى عنوان عام. تصل الطلبات عبر النفق إلى cloudflared، الذي يمرّرها إلى oleafly-server.جهازك، دون عنوان عامOleaflyعلى كلحاسوبCloudflareHTTPScloudflaredيفتح النفقoleafly-serverوحدة تخزين البياناتالنشر عبر Cloudflare Tunnelيتصل Oleafly على كل حاسوب عبر HTTPS بـ Cloudflare. وتفتح حاوية cloudflared على جهازك نفقًا إلى Cloudflare، فلا يحتاج الجهاز إلى عنوان عام. تصل الطلبات عبر النفق إلى cloudflared، الذي يمرّرها إلى oleafly-server.جهازك، دون عنوان عامOleaflyعلى كل حاسوبCloudflareHTTPScloudflaredيفتح النفقoleafly-serverوحدة تخزين البياناتالنفق
Cloudflare Tunnel: يفتح جهازك النفق بنفسه، فلا يحتاج إلى عنوان عام.
  1. اتبع خطوات Docker Compose يدويًا حتى الوصول إلى تحرير .env. اضبط OLEAFLY_DOMAIN على اسم المضيف الذي ستستخدمه، مثل collab.example.org. لا يناسب المثبِّت ذو الأمر الواحد هذه الحالة، لأنه يشغّل Caddy.

  2. شغّل الخادم فقط. لا حاجة إلى Caddy هنا:

    نافذة المحطة الطرفية
    sudo docker compose up -d oleafly-server
  3. في لوحة تحكم Cloudflare، انتقل إلى Networking › Tunnels، واختر Create Tunnel، وامنحه اسمًا، ثم اختر Create Tunnel مجددًا. انسخ الرمز من أمر التثبيت الذي تعرضه.

  4. شغّل النفق بجوار الخادم. ينتظر الأمر read منك لصق الرمز ولا يعرضه:

    نافذة المحطة الطرفية
    read -rs TUNNEL_TOKEN && export TUNNEL_TOKEN
    sudo --preserve-env=TUNNEL_TOKEN docker run -d --name oleafly-tunnel --restart unless-stopped --network oleafly-server_default -e TUNNEL_TOKEN cloudflare/cloudflared:2026.10.0 tunnel --no-autoupdate run
  5. عد إلى اللوحة، وافتح النفق. ضمن Routes، اختر Add route ثم Published application. ضمن Hostname، أدخل النطاق الفرعي واختر نطاقك. اضبط Service URL على http://oleafly-server:8080 ثم اختر Add route.

  6. تحقق من أنه يجيب على https://collab.example.org/healthz، ثم كن أول مسؤول.

على جهاز لا يوجد فيه Docker، ثبّت cloudflared من مستودع حزم Cloudflare (يفتح في علامة تبويب جديدة)، وشغّل sudo cloudflared service install متبوعًا بالرمز، واضبط Service URL على http://127.0.0.1:8080.

يمرر Cloudflare الاتصالات المباشرة ويضع عنوان الزائر في آخر X-Forwarded-For، لذا أبقِ OLEAFLY_BEHIND_PROXY=true. عندما يقود النفق إلى وكيل آخر، مثل وكيل Coolify، لا إلى الخادم مباشرة، فاضبط أيضًا OLEAFLY_PROXY_HOPS=2. يرفض Cloudflare الطلبات الأكبر من 100 MB في خطتي Free و Pro، لذا اضبط OLEAFLY_MAX_PROJECT_MB على 100 أو أقل، وإلا فشل تحميل المشاريع الكبيرة. لا تضع Cloudflare Access أمام الخادم، لأن Oleafly لا يستطيع تجاوز صفحة تسجيل الدخول الخاصة به.

عند تحديث الخادم لاحقًا، نزّل ملفات الإصدار الجديد وحدد الخدمة بالاسم حتى يبقى Caddy خارج التشغيل: sudo docker compose up -d oleafly-server.

الخادم الجديد لا مسؤول له. حتى يُتم شخص ما الإعداد، ينشئ الخادم رمز إعداد جديدًا أحادي الاستخدام في كل مرة يبدأ فيها، ويكتبه في سجله.

  1. اعثر في السجل على أحدث سطر يبدأ بـ Setup code::
    • التثبيت بأمر واحد: يطبع المثبِّت الرمز عند انتهائه. لرؤيته مجددًا، شغّل cd /opt/oleafly-server && sudo docker compose logs oleafly-server | grep 'Setup code'
    • Docker Compose يدويًا: sudo docker compose logs oleafly-server | grep 'Setup code' في مجلد الخادم
    • Coolify: سجلات خدمة oleafly-server
    • systemd: sudo journalctl -u oleafly-server | grep 'Setup code'
  2. في Oleafly، افتح Settings → Collaboration، واختر Add server، وأدخل عنوان خادمك. يرى Oleafly أن الخادم يحتاج إلى إعداد، فيطلب منك Setup code.
  3. أدخل الرمز وسجّل الدخول بأي مزوّد ضبطته. تصبح مسؤول الخادم، ويتوقف الرمز عن العمل.

أي شخص يحصل على الرمز قبل استخدامك له يمكنه جعل نفسه مسؤولًا، لذا لا تلصقه أبدًا إلا في Oleafly.

يمكنك أيضًا اختيار الرمز بنفسك عبر OLEAFLY_SETUP_CODE: 12 حرفًا أو رقمًا على الأقل، مع شرطات أو مسافات إن شئت. عندئذ لا يطبعه الخادم أبدًا. يقول السجل فقط Setup code: set by OLEAFLY_SETUP_CODE، وتُدخل أنت القيمة التي ضبطتها. أزله من إعداداتك متى اكتمل الإعداد.

الخطوة التالية هي إدخال الناس. تشرح صفحة تسجيل الدخول والوصول كيفية ذلك.

  • مع التثبيت بأمر واحد، يفحص sudo sh /opt/oleafly-server/install.sh status الحاويات و HTTPS دفعة واحدة.
  • يجيب https://collab.example.org/healthz بـ 200 طالما تعمل عملية الخادم.
  • لا يجيب /readyz بـ 200 إلا طالما يستطيع الخادم الكتابة إلى قاعدة بياناته ومجلد بياناته. عندما لا يستطيع، مثلًا عند امتلاء القرص، يجيب بـ 503 ويذكر ما الذي تعطل، database أو storage.
  • تفحص صورة Docker /readyz بنفسها، لذا يعرض docker ps و Coolify خادمًا غير سليم بدل خادم يعمل لكنه لا يستطيع حفظ أي شيء.
  • في Oleafly، يفحص Test connection ضمن Settings → Collaboration العنوان و HTTPS والإصدار والاتصالات المباشرة وخيارات تسجيل الدخول وساعة الخادم. وتشغّل Connection checks في وحدة تحكم المسؤول الفحوصات نفسها.
معاينة الصورة

تعذّر تحميل إجابات الذكاء الاصطناعي

حاول مرة أخرى، أو ابحث في الوثائق.