docs: add openim scripts deployment system

Signed-off-by: Xinwei Xiong(cubxxw) <3293172751nss@gmail.com>

.env

@@ -30,11 +30,18 @@ MINIO_ENDPOINT=http://172.28.0.1:10005
 
 # Base URL for the application programming interface (API).
 # Default: API_URL=http://172.28.0.1:10002
-API_URL=http://127.0.0.1:10002
+API_URL=http://14.155.86.214:10002
 
 # Directory path for storing data files or related information.
 # Default: DATA_DIR=./
-DATA_DIR=./
+DATA_DIR=/root/workspaces/openim/Open-IM-Server
+
+# Choose the appropriate image address, the default is GITHUB image, 
+# you can choose docker hub, for Chinese users can choose Ali Cloud
+# export IMAGE_REGISTRY="ghcr.io/openimsdk"
+# export IMAGE_REGISTRY="openim"
+# export IMAGE_REGISTRY="registry.cn-hangzhou.aliyuncs.com/openimsdk"
+IMAGE_REGISTRY=ghcr.io/openimsdk
 
 # ======================================
 # ========= Network Configuration ======

Makefile

@@ -73,9 +73,9 @@ gen:
 demo:
 	@$(MAKE) go.demo
 
-## versionchecker: Check version of openim. ✨
+## version: Check version of openim. ✨
-.PHONY: versionchecker
+.PHONY: version
-versionchecker:
+version:
 	@$(MAKE) go.versionchecker
 
 ## build: Build binaries by default ✨

config/config.yaml

@@ -19,6 +19,9 @@
 # --| target: config/config.yaml
 # -----------------------------------------------------------------
 
+envs:
+  discovery: zookeeper
+
 ###################### Zookeeper ######################
 # Zookeeper configuration
 # It's not recommended to modify the schema
@@ -26,9 +29,6 @@
 # Zookeeper address
 # Zookeeper username
 # Zookeeper password
-envs:
-  discovery: zookeeper
-
 zookeeper:
   schema: openim
   address: [ 172.28.0.1:12181 ]
@@ -135,14 +135,14 @@ api:
 # minio.signEndpoint is minio public network address
 object:
   enable: "minio"
-  apiURL: "http://127.0.0.1:10002"
+  apiURL: "http://14.155.86.214:10002"
   minio:
     bucket: "openim"
     endpoint: "http://172.28.0.1:10005"
     accessKeyID: "root"
     secretAccessKey: "openIM123"
     sessionToken: ''
-    signEndpoint: "http://127.0.0.1:10005"
+    signEndpoint: "http://14.155.86.214:10005"
     publicRead: false
   cos:
     bucketURL: https://temp-1252357374.cos.ap-chengdu.myqcloud.com
@@ -168,7 +168,6 @@ rpcPort:
   openImUserPort: [ 10110 ]
   openImFriendPort: [ 10120 ]
   openImMessagePort: [ 10130 ]
-  openImMessageGatewayPort: [ 10140 ]
   openImGroupPort: [ 10150 ]
   openImAuthPort: [ 10160 ]
   openImPushPort: [ 10170 ]
@@ -199,7 +198,7 @@ rpcRegisterName:
 # Whether to output in json format
 # Whether to include stack trace in logs
 log:
-  storageLocation: ../../logs/
+  storageLocation: /root/workspaces/openim/Open-IM-Server/logs/
   rotationTime: 24
   remainRotationCount: 2
   remainLogLevel: 6
@@ -216,8 +215,8 @@ log:
 # Websocket connection handshake timeout
 longConnSvr:
   openImWsPort: [ 10001 ]
-  openImMessageGatewayPort: [ 10140 ]
   websocketMaxConnNum: 100000
+  openImMessageGatewayPort: [ 10140 ]
   websocketMaxMsgLen: 4096
   websocketTimeout: 10
 

deployments/README.md

@@ -1,52 +1,48 @@
-# OpenIM 应用容器化部署指南
+# OpenIM Application Containerization Deployment Guide
 
-OpenIM 支持很多种集群化部署方式，包括但不限于 helm, sealos, kubeam, kubesphere, kubeflow, kuboard, kubespray, k3s, k3d, k3c, k3sup, k3v, k3x
+OpenIM supports a variety of cluster deployment methods, including but not limited to `helm`, `sealos`, `kustomize`
 
-**目前还在开发这个模块，预计 v3.2.0 之前会有一个集群方案。**
+Various contributors, as well as previous official releases, have provided some referenceable solutions:
 
