什么是 miniboard ？

miniboard 是带有选项卡和在线状态检查的轻量级仪表板。可以通过 GUI 或 yaml 文件进行配置。 采用 shoutrrr 通知。

什么是 Shoutrrr ？

Shoutrrr 是一个类似 caronc/apprise 的通知库，支持多种通知服务。

安装

在群晖上以 Docker 方式安装。

本文写作时， latest 版本对应为 v0.9.0；

docker cli 安装

如果你熟悉命令行，可能用 docker cli 更快捷

# 新建文件夹 miniboard 和 子目录
mkdir -p /volume1/docker/miniboard/data

# 进入 miniboard 目录
cd /volume1/docker/miniboard

# 运行容器
docker run -d \
   --restart unless-stopped \
   --name miniboard \
   -p 8849:8849 \
   -v $(pwd)/data:/data/miniboard \
   -v /var/run/docker.sock:/var/run/docker.sock \
   -e TZ=Asia/Shanghai \
   aceberg/miniboard

更多的环境变量，可以参考官方的文档：https://github.com/aceberg/miniboard#config

docker-compose 安装

也可以用 docker-compose 安装，将下面的内容保存为 docker-compose.yml 文件

version: '3'

services:
  miniboard:
    image: aceberg/miniboard
    container_name: miniboard
    restart: unless-stopped
    ports:
      - 8849:8849
    volumes:
      - ./data:/data/miniboard
      - /var/run/docker.sock:/var/run/docker.sock
    environment:
      - TZ=Asia/Shanghai

然后执行下面的命令

# 新建文件夹 miniboard 和 子目录
mkdir -p /volume1/docker/miniboard/data

# 进入 miniboard 目录
cd /volume1/docker/miniboard

# 将 docker-compose.yml 放入当前目录

# 一键启动
docker-compose up -d

运行

在浏览器中输入 http://群晖IP:8849 就能看主界面

不过现在除了菜单，什么都还没有

这个时候看 data 目录，里面生成了 2 个文件，config.yaml 和 board.yaml

设置

config 中可以设置主题等

新建 panel

点 Edit panel 进入 panel 编辑界面

在 Create panel from Docker API 下方输入名称，点 √

• 勾选 Scan ：检查这个 panel 下的主机是否在线；
• Timeout：两次扫描之间的时间（分钟）；

完成后点 √保存，点前面的笔，可以查看这个 panel 下通过 Docker API 获取的容器

当然，你也可以添加其他的网站

要想正常访问，需要将 IP Addres 改为正确的 IP，URL 和 Icon

另一种方式是直接编辑 board.yaml 文件

记得文件报存后，一定要 Reload 才能生效

像多端口的容器会生成多条记录，可以删除掉非 web 访问的端口

新建 Tabs

Edit tabs 进入 Tabs 编辑界面

填入名称，选中 docker，点保存

点开 ds3617 这个 tab

小结

软件的使用比较简单，Web GUI 上首先创建新面板（panel），然后使用该面板创建新选项卡（tab）。然后，您可以根据需要添加任意数量的主机（到面板）、面板和选项卡。

最终可以实现下面这样的效果

参考文档

aceberg/miniboard: Lightweight Dashboard with Tabs and online status check
地址：https://github.com/aceberg/miniboard

containrrr/shoutrrr: Notification library for gophers and their furry friends.
地址：https://github.com/containrrr/shoutrrr/

Service Overview - Shoutrrr
地址：https://containrrr.dev/shoutrrr/0.7/services/overview/