Skip to content

Commit 1465f6f

Browse files
committed
fix: correct documentation around the passphrase parameter
Closes dokku/dokku-mysql#101
1 parent 98edfb9 commit 1465f6f

File tree

2 files changed

+6
-6
lines changed

2 files changed

+6
-6
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ postgres:backup-auth <name> <aws_access_key_id> <aws_secret_access_key> (<aws_de
2323
postgres:backup-deauth <name> Removes backup authentication for the postgres service
2424
postgres:backup-schedule <name> <schedule> <bucket> Schedules a backup of the postgres service
2525
postgres:backup-schedule-cat <name> Show the backup schedule for the service
26-
postgres:backup-set-encryption <name> <encryption_key> Sets up GPG encryption for future backups of the postgres service
26+
postgres:backup-set-encryption <name> <passphrase> Set a GPG passphrase for backups
2727
postgres:backup-unschedule <name> Unschedules the backup of the postgres service
2828
postgres:backup-unset-encryption <name> Removes backup encryption for future backups of the postgres service
2929
postgres:clone <name> <new-name> Create container <new-name> then copy data from <name> into <new-name>

subcommands/backup-set-encryption

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,19 +5,19 @@ source "$PLUGIN_BASE_PATH/common/functions"
55
source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
66

77
service-backup-set-encryption-cmd() {
8-
#E set a GPG encryption key for backups
8+
#E set a GPG passphrase for backups
99
#E dokku $PLUGIN_COMMAND_PREFIX:backup-set-encryption lolipop
1010
#A service, service to run command against
11-
#A encryption-key, a GPG encryption key
11+
#A passphrase, a GPG-compatible passphrase
1212
declare desc="sets encryption for all future backups of $PLUGIN_SERVICE service"
1313
local cmd="$PLUGIN_COMMAND_PREFIX:backup-set-encryption" argv=("$@"); [[ ${argv[0]} == "$cmd" ]] && shift 1
14-
declare SERVICE="$1" ENCRYPTION_KEY="$2"
14+
declare SERVICE="$1" PASSPHRASE="$2"
1515
is_implemented_command "$cmd" || dokku_log_fail "Not yet implemented"
1616

1717
[[ -z "$SERVICE" ]] && dokku_log_fail "Please specify a name for the service"
18-
[[ -z "$ENCRYPTION_KEY" ]] && dokku_log_fail "Please specify a GPG encryption key"
18+
[[ -z "$PASSPHRASE" ]] && dokku_log_fail "Please specify a GPG backup passphrase"
1919
verify_service_name "$SERVICE"
20-
service_backup_set_encryption "$SERVICE" "$ENCRYPTION_KEY"
20+
service_backup_set_encryption "$SERVICE" "$PASSPHRASE"
2121
}
2222

2323
service-backup-set-encryption-cmd "$@"

0 commit comments

Comments
 (0)