eBackup - Simple and reliable backups for your server! Supports FTP/SFTP! - eBackup - 服务器备份插件

💡eBackup

一款简单可靠的服务器备份插件！它能将你的服务器文件压缩为 zip 格式进行备份，支持定时任务与远程存储，且完全免费开源。

🎮主要特性

• 压缩备份：将服务器文件备份到压缩的 zip 文件中。
• 自定义选择：可自由选择需要备份或忽略的文件与目录。
• 定时任务：使用 cron 表达式设置自动备份计划。
• 远程支持：支持通过 FTP 和 SFTP 将备份上传到远程服务器。
• 备份限制：可设置本地保留的备份数量上限。
• 异步快速：备份过程在后台异步进行，避免造成服务器卡顿。
• 长期兼容：对 Bukkit API 依赖极少，未来多个 Minecraft 版本无需更新即可使用。
• 完全免费：插件完全免费并开源。

🔧安装与配置

• 将插件 jar 文件放入服务器的 plugins 文件夹。
• 启动服务器以生成配置文件，然后编辑 plugins/eBackup 目录下的 config.yml。
• 授予管理员 ebackup.admin 权限以使用所有命令。

配置注意事项

• SFTP 路径问题：如果遇到 SFTP 连接问题，请尝试使用从根目录开始的绝对路径（例如 /home/user/backups），而非相对路径。
• Windows 系统：在 Windows 上打开备份文件时，强烈建议使用 7zip 软件。
• bStats 统计：插件集成了匿名使用统计。如需禁用，请在 bStats 配置中关闭。

✨命令列表

拥有 ebackup.admin 权限的玩家或控制台可使用以下命令：

• /ebackup list - 列出备份文件夹中的所有备份文件。
• /ebackup backup - 立即开始一次备份（包含远程上传）。
• /ebackup backuplocal - 立即开始一次备份，但不上传到 FTP/SFTP。
• /ebackup stats - 显示备份存储空间统计信息。
• /ebackup testupload - 测试 FTP/SFTP 上传功能，但不创建新备份。
• /ebackup reload - 重载插件配置文件。

⭐配置文件详解 (`config.yml`)

以下为关键配置项的说明

定时任务

• crontask: '0 0 4 *'

- 此示例表示每天凌晨 4 点执行备份。

- 格式为：`秒 分 时 日 月 星期`。

- 执行 `/ebackup reload` 后，控制台会显示当前 cron 表达式的具体含义。

备份文件

• backup-format: 'eBackup {DATE}'

- 备份文件的命名格式，`{DATE}` 将被替换。

• backup-date-format: 'yyyy-MM-dd HH-mm-ss'

- 替换 `{DATE}` 的日期格式，遵循 `java.text.SimpleDateFormat` 规范。

• backup-path: 'plugins/eBackup/backups'

- 本地存储备份文件的目录。

• max-backups: 20

- 本地保留的最大备份数量，达到上限后将删除最旧的备份。设置为 `0` 可禁用此功能。

• compression-level: 4

- ZIP 压缩等级 (0-9)。等级越高，文件越小，但 CPU 占用更高且耗时更长。

远程上传 (FTP/SFTP)

• ftp.enable: false

- 设置为 `true` 以启用远程备份。

• ftp.type: sftp

- 连接类型，可选 `ftp` 或 `sftp`。

• ftp.path: '/home/user/backups/'

- **重要**：请更改为你的远程服务器路径。

• ftp.use-key-auth: false

- 仅限 SFTP。设置为 `true` 可使用 SSH 密钥认证（此时将忽略密码）。

• delete-after-upload: false

- 设置为 `true` 将在每次成功上传后删除本地备份文件。

备份内容

• backup.pluginjars: true

- 是否备份插件 jar 文件。

• backup.pluginconfs: true

- 是否备份各插件的配置和数据文件夹。

• backup.ignore

- 在此列表中添加文件或目录路径，它们将被排除在备份之外。默认已忽略 eBackup 自身的备份文件夹、dynmap 插件数据、日志等。

其他选项

• only-backup-if-players-were-on: true

- 设置为 `true` 后，仅当上次备份或服务器启动后有玩家进入过服务器，才会执行定时备份，以节省磁盘空间。

❓开发者与项目信息

eBackup 是一个完全免费和开源的插件，你可以自由获取、修改代码或创建分支。

• 开发背景：为解决当时缺乏优秀免费备份插件的问题而创建，特别增加了对 SFTP（通过 SSH 连接）的支持，其性能相比同类插件有显著提升。
• 开源贡献：如果你有想要实现的功能，欢迎提交 Pull Request 或 Fork 项目并开启新分支。
• 使用统计：完整的匿名使用统计可在此查看：https://bstats.org/plugin/bukkit/eBackup/5262