HELBACKUP

HELBACKUP

Docker 应用程序 from Kreuzbube88's Repository

概述

HELBACKUP is a self-hosted backup orchestrator built specifically for Unraid. One container, full control — no cloud dependency, no subscription.


Backup Types:

✓ Flash Drive — Incremental rsync of /boot with SHA-256 verification

✓ Appdata — Optional container stop/start, Docker config export included

✓ Virtual Machines — Libvirt snapshot, vDisk rsync, XML config export

✓ Docker Images — Save images as .tar archives via Docker API

✓ System Config — Network, users, shares, plugins, disk assignments


Targets:

✓ Remote NAS / Server — SSH + Rsync with optional strict host-key pinning

✓ Local Filesystem — Direct path on the Unraid array

✓ NAS Power Management — Wake-on-LAN before backup, auto-shutdown after


Job Engine:

✓ Visual Job Builder — Drag-and-drop step ordering with dependency graph

✓ Retry Logic — Linear or exponential backoff per step

✓ Pre/Post Hook Scripts — Run custom scripts around backup jobs

✓ Catch-Up on Start — Runs missed schedules after container restart

✓ Checksum Verification — SHA-256 validation for all backup files


Retention:

✓ Simple Retention — Keep last N backups with configurable minimum

✓ GFS Rotation — Grandfather-Father-Son: Daily / Weekly / Monthly, saves up to 90% storage


Security & Encryption:

✓ AES-256 Encryption — Optional end-to-end GPG encryption with recovery key

✓ First-Run Setup — No default passwords, admin account created on first access

✓ API Tokens — Scoped tokens with optional expiry

✓ Webhooks — HMAC-signed event delivery


Recovery:

✓ Granular File Restore — Browse and restore individual files or directories

✓ Full Server Restore Wizard — Step-by-step guided recovery for all backup types

✓ Flash Drive Restore — Complete /boot restoration with confirmation guard


Monitoring & Notifications:

✓ 7 Notification Channels — Email, Gotify, ntfy, Pushover, Telegram, Discord, Slack

✓ Live Logs — Real-time backup progress via SSE stream

✓ Dashboard — System status, per-target storage, 30-day history chart

✓ Prometheus Metrics — Ready-made monitoring integration

✓ German & English UI — Full i18n support


First-Time Setup:

  1. Install the container
  2. Open the Web UI
  3. Create your admin account
  4. Save your Recovery Key (shown once!)
  5. Follow the onboarding wizard to create your first backup

Documentation: https://github.com/Kreuzbube88/helbackup

运行时参数

网络用户界面
http://[IP]:[PORT:3000]
网络
br0
外壳
sh
特权
false

模板配置

Web UI PortPorttcp

Port for the HELBACKUP web interface

目标
3000
默认值
3000
价值
3000
ConfigPathrw

SSH keys and application config

目标
/app/config
默认值
/mnt/user/appdata/helbackup/config
价值
/mnt/user/appdata/helbackup/config
DataPathrw

SQLite database

目标
/app/data
默认值
/mnt/user/appdata/helbackup/data
价值
/mnt/user/appdata/helbackup/data
LogsPathrw

Application logs

目标
/app/logs
默认值
/mnt/user/appdata/helbackup/logs
价值
/mnt/user/appdata/helbackup/logs
Docker SocketPathrw

Docker socket for container management (stop/start during backups)

目标
/var/run/docker.sock
默认值
/var/run/docker.sock
价值
/var/run/docker.sock
Unraid Flash DrivePathrw

⚠️ Unraid USB flash drive (READ-WRITE for automated Flash restore). PROTECTED: Write operations only allowed during explicit restore sessions with multi-step confirmation!

目标
/unraid/boot
默认值
/boot
价值
/boot
Host System (Restore)Pathrw

⚠️ Unraid user array (READ-WRITE for automated restore). PROTECTED: Write operations only allowed during explicit restore sessions with multi-step confirmation!

目标
/unraid/user
默认值
/mnt/user
价值
/mnt/user
Cache DrivePathrw

⚠️ Unraid cache drive (READ-WRITE for restore). Required if appdata or VM disks live on cache (/mnt/cache/appdata/, /mnt/cache/domains/).

目标
/unraid/cache
默认值
/mnt/cache
价值
/mnt/cache
Libvirt ConfigsPathro

⚠️ VM configurations (READ-WRITE for restore). Required for VM backup and restore. Remove if you don't use virtual machines.

目标
/unraid/libvirt
默认值
/etc/libvirt
价值
/etc/libvirt
Libvirt SocketPathrw

Libvirt Unix socket. Required for VM live snapshot support during backup. Only available when libvirt is running on the host — remove if not using VMs.

目标
/var/run/libvirt/libvirt-sock
默认值
/var/run/libvirt/libvirt-sock
价值
/var/run/libvirt/libvirt-sock
LIBVIRT_DEFAULT_URIVariable

Libvirt connection URI for VM management. Do not change unless your libvirt setup uses a different URI.

默认值
qemu:///system
价值
qemu:///system
JWT_SECRETVariable

Required: Random secret for authentication. Generate with: openssl rand -hex 32

SECURE_COOKIESVariable

Set to false for local HTTP access. Set to true when using HTTPS via reverse proxy.

默认值
false
价值
false
TZVariable

Timezone for scheduled backups (e.g., Europe/Berlin, America/New_York)

默认值
Europe/Berlin
价值
Europe/Berlin
LOG_LEVELVariable

Log verbosity: debug, info, warn, error

默认值
info
价值
info
PUIDVariable

User ID for file permissions (Unraid default: 99)

默认值
99
价值
99
PGIDVariable

Group ID for file permissions (Unraid default: 100)

默认值
100
价值
100

类别

详细信息

存储库
ghcr.io/kreuzbube88/helbackup:latest
最后更新2026-06-01
初见2026-04-09

在Unraid 上运行 HELBACKUP 。

HELBACKUP 已被列入Unraid OS 的社区应用程序。探索Unraid ,构建灵活的家庭服务器、NAS 或家庭实验室。