Homelab: Node-RED Backup & Restore

This repository contains Python scripts leveraging the Node-RED Admin API endpoints to create and restore backups.

Attention: the Node-RED installation must either be unsecured or secured by OAuth!

Installation

The package is published in (Test)PyPi and can be installed via:

pip install homelab-node-red-backup

Configuration

The following arguments are available:

• --endpoint / -e: the Node-RED endpoint
• --file / -f: the JSON file
• --jwt-token / -jwt: the JWT token to authenticate with

Credentials

Credentials are detected, retrieved, and merged to the output JSON file. The following credential types are recognized:

• servers: e.g. a Home Assistant server with an access token
• telegram bot: Telegram bot with a token

Usage

The following commands are available, and all commands require the arguments --endpoint, and, optionally, --jwt-token set.

• check: checks if data exists for a backup (return code 0 if data exists, else 1)
• backup: creates a backup
  • requires: --file
• restore: restores from a backup
  • requires: --file
• auto: performs a check and either creates a backup to or restores a backup from the given --file
  • requires: --file

Examples

# checking if data exists
homelab-node-red-backup check -e http://localhost:1880 -jwt <TOKEN>

# creating a backup
homelab-node-red-backup backup -e http://localhost:1880 -jwt <TOKEN> -f backup.json

# restoring from the backup
homelab-node-red-backup restore -e http://localhost:1880 -jwt <TOKEN> -f backup.json

Supporting

If you enjoy the application and want to support my efforts, please feel free to buy me a coffe. :)