plutonhq/pluton

Pluton 镜像文档

镜像概述

Pluton是一款自托管备份管理平台，旨在简化跨存储目的地的自动化增量备份流程。该平台整合了强大的开源工具——Restic（用于安全增量备份）和Rclone（用于多云存储连接），并通过直观的Web界面呈现，兼顾初学者和高级用户需求。

官方网站 | 文档 | https://github.com/plutonhq/pluton

核心功能与特性

• 自动化备份：基于Restic实现加密、压缩和保留策略的自动化备份
• 灵活调度：支持精细的备份任务调度和保留策略配置
• 端到端加密：从本地机器到云存储的备份全程加密，确保数据安全
• 50+存储支持：借助Rclone支持多种云存储服务
• 轻松恢复与下载：通过简单点击即可恢复或下载备份快照数据
• 事件通知：备份开始、结束、完成或失败时发送邮件通知
• 自动重试逻辑：备份失败时自动重试，支持自定义重试选项
• 直观用户界面：通过单一简洁界面管理所有备份任务
• 实时进度跟踪：实时监控备份进度
• 全面日志记录：在UI中查看应用和备份日志，便于调试
• 前后置脚本：支持在备份前后运行自定义脚本

使用场景

• 个人用户本地数据（文档、照片等）的自动化备份
• 小型企业服务器数据的定期备份与管理
• Docker容器数据卷的备份与恢复
• 需要跨多种云存储服务管理备份的场景
• 对数据隐私和控制权有较高要求的备份需求

安装与使用方法

前提条件

• 已安装Docker和Docker Compose

Docker Compose配置

创建docker-compose.yml文件，内容如下：

yaml
services:
  pluton:
    image: plutonhq/pluton:latest
    container_name: pluton-backup
    restart: unless-stopped

    ports:
      - "${SERVER_PORT:-5173}:${SERVER_PORT:-5173}"

    volumes:
      # 主数据卷 - 包含数据库、配置和日志
      - pluton-data:/data

      # 可选：挂载主机目录以便备份
      
      # 示例：让Pluton可访问用户文档文件夹
      # - /home/user/documents:/mnt/documents:ro # Linux
      # - /home/user/photos:/mnt/photos:ro # Linux
      # - C:/Users/username/Documents:/mnt/documents:ro # Windows
      # - C:/Users/username/Pictures:/mnt/photos:ro # Windows

      # 示例：让Pluton可访问Docker数据卷
      # - /var/lib/docker/volumes/wp-data/_data:/mnt/wordpress:ro
      # - C:/ProgramData/docker/volumes/wp-data/_data:/mnt/wordpress:ro  # Windows

    environment:
      # ===== 必需：安全与认证 =====
      # 生成安全随机字符串（至少12个字符）
      ENCRYPTION_KEY: ${ENCRYPTION_KEY} # 用于Restic/Rclone快照加密的密钥
      USER_NAME: ${USER_NAME} # 登录用管理员用户名
      USER_PASSWORD: ${USER_PASSWORD} # 登录用管理员密码

      # ===== 应用设置 =====
      APP_TITLE: ${APP_TITLE:-Pluton}
      APP_URL: ${APP_URL:-http://localhost:5173}
      SERVER_PORT: ${SERVER_PORT:-5173}
      MAX_CONCURRENT_BACKUPS: ${MAX_CONCURRENT_BACKUPS:-2}
      SESSION_DURATION: ${SESSION_DURATION:-7} # 前端登录会话持续时间（天）

      # ===== 用户界面安全设置 =====
      ALLOW_CUSTOM_RESTORE_PATH: ${ALLOW_CUSTOM_RESTORE_PATH:-true}
      ALLOW_FILE_BROWSER: ${ALLOW_FILE_BROWSER:-true}
      DISABLE_EVENT_SCRIPTS: ${DISABLE_EVENT_SCRIPTS:-false}

      # ===== Docker特定设置（请勿修改） =====
      NODE_ENV: production
      IS_DOCKER: "true"

volumes:
  pluton-data:
    driver: local

环境变量配置

创建.env文件，包含必需的环境变量：

env
ENCRYPTION_KEY=s0eK1r12973fS501SW  # 替换为安全随机字符串（至少12字符）
USER_NAME=admin  # 自定义管理员用户名
USER_PASSWORD=0123456789  # 自定义管理员密码

# 可选 - 覆盖默认值
# SERVER_PORT=7173  # 自定义端口

启动服务

执行以下命令启动Pluton服务：

bash
docker compose up -d

服务启动后，通过http://localhost:5173（或自定义端口）访问Pluton Web界面，使用配置的用户名和密码登录。

配置说明

必需环境变量

可选环境变量