Skip to main content

​
Introduction

ZFlash writes an EVE-OS installer or live image onto a USB drive or SD card. Use the flashed drive to install EVE-OS on a node’s onboard storage, or to live-boot EVE-OS on hardware without onboard storage. ZFlash supports .raw, .img, .wic, .zip, .gz, .xz, .iso, and .zst file formats.
Flashing completely overwrites the target drive. Confirm you have selected the correct storage device before proceeding.

​
Prerequisites

​
Flash on macOS

  1. Go to https://github.com/zededa/zflash/releases/latest.
  2. Download ZFlash.Imager-<version>.dmg.
  3. Open the downloaded .dmg file and drag zflash.app to your Applications folder.
  4. Launch zflash.app. If macOS blocks it, go to System Settings > Privacy & Security, find the blocked message, and click Open Anyway.
  5. In ZFlash, click Choose OS and select one of the following options: Select a custom image file from your computer and choose the EVE-OS image file you generated, or select a generic EVE-OS version that can be downloaded directly from GitHub.
  6. Connect your USB drive or SD card.
  7. Click Choose Storage and select your storage device.
  8. Click Next until the process is complete.

​
Flash on Linux

  1. Go to https://github.com/zededa/zflash/releases/latest.
  2. Download ZFlash-<version>.AppImage.
  3. Set the executable permission on the downloaded file.
  1. Run ZFlash.
  1. Click Choose OS and select one of the following options: Select a custom image file from your computer and choose the EVE-OS image file you generated, or select a generic EVE-OS version that can be downloaded directly from GitHub.
  2. Connect your USB drive or SD card.
  3. Click Choose Storage and select your storage device.
  4. Click Next until the process is complete.

​
Flash on Windows

  1. Go to https://github.com/zededa/zflash/releases/latest.
  2. Download ZFlash-Image-<version>.exe and run the installer.
  3. Launch the ZFlash app.
  4. Click Choose OS and select one of the following options: Select a custom .img from your computer and choose the EVE-OS image file you generated, or select a generic EVE-OS version that can be downloaded directly from GitHub.
  5. Insert your USB drive or SD card.
  6. Click Choose Storage and select your storage device.
  7. Click Next until the process is complete.

​
Flash for Raspberry Pi Devices

Raspberry Pi devices require a live EVE-OS image and must be booted from an SD card. See Get EVE-OS for instructions on generating a live image. Use EVE-OS version 14.0.0-LTS or later for Raspberry Pi 5 support.
  1. Install the Raspberry Pi Imager.
  2. Connect a USB SD card adapter to your local machine.
  3. Insert your SD card into the USB adapter.
  4. Open the Raspberry Pi Imager.
  5. Select your Raspberry Pi model from the device dropdown.
  6. Select Use Custom from the Operating System dropdown and choose your EVE-OS live image file.
  7. Select your USB drive from the Storage window.
  8. Click Next, then No when prompted for OS customizations.
  9. Click Yes to confirm erasing the SD card, then Continue.
  10. Eject the SD card after flashing is complete.
Connect the flashed SD card to your node to boot into EVE-OS.

​
Next Steps

  • If you flashed an installer image: Install EVE-OS onto an Edge Device.
  • If you flashed a live image: connect the storage device to your node and power it on to live-boot EVE-OS.