linuxserver/rsnapshot

linuxserver/rsnapshot

镜像概述和主要用途

Rsnapshot 是一个基于rsync的文件系统快照工具。它能够轻松地对本地机器和通过SSH连接的远程机器创建定期快照。该工具尽可能利用硬链接，从而大大减少所需的磁盘空间。

LinuxServer.io团队提供的此容器具有以下特点：

• 定期及时的应用更新
• 简单的用户映射（PGID、PUID）
• 带有s6覆盖层的自定义基础镜像
• 每周基础操作系统更新，在整个LinuxServer.io生态系统中共享通用层，以最小化空间使用、停机时间和带宽
• 定期安全更新

核心功能和特性

• 基于rsync的高效文件系统快照
• 利用硬链接减少磁盘空间占用
• 支持本地和远程（SSH）机器快照
• 灵活的备份策略配置
• 定期自动备份（通过cron）
• 简单的用户/组权限映射
• 多架构支持

支持的架构

该镜像利用docker manifest实现多平台支持。只需拉取 lscr.io/linuxserver/rsnapshot:latest 即可获取适合您架构的正确镜像，也可以通过标签拉取特定架构的镜像。

支持的架构：

使用场景和适用范围

• 个人或小型企业服务器的定期备份
• 多台远程服务器的集中备份管理
• 需要高效利用磁盘空间的备份解决方案
• 希望通过容器化方式简化备份配置和管理的环境

详细的使用方法和配置说明

应用设置

重要注意事项：

启动容器后，您需要编辑 /config/rsnapshot.conf 配置文件。

快照根目录

rsnapshot默认配置为将数据备份到 /.snapshots 卷。您可以在配置中更改此设置，但请确保挂载与此匹配的卷到容器。

备份级别/间隔

rsnapshot根据此部分的配置保留备份。有关更多信息，请参阅https://github.com/rsnapshot/rsnapshot/blob/master/README.md#configuration%E3%80%82

备份点

rsnapshot默认配置为从 /data 卷备份数据。您可以在配置中更改此设置，但请确保挂载与此匹配的卷到容器。

cron配置

然后，您需要编辑 /config/crontabs/root 来设置运行rsnapshot的cron任务。默认情况下，没有启用任何cron任务。配置文件中包含基于https://github.com/rsnapshot/rsnapshot/blob/master/README.md#configuration%E7%9A%84%E7%A4%BA%E4%BE%8B%E3%80%82

部署方案示例

docker-compose（推荐）

yaml
---
services:
  rsnapshot:
    image: lscr.io/linuxserver/rsnapshot:latest
    container_name: rsnapshot
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=Etc/UTC
    volumes:
      - /path/to/rsnapshot/config:/config
      - /path/to/snapshots:/.snapshots #可选
      - /path/to/data:/data #可选
    restart: unless-stopped

docker cli

bash
docker run -d \
  --name=rsnapshot \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=Etc/UTC \
  -v /path/to/rsnapshot/config:/config \
  -v /path/to/snapshots:/.snapshots `#可选` \
  -v /path/to/data:/data `#可选` \
  --restart unless-stopped \
  lscr.io/linuxserver/rsnapshot:latest

配置参数说明

容器通过运行时传递的参数进行配置。这些参数用冒号分隔，表示 <外部>:<内部>。例如，-p 8080:80 会将容器内的端口 80 暴露出来，可通过主机IP的 8080 端口访问。

环境变量

您可以通过使用特殊的前缀 FILE__ 从文件中设置任何环境变量。

例如：

bash
-e FILE__MYVAR=/run/secrets/mysecretvariable

这将根据 /run/secrets/mysecretvariable 文件的内容设置环境变量 MYVAR。

Umask设置

对于所有镜像，我们提供了使用可选的 -e UMASK=022 设置来覆盖容器内启动的服务的默认umask设置的能力。请注意，umask不是chmod，它根据其值减去权限，而不是添加权限。

用户/组标识符

使用卷（-v 标志）时，主机操作系统和容器之间可能会出现权限问题。我们通过允许您指定用户 PUID 和组 PGID 来避免此问题。

确保主机上的任何卷目录都由您指定的相同用户拥有，这样任何权限问题都会迎刃而解。

在此实例中 PUID=1000 和 PGID=1000，要查找您的PUID和PGID，请使用 id your_user：

