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

Pre-conditions

general

  1. Completed installation; default config dir contains installer-generated app.toml, bak.toml, and prj.toml, tuned for your environment
  2. The user executing the backup/restore command has read/write permissions on log_dir, local_bak_home, local_tmp_home, data_dir in the configuration
  3. First execution may trigger device binding login, please complete authorization before timeout

Windows

  1. User has permission to write % temp %, % LOCALAPPDATA % and user level path
  2. No admin permissions required
  3. Default configuration directory: % USERPROFILE %\ .peppykeep\ conf (generated at installation)

macOS / Linux

  1. The user has permission to write to the configuration directory and backup directory under /tmp
  2. Default configuration directory: ~/.peppykeep/conf (generated during installation)
  3. The mysqldump/’mysql` client can be accessed natively or within a container if MySQL backup is enabled

Optional Dependencies

capabilityDependent
Object Storage Upload[object_storage] valid credentials and network
Backup EncryptionPublic key file ppk.pub (specified by backup_encryption.public_key_file)
Encryption RecoveryPrivate key file ppk.key with environment variable PPKPKPSW (or restore_encryption.private_key_passphrase_env specified name)
MySQL Recovery[restore.mysql] independent target library, do not mix with production [mysql]