docs: stratum authentication against a Pithead stack (set the pool pass)#97
Merged
Conversation
Pithead added an optional stratum password (p2pool.stratum_password, pithead#152/#207): when the operator turns it on, the stack's :3333 proxy rejects any rig whose stratum 'pass' doesn't match (XMRig logs "Permission denied"). RigForge already carries the secret — pools[].pass is XMRig's native field (default "x") — so this is documentation, not a code change. - docs/pithead-integration.md: new "Stratum authentication (optional)" subsection under the mining connection — set pools[].pass to the stack's p2pool.stratum_password, where to find the value (printed by pithead apply/setup, in .env, shown by pithead status), and the cleartext-over-LAN caveat. Cross-links pithead docs/workers.md#authentication. Plus a troubleshooting row for the "Permission denied" symptom. - docs/configuration.md: the pools[].pass reference now explains the stratum-password use case instead of just showing the default. - tests: assert a Pithead-style password (auto-generated hex, and a literal with the . _ : @ - punctuation Pithead allows) flows through verbatim as the pool pass — the cross-repo contract that a stack-side secret is always a valid XMRig pass. Refs pithead#152, pithead#207, pithead#208. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Companion to pithead#207, which adds an optional stratum password
(
p2pool.stratum_password) to the stack. When the operator turns it on, the stack's:3333proxy rejects any rig whose stratumpassdoesn't match — XMRig logsPermission deniedand the rig won't mine.RigForge already carries the secret:
pools[].passis XMRig's native field (default"x"). So this is documentation + a contract test, not a code change.What's here
docs/pithead-integration.md— new Stratum authentication (optional) subsectionunder the mining connection: set the rig's
pools[].passto the stack'sp2pool.stratum_password, where to find the value (printed bypithead apply/setup,stored in the stack
.env, shown bypithead status), and the cleartext-over-LANcaveat. Plus a troubleshooting row for the
Permission deniedsymptom. Cross-links thestack's
docs/workers.md#authentication.docs/configuration.md— thepools[].passreference now explains thestratum-password use case instead of just showing the default.
. _ : @ -punctuation Pithead's validator allows) flows through verbatim as the poolpass. This pins the cross-repo contract: a stack-side secret is always a valid XMRigpass (RigForge validates
passas any printable non-space, a superset of Pithead'scharset). Suite stays green (545), lint clean.
Test plan
make lint test-suite— 545 pass, shellcheck + shfmt clean#stratum-authentication-optional,#pools-full-control)Refs pithead#152, pithead#207, pithead#208 (the default-on / auto-fetch follow-up).