Early dashboard development

README.md

@@ -0,0 +1,93 @@
+# Bitcoin Node for Solo Miners
+*A Linux Appliance by Robbie Ferguson*
+
+## Overview
+**Bitcoin Node for Solo Miners** is a self-contained Debian-based appliance that lets you host your own Bitcoin node for your solo miners with no third-party pool (or fees) required.
+
+This system installs and configures:
+- **Bitcoin Core** (with pruning)
+- **ckpool** (running in solo mining mode)
+- A custom, secure **HTTPS web dashboard** for monitoring and configuration
+
+This appliance is designed for hobbyists, home miners, and small operations who want to mine independently while maintaining full control of their rewards and privacy. Running your own independent mining node helps strengthen the decentralization of both the Bitcoin blockchain and the global mining network.
+
+---
+
+## Features
+- 🧱 **Full or Pruned Node Support** — Select from 550 MB to full blockchain retention.
+- ⚡ **Solo Mining with ckpool** — Connect ASICs directly via Stratum (`stratum+tcp://your-node:3333`).
+- 🔒 **Secure HTTPS Interface** — Self-signed TLS certificate generated on first boot.
+- 🧭 **Web Dashboard** — View node sync progress, service health, and pool status.
+- 💰 **Optional Donation (Pool Fee)** — At your own discretion, donate from 0 – 5% of a block reward to Robbie Ferguson.
+- 🧩 **Automatic Service Management** — Fully integrated systemd services for `bitcoind` and `ckpool`.
+
+---
+
+## Installation
+Download and run the installer script as root on a clean **Debian 13 (Trixie)** system:
+
+```bash
+chmod +x installer
+sudo ./installer
+```
+
+When installation completes:
+1. Open your browser to `https://<your-server-ip>/activate/`
+2. Create your admin credentials (used for web access and RPC)
+3. Optionally regenerate your HTTPS certificate
+4. You’ll be redirected to the dashboard once activation is complete
+
+---
+
+## Configuration
+Access the settings panel anytime using the link on the dashboard.
+
+From here you can:
+- Adjust pruning size (550 MB – Full)
+- Change donation (pool fee) percentage
+- Regenerate your certificate
+- Restart core services as needed
+
+---
+
+## Connecting Miners
+Point your ASIC miners to:
+```
+stratum+tcp://<your-server-ip>:3333
+```
+
+**Username:** your Bitcoin wallet address to receive payout (this can be different for each miner if desired)
+**Password:** anything
+
+Your miners can begin hashing once the Bitcoin node finishes syncing.
+
+---
+
+## Security Notes
+- The web interface is HTTPS-only and disabled until activation is complete.
+- RPC/admin credentials are generated at first activation
+- Self-signed certificates are created automatically on first boot and can be regenerated later.
+
+---
+
+## System Requirements
+| Component | Minimum | Recommended |
+|------------|----------|-------------|
+| OS | Debian 13 (Trixie) | Debian 13 (Trixie) |
+| CPU | 2 cores | 4+ cores |
+| RAM | 2 GB | 4 GB+ |
+| Storage | 16 GB (pruned) | 500 GB+ (full node) |
+| Network | Broadband | High-speed fiber |
+
+---
+
+## License
+This project is released under the **Apache 2.0 License**.
+Copyright © 2025 Robbie Ferguson
+
+---
+
+## Credits
+- [Bitcoin Core](https://bitcoincore.org)
+- [ckpool](https://bitbucket.org/ckolivas/ckpool)
+- Linux appliance integration by Robbie Ferguson