Skip to content

Extract the worker kit into its own repo (RigForge); keep a connection guide here#74

Merged
VijitSingh97 merged 1 commit into
mainfrom
claude/extract-worker-rigforge
Jun 3, 2026
Merged

Extract the worker kit into its own repo (RigForge); keep a connection guide here#74
VijitSingh97 merged 1 commit into
mainfrom
claude/extract-worker-rigforge

Conversation

@VijitSingh97
Copy link
Copy Markdown
Collaborator

Executes the worker split proposed in #71. The worker provisioning kit now lives in its own repository — p2pool-starter-stack/rigforge — and this repo keeps just enough to connect miners to the orchestrator.

Why

As detailed in #71, the worker was never really part of this project's codebase — it's stock upstream XMRig plus setup scripts, on a different machine, with a different toolchain, coupled to the stack only by the host:3333 Stratum contract. This repo is the orchestrator; miners are separate.

The new repo: RigForge

github.com/p2pool-starter-stack/rigforge (public, MIT) — "provision a hardware-tuned XMRig miner in one command."

  • The kit moved wholesale: rigforge.sh (renamed from p2pool-starter-worker.sh), templates, util/, systemd/.
  • Self-contained, RigForge-branded README (capabilities, hardware requirements, connecting, deployment, maintenance, verification).
  • Added LICENSE (MIT), .gitignore, and a shellcheck CI workflow. Fixed two pre-existing shellcheck warnings (SC2046, SC2155) the parent never linted.

What changes here

  • Remove worker/ (6 files, ~850 lines) — it lives in RigForge now.
  • Rewrite docs/workers.md → "Connecting Miners": a complete guide for people who already run XMRig (the 3333 endpoint, minimal config, multiple rigs, mDNS, firewall, dashboard appearance, and an explicit "any recent XMRig works — no required miner version" note), then point newcomers to RigForge to provision a tuned miner from scratch.
  • Repoint every worker-kit link (README, docs index, getting-started, hardware) to RigForge; rename the "Adding Workers" nav to "Connecting Miners".
  • Drop the now-dead /worker/* entries from .gitignore.

Miner ↔ stack version compatibility (per your question)

Checked the proxy and p2pool: there's no required miner version. xmrig-proxy is "compatible with any pool and any miner that supports NiceHash" (XMRig enables that automatically behind a proxy), and RandomX has shipped in XMRig since 5.0. So the stack's pinned xmrig-proxy 6.26.0 / p2pool v4.15.1 don't dictate a worker version — now documented in docs/workers.md.

Closes #71.

🤖 Generated with Claude Code

…e here

Executes the worker split (#71): the worker provisioning kit now lives in its
own repository, github.com/p2pool-starter-stack/rigforge. This repo keeps just
enough to connect miners to the orchestrator.

- Remove worker/ (the kit moved to RigForge, with its script renamed rigforge.sh,
  a self-contained README, MIT LICENSE, .gitignore, and shellcheck CI).
- Rewrite docs/workers.md → "Connecting Miners": a complete guide for people who
  already run XMRig (the 3333 endpoint, minimal config, multi-rig, mDNS,
  firewall, dashboard, and an explicit "any recent XMRig works — no required
  miner version" note), then point newcomers to RigForge to provision a tuned
  miner from scratch.
- Repoint every worker-kit link (README, docs index, getting-started, hardware)
  to the RigForge repo; rename the "Adding Workers" nav to "Connecting Miners".
- Drop the now-dead /worker/* entries from .gitignore.

Miner-vs-stack-version compatibility: xmrig-proxy and P2Pool accept any Stratum
miner that supports NiceHash (XMRig does so automatically behind a proxy), so the
stack's pinned proxy (6.26.0) / p2pool (v4.15.1) versions don't dictate a worker
version — documented in docs/workers.md.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@VijitSingh97 VijitSingh97 merged commit f68ad04 into main Jun 3, 2026
5 checks passed
VijitSingh97 added a commit that referenced this pull request Jun 4, 2026
The worker kit was extracted to the RigForge repo (#71/#74), but a stale worker/ dir
can linger locally with miner runtime logs/state until that cutover is finished.
It wasn't ignored, so `git add -A` would sweep in those (sometimes very large) files.
Nothing under worker/ is tracked, so ignoring it is safe.

Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Extract the worker provisioning kit (worker/) into its own repository

1 participant