Skip to content

从源码安装

前置条件

  • go 语言版本 >= 1.24
  • 通过命令行访问的终端

克隆源码

请先从源码仓库,克隆项目源代码

源码仓库

bash
git clone https://github.com/ledccn/suws.git && cd suws

构建二进制文件

bash
go mod download
go build -o suws
bash
make build           # 构建二进制文件
make build-all       # 为所有平台构建(Linux、Windows、macOS)
make install         # 安装到 $GOPATH/bin

配置项

配置项描述默认值
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
# 使用默认 config.json
./suws

# 使用自定义配置文件
./suws -config /path/to/config.json
bash
make run                          # 使用默认 config.json 构建并运行
CONFIG=prod.json make run-config  # 使用自定义配置文件构建并运行
make dev                          # 使用竞态检测器运行(开发模式)

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

下一步

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