Quick Start

Your first backup in under 5 minutes

⏱ 5 minutes

borg-anchor creates deduplicated, compressed backups and timestamps them on Bitcoin for proof of existence.

1 Install

# Install BorgBackup
brew install borgbackup        # macOS
sudo apt install borgbackup    # Ubuntu/Debian

# Install borg-anchor
npm install -g borg-anchor

2 Back Up a Folder

# Back up the ~/Documents/ folder to ~/backups/
borg-anchor init ~/backups/
borg-anchor backup ~/Documents/ ~/backups/ --name my-backup --no-anchor

3 Verify & Restore

# List your backups
borg-anchor list ~/backups/

# Restore to a new location
borg-anchor restore my-backup ~/restored/ ~/backups/

🎉 You're done! You now have a working Borg backup. Files are deduplicated (same file stored once) and compressed automatically.

What Just Happened?

borg-anchor init created a repository at ~/backups/repo/ where all your backups are stored.

borg-anchor backup created an archive (a snapshot) of your Documents folder. If you run it again, only changed files are stored.

borg-anchor restore extracts your files exactly as they were when backed up.

Common Commands

# Create backups
borg-anchor backup ~/mydata ~/backups/
borg-anchor backup ~/mydata ~/backups/ --name daily-backup

# View backups
borg-anchor list ~/backups/

# Restore
borg-anchor restore my-backup ~/destination ~/backups/

What's Next?

You've got backups working. Now explore:

How It Works Add Bitcoin Timestamping

Why Borg?

Deduplication: If you backup the same 1GB file 10 times, it only takes 1GB of space.

Compression: Data is automatically compressed. A 100GB backup might only use 30GB.

Speed: After the first backup, subsequent backups are extremely fast since only changes are stored.

Encryption: Add --encryption repokey when initializing for AES-256 encryption.

Troubleshooting

borg: command not found

Install BorgBackup with your package manager: brew install borgbackup or sudo apt install borgbackup

No config found

Make sure you're in the backup directory or run borg-anchor init first.

Need help?

Check the full getting started guide or visit GitHub.