This plugin creates scheduled backups of your server with configurable intervals, file selection, optional Discord integration, and more.
Features
- Configure automatic backups at intervals such as hourly, daily, or weekly.
- Backups run asynchronously to reduce server performance impact.
- Trigger backups on demand using commands.
- Limit the number of backups to keep and automatically delete older backups when the limit is reached.
- Compress backups into zip files to save disk space.
- Define specific files or directories to include or exclude from backups.
- Store backups locally in the server directory or send them to a Discord webhook.
- Ensure backups are segregated by server identity to prevent misdirected or misplaced backups.
Commands
backup
(Console) - Triggers a manual backup of the server files immediately.
Configuration
JSON:
{
"Version": "1.0.0",
"Enable Scheduled Backups": true,
"Backup Interval Type (Options: Seconds, Minutes, Hours, Days)": "Minutes",
"Backup Interval (e.g., 5 for every 5 minutes, 1 for daily)": 30,
"Maximum Number Of Backups": 5,
"Whitelist Mode (Set to true to backup only specified files)": false,
"Files To Backup (Used in Whitelist Mode)": [
"player.blueprints",
"proceduralmap",
"sv.files"
],
"Ignored Files (Used when Whitelist Mode is false)": [
"cfg",
"serveremoji",
"companion.id",
"Log.EAC.txt",
"logs",
"lang",
"oxide.config"
],
"Include Oxide In Backup": false,
"Save Backups As Zip (Set to false to save as directories)": false,
"Discord Webhook Url (Leave blank to disable)": ""
}
Enable Scheduled Backups
- Enables or disables automatic backups at regular intervals.Backup Interval Type
- Defines the time unit for backup intervals. Options include Seconds, Minutes, Hours, or Days.Backup Interval
- The frequency of backups based on the interval type. For example, 30 withMinutes
creates a backup every 30 minutes.Maximum Number Of Backups
- Specifies the maximum number of backups to retain. Older backups are deleted once the limit is reached.Whitelist Mode
- Determines the mode for file selection during backups. Set to true to only backup files listed inFiles To Backup
or false to exclude files listed inIgnored Files
.Files To Backup
- A list of specific files to include in backups when whitelist mode is enabled.Ignored Files
- A list of files or directories to exclude from backups when whitelist mode is disabled.Include Oxide In Backup
- Determines whether to include the Oxide directory in backups.Save Backups As Zip
- Specifies whether backups should be saved as compressed ZIP files. Set to false for plain directories.Discord Webhook Url
- A url for sending backups to Discord via a webhook. Leave blank to disable this feature.