الانتقال إلى المحتوى الرئيسي

دليل تشغيل البوابة

استخدم هذه الصفحة للتشغيل في اليوم الأول والعمليات التشغيلية اللاحقة لخدمة البوابة.

استكشاف الأخطاء العميق

تشخيصات تبدأ من الأعراض مع سلاسل أوامر دقيقة وتواقيع السجلات.

الإعداد

دليل إعداد موجّه بالمهام + مرجع إعداد كامل.

إدارة الأسرار

عقد SecretRef، وسلوك لقطات وقت التشغيل، وعمليات الترحيل/إعادة التحميل.

عقد خطة الأسرار

قواعد secrets apply الدقيقة الخاصة بالهدف/المسار وسلوك ملف تعريف المصادقة المعتمد على المراجع فقط.

تشغيل محلي خلال 5 دقائق

1

ابدأ البوابة

openclaw gateway --port 18789
# عكس debug/trace إلى stdio
openclaw gateway --port 18789 --verbose
# اقتل المستمع على المنفذ المحدد بالقوة، ثم ابدأ
openclaw gateway --force
2

تحقق من سلامة الخدمة

openclaw gateway status
openclaw status
openclaw logs --follow
الخط الأساسي السليم: Runtime: running وRPC probe: ok.
3

تحقق من جاهزية القناة

openclaw channels status --probe
مع بوابة يمكن الوصول إليها، يُشغّل هذا فحوصات قنوات مباشرة لكل حساب وتدقيقات اختيارية. أما إذا تعذر الوصول إلى البوابة، فيعود CLI إلى ملخصات قنوات معتمدة على الإعداد فقط بدلًا من إخراج الفحص المباشر.
تراقب إعادة تحميل إعداد البوابة مسار ملف الإعداد النشط (المحلول من القيم الافتراضية للملف الشخصي/الحالة، أو OPENCLAW_CONFIG_PATH عند ضبطه). الوضع الافتراضي هو gateway.reload.mode="hybrid". بعد أول تحميل ناجح، تخدم العملية الجارية لقطة الإعداد النشطة داخل الذاكرة؛ وتستبدل إعادة التحميل الناجحة تلك اللقطة بشكل ذري.

نموذج وقت التشغيل

  • عملية واحدة دائمة التفعيل للتوجيه، ومستوى التحكم، واتصالات القنوات.
  • منفذ واحد متعدد الإرسال من أجل:
    • التحكم/RPC عبر WebSocket
    • HTTP APIs، متوافقة مع OpenAI (/v1/models, /v1/embeddings, /v1/chat/completions, /v1/responses, /tools/invoke)
    • واجهة المستخدم الخاصة بالتحكم والخطافات
  • وضع الربط الافتراضي: loopback.
  • المصادقة مطلوبة افتراضيًا. وتستخدم إعدادات السر المشترك gateway.auth.token / gateway.auth.password (أو OPENCLAW_GATEWAY_TOKEN / OPENCLAW_GATEWAY_PASSWORD)، ويمكن لإعدادات reverse-proxy غير المعتمدة على loopback استخدام gateway.auth.mode: "trusted-proxy".

نقاط النهاية المتوافقة مع OpenAI

أصبح سطح التوافق الأعلى فائدة في OpenClaw الآن:
  • GET /v1/models
  • GET /v1/models/{id}
  • POST /v1/embeddings
  • POST /v1/chat/completions
  • POST /v1/responses
لماذا تهم هذه المجموعة:
  • تبدأ معظم تكاملات Open WebUI وLobeChat وLibreChat بالفحص عبر /v1/models.
  • تتوقع كثير من خطوط RAG والذاكرة وجود /v1/embeddings.
  • يفضّل العملاء الأصليون للوكلاء بشكل متزايد /v1/responses.
ملاحظة تخطيطية:
  • الأمر /v1/models موجه للوكلاء أولًا: فهو يعيد openclaw وopenclaw/default وopenclaw/<agentId>.
  • openclaw/default هو الاسم المستعار الثابت الذي يرتبط دائمًا بالوكيل الافتراضي المُعد.
  • استخدم x-openclaw-model عندما تريد تجاوز موفّر/نموذج الخلفية؛ وإلا يظل إعداد النموذج والتضمين العادي الخاص بالوكيل المحدد هو المتحكم.
تعمل جميع هذه النقاط على منفذ البوابة الرئيسي نفسه وتستخدم حد مصادقة المشغّل الموثوق نفسه المستخدم في بقية Gateway HTTP API.

أسبقية المنفذ ووضع الربط

الإعدادترتيب التحليل
منفذ البوابة--portOPENCLAW_GATEWAY_PORTgateway.port18789
وضع الربطCLI/التجاوز ← gateway.bindloopback

أوضاع إعادة التحميل السريع

gateway.reload.modeالسلوك
offلا توجد إعادة تحميل للإعداد
hotتطبيق التغييرات الآمنة للسخونة فقط
restartإعادة تشغيل عند التغييرات التي تتطلب إعادة تحميل
hybrid (الافتراضي)تطبيق سريع عندما يكون آمنًا، وإعادة تشغيل عند الحاجة

مجموعة أوامر المشغّل

openclaw gateway status
openclaw gateway status --deep   # يضيف فحص خدمة على مستوى النظام
openclaw gateway status --json
openclaw gateway install
openclaw gateway restart
openclaw gateway stop
openclaw secrets reload
openclaw logs --follow
openclaw doctor
إن gateway status --deep مخصص لاكتشاف الخدمات الإضافية (LaunchDaemons/وحدات systemd على مستوى النظام/schtasks)، وليس فحص RPC أعمق لسلامة النظام.

