Reference for provisioning, configuring, and operating a RigForge mining worker.
New here? Start with the Getting Started guide. It takes you from a fresh Ubuntu machine to a tuned, running XMRig worker in one command. The other guides go deeper on individual topics once you're up and running.
| Guide | What it covers |
|---|---|
| Getting Started | Prerequisites, installation, first-run setup, the Linux reboot, and how to verify the worker is mining. |
| Hardware Requirements | Worker CPU / RAM / HugePages requirements and the per-CPU tuning profiles RigForge applies. |
| Benchmarks | Measured stock-vs-tuned hashrate and efficiency (H/s per watt) on real hardware, mining live, with the method and caveats. |
| Configuration | Every config.json key and default, minimal vs. advanced setups, and how the XMRig config is generated. |
| Operations & Maintenance | The full command reference, service management, logs, upgrades, and troubleshooting. |
| How It Works | What the script actually does: dependencies, compile-from-source, HugePages, MSR, NUMA, the governor, and the systemd service. |
| Pithead Integration | The worker ↔ dashboard contract: discovery via :3333, the read-only HTTP API on :8080, and the token rules. |
| FAQ | Common questions, plus why RigForge vs. setting XMRig up by hand. |
For how RigForge is versioned and released, see RELEASING.md and
CHANGELOG.md.
Significant, cross-cutting decisions are recorded as ADRs under adr/:
- ADR 0001: Writable worker-config control path — Accepted. How the stack applies config changes through RigForge without breaking the read-only sister API.
- ADR 0002: Remote worker-upgrade control path — Proposed. Opt-in remote RigForge upgrade for the stack (#308), extending ADR 0001 from a tuning surface to a code-update one; hash-only trust, no signing.
- Just want to start mining? → Getting Started
- What do I run day to day? → Operations › Common tasks
- Redeploy after a
git pull? → Operations › Upgrading - Run a live tune now? → Operations › Live auto-tuning
- Will my CPU do well? → Hardware Requirements
- How much does the tuning help? → Benchmarks
- Change a setting? → Configuration
- Mining to a public pool (SupportXMR, etc.)? → Configuration › Connecting to a public pool
- Connecting to a Pithead stack? → Pithead Integration
- Something's not working? → Operations › Troubleshooting