@wflclaw/openclaw-channel
v1.0.9
Published
OpenClaw channel plugin for AI Staff Center (WFL Claw)
Maintainers
Readme
WFL Claw - OpenClaw Channel Plugin
AI Staff Center WebSocket channel plugin for OpenClaw.
Installation
方式一:npm pack 安装(推荐 ⭐)
# 1. 创建插件目录
mkdir -p ~/.openclaw/extensions/wflclaw
cd ~/.openclaw/extensions/wflclaw
# 2. 下载并解压 npm 包
npm pack @wflclaw/openclaw-channel
tar -xzf wflclaw-openclaw-channel-*.tgz --strip-components=1
rm wflclaw-openclaw-channel-*.tgz
# 3. 安装依赖
npm install --production方式二:从源码安装
cd /path/to/openclaw-plugin
npm install
npm run build
npm publish --access public
# 然后按方式一安装Configuration
Method 1: Remote Config File (推荐 ⭐)
从服务器动态读取配置文件,配置更新无需重启 OpenClaw。
环境变量方式:
export WFLCLAW_CONFIG_URL=https://clawde.shwfl.edu.cn/api/v1/plugin/config/4
# 或者使用默认的 employee_id
export AI_STAFF_EMPLOYEE_ID=4远程配置文件格式(服务器端):
{
"url": "wss://clawde.shwfl.edu.cn/ws/bot",
"token": "YOUR_BOT_TOKEN",
"enabled": true,
"reconnect": true,
"reconnectInterval": 5000
}优势:
- ✅ 配置集中管理
- ✅ 支持热更新(定期重新 fetch)
- ✅ 适合大规模部署
- ✅ 与后端 API 集成
Method 2: OpenClaw Config File
在 ~/.openclaw/openclaw.json 中添加或修改配置:
方式 A: 使用快速配置脚本(推荐 ⭐)
# 自动合并配置,不会影响其他渠道
bash configure-wflclaw.sh YOUR_BOT_TOKEN clawde.shwfl.edu.cn方式 B: 手动编辑配置文件
# 1. 备份现有配置
cp ~/.openclaw/openclaw.json ~/.openclaw/openclaw.json.backup
# 2. 编辑配置文件
vi ~/.openclaw/openclaw.json
# 3. 在 channels 中添加 wflclaw(保留其他渠道配置)
{
"channels": {
"feishu": { ... }, // ← 保留现有配置
"telegram": { ... }, // ← 保留现有配置
"wflclaw": { // ← 新增(注意:渠道名必须是 wflclaw)
"enable": true,
"token": "YOUR_BOT_TOKEN",
"domain": "clawde.shwfl.edu.cn"
}
}
}⚠️ 重要提示:
- ❌ 不要直接覆盖整个文件,会丢失其他渠道配置
- ✅ 应该在现有的
channels对象中添加wflclaw - ✅ 使用
configure-wflclaw.sh脚本会自动合并配置 - ✅ 渠道名必须使用
wflclaw(与插件内部声明一致)
{
"channels": {
"wflclaw": {
"enable": true,
"token": "YOUR_BOT_TOKEN",
"domain": "clawde.shwfl.edu.cn"
}
}
}或者使用完整的 URL:
{
"channels": {
"wflclaw": {
"enable": true,
"token": "YOUR_BOT_TOKEN",
"url": "wss://clawde.shwfl.edu.cn/ws/bot"
}
}
}支持的配置项:
enable/enabled: 是否启用(布尔值)token: Bot Token(必填)url/wsUrl: 完整的 WebSocket URL(选填,与 domain 二选一)domain: 域名,会自动拼接为wss://{domain}/ws/bot(选填,与 url 二选一)reconnect: 是否自动重连(可选,默认 true)reconnectInterval: 重连间隔毫秒数(可选,默认 5000)
Method 3: Environment Variables
插件会自动从以下端点获取配置:
GET /api/v1/plugin/config/{employee_id}Method 4: Manual Configuration
也可以在 OpenClaw 配置文件中手动指定:
{
"channels": {
"wflclaw": {
"url": "wss://clawde.shwfl.edu.cn/ws/bot",
"token": "YOUR_BOT_TOKEN",
"enabled": true
}
}
}Usage
安装后,在 OpenClaw 的 config.json 中启用即可自动连接。
Development
npm install
npm run build
npm run dev # watch modeLicense
MIT
