Skip to main content

​
अवलोकन

  • एक दीर्घकालिक Gateway सभी मैसेजिंग माध्यमों का स्वामी होता है (Baileys के माध्यम से WhatsApp, grammY के माध्यम से Telegram, Slack, Discord, Signal, iMessage, WebChat)।
  • कंट्रोल-प्लेन क्लाइंट (macOS ऐप, CLI, वेब UI, ऑटोमेशन) कॉन्फ़िगर किए गए बाइंड होस्ट (डिफ़ॉल्ट 127.0.0.1:18789) पर WebSocket के माध्यम से Gateway से कनेक्ट होते हैं।
  • Nodes (macOS/iOS/Android/हेडलेस) भी WebSocket के माध्यम से कनेक्ट होते हैं, लेकिन स्पष्ट क्षमताओं/कमांड के साथ role: node घोषित करते हैं।
  • प्रति होस्ट एक Gateway होता है; केवल यही WhatsApp सत्र खोलता है।
  • कैनवास होस्ट को Gateway HTTP सर्वर द्वारा इसके अंतर्गत सर्व किया जाता है:
    • /__openclaw__/canvas/ (एजेंट द्वारा संपादन योग्य HTML/CSS/JS)
    • /__openclaw__/a2ui/ (A2UI होस्ट)
    यह Gateway वाले पोर्ट का ही उपयोग करता है (डिफ़ॉल्ट 18789)।

​
घटक और प्रवाह

​
Gateway (डेमन)

  • प्रोवाइडर कनेक्शन बनाए रखता है।
  • एक टाइप्ड WS API (अनुरोध, प्रतिक्रियाएँ, सर्वर-पुश इवेंट) उपलब्ध कराता है।
  • आने वाले फ़्रेम को JSON Schema के विरुद्ध सत्यापित करता है।
  • agent, chat, presence, health, heartbeat, cron जैसे इवेंट उत्सर्जित करता है।

​
क्लाइंट (Mac ऐप / CLI / वेब एडमिन)

  • प्रति क्लाइंट एक WS कनेक्शन।
  • अनुरोध भेजते हैं (health, status, send, agent, system-presence)।
  • इवेंट की सदस्यता लेते हैं (tick, agent, presence, shutdown)।

​
Nodes (macOS / iOS / Android / हेडलेस)

  • role: node के साथ उसी WS सर्वर से कनेक्ट होते हैं।
  • connect में डिवाइस पहचान प्रदान करते हैं; पेयरिंग डिवाइस-आधारित है (भूमिका node) और अनुमोदन डिवाइस पेयरिंग स्टोर में रहता है।
  • canvas.*, camera.*, screen.record, location.get जैसे कमांड उपलब्ध कराते हैं।
प्रोटोकॉल का विवरण: Gateway प्रोटोकॉल

​
WebChat

  • स्थिर UI, जो चैट इतिहास और संदेश भेजने के लिए Gateway WS API का उपयोग करता है।
  • रिमोट सेटअप में, अन्य क्लाइंट की तरह उसी SSH/Tailscale टनल के माध्यम से कनेक्ट होता है।

​
कनेक्शन जीवनचक्र (एकल क्लाइंट)

​
वायर प्रोटोकॉल (सारांश)

  • ट्रांसपोर्ट: WebSocket, JSON पेलोड वाले टेक्स्ट फ़्रेम।
  • पहला फ़्रेम connect होना अनिवार्य है।
  • हैंडशेक के बाद:
    • अनुरोध: {type:"req", id, method, params} → {type:"res", id, ok, payload|error}
    • इवेंट: {type:"event", event, payload, seq?, stateVersion?}
  • hello-ok.features.methods / events खोज संबंधी मेटाडेटा हैं, प्रत्येक कॉल किए जा सकने वाले हेल्पर रूट का जनरेट किया हुआ डंप नहीं।
  • साझा-सीक्रेट प्रमाणीकरण, कॉन्फ़िगर किए गए Gateway प्रमाणीकरण मोड के अनुसार, connect.params.auth.token या connect.params.auth.password का उपयोग करता है।
  • Tailscale Serve (gateway.auth.allowTailscale: true) या नॉन-लूपबैक gateway.auth.mode: "trusted-proxy" जैसे पहचान-युक्त मोड, connect.params.auth.* के बजाय अनुरोध हेडर से प्रमाणीकरण पूरा करते हैं।
  • प्राइवेट-इनग्रेस gateway.auth.mode: "none" साझा-सीक्रेट प्रमाणीकरण को पूरी तरह अक्षम कर देता है; सार्वजनिक/अविश्वसनीय इनग्रेस पर उस मोड को बंद रखें।
  • दुष्प्रभाव उत्पन्न करने वाली विधियों (send, agent) को सुरक्षित रूप से दोबारा आज़माने के लिए आइडेम्पोटेंसी कुंजियाँ आवश्यक हैं; सर्वर अल्पकालिक डीडुप कैश रखता है।
  • Nodes को connect में क्षमताओं/कमांड/अनुमतियों के साथ role: "node" शामिल करना अनिवार्य है।

