WuKongIM

Appearance

多节点模式 ​

说明 ​

适用场景：对数据安全要求高的应用，大型应用。

优点：高可用，容灾性强，支持在线扩容，多副本之间实时自动备份，负载均衡等。

缺点：部署稍复杂，需要多台机器。

WuKongIM集群符合 2n+1 原则，n表示宕机数量，比如允许1台机器宕机不影响服务正常运行则需要2*1+1=3台机器的集群，比如允许2台机器宕机不影响服务正常运行则需要2*2+1=5台机器的集群，依次类推。

环境要求 ​

  • 机器数量：3台或以上

  • Linux系统（推荐Ubuntu）(推荐配置 2核4G或4核8G)

  • 安装Docker (推荐：Docker版本24.0.4或以上)

假设三台服务器，信息如下

名称内网IP外网IP
node1(1001)10.206.0.13119.45.229.172
node2(1002)10.206.0.14129.211.213.76
node3(1003)10.206.0.81.13.191.138

准备工作 ​

需要在node1节点上部署nginx推荐版本1.27.0，用于负载均衡。

安装 ​

  1. 下载执行文件

范围：所有节点

bash
curl -L -o wukongim https://github.com/WuKongIM/WuKongIM/releases/download/v2.1.2-20250120/wukongim-linux-amd64
bash
curl -L -o wukongim https://github.com/WuKongIM/WuKongIM/releases/download/v2.1.2-20250120/wukongim-linux-arm64
  1. 修改执行文件权限

范围：所有节点

bash
chmod +x wukongim

配置 ​

配置WuKongIM ​

在node1上创建配置文件wk.yaml 内容如下：

yaml
mode: "release"
external: # 公网配置
  ip: "119.45.229.172" # 节点外网IP，客户端能够访问到的IP地址。
  tcpAddr: "119.45.229.172:15100" #  app访问的长连接地址, 注意这里是负载均衡服务器的ip和端口，不是本机的
  wsAddr: "ws://119.45.229.172:15200" #  web访问的长连接地址，注意这里是负载均衡服务器的ip和端口，不是本机的
cluster:
  nodeId: 1001 # 节点id
  apiUrl: "http://10.206.0.13:5001" # 当前节点内网的api地址
  serverAddr: "10.206.0.13:11110" # 当前节点内网的分布式通讯地址
  initNodes: 
    - "1001@10.206.0.13:11110"
    - "1002@10.206.0.14:11110"
    - "1003@10.206.0.8:11110"

在node2上创建配置文件wk.yaml 内容如下：

yaml
mode: "release"
external: # 公网配置
  ip: "129.211.213.76" # 节点外网IP，客户端能够访问到的IP地址。
  tcpAddr: "119.45.229.172:15100" #  app访问的长连接地址, 注意这里是负载均衡服务器的ip和端口，不是本机的
  wsAddr: "ws://119.45.229.172:15200" #  web访问的长连接地址，注意这里是负载均衡服务器的ip和端口，不是本机的
cluster:
  nodeId: 1002 # 节点id
  apiUrl: "http://10.206.0.14:5001" # 当前节点内网的api地址
  serverAddr: "10.206.0.14:11110" # 当前节点内网的分布式通讯地址
  initNodes: 
    - "1001@10.206.0.13:11110"
    - "1002@10.206.0.14:11110"
    - "1003@10.206.0.8:11110"

在node3上创建配置文件wk.yaml 内容如下：

yaml
mode: "release"
external: # 公网配置
  ip: "1.13.191.138" # 节点外网IP，客户端能够访问到的IP地址。
  tcpAddr: "119.45.229.172:15100" #  app访问的长连接地址, 注意这里是负载均衡服务器的ip和端口，不是本机的
  wsAddr: "ws://119.45.229.172:15200" #  web访问的长连接地址，注意这里是负载均衡服务器的ip和端口，不是本机的
cluster:
  nodeId: 1003 # 节点id
  apiUrl: "http://10.206.0.8:5001" # 当前节点内网的api地址
  serverAddr: "10.206.0.8:11110" # 当前节点内网的分布式通讯地址
  initNodes: 
    - "1001@10.206.0.13:11110"
    - "1002@10.206.0.14:11110"
    - "1003@10.206.0.8:11110"

配置nginx ​

nginx
user  nginx;
worker_processes  auto;

error_log  /var/log/nginx/error.log notice;
pid        /var/run/nginx.pid;

