Skip to content

FPP-Backup 0.1.0

Choose a tag to compare

@SRipaldi SRipaldi released this 28 Oct 02:45
· 38 commits to main since this release

The first public release of FPP-Backup, a local web app and command-line tools for backing up, monitoring and rebuilding the controllers of an FPP (Falcon Player) light show from a Mac.

It's in use on an 11-controller show (Raspberry Pi 4, BeagleBone Black with KulpLights capes, PocketBeagle 2; FPP 8.5.1 and 10.3). Versions before 1.0 may still change how things work between releases.

What it does

  • Back up every controller's configuration, and optionally its sequences, music and video, through your player. Backing up only reads from the controllers. Media backups are incremental: unchanged files are linked from the previous backup, so a repeat backup takes seconds.
  • Keep the fleet consistent: compare every controller against a policy (time zone, time server, location, gateway, services and anything else you choose) and fix the differences in a click.
  • Check the show will play: find sequences missing from a controller, or an older render of one. With xLights running on the Mac, push the right version as FPP Connect would.
  • Watch a running show: a Live page shows whether each remote is playing the same sequence at the same point as the player.
  • Rebuild or upgrade a controller onto a fresh SD card: turn a backup into a ready-to-boot card image, on the same or a newer FPP version. The app then flashes the card, reads it back to check it, and checks the controller after it boots. The controller comes up with its old hostname, address, settings, outputs and sequences, with no setup steps.
  • Get told when something changes: controllers going offline, remotes dark during a show, policy differences, missing sequences and new FPP releases.
  • Controllers with a UI password work too: passwords are kept in the macOS Keychain. Controllers your player doesn't list can be added by address.

Requirements

  • A Mac; flashing cards needs macOS. Python 3.9 or newer, with no packages to install.
  • Network access to your FPP player.
  • To build card images: Rancher Desktop or another Docker engine, plus Rust once to build the SD card detector.
  • To push sequences: xLights on the same Mac, with its automation port turned on.

See the README to install and set it up.

Known limits

  • Only BeagleBone Black card images have been built and booted so far. Raspberry Pi and BB64 images use the same code but are untested.
  • Password support hasn't yet been tried against a real FPP with its UI password on.
  • Plugins aren't carried onto a rebuilt card (their settings are); reinstall them from FPP's plugin page.
  • Backups run when you start them; there's no schedule yet.
  • Security: the web UI is for the Mac it runs on only. Backups and built card images contain your controllers' passwords and Wi-Fi keys: never share them. xLights' automation port has no password, so turn it on only while pushing. See SECURITY.md.

Not affiliated with or endorsed by the Falcon Player project.