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 backupbackup
: creates a backup- requires:
--file
- requires:
restore
: restores from a backup- 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.1.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3fb21169f1026d67c22a5a5ba8a1a6b0af6a2143fa1fbece06eafa1913379535 |
|
MD5 | b60432b243472874f22a027f9e0db82b |
|
BLAKE2b-256 | 7d6dbf7811cda564a9cff8ded1c95f4a967e1add88bbf7deacc9ce3d82ba73af |
Hashes for homelab_node_red_backup-1.1.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ee7e22f65489cb8f5bd6e47408e5d649db8ed7b3d79658ea7c23df8e214bc8e3 |
|
MD5 | 62158555b463a1a3436ff78a8cf1d77b |
|
BLAKE2b-256 | 98cfd203325142e94474fdad6a7cf7dd4d46002c2152d04d69b3bd573f68f670 |