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

Windows User Manual

Configure Folders

After install, %USERPROFILE%\.peppykeep\conf gets app.toml, bak.toml, and prj.toml. Before the first backup, confirm they exist and match your environment (MySQL, paths, object storage). Bulk MySQL jobs also need mysql_bak_request.toml.

Field reference: Configuration files (app.toml, bak.toml, prj.toml, etc.). Use --config-home or env var PPK for the config directory.

Quick Start (Basic Application Data Backup)

In cmd:

REM1. Confirm that the download and installation have been completed on the official website

REM2. Confirm that app.toml, bak.toml, prj.toml already exists under % USERPROFILE %\ .peppykeep\ conf and modify it by environment (e.g. data_dir of prj.toml)

REM3. Prepare test data
mkdir %TEMP%\test_file_717
echo sample > %TEMP%\test_file_717\sample.txt

REM4. Pre-inspection
peppykeep backup run --config-home %USERPROFILE%\.peppykeep\conf --bak-type app-data

REM5. Official backup (local + upload, configured by bak.toml)
peppykeep backup run --apply --config-home %USERPROFILE%\.peppykeep\conf --bak-type app-data

’–no-upload` can only be added when backing up locally.

Download & Install

Go to the PeppyKeep official website download page to download and install

Function elements

Follow the scenario step by step, each section contains configuration points, dry-run and formal execution (--apply):

Function block index

Configuration Specification (CS)

The following files are automatically generated in the default configuration directory during installation. Please confirm that the files exist before modifying them: