btcpayserver-docker/btcpay-restore.sh

#!/bin/bash -e

set -o pipefail -o errexit

if [ "$(id -u)" != "0" ]; then
  printf "\n🚨 This script must be run as root.\n"
  printf "➡️ Use the command 'sudo su -' (include the trailing hypen) and try again.\n\n"
  exit 1
fi

backup_path=$1
if [ -z "$backup_path" ]; then
  printf "\nℹ️ Usage: btcpay-restore.sh /path/to/backup.tar.gz\n\n"
  exit 1
fi

if [ ! -f "$backup_path" ]; then
  printf "\n🚨 $backup_path does not exist.\n\n"
  exit 1
fi

if [[ "$backup_path" == *.gpg && -z "$BTCPAY_BACKUP_PASSPHRASE" ]]; then
  printf "\n🔐 $backup_path is encrypted. Please provide the passphrase to decrypt it."
  printf "\nℹ️ Usage: BTCPAY_BACKUP_PASSPHRASE=t0pSeCrEt btcpay-restore.sh /path/to/backup.tar.gz.gpg\n\n"
  exit 1
fi

# preparation
docker_dir=$(docker volume inspect generated_btcpay_datadir --format="{{.Mountpoint}}" | sed -e "s%/volumes/.*%%g")
restore_dir="$docker_dir/volumes/backup_datadir/_data/restore"
postgres_dump_name=postgres.sql.gz
btcpay_dir="$BTCPAY_BASE_DIRECTORY/btcpayserver-docker"

# ensure clean restore dir
printf "\nℹ️ Cleaning restore directory $restore_dir …\n\n"
rm -rf $restore_dir
mkdir -p $restore_dir

if [[ "$backup_path" == *.gpg ]]; then
  echo "🔐 Decrypting backup file …"
  {
    gpg -o "${backup_path%.*}" --batch --yes --passphrase "$BTCPAY_BACKUP_PASSPHRASE" -d $backup_path
    backup_path="${backup_path%.*}"
    printf "✅ Decryption done.\n\n"
  } || {
    echo "🚨 Decryption failed. Please check the error message above."
    exit 1
  }
fi

cd $restore_dir

echo "ℹ️ Extracting files in $(pwd) …"
tar -xvf $backup_path -C $restore_dir

# basic control checks
if [ ! -f "$postgres_dump_name" ]; then
  printf "\n🚨 $postgres_dump_name does not exist.\n\n"
  exit 1
fi

if [ ! -d "volumes" ]; then
  printf "\n🚨 volumes directory does not exist.\n\n"
  exit 1
fi

if [ -f "mariadb.sql.gz" ]; then
  mariadb_dump_name=mariadb.sql.gz
fi

cd $btcpay_dir
. helpers.sh

printf "\nℹ️ Stopping BTCPay Server …\n\n"
btcpay_down

cd $restore_dir

{
  printf "\nℹ️ Restoring volumes …\n"
  # ensure volumes dir exists
  if [ ! -d "$docker_dir/volumes" ]; then
    mkdir -p $docker_dir/volumes
  fi
  # copy volume directories over
  cp -r volumes/* $docker_dir/volumes/
  # ensure datadirs excluded in backup exist
  mkdir -p $docker_dir/volumes/generated_postgres_datadir/_data
  if [ ! -z "$mariadb_dump_name" ]; then
    mkdir -p $docker_dir/volumes/generated_mariadb_datadir/_data
  fi
  echo "✅ Volume restore done."
} || {
  echo "🚨  Restoring volumes failed. Please check the error message above."
  printf "\nℹ️ Restarting BTCPay Server …\n\n"
  cd $btcpay_dir
  btcpay_up
  exit 1
}

# Start Postgres database
{
  printf "\nℹ️ Starting Postgres database container …\n"
  docker-compose -f $BTCPAY_DOCKER_COMPOSE up -d postgres
  sleep 10
  postgres_container=$(docker ps -a -q -f "name=postgres_1")
  if [ -z "$postgres_container" ]; then
    echo "🚨 Postgres database container could not be started or found."
    printf "\nℹ️ Restarting BTCPay Server …\n\n"
    cd $btcpay_dir
    btcpay_up
    exit 1
  fi
} || {
  echo "🚨 Starting Postgres database container failed. Please check the error message above."
  printf "\nℹ️ Restarting BTCPay Server …\n\n"
  cd $btcpay_dir
  btcpay_up
  exit 1
}

# Optional: Start MariaDB database
if [ ! -z "$mariadb_dump_name" ]; then
  {
    printf "\nℹ️ Starting MariaDB database container …\n"
    docker-compose -f $BTCPAY_DOCKER_COMPOSE up -d mariadb
    sleep 10
    mariadb_container=$(docker ps -a -q -f "name=mariadb_1")
    if [ -z "$mariadb_container" ]; then
      echo "🚨 MariaDB database container could not be started or found."
      printf "\nℹ️ Restarting BTCPay Server …\n\n"
      cd $btcpay_dir
      btcpay_up
      exit 1
    fi
  } || {
    echo "🚨 Starting MariaDB database container failed. Please check the error message above."
    printf "\nℹ️ Restarting BTCPay Server …\n\n"
    cd $btcpay_dir
    btcpay_up
    exit 1
  }
fi

cd $restore_dir

# Postgres database
{
  printf "\nℹ️ Restoring Postgres database …"
  gunzip -c $postgres_dump_name | docker exec -i $postgres_container psql -U postgres postgres
  echo "✅ Postgres database restore done."
} || {
  echo "🚨 Restoring Postgres database failed. Please check the error message above."
  printf "\nℹ️  Restarting BTCPay Server …\n\n"
  cd $btcpay_dir
  btcpay_up
  exit 1
}

# Optional: MariaDB database
if [ ! -z "$mariadb_dump_name" ]; then
  {
    printf "\nℹ️ Restoring MariaDB database …"
    gunzip -c $mariadb_dump_name | docker exec -i $mariadb_container mysql -u root -pwordpressdb
    printf "\n✅ MariaDB database restore done."
  } || {
    echo "🚨 Restoring MariaDB database failed. Please check the error message above."
    printf "\nℹ️  Restarting BTCPay Server …\n\n"
    cd $btcpay_dir
    btcpay_up
    exit 1
  }
fi

printf "\nℹ️ Restarting BTCPay Server …\n\n"
cd $btcpay_dir
btcpay_up

printf "\nℹ️ Cleaning up …\n\n"
rm -rf $restore_dir

printf "✅ Restore done\n\n"