Backup & Restore - Auk Documentation

Why Backup?

Protect your API collections, environments, and history from:

Accidental Deletion

Recover deleted collections or requests

Data Corruption

Restore from corruption or file system errors

Hardware Failure

Recover from disk failures or computer loss

Sync Conflicts

Rollback to known good state after conflicts

Backup Strategies

1. Git Sync (Recommended)

Using Git provides automatic, versioned backups: Advantages:

✅ Automatic backups on every sync
✅ Complete version history
✅ Easy rollback to any point
✅ Team collaboration built-in
✅ Remote storage included

Setup:

{
  "git": {
    "enabled": true,
    "remoteUrl": "[email protected]:username/api-collections.git",
    "autoSync": true,
    "syncInterval": 900
  }
}

Restore from Git:

# View history
git log --oneline

# Restore specific file
git checkout <commit-hash> -- collections/user-api.json

# Restore entire workspace to specific point
git checkout <commit-hash>

2. Time Machine (macOS)

macOS Time Machine automatically backs up Auk data: Setup:

Enable Time Machine in System Preferences
Auk data is automatically included
Backups occur hourly

Restore:

Open Time Machine
Navigate to Auk workspace folder
Select date to restore from
Click “Restore”

3. Manual Backups

Create manual backups on demand:

macOS/Linux
Windows

# Backup single workspace
tar -czf ~/Backups/my-workspace-$(date +%Y%m%d).tar.gz \
  ~/Library/Application\ Support/Auk/workspaces/my-workspace/

# Backup all workspaces
tar -czf ~/Backups/auk-all-$(date +%Y%m%d).tar.gz \
  ~/Library/Application\ Support/Auk/workspaces/

# Backup to external drive
rsync -av ~/Library/Application\ Support/Auk/workspaces/ \
  /Volumes/Backup/Auk/

# Backup single workspace
tar -czf %USERPROFILE%\Backups\my-workspace-%date:~-4,4%%date:~-10,2%%date:~-7,2%.tar.gz ^
  %APPDATA%\Auk\workspaces\my-workspace\

# Or use Windows Backup
# Settings → Update & Security → Backup

4. Automated Backup Script

Create a script for regular backups:

Bash Script
PowerShell Script

#!/bin/bash
# backup-auk.sh

BACKUP_DIR=~/Backups/Auk
WORKSPACE_DIR=~/Library/Application\ Support/Auk/workspaces
DATE=$(date +%Y%m%d-%H%M%S)
RETENTION_DAYS=30

# Create backup directory
mkdir -p $BACKUP_DIR

# Backup all workspaces
tar -czf $BACKUP_DIR/auk-backup-$DATE.tar.gz $WORKSPACE_DIR

# Delete old backups
find $BACKUP_DIR -name "auk-backup-*.tar.gz" -mtime +$RETENTION_DAYS -delete

echo "Backup completed: auk-backup-$DATE.tar.gz"

Schedule with cron:

# Edit crontab
crontab -e

# Add daily backup at 2 AM
0 2 * * * /path/to/backup-auk.sh

# backup-auk.ps1

$BackupDir = "$env:USERPROFILE\Backups\Auk"
$WorkspaceDir = "$env:APPDATA\Auk\workspaces"
$Date = Get-Date -Format "yyyyMMdd-HHmmss"
$RetentionDays = 30

# Create backup directory
New-Item -ItemType Directory -Force -Path $BackupDir

# Backup all workspaces
Compress-Archive -Path $WorkspaceDir -DestinationPath "$BackupDir\auk-backup-$Date.zip"

# Delete old backups
Get-ChildItem $BackupDir -Filter "auk-backup-*.zip" |
  Where-Object { $_.LastWriteTime -lt (Get-Date).AddDays(-$RetentionDays) } |
  Remove-Item

Write-Host "Backup completed: auk-backup-$Date.zip"

Schedule with Task Scheduler:

Open Task Scheduler
Create Basic Task
Trigger: Daily at 2 AM
Action: Start a program → PowerShell
Arguments: -File C:\path\to\backup-auk.ps1

5. Cloud Backup

Backup to cloud storage:

Dropbox
Google Drive
AWS S3

# Sync workspace to Dropbox
rsync -av ~/Library/Application\ Support/Auk/workspaces/ \
  ~/Dropbox/Auk-Backup/

# Sync workspace to Google Drive
rsync -av ~/Library/Application\ Support/Auk/workspaces/ \
  ~/Google\ Drive/Auk-Backup/

# Install AWS CLI first
# brew install awscli

# Sync to S3
aws s3 sync ~/Library/Application\ Support/Auk/workspaces/ \
  s3://my-bucket/auk-backup/

Restore Procedures

Restore from Git

View History

cd ~/Library/Application\ Support/Auk/workspaces/my-workspace
git log --oneline --graph

Find Commit

Identify the commit to restore to

Restore

# Restore specific file
git checkout <commit-hash> -- collections/user-api.json

# Restore entire workspace
git reset --hard <commit-hash>

# Or create new branch from old state
git checkout -b recovery <commit-hash>

Verify

Open Auk and verify data is restored correctly

Restore from Archive

Locate Backup

Find the backup archive to restore from

Close Auk

Ensure Auk is not running

Extract

# macOS/Linux
tar -xzf ~/Backups/auk-backup-20240220.tar.gz -C /tmp/

# Windows
Expand-Archive -Path $env:USERPROFILE\Backups\auk-backup-20240220.zip -DestinationPath C:\Temp\

Copy Files

