gobackup

gobackup

将你的世界备份到 GoFile(需要付费订阅)

gobackup:一个基础的服务器端备份工具

这个工具是为了满足 GoFile 上传需求而制作的,现有的备份模组都无法满足这一需求。它旨在用于那些限制访问 .sh 文件且不允许在服务器存储上备份的廉价主机(如 PebbleHost),并利用 GoFile 廉价的大容量存储。

警告
此模组需要 GoFile Patreon 订阅(以访问 API,每月仅需 5 美元,同时你也在为大家支持免费存储),并且不保证它能按预期工作。使用风险自负!

警告
此模组不包含恢复功能。这很难实现。请确保你或你信任的人始终可以访问备份文件夹——你可以通过为每个文件夹设置带密码的公开访问来允许其他人使用它们。

注意
此模组不适用于客户端,也未在客户端进行测试。仅在服务器上使用。

配置

配置文件位于 config 文件夹中,包含以下字段:

  • gofile-api-key - 你的 GoFile API 密钥。登录后可在 你的 GoFile 个人资料页面 找到。
  • gofile-container-folder - 用于存放备份的文件夹 ID。转到 GoFile 侧边栏的 My Files,创建一个文件夹,进入该文件夹,然后将 URL 中 /d/ 后面的部分插入此处。
  • backup-type - 尚未实现。保持为 world 或从配置中完全移除。
    • 此选项实现后,将允许你备份所有服务器文件,而不仅仅是世界。
  • allow-manual - 是否允许通过 /gobackup now 进行手动备份。
  • announce-backup - 模组是否应在聊天中公告正在备份服务器。
    • 无论此项设置如何,服务器日志中始终会通知你服务器何时正在备份。
  • do-schedule - 是否应按计划执行备份。
  • interval - 计划备份之间的时间间隔,单位为秒。
    • 请明确你在做什么。如果你将其设置为非常小的值,例如 1 秒,你的服务器很快就会崩溃。
    • 建议至少 10 分钟,以避免服务器过载、被限流以及超出账户配额。
  • backup-limit - 存储的最大备份数量。一旦你的备份数量超过此数字,最旧的备份将被删除,以便为下一个备份腾出空间。
    • 用逻辑来决定这个值应该是多少。例如,如果你想每 30 分钟备份一个小世界,并希望在任何时候都保留最近两天的记录,你需要将限制设为 96 个备份。
    • 手动备份不计入其中。
  • show-progress-messages - 模组是否应在控制台记录消息,以指示备份进行到哪一步。
  • show-debug-messages - 出错时是否在控制台显示完整的错误日志和 GoFile API 响应。

如果你(不知怎么地)把文件弄坏了,只需删除它,就会生成一个新的空文件。

虽然 GoFile 提供优质廉价的存储,但请确保不要违反他们的条款。捐赠者被要求不要像免费用户那样滥用存储空间,因此请确保设置合理的间隔和限制。

使用方法

一切都会按照配置文件中的定义自动进行!但是,如果允许的话,你也可以使用 /gobackup now 在定义的频率之外进行备份——这会将备份发送到一个单独的文件夹,该文件夹中的备份不会由模组自动删除。

不要在文件或文件夹正在被处理时删除它们

GoBackup 在设计上尽可能在你与文件交互时保持弹性。但是,如果它在活动时未能及时跟上,你不应感到惊讶。为了尽可能安全,当你想要修改存储结构时,应首先执行 /gobackup disable。准备好后,再运行 /gobackup enable。

许可证

本项目采用 OSSAL 许可证,该许可证不允许将使用或修改本项目的代码以 GPL 及其他要求分发源代码的许可证进行授权。但是,本项目可以以任何其他方式使用,并且在其他方面与 MIT / Expat 许可证非常相似。