快速开始¶

使用前要准备什么¶

你已经安装并运行了 MCDReforged
你接受本插件实际进行文件备份的是 restic
你的系统为 Windows x64 或 Linux x64（否则需要手动安装 restic 并修改一些配置）

如果你完全没接触过 restic，也可以先按默认配置直接使用（这会使得备份与源文件在同一服务器，占用同一块硬盘空间，通常不是好的实现），再按需配置备份频率或对象存储。

默认设置：

备份频率为每三小时备份一次，24 小时内备份全保留，之后每天保留一个，共保留 7 天，可调节调度设置改变效果
默认备份存储位置为 /restic-repo

第一步：安装插件¶

自动安装：在MCDR终端中输入!!MCDR plugin install mcdr2restic以进行自动安装

手动安装：在 GitHub Releases 中下载最新版本，然后将其放入 MCDR 的 plugins 文件夹中，使用 !!MCDR plugin load mcdr2restic.mcdr 加载插件。

重载后，如果 config/mcdr2restic/config.yml 不存在，插件会自动生成一份示例配置。

第二步：按需修改配置文件¶

配置文件注释和默认插件语言会跟随 MCDR 的语言设置，目前支持 en_us、zh_cn、zh_tw
默认的 restic 备份命令会识别 /server/ 下是原版单文件夹世界还是 Paper 的三文件夹世界并自动添加（无论有没有识别成功都会自动添加 /server/world 进备份范围）
按需调整备份范围和保留时间
按需调整存储方式和位置

第三步：重载配置¶

改完配置后，在 MCDR 里执行：

!!restic reload

如果你把命令根节点改掉了，就把 !!restic 换成你自己的命令根。

第四步：查看当前状态¶

执行：

!!restic status

或者直接：

!!restic

你应该至少能看到这些状态信息：

插件是否启用
当前是否在备份
Minecraft 是否已经处于可操作状态
下一次正常备份时间
下一次强制备份时间

如果快照缓存开启，状态页还会附带快照列表。第一次查快照时，可能需要等待插件调用一次 restic snapshots --json。

第五步：手动做一次备份¶

执行：

!!restic backup

这条命令会尝试按下面的顺序工作：

检查 Minecraft 是否已经正常运行
检查本地仓库是否被放进了备份源目录里
如果你保持默认 restic 路径，且文件不存在，就尝试自动下载
如果本地仓库还没初始化，就自动执行 restic init
执行 Minecraft 保存相关命令
执行 restic backup

第一次成功后，再执行一次 !!restic status，通常就能看到快照列表。

最容易踩的 5 个坑¶

1. 仓库路径放进了备份源目录¶

错误示例：

restic:
  repository: "./server/world/restic-repo"
  backup_command:
    - "backup"
    - "./server/world"

这样会让仓库被备份进自己，插件会直接拒绝执行。请把仓库放到备份目录外面。

2. 没改示例密码就长期使用¶

示例密码只是为了降低第一次试运行门槛。正式使用时请一定改成你自己的强密码，或者改用 password_file。

3. 把 `schedule.cron_expression` 留空¶

正常调度的 schedule 不应该把 cron_expression 留空。要么填合法的 6 位 cron，要么改用 interval_seconds。

4. 以为维护会跟着每次备份一起跑¶

不会。维护由 maintenance_schedule 单独调度，或者你手动执行 !!restic maintenance。

5. 以为 `restore` 命令会立刻恢复¶

不会。restore 默认只是把任务加入队列，执行要靠 restore apply。

国内网络环境提示¶

如果你在中国大陆使用：

pip 装依赖失败，可能是网络或代理问题
自动下载 restic 失败，也可能是网络问题

这时建议：

先确认代理是否可用，或临时关闭有问题的代理再试
给 MCDR 使用的 Python / pip 配置镜像或代理
保留默认的 download_proxy_prefixes，让插件自动尝试下载代理前缀