Snider/Mining
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
Mining/site-docs/getting-started/quickstart.md
snider 69376b886f feat: Rebrand xmrig to miner and vendor XMRig ecosystem 
Complete rebranding of all components:
- Core miner: xmrig -> miner (binary, version.h, CMakeLists.txt)
- Proxy: xmrig-proxy -> miner-proxy
- CUDA plugin: xmrig-cuda -> miner-cuda
- Heatmap: xmrig-nonces-heatmap -> miner-nonces-heatmap
- Go CLI wrapper: miner-cli -> miner-ctrl

Vendored XMRig ecosystem into miner/ directory:
- miner/core - XMRig CPU/GPU miner
- miner/proxy - Stratum proxy
- miner/cuda - NVIDIA CUDA plugin
- miner/heatmap - Nonce visualization tool
- miner/config - Configuration UI
- miner/deps - Pre-built dependencies

Updated dev fee to use project wallet with opt-out (kMinimumDonateLevel=0)
Updated branding to Lethean (domain, copyright, version 0.1.0)

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2025-12-30 19:43:02 +00:00

2.3 KiB
Raw Permalink Blame History

Quick Start Guide

Get mining in 5 minutes with this quick start guide.

Step 1: Start the Server

./miner-ctrl serve

This starts:

Step 2: Install a Miner

Navigate to Miners in the sidebar and click Install on XMRig (or TT-Miner for GPU mining).

Miners Page

The miner will be downloaded and extracted automatically.

Step 3: Create a Profile

Go to Profiles and click New Profile:

New Profile

Fill in:

Field Description Example
Profile Name Friendly name "My XMR Pool"
Miner Type Select miner xmrig
Pool Address Mining pool URL pool.supportxmr.com:3333
Wallet Address Your XMR wallet 4xxx...
TLS Enable encryption ✓ Recommended

Click Create Profile.

Step 4: Start Mining

Two ways to start:

  1. From Profiles: Click the Start button on your profile card
  2. From Workers: Select a profile from the dropdown and click Start

Workers Page

Step 5: Monitor Your Miner

Dashboard

The Dashboard shows real-time stats:

Dashboard

  • Hashrate - Current mining speed
  • Shares - Accepted/rejected shares
  • Uptime - How long the miner has been running
  • Avg Diff - Average difficulty per share
  • Pool - Connected pool

Console

View live miner output in the Console:

Console

Send commands to the miner using the input field:

Command Action
h Show hashrate
p Pause mining
r Resume mining
s Show results
c Show connection info

Common Pool Addresses

Pool Address
SupportXMR pool.supportxmr.com:3333
MoneroOcean gulf.moneroocean.stream:10128
2Miners xmr.2miners.com:2222
HashVault pool.hashvault.pro:3333

Next Steps