From 733e14ee73899d601cb7efe7631bddb62ee69b26 Mon Sep 17 00:00:00 2001 From: Jose Diaz-Gonzalez Date: Sun, 2 Dec 2018 04:33:58 -0500 Subject: [PATCH] fix: correct documentation around the passphrase parameter Closes dokku/dokku-mysql#101 --- README.md | 2 +- subcommands/backup-set-encryption | 10 +++++----- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index a3fcd98..ce5a628 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,7 @@ mysql:backup-auth ( Removes backup authentication for the mysql service mysql:backup-schedule Schedules a backup of the mysql service mysql:backup-schedule-cat Cat the contents of the configured backup cronfile for the service -mysql:backup-set-encryption Sets up GPG encryption for future backups of the mysql service +mysql:backup-set-encryption Set a GPG passphrase for backups mysql:backup-unschedule Unschedules the backup of the mysql service mysql:backup-unset-encryption Removes backup encryption for future backups of the mysql service mysql:clone Create container then copy data from into diff --git a/subcommands/backup-set-encryption b/subcommands/backup-set-encryption index 175d716..dce3620 100755 --- a/subcommands/backup-set-encryption +++ b/subcommands/backup-set-encryption @@ -5,19 +5,19 @@ source "$PLUGIN_BASE_PATH/common/functions" source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions" service-backup-set-encryption-cmd() { - #E set a GPG encryption key for backups + #E set a GPG passphrase for backups #E dokku $PLUGIN_COMMAND_PREFIX:backup-set-encryption lolipop #A service, service to run command against - #A encryption-key, a GPG encryption key + #A passphrase, a GPG-compatible passphrase declare desc="sets encryption for all future backups of $PLUGIN_SERVICE service" local cmd="$PLUGIN_COMMAND_PREFIX:backup-set-encryption" argv=("$@"); [[ ${argv[0]} == "$cmd" ]] && shift 1 - declare SERVICE="$1" ENCRYPTION_KEY="$2" + declare SERVICE="$1" PASSPHRASE="$2" is_implemented_command "$cmd" || dokku_log_fail "Not yet implemented" [[ -z "$SERVICE" ]] && dokku_log_fail "Please specify a name for the service" - [[ -z "$ENCRYPTION_KEY" ]] && dokku_log_fail "Please specify a GPG encryption key" + [[ -z "$PASSPHRASE" ]] && dokku_log_fail "Please specify a GPG backup passphrase" verify_service_name "$SERVICE" - service_backup_set_encryption "$SERVICE" "$ENCRYPTION_KEY" + service_backup_set_encryption "$SERVICE" "$PASSPHRASE" } service-backup-set-encryption-cmd "$@"