Snider/Mining
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
Mining/site-docs/getting-started/quickstart.md
snider 3057701ac1 feat: Add SQLite persistence, enhanced dashboard UI, and comprehensive E2E tests 
- Add SQLite database package for hashrate history persistence with configurable retention
- Enhance dashboard with responsive stats bar, improved chart component, and worker selector
- Add terminal modal component for console output viewing
- Implement comprehensive E2E test suite with page objects pattern
- Add history API endpoints for historical data queries
- Update worker message handling with proper registration
- Add new UI pages structure with layouts and components
- Update Docker configuration for Go 1.24
- Add PostCSS configuration for Tailwind CSS processing

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

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

2.3 KiB
Raw Blame History

Quick Start Guide

Get mining in 5 minutes with this quick start guide.

Step 1: Start the Server

./miner-cli 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