abesesr/ncdu-web-viewer

ncdu-web-viewer 镜像文档

镜像概述

ncdu-web-viewer是一个Docker化的Web界面工具，专门用于可视化和导航ncdu（NCurses Disk Usage）生成的磁盘使用分析结果。该镜像将命令行工具ncdu的分析数据通过Web界面直观展示，使用户能够更便捷地查看、分析和共享磁盘占用情况，无需直接操作命令行环境。

核心功能与特性

• Docker化部署：提供容器化封装，简化安装和运行流程，支持跨平台使用
• Web界面可视化：将ncdu的文本分析结果转换为直观的Web图形界面，便于数据浏览
• 结果导航功能：支持对磁盘使用数据进行交互式导航，查看目录层级和文件占用详情
• 轻量高效：无需在本地安装ncdu，通过容器即可快速访问分析结果
• 数据共享：可通过Web界面轻松与团队共享磁盘使用分析结果

使用场景

• 系统管理员：远程分析服务器或工作站的磁盘使用情况，定位大文件和目录
• 开发人员：查看项目或应用的磁盘占用分布，优化存储使用
• 团队协作：共享磁盘分析结果，共同排查存储问题或进行容量规划
• 非技术用户：通过图形界面查看磁盘使用情况，无需掌握命令行操作

使用方法与配置说明

前提条件

• 已安装Docker引擎
• 已通过ncdu生成磁盘使用分析结果文件（通常为.ncdu扩展名，可通过ncdu -o result.ncdu /path/to/analyze命令生成）

基本使用（docker run）

通过以下命令启动容器，挂载ncdu结果文件目录并映射端口：

bash
docker run -d \
  --name ncdu-web-viewer \
  -p 8080:80 \
  -v /path/to/your/ncdu/results:/data \
  abes-esr/ncdu-web-viewer

参数说明：

• -d：后台运行容器
• --name ncdu-web-viewer：指定容器名称，便于管理
• -p 8080:80：将容器内80端口映射到主机8080端口（可根据需要修改主机端口）
• -v /path/to/your/ncdu/results:/data：挂载本地ncdu结果文件所在目录到容器内/data目录（容器将读取此目录下的.ncdu文件）

访问Web界面

容器启动后，通过浏览器访问 http://<主机IP>:8080 即可查看ncdu分析结果。界面将展示目录结构、文件大小占比等信息，支持交互式导航。

docker-compose配置示例

创建 docker-compose.yml 文件，简化部署和管理：

yaml
version: '3'
services:
  ncdu-web-viewer:
    image: abes-esr/ncdu-web-viewer
    container_name: ncdu-web-viewer
    ports:
      - "8080:80"  # 主机端口:容器端口
    volumes:
      - /path/to/local/ncdu/results:/data  # 本地ncdu结果目录映射
    restart: unless-stopped  # 容器退出时自动重启（除非手动停止）

启动服务：

bash
docker-compose up -d

注意事项

• 确保挂载的本地目录包含有效的ncdu结果文件（.ncdu格式），否则Web界面可能无法正常显示数据
• 如需调整访问端口，修改-p参数中的主机端口部分（例如-p 8888:80将使用8888端口访问）
• 容器运行时需要对挂载目录有读取权限，确保本地目录权限设置正确
• 更多高级配置和使用细节可参考项目官方文档：https://github.com/abes-esr/ncdu-web-viewer