khairul169/garage-webui

Garage Web UI

Garage Web UI 是 Garage 的简单管理界面，而 Garage 是一款自托管、S3 兼容的分布式对象存储服务。该 Web UI 提供可视化界面，简化 Garage 存储集群的管理操作。

核心功能与特性

• 健康状态监控：实时查看 Garage 集群健康状态
• 集群与布局管理：管理集群配置及存储布局
• 桶管理：创建、更新或查看桶信息
• 对象/桶浏览器：集成的对象和桶浏览功能
• 访问密钥管理：创建并分配访问密钥

使用场景与适用范围

适用于需要可视化管理 Garage 存储集群的场景，包括：

• 自托管存储服务管理员
• 需要监控集群健康状态的运维人员
• 需通过图形界面管理存储桶和对象的用户
• 希望简化访问密钥管理流程的团队

安装与使用方法

Docker CLI 安装

直接通过 Docker 命令行启动：

sh
$ docker run -p 3909:3909 -v ./garage.toml:/etc/garage.toml:ro --restart unless-stopped --name garage-webui khairul169/garage-webui:latest

Docker Compose 安装

若 Garage 已通过 Docker 部署，可使用以下 Compose 配置将 Web UI 与 Garage 一同部署：

yml
services:
  garage:
    image: dxflrs/garage:v1.0.1
    container_name: garage
    volumes:
      - ./garage.toml:/etc/garage.toml
      - ./meta:/var/lib/garage/meta
      - ./data:/var/lib/garage/data
    restart: unless-stopped
    ports:
       - 3900:3900
       - 3901:3901
       - 3902:3903
       - 3903:3903

  webui:
    image: khairul169/garage-webui:latest
    container_name: garage-webui
    restart: unless-stopped
    volumes:
      - ./garage.toml:/etc/garage.toml:ro
    ports:
      - 3909:3909
    environment:
      API_BASE_URL: "http://garage:3903"  # Garage admin API 端点
      S3_ENDPOINT_URL: "http://garage:3900"  # S3 API 端点

配置说明

配置文件依赖

为简化安装，Web UI 会读取 Garage 配置文件中的以下关键参数：

• rpc_public_addr
• admin.admin_token
• s3_web.root_domain

示例 config.toml 内容：

toml
metadata_dir = "/var/lib/garage/meta"
data_dir = "/var/lib/garage/data"
db_engine = "sqlite"
metadata_auto_snapshot_interval = "6h"

replication_factor = 3
compression_level = 2

rpc_bind_addr = "[::]:3901"
rpc_public_addr = "localhost:3901"  # 必需配置
rpc_secret = "YOUR_RPC_SECRET_HERE"

[s3_api]
s3_region = "garage"
api_bind_addr = "[::]:3900"
root_domain = ".s3.domain.com"

[s3_web]  # 可选，如需将桶作为网站暴露
bind_addr = "[::]:3902"
root_domain = ".web.domain.com"
index = "index.html"

[admin]  # 必需配置
api_bind_addr = "[::]:3903"
admin_token = "YOUR_ADMIN_TOKEN_HERE"
metrics_token = "YOUR_METRICS_TOKEN_HERE"

环境变量配置

若配置文件加载失败，可通过以下环境变量手动指定：

运行与访问

启动后，通过 http://your-ip:3909 访问 Web UI。建议通过反向代理（如 Nginx）配置 SSL 以增强安全性。

故障排除

• 确保使用最新版本的 Garage。
• 若无法加载数据，请检查 Garage 的 admin API 是否已启用且端口可访问。
• 如遇问题，可在 https://github.com/khairul169/garage-webui/issues 提交 issue，描述问题并附上错误日志。