Backup and Restore for Node-RED.
Project description
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 tokentelegram 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 code0
if data exists, else1
)backup
: creates a backup- requires:
--file
- requires:
restore
: restores from a backup- requires:
--file
- requires:
auto
: performs acheck
and either creates a backup to or restores a backup from the given--file
- requires:
--file
- requires:
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. :)
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for homelab_node_red_backup-1.4.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | e9f4dbcd2953f725cbf17656c7fd1a115559876428663ca46ce8811eae4ac37d |
|
MD5 | 058dae3e69d28f74011ee5e6109e1f6b |
|
BLAKE2b-256 | 5dfd4c49bed4abe9ece8a7487ea45a714b8fe7777f41d51b75671fb2186c2173 |
Hashes for homelab_node_red_backup-1.4.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | adb6a55a408aac2e88b9279efa9cc217c95a83569214d732ad0660cd16e98ad9 |
|
MD5 | 752cd64d5fcfee6b873845f5aec8c913 |
|
BLAKE2b-256 | c515507cfe05ae1c1c7051f1b1baca837706ff228587a6c369305044e4ff2d01 |