aceberg/watchyourports Docker 镜像 - 轩辕镜像 | Docker 镜像高效稳定拉取服务

WatchYourPorts

镜像概述

WatchYourPorts是一款本地服务器开放端口清单工具，主要用于监控和管理本地网络中的服务器开放端口状态，并支持将数据导出至InfluxDB2，结合Grafana实现可视化分析。通过Web界面可直观查看端口在线状态、历史记录及统计信息，适用于系统管理员和DevOps工程师跟踪服务可用性。

!Screenshot

核心功能与特性

• 端口监控：定期扫描指定服务器端口状态，记录在线/离线历史
• 数据导出：支持将端口状态数据导出至InfluxDB2，便于Grafana可视化
• Web界面：提供直观的Web管理界面，展示端口状态、统计信息及历史记录
• Docker集成：可从Docker环境导入端口信息，自动生成监控目标
• 本地网络支持：可配置为完全离线运行，不依赖外部网络资源
• API接口：提供RESTful API，支持数据查询与集成

使用场景

• 本地服务器端口状态监控与管理
• 服务可用性跟踪与故障预警
• 网络设备端口开放情况审计
• 结合InfluxDB2和Grafana构建端口状态监控仪表盘

快速开始

Docker Run 命令

sh
docker run --name wyp \
-e "TZ=Asia/Shanghai" \
-v ~/.dockerdata/WatchYourPorts:/data/WatchYourPorts \
-p 8853:8853 \
aceberg/watchyourports

Docker Compose 配置

可参考项目仓库中的docker-compose.yml文件。

访问控制

可通过ForAuth限制对WatchYourPorts的访问，示例配置见docker-compose-auth.yml。此外，Authelia等SSO工具也可正常工作。

从Docker导入端口

1. 在安装Docker的服务器上运行docker-export.sh脚本，其中$ADDR为服务器的IP或域名（不带http(s)://前缀，用于端口探测）：

   sh
   ./docker-export.sh $ADDR
   

2. 将脚本输出粘贴到WatchYourPorts配置目录下的hosts.yaml文件中
3. 可在hosts.yaml中添加多个服务器

配置说明

配置可通过config.yaml文件、Web界面或环境变量进行，支持以下参数：

基本配置

InfluxDB2配置

以下配置需与Grafana的InfluxDB数据源配置匹配：

命令行选项

本地网络部署

默认情况下，应用会从互联网拉取主题、图标和字体。如需完全离线运行，可使用独立的node-bootstrap镜像提供本地资源：

1. 启动node-bootstrap：

   sh
   docker run --name node-bootstrap \
       -v ~/.dockerdata/icons:/app/icons \  # 用于本地图片
       -p 8850:8850 \
       aceberg/node-bootstrap
   

2. 启动WatchYourPorts并指定本地资源：

   sh
   docker run --name wyp \
       -v ~/.dockerdata/WatchYourPorts:/data/WatchYourPorts \
       -p 8853:8853 \
       aceberg/watchyourports -n "[***]"
   

也可使用项目仓库中的docker-compose-local.yml配置文件。

API接口

获取所有地址数据

http
GET /api/all

返回所有已保存地址的详细数据（JSON格式）。

json
{
    "192.168.2.2": {
        "Name": "SomeAddrName",
        "Addr": "192.168.2.2",
        "PortMap": {},  // 所有已保存端口将显示于此
        "Total": 0,
        "Watching": 0,
        "Online": 0,
        "Offline": 0
    }
}

获取历史数据

http
GET /api/history

返回内存中的所有端口状态历史记录（JSON格式）。

json
{
"192.168.2.3:8849": {
        "Name": "OS",
        "Addr": "192.168.2.3",
        "Port": 8849,
        "PortName": "MiniBoard",
        "State": [
            {
                "Date": "2024-06-28 22:42:45",
                "State": true
            },
            {
                "Date": "2024-06-28 22:52:45",
                "State": true
            }
        ],
        "NowState": true
    }
}

获取指定地址的端口映射

http
GET /api/port/:addr

返回指定地址（:addr）的当前端口映射信息。

bash
curl [***]

json
{
    "8850": {
        "Name": "node-bootstrap",
        "Port": 8850,
        "State": true,
        "Watch": true
    },
    "8851": {
        "Name": "Exercise Diary",
        "Port": 8851,
        "State": true,
        "Watch": true
    }
}

获取指定地址的指定端口状态

http
GET /api/port/:addr/:port

返回指定地址（:addr）和端口（:port）的当前状态。

bash
curl [***]

json
{
    "Name": "git-syr",
    "Port": 8844,
    "State": true,
    "Watch": true
}

致谢

• 所有依赖的Go包：dependencies
• Bootstrap
• 主题：Bootstrap免费主题
• 图标和logo：Flaticon