@axonflow/openclaw 2.0.3 → 2.0.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +32 -0
- package/README.md +65 -46
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/openclaw.plugin.json +8 -0
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,37 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## [2.0.4] - 2026-05-01 — Restore `userEmail` configuration + reframe Community SaaS as exploration-only
|
|
4
|
+
|
|
5
|
+
`openclaw.plugin.json` declared `configSchema.additionalProperties: false` but did not list `userEmail` in `properties`, even though the plugin's runtime config resolver (`src/config.ts`) reads `userEmail` from `pluginConfig` and forwards it as the `X-User-Email` header on every request. OpenClaw's plugin loader runs the published configSchema against the user's `pluginConfig`; when validation fails (because of the unknown property), the loader emits a single `[plugins] axonflow-governance invalid config: ...` log line and skips the plugin entirely — it never registers, no hooks fire, and tool calls execute completely ungoverned.
|
|
6
|
+
|
|
7
|
+
In practice this affected every user who followed the documented configuration path for the override workflow. `client.createOverride()`, `client.revokeOverride()`, `client.listOverrides()` all require `userEmail` to be set (the endpoints reject calls without user identity with HTTP 401), and `client.explainDecision()` needs it for correct per-user scoping. Setting it via `pluginConfig.userEmail` — which is what the README, the SKILL.md on ClawHub, and the rest of the documentation describe — failed schema validation, disabled the plugin silently, and left the user with neither governance nor an obvious error.
|
|
8
|
+
|
|
9
|
+
### Fixed
|
|
10
|
+
|
|
11
|
+
- **`pluginConfig.userEmail` is now accepted by the configSchema.** Added `"userEmail": { "type": "string" }` to `openclaw.plugin.json` `properties`, plus a matching `uiHints.userEmail` block so portal UIs render a labelled input with placeholder and help text. Plugin runtime behaviour was already correct in v2.0.0+ — only the schema gate was rejecting it.
|
|
12
|
+
|
|
13
|
+
### Why this is a patch (not a minor)
|
|
14
|
+
|
|
15
|
+
The capability already existed in code; we're closing the schema gap that prevented the documented `pluginConfig` path from reaching it. Pure additive change to the schema — no existing valid config breaks.
|
|
16
|
+
|
|
17
|
+
### Upgrade
|
|
18
|
+
|
|
19
|
+
`openclaw plugins install @axonflow/openclaw@latest`. No code changes required on your side. If your config currently sets `userEmail` and the plugin was being silently disabled, it will now register and start enforcing policy on the next plugin reload.
|
|
20
|
+
|
|
21
|
+
### Documentation: Community SaaS reframed as exploration-only
|
|
22
|
+
|
|
23
|
+
The README "Where your data goes" section now leads with **Self-hosted (recommended for any real use)** as the primary deployment path and demotes Community SaaS to a clearly labelled "for early exploration only" section. Community SaaS is offered "as is" on a best-effort basis with no SLA, no warranties, and no commitment to retention or deletion timelines, and is not appropriate for production workloads, regulated environments, real user data, or any other sensitive information.
|
|
24
|
+
|
|
25
|
+
The reframing surfaces three production-fit alternatives:
|
|
26
|
+
|
|
27
|
+
- **[Self-host AxonFlow Community Edition](https://docs.getaxonflow.com/docs/deployment/self-hosted/)** for any real workload (data stays within your boundary).
|
|
28
|
+
- **Community Edition with an [Evaluation License](https://docs.getaxonflow.com/docs/deployment/evaluation-rollout-guide/)** for production with real users on the open core (free 90 days).
|
|
29
|
+
- **[AxonFlow Enterprise](https://docs.getaxonflow.com/docs/deployment/community-to-enterprise-migration/)** for regulated industries with SLOs and contractual commitments.
|
|
30
|
+
|
|
31
|
+
Plugin runtime behaviour is unchanged — Community SaaS auto-bootstrap still happens on zero-config installs, with the `AXONFLOW_COMMUNITY_SAAS=0` opt-out documented in v2.0.0+.
|
|
32
|
+
|
|
33
|
+
---
|
|
34
|
+
|
|
3
35
|
## [2.0.3] - 2026-04-30 — Scrub bait shapes from published markdown + scan all shipped files
|
|
4
36
|
|
|
5
37
|
The v2.0.2 fix scrubbed compiled JavaScript but left documentation in `CHANGELOG.md`, `README.md`, and `policies/README.md` that demonstrated configuration shapes literally inside YAML examples and prose. ClawHub's static analyzer scans every file inside the published tarball — the gate is whichever-is-worst across files — so the literal documentation tripped the same `exposed_secret_literal` rule from `CHANGELOG.md` line 5 and continued to block install of v2.0.2 even though the compiled artifact was clean.
|
package/README.md
CHANGED
|
@@ -29,33 +29,43 @@ OpenClaw handles agent runtime, MCP connectivity, channels, and tool execution.
|
|
|
29
29
|
|
|
30
30
|
## Where your data goes
|
|
31
31
|
|
|
32
|
-
The plugin governs tool calls and outbound messages by sending each one to an AxonFlow endpoint for policy evaluation
|
|
32
|
+
The plugin governs tool calls and outbound messages by sending each one to an AxonFlow endpoint for policy evaluation and audit. Pick the deployment mode that fits your workload:
|
|
33
33
|
|
|
34
|
-
|
|
34
|
+
> **Privacy notice — read before installing.** AxonFlow [Community SaaS](https://docs.getaxonflow.com/docs/deployment/community-saas/) at `try.getaxonflow.com` is the zero-config endpoint the plugin uses if no other endpoint is configured. In that mode, governed tool inputs (tool name + arguments) and outbound message bodies are sent off-host to AxonFlow's shared evaluation endpoint for policy evaluation and audit. **Community SaaS is for early exploration only** — not for production workloads, regulated environments, real user data, personal data, or any other sensitive information. It is offered "as is" on a best-effort basis with no SLA, no warranties, and no commitment to retention, deletion, or incident-response timelines.
|
|
35
|
+
>
|
|
36
|
+
> For any serious use, choose one of the following instead:
|
|
37
|
+
>
|
|
38
|
+
> 1. **[Self-host AxonFlow Community Edition](https://docs.getaxonflow.com/docs/deployment/self-hosted/)** — runs entirely on your infrastructure and keeps data within your boundary. Recommended for any real workload.
|
|
39
|
+
> 2. **Community Edition with an [Evaluation License](https://docs.getaxonflow.com/docs/deployment/evaluation-rollout-guide/)** — for production use with real users or clients on the open core; adds production-fit limits and license-gated features. Free 90-day [evaluation license](https://getaxonflow.com/plugins/evaluation-license).
|
|
40
|
+
> 3. **[AxonFlow Enterprise](https://docs.getaxonflow.com/docs/deployment/community-to-enterprise-migration/)** — production-grade governance, regulatory-grade controls, SLOs, and contractual commitments suitable for regulated industries. Contact [hello@getaxonflow.com](mailto:hello@getaxonflow.com).
|
|
41
|
+
>
|
|
42
|
+
> To skip Community SaaS entirely: set `pluginConfig.endpoint` to a self-hosted AxonFlow URL. That alone flips the plugin into self-hosted mode — the Community SaaS auto-bootstrap is not attempted, and no env var is required. Get the AxonFlow platform from [getaxonflow/axonflow](https://github.com/getaxonflow/axonflow) and follow the [Getting Started](https://docs.getaxonflow.com/docs/getting-started/) guide for the Docker Compose setup. For air-gapped environments where AxonFlow is not yet reachable but you want to suppress the bootstrap attempt, set `AXONFLOW_COMMUNITY_SAAS=0`; set `AXONFLOW_TELEMETRY=off` to also disable the anonymous 7-day heartbeat.
|
|
35
43
|
|
|
36
|
-
|
|
44
|
+
### Self-hosted (recommended for any real use)
|
|
37
45
|
|
|
38
|
-
|
|
39
|
-
|---|---|
|
|
40
|
-
| Tool name + arguments before each governed call | LLM provider API keys |
|
|
41
|
-
| Outbound message bodies before delivery (PII/secret scan) | OpenClaw conversation history outside governed tools |
|
|
42
|
-
| Anonymous 7-day heartbeat (plugin version, OS, runtime) | Files outside the OpenClaw runtime |
|
|
46
|
+
Point the plugin at an AxonFlow instance you run. Nothing leaves your network except the anonymous 7-day heartbeat (which can also be disabled). Configure three values in `pluginConfig`:
|
|
43
47
|
|
|
44
|
-
|
|
48
|
+
- `endpoint` — the URL of your AxonFlow agent gateway (for example `https://axonflow.your-corp.example.com`).
|
|
49
|
+
- `clientId` — the AxonFlow tenant identifier issued to your deployment.
|
|
50
|
+
- `clientSecret` — the matching secret. **Never commit this to source control or paste it into a config file checked into a repository.** Resolve it from a secret manager (Vault, AWS Secrets Manager, GCP Secret Manager, or your CI provider's secret store) and inject the value via your OpenClaw config templating, an environment variable consumed by your config loader, or your platform's secret-injection sidecar.
|
|
45
51
|
|
|
46
|
-
|
|
52
|
+
For production with real users or clients: run Community Edition with a free 90-day [Evaluation License](https://docs.getaxonflow.com/docs/deployment/evaluation-rollout-guide/) for production-fit limits and license-gated features, or [AxonFlow Enterprise](https://docs.getaxonflow.com/docs/deployment/community-to-enterprise-migration/) for regulated industries with SLOs and contractual commitments.
|
|
47
53
|
|
|
48
|
-
|
|
54
|
+
See the [Self-Hosted Deployment Guide](https://docs.getaxonflow.com/docs/deployment/self-hosted/) for prerequisites and production options, or the [OpenClaw Integration Guide](https://docs.getaxonflow.com/docs/integration/openclaw/) for architecture and the full pluginConfig schema.
|
|
49
55
|
|
|
50
|
-
|
|
56
|
+
### Community SaaS — for early exploration only
|
|
51
57
|
|
|
52
|
-
|
|
58
|
+
The plugin's zero-config fallback. Install the plugin without setting `pluginConfig.endpoint` and it auto-registers with **`try.getaxonflow.com`** on first load. The first-load disclosure banner surfaces this in your plugin logs before the registration POST fires. Auto-registration credentials persist at `$AXONFLOW_CONFIG_DIR/try-registration.json` (mode `0600`).
|
|
53
59
|
|
|
54
|
-
|
|
55
|
-
- `clientId` — the AxonFlow tenant identifier issued to your deployment.
|
|
56
|
-
- `clientSecret` — the matching secret. **Never commit this to source control or paste it into a config file checked into a repository.** Resolve it from a secret manager (Vault, AWS Secrets Manager, GCP Secret Manager, or your CI provider's secret store) and inject the value via your OpenClaw config templating, an environment variable consumed by your config loader, or your platform's secret-injection sidecar.
|
|
60
|
+
**Use only for early exploration of the plugin's behaviour. Not for production workloads, regulated environments, real user data, personal data, or any other sensitive information.**
|
|
57
61
|
|
|
58
|
-
|
|
62
|
+
| What goes to `try.getaxonflow.com` | What does NOT |
|
|
63
|
+
|---|---|
|
|
64
|
+
| Tool name + arguments before each governed call | LLM provider API keys |
|
|
65
|
+
| Outbound message bodies before delivery (PII/secret scan) | OpenClaw conversation history outside governed tools |
|
|
66
|
+
| Anonymous 7-day heartbeat (plugin version, OS, runtime) | Files outside the OpenClaw runtime |
|
|
67
|
+
|
|
68
|
+
The endpoint runs against shared Ollama models, rate-limits at 20 req/min · 500 req/day per tenant, and is offered "as is" on a best-effort basis with no SLA, no warranties, no commitment to retention or deletion timelines, and may be modified or discontinued without notice. Read the [Try AxonFlow — Free Trial Server](https://docs.getaxonflow.com/docs/deployment/community-saas/) page for the full disclosure, including [data retention](https://docs.getaxonflow.com/docs/deployment/community-saas/#limitations-and-disclaimers) and [registration mechanics](https://docs.getaxonflow.com/docs/deployment/community-saas/#registration).
|
|
59
69
|
|
|
60
70
|
### Air-gapped: zero outbound
|
|
61
71
|
|
|
@@ -196,7 +206,27 @@ Org-wide policies and session overrides are **Enterprise-only** — those are th
|
|
|
196
206
|
|
|
197
207
|
## Install
|
|
198
208
|
|
|
199
|
-
|
|
209
|
+
This is a **three-step** install: stand up the AxonFlow platform, add the plugin to OpenClaw, then point the plugin at the platform. The plugin alone does not enforce policy — it is a thin client that talks to an AxonFlow agent gateway. If the platform is not installed and reachable, governed tool calls have nothing to evaluate against. **Skipping Step 3 is the most common mistake**: the platform is running locally but the plugin still falls back to Community SaaS because no endpoint is configured.
|
|
210
|
+
|
|
211
|
+
### Step 1: install the AxonFlow platform
|
|
212
|
+
|
|
213
|
+
For any real workload, run AxonFlow on your own infrastructure via Docker Compose:
|
|
214
|
+
|
|
215
|
+
```bash
|
|
216
|
+
git clone https://github.com/getaxonflow/axonflow.git
|
|
217
|
+
cd axonflow && docker compose up -d
|
|
218
|
+
|
|
219
|
+
# verify
|
|
220
|
+
curl -s http://localhost:8080/health | jq .
|
|
221
|
+
```
|
|
222
|
+
|
|
223
|
+
Follow the [Getting Started](https://docs.getaxonflow.com/docs/getting-started/) guide for prerequisites (Docker Engine or Desktop, Docker Compose v2, 4 GB RAM, 10 GB disk) and the [Self-Hosted Deployment Guide](https://docs.getaxonflow.com/docs/deployment/self-hosted/) for production options. For production with real users or clients, run Community Edition with a free 90-day [Evaluation License](https://docs.getaxonflow.com/docs/deployment/evaluation-rollout-guide/) or [AxonFlow Enterprise](https://docs.getaxonflow.com/docs/deployment/community-to-enterprise-migration/).
|
|
224
|
+
|
|
225
|
+
> Skipping Step 1 makes the plugin fall back to the [Community SaaS](https://docs.getaxonflow.com/docs/deployment/community-saas/) endpoint at `try.getaxonflow.com` for early exploration only. **Do not skip Step 1 for any real workload** — see the [Privacy notice](#where-your-data-goes) above.
|
|
226
|
+
|
|
227
|
+
### Step 2: install the plugin
|
|
228
|
+
|
|
229
|
+
Requires OpenClaw **2026.4.15 or later** (CVE floor). Upgrade with `npm install -g openclaw@latest` if needed.
|
|
200
230
|
|
|
201
231
|
```bash
|
|
202
232
|
openclaw plugins install @axonflow/openclaw
|
|
@@ -216,52 +246,41 @@ openclaw plugins install "./$TGZ"
|
|
|
216
246
|
```
|
|
217
247
|
</details>
|
|
218
248
|
|
|
219
|
-
###
|
|
220
|
-
|
|
221
|
-
The plugin connects to AxonFlow, a self-hosted governance platform. AxonFlow must be running before the plugin loads. Everything stays on your infrastructure.
|
|
222
|
-
|
|
223
|
-
```bash
|
|
224
|
-
git clone https://github.com/getaxonflow/axonflow.git
|
|
225
|
-
cd axonflow && docker compose up -d
|
|
226
|
-
```
|
|
227
|
-
|
|
228
|
-
See [Getting Started](https://docs.getaxonflow.com/docs/getting-started/) for production deployment options.
|
|
229
|
-
|
|
230
|
-
---
|
|
231
|
-
|
|
232
|
-
## Configure
|
|
233
|
-
|
|
234
|
-
The plugin works without any configuration. Install it and run a tool — on first run it registers against AxonFlow Community SaaS at `https://try.getaxonflow.com` and persists the resulting credentials to `~/.config/axonflow/try-registration.json` (mode 0600). Every plugin init logs:
|
|
235
|
-
|
|
236
|
-
```
|
|
237
|
-
[AxonFlow] Connected to AxonFlow at https://try.getaxonflow.com (mode=community-saas)
|
|
238
|
-
```
|
|
249
|
+
### Step 3: point the plugin at the platform
|
|
239
250
|
|
|
240
|
-
|
|
251
|
+
Without this step the plugin auto-registers with Community SaaS regardless of whether you ran Step 1 — it does not auto-detect a locally-running AxonFlow. Set `pluginConfig.endpoint` (and `clientId` / `clientSecret` if you have them):
|
|
241
252
|
|
|
242
253
|
```yaml
|
|
243
254
|
# openclaw.config.yaml
|
|
244
255
|
plugins:
|
|
245
|
-
@axonflow/openclaw:
|
|
246
|
-
endpoint: http://localhost:8080
|
|
247
|
-
|
|
248
|
-
- web_fetch
|
|
249
|
-
- message
|
|
256
|
+
"@axonflow/openclaw":
|
|
257
|
+
endpoint: http://localhost:8080 # or your remote AxonFlow URL
|
|
258
|
+
# clientId + clientSecret are required for Evaluation License or Enterprise tenants
|
|
250
259
|
```
|
|
251
260
|
|
|
252
|
-
|
|
261
|
+
Every plugin init logs a one-line canary on stderr confirming the active mode:
|
|
253
262
|
|
|
254
263
|
```
|
|
255
264
|
[AxonFlow] Connected to AxonFlow at http://localhost:8080 (mode=self-hosted)
|
|
256
265
|
```
|
|
257
266
|
|
|
267
|
+
If the canary says `mode=community-saas` after you ran Step 1, the plugin is still hitting `try.getaxonflow.com` because Step 3 was skipped or `pluginConfig.endpoint` is unset. Fix Step 3 and reload.
|
|
268
|
+
|
|
269
|
+
See [Configure](#configure) below for the full pluginConfig schema (`highRiskTools`, `governedTools`, `onError`, `userEmail`, etc.).
|
|
270
|
+
|
|
271
|
+
---
|
|
272
|
+
|
|
273
|
+
## Configure
|
|
274
|
+
|
|
275
|
+
[Step 3](#step-3-point-the-plugin-at-the-platform) above covers the minimum config (`endpoint` + optional `clientId` / `clientSecret`). The full pluginConfig schema is below.
|
|
276
|
+
|
|
258
277
|
### Full configuration reference
|
|
259
278
|
|
|
260
279
|
| Option | Required | Default | Description |
|
|
261
280
|
|--------|----------|---------|-------------|
|
|
262
281
|
| `endpoint` | No | `https://try.getaxonflow.com` (Community SaaS) when unset; `http://localhost:8080` when self-hosted with no endpoint specified | AxonFlow agent gateway URL |
|
|
263
282
|
| `clientId` | No | `"community"` (self-hosted) or auto-bootstrapped `cs_<uuid>` (Community SaaS) | Tenant identity for data isolation. Override for evaluation/enterprise. |
|
|
264
|
-
| `clientSecret` | No | `""` (self-hosted) or auto-bootstrapped (Community SaaS) | Basic-auth secret paired with `clientId`. Required for
|
|
283
|
+
| `clientSecret` | No | `""` (self-hosted) or auto-bootstrapped (Community SaaS) | Basic-auth secret paired with `clientId`. Required for self-hosted Community Edition with an Evaluation License or AxonFlow Enterprise; auto-populated for Community SaaS; can be left unset for self-hosted Community Edition without a license. |
|
|
265
284
|
| `userEmail` | No | — | Per-user identity forwarded on explain/override calls. Shared agents should set this from session context. |
|
|
266
285
|
| `highRiskTools` | No | `[]` | Tools that require human approval even when policy allows |
|
|
267
286
|
| `governedTools` | No | `[]` (all) | Tools to govern. Empty = all tools. |
|
package/dist/index.d.ts
CHANGED
|
@@ -25,7 +25,7 @@
|
|
|
25
25
|
* for async hook support.
|
|
26
26
|
*/
|
|
27
27
|
/** Plugin version — update before each release. */
|
|
28
|
-
export declare const VERSION = "2.0.
|
|
28
|
+
export declare const VERSION = "2.0.4";
|
|
29
29
|
export { AxonFlowClient } from "./axonflow-client.js";
|
|
30
30
|
export type { AxonFlowPluginConfig } from "./config.js";
|
|
31
31
|
export { resolveConfig, shouldGovernTool } from "./config.js";
|
package/dist/index.js
CHANGED
|
@@ -35,7 +35,7 @@ import { bootstrapCommunitySaas } from "./community-saas-bootstrap.js";
|
|
|
35
35
|
import { resetMetrics } from "./metrics.js";
|
|
36
36
|
import { runPluginVersionCheck } from "./plugin-version-check.js";
|
|
37
37
|
/** Plugin version — update before each release. */
|
|
38
|
-
export const VERSION = "2.0.
|
|
38
|
+
export const VERSION = "2.0.4";
|
|
39
39
|
// Re-export for external consumers
|
|
40
40
|
export { AxonFlowClient } from "./axonflow-client.js";
|
|
41
41
|
export { resolveConfig, shouldGovernTool } from "./config.js";
|
package/openclaw.plugin.json
CHANGED
|
@@ -76,6 +76,11 @@
|
|
|
76
76
|
"placeholder": "your-secret",
|
|
77
77
|
"help": "AxonFlow authentication client secret"
|
|
78
78
|
},
|
|
79
|
+
"userEmail": {
|
|
80
|
+
"label": "User Email",
|
|
81
|
+
"placeholder": "alice@example.com",
|
|
82
|
+
"help": "Per-user identity forwarded as the X-User-Email header. Required for the override lifecycle endpoints (createOverride, revokeOverride, listOverrides) and for correct per-user scoping on explainDecision. Block-path features still work without it."
|
|
83
|
+
},
|
|
79
84
|
"highRiskTools": {
|
|
80
85
|
"label": "High-Risk Tools",
|
|
81
86
|
"placeholder": "web_fetch, message",
|
|
@@ -119,6 +124,9 @@
|
|
|
119
124
|
"clientSecret": {
|
|
120
125
|
"type": "string"
|
|
121
126
|
},
|
|
127
|
+
"userEmail": {
|
|
128
|
+
"type": "string"
|
|
129
|
+
},
|
|
122
130
|
"highRiskTools": {
|
|
123
131
|
"type": "array",
|
|
124
132
|
"items": {
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@axonflow/openclaw",
|
|
3
|
-
"version": "2.0.
|
|
3
|
+
"version": "2.0.4",
|
|
4
4
|
"description": "Policy enforcement, approval gates, and audit trails for OpenClaw — govern tool inputs before execution, scan outbound messages for PII/secrets, and record agent activity for review and compliance",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "dist/index.js",
|