docs: Add future ideas and enhancement roadmap
Document potential enhancements identified during code review: - Telegram/Discord monitoring bot - Pool auto-discovery with pools.json - Profitability calculator with CoinGecko API - One-click deploy templates (Unraid, Proxmox, DO, K8s) - Community visibility improvements - Additional ideas (GPU temps, scheduling, auto-switching) 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
This commit is contained in:
snider
parent
185bfd13dd
commit
84635c3c17
1 changed files with 161 additions and 0 deletions
161
docs/FUTURE_IDEAS.md
Normal file
161
docs/FUTURE_IDEAS.md
Normal file
|
|
@ -0,0 +1,161 @@
|
|||
# Future Ideas
|
||||
|
||||
This document captures ideas for future enhancements identified during code review and architecture analysis.
|
||||
|
||||
## Remote Monitoring Bot
|
||||
|
||||
**Priority:** High
|
||||
**Effort:** Medium
|
||||
|
||||
Create a Telegram or Discord bot for remote monitoring of mining operations.
|
||||
|
||||
### Features
|
||||
- Real-time hashrate alerts (drop below threshold)
|
||||
- Share accepted/rejected notifications
|
||||
- Daily summary reports
|
||||
- Remote start/stop commands
|
||||
- Multi-node aggregated stats
|
||||
|
||||
### Implementation Notes
|
||||
- Use existing EventHub WebSocket infrastructure
|
||||
- Bot subscribes to miner events and forwards to chat
|
||||
- Store bot token in settings (encrypted)
|
||||
- Rate limit notifications to prevent spam
|
||||
|
||||
---
|
||||
|
||||
## Pool Auto-Discovery
|
||||
|
||||
**Priority:** Medium
|
||||
**Effort:** Low
|
||||
|
||||
Add pool auto-discovery with a community-maintained `pools.json` file.
|
||||
|
||||
### Features
|
||||
- Curated list of pools per algorithm/coin
|
||||
- Pool health/latency checking
|
||||
- Automatic failover suggestions
|
||||
- Community contributions via PR
|
||||
|
||||
### Implementation Notes
|
||||
- Host `pools.json` on GitHub (or embed in binary)
|
||||
- Include: name, url, ports, fees, minimum payout, regions
|
||||
- UI dropdown to select from known pools
|
||||
- Validate pool connectivity before saving
|
||||
|
||||
### Example Structure
|
||||
```json
|
||||
{
|
||||
"monero": [
|
||||
{
|
||||
"name": "SupportXMR",
|
||||
"url": "pool.supportxmr.com",
|
||||
"ports": {"stratum": 3333, "ssl": 443},
|
||||
"fee": 0.6,
|
||||
"minPayout": 0.1
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Profitability Calculator
|
||||
|
||||
**Priority:** Medium
|
||||
**Effort:** Medium
|
||||
|
||||
Add real-time profitability calculations using CoinGecko API.
|
||||
|
||||
### Features
|
||||
- Fetch current coin prices (XMR, ETH, RVN, etc.)
|
||||
- Calculate daily/weekly/monthly earnings based on hashrate
|
||||
- Factor in electricity costs (user-configurable)
|
||||
- Compare profitability across algorithms
|
||||
- Historical profitability charts
|
||||
|
||||
### Implementation Notes
|
||||
- CoinGecko free tier: 10-50 calls/minute
|
||||
- Cache prices for 5 minutes to reduce API calls
|
||||
- Store electricity rate in settings ($/kWh)
|
||||
- Formula: `(hashrate / network_hashrate) * block_reward * price - electricity_cost`
|
||||
|
||||
### API Endpoints
|
||||
- `GET /api/v1/mining/profitability` - Current estimates
|
||||
- `GET /api/v1/mining/profitability/history` - Historical data
|
||||
|
||||
---
|
||||
|
||||
## One-Click Deploy Templates
|
||||
|
||||
**Priority:** Low
|
||||
**Effort:** Medium
|
||||
|
||||
Create deployment templates for popular self-hosting platforms.
|
||||
|
||||
### Platforms
|
||||
- **Unraid** - Community Applications template
|
||||
- **Proxmox** - LXC/VM template with cloud-init
|
||||
- **DigitalOcean** - 1-Click Droplet image
|
||||
- **Docker Compose** - Production-ready compose file
|
||||
- **Kubernetes** - Helm chart
|
||||
|
||||
### Template Contents
|
||||
- Pre-configured environment variables
|
||||
- Volume mounts for persistence
|
||||
- Health checks
|
||||
- Resource limits
|
||||
- Auto-update configuration
|
||||
|
||||
### Files to Create
|
||||
```
|
||||
deploy/
|
||||
├── docker-compose.prod.yml
|
||||
├── unraid/
|
||||
│ └── mining-dashboard.xml
|
||||
├── proxmox/
|
||||
│ └── mining-dashboard.yaml
|
||||
├── kubernetes/
|
||||
│ └── helm/
|
||||
└── digitalocean/
|
||||
└── marketplace.yaml
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Community Visibility (Manual Tasks)
|
||||
|
||||
### Submit to Awesome Lists
|
||||
- [ ] [awesome-monero](https://github.com/monero-ecosystem/awesome-monero)
|
||||
- [ ] [awesome-selfhosted](https://github.com/awesome-selfhosted/awesome-selfhosted)
|
||||
- [ ] [awesome-crypto](https://github.com/coinpride/CryptoList)
|
||||
|
||||
### GitHub Repository Optimization
|
||||
- [ ] Add topic tags: `mining`, `monero`, `xmrig`, `cryptocurrency`, `dashboard`, `self-hosted`, `golang`, `angular`
|
||||
- [ ] Add social preview image
|
||||
- [ ] Create GitHub Discussions for community Q&A
|
||||
- [ ] Add "Used By" section in README
|
||||
|
||||
---
|
||||
|
||||
## Additional Ideas
|
||||
|
||||
### GPU Temperature Monitoring
|
||||
- Read GPU temps via NVML (NVIDIA) or ROCm (AMD)
|
||||
- Alert on thermal throttling
|
||||
- Auto-pause mining on overtemp
|
||||
|
||||
### Mining Schedule
|
||||
- Time-based mining schedules
|
||||
- Pause during peak electricity hours
|
||||
- Resume when rates are lower
|
||||
|
||||
### Multi-Algorithm Auto-Switching
|
||||
- Monitor profitability across algorithms
|
||||
- Automatically switch to most profitable
|
||||
- Configurable switch threshold (prevent thrashing)
|
||||
|
||||
### Web Terminal
|
||||
- Embedded terminal in dashboard
|
||||
- Direct access to miner stdin/stdout
|
||||
- Real-time log streaming with search/filter
|
||||
Loading…
Add table
Reference in a new issue