vi0oss/websocat

websocket-connector

概述

websocket-connector是一款轻量级CLI工具，旨在实现WebSockets与多种服务（如控制台、TCP连接、子进程）之间的互连，提供不同协议间的数据转发与通信能力，简化跨服务数据交互流程。

核心功能和特性

• 多协议互连：支持WebSockets与控制台（标准输入/输出）、TCP连接、子进程间的双向数据传输
• 轻量级设计：体积小巧，资源占用低，适合嵌入式环境和资源受限场景
• 命令行操作：通过简洁的命令参数配置连接关系，无需复杂配置文件
• 跨平台支持：基于Docker容器化，可在Linux、Windows、macOS等主流操作系统运行

使用场景和适用范围

• 开发调试：在开发环境中快速连接WebSocket服务与本地控制台/TCP服务，实时查看和测试数据交互
• 协议转换桥梁：作为中间件连接WebSocket服务与传统TCP服务，实现不同协议系统间的通信
• 实时数据转发：将控制台输出、子进程日志等实时数据转发至WebSocket服务，实现远程监控
• 子进程通信中介：为子进程提供与外部WebSocket服务的通信能力，扩展本地应用的网络功能

使用方法和配置说明

获取镜像

bash
docker pull websocket-connector:latest

基本使用示例

1. WebSocket连接到控制台

将WebSocket服务的数据转发至本地控制台输出，并将控制台输入发送至WebSocket服务：

bash
docker run --rm -it websocket-connector connect \
  --from ws://example.com:8080/ws-endpoint \
  --to console

2. TCP连接到WebSocket

将TCP服务（如本地3000端口）的数据转发至WebSocket服务：

bash
docker run --rm websocket-connector connect \
  --from tcp://localhost:3000 \
  --to ws://example.com:8080/ws-endpoint

3. 子进程输出到WebSocket

运行子进程并将其输出转发至WebSocket服务：

bash
docker run --rm websocket-connector connect \
  --from child:"python3 -m http.server" \
  --to ws://example.com:8080/logs-endpoint

配置参数

环境变量

Docker Compose配置示例

yaml
version: '3'
services:
  websocket-bridge:
    image: websocket-connector:latest
    command: connect --from tcp://tcp-service:5000 --to ws://websocket-service:8080/ws
    environment:
      - LOG_LEVEL=debug
    depends_on:
      - tcp-service
      - websocket-service

  tcp-service:
    image: some-tcp-service:latest

  websocket-service:
    image: some-websocket-service:latest