Skip to content

/cg backup

Creates a backup for the selected target.

Syntax

/cg backup [--full] [--note ]

Targets

  • plugins
    Back up configs (or a full snapshot) for all plugin folders under /plugins

  • plugin:Name[,Name...]
    Back up specific plugin folders under /plugins/

  • path:relative/path
    Back up a specific file or directory (relative to server root)

  • folder:NameOrPath
    Two behaviors:

  • If NameOrPath contains a slash, it is treated as a relative folder path
  • If it is a plain name, ConfigGuard searches for all folders with that name under server root

Default target behavior

  • If you omit the prefix, it is treated as folder:

Modes

  • configs-only (default)
    Copies only files listed in backup.configFiles

  • --full (full snapshot)
    Copies all files under the target and applies include/exclude filters

Notes

  • A global lock is used to prevent conflicts with scheduler, restore and reload
  • Hard size limit: backup.maxTotalMb (0 disables, not recommended)
  • In FULL mode on Windows, some files can be locked (DB files). ConfigGuard may skip them and create:
  • backups//locked-files.txt