Amazon S3 backup script.

[GuzzaPower]

Hey!

Planka is excellent software, and I enjoy using it. However, I had a problem with the backups filling up space, with the time backup needing more space. So, I wrote a bash script to keep backups only on an S3 bucket and limit the number of backups retained if required. Changing a variable can also keep backups locally and S3 in sync. The oldest backup will be deleted and replaced with a new one based on the number set to be retained daily, weekly, and monthly.

My inspiration was the backup system from cPanel WHM, which has daily, weekly, and monthly backups to retain.

#!/bin/bash

# Stop on error and log each command
set -e
set -o pipefail

# === VARIABLES ===

BACKUP_DATETIME="$(date +"%Y-%m-%d_%H-%M-%S")"  # Timestamp for backup names
INSTALL_DIR="/opt/planka"  # Root directory where Planka is installed
DAILY_BACKUP_DESTINATION="$INSTALL_DIR/backup/daily"  # Directory for daily backups
WEEKLY_BACKUP_DESTINATION="$INSTALL_DIR/backup/weekly"  # Directory for weekly backups
MONTHLY_BACKUP_DESTINATION="$INSTALL_DIR/backup/monthly"  # Directory for monthly backups
LOG_FILE="$INSTALL_DIR/logs/backup.log"  # Log file to store backup process logs

PLANKA_DOCKER_CONTAINER_POSTGRES="planka_db"  # Docker container name for PostgreSQL
PLANKA_DOCKER_CONTAINER_PLANKA="planka"  # Docker container name for the Planka application

MAX_DAILY_BACKUPS=5  # Maximum number of daily backups to retain on S3 & locally
MAX_WEEKLY_BACKUPS=4  # Maximum number of weekly backups to retain on S3 & locally
MAX_MONTHLY_BACKUPS=2  # Maximum number of monthly backups to retain on S3 & locally

S3_BUCKET="s3://backup-planka"  # S3 bucket path where backups will be stored
KEEP_LOCAL=1  # Set to 1 to keep only on S3, or 0 to keep both locally and on S3

# DAY AND WEEK VALUES
DAY_OF_MONTH_VALUE=25  # The day of the month to trigger monthly backups
DAY_OF_WEEK_VALUE=7  # The day of the week (1 = Monday, 7 = Sunday) to trigger weekly backups

# === FUNCTION DEFINITIONS ===

# Function to log messages
log_message() {
    local message="$1"
    echo "$(date +"%A, %B %d, %Y %H:%M:%S") - $message" | tee -a "$LOG_FILE"
}

# Function to manage backup retention on S3
manage_s3_backup_retention() {

    local s3_path="$1"
    local max_backups="$2"

    log_message "Managing backup retention on S3 in $s3_path. Keeping only the last $max_backups backups."

    log_message "Listing backups in S3..."
    s3cmd ls "$s3_path/*" | grep '.tgz' | awk '{print $4}' > /tmp/s3_backups_list.txt

    if [ ! -s /tmp/s3_backups_list.txt ]; then
        log_message "No backups found in S3 path: $s3_path."
        return
    else
        log_message "Backups found in S3:"
        cat /tmp/s3_backups_list.txt | tee -a "$LOG_FILE"
    fi

    total_backups=$(cat /tmp/s3_backups_list.txt | wc -l)
    
    if [ "$total_backups" -le "$max_backups" ]; then
        log_message "No backups to delete. Only $total_backups backups found."
    else
        backups_to_delete=$(cat /tmp/s3_backups_list.txt | head -n -"$max_backups")

        if [ -z "$backups_to_delete" ]; then
            log_message "No backups to delete."
        else
            log_message "Backups to delete:"
            echo "$backups_to_delete" | tee -a "$LOG_FILE"

            for backup in $backups_to_delete; do
                log_message "Deleting old backup from S3: $backup"
                s3cmd del "$backup"
            done
        fi
    fi

    log_message "S3 backup retention management completed."
}

