ucg-config-backup

Logs in to the local UniFi OS API of a UCG Ultra (or another UniFi OS console), triggers a config backup and downloads it on a cron schedule.

  • Backup
  • Network Services
Logs in to the local UniFi OS API of a UCG Ultra (or another UniFi OS console), triggers a config backup and downloads it on a cron schedule. The console needs no cloud connection. Old backups are deleted after RETENTION_DAYS; failures (and optionally successes) can be sent to a webhook. Progress is in the container log.

Platform availability

Available on 1 of 6 install platforms

  • Unraid
  • TrueNAS (not listed)
  • Umbrel (not listed)
  • ZimaOS (not listed)
  • Proxmox (not listed)
  • Helm (not listed)

Also on GitHub

Health score

44/100 Fair

Maintained
79last commit 2 days ago
Popular
61 GitHub stars
Easy to install
201 install platform, Docker image
Light to run
No data

Based on 3 of 4 factors.

How is this calculated?

A 0-100 score computed nightly from four factors: maintained (40%: recent commits and steady activity), popular (25%: GitHub stars, log scale), easy to install (20%: platforms, install notes, setup guides, Docker image) and light to run (15%: minimum RAM, ARM support). Factors without data are left out and the rest are rescaled.

Availability: platform listings confirmed today

GitHub stars
1
Open issues
0
Last commit
2026-10-04
Latest release
v2.1.2
License
MIT
Activity
rising

Checked today - source: GitHub (Tom-Joad/ucg-config-backup)

Resources & Compatibility

Requirements not published yet.

Checked today - source: Docker Hub image tags and published docs

First-install notes

No first-install notes yet.

Alternatives

No alternatives collected yet.

Common questions

Which environment variables should I set for the Docker container?

Add UCG_HOST, UCG_USERNAME, UCG_PASSWORD, PUID=99, PGID=100, and UMASK=002, plus any optional variables; at minimum set TZ.

How do I install it on Unraid?

Install ucg-config-backup for Unraid OS from Community Apps.

How is the backup scheduled?

It triggers a config backup and downloads it on a cron schedule.

How do I confirm the first backup succeeded?

Check Docker → container icon → Logs to confirm the first backup ran cleanly.

Answers sourced from ca.unraid.net, github.com

Community

No community discussions collected yet.