iperf-web 镜像文档

镜像概述和主要用途

iperf-web是一个基于Alpine的Python 3.12 Flask Web服务器镜像，提供直观的Web界面，用于执行多种网络诊断命令，包括iperf、iperf3、dig、nslookup、netcat、ping和traceroute。该镜像支持多架构（amd64、arm64、arm/v7），方便在不同硬件平台部署，适用于网络性能测试和诊断场景。

!Overview

核心功能和特性

• 多网络工具支持：通过Web界面执行iperf、iperf3、dig、nslookup、netcat、ping、traceroute等命令
• 多架构支持：构建时启用了amd64、arm64、arm/v7架构支持
• 服务器配置保存：可预设常用服务器连接详情，自动填充测试参数
• 灵活配置：支持通过环境变量自定义Web服务端口和调试模式
• 轻量级基础：基于Alpine Linux，镜像体积小，资源占用低

使用场景和适用范围

• 网络吞吐量测试（使用iperf/iperf3客户端连接服务器）
• DNS查询与反向解析（dig、nslookup）
• 网络连通性测试（ping、traceroute）
• 端口检测（netcat）
• 适合管理员、开发者或需要便捷网络诊断工具的用户，尤其适用于需要通过Web界面统一管理网络测试的场景

详细使用方法和配置说明

前提要求

• iperf服务器：需有运行中的iperf或iperf3服务器（可部署iitgdocker/iperf-server容器或使用公共iperf3服务器）
• 网络连通性：测试主机与目标服务器之间需网络连通
• ICMP权限：ping和traceroute测试需允许ICMP协议通过

快速开始

使用最小参数启动Web服务器：

sudo docker run -d --restart=always --name iperf-web -p 5000:5000 iitgdocker/iperf-web

保存服务器连接详情

若需预设常用服务器配置（如定期测试的目标），可通过配置文件保存连接详情，实现测试参数自动填充。

步骤1：挂载配置目录

将主机目录挂载到容器内/app/config目录，确保配置文件持久化：

sudo mkdir -p /opt/iperf-web/config
sudo docker run -d --restart=always --name iperf-web -p 5000:5000 -v /opt/iperf-web/config:/app/config iitgdocker/iperf-web

步骤2：编辑配置文件

在主机/opt/iperf-web/config目录下创建config.json文件，格式示例：

{
    "dig": [
        {
            "name": "ineedmyip.com",
            "dig_target": "ineedmyip.com",
            "dig_parameters": "+short"
        },
        {
            "name": "ineedmyip.com reverse DNS",
            "dig_target": "140.82.49.8",
            "dig_parameters": "-x"
        }
    ],
    "iperf": [
        {
            "name": "Server 1",
            "iperf_version": "3",
            "iperf_target": "192.168.1.111",
            "iperf_port": "5201",
            "iperf_conn_type": "TCP",
            "iperf_timeout": "10",
            "iperf_parameters": "--format m"
        },
        {
            "name": "Server 2",
            "iperf_version": "2",
            "iperf_target": "192.168.1.222",
            "iperf_port": "5201",
            "iperf_conn_type": "UDP",
            "iperf_timeout": "15",
            "iperf_parameters": "--bandwidth 10M"
        }
    ],
    "nc": [
        {
            "name": "ineedmyip.com SSH port 22",
            "nc_target": "ineedmyip.com",
            "nc_port": "22"
        }
    ],
    "ping": [
        {
            "name": "8.8.8.8",
            "ping_target": "8.8.8.8",
            "ping_count": "4"
        }
    ]
}

注意：配置文件需按测试类型（如dig、iperf、ping等）组织，字段名需与Web界面表单字段对应。可参考模板文件确认最新字段名。

步骤3：重启容器

更新配置后需重启容器使生效：

sudo docker pull iitgdocker/iperf-web:latest
sudo docker stop iperf-web
sudo docker rm iperf-web
sudo docker run -d --restart=always --name iperf-web -p 5000:5000 -v /opt/iperf-web/config:/app/config iitgdocker/iperf-web

配置生效后，选择对应测试类型（如Dig、Iperf）时，将显示预设配置下拉菜单，选择后自动填充测试参数。

环境变量

IPERF_WEB_PORT

设置Flask应用监听端口。

• 取值范围：1025-65535（整数）
• 默认值：5000
• 示例：-e IPERF_WEB_PORT=8080（使用8080端口）

IPERF_WEB_DEBUG_MODE

启用Flask应用调试模式。

• 取值：True（启用）、False（禁用）
• 默认值：False
• 示例：-e IPERF_WEB_DEBUG_MODE=True

非容器化运行

若无需容器部署，可直接从GitHub获取源码运行：

步骤1：获取必要文件

从GitHub仓库下载：

• app.py
• static/目录
• templates/目录
• config/目录（可选，用于配置文件）

步骤2：安装依赖

pip3 install flask

安装必要网络工具（根据操作系统，至少需mtr、traceroute、iperf、iperf3）。

步骤3：启动应用

python3 app.py