vrr/openclaw
2
0
Fork 0
mirror of https://github.com/openclaw/openclaw.git synced 2026-09-10 18:38:00 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 21
openclaw/docs/plugins/reference/crabbox.md
Vincent Koc cc358246f6
docs(gateway): split the configuration reference by domain (#140440) 
The configuration reference was 2,077 lines / 146,192 characters with 55
headings, roughly seven times the 20k split threshold and well past the
40-heading split signal. It is now a short index parent plus nine
domain pages. No prose was rewritten: every moved H2 section body is
byte-identical to its source.

Children (all moved verbatim from configuration-reference.md):

- gateway/config-runtime (1,117 words): worktreeRoot, Models, Discovery,
  Update, ACP, Wizard, Bridge (legacy, removed)
- gateway/config-extensions (2,221 words): MCP, Skills, Plugins,
  Canvas widget presenter
- gateway/config-browser-ui-desktop (2,012 words): Browser, UI, Desktop
- gateway/config-gateway (3,600 words): Gateway, incl. OpenAI-compatible
  endpoints, multi-instance isolation, gateway.tls, gateway.reload
- gateway/config-cloud-workers (1,495 words): Cloud worker environments
- gateway/config-hooks (3,273 words): Hooks, incl. HTTP contract, agent
  payload, session policy, mapping, retries and fan-out, Gmail
- gateway/config-secrets-env (1,042 words): Environment, Secrets,
  Auth storage, Config includes ($include)
- gateway/config-observability (1,190 words): Audit, Logging,
  Diagnostics, Telemetry
- gateway/config-automation (958 words): Automations (cron), Media model
  template variables

Anchor preservation. docs.json redirects match on pathname only - 0 of
the 281 existing redirects carry a fragment in `source`, and fragments
never reach a redirect matcher - so no path redirect is added and the
parent keeps its route. Instead every anchor stays resolvable on
/gateway/configuration-reference: all 32 original H2 headings remain as
one-line pointer sections, and all 23 original H3 anchors are retained
as authored <a id> stubs (the pattern already used in
docs/help/faq-first-run.md). All 46 anchored in-repo references across
27 files are rewritten to the child page that now owns the heading;
docs-link-audit --anchors reports 8,717 links checked, 0 broken.

Losslessness (parent + nine children vs. the old single file):

- code fences: 40 -> 40
- MDX components: 4 -> 4
- distinct config keys documented: 490 -> 511 (0 lost, 21 gained from
  the new index text)
- words: 16,756 -> 17,542 (+786, all new index and lede text)
- headings: 55 -> 83 (55 original + 27 pointer H2 + 1 index H2)
- parent page: 2,077 -> 226 lines, 146,192 -> 9,701 chars, 55 -> 33
  headings

src/docs/cloud-workers-config.test.ts pinned the cloudWorkers examples
to configuration-reference.md by path; it now names
config-cloud-workers.md. Twelve zh-CN glossary entries were added for
the new and existing "Configuration - <domain>" page titles.

Closes audit findings: r3-0286, r3-1510
2026-09-07 05:18:18 +08:00

1.4 KiB
Raw Permalink Blame History

summary read_when title
Cloud worker provider backed by the Crabbox CLI.
You are installing, configuring, or auditing the crabbox plugin
Crabbox plugin reference

Cloud worker provider backed by the Crabbox CLI.

Distribution

  • Package: @openclaw/crabbox-provider
  • Install route: included in OpenClaw

Surface

  • CLI commands: openclaw crabbox
  • Contracts: workerProviders

Configure

See Cloud worker environments for the profile schema and lifecycle notes.

Forward Gateway environment variables to an operator-provided setup script by listing their names in the Crabbox profile settings:

{
  setup: 'install-worker "$OPENCLAW_WORKER_ARTIFACT_TOKEN"',
  setupEnv: ["OPENCLAW_WORKER_ARTIFACT_TOKEN"],
}

setupEnv explicitly forwards up to 16 unique environment variable names to the setup command only. Values are read from the Gateway process environment and are never stored in the profile configuration. Missing variables fail before a machine is allocated.