floibach/restic-browser

Restic Browser

https://img.shields.io/badge/GitHub-Repository-blue?logo=github](https://github.com/florianibach/restic-browser) https://img.shields.io/badge/Docker_Hub-Repository-blue?logo=docker](https://hub.docker.com/r/floibach/restic-browser)

一个轻量级Web UI，用于浏览、下载和检查restic备份——基于Go和Docker构建。

Restic Browser提供：

• /repo挂载目录的文件浏览器
• restic仓库的自动检测
• 基于SQLite的仓库配置页面（密码+无锁模式）
• 快照列表展示、浏览及文件/文件夹ZIP下载功能

本项目与restic无关联。

本项目由我在业余时间开发和维护。如果它对你有帮助或节省了时间，可以通过https://raw.githubusercontent.com/pachadotdev/buymeacoffee-badges/main/bmc-black.svg]([***]

核心功能

• /files路径下的文件浏览器（浏览/repo目录）
• 自动检测restic仓库（识别config、data/、index/、keys/等结构）
• 通过UI（/config）配置仓库并将设置存储在SQLite中
• 按最新顺序列出快照
• 浏览快照内容
• 下载单个文件
• 流式下载文件夹为ZIP包
• 支持多架构（amd64 & arm64），可在树莓派上完美运行

快速开始（Docker）

1) 准备文件夹

• 仓库根目录（你的restic仓库需存放在此目录下）：挂载到/repo
• 持久化应用数据（SQLite数据库）：挂载到/data

主机端示例：

bash
mkdir -p ./data
# 你的restic仓库可存放在例如/home/${USER}/backup/repos这样的路径下

2) 运行容器

bash
docker run -d \
  -p 8080:8080 \
  -v /home/${USER}/backup/repos:/repo:ro \
  -v ./data:/data \
  --name restic-browser \
  floibach/restic-browser:latest

访问：

• 文件浏览器：http://localhost:8080/
• 健康检查：http://localhost:8080/health

Docker Compose示例

yaml
services:
  restic-browser:
    image: floibach/restic-browser:latest
    ports:
      - "8080:8080"
    environment:
      # 可选配置：
      # CONFIG_DB_PATH: /data/config.db 
      # RESTIC_CACHE_DIR: /cache
    volumes:
      - /home/florian/backrest/repos:/repo:ro
      - ./data:/data # 容器内路径需与CONFIG_DB_PATH配置一致
      # 可选restic缓存：
      # - restic-cache:/cache

# volumes:
#   restic-cache:

工作原理

1. 访问/files浏览挂载的/repo文件夹。
2. 当检测到某个文件夹为restic仓库时：
   • 若已配置，可直接打开
   • 或通过/config配置（输入密码+选择无锁模式）
3. 配置完成后，Restic Browser可对该仓库执行restic命令：
   • restic snapshots --json
   • restic ls ... --json
   • restic dump ...
4. 浏览快照文件并下载：
   • 单个文件下载
   • 文件夹ZIP下载

配置说明

环境变量

卷挂载

建议：为安全起见，将/repo以只读模式（:ro）挂载。

安全注意事项

• 仓库密码目前以明文形式存储在SQLite中：
  • 建议限制对数据库卷的访问
  • 未来计划添加加密/操作系统密钥集成功能
• 若公开暴露服务，建议使用反向代理+身份验证
• 尽可能以只读模式挂载仓库

开发说明

本地运行（需安装restic）：

bash
go run .

或使用提供的开发容器。

Roadmap/想法

• 配置列表页面/configs（编辑现有仓库）
• 优化排序（文件夹优先、大小格式化）
• 快照内容内搜索
• 可选基础认证/认证中间件
• 加密存储的密码

许可证

MIT