Getting Started with BeepBackup
Welcome to BeepBackup! This guide will walk you through setting up your first backup in just a few minutes.
What You’ll Need
Before getting started, make sure you have:
- A server you want to back up, with connection access over SSH.
- An S3-compatible storage provider (for example: AWS S3, DigitalOcean Spaces, Hetzner Object Storage, Minio etc.)
- Your S3 credentials (access key, secret key, bucket name).
- A GPG key if you want to encrypt your backups (see: How To Create A GPG Key Pair if you don’t have one)
Understanding The Back-up Process
Creating A Backup Configuration
We’ve tried to make it as fast as possible to get you set up. If you want, you can first connect the necessary resources, for example:
In this guide, we’ll do all the necessary steps at once, while going through the flow of setting up a file backup.
Step 3: Configure Your First Backup
- Click “Create Backup” in your dashboard
- Select your server from the dropdown
- Choose what type of backup you want to create:
- File Backup: Back up directories and files
- Database Backup: Back up MySQL (PostgreSQL, and Sqlite coming soon)
Step 4: Set Up S3 Storage
- Enter your S3 credentials:
- Access Key ID
- Secret Access Key
- Bucket Name
- Region
- Test the connection to ensure everything is working
Step 5: Configure Encryption (Optional)
For enhanced security, you can enable encryption at rest:
- Generate or upload your GPG public key
- BeepBackup will encrypt all backups before sending them to S3
- Only you will have the private key to decrypt your data
Step 6: Set Retention Policy
Configure how long you want to keep your backups:
- Hourly: Keep backups for a few days
- Daily: Keep daily backups for weeks
- Weekly: Keep weekly backups for months
- Monthly: Keep monthly backups for years
Step 7: Start Your First Backup
- Review your configuration
- Click “Start Backup”
- Monitor the progress in your dashboard
Next Steps
Once your first backup is complete:
- Set up backup monitoring and notifications
- Configure additional backup jobs
- Test your backup restoration process
Need help? Check out our other documentation articles or contact support.