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

backup encrypt-artifact

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

Command Format:

peppykeep backup encrypt-artifact --input-file <INPUT_FILE> [--apply] [--config-home <DIR>]

Description

  • --input-file<INPUT_FILE>: Backup file path already exists, usually * .ppk.
  • --apply: Really perform encryption. Only test results are output without this parameter.
  • --config-home<DIR>: configuration directory for reading the encryption configuration in `bak.toml’.

Usage Sample

peppykeep backup encrypt-artifact --input-file /tmp/test_mysql_101-bak_20260320072031.ppk --config-home additional/conf/dev
peppykeep backup encrypt-artifact --input-file /tmp/test_mysql_101-bak_20260320072031.ppk --config-home additional/conf/dev --apply

Behaviour description

  • Without --apply only prints which file will be encrypted and which public key will be used.
  • With --apply, press the backup_encryption configuration in bak.toml to perform encryption.
  • The output file is in the same directory as the input file by default, and the file name is the .ppke extension after the original file.

notice

  • The command depends on backup_encryption.enabled = true.
  • The command relies on a valid backup_encryption.public_key_file.
  • When delete_plain_after_encrypt = true, the original plaintext file is deleted after successful encryption.