بوابات متعددة (على المضيف نفسه)

ينبغي أن يشغّل معظم التثبيتات بوابة واحدة لكل جهاز. ويمكن لبوابة واحدة أن تستضيف عدة وكلاء وقنوات. أنت تحتاج إلى عدة بوابات فقط عندما تريد عمدًا العزل أو بوت إنقاذ. فحوصات مفيدة:
openclaw gateway status --deep
openclaw gateway probe
ما الذي يجب توقعه:
  • يمكن أن يعرض gateway status --deep الرسالة Other gateway-like services detected (best effort) ويطبع تلميحات تنظيف عندما تكون تثبيتات launchd/systemd/schtasks القديمة لا تزال موجودة.
  • يمكن أن يحذّر gateway probe من multiple reachable gateways عندما يجيب أكثر من هدف واحد.
  • إذا كان ذلك مقصودًا، فاعزل المنافذ، والإعداد/الحالة، وجذور مساحة العمل لكل بوابة.
الإعداد المفصل: /gateway/multiple-gateways.

الوصول البعيد

المفضل: Tailscale/VPN. البديل: نفق SSH.
ssh -N -L 18789:127.0.0.1:18789 user@host
ثم صِل العملاء بـ ws://127.0.0.1:18789 محليًا.
لا تتجاوز أنفاق SSH مصادقة البوابة. ففي إعدادات السر المشترك، لا يزال يتعين على العملاء إرسال token/password حتى عبر النفق. أما في الأوضاع المعتمدة على الهوية، فيجب أن يستوفي الطلب أيضًا مسار المصادقة ذاك.
راجع: البوابة البعيدة، المصادقة، Tailscale.

الإشراف ودورة حياة الخدمة

استخدم التشغيل تحت إشراف من أجل موثوقية تشبه الإنتاج.
openclaw gateway install
openclaw gateway status
openclaw gateway restart
openclaw gateway stop
تكون تسميات LaunchAgent هي ai.openclaw.gateway (الافتراضي) أو ai.openclaw.<profile> (للملفات الشخصية المسماة). ويقوم openclaw doctor بتدقيق انحراف إعداد الخدمة وإصلاحه.

بوابات متعددة على مضيف واحد

يجب أن تشغّل معظم الإعدادات بوابة واحدة. استخدم عدة بوابات فقط من أجل العزل/الاعتمادية الصارمة (مثل ملف تعريف إنقاذ). قائمة التحقق لكل مثيل:
  • gateway.port فريد
  • OPENCLAW_CONFIG_PATH فريد
  • OPENCLAW_STATE_DIR فريد
  • agents.defaults.workspace فريد
مثال:
OPENCLAW_CONFIG_PATH=~/.openclaw/a.json OPENCLAW_STATE_DIR=~/.openclaw-a openclaw gateway --port 19001
OPENCLAW_CONFIG_PATH=~/.openclaw/b.json OPENCLAW_STATE_DIR=~/.openclaw-b openclaw gateway --port 19002
راجع: بوابات متعددة.

المسار السريع لملف تعريف التطوير

openclaw --dev setup
openclaw --dev gateway --allow-unconfigured
openclaw --dev status
تتضمن القيم الافتراضية حالة/إعدادًا معزولين ومنفذ بوابة أساسي 19001.

مرجع البروتوكول السريع (منظور المشغّل)

  • يجب أن يكون أول إطار عميل هو connect.
  • تعيد البوابة لقطة hello-ok (presence, health, stateVersion, uptimeMs, limits/policy).
  • hello-ok.features.methods / events هي قائمة اكتشاف متحفظة، وليست تفريغًا مولدًا لكل مسار مساعد قابل للاستدعاء.
  • الطلبات: req(method, params)res(ok/payload|error).
  • تشمل الأحداث الشائعة connect.challenge وagent وchat و session.message وsession.tool وsessions.changed وpresence وtick و health وheartbeat وأحداث دورة حياة الاقتران/الموافقة وshutdown.
تشغيلات الوكيل ذات مرحلتين:
  1. إقرار فوري بالقبول (status:"accepted")
  2. استجابة نهائية عند الاكتمال (status:"ok"|"error")، مع تدفق أحداث agent بينهما.
راجع وثائق البروتوكول الكاملة: بروتوكول البوابة.

فحوصات تشغيلية

التوفر

  • افتح WS وأرسل connect.
  • توقّع استجابة hello-ok مع لقطة.

الجاهزية

openclaw gateway status
openclaw channels status --probe
openclaw health

استرداد الفجوات

لا تتم إعادة تشغيل الأحداث. وعند وجود فجوات في التسلسل، حدّث الحالة (health، system-presence) قبل المتابعة.

تواقيع الإخفاق الشائعة

التوقيعالمشكلة المحتملة
refusing to bind gateway ... without authربط غير loopback من دون مسار مصادقة صالح للبوابة
another gateway instance is already listening / EADDRINUSEتعارض منفذ
Gateway start blocked: set gateway.mode=localالإعداد مضبوط على الوضع البعيد، أو أن ختم الوضع المحلي مفقود من إعداد تالف
unauthorized during connectعدم تطابق المصادقة بين العميل والبوابة
للحصول على سلاسل التشخيص الكاملة، استخدم استكشاف أخطاء البوابة وإصلاحها.

ضمانات الأمان

  • يفشل عملاء بروتوكول البوابة بسرعة عندما تكون البوابة غير متاحة (ولا يوجد رجوع ضمني مباشر إلى القنوات).
  • يتم رفض وإغلاق الإطارات الأولى غير الصالحة/غير connect.
  • يصدر الإغلاق السلس الحدث shutdown قبل إغلاق المقبس.

ذو صلة: