finetu/aquarhome

Aquar Home

高度可定制的个人Home页，同时是强大的NAS服务控制台。

!https://raw.githubusercontent.com/firemakergk/aquar-home-helper/master/images/screenshot.jpg

AquarHome（水瓶Home页）是一个强大可定制的工具，具备基础导航功能（如搜索框、导航链接），同时适配多种NAS常用服务的API，集成NextCloud、Docker、Syncthing、TrueNas等服务，可在同一页面直接查看各服务的核心数据与最新状态。

!https://raw.githubusercontent.com/firemakergk/aquar-home-helper/master/images/readme_action.gif

核心特性

• 适配多种开源服务API的组件：
  • NextCloud文件浏览器
  • TrueNas存储池状态监控
  • Docker容器状态监控
  • Syncthing同步目录状态监控
  • PVE虚拟机状态监控
  • 基于rsync的文件增量备份组件
• 完善的Home页导航功能：
  • 多尺寸图标样式
  • 自定义上传图标
  • 自动抓取网站ico图标
  • 链接批量导入
  • 搜索框组件
• 页面适配移动端设备显示
• 所有组件大小位置可自定义
• 多标签页
• 支持登录验证与无登录验证
• 风格主题可选
• 背景图片可自定义

技术特性

• Vue+Node.js技术栈
• Docker镜像
• 不依赖数据库

目前项目仍处于早期，更多组件已列入开发计划：

• TodoList组件
• 日历组件
• 留言板&相册幻灯片
• RTSP推流监视器
• Emby/Jellyfin组件
• ...

快速开始

Docker方式

AquarHome的部署推荐使用docker-compose方式。

0. Docker及docker-compose的安装请参考其他资料。

1. 创建新文件夹：

bash
mkdir aquarhome

2. 在文件夹中创建docker-compose.yml文件：

bash
touch docker-compose.yml

3. 粘贴以下配置并根据自身目录结构调整卷挂载点：

yml
version: "3"
services:
  aquarhome:
    image: finetu/aquarhome:latest
    container_name: aquarhome 
    environment:
        - PUID=1000
        - PGID=1000
        - TZ=Asia/Shanghai
    volumes:
        - your/path/to/data:/var/aquardata # 数据目录，包含核心配置、缓存/上传文件等
        - your/path/to/aquarpool:/opt/aquarpool # 文件同步功能使用目录（无需可填空文件夹）
        - /opt/aquar/storages/apps/aquarhome/logs:/root/.pm2/logs # 日志文件
    ports:
        - 8172:8172
        - 10000-10100:10000-10100 # 视频聊天组件需预留100个流媒体端口
    restart: unless-stopped

4. 启动容器：

bash
cd aquarhome
docker-compose up -d

5. 访问服务： 部署成功后，访问宿主机内网地址（如[***]

源码方式

若不便使用Docker或需修改代码，可采用源码方式部署（非开发者不建议）。

1. 环境要求（Linux推荐）：

   • Node.js >=14及对应npm
   • Python >=3.6及对应pip
   • GNU make
   • GCC/G++ >=4.9或支持C++11的clang
   • 中国大陆用户需具备外网访问能力（否则mediasoup组件无法下载依赖）

2. 下载源码：

bash
git clone https://gitee.com/firemaker/aquar-home.git

3. 部署步骤：

bash
sudo -i # 以管理员身份操作
npm config set registry https://registry.npm.taobao.org # 切换国内npm源
npm install -g pm2 # 安装pm2
cd /path/to/aquar-home
cd aquar_home_front # 进入前端目录
npm install # 安装依赖
npm run build # 构建前端
cd ../aquar_home_server # 进入后端目录
rm -rf public/static/ public/favicon.ico public/index.html # 清空旧静态资源
cp -r ../aquar_home_front/dist/* public/ # 拷贝前端构建文件
npm install --unsafe-perm # 安装后端依赖（需管理员权限）
npm run prd # 用pm2启动项目

更进一步

AquarHome采用轻量化设计，摒弃数据库，通过配置文件实现数据持久化，配置数据可读性高、易迁移。

数据目录（Docker中/var/aquardata的宿主机挂载点）结构如下：

.
├── bg_img   # 背景图上传目录
├── cache    # 组件缓存目录
├── cert     # 自定义SSL证书目录（证书需命名为aquarhome.key/crt，PEM格式）
├── db       # 核心配置数据（db.json）
├── icon_img # 图标文件目录（上传/自动抓取的图标）
└── log      # 日志目录

核心配置文件/db/db.json示例（带注释）：

json
{
  "auth": { # 权限验证信息（密钥、用户名密码MD5散列）
    "secret": "p3xkCUbUte",
    "userName": "firemaker",
    "password": "3b774fe4f5d86e9b112789a2708e1e91"
  },
  "config": { # 系统配置（背景、主题等）
    "current_index": 0,
    "appearance": {
      "bgColor": "#455A65",
      "bgImg": "/bg_img/6bf762336ffa3a8b2cd39474d2bbdc7c.webp",
      "bgBlur": "0",
      "theme": "defaultLight"
    }
  },
  "tabs": [ # 标签页数据（标题及组件列表）
    {
      "title": "导航",
      "widgets": [ # 组件列表
        {
          "id": "cbaf8dda-8e77-4ab4-a328-c13f78b2c386", # 组件唯一ID
          "sort": 1, # 排序属性（暂未使用）
          "name": "syncthing local", # 组件名称
          "href": "http://localhost:8384", # 链接地址
          "image": "img/nextcloud.jpg", # 图标地址
          "widget": "SyncthingWidget", # 组件类型
          "layout": { # 位置及大小
            "x": 4,
            "y": 2,
            "w": 3,
            "h": 4,
            "i": "cbaf8dda-8e77-4ab4-a328-c13f78b2c386",
            "moved": false
          },
          "data": {
            "server": "http://localhost:8384", # 服务地址
            "app_key": "mESCgd6imiPvTfVGojshHRSwcAd9SYzp" # Syncthing鉴权密钥
          }
        }
      ]
    }
  ]
}

更多详细文档

详细使用文档请参考：https://github.com/firemakergk/aquar-home-helper