bash
id your_user

示例输出：

text
uid=1000(your_user) gid=1000(your_user) groups=1000(your_user)

Docker Mods

我们发布了各种https://github.com/linuxserver/docker-mods%EF%BC%8C%E4%BB%A5%E5%90%AF%E7%94%A8%E5%AE%B9%E5%99%A8%E5%86%85%E7%9A%84%E5%85%B6%E4%BB%96%E5%8A%9F%E8%83%BD%E3%80%82%E4%B8%8A%E8%BF%B0%E5%8A%A8%E6%80%81%E5%BE%BD%E7%AB%A0%E5%8F%AF%E8%AE%BF%E9%97%AE%E6%AD%A4%E9%95%9C%E5%83%8F%E5%8F%AF%E7%94%A8%E7%9A%84Mods%E5%88%97%E8%A1%A8%EF%BC%88%E5%A6%82%E6%9C%89%EF%BC%89%E4%BB%A5%E5%8F%8A%E5%8F%AF%E5%BA%94%E7%94%A8%E4%BA%8E%E6%88%91%E4%BB%AC%E4%BB%BB%E4%BD%95%E9%95%9C%E5%83%8F%E7%9A%84%E9%80%9A%E7%94%A8Mods%E3%80%82

支持信息

• 容器运行时的Shell访问：

  bash
  docker exec -it rsnapshot /bin/bash
  

• 实时监控容器日志：

  bash
  docker logs -f rsnapshot
  

• 容器版本号：

  bash
  docker inspect -f '{{ index .Config.Labels "build_version" }}' rsnapshot
  

• 镜像版本号：

  bash
  docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/rsnapshot:latest
  

更新信息

我们的大多数镜像是静态的、版本化的，需要更新镜像并重新创建容器来更新内部的应用程序。除了一些例外情况（在相关的readme.md中注明），我们不建议或支持在容器内更新应用程序。请参考上面的应用设置部分，查看是否推荐对镜像进行更新。

以下是更新容器的说明：

使用Docker Compose

• 更新镜像：

  • 所有镜像：

    bash
    docker-compose pull
    

  • 单个镜像：

    bash
    docker-compose pull rsnapshot
    

• 更新容器：

  • 所有容器：

    bash
    docker-compose up -d
    

  • 单个容器：

    bash
    docker-compose up -d rsnapshot
    

• 您还可以删除旧的悬空镜像：

  bash
  docker image prune
  

使用Docker Run

• 更新镜像：

  bash
  docker pull lscr.io/linuxserver/rsnapshot:latest
  

• 停止运行中的容器：

  bash
  docker stop rsnapshot
  

• 删除容器：

  bash
  docker rm rsnapshot
  

• 使用上述指示的相同docker run参数重新创建新容器（如果正确映射到主机文件夹，您的 /config 文件夹和设置将被保留）

• 您还可以删除旧的悬空镜像：

  bash
  docker image prune
  

镜像更新通知 - Diun (Docker Image Update Notifier)

我们建议使用Diun进行更新通知。不建议或支持其他自动更新容器的工具。

本地构建

如果您想对这些镜像进行本地修改以用于开发目的或自定义逻辑：

bash
git clone https://github.com/linuxserver/docker-rsnapshot.git
cd docker-rsnapshot
docker build \
  --no-cache \
  --pull \
  -t lscr.io/linuxserver/rsnapshot:latest .

可以使用 lscr.io/linuxserver/qemu-static 在x86_64硬件上构建ARM变体，反之亦然

bash
docker run --rm --privileged lscr.io/linuxserver/qemu-static --reset

注册后，您可以使用 -f Dockerfile.aarch64 定义要使用的dockerfile。

版本历史

• 01.02.25: - 重新基于Alpine 3.21构建
• 06.03.24: - 重新基于Alpine 3.20构建
• 23.12.23: - 重新基于Alpine 3.19构建，为logrotate添加root周期性crontabs
• 25.05.23: - 重新基于Alpine 3.18构建，弃用armhf
• 02.03.23: - 将cron拆分为单独的初始化步骤并设置crontab权限
• 15.12.22: - 重新基于Alpine 3.17构建
• 11.10.22: - 重新基于Alpine 3.16构建，迁移到s6v3
• 10.10.21: - 重新基于Alpine 3.14构建
• 20.08.20: - 初始发布