DUXPLIMA Documentation

Welcome

What uxmBackup does, who it is for, and where to read next.

uxmBackup takes backups from inside the server: worlds, files and databases go into one zip archive with a manifest of every file and its checksum, and the archive goes to one or more storages. Each backup is a named set with its own schedule, and every storage keeps its own retention rules.

PartWhat it gives you
SetsNamed backups, each with its worlds, paths, databases, excludes, storages and schedule
SchedulesFive-field cron or a period such as 6h
StoragesLocal folders, SFTP, any S3 endpoint, WebDAV and FTPS, as many as you like
RetentionPer storage: a count, a size and an age, and the newest archive is never removed
DatabasesSQLite, MySQL, MariaDB and PostgreSQL dumped by their own engine while the server runs
VerifyingEvery archive read back against its manifest
RestoringThree levels, from a dry run to an in-place restore behind five protections
AlertsAction lines and a Discord webhook when a run ends

Related: Commands, Configuration