Automated Backups with Restic + Backblaze B2

TL;DR

To set up automated backups on your Debian 13 server using Restic and Backblaze B2, follow these concise steps:

  1. Install Restic: Ensure you have Restic installed on your system. Use the following command:

    sudo apt update && sudo apt install restic

  2. Configure Backblaze B2: Create a Backblaze B2 account and obtain your Account ID and Application Key. Store these securely.

  3. Set Up Environment Variables: Export your Backblaze B2 credentials as environment variables to avoid hardcoding them in scripts:

    export B2_ACCOUNT_ID='your_account_id'
export B2_APPLICATION_KEY='your_application_key'

  4. Initialize Restic Repository: Initialize your Restic repository on Backblaze B2:

    restic init --repo b2:your_bucket_name:path/to/repo

  5. Create Backup Script: Write a simple backup script. Save it as backup.sh:

    #!/bin/bash
export B2_ACCOUNT_ID='your_account_id'
export B2_APPLICATION_KEY='your_application_key'
restic -r b2:your_bucket_name:path/to/repo backup /path/to/data

  6. Make the Script Executable: Change permissions to make your script executable:

    chmod +x backup.sh

  7. Schedule Backups with Cron: Use cron to automate the backup process. Edit your crontab:

    crontab -e

    Add the following line to schedule daily backups at 2 AM:

    0 2 * * * /path/to/backup.sh >> /var/log/restic_backup.log 2>&1

Caution: Ensure your backup script has appropriate permissions and is secured against unauthorized access. Regularly check your backup logs for any errors.

Introduction to Restic and Backblaze B2

Restic is a fast, secure, and efficient backup program that supports various backends, making it an excellent choice for automated backups. It is designed to handle large amounts of data while ensuring data integrity through cryptographic verification. Restic’s deduplication feature minimizes storage usage by only saving unique data blocks, which is particularly beneficial when backing up similar files over time.

Backblaze B2 is a cloud storage service that provides a cost-effective solution for storing backups. It offers a simple pricing model based on the amount of data stored and the bandwidth used, making it an attractive option for individuals and businesses alike. The integration of Restic with Backblaze B2 allows users to leverage the strengths of both tools, ensuring reliable and secure offsite backups.

To get started, you will need to create a Backblaze B2 account and set up a bucket for your backups. Once your bucket is ready, you can configure Restic to use Backblaze B2 as the storage backend. Ensure you have the Backblaze B2 application key and key ID handy, as you will need them for authentication.

Before proceeding, it is crucial to install Restic on your Debian 13 server. You can do this by running:

sudo apt update && sudo apt install restic  # Install Restic

Next, set up your environment variables for Backblaze B2:

export B2_ACCOUNT_ID="your_account_id"  # Replace with your Backblaze B2 account ID
export B2_ACCOUNT_KEY="your_account_key"  # Replace with your Backblaze B2 application key

Caution: Be careful not to expose your Backblaze credentials in public scripts or logs. Always use secure methods to handle sensitive information. For added security, consider using a password manager or environment variable management tool to store your credentials.

Installation of Required Packages

To set up automated backups using Restic with Backblaze B2, you need to install the required packages. Follow the steps below to ensure a smooth installation process.

First, update your package list to ensure you have the latest information on available packages:

sudo apt update  # Update package list

Next, install Restic, which is available in the Debian repositories:

sudo apt install restic  # Install Restic for backups

Restic requires a few additional utilities for optimal functionality. Install the following packages:

sudo apt install curl jq  # Install curl for HTTP requests and jq for JSON parsing

Caution: Ensure that you have sufficient disk space available on your server before proceeding with the installation. You can check your disk space using:

df -h  # Check available disk space

After installing the required packages, you should also consider installing cron if it is not already installed. Cron is essential for scheduling automated backup tasks:

sudo apt install cron  # Install cron for scheduling tasks

Safe Defaults: By default, cron should be enabled and running. You can verify its status with:

sudo systemctl status cron  # Check if cron service is active

If it is not running, you can start it with:

sudo systemctl start cron  # Start cron service

With these packages installed, you are now ready to configure Restic for your automated backups to Backblaze B2. Make sure to keep your system updated regularly to maintain security and functionality.

Configuring Backblaze B2

To configure Backblaze B2 for use with Restic, you first need to create a Backblaze B2 account and set up a bucket for your backups. Follow these steps:

  1. Create a Backblaze B2 Account: Go to the Backblaze website and sign up for an account. Once logged in, navigate to the B2 Cloud Storage section.

  2. Create a Bucket:

    • Click on “Buckets” and then “Create a Bucket”.
    • Choose a unique name for your bucket and set the bucket type to “Private” for security.

  3. Generate Application Keys:

    • In the B2 dashboard, go to “App Keys” and click on “Add a New Application Key”.
    • Provide a name for the key and select the bucket you just created. This limits the key’s access to only that bucket.
    • Make sure to copy the “Key ID” and “Application Key” as you will need them later.

  4. Install Restic (if not already installed):

    sudo apt update
sudo apt install restic

  5. Set Environment Variables: To securely store your Backblaze credentials, set the following environment variables in your shell or add them to your .bashrc or .bash_profile:

    export B2_ACCOUNT_ID="your_key_id"  # Replace with your Key ID
