itzg/mc-backup

itzg/mc-backup Docker 镜像文档

镜像概述

itzg/mc-backup 是一个轻量级的 side-car 容器，专为辅助 itzg/minecraft-server 容器实现数据备份而设计。作为辅助容器，它通过共享数据卷的方式访问 Minecraft 服务器数据，实现自动化、可配置的备份策略，保障服务器世界文件、配置数据及插件数据的安全性。

主要用途

提供与 itzg/minecraft-server 容器的无缝集成，实现 Minecraft 服务器数据的定时备份、存储管理及自动化维护，降低数据丢失风险。

核心功能与特性

• 定时备份：支持自定义备份间隔（如每小时、每天），满足不同频率的备份需求。
• 多存储目标：支持本地文件系统、S3 兼容对象存储、FTP/SFTP 等多种备份目标（具体取决于配置）。
• 备份管理：支持配置备份文件保留策略（如保留最近 N 个备份），自动清理过期备份。
• 数据压缩：默认启用备份文件压缩（如 GZIP），减少存储空间占用。
• 低侵入性：通过 side-car 模式与主服务器容器共享数据卷，无需修改主容器配置。

使用场景与适用范围

适用场景

• 与 itzg/minecraft-server 容器配合使用，实现 Minecraft 服务器数据的自动化备份。
• 需定期备份服务器世界数据、玩家数据、配置文件及插件数据的场景。
• 对备份存储位置（本地/远程）、保留策略有自定义需求的场景。

适用用户

Minecraft 服务器管理员（腐竹）、需要保障服务器数据安全的个人或小型团队。

使用方法

前置条件

• 已部署 itzg/minecraft-server 容器，并通过数据卷（Volume）管理服务器数据。
• 确保 mc-backup 容器与主服务器容器具有相同的数据卷访问权限。

Docker Run 示例

通过 --volumes-from 共享主服务器容器的数据卷，配置基础备份参数：

bash
docker run -d \
  --name mc-backup \
  --volumes-from mc-server \  # 共享主服务器容器的数据卷（假设主容器名为 mc-server）
  -e BACKUP_INTERVAL=24h \    # 备份间隔（支持格式：1h=1小时，30m=30分钟，1d=1天）
  -e BACKUP_DIR=/data \       # 需备份的源目录（与主服务器数据目录一致，默认 /data）
  -e DESTINATION=local \      # 备份目标类型（local=本地，s3=S3兼容存储，ftp=FTP等）
  -e LOCAL_BACKUP_DIR=/backups \  # 本地备份目录（需挂载到宿主机或持久化卷）
  -e RETENTION_COUNT=7 \      # 保留最近 7 个备份文件
  -v /path/on/host/backups:/backups \  # 挂载宿主机目录作为本地备份存储
  itzg/mc-backup

Docker Compose 示例

与 itzg/minecraft-server 容器一同编排，简化部署与管理：

yaml
version: '3.8'

services:
  # Minecraft 主服务器容器
  mc-server:
    image: itzg/minecraft-server
    container_name: mc-server
    volumes:
      - mc-data:/data  # 主数据卷（需与备份容器共享）
    environment:
      - EULA=TRUE
      - VERSION=latest
    ports:
      - "25565:25565"
    restart: unless-stopped

  # 备份辅助容器
  mc-backup:
    image: itzg/mc-backup
    container_name: mc-backup
    volumes_from:
      - mc-server  # 共享主服务器的数据卷
    volumes:
      - /path/on/host/backups:/backups  # 宿主机备份目录（本地存储时使用）
    environment:
      - BACKUP_INTERVAL=12h  # 每 12 小时备份一次
      - BACKUP_DIR=/data     # 备份源目录（与主服务器 /data 一致）
      - DESTINATION=local    # 本地存储备份
      - LOCAL_BACKUP_DIR=/backups  # 本地备份文件存放路径
      - RETENTION_COUNT=5    # 保留最近 5 个备份
      - COMPRESSION=true     # 启用 GZIP 压缩
    restart: unless-stopped

volumes:
  mc-data:  # 主服务器数据卷（持久化存储）

配置说明

环境变量

通过环境变量配置备份行为，以下为常用参数（完整列表请参考 https://github.com/itzg/docker-mc-backup%EF%BC%89%EF%BC%9A

注意事项

1. 数据卷权限：确保 mc-backup 容器对共享数据卷具有读权限，避免因权限不足导致备份失败。
2. 存储目标配置：远程存储（如 S3、FTP）需提前配置目标服务的访问权限及网络连通性。
3. 备份验证：建议定期检查备份文件完整性，可通过手动恢复测试确认备份有效性。
4. 资源占用：备份过程可能短暂占用磁盘 I/O 及 CPU 资源，建议避开服务器高负载时段（可通过调整 BACKUP_INTERVAL 实现）。

参考链接

• Docker Hub 镜像地址：https://hub.docker.com/r/itzg/mc-backup
• 官方文档：https://github.com/itzg/docker-mc-backup