Skip to content

Commit

Permalink
docs: corrects README
Browse files Browse the repository at this point in the history
  • Loading branch information
Justintime50 committed Dec 7, 2023
1 parent 435f7d4 commit ae031cd
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 8 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
12 changes: 5 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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

Expand Down

0 comments on commit ae031cd

Please sign in to comment.