hopbitsDocs

↑ ↓ to moveEnter to openEsc to close

Sign inCreate account

Run a node

Quick install

One command starts a node. One code links it to your account.

On this page

  1. Run the installer

    On the machine that will be your node:

    Linux shell
    curl -fsSL https://hopbits.io/install.sh | sudo sh

    It downloads the SHA-256-verified release binary, builds a hardened local image (hopbits/agent:local), creates the hopbits-data volume and starts a container named hopbits-agent.

  2. Copy the pairing code

    The installer ends by printing the node's first log lines. Find the line that says PAIRING CODE and note its 8 characters. To see the log again:

    Linux shell
    sudo docker logs hopbits-agent

  3. Pair it in the dashboard

    Open the operator dashboard. Under Pair with 8-character code, type the code and press Pair node. A code is valid for 15 minutes.

  4. See it online

    The node appears under Connected nodes and starts taking jobs.

What the installer does

  • Checks that Docker is installed and that it can reach it.
  • Downloads SHA256SUMS and the Linux release binary (x86_64 or ARM64) from https://hopbits.io/releases, verifies its SHA-256 digest, and builds a hardened local distroless image (hopbits/agent:local).
  • Creates the hopbits-data volume and replaces any earlier hopbits-agent container.
  • Starts the container with --restart=always, --cap-drop ALL and no-new-privileges, connecting outbound to wss://api.hopbits.io/v1/node.
  • Prints the last log lines, with the pairing code.

It is a short shell script. Read it before you run it: hopbits.io/install.sh.

Installer options

Set an option in front of the command, and call sudo with -E so it is passed on:

Linux shell
curl -fsSL https://hopbits.io/install.sh | HOPBITS_DAILY_MB=100 sudo -E sh
OptionDefaultWhat it does
HOPBITS_NETWORK_MODEhosthost or bridge. See Host or bridge.
HOPBITS_DAILY_MB200A lower daily cap for measurement traffic, in MB.
HOPBITS_ENROLLNoneAn enrolment token, to skip pairing by hand. See Enrol a fleet.
HOPBITS_DISABLE_KINDSNoneComma-separated check kinds to disable (http, tcp_connect, icmp_ping).
HOPBITS_AUTO_UPDATEtrueSet to false to disable automatic signed release updates.
HOPBITS_IMAGEhopbits/agent:local (verified build)Pull and run a custom pre-built image instead of building locally.
HOPBITS_CONTAINER_NAMEhopbits-agentThe name of the container.
HOPBITS_VOLUME_NAMEhopbits-dataThe name of the volume.