التثبيت
ثبّت Mattermost قبل تهيئة القناة:- npm registry
- Local checkout
الإعداد السريع
Ensure plugin is available
ثبّت
@openclaw/mattermost باستخدام الأمر أعلاه، ثم أعد تشغيل Gateway إذا كان قيد التشغيل بالفعل.أوامر الشرطة المائلة الأصلية
أوامر الشرطة المائلة الأصلية اختيارية. عند تفعيلها، يسجّل OpenClaw أوامر الشرطة المائلةoc_* عبر Mattermost API ويتلقى طلبات POST للردود على خادم HTTP الخاص بالـ Gateway.
Behavior notes
Behavior notes
- الإعداد
native: "auto"يكون معطّلًا افتراضيًا لـ Mattermost. عيّنnative: trueللتفعيل. - إذا حُذف
callbackUrl، يشتق OpenClaw واحدًا من مضيف/منفذ Gateway +callbackPath. - في إعدادات الحسابات المتعددة، يمكن ضبط
commandsفي المستوى الأعلى أو ضمنchannels.mattermost.accounts.<id>.commands(قيم الحساب تتجاوز الحقول ذات المستوى الأعلى). - تُتحقق ردود الأوامر باستخدام الرموز الخاصة بكل أمر التي يرجعها Mattermost عندما يسجّل OpenClaw أوامر
oc_*. - يحدّث OpenClaw تسجيل أوامر Mattermost الحالي قبل قبول كل رد حتى تتوقف الرموز القديمة من أوامر الشرطة المائلة المحذوفة أو المعاد إنشاؤها عن القبول دون إعادة تشغيل Gateway.
- يفشل تحقق الرد بإغلاق آمن إذا تعذر على Mattermost API تأكيد أن الأمر لا يزال حاليًا؛ تُخزّن عمليات التحقق الفاشلة مؤقتًا لوقت قصير، وتُدمج عمليات البحث المتزامنة، وتُقيّد بدايات البحث الجديدة بمعدل لكل أمر للحد من ضغط إعادة التشغيل.
- تفشل ردود الشرطة المائلة بإغلاق آمن عند فشل التسجيل، أو كان بدء التشغيل جزئيًا، أو لم يطابق رمز الرد الرمز المسجل للأمر المحلول (لا يمكن لرمز صالح لأمر واحد الوصول إلى تحقق المنبع لأمر مختلف).
Reachability requirement
Reachability requirement
يجب أن تكون نقطة نهاية الرد قابلة للوصول من خادم Mattermost.
- لا تضبط
callbackUrlعلىlocalhostإلا إذا كان Mattermost يعمل على المضيف نفسه/نطاق الشبكة نفسه مثل OpenClaw. - لا تضبط
callbackUrlعلى عنوان URL الأساسي لـ Mattermost لديك إلا إذا كان ذلك العنوان يمرر/api/channels/mattermost/commandإلى OpenClaw عبر وكيل عكسي. - فحص سريع هو
curl https://<gateway-host>/api/channels/mattermost/command؛ يجب أن يعيد طلب GET القيمة405 Method Not Allowedمن OpenClaw، وليس404.
Mattermost egress allowlist
Mattermost egress allowlist
إذا كانت وجهة الرد تستهدف عناوين خاصة/داخل tailnet/داخلية، فاضبط
ServiceSettings.AllowedUntrustedInternalConnections في Mattermost لتضمين مضيف/نطاق الرد.استخدم إدخالات المضيف/النطاق، وليس عناوين URL كاملة.- جيد:
gateway.tailnet-name.ts.net - سيئ:
https://gateway.tailnet-name.ts.net
متغيرات البيئة (الحساب الافتراضي)
اضبط هذه على مضيف Gateway إذا كنت تفضّل متغيرات البيئة:MATTERMOST_BOT_TOKEN=...MATTERMOST_URL=https://chat.example.com
تنطبق متغيرات البيئة فقط على الحساب الافتراضي (
default). يجب أن تستخدم الحسابات الأخرى قيم الإعدادات.لا يمكن ضبط MATTERMOST_URL من ملف .env لمساحة العمل؛ راجع ملفات .env لمساحة العمل.أوضاع الدردشة
يرد Mattermost على الرسائل المباشرة تلقائيًا. يتحكمchatmode في سلوك القنوات:
- oncall (default)
- onmessage
- onchar
يرد فقط عند @الإشارة إليه في القنوات.
- لا يزال
oncharيرد على @الإشارات الصريحة. - يُحترم
channels.mattermost.requireMentionللإعدادات القديمة، لكنchatmodeهو المفضل. - بعد أن يرسل البوت ردًا مرئيًا في سلسلة قناة، تُجاب الرسائل اللاحقة في السلسلة نفسها دون @إشارة جديدة أو بادئة
onchar، لذلك تستمر محادثات السلاسل متعددة الجولات. تُتذكّر المشاركة لمدة 7 أيام من خمول السلسلة (وتُحدّث عند كل رد) وتستمر عبر عمليات إعادة تشغيل Gateway. لا تتأثر السلاسل التي راقبها البوت فقط؛ ابدأ رسالة جديدة في المستوى الأعلى لطلب إشارة صريحة مرة أخرى.
السلاسل والجلسات
استخدمchannels.mattermost.replyToMode للتحكم فيما إذا كانت ردود القناة والمجموعة تبقى في القناة الرئيسية أو تبدأ سلسلة تحت المنشور الذي شغّلها.
off(الافتراضي): الرد في سلسلة فقط عندما يكون المنشور الوارد موجودًا بالفعل في سلسلة.first: لمنشورات القناة/المجموعة في المستوى الأعلى، ابدأ سلسلة تحت ذلك المنشور ووجّه المحادثة إلى جلسة بنطاق السلسلة.all: السلوك نفسه مثلfirstلـ Mattermost حاليًا.- تتجاهل الرسائل المباشرة هذا الإعداد وتبقى غير مسلسلة.
- تستخدم الجلسات بنطاق السلسلة معرّف المنشور المشغّل كجذر للسلسلة.
firstوallمتكافئان حاليًا لأنه بمجرد أن يكون لدى Mattermost جذر سلسلة، تستمر المقاطع اللاحقة والوسائط في السلسلة نفسها.
التحكم في الوصول (الرسائل المباشرة)
- الافتراضي:
channels.mattermost.dmPolicy = "pairing"(المرسلون غير المعروفين يحصلون على رمز اقتران). - الموافقة عبر:
openclaw pairing list mattermostopenclaw pairing approve mattermost <CODE>
- الرسائل المباشرة العامة:
channels.mattermost.dmPolicy="open"بالإضافة إلىchannels.mattermost.allowFrom=["*"]. - يقبل
channels.mattermost.allowFromإدخالاتaccessGroup:<name>. راجع مجموعات الوصول.
القنوات (المجموعات)
- الافتراضي:
channels.mattermost.groupPolicy = "allowlist"(محكوم بالإشارة). - اسمح للمرسلين باستخدام
channels.mattermost.groupAllowFrom(يُوصى بمعرّفات المستخدمين). - يقبل
channels.mattermost.groupAllowFromإدخالاتaccessGroup:<name>. راجع مجموعات الوصول. - تعيش تجاوزات الإشارة لكل قناة ضمن
channels.mattermost.groups.<channelId>.requireMentionأوchannels.mattermost.groups["*"].requireMentionكافتراضي. - مطابقة
@usernameقابلة للتغيير ولا تُفعّل إلا عندchannels.mattermost.dangerouslyAllowNameMatching: true. - القنوات المفتوحة:
channels.mattermost.groupPolicy="open"(محكومة بالإشارة). - ملاحظة وقت التشغيل: إذا كان
channels.mattermostمفقودًا بالكامل، يعود وقت التشغيل إلىgroupPolicy="allowlist"لفحوصات المجموعة (حتى إذا كانchannels.defaults.groupPolicyمضبوطًا).
أهداف التسليم الصادر
استخدم صيغ الأهداف هذه معopenclaw message send أو cron/webhooks:
channel:<id>لقناةuser:<id>لرسالة مباشرة@usernameلرسالة مباشرة (تُحل عبر Mattermost API)
إعادة محاولة قناة الرسائل المباشرة
عندما يرسل OpenClaw إلى هدف رسالة مباشرة في Mattermost ويحتاج إلى حل القناة المباشرة أولًا، فإنه يعيد محاولة إخفاقات إنشاء القناة المباشرة المؤقتة افتراضيًا. استخدمchannels.mattermost.dmChannelRetry لضبط هذا السلوك عمومًا لـ Mattermost plugin، أو channels.mattermost.accounts.<id>.dmChannelRetry لحساب واحد.
- ينطبق هذا فقط على إنشاء قناة الرسائل المباشرة (
/api/v4/channels/direct)، وليس كل استدعاء لـ Mattermost API. - تنطبق إعادة المحاولة على الإخفاقات المؤقتة مثل حدود المعدل، واستجابات 5xx، وأخطاء الشبكة أو المهلة.
- تُعامل أخطاء العميل 4xx غير
429كدائمة ولا تُعاد محاولتها.
بث المعاينة
يبث Mattermost التفكير ونشاط الأدوات ونص الرد الجزئي في منشور معاينة مسودة واحد يُنهى في مكانه عندما يكون الجواب النهائي آمنًا للإرسال. تُحدّث المعاينة على معرّف المنشور نفسه بدل إغراق القناة برسائل لكل مقطع. تلغي النهايات الخاصة بالوسائط/الأخطاء تعديلات المعاينة المعلقة وتستخدم التسليم العادي بدل تفريغ منشور معاينة مؤقت. فعّل عبرchannels.mattermost.streaming:
Streaming modes
Streaming modes
partialهو الخيار المعتاد: منشور معاينة واحد يُحرر مع نمو الرد، ثم يُنهى بالجواب الكامل.- يستخدم
blockمقاطع مسودة بأسلوب الإلحاق داخل منشور المعاينة. - يعرض
progressمعاينة حالة أثناء التوليد وينشر الجواب النهائي فقط عند الاكتمال. - يعطل
offبث المعاينة.
Streaming behavior notes
Streaming behavior notes
- إذا تعذر إنهاء البث في مكانه (على سبيل المثال، حُذف المنشور أثناء البث)، يعود OpenClaw إلى إرسال منشور نهائي جديد حتى لا يضيع الرد أبدًا.
- تُحجب حمولات التفكير فقط من منشورات القناة، بما في ذلك النص الذي يصل كاقتباس كتلي
> Thinking. اضبط/reasoning onلرؤية التفكير في أسطح أخرى؛ يحتفظ المنشور النهائي في Mattermost بالجواب فقط. - راجع Streaming لمصفوفة ربط القنوات.
التفاعلات (أداة الرسائل)
- استخدم
message action=reactمعchannel=mattermost. messageIdهو معرّف منشور Mattermost.- يقبل
emojiأسماء مثلthumbsupأو:+1:(النقطتان الرأسيتان اختياريتان). - اضبط
remove=true(منطقي) لإزالة تفاعل. - تُمرر أحداث إضافة/إزالة التفاعلات كأحداث نظام إلى جلسة الوكيل الموجّهة.
channels.mattermost.actions.reactions: تفعيل/تعطيل إجراءات التفاعل (الافتراضي true).- تجاوز لكل حساب:
channels.mattermost.accounts.<id>.actions.reactions.
الأزرار التفاعلية (أداة الرسائل)
أرسل رسائل بأزرار قابلة للنقر. عندما ينقر مستخدم زرًا، يتلقى الوكيل الاختيار ويمكنه الرد. يمكن أن تتضمن ردود الوكيل العادية أيضًا حمولاتpresentation دلالية. يعرض OpenClaw أزرار القيم كأزرار تفاعلية في Mattermost، ويبقي أزرار URL مرئية في نص الرسالة، ويحوّل قوائم الاختيار إلى نص مقروء.
فعّل الأزرار بإضافة inlineButtons إلى إمكانات القناة:
message action=send مع معامل buttons. الأزرار مصفوفة ثنائية الأبعاد (صفوف من الأزرار):
تسمية العرض.
القيمة المُرسلة عند النقر (تُستخدم كمعرّف الإجراء).
نمط الزر.
ملاحظات التنفيذ
ملاحظات التنفيذ
- تستخدم استدعاءات الأزرار التحقق HMAC-SHA256 (تلقائي، لا يحتاج إلى إعداد).
- يزيل Mattermost بيانات الاستدعاء من استجابات API الخاصة به (ميزة أمان)، لذلك تُزال كل الأزرار عند النقر - الإزالة الجزئية غير ممكنة.
- تُعقّم معرّفات الإجراءات التي تحتوي على واصلات أو شرطات سفلية تلقائيًا (قيد في توجيه Mattermost).
الإعداد وقابلية الوصول
الإعداد وقابلية الوصول
channels.mattermost.capabilities: مصفوفة من سلاسل الإمكانات. أضف"inlineButtons"لتفعيل وصف أداة الأزرار في مطالبة نظام الوكيل.channels.mattermost.interactions.callbackBaseUrl: عنوان URL أساسي خارجي اختياري لاستدعاءات الأزرار (على سبيل المثالhttps://gateway.example.com). استخدم هذا عندما لا يستطيع Mattermost الوصول إلى Gateway مباشرة على مضيف الربط الخاص به.- في إعدادات الحسابات المتعددة، يمكنك أيضًا تعيين الحقل نفسه ضمن
channels.mattermost.accounts.<id>.interactions.callbackBaseUrl. - إذا حُذف
interactions.callbackBaseUrl، يشتق OpenClaw عنوان URL للاستدعاء منgateway.customBindHost+gateway.port، ثم يعود إلىhttp://localhost:<port>. - قاعدة قابلية الوصول: يجب أن يكون عنوان URL لاستدعاء الزر قابلًا للوصول من خادم Mattermost. لا يعمل
localhostإلا عندما يعمل Mattermost وOpenClaw على المضيف نفسه/مساحة أسماء الشبكة نفسها. - إذا كان هدف الاستدعاء خاصًا/ضمن tailnet/داخليًا، فأضف مضيفه/نطاقه إلى
ServiceSettings.AllowedUntrustedInternalConnectionsفي Mattermost.
التكامل المباشر مع API (السكربتات الخارجية)
يمكن للسكربتات الخارجية وwebhooks نشر الأزرار مباشرة عبر REST API الخاص بـ Mattermost بدلًا من المرور عبر أداةmessage الخاصة بالوكيل. استخدم buildButtonAttachments() من Plugin عندما يكون ذلك ممكنًا؛ وإذا كنت تنشر JSON خامًا، فاتبع هذه القواعد:
بنية الحمولة:
سلسل باستخدام مفاتيح مرتبة
سلسل باستخدام مفاتيح مرتبة ودون مسافات (يستخدم Gateway
JSON.stringify مع مفاتيح مرتبة، ما ينتج خرجًا مضغوطًا).أخطاء HMAC الشائعة
أخطاء HMAC الشائعة
- يضيف
json.dumpsفي Python مسافات افتراضيًا ({"key": "val"}). استخدمseparators=(",", ":")لمطابقة الخرج المضغوط في JavaScript ({"key":"val"}). - وقّع دائمًا كل حقول السياق (ناقص
_token). يزيل Gateway_tokenثم يوقّع كل ما يتبقى. توقيع مجموعة فرعية يسبب فشل تحقق صامتًا. - استخدم
sort_keys=True- يرتب Gateway المفاتيح قبل التوقيع، وقد يعيد Mattermost ترتيب حقول السياق عند تخزين الحمولة. - اشتق السر من رمز bot (حتمي)، وليس من بايتات عشوائية. يجب أن يكون السر نفسه في العملية التي تنشئ الأزرار وفي Gateway الذي يتحقق منها.
محوّل الدليل
يتضمن Plugin الخاص بـ Mattermost محوّل دليل يحل أسماء القنوات والمستخدمين عبر API الخاص بـ Mattermost. يتيح هذا أهداف#channel-name و@username في openclaw message send وتسليمات cron/webhook.
لا يلزم أي إعداد - يستخدم المحوّل رمز bot من إعداد الحساب.
الحسابات المتعددة
يدعم Mattermost حسابات متعددة ضمنchannels.mattermost.accounts:
استكشاف الأخطاء وإصلاحها
لا توجد ردود في القنوات
لا توجد ردود في القنوات
تأكد من أن bot موجود في القناة واذكره (oncall)، أو استخدم بادئة تشغيل (onchar)، أو عيّن
chatmode: "onmessage".أخطاء المصادقة أو الحسابات المتعددة
أخطاء المصادقة أو الحسابات المتعددة
- تحقق من رمز bot، وعنوان URL الأساسي، وما إذا كان الحساب مفعّلًا.
- مشكلات الحسابات المتعددة: لا تنطبق متغيرات env إلا على الحساب
default.
تفشل أوامر slash الأصلية
تفشل أوامر slash الأصلية
Unauthorized: invalid command token.: لم يقبل OpenClaw رمز الاستدعاء. الأسباب المعتادة:- فشل تسجيل أمر slash أو اكتمل جزئيًا فقط عند بدء التشغيل
- يصل الاستدعاء إلى Gateway/الحساب الخطأ
- لا يزال لدى Mattermost أوامر قديمة تشير إلى هدف استدعاء سابق
- أعيد تشغيل Gateway دون إعادة تنشيط أوامر slash
- إذا توقفت أوامر slash الأصلية عن العمل، فتحقق من السجلات بحثًا عن
mattermost: failed to register slash commandsأوmattermost: native slash commands enabled but no commands could be registered. - إذا حُذف
callbackUrlوحذرت السجلات من أن الاستدعاء حُل إلىhttp://127.0.0.1:18789/...، فمن المحتمل ألا يكون عنوان URL هذا قابلًا للوصول إلا عندما يعمل Mattermost على المضيف نفسه/مساحة أسماء الشبكة نفسها مثل OpenClaw. عيّنcommands.callbackUrlصريحًا وقابلًا للوصول خارجيًا بدلًا من ذلك.
مشكلات الأزرار
مشكلات الأزرار
- تظهر الأزرار كمربعات بيضاء: قد يرسل الوكيل بيانات أزرار غير صحيحة البنية. تحقق من أن كل زر يحتوي على حقلي
textوcallback_data. - تُعرض الأزرار لكن النقرات لا تفعل شيئًا: تحقق من أن
AllowedUntrustedInternalConnectionsفي إعداد خادم Mattermost يتضمن127.0.0.1 localhost، وأنEnablePostActionIntegrationهوtrueفي ServiceSettings. - تعيد الأزرار 404 عند النقر: من المحتمل أن يحتوي
idالزر على واصلات أو شرطات سفلية. يتعطل موجّه إجراءات Mattermost عند المعرّفات غير الأبجدية الرقمية. استخدم[a-zA-Z0-9]فقط. - تسجل سجلات Gateway
invalid _token: عدم تطابق HMAC. تحقق من أنك توقّع كل حقول السياق (وليس مجموعة فرعية)، وتستخدم مفاتيح مرتبة، وتستخدم JSON مضغوطًا (دون مسافات). راجع قسم HMAC أعلاه. - تسجل سجلات Gateway
missing _token in context: حقل_tokenغير موجود في سياق الزر. تأكد من تضمينه عند إنشاء حمولة التكامل. - يعرض التأكيد معرّفًا خامًا بدلًا من اسم الزر: لا يطابق
context.action_idقيمةidالخاصة بالزر. عيّن كليهما إلى القيمة المنقحة نفسها. - لا يعرف الوكيل عن الأزرار: أضف
capabilities: ["inlineButtons"]إلى إعداد قناة Mattermost.
ذات صلة
- توجيه القنوات - توجيه الجلسات للرسائل
- نظرة عامة على القنوات - كل القنوات المدعومة
- المجموعات - سلوك دردشة المجموعات وبوابة الذكر
- الاقتران - مصادقة الرسائل المباشرة وتدفق الاقتران
- الأمان - نموذج الوصول والتقوية