# Backup current state first
mv ~/Library/Application\ Support/Auk/workspaces/my-workspace \
   ~/Library/Application\ Support/Auk/workspaces/my-workspace.old

# Restore from backup
cp -r /tmp/workspaces/my-workspace \
   ~/Library/Application\ Support/Auk/workspaces/

Verify

Open Auk and verify restoration

Restore from Time Machine

Open Time Machine

Click Time Machine icon in menu bar → “Enter Time Machine”

Navigate

Navigate to:

~/Library/Application Support/Auk/workspaces/my-workspace/

Select Date

Use timeline to find the date to restore from

Restore

Select files/folders and click “Restore”

Selective Restore

Restore specific items:

Single Collection
Environment
Entire Workspace

# From Git
git checkout <commit-hash> -- collections/user-api.json

# From archive
tar -xzf backup.tar.gz --strip-components=3 \
  workspaces/my-workspace/collections/user-api.json

# From Git
git checkout <commit-hash> -- environments/production.json

# From archive
tar -xzf backup.tar.gz --strip-components=3 \
  workspaces/my-workspace/environments/production.json

# From Git
git reset --hard <commit-hash>

# From archive
tar -xzf backup.tar.gz -C ~/Library/Application\ Support/Auk/

Backup Best Practices

3-2-1 Rule

Follow the 3-2-1 backup rule:

3 copies of data (original + 2 backups)
2 different storage types (local + cloud)
1 offsite backup (cloud or external drive)

Example:

Original: Auk workspace
Backup 1: Git remote (GitHub)
Backup 2: Time Machine / local archive

Regular Schedule

Backup regularly:

Git sync: Every 15 minutes (automatic)
Manual backup: Weekly
Cloud backup: Daily
External drive: Monthly

Test Restores

Regularly test restore procedures:

Create test workspace
Backup test workspace
Delete test workspace
Restore from backup
Verify all data intact

Version Retention

Keep multiple backup versions:

Daily: Last 7 days
Weekly: Last 4 weeks
Monthly: Last 12 months
Yearly: Indefinite

Encrypt Sensitive Data

Encrypt backups containing sensitive data:

# Encrypt backup
tar -czf - workspace/ | gpg -c > backup.tar.gz.gpg

# Decrypt backup
gpg -d backup.tar.gz.gpg | tar -xz

Backup Verification

Verify Backup Integrity

Archive Integrity
Git Integrity
Checksum

# Test archive
tar -tzf backup.tar.gz > /dev/null && echo "OK" || echo "CORRUPTED"

# List contents
tar -tzf backup.tar.gz | head -20

cd workspace-directory

# Verify repository
git fsck --full

# Verify remote
git ls-remote origin

# Create checksum
shasum -a 256 backup.tar.gz > backup.tar.gz.sha256

# Verify checksum
shasum -a 256 -c backup.tar.gz.sha256

Disaster Recovery

Complete Data Loss

If all local data is lost:

Reinstall Auk

Download and install Auk

Restore from Git

# Clone workspace
git clone [email protected]:username/api-collections.git \
  ~/Library/Application\ Support/Auk/workspaces/my-workspace

Open in Auk

Open Auk and add workspace from cloned directory

Verify

Check all collections and environments are present

Partial Data Loss

If some data is lost:

Identify Missing Data - What’s missing?
Check Git History - Is it in Git?
Check Backups - Is it in backups?
Restore Selectively - Restore only missing items

Monitoring Backups

Backup Status Dashboard

Create a script to monitor backups:

#!/bin/bash
# check-backups.sh

echo "=== Auk Backup Status ==="
echo

# Git sync status
cd ~/Library/Application\ Support/Auk/workspaces/my-workspace
echo "Git Status:"
git status -sb
echo

# Last backup
echo "Last Manual Backup:"
ls -lht ~/Backups/Auk/ | head -2
echo

# Backup size
echo "Total Backup Size:"
du -sh ~/Backups/Auk/

Backup Alerts

Set up alerts for backup failures:

#!/bin/bash
# backup-with-alert.sh

if ! /path/to/backup-auk.sh; then
  # Send email alert
  echo "Auk backup failed!" | mail -s "Backup Alert" [email protected]

  # Or use notification
  osascript -e 'display notification "Auk backup failed!" with title "Backup Alert"'
fi

Next Steps

Git Sync

Set up automatic Git backups

Data Location

Find your workspace data

File System

Understand file storage

Workspace Settings

Configure workspace options

Documentation Index

​Why Backup?

Accidental Deletion

Data Corruption

Hardware Failure

Sync Conflicts

​Backup Strategies

​1. Git Sync (Recommended)

​2. Time Machine (macOS)

​3. Manual Backups

​4. Automated Backup Script

​5. Cloud Backup

​Restore Procedures

​Restore from Git

​Restore from Archive

​Restore from Time Machine

​Selective Restore

​Backup Best Practices

​Backup Verification

​Verify Backup Integrity

​Disaster Recovery

​Complete Data Loss

​Partial Data Loss

​Monitoring Backups

​Backup Status Dashboard

​Backup Alerts

​Next Steps

Git Sync

Data Location

File System

Workspace Settings

Why Backup?

Backup Strategies

1. Git Sync (Recommended)

2. Time Machine (macOS)

3. Manual Backups

4. Automated Backup Script

5. Cloud Backup

Restore Procedures

Restore from Git

Restore from Archive

Restore from Time Machine

Selective Restore

Backup Best Practices

Backup Verification

Verify Backup Integrity

Disaster Recovery

Complete Data Loss

Partial Data Loss

Monitoring Backups

Backup Status Dashboard

Backup Alerts

Next Steps