Configuration Files
PeppyKeep drives backups, restores, cleanups, and walkthroughs with TOML files in the configuration directory.
After installation is complete, app.toml, bak.toml, prj.toml will be automatically generated in the default configuration directory. Before performing the backup for the first time, make sure that these three files exist, and modify the connection information, backup path, object storage and other fields according to the actual environment.
Please refer to the download page of the official website of PeppyKeep for installation and updates; the retention and update rules of existing profiles are subject to the instructions on the download page.
Default configuration directory:
- macOS / Linux：
~/.peppykeep/conf - Windows：
%USERPROFILE%\.peppykeep\conf
See Prerequisites for environmental requirements.
Directory Structure
conf/
├── app.toml # Basic PeppyKeep runtime settings (defaults usually fine)
├── bak.toml # Backup engine, object storage, MySQL, encryption, recovery, drills (auto-generated at install)
├── prj.toml # Project identity, data dirs, remote retention (auto-generated at install)
└── mysql_bak_request.toml # Bulk MySQL backup requests (create manually as needed)
File duties
| DOCUMENT | Functions | Whether the report is generated automatically |
|---|---|---|
app.toml | The basic configuration file required for PeppyKeep operation, which is kept by default and usually does not need to be modified | Yes (during installation) |
bak.toml | Backup Type, Storage Location, MySQL Connection, Object Storage, Encryption, Recovery Target, Disaster Recovery Drill | Yes (during installation) |
prj.toml | Project Identification, Applying Data Catalogs, Table Filtering, Remote Retention Policies | Yes (during installation) |
mysql_bak_request.toml | Database list and control parameters for a batch MySQL backup task | No, create manually |
Usage
Specify the configuration directory through --config-home when executing the command (the above default directory is usually used when omitted):
peppykeep backup run --config-home /path/to/user/.peppykeep/conf
You can also set the environment variable PPK to point to the same directory, omitting --config-home.