Skip to content
This repository has been archived by the owner on Mar 15, 2021. It is now read-only.

Latest commit

 

History

History
92 lines (61 loc) · 2.72 KB

README.md

File metadata and controls

92 lines (61 loc) · 2.72 KB
Raw

miner-manager

(auto profit switching) mining monitoring software (wrapper)

can use nicehash, miningpoolhub and minecryptonight api via https://github.com/felixbrucker/profitability-service or run standalone without switching

currently supports the following miners:

  • ccminer
  • claymore-eth
  • claymore-xmr
  • claymore-zec
  • optiminer-zec
  • cpuminer-opt
  • sgminer

If you want your favourite miner to be supported as well create an issue

Screens

Stats Config

Prerequisites

miner-manager requires nodejs >= 7.6.0, npm and optionally pm2 to run. Additionally miner binaries are needed for cpu and gpu mining.

Installation

git clone https://github.com/felixbrucker/miner-manager
cd miner-manager
npm install
npm install pm2 -g

Run

pm2 start process.json

or

npm start

to startup on boot:

pm2 save
pm2 startup

note: windows users need the following instead for pm2:

npm install pm2-windows-startup -g
pm2-startup install
pm2 save

or just modify startTemplate.bat file to match your preferred compile and save as start.bat to not interfere with git updates

Update software

run git pull

Notes

  • When using custom directories for miner binaries and you are using pm2 for miner-manager be sure to exclude this directory in ignore_watch
  • When using claymore-* miners be sure to set command line option -r 1 so restarts are handled by miner-manager
  • Selecting multiple regular pools for a single pool entry in group config will only use the first pool, only autoswitch pools can be combined to use the most profitable
  • Currently there is no strong support for linux (miner binaries), but it should be possible out of the box ™
  • Currently pool availability monitoring and automatic failover have been disabled because most pools bock your ip if you do not send actual mining data over the stratum conenction made to check their availability. I'll probably include this again with regular pings or tcp port checks.
  • Currently there are no releases and versioning but this is planned as well
  • Selecting use stratum proxy for a miner enables a MITM-Stratum-Proxy which supports switching to other pools of the same algo without restarting your miner each time. It can also be used to connect to non-SSL pools as if they supported SSL (reduces dev fee for claymore). On startup of the miner a random port is chosen by the system and assigned to the proxy. For claymore miners it is advised to configure -retrydelay 1 to allow fast switching. IMPORTANT: has only been tested with a few algos!

Todos

  • Add Code Comments
  • Write Tests

License

GNU GPLv3 (see LICENSE)