Skip to main content
All configuration options are located in the config.lua file within the script folder.

Commands & Key Mappings

Commands

Available Commands:
  • /backup - Open the backup UI (client-side)
  • /makebackup - Create a manual backup (opens UI)
  • /deletebackup - Delete a backup (opens UI)

Key Mappings

Default Key: F6 - Opens the backup interface

Backup Settings

Automatic Backups

Enable Auto Backups

Options:
  • true - Automatic backups enabled
  • false - Manual backups only

Backup Time

Format: 12-hour format with AM/PM
Examples: '2:30 PM', '11:45 PM', '12:00 AM'

Backup Interval

Options:
  • 1 - Daily backups
  • 7 - Weekly backups
  • 30 - Monthly backups

Cleanup Settings

Auto Cleanup

Options:
  • true - Old backups automatically deleted
  • false - Manual cleanup required

Cleanup Days

Examples:
  • 7 - Keep backups for 1 week
  • 30 - Keep backups for 1 month
  • 90 - Keep backups for 3 months

Max Backups

Purpose: Prevents unlimited backup accumulation
Behavior: Oldest backups deleted when limit reached

Database Settings

Fallback Database Configuration

These settings are fallback options. The script prefers your server’s mysql_connection_string from server.cfg.
Only configure these if your server doesn’t use mysql_connection_string in server.cfg.

Permissions

Admin Groups

Purpose: Defines which player groups can access backup features Supported Frameworks:
  • ESX: Uses Player.getGroup()
  • QBCore: Uses Player.PlayerData.gang.name and Player.PlayerData.job.name
  • vRP: Uses vRP.getUserGroup()
  • Custom: Add your framework’s group checking logic
Add or remove group names based on your server’s permission system. Players in these groups can create, delete, and restore backups.

Configuration Examples

Daily Backups at Midnight

Weekly Backups with Monthly Retention

Manual Backups Only

Backup Storage

Backups are automatically stored in the script folder as .sql files:
Backup files are named with timestamps for easy identification and sorting.