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

App profile description (app.toml)

This file is the basic configuration file required for PeppyKeep to run. It is automatically generated during installation, and it is recommended to keep the defaults, which usually do not need to be modified; only adjust the relevant fields when explicitly required by the specific feature documentation.

Configuration SegmentDescription
[log.tracing]Program Run Log (app.log)
[site]Official website address for help with links and update checks
[notification]Optional, backup task alarm webhook (default comment disabled, see platform example for details)

Field reference

[log.tracing]

ParameterDescriptionExample
dirLog directory. The directory must exist and be writable by the current user.See the platform path examples below.
file_nameLog file name."app.log"
levelLog level: error, warn, info, debug, or trace."info"

[site]

ParameterDescriptionExample
official_site_base_urlOfficial website address, used for help links and update checks. It must begin with http:// or https://."https://www.peppykeep.com"

Platform path differences

Configuration fields and behavior are the same on every operating system; only directory syntax differs.

Platformdir example
Windows"C:\\Users\\<Username>\\AppData\\Local\\Temp\\log\\peppykeep"
macOS / Linux"/tmp/log/peppykeep"

macOS / Linux:

[log.tracing]
dir = "/tmp/log/peppykeep"
file_name = "app.log"
level = "info"

[site]
official_site_base_url = "https://www.peppykeep.com"

Windows:

[log.tracing]
dir = "C:\\Users\\<Username>\\AppData\\Local\\Temp\\log\\peppykeep"
file_name = "app.log"
level = "info"

[site]
official_site_base_url = "https://www.peppykeep.com"