minerwrangler/README.md

87 lines
3.5 KiB
Markdown

![logo](/resources/minerwrangler.png)
<p align="center">
<em>Get it? It's headless!</em>
</p>
<h2 align="center">
A headless driver installer & crypto miner configurator
</h2>
<h3 align="center">
<a href="https://cryptoclarified.netlify.app/minerwrangler/">Installation & Tutorial</a>
</h3>
<p align="center">
MinerWrangler is the ultimate bundle of bash scripts to ease your way into cryptocurrency mining that is open-source and gives you full control over your rigs—by default. No monitor, keyboard, or mouse required. Only NVIDIA support for now.
</p>
<p align="center">
<a href="https://github.com/NikolaiTeslovich/minerwrangler/blob/main/LICENSE">
<img alt="MIT license" src="https://img.shields.io/github/license/NikolaiTeslovich/minerwrangler">
</a>
<img alt="GPU Support" src="https://img.shields.io/badge/GPU-NVIDIA-green">
</p>
## The ultimate one-liner
```
git clone https://github.com/NikolaiTeslovich/minerwrangler.git && cd minerwrangler && chmod +x install1.sh && sudo ./install1.sh
```
## Features
- [x] Simple and intuitive to use
- [x] One line to install
- [x] Full control over your rig(s)
- [x] Truly headless
- [x] Integrated with 💊 [OhGodAnETHlargementPill](https://github.com/admin-ipfs/OhGodAnETHlargementPill) (GTX 1080, GTX 1080Ti & TITAN Xp—GDDR5X GPUs)
> "ED (Ethereum Dysfunction) affects 1 in 10 NVIDIA GPUs in North America"
- [x] Support for the latest & greatest version of Ubuntu Server LTS
- [x] Firewall is enabled by default
- [x] Command-line interface
## Tested on
* **GPUs**
* GTX 1080
* RTX 2080
* **Driver version**
* nvidia-driver-440
* nvidia-driver-460 (default)
## To do
* Run the installation in a screen session for more bullet-proofness
* Add option to automatically mine on boot
* Script to more easily configure overclocks and fan speeds
* RVN mining support
* Break down existing code in detail
* XMRig support
* AMD GPU support
* Support other miners and algorithms
## Preface
NVIDIA drivers on Linux are rather finicky and do not like being overclocked without a monitor connected to them, so I had to trick them using a combination of **lightdm** and some other commands.
After countless hours, probably even days of banging my head against the monitor in despair to have my rigs work headlessly, and be **actually be overclockable**, I wanted to find a way that was simple, yet have the code and process be open-source. In contrast to operating systems like HiveOS, or NHOS, using *MinerWrangler* in conjunction with Ubuntu Server, you can actually understand each step of the process and have full control over your rigs as providers of the blockchain.
## Credits
### Threads and forums that helped massively
* [OC Nvidia GTX1070s in Ubuntu 16.04LTS for Ethereum mining](https://gist.github.com/bsodmike/369f8a202c5a5c97cfbd481264d549e9) - tricking NVIDIA drivers into allowing headless overclocking
* [How to create a bootable USB stick to flash a BIOS](https://askubuntu.com/questions/46886/how-to-create-a-bootable-usb-stick-to-flash-a-bios) - updating BIOS on an old computer
### Logo
* [Western retro font](https://www.dafont.com/western-retro.font)
* [Cowboy hat](https://www.pngitem.com/middle/hTiibR_guitar-clipart-cowboy-hat-cartoon-transparent-cowboy-hat/)
* [Cactus](http://clipart-library.com/clipart/cactus-clipart-34.htm)
* [Headless person from Dumb Ways To Die](https://dumbways2die.fandom.com/wiki/Hapless)
* [Ethereum logo](https://en.wikipedia.org/wiki/Ethereum#/media/File:Ethereum-icon-purple.svg)