Skip to content

docs(quickstart): point enriched-coordinator setups at the sister API (#345) #385

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
VijitSingh97 merged 3 commits into from
Aug 21, 2026
Merged

docs(quickstart): point enriched-coordinator setups at the sister API (#345) #385

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
75394b3
docs: add sister API setup to Quick Start (#345)
VijitSingh97 Aug 21, 2026
01f7190
docs(quickstart): the sister API activates on Linux rigs only — say s…
VijitSingh97 Aug 21, 2026
3a3b33c
Merge branch 'develop' into fix/345-quickstart-sister-api
VijitSingh97 Aug 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions docs/getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,6 +136,26 @@ grep -i msr data/worker/xmrig.log # MSR mod applied (no errors)

---

## 6. Connect to Pithead dashboard (optional)

Running a [Pithead](https://github.com/p2pool-starter-stack/pithead) stack? The dashboard discovers workers from the mining connection, but to show enriched stats (RigForge version, health probes, tune state, watchdog status), each rig's **sister API** must be enabled. If your worker appears in **Workers Alive** without these status chips, the sister API is off.

Enable it by adding an `api` block to `config.json`, with `ACCESS_TOKEN` set to your rig's pool `user` (the dashboard label):

```json
{
"pools": [
{ "url": "your-stack:3333", "user": "garage-rig" }
],
"api": "enabled",
"ACCESS_TOKEN": "garage-rig"
}
```

Then, on the Linux rig, `sudo ./rigforge.sh apply` activates the sister API on `:8081` (the sister API is part of the Linux service install — a macOS dev build accepts the config but runs no API). Set `ACCESS_TOKEN` to match the rig name so Pithead can use `workers.api_auth: name` mode (the simplest setup). For other token strategies and the full API contract, see [Pithead Integration › Sister API](pithead-integration.md#sister-api-optional-8081).

---

## Next steps

- [Configuration](configuration.md): every config key, and how the XMRig config is generated.
Expand Down