Miner Manager for ethOS

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

These instructions were written for the average NON linux PC user (thats you!)

These instructions were written for the average NON linux PC user (thats you!)

Estimated read time: 10 minutes (Jump to TL:DR)

List of currently supported miners

key

• ✔️ = Fully integrated into ethOS for configuration and hash reporting.
• ❌ = Only miner program is included and may not be able to be configured or report hash with ethOS. You will need to run the miner manually in /opt/miners/MINERNAME and monitor it with your * own solution.
• 🚀 = Miner programs are downloaded directly from developers release source. You can update as soon as the developer releases the miner.
• 🔗 = We link to the miner program version directly, either from the developers source or this repo. You can update when we update the link to the new version.
• 🐌 = We had to compile these miners from code to work on ethOS using the miner-builder. You can update only after we compile and link the new version.

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.

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.

You can get assistance through the support team here: http://ethosdistro.com/kb/#support

Prerequisites

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

Installing the miners

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.

Below are instructions to install the miner-manager script if you think you will use it often, or you can skip installing the manager and just run the script from the github repo in which case the command would look like NON WORKING EXAMPLE

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

NOTICE: YOU SET THE LAST TWO WORDS to what you want to do. Where the miner is the name of the miner branch in this repo and the actions are install, update, or revert IE for a full install of phoenixminer example or an update of all files run:

bash <(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 example program to the latest release run:

bash <(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 example run:

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

Downgrading / Version selection

The miner-manager can downgrade a miner by adding a third argument, this works for both the install and update arguments

bash <(curl -s https://raw.githubusercontent.com/cynixx3/third-party-miner-installer-for-ethos/master/miner-manager) phoenixminer update 4.5c

Or allow you to select a specific version

bash <(curl -s https://raw.githubusercontent.com/cynixx3/third-party-miner-installer-for-ethos/master/miner-manager) xmr-stak install amd

Where xmr-stak has a cpu version by default but you can select amd or nvidia.

xmr-stak-rx-linux-1.0.1-cpu.tar.xz
xmr-stak-rx-linux-1.0.1-cpu_cuda-nvidia.tar.xz
xmr-stak-rx-linux-1.0.1-cpu_opencl-amd.tar.xz

Or allow you to downgrade and select a specific version by being more specific.

bash <(curl -s https://raw.githubusercontent.com/cynixx3/third-party-miner-installer-for-ethos/master/miner-manager) xmr-stak update 1.0.0-cpu_opencl-amd

ethOS Config Sample

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

Set the miner

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

globalminer phoenixminer

OR in a remote config to set just one rig

miner c94e13 phoenixminer

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

phoenixminer=proxywallet walletORusername
phoenixminer=proxypool1 pool.com:port
phoenixminer=proxypool2 pool.com:port
phoenixminer=poolpass1 x
phoenixminer=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 pools 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 2>&1 /var/run/ethos/miner.output

The 2>&1 /var/run/ethos/miner.output allows you to use show miner even in manual mode. Add any miner flags just as your pool or miner instructs. That's all you need to do.

About screen

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 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 does not install a miner, just the script)

If you plan to use this often you can download the miner-manager script and give it execute permissions. To install simply copy paste the command:

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

When installed you can use it with miner-manager miner action instead of the larger bash <(curl ... commands above. To update the manager script just repeat the first command.

Farms

You are limited to installing 30 miners an hour as this script makes 2 API querries per install. With authenticated requests you get enough to install on 2,500 miners per hour per user.

See GitHub API Documentation for more information.

To authenticate, either use a file (/home/ethos/.gituser) or use the variables after installing the miner-manager. These environmental variables are currently:

• GITHUB_USERNAME
• GITHUB_PASSWORD

An example file is in this repository but is not installed by default.

You must use a valid github.com user for this.

It is recommended to use your Personal Access Token as the GITHUB_PASSWORD for your privacy over https. You can get a PAT from GitHub by going to the User Icon in the upper right corner > Settings > Developer Options > Personal access token > "Generate new token" button > Note "miner-manager" > select Scope of "read:packages" > Generate token. You can now use this token as your GITHUB_PASSWORD in .gituser or the miner-manager file directly. If you loose the token just delete the current PAT and make a new one.

Development

If you are a developer please check the developers guide for information on how to add your miner to ethos and 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 to encourage more development (every coin helps):
~ BTC bc1qk5mgs5tcm00287vapxupj5x4wqguhqr5qrmu8k
~ ETH 0x456ba7b1e9758c4c6fc56007107796f08ffba12b
~ XMR 44tLr5hm5g3LJnpy5HGK2hDADofwPXcPvCd1CF67q5NdavbiZuFKasWja1vCGpapDyfWXcqH49FWm6XkvJSfQ3Vh4TQ8oy3
~ LTC LP7iuax4k57EC8GYo1inNMeqAVJ63mMrAc
~ Zcash Zcash t1YzbApi36dftoP2tchEzpZpDkLTM1XkNSq

Contributors

• unsivil - added and integrated several miners - unsivilaudio
• Kahlid74 - added cryptodredge - Phaelon74
• virusHQ - ported ubqminer - virusHQ
• amnesium - ported grin-miner - amnesium
• asluchevskiy - ported t-rex - asluchevskiy
• Virosa - improved grin-miner, added bminer - Virosa
• HTCang - ported gminer - HTCang

License

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

TL;DR

Step 1: To just install Phoenixminer on your rig Run in the terminal:

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

Step 2: Edit your config to match the miner you installed above:

globalminer phoenixminer

You're Done