fix: correct documentation around the passphrase parameter

Closes dokku/dokku-mysql#101
This commit is contained in:
Jose Diaz-Gonzalez
2018-12-02 04:33:58 -05:00
parent fc018c65f1
commit 733e14ee73
2 changed files with 6 additions and 6 deletions

View File

@@ -23,7 +23,7 @@ mysql:backup-auth <name> <aws_access_key_id> <aws_secret_access_key> (<aws_defau
mysql:backup-deauth <name> Removes backup authentication for the mysql service
mysql:backup-schedule <name> <schedule> <bucket> Schedules a backup of the mysql service
mysql:backup-schedule-cat <name> Cat the contents of the configured backup cronfile for the service
mysql:backup-set-encryption <name> <encryption_key> Sets up GPG encryption for future backups of the mysql service
mysql:backup-set-encryption <name> <passphrase> Set a GPG passphrase for backups
mysql:backup-unschedule <name> Unschedules the backup of the mysql service
mysql:backup-unset-encryption <name> Removes backup encryption for future backups of the mysql service
mysql:clone <name> <new-name> Create container <new-name> then copy data from <name> into <new-name>

View File

@@ -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 "$@"