WuKongIM Docs

环境准备

准备从源码运行 WuKongIM 所需的工具、端口和本地目录。

编辑此页报告文档问题

快速开始使用源码启动方式,因为它只需要 Git 和 Go,并直接采用仓库中受测试的单节点集群示例配置。

必需工具

工具要求用途
Git可访问 GitHub获取源码
Go1.25.11构建并运行 WuKongIM
curl支持 --fail验证就绪状态
浏览器支持现代 WebSocket使用 Manager 和 Chat Demo

检查本机环境:

git --version
go version
curl --version

go version 应报告 go1.25.11。其他版本可能能够构建,但不属于本快速开始的受验证工具链。

本地端口

默认示例需要以下端口未被占用:

端口用途
5001HTTP API、就绪检查、指标和内嵌 Chat Demo
5100WKProto TCP
5200WebSocket 多路复用入口
5301Manager
7001节点间 Transport

如果端口冲突,请先停止占用程序,或在复制出的 wukongim.toml 中修改对应监听地址。不要直接修改 wukongim.toml.example

磁盘与网络

  • 当前目录必须允许创建 ./data/wukongim-single-node-data
  • 首次运行需要网络访问以下载 Go 模块。
  • 测试用户只需在本机浏览器访问,不需要公网域名。

准备完成后,继续启动单节点集群

本页内容