-目前各个贡献者，以及之前的官方有出过一些可以参考的方案：
++ [k8s-jenkins Repository](https://github.com/OpenIMSDK/k8s-jenkins)
++ [open-im-server-k8s-deploy Repository](https://github.com/openimsdk/open-im-server-k8s-deploy)
++ [openim-charts Repository](https://github.com/OpenIMSDK/openim-charts)
++ [deploy-openim Repository](https://github.com/showurl/deploy-openim)
 
-- https://github.com/OpenIMSDK/k8s-jenkins
+### Dependency Check
-- https://github.com/openimsdk/open-im-server-k8s-deploy
-- https://github.com/OpenIMSDK/openim-charts
-- https://github.com/showurl/deploy-openim
-
-
-### 依赖检查
 
 ```bash
 Kubernetes: >= 1.16.0-0
 Helm: >= 3.0
 ```
 
+### Minimum Configuration
 
-### 最低配置
+The recommended minimum configuration for a production environment is as follows:
-
-建议生产环境的最低配置如下：
 
-```bash
+```yaml
 CPU: 4
 Memory: 8G
 Disk: 100G
 ```
 
-## 生成配置文件
+## Configuration File Generation
 
-我们将自动文件全部自动化处理了，所以生成配置文件对于 openim 来说是可选的，但是如果你想要自定义配置，可以参考下面的步骤：
+We have automated all the files, making the generation of configuration files optional for OpenIM. However, if you desire custom configurations, you can follow the steps below:
 
 ```bash
 $ make init
-# 或者是使用脚本:
+# Alternatively, use script:
 # ./scripts/init-config.sh
 ```
-此时会帮你在 `deployments/openim/config` 目录下生成配置文件，你可以根据自己的需求进行修改。
 
+At this point, configuration files will be generated under `deployments/openim/config`, which you can modify as per your requirements.
 
-## 集群搭建
+## Cluster Setup
 
-如果你已经有了一个 `kubernetes` 集群，或者是你希望自己从头开始搭建一个 `kubernetes` 那么你可以直接跳过这一步。
+If you already have a `kubernetes` cluster, or if you wish to build a `kubernetes` cluster from scratch, you can skip this step.
 
-为了快速开始，我使用 [sealos](https://github.com/labring/sealos) 来快速搭建集群，sealos 底层也是对 kubeadm 的封装:
+For a quick start, I used [sealos](https://github.com/labring/sealos) to rapidly set up the cluster, with sealos also being a wrapper for kubeadm at its core:
 
 ```bash
 $ SEALOS_VERSION=`curl -s https://api.github.com/repos/labring/sealos/releases/latest | grep -oE '"tag_name": "[^"]+"' | head -n1 | cut -d'"' -f4` && \
@@ -54,21 +50,20 @@ $ SEALOS_VERSION=`curl -s https://api.github.com/repos/labring/sealos/releases/l
   sh -s ${SEALOS_VERSION} labring/sealos
 ```
 
-**支持的版本：**
+**Supported Versions:**
 
 + docker: `labring/kubernetes-docker`:(v1.24.0~v1.27.0)
 + containerd: `labring/kubernetes`:(v1.24.0~v1.27.0)
 
+#### Cluster Installation:
 
-#### 安装集群：
+Cluster details are as follows:
-
-集群的信息如下：
 
-| 机器名   | IP地址          | 系统信息                                                                                                    |
+| Hostname | IP Address | System Info                                                  |
-|---------|-----------------|------------------------------------------------------------------------------------------------------------|
+| -------- | ---------- | ------------------------------------------------------------ |
-| master01| 10.0.0.9   | Linux VM-0-9-ubuntu 5.15.0-76-generic #83-Ubuntu SMP Thu Jun 15 19:16:32 UTC 2023 x86_64 x86_64 x86_64 GNU/Linux |
+| master01 | 10.0.0.9   | `Linux VM-0-9-ubuntu 5.15.0-76-generic #83-Ubuntu SMP Thu Jun 15 19:16:32 UTC 2023 x86_64 x86_64 x86_64 GNU/Linux` |
-| node01  | 10.0.0.4   | Linux VM-0-9-ubuntu 5.15.0-76-generic #83-Ubuntu SMP Thu Jun 15 19:16:32 UTC 2023 x86_64 x86_64 x86_64 GNU/Linux |
+| node01   | 10.0.0.4   | Similar to master01                                          |
-| node02  | 10.0.0.10  | Linux VM-0-9-ubuntu 5.15.0-76-generic #83-Ubuntu SMP Thu Jun 15 19:16:32 UTC 2023 x86_64 x86_64 x86_64 GNU/Linux |
+| node02   | 10.0.0.10  | Similar to master01                                          |
 
 ```bash
 $ export CLUSTER_USERNAME=ubuntu
@@ -80,50 +75,41 @@ $ sudo sealos run labring/kubernetes:v1.25.0 labring/helm:v3.8.2 labring/calico:
     -p "$CLUSTER_PASSWORD"
 ```
 
-> **Node**
+> **Node** Uninstallation method: using `kubeadm` for uninstallation does not remove `etcd` and `cni` related configurations. Manual clearance or using `sealos` for uninstallation is needed.
-> 卸载的方式：使用 `kubeadm` 卸载并不会清除 `etcd` 和 `cni` 相关，所以需要手动清除，或者使用 `sealos` 卸载。
+>
 > ```bash
-> sealos reset
+> $ sealos reset
 > ```
 
-### 安装 helm
+### Installing helm
 
-helm通过打包的方式，支持发布的版本管理和控制，很大程度上简化了Kubernetes应用的部署和管理。
+Helm simplifies the deployment and management of Kubernetes applications to a large extent by offering version control and release management through packaging.
 
-
+**Using Script:**
-**使用脚本：**
 
 ```bash
 $ curl https://raw.githubusercontent.com/helm/helm/main/scripts/get-helm-3 | bash
 ```
 
-**Helm Version:**
+**Adding Repository:**
-
-```bash
-$ helm version 
-version.BuildInfo{Version:"v3.13.1", GitCommit:"3547a4b5bf5edb5478ce352e18858d8a552a4110", GitTreeState:"clean", GoVersion:"go1.20.8"}
-``
-
-**添加仓库：**
 
 ```bash
 $ helm repo add brigade https://openimsdk.github.io/openim-charts
 ```
 
-### OpenIM 的镜像策略
+### OpenIM Image Strategy
 
-自动化提供的 aliyun, ghcr, docker hub: https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/images.md
+Automated offerings include aliyun, ghcr, docker hub: [Image Documentation](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/images.md)
 
-**本地化测试构建方法：**
+**Local Test Build Method:**
 
 ```bash
 $ make image
 ```
 
+> This command assists in quickly building the required images locally. For a detailed build strategy, refer to the [Build Documentation](https://github.com/openimsdk/open-im-server/blob/main/build/README.md).
 
-### 容器化安装
+## Installation
 
-具体安装步骤如下：
+Explore our Helm-Charts repository and read through: [Helm-Charts Repository](https://github.com/openimsdk/helm-charts)
 
-> **Note**
-> 针对中国的用户，阅读我们的 [Docker 镜像标准](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/images.md) 以便使用国内 aliyun 的镜像地址。OpenIM 也有针对中国的 gitee 同步仓库，你可以在 [gitee.com](https://gitee.com/openimsdk) 上找到它。

deployments/templates/init/README.md

@@ -1,220 +0,0 @@
-# Systemd Configuration, Installation, and Startup
-
-- [Systemd Configuration, Installation, and Startup](#systemd-configuration-installation-and-startup)
-  - [1. Introduction](#1-introduction)
-  - [2. Prerequisites (Requires root permissions)](#2-prerequisites-requires-root-permissions)
-  - [3. Create `openim-api` systemd unit template file](#3-create-openim-api-systemd-unit-template-file)
-  - [4. Copy systemd unit template file to systemd config directory (Requires root permissions)](#4-copy-systemd-unit-template-file-to-systemd-config-directory-requires-root-permissions)
-  - [5. Start systemd service](#5-start-systemd-service)
-
-## 1. Introduction
-
-Systemd is the default service management form for the latest Linux distributions, replacing the original init.
-
-Format introduction:
-
-```bash
-[Unit] : Unit of the service
-
-Description: Brief description of the service
-
-[Service]: Configuration of the service's runtime behavior
-
-ExecStart: Complete path of the program
-
-Restart: Restart configurations like no, always, on-success, on-failure, on-abnormal, on-abort, on-watchdog
-
-[Install]: Installation configuration
-
-WantedBy: Multi-user, etc.
-```
-
-For more details, refer to: [Systemd Service Manual](https://www.freedesktop.org/software/systemd/man/systemd.service.html)
-
-Starting command:
-
-```bash
-systemctl daemon-reload && systemctl enable openim-api && systemctl restart openim-api
-```
-
-Service status:
-
-```bash
-systemctl status openim-api
-```
-
-Stop command:
-
-```bash
-systemctl stop openim-api
-```
-
-More command:
-```bash
-# 列出正在运行的Unit,可以直接使用systemctl
-systemctl list-units
-
-# 列出所有Unit，包括没有找到配置文件的或者启动失败的
-systemctl list-units --all
-
-# 列出所有没有运行的 Unit
-systemctl list-units --all --state=inactive
-
-# 列出所有加载失败的 Unit
-systemctl list-units --failed
-
-# 列出所有正在运行的、类型为service的Unit
-systemctl list-units --type=service
-
-# 显示某个 Unit 是否正在运行
-systemctl is-active application.service
-
-# 显示某个 Unit 是否处于启动失败状态
-systemctl is-failed application.service
-
-# 显示某个 Unit 服务是否建立了启动链接
-systemctl is-enabled application.service
-
-# 立即启动一个服务
-sudo systemctl start apache.service
-
-# 立即停止一个服务
-sudo systemctl stop apache.service
-
-# 重启一个服务
-sudo systemctl restart apache.service
-
-# 重新加载一个服务的配置文件
-sudo systemctl reload apache.service
-
-# 重载所有修改过的配置文件
-sudo systemctl daemon-reload
-```
-
-**Why choose systemd?**
-
-**Advanced requirements:**
-
-- Convenient service runtime log recording for problem analysis
-- Service management logs
-- Option to restart upon abnormal exit
-
-The daemon does not meet these advanced requirements.
-
-`nohup` only logs the service's runtime outputs and errors.
-
-Only systemd can fulfill all of the above requirements.
-
-> The default logs are enhanced with timestamps, usernames, service names, PIDs, etc., making them user-friendly. You can view logs of abnormal service exits. Advanced customization is possible through the configuration files in `/lib/systemd/system/`.
-
-In short, systemd is the current mainstream way to manage backend services on Linux, so I've abandoned `nohup` in my new versions of bash scripts, opting instead for systemd.
-
-## 2. Prerequisites (Requires root permissions)
-
-1. Configure `environment.sh` based on the comments.
-2. Create a data directory:
-
-```bash
-mkdir -p ${OPENIM_DATA_DIR}/{openim-api,openim-crontask}
-```
-
-3. Create a bin directory and copy `openim-api` and `openim-crontask` executable files:
-
-```bash
-source ./environment.sh
-mkdir -p ${OPENIM_INSTALL_DIR}/bin
-cp openim-api openim-crontask ${OPENIM_INSTALL_DIR}/bin
-```
-
-4. Copy the configuration files of `openim-api` and `openim-crontask` to the `${OPENIM_CONFIG_DIR}` directory:
-
-```bash
-mkdir -p ${OPENIM_CONFIG_DIR}
-cp openim-api.yaml openim-crontask.yaml ${OPENIM_CONFIG_DIR}
-```
-
-## 3. Create `openim-api` systemd unit template file
-
-For each OpenIM service, we will create a systemd unit template. Follow the steps below for each service:
-
-Run the following shell script to generate the `openim-api.service.template`:
-
-```bash
-source ./environment.sh
-cat > openim-api.service.template <<EOF
-[Unit]
-Description=OpenIM Server API
-Documentation=https://github.com/oepnimsdk/open-im-server/blob/master/init/README.md
-
-[Service]
-WorkingDirectory=${OPENIM_DATA_DIR}/openim-api
-ExecStart=${OPENIM_INSTALL_DIR}/bin/openim-api --config=${OPENIM_CONFIG_DIR}/openim-api.yaml
-Restart=always
-RestartSec=5
-StartLimitInterval=0
-
-[Install]
-WantedBy=multi-user.target
-EOF
-```
-
-Following the above style, create the respective template files or generate them in bulk:
-
-First, make sure you've sourced the environment variables:
-
-```bash
-source ./environment.sh
-```
-
-Use the shell script to generate the systemd unit template for each service:
-
-```bash
-declare -a services=(
-"openim-api"
-... [other services]
-)
-
-for service in "${services[@]}"
-do
-   cat > $service.service.template <<EOF
-[Unit]
-Description=OpenIM Server - $service
-Documentation=https://github.com/oepnimsdk/open-im-server/blob/master/init/README.md
-
-[Service]
-WorkingDirectory=${OPENIM_DATA_DIR}/$service
-ExecStart=${OPENIM_INSTALL_DIR}/bin/$service --config=${OPENIM_CONFIG_DIR}/$service.yaml
-Restart=always
-RestartSec=5
-StartLimitInterval=0
-
-[Install]
-WantedBy=multi-user.target
-EOF
-done
-```
-
-## 4. Copy systemd unit template file to systemd config directory (Requires root permissions)
-
-Ensure you have root permissions to perform this operation:
-
-```bash
-for service in "${services[@]}"
-do
-   sudo cp $service.service.template /etc/systemd/system/$service.service
-done
-...
-```
-
-## 5. Start systemd service
-
-To start the OpenIM services:
-
-```bash
-for service in "${services[@]}"
-do
-   sudo systemctl daemon-reload 
-   sudo systemctl enable $service 
-   sudo systemctl restart $service
-done
-```

deployments/templates/init/openim-api.service

@@ -1,16 +0,0 @@
-[Unit]
-Description=OPENIM OPENIM API
-Documentation=Control interface for the OpenIM API service.
-Documentation=https://github.com/openimsdk/open-im-server/blob/main/deployment/init/README.md
-
-[Service]
-WorkingDirectory=${OPENIM_DATA_DIR}/openim-api
-ExecStartPre=/usr/bin/mkdir -p ${OPENIM_DATA_DIR}/openim-api
-ExecStartPre=/usr/bin/mkdir -p ${OPENIM_LOG_DIR}
-ExecStart=${OPENIM_INSTALL_DIR}/bin/openim-api --config=${OPENIM_CONFIG_DIR}/openim-api.yaml
-Restart=always
-RestartSec=5
-StartLimitInterval=0
-
-[Install]
-WantedBy=multi-user.target

deployments/templates/init/openim-cmdutils.service

@@ -1,16 +0,0 @@
-[Unit]
-Description=OPENIM OPENIM CMDUTILS
-Documentation=Utility toolkit for common OpenIM command-line operations.
-Documentation=https://github.com/openimsdk/open-im-server/blob/main/deployment/init/README.md
-
-[Service]
-WorkingDirectory=${OPENIM_DATA_DIR}/openim-cmdutils
-ExecStartPre=/usr/bin/mkdir -p ${OPENIM_DATA_DIR}/openim-cmdutils
-ExecStartPre=/usr/bin/mkdir -p ${OPENIM_LOG_DIR}
-ExecStart=${OPENIM_INSTALL_DIR}/bin/openim-cmdutils --config=${OPENIM_CONFIG_DIR}/openim-cmdutils.yaml
-Restart=always
-RestartSec=5
-StartLimitInterval=0
-
-[Install]
-WantedBy=multi-user.target

deployments/templates/init/openim-crontask.service

@@ -1,16 +0,0 @@
-[Unit]
-Description=OPENIM OPENIM CRONTASK
-Documentation=Manages the OpenIM CronTask service, with both direct and systemctl installation methods.
-Documentation=https://github.com/openimsdk/open-im-server/blob/main/deployment/init/README.md
-
-[Service]
-WorkingDirectory=${OPENIM_DATA_DIR}/openim-crontask
-ExecStartPre=/usr/bin/mkdir -p ${OPENIM_DATA_DIR}/openim-crontask
-ExecStartPre=/usr/bin/mkdir -p ${OPENIM_LOG_DIR}
-ExecStart=${OPENIM_INSTALL_DIR}/bin/openim-crontask -c=${OPENIM_CONFIG_DIR}
-Restart=always
-RestartSec=5
-StartLimitInterval=0
-
-[Install]
-WantedBy=multi-user.target

deployments/templates/init/openim-msggateway.service

@@ -1,15 +0,0 @@
-[Unit]
-Description=OPENIM OPENIM MSGGATEWAY
-Documentation=https://github.com/openimsdk/open-im-server/blob/main/deployment/init/README.md
-
-[Service]
-WorkingDirectory=${OPENIM_DATA_DIR}/openim-msggateway
-ExecStartPre=/usr/bin/mkdir -p ${OPENIM_DATA_DIR}/openim-msggateway
-ExecStartPre=/usr/bin/mkdir -p ${OPENIM_LOG_DIR}
-ExecStart=${OPENIM_INSTALL_DIR}/bin/openim-msggateway --config=${OPENIM_CONFIG_DIR}/openim-msggateway.yaml
-Restart=always
-RestartSec=5
-StartLimitInterval=0
-
-[Install]
-WantedBy=multi-user.target

deployments/templates/init/openim-msgtransfer.service

@@ -1,15 +0,0 @@
-[Unit]
-Description=OPENIM OPENIM MSGTRANSFER
-Documentation=https://github.com/openimsdk/open-im-server/blob/main/deployment/init/README.md
-
-[Service]
-WorkingDirectory=${OPENIM_DATA_DIR}/openim-msgtransfer
-ExecStartPre=/usr/bin/mkdir -p ${OPENIM_DATA_DIR}/openim-msgtransfer
-ExecStartPre=/usr/bin/mkdir -p ${OPENIM_LOG_DIR}
-ExecStart=${OPENIM_INSTALL_DIR}/bin/openim-msgtransfer --config=${OPENIM_CONFIG_DIR}/openim-msgtransfer.yaml
-Restart=always
-RestartSec=5
-StartLimitInterval=0
-
-[Install]
-WantedBy=multi-user.target

deployments/templates/init/openim-push.service

@@ -1,16 +0,0 @@
-[Unit]
-Description=OPENIM OPENIM PUSH
-Documentation=Interface for controlling the OpenIM Push Notification service.
-Documentation=https://github.com/openimsdk/open-im-server/blob/main/deployment/init/README.md
-
-[Service]
-WorkingDirectory=${OPENIM_DATA_DIR}/openim-push
-ExecStartPre=/usr/bin/mkdir -p ${OPENIM_DATA_DIR}/openim-push
-ExecStartPre=/usr/bin/mkdir -p ${OPENIM_LOG_DIR}
-ExecStart=${OPENIM_INSTALL_DIR}/bin/openim-push --port ${OPENIM_PUSH_PORT} --prometheus_port ${PUSH_PROM_PORT}
-Restart=always
-RestartSec=5
-StartLimitInterval=0
-
-[Install]
-WantedBy=multi-user.target

deployments/templates/init/openim-rpc.service

@@ -1,15 +0,0 @@
-[Unit]
-Description=OPENIM OPENIM RPC AUTH
-Documentation=https://github.com/openimsdk/open-im-server/blob/main/deployment/init/README.md
-
-[Service]
-WorkingDirectory=${OPENIM_DATA_DIR}/openim-rpc-auth
-ExecStartPre=/usr/bin/mkdir -p ${OPENIM_DATA_DIR}/openim-rpc-auth
-ExecStartPre=/usr/bin/mkdir -p ${OPENIM_LOG_DIR}
-ExecStart=${OPENIM_INSTALL_DIR}/bin/openim-rpc-auth --config=${OPENIM_CONFIG_DIR}/openim-rpc-auth.yaml
-Restart=always
-RestartSec=5
-StartLimitInterval=0
-
-[Install]
-WantedBy=multi-user.target

deployments/templates/openim.service

@@ -0,0 +1,13 @@
+[Unit]
+Description=${SERVER_NAME} for OpenIM
+Documentation=https://github.com/openimsdk/open-im-server/blob/main/deployment/init/README.md
+
+[Service]
+WorkingDirectory=${OPENIM_DATA_DIR}
+ExecStart=${OPENIM_INSTALL_DIR}/${SERVER_NAME} -c ${OPENIM_CONFIG_DIR}
+Restart=always
+RestartSec=5
+StartLimitInterval=0
+
+[Install]
+WantedBy=multi-user.target

deployments/templates/openim.yaml

@@ -168,7 +168,6 @@ rpcPort:
   openImUserPort: [ ${OPENIM_USER_PORT} ]
   openImFriendPort: [ ${OPENIM_FRIEND_PORT} ]
   openImMessagePort: [ ${OPENIM_MESSAGE_PORT} ]
-  openImMessageGatewayPort: [ ${OPENIM_MESSAGE_GATEWAY_PORT} ]
   openImGroupPort: [ ${OPENIM_GROUP_PORT} ]
   openImAuthPort: [ ${OPENIM_AUTH_PORT} ]
   openImPushPort: [ ${OPENIM_PUSH_PORT} ]
@@ -217,6 +216,7 @@ log:
 longConnSvr:
   openImWsPort: [ ${OPENIM_WS_PORT} ]
   websocketMaxConnNum: ${WEBSOCKET_MAX_CONN_NUM}
+  openImMessageGatewayPort: [ ${OPENIM_MESSAGE_GATEWAY_PORT} ]
   websocketMaxMsgLen: ${WEBSOCKET_MAX_MSG_LEN}
   websocketTimeout: ${WEBSOCKET_TIMEOUT}
 

docs/conversions/version.md

@@ -7,6 +7,7 @@
   - [Tag Management: The Cornerstone of Version Control](#tag-management-the-cornerstone-of-version-control)
   - [Release Management: A Guided Tour](#release-management-a-guided-tour)
   - [Milestones, Branching, and Addressing Major Bugs](#milestones-branching-and-addressing-major-bugs)
+  - [Version Skew Policy](#version-skew-policy)
   - [Applying Principles: A Git Workflow Example](#applying-principles-a-git-workflow-example)
   - [Docker Images Version Management](#docker-images-version-management)
 
@@ -77,6 +78,97 @@ When dealing with major bugs, we selectively merge the fix into the affected ver
 
 We reinforce our approach to branch management and versioning with stringent testing protocols. Automated tests and code review sessions form vital components of maintaining a robust and reliable codebase.
 
+## Version Skew Policy
+
+This document describes the maximum version skew supported between various openim components. Specific cluster deployment tools may place additional restrictions on version skew.
+
+
+### Supported version skew
+
+In highly-available (HA) clusters, the newest and oldest `openim-api` instances must be within one minor version.
+
+### OpenIM Versioning, Branching, and Tag Strategy
+
+Similar to Kubernetes, OpenIM has a strict versioning, branching, and tag strategy to ensure compatibility among its various services and components. This document outlines the policies, especially focusing on the version skew supported between OpenIM's components. Given that the current version is v3.3, the policy references will be centered around this version.
+
+#### Supported Version Skew
+
+##### openim-api
+
+In highly-available (HA) clusters, the newest and oldest `openim-api` instances must be within one minor version.
+
+Example:
+
++ Newest `openim-api` is at v3.3
++ Other `openim-api` instances are supported at v3.3 and v3.2
+
+##### openim-rpc-* Components
+
+All `openim-rpc-*` components (e.g., `openim-rpc-auth`, `openim-rpc-conversation`, etc.) should adhere to the following rules:
+
+1. They must not be newer than `openim-api`.
+2. They may be up to one minor version older than `openim-api`.
+
+Example:
+
++ `openim-api` is at v3.3
++ All `openim-rpc-*` components are supported at v3.3 and v3.2
+
+Note: If version skew exists between `openim-api` instances in an HA cluster, this narrows the allowed `openim-rpc-*` components versions.
+
+##### Other OpenIM Services
+
+Other OpenIM services such as `openim-cmdutils`, `openim-crontask`, `openim-msggateway`, etc. should adhere to the following rules:
+
+1. These services must not be newer than `openim-api`.
+2. They are expected to match the `openim-api` minor version but may be up to one minor version older (to allow live upgrades).
+
+Example:
+
++ `openim-api` is at v3.3
++ `openim-msggateway`, `openim-cmdutils`, and other services are supported at v3.3 and v3.2
+
+#### Supported Component Upgrade Order
+
+The version skew policy has implications on the order in which components should be upgraded. Below is the recommended order to transition an existing cluster from version v3.2 to v3.3:
+
+##### openim-api
+
+Pre-requisites:
+
+1. In a single-instance cluster, the existing `openim-api` instance is v3.2.
+2. In an HA cluster, all `openim-api` instances are at v3.2 or v3.3.
+3. All `openim-rpc-*` and other OpenIM services communicating with this server are at version v3.2.
+
+Upgrade Procedure:
+
+1. Upgrade `openim-api` to v3.3.
+
+##### openim-rpc-* Components
+
+Pre-requisites:
+
+1. The `openim-api` instances these components communicate with are at v3.3.
+
+Upgrade Procedure:
+
+2. Upgrade all `openim-rpc-*` components to v3.3.
+
+##### Other OpenIM Services
+
+Pre-requisites:
+
+1. The `openim-api` instances these services communicate with are at v3.3.
+
+Upgrade Procedure:
+
+2. Upgrade other OpenIM services such as `openim-msggateway`, `openim-cmdutils`, etc., to v3.3.
+
+#### Conclusion
+
+Just like Kubernetes, it's essential for OpenIM to have a strict versioning and upgrade policy to ensure seamless operation and compatibility among its various services. Adhering to the policies outlined above will help in achieving this goal.
+
+
 ## Applying Principles: A Git Workflow Example
 
 The workflow to address a bug fix might follow these steps:

go.mod

@@ -65,6 +65,8 @@ require (
 	github.com/eapache/go-resiliency v1.4.0 // indirect
 	github.com/eapache/go-xerial-snappy v0.0.0-20230731223053-c322873962e3 // indirect
 	github.com/eapache/queue v1.1.0 // indirect
+	github.com/emirpasic/gods v1.12.0 // indirect
+	github.com/fatih/color v1.15.0 // indirect
 	github.com/gabriel-vasile/mimetype v1.4.2 // indirect
 	github.com/gin-contrib/sse v0.1.0 // indirect
 	github.com/go-playground/universal-translator v0.18.1 // indirect
@@ -79,6 +81,7 @@ require (
 	github.com/hashicorp/go-multierror v1.1.1 // indirect
 	github.com/hashicorp/go-uuid v1.0.3 // indirect
 	github.com/inconshreveable/mousetrap v1.1.0 // indirect
+	github.com/jbenet/go-context v0.0.0-20150711004518-d14ea06fba99 // indirect
 	github.com/jcmturner/aescts/v2 v2.0.0 // indirect
 	github.com/jcmturner/dnsutils/v2 v2.0.0 // indirect
 	github.com/jcmturner/gofork v1.7.6 // indirect
@@ -87,13 +90,16 @@ require (
 	github.com/jinzhu/inflection v1.0.0 // indirect
 	github.com/jinzhu/now v1.1.5 // indirect
 	github.com/json-iterator/go v1.1.12 // indirect
+	github.com/kevinburke/ssh_config v0.0.0-20190725054713-01f96b0aa0cd // indirect
 	github.com/klauspost/compress v1.16.7 // indirect
 	github.com/klauspost/cpuid/v2 v2.2.5 // indirect
 	github.com/leodido/go-urn v1.2.4 // indirect
 	github.com/lithammer/shortuuid v3.0.0+incompatible // indirect
+	github.com/mattn/go-colorable v0.1.13 // indirect
 	github.com/matttproud/golang_protobuf_extensions v1.0.4 // indirect
 	github.com/minio/md5-simd v1.1.2 // indirect
 	github.com/minio/sha256-simd v1.0.1 // indirect
+	github.com/mitchellh/go-homedir v1.1.0 // indirect
 	github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect
 	github.com/modern-go/reflect2 v1.0.2 // indirect
 	github.com/montanaflynn/stats v0.0.0-20171201202039-1bf9dbcd8cbe // indirect
@@ -108,8 +114,11 @@ require (
 	github.com/prometheus/procfs v0.11.1 // indirect
 	github.com/rcrowley/go-metrics v0.0.0-20201227073835-cf1acfcdf475 // indirect
 	github.com/rs/xid v1.5.0 // indirect
+	github.com/sergi/go-diff v1.0.0 // indirect
 	github.com/spf13/pflag v1.0.5 // indirect
+	github.com/src-d/gcfg v1.4.0 // indirect
 	github.com/twitchyliquid64/golang-asm v0.15.1 // indirect
+	github.com/xanzy/ssh-agent v0.2.1 // indirect
 	github.com/xdg-go/pbkdf2 v1.0.0 // indirect
 	github.com/xdg-go/scram v1.1.2 // indirect
 	github.com/xdg-go/stringprep v1.0.4 // indirect
@@ -128,7 +137,10 @@ require (
 	google.golang.org/appengine v1.6.7 // indirect
 	google.golang.org/genproto v0.0.0-20231002182017-d307bd883b97 // indirect
 	google.golang.org/genproto/googleapis/api v0.0.0-20231002182017-d307bd883b97 // indirect
-	google.golang.org/genproto/googleapis/rpc v0.0.0-20231012201019-e917dd12ba7a // indirect
+	google.golang.org/genproto/googleapis/rpc v0.0.0-20231009173412-8bfb1ae86b6c // indirect
+	gopkg.in/src-d/go-billy.v4 v4.3.2 // indirect
+	gopkg.in/src-d/go-git.v4 v4.13.1 // indirect
+	gopkg.in/warnings.v0 v0.1.2 // indirect
 )
 
 require (

go.sum

@@ -23,8 +23,11 @@ github.com/OpenIMSDK/protocol v0.0.30/go.mod h1:F25dFrwrIx3lkNoiuf6FkCfxuwf8L4Z8
 github.com/OpenIMSDK/tools v0.0.14 h1:WLof/+WxyPyRST+QkoTKubYCiV73uCLiL8pgnpH/yKQ=
 github.com/OpenIMSDK/tools v0.0.14/go.mod h1:eg+q4A34Qmu73xkY0mt37FHGMCMfC6CtmOnm0kFEGFI=
 github.com/QcloudApi/qcloud_sign_golang v0.0.0-20141224014652-e4130a326409/go.mod h1:1pk82RBxDY/JZnPQrtqHlUFfCctgdorsd9M06fMynOM=
+github.com/alcortesm/tgz v0.0.0-20161220082320-9c5fe88206d7/go.mod h1:6zEj6s6u/ghQa61ZWa/C2Aw3RkjiTBOix7dkqa1VLIs=
 github.com/aliyun/aliyun-oss-go-sdk v2.2.9+incompatible h1:Sg/2xHwDrioHpxTN6WMiwbXTpUEinBpHsN7mG21Rc2k=
 github.com/aliyun/aliyun-oss-go-sdk v2.2.9+incompatible/go.mod h1:T/Aws4fEfogEE9v+HPhhw+CntffsBHJ8nXQCwKr0/g8=
+github.com/anmitsu/go-shlex v0.0.0-20161002113705-648efa622239/go.mod h1:2FmKhYUyUczH0OGQWaF5ceTx0UBShxjsH6f8oGKYe2c=
+github.com/armon/go-socks5 v0.0.0-20160902184237-e75332964ef5/go.mod h1:wHh0iHkYZB8zMSxRWpUBQtwG5a7fFgvEO+odwuTv2gs=
 github.com/benbjohnson/clock v1.1.0 h1:Q92kusRqC1XV2MjkWETPvjJVqKetz1OzxZB7mHJLju8=
 github.com/beorn7/perks v1.0.1 h1:VlbKKnNfV8bJzeqoa4cOKqO6bYr3WgKZxO8Z16+hsOM=
 github.com/beorn7/perks v1.0.1/go.mod h1:G2ZrVWU2WbWT9wwq4/hrbKbnv/1ERSJQ0ibhJ6rlkpw=
@@ -49,6 +52,7 @@ github.com/clbanning/mxj v1.8.4/go.mod h1:BVjHeAH+rl9rs6f+QIpeRl0tfu10SXn1pUSa5P
 github.com/client9/misspell v0.3.4/go.mod h1:qj6jICC3Q7zFZvVWo7KLAzC3yx5G7kyvSDkc90ppPyw=
 github.com/cncf/udpa/go v0.0.0-20191209042840-269d4d468f6f/go.mod h1:M8M6+tZqaGXZJjfX53e64911xZQV5JYwmTeXPW+k8Sc=
 github.com/cpuguy83/go-md2man/v2 v2.0.2/go.mod h1:tgQtvFlXSQOSOSIRvRPT7W67SCa46tRHOmNcaadrF8o=
+github.com/creack/pty v1.1.7/go.mod h1:lj5s0c3V2DBrqTV7llrYr5NG6My20zk30Fl46Y7DoTY=
 github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
 github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
@@ -65,10 +69,15 @@ github.com/eapache/go-xerial-snappy v0.0.0-20230731223053-c322873962e3 h1:Oy0F4A
 github.com/eapache/go-xerial-snappy v0.0.0-20230731223053-c322873962e3/go.mod h1:YvSRo5mw33fLEx1+DlK6L2VV43tJt5Eyel9n9XBcR+0=
 github.com/eapache/queue v1.1.0 h1:YOEu7KNc61ntiQlcEeUIoDTJ2o8mQznoNvUhiigpIqc=
 github.com/eapache/queue v1.1.0/go.mod h1:6eCeP0CKFpHLu8blIFXhExK/dRa7WDZfr6jVFPTqq+I=
+github.com/emirpasic/gods v1.12.0 h1:QAUIPSaCu4G+POclxeqb3F+WPpdKqFGlw36+yOzGlrg=
+github.com/emirpasic/gods v1.12.0/go.mod h1:YfzfFFoVP/catgzJb4IKIqXjX78Ha8FMSDh3ymbK86o=
 github.com/envoyproxy/go-control-plane v0.9.0/go.mod h1:YTl/9mNaCwkRvm6d1a2C3ymFceY/DCBVvsKhRF0iEA4=
 github.com/envoyproxy/go-control-plane v0.9.1-0.20191026205805-5f8ba28d4473/go.mod h1:YTl/9mNaCwkRvm6d1a2C3ymFceY/DCBVvsKhRF0iEA4=
 github.com/envoyproxy/go-control-plane v0.9.4/go.mod h1:6rpuAdCZL397s3pYoYcLgu1mIlRU8Am5FuJP05cCM98=
 github.com/envoyproxy/protoc-gen-validate v0.1.0/go.mod h1:iSmxcyjqTsJpI2R4NaDN7+kN2VEUnK/pcBlmesArF7c=
+github.com/fatih/color v1.15.0 h1:kOqh6YHBtK8aywxGerMG2Eq3H6Qgoqeo13Bk2Mv/nBs=
+github.com/fatih/color v1.15.0/go.mod h1:0h5ZqXfHYED7Bhv2ZJamyIOUej9KtShiJESRwBDUSsw=
+github.com/flynn/go-shlex v0.0.0-20150515145356-3f9db97f8568/go.mod h1:xEzjJPgXI435gkrCt3MPfRiAkVrwSbHsst4LCFVfpJc=
 github.com/fortytw2/leaktest v1.3.0 h1:u8491cBMTQ8ft8aeV+adlcytMZylmA5nnwwkRZjI8vw=
 github.com/fsnotify/fsnotify v1.4.7/go.mod h1:jwhsz4b93w/PPRr/qN1Yymfu8t87LnFCMoQvtojpjFo=
 github.com/fsnotify/fsnotify v1.4.9 h1:hsms1Qyu0jgnwNXIxa+/V/PDsU6CfLf6CNO8H7IWoS4=
@@ -79,6 +88,11 @@ github.com/gin-contrib/sse v0.1.0 h1:Y/yl/+YNO8GZSjAhjMsSuLt29uWRFHdHYUb5lYOV9qE
 github.com/gin-contrib/sse v0.1.0/go.mod h1:RHrZQHXnP2xjPF+u1gW/2HnVO7nvIa9PG3Gm+fLHvGI=
 github.com/gin-gonic/gin v1.9.1 h1:4idEAncQnU5cB7BeOkPtxjfCSye0AAm1R0RVIqJ+Jmg=
 github.com/gin-gonic/gin v1.9.1/go.mod h1:hPrL7YrpYKXt5YId3A/Tnip5kqbEAP+KLuI3SUcPTeU=
+github.com/gliderlabs/ssh v0.2.2/go.mod h1:U7qILu1NlMHj9FlMhZLlkCdDnU1DBEAqr0aevW3Awn0=
+github.com/go-delve/delve v1.21.1 h1:oDpED8gvXPLS1VKSYzaMH/ihZtyk04H9jqQ9xpyFXl0=
+github.com/go-delve/delve v1.21.1/go.mod h1:FgTAiRUe43RS5EexL06RPyMtP8AMZVL/t9Qqgy3qUe4=
+github.com/go-delve/liner v1.2.3-0.20220127212407-d32d89dd2a5d h1:pxjSLshkZJGLVm0wv20f/H0oTWiq/egkoJQ2ja6LEvo=
+github.com/go-delve/liner v1.2.3-0.20220127212407-d32d89dd2a5d/go.mod h1:biJCRbqp51wS+I92HMqn5H8/A0PAhxn2vyOT+JqhiGI=
 github.com/go-playground/assert/v2 v2.2.0 h1:JvknZsQTYeFEAhQwI4qEt9cyV5ONwRHC+lYKSsYSR8s=
 github.com/go-playground/locales v0.14.1 h1:EWaQ/wswjilfKLTECiXz7Rh+3BjFhfDFKv/oXslEjJA=
 github.com/go-playground/locales v0.14.1/go.mod h1:hxrqLVvrK65+Rwrd5Fc6F2O76J/NuW9t0sjnWqG1slY=
@@ -165,6 +179,8 @@ github.com/hpcloud/tail v1.0.0/go.mod h1:ab1qPbhIpdTxEkNHXyeSf5vhxWSCs/tWer42PpO
 github.com/ianlancetaylor/demangle v0.0.0-20200824232613-28f6c0f3b639/go.mod h1:aSSvb/t6k1mPoxDqO4vJh6VOCGPwU4O0C2/Eqndh1Sc=
 github.com/inconshreveable/mousetrap v1.1.0 h1:wN+x4NVGpMsO7ErUn/mUI3vEoE6Jt13X2s0bqwp9tc8=
 github.com/inconshreveable/mousetrap v1.1.0/go.mod h1:vpF70FUmC8bwa3OWnCshd2FqLfsEA9PFc4w1p2J65bw=
+github.com/jbenet/go-context v0.0.0-20150711004518-d14ea06fba99 h1:BQSFePA1RWJOlocH6Fxy8MmwDt+yVQYULKfN0RoTN8A=
+github.com/jbenet/go-context v0.0.0-20150711004518-d14ea06fba99/go.mod h1:1lJo3i6rXxKeerYnT8Nvf0QmHCRC1n8sfWVwXF2Frvo=
 github.com/jcmturner/aescts/v2 v2.0.0 h1:9YKLH6ey7H4eDBXW8khjYslgyqG2xZikXP0EQFKrle8=
 github.com/jcmturner/aescts/v2 v2.0.0/go.mod h1:AiaICIRyfYg35RUkr8yESTqvSy7csK90qZ5xfvvsoNs=
 github.com/jcmturner/dnsutils/v2 v2.0.0 h1:lltnkeZGL0wILNvrNiVCR6Ro5PGU/SeBvVO/8c/iPbo=
@@ -177,6 +193,7 @@ github.com/jcmturner/gokrb5/v8 v8.4.4 h1:x1Sv4HaTpepFkXbt2IkL29DXRf8sOfZXo8eRKh6
 github.com/jcmturner/gokrb5/v8 v8.4.4/go.mod h1:1btQEpgT6k+unzCwX1KdWMEwPPkkgBtP+F6aCACiMrs=
 github.com/jcmturner/rpc/v2 v2.0.3 h1:7FXXj8Ti1IaVFpSAziCZWNzbNuZmnvw/i6CqLNdWfZY=
 github.com/jcmturner/rpc/v2 v2.0.3/go.mod h1:VUJYCIDm3PVOEHw8sgt091/20OJjskO/YJki3ELg/Hc=
+github.com/jessevdk/go-flags v1.4.0/go.mod h1:4FA24M0QyGHXBuZZK/XkWh8h0e1EYbRYJSGM75WSRxI=
 github.com/jinzhu/copier v0.4.0 h1:w3ciUoD19shMCRargcpm0cm91ytaBhDvuRpz1ODO/U8=
 github.com/jinzhu/copier v0.4.0/go.mod h1:DfbEm0FYsaqBcKcFuvmOZb218JkPGtvSHsKg8S8hyyg=
 github.com/jinzhu/inflection v1.0.0 h1:K317FqzuhWc8YvSVlFMCCUb36O/S9MCKRDI7QkRKD/E=
@@ -186,6 +203,8 @@ github.com/jinzhu/now v1.1.5/go.mod h1:d3SSVoowX0Lcu0IBviAWJpolVfI5UJVZZ7cO71lE/
 github.com/jonboulle/clockwork v0.4.0 h1:p4Cf1aMWXnXAUh8lVfewRBx1zaTSYKrKMF2g3ST4RZ4=
 github.com/json-iterator/go v1.1.12 h1:PV8peI4a0ysnczrg+LtxykD8LfKY9ML6u2jnxaEnrnM=
 github.com/json-iterator/go v1.1.12/go.mod h1:e30LSqwooZae/UwlEbR2852Gd8hjQvJoHmT4TnhNGBo=
+github.com/kevinburke/ssh_config v0.0.0-20190725054713-01f96b0aa0cd h1:Coekwdh0v2wtGp9Gmz1Ze3eVRAWJMLokvN3QjdzCHLY=
+github.com/kevinburke/ssh_config v0.0.0-20190725054713-01f96b0aa0cd/go.mod h1:CT57kijsi8u/K/BOFA39wgDQJ9CxiF4nAY/ojJ6r6mM=
 github.com/kisielk/errcheck v1.5.0/go.mod h1:pFxgyoBC7bSaBwPgfKdkLd5X25qrDl4LWUI2bnpBCr8=
 github.com/kisielk/gotool v1.0.0/go.mod h1:XhKaO+MFFWcvkIS/tQcRk01m1F5IRFswLeQ+oQHNcck=
 github.com/klauspost/compress v1.13.6/go.mod h1:/3/Vjq9QcHkK5uEr5lBEmyoZ1iFhe47etQ6QUkpK6sk=
@@ -195,7 +214,11 @@ github.com/klauspost/cpuid/v2 v2.0.1/go.mod h1:FInQzS24/EEf25PyTYn52gqo7WaD8xa02
 github.com/klauspost/cpuid/v2 v2.0.9/go.mod h1:FInQzS24/EEf25PyTYn52gqo7WaD8xa0213Md/qVLRg=
 github.com/klauspost/cpuid/v2 v2.2.5 h1:0E5MSMDEoAulmXNFquVs//DdoomxaoTY1kUhbc/qbZg=
 github.com/klauspost/cpuid/v2 v2.2.5/go.mod h1:Lcz8mBdAVJIBVzewtcLocK12l3Y+JytZYpaMropDUws=
+github.com/kr/pretty v0.1.0/go.mod h1:dAy3ld7l9f0ibDNOQOHHMYYIIbhfbHSm3C4ZsoJORNo=
 github.com/kr/pretty v0.3.1 h1:flRD4NNwYAUpkphVc1HcthR4KEIFJ65n8Mw5qdRn3LE=
+github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ=
+github.com/kr/pty v1.1.8/go.mod h1:O1sed60cT9XZ5uDucP5qwvh+TE3NnUj51EiZO/lmSfw=
+github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI=
 github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY=
 github.com/leodido/go-urn v1.2.4 h1:XlAE/cm/ms7TE/VMVoduSpNBoyc2dOxHs5MZSwAN63Q=
 github.com/leodido/go-urn v1.2.4/go.mod h1:7ZrI8mTSeBSHl/UaRyKQW1qZeMgak41ANeCNaVckg+4=
@@ -207,6 +230,11 @@ github.com/lestrrat-go/strftime v1.0.6 h1:CFGsDEt1pOpFNU+TJB0nhz9jl+K0hZSLE205Ah
 github.com/lestrrat-go/strftime v1.0.6/go.mod h1:f7jQKgV5nnJpYgdEasS+/y7EsTb8ykN2z68n3TtcTaw=
 github.com/lithammer/shortuuid v3.0.0+incompatible h1:NcD0xWW/MZYXEHa6ITy6kaXN5nwm/V115vj2YXfhS0w=
 github.com/lithammer/shortuuid v3.0.0+incompatible/go.mod h1:FR74pbAuElzOUuenUHTK2Tciko1/vKuIKS9dSkDrA4w=
+github.com/mattn/go-colorable v0.0.9 h1:UVL0vNpWh04HeJXV0KLcaT7r06gOH2l4OW6ddYRUIY4=
+github.com/mattn/go-colorable v0.0.9/go.mod h1:9vuHe8Xs5qXnSaW/c/ABM9alt+Vo+STaOChaDxuIBZU=
+github.com/mattn/go-colorable v0.1.13 h1:fFA4WZxdEF4tXPZVKMLwD8oUnCTTo08duU7wxecdEvA=
+github.com/mattn/go-colorable v0.1.13/go.mod h1:7S9/ev0klgBDR4GtXTXX8a3vIGJpMovkB8vQcUbaXHg=
+github.com/mattn/go-isatty v0.0.16/go.mod h1:kYGgaQfpe5nmfYZH+SKPsOc2e4SrIfOl2e/yFXSvRLM=
 github.com/mattn/go-isatty v0.0.19 h1:JITubQf0MOLdlGRuRq+jtsDlekdYPia9ZFsB8h/APPA=
 github.com/mattn/go-isatty v0.0.19/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y=
 github.com/matttproud/golang_protobuf_extensions v1.0.4 h1:mmDVorXM7PCGKw94cs5zkfA9PSy5pEvNWRP0ET0TIVo=
@@ -217,6 +245,8 @@ github.com/minio/minio-go/v7 v7.0.63 h1:GbZ2oCvaUdgT5640WJOpyDhhDxvknAJU2/T3yurw
 github.com/minio/minio-go/v7 v7.0.63/go.mod h1:Q6X7Qjb7WMhvG65qKf4gUgA5XaiSox74kR1uAEjxRS4=
 github.com/minio/sha256-simd v1.0.1 h1:6kaan5IFmwTNynnKKpDHe6FWHohJOHhCPchzK49dzMM=
 github.com/minio/sha256-simd v1.0.1/go.mod h1:Pz6AKMiUdngCLpeTL/RJY1M9rUuPMYujV5xJjtbRSN8=
+github.com/mitchellh/go-homedir v1.1.0 h1:lukF9ziXFxDFPkA1vsr5zpc1XuPDn/wFntq5mG+4E0Y=
+github.com/mitchellh/go-homedir v1.1.0/go.mod h1:SfyaCUpYCn1Vlf4IUYiD9fPX4A5wJrkLzIz1N1q0pr0=
 github.com/mitchellh/mapstructure v1.4.3/go.mod h1:bFUtVrKA4DC2yAKiSyO/QUcy7e+RRV2QTWOzhPopBRo=
 github.com/mitchellh/mapstructure v1.5.0 h1:jeMsZIYE/09sWLaz43PL7Gy6RuMjD2eJVyuac5Z2hdY=
 github.com/mitchellh/mapstructure v1.5.0/go.mod h1:bFUtVrKA4DC2yAKiSyO/QUcy7e+RRV2QTWOzhPopBRo=
@@ -246,10 +276,12 @@ github.com/onsi/gomega v1.10.1/go.mod h1:iN09h71vgCQne3DLsj+A5owkum+a2tYe+TOCB1y
 github.com/onsi/gomega v1.17.0/go.mod h1:HnhC7FXeEQY45zxNK3PPoIUhzk/80Xly9PcubAlGdZY=
 github.com/onsi/gomega v1.18.1 h1:M1GfJqGRrBrrGGsbxzV5dqM2U2ApXefZCQpkukxYRLE=
 github.com/onsi/gomega v1.18.1/go.mod h1:0q+aL8jAiMXy9hbwj2mr5GziHiwhAIQpFmmtT5hitRs=
+github.com/pelletier/go-buffruneio v0.2.0/go.mod h1:JkE26KsDizTr40EUHkXVtNPvgGtbSNq5BcowyYOWdKo=
 github.com/pelletier/go-toml/v2 v2.0.8 h1:0ctb6s9mE31h0/lhu+J6OPmVeDxJn+kYnJc2jZR9tGQ=
 github.com/pelletier/go-toml/v2 v2.0.8/go.mod h1:vuYfssBdrU2XDZ9bYydBu6t+6a6PYNcZljzZR9VXg+4=
 github.com/pierrec/lz4/v4 v4.1.18 h1:xaKrnTkyoqfh1YItXl56+6KJNVYWlEEPuAQW9xsplYQ=
 github.com/pierrec/lz4/v4 v4.1.18/go.mod h1:gZWDp/Ze/IJXGXf23ltt2EXimqmTUXEy0GFuRQyBid4=
+github.com/pkg/errors v0.8.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0=
 github.com/pkg/errors v0.9.1 h1:FEBLx1zS214owpjy7qsBeixbURkuhQAwrK5UwLGTwt4=
 github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0=
 github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
@@ -273,13 +305,18 @@ github.com/rogpeppe/go-internal v1.11.0 h1:cWPaGQEPrBb5/AsnsZesgZZ9yb1OQ+GOISoDN
 github.com/rs/xid v1.5.0 h1:mKX4bl4iPYJtEIxp6CYiUuLQ/8DYMoz0PUdtGgMFRVc=
 github.com/rs/xid v1.5.0/go.mod h1:trrq9SKmegXys3aeAKXMUTdJsYXVwGY3RLcfgqegfbg=
 github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=
+github.com/sergi/go-diff v1.0.0 h1:Kpca3qRNrduNnOQeazBd0ysaKrUJiIuISHxogkT9RPQ=
+github.com/sergi/go-diff v1.0.0/go.mod h1:0CfEIISq7TuYL3j771MWULgwwjU+GofnZX9QAmXWZgo=
 github.com/sirupsen/logrus v1.9.3 h1:dueUQJ1C2q9oE3F7wvmSGAaVtTmUizReu6fjN8uqzbQ=
 github.com/sirupsen/logrus v1.9.3/go.mod h1:naHLuLoDiP4jHNo9R0sCBMtWGeIprob74mVsIT4qYEQ=
 github.com/spf13/cobra v1.7.0 h1:hyqWnYt1ZQShIddO5kBpj3vu05/++x6tJ6dg8EC572I=
 github.com/spf13/cobra v1.7.0/go.mod h1:uLxZILRyS/50WlhOIKD7W6V5bgeIt+4sICxh6uRMrb0=
 github.com/spf13/pflag v1.0.5 h1:iy+VFUOCP1a+8yFto/drg2CJ5u0yRoB7fZw3DKv/JXA=
 github.com/spf13/pflag v1.0.5/go.mod h1:McXfInJRrz4CZXVZOBLb0bTZqETkiAhM9Iw0y3An2Bg=
+github.com/src-d/gcfg v1.4.0 h1:xXbNR5AlLSA315x2UO+fTSSAXCDf+Ar38/6oyGbDKQ4=
+github.com/src-d/gcfg v1.4.0/go.mod h1:p/UMsR43ujA89BJY9duynAwIpvqEujIH/jFlfL7jWoI=
 github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
+github.com/stretchr/objx v0.2.0/go.mod h1:qt09Ya8vawLte6SNmTgCsAVtYtaKzEcn8ATUoHMkEqE=
 github.com/stretchr/objx v0.4.0/go.mod h1:YvHI0jy2hoMjB+UWwv71VJQ9isScKT/TqJzVSSt89Yw=
 github.com/stretchr/objx v0.5.0/go.mod h1:Yh+to48EsGEfYuaHDzXPcE3xhTkx73EhmCGUpEOglKo=
 github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI=
@@ -301,6 +338,8 @@ github.com/twitchyliquid64/golang-asm v0.15.1 h1:SU5vSMR7hnwNxj24w34ZyCi/FmDZTkS
 github.com/twitchyliquid64/golang-asm v0.15.1/go.mod h1:a1lVb/DtPvCB8fslRZhAngC2+aY1QWCk3Cedj/Gdt08=
 github.com/ugorji/go/codec v1.2.11 h1:BMaWp1Bb6fHwEtbplGBGJ498wD+LKlNSl25MjdZY4dU=
 github.com/ugorji/go/codec v1.2.11/go.mod h1:UNopzCgEMSXjBc6AOMqYvWC1ktqTAfzJZUZgYf6w6lg=
+github.com/xanzy/ssh-agent v0.2.1 h1:TCbipTQL2JiiCprBWx9frJ2eJlCYT00NmctrHxVAr70=
+github.com/xanzy/ssh-agent v0.2.1/go.mod h1:mLlQY/MoOhWBj+gOGMQkOeiEvkx+8pJSI+0Bx9h2kr4=
 github.com/xdg-go/pbkdf2 v1.0.0 h1:Su7DPu48wXMwC3bs7MCNG+z4FhcyEuz5dlvchbq0B0c=
 github.com/xdg-go/pbkdf2 v1.0.0/go.mod h1:jrpuAogTd400dnrH08LKmI/xc1MbPOebTwRqcT5RDeI=
 github.com/xdg-go/scram v1.1.2 h1:FHX5I5B4i4hKRVRBCFRxq1iQRej7WO3hhBuJf+UUySY=
@@ -326,7 +365,9 @@ go.uber.org/zap v1.24.0/go.mod h1:2kMP+WWQ8aoFoedH3T2sq6iJ2yDWpHbP0f6MQbS9Gkg=
 golang.org/x/arch v0.0.0-20210923205945-b76863e36670/go.mod h1:5om86z9Hs0C8fWVUuoMHwpExlXzs5Tkyp9hOrfG7pp8=
 golang.org/x/arch v0.3.0 h1:02VY4/ZcO/gBOH6PUaoiptASxtXU10jazRCP865E97k=
 golang.org/x/arch v0.3.0/go.mod h1:5om86z9Hs0C8fWVUuoMHwpExlXzs5Tkyp9hOrfG7pp8=
+golang.org/x/crypto v0.0.0-20190219172222-a4c6cb3142f2/go.mod h1:6SG95UA2DQfeDnfUPMdvaQW0Q7yPrPDi9nlGo2tz2b4=
 golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
+golang.org/x/crypto v0.0.0-20190701094942-4def268fd1a4/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI=
 golang.org/x/crypto v0.0.0-20191011191535-87dc89f01550/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI=
 golang.org/x/crypto v0.0.0-20200622213623-75b288015ac9/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto=
 golang.org/x/crypto v0.0.0-20210921155107-089bfa567519/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc=
@@ -351,6 +392,7 @@ golang.org/x/net v0.0.0-20190311183353-d8887717615a/go.mod h1:t9HGtf8HONx5eT2rtn
 golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg=
 golang.org/x/net v0.0.0-20190603091049-60506f45cf65/go.mod h1:HSz+uSET+XFnRR8LxR5pz3Of3rY3CfYBVs4xY44aLks=
 golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
+golang.org/x/net v0.0.0-20190724013045-ca1201d0de80/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
 golang.org/x/net v0.0.0-20200114155413-6afb5195e5aa/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
 golang.org/x/net v0.0.0-20200226121028-0de0cce0169b/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
 golang.org/x/net v0.0.0-20200520004742-59133d7f0dd7/go.mod h1:qpuaurCH72eLCgpAm/N6yyVIVM9cpaDIP3A8BGJEC5A=
@@ -379,7 +421,9 @@ golang.org/x/sync v0.4.0/go.mod h1:FU7BRWz2tNW+3quACPkgCx/L+uEAv1htQ0V83Z9Rj+Y=
 golang.org/x/sys v0.0.0-20180830151530-49385e6e1522/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
 golang.org/x/sys v0.0.0-20180909124046-d0be0721c37e/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
 golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
+golang.org/x/sys v0.0.0-20190221075227-b4e8571b14e0/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
 golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
+golang.org/x/sys v0.0.0-20190726091711-fc99dfbffb4e/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
 golang.org/x/sys v0.0.0-20190904154756-749cb33beabd/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
 golang.org/x/sys v0.0.0-20191005200804-aed5e4c7ecf9/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
 golang.org/x/sys v0.0.0-20191120155948-bd437916bb0e/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
@@ -417,6 +461,7 @@ golang.org/x/tools v0.0.0-20190114222345-bf090417da8b/go.mod h1:n7NCudcB/nEzxVGm
 golang.org/x/tools v0.0.0-20190226205152-f727befe758c/go.mod h1:9Yl7xja0Znq3iFh3HoIrodX9oNMXvdceNzlUR8zjMvY=
 golang.org/x/tools v0.0.0-20190311212946-11955173bddd/go.mod h1:LCzVGOaR6xXOjkQ3onu1FJEFr0SW1gC7cKk1uF8kGRs=
 golang.org/x/tools v0.0.0-20190524140312-2c0ae7006135/go.mod h1:RgjU9mgBXZiqYHBnxXauZ1Gv1EHHAz9KjViQ78xBX0Q=
+golang.org/x/tools v0.0.0-20190729092621-ff9f1409240a/go.mod h1:jcCCGcm9btYwXyDqrUWc6MKQKKGJCWEQ3AfLSRIbEuI=
 golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo=
 golang.org/x/tools v0.0.0-20200619180055-7c47624df98f/go.mod h1:EkVYQZoAsY45+roYkvgYkIh4xh/qjgUK9TdY2XT94GE=
 golang.org/x/tools v0.0.0-20201224043029-2b0845dc783e/go.mod h1:emZCQorbCU4vsT4fOWvOPXz4eW1wZW4PmDk9uLelYpA=
@@ -464,12 +509,20 @@ google.golang.org/protobuf v1.26.0/go.mod h1:9q0QmTI4eRPtz6boOQmLYwt+qCgq0jsYwAQ
 google.golang.org/protobuf v1.31.0 h1:g0LDEJHgrBl9N9r17Ru3sqWhkIx2NB67okBHPwC7hs8=
 google.golang.org/protobuf v1.31.0/go.mod h1:HV8QOd/L58Z+nl8r43ehVNZIU/HEI6OcFqwMG9pJV4I=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
 gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c h1:Hei/4ADfdWqJk1ZMxUNpqntNwaWcugrBjAiHlqqRiVk=
 gopkg.in/fsnotify.v1 v1.4.7/go.mod h1:Tz8NjZHkW78fSQdbUxIjBTcgA1z1m8ZHf0WmKUhAMys=
 gopkg.in/ini.v1 v1.67.0 h1:Dgnx+6+nfE+IfzjUEISNeydPJh9AXNNsWbGP9KzCsOA=
 gopkg.in/ini.v1 v1.67.0/go.mod h1:pNLf8WUiyNEtQjuu5G5vTm06TEv9tsIgeAvK8hOrP4k=
+gopkg.in/src-d/go-billy.v4 v4.3.2 h1:0SQA1pRztfTFx2miS8sA97XvooFeNOmvUenF4o0EcVg=
+gopkg.in/src-d/go-billy.v4 v4.3.2/go.mod h1:nDjArDMp+XMs1aFAESLRjfGSgfvoYN0hDfzEk0GjC98=
+gopkg.in/src-d/go-git-fixtures.v3 v3.5.0/go.mod h1:dLBcvytrw/TYZsNTWCnkNF2DSIlzWYqTe3rJR56Ac7g=
+gopkg.in/src-d/go-git.v4 v4.13.1 h1:SRtFyV8Kxc0UP7aCHcijOMQGPxHSmMOPrzulQWolkYE=
+gopkg.in/src-d/go-git.v4 v4.13.1/go.mod h1:nx5NYcxdKxq5fpltdHnPa2Exj4Sx0EclMWZQbYDu2z8=
 gopkg.in/tomb.v1 v1.0.0-20141024135613-dd632973f1e7 h1:uRGJdciOHaEIrze2W8Q3AKkepLTh2hOroT7a+7czfdQ=
 gopkg.in/tomb.v1 v1.0.0-20141024135613-dd632973f1e7/go.mod h1:dt/ZhP58zS4L8KSrWDmTeBkI65Dw0HsyUHuEVlX15mw=
+gopkg.in/warnings.v0 v0.1.2 h1:wFXVbFY8DY5/xOe1ECiWdKCzZlxgshcYVNkBHstARME=
+gopkg.in/warnings.v0 v0.1.2/go.mod h1:jksf8JmL6Qr/oQM2OXTHunEvvTAsrWBLb6OOjuVWRNI=
 gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
 gopkg.in/yaml.v2 v2.2.4/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
 gopkg.in/yaml.v2 v2.3.0/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=

pkg/common/cmd/msg_gateway.go

@@ -15,10 +15,11 @@
 package cmd
 
 import (
+	"log"
+
 	"github.com/openimsdk/open-im-server/v3/internal/msggateway"
-	config2 "github.com/openimsdk/open-im-server/v3/pkg/common/config"
+	v3config "github.com/openimsdk/open-im-server/v3/pkg/common/config"
 
-	//"github.com/openimsdk/open-im-server/internal/msggateway".
 	"github.com/spf13/cobra"
 
 	"github.com/OpenIMSDK/protocol/constant"
@@ -39,7 +40,10 @@ func (m *MsgGatewayCmd) AddWsPortFlag() {
 }
 
 func (m *MsgGatewayCmd) getWsPortFlag(cmd *cobra.Command) int {
-	port, _ := cmd.Flags().GetInt(constant.FlagWsPort)
+	port, err := cmd.Flags().GetInt(constant.FlagWsPort)
+	if err != nil {
+		log.Println("Error getting ws port flag:", err)
+	}
 	if port == 0 {
 		port = m.PortFromConfig(constant.FlagWsPort)
 	}
@@ -58,9 +62,9 @@ func (m *MsgGatewayCmd) Exec() error {
 }
 func (m *MsgGatewayCmd) GetPortFromConfig(portType string) int {
 	if portType == constant.FlagWsPort {
-		return config2.Config.LongConnSvr.OpenImWsPort[0]
+		return v3config.Config.LongConnSvr.OpenImWsPort[0]
 	} else if portType == constant.FlagPort {
-		return config2.Config.LongConnSvr.OpenImMessageGatewayPort[0]
+		return v3config.Config.LongConnSvr.OpenImMessageGatewayPort[0]
 	} else if portType == constant.FlagPrometheusPort {
 		return 0
 	} else {

pkg/common/cmd/root.go

@@ -131,7 +131,10 @@ func (r *RootCmd) AddPortFlag() {
 }
 
 func (r *RootCmd) getPortFlag(cmd *cobra.Command) int {
-	port, _ := cmd.Flags().GetInt(constant.FlagPort)
+	port, err := cmd.Flags().GetInt(constant.FlagPort)
+	if err != nil {
+		fmt.Println("Error getting ws port flag:", err)
+	}
 	if port == 0 {
 		port = r.PortFromConfig(constant.FlagPort)
 	}

pkg/common/version/base.go

@@ -0,0 +1,47 @@
+package version
+
+// Base version information.
+//
+// This is the fallback data used when version information from git is not
+// provided via go ldflags. It provides an approximation of the Kubernetes
+// version for ad-hoc builds (e.g. `go build`) that cannot get the version
+// information from git.
+//
+// If you are looking at these fields in the git tree, they look
+// strange. They are modified on the fly by the build process. The
+// in-tree values are dummy values used for "git archive", which also
+// works for GitHub tar downloads.
+//
+// When releasing a new Kubernetes version, this file is updated by
+// build/mark_new_version.sh to reflect the new version, and then a
+// git annotated tag (using format vX.Y where X == Major version and Y
+// == Minor version) is created to point to the commit that updates
+var (
+	// TODO: Deprecate gitMajor and gitMinor, use only gitVersion
+	// instead. First step in deprecation, keep the fields but make
+	// them irrelevant. (Next we'll take it out, which may muck with
+	// scripts consuming the kubectl version output - but most of
+	// these should be looking at gitVersion already anyways.)
+	gitMajor string = "" // major version, always numeric
+	gitMinor string = "" // minor version, numeric possibly followed by "+"
+
+	// semantic version, derived by build scripts (see
+	// https://github.com/kubernetes/sig-release/blob/master/release-engineering/versioning.md#kubernetes-release-versioning
+	// https://kubernetes.io/releases/version-skew-policy/
+	// for a detailed discussion of this field)
+	//
+	// TODO: This field is still called "gitVersion" for legacy
+	// reasons. For prerelease versions, the build metadata on the
+	// semantic version is a git hash, but the version itself is no
+	// longer the direct output of "git describe", but a slight
+	// translation to be semver compliant.
+
+	// NOTE: The $Format strings are replaced during 'git archive' thanks to the
+	// companion .gitattributes file containing 'export-subst' in this same
+	// directory.  See also https://git-scm.com/docs/gitattributes
+	gitVersion   string = "latest"
+	gitCommit    string = ""            // sha1 from git, output of $(git rev-parse HEAD)
+	gitTreeState string = ""            // state of git tree, either "clean" or "dirty"
+
+	buildDate string = "1970-01-01T00:00:00Z" // build date in ISO8601 format, output of $(date -u +'%Y-%m-%dT%H:%M:%SZ')
+)

pkg/common/version/types.go

@@ -0,0 +1,29 @@
+package version
+
+// Info contains versioning information.
+// TODO: Add []string of api versions supported? It's still unclear
+// how we'll want to distribute that information.
+type Info struct {
+	Major      string `json:"major,omitempty"`
+	Minor      string `json:"minor,omitempty"`
+	GitVersion string `json:"gitVersion"`
+	GitCommit  string `json:"gitCommit,omitempty"`
+	BuildDate  string `json:"buildDate"`
+	GoVersion  string `json:"goVersion"`
+	Compiler   string `json:"compiler"`
+	Platform   string `json:"platform"`
+}
+
+type Output struct {
+	OpenIMServerVersion Info                 `json:"OpenIMServerVersion,omitempty" yaml:"OpenIMServerVersion,omitempty"`
+	OpenIMClientVersion *OpenIMClientVersion `json:"OpenIMClientVersion,omitempty" yaml:"OpenIMClientVersion,omitempty"`
+}
+
+type OpenIMClientVersion struct {
+	ClientVersion string `json:"clientVersion,omitempty" yaml:"clientVersion,omitempty"`	//sdk core version
+}
+
+// String returns info as a human-friendly version string.
+func (info Info) String() string {
+	return info.GitVersion
+}

pkg/common/version/version.go

@@ -0,0 +1,57 @@
+package version
+
+import (
+	"fmt"
+	"runtime"
+
+	"gopkg.in/src-d/go-git.v4"
+)
+
+// Get returns the overall codebase version. It's for detecting
+// what code a binary was built from.
+func Get() Info {
+	// These variables typically come from -ldflags settings and in
+	// their absence fallback to the settings in ./base.go
+	return Info{
+		Major:      gitMajor,
+		Minor:      gitMinor,
+		GitVersion: gitVersion,
+		GitCommit:  gitCommit,
+		BuildDate:  buildDate,
+		GoVersion:  runtime.Version(),
+		Compiler:   runtime.Compiler,
+		Platform:   fmt.Sprintf("%s/%s", runtime.GOOS, runtime.GOARCH),
+	}
+}
+
+// GetClientVersion returns the git version of the OpenIM client repository
+func GetClientVersion() (*OpenIMClientVersion, error) {
+	clientVersion, err := getClientVersion()
+	if err != nil {
+		return nil, err
+	}
+	return &OpenIMClientVersion{
+		ClientVersion: clientVersion,
+	}, nil
+}
+
+func getClientVersion() (string, error) {
+	repo, err := git.PlainClone("/tmp/openim-sdk-core", false, &git.CloneOptions{
+		URL: "https://github.com/OpenIMSDK/openim-sdk-core",
+	})
+	if err != nil {
+		return "", fmt.Errorf("error cloning repository: %w", err)
+	}
+
+	ref, err := repo.Head()
+	if err != nil {
+		return "", fmt.Errorf("error getting head reference: %w", err)
+	}
+
+	return ref.Hash().String(), nil
+}
+
+// GetSingleVersion returns single version of sealer
+func GetSingleVersion() string {
+	return gitVersion
+}

scripts/check-all.sh

@@ -33,8 +33,9 @@ openim::log::info "\n# Begin to check all openim service"
 # OpenIM status
 # Elegant printing function
 print_services_and_ports() {
-    local -n service_names=$1
+    # 获取数组
-    local -n service_ports=$2
+    declare -g service_names=("${!1}")
+    declare -g service_ports=("${!2}")
 
     echo "+-------------------------+----------+"
     echo "| Service Name            | Port     |"

scripts/install/environment.sh

@@ -118,7 +118,7 @@ GRAFANA_NETWORK_ADDRESS=$(generate_ip)
 # read: https://github.com/openimsdk/open-im-server/blob/main/deployment/init/README.md
 def "OPENIM_DATA_DIR" "/data/openim"
 def "OPENIM_INSTALL_DIR" "/opt/openim"
-def "OPENIM_CONFIG_DIR" "/etc/openim"
+def "OPENIM_CONFIG_DIR" "/etc/openim/config"
 def "OPENIM_LOG_DIR" "/var/log/openim"
 def "CA_FILE" "${OPENIM_CONFIG_DIR}/cert/ca.pem"
 

scripts/install/install.sh

@@ -51,15 +51,9 @@
 OPENIM_ROOT=$(cd "$(dirname "${BASH_SOURCE[0]}")"/../.. && pwd -P)
 [[ -z ${COMMON_SOURCED} ]] && source "${OPENIM_ROOT}"/scripts/install/common.sh
 
-source "${OPENIM_ROOT}"/scripts/install/openim-msggateway.sh
+${OPENIM_ROOT}/scripts/install/openim-man.sh
-source "${OPENIM_ROOT}"/scripts/install/openim-msgtransfer.sh
+${OPENIM_ROOT}/scripts/install/openim-tools.sh
-source "${OPENIM_ROOT}"/scripts/install/openim-push.sh
+${OPENIM_ROOT}/scripts/install/test.sh
-source "${OPENIM_ROOT}"/scripts/install/openim-rpc.sh
-source "${OPENIM_ROOT}"/scripts/install/openim-crontask.sh
-source "${OPENIM_ROOT}"/scripts/install/openim-api.sh
-source "${OPENIM_ROOT}"/scripts/install/openim-man.sh
-source "${OPENIM_ROOT}"/scripts/install/openim-tools.sh
-source "${OPENIM_ROOT}"/scripts/install/test.sh
 
 # Detailed help function
 function openim::install::show_help() {
@@ -79,15 +73,21 @@ function openim::install::show_help() {
 
 function openim::install::install_openim()
 {
+    openim::common::sudo "mkdir -p ${OPENIM_DATA_DIR} ${OPENIM_INSTALL_DIR} ${OPENIM_CONFIG_DIR} ${OPENIM_LOG_DIR}"
     openim::log::info "check openim dependency"
+    openim::common::sudo "cp -r ${OPENIM_ROOT}/config/* ${OPENIM_CONFIG_DIR}/"
+
+    echo ${LINUX_PASSWORD} | sudo -S bash -c \
+        "${OPENIM_ROOT}/scripts/genconfig.sh ${ENV_FILE} deployments/templates/openim.yaml > ${OPENIM_CONFIG_DIR}/config.yaml"
+
     openim::util::check_ports ${OPENIM_DEPENDENCY_PORT_LISTARIES[@]}
 
-    openim::msggateway::install || return 1
+    ${OPENIM_ROOT}/scripts/install/openim-msggateway.sh openim::msggateway::install || return 1
-    openim::msgtransfer::install || return 1
+    ${OPENIM_ROOT}/scripts/install/openim-msgtransfer.sh openim::msgtransfer::install || return 1
-    openim::push::install || return 1
+    ${OPENIM_ROOT}/scripts/install/openim-push.sh openim::push::install || return 1
-    openim::rpc::install || return 1
+    ${OPENIM_ROOT}/scripts/install/openim-crontask.sh openim::crontask::install || return 1
-    openim::crontask::install || return 1
+    ${OPENIM_ROOT}/scripts/install/openim-rpc.sh openim::rpc::install || return 1
-    openim::api::install || return 1
+    ${OPENIM_ROOT}/scripts/install/openim-api.sh openim::api::install || return 1
 
     openim::log::success "openim install success"
 }
@@ -96,12 +96,12 @@ function openim::uninstall::uninstall_openim()
 {
     openim::log::info "uninstall openim"
 
-    openim::msggateway::uninstall || return 1
+    ${OPENIM_ROOT}/scripts/install/openim-msggateway.sh openim::msggateway::uninstall || return 1
-    openim::msgtransfer::uninstall || return 1
+    ${OPENIM_ROOT}/scripts/install/openim-msgtransfer.sh openim::msgtransfer::uninstall || return 1
-    openim::push::uninstall || return 1
+    ${OPENIM_ROOT}/scripts/install/openim-push.sh openim::push::uninstall || return 1
-    openim::rpc::uninstall || return 1
+    ${OPENIM_ROOT}/scripts/install/openim-crontask.sh openim::crontask::uninstall || return 1
-    openim::crontask::uninstall || return 1
+    ${OPENIM_ROOT}/scripts/install/openim-rpc.sh openim::rpc::uninstall || return 1
-    openim::api::uninstall || return 1
+    ${OPENIM_ROOT}/scripts/install/openim-api.sh openim::api::uninstall || return 1
 
     openim::log::success "openim uninstall success"
 }
@@ -110,12 +110,12 @@ function openim::install::status()
 {
     openim::log::info "check openim status"
 
-    openim::msggateway::status || return 1
+    ${OPENIM_ROOT}/scripts/install/openim-msggateway.sh openim::msggateway::status || return 1
-    openim::msgtransfer::status || return 1
+    ${OPENIM_ROOT}/scripts/install/openim-msgtransfer.sh openim::msgtransfer::status || return 1
-    openim::push::status || return 1
+    ${OPENIM_ROOT}/scripts/install/openim-push.sh openim::push::status || return 1
-    openim::rpc::status || return 1
+    ${OPENIM_ROOT}/scripts/install/openim-crontask.sh openim::crontask::status || return 1
-    openim::crontask::status || return 1
+    ${OPENIM_ROOT}/scripts/install/openim-rpc.sh openim::rpc::status || return 1
-    openim::api::status || return 1
+    ${OPENIM_ROOT}/scripts/install/openim-api.sh openim::api::status || return 1
 
     openim::log::success "openim status success"
 }

scripts/install/openim-api.sh

@@ -92,21 +92,70 @@ function openim::api::start_service() {
 ###################################### Linux Systemd ######################################
 SYSTEM_FILE_PATH="/etc/systemd/system/${SERVER_NAME}.service"
 
+# Print the necessary information after installation
+function openim::api::info() {
+cat << EOF
+openim-api listen on: ${OPENIM_API_HOST}:${API_OPENIM_PORT}
+EOF
+}
+
+# install openim-api
 function openim::api::install() {
     openim::log::info "Installing ${SERVER_NAME} ..."
+
+    pushd "${OPENIM_ROOT}"
+
+    # 1. Build openim-api
+    make build BINS=${SERVER_NAME}
+    openim::common::sudo "cp -r ${OPENIM_OUTPUT_HOSTBIN}/${SERVER_NAME} ${OPENIM_INSTALL_DIR}/${SERVER_NAME}"
+    openim::log::status "${SERVER_NAME} binary: ${OPENIM_INSTALL_DIR}/${SERVER_NAME}/${SERVER_NAME}"
+
+    # 2. Generate and install the openim-api configuration file (config)
+    openim::log::status "${SERVER_NAME} config file: ${OPENIM_CONFIG_DIR}/config.yaml"
+
+    # 3. Create and install the ${SERVER_NAME} systemd unit file
+    echo ${LINUX_PASSWORD} | sudo -S bash -c \
+        "SERVER_NAME=${SERVER_NAME} ./scripts/genconfig.sh ${ENV_FILE} deployments/templates/openim.service > ${SYSTEM_FILE_PATH}"
+    openim::log::status "${SERVER_NAME} systemd file: ${SYSTEM_FILE_PATH}"
+
+    # 4. Start the openim-api service
+    openim::common::sudo "systemctl daemon-reload"
+    openim::common::sudo "systemctl restart ${SERVER_NAME}"
+    openim::common::sudo "systemctl enable ${SERVER_NAME}"
+    openim::api::status || return 1
+    openim::api::info
+
+    openim::log::info "install ${SERVER_NAME} successfully"
+    popd
 }
 
+# Unload
 function openim::api::uninstall() {
     openim::log::info "Uninstalling ${SERVER_NAME} ..."
 
+    set +o errexit
+    openim::common::sudo "systemctl stop ${SERVER_NAME}"
+    openim::common::sudo "systemctl disable ${SERVER_NAME}"
+    openim::common::sudo "rm -f ${OPENIM_INSTALL_DIR}/${SERVER_NAME}"
+    openim::common::sudo "rm -f ${OPENIM_CONFIG_DIR}/${SERVER_NAME}.yaml"
+    openim::common::sudo "rm -f /etc/systemd/system/${SERVER_NAME}.service"
+    set -o errexit
+    openim::log::info "uninstall ${SERVER_NAME} successfully"
 }
 
+# Status Check
 function openim::api::status() {
     openim::log::info "Checking ${SERVER_NAME} status ..."
 
+    # Check the running status of the ${SERVER_NAME}. If active (running) is displayed, the ${SERVER_NAME} is started successfully.
+    systemctl status ${SERVER_NAME}|grep -q 'active' || {
+        openim::log::error "${SERVER_NAME} failed to start, maybe not installed properly"
+        return 1
+    }
+
     openim::util::check_ports ${OPENIM_API_PORT_LISTARIES[@]}
 }
 
 if [[ "$*" =~ openim::api:: ]];then
-  eval $*
+    eval $*
-fi
+fi

scripts/install/openim-crontask.sh

@@ -51,7 +51,7 @@ function openim::crontask::start()
     openim::util::stop_services_with_name ${OPENIM_CRONTASK_BINARY}
 
     openim::log::status "start cron_task process, path: ${OPENIM_CRONTASK_BINARY}"
-    nohup ${OPENIM_CRONTASK_BINARY} >> ${LOG_FILE} 2>&1 &
+    nohup ${OPENIM_CRONTASK_BINARY} -c ${OPENIM_PUSH_CONFIG} >> ${LOG_FILE} 2>&1 &
     openim::util::check_process_names ${SERVER_NAME}
 }
 
@@ -72,18 +72,16 @@ function openim::crontask::install()
 
   # 1. Build openim-crontask
   make build BINS=${SERVER_NAME}
-  openim::common::sudo "cp ${OPENIM_OUTPUT_HOSTBIN}/${SERVER_NAME} ${OPENIM_INSTALL_DIR}/bin"
 
-  openim::log::status "${SERVER_NAME} binary: ${OPENIM_INSTALL_DIR}/bin/${SERVER_NAME}"
+  openim::common::sudo "cp -r ${OPENIM_OUTPUT_HOSTBIN}/${SERVER_NAME} ${OPENIM_INSTALL_DIR}/${SERVER_NAME}"
+  openim::log::status "${SERVER_NAME} binary: ${OPENIM_INSTALL_DIR}/${SERVER_NAME}/${SERVER_NAME}"
 
   # 2. Generate and install the openim-crontask configuration file (openim-crontask.yaml)
-  echo ${LINUX_PASSWORD} | sudo -S bash -c \
+  openim::log::status "${SERVER_NAME} config file: ${OPENIM_CONFIG_DIR}/config.yaml"
-    "./scripts/genconfig.sh ${ENV_FILE} deployments/templates/${SERVER_NAME}.yaml > ${OPENIM_CONFIG_DIR}/${SERVER_NAME}.yaml"
-  openim::log::status "${SERVER_NAME} config file: ${OPENIM_CONFIG_DIR}/${SERVER_NAME}.yaml"
 
   # 3. Create and install the ${SERVER_NAME} systemd unit file
   echo ${LINUX_PASSWORD} | sudo -S bash -c \
-    "./scripts/genconfig.sh ${ENV_FILE} deployments/templates/init/${SERVER_NAME}.service > ${SYSTEM_FILE_PATH}"
+    "SERVER_NAME=${SERVER_NAME} ./scripts/genconfig.sh ${ENV_FILE} deployments/templates/openim.service > ${SYSTEM_FILE_PATH}"
   openim::log::status "${SERVER_NAME} systemd file: ${SYSTEM_FILE_PATH}"
 
   # 4. Start the openim-crontask service
@@ -104,7 +102,7 @@ function openim::crontask::uninstall()
   set +o errexit
   openim::common::sudo "systemctl stop ${SERVER_NAME}"
   openim::common::sudo "systemctl disable ${SERVER_NAME}"
-  openim::common::sudo "rm -f ${OPENIM_INSTALL_DIR}/bin/${SERVER_NAME}"
+  openim::common::sudo "rm -f ${OPENIM_INSTALL_DIR}/${SERVER_NAME}"
   openim::common::sudo "rm -f ${OPENIM_CONFIG_DIR}/${SERVER_NAME}.yaml"
   openim::common::sudo "rm -f /etc/systemd/system/${SERVER_NAME}.service"
   set -o errexit
@@ -115,15 +113,11 @@ function openim::crontask::uninstall()
 function openim::crontask::status()
 {
   # Check the running status of the ${SERVER_NAME}. If active (running) is displayed, the ${SERVER_NAME} is started successfully.
-  systemctl status ${SERVER_NAME}|grep -q 'active' || {
+  if systemctl is-active --quiet "${SERVER_NAME}"; then
+    openim::log::info "${SERVER_NAME} is running successfully."
+  else
     openim::log::error "${SERVER_NAME} failed to start, maybe not installed properly"
     return 1
-  }
-
-  # The listening port is hardcode in the configuration file
-  if echo | telnet 127.0.0.1 7070 2>&1|grep refused &>/dev/null;then
-    openim::log::error "cannot access health check port, ${SERVER_NAME} maybe not startup"
-    return 1
   fi
 }
 

scripts/install/openim-msggateway.sh

@@ -74,7 +74,7 @@ SYSTEM_FILE_PATH="/etc/systemd/system/${SERVER_NAME}.service"
 # Print the necessary information after installation
 function openim::msggateway::info() {
 cat << EOF
-openim-msggateway listen on: ${OPENIM_MSGGATEWAY_HOST}
+openim-msggateway listen on: ${OPENIM_MSGGATEWAY_HOST}:${OPENIM_MESSAGE_GATEWAY_PORT}
 EOF
 }
 
@@ -85,18 +85,15 @@ function openim::msggateway::install()
 
   # 1. Build openim-msggateway
   make build BINS=${SERVER_NAME}
-  openim::common::sudo "cp ${OPENIM_OUTPUT_HOSTBIN}/${SERVER_NAME} ${OPENIM_INSTALL_DIR}/bin"
+  openim::common::sudo "cp -r ${OPENIM_OUTPUT_HOSTBIN}/${SERVER_NAME} ${OPENIM_INSTALL_DIR}/${SERVER_NAME}"
-
+  openim::log::status "${SERVER_NAME} binary: ${OPENIM_INSTALL_DIR}/${SERVER_NAME}"
-  openim::log::status "${SERVER_NAME} binary: ${OPENIM_INSTALL_DIR}/bin/${SERVER_NAME}"
 
   # 2. Generate and install the openim-msggateway configuration file (openim-msggateway.yaml)
-  echo ${LINUX_PASSWORD} | sudo -S bash -c \
+  # nono
-    "./scripts/genconfig.sh ${ENV_FILE} deployments/templates/${SERVER_NAME}.yaml > ${OPENIM_CONFIG_DIR}/${SERVER_NAME}.yaml"
-  openim::log::status "${SERVER_NAME} config file: ${OPENIM_CONFIG_DIR}/${SERVER_NAME}.yaml"
 
   # 3. Create and install the ${SERVER_NAME} systemd unit file
   echo ${LINUX_PASSWORD} | sudo -S bash -c \
-    "./scripts/genconfig.sh ${ENV_FILE} deployments/templates/init/${SERVER_NAME}.service > ${SYSTEM_FILE_PATH}"
+    "SERVER_NAME=${SERVER_NAME} ./scripts/genconfig.sh ${ENV_FILE} deployments/templates/openim.service > ${SYSTEM_FILE_PATH}"
   openim::log::status "${SERVER_NAME} systemd file: ${SYSTEM_FILE_PATH}"
 
   # 4. Start the openim-msggateway service
@@ -117,7 +114,7 @@ function openim::msggateway::uninstall()
   set +o errexit
   openim::common::sudo "systemctl stop ${SERVER_NAME}"
   openim::common::sudo "systemctl disable ${SERVER_NAME}"
-  openim::common::sudo "rm -f ${OPENIM_INSTALL_DIR}/bin/${SERVER_NAME}"
+  openim::common::sudo "rm -f ${OPENIM_INSTALL_DIR}/${SERVER_NAME}"
   openim::common::sudo "rm -f ${OPENIM_CONFIG_DIR}/${SERVER_NAME}.yaml"
   openim::common::sudo "rm -f /etc/systemd/system/${SERVER_NAME}.service"
   set -o errexit
@@ -134,7 +131,7 @@ function openim::msggateway::status()
   }
 
   # The listening port is hardcode in the configuration file
-  if echo | telnet 127.0.0.1 7070 2>&1|grep refused &>/dev/null;then
+  if echo | telnet ${OPENIM_MSGGATEWAY_HOST} ${OPENIM_MESSAGE_GATEWAY_PORT} 2>&1|grep refused &>/dev/null;then
     openim::log::error "cannot access health check port, ${SERVER_NAME} maybe not startup"
     return 1
   fi

scripts/install/openim-msgtransfer.sh

@@ -95,18 +95,18 @@ function openim::msgtransfer::install()
 
   # 1. Build openim-msgtransfer
   make build BINS=${SERVER_NAME}
-  openim::common::sudo "cp ${OPENIM_OUTPUT_HOSTBIN}/${SERVER_NAME} ${OPENIM_INSTALL_DIR}/bin"
+
+  openim::common::sudo "cp -r ${OPENIM_OUTPUT_HOSTBIN}/${SERVER_NAME} ${OPENIM_INSTALL_DIR}/${SERVER_NAME}"
+  openim::log::status "${SERVER_NAME} binary: ${OPENIM_INSTALL_DIR}/${SERVER_NAME}/${SERVER_NAME}"
 
   openim::log::status "${SERVER_NAME} binary: ${OPENIM_INSTALL_DIR}/bin/${SERVER_NAME}"
 
   # 2. Generate and install the openim-msgtransfer configuration file (openim-msgtransfer.yaml)
-  echo ${LINUX_PASSWORD} | sudo -S bash -c \
+  # nono
-    "./scripts/genconfig.sh ${ENV_FILE} deployments/templates/${SERVER_NAME}.yaml > ${OPENIM_CONFIG_DIR}/${SERVER_NAME}.yaml"
-  openim::log::status "${SERVER_NAME} config file: ${OPENIM_CONFIG_DIR}/${SERVER_NAME}.yaml"
 
   # 3. Create and install the ${SERVER_NAME} systemd unit file
   echo ${LINUX_PASSWORD} | sudo -S bash -c \
-    "./scripts/genconfig.sh ${ENV_FILE} deployments/templates/init/${SERVER_NAME}.service > ${SYSTEM_FILE_PATH}"
+    "SERVER_NAME=${SERVER_NAME} ./scripts/genconfig.sh ${ENV_FILE} deployments/templates/openim.service > ${SYSTEM_FILE_PATH}"
   openim::log::status "${SERVER_NAME} systemd file: ${SYSTEM_FILE_PATH}"
 
   # 4. Start the openim-msgtransfer service
@@ -127,7 +127,7 @@ function openim::msgtransfer::uninstall()
   set +o errexit
   openim::common::sudo "systemctl stop ${SERVER_NAME}"
   openim::common::sudo "systemctl disable ${SERVER_NAME}"
-  openim::common::sudo "rm -f ${OPENIM_INSTALL_DIR}/bin/${SERVER_NAME}"
+  openim::common::sudo "rm -f ${OPENIM_INSTALL_DIR}/${SERVER_NAME}"
   openim::common::sudo "rm -f ${OPENIM_CONFIG_DIR}/${SERVER_NAME}.yaml"
   openim::common::sudo "rm -f /etc/systemd/system/${SERVER_NAME}.service"
   set -o errexit
@@ -138,15 +138,11 @@ function openim::msgtransfer::uninstall()
 function openim::msgtransfer::status()
 {
   # Check the running status of the ${SERVER_NAME}. If active (running) is displayed, the ${SERVER_NAME} is started successfully.
-  systemctl status ${SERVER_NAME}|grep -q 'active' || {
+  if systemctl is-active --quiet "${SERVER_NAME}"; then
+    openim::log::info "${SERVER_NAME} is running successfully."
+  else
     openim::log::error "${SERVER_NAME} failed to start, maybe not installed properly"
     return 1
-  }
-
-  # The listening port is hardcode in the configuration file
-  if echo | telnet 127.0.0.1 7070 2>&1|grep refused &>/dev/null;then
-    openim::log::error "cannot access health check port, ${SERVER_NAME} maybe not startup"
-    return 1
   fi
 }
 

scripts/install/openim-push.sh

@@ -83,7 +83,7 @@ SYSTEM_FILE_PATH="/etc/systemd/system/${SERVER_NAME}.service"
 # Print the necessary information after installation
 function openim::push::info() {
 cat << EOF
-openim-push listen on: ${OPENIM_PUSH_HOST}
+openim-push listen on: ${OPENIM_PUSH_HOST}:${OPENIM_PUSH_PORT}
 EOF
 }
 
@@ -94,18 +94,15 @@ function openim::push::install()
 
   # 1. Build openim-push
   make build BINS=${SERVER_NAME}
-  openim::common::sudo "cp -r ${OPENIM_OUTPUT_HOSTBIN}/${SERVER_NAME} ${OPENIM_INSTALL_DIR}/bin"
+  openim::common::sudo "cp -r ${OPENIM_OUTPUT_HOSTBIN}/${SERVER_NAME} ${OPENIM_INSTALL_DIR}/${SERVER_NAME}"
+  openim::log::status "${SERVER_NAME} binary: ${OPENIM_INSTALL_DIR}/${SERVER_NAME}/${SERVER_NAME}"
 
-  openim::log::status "${SERVER_NAME} binary: ${OPENIM_INSTALL_DIR}/bin/${SERVER_NAME}"
+  # 2. Generate and install the openim-push configuration file (config)
-
+  openim::log::status "${SERVER_NAME} config file: ${OPENIM_CONFIG_DIR}/config.yaml"
-  # 2. Generate and install the openim-push configuration file (openim-push.yaml)
-  echo ${LINUX_PASSWORD} | sudo -S bash -c \
-    "./scripts/genconfig.sh ${ENV_FILE} deployments/templates/${SERVER_NAME}.yaml > ${OPENIM_CONFIG_DIR}/${SERVER_NAME}.yaml"
-  openim::log::status "${SERVER_NAME} config file: ${OPENIM_CONFIG_DIR}/${SERVER_NAME}.yaml"
 
   # 3. Create and install the ${SERVER_NAME} systemd unit file
   echo ${LINUX_PASSWORD} | sudo -S bash -c \
-    "./scripts/genconfig.sh ${ENV_FILE} deployments/templates/init/${SERVER_NAME}.service > ${SYSTEM_FILE_PATH}"
+    "SERVER_NAME=${SERVER_NAME} ./scripts/genconfig.sh ${ENV_FILE} deployments/templates/openim.service > ${SYSTEM_FILE_PATH}"
   openim::log::status "${SERVER_NAME} systemd file: ${SYSTEM_FILE_PATH}"
 
   # 4. Start the openim-push service
@@ -125,7 +122,7 @@ function openim::push::uninstall()
   set +o errexit
   openim::common::sudo "systemctl stop ${SERVER_NAME}"
   openim::common::sudo "systemctl disable ${SERVER_NAME}"
-  openim::common::sudo "rm -f ${OPENIM_INSTALL_DIR}/bin/${SERVER_NAME}"
+  openim::common::sudo "rm -f ${OPENIM_INSTALL_DIR}/${SERVER_NAME}"
   openim::common::sudo "rm -f ${OPENIM_CONFIG_DIR}/${SERVER_NAME}.yaml"
   openim::common::sudo "rm -f /etc/systemd/system/${SERVER_NAME}.service"
   set -o errexit
@@ -142,7 +139,7 @@ function openim::push::status()
   }
 
   # The listening port is hardcode in the configuration file
-  if echo | telnet 127.0.0.1 7071 2>&1|grep refused &>/dev/null;then  # Assuming a different port for push
+  if echo | telnet ${OPENIM_MSGGATEWAY_HOST} ${OPENIM_PUSH_PORT} 2>&1|grep refused &>/dev/null;then  # Assuming a different port for push
     openim::log::error "cannot access health check port, ${SERVER_NAME} maybe not startup"
     return 1
   fi

scripts/install/openim-rpc.sh

@@ -160,26 +160,86 @@ function openim::rpc::start_service() {
 }
 
 ###################################### Linux Systemd ######################################
-SYSTEM_FILE_PATH="/etc/systemd/system/${SERVER_NAME}.service"
+declare -A SYSTEM_FILE_PATHS
-
+for service in "${OPENIM_RPC_SERVICE_LISTARIES[@]}"; do
-function openim::rpc::install() {
+    SYSTEM_FILE_PATHS["$service"]="/etc/systemd/system/${service}.service"
-    openim::log::info "Installing ${SERVER_NAME} ..."
+done
+
+# Print the necessary information after installation
+function openim::rpc::info() {
+    for service in "${OPENIM_RPC_SERVICE_LISTARIES[@]}"; do
+        echo "${service} listen on: ${OPENIM_RPC_PORT_LISTARIES[@]}"
+    done
 }
 
-function openim::rpc::uninstall() {
+# install openim-rpc
-    openim::log::info "Uninstalling ${SERVER_NAME} ..."
+function openim::rpc::install()
+{
+    pushd "${OPENIM_ROOT}"
 
-}
+    # 1. Build openim-rpc
+    for service in "${OPENIM_RPC_SERVICE_LISTARIES[@]}"; do
+        make build BINS=${service}
+        openim::common::sudo "cp -r ${OPENIM_OUTPUT_HOSTBIN}/${service} ${OPENIM_INSTALL_DIR}/${service}"
+        openim::log::status "${service} binary: ${OPENIM_INSTALL_DIR}/${service}/${service}"
+    done
 
-function openim::rpc::status() {
+    # 2. Generate and install the openim-rpc configuration file (config)
-    openim::log::info "Checking ${SERVER_NAME} status ..."
+    openim::log::status "openim-rpc config file: ${OPENIM_CONFIG_DIR}/config.yaml"
 
-    openim::util::check_ports ${OPENIM_RPC_PORT_TARGETS[@]}
+    # 3. Create and install the systemd unit files
-    # openim::util::check_ports ${OPENIM_RPC_PROM_PORT_TARGETS[@]}
+    for service in "${OPENIM_RPC_SERVICE_LISTARIES[@]}"; do
+        echo ${LINUX_PASSWORD} | sudo -S bash -c \
+            "SERVER_NAME=${service} ./scripts/genconfig.sh ${ENV_FILE} deployments/templates/openim.service > ${SYSTEM_FILE_PATHS[$service]}"
+        openim::log::status "${service} systemd file: ${SYSTEM_FILE_PATHS[$service]}"
+    done
 
-    openim::util::check_process_names ${SERVER_NAME}
+    # 4. Start the openim-rpc services
+    openim::common::sudo "systemctl daemon-reload"
+    for service in "${OPENIM_RPC_SERVICE_LISTARIES[@]}"; do
+        openim::common::sudo "systemctl restart ${service}"
+        openim::common::sudo "systemctl enable ${service}"
+    done
+    openim::rpc::status || return 1
+    openim::rpc::info
+
+    openim::log::info "install openim-rpc successfully"
+    popd
+}
+
+# Unload
+function openim::rpc::uninstall()
+{
+    set +o errexit
+    for service in "${OPENIM_RPC_SERVICE_LISTARIES[@]}"; do
+        openim::common::sudo "systemctl stop ${service}"
+        openim::common::sudo "systemctl disable ${service}"
+        openim::common::sudo "rm -f ${OPENIM_INSTALL_DIR}/${service}"
+        openim::common::sudo "rm -f ${OPENIM_CONFIG_DIR}/${service}.yaml"
+        openim::common::sudo "rm -f ${SYSTEM_FILE_PATHS[$service]}"
+    done
+    set -o errexit
+    openim::log::info "uninstall openim-rpc successfully"
+}
+
+# Status Check
+function openim::rpc::status()
+{
+    for service in "${OPENIM_RPC_SERVICE_LISTARIES[@]}"; do
+        # Check the running status of the ${service}. If active (running) is displayed, the ${service} is started successfully.
+        systemctl status ${service}|grep -q 'active' || {
+            openim::log::error "${service} failed to start, maybe not installed properly"
+            return 1
+        }
+
+        # The listening port is hardcoded in the configuration file
+        if echo | telnet ${OPENIM_MSGGATEWAY_HOST} ${OPENIM_RPC_PORT_LISTARIES[@]} 2>&1|grep refused &>/dev/null;then
+            openim::log::error "cannot access health check port, ${service} maybe not startup"
+            return 1
+        fi
+    done
 }
 
 if [[ "$*" =~ openim::rpc:: ]];then
-  eval $*
+    eval $*
-fi
+fi

tools/infra/infra.go

@@ -1,29 +1,25 @@
-// Copyright © 2023 OpenIM. All rights reserved.
-//
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-//     http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-
 package main
 
 import (
 	"fmt"
-	"log"
+
+	"github.com/fatih/color"
 )
 
+// 定义一个函数以打印重要的链接信息
+func printLinks() {
+	blue := color.New(color.FgBlue).SprintFunc()
+	fmt.Printf("OpenIM Github: %s\n", blue("https://github.com/OpenIMSDK/Open-IM-Server"))
+	fmt.Printf("Slack Invitation: %s\n", blue("https://openimsdk.slack.com"))
+}
+
 func main() {
-	log.Println("Current module is still under development.")
+	yellow := color.New(color.FgYellow)
-	message := `
+	blue := color.New(color.FgBlue, color.Bold)
-Current module is still under development.
+
+	yellow.Println("Current module is still under development.")
 
+	message := `
 ____                       _____  __  __ 
 / __ \                     |_   _||  \/  |
 | |  | | _ __    ___  _ __    | |  | \  / |
@@ -36,5 +32,6 @@ ____                       _____  __  __
 Keep checking for updates!
 `
 
-	fmt.Println(message)
+	blue.Println(message)
+	printLinks() // 调用函数以打印链接信息
 }

tools/versionchecker/versionchecker.go

@@ -20,9 +20,12 @@ import (
 	"os/exec"
 	"runtime"
 	"time"
+
+	"github.com/fatih/color"
+	"github.com/openimsdk/open-im-server/v3/pkg/common/version"
 )
 
-func executeCommand(cmdName string, args ...string) (string, error) {
+func ExecuteCommand(cmdName string, args ...string) (string, error) {
 	cmd := exec.Command(cmdName, args...)
 	var out bytes.Buffer
 	var stderr bytes.Buffer
@@ -31,19 +34,15 @@ func executeCommand(cmdName string, args ...string) (string, error) {
 
 	err := cmd.Run()
 	if err != nil {
-		return "", fmt.Errorf("Error executing %s: %v", cmdName, err)
+		return "", fmt.Errorf("error executing %s: %v, stderr: %s", cmdName, err, stderr.String())
 	}
 	return out.String(), nil
 }
 
 func printTime() string {
 	currentTime := time.Now()
-
-	// 使用 Format 函数以优雅的方式格式化日期和时间
-	// 2006-01-02 15:04:05 是 Go 中的标准时间格式
 	formattedTime := currentTime.Format("2006-01-02 15:04:05")
-
+	return fmt.Sprintf("Current Date & Time: %s", formattedTime)
-	return fmt.Sprintf("Current Date & Time:", formattedTime)
 }
 
 func getGoVersion() string {
@@ -54,7 +53,7 @@ func getGoVersion() string {
 }
 
 func getDockerVersion() string {
-	version, err := executeCommand("docker", "--version")
+	version, err := ExecuteCommand("docker", "--version")
 	if err != nil {
 		return "Docker is not installed. Please install it to get the version."
 	}
@@ -62,7 +61,7 @@ func getDockerVersion() string {
 }
 
 func getDockerComposeVersion() string {
-	version, err := executeCommand("docker-compose", "--version")
+	version, err := ExecuteCommand("docker-compose", "--version")
 	if err != nil {
 		return "Docker Compose is not installed. Please install it to get the version."
 	}
@@ -70,7 +69,7 @@ func getDockerComposeVersion() string {
 }
 
 func getKubernetesVersion() string {
-	version, err := executeCommand("kubectl", "version", "--client", "--short")
+	version, err := ExecuteCommand("kubectl", "version", "--client", "--short")
 	if err != nil {
 		return "Kubernetes is not installed. Please install it to get the version."
 	}
@@ -78,7 +77,7 @@ func getKubernetesVersion() string {
 }
 
 func getGitVersion() string {
-	version, err := executeCommand("git", "branch", "--show-current")
+	version, err := ExecuteCommand("git", "branch", "--show-current")
 	if err != nil {
 		return "Git is not installed. Please install it to get the version."
 	}
@@ -88,28 +87,42 @@ func getGitVersion() string {
 // NOTE: You'll need to provide appropriate commands for OpenIM versions.
 func getOpenIMServerVersion() string {
 	// Placeholder
-	return "OpenIM Server: v3.2"
+	openimVersion := version.GetSingleVersion()
+	return "OpenIM Server: " + openimVersion + "\n"
 }
 
-func getOpenIMClientVersion() string {
+func getOpenIMClientVersion() (string, error) {
-	// Placeholder
+	openIMClientVersion, err := version.GetClientVersion()
-	return "OpenIM Client: v3.2"
+	if err != nil {
+		return "", err
+	}
+	return "OpenIM Client: " + openIMClientVersion.ClientVersion + "\n", nil
 }
 
 func main() {
-	fmt.Println(printTime())
+	red := color.New(color.FgRed).SprintFunc()
-	fmt.Println("# Diagnostic Tool Result\n")
+	green := color.New(color.FgGreen).SprintFunc()
-	fmt.Println("## Go Version")
+	blue := color.New(color.FgBlue).SprintFunc()
+	yellow := color.New(color.FgYellow).SprintFunc()
+
+	fmt.Println(green(printTime()))
+	fmt.Println(yellow("# Diagnostic Tool Result\n"))
+	fmt.Println(blue("## Go Version"))
 	fmt.Println(getGoVersion())
-	fmt.Println("## Branch Type")
+	fmt.Println(blue("## Branch Type"))
 	fmt.Println(getGitVersion())
-	fmt.Println("## Docker Version")
+	fmt.Println(blue("## Docker Version"))
 	fmt.Println(getDockerVersion())
-	fmt.Println("## Docker Compose Version")
+	fmt.Println(blue("## Docker Compose Version"))
 	fmt.Println(getDockerComposeVersion())
-	fmt.Println("## Kubernetes Version")
+	fmt.Println(blue("## Kubernetes Version"))
 	fmt.Println(getKubernetesVersion())
-	fmt.Println("## OpenIM Versions")
+	fmt.Println(blue("## OpenIM Versions"))
 	fmt.Println(getOpenIMServerVersion())
-	fmt.Println(getOpenIMClientVersion())
+	// clientVersion, err := getOpenIMClientVersion()
-}
+	// if err != nil {
+	// 	fmt.Println(red("Error getting OpenIM Client Version: "), err)
+	// } else {
+	// 	fmt.Println(clientVersion)
+	// }
+}