# ucg-config-backup

ucg-config-backup is a self-hosted backup app. 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. It is open source and self-hosted, installable on Unraid.

Canonical page: https://ourlocalhost.com/app/6847/ucg-config-backup

## Description

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.

## Health score

44/100 (Fair), based on 3 of 4 factors.
- Maintained: 79 (last commit 2 days ago)
- Popular: 6 (1 GitHub stars)
- Easy to install: 20 (1 install platform, Docker image)

## Links

- Unraid: https://ca.unraid.net/apps/ucg-config-backup-02qvi2b06kprlb?q=ucg-config-backup
- GitHub: https://github.com/Tom-Joad/ucg-config-backup

## 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.

---
Source: Our Local Host (https://ourlocalhost.com/app/6847/ucg-config-backup), the self-hosted and open-source app directory.