Backup

A lightweight database backup solution for Medusa v2 that enables creation, management, and restoration of PostgreSQL backups.

Features

Backup Capabilities

• Automatic Daily Backups: Configurable via cron scheduling
• Manual Backups: On-demand backup creation
• S3 Storage: Store backups securely in AWS S3
• Compression: Reduces backup sizes by approximately 70%

Restore Functionality

• Production to Local: Safely restore production databases to local environments
• Point-in-Time Recovery: Restore from any previous backup
• Safe Operations: Prevents accidental overwrites

Installation

npm install medusa-backup

Requirements

• Medusa v2.4.0 or higher
• PostgreSQL database
• pg_dump utility installed
• AWS S3 account and credentials

Configuration

S3 Setup

Configure your AWS S3 bucket:

• Bucket name
• AWS credentials (Access Key ID, Secret Access Key)
• Region

Automatic Backups

• Disabled by default
• Only functions in production environments
• Configurable cron schedule
• Daily backups recommended

Usage

Manual Backup

Create backups on-demand through the Medusa admin interface or API.

Automatic Backup

Configure cron schedule for automatic daily backups:

# Daily at 2 AM
0 2 * * *

Restore Process

1. Select backup from available backups
2. Choose target environment
3. Confirm restoration
4. Database restored from backup

Security Considerations

• Automatic backups only in production
• Encrypted S3 storage
• Access control via AWS IAM
• Safe restore operations

Use Cases

• Disaster recovery
• Development environment setup
• Pre-deployment backups
• Data migration
• Testing with production data
• Compliance requirements

Backup Management

• View all backups
• Download backups
• Delete old backups
• Monitor backup status
• Track backup sizes (compressed)

Compatibility

Compatible with Medusa v2.4.0 and above.