Guide

Hive OS and mmpOS

Installing the current version on a mining OS, what each flight-sheet field becomes, and the force_algo escape hatch.

A mining OS does two things for you: it assembles the command line from a form, and it reads the miner’s stats back onto its dashboard. Both work with bzminer without adaptation — it accepts the flags a 1.x flight sheet writes, and it serves the stats formats those dashboards poll. What the OS does not do is ship the current version, and its algorithm list may predate an algorithm bzminer has since gained. This guide covers both, on Hive OS and mmpOS.

Hive OS

Two routes. The first is cleaner; the second is for a rig already set up with Hive’s own bzminer entry.

Route 1: the custom miner package (recommended)

Every release ships a Hive custom-miner archive, bzminer_custom-v100.82.tar.gz, built around the full Linux binary with Hive’s install, config and stats callbacks. Hive downloads it from the URL you give it and runs the current version from day one, and its algorithm box is free text, so nothing is off the menu.

  1. Make a flight sheet

    Coin, wallet and pool as usual. Under Miner pick Custom, then open Setup Miner Config.

  2. Fill in the form

    Hive fieldValueBecomes
    Miner namebzminer_customthe install directory
    Installation URLhttps://github.com/bzminer/bzminer/releases/download/v100.82/bzminer_custom-v100.82.tar.gzwhere Hive fetches the package
    Hash algorithme.g. xelis, rvn, etchash, cn-a
    Wallet and worker template%WAL%-w. Hive passes the rig name separately and it becomes --worker, so the template holds only the wallet — a template with a worker in it names the worker twice
    Pool URLhost:port, or stratum+ssl://host:port-p, one per whitespace-separated URL — the first is primary, the rest backups. A bare host:port gets stratum+tcp://; explicit stratum+ssl://, ws://, http:// are kept, so solo node URLs work
    Passx, or a MoneroOcean pin like rig1~kawpow--pass
    Extra config argumentsany bzminer flagsappended as-is: --oc-power-limit 160, --devices !1, --cpu_threads 8. Quotes and backslash escapes work; shell substitutions are deliberately not run
  3. Apply it

    Hive installs the package on first start into /hive/miners/custom/bzminer_custom. The rig’s hashrate, temperatures, fans and shares appear on the Hive dashboard: the stats callback reads http://127.0.0.1:4014/hive_status, which bzminer serves itself, so keep the web server enabled on port 4014.

  4. Updating

    Change the version in the installation URL. Hive fetches the new package on the next start.

Under the hood Hive’s fields become one argument per line in a file the runner reads, so a value with spaces survives without anything being eval’d. Output goes to the plain log screen automatically, because bzminer sees no terminal.

Route 2: Hive’s own bzminer entry, updated in place

Hive lists bzminer among its miners, from the 1.x days. A flight sheet using that entry works — bzminer 2 accepts everything a 1.x sheet writes — but the binary Hive installs is whatever version Hive packaged. To replace it with v100.82, run this over SSH or in the Hive web shell. You do not need to know which version Hive installed: it replaces the binary in every bzminer folder it finds, and whichever one your flight sheet points at gets the new build.

version=v100.82
cd /tmp && wget -q https://github.com/bzminer/bzminer/releases/download/${version}/bzminer_${version}_linux.tar.gz && tar -xf bzminer_${version}_linux.tar.gz || { echo "download failed"; exit 1; }
miner stop
n=0; for d in /hive/miners/bzminer/*/; do [ -d "$d" ] && cp -f "bzminer_${version}_linux/bzminer" "$d" && n=$((n+1)); done
[ "$n" -gt 0 ] && echo "updated $n bzminer folder(s)" || echo "no /hive/miners/bzminer/<version>/ found - install bzminer from the flight sheet first"
miner start

It prints how many folders it updated. 0 means bzminer has never been installed from a flight sheet on that rig, so there is nothing to replace yet. Hive’s entry has a fixed algorithm dropdown, so an algorithm bzminer gained since needs the escape hatch below.

mmpOS

mmpOS ships a bzminer miner profile. Make one for your coin, then give it the current version and, if needed, the algorithm name.

  1. Create a miner profile

    Miner bzminer, the coin or algorithm, pool and wallet. The rig name becomes --worker.

  2. Install the current version

    In the profile, under Advanced, paste this into “Initiate command prior to miner launch”. It downloads v100.82 once and copies the binary into mmpOS’s miner folder; on every later launch the if sees the archive already in /tmp and exits immediately, so it costs nothing per restart. To move to a later release, change the version on the first line.

    export version="v100.82"
    if [ -f "/tmp/bzminer_${version}_linux.tar.gz" ]; then
    exit 0
    else
    cd /tmp; wget https://github.com/bzminer/bzminer/releases/download/${version}/bzminer_${version}_linux.tar.gz; tar -xvf bzminer_${version}_linux.tar.gz; sudo cp -adpR bzminer_${version}_linux/bzminer /opt/mmp/miners/bzminer/
    fi
  3. Extra arguments

    Any bzminer flag goes in the profile’s extra arguments: overclocks, device selection, thread counts, and --force_algo when the algorithm is not in mmpOS’s list.

  4. Assign the profile to the rig

    Stats are read from bzminer’s web port, so leave the web server on 4014.

When the OS spells it differently

Before reaching for the override below, try the name the OS already has. An algorithm can answer to more than one -a spelling, and the mining OSes do not all use the same one: Pearl is pearl here and pearlhash in several of their algorithm lists, and bzminer answers to both — same chain, same work, same fee. Type whichever your OS offers.

-a pearl        # both of these mine the same thing
-a pearlhash

The full list of names each algorithm answers to is on the algorithm table, and bzminer --list-algos prints the ones your build actually has. Only when the name is in neither list is the override below what you want.

When the OS does not know the algorithm

Both mining OSes rewrite the pool block from their own algorithm list, so an algorithm bzminer gained after that front-end shipped cannot be picked in their UI. --force_algo overrides it, whatever wrote it:

--force_algo warthog             # every pool
--force_algo warthog,xelis       # one per pool, in order

It is also a top-level config.txt option ("force_algo": "warthog") — top-level on purpose, rather than a field inside pools[], because that is the block the OS overwrites. Pick any algorithm in the dropdown so the OS is happy, and let the flag name the real one.

The stats endpoints

bzminer serves the two formats mining-OS dashboards already parse, unauthenticated, on the web port:

  • /hive_status — Hive’s format: total_khs, per-GPU hs[], temperatures, fans, uptime, accepted/rejected/invalid shares, the algorithm, pool and wallet. Hashrates in kH/s, and total_khs always equals the sum of hs, which Hive assumes.
  • /status — bzminer 1.x’s full settings-and-stats document, key for key, so a dashboard that addressed 1.x by key path keeps working. Hashrates in raw H/s, memory in bytes, clocks in kHz.

GET /help on the port documents every field, its units and the placeholders. The dashboard guide lists the rest of the API.

Problems

  • Hive shows no hashrate. The web server is off or on another port. The stats callback reads port 4014; if you moved it, CUSTOM_API_PORT in the package manifest and --http-port have to change together.
  • The worker shows up as rig.rig on the pool. The wallet template contained a worker. Change it to %WAL% on its own.
  • “algorithm ‘X’ is not supported by this build” and the rig drops into monitoring mode. The OS wrote an algorithm name bzminer does not know, or the binary is older than the algorithm. Update the binary, or --force_algo the right name.
  • The update script printed 0. Hive’s bzminer entry has never been installed on that rig. Use the custom package instead.