Skip to content

config.yml

Location

plugins/Mina/ConfigGuard/config.yml

This page documents every configuration key, default values and enforced safety rules.

messages.locale

  • Default: empty (uses system locale)
  • Examples: en, ru
  • Supported: en, ru, es, pt, de, fr

backup.maxTotalMb

  • Default: 200
  • Hard safety limit for any backup
  • disables the limit (not recommended)

backup.configFiles

  • Default: [config.yml]
  • List of file names considered configs-only
  • In configs-only mode only these file names are copied

The default config also includes examples like config.json.

backup.full.include

Controls which files are included in FULL mode.

  • backup.full.include.folderNames
  • backup.full.include.fileExtensions

Behavior:

  • If both lists are empty, everything is included (exclude still applies)
  • If at least one list is non-empty:
    • folderNames: path contains any listed folder name
    • fileExtensions: file name ends with any listed extension
    • When both are present, both conditions must pass

backup.full.exclude

  • backup.full.exclude.folderNames

    • Default if empty: logs, log, cache, .cache, crash-reports

  • backup.full.exclude.fileExtensions

    • Default if empty: .log, .tmp

Behavior:

  • Exclude is applied after include
  • Matches when:
    • any path segment equals a folder name
    • or file name ends with a listed extension

backup.retention

  • backup.retention.maxCount

    • Default: 20
    • disables this rule

  • backup.retention.maxDays

    • Default: 14
    • disables this rule

Retention runs: - after a successful backup - optionally on plugin enable (depending on lifecycle)

list.defaultLimit

  • Default: 10
  • If <= 0, it falls back to 10
  • Used when /cg list is executed without --limit

diff.content

  • diff.content.maxFiles

    • Default: 5
    • Clamped to 1..50

  • diff.content.maxBytesPerFile

    • Default: 262144 (256 KB)
    • Minimum enforced: 4096 bytes

restore

  • restore.requireBackupBefore

    • Default: false
    • If true, every restore creates a safety snapshot first

  • restore.maxFilesPerRun

    • Default: 5000
    • Minimum enforced: 1

  • restore.maxBytesPerFile

    • Default: 0 (no limit)
    • Minimum enforced: 0

  • restore.previewLines

    • Default: 20
    • Clamped to 1..200

scheduler

See Scheduler page.

shutdownBackup

See Shutdown backup page.