docking-station Docker镜像文档

镜像概述

docking-station是一款Docker Compose栈管理工具，旨在简化多个Docker Compose项目的集中管理。该工具支持监控服务状态、检查更新，并提供直观的Web界面和Swagger API文档，同时可与Homepage集成展示服务统计信息。

核心功能与特性

• Docker Compose栈管理：集中管理多个Docker Compose项目的配置文件
• 服务状态监控：实时统计栈数量、服务数量等关键指标
• 更新检查：自动检测需要更新的服务
• Web界面：提供可视化操作界面，便于日常管理
• API支持：内置Swagger API文档，支持接口调用
• Homepage集成：可通过customapi widget在Homepage展示服务统计

使用场景

• 自托管服务器管理员：集中管理多个Docker Compose应用栈
• 开发/测试环境维护者：监控服务状态和更新需求
• 多服务部署场景：统一管理分散的Docker Compose配置

使用方法与配置说明

Docker Compose配置示例

services:
  docking-station:
    image: loolzzz/docking-station
    restart: unless-stopped
    # 可选环境变量
    # environment:
    #   - WEB_PORT=3000  # Web界面端口，默认3000
    #   - SERVER_PORT=3001  # 服务端口，默认3001
    ports:
      - 3000:3000  # Web界面及API端口映射
    volumes:
      - /path/to/config:/config  # 配置文件存储
      - /path/to/data:/data  # 应用数据存储
      - /path/to/logs:/logs  # 日志文件存储
      - /var/run/docker.sock:/var/run/docker.sock  # 与Docker守护进程通信
      - /etc/localtime:/etc/localtime:ro  # 确保时区与主机一致
      # 挂载需要管理的Docker Compose文件目录（示例）
      - /mnt/compose-files:/mnt/compose-files  # 存放各项目的docker-compose文件

卷挂载说明

访问方式

• Web应用：部署后访问 http://localhost:3000
• API文档：访问 http://localhost:3000/docs 查看Swagger API文档

Homepage集成配置

通过Homepage的customapi widget展示服务统计信息：

  - Docking Station:
      widget:
        type: customapi
        url: [***]
        mappings:
          - field: numOfStacks
            label: Stacks
            format: number
          - field: numOfServices
            label: Services
            format: number
          - field: numOfServicesWithUpdates
            label: Updates
            format: number

（集成效果示例：显示栈数量、服务数量及需更新服务数量）