速维通

主题

快速开始 ​

大家好，欢迎访问 SuWS 的快速开始章节！

SuWS 是一款高性能 WebSocket 通信组件，既可以作为完整的 WebSocket 服务端，也可以作为独立的 WebSocket 通信组件库来使用。

前置条件 ​

  • 通过命令行访问的终端

下载发行版二进制可执行文件 ​

按您的操作系统选择对应的可执行文件。

发行版

把下载后的可执行文件改名为 suws，创建一个配置文件 config.json，并把 config.json 放在与可执行文件相同的目录内。

配置项 ​

配置项描述默认值
port服务端口8788
token认证Token无
webhookWebHook地址无
webhook_timeoutWebHook超时时间（秒）5
webhook_max_idle_connsWebHook最大空闲连接数100
webhook_max_idle_conns_per_hostWebHook每主机最大空闲连接数5
webhook_idle_conn_timeoutWebHook空闲连接超时时间（秒）90
log日志配置无
log.verbose是否开启详细日志false

完整的配置文件示例 ​

警告

请完善配置文件中的，token 字段。

json
{
  "port": 8788,
  "token": "",
  "webhook": "https://domain.com/webhook",
  "webhook_timeout": 5,
  "webhook_max_idle_conns": 100,
  "webhook_max_idle_conns_per_host": 5,
  "webhook_idle_conn_timeout": 90,
  "log": {
    "verbose": false
  }
}

使用方法 ​

启动服务 ​

bash
# 设置可执行文件权限
chmod +x ./suws

# 启动服务，使用默认 config.json
./suws

# 启动服务，使用自定义配置文件
./suws -config /path/to/config.json
bash
# 使用默认 config.json
./suws.exe

# 使用自定义配置文件
./suws.exe -config /path/to/config.json

服务默认运行在 http://127.0.0.1:8788上。在浏览器中访问URL以查看服务的运行情况吧！

下一步 ​

  • 生产环境部署，务必阅读 配置
  • 与其他系统集成，请查看 路由
  • 想要调用RPC接口，请查看 RPC