diff --git a/readme.md b/readme.md index ea01a3e..1ed1867 100644 --- a/readme.md +++ b/readme.md @@ -1,17 +1,30 @@ -Easily set up a GPU mining server for XENBLOCKS mining. A single line of code installs all dependencies and executes GPU mining. Here's how you get started: - # XENBLOCKS - Effortless GPU Mining on VAST.AI 1. **VAST.AI Mining - vast.ai (verified)**: - - First, clone this repository to your own public repository. - - Navigate to your repo, open `vast.sh` (depending on where you mine or vast4.sh or vast8.sh, depending on the number of GPUs) and replace the existing address with your own: - - ![image](https://github.com/JozefJarosciak/xgpu/assets/3492464/5ddc43df-4e40-44b9-9aa9-4584e2e1b724) - - Go to Vast.ai, select Templates / Cuda:12.0.1-Devel-Ubuntu20.04 option: + - If you don't have your own GithHub account, sign up at [https://github.com](https://github.com/join) + - Once signed up, login to your GitHub account and fork my repo to your own public repository. Forking repository is simple. Navigate to https://github.com/JozefJarosciak/xgpu, then in the top-right corner of the page, you will find a button labeled "Fork". Click on this button. GitHub will take a few moments to create a copy of my repository in your own account. You will be redirected to the new fork in your GitHub account once it's done. + + - Navigate to the forked repository. In there you'll find several files named `vast.sh` (..., vast4.sh, vast8.sh, etc.). Each is named by the number of GPUs it support. So if you're planning to mine on a single GPU Vast.ai machine, we'll need to edit `vast.sh`. If you're planning to mine on 4 GPU Vast.ai machine, you'll need to edit 'vast4.sh' file. +So let's say you want to mine on 4 GPU Vast.ai machine. How do you edit the file? +-- Once you have forked my original repository, navigate to your fork, and find the vast4.sh file in your own repository. +-- To Edit the File: Open the file by clicking on it. Look for the pencil icon (Edit this file) in the upper right corner of the file view. Click on the pencil icon, which will open the web-based editor. +-- Here you need to replace the existing ETH address with your own (as illustrated in this image): + ![image](https://github.com/JozefJarosciak/xgpu/assets/3492464/5ddc43df-4e40-44b9-9aa9-4584e2e1b724) +-- Once done, save the change by pressing the 'Commit Changes' green button at the top right hand corner + +- Now, we need to go to Vast.ai to order a GPU server which will mine the XenBlocks for us. To do so follow these steps: +-- Sign up at https://vast.ai for your own account +-- Once sign up, deposit some cash at https://cloud.vast.ai/billing/ (note, they also support Ethereum deposits via Coinbase) +-- When you have the cash in the account, navigate to https://cloud.vast.ai/templates/ +-- Here we need to select the template that supports XenBlocks mining. It's this one: / Cuda:12.0.1-Devel-Ubuntu20.04 and it'll look like this on the page. Press the select button when you find it: ![image](https://github.com/JozefJarosciak/xgpu/assets/3492464/cf8fb6fa-3747-4777-aafc-5d025f4f12ce) - - Then under machines select the image you want. If you select 'unverified machines' you may find those that are a better deal: + -- Once done, under machines select the server you want to use for mining XenBlocks. The choice will depend on the cost and number of GPUs. Also, note, you can select 'unverified machines' on the left side, which sometime allows you to find a better deal (but note, often those servers are more problematic or do not run at all): ![image](https://github.com/JozefJarosciak/xgpu/assets/3492464/1d7a937c-8f64-453b-8ff1-b8b169f427df) - - Now you're all set! - - Use a single line command below to get a new GPU server up and running (from 0 to full-speed mining with one press of a button). - - Note: of course replace (JozefJarosciak/xgpu/main/vast.sh, or vash4.sh or vast8.sh) with a path to your repo + -- Once you found a server you want, simply press the RENT button and within a couple of seconds the server will appear in your rented list of instances at: https://cloud.vast.ai/instances/. Wait for a moment, until the blue button on it -- turns from LOADING state to 'CONNECT' state. +-- Before you can press 'CONNECT' button, you need to generate the RSA SSH public/private keypair. This is easy, just follow these instructions: https://vast.ai/faq#how-do-i-connect-to-an-ssh-instance-on-linuxmac +-- Once done, click on CONNECT button, copy the connect URL and paste it into your choice of command line tool. + +- Now, that we're connected to our server of choice. Copy a single line command below to get a new GPU server up and running mining XenBlocks for you. + -- Important Note: In the below one liner commands, replace (JozefJarosciak/xgpu/main/vast.sh, or vash4.sh or vast8.sh, etc.) with a path to your own fork of my repository For single GPU use vast.sh: ``` @@ -80,3 +93,6 @@ Renaming directory: ``` mv XENGPUMiner XENGPUMiner2 ``` + + +