export B2_ACCOUNT_KEY="your_app_key" # Replace with your Application Key

  6. Initialize Restic Repository: Use the following command to initialize your Restic repository on Backblaze B2:

    restic init --repo b2:your_bucket_name:path/to/repo  # Replace with your bucket name

Caution: Ensure that your Application Key has limited permissions and is not exposed in public repositories or shared environments. Use a .env file or a secrets management tool for better security practices. Always test your backup and restore process to confirm that everything is functioning as expected.

Setting Up Restic Repository

To set up a Restic repository with Backblaze B2, follow these steps:

  1. Install Restic: Ensure Restic is installed on your Debian 13 server. If you haven’t installed it yet, run:

    sudo apt update && sudo apt install restic

  2. Create Backblaze B2 Account: Sign up for a Backblaze B2 account if you haven’t done so. After logging in, create a new bucket for your backups.

  3. Obtain Credentials: In your Backblaze B2 account, navigate to the “App Keys” section and create a new application key. Note down the Account ID and Application Key.

  4. Set Environment Variables: For security, store your Backblaze credentials in environment variables. You can add the following lines to your ~/.bashrc or ~/.profile file:

    export B2_ACCOUNT_ID="your_account_id"
export B2_APPLICATION_KEY="your_application_key"

    Replace your_account_id and your_application_key with your actual credentials. After editing, run source ~/.bashrc or source ~/.profile to apply the changes.

  5. Initialize the Restic Repository: Create and initialize your Restic repository in the Backblaze B2 bucket. Replace your-bucket-name and your-repo-name with your actual bucket and desired repository name:

    restic init --repo b2:your-bucket-name:your-repo-name

    This command will prompt you to set a password for your repository. Choose a strong password and store it securely.

  6. Caution: Always ensure your password is stored securely. If you lose it, you will not be able to access your backups.

  7. Test the Repository: Verify that your repository is set up correctly by running:

    restic check --repo b2:your-bucket-name:your-repo-name

    This command checks the integrity of your repository and ensures everything is functioning as expected.

Automating Backups with Cron

To automate your backups with Restic and Backblaze B2, you can use Cron, a time-based job scheduler in Unix-like operating systems. This allows you to run your backup script at regular intervals without manual intervention.

First, create a backup script. Open your preferred text editor and create a new script file:

nano ~/backup_script.sh

Add the following content to the script, adjusting the paths and variables as necessary:

#!/bin/bash

export B2_ACCOUNT_ID="your_account_id"
export B2_ACCOUNT_KEY="your_account_key"
export RESTIC_REPOSITORY="b2:bucket_name:path/to/repo"
export RESTIC_PASSWORD="your_restic_password"

# Run the backup
restic backup /path/to/backup --verbose

# Optional: Prune old backups
restic forget --prune --keep-last 7 --keep-daily 30 --keep-weekly 12 --keep-monthly 6

Make the script executable:

chmod +x ~/backup_script.sh

Next, edit your crontab to schedule the backup. Open the crontab editor:

crontab -e

Add a line to schedule the backup. For example, to run the backup daily at 2 AM:

0 2 * * * /bin/bash ~/backup_script.sh >> ~/backup.log 2>&1

This command redirects both standard output and errors to a log file for troubleshooting.

Caution: Ensure your backup script is secure. Avoid hardcoding sensitive information directly in the script. Consider using environment variables or a secure vault for credentials.

Safe Defaults: Test your backup script manually before scheduling it with Cron to ensure it works as expected. Monitor the log file regularly to catch any issues early.

2 * * * /usr/bin/restic backup /path/to/backup –repo b2:your_bucket_name:your_repo_name

To automate your backups using Restic with Backblaze B2, you will need to set up a cron job that runs the backup command at specified intervals. The following example demonstrates how to create a cron job that executes the backup every hour.

First, open the crontab for editing:

crontab -e

Add the following line to schedule the backup:

Breakdown of the cron job:

  • 2 * * *: This specifies that the backup will run at 2 minutes past every hour. Adjust the timing as needed.
  • /usr/bin/restic: This is the full path to the Restic binary. Ensure that Restic is installed and accessible at this location.
  • backup: This is the Restic command to initiate a backup.
  • /path/to/backup: Replace this with the actual path you want to back up. Ensure that this directory is accessible and contains the files you wish to back up.
  • --repo b2:your_bucket_name:your_repo_name: Replace your_bucket_name and your_repo_name with your actual Backblaze B2 bucket and repository names.

Cautions:

  1. Environment Variables: Ensure that your B2 credentials are set in your environment. You can do this by exporting them in your shell or including them in a script that runs before the backup command.

    export B2_ACCOUNT_ID=your_account_id
export B2_ACCOUNT_KEY=your_account_key

  2. Permissions: Make sure that the user running the cron job has the necessary permissions to access the backup directory and execute Restic.

  3. Testing: Before relying on the automated backup, manually run the backup command to ensure it works as expected. Check the logs for any errors.

  4. Backup Retention: Consider implementing a retention policy to manage the number of backups stored in your repository, using the forget command in Restic.

By following these guidelines, you can ensure that your automated backups are set up correctly and securely.

Buy me a coffee ☕