Configuration Backup and Restore with Shell Scripts
Configuration Backup and Restore with Shell Scripts
Use radiator-backup and radiator-restore to automate configuration export
and import through Management API.
Back Up Configuration
radiator-backup --host radiator.example.com \
--output-dir /var/backups/radiator
By default, the script asks Radiator to include all supported content types in
the archive. Use --no-* options to exclude content. Use the cleanup options
to apply retention.
Radiator exports pending configuration when it exists. To avoid backing up
pending edits unintentionally, the script checks pending status and stops
before requesting the export. Use --allow-pending to export pending
configuration intentionally.
Restore Configuration
radiator-restore --host radiator.example.com backup.zip
The script completes the restore automatically if there is no existing pending configuration, no file conflict, and no unacknowledged full-check failure. It sends the archive and selected import options to Radiator, then requests deployment.
Radiator builds pending configuration from the archive, runs the full configuration check used by normal deployment, creates a backup of the target server's active configuration, and deploys pending configuration. The full check loads all configuration files and attempts to start Radiator in dry-run mode.
Use --no-deploy to stop after Radiator creates pending configuration. The
script leaves pending configuration available for review in Radiator UI. This
option refuses to overwrite existing pending configuration.
Use --deploy to allow Radiator to replace existing pending configuration,
import the archive, and deploy the resulting pending configuration. There is
no option to overwrite existing pending configuration while leaving the
imported configuration pending.
Use --ignore-configuration-checks to make the script acknowledge a failed
full configuration check and retry deployment. The script does not bypass file
conflicts. Resolve file conflicts in Radiator UI.
Selective Restore
Radiator builds pending configuration according to the selected import options:
- For each selected content type, Radiator uses content from the archive.
- For each content type excluded with a
--no-*option, Radiator retains that content from the target server's current active configuration. - If a selected content type is absent from the archive, that content remains absent from pending configuration.
Deployment replaces active configuration with the resulting pending
configuration. A restore with all content types selected uses archive content
except where an import mode merges or preserves target-server content. For
example, templates and licenses support append, replace, and ignore
modes. Templates default to append, so Radiator retains target-server
templates and overlays templates from the archive. Licenses default to
replace, so pending configuration uses only licenses from the archive.
Use --template-import-mode replace to use only templates from the archive.
Use --license-import-mode append to retain target-server licenses and overlay
licenses from the archive. Use ignore to retain target-server templates or
licenses unchanged. See
Configuration Import and Export for import
mode behavior.
After deployment, restart Radiator to load general configuration changes. See Linux systemd support or Containers for the applicable deployment method.
Command Reference
Run the commands with --help for all options, environment variables, defaults,
and exit codes:
radiator-backup --help
radiator-restore --help
Supply credentials with a .netrc file or the environment variables listed by
--help.