Files
spinifex/docs/install-usb
tomnewton-mulga 7cc90f554c daemon race fix
2026-04-21 14:54:00 +10:00
..
2026-04-21 14:54:00 +10:00

Installing Spinifex from Bootable USB

Spinifex is designed for bare-metal hardware, edge nodes and data-centre use. Follow this guide to install Spinifex from a bootable USB using the Spinifex ISO.

Note this tutorial is for x86 architecture. Also note, this procedure COMPLETELY WIPES the target disk. For systems with multiple disks, ensure the correct one is targeted.

Booting Media

For this tutorial, a USB drive with at least 8GB of memory is required. Note that flashing the Spinifex ISO onto the USB completely wipes the USB, so ensure no important data is stored on the USB used.

Balena Etcher installation

For this tutorial download Balena Etcher to simplify the ISO flash process.

Download Spinifex ISO

Next, download the Spinifex ISO (x86)

Flash Media

Once installed, open Balena Etcher. Select "Flash From Image," then select the downloaded spinifex.iso file (it should be in your Downloads folder).

Next, click "Select target" and choose the USB drive to be used as the boot media. Then click "Flash!"

Balena Etcher will now flash the USB drive with the spinifex.iso file. If completed successfully, it will look like this: Balena complete

You can now safely eject the USB drive if it was not ejected automatically.

Boot From USB drive

Insert your newly flashed USB drive into the target device and turn it on.

ASUS Box

As it boots, quickly press the correct key for your device to bring up the BIOS/UEFI menu (commonly F2, F10, F12, ESC or DEL) (image) and change the boot order such that the flashed USB drive has first priority, then continue to boot.

If done succesfully, the Spinifex ISO GRUB menu will appear. GRUB From this menu you can select which method of install is used (console recommended). Headless mode can be configured by mounting the USB on a host device after flashing and editing the grub.cfg file with the desired values.

Setting up the Spinifex Node

In console mode, follow the installation prompts to set the required networking values for the Spinifex node.

The installer will default to the most sensible disk to install on depending on system configuration - ensure this default is correct before installation, as the process will wipe the disk.

For network configuration, it is recommended to use automatic IP (DHCP), but this can also be configured manually.

Network interfaces will be automatically detected. In the event that none are detected, the user can manually input the name of the network interface. in the event that multiple network interfaces are detected, the installer will prompt for WAN selection first, followed by LAN.

A hostname (eg node1) and admin password must be set, followed by the "cluster role" - whether the node is the first in a new cluster, or joining an already an existing one.

Once configuration is complete, a summary of the configuration will be shown.

Installer complete

The installer will then complete the installation of Spinifex onto the target device. Once complete, you will be prompted to remove the USB drive from the device before automatic reboot.

Once the USB drive is removed, press enter or wait for the auto-reboot.

Log In

The device will reboot and spend ~2-5 minutes configuring the Spinifex node. The user will then be prompted to log in. Use the following credentials for login:

  • Login: spinifex
  • Password: Set by user during installation

Both before and after login, a banner will be printed specifying important info, such as details for SSH into the node and accessing the web UI for further configuration of the node. banner

Setup Complete

Congratulations! You have now configured your device to operate as a Spinifex node!