3057701ac1
- 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>
92 lines
1.9 KiB
Markdown
92 lines
1.9 KiB
Markdown
# Installation
|
|
|
|
This guide covers installing the Mining Dashboard on your system.
|
|
|
|
## Prerequisites
|
|
|
|
- **Go 1.21+** - For building the backend
|
|
- **Node.js 18+** - For building the frontend (optional, pre-built included)
|
|
- **Git** - For cloning the repository
|
|
|
|
## Quick Install
|
|
|
|
### From Source
|
|
|
|
```bash
|
|
# Clone the repository
|
|
git clone https://github.com/Snider/Mining.git
|
|
cd Mining
|
|
|
|
# Build the CLI binary
|
|
make build
|
|
|
|
# The binary is now at ./miner-cli
|
|
./miner-cli --help
|
|
```
|
|
|
|
### Build Commands
|
|
|
|
| Command | Description |
|
|
|---------|-------------|
|
|
| `make build` | Build the CLI binary |
|
|
| `make build-all` | Build for all platforms (Linux, macOS, Windows) |
|
|
| `make test` | Run tests with coverage |
|
|
| `make lint` | Run linters |
|
|
| `make docs` | Generate Swagger API documentation |
|
|
| `make dev` | Start development server |
|
|
|
|
## Platform-Specific Notes
|
|
|
|
### Linux
|
|
|
|
No additional dependencies required. The miner binaries (XMRig, TT-Miner) will be automatically downloaded when you install them through the UI.
|
|
|
|
```bash
|
|
# Optional: Enable huge pages for better XMRig performance
|
|
sudo sysctl -w vm.nr_hugepages=1280
|
|
```
|
|
|
|
### macOS
|
|
|
|
Works out of the box on both Intel and Apple Silicon.
|
|
|
|
### Windows
|
|
|
|
Build with:
|
|
```powershell
|
|
go build -o miner-cli.exe ./cmd/mining
|
|
```
|
|
|
|
## Docker
|
|
|
|
```bash
|
|
# Build the image
|
|
docker build -t mining-dashboard .
|
|
|
|
# Run with persistent data
|
|
docker run -d \
|
|
-p 9090:9090 \
|
|
-v mining-data:/root/.local/share/lethean-desktop \
|
|
-v mining-config:/root/.config/lethean-desktop \
|
|
mining-dashboard
|
|
```
|
|
|
|
## Verify Installation
|
|
|
|
```bash
|
|
# Check version
|
|
./miner-cli --version
|
|
|
|
# Run doctor to check system
|
|
./miner-cli doctor
|
|
|
|
# Start the server
|
|
./miner-cli serve
|
|
```
|
|
|
|
Then open [http://localhost:9090](http://localhost:9090) to access the dashboard.
|
|
|
|
## Next Steps
|
|
|
|
- [Quick Start Guide](quickstart.md) - Get mining in 5 minutes
|
|
- [Configuration](configuration.md) - Customize your setup
|