MCDR-FTPBackup

一个为 Minecraft 服务器提供备份与 FTP 远程同步功能的 MCDReforged 插件。

功能特性

一键备份：自动压缩服务器文件并支持断连保护
远程同步：将备份文件上传至远程FTP/SFTP服务器
匹配编码：自动匹配FTP服务器的编码
智能清理：保留指定数量的本地备份文件
安全模式：关闭服务器后再执行备份（可在配置文件内修改）
权限管理：可配置不同命令的权限等级

安装指南

将插件文件放置于 MCDR 的 plugins 目录
首次运行会自动生成配置文件 config/config.json
根据服务器环境修改配置文件（配置说明见下文）

配置说明

{
    "stop_server": true,                // 是否在备份前停服
    "protocol": "ftp",                  // 选择协议 大小写均可
    "host": "ftp.example.com",          // FTP/SFTP 服务器地址
    "port": 21,                         // FTP/SFTP 端口
    "timeout": 10,                      // 超时时间  
    "username": "anonymous",            // 登录用户名
    "private_key_path": "",             // SFTP服务器秘钥路径
    "password": "",                     // 登录密码
    "prefix": "!!fb",                   // 命令前缀
    "server_dir": "./server",           // 服务器目录
    "keep_local_backups": 3,            // 本地保留备份数量
    "required_permission": 3,           // 操作所需权限等级
    "exclude_patterns": [               // 需要排除的文件
        "logs",
        "*.tmp",
        "*.lock"
    ]
    remote_path : str = '/'             // 指定远程备份路径
    local_path: str = './backups'       // 指定本地备份路径
    auto_backup: bool = False           // 是否开启定时备份功能
    cron_expression: str = '0 0 * * *'  // 定时备份时间
}

命令列表

注意:本文档假定你使用!!fb作为 MCDR 命令的前缀

!!fb - 显示帮助信息
!!fb test - 测试与FTP服务器的连接
!!fb make - 创建一个备份并上传到FTP服务器
!!fb inquire - 查询备份进度
!!fb reload - 热重载配置
!!fb abort - 终止备份

注意事项

首次使用前需要在config.json文件中修改FTP/SFTP服务器有关设置
备份完毕后会在backups文件夹内保留备份，保留数量可在配置文件内修改
排除的文件以unix shell风格匹配
定时备份表达式为一个 crontab 字符串，可以使用 https://crontab.guru/ 来创建一个 crontab 字符串

许可证

本项目基于 Apache License 2.0 发布

贡献

欢迎提交 Issue 和 Pull Request！

TODO

支持sftp协议
添加定时备份功能
使用@new_thread实现多线程(~~不仔细看文档的后果~~)

友商项目

八宝粥 (多)MC服务端管理面板