Skip to content

Latest commit

 

History

History
167 lines (142 loc) · 9.23 KB

README.md

File metadata and controls

167 lines (142 loc) · 9.23 KB
Raw

Third Party Miner Manager for ethOS

This UNOFFICIAL miner manager will install, update, or revert these unsupported miners to ethOS version 1.3.3

List of currently supported miners [click name to get miner specific information]

ONLY ONE ADDITIONAL MINER CAN BE INSTALLED AT A TIME

ethOS files are overwritten for the installation of each miner even though miners can be left in place with (update). Some miner dependencies will prevent other miners from starting you can completely uninstall a miner using the information here.

Support

This manager was not written or supported by ethOS and neither the scirpt or the installed miners are supported by their policies. For support please visit the https://www.rizon.net/chat and join channel #miningmasterrace, if you are already on #ethosdistro, this is as simple as typing /join #miningmasterrace in chat.

Getting Started

Following these instructions will install the chosen miner and its integration files on your ethOS machine. Each miner integration is stored in a branch of github for you to review.

Prerequisites

You need to be running ethos 1.3.3 to install a miner with this script.

Installing the miners

Or you can skip installing the manager and just run the script from the github repo in which case the command would look like

source <(curl -s https://raw.githubusercontent.com/cynixx3/third-party-miner-installer-for-ethos/master/miner-manager) miner action

Where the miner is the branch in the repo and the actions are install, update, or revert IE for a full install of phoenixminer or an update of all files run:

source <(curl -s https://raw.githubusercontent.com/cynixx3/third-party-miner-installer-for-ethos/master/miner-manager) phoenixminer install

Updating

The miner can be easily updated when new releases are out by just changing the action argument to "update" IE to only update the energiminer program to the latest release run:

source <(curl -s https://raw.githubusercontent.com/cynixx3/third-party-miner-installer-for-ethos/master/miner-manager) energiminer update

UnInstalling

The miner can be easily uninstalled by changing the action argument to "revert" IE to uninstall wildrig-multi run:

source <(curl -s https://raw.githubusercontent.com/cynixx3/third-party-miner-installer-for-ethos/master/miner-manager) wildrig-multi revert

ethOS Config Sample

Here is an example of how to add ubqminer to ethos. These instructions will apply to any miner simply by changing "ubqminer" to the miner you want.

Set the miner

You can use the miner on your local config or globally on a remote config

globalminer ubqminer

OR in a remote config to set just one rig

miner c94e13 ubqminer

Where c94e13 is your EthOS rig hostname. You can get your miners hostname by running the terminal command hostname

Set your pool and wallet

for local configs or remote configs to apply globally use

proxywallet walletORusername
proxypool1 pool.com:port
proxypool2 pool.com:port
poolpass1 x
poolpass2 x

OR to make it specific to this miner program in a remote config

ubqminer=proxywallet walletORusername
ubqminer=proxypool1 pool.com:port
ubqminer=proxypool2 pool.com:port
ubqminer=poolpass1 x
ubqminer=poolpass2 x

OR to make it specific to this rig

rigwallet c94e13 walletORusername
rigpool1 c94e13 pool.com:port
rigpool2 c94e13 pool.com:port
rigpoolpass1 c94e13 x
rigpoolpass2 c94e13 x

NOTES: Some miners allow you to use a single cpu thread, for these you can set

globalminer ubqminer-single

Some miners depend on a fallback pool, others do not use them. Best practice is to set both to avoid errors.

Manual config sample

ethOS requires several file changes in order to intergrate a miner into its config and hash reporting features, when this code has not been created you can manually run a miner. In this example we will use grinpro, but you can suppliment it with the miner of your choosing.

First stop ethOS from trying to manage a miner, run disallow && minestop, then go to the miner folder cd /opt/miners/grinpro and run the miner ./GrinProMiner to check that its working and to make any firt run configurations. This process will close when you disconnect from ssh and it will not start with ethOS. Exit the miner with the key combination ctrl+c

Once you get the miner to run and know the start command in order to mine add it to custom.sh nano guide

nano /home/ethos/custom.sh

Add the following line with the information you discovered, above "exit 0" (you can also start the miner with this command)

screen -dmS miner /opt/miners/grinpro/GrinProMiner ignore-config=true stratum-address=eu-west-stratum.grinmint.com stratum-port=4416 stratum-tls=true [email protected] nvidia=0 amd=0:0

Add any miner flags just as your pool or miner instructs. That's all you need to do.

Screen is a linux program that runs an interactive terminal session that you can run independently, connect, and disconnect from. To connect to the miner session and interact with it use

screen -x

To disconnect from a screen session without killing the miner use the key combination ctrl+a d where you press ctrl and a a the same time, release, then press d. Using the ctrl+c key combination will kill the miner, not the screen session and create an interesting situation where rebooting is the easiest fix (alternative is ctrl+a k y, checking for live sessions with screen -ls and killing them if found, then restarting the miner with the screen -dmS ... command above.)

Installing the miner-manager (optional)

This script was designed for ease of use. You can run a single command to install, update, or remove any miner on this repo and any dependencies with it.

If you plan to use this often you can download the miner-manager script, give it execute permissions.

sudo wget https://raw.githubusercontent.com/cynixx3/third-party-miner-installer-for-ethos/master/miner-manager -O /usr/bin/miner-manager
sudo chmod +x /usr/bin/miner-manager

and use it with miner-manager miner action To update just repeat the first command.

Development

If you are a developer please check the developers guide for information on how to add your miner to ethos and / or this repo.

Contributing

Any setting changes to the miner-manager (like an updated release) should be made to the miner.settings file in each miners branch of this repo.

If you got a new miner working using these tools or just improved an intergration please submit a pull request with a new branch for the miner you added.

Authors

  • cYnIxX3 - Initial work - cYnIxX3 <== MVP
~ If you found this script useful please donate BitCoin to:
~ BTC 1G6DcU8GrK1JuXWEJ4CZL2cLyCT57r6en2
~ or Ethereum to:
~ ETH 0x42D23fC535af25babbbB0337Cf45dF8a54e43C37

Contributers

License

This project is licensed under the MIT License - see the LICENSE.md file for details