diff --git a/profile/README.md b/profile/README.md index 7cd14d0..157910f 100644 --- a/profile/README.md +++ b/profile/README.md @@ -1,8 +1,18 @@ -# Private Monero mining, self-hosted โ€” the whole operation ๐Ÿง…โ›๏ธ +# P2Pool Starter Stack -> An **orchestrator** and the **miners** that feed it. Two open-source projects for running a -> private, optimized **Monero + Tari** mining operation on hardware you own โ€” no custodians, no -> exposed home IP, no hand-tuning. +### Mine Monero privately, on hardware you own โ€” the whole operation, in one command. ๐Ÿง…โ›๏ธ + +[![Pithead release](https://img.shields.io/github/v/release/p2pool-starter-stack/pithead?sort=semver&display_name=tag&label=Pithead&color=F26822&logo=github)](https://github.com/p2pool-starter-stack/pithead/releases/latest) +[![RigForge release](https://img.shields.io/github/v/release/p2pool-starter-stack/rigforge?sort=semver&display_name=tag&label=RigForge&color=ff5236&logo=github)](https://github.com/p2pool-starter-stack/rigforge/releases/latest) +[![License: MIT](https://img.shields.io/badge/license-MIT-yellow)](https://github.com/p2pool-starter-stack) + +> Two open-source projects for running a **private, optimized Monero + Tari mining operation** at +> home: an **orchestrator** ([Pithead](https://github.com/p2pool-starter-stack/pithead)) and the +> **miners** that feed it ([RigForge](https://github.com/p2pool-starter-stack/rigforge)). Decentralized, +> **zero-fee P2Pool** payouts straight to your own wallet, all behind **Tor** โ€” no custodians, no +> exposed home IP, no pool fees, no hand-tuning. + +**๐ŸŒ [p2pool-starter-stack.github.io](https://p2pool-starter-stack.github.io/)** ยท free & MIT ยท no token ยท no premine ยท no VC ยท Tor-first --- @@ -13,24 +23,24 @@ A professional-grade, containerized stack that runs a private Monero full node, **P2Pool**, **Tari** merge mining, a single mining endpoint, and a live dashboard โ€” all behind **Tor**, in one command. -- ๐Ÿง… **Private by default** โ€” Tor hidden services for Monero, Tari, and P2Pool; no port forwarding, no exposed IP. -- โ›๏ธ **Monero + Tari, merge-mined** โ€” earn on both chains at once, with zero extra effort. -- ๐Ÿง  **Algorithmic yield optimization** โ€” continuously splits your hashrate between P2Pool and XMRvsBeast bonus rounds to maximize return. -- ๐Ÿ”Œ **One endpoint for every rig** โ€” all your miners point at a single address; the stack routes hashrate upstream. -- ๐Ÿ“Š **A dashboard that actually tells you things** โ€” live hashrate, sync progress, PPLNS window, and per-worker stats, served over HTTPS on your LAN. -- ๐Ÿ”’ **Hardened out of the box** โ€” least-privilege containers, SHA256-verified pinned binaries, and tightly scoped Docker-socket proxies. +- ๐Ÿง… **Private by default** โ€” Tor hidden services for Monero, Tari, and P2Pool; your router stays shut and your home IP is never advertised to an inbound peer. +- โ›๏ธ **Monero + Tari, merge-mined** โ€” every hash mines Monero on zero-fee P2Pool and merge-mines Tari at once: a second payout for zero extra power or config. +- ๐Ÿง  **Algorithmic yield optimization** โ€” watches the XMRvsBeast raffle and shifts hashrate to grab bonus rounds, donating only the minimum to hold your tier, then handing every spare cycle back to your own P2Pool payouts. +- ๐Ÿ”Œ **One endpoint for every rig** โ€” all your miners point at a single address; no wallet in the miner, no per-rig pool config. +- ๐Ÿ“Š **A dashboard worth leaving open** โ€” live hashrate, the P2Pool/XvB split shading in real time, the PPLNS window, an honest tier + explicit VIP status, and per-worker stats, served over HTTPS on your LAN. +- ๐Ÿ”’ **Hardened out of the box** โ€” least-privilege containers, SHA256-verified pinned binaries, and tightly scoped Docker-socket proxies (read-only for stats, start/stop-only for failover). ### ๐Ÿ”ฅ [RigForge](https://github.com/p2pool-starter-stack/rigforge) โ€” the miners -Turn any machine into a tuned mining worker in one command. RigForge builds stock **XMRig** from -source, applies CPU- and kernel-level tuning for maximum RandomX hashrate, and runs it as a managed -service โ€” then points it at your stack. +Turn any Ubuntu/Debian โ€” or macOS โ€” machine into a tuned mining worker in one command. RigForge +compiles stock, commit-pinned **XMRig** from source, applies CPU- and kernel-level tuning for maximum +RandomX hashrate, and runs it as a managed service โ€” then points it at your stack, or any RandomX pool. -- โšก **One command** from bare metal to a running, tuned miner. -- ๐Ÿง  **Hardware-aware** โ€” detects your CPU (AMD EPYC, Ryzen X3D, โ€ฆ) and applies a matching performance profile. -- โš™๏ธ **Kernel-tuned** โ€” HugePages (1 GB / 2 MB), MSR access, and NUMA binding, done for you. -- ๐Ÿ”ง **Managed** โ€” runs as a `systemd` service with a performance governor and automatic log rotation. -- ๐Ÿ”— **Plug-and-play** โ€” connects to Pithead, or any RandomX Stratum pool. +- โšก **One command** from bare metal to a running, tuned miner โ€” on Ubuntu/Debian or macOS. +- ๐Ÿ“ˆ **Measurably faster, and cooler** โ€” +3.5% hashrate and +7.6% efficiency on a Ryzen 7800X3D, measured live against stock XMRig (and +6.6% on a 48-core EPYC). +- ๐Ÿง  **Hardware-aware** โ€” detects your CPU (AMD EPYC, Ryzen X3D, โ€ฆ), applies a matching profile, then live-A/Bs the hardware prefetcher to keep the fastest. +- โš™๏ธ **Kernel-tuned (Linux)** โ€” HugePages (1 GB / 2 MB), MSR access, NUMA binding, and a performance governor, done for you. +- ๐Ÿ”— **Plug-and-play** โ€” connects to Pithead, or any RandomX Stratum pool. Stock XMRig pinned to a verified commit โ€” no custom binary, a 0% dev fee, idempotent re-runs. ### ๐Ÿ”— How they fit together @@ -46,12 +56,48 @@ privacy, payouts, and optimization; the miners just hash. --- +## โ“ Common questions + +**How do I mine Monero privately at home?** +Run the P2Pool Starter Stack. One command stands up a private Monero full node, P2Pool, and a single +mining endpoint behind Tor โ€” your home IP is never advertised to an inbound peer and you never forward +a port. Point any XMRig rig (or a RigForge worker) at it and you're mining straight to your own wallet, +no account and no custodian. + +**Do I have to forward ports or expose my home IP?** +No. Monero, Tari, and P2Pool run as Tor hidden services, so inbound peers reach you over an onion +address and your router stays shut; RPC is localhost-bound. The few outbound yield paths still on +clearnet in v1.0 are mapped in the privacy guide and move to Tor-by-default in v1.1. + +**What is P2Pool, and why mine to it instead of a centralized pool?** +P2Pool is a decentralized, peer-to-peer Monero mining pool: no operator, no account, and no pool fee โ€” +the network pays block rewards straight to your own wallet. The stack runs your own P2Pool node, so you +get decentralized, zero-fee payouts without the fiddly setup. + +**Is it free? Are there any fees?** +Yes โ€” free and MIT-licensed. P2Pool charges no pool fee, and RigForge compiles stock XMRig with the +dev-fee pinned to 0%. No token, no premine, no VC โ€” just an optional Monero donation if a stack saves +you time. + +**Can I point my existing XMRig miners at it?** +Yes โ€” point any XMRig or RandomX rig at the stack's single endpoint (`host:3333`), no wallet in the +miner. For maximum hashrate, RigForge provisions a kernel-tuned XMRig worker in one command +(+3.5% hashrate / +7.6% efficiency on a Ryzen 7800X3D vs stock). + +**What hardware do I need?** +Stack host: Ubuntu Server 24.04, 16 GB+ RAM, an SSD (~300 GB pruned; 2โ€“4 TB for set-and-forget). +Mining itself is CPU-bound โ€” Monero's RandomX runs on any modern AMD/Intel CPU, and large-L3 chips +(Ryzen X3D, EPYC) shine. RigForge tunes per-CPU automatically. + +--- + ## ๐Ÿ› ๏ธ How we build A few principles you'll see throughout the code: -- **Privacy is the default, not a setting.** Tor-only upstreams, localhost-bound RPC, and no public - port forwarding. You opt *out* of privacy โ€” never *in*. +- **Privacy is the default, not a setting.** Inbound rides Tor hidden services โ€” no port forwarding, + your home IP never advertised to a peer โ€” and RPC is localhost-bound. The few outbound paths that + still touch clearnet in v1.0 are mapped in the privacy guide and move to Tor-by-default in v1.1. - **Least privilege, everywhere.** Capability-scoped containers, a read-only Docker-socket proxy kept separate from a start/stop-only one, owner-only secrets. Nothing gets more access than it needs. @@ -71,5 +117,7 @@ A few principles you'll see throughout the code: - **New to this?** โ†’ [**Pithead**](https://github.com/p2pool-starter-stack/pithead) gets the whole operation running in one command. - **Already have the stack?** โ†’ [**RigForge**](https://github.com/p2pool-starter-stack/rigforge) provisions your miners. +- **Want the overview?** โ†’ [**p2pool-starter-stack.github.io**](https://p2pool-starter-stack.github.io/) -Everything here is **MIT-licensed** and built in the open. Issues and pull requests are welcome. +Both projects are at their **v1.0** โ€” RigForge complete, Pithead feature-complete and through its +release gate. Everything here is **MIT-licensed** and built in the open. Issues and pull requests are welcome.