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

ppk encrypt

Encrypt a .ppk archive into a .ppke file. Use this command for new backup workflows.

Command Format:

ppk encrypt --input <INPUT_FILE> --output <OUTPUT_FILE> [--apply] [--config-home <DIR>]

Description

  • --input <INPUT_FILE>: The .ppk archive to encrypt.
  • --output <OUTPUT_FILE>: The resulting encrypted .ppke file.
  • --apply: Perform encryption; without it, only report checks.
  • --config-home <DIR>: Configuration directory containing backup encryption settings in bak.toml.

Usage Sample

ppk encrypt --input /tmp/backup.ppk --output /tmp/backup.ppke --config-home /path/to/conf
ppk encrypt --input /tmp/backup.ppk --output /tmp/backup.ppke --apply --config-home /path/to/conf

Behaviour description

  • Without --apply, only display the input, output and public key to be used.
  • With --apply, encrypt using public_key_file from [backup_encryption].
  • After encryption succeeds, the backup policy determines whether the unencrypted .ppk archive is retained.

Compatibility

Legacy .tar.gz archives and .tar.gz.enc encrypted files remain supported for recovery. Existing automation may continue using backup encrypt-artifact, but new workflows should use .ppk, .ppke and ppk encrypt.

v26.10.2001+202610201530