# Function to upload backups to S3 and optionally remove local copies
sync_to_s3_and_cleanup() {
    local local_dir="$1"
    local s3_path="$2"

    log_message "Syncing $local_dir to $s3_path"
    s3cmd sync "$local_dir/" "$s3_path/"

    if [ $? -eq 0 ]; then
        log_message "Sync to S3 completed successfully."
        if [ "$KEEP_LOCAL" -eq 1 ]; then
            log_message "Removing local backups from $local_dir."
            rm -rf "$local_dir"/*
            log_message "Local backups removed from $local_dir."
        else
            log_message "Local backups are not removed as per the flag."
        fi
    else
        log_message "Failed to sync $local_dir to S3. Retaining local backups."
    fi
}

# Start of backup process
log_message "Backup process started."

# Create temporary folder for backup
TEMP_BACKUP_DIR="$DAILY_BACKUP_DESTINATION/$BACKUP_DATETIME-backup"
log_message "Creating temporary backup directory: $TEMP_BACKUP_DIR"
mkdir -p "$TEMP_BACKUP_DIR"

# Dump DB into SQL File
log_message "Exporting Postgres database..."
docker exec -t "$PLANKA_DOCKER_CONTAINER_POSTGRES" pg_dumpall -c -U postgres > "$TEMP_BACKUP_DIR/postgres.sql"
log_message "Postgres database export completed successfully."

# Function to export Docker volumes
export_docker_volume() {
    local volume_path="$1"
    local destination_path="$2"
    log_message "Exporting $volume_path ..."
    docker run --rm --volumes-from "$PLANKA_DOCKER_CONTAINER_PLANKA" -v "$TEMP_BACKUP_DIR:/backup" ubuntu cp -r "$volume_path" "$destination_path"
    log_message "Export of $volume_path completed successfully."
}

# Export user avatars, project background images, and attachments
export_docker_volume "/app/public/user-avatars" "/backup/user-avatars"
export_docker_volume "/app/public/project-background-images" "/backup/project-background-images"
export_docker_volume "/app/private/attachments" "/backup/attachments"

# Create a tar.gz archive of the backup
log_message "Creating final tarball $BACKUP_DATETIME-backup.tgz..."
cd "$DAILY_BACKUP_DESTINATION"
tar -czf "$DAILY_BACKUP_DESTINATION/$BACKUP_DATETIME-backup.tgz" -C "$TEMP_BACKUP_DIR" .
log_message "Tarball created successfully."

# Remove temporary backup directory
log_message "Cleaning up temporary files and folders..."
rm -rf "$TEMP_BACKUP_DIR"
log_message "Cleanup completed successfully."

# Check for day 7 (weekly) and day 25 (monthly)
DAY_OF_WEEK=$(date +%u)  # 1 = Monday, 7 = Sunday
DAY_OF_MONTH=$(date +%d)  # Day of the month

RUN_WEEKLY=false
RUN_MONTHLY=false

if [ "$DAY_OF_WEEK" -eq "$DAY_OF_WEEK_VALUE" ]; then
    RUN_WEEKLY=true
fi

if [ "$DAY_OF_MONTH" -eq "$DAY_OF_MONTH_VALUE" ]; then
    RUN_MONTHLY=true
fi

# Handle Both Weekly and Monthly Backup on the Same Day
if [ "$RUN_WEEKLY" = true ] && [ "$RUN_MONTHLY" = true ]; then
    log_message "Both weekly and monthly backups are running on the same day."

    # Find the latest daily backup tarball
    LATEST_DAILY_BACKUP=$(ls -1t "$DAILY_BACKUP_DESTINATION"/*.tgz | head -n 1)

    if [ -n "$LATEST_DAILY_BACKUP" ]; then
        log_message "Copying latest daily backup to both weekly and monthly backups: $LATEST_DAILY_BACKUP"

        # Copy the latest daily backup to both the weekly and monthly backup destinations
        cp "$LATEST_DAILY_BACKUP" "$WEEKLY_BACKUP_DESTINATION/"
        cp "$LATEST_DAILY_BACKUP" "$MONTHLY_BACKUP_DESTINATION/"
        log_message "Daily backup copied to weekly and monthly directories."

        # Sync weekly backups to S3
        sync_to_s3_and_cleanup "$WEEKLY_BACKUP_DESTINATION" "$S3_BUCKET/weekly" 

        # Sync monthly backups to S3
        sync_to_s3_and_cleanup "$MONTHLY_BACKUP_DESTINATION" "$S3_BUCKET/monthly" 

        # Sync daily backups to S3
        sync_to_s3_and_cleanup "$DAILY_BACKUP_DESTINATION" "$S3_BUCKET/daily" 

        # Manage weekly backup retention on S3
        manage_s3_backup_retention "$S3_BUCKET/weekly" "$MAX_WEEKLY_BACKUPS"

        # Manage monthly backup retention on S3
        manage_s3_backup_retention "$S3_BUCKET/monthly" "$MAX_MONTHLY_BACKUPS"

        # Manage daily backups retention on S3 
        manage_s3_backup_retention "$S3_BUCKET/daily" "$MAX_DAILY_BACKUPS"


if [ "$KEEP_LOCAL" -eq 0 ]; then
    log_message "Managing local backup retention for WEEKLY backups. Keeping only the last $MAX_WEEKLY_BACKUPS locally."
    weekly_backups_to_delete=$(ls -1t "$WEEKLY_BACKUP_DESTINATION"/*.tgz | tail -n +$((MAX_WEEKLY_BACKUPS + 1)))
    for backup in $weekly_backups_to_delete; do
        log_message "Deleting old local WEEKLY backup: $backup"
        rm -rf "$backup"
    done
fi

if [ "$KEEP_LOCAL" -eq 0 ]; then
    log_message "Managing local backup retention for MONTHLY backups. Keeping only the last $MAX_MONTHLY_BACKUPS locally."
    monthly_backups_to_delete=$(ls -1t "$MONTHLY_BACKUP_DESTINATION"/*.tgz | tail -n +$((MAX_MONTHLY_BACKUPS + 1)))
    for backup in $monthly_backups_to_delete; do
        log_message "Deleting old local MONTHLY backup: $backup"
        rm -rf "$backup"
    done
fi

if [ "$KEEP_LOCAL" -eq 0 ]; then
    log_message "Managing local backup retention for DAILY backups. Keeping only the last $MAX_DAILY_BACKUPS backups locally."
    backups_to_delete=$(ls -1t "$DAILY_BACKUP_DESTINATION"/*.tgz | tail -n +$((MAX_DAILY_BACKUPS + 1)))
    for backup in $backups_to_delete; do
        log_message "Deleting old local DAILY backup: $backup"
        rm -rf "$backup"
    done
fi
    else
        log_message "No daily backups found to copy for weekly and monthly backups."
    fi

# Handle Weekly Backup Only
elif [ "$RUN_WEEKLY" = true ]; then
    log_message "Weekly backup process started."

    # Find the latest daily backup tarball
    LATEST_DAILY_BACKUP=$(ls -1t "$DAILY_BACKUP_DESTINATION"/*.tgz | head -n 1)

    if [ -n "$LATEST_DAILY_BACKUP" ]; then
        log_message "Copying latest daily backup to weekly backups: $LATEST_DAILY_BACKUP"
        
        # Copy the latest daily backup to the weekly backup destination
        cp "$LATEST_DAILY_BACKUP" "$WEEKLY_BACKUP_DESTINATION/"
        log_message "Weekly backup copied successfully."

        # Sync weekly backups to S3
        sync_to_s3_and_cleanup "$WEEKLY_BACKUP_DESTINATION" "$S3_BUCKET/weekly"

        # Sync daily backups to S3 (if not already done)
        sync_to_s3_and_cleanup "$DAILY_BACKUP_DESTINATION" "$S3_BUCKET/daily"

        # Manage weekly backup retention on S3
        manage_s3_backup_retention "$S3_BUCKET/weekly" "$MAX_WEEKLY_BACKUPS"

        # Manage daily backups retention on S3 
        manage_s3_backup_retention "$S3_BUCKET/daily" "$MAX_DAILY_BACKUPS"


if [ "$KEEP_LOCAL" -eq 0 ]; then
    log_message "Managing local backup retention for WEEKLY backups. Keeping only the last $MAX_WEEKLY_BACKUPS locally."
    weekly_backups_to_delete=$(ls -1t "$WEEKLY_BACKUP_DESTINATION"/*.tgz | tail -n +$((MAX_WEEKLY_BACKUPS + 1)))
    for backup in $weekly_backups_to_delete; do
        log_message "Deleting old local WEEKLY backup: $backup"
        rm -rf "$backup"
    done
fi

if [ "$KEEP_LOCAL" -eq 0 ]; then
    log_message "Managing local backup retention for DAILY backups. Keeping only the last $MAX_DAILY_BACKUPS backups locally."
    backups_to_delete=$(ls -1t "$DAILY_BACKUP_DESTINATION"/*.tgz | tail -n +$((MAX_DAILY_BACKUPS + 1)))
    for backup in $backups_to_delete; do
        log_message "Deleting old local DAILY backup: $backup"
        rm -rf "$backup"
    done
fi
    else
        log_message "No daily backups found to copy for weekly backup."
    fi

# Handle Monthly Backup Only
elif [ "$RUN_MONTHLY" = true ]; then
    log_message "Monthly backup process started."

    # Find the latest daily backup tarball
    LATEST_DAILY_BACKUP=$(ls -1t "$DAILY_BACKUP_DESTINATION"/*.tgz | head -n 1)

    if [ -n "$LATEST_DAILY_BACKUP" ]; then
        log_message "Copying latest daily backup to monthly backups: $LATEST_DAILY_BACKUP"

        # Copy the latest daily backup to the monthly backup destination
        cp "$LATEST_DAILY_BACKUP" "$MONTHLY_BACKUP_DESTINATION/"
        log_message "Monthly backup copied successfully."

        # Sync monthly backups to S3
        sync_to_s3_and_cleanup "$MONTHLY_BACKUP_DESTINATION" "$S3_BUCKET/monthly"

        # Sync daily backups to S3 (if not already done)
        sync_to_s3_and_cleanup "$DAILY_BACKUP_DESTINATION" "$S3_BUCKET/daily"

        # Manage monthly backup retention on S3
        manage_s3_backup_retention "$S3_BUCKET/monthly" "$MAX_MONTHLY_BACKUPS"

         # Manage daily backups retention on S3
        manage_s3_backup_retention "$S3_BUCKET/daily" "$MAX_DAILY_BACKUPS"

if [ "$KEEP_LOCAL" -eq 0 ]; then
    log_message "Managing local backup retention for MONTHLY backups. Keeping only the last $MAX_MONTHLY_BACKUPS locally."
    monthly_backups_to_delete=$(ls -1t "$MONTHLY_BACKUP_DESTINATION"/*.tgz | tail -n +$((MAX_MONTHLY_BACKUPS + 1)))
    for backup in $monthly_backups_to_delete; do
        log_message "Deleting old local MONTHLY backup: $backup"
        rm -rf "$backup"
    done
fi

if [ "$KEEP_LOCAL" -eq 0 ]; then
    log_message "Managing local backup retention for DAILY backups. Keeping only the last $MAX_DAILY_BACKUPS backups locally."
    backups_to_delete=$(ls -1t "$DAILY_BACKUP_DESTINATION"/*.tgz | tail -n +$((MAX_DAILY_BACKUPS + 1)))
    for backup in $backups_to_delete; do
        log_message "Deleting old local DAILY backup: $backup"
        rm -rf "$backup"
    done
fi
    else
        log_message "No daily backups found to copy for monthly backup."
    fi

# Handle Daily Backup Only
else
    log_message "Daily backup process only."

    # Sync daily backups to S3 and remove local copies
    sync_to_s3_and_cleanup "$DAILY_BACKUP_DESTINATION" "$S3_BUCKET/daily"

    # Manage daily backup retention on S3
    manage_s3_backup_retention "$S3_BUCKET/daily" "$MAX_DAILY_BACKUPS"

if [ "$KEEP_LOCAL" -eq 0 ]; then
    log_message "Managing local backup retention for DAILY backups. Keeping only the last $MAX_DAILY_BACKUPS backups locally. 1 daily"
    backups_to_delete=$(ls -1t "$DAILY_BACKUP_DESTINATION"/*.tgz | tail -n +$((MAX_DAILY_BACKUPS + 1)))
    for backup in $backups_to_delete; do
        log_message "Deleting old local DAILY backup: $backup"
        rm -rf "$backup"
    done
fi
fi

# End of backup process
log_message "Backup process completed successfully!"

[meltyshev]

Hey! Feel free to submit a PR to the documentation with this script :)