Skip to content

Commit fbc85bc

Browse files
VijitSingh97claude
andauthored
docs(readme): showcase the full feature + config surface (#610)
The front-page feature list predated a lot of what shipped. Add the telemetry/history store (#196), the depth of the in-browser config editor (guided form + JSON + upload, per-rig inspect + config-version hashrate correlation, #529/#518/#492), the configurability breadth (~94 keys across 13 sections), the energy/profit calculator (#260), and encrypted backups (#374). House voice, accurate to what ships — no invented features, no banned marketing words. Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
1 parent 29841a4 commit fbc85bc

1 file changed

Lines changed: 17 additions & 4 deletions

File tree

README.md

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -36,18 +36,31 @@ a Tor daemon. The `pithead` script renders config, provisions Tor, and drives do
3636
guide](docs/privacy.md) maps every connection.
3737
- 🔌 **One endpoint for every rig.** Point all workers at a single address on port `3333`. No wallet
3838
address in the miner config; the stack routes the hashrate.
39-
- 📊 **Live dashboard, now with config editing.** Hashrate, the P2Pool/XvB split, the PPLNS window,
40-
and per-worker updates over HTTPS on your LAN. Opt in with `dashboard.control.enabled` to edit
41-
`config.json`, one-click upgrade to a new release, and watch the access + config-change audit logs
42-
from the browser — every change gated host-side behind a login. See
39+
- 📊 **Live dashboard, with history.** Hashrate, the P2Pool/XvB split, the PPLNS window, and
40+
per-worker stats over HTTPS on your LAN — and a time-series store keeps blocks found, XvB credit,
41+
network difficulty, disk growth, and per-rig hashrate as trends, not just the latest reading.
42+
- 🎛️ **Configure and tune from the browser.** Opt in with `dashboard.control.enabled` to edit
43+
`config.json` from a guided form — or raw JSON, with file upload — inspect and retune each rig,
44+
see how a rig's hashrate tracks each config version, one-click upgrade to a new release, and read
45+
the access and config-change audit logs. Every change is gated host-side behind a login. See
4346
[The Dashboard](docs/dashboard.md).
47+
- ⚙️ **One config, tuned to your setup.** A local or remote Monero node, pruned or full; the P2Pool
48+
tier (`main`, `mini`, or `nano`); XvB donation strategy; per-worker power and API settings; four
49+
alert channels; timezone, memory limits, and every privacy toggle — around 94 keys across 13
50+
sections, all in one `config.json` and validated on every `apply`. Most have defaults you'll never
51+
touch. See [Configuration](docs/configuration.md).
52+
- 💡 **Energy-aware earnings.** Set your electricity cost and XMR price and add each rig's watts; the
53+
Energy tab shows fleet power draw, efficiency in hashes per watt, and estimated profit after power.
4454
- 📟 **Telegram operator bot.** Opt-in alerts for a downed node, a worker that dropped off, sync
4555
finishing, low disk, a clearnet leak, or a sustained hashrate drop — plus a daily digest and
4656
read-only commands (`/status`, `/hashrate`, `/workers`, `/earnings`). Routed over Tor. The same
4757
alerts also push to a generic JSON webhook or an [ntfy](https://ntfy.sh) topic. See the
4858
[Telegram guide](docs/telegram.md).
4959
- 🔔 **Dead-man's switch.** An optional [Healthchecks.io](https://healthchecks.io/) ping tells you
5060
when the whole box goes dark — the one failure a monitor running *on* that box can never report.
61+
- 💾 **Encrypted backups.** `./pithead backup` writes config, secrets, and onion keys to a single
62+
AES-256 archive (the blockchains too, with `--with-chains`); `restore` brings a box back on new
63+
hardware with the same onion address.
5164
- 🚀 **Interactive setup.** `./pithead setup` checks dependencies, writes config, provisions Tor, and
5265
(on Linux) tunes HugePages for RandomX. It prompts before any GRUB change, then offers to start.
5366
- 🔒 **Hardened defaults.** Non-root containers, SHA256-verified binaries, digest-pinned base and

0 commit comments

Comments
 (0)