events {
    worker_connections  1024;
}
http {
    include       /etc/nginx/mime.types;
    default_type  application/octet-stream;

    log_format  main  '$remote_addr - $remote_user [$time_local] "$request" '
                      '$status $body_bytes_sent "$http_referer" '
                      '"$http_user_agent" "$http_x_forwarded_for"';

    access_log  /var/log/nginx/access.log  main;

    sendfile        on;
    #tcp_nopush     on;

    keepalive_timeout  65;

    #gzip  on;

    include /etc/nginx/conf.d/*.conf;


    # api负载均衡
    upstream wukongimapi {
        server 10.206.0.13:5001;
        server 10.206.0.14:5001;
        server 10.206.0.8:5001;
    }
    # demo负载均衡
    upstream wukongimdemo {
        server 10.206.0.13:5172;
        server 10.206.0.14:5172;
        server 10.206.0.8:5172;
    }
    # manager负载均衡
    upstream wukongimanager {
        server 10.206.0.13:5300;
        server 10.206.0.14:5300;
        server 10.206.0.8:5300;
    }
    # ws负载均衡
    upstream wukongimws {
        server 10.206.0.13:5200;
        server 10.206.0.14:5200;
        server 10.206.0.8:5200;
    }
    # http api转发
    server {
        listen 15001;
        location / {
            proxy_pass http://wukongimapi;
            proxy_connect_timeout 20s;
            proxy_read_timeout 60s;
        }
    }
    # demo
    server {
        listen 15172;
        location / {
            proxy_pass http://wukongimdemo;
            proxy_connect_timeout 20s;
            proxy_read_timeout 60s;
        }
        location /login {
            rewrite ^ /chatdemo?apiurl=http://119.45.229.172:15001;
            proxy_pass http://wukongimdemo;
            proxy_connect_timeout 20s;
            proxy_read_timeout 60s;
        }
    }
    # manager
    server {
        listen 15300;
        location / {
            proxy_pass http://wukongimanager;
            proxy_connect_timeout 60s;
            proxy_read_timeout 60s;
        }
    }
    # ws
    server {
        listen 15200;
        location / {
            proxy_pass http://wukongimws;
            proxy_redirect off;
            proxy_http_version 1.1;
            # nginx接收upstream server数据超时, 默认120s, 如果连续的120s内没有收到1个字节, 连接关闭
            proxy_read_timeout 120s;
            # nginx发送数据至upstream server超时, 默认120s, 如果连续的120s内没有发送1个字节, 连接关闭
            proxy_send_timeout 120s; 
            # nginx与upstream server的连接超时时间
            proxy_connect_timeout 4s; 
            proxy_set_header  X-Real-IP $remote_addr;
            proxy_set_header Upgrade $http_upgrade;
            proxy_set_header Connection "upgrade";
        }
    }
}

# tcp
stream {
  # tcp负载均衡
  upstream wukongimtcp {
    server 10.206.0.13:5100;
    server 10.206.0.14:5100;
    server 10.206.0.8:5100;
  }
  server {
    listen 15100;
    proxy_connect_timeout 4s;
    proxy_timeout 120s;
    proxy_pass wukongimtcp;
  }
}

记得重启nginx生效

启动或停止 ​

所有节点启动WuKongIM

bash

./wukongim --config wk.yaml -d

# 停止
# ./wukongim stop

开放端口 ​

外网开放 ​

端口说明
15001http api 端口 (仅内部局域网开放)
15100tcp 端口 ， app端需要能访问到
15200websocket 端口 ， web im端需要能访问到
15300后台管理系统的端口
15172demo的端口，用于演示wukongim通讯能力的demo

内网开放(需要节点之间能访问到) ​

端口说明
5001http api 端口 (仅内部局域网开放)
5100tcp 端口 ， 分布式情况下只需内网开放
5200websocket 端口 ，分布式情况下只需内网开放 web im端需要能访问到
5300后台管理系统的端口

验证 ​

  1. 访问http://119.45.229.172:15172/login，随便输入用户名和密码，登录后可以聊天，说明部署成功。

  2. 访问 http://119.45.229.172:15300/web 可以进入后台管理系统 默认系统内置的guest只有读权限，如果需要操作权限，请看授权的配置 。

本文档内容版权属于 上海信必达网络科技有限公司，保留所有权利

Copyright © 2023 | Powered by WuKongIM | ICP备案号：沪ICP备2021032718号-2