lissy93/dashy

Dashy

镜像概述和主要用途

Dashy 是一款专为家庭实验室设计的仪表板工具，旨在帮助用户集中组织和访问各类自托管服务，通过单一入口点简化多服务管理流程，提升自托管环境的使用效率。

核心功能和特性

• 集中访问入口：整合分散的自托管服务，提供统一访问界面
• 简化服务管理：通过直观的可视化布局，降低多服务切换的操作复杂度
• 轻量高效：基于现代前端技术构建，资源占用低，响应速度快
• 灵活扩展：支持通过配置文件自定义服务条目、分类及界面样式

使用场景和适用范围

• 家庭实验室用户：管理本地部署的各类服务（如NAS、媒体服务器、智能家居控制等）
• 自托管爱好者：整合个人服务器上的Web应用、API服务、监控工具等
• 小型团队/个人开发者：集中管理开发环境中的测试服务、文档系统、CI/CD工具等

详细的使用方法和配置说明

1. 快速启动（Docker Run）

通过以下命令快速部署 Dashy 容器：

bash
docker run -d \
  --name dashy \
  -p 8080:80 \
  -v /path/to/your/config.yml:/app/public/conf.yml \
  --restart unless-stopped \
  lissy93/dashy

说明：

• -p 8080:80：将容器内80端口映射到主机8080端口（可根据需求修改主机端口）
• -v /path/to/your/config.yml:/app/public/conf.yml：挂载本地配置文件（需提前创建，定义服务列表和界面配置）

2. Docker Compose 配置示例

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

yaml
version: '3'
services:
  dashy:
    image: lissy93/dashy
    container_name: dashy
    ports:
      - "8080:80"  # 主机端口:容器端口
    volumes:
      - ./config.yml:/app/public/conf.yml  # 挂载本地配置文件
    restart: unless-stopped
    environment:
      - NODE_ENV=production  # 运行环境（生产/开发）
      - PORT=80  # 容器内服务端口（默认80，通常无需修改）

启动命令：

bash
docker-compose up -d

3. 配置文件说明

Dashy 的核心配置通过 config.yml 文件定义，需挂载到容器内 /app/public/conf.yml。基础配置示例（详细参数参考官方文档）：

yaml
pageInfo:
  title: "My Homelab Dashboard"  # 页面标题
  description: "Central hub for my self-hosted services"  # 描述
sections:
  - name: "Media Services"  # 服务分类
    items:
      - title: "Plex"  # 服务名称
        description: "Media streaming server"  # 服务描述
        url: "http://plex.local:32400"  # 服务访问地址
        icon: "plex"  # 图标（支持Font Awesome或自定义图标）
  - name: "Productivity"
    items:
      - title: "Nextcloud"
        url: "https://nextcloud.local"
        icon: "nextcloud"

4. 环境变量说明

5. 访问方式

部署完成后，通过浏览器访问 http://<主机IP>:8080 即可打开 Dashy 仪表板。首次访问时，若未挂载配置文件，将显示默认示例界面，可通过修改 config.yml 自定义内容。

参考链接

• 用户展示
• 在线演示
• 官方文档
• https://github.com/Lissy93/dashy