egladman / octoprint-fedora-arm

Fedora-based Octoprint image for ARM single board computers

octoprint-fedora-arm

An immutable Octoprint ARM image with an emphasis on resiliency. Set it and forget it. This project was inspired by OctoPi, but shares zero code.

Features

• Read-only filesystem
  • Flash storage is susceptible to data corruption on power loss, and heavy writes. We're able to entirely circumvent this issue by mounting the filesystem as read-only and leveraging a tmpfs that lives in RAM.
• Container-based
• Application auto-updates
  • Disabled by default
• Device Autodiscovery
  • On boot all relevant character devices (i.e, serial ports, cameras) will be made accessible to Octoprint

Hardware Requirements

RAM

Everything lives in RAM. This includes the root filesystem and container hence it's heavier than a traditional octoprint install.

• minimum: 4GB

Storage

• minimum: 8GB

Persistence

1. Format a usb flashdrive with the following settings:

• label: OCTOPRINT

2. While off insert the usb flashdrive into the device.

3. Power on the device. Octoprint config settings will be written to the flashdrive.

Build

1. Download the corresponding raw aarch64 image from fedoraproject.org and save it to the working directory

2. Verify checksums

3. Build image

make boards/arm64/v8/generic

Note: The image will be placed in build/dist

Install

xzcat

xzcat Octoprint-Fedora-38-1.6.aarch64.raw.xz | dd iflag=fullblock of=/dev/XXX oflag=direct bs=4M status=progress && sync

Note: Depending on your setup you might need to prefix dd with sudo (i.e, xzcat ... | sudo dd ...).

arm-image-installer

arm-image-installer --media=/dev/XXX --resizefs --target=none --image=Octoprint-Fedora-38-1.6.aarch64.raw.xz

Post Install

1. SSH into the machine

ssh octo@octoprint

2. Change the default password for user octo

sudo octoprint-readonly disable
passwd octo
sudo octoprint-readonly enable

Packaging

make ENABLE_DEBUG=0 ENABLE_RELEASE=1 boards/arm64/v8/generic
(cd build/dist; sha512sum *) > build/dist/CHECKSUM)

Development

Dependencies:

• systemd-nspawn
• qemu
• make
• bash

QEMU

make setup-qemu
sudo make setup-binfmt

Debugging

Raspberry Pi

If the device fails to start then attach a serial cable and watch the logs

screen /dev/ttyUSB0 115200

To exit screen, type Control-A k.

Commonly Asked Questions

1. What's the default username/password for the unprivileged user?

• Username: octo
• Password: octo

2. I can't delete build, it says its busy

sudo umount build/rootfs/boot
sudo umount build/firmware
sudo umount build/rootfs
sudo vgchange -an fedora
sudo losetup -D build/fedora.raw

3. I can't delete build, it says permission denied

sudo rm -irf build

4. How do a run a command as root if a password isn't set for it?

While logged in as octo run:

sudo su -
whoami

5. Is it possible to temporarily enable write access to the root filesystem?

sudo octoprint-readonly disable

Once you're done making changes remount as readonly

sudo octoprint-readonly enable

6. What's the stream/snapshot webcam URLs?

• stream: /webcam/?action=stream
• snapshot: http://localhost:8080/?action=snapshot

source