aceberg/watchyourports

WatchYourPorts

镜像概述

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

!https://raw.githubusercontent.com/aceberg/WatchYourPorts/main/assets/Screenshot1.png

核心功能与特性

• 端口监控：定期扫描指定服务器端口状态，记录在线/离线历史
• 数据导出：支持将端口状态数据导出至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 配置

可参考项目仓库中的https://github.com/aceberg/watchyourports/blob/main/docker-compose.yml%E6%96%87%E4%BB%B6%E3%80%82

访问控制

可通过https://github.com/aceberg/ForAuth%E9%99%90%E5%88%B6%E5%AF%B9WatchYourPorts%E7%9A%84%E8%AE%BF%E9%97%AE%EF%BC%8C%E7%A4%BA%E4%BE%8B%E9%85%8D%E7%BD%AE%E8%A7%81https://github.com/aceberg/watchyourports/blob/main/docker-compose-auth.yml%E3%80%82%E6%AD%A4%E5%A4%96%EF%BC%8CAuthelia%E7%AD%89SSO%E5%B7%A5%E5%85%B7%E4%B9%9F%E5%8F%AF%E6%AD%A3%E5%B8%B8%E5%B7%A5%E4%BD%9C%E3%80%82

从Docker导入端口

1. 在安装Docker的服务器上运行https://github.com/aceberg/watchyourports/blob/main/configs/docker-export.sh%E8%84%9A%E6%9C%AC%EF%BC%8C%E5%85%B6%E4%B8%AD%60$ADDR%60%E4%B8%BA%E6%9C%8D%E5%8A%A1%E5%99%A8%E7%9A%84IP%E6%88%96%E5%9F%9F%E5%90%8D%EF%BC%88%E4%B8%8D%E5%B8%A6%60http(s)://%60%E5%89%8D%E7%BC%80%EF%BC%8C%E7%94%A8%E4%BA%8E%E7%AB%AF%E5%8F%A3%E6%8E%A2%E6%B5%8B%EF%BC%89%EF%BC%9A

   sh
   ./docker-export.sh $ADDR
   

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

配置说明

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

基本配置

InfluxDB2配置

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

命令行选项

本地网络部署

默认情况下，应用会从互联网拉取主题、图标和字体。如需完全离线运行，可使用独立的https://github.com/aceberg/my-dockerfiles/tree/main/node-bootstrap%E9%95%9C%E5%83%8F%E6%8F%90%E4%BE%9B%E6%9C%AC%E5%9C%B0%E8%B5%84%E6%BA%90%EF%BC%9A

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 "http://$YOUR_IP:8850"
   

也可使用项目仓库中的https://github.com/aceberg/watchyourports/blob/main/docker-compose-local.yml%E9%85%8D%E7%BD%AE%E6%96%87%E4%BB%B6%E3%80%82

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 http://0.0.0.0:8853/api/port/192.168.2.2

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 http://0.0.0.0:8853/api/port/192.168.2.2/8844

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

致谢

• 所有依赖的Go包：https://github.com/aceberg/watchyourports/network/dependencies
• Bootstrap
• 主题：Bootstrap免费主题
• 图标和logo：Flaticon