From ae031cdc3cece6469934a0743c1ba4ece5d83a7e Mon Sep 17 00:00:00 2001 From: Justintime50 <39606064+Justintime50@users.noreply.github.com> Date: Thu, 7 Dec 2023 10:09:52 -0700 Subject: [PATCH] docs: corrects README --- .github/workflows/build.yml | 2 +- README.md | 12 +++++------- 2 files changed, 6 insertions(+), 8 deletions(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index dd6d780..322c50b 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -6,7 +6,7 @@ jobs: sh-checker: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v4 - uses: luizm/action-sh-checker@master env: SHFMT_OPTS: -i 4 -d diff --git a/README.md b/README.md index 4aeb08c..50e4f9e 100644 --- a/README.md +++ b/README.md @@ -42,6 +42,8 @@ echo 'export SRVINFRA_DATABASE_EXECUTABLE=mariadb' >> ~/.zshrc ## Usage +> NOTE: You may need to quote `ROOT_PASSWORD` in the commands below. + ```bash # Deploy a service (relative from $SRVINFRA_SERVICES_DIR), subdirectories are possible srvinfra deploy justintime50/justinpaulhammond @@ -54,22 +56,18 @@ srvinfra deploy_all # The BACKUP_SECRET is assumed to be the same as the database ROOT_PASSWORD srvinfra decrypt_database_backup PATH_TO_SQL_FILE BACKUP_SECRET -# Export a SQL database from a Docker container +# Export a SQL database from a Docker container, unencrypted and uncompressed # Default PATH_TO_SQL_FILE: './database.sql' -# Note: May need to quote `ROOT_PASSWORD` srvinfra export_database DATABASE_CONTAINER_NAME ROOT_PASSWORD DATABASE_NAME PATH_TO_SQL_FILE -# Export a compressed SQL databse from a Docker container and encrypt the backup (recommended) -# Default PATH_TO_SQL_FILE: './database.sql' -# Note: May need to quote `ROOT_PASSWORD` +# Export a compressed SQL database from a Docker container and encrypt the backup (recommended) +# Default PATH_TO_SQL_FILE: './database.enc.gz' srvinfra export_database_secure DATABASE_CONTAINER_NAME ROOT_PASSWORD DATABASE_NAME PATH_TO_SQL_FILE # Import a SQL database to a Docker container -# Note: May need to quote `ROOT_PASSWORD` srvinfra import_database DATABASE_CONTAINER_NAME ROOT_PASSWORD DATABASE_NAME PATH_TO_SQL_FILE # Import an encrypted & compressed SQL database to a Docker container (command combines `decrypt_database_backup` and `import_database` commands) -# Note: May need to quote `ROOT_PASSWORD` # ROOT_PASSWORD is assumed to be the same as the database root password srvinfra import_encrypted_database DATABASE_CONTAINER_NAME ROOT_PASSWORD DATABASE_NAME PATH_TO_SQL_FILE