MCDR2Restic

What MCDR2Restic is

MCDR2Restic is an MCDReforged plugin for backing up chosen directories with restic while a server is running. It can run backups on a schedule, start one immediately, or interrupt a backup already underway. Scheduled runs can be skipped when the server has no active players; a separate forced-scheduling setting bypasses activity detection and is disabled by default. With the default configuration, the plugin downloads a restic binary for the system if one is not in the MCDR working directory.

For recovery, commands let users queue and apply restores of an entire snapshot, an individual file, or a folder. A configuration check requires the local restic repository to be outside every backup source directory. Notifications can be sent through OneBot QQ or Discord Webhooks. Messages and configuration comments are available in Chinese and English, according to the MCDR language setting.

The project is free and open source under GPL-3.0. It requires MCDReforged >=2.12.0, PyYAML >=6.0, and websocket-client >=1.8.0. Its maker recommends understanding restic's basic concepts and knowing how to use restic independently, since many backup features rely on that knowledge. The README is being refactored and may contain outdated information.

Who it suits

MCDR server operators who want scheduled restic backups, player-activity-aware scheduling, and command-based restore options may find it suitable. It is best suited to users already comfortable using restic independently.

Limits

The plugin requires the local restic repository to be outside every backup source directory. Many backup features require basic restic knowledge; the README may contain outdated information while it is being refactored.

Getting started

1. Open the project website for the plugin introduction.
2. Use a system with MCDReforged >=2.12.0, PyYAML >=6.0, and websocket-client >=1.8.0.
3. Configure the plugin and keep the local restic repository outside every backup source directory.
4. With default configuration, allow the plugin to download restic if its binary is absent from the MCDR working directory.
5. Set scheduled or immediate backups and choose whether to skip runs when no players are active.

Verdict

Choose MCDR2Restic if you run MCDReforged and want scheduled restic backups with multiple restore granularities. Look elsewhere if you need a backup workflow that does not rely on restic knowledge or do not meet its listed dependencies.