thun888/mirouter-ui

小米路由器UI展示面板 Docker镜像文档

镜像概述

本镜像为基于小米路由器API开发的UI展示面板，通过Docker容器化部署，旨在为用户提供便捷的小米路由器数据可视化界面。无需复杂配置，通过简单的Docker命令即可快速搭建，适用于需要监控和查看小米路由器状态的用户。

核心功能与特性

• 路由器数据可视化：通过UI界面直观展示小米路由器的关键数据（如连接设备、流量使用、网络状态等）
• 基于小米路由器API：直接与小米路由器API交互，实时获取路由器数据
• Docker化部署：容器化设计，简化安装流程，避免系统环境依赖问题
• 自动生成配置文件：部署后自动在挂载目录生成配置文件，支持用户自定义配置

使用场景

• 个人用户监控小米路由器实时状态
• 家庭或小型办公环境中需要可视化展示路由器数据的场景
• 希望通过简单方式快速部署路由器监控工具的用户

使用方法与配置说明

前提条件

• 已安装Docker引擎（Docker Engine 18.06.0+）
• 小米路由器已开启API访问权限（具体开启方法请参考小米路由器官方文档）
• 具备基本的Docker命令操作能力

部署步骤

1. 创建工作目录

首先创建一个本地文件夹用于存储配置文件（建议使用空文件夹，避免文件冲突）：

bash
mkdir -p ~/mirouter-ui && cd ~/mirouter-ui

2. 启动Docker容器

在创建的文件夹中执行以下命令启动容器：

bash
docker run -d -p 6789:6789 -v $(pwd):/app/data docker.xuanyuan.run/thun888/mirouter-ui

命令参数说明：

• -d：后台运行容器
• -p 6789:6789：端口映射，将容器内6789端口映射到主机6789端口（确保主机6789端口未被占用）
• -v $(pwd):/app/data：数据卷挂载，将当前目录（工作目录）挂载到容器内/app/data目录，用于存储配置文件

3. 配置文件设置

容器启动后，会在挂载的工作目录（~/mirouter-ui）下自动生成配置文件（通常为config.json或类似名称）。用户可根据需求修改配置文件，例如：

• 小米路由器API地址（默认可能自动检测，如需手动指定可修改）
• 数据刷新频率
• 显示数据项配置

4. 访问UI界面

配置完成后，通过浏览器访问 http://主机IP:6789 即可打开小米路由器UI展示面板。

配置文件说明

配置文件位于工作目录下，具体名称以实际生成文件为准。主要配置项可能包括：

• router_ip：小米路由器IP地址（默认可能为192.168.31.1）
• api_port：路由器API端口（默认通常为80）
• refresh_interval：数据刷新间隔（单位：秒，默认可能为10）
• display_items：需要展示的数据项（如连接设备列表、上行/下行流量等）

修改配置文件后，需重启容器使配置生效：

bash
docker restart <容器ID或容器名称>

容器管理

• 查看容器状态：

  bash
  docker ps | grep thun888/mirouter-ui
  

• 停止容器：

  bash
  docker stop <容器ID或容器名称>
  

• 删除容器：

  bash
  docker rm <容器ID或容器名称>
  

注意事项

• 确保小米路由器与运行容器的主机在同一局域网内，且API服务正常
• 若主机6789端口已被占用，可修改端口映射（如-p 8080:6789将主机8080端口映射到容器6789端口）
• 配置文件修改后需重启容器方可生效
• 升级镜像时，建议先备份工作目录下的配置文件，避免配置丢失