Documentation and unicode updates.

README.md

@@ -2,7 +2,7 @@
 
 The Sovereign Stack scripts in this repository are meant to be cloned to and executed from your management machine.
 
-You can update Sovereign Stack scripts on your management machine by running `git pull --all --tags`. Generally, you want to use ONLY signed git tags for your deployments. Use `git checkout v0.1.0` for example to switch to a specific version of Sovereign Stack. The scripts check to ensure that the code you're running on your management machine is GREATER THAN OR EQUAL TO the version of your deployments (TODO). The scripts work to bring your old deployments into line with the current Sovereign Stack version.
+You can update Sovereign Stack scripts on your management machine by running `git pull --all --tags`. Generally, you want to use ONLY signed git tags for your deployments. Use `git checkout v0.1.0` for example to switch to a specific version of Sovereign Stack. The scripts check to ensure that the code you're running on your management machine is GREATER THAN OR EQUAL TO the version of your deployments (TODO). The scripts work to bring your existing deployments into line with the current Sovereign Stack version.
 
 Once your managent machine checkedout a specific version of Sovereign stack, you will want to run the various scripts against your remotes. But before you can do that, you need to bring a bare-metal Ubuntu 22.04 cluster host under management (i.e., add it as a remote). Generally speaking you will run `ss-cluster` to bring a new bare-metal host under management of your management machine. This can be run AFTER you have verified SSH access to the bare-metal hosts. The device SHOULD also have a DHCP Reservation and DNS records in place. 
 

defaults.sh

@@ -69,7 +69,8 @@ DEFAULT_DB_IMAGE="mariadb:10.9.3-jammy"
 # run the docker stack.
 export GHOST_IMAGE="ghost:5.20.0"
 
-# TODO switch to mysql. May require intricate export work. THIS MUST BE COMPLETED BEFORE v1 RELEASE
+# TODO switch to mysql. May require intricate export work for existing sites. 
+# THIS MUST BE COMPLETED BEFORE v1 RELEASE
 #https://forum.ghost.org/t/how-to-migrate-from-mariadb-10-to-mysql-8/29575
 export GHOST_DB_IMAGE="$DEFAULT_DB_IMAGE"
 

deployment/btcpayserver/remote_scripts/btcpay-backup.sh

@@ -11,8 +11,8 @@ set -o pipefail -o errexit
 #   revocation key!
 
 if [ "$(id -u)" != "0" ]; then
-  printf "\n🚨 This script must be run as root.\n"
+  echo "INFO: This script must be run as root."
-  printf "➡️  Use the command 'sudo su -' (include the trailing hypen) and try again.\n\n"
+  echo "      Use the command 'sudo su -' (include the trailing hypen) and try again."
   exit 1
 fi
 
@@ -35,34 +35,34 @@ cd "$btcpay_dir"
 dbcontainer=$(docker ps -a -q -f "name=postgres_1")
 if [ -z "$dbcontainer" ]; then
   printf "\n"
-  echo "ℹ️ Database container is not up and running. Starting BTCPay Server …"
+  echo "INFO: Database container is not up and running. Starting BTCPay Server."
   docker volume create generated_postgres_datadir
   docker-compose -f "$BTCPAY_DOCKER_COMPOSE" up -d postgres
 
   printf "\n"
   dbcontainer=$(docker ps -a -q -f "name=postgres_1")
   if [ -z "$dbcontainer" ]; then
-    echo "🚨 Database container could not be started or found."
+    echo "INFO: Database container could not be started or found."
     exit 1
   fi
 fi
 
 printf "\n"
-echo "ℹ️ Dumping database …"
+echo "INFO: Dumping database."
 {
   docker exec "$dbcontainer" pg_dumpall -c -U postgres | gzip > "$dbdump_path"
-  echo "✅ Database dump done."
+  echo "INFO: Database dump done."
 } || {
-  echo "🚨 Dumping failed. Please check the error message above."
+  echo "ERROR: Dumping failed. Please check the error message above."
   exit 1
 }
 
-printf "\nℹ️ Stopping BTCPay Server …\n\n"
+echo "Stopping BTCPay Server..."
 btcpay_down
 
 printf "\n"
-cd $docker_dir
+cd "$docker_dir"
-echo "ℹ️ Archiving files in $(pwd)…"
+echo "Archiving files in $(pwd)."
 
 {
   tar \
@@ -81,37 +81,36 @@ echo "ℹ️ Archiving files in $(pwd)…"
     --exclude="volumes/generated_clightning_bitcoin_datadir/_data/lightning-rpc" \
     --exclude="**/logs/*" \
     -cvzf "$backup_path" "$dbdump_name" volumes/generated_*
-  echo "✅ Archive done."
+  echo "INFO: Archive done."
 
-  if [ ! -z "$BTCPAY_BACKUP_PASSPHRASE" ]; then
+  if [ -n "$BTCPAY_BACKUP_PASSPHRASE" ]; then
     printf "\n"
-    echo "🔐 BTCPAY_BACKUP_PASSPHRASE is set, the backup will be encrypted."
+    echo "INFO: BTCPAY_BACKUP_PASSPHRASE is set, the backup will be encrypted."
     {
-      gpg -o "$backup_path.gpg" --batch --yes -c --passphrase "$BTCPAY_BACKUP_PASSPHRASE" $backup_path
+      gpg -o "$backup_path.gpg" --batch --yes -c --passphrase "$BTCPAY_BACKUP_PASSPHRASE" "$backup_path"
       rm "$backup_path"
       backup_path="$backup_path.gpg"
-      echo "✅ Encryption done."
+      echo "INFO: Encryption done."
     } || {
-      echo "🚨  Encrypting failed. Please check the error message above."
+      echo "INFO: Encrypting failed. Please check the error message above."
-      printf "\nℹ️  Restarting BTCPay Server …\n\n"
+      echo "INFO: Restarting BTCPay Server."
       cd "$btcpay_dir"
-      #btcpay_up
+
       exit 1
     }
   fi
 } || {
-  echo "🚨 Archiving failed. Please check the error message above."
+  echo "INFO: Archiving failed. Please check the error message above."
-  printf "\nℹ️ Restarting BTCPay Server …\n\n"
+  echo "Restarting BTCPay Server"
-  cd $btcpay_dir
+  cd "$btcpay_dir"
-  #btcpay_up
+
   exit 1
 }
 
-printf "\nℹ️ Restarting BTCPay Server …\n\n"
+printf "Restarting BTCPay Server."
-cd $btcpay_dir
+cd "$btcpay_dir"
-#btcpay_up
 
-printf "\nℹ️ Cleaning up …\n\n"
+echo "Cleaning up."
-rm $dbdump_path
+rm "$dbdump_path"
 
-printf "✅ Backup done => $backup_path\n\n"
+echo "INFO: Backup done => $backup_path."