Skip to content

fullerzz/borgboi

Repository files navigation

BorgBoi 👦🏼

Wrapper around Borg to ease the process of taking automated backups for my personal systems.

The Borg repository can be synced with an S3 bucket as part of the daily backup operation, or used in offline mode without cloud services.

drawing

Usage

The program can be invoked with: borgboi <cmd> or bb <cmd>

Take Daily Backup

borgboi daily-backup <path-to-repo>

Offline Mode

BorgBoi supports offline mode for users who prefer not to use AWS services:

# Enable offline mode with environment variable
export BORGBOI_OFFLINE=1
bb create-repo --repo-path /opt/borg-repos/docs --backup-target ~/Documents

# Or use the --offline flag
bb daily-backup --repo-path /opt/borg-repos/docs --offline

To Do

  • Wrap common borg operations for creating archive, pruning, and compacting
  • Display borg logs to user through terminal as borg is running
  • Sync local borg repo/its archives with a S3 bucket
  • Add command to print out information on the borg repo
  • Document additional commands
  • Add command to delete borg repo
  • Add command to download remote borg repo from S3
  • Add command to restore from borg repo
  • Additional tests

About

Wrapper around Borg for to taking backups of my system and syncing with S3.

Topics

Resources

License

Stars

Watchers

Forks

Contributors 4

  •  
  •  
  •  
  •