Skip to content

Quick Start never mentions the sister API the enriched coordinator setup expects #345

Description

@VijitSingh97

Quick Start gap found by walking the coordinator's expectations against a bare-minimum rig: a coordinator configured with workers.api_auth: "name" (the documented enriched setup) expects each rig's sister API (api: enabled, ACCESS_TOKEN = rig name). A rig built strictly from the Quick Start ships with the sister API off — it appears in Workers Alive via :8080, but never gets the RigForge version/health/tune/watchdog chips, and nothing tells the rig owner why.

One paragraph in the Quick Start ("if your coordinator dashboard shows the rig without RigForge details, enable the api block — here's the snippet") closes it. Alternatively default api: enabled on new configs — that's a defaults decision for the maintainer, the doc line is the floor.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions