Welcome To The Foreman Knowledge Base

Search

How To: Install Pickaxe

Overview

Pickaxe is our application that extracts metrics from your miners and provides them to your private dashboard. This guide will take you through the steps to configure your Pickaxe with a Service Account for optimal use.

Select Hardware

Need more information on hardware specifics? Check out our reference guide.

Create Service Account

We recommend that you create a service account for your Pickaxe. While you can use an individual user's API key for your Pickaxe, using a service account removes any complications should that user account need to be deleted.

Reference our user guide on how to create a service account if required.

Important: 

  • Use the API key associated with the service account you created anywhere in the instructions below that references [Insert Pickaxe Service Account API Key].
  • You will also need your Client ID, Follow this article to find your Client ID.

 

Install Software

Installation Recommendations

  • For ASICs: We recommend that Pickaxe run on a server connected directly to the network with your miners.
  • For GPU mining: We recommend that Pickaxe be installed on each GPU rig. Querying multiple rigs from one Pickaxe is possible, but requires familiarity with firewalls.

 

Installation Guides by Setup Type

Choose the guide that matches your hardware and operating system:

Monitoring ASICs from Windows
Follow these steps.

The following steps must be completed from your Windows machine:

  1. Download the latest version of the Foreman Staging Windows Agent here.
  2. Unzip windows-agent-1.3.0-jre.zip.
  3. Open and replace the contents of conf/foreman.txt with the following: 
apiKey=[INSERT PICKAXE SERVICE ACCOUNT API KEY]
clientId=[INSERT CLIENT ID]
  1. Run bin/service-start.bat.
  2. If Windows says it's an unrecognized app, click More info and then Run anyway.
  3. When you're asked if this application can make changes to your device, select Yes.
  4. You'll know things are working when you see Pickaxe appear here — it should be immediate.
  5. Now it's time to add a miner.

Notes:

Monitoring ASICs from Linux
Follow these steps.

The following steps must be completed from your Linux machine:

  1. SSH to your Linux machine.
  2. From the command prompt, run the following command (will download, install, configure, and start Pickaxe): 
curl https://tinyurl.com/service-install -Ls --output install.sh; sudo bash install.sh [INSERT CLIENT ID] [INSERT PICKAXE SERVICE ACCOUNT API KEY]
  1. You'll know things are working when you see Pickaxe appear here — it should be immediate.
  2. Now it's time to add a miner.

Notes:

  • Pickaxe was installed to: /opt/foreman/pickaxe
  • To start Pickaxe, run: sudo service foreman start
  • To stop Pickaxe, run: sudo service foreman stop
  • To restart Pickaxe, run: sudo service foreman restart
  • The Linux service will automatically upgrade your Pickaxe.
Monitoring a Windows rig
Follow these steps.
  1. Download the latest version of the Foreman Staging Windows Agent here.
  2. Unzip windows-agent-1.3.0-jre.zip.
  3. Open and replace the contents of conf/foreman.txt with the following: 
apiKey=[INSERT PICKAXE SERVICE ACCOUNT API KEY]
clientId=[INSERT CLIENT ID]
  1. Run bin/service-start.bat.
  2. If Windows says it's an unrecognized app, click More info and then Run anyway.
  3. When you're asked if this application can make changes to your device, select Yes.
  4. You'll know things are working when you see Pickaxe appear here — it should be immediate.
  5. Now it's time to add a miner.

Notes:

  • To stop the service, run: bin/service-stop.bat
  • The agent will automatically upgrade your Pickaxe.
Monitoring a Linux rig
Follow these steps.
  1. SSH to your rig.
  2. From the command prompt, run the following command (will download, install, configure, and start Pickaxe): 
curl https://tinyurl.com/service-install -Ls --output install.sh; sudo bash install.sh [INSERT CLIENT ID] [INSERT PICKAXE SERVICE ACCOUNT API KEY]
  1. You'll know things are working when you see Pickaxe appear here — it should be immediate.
  2. Now it's time to add a miner.

Notes:

  • Pickaxe was installed to: /opt/foreman/pickaxe
  • To start Pickaxe, run: sudo service foreman start
  • To stop Pickaxe, run: sudo service foreman stop
  • To restart Pickaxe, run: sudo service foreman restart
  • The Linux service will automatically upgrade your Pickaxe.
Monitoring an nvOC rig
Follow these steps.

We are fully integrated into nvOC starting from nvOC 3.1! If you're running an earlier version, see the generic Linux section above.

  1. SSH to your rig.
  2. Edit 1bash.
  3. Set the following values:
FOREMAN_MONITOR="YES"
FOREMAN_CLIENT="[INSERT CLIENT ID]"
FOREMAN_API_KEY="[INSERT PICKAXE SERVICE ACCOUNT API KEY]"
  1. Perform an nvOC restart or restart your rig (this will download, install, configure, and start Pickaxe).
  2. Your miner will automatically be added within 2 minutes. You're done!
  3. Now it's time to add a miner.

Notes:

  • Pickaxe was installed to: ~/.foreman/pickaxe
  • Chisel was installed to: ~/.foreman/chisel
  • The Linux service will automatically upgrade your Pickaxe.

 

Troubleshooting:

Windows:

Missing apiKey or clientId in foreman.txt
 

If you're seeing this message anywhere, your conf/foreman.txt is not formatted properly. See the Windows installation guide above for proper formatting instructions.

 
 
 

 

Was this article helpful?

0 out of 0 found this helpful

Have more questions? Submit a request

Comments

0 comments

Please sign in to leave a comment.