clawrelay
v0.4.0
Published
Channel relay plugin for OpenClaw — receives messages from an always-on relay proxy
Downloads
42
Maintainers
Readme
clawrelay
OpenClaw channel plugin that receives forwarded messages from an always-on relay proxy (ClawRelay), dispatches them through the agent pipeline, and sends responses back via the gateway protocol.
How it works
- Plugin registers a
relay.inboundgateway method and a/relay/healthHTTP route on the gateway's existing server - The relay service connects to the gateway via WebSocket and authenticates using the gateway protocol
- Inbound messages arrive as
relay.inboundmethod calls - Messages are dispatched through the OpenClaw agent pipeline
- Agent responses are returned in the gateway method response
Installation
Install from npm:
openclaw plugins install clawrelayOr install from a local path during development:
openclaw plugins install ./packages/relay-channelUpdate to the latest version:
openclaw plugins update clawrelayOr install from a tarball:
cd packages/relay-channel && npm pack
openclaw plugins install clawrelay-0.3.0.tgzGateway configuration
Add to ~/.openclaw/openclaw.json:
{
"channels": {
"relay": {
"enabled": true
}
},
"plugins": {
"allow": ["clawrelay"],
"entries": {
"clawrelay": { "enabled": true }
}
}
}Authentication is handled by the gateway's own auth token (gateway.auth.token).
Verify installation
openclaw plugins list
openclaw plugins info clawrelay
openclaw plugins doctorEndpoints
| Type | Path/Method | Description |
|---|---|---|
| HTTP | GET /relay/health | Health check — returns {"status":"ok","ready":true} |
| Gateway | relay.inbound | Gateway method for receiving relay messages |
Source files
| File | Purpose |
|---|---|
| src/index.ts | Plugin entry point, gateway method + HTTP route registration |
| src/channel.ts | Channel definition, config resolution, onboarding |
| src/gateway-handler.ts | relay.inbound gateway method handler |
| src/health-handler.ts | HTTP health route handler |
| src/onboarding.ts | Setup wizard (enable channel, sprite gateway service) |
| src/runtime.ts | OpenClaw runtime accessor |
| src/types.ts | Protocol and config types |
Links
- ClawRelay — relay proxy + plugin monorepo
- OpenClaw Plugin Docs
