A unified setup wizard and monitoring dashboard for Stratum V2 mining.
docker run -d \
--name sv2-ui \
-p 8080:8080 \
-e HOST_HOME=$HOME \
-v /var/run/docker.sock:/var/run/docker.sock \
-v sv2-config:/app/data/config \
stratumv2/sv2_ui:mainThen open http://localhost:8080 (or your machine's IP). On first run, you'll be guided through the setup wizard.
Important:
- The
-e HOST_HOME=$HOMEis required for Job Declaration mode to locate your Bitcoin Core socket - The
-v /var/run/docker.sock:/var/run/docker.sockmount is required so sv2-ui can manage the Translator and JDC containers - The
-v sv2-config:/app/data/configvolume is shared with the Translator/JDC containers for configuration files
docker run -d --name sv2-ui -p 8080:8080 \
-e HOST_HOME=$HOME \
-v /var/run/docker.sock:/var/run/docker.sock \
-v sv2-config:/app/data/config \
stratumv2/sv2_ui:mainMount the appropriate Docker socket for your setup:
# Colima
docker run -d --name sv2-ui -p 8080:8080 \
-e HOST_HOME=$HOME \
-v $HOME/.colima/default/docker.sock:/var/run/docker.sock \
-v sv2-config:/app/data/config \
stratumv2/sv2_ui:main
# OrbStack
docker run -d --name sv2-ui -p 8080:8080 \
-e HOST_HOME=$HOME \
-v $HOME/.orbstack/run/docker.sock:/var/run/docker.sock \
-v sv2-config:/app/data/config \
stratumv2/sv2_ui:maindocker stop sv2-ui && docker rm sv2-ui# Install dependencies (includes server workspace)
npm install
# Make sure Docker Desktop / Docker Engine is running
# Start frontend + backend
npm run devThen open http://localhost:5173. On first run, you'll be guided through the setup wizard.
The backend auto-detects common local Docker sockets, including /var/run/docker.sock and ~/.docker/run/docker.sock. To override detection, set DOCKER_SOCKET_PATH or DOCKER_HOST before starting the server.
-
Setup Wizard - Guides you through configuration
- Choose Solo or Pool mining
- Select a pool (Braiins, SRI, etc.)
- Configure your username/Bitcoin address
- For JD mode: configure Bitcoin Core connection
-
Docker Orchestration - Starts and manages containers
- Translator Proxy (SV1 to SV2 translation)
- JD Client (for custom block templates, optional)
-
Monitoring Dashboard - Real-time stats
- Total hashrate from connected miners
- Active workers
- Shares to pool
- Hashrate history chart
Pool Mining (No-JD)
Pool ← Translator ← SV1 Miners
Pool Mining with Job Declaration
Pool ← JDC ← Translator ← SV1 Miners
↑
Bitcoin Core (your node creates block templates)
Solo Mining
Solo Pool ← Translator ← SV1 Miners
| Pool | Mode | Status |
|---|---|---|
| Braiins Pool | Pool (No-JD) | Available |
| SRI Pool | Pool (JD) | Testing |
| SRI Solo Pool | Solo | Available |
| Blitzpool | Solo | Coming Soon |
# Build for production
npm run build:allsv2-ui/
├── src/ # React frontend
│ ├── components/
│ │ ├── setup/ # Setup wizard steps
│ │ ├── settings/ # Settings page components
│ │ ├── data/ # Dashboard components
│ │ └── ui/ # Base UI primitives
│ ├── hooks/ # React hooks
│ └── pages/ # Page components
├── server/ # Node.js backend
│ └── src/
│ ├── index.ts # Express API
│ ├── docker.ts # Docker orchestration
│ └── config-generator.ts # TOML config generation
├── Dockerfile # Multi-stage build
└── public/ # Static assets
stratumv2/translator_sv2:main- Translator Proxystratumv2/jd_client_sv2:main- JD Client
| Port | Service | Description |
|---|---|---|
| 3000 | sv2-ui | Web UI |
| 34255 | Translator | SV1 miners connect here |
| 9092 | Translator | Monitoring API |
| 34265 | JDC | Translator connects here (JD mode) |
| 9091 | JDC | Monitoring API (JD mode) |
- React 18 + TypeScript - Frontend
- Vite - Build tool
- Tailwind CSS - Styling
- React Query - Data fetching
- Express - Backend API
- Dockerode - Docker orchestration
- stratum-mining/sv2-apps - Translator, JDC, Pool, JDS
- stratum-mining/stratum - SV2 protocol implementation
MIT OR Apache-2.0