​
पेयरिंग और स्थानीय विश्वास

  • सभी WS क्लाइंट (ऑपरेटर + Nodes) connect पर एक डिवाइस पहचान शामिल करते हैं।
  • नई डिवाइस ID के लिए पेयरिंग अनुमोदन आवश्यक है; Gateway बाद के कनेक्शन के लिए एक डिवाइस टोकन जारी करता है।
  • एक ही होस्ट पर उपयोगकर्ता अनुभव को सुचारु बनाए रखने के लिए सीधे स्थानीय लूपबैक कनेक्शन स्वचालित रूप से अनुमोदित किए जा सकते हैं।
  • OpenClaw में विश्वसनीय साझा-सीक्रेट हेल्पर प्रवाहों के लिए एक सीमित बैकएंड/कंटेनर-स्थानीय स्व-कनेक्शन पथ भी है।
  • एक ही होस्ट के टेलनेट बाइंड सहित Tailnet और LAN कनेक्शन के लिए अब भी स्पष्ट पेयरिंग अनुमोदन आवश्यक है।
  • सभी कनेक्शन को connect.challenge नॉन्स पर हस्ताक्षर करना अनिवार्य है। हस्ताक्षर पेलोड v3 platform और deviceFamily को भी बाँधता है; Gateway दोबारा कनेक्ट होने पर पेयर किया गया मेटाडेटा पिन करता है और मेटाडेटा परिवर्तन के लिए सुधारात्मक पेयरिंग आवश्यक करता है।
  • गैर-स्थानीय कनेक्शन के लिए अब भी स्पष्ट अनुमोदन आवश्यक है।
  • Gateway प्रमाणीकरण (gateway.auth.*) अब भी स्थानीय या रिमोट सभी कनेक्शन पर लागू होता है।
विवरण: Gateway प्रोटोकॉल, पेयरिंग, सुरक्षा।

​
प्रोटोकॉल टाइपिंग और कोड जनरेशन

  • TypeBox स्कीमा प्रोटोकॉल को परिभाषित करते हैं।
  • उन स्कीमा से JSON Schema जनरेट किया जाता है।
  • JSON Schema से Swift मॉडल जनरेट किए जाते हैं।

​
रिमोट एक्सेस

  • वरीयता: Tailscale या VPN।
  • वैकल्पिक: SSH टनल
  • टनल पर भी वही हैंडशेक + प्रमाणीकरण टोकन लागू होते हैं।
  • रिमोट सेटअप में WS के लिए TLS + वैकल्पिक पिनिंग सक्षम की जा सकती है।

​
संचालन स्नैपशॉट

  • प्रारंभ: openclaw gateway (फ़ोरग्राउंड, लॉग stdout पर)।
  • स्वास्थ्य: WS पर health (hello-ok में भी शामिल)।
  • पर्यवेक्षण: स्वचालित पुनःप्रारंभ के लिए launchd/systemd।

​
अपरिवर्तनीय नियम

  • प्रति होस्ट ठीक एक Gateway एकल Baileys सत्र नियंत्रित करता है।
  • हैंडशेक अनिवार्य है; कोई भी गैर-JSON या गैर-कनेक्ट पहला फ़्रेम तत्काल कनेक्शन बंद कर देता है।
  • इवेंट दोबारा नहीं चलाए जाते; अंतराल होने पर क्लाइंट को रीफ़्रेश करना अनिवार्य है।

​
संबंधित