Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

restore decrypt

This is an old command that is compatible with existing automation scripts. Use ppk decrypt to decrypt the .ppke backup file to a .ppk file.

Command Format:

peppykeep restore decrypt --backup-file <BACKUP_FILE> [--output-file <FILE>] [--decrypt-private-key-file <FILE>] [--prompt-for-private-key-passphrase] [--apply] [--config-home <DIR>]

Description

  • --backup-file<BACKUP_FILE>: encrypts the backup file path.
  • --output-file<FILE>: decrypts the output file path.
  • --decrypt-private-key-file<FILE>: path to the private key file. Use the recovery private key in the configuration when not passing.
  • --prompt-for-private-key-passphrase: Enter the private key password from the terminal prompt.
  • --apply: really perform decryption.
  • --config-home<DIR>: configuration directory.

Usage Sample

peppykeep restore decrypt --backup-file /tmp/a.ppke
peppykeep restore decrypt --backup-file /tmp/a.ppke --output-file /tmp/a.ppk --apply
peppykeep restore decrypt --backup-file /tmp/a.ppke --decrypt-private-key-file /tmp/ppk.key --prompt-for-private-key-passphrase --apply

Behaviour description

  • Without `--apply’, only print which file will be decrypted, where it will be output, and which private key to use.
  • Actual decryption is performed with `--apply’.

notice

  • The private key password can also be provided via the environment variable PPKPKPSW.
  • If the output directory does not exist, you need to create it manually first.