Skip to content

FPP-Backup 0.3.0

Choose a tag to compare

@SRipaldi SRipaldi released this 16 Nov 04:23
· 24 commits to main since this release
26196b5

Upgrade controllers in place

The Fleet page can now upgrade controllers to a newer FPP release without rebuilding their SD cards. Use Upgrade… on a controller's row, or Upgrade all….

  • Two kinds of upgrade, the same ones FPP's About page offers:
    • FPP update: the controller fetches the new release from GitHub and rebuilds FPP. It keeps its current operating system.
    • OS upgrade: replaces the controller's whole system with the release's OS image.
      The dialog recommends one based on what the release notes say.
  • One controller at a time, player last. The run stops at the first problem, so a bad release can affect only one controller.
  • Waits for the show. Nothing starts while the show plays, or if a playlist is due before the upgrade could finish.
  • Checks each controller afterwards. Before upgrading, it records the version, outputs, sequences, playlists, network, settings, warnings and ColorLight receiver. After the reboot it compares them, and it can back the controller up first.
  • Controllers without internet access get the OS image from this Mac. The image is checked against GitHub's SHA-256, uploaded through the player and deleted afterwards.
  • Old OS images left in controllers' Uploads folders (1–1.3 GB each) can be listed and deleted.
  • tools/upgrade.py recheck --hosts <name> re-runs the comparison later, for example after a power cycle.

Handling FPP's unreliable restarts

In the first live upgrades, every controller reached the new version, but FPP's restart afterwards wasn't always clean. The tool now handles what we saw:

  • FPP's startup times out on the first boot after an OS upgrade: the tool reboots once more.
  • An FPP update takes FPP's player service down to finish: the tool treats this as a normal restart and always reboots at the end.
  • A controller stays off the network, or FPP doesn't start: the message says the upgrade probably worked and tells you to power-cycle the controller, then run recheck.
  • "Plugins must be reinstalled" after an OS upgrade: shown as a separate check with a note that this is expected.

Hardening

  • Hostnames that devices announce on the network must be valid before they're used in file paths.
  • OS images must be plain .fppos files from github.com.
  • A .snyk file keeps Snyk scans out of local data (snapshots/ holds controller passwords). Snyk's infrastructure-as-code scan is turned off for this folder, since there's nothing for it to check here.

Notes

  • If a controller's last backup is older than 24 hours, the dialog offers to back it up first. Take the backup: it's what you'd rebuild a card from if an upgrade goes wrong.
  • An OS upgrade sometimes needs a power cycle to finish. When it does, the tool says so.
  • Tests: python3 -m unittest discover -s tests runs 33 tests against a simulated controller.

Full changes: v0.2.1...v0.3.0