Learning path

Module 2: Setting Up Pickaxe for Miner Management

Updated

Goal: install Pickaxe on your mining network and get your miners reporting to Foreman.
Time: 30–60 minutes, depending on how many miners you have.

Pickaxe is Foreman's agent. It runs on a computer at your site, collects stats from your miners and sends them to your dashboard, and carries out the commands you send from Foreman.

Onboarding: How Pickaxe connects your miners to Foreman

Before You Start

  • Finish Module 1. You need your Client ID and a service account token.
  • Have a computer on the same network as your miners. Linux is recommended, especially for large fleets. Check sizing in Quick Guide: Hardware Requirements.
  • Know your miners' IP ranges and, if you've changed them, their login usernames and passwords.

Decisions to Make

  • Windows or Linux for the Pickaxe computer.
  • How to add miners:
    • Find Miners scans IP ranges and adds many miners at once. Best for getting a whole site in quickly.
    • Interactive Miner Add registers miners one at a time as a technician presses each miner's IP Report button. Best when you also want each miner's exact rack position.
    • Add Miner adds a single miner by IP.
  • How to name miners: by miner type and MAC, type and IP, hostname, or worker name.

Step 1: Install Pickaxe

  1. In Foreman, go to Support > Guides > Installation in the left-hand menu. This page shows the install steps for Windows and Linux with your Client ID already filled in.
  2. Follow the steps for your operating system, using your service account token as the API key.
    • Linux: one command downloads, installs and starts Pickaxe.
    • Windows: download the Foreman Windows Agent, add your token and Client ID to conf/foreman.txt, then run bin/service-start.bat.
  3. Go to Pickaxe in the left-hand menu. Your new Pickaxe should appear right away with a green status dot.

Onboarding: Pickaxe online on the Pickaxe page

Full steps: How To: Install Pickaxe. If Pickaxe doesn't come online, see Common Troubleshooting: Pickaxe.

Step 2: Add Your Miners

All three options start from the card for your Pickaxe on the Pickaxe page.

Onboarding: Interactive Miner Add and Find Miners on the Pickaxe card

To scan for miners:

  1. Click Find Miners.
  2. Choose the Miner Manufacturer and a Scan Type: Find Miners (Simple) for one range, or Find Miners (Ranges) for several.
  3. Enter the IP Ranges to Search, and the miner username and password if you've changed the defaults.
  4. Choose how to Name Miners By, then start the scan and save the miners it finds.

Onboarding: Remote Miner Discovery

To keep IP changes and new miners in sync automatically, add a recurring re-sync. See How To: Make Foreman Update IPs Automatically.

To add miners at the rack: click Interactive Miner Add and follow the prompts. If IP Report presses aren't picked up on Windows, see the Windows Firewall how-to.

More detail: How To: Mass Import ASICs and How To: Add A Miner. To check whether a model is supported, see Support > Supported Miners in Foreman.

Done When

  • ☐ Your Pickaxe shows as online on the Pickaxe page.
  • ☐ Your miners appear on the Miners page and start reporting stats within a few minutes.
  • ☐ (Optional) A recurring re-sync is set up so IP changes are picked up automatically.

Next

Module 3: Monitoring Miners: find your way around the dashboard, the Miners page and miner details.

Last verified: November 19, 2026

Was this article helpful?

0 out of 0 found this helpful

Have more questions? Submit a request

Can't find what you're looking for?

Our support team can help with setup, hardware and billing questions.

Contact Support