feat(release-v3.4): Enhanced Build, Deployment, and Configuration Management for Optimized Performance and Automation (#1255)

* docs: add openim docs

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

* docs: add openim images test

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

* feat: fix openim ci and deployment

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

* feat: fix openim ci and deployment

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

* feat: add openim flag api configpath env set

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

* fix: fix openim push logger

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

* fix: fix openim config path

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

* fix: fix openim config path

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

* fix: fix openim config path

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

---------

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

.docker-compose_cfg/config.yaml

@@ -0,0 +1,79 @@
+# 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.
+
+#---------------Infrastructure configuration---------------------#
+etcd:
+  etcdSchema: openim  #默认即可
+  etcdAddr: [ 127.0.0.1:2379 ] #单机部署时，默认即可
+  userName:
+  password:
+  secret: openIM123
+
+mysql:
+  dbMysqlDatabaseName: admin_chat # 数据库名字 默认即可
+
+# 默认管理员账号
+admin:
+  defaultAccount:
+    account: [ "admin1", "admin2" ]
+    defaultPassword: [ "password1", "password2" ]
+    openIMUserID: [ "openIM123456", "openIMAdmin" ]
+    faceURL: [ "", "" ]
+    nickname: [ "admin1", "admin2" ]
+    level: [ 1, 100 ]
+
+
+adminapi:
+  openImAdminApiPort: [ 10009 ] #管理后台api服务端口，默认即可，需要开放此端口或做nginx转发
+  listenIP: 0.0.0.0
+
+chatapi:
+  openImChatApiPort: [ 10008 ] #登录注册，默认即可，需要开放此端口或做nginx转发
+  listenIP: 0.0.0.0
+
+rpcport: # rpc服务端口 默认即可
+  openImAdminPort: [ 30200 ]
+  openImChatPort: [ 30300 ]
+
+
+rpcregistername: #rpc注册服务名，默认即可
+  openImChatName: Chat
+  openImAdminCMSName: Admin
+
+chat:
+  codeTTL: 300 #短信验证码有效时间(秒)
+  superVerificationCode: 666666 # 超级验证码
+  alismsverify: #阿里云短信配置，在阿里云申请成功后修改以下四项
+    accessKeyId:
+    accessKeySecret:
+    signName:
+    verificationCodeTemplateCode:
+
+
+oss:
+  tempDir: enterprise-temp # 临时密钥上传的目录
+  dataDir: enterprise-data # 最终存放目录
+  aliyun:
+    endpoint: https://oss-cn-chengdu.aliyuncs.com
+    accessKeyID: ""
+    accessKeySecret: ""
+    bucket: ""
+  tencent:
+    BucketURL: ""
+    serviceURL: https://cos.COS_REGION.myqcloud.com
+    secretID: ""
+    secretKey: ""
+    sessionToken: ""
+    bucket: ""
+  use: "minio"

.docker-compose_cfg/datasource-compose.yaml

@@ -0,0 +1,27 @@
+# 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.
+
+#more datasource-compose.yaml 
+apiVersion: 1
+
+datasources:
+- name: Prometheus
+  type: prometheus
+  access: proxy
+  orgId: 1
+  url: http://127.0.0.1:9091
+  basicAuth: false
+  isDefault: true
+  version: 1
+  editable: true

.docker-compose_cfg/grafana.ini

@@ -306,7 +306,7 @@ content_security_policy = false
 # Set Content Security Policy template used when adding the Content-Security-Policy header to your requests.
 # $NONCE in the template includes a random nonce.
 # $ROOT_PATH is server.root_url without the protocol.
-content_security_policy_template = """script-src 'self' 'unsafe-eval' 'unsafe-inline' 'strict-dynamic' $NONCE;object-src 'none';font-src 'self';style-src 'self' 'unsafe-inline' blob:;img-src * data:;base-uri 'self';connect-src 'self' grafana.com ws://$ROOT_PATH wss://$ROOT_PATH;manifest-src 'self';media-src 'none';form-action 'self';"""
+content_security_policy_template = """scripts-src 'self' 'unsafe-eval' 'unsafe-inline' 'strict-dynamic' $NONCE;object-src 'none';font-src 'self';style-src 'self' 'unsafe-inline' blob:;img-src * data:;base-uri 'self';connect-src 'self' grafana.com ws://$ROOT_PATH wss://$ROOT_PATH;manifest-src 'self';media-src 'none';form-action 'self';"""
 
 # Controls if old angular plugins are supported or not. This will be disabled by default in future release
 angular_support_enabled = true
@@ -633,7 +633,7 @@ active_sync_enabled = true
 #################################### AWS ###########################
 [aws]
 # Enter a comma-separated list of allowed AWS authentication providers.
-# Options are: default (AWS SDK Default), keys (Access && secret key), credentials (Credentials field), ec2_iam_role (EC2 IAM Role)
+# Options are: default (AWS SDK Default), keys (Access && secret key), credentials (Credentials field), ec2_iam_role (EC2 OpenIM Role)
 allowed_auth_providers = default,keys,credentials
 
 # Allow AWS users to assume a role using temporary security credentials.

.docker-compose_cfg/prometheus-compose.yml

@@ -1,3 +1,17 @@
+# 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.
+
 #more prometheus-compose.yml 
 global:
   scrape_interval:     15s 
@@ -17,11 +31,6 @@ scrape_configs:
         labels:
           group: 'api'
 
-      - targets: ['localhost:10006']
-        labels:
-          group: 'cms-api'
-          
-
       - targets: ['localhost:20110']
         labels:
           group: 'user'
@@ -52,27 +61,13 @@ scrape_configs:
 
       - targets: ['localhost:20120']
         labels:
-          group: 'friend'    
+          group: 'friend'
 
-      - targets: ['localhost:20200']
-        labels:
-          group: 'admin-cms' 
-      
-      - targets: ['localhost:20120']
-        labels:
-          group: 'office' 
-      
-      - targets: ['localhost:20220']
-        labels:
-          group: 'organization' 
       
       - targets: ['localhost:20230']
         labels:
           group: 'conversation' 
-      
-      - targets: ['localhost:20240']
-        labels:
-          group: 'cache' 
+
       
       - targets: ['localhost:21400', 'localhost:21401', 'localhost:21402', 'localhost:21403']
         labels:

.dockerignore

@@ -0,0 +1,32 @@
+# Ignore files and directories starting with a dot
+
+# Ignore specific files
+.dockerignore
+.git
+
+# Ignore build artifacts
+_output/
+logs/
+
+# Ignore non-essential documentation
+README.md
+README-zh_CN.md
+CONTRIBUTING.md
+CHANGELOG/
+# LICENSE
+
+# Ignore testing and linting configuration
+.golangci.yml
+
+# Ignore deployment-related files
+docker-compose.yaml
+deployments/
+
+# Ignore assets
+assets/
+
+# Ignore components
+components/
+
+# Ignore tools and scripts
+.github/

.env

@@ -0,0 +1,278 @@
+# 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.
+
+# ======================================
+# ========= Basic Configuration ========
+# ======================================
+
+# The user for authentication or system operations.
+# Default: USER=root
+USER=root
+
+# Password associated with the specified user for authentication.
+# Default: PASSWORD=openIM123
+PASSWORD=openIM123
+
+# Endpoint for the MinIO object storage service.
+# Default: MINIO_ENDPOINT=http://172.28.0.1:10005
+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
+
+# Directory path for storing data files or related information.
+# Default: DATA_DIR=./
+DATA_DIR=./
+
+# ======================================
+# ========= Network Configuration ======
+# ======================================
+
+# Subnet for the Docker network.
+# Default: DOCKER_BRIDGE_SUBNET=172.28.0.0/16
+DOCKER_BRIDGE_SUBNET=172.28.0.0/16
+
+# Gateway for the Docker network.
+# Default: DOCKER_BRIDGE_GATEWAY=172.28.0.1
+DOCKER_BRIDGE_GATEWAY=172.28.0.1
+
+# Address or hostname for the MySQL network.
+# Default: MYSQL_NETWORK_ADDRESS=172.28.0.2
+MYSQL_NETWORK_ADDRESS=172.28.0.2
+
+# Address or hostname for the MongoDB network.
+# Default: MONGO_NETWORK_ADDRESS=172.28.0.3
+MONGO_NETWORK_ADDRESS=172.28.0.3
+
+# Address or hostname for the Redis network.
+# Default: REDIS_NETWORK_ADDRESS=172.28.0.4
+REDIS_NETWORK_ADDRESS=172.28.0.4
+
+# Address or hostname for the Kafka network.
+# Default: KAFKA_NETWORK_ADDRESS=172.28.0.5
+KAFKA_NETWORK_ADDRESS=172.28.0.5
+
+# Address or hostname for the ZooKeeper network.
+# Default: ZOOKEEPER_NETWORK_ADDRESS=172.28.0.6
+ZOOKEEPER_NETWORK_ADDRESS=172.28.0.6
+
+# Address or hostname for the MinIO network.
+# Default: MINIO_NETWORK_ADDRESS=172.28.0.7
+MINIO_NETWORK_ADDRESS=172.28.0.7
+
+# Address or hostname for the OpenIM web network.
+# Default: OPENIM_WEB_NETWORK_ADDRESS=172.28.0.8
+OPENIM_WEB_NETWORK_ADDRESS=172.28.0.8
+
+# Address or hostname for the OpenIM server network.
+# Default: OPENIM_SERVER_NETWORK_ADDRESS=172.28.0.9
+OPENIM_SERVER_NETWORK_ADDRESS=172.28.0.9
+
+# Address or hostname for the OpenIM chat network.
+# Default: OPENIM_CHAT_NETWORK_ADDRESS=172.28.0.10
+OPENIM_CHAT_NETWORK_ADDRESS=172.28.0.10
+
+# Address or hostname for the Prometheus network.
+# Default: PROMETHEUS_NETWORK_ADDRESS=172.28.0.11
+PROMETHEUS_NETWORK_ADDRESS=172.28.0.11
+
+# Address or hostname for the Grafana network.
+# Default: GRAFANA_NETWORK_ADDRESS=172.28.0.12
+GRAFANA_NETWORK_ADDRESS=172.28.0.12
+
+
+# ===============================================
+# = Component Extension Configuration =
+# ===============================================
+
+# ============ Component Extension Configuration ==========
+# ----- ZooKeeper Configuration -----
+# Address or hostname for the ZooKeeper service.
+# Default: ZOOKEEPER_ADDRESS=172.28.0.1
+ZOOKEEPER_ADDRESS=172.28.0.6
+
+# Port for ZooKeeper service.
+# Default: ZOOKEEPER_PORT=12181
+ZOOKEEPER_PORT=12181
+
+# ----- MySQL Configuration -----
+
+# Address or hostname for the MySQL service.
+# Default: MYSQL_ADDRESS=172.28.0.1
+MYSQL_ADDRESS=172.28.0.2
+
+# Port on which MySQL database service is running.
+# Default: MYSQL_PORT=13306
+MYSQL_PORT=13306
+
+# Password to authenticate with the MySQL database service.
+# Default: MYSQL_PASSWORD=openIM123
+MYSQL_PASSWORD=openIM123
+
+# ----- MongoDB Configuration -----
+# Address or hostname for the MongoDB service.
+# Default: MONGO_ADDRESS=172.28.0.1
+MONGO_ADDRESS=172.28.0.3
+
+# Port on which MongoDB service is running.
+# Default: MONGO_PORT=37017
+MONGO_PORT=37017
+
+# Username to authenticate with the MongoDB service.
+# Default: MONGO_USERNAME=root
+MONGO_USERNAME=root
+
+# Password to authenticate with the MongoDB service.
+# Default: MONGO_PASSWORD=openIM123
+MONGO_PASSWORD=openIM123
+
+# Name of the database in MongoDB to be used.
+# Default: MONGO_DATABASE=openIM_v3
+MONGO_DATABASE=openIM_v3
+
+# ----- Redis Configuration -----
+# Address or hostname for the Redis service.
+# Default: REDIS_ADDRESS=172.28.0.1
+REDIS_ADDRESS=172.28.0.4
+
+# Port on which Redis in-memory data structure store is running.
+# Default: REDIS_PORT=16379
+REDIS_PORT=16379
+
+# Password to authenticate with the Redis service.
+# Default: REDIS_PASSWORD=openIM123
+REDIS_PASSWORD=openIM123
+
+# ----- Kafka Configuration -----
+# Address or hostname for the Kafka service.
+# Default: KAFKA_ADDRESS=172.28.0.1
+KAFKA_ADDRESS=172.28.0.5
+
+# Port on which Kafka distributed streaming platform is running.
+# Default: KAFKA_PORT=19092
+KAFKA_PORT=19094
+
+# Topic in Kafka for storing the latest messages in Redis.
+# Default: KAFKA_LATESTMSG_REDIS_TOPIC=latestMsgToRedis
+KAFKA_LATESTMSG_REDIS_TOPIC=latestMsgToRedis
+
+# Topic in Kafka for pushing messages (e.g. notifications or updates).
+# Default: KAFKA_MSG_PUSH_TOPIC=msgToPush
+KAFKA_MSG_PUSH_TOPIC=msgToPush
+
+# Topic in Kafka for storing offline messages in MongoDB.
+# Default: KAFKA_OFFLINEMSG_MONGO_TOPIC=offlineMsgToMongoMysql
+KAFKA_OFFLINEMSG_MONGO_TOPIC=offlineMsgToMongoMysql
+
+# ----- MinIO Configuration ----
+# Address or hostname for the MinIO object storage service.
+# Default: MINIO_ADDRESS=172.28.0.1
+MINIO_ADDRESS=172.28.0.7
+
+# Port on which MinIO object storage service is running.
+# Default: MINIO_PORT=10005
+MINIO_PORT=10005
+
+# Access key to authenticate with the MinIO service.
+# Default: MINIO_ACCESS_KEY=root
+MINIO_ACCESS_KEY=root
+
+# Secret key corresponding to the access key for MinIO authentication.
+# Default: MINIO_SECRET_KEY=openIM123
+MINIO_SECRET_KEY=openIM123
+
+# ----- Prometheus Configuration -----
+# Address or hostname for the Prometheus service.
+# Default: PROMETHEUS_ADDRESS=172.28.0.1
+PROMETHEUS_ADDRESS=172.28.0.11
+
+# Port on which Prometheus service is running.
+# Default: PROMETHEUS_PORT=19090
+PROMETHEUS_PORT=19090
+
+# ----- Grafana Configuration -----
+# Address or hostname for the Grafana service.
+# Default: GRAFANA_ADDRESS=172.28.0.1
+GRAFANA_ADDRESS=172.28.0.12
+
+# Port on which Grafana service is running.
+# Default: GRAFANA_PORT=3000
+GRAFANA_PORT=3000
+
+# ======================================
+# ============ OpenIM Web ===============
+# ======================================
+
+# Path to the OpenIM web distribution.
+# Default: OPENIM_WEB_DIST_PATH=/app/dist
+OPENIM_WEB_DIST_PATH=/app/dist
+
+# Port on which OpenIM web service is running.
+# Default: OPENIM_WEB_PORT=11001
+OPENIM_WEB_PORT=11001
+
+# Address or hostname for the OpenIM web service.
+# Default: OPENIM_WEB_ADDRESS=172.28.0.1
+OPENIM_WEB_ADDRESS=172.28.0.8
+
+# ======================================
+# ========= OpenIM Server ==============
+# ======================================
+
+# Address or hostname for the OpenIM server.
+# Default: OPENIM_SERVER_ADDRESS=172.28.0.1
+OPENIM_SERVER_ADDRESS=172.28.0.9
+
+# Port for the OpenIM WebSockets.
+# Default: OPENIM_WS_PORT=10001
+OPENIM_WS_PORT=10001
+
+# Port for the OpenIM API.
+# Default: API_OPENIM_PORT=10002
+API_OPENIM_PORT=10002
+
+
+# ======================================
+# ========== OpenIM Chat ===============
+# ======================================
+
+# Branch name for OpenIM chat.
+# Default: CHAT_BRANCH=main
+CHAT_BRANCH=main
+
+# Address or hostname for the OpenIM chat service.
+# Default: OPENIM_CHAT_ADDRESS=172.28.0.1
+OPENIM_CHAT_ADDRESS=172.28.0.10
+
+# Port for the OpenIM chat API.
+# Default: OPENIM_CHAT_API_PORT=10008
+OPENIM_CHAT_API_PORT=10008
+
+# Directory path for storing data files or related information for OpenIM chat.
+# Default: OPENIM_CHAT_DATA_DIR=./openim-chat/main
+OPENIM_CHAT_DATA_DIR=./openim-chat/main
+
+
+# ======================================
+# ========== OpenIM Admin ==============
+# ======================================
+
+# Branch name for OpenIM server.
+# Default: SERVER_BRANCH=main
+SERVER_BRANCH=main
+
+# Port for the OpenIM admin API.
+# Default: OPENIM_ADMIN_API_PORT=10009
+OPENIM_ADMIN_API_PORT=10009

.github/.codecov.yml

@@ -0,0 +1,23 @@
+# 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.
+
+coverage:
+  status:
+    project:
+      default: false # disable the default status that measures entire project
+      pkg: # declare a new status context "pkg"
+        paths:
+          - pkg/* # only include coverage in "pkg/" folder
+        informational: true # Always pass check
+    patch: off # disable the commit only checks

.github/ISSUE_TEMPLATE/ISSUE_TEMPLATE.md

@@ -1,37 +0,0 @@
----
-name: "\U0001F41E Bug"
-about: File a bug/issue
-title: "[BUG] <title>"
-labels: ''
-assignees: ''
-
----
-
-<!--
-Note: Please search to see if an issue already exists for the bug you encountered.
--->
-
-### Environment:
-<!-- linux? windows? or Mac?
-Example:
-- OS: Ubuntu 20.04 -->
-
-### Physical Memory Capacity:
-<!-- 8G or above is better -->
-
-### Docker Image:
-<!-- Did you pull the docker image before execute docker images -->
-
-### Code Version:
-<!-- Did you pull code from github? Make sure the code is up to date-->
-
-### Component installation:
-<!-- Has etcd, mysql, mongodb, redis or Kafka been installed on the server before Open-IM-Server deployment-->
-
-
-### Log File:
-<!-- view log file(logs/openIM.log) content. -->
-
-
-### screenshot:
-<!---->

.github/ISSUE_TEMPLATE/deployment-issues.md

@@ -1,36 +0,0 @@
----
-name: Deployment issues
-about: Deployment issues
-title: ''
-labels: ''
-assignees: ''
-
----
-
-If you are deploying OpenIM for the first time
-
-
-
-```
-git clone https://github.com/OpenIMSDK/Open-IM-Server.git --recursive
-```
-
-screenshot here
-
-```
-cd Open-IM-Server/script ; chmod +x *.sh ; ./env_check.sh
-```
-
-screenshot here
-
-```
-cd .. ; docker-compose up -d
-```
-
-screenshot here
-
-```
-cd script ; ./docker_check_service.sh
-```
-
-screenshot here

.github/ISSUE_TEMPLATE/update-.md

@@ -1,38 +0,0 @@
----
-name: 'update '
-about: update docker image
-title: update docker image
-labels: ''
-assignees: ''
-
----
-
-```
-cd Open-IM-Server ; docker-compose down
-```
-
-screenshot here
-
-```
-git pull
-```
-
-screenshot here
-
-```
-docker-compose pull
-```
-
-screenshot here
-
-```
-chmod +x script/*.sh ; docker-compose up -d
-```
-
-screenshot here
-
-```
-cd script ; ./docker_check_service.sh
-```
-
-screenshot here

.github/dependabot.yml

@@ -0,0 +1,59 @@
+# 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.
+
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "gomod"
+    directory: "/"
+    schedule:
+      interval: "daily"
+      time: "08:00"
+    labels:
+      - "dependencies"
+    commit-message:
+      prefix: "feat"
+      include: "scope"
+    groups:
+      gomod-deps:
+        patterns:
+          - "*"
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "daily"
+      time: "08:00"
+    labels:
+      - "dependencies"
+    commit-message:
+      prefix: "chore"
+      include: "scope"
+    groups:
+      github-actions:
+        patterns:
+          - "*"
+  - package-ecosystem: "docker"
+    directory: "/"
+    schedule:
+      interval: "daily"
+      time: "08:00"
+    labels:
+      - "dependencies"
+    commit-message:
+      prefix: "feat"
+      include: "scope"

.github/labels.yml

@@ -0,0 +1,43 @@
+# 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.
+
+# Refer to Kubernetes for size/* Settings
+# https://github.com/Kubernetes/Kubernetes
+XS:
+  name: size/XS
+  lines: 0
+  color: 3CBF00
+S:
+  name: size/S
+  lines: 10
+  color: 5D9801
+M:
+  name: size/M
+  lines: 30
+  color: 7F7203
+L:
+  name: size/L
+  lines: 100
+  color: A14C05
+XL:
+  name: size/XL
+  lines: 500
+  color: C32607
+XXL:
+  name: size/XXL
+  lines: 1000
+  color: E50009
+  comment: |
+    # Whoa! Easy there, Partner!
+    This PR is too big. Please break it up into smaller PRs.

.github/release-drafter.yml

@@ -0,0 +1,51 @@
+# 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.
+
+name-template: 'v$RESOLVED_VERSION 🌈'
+tag-template: 'v$RESOLVED_VERSION'
+categories:
+  - title: '🚀 Features'
+    labels:
+      - 'feature'
+      - 'enhancement'
+  - title: '🐛 Bug Fixes'
+    labels:
+      - 'kind/fix'
+      - 'kind/feature'
+      - 'enhancement'
+      - 'kind/documentation'
+      - 'good first issue'
+  - title: '🧰 Maintenance'
+    label: 'chore'
+change-template: '- $TITLE @$AUTHOR (#$NUMBER)'
+change-title-escapes: '\<*_&' # You can add # and @ to disable mentions, and add ` to disable code blocks.
+version-resolver:
+  major:
+    labels:
+      - 'major'
+  minor:
+    labels:
+      - 'minor'
+  patch:
+    labels:
+      - 'patch'
+  default: patch
+template: |
+  ## Changes $PREVIOUS_TAG
+
+  $CHANGES
+
+  ## Contributors to this $REPOSITORY	release
+
+  $CONTRIBUTORS	

.github/sync-release.yml

@@ -0,0 +1,30 @@
+# 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.
+
+OpenIMSDK/openim-docker:
+  - source: ./config
+    dest: ./openim-server/release/config
+    replace: true
+  - source: ./docs
+    dest: ./openim-server/release/docs
+    replace: true
+  - source: ./scripts
+    dest: ./openim-server/release/scripts
+    replace: true
+  - source: ./scripts
+    dest: ./scripts
+    replace: false
+  - source: ./Makefile
+    dest: ./Makefile
+    replace: false

.github/sync.yml

@@ -0,0 +1,136 @@
+# 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.
+
+# https://github.com/BetaHuhn/repo-file-sync-action
+# Synchronization for the.github repository
+OpenIMSDK/.github:
+  - source: LICENSE
+    dest: LICENSE 
+  - source: scripts/LICENSE/
+    dest: scripts/LICENSE/
+    replace: false
+
+OpenIMSDK/community:
+  - source: LICENSE
+    dest: LICENSE
+  - source: scripts/LICENSE/
+    dest: scripts/LICENSE/
+    replace: false
+  - source: .github/workflows/
+    dest: .github/workflows/
+
+OpenIMSDK/openim-sdk-core:
+  - source: LICENSE
+    dest: LICENSE
+  - source: scripts/LICENSE/
+    dest: scripts/LICENSE/
+    replace: false
+  - source: .github/workflows/issue-robot.yml
+    dest: .github/workflows/issue-robot.yml
+    replace: false
+  - source: .github/workflows/stale.yml
+    dest: .github/workflows/stale.yml
+    replace: false
+  - source: .github/.codecov.yml
+    dest: .github/.codecov.yml
+    replace: false
+
+OpenIMSDK/OpenIM-Docs:
+  - source: .github/workflows/
+    dest: .github/workflows/
+    exclude: |
+      e2e-test.yml
+      sync.yml
+  - source: scripts/githooks/
+    dest: scripts/githooks/
+    replace: true
+  - source: .github/.codecov.yml
+    dest: .github/.codecov.yml
+    replace: false
+
+OpenIMSDK/OpenKF:
+  - source: LICENSE
+    dest: LICENSE
+  - source: scripts/LICENSE/
+    dest: scripts/LICENSE/
+    replace: false
+  - source: .github/workflows/issue-robot.yml
+    dest: .github/workflows/issue-robot.yml
+    replace: false
+  - source: .github/workflows/stale.yml
+    dest: .github/workflows/stale.yml
+    replace: false
+  - source: .github/.codecov.yml
+    dest: .github/.codecov.yml
+    replace: false
+
+OpenIMSDK/openim-docker:
+  - source: ./config
+    dest: ./openim-server/main/config
+    replace: true
+  - source: ./docs
+    dest: ./openim-server/main/docs
+    replace: true
+  - source: ./scripts
+    dest: ./openim-server/main/scripts
+    replace: true
+  - source: ./scripts
+    dest: ./scripts
+    replace: true
+  - source: ./Makefile
+    dest: ./Makefile
+    replace: true
+
+group:
+  # first group：common to all warehouses
+  # TODO: add the required warehouse here
+  - repos: |
+      OpenIMSDK/OpenKF@main
+      OpenIMSDK/openim-miniprogram-demo@main
+      OpenIMSDK/docs
+      OpenIMSDK/chat
+      OpenIMSDK/community
+      OpenIMSDK/openim-charts
+      OpenIMSDK/openim-sdk-cpp@main
+    files:
+      - source: LICENSE
+        dest: LICENSE
+        replace: false
+      - source: .github/workflows/issue-robot.yml
+        dest: .github/workflows/issue-robot.yml
+        replace: false
+      - source: .github/workflows/stale.yml
+        dest: .github/workflows/stale.yml
+        replace: false
+      - source: .github/workflows/project-progress.yml
+        dest: .github/workflows/project-progress.yml
+        replace: false 
+      - source: .github/workflows/help-comment-issue.yml
+        dest: .github/workflows/help-comment-issue.yml
+        replace: false
+      - source: .github/.codecov.yml
+        dest: .github/.codecov.yml
+        replace: false
+      - source: .github/workflows/cla.yml
+        dest: .github/workflows/cla.yml
+        replace: false
+      - source: .github/workflows/auto-assign-issue.yml
+        dest: .github/workflows/auto-assign-issue.yml
+        replace: false
+      - source: .github/workflows/release.yml
+        dest: .github/workflows/release.yml
+        replace: false
+      - source: ./scripts/githooks/
+        dest: ./scripts/githooks/
+        replace: true

.github/weekly-digest.yml

@@ -0,0 +1,21 @@
+# 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.
+
+# https://github.com/apps/weekly-digest/installations/new
+publishDay: sun
+canPublishIssues: true
+canPublishPullRequests: true
+canPublishContributors: true
+canPublishStargazers: true
+canPublishCommits: true

.github/workflows/auto-assign-issue.yml

@@ -0,0 +1,43 @@
+# Copyright © 2023 OpenIM open source community. 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.
+
+name: Assign issue to comment author
+on:
+  issue_comment:
+    types: [created]
+jobs:
+  assign-issue:
+    if: |
+      contains(github.event.comment.body, '/assign') || contains(github.event.comment.body, '/accept') &&
+      !contains(github.event.comment.user.login, 'openimbot') &&
+      !contains(github.event.comment.user.login, 'kubbot')
+    runs-on: ubuntu-latest
+    permissions:
+      issues: write
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Assign the issue
+        run: |
+          export LETASE_MILESTONES=$(curl 'https://api.github.com/repos/$OWNER/$PEPO/milestones' | jq -r 'last(.[]).title')
+          gh issue edit ${{ github.event.issue.number }} --add-assignee "${{ github.event.comment.user.login }}"
+          gh issue edit ${{ github.event.issue.number }} --add-label "triage/accepted"
+          gh issue edit ${{ github.event.issue.number }} --milestone "$LETASE_MILESTONES"
+          gh issue comment $ISSUE --body "@${{ github.event.comment.user.login }} Glad to see you accepted this issue🤲, this issue has been assigned to you. I set the milestones for this issue to [$LETASE_MILESTONES](https://github.com/$OWNER/$PEPO/milestones), We are looking forward to your PR!"
+        env:
+          GH_TOKEN: ${{ secrets.REDBOT_GITHUB_TOKEN }}
+          ISSUE: ${{ github.event.issue.html_url }}
+          OWNER: ${{ github.repository_owner }}
+          REPO: ${{ github.event.repository.name }}

.github/workflows/auto-gh-pr.yml

@@ -0,0 +1,61 @@
+# Copyright © 2023 OpenIM open source community. 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.
+
+name: Auto PR to release
+
+on:
+  pull_request:
+    # types:
+    #   - closed
+  issue_comment:
+    types: [created]
+  pull_request_review_comment:
+    types: [created]
+
+jobs:
+  create-pr:
+    runs-on: ubuntu-latest
+    if: github.event.pull_request.base.ref == 'main'
+    # && github.event.pull_request.merged == true
+    steps:
+        - name: Check out code
+          uses: actions/checkout@v4
+          with:
+            fetch-depth: 0
+
+        - name: Create PR to release branch
+          run: |
+            ISSUEID=$(gh pr view ${{ github.event.pull_request.number }} --repo $OWNER/$REPO | grep -oP 'Fixes #\K\d+')
+            echo "===========> $ISSUEID"
+            ISSUE=$(gh issue view $ISSUEID --repo $OWNER/$REPO --json labels,assignees,milestone,title)
+            echo "===========> $ISSUE"
+
+            LABELS=$(echo $ISSUE | jq -r '.labels[] | select(.name) | .name' | jq -R -r -s -c 'split("\n")[:-1] | join(",")')
+            ASSIGNEES=$(echo $ISSUE | jq -r '.assignees[] | select(.login) | .login' | jq -R -s -c 'split("\n")[:-1] | join(",")')
+            MILESTONE=$(echo $ISSUE | jq -r '.milestone | select(.title) | .title')
+            TITLE=$(echo $ISSUE | jq -r '.title')
+
+            gh pr edit ${{ github.event.pull_request.number }} --repo $OWNER/$REPO --add-label "$LABELS" --add-assignee "$ASSIGNEES" --milestone "$MILESTONE"
+
+            # git checkout -b bot/merge-to-release-$ISSUEID
+            # git push origin bot/merge-to-release-$ISSUEID
+            # gh pr create --base release --head bot/merge-to-release-$ISSUEID --title "Merge main to release" --body ""
+            # gh pr create --base main --head feat/auto-release-pr-624  --title "The bug is fixed" --body "$x" --repo openimsdk/open-im-server --reviewer "cubxxw"
+          continue-on-error: true
+          env:
+              GITHUB_TOKEN: ${{ secrets.BOT_GITHUB_TOKEN }}
+              GH_TOKEN: ${{ github.token }}
+              ISSUE: ${{ github.event.issue.html_url }}
+              OWNER: ${{ github.repository_owner }}
+              REPO: ${{ github.event.repository.name }}

.github/workflows/auto-invite.yml

@@ -0,0 +1,53 @@
+# Copyright © 2023 OpenIM open source community. 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.
+
+name: Invite users to join our group
+on:
+  issue_comment:
+    types:
+      - created
+jobs:
+  issue_comment:
+    name: Invite users to join our group
+    if: ${{ github.event.comment.body == '/invite' || github.event.comment.body == '/close' || github.event.comment.body == '/comment' }}
+    runs-on: ubuntu-latest
+    permissions:
+      issues: write
+    steps:
+
+      - name: Invite user to join our group
+        uses: peter-evans/create-or-update-comment@v3
+        with:
+          token: ${{ secrets.BOT_GITHUB_TOKEN }}
+          issue-number: ${{ github.event.issue.number }}
+          body: |
+            We value close connections with our users, developers, and contributors here at Open-IM-Server. With a large community and maintainer team, we're always here to help and support you. Whether you're looking to join our community or have any questions or suggestions, we welcome you to get in touch with us.
+
+            Our most recommended way to get in touch is through [Slack](https://join.slack.com/t/openimsdk/shared_invite/zt-22720d66b-o_FvKxMTGXtcnnnHiMqe9Q). Even if you're in China, Slack is usually not blocked by firewalls, making it an easy way to connect with us. Our Slack community is the ideal place to discuss and share ideas and suggestions with other users and developers of Open-IM-Server. You can ask technical questions, seek help, or share your experiences with other users of Open-IM-Server.
+            
+            In addition to Slack, we also offer the following ways to get in touch:
+            
+            + <a href="https://join.slack.com/t/openimsdk/shared_invite/zt-22720d66b-o_FvKxMTGXtcnnnHiMqe9Q" target="_blank"><img src="https://img.shields.io/badge/Slack-OpenIM%2B-blueviolet?logo=slack&amp;logoColor=white"></a> We also have Slack channels for you to communicate and discuss. To join, visit https://slack.com/ and join our [👀 Open-IM-Server slack](https://join.slack.com/t/openimsdk/shared_invite/zt-22720d66b-o_FvKxMTGXtcnnnHiMqe9Q) team channel.
+            + <a href="https://mail.google.com/mail/u/0/?fs=1&tf=cm&to=winxu81@gmail.com" target="_blank"><img src="https://img.shields.io/badge/gmail-%40OOpenIMSDKCore?style=social&logo=gmail"></a> Get in touch with us on [Gmail](https://mail.google.com/mail/u/0/?fs=1&tf=cm&to=winxu81@gmail.com). If you have any questions or issues that need resolving, or any suggestions and feedback for our open source projects, please feel free to contact us via email.
+            + <a href="https://doc.rentsoft.cn/" target="_blank"><img src="https://img.shields.io/badge/%E5%8D%9A%E5%AE%A2-%40OpenIMSDKCore-blue?style=social&logo=Octopus%20Deploy"></a> Read our [blog](https://doc.rentsoft.cn/). Our blog is a great place to stay up-to-date with Open-IM-Server projects and trends. On the blog, we share our latest developments, tech trends, and other interesting information.
+            + <a href="https://github.com/OpenIMSDK/OpenIM-Docs/blob/main/docs/images/WechatIMG20.jpeg" target="_blank"><img src="https://img.shields.io/badge/%E5%BE%AE%E4%BF%A1-OpenIMSDKCore-brightgreen?logo=wechat&style=flat-square"></a> Add [Wechat](https://github.com/OpenIMSDK/OpenIM-Docs/blob/main/docs/images/WechatIMG20.jpeg) and indicate that you are a user or developer of Open-IM-Server. We will process your request as soon as possible.
+
+      - name: Close Issue
+        uses: peter-evans/close-issue@v3
+        with:
+          token: ${{ secrets.BOT_GITHUB_TOKEN }}
+          issue-number: ${{ github.event.issue.number }}
+          comment: 🤖 Auto-closing issue, if you still need help please reopen the issue or ask for help in the community above
+          labels: |
+            triage/accepted

.github/workflows/auto-tag.yml

@@ -0,0 +1,52 @@
+# 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.
+
+name: Create Tag
+
+on:
+  issue_comment:
+    types: [created]
+  pull_request_review_comment:
+    types: [created]
+
+jobs:
+  create_tag:
+    runs-on: ubuntu-latest
+    if: startsWith(github.event.comment.body, '/create tag')
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Validate version number and get comment
+        id: validate
+        run: |
+          COMMENT="${{ github.event.comment.body }}"
+          VERSION=$(echo $COMMENT | cut -d ' ' -f 3)
+          TAG_COMMENT=$(echo $COMMENT | cut -d '"' -f 2)
+          if [[ $VERSION =~ ^v([0-9]+\.){2}[0-9]+$ ]]; then
+            echo "version=$VERSION" >> $GITHUB_STATE
+            echo "tag_comment=$TAG_COMMENT" >> $GITHUB_STATE
+          else
+            echo "Invalid version number."
+            exit 1
+          fi
+
+      - name: Create a new tag
+        env:
+          GH_TOKEN: ${{ secrets.BOT_GITHUB_TOKEN }}
+        run: |
+          source $GITHUB_STATE
+          git tag -a $VERSION -m "$tag_comment"
+          git push origin $VERSION
+          echo "tag_created=$VERSION" >> $GITHUB_OUTPUT

.github/workflows/bot-auto-cherry-pick.yml

@@ -0,0 +1,67 @@
+# 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.
+
+name: 'Github Rebot for Cherry Pick when PR is merged'
+on:
+  pull_request_target:
+    types:
+      - closed
+
+jobs:
+  comment:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Comment cherry-pick command
+        uses: actions/github-script@v6
+        with:
+          script: |
+            const pr = context.payload.pull_request;
+            if (!pr.merged) {
+              console.log("PR is not merged. Skipping...");
+              return;
+            }
+            if (!pr.milestone || !pr.milestone.title) {
+              console.log("Milestone is not set. Skipping...");
+              return;
+            }
+            const milestone = pr.milestone.title;
+            const ref = `heads/release-${milestone}`;
+            let branchExists;
+            try {
+              await github.rest.git.getRef({
+                owner: context.repo.owner,
+                repo: context.repo.repo,
+                ref: ref
+              });
+              branchExists = true;
+            } catch (error) {
+              if (error.status === 404) {
+                console.log(`Branch ${ref} does not exist. Skipping...`);
+                branchExists = false;
+              } else {
+                throw error; // Rethrow if it's another error
+              }
+            }
+            if (!branchExists) {
+              return;
+            }
+            const cherryPickCmd = `/cherry-pick release-${milestone}`;
+            console.log(`Adding comment: ${cherryPickCmd}`);
+            await github.rest.issues.createComment({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              issue_number: pr.number,
+              body: cherryPickCmd
+            });
+          github-token: ${{ secrets.BOT_GITHUB_TOKEN }}

.github/workflows/bot-cherry-pick.yml

@@ -0,0 +1,34 @@
+# Copyright © 2023 OpenIM open source community. 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.
+
+name: Github Rebot for Cherry Pick On Comment
+on:
+  issue_comment:
+    types: [created]
+jobs:
+  cherry-pick:
+    name: Cherry Pick
+    # && github.event.comment.user.login=='kubbot'
+    if: github.event.issue.pull_request != '' && contains(github.event.comment.body, '/cherry-pick')
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout the latest code
+        uses: actions/checkout@v4
+        with:
+          token: ${{ secrets.BOT_GITHUB_TOKEN }}
+          fetch-depth: 0 # otherwise, you will fail to push refs to dest repo
+      - name: Automatic Cherry Pick
+        uses: vendoo/gha-cherry-pick@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.BOT_GITHUB_TOKEN }}

.github/workflows/build-docker-image.yml

@@ -0,0 +1,148 @@
+# Copyright © 2023 OpenIM open source community. 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.
+
+name: Publish Docker image
+
+on:
+  schedule:
+  - cron: '30 2 * * *'
+  push:
+    branches:
+      - main
+      - release-*
+    tags:
+      - v*
+  workflow_dispatch:
+
+env:
+  # Common versions
+  GO_VERSION: "1.20"
+
+jobs:
+  build-dockerhub:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v3
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+# docker.io/openim/openim-server:latest
+      - name: Extract metadata (tags, labels) for Docker
+        id: meta
+        uses: docker/metadata-action@v5.0.0
+        with:
+          images: openim/openim-server
+          # generate Docker tags based on the following events/attributes
+          tags: |
+            type=schedule
+            type=ref,event=branch
+            type=ref,event=pr
+            type=semver,pattern={{version}}
+            type=semver,pattern={{major}}.{{minor}}
+            type=semver,pattern={{major}}
+            type=sha
+
+      - name: Log in to Docker Hub
+        uses: docker/login-action@v3
+        with:
+          username: ${{ secrets.DOCKER_USERNAME }}
+          password: ${{ secrets.DOCKER_PASSWORD }}
+
+      - name: Build and push Docker image
+        uses: docker/build-push-action@v5
+        with:
+          context: .
+          # linux/ppc64le,linux/s390x
+          platforms: linux/amd64,linux/arm64
+          push: ${{ github.event_name != 'pull_request' }}
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+
+  build-aliyun:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v3
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+# registry.cn-hangzhou.aliyuncs.com/openimsdk/openim-server:latest
+      - name: Extract metadata (tags, labels) for Docker
+        id: meta2
+        uses: docker/metadata-action@v5.0.0
+        with:
+          images: registry.cn-hangzhou.aliyuncs.com/openimsdk/openim-server
+
+      - name: Log in to AliYun Docker Hub
+        uses: docker/login-action@v3
+        with:
+          registry: registry.cn-hangzhou.aliyuncs.com
+          username: ${{ secrets.ALIREGISTRY_USERNAME }}
+          password: ${{ secrets.ALIREGISTRY_TOKEN }}
+      
+      - name: Build and push Docker image
+        uses: docker/build-push-action@v5
+        with:
+          context: .
+          # linux/ppc64le,linux/s390x
+          platforms: linux/amd64,linux/arm64
+          push: ${{ github.event_name != 'pull_request' }}
+          tags: ${{ steps.meta2.outputs.tags }}
+          labels: ${{ steps.meta2.outputs.labels }}
+
+  build-ghcr:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v3
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+# ghcr.io/openimsdk/openim-server:latest
+      - name: Extract metadata (tags, labels) for Docker
+        id: meta3
+        uses: docker/metadata-action@v5.0.0
+        with:
+          images: ghcr.io/openimsdk/openim-server
+          # generate Docker tags based on the following events/attributes
+          tags: |
+            type=schedule
+            type=ref,event=branch
+            type=ref,event=pr
+            type=semver,pattern={{version}}
+            type=semver,pattern={{major}}.{{minor}}
+            type=semver,pattern={{major}}
+            type=sha
+
+      - name: Log in to GitHub Container Registry
+        uses: docker/login-action@v3
+        with:
+          registry: ghcr.io
+          username: ${{ github.repository_owner }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Build and push Docker image
+        uses: docker/build-push-action@v5
+        with:
+          context: .
+          # linux/ppc64le,linux/s390x
+          platforms: linux/amd64,linux/arm64
+          push: ${{ github.event_name != 'pull_request' }}
+          tags: ${{ steps.meta3.outputs.tags }}
+          labels: ${{ steps.meta3.outputs.labels }}

.github/workflows/build-openim-web-image.yml

@@ -0,0 +1,139 @@
+# Copyright © 2023 OpenIM open source community. 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.
+
+name: Build OpenIM Web Docker image
+
+on:
+  schedule:
+  - cron: '30 3 * * *'
+  push:
+    branches:
+      - main
+      - release-*
+    tags:
+      - v*
+  workflow_dispatch:
+
+env:
+  # Common versions
+  GO_VERSION: "1.20"
+
+jobs:
+  build-openim-web-dockerhub:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v3
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+# docker.io/openim/openim-web:latest
+      - name: Extract metadata (tags, labels) for Docker
+        id: meta
+        uses: docker/metadata-action@v5.0.0
+        with:
+          images: openim/openim-web
+          # generate Docker tags based on the following events/attributes
+          tags: |
+            type=schedule
+            type=ref,event=branch
+            type=ref,event=pr
+            type=semver,pattern={{version}}
+            type=semver,pattern={{major}}.{{minor}}
+            type=semver,pattern={{major}}
+            type=sha
+
+      - name: Log in to Docker Hub
+        uses: docker/login-action@v3
+        with:
+          username: ${{ secrets.DOCKER_USERNAME }}
+          password: ${{ secrets.DOCKER_PASSWORD }}
+
+      - name: Build and push Docker image
+        uses: docker/build-push-action@v5
+        with:
+          context: .
+          file: ./build/images/openim-tools/openim-web/Dockerfile
+          platforms: linux/amd64,linux/arm64
+          push: ${{ github.event_name != 'pull_request' }}
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+
+  build-openim-web-aliyun:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v3
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+# registry.cn-hangzhou.aliyuncs.com/openimsdk/openim-web:latest
+      - name: Extract metadata (tags, labels) for Docker
+        id: meta2
+        uses: docker/metadata-action@v5.0.0
+        with:
+          images: registry.cn-hangzhou.aliyuncs.com/openimsdk/openim-web
+
+      - name: Log in to AliYun Docker Hub
+        uses: docker/login-action@v3
+        with:
+          registry: registry.cn-hangzhou.aliyuncs.com
+          username: ${{ secrets.ALIREGISTRY_USERNAME }}
+          password: ${{ secrets.ALIREGISTRY_TOKEN }}
+      
+      - name: Build and push Docker image
+        uses: docker/build-push-action@v5
+        with:
+          context: .
+          file: ./build/images/openim-tools/openim-web/Dockerfile
+          platforms: linux/amd64,linux/arm64
+          push: ${{ github.event_name != 'pull_request' }}
+          tags: ${{ steps.meta2.outputs.tags }}
+          labels: ${{ steps.meta2.outputs.labels }}
+
+  build-openim-web-ghcr:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v3
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+# ghcr.io/openimsdk/openim-web:latest
+      - name: Extract metadata (tags, labels) for Docker
+        id: meta2
+        uses: docker/metadata-action@v5.0.0
+        with:
+          images: ghcr.io/openimsdk/openim-web
+
+      - name: Log in to GitHub Container Registry
+        uses: docker/login-action@v3
+        with:
+          registry: ghcr.io
+          username: ${{ github.repository_owner }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Build and push Docker image
+        uses: docker/build-push-action@v5
+        with:
+          context: .
+          file: ./build/images/openim-tools/openim-web/Dockerfile
+          platforms: linux/amd64,linux/arm64
+          push: ${{ github.event_name != 'pull_request' }}
+          tags: ${{ steps.meta2.outputs.tags }}
+          labels: ${{ steps.meta2.outputs.labels }}

.github/workflows/check-coverage.yml

@@ -0,0 +1,59 @@
+# Copyright © 2023 OpenIM open source community. 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.
+
+name: Check-Coverage
+
+on:
+  workflow_dispatch:
+  push:
+    branches: [ "main" ]
+    paths-ignore:
+      - "docs/**"
+      - "**/*.md"
+      - "**/*.yaml"
+      - "CONTRIBUTORS"
+      - "CHANGELOG/**"
+  pull_request:
+    branches: [ "*" ]
+    paths-ignore:
+      - "docs/**"
+      - "**/*.md"
+      - "**/*.yaml"
+      - "CONTRIBUTORS"
+      - "CHANGELOG/**"
+env:
+  # Common versions
+  GO_VERSION: "1.20"
+
+jobs:
+  coverage:
+    runs-on: ubuntu-20.04
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Golang with cache
+        uses: magnetikonline/action-golang-cache@v4
+        with:
+          go-version: ${{ env.GO_VERSION }}
+
+      - name: Install Dependencies
+        run: sudo apt update && sudo apt install -y libgpgme-dev libbtrfs-dev libdevmapper-dev
+
+      - name: Run Cover
+        run: make cover
+        continue-on-error: true
+
+      - name: Upload Coverage to Codecov
+        uses: codecov/codecov-action@v3

.github/workflows/cla.yml

@@ -0,0 +1,62 @@
+# Copyright © 2023 OpenIM open source community. 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.
+
+name: "OpenIM CLA Assistant"
+on:
+  issue_comment:
+    types: [created]
+  pull_request_target:
+    types: [opened,closed,synchronize]
+
+# explicitly configure permissions, in case your GITHUB_TOKEN workflow permissions are set to read-only in repository settings
+permissions:
+  actions: write
+  contents: write
+  pull-requests: write
+  statuses: write
+
+env:
+  # Define Open-IM-Server variables here
+  OPEN_IM_SERVER_REMOTE_ORGANIZATION: openim-sigs
+  REMOTE_REPOSITORY: cla
+  OPEN_IM_SERVER_CLA_DOCUMENT: https://github.com/openim-sigs/cla/blob/main/README.md
+  OPEN_IM_SERVER_SIGNATURES_PATH: signatures/${{ github.event.repository.name }}/cla.json
+
+  OPEN_IM_SERVER_ALLOWLIST: kubbot,bot* 
+
+jobs:
+  CLAAssistant:
+    runs-on: ubuntu-latest
+    steps:
+      - name: "CLA Assistant"
+        if: (github.event.comment.body == 'recheck' || github.event.comment.body == 'I have read the CLA Document and I hereby sign the CLA') || github.event_name == 'pull_request_target'
+        uses: contributor-assistant/github-action@v2.3.1
+        env:
+          GITHUB_TOKEN: ${{ secrets.BOT_GITHUB_TOKEN }}
+          PERSONAL_ACCESS_TOKEN: ${{ secrets.REDBOT_GITHUB_TOKEN }}
+        with:
+          path-to-signatures: ${{ env.OPEN_IM_SERVER_SIGNATURES_PATH }}
+          path-to-document: ${{ env.OPEN_IM_SERVER_CLA_DOCUMENT }}
+          branch: 'main'
+          allowlist: ${{ env.OPEN_IM_SERVER_ALLOWLIST }}
+
+          remote-organization-name: ${{ env.OPEN_IM_SERVER_REMOTE_ORGANIZATION }}
+          remote-repository-name: ${{ env.REMOTE_REPOSITORY }}
+
+          create-file-commit-message: '📚 Docs: Creating file for storing ${{ github.event.repository.name }} CLA Signatures'
+          custom-notsigned-prcomment: '💕 Thank you for your contribution and please kindly read and sign our [🎯https://github.com/openim-sigs/cla/blob/main/README.md](https://github.com/openim-sigs/cla/blob/main/README.md). <br> If you wish to sign the CRA, **Please copy and comment on the following sentence:**'
+          custom-pr-sign-comment: 'I have read the CLA Document and I hereby sign the CLA'
+          custom-allsigned-prcomment: '🤖 All Contributors have signed the [${{ github.event.repository.name }} CLA](https://github.com/openim-sigs/cla/blob/main/README.md).<br> The signed information is recorded [🤖here](https://github.com/openim-sigs/cla/tree/main/signatures/${{ github.event.repository.name }}/cla.json)'
+        #   lock-pullrequest-aftermerge: false - if you don't want this bot to automatically lock the pull request after merging (default - true)
+        #   use-dco-flag: true - If you are using DCO instead of CLA

.github/workflows/codeql-analysis.yml

@@ -1,71 +1,76 @@
-# For most projects, this workflow file will not need changing; you simply need
-# to commit it to your repository.
+# Copyright © 2023 OpenIM open source community. All rights reserved.
 #
-# You may wish to alter this file to override the set of languages analyzed,
-# or to provide custom queries or build logic.
+# 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
 #
-# ******** NOTE ********
-# We have attempted to detect the languages in your repository. Please check
-# the `language` matrix defined below to confirm you have the correct set of
-# supported CodeQL languages.
+#     http://www.apache.org/licenses/LICENSE-2.0
 #
-name: "CodeQL"
+# 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.
+
+
+name: "OpenIM Code Scanning - Action"
 
 on:
   push:
-    branches: [ main ]
+    branches: [main]
   pull_request:
-    # The branches below must be a subset of the branches above
-    branches: [ main ]
+    branches: [main]
   schedule:
-    - cron: '23 2 * * 2'
+    #        ┌───────────── minute (0 - 59)
+    #        │  ┌───────────── hour (0 - 23)
+    #        │  │ ┌───────────── day of the month (1 - 31)
+    #        │  │ │ ┌───────────── month (1 - 12 or JAN-DEC)
+    #        │  │ │ │ ┌───────────── day of the week (0 - 6 or SUN-SAT)
+    #        │  │ │ │ │
+    #        │  │ │ │ │
+    #        │  │ │ │ │
+    #        *  * * * *
+    - cron: '30 1 * * 0'
 
 jobs:
-  analyze:
-    name: Analyze
+  CodeQL-Build:
+    # CodeQL runs on ubuntu-latest, windows-latest, and macos-latest
     runs-on: ubuntu-latest
+
     permissions:
-      actions: read
-      contents: read
+      # required for all workflows
       security-events: write
 
-    strategy:
-      fail-fast: false
-      matrix:
-        language: [ 'go' ]
-        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python' ]
-        # Learn more:
-        # https://docs.github.com/en/free-pro-team@latest/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#changing-the-languages-that-are-analyzed
+      # only required for workflows in private repositories
+      actions: write
+      contents: write
 
     steps:
-    - name: Checkout repository
-      uses: actions/checkout@v2
+      - name: Checkout repository
+        uses: actions/checkout@v4
 
-    # Initializes the CodeQL tools for scanning.
-    - name: Initialize CodeQL
-      uses: github/codeql-action/init@v1
-      with:
-        languages: ${{ matrix.language }}
-        # If you wish to specify custom queries, you can do so here or in a config file.
-        # By default, queries listed here will override any specified in a config file.
-        # Prefix the list here with "+" to use these queries and those in the config file.
-        # queries: ./path/to/local/query, your-org/your-repo/queries@main
+      # Initializes the CodeQL tools for scanning.
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@v2
+        # Override language selection by uncommenting this and choosing your languages
+        with:
+          languages: go
 
-    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
-    # If this step fails, then you should remove it and run the build manually (see below)
-    - name: Autobuild
-      uses: github/codeql-action/autobuild@v1
+      # Autobuild attempts to build any compiled languages (C/C++, C#, Go, or Java).
+      # If this step fails, then you should remove it and run the build manually (see below).
+      - name: Autobuild
+        uses: github/codeql-action/autobuild@v2
 
-    # ℹ️ Command-line programs to run using the OS shell.
-    # 📚 https://git.io/JvXDl
+      # ℹ️ Command-line programs to run using the OS shell.
+      # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
 
-    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
-    #    and modify them (or add more) to build your code if your project
-    #    uses a compiled language
+      # ✏️ If the Autobuild fails above, remove it and uncomment the following
+      #    three lines and modify them (or add more) to build your code if your
+      #    project uses a compiled language
 
-    #- run: |
-    #   make bootstrap
-    #   make release
+    #   - run: |
+    #       make bootstrap
+    #       make release
 
-    - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v1
+      - name: Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@v2

.github/workflows/create_branch_on_tag.yml

@@ -0,0 +1,76 @@
+# 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.
+
+name: Create Branch on Tag
+
+on:
+  push:
+    tags:
+      - 'v*.*.0'
+
+jobs:
+  create-branch:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Check out code
+      uses: actions/checkout@v4
+      with:
+        fetch-depth: 0
+
+    - name: Set up Git
+      run: |
+        git config --global user.name 'kubbot'
+        git config --global user.email '3293172751yxy@gmail.com'
+
+    - name: Install git-chglog
+      run: make install.git-chglog
+
+    - name: Create Branch
+      run: |
+        TAG_NAME=${GITHUB_REF/refs\/tags\//}
+        IFS='.' read -ra VERSION_PARTS <<< "$TAG_NAME"
+        if [[ "${VERSION_PARTS[2]}" = "0" ]]; then
+          BRANCH_NAME="release-v${VERSION_PARTS[0]}.${VERSION_PARTS[1]}"
+          echo "Creating branch $BRANCH_NAME"
+          git checkout -b "$BRANCH_NAME"
+          git push origin "$BRANCH_NAME"
+        fi
+
+    - name: Push Changes
+      uses: stefanzweifel/git-auto-commit-action@v5
+      with:
+        commit_message: "Auto Commit CHANGELOG"
+        branch: release-v${VERSION_PARTS[0]}.${VERSION_PARTS[1]}
+      env:
+        GITHUB_TOKEN: ${{ secrets.BOT_GITHUB_TOKEN }}
+
+    - name: Create and Push CHANGELOG
+      run: |
+        git checkout main
+        TAG_NAME=${GITHUB_REF/refs\/tags\//}
+        IFS='.' read -ra VERSION_PARTS <<< "$TAG_NAME"
+        if [[ "${VERSION_PARTS[2]}" = "0" ]]; then
+          cd CHANGELOG
+          git-chglog --tag-filter-pattern "v${VERSION_PARTS[0]}.${VERSION_PARTS[1]}.*"  -o "CHANGELOG-${VERSION_PARTS[0]}.${VERSION_PARTS[1]}.md"
+          git add "CHANGELOG-${VERSION_PARTS[0]}.${VERSION_PARTS[1]}.md"
+          git commit -m "Update CHANGELOG for $TAG_NAME"
+        fi
+
+    - name: Push Changes
+      uses: stefanzweifel/git-auto-commit-action@v5
+      with:
+        commit_message: "Auto Commit CHANGELOG"
+        branch: main
+      env:
+        GITHUB_TOKEN: ${{ secrets.BOT_GITHUB_TOKEN }}

.github/workflows/deploy.yml

@@ -0,0 +1,55 @@
+# Copyright © 2023 OpenIM open source community. 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.
+
+name: OpenIM Deploy for dev
+
+on:
+  push:
+    branches:
+      - 'devops' # Only for the dev branch
+      - 'main'
+    paths:
+      - '.github/workflows/*'
+      # - '__test__/**' # dev No immediate testing is required
+      - 'src/**'
+      - 'Dockerfile'
+      - 'docker-compose.yml'
+      - 'bin/*'
+
+jobs:
+  deploy-dev:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: executing remote ssh commands using password
+        uses: appleboy/ssh-action@v1.0.0
+        env:
+            OWNER: ${{ github.repository_owner }}
+            REPO: ${{ github.event.repository.name }}
+        with:
+          host: "${{ secrets.SG_M1_HOST }}, ${{ secrets.SG_N1_HOST }}, ${{ secrets.SG_N2_HOST}}"
+          username: ${{ secrets.SG_USERNAME }}
+          password: ${{ secrets.SG_PASSWORD }}
+          port: ${{ secrets.SG_PORT }}
+          envs: OWNER,REPO
+          script_stop: true
+          script: |
+            mkdir -p /test/openim
+            cd /test/openim
+            pwd;ls -al
+            echo "OWNER: $OWNER"
+            echo "REPO: $REPO"
+            git clone -b develop https://github.com/${OWNER}/${REPO}.git; cd ${REPO}
+            docker compose up -d
+        continue-on-error: true

.github/workflows/depsreview.yaml

@@ -0,0 +1,18 @@
+# Copyright © 2023 KubeCub open source community. All rights reserved.
+# Licensed under the MIT License (the "License");
+# you may not use this file except in compliance with the License.
+
+name: Dependency Review
+on: [pull_request]
+
+permissions:
+  contents: read
+
+jobs:
+  dependency-review:
+    runs-on: ubuntu-latest
+    steps:
+      - name: 'Checkout Repository'
+        uses: actions/checkout@v4
+      - name: 'Dependency Review'
+        uses: actions/dependency-review-action@v3

.github/workflows/docker-buildx.yml

@@ -0,0 +1,321 @@
+# Copyright © 2023 OpenIM open source community. 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.
+
+name: Docker Buildx Images CI
+
+on:
+  schedule:
+  - cron: '30 1 * * *'
+  push:
+    branches:
+      - release-*
+    tags:
+      - v*
+  workflow_dispatch:
+
+jobs:
+  build-ghcr:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v3
+        
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+        with:
+          install: true
+
+      - name: Cache Docker layers
+        uses: actions/cache@v3
+        with:
+          path: /tmp/.buildx-cache
+          key: ${{ runner.os }}-buildx-${{ github.sha }}
+          restore-keys: |
+            ${{ runner.os }}-buildx-
+
+      - name: Log in to GitHub Container Registry
+        uses: docker/login-action@v3
+        with:
+          registry: ghcr.io
+          username: ${{ github.repository_owner }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+################################################
+# build/
+# └── docker
+#     ├── openim-api
+#     │   └── Dockerfile
+#     ├── openim-cmdutils
+#     │   └── Dockerfile
+#     ├── openim-crontask
+#     │   └── Dockerfile
+#     ├── openim-msggateway
+#     │   └── Dockerfile
+#     ├── openim-msgtransfer
+#     │   └── Dockerfile
+#     ├── openim-push
+#     │   └── Dockerfile
+#     ├── openim-rpc-auth
+#     │   └── Dockerfile
+#     ├── openim-rpc-conversation
+#     │   └── Dockerfile
+#     ├── openim-rpc-friend
+#     │   └── Dockerfile
+#     ├── openim-rpc-group
+#     │   └── Dockerfile
+#     ├── openim-rpc-msg
+#     │   └── Dockerfile
+#     ├── openim-rpc-third
+#     │   └── Dockerfile
+#     └── openim-rpc-user
+#         └── Dockerfile
+#############################################
+
+      - name: Extract metadata (tags, labels) for Docker openim-api
+        id: meta1
+        uses: docker/metadata-action@v5.0.0
+        with:
+          images: ghcr.io/openimsdk/openim-api
+
+      - name: Build and push Docker image for openim-api
+        uses: docker/build-push-action@v5
+        with:
+          context: .
+          file: ./build/images/openim-api/Dockerfile
+          platforms: linux/amd64,linux/arm64
+          push: ${{ github.event_name != 'pull_request' }}
+          tags: ${{ steps.meta1.outputs.tags }}
+          labels: ${{ steps.meta1.outputs.labels }}
+          cache-from: type=local,src=/tmp/.buildx-cache
+          cache-to: type=local,dest=/tmp/.buildx-cache
+
+      - name: Extract metadata (tags, labels) for Docker openim-cmdutils
+        id: meta2
+        uses: docker/metadata-action@v5.0.0
+        with:
+          images: ghcr.io/openimsdk/openim-cmdutils
+
+      - name: Build and push Docker image for openim-cmdutils
+        uses: docker/build-push-action@v5
+        with:
+          context: .
+          file: ./build/images/openim-cmdutils/Dockerfile
+          platforms: linux/amd64,linux/arm64
+          push: ${{ github.event_name != 'pull_request' }}
+          tags: ${{ steps.meta2.outputs.tags }}
+          labels: ${{ steps.meta2.outputs.labels }}
+          cache-from: type=local,src=/tmp/.buildx-cache
+          cache-to: type=local,dest=/tmp/.buildx-cache
+
+      - name: Extract metadata (tags, labels) for Docker openim-crontask
+        id: meta3
+        uses: docker/metadata-action@v5.0.0
+        with:
+          images: ghcr.io/openimsdk/openim-crontask
+
+      - name: Build and push Docker image for openim-crontask
+        uses: docker/build-push-action@v5
+        with:
+          context: .
+          file: ./build/images/openim-crontask/Dockerfile
+          platforms: linux/amd64,linux/arm64
+          push: ${{ github.event_name != 'pull_request' }}
+          tags: ${{ steps.meta3.outputs.tags }}
+          labels: ${{ steps.meta3.outputs.labels }}
+          cache-from: type=local,src=/tmp/.buildx-cache
+          cache-to: type=local,dest=/tmp/.buildx-cache
+
+      - name: Extract metadata (tags, labels) for Docker openim-msggateway
+        id: meta4
+        uses: docker/metadata-action@v5.0.0
+        with:
+          images: ghcr.io/openimsdk/openim-msggateway
+
+      - name: Build and push Docker image for openim-msggateway
+        uses: docker/build-push-action@v5
+        with:
+          context: .
+          file: ./build/images/openim-msggateway/Dockerfile
+          platforms: linux/amd64,linux/arm64
+          push: ${{ github.event_name != 'pull_request' }}
+          tags: ${{ steps.meta4.outputs.tags }}
+          labels: ${{ steps.meta4.outputs.labels }}
+          cache-from: type=local,src=/tmp/.buildx-cache
+          cache-to: type=local,dest=/tmp/.buildx-cache
+
+      - name: Extract metadata (tags, labels) for Docker openim-msgtransfer
+        id: meta5
+        uses: docker/metadata-action@v5.0.0
+        with:
+          images: ghcr.io/openimsdk/openim-msgtransfer
+
+      - name: Build and push Docker image for openim-msgtransfer
+        uses: docker/build-push-action@v5
+        with:
+          context: .
+          file: ./build/images/openim-msgtransfer/Dockerfile
+          platforms: linux/amd64,linux/arm64
+          push: ${{ github.event_name != 'pull_request' }}
+          tags: ${{ steps.meta5.outputs.tags }}
+          labels: ${{ steps.meta5.outputs.labels }}
+          cache-from: type=local,src=/tmp/.buildx-cache
+          cache-to: type=local,dest=/tmp/.buildx-cache
+          
+      - name: Extract metadata (tags, labels) for Docker openim-push
+        id: meta6
+        uses: docker/metadata-action@v5.0.0
+        with:
+          images: ghcr.io/openimsdk/openim-push
+
+      - name: Build and push Docker image for openim-push
+        uses: docker/build-push-action@v5
+        with:
+          context: .
+          file: ./build/images/openim-push/Dockerfile
+          platforms: linux/amd64,linux/arm64
+          push: ${{ github.event_name != 'pull_request' }}
+          tags: ${{ steps.meta6.outputs.tags }}
+          labels: ${{ steps.meta6.outputs.labels }}
+          cache-from: type=local,src=/tmp/.buildx-cache
+          cache-to: type=local,dest=/tmp/.buildx-cache
+
+      - name: Extract metadata (tags, labels) for Docker openim-rpc-auth
+        id: meta7
+        uses: docker/metadata-action@v5.0.0
+        with:
+          images: ghcr.io/openimsdk/openim-rpc-auth
+
+      - name: Build and push Docker image for openim-rpc-auth
+        uses: docker/build-push-action@v5
+        with:
+          context: .
+          file: ./build/images/openim-rpc-auth/Dockerfile
+          platforms: linux/amd64,linux/arm64
+          push: ${{ github.event_name != 'pull_request' }}
+          tags: ${{ steps.meta7.outputs.tags }}
+          labels: ${{ steps.meta7.outputs.labels }}
+          cache-from: type=local,src=/tmp/.buildx-cache
+          cache-to: type=local,dest=/tmp/.buildx-cache
+
+      - name: Extract metadata (tags, labels) for Docker openim-rpc-conversation
+        id: meta8
+        uses: docker/metadata-action@v5.0.0
+        with:
+          images: ghcr.io/openimsdk/openim-rpc-conversation
+
+      - name: Build and push Docker image for openim-rpc-conversation
+        uses: docker/build-push-action@v5
+        with:
+          context: .
+          file: ./build/images/openim-rpc-conversation/Dockerfile
+          platforms: linux/amd64,linux/arm64
+          push: ${{ github.event_name != 'pull_request' }}
+          tags: ${{ steps.meta8.outputs.tags }}
+          labels: ${{ steps.meta8.outputs.labels }}
+          cache-from: type=local,src=/tmp/.buildx-cache
+          cache-to: type=local,dest=/tmp/.buildx-cache
+
+      - name: Extract metadata (tags, labels) for Docker openim-rpc-friend
+        id: meta9
+        uses: docker/metadata-action@v5.0.0
+        with:
+          images: ghcr.io/openimsdk/openim-rpc-friend
+
+      - name: Build and push Docker image for openim-rpc-friend
+        uses: docker/build-push-action@v5
+        with:
+          context: .
+          file: ./build/images/openim-rpc-friend/Dockerfile
+          platforms: linux/amd64,linux/arm64
+          push: ${{ github.event_name != 'pull_request' }}
+          tags: ${{ steps.meta9.outputs.tags }}
+          labels: ${{ steps.meta9.outputs.labels }}
+          cache-from: type=local,src=/tmp/.buildx-cache
+          cache-to: type=local,dest=/tmp/.buildx-cache
+
+      - name: Extract metadata (tags, labels) for Docker openim-rpc-group
+        id: meta10
+        uses: docker/metadata-action@v5.0.0
+        with:
+          images: ghcr.io/openimsdk/openim-rpc-group
+
+      - name: Build and push Docker image for openim-rpc-group
+        uses: docker/build-push-action@v5
+        with:
+          context: .
+          file: ./build/images/openim-rpc-group/Dockerfile
+          platforms: linux/amd64,linux/arm64
+          push: ${{ github.event_name != 'pull_request' }}
+          tags: ${{ steps.meta10.outputs.tags }}
+          labels: ${{ steps.meta10.outputs.labels }}
+          cache-from: type=local,src=/tmp/.buildx-cache
+          cache-to: type=local,dest=/tmp/.buildx-cache
+
+      - name: Extract metadata (tags, labels) for Docker openim-rpc-msg
+        id: meta11
+        uses: docker/metadata-action@v5.0.0
+        with:
+          images: ghcr.io/openimsdk/openim-rpc-msg
+
+      - name: Build and push Docker image for openim-rpc-msg
+        uses: docker/build-push-action@v5
+        with:
+          context: .
+          file: ./build/images/openim-rpc-msg/Dockerfile
+          platforms: linux/amd64,linux/arm64
+          push: ${{ github.event_name != 'pull_request' }}
+          tags: ${{ steps.meta11.outputs.tags }}
+          labels: ${{ steps.meta11.outputs.labels }}
+          cache-from: type=local,src=/tmp/.buildx-cache
+          cache-to: type=local,dest=/tmp/.buildx-cache
+
+      - name: Extract metadata (tags, labels) for Docker openim-rpc-third
+        id: meta12
+        uses: docker/metadata-action@v5.0.0
+        with:
+          images: ghcr.io/openimsdk/openim-rpc-third
+
+      - name: Build and push Docker image for openim-rpc-third
+        uses: docker/build-push-action@v5
+        with:
+          context: .
+          file: ./build/images/openim-rpc-third/Dockerfile
+          platforms: linux/amd64,linux/arm64
+          push: ${{ github.event_name != 'pull_request' }}
+          tags: ${{ steps.meta12.outputs.tags }}
+          labels: ${{ steps.meta12.outputs.labels }}
+          cache-from: type=local,src=/tmp/.buildx-cache
+          cache-to: type=local,dest=/tmp/.buildx-cache
+
+      - name: Extract metadata (tags, labels) for Docker openim-rpc-user
+        id: meta13
+        uses: docker/metadata-action@v5.0.0
+        with:
+          images: ghcr.io/openimsdk/openim-rpc-user
+
+      - name: Build and push Docker image for openim-rpc-user
+        uses: docker/build-push-action@v5
+        with:
+          context: .
+          file: ./build/images/openim-rpc-user/Dockerfile
+          platforms: linux/amd64,linux/arm64
+          push: ${{ github.event_name != 'pull_request' }}
+          tags: ${{ steps.meta13.outputs.tags }}
+          labels: ${{ steps.meta13.outputs.labels }}
+          cache-from: type=local,src=/tmp/.buildx-cache
+          cache-to: type=local,dest=/tmp/.buildx-cache
+

.github/workflows/e2e-test.yml

@@ -0,0 +1,44 @@
+# 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.
+
+name: e2e
+
+on:
+  workflow_dispatch:
+  pull_request:
+  push:
+  schedule:
+    # run e2e test every 4 hours
+    - cron: 0 */4 * * *
+
+jobs:
+  build:
+    name: Test
+    runs-on: ubuntu-latest
+    env:
+      GO111MODULE: on
+    steps:
+
+      - name: Set up Go 1.21
+        uses: actions/setup-go@v4
+        with:
+          go-version: 1.21
+        id: go
+
+      - name: Check out code into the Go module directory
+        uses: actions/checkout@v4
+
+      - name: Create e2e test
+        run: |
+          echo "...test e2e"

.github/workflows/golangci-lint.yml

@@ -0,0 +1,50 @@
+# Copyright © 2023 OpenIM open source community. 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.
+
+
+name: OpenIM golangci-lint
+on:
+  push:
+    branches: [main]
+  pull_request:
+jobs:
+    golangci:
+      name: lint
+      runs-on: ubuntu-latest
+      steps:
+        - uses: actions/checkout@v4
+        - uses: actions/setup-go@v4
+          with:
+            go-version: '1.21'
+            cache: false
+        - name: golangci-lint
+          uses: golangci/golangci-lint-action@v3.7.0
+          with:
+            # Require: version of golangci-lint to use in form of v1.2 or v1.2.3 or `latest` to use the latest version
+            version: v1.54
+
+            # Optional: working directory, useful for monorepos
+            # working-directory: server
+
+            # Optional: golangci-lint command line arguments.
+            # 
+            # Note: by default the `.golangci.yml` file should be at the root of the repository.
+            # The location of the configuration file can be changed by using `--config=`
+            # args: --timeout=30m --config=/scripts/.golangci.yml --issues-exit-code=0
+
+            # Optional: show only new issues if it's a pull request. The default value is `false`.
+            only-new-issues: true
+
+            # Optional:The mode to install golangci-lint. It can be 'binary' or 'goinstall'.
+            # install-mode: "goinstall"

.github/workflows/gosec.yml

@@ -0,0 +1,45 @@
+# 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.
+
+name: OpenIM Run Gosec
+
+# gosec is a source code security audit tool for the Go language. It performs a static 
+# analysis of the Go code, looking for potential security problems. The main functions of gosec are:
+#     1. Find common security vulnerabilities, such as SQL injection, command injection, and cross-site scripting (XSS).
+#     2. Audit codes according to common security standards and find non-standard codes.
+#     3. Assist the Go language engineer to write safe and reliable code.
+# https://github.com/securego/gosec/
+on:
+  push:
+    branches: "*"
+  pull_request:
+    branches: "*"
+    paths-ignore:
+      - '*.md'
+      - '*.yml'
+      - '.github'
+
+jobs:
+  golang-security-action:
+    runs-on: ubuntu-latest
+    env:
+      GO111MODULE: on
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v4
+      - name: Run Gosec Security Scanner
+        uses: securego/gosec@master
+        with:
+          args: ./...
+        continue-on-error: true

.github/workflows/greetings.yml

@@ -0,0 +1,49 @@
+# 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.
+
+name: first-interaction
+
+on:
+  issues:
+    types: [opened]
+  pull_request:
+    branches: [main]
+    types: [opened]
+
+jobs:
+  check_for_first_interaction:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/first-interaction@v1.2.0
+        with:
+          repo-token: ${{ secrets.BOT_GITHUB_TOKEN }}
+          pr-message: |
+            Hello! Thank you for your contribution.
+            
+            If you are fixing a bug, please reference the issue number in the description.
+
+            If you are implementing a feature request, please check with the maintainers that the feature will be accepted first.
+
+            [Join slack 🤖](https://join.slack.com/t/openimsdk/shared_invite/zt-22720d66b-o_FvKxMTGXtcnnnHiMqe9Q) to connect and communicate with our developers.
+
+            Please leave your information in the [✨ discussions](https://github.com/orgs/OpenIMSDK/discussions/426), we expect anyone to join OpenIM developer community.
+
+          issue-message: |
+            Hello! Thank you for filing an issue.
+
+            If this is a bug report, please include relevant logs to help us debug the problem.
+            
+            [Join slack 🤖](https://join.slack.com/t/openimsdk/shared_invite/zt-22720d66b-o_FvKxMTGXtcnnnHiMqe9Q) to connect and communicate with our developers.
+        continue-on-error: true

.github/workflows/help-comment-issue.yml

@@ -0,0 +1,35 @@
+# 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.
+
+name: Good frist issue add comment
+on:
+  issues:
+    types:
+      - labeled
+jobs:
+  add-comment:
+    if: github.event.label.name == 'help wanted' || github.event.label.name == 'good first issue'
+    runs-on: ubuntu-latest
+    permissions:
+      issues: write
+    steps:
+      - name: Add comment
+        uses: peter-evans/create-or-update-comment@v3
+        with:
+          issue-number: ${{ github.event.issue.number }}
+          token: ${{ secrets.BOT_GITHUB_TOKEN }}
+          body: |
+            This issue is available for anyone to work on. **Make sure to reference this issue in your pull request.** :sparkles: Thank you for your contribution! :sparkles:
+            [Join slack 🤖](https://join.slack.com/t/openimsdk/shared_invite/zt-22720d66b-o_FvKxMTGXtcnnnHiMqe9Q) to connect and communicate with our developers.
+            If you wish to accept this assignment, please leave a comment in the comments section: `/accept`.🎯

.github/workflows/issue-robot.yml

@@ -0,0 +1,31 @@
+# Copyright © 2023 OpenIM open source community. 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.
+
+name: 'issue translator'
+on:
+  issue_comment:
+    types: [created]
+  issues:
+    types: [opened]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: usthe/issues-translate-action@v2.7
+        with:
+          # it is not necessary to decide whether you need to modify the issue header content
+          IS_MODIFY_TITLE: true
+          BOT_GITHUB_TOKEN: ${{ secrets.BOT_GITHUB_TOKEN }}
+          # Required, input your bot github token

.github/workflows/link-pr.yml

@@ -0,0 +1,53 @@
+# Copyright © 2023 OpenIM open source community. 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.
+
+name: Github Rebot for Link check error
+
+# Every Monday at 12:30 p.m
+on:
+  schedule:
+    - cron: '30 12 * * 1'
+
+jobs:
+  linkChecker:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Link Checker
+        id: lychee
+        uses: lycheeverse/lychee-action@v1.8.0
+        with:
+            # For parameter description, see https://github.com/lycheeverse/lychee#commandline-parameters
+            # Actions Link address -> https://github.com/lycheeverse/lychee-action
+            # -E, --exclude-all-private    Exclude all private IPs from checking.
+            # -i, --insecure               Proceed for server connections considered insecure (invalid TLS)
+            # -n, --no-progress            Do not show progress bar.
+            # -t, --timeout <timeout>      Website timeout in seconds from connect to response finished [default:20]
+            # --max-concurrency <max-concurrency>    Maximum number of concurrent network requests [default: 128]
+            # -a --accept <accept>                      Comma-separated list of accepted status codes for valid links
+            # docs/.vitepress/dist the site directory to check
+            # ./*.md all markdown files in the root directory
+          args: --verbose  -E -i --no-progress --exclude-path './CHANGELOG' './**/*.md'
+        env:
+          GITHUB_TOKEN: ${{secrets.GH_PAT}}
+
+      - name: Create Issue From File
+        if: env.lychee_exit_code != 0
+        uses: peter-evans/create-issue-from-file@v4
+        with:
+          title: Bug reports for links in OpenIM docs
+          content-filepath: ./lychee/out.md
+          labels: kind/documentation, triage/unresolved, report
+          token: ${{ secrets.BOT_GITHUB_TOKEN }}

.github/workflows/lock-issue.yml

@@ -0,0 +1,65 @@
+# Copyright © 2023 OpenIM open source community. 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.
+
+name: 'Lock Threads'
+
+on:
+  schedule:
+    - cron: '0 * * * *'
+  workflow_dispatch:
+
+permissions:
+  issues: write
+  pull-requests: write
+
+concurrency:
+  group: lock
+
+jobs:
+  action:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: dessant/lock-threads@v4
+        with:
+          github-token: ${{ secrets.BOT_GITHUB_TOKEN }}
+          issue-inactive-days: '365'
+          exclude-issue-created-before: ''
+          exclude-issue-created-after: ''
+          exclude-issue-created-between: ''
+          exclude-issue-closed-before: ''
+          exclude-issue-closed-after: ''
+          exclude-issue-closed-between: ''
+          include-any-issue-labels: ''
+          include-all-issue-labels: ''
+          exclude-any-issue-labels: ''
+          add-issue-labels: ''
+          remove-issue-labels: ''
+          issue-comment: ''
+          issue-lock-reason: 'resolved'
+          pr-inactive-days: '365'
+          exclude-pr-created-before: ''
+          exclude-pr-created-after: ''
+          exclude-pr-created-between: ''
+          exclude-pr-closed-before: ''
+          exclude-pr-closed-after: ''
+          exclude-pr-closed-between: ''
+          include-any-pr-labels: ''
+          include-all-pr-labels: ''
+          exclude-any-pr-labels: ''
+          add-pr-labels: ''
+          remove-pr-labels: ''
+          pr-comment: ''
+          pr-lock-reason: 'resolved'
+          process-only: ''
+          log-output: false

.github/workflows/milestone.yml

@@ -0,0 +1,72 @@
+# 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.
+
+# shamelessly copied from https://github.com/sigstore/cosign/blob/main/.github/workflows/milestone.yaml
+
+name: milestone
+
+on:
+  pull_request_target:
+    types: [closed]
+    branches:
+      - main
+
+jobs:
+  milestone:
+    runs-on: ubuntu-latest
+
+    permissions:
+      actions: none
+      checks: none
+      contents: read
+      deployments: none
+      issues: write
+      packages: none
+      pull-requests: write
+      repository-projects: none
+      security-events: none
+      statuses: none
+
+    steps:
+      - uses: actions/github-script@v6 # v6
+        with:
+          script: |
+            if (!context.payload.pull_request.merged) {
+              console.log('PR was not merged, skipping.');
+              return;
+            }
+
+            if (!!context.payload.pull_request.milestone) {
+              console.log('PR has existing milestone, skipping.');
+              return;
+            }
+
+            milestones = await github.rest.issues.listMilestones({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              state: 'open',
+              sort: 'due_on',
+              direction: 'asc'
+            })
+            if (milestones.data.length === 0) {
+              console.log('There are no milestones, skipping.');
+              return;
+            }
+
+            await github.rest.issues.update({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              issue_number: context.payload.pull_request.number,
+              milestone: milestones.data[0].number
+            });

.github/workflows/opencommit.yml

@@ -0,0 +1,52 @@
+# 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.
+
+name: 'OpenIM Commit Action'
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  opencommit:
+    timeout-minutes: 10
+    name: OpenCommit
+    runs-on: ubuntu-latest
+    permissions: write-all
+    steps:
+      - name: Setup Node.js Environment
+        uses: actions/setup-node@v3
+        with:
+          node-version: '16'
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - uses: di-sukharev/opencommit@github-action-v1.0.4
+        with:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+        env:
+          # set openAI api key in repo actions secrets,
+          # for openAI keys go to: https://platform.openai.com/account/api-keys
+          # for repo secret go to: https://github.com/kuebcub/settings/secrets/actions
+          OCO_OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
+
+          # customization
+          OCO_OPENAI_MAX_TOKENS: 500
+          OCO_OPENAI_BASE_PATH: ''
+          OCO_DESCRIPTION: false
+          OCO_EMOJI: false
+          OCO_MODEL: gpt-3.5-turbo
+          OCO_LANGUAGE: en

.github/workflows/openimci.yml

@@ -0,0 +1,172 @@
+# Copyright © 2023 OpenIM open source community. 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.
+
+name: OpenIM CI Aotu Build and Install
+
+on: 
+  push:
+    branches:
+        - main
+    paths-ignore:
+        - "docs/**"
+        - "README.md"
+        - "README_zh-CN.md"
+        - "CONTRIBUTING.md"
+  pull_request:
+    branches:
+        - main
+    paths-ignore:
+        - "README.md"
+        - "README_zh-CN.md"
+        - "CONTRIBUTING.md"
+        - "docs/**"
+
+env:
+  GO_VERSION: "1.19"
+  GOLANGCI_VERSION: "v1.50.1"
+
+
+jobs:
+  openim:
+    name: Test with go ${{ matrix.go_version }} on ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    permissions:
+        contents: write
+    environment:
+      name: openim
+
+    strategy:
+      matrix:
+        go_version: ["1.19","1.20","1.21"]
+        os: [ubuntu-latest]
+
+    steps:
+    - name: Setup
+      uses: actions/checkout@v4
+      
+    - name: Set up Go ${{ matrix.go_version }}
+      uses: actions/setup-go@v4
+      with:
+        go-version: ${{ matrix.go_version }}
+      id: go
+
+    - name: Install Task
+      uses: arduino/setup-task@v1
+      with:
+        version: 2.x
+
+    - name: Module Operations
+      run: |
+        sudo make tidy
+        sudo make tools.verify.go-gitlint
+
+    - name: Format Code
+      run: sudo make format
+      continue-on-error: true
+
+    - name: Generate Files
+      run: make gen
+      continue-on-error: true
+
+    - name: Build Source
+      run: sudo make build
+
+    - name: Cleanup Build
+      run: sudo make clean
+
+    - name: Push Changes to Main
+      uses: stefanzweifel/git-auto-commit-action@v5
+      with:
+        commit_message: "cicd: robot automated Change"
+        branch: main
+      continue-on-error: true
+
+    - name: Set Current Directory
+      id: set_directory
+      run: echo "::set-output name=directory::$(pwd)"
+      continue-on-error: true
+
+    - name: Collect and Display Test Coverage
+      id: collect_coverage
+      run: |
+        cd ${{ steps.set_directory.outputs.directory }}
+        make cover
+        echo "::set-output name=coverage_file::./_output/tmp/coverage.out"
+        echo "Test Coverage:"
+        cat ${{ steps.collect_coverage.outputs.coverage_file }}
+      continue-on-error: true
+
+  openim-start:
+    name: Test OpenIM install/start on ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    environment:
+      name: openim
+    strategy:
+      matrix:
+        go_version: ["1.21"]
+        os: ["ubuntu-latest"]
+    steps:
+    - name: Checkout and Install OpenIM
+      uses: actions/checkout@v4
+    - name: Install Task
+      uses: arduino/setup-task@v1
+      with:
+        version: 2.x
+    - name: Run OpenIM make install start
+      run: |
+        sudo make install
+
+  execute-scripts:
+    name: Execute OpenIM script on ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    environment:
+      name: openim
+    strategy:
+      matrix:
+        go_version: ["1.20"]
+        os: ["ubuntu-latest"]
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v4
+
+    - name: Set up Go ${{ matrix.go_version }}
+      uses: actions/setup-go@v4
+      with:
+        go-version: ${{ matrix.go_version }}
+      id: go
+    - name: Install Task
+      uses: arduino/setup-task@v1
+      with:
+        version: 2.x
+    - name: Docker Operations
+      run: |
+        curl -o docker-compose.yml https://raw.githubusercontent.com/OpenIMSDK/openim-docker/main/example/basic-openim-server-dependency.yml
+        sudo docker compose up -d
+        sudo sleep 60
+
+    - name: Module Operations
+      run: |
+        sudo make tidy
+        sudo make tools.verify.go-gitlint
+
+    - name: Build, Start and Check Services
+      run: |
+        sudo make init
+        sudo make build
+        sudo make start
+        sudo make check
+
+    - name: Print OpenIM Logs
+      run: sudo cat ./_output/logs/* 2>/dev/null
+      continue-on-error: true

.github/workflows/project-progress.yml

@@ -0,0 +1,36 @@
+# Copyright © 2023 OpenIM open source community. 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.
+
+# GitHub recommends pinning actions to a commit SHA.
+# To get a newer version, you will need to update the SHA.
+# You can also reference a tag or branch, but the action may change without warning.
+
+name: Move assigned card
+on:
+  issues:
+    types:
+      - assigned
+  pull_request:
+    types: 
+      - assigned
+
+jobs:
+  move-assigned-card:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: alex-page/github-project-automation-plus@v0.8.3
+        with:
+          project: openim-powerful
+          column: In Progress
+          repo-token: ${{ secrets.BOT_GITHUB_TOKEN }}

.github/workflows/pull-request.yml

@@ -0,0 +1,122 @@
+# 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.
+
+name: Github Pull Request
+on:
+  push:
+    branches: [main]
+    paths-ignore:
+      - 'README.md'
+      - 'CONTRIBUTING.md'
+      - 'docs/**'
+  workflow_dispatch:
+  schedule:
+    - cron: '0 2 * * *'
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Get League branch Patch
+        run: |
+          git config user.name 'openimbot'
+          git config user.email 'openimsdk@qq.com'
+          git checkout -b cicd/patch-${{ github.event.number }}
+      - uses: actions/setup-node@v3
+      - name: Setup Go
+        uses: actions/setup-go@v4
+      - name: Run go modules tidy
+        run: |
+          sudo make tidy
+          sudo make tools.verify.go-gitlint
+          echo "Run go modules tidy successfully" 
+
+      - name: Run go format
+        run: |
+          sudo make format
+          echo "Run go format successfully" 
+        continue-on-error: true
+
+      - name: Run go lint
+        run: |
+          sudo make lint
+          echo "Run go lint successfully" 
+        continue-on-error: true
+
+      - name: Generate all necessary files, such as error code files
+        run: |
+          make generate
+          echo "Generate all necessary files successfully" 
+        continue-on-error: true
+
+      - name: Run unit test and get test coverage
+        run: |
+          make cover
+          echo "Run unit test and get test coverage successfully" 
+        continue-on-error: true
+
+    #   - name: Initialize CodeQL
+    #     uses: github/codeql-action/init@v2
+    #     with:
+    #       languages: go
+
+    #   - name: Perform CodeQL Analysis
+        # uses: github/codeql-action/analyze@v2
+
+      - name: OpenIM verify copyright
+        run: |
+          sudo make verify-copyright
+          sudo make add-copyright
+          echo "OpenIM verify successfully" 
+        continue-on-error: true
+      
+    #   - name: Commit code
+    #     run: |
+    #         git add .
+    #         git commit -m "cicd: bump League Patch to cicd/patch-${{ github.event.number }}"
+    
+      - name: Create Pull Request
+        uses: peter-evans/create-pull-request@v5
+        with:
+          token: ${{ secrets.BOT_GITHUB_TOKEN }}
+          commit-message: "cicd: bump League Patch to cicd/patch-${{ github.event.number }}"
+          title: Bump League Patch to cicd/patch-${{ github.event.number }}
+          author: kubbot <kubbot@3293172751ysy@gmail.com>
+          signoff: false
+          draft: false
+          branch: "cicd/patch-${{ github.event.number }}"
+          assignees: cubxxw
+          reviewers: cubxxw
+          delete-branch: true
+          body: |
+            Review criteria:
+
+            - [ ] Disenchanter can connect and issue actions
+            
+            This is an automated PR. @ ${{ github.actor }}
+            <sub>[workflow](https://github.com/openimsdk/open-im-server/blob/main/.github/workflows/pull-request.yml).</sub>
+          base: main
+          labels: |
+            kind/documentation
+            enhancement
+            report

.github/workflows/release-drafter.yml

@@ -0,0 +1,55 @@
+# 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.
+
+name: Release Drafter
+
+on:
+  push:
+    # branches to consider in the event; optional, defaults to all
+    branches:
+      - main
+  # pull_request event is required only for autolabeler
+  pull_request:
+    # Only following types are handled by the action, but one can default to all as well
+    # types: [opened, reopened, synchronize]
+  # pull_request_target event is required for autolabeler to support PRs from forks
+  # pull_request_target:
+  #   types: [opened, reopened, synchronize]
+
+permissions:
+  contents: read
+
+jobs:
+  update_release_draft:
+    permissions:
+      # write permission is required to create a github release
+      contents: write
+      # write permission is required for autolabeler
+      # otherwise, read permission is required at least
+      pull-requests: write
+    runs-on: ubuntu-latest
+    steps:
+      # (Optional) GitHub Enterprise requires GHE_HOST variable set
+      #- name: Set GHE_HOST
+      #  run: |
+      #    echo "GHE_HOST=${GITHUB_SERVER_URL##https:\/\/}" >> $GITHUB_ENV
+
+      # Drafts your next Release notes as Pull Requests are merged into "master"
+      - uses: release-drafter/release-drafter@v5
+        # (Optional) specify config name to use, relative to .github/. Default: release-drafter.yml
+        # with:
+        #   config-name: my-config.yml
+        #   disable-autolabeler: true
+        env:
+          GITHUB_TOKEN: ${{ secrets.REDBOT_GITHUB_TOKEN }}

.github/workflows/release.yml

@@ -0,0 +1,81 @@
+# 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.
+
+name: OpenIM Server Release Workflow
+
+on:
+  push:
+    # run only against tags
+    tags:
+      - '*'
+
+permissions:
+  contents: write
+  packages: write
+  issues: write
+
+jobs:
+  goreleaser:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - run: git fetch --force --tags
+      - uses: actions/setup-go@v4
+        with:
+          go-version: stable
+      # More assembly might be required: Docker logins, GPG, etc. It all depends
+      # on your needs.
+      - uses: goreleaser/goreleaser-action@v5
+        with:
+          # either 'goreleaser' (default) or 'goreleaser-pro':
+          distribution: goreleaser
+          version: latest
+          workdir: .
+          args: release -f ./build/goreleaser.yaml --clean --release-footer-tmpl=scripts/template/footer.md.tmpl --release-header-tmpl=scripts/template/head.md.tmpl
+        env:
+          USERNAME: ${{ github.repository_owner }}
+          GITHUB_TOKEN: ${{ secrets.BOT_GITHUB_TOKEN }}
+          FURY_TOKEN: ${{ secrets.FURY_TOKEN }}
+          # Your GoReleaser Pro key, if you are using the 'goreleaser-pro'
+          # distribution:
+          # GORELEASER_KEY: ${{ secrets.GORELEASER_KEY }}
+
+  goreleaser-check-pkgs:
+    runs-on: ubuntu-latest
+    env:
+      DOCKER_CLI_EXPERIMENTAL: "enabled"
+    needs: [ goreleaser ]
+    if: github.ref == 'refs/heads/main'
+    strategy:
+      matrix:
+        format: [ deb, rpm, apk ]
+    steps:
+      - uses: actions/checkout@v4 # v3
+        with:
+          fetch-depth: 0
+      - uses: arduino/setup-task@e26d8975574116b0097a1161e0fe16ba75d84c1c # v1
+        with:
+          version: 3.x
+          repo-token: ${{ secrets.GITHUB_TOKEN }}
+      - uses: docker/setup-qemu-action@326560df218a7ea9cf6ab49bbc88b8b306bb437e # v2
+      - uses: actions/cache@88522ab9f39a2ea568f7027eddc7d8d8bc9d59c8 # v3
+        with:
+          path: |
+            ./_output/dist/*.deb
+            ./_output/dist/*.rpm
+            ./_output/dist/*.apk
+          key: ${{ github.ref }}
+      - run: task goreleaser:test:${{ matrix.format }}

.github/workflows/scripts-verify.yml

@@ -0,0 +1,76 @@
+# 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.
+
+name: OpenIM executes the script validation code
+
+on: 
+  push:
+    branches:
+        - main
+    paths-ignore:
+        - "docs/**"
+        - "README.md"
+        - "README_zh-CN.md"
+        - "CONTRIBUTING.md"
+  pull_request:
+    branches:
+        - main
+    paths-ignore:
+        - "README.md"
+        - "README_zh-CN.md"
+        - "CONTRIBUTING.md"
+        - "docs/**"
+
+env:
+  GO_VERSION: "1.19"
+  GOLANGCI_VERSION: "v1.50.1"
+
+jobs:
+  openim:
+    name: Test with go ${{ matrix.go_version }} on ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    permissions:
+        contents: write
+    environment:
+      name: openim
+
+    strategy:
+      matrix:
+        go_version: ["1.21"]
+        os: [ubuntu-latest]
+
+    steps:
+    - name: Setup
+      uses: actions/checkout@v4
+      
+    - name: In ${{ matrix.os }} Execute the script validation code
+      uses: actions/setup-go@v4
+      with:
+        go-version: ${{ matrix.go_version }}
+      id: go
+
+    - name: scripts validation
+      run: |
+        sudo make verify
+      continue-on-error: true
+
+    - name: verify format
+      run: |
+        sudo make format
+      continue-on-error: true
+
+    - name: verify license
+      run: |
+        sudo make verify-copyright
+      continue-on-error: true

.github/workflows/stale.yml

@@ -0,0 +1,48 @@
+# 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.
+
+# This workflow warns and then closes issues and PRs that have had no activity for a specified amount of time.
+#
+# You can adjust the behavior by modifying this file.
+# For more information, see:
+# https://github.com/actions/stale
+name: Mark stale issues and pull requests
+
+on:
+  schedule:
+  - cron: '0 8 * * *'
+
+jobs:
+  stale:
+
+    runs-on: ubuntu-latest
+    permissions:
+      issues: write
+      pull-requests: write
+
+    steps:
+    - uses: actions/stale@v8
+      with:
+        repo-token: ${{ secrets.BOT_GITHUB_TOKEN }}
+        days-before-stale: 60
+        days-before-close: 7
+        stale-issue-message: 'This issue is stale because it has been open 60 days with no activity. Remove stale label or comment or this will be closed in 7 days.'
+        stale-pr-message: 'This issue is stale because it has been open 60 days with no activity.'
+        close-issue-message: 'This issue was closed because it has been stalled for 7 days with no activity.'
+        close-pr-message: 'This PR was closed because it has been stalled for 7 days with no activity. You can reopen it if you want.'
+        stale-pr-label: lifecycle/stale
+        stale-issue-label: lifecycle/stale
+        exempt-issue-labels: 'openim'
+        exempt-pr-labels: 'openim'
+        exempt-draft-pr: true

.github/workflows/sync-release.yml

@@ -0,0 +1,43 @@
+# Copyright © 2023 KubeCub open source community. All rights reserved.
+# Licensed under the MIT License (the "License");
+# you may not use this file except in compliance with the License.
+
+# https://github.com/BetaHuhn/repo-file-sync-action
+name: Synchronize kubecub public code to other repositories
+on:
+    push:
+        paths:
+            - scripts/*
+            - docs/*
+            - config/*
+        branches:
+          - release-v*.*
+    workflow_dispatch:
+
+jobs:
+  sync:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Run GitHub File Sync
+        uses: BetaHuhn/repo-file-sync-action@latest
+        with:
+          GH_INSTALLATION_TOKEN: "${{ secrets.BOT_GITHUB_TOKEN }}"
+          CONFIG_PATH: .github/sync-release.yml
+          ORIGINAL_MESSAGE: true
+          SKIP_PR: true
+          COMMIT_EACH_FILE: false
+          COMMIT_BODY: "🤖 kubbot to synchronize the warehouse"
+          GIT_EMAIL: "3293172751ysy@gmail.com"
+          GIT_USERNAME: "kubbot"
+          PR_BODY: 👌 kubecub provides automated community services
+          REVIEWERS: |
+            kubbot
+            cubxxw
+          PR_LABELS: |
+            file-sync
+            automerge
+          ASSIGNEES: |
+            kubbot

.github/workflows/sync.yml

@@ -0,0 +1,39 @@
+# Copyright © 2023 KubeCub open source community. All rights reserved.
+# Licensed under the MIT License (the "License");
+# you may not use this file except in compliance with the License.
+
+# https://github.com/BetaHuhn/repo-file-sync-action
+name: Synchronize kubecub public code to other repositories
+on:
+    push:
+        branches:
+          - main
+    workflow_dispatch:
+
+jobs:
+  sync:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Run GitHub File Sync
+        uses: BetaHuhn/repo-file-sync-action@latest
+        with:
+          GH_INSTALLATION_TOKEN: "${{ secrets.BOT_GITHUB_TOKEN }}"
+          CONFIG_PATH: .github/sync.yml
+          ORIGINAL_MESSAGE: true
+          SKIP_PR: true
+          COMMIT_EACH_FILE: false
+          COMMIT_BODY: "🤖 kubbot to synchronize the warehouse"
+          GIT_EMAIL: "3293172751ysy@gmail.com"
+          GIT_USERNAME: "kubbot"
+          PR_BODY: 👌 kubecub provides automated community services
+          REVIEWERS: |
+            kubbot
+            cubxxw
+          PR_LABELS: |
+            file-sync
+            automerge
+          ASSIGNEES: |
+            kubbot

.gitignore

@@ -1,22 +1,403 @@
-bin
+# Copyright © 2023 OpenIMSDK.
+#
+# 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.
+
+# ==============================================================================
+# For the entire design of.gitignore, ignore git commits and ignore files
+#===============================================================================
+#
+
+### OpenIM developer supplement ###
 logs
 .devcontainer
 components
-logs
 out-test
-.github
-.idea
+Dockerfile.cross
 
+### Makefile ###
+tmp/
+bin/
+output/
+_output/
 
-deploy/open_im_demo
-deploy/open_im_api
-deploy/open_im_msg_gateway
-deploy/open_im_msg_transfer
-deploy/open_im_push
-deploy/open_im_timer_task
-deploy/open_im_rpc_user
-deploy/open_im_rpc_friend
-deploy/open_im_rpc_group
-deploy/open_im_rpc_msg
-deploy/open_im_rpc_auth
+### OpenIM Config ###
+config/config.yaml
+./config/config.yaml
+.env
+./.env
+
+### OpenIM deploy ###
+deploy/openim_demo
+deploy/openim-api
+deploy/openim-rpc-msg_gateway
+deploy/openim-msgtransfer
+deploy/openim-push
+deploy/openim_timer_task
+deploy/openim-rpc-user
+deploy/openim-rpc-friend
+deploy/openim-rpc-group
+deploy/openim-rpc-msg
+deploy/openim-rpc-auth
 deploy/Open-IM-SDK-Core
+
+# files used by the developer
+.idea.md
+.todo.md
+.note.md
+
+# ==============================================================================
+# Created by https://www.toptal.com/developers/gitignore/api/go,git,vim,tags,test,emacs,backup,jetbrains
+# Edit at https://www.toptal.com/developers/gitignore?templates=go,git,vim,tags,test,emacs,backup,jetbrains
+
+### Backup ###
+*.bak
+*.gho
+*.ori
+*.orig
+*.tmp
+
+### Emacs ###
+# -*- mode: gitignore; -*-
+*~
+\#*\#
+/.emacs.desktop
+/.emacs.desktop.lock
+*.elc
+auto-save-list
+tramp
+.\#*
+
+# Org-mode
+.org-id-locations
+*_archive
+
+# flymake-mode
+*_flymake.*
+
+# eshell files
+/eshell/history
+/eshell/lastdir
+
+# elpa packages
+/elpa/
+
+# reftex files
+*.rel
+
+# AUCTeX auto folder
+/auto/
+
+# cask packages
+.cask/
+dist/
+
+# Flycheck
+flycheck_*.el
+
+# server auth directory
+/server/
+
+# projectiles files
+.projectile
+
+# directory configuration
+.dir-locals.el
+
+# network security
+/network-security.data
+
+### vscode ###
+.vscode
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+*.code-workspace
+
+# End of https://www.toptal.com/developers/gitignore/api/vim,jetbrains,vscode,git,go,tags,backup,test
+
+### Git ###
+# Created by git for backups. To disable backups in Git:
+# $ git config --global mergetool.keepBackup false
+
+# Created by git when using merge tools for conflicts
+*.BACKUP.*
+*.BASE.*
+*.LOCAL.*
+*.REMOTE.*
+*_BACKUP_*.txt
+*_BASE_*.txt
+*_LOCAL_*.txt
+*_REMOTE_*.txt
+
+### Go ###
+# If you prefer the allow list template instead of the deny list, see community template:
+# https://github.com/github/gitignore/blob/main/community/Golang/Go.AllowList.gitignore
+#
+# Binaries for programs and plugins
+*.exe
+*.exe~
+*.dll
+*.so
+*.dylib
+
+# Test binary, built with `go test -c`
+*.test
+
+# Output of the go coverage tool, specifically when used with LiteIDE
+*.out
+
+# Dependency directories (remove the comment below to include it)
+vendor/
+
+# Go workspace file
+# go.work
+go.work.sum
+
+### JetBrains ###
+# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider
+# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
+
+# User-specific stuff
+.idea/
+.idea/**/workspace.xml
+.idea/**/tasks.xml
+.idea/**/usage.statistics.xml
+.idea/**/dictionaries
+.idea/**/shelf
+
+# AWS User-specific
+.idea/**/aws.xml
+
+# Generated files
+.idea/**/contentModel.xml
+
+# Sensitive or high-churn files
+.idea/**/dataSources/
+.idea/**/dataSources.ids
+.idea/**/dataSources.local.xml
+.idea/**/sqlDataSources.xml
+.idea/**/dynamic.xml
+.idea/**/uiDesigner.xml
+.idea/**/dbnavigator.xml
+
+# Gradle
+.idea/**/gradle.xml
+.idea/**/libraries
+
+# Gradle and Maven with auto-import
+# When using Gradle or Maven with auto-import, you should exclude module files,
+# since they will be recreated, and may cause churn.  Uncomment if using
+# auto-import.
+# .idea/artifacts
+# .idea/compiler.xml
+# .idea/jarRepositories.xml
+# .idea/modules.xml
+# .idea/*.iml
+# .idea/modules
+# *.iml
+# *.ipr
+
+# CMake
+cmake-build-*/
+
+# Mongo Explorer plugin
+.idea/**/mongoSettings.xml
+
+# File-based project format
+*.iws
+
+# IntelliJ
+out/
+
+# mpeltonen/sbt-idea plugin
+.idea_modules/
+
+# JIRA plugin
+atlassian-ide-plugin.xml
+
+# Cursive Clojure plugin
+.idea/replstate.xml
+
+# SonarLint plugin
+.idea/sonarlint/
+
+# Crashlytics plugin (for Android Studio and IntelliJ)
+com_crashlytics_export_strings.xml
+crashlytics.properties
+crashlytics-build.properties
+fabric.properties
+
+# Editor-based Rest Client
+.idea/httpRequests
+
+# Android studio 3.1+ serialized cache file
+.idea/caches/build_file_checksums.ser
+
+### JetBrains Patch ###
+# Comment Reason: https://github.com/joeblau/gitignore.io/issues/186#issuecomment-215987721
+
+# *.iml
+# modules.xml
+# .idea/misc.xml
+# *.ipr
+
+# Sonarlint plugin
+# https://plugins.jetbrains.com/plugin/7973-sonarlint
+.idea/**/sonarlint/
+
+# SonarQube Plugin
+# https://plugins.jetbrains.com/plugin/7238-sonarqube-community-plugin
+.idea/**/sonarIssues.xml
+
+# Markdown Navigator plugin
+# https://plugins.jetbrains.com/plugin/7896-markdown-navigator-enhanced
+.idea/**/markdown-navigator.xml
+.idea/**/markdown-navigator-enh.xml
+.idea/**/markdown-navigator/
+
+# Cache file creation bug
+# See https://youtrack.jetbrains.com/issue/JBR-2257
+.idea/$CACHE_FILE$
+
+# CodeStream plugin
+# https://plugins.jetbrains.com/plugin/12206-codestream
+.idea/codestream.xml
+
+# Azure Toolkit for IntelliJ plugin
+# https://plugins.jetbrains.com/plugin/8053-azure-toolkit-for-intellij
+.idea/**/azureSettings.xml
+
+### Tags ###
+# Ignore tags created by etags, ctags, gtags (GNU global) and cscope
+TAGS
+.TAGS
+!TAGS/
+tags
+.tags
+!tags/
+gtags.files
+GTAGS
+GRTAGS
+GPATH
+GSYMS
+cscope.files
+cscope.out
+cscope.in.out
+cscope.po.out
+
+
+### Test ###
+### Ignore all files that could be used to test your code and
+### you wouldn't want to push
+
+# Reference https://en.wikipedia.org/wiki/Metasyntactic_variable
+
+# Most common
+*foo
+*bar
+*fubar
+*foobar
+*baz
+
+# Less common
+*qux
+*quux
+*bongo
+*bazola
+*ztesch
+
+# UK, Australia
+*wibble
+*wobble
+*wubble
+*flob
+*blep
+*blah
+*boop
+*beep
+
+# Japanese
+*hoge
+*piyo
+*fuga
+*hogera
+*hogehoge
+
+# Portugal, Spain
+*fulano
+*sicrano
+*beltrano
+*mengano
+*perengano
+*zutano
+
+# France, Italy, the Netherlands
+*toto
+*titi
+*tata
+*tutu
+*pipppo
+*pluto
+*paperino
+*aap
+*noot
+*mies
+
+# Other names that would make sense
+*tests
+*testsdir
+*testsfile
+*testsfiles
+*testdir
+*testfile
+*testfiles
+*testing
+*testingdir
+*testingfile
+*testingfiles
+*temp
+*tempdir
+*tempfile
+*tempfiles
+*tmp
+*tmpdir
+*tmpfile
+*tmpfiles
+*lol
+
+### Vim ###
+# Swap
+[._]*.s[a-v][a-z]
+!*.svg  # comment out if you don't need vector files
+[._]*.sw[a-p]
+[._]s[a-rt-v][a-z]
+[._]ss[a-gi-z]
+[._]sw[a-p]
+
+# Session
+Session.vim
+Sessionx.vim
+
+# Temporary
+.netrwhist
+# Auto-generated tag files
+# Persistent undo
+[._]*.un~
+
+# End of https://www.toptal.com/developers/gitignore/api/go,git,vim,tags,test,emacs,backup,jetbrains
+.idea
+dist/
+.env
+config/config.yaml

.gitmodules

@@ -1,4 +0,0 @@
-
-[submodule "cmd/Open-IM-SDK-Core"]
-	path = cmd/Open-IM-SDK-Core
-	url = https://github.com/OpenIMSDK/Open-IM-SDK-Core.git

.golangci.yml

@@ -0,0 +1,920 @@
+# Copyright © 2023 OpenIMSDK open source community. 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.
+
+# This file contains all available configuration options
+# with their default values.
+
+# options for analysis running
+run:
+  # default concurrency is a available CPU number
+  concurrency: 4
+
+  # timeout for analysis, e.g. 30s, 5m, default is 1m
+  timeout: 5m
+
+  # exit code when at least one issue was found, default is 1
+  issues-exit-code: 1
+
+  # include test files or not, default is true
+  tests: true
+
+  # list of build tags, all linters use it. Default is empty list.
+  build-tags:
+    - mytag
+
+  # which dirs to skip: issues from them won't be reported;
+  # can use regexp here: generated.*, regexp is applied on full path;
+  # default value is empty list, but default dirs are skipped independently
+  # from this option's value (see skip-dirs-use-default).
+  # "/" will be replaced by current OS file path separator to properly work
+  # on Windows.
+  skip-dirs:
+    - util
+    - .*~
+    - api/swagger/docs
+    - server/docs
+
+  # default is true. Enables skipping of directories:
+  #   vendor$, third_party$, testdata$, examples$, Godeps$, builtin$
+  skip-dirs-use-default: true
+
+  # which files to skip: they will be analyzed, but issues from them
+  # won't be reported. Default value is empty list, but there is
+  # no need to include all autogenerated files, we confidently recognize
+  # autogenerated files. If it's not please let us know.
+  # "/" will be replaced by current OS file path separator to properly work
+  # on Windows.
+  skip-files:
+    - ".*\\.my\\.go$"
+    - _test.go
+
+  # by default isn't set. If set we pass it to "go list -mod={option}". From "go help modules":
+  # If invoked with -mod=readonly, the go command is disallowed from the implicit
+  # automatic updating of go.mod described above. Instead, it fails when any changes
+  # to go.mod are needed. This setting is most useful to check that go.mod does
+  # not need updates, such as in a continuous integration and testing system.
+  # If invoked with -mod=vendor, the go command assumes that the vendor
+  # directory holds the correct copies of dependencies and ignores
+  # the dependency descriptions in go.mod.
+  #modules-download-mode: release|readonly|vendor
+
+  # Allow multiple parallel golangci-lint instances running.
+  # If false (default) - golangci-lint acquires file lock on start.
+  allow-parallel-runners: true
+
+
+# output configuration options
+output:
+  # colored-line-number|line-number|json|tab|checkstyle|code-climate, default is "colored-line-number"
+  format: colored-line-number
+
+  # print lines of code with issue, default is true
+  print-issued-lines: true
+
+  # print linter name in the end of issue text, default is true
+  print-linter-name: true
+
+  # make issues output unique by line, default is true
+  uniq-by-line: true
+
+  # add a prefix to the output file references; default is no prefix
+  path-prefix: ""
+
+  # sorts results by: filepath, line and column
+  sort-results: true
+
+# all available settings of specific linters
+linters-settings:
+  bidichk:
+    # The following configurations check for all mentioned invisible unicode
+    # runes. It can be omitted because all runes are enabled by default.
+    left-to-right-embedding: true
+    right-to-left-embedding: true
+    pop-directional-formatting: true
+    left-to-right-override: true
+    right-to-left-override: true
+    left-to-right-isolate: true
+    right-to-left-isolate: true
+    first-strong-isolate: true
+    pop-directional-isolate: true
+  dogsled:
+    # checks assignments with too many blank identifiers; default is 2
+    max-blank-identifiers: 2
+  dupl:
+    # tokens count to trigger issue, 150 by default
+    threshold: 200
+  errcheck:
+    # report about not checking of errors in type assertions: `a := b.(MyStruct)`;
+    # default is false: such cases aren't reported by default.
+    check-type-assertions: false
+
+    # report about assignment of errors to blank identifier: `num, _ := strconv.Atoi(numStr)`;
+    # default is false: such cases aren't reported by default.
+    check-blank: false
+
+    # [deprecated] comma-separated list of pairs of the form pkg:regex
+    # the regex is used to ignore names within pkg. (default "fmt:.*").
+    # see https://github.com/kisielk/errcheck#the-deprecated-method for details
+    #ignore: GenMarkdownTree,os:.*,BindPFlags,WriteTo,Help
+    #ignore: (os\.)?std(out|err)\..*|.*Close|.*Flush|os\.Remove(All)?|.*print(f|ln)?|os\.(Un)?Setenv
+
+    # path to a file containing a list of functions to exclude from checking
+    # see https://github.com/kisielk/errcheck#excluding-functions for details
+    #exclude: errcheck.txt
+    
+  errorlint:
+    # Check whether fmt.Errorf uses the %w verb for formatting errors. See the readme for caveats
+    errorf: true
+    # Check for plain type assertions and type switches
+    asserts: true
+    # Check for plain error comparisons
+    comparison: true
+
+  exhaustive:
+    # check switch statements in generated files also
+    check-generated: false
+    # indicates that switch statements are to be considered exhaustive if a
+    # 'default' case is present, even if all enum members aren't listed in the
+    # switch
+    default-signifies-exhaustive: false
+    # enum members matching the supplied regex do not have to be listed in
+    # switch statements to satisfy exhaustiveness
+    ignore-enum-members: ""
+    # consider enums only in package scopes, not in inner scopes
+    package-scope-only: false
+  exhaustivestruct:
+    struct-patterns:
+      - '*.Test'
+      - '*.Test2'
+      - '*.Embedded'
+      - '*.External'
+
+  # forbidigo:
+  #   # Forbid the following identifiers (identifiers are written using regexp):
+  #   forbid:
+  #     - ^print.*$
+  #     - 'fmt\.Print.*'
+  #     - fmt.Println.* # too much log noise
+  #     - ginkgo\\.F.* # these are used just for local development
+  #   # Exclude godoc examples from forbidigo checks.  Default is true.
+  #   exclude_godoc_examples: false
+  funlen:
+    lines: 150
+    statements: 50
+  gci:
+    # put imports beginning with prefix after 3rd-party packages;
+    # only support one prefix
+    # if not set, use goimports.local-prefixes
+    prefix: github.com/openimsdk/open-im-server
+  gocognit:
+    # minimal code complexity to report, 30 by default (but we recommend 10-20)
+    min-complexity: 30
+  goconst:
+    # minimal length of string constant, 3 by default
+    min-len: 3
+    # minimal occurrences count to trigger, 3 by default
+    min-occurrences: 3
+    # ignore test files, false by default
+    ignore-tests: false
+    # look for existing constants matching the values, true by default
+    match-constant: true
+    # search also for duplicated numbers, false by default
+    numbers: false
+    # minimum value, only works with goconst.numbers, 3 by default
+    min: 3
+    # maximum value, only works with goconst.numbers, 3 by default
+    max: 3
+    # ignore when constant is not used as function argument, true by default
+    ignore-calls: true
+
+  gocritic:
+    # Which checks should be enabled; can't be combined with 'disabled-checks';
+    # See https://go-critic.github.io/overview#checks-overview
+    # To check which checks are enabled run `GL_DEBUG=gocritic golangci-lint run`
+    # By default list of stable checks is used.
+    enabled-checks:
+      #- rangeValCopy
+      - nestingreduce
+      - truncatecmp
+      - unnamedresult
+      - ruleguard
+
+    # Which checks should be disabled; can't be combined with 'enabled-checks'; default is empty
+    disabled-checks:
+      - regexpMust
+      - ifElseChain
+      #- exitAfterDefer
+
+    # Enable multiple checks by tags, run `GL_DEBUG=gocritic golangci-lint run` to see all tags and checks.
+    # Empty list by default. See https://github.com/go-critic/go-critic#usage -> section "Tags".
+    enabled-tags:
+      - performance
+    disabled-tags:
+      - experimental
+
+    # Settings passed to gocritic.
+    # The settings key is the name of a supported gocritic checker.
+    # The list of supported checkers can be find in https://go-critic.github.io/overview.
+    settings:
+      captLocal: # must be valid enabled check name
+        # whether to restrict checker to params only (default true)
+        paramsOnly: true
+      elseif:
+        # whether to skip balanced if-else pairs (default true)
+        skipBalanced: true
+      hugeParam:
+        # size in bytes that makes the warning trigger (default 80)
+        sizeThreshold: 80
+      nestingReduce:
+        # min number of statements inside a branch to trigger a warning (default 5)
+        bodyWidth: 5
+      rangeExprCopy:
+        # size in bytes that makes the warning trigger (default 512)
+        sizeThreshold: 512
+        # whether to check test functions (default true)
+        skipTestFuncs: true
+      rangeValCopy:
+        # size in bytes that makes the warning trigger (default 128)
+        sizeThreshold: 32
+        # whether to check test functions (default true)
+        skipTestFuncs: true
+      ruleguard:
+        # path to a gorules file for the ruleguard checker
+        rules: ''
+      truncateCmp:
+        # whether to skip int/uint/uintptr types (default true)
+        skipArchDependent: true
+      underef:
+        # whether to skip (*x).method() calls where x is a pointer receiver (default true)
+        skipRecvDeref: true
+      unnamedResult:
+        # whether to check exported functions
+        checkExported: true
+  gocyclo:
+    # minimal code complexity to report, 30 by default (but we recommend 10-20)
+    min-complexity: 30
+  cyclop:
+    # the maximal code complexity to report
+    max-complexity: 50
+    # the maximal average package complexity. If it's higher than 0.0 (float) the check is enabled (default 0.0)
+    package-average: 0.0
+    # should ignore tests (default false)
+    skip-tests: false
+  godot:
+    # comments to be checked: `declarations`, `toplevel`, or `all`
+    scope: declarations
+    # list of regexps for excluding particular comment lines from check
+    exclude:
+      # example: exclude comments which contain numbers
+      # - '[0-9]+'
+    # check that each sentence starts with a capital letter
+    capital: false
+  godox:
+    # report any comments starting with keywords, this is useful for TODO or FIXME comments that
+    # might be left in the code accidentally and should be resolved before merging
+    keywords: # default keywords are TODO, BUG, and FIXME, these can be overwritten by this setting
+      #- TODO
+      - BUG
+      - FIXME
+      #- NOTE
+      - OPTIMIZE # marks code that should be optimized before merging
+      - HACK # marks hack-arounds that should be removed before merging
+  gofmt:
+    # simplify code: gofmt with `-s` option, true by default
+    simplify: true
+
+  gofumpt:
+    # Select the Go version to target. The default is `1.18`.
+    lang-version: "1.20"
+
+    # Choose whether or not to use the extra rules that are disabled
+    # by default
+    extra-rules: false
+
+  goheader:
+    values:
+      const:
+        # define here const type values in format k:v, for example:
+        # COMPANY: MY COMPANY
+      regexp:
+        # define here regexp type values, for example
+        # AUTHOR: .*@mycompany\.com
+    template: # |-
+      # put here copyright header template for source code files, for example:
+      # Note: {{ YEAR }} is a builtin value that returns the year relative to the current machine time.
+      #
+      # {{ AUTHOR }} {{ COMPANY }} {{ YEAR }}
+      # SPDX-License-Identifier: Apache-2.0
+
+      # 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.
+    template-path:
+      # also as alternative of directive 'template' you may put the path to file with the template source
+  goimports:
+    # put imports beginning with prefix after 3rd-party packages;
+    # it's a comma-separated list of prefixes
+    local-prefixes: github.com/openimsdk/open-im-server
+
+  gomnd:
+    settings:
+      mnd:
+        # the list of enabled checks, see https://github.com/tommy-muehle/go-mnd/#checks for description.
+        checks: argument,case,condition,operation,return,assign
+        # ignored-numbers: 1000
+        # ignored-files: magic_.*.go
+        # ignored-functions: math.*
+  gomoddirectives:
+    # Allow local `replace` directives. Default is false.
+    replace-local: true
+    # List of allowed `replace` directives. Default is empty.
+    replace-allow-list:
+      - google.golang.org/grpc
+
+    # Allow to not explain why the version has been retracted in the `retract` directives. Default is false.
+    retract-allow-no-explanation: false
+    # Forbid the use of the `exclude` directives. Default is false.
+    exclude-forbidden: false
+  gomodguard:
+    allowed:
+      modules:    
+        - gorm.io/gen                                                    # List of allowed modules
+        - gorm.io/gorm
+        - gorm.io/driver/mysql
+        - k8s.io/klog
+        - github.com/allowed/module
+        - go.mongodb.org/mongo-driver/mongo
+        # - gopkg.in/yaml.v2
+      domains:                                                        # List of allowed module domains
+        - google.golang.org
+        - gopkg.in
+        - golang.org
+        - github.com
+        - go.mongodb.org
+        - go.uber.org
+        - openim.io
+        - go.etcd.io
+    blocked:
+      versions:
+        - github.com/MakeNowJust/heredoc:
+            version: "> 2.0.9"
+            reason: "use the latest version"
+      local_replace_directives: false     # Set to true to raise lint issues for packages that are loaded from a local path via replace directive
+
+  gosec:
+    # To select a subset of rules to run.
+    # Available rules: https://github.com/securego/gosec#available-rules
+    includes:
+      - G401
+      - G306
+      - G101
+    # To specify a set of rules to explicitly exclude.
+    # Available rules: https://github.com/securego/gosec#available-rules
+    excludes:
+      - G204
+    # Exclude generated files
+    exclude-generated: true
+    # Filter out the issues with a lower severity than the given value. Valid options are: low, medium, high.
+    severity: "low"
+    # Filter out the issues with a lower confidence than the given value. Valid options are: low, medium, high.
+    confidence: "low"
+    # To specify the configuration of rules.
+    # The configuration of rules is not fully documented by gosec:
+    # https://github.com/securego/gosec#configuration
+    # https://github.com/securego/gosec/blob/569328eade2ccbad4ce2d0f21ee158ab5356a5cf/rules/rulelist.go#L60-L102
+    config:
+      G306: "0600"
+      G101:
+        pattern: "(?i)example"
+        ignore_entropy: false
+        entropy_threshold: "80.0"
+        per_char_threshold: "3.0"
+        truncate: "32"
+
+  gosimple:
+    # Select the Go version to target. The default is '1.13'.
+    go: "1.20"
+    # https://staticcheck.io/docs/options#checks
+    checks: [ "all" ]
+
+  govet:
+    # report about shadowed variables
+    check-shadowing: true
+
+    # settings per analyzer
+    settings:
+      printf: # analyzer name, run `go tool vet help` to see all analyzers
+        funcs: # run `go tool vet help printf` to see available settings for `printf` analyzer
+          - (github.com/golangci/golangci-lint/pkg/logutils.Log).Infof
+          - (github.com/golangci/golangci-lint/pkg/logutils.Log).Warnf
+          - (github.com/golangci/golangci-lint/pkg/logutils.Log).Errorf
+          - (github.com/golangci/golangci-lint/pkg/logutils.Log).Fatalf
+
+    # enable or disable analyzers by name
+    enable:
+      - atomicalign
+    enable-all: false
+    disable:
+      - shadow
+    disable-all: false
+  # depguard:
+  #   list-type: blacklist
+  #   include-go-root: false
+  #   packages:
+  #     - github.com/Sirupsen/logrus
+  #   packages-with-error-message:
+  #     # specify an error message to output when a blacklisted package is used
+  #     - github.com/Sirupsen/logrus: "logging is allowed only by logutils.Log"
+
+
+  importas:
+    # if set to `true`, force to use alias.
+    no-unaliased: true
+    # List of aliases
+    alias:
+      # using `servingv1` alias for `knative.dev/serving/pkg/apis/serving/v1` package
+      - pkg: knative.dev/serving/pkg/apis/serving/v1
+        alias: servingv1
+      # using `autoscalingv1alpha1` alias for `knative.dev/serving/pkg/apis/autoscaling/v1alpha1` package
+      - pkg: knative.dev/serving/pkg/apis/autoscaling/v1alpha1
+        alias: autoscalingv1alpha1
+      # You can specify the package path by regular expression,
+      # and alias by regular expression expansion syntax like below.
+      # see https://github.com/julz/importas#use-regular-expression for details
+      - pkg: knative.dev/serving/pkg/apis/(\w+)/(v[\w\d]+)
+        alias: $1$2
+    # using `jwt` alias for `github.com/appleboy/gin-jwt/v2` package
+    jwt: github.com/appleboy/gin-jwt/v2
+
+  ireturn:
+    # ireturn allows using `allow` and `reject` settings at the same time.
+    # Both settings are lists of the keywords and regular expressions matched to interface or package names.
+    # keywords:
+    # - `empty` for `interface{}`
+    # - `error` for errors
+    # - `stdlib` for standard library
+    # - `anon` for anonymous interfaces
+
+    # By default, it allows using errors, empty interfaces, anonymous interfaces,
+    # and interfaces provided by the standard library.
+    allow:
+    - anon
+    - error
+    - empty
+    - stdlib
+    # You can specify idiomatic endings for interface
+    - (or|er)$
+
+    # Reject patterns
+    reject:
+    - github.com\/user\/package\/v4\.Type
+
+  lll:
+    # max line length, lines longer will be reported. Default is 120.
+    # '\t' is counted as 1 character by default, and can be changed with the tab-width option
+    line-length: 240
+    # tab width in spaces. Default to 1.
+    tab-width: 4
+  maligned:
+    # print struct with more effective memory layout or not, false by default
+    suggest-new: true
+  misspell:
+    # Correct spellings using locale preferences for US or UK.
+    # Default is to use a neutral variety of English.
+    # Setting locale to US will correct the British spelling of 'colour' to 'color'.
+    locale: US
+    ignore-words:
+      - someword
+  nakedret:
+    # make an issue if func has more lines of code than this setting and it has naked returns; default is 30
+    max-func-lines: 30
+
+  nestif:
+    # minimal complexity of if statements to report, 5 by default
+    min-complexity: 4
+
+  nilnil:
+    # By default, nilnil checks all returned types below.
+    checked-types:
+      - ptr
+      - func
+      - iface
+      - map
+      - chan
+
+  nlreturn:
+    # size of the block (including return statement that is still "OK")
+    # so no return split required.
+    block-size: 1
+
+  nolintlint:
+    # Disable to ensure that all nolint directives actually have an effect. Default is true.
+    allow-unused: false
+    # Disable to ensure that nolint directives don't have a leading space. Default is true.
+    allow-leading-space: true
+    # Exclude following linters from requiring an explanation.  Default is [].
+    allow-no-explanation: [ ]
+    # Enable to require an explanation of nonzero length after each nolint directive. Default is false.
+    require-explanation: false
+    # Enable to require nolint directives to mention the specific linter being suppressed. Default is false.
+    require-specific: true
+
+  prealloc:
+    # XXX: we don't recommend using this linter before doing performance profiling.
+    # For most programs usage of prealloc will be a premature optimization.
+
+    # Report preallocation suggestions only on simple loops that have no returns/breaks/continues/gotos in them.
+    # True by default.
+    simple: true
+    range-loops: true # Report preallocation suggestions on range loops, true by default
+    for-loops: false # Report preallocation suggestions on for loops, false by default
+
+  promlinter:
+    # Promlinter cannot infer all metrics name in static analysis.
+    # Enable strict mode will also include the errors caused by failing to parse the args.
+    strict: false
+    # Please refer to https://github.com/yeya24/promlinter#usage for detailed usage.
+    disabled-linters:
+    #  - "Help"
+    #  - "MetricUnits"
+    #  - "Counter"
+    #  - "HistogramSummaryReserved"
+    #  - "MetricTypeInName"
+    #  - "ReservedChars"
+    #  - "CamelCase"
+    #  - "lintUnitAbbreviations"
+    
+  predeclared:
+    # comma-separated list of predeclared identifiers to not report on
+    ignore: ""
+    # include method names and field names (i.e., qualified names) in checks
+    q: false
+  rowserrcheck:
+    packages:
+      - github.com/jmoiron/sqlx
+  revive:
+    # see https://github.com/mgechev/revive#available-rules for details.
+    ignore-generated-header: true
+    severity: warning
+    rules:
+      - name: indent-error-flow
+        severity: warning
+  staticcheck:
+    # Select the Go version to target. The default is '1.13'.
+    go: "1.16"
+    # https://staticcheck.io/docs/options#checks
+    checks: [ "all" ]
+
+  stylecheck:
+    # Select the Go version to target. The default is '1.13'.
+    go: "1.16"
+
+    # https://staticcheck.io/docs/options#checks
+    checks: [ "all", "-ST1000", "-ST1003", "-ST1016", "-ST1020", "-ST1021", "-ST1022" ]
+    # https://staticcheck.io/docs/options#dot_import_whitelist
+    dot-import-whitelist:
+      - fmt
+    # https://staticcheck.io/docs/options#initialisms
+    initialisms: [ "ACL", "API", "ASCII", "CPU", "CSS", "DNS", "EOF", "GUID", "HTML", "HTTP", "HTTPS", "ID", "IP", "JSON", "QPS", "RAM", "RPC", "SLA", "SMTP", "SQL", "SSH", "TCP", "TLS", "TTL", "UDP", "UI", "GID", "UID", "UUID", "URI", "URL", "UTF8", "VM", "XML", "XMPP", "XSRF", "XSS" ]
+    # https://staticcheck.io/docs/options#http_status_code_whitelist
+    http-status-code-whitelist: [ "200", "400", "404", "500" ]
+
+
+  tagliatelle:
+    # check the struck tag name case
+    case:
+      # use the struct field name to check the name of the struct tag
+      use-field-name: true
+      rules:
+        # any struct tag type can be used.
+        # support string case: `camel`, `pascal`, `kebab`, `snake`, `goCamel`, `goPascal`, `goKebab`, `goSnake`, `upper`, `lower`
+        json: camel
+        yaml: camel
+        xml: camel
+        bson: camel
+        avro: snake
+        mapstructure: kebab
+
+  testpackage:
+    # regexp pattern to skip files
+    skip-regexp: (id|export|internal)_test\.go
+  thelper:
+    # The following configurations enable all checks. It can be omitted because all checks are enabled by default.
+    # You can enable only required checks deleting unnecessary checks.
+    test:
+      first: true
+      name: true
+      begin: true
+    benchmark:
+      first: true
+      name: true
+      begin: true
+    tb:
+      first: true
+      name: true
+      begin: true
+
+  tenv:
+    # The option `all` will run against whole test files (`_test.go`) regardless of method/function signatures.
+    # By default, only methods that take `*testing.T`, `*testing.B`, and `testing.TB` as arguments are checked.
+    all: false
+
+  unparam:
+    # Inspect exported functions, default is false. Set to true if no external program/library imports your code.
+    # XXX: if you enable this setting, unparam will report a lot of false-positives in text editors:
+    # if it's called for subdir of a project it can't find external interfaces. All text editor integrations
+    # with golangci-lint call it on a directory with the changed file.
+    check-exported: false
+  unused:
+    # treat code as a program (not a library) and report unused exported identifiers; default is false.
+    # XXX: if you enable this setting, unused will report a lot of false-positives in text editors:
+    # if it's called for subdir of a project it can't find funcs usages. All text editor integrations
+    # with golangci-lint call it on a directory with the changed file.
+    check-exported: false
+  whitespace:
+    multi-if: false   # Enforces newlines (or comments) after every multi-line if statement
+    multi-func: false # Enforces newlines (or comments) after every multi-line function signature
+
+  wrapcheck:
+    # An array of strings that specify substrings of signatures to ignore.
+    # If this set, it will override the default set of ignored signatures.
+    # See https://github.com/tomarrell/wrapcheck#configuration for more information.
+    ignoreSigs:
+      - .Errorf(
+      - errors.New(
+      - errors.Unwrap(
+      - .Wrap(
+      - .Wrapf(
+      - .WithMessage(
+      - .WithMessagef(
+      - .WithStack(
+    ignorePackageGlobs:
+        - encoding/*
+        - github.com/pkg/*
+
+  wsl:
+    # If true append is only allowed to be cuddled if appending value is
+    # matching variables, fields or types on line above. Default is true.
+    strict-append: true
+    # Allow calls and assignments to be cuddled as long as the lines have any
+    # matching variables, fields or types. Default is true.
+    allow-assign-and-call: true
+    # Allow assignments to be cuddled with anything. Default is false.
+    allow-assign-and-anything: false
+    # Allow multiline assignments to be cuddled. Default is true.
+    allow-multiline-assign: true
+    # Allow declarations (var) to be cuddled.
+    allow-cuddle-declarations: false
+    # Allow trailing comments in ending of blocks
+    allow-trailing-comment: false
+    # Force newlines in end of case at this limit (0 = never).
+    force-case-trailing-whitespace: 0
+    # Force cuddling of err checks with err var assignment
+    force-err-cuddling: false
+    # Allow leading comments to be separated with empty liens
+    allow-separated-leading-comment: false
+  makezero:
+    # Allow only slices initialized with a length of zero. Default is false.
+    always: false
+
+
+  # The custom section can be used to define linter plugins to be loaded at runtime. See README doc
+  #  for more info.
+  #custom:
+    # Each custom linter should have a unique name.
+    #example:
+      # The path to the plugin *.so. Can be absolute or local. Required for each custom linter
+      #path: /path/to/example.so
+      # The description of the linter. Optional, just for documentation purposes.
+      #description: This is an example usage of a plugin linter.
+      # Intended to point to the repo location of the linter. Optional, just for documentation purposes.
+      #original-url: github.com/golangci/example-linter
+
+linters:
+  # please, do not use `enable-all`: it's deprecated and will be removed soon.
+  # inverted configuration with `enable-all` and `disable` is not scalable during updates of golangci-lint
+  # enable-all: true
+  disable-all: true
+  enable:
+    - typecheck
+    - asciicheck
+    - bodyclose
+    - cyclop
+    # - depguard
+    - dogsled
+    - dupl
+    - durationcheck
+    - errcheck
+    - errorlint
+    - exhaustive
+    - exportloopref
+    # - forbidigo
+    - funlen
+    # - gci
+    # - gochecknoinits
+    - gocognit
+    - goconst
+    - gocyclo
+    - godot
+    - godox
+    - gofmt
+    - gofumpt
+    - goheader
+    - goimports
+    - gomoddirectives
+    - gomodguard
+    - goprintffuncname
+    - gosec
+    - gosimple
+    - govet
+    - importas
+    - ineffassign
+    - lll
+    - makezero
+    - misspell
+    - nakedret
+    - nestif
+    - nilerr
+    - nlreturn
+    - noctx
+    - nolintlint
+    - paralleltest
+    - prealloc
+    - predeclared
+    - promlinter
+    - revive
+    - rowserrcheck
+    - sqlclosecheck
+    - staticcheck
+    - stylecheck
+    - thelper
+    - tparallel
+    - unconvert
+    - unparam
+    - unused
+    - wastedassign
+    - whitespace
+    - bidichk
+    - wastedassign
+    - execinquery
+    - nosprintfhostport
+    - grouper
+    - decorder
+    - errchkjson
+    - maintidx
+      #- containedctx
+      #- tagliatelle
+      #- nonamedreturns
+      #- nilnil
+      #- tenv
+      #- varnamelen
+      #- contextcheck
+      #- errname
+      #- ForceTypeAssert
+      #- nilassign
+  fast: false
+
+issues:
+  # List of regexps of issue texts to exclude, empty list by default.
+  # But independently from this option we use default exclude patterns,
+  # it can be disabled by `exclude-use-default: false`. To list all
+  # excluded by default patterns execute `golangci-lint run --help`
+  exclude:
+    - tools/.*
+    - test/.*
+    - third_party/.*
+
+  # Excluding configuration per-path, per-linter, per-text and per-source
+  exclude-rules:
+    - linters:
+      - revive
+      path: (log/.*)\.go
+
+    - linters:
+      - wrapcheck
+      path: (cmd/.*|pkg/.*)\.go
+
+    - linters:
+      - typecheck
+        #path: (pkg/storage/.*)\.go
+      path: (internal/.*|pkg/.*)\.go
+
+    - path: (cmd/.*|test/.*|tools/.*|internal/pump/pumps/.*)\.go
+      linters:
+        - forbidigo
+
+    - path: (cmd/[a-z]*/.*|store/.*)\.go
+      linters:
+        - dupl
+
+    - linters:
+        - gocritic
+      text: (hugeParam:|rangeValCopy:)
+
+    - path: (cmd/[a-z]*/.*)\.go
+      linters:
+        - lll
+
+    - path: (validator/.*|code/.*|validator/.*|watcher/watcher/.*)
+      linters:
+        - gochecknoinits
+
+    - path: (internal/.*/options|internal/pump|pkg/log/options.go|internal/authzserver|tools/)
+      linters:
+        - tagliatelle
+
+    - path: (pkg/app/.*)\.go
+      linters:
+        - unused
+        - forbidigo
+
+    # Exclude some staticcheck messages
+    - linters:
+        - staticcheck
+      text: "SA9003:"
+
+    # Exclude lll issues for long lines with go:generate
+    - linters:
+        - lll
+      source: "^//go:generate "
+
+  # Independently from option `exclude` we use default exclude patterns,
+  # it can be disabled by this option. To list all
+  # excluded by default patterns execute `golangci-lint run --help`.
+  # Default value for this option is true.
+  exclude-use-default: true
+
+  # The default value is false. If set to true exclude and exclude-rules
+  # regular expressions become case sensitive.
+  exclude-case-sensitive: false
+
+  # The list of ids of default excludes to include or disable. By default it's empty.
+  include:
+    - EXC0002 # disable excluding of issues about comments from golint
+
+  # Maximum issues count per one linter. Set to 0 to disable. Default is 50.
+  max-issues-per-linter: 0
+
+  # Maximum count of issues with the same text. Set to 0 to disable. Default is 3.
+  max-same-issues: 0
+
+  # Show only new issues: if there are unstaged changes or untracked files,
+  # only those changes are analyzed, else only changes in HEAD~ are analyzed.
+  # It's a super-useful option for integration of golangci-lint into existing
+  # large codebase. It's not practical to fix all existing issues at the moment
+  # of integration: much better don't allow issues in new code.
+  # Default is false.
+  new: false
+
+  # Show only new issues created after git revision `REV`
+  # new-from-rev: REV
+
+  # Show only new issues created in git patch with set file path.
+  #new-from-patch: path/to/patch/file
+
+  # Fix found issues (if it's supported by the linter)
+  fix: true
+
+severity:
+  # Default value is empty string.
+  # Set the default severity for issues. If severity rules are defined and the issues
+  # do not match or no severity is provided to the rule this will be the default
+  # severity applied. Severities should match the supported severity names of the
+  # selected out format.
+  # - Code climate: https://docs.codeclimate.com/docs/issues#issue-severity
+  # -   Checkstyle: https://checkstyle.sourceforge.io/property_types.html#severity
+  # -       Github: https://help.github.com/en/actions/reference/workflow-commands-for-github-actions#setting-an-error-message
+  default-severity: error
+
+  # The default value is false.
+  # If set to true severity-rules regular expressions become case sensitive.
+  case-sensitive: false
+
+  # Default value is empty list.
+  # When a list of severity rules are provided, severity information will be added to lint
+  # issues. Severity rules have the same filtering capability as exclude rules except you
+  # are allowed to specify one matcher per severity rule.
+  # Only affects out formats that support setting severity information.
+  rules:
+    - linters:
+      - dupl
+      severity: info

CHANGELOG.md

@@ -0,0 +1 @@
+CHANGELOG/CHANGELOG.md

CHANGELOG/.chglog/CHANGELOG.tpl.md

@@ -0,0 +1,62 @@
+# Version logging for OpenIM
+
+<!-- BEGIN MUNGE: GENERATED_TOC -->
+
+<!-- END MUNGE: GENERATED_TOC -->
+
+{{ if .Versions -}}
+<a name="unreleased"></a>
+## [Unreleased]
+
+{{ if .Unreleased.CommitGroups -}}
+{{ range .Unreleased.CommitGroups -}}
+### {{ .Title }}
+{{ range .Commits -}}
+- {{ if .Scope }}**{{ .Scope }}:** {{ end }}{{ .Subject }}
+{{ end }}
+{{ end -}}
+{{ end -}}
+{{ end -}}
+
+{{ range .Versions }}
+<a name="{{ .Tag.Name }}"></a>
+## {{ if .Tag.Previous }}[{{ .Tag.Name }}]{{ else }}{{ .Tag.Name }}{{ end }} - {{ datetime "2006-01-02" .Tag.Date }}
+{{ range .CommitGroups -}}
+### {{ .Title }}
+{{ range .Commits -}}
+- {{ if .Scope }}**{{ .Scope }}:** {{ end }}{{ .Subject }}
+{{ end }}
+{{ end -}}
+
+{{- if .RevertCommits -}}
+### Reverts
+{{ range .RevertCommits -}}
+- {{ .Revert.Header }}
+{{ end }}
+{{ end -}}
+
+{{- if .MergeCommits -}}
+### Pull Requests
+{{ range .MergeCommits -}}
+- {{ .Header }}
+{{ end }}
+{{ end -}}
+
+{{- if .NoteGroups -}}
+{{ range .NoteGroups -}}
+### {{ .Title }}
+{{ range .Notes }}
+{{ .Body }}
+{{ end }}
+{{ end -}}
+{{ end -}}
+{{ end -}}
+
+{{- if .Versions }}
+[Unreleased]: {{ .Info.RepositoryURL }}/compare/{{ $latest := index .Versions 0 }}{{ $latest.Tag.Name }}...HEAD
+{{ range .Versions -}}
+{{ if .Tag.Previous -}}
+[{{ .Tag.Name }}]: {{ $.Info.RepositoryURL }}/compare/{{ .Tag.Previous.Name }}...{{ .Tag.Name }}
+{{ end -}}
+{{ end -}}
+{{ end -}}

CHANGELOG/.chglog/config.yml

@@ -0,0 +1,67 @@
+bin: git
+style: github
+template: CHANGELOG.tpl.md
+info:
+  title: CHANGELOG
+  repository_url: https://github.com/openimsdk/open-im-server
+options:
+  tag_filter_pattern: '^v'
+  sort: "date"
+
+  commits:
+    filters:
+      Type:
+        - feat
+        - fix
+        - perf
+        - refactor
+        - docs
+        - test
+        - chore
+        - ci
+        - build
+    sort_by: Scope
+
+  commit_groups:
+    group_by: Type
+    sort_by: Title
+    title_order:
+      - feat
+      - fix
+      - perf
+      - refactor
+      - docs
+      - test
+      - chore
+      - ci
+      - build
+    title_maps:
+      feat: Features
+
+  header:
+    pattern: "<regexp>"
+    pattern_maps:
+      - PropName
+
+  issues:
+    prefix:
+      - #
+
+  refs:
+    actions:
+      - Closes
+      - Fixes
+
+  merges:
+    pattern: "^Merge branch '(\\w+)'$"
+    pattern_maps:
+      - Source
+
+  reverts:
+    pattern: "^Revert \"([\\s\\S]*)\"$"
+    pattern_maps:
+      - Header
+
+  notes:
+    keywords:
+      - BREAKING CHANGE

CHANGELOG/CHANGELOG-1.0.md

@@ -0,0 +1,56 @@
+# Version logging for OpenIM
+
+> **Note**:
+> Deprecated version logging for OpenIM, please refer to [CHANGELOG.md](../CHANGELOG.md)
+
+<!-- BEGIN MUNGE: GENERATED_TOC -->
+
+- [Version logging for OpenIM](#version-logging-for-openim)
+  - [Unreleased](#unreleased)
+  - [v1.0.7 - 2021-12-17](#v107---2021-12-17)
+  - [v1.0.6 - 2021-12-10](#v106---2021-12-10)
+  - [v1.0.5 - 2021-12-03](#v105---2021-12-03)
+  - [v1.0.4 - 2021-11-25](#v104---2021-11-25)
+  - [v1.0.3 - 2021-11-12](#v103---2021-11-12)
+  - [v1.0.1 - 2021-11-04](#v101---2021-11-04)
+  - [v1.0.0 - 2021-10-28](#v100---2021-10-28)
+    - [Reverts](#reverts)
+
+<!-- END MUNGE: GENERATED_TOC -->
+
+<a name="unreleased"></a>
+## [Unreleased]
+
+
+<a name="v1.0.7"></a>
+## [v1.0.7] - 2021-12-17
+
+<a name="v1.0.6"></a>
+## [v1.0.6] - 2021-12-10
+
+<a name="v1.0.5"></a>
+## [v1.0.5] - 2021-12-03
+
+<a name="v1.0.4"></a>
+## [v1.0.4] - 2021-11-25
+
+<a name="v1.0.3"></a>
+## [v1.0.3] - 2021-11-12
+
+<a name="v1.0.1"></a>
+## [v1.0.1] - 2021-11-04
+
+<a name="v1.0.0"></a>
+## v1.0.0 - 2021-10-28
+### Reverts
+- friend modify
+- update
+
+
+[Unreleased]: https://github.com/openimsdk/open-im-server/compare/v1.0.7...HEAD
+[v1.0.7]: https://github.com/openimsdk/open-im-server/compare/v1.0.6...v1.0.7
+[v1.0.6]: https://github.com/openimsdk/open-im-server/compare/v1.0.5...v1.0.6
+[v1.0.5]: https://github.com/openimsdk/open-im-server/compare/v1.0.4...v1.0.5
+[v1.0.4]: https://github.com/openimsdk/open-im-server/compare/v1.0.3...v1.0.4
+[v1.0.3]: https://github.com/openimsdk/open-im-server/compare/v1.0.1...v1.0.3
+[v1.0.1]: https://github.com/openimsdk/open-im-server/compare/v1.0.0...v1.0.1

CHANGELOG/CHANGELOG-2.0.md

@@ -0,0 +1,87 @@
+# Version logging for OpenIM
+
+<!-- BEGIN MUNGE: GENERATED_TOC -->
+
+<!-- END MUNGE: GENERATED_TOC -->
+
+<a name="unreleased"></a>
+## [Unreleased]
+
+
+<a name="v2.0.10"></a>
+## [v2.0.10] - 2022-05-13
+
+<a name="v2.0.9"></a>
+## [v2.0.9] - 2022-04-29
+### Reverts
+- update etcd to v3.5.2 ([#206](https://github.com/openimsdk/open-im-server/issues/206))
+
+### Pull Requests
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+
+
+<a name="v2.0.8"></a>
+## [v2.0.8] - 2022-04-24
+### Pull Requests
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+
+
+<a name="v2.0.7"></a>
+## [v2.0.7] - 2022-04-08
+### Pull Requests
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+
+
+<a name="v2.0.6"></a>
+## [v2.0.6] - 2022-04-01
+### Pull Requests
+- Merge branch 'tuoyun'
+
+
+<a name="v2.0.5"></a>
+## [v2.0.5] - 2022-03-24
+
+<a name="v2.04"></a>
+## [v2.04] - 2022-03-18
+
+<a name="v2.0.3"></a>
+## [v2.0.3] - 2022-03-11
+
+<a name="v2.0.2"></a>
+## [v2.0.2] - 2022-03-04
+### Pull Requests
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+
+
+<a name="v2.0.1"></a>
+## [v2.0.1] - 2022-02-25
+
+<a name="v2.0.0"></a>
+## v2.0.0 - 2022-02-23
+### Reverts
+- friend modify
+- update
+
+
+[Unreleased]: https://github.com/openimsdk/open-im-server/compare/v2.0.10...HEAD
+[v2.0.10]: https://github.com/openimsdk/open-im-server/compare/v2.0.9...v2.0.10
+[v2.0.9]: https://github.com/openimsdk/open-im-server/compare/v2.0.8...v2.0.9
+[v2.0.8]: https://github.com/openimsdk/open-im-server/compare/v2.0.7...v2.0.8
+[v2.0.7]: https://github.com/openimsdk/open-im-server/compare/v2.0.6...v2.0.7
+[v2.0.6]: https://github.com/openimsdk/open-im-server/compare/v2.0.5...v2.0.6
+[v2.0.5]: https://github.com/openimsdk/open-im-server/compare/v2.04...v2.0.5
+[v2.04]: https://github.com/openimsdk/open-im-server/compare/v2.0.3...v2.04
+[v2.0.3]: https://github.com/openimsdk/open-im-server/compare/v2.0.2...v2.0.3
+[v2.0.2]: https://github.com/openimsdk/open-im-server/compare/v2.0.1...v2.0.2
+[v2.0.1]: https://github.com/openimsdk/open-im-server/compare/v2.0.0...v2.0.1

CHANGELOG/CHANGELOG-2.1.md

@@ -0,0 +1,50 @@
+# Version logging for OpenIM:v2.1
+
+> **Note**:
+> Deprecated version logging for OpenIM, please refer to [CHANGELOG.md](../CHANGELOG.md)
+
+<!-- BEGIN MUNGE: GENERATED_TOC -->
+
+- [Version logging for OpenIM:v2.1](#version-logging-for-openimv21)
+  - [Unreleased](#unreleased)
+  - [v2.1.0 - 2022-06-17](#v210---2022-06-17)
+    - [Reverts](#reverts)
+    - [Pull Requests](#pull-requests)
+
+
+<!-- END MUNGE: GENERATED_TOC -->
+
+<a name="unreleased"></a>
+## [Unreleased]
+
+
+<a name="v2.1.0"></a>
+## v2.1.0 - 2022-06-17
+### Reverts
+- update etcd to v3.5.2 ([#206](https://github.com/openimsdk/open-im-server/issues/206))
+- friend modify
+- update
+
+### Pull Requests
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+
+
+[Unreleased]: https://github.com/openimsdk/open-im-server/compare/v2.1.0...HEAD

CHANGELOG/CHANGELOG-2.2.md

@@ -0,0 +1,50 @@
+# Version logging for OpenIM:v2.2
+
+> **Note**:
+> Deprecated version logging for OpenIM, please refer to [CHANGELOG.md](../CHANGELOG.md)
+
+<!-- BEGIN MUNGE: GENERATED_TOC -->
+
+- [Version logging for OpenIM:v2.2](#version-logging-for-openimv22)
+  - [Unreleased](#unreleased)
+  - [v2.2.0 - 2022-07-01](#v220---2022-07-01)
+    - [Reverts](#reverts)
+    - [Pull Requests](#pull-requests)
+
+
+<!-- END MUNGE: GENERATED_TOC -->
+
+<a name="unreleased"></a>
+## [Unreleased]
+
+
+<a name="v2.2.0"></a>
+## v2.2.0 - 2022-07-01
+### Reverts
+- update etcd to v3.5.2 ([#206](https://github.com/openimsdk/open-im-server/issues/206))
+- friend modify
+- update
+
+### Pull Requests
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+
+
+[Unreleased]: https://github.com/openimsdk/open-im-server/compare/v2.2.0...HEAD

CHANGELOG/CHANGELOG-2.3.md

@@ -0,0 +1,70 @@
+# Version logging for OpenIM:v2.3
+
+> **Note**:
+> Deprecated version logging for OpenIM, please refer to [CHANGELOG.md](../CHANGELOG.md)
+
+<!-- BEGIN MUNGE: GENERATED_TOC -->
+
+- [Version logging for OpenIM:v2.3](#version-logging-for-openimv23)
+  - [Unreleased](#unreleased)
+  - [v2.3.3 - 2022-09-18](#v233---2022-09-18)
+  - [v2.3.2 - 2022-09-09](#v232---2022-09-09)
+  - [v2.3.0-rc2 - 2022-07-29](#v230-rc2---2022-07-29)
+  - [v2.3.0-rc1 - 2022-07-25](#v230-rc1---2022-07-25)
+  - [v2.3.0-rc0 - 2022-07-15](#v230-rc0---2022-07-15)
+    - [Reverts](#reverts)
+    - [Pull Requests](#pull-requests)
+
+
+<!-- END MUNGE: GENERATED_TOC -->
+
+<a name="unreleased"></a>
+## [Unreleased]
+
+
+<a name="v2.3.3"></a>
+## [v2.3.3] - 2022-09-18
+
+<a name="v2.3.2"></a>
+## [v2.3.2] - 2022-09-09
+
+<a name="v2.3.0-rc2"></a>
+## [v2.3.0-rc2] - 2022-07-29
+
+<a name="v2.3.0-rc1"></a>
+## [v2.3.0-rc1] - 2022-07-25
+
+<a name="v2.3.0-rc0"></a>
+## v2.3.0-rc0 - 2022-07-15
+### Reverts
+- update etcd to v3.5.2 ([#206](https://github.com/openimsdk/open-im-server/issues/206))
+- friend modify
+- update
+
+### Pull Requests
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+
+
+[Unreleased]: https://github.com/openimsdk/open-im-server/compare/v2.3.3...HEAD
+[v2.3.3]: https://github.com/openimsdk/open-im-server/compare/v2.3.2...v2.3.3
+[v2.3.2]: https://github.com/openimsdk/open-im-server/compare/v2.3.0-rc2...v2.3.2
+[v2.3.0-rc2]: https://github.com/openimsdk/open-im-server/compare/v2.3.0-rc1...v2.3.0-rc2
+[v2.3.0-rc1]: https://github.com/openimsdk/open-im-server/compare/v2.3.0-rc0...v2.3.0-rc1

CHANGELOG/CHANGELOG-2.9.md

@@ -0,0 +1,52 @@
+# Version logging for OpenIM
+
+<!-- BEGIN MUNGE: GENERATED_TOC -->
+
+- [Version logging for OpenIM](#version-logging-for-openim)
+  - [Unreleased](#unreleased)
+  - [v2.9.0+1.839643f - 2023-07-07](#v2901839643f---2023-07-07)
+  - [v2.9.0+2.35f07fe - 2023-07-06](#v290235f07fe---2023-07-06)
+  - [v2.9.0+1.b5072b1 - 2023-07-05](#v2901b5072b1---2023-07-05)
+  - [v2.9.0+3.2667a3a - 2023-07-05](#v29032667a3a---2023-07-05)
+  - [v2.9.0+7.04818ca - 2023-07-05](#v290704818ca---2023-07-05)
+  - [v2.9.0 - 2023-07-04](#v290---2023-07-04)
+    - [Reverts](#reverts)
+    - [Pull Requests](#pull-requests)
+
+
+<!-- END MUNGE: GENERATED_TOC -->
+
+<a name="unreleased"></a>
+## [Unreleased]
+
+
+<a name="v2.9.0+1.839643f"></a>
+## [v2.9.0+1.839643f] - 2023-07-07
+
+<a name="v2.9.0+2.35f07fe"></a>
+## [v2.9.0+2.35f07fe] - 2023-07-06
+
+<a name="v2.9.0+1.b5072b1"></a>
+## [v2.9.0+1.b5072b1] - 2023-07-05
+
+<a name="v2.9.0+3.2667a3a"></a>
+## [v2.9.0+3.2667a3a] - 2023-07-05
+
+<a name="v2.9.0+7.04818ca"></a>
+## [v2.9.0+7.04818ca] - 2023-07-05
+
+<a name="v2.9.0"></a>
+## v2.9.0 - 2023-07-04
+### Reverts
+- update etcd to v3.5.2 ([#206](https://github.com/openimsdk/open-im-server/issues/206))
+
+### Pull Requests
+- Merge branch 'tuoyun'
+
+
+[Unreleased]: https://github.com/openimsdk/open-im-server/compare/v2.9.0+1.839643f...HEAD
+[v2.9.0+1.839643f]: https://github.com/openimsdk/open-im-server/compare/v2.9.0+2.35f07fe...v2.9.0+1.839643f
+[v2.9.0+2.35f07fe]: https://github.com/openimsdk/open-im-server/compare/v2.9.0+1.b5072b1...v2.9.0+2.35f07fe
+[v2.9.0+1.b5072b1]: https://github.com/openimsdk/open-im-server/compare/v2.9.0+3.2667a3a...v2.9.0+1.b5072b1
+[v2.9.0+3.2667a3a]: https://github.com/openimsdk/open-im-server/compare/v2.9.0+7.04818ca...v2.9.0+3.2667a3a
+[v2.9.0+7.04818ca]: https://github.com/openimsdk/open-im-server/compare/v2.9.0...v2.9.0+7.04818ca

CHANGELOG/CHANGELOG-3.0.md

@@ -0,0 +1,188 @@
+# Version logging for OpenIM
+
+<!-- BEGIN MUNGE: GENERATED_TOC -->
+- [Version logging for OpenIM](#version-logging-for-openim)
+  - [Unreleased](#unreleased)
+  - [v2.9.0 - 2023-07-04](#v290---2023-07-04)
+    - [Reverts](#reverts)
+    - [Pull Requests](#pull-requests)
+  - [v2.3.3 - 2022-09-18](#v233---2022-09-18)
+  - [v2.3.2 - 2022-09-09](#v232---2022-09-09)
+  - [v2.3.0-rc2 - 2022-07-29](#v230-rc2---2022-07-29)
+  - [v2.3.0-rc1 - 2022-07-25](#v230-rc1---2022-07-25)
+  - [v2.3.0-rc0 - 2022-07-15](#v230-rc0---2022-07-15)
+  - [v2.2.0 - 2022-07-01](#v220---2022-07-01)
+  - [v2.1.0 - 2022-06-17](#v210---2022-06-17)
+    - [Pull Requests](#pull-requests-1)
+  - [v2.0.10 - 2022-05-13](#v2010---2022-05-13)
+  - [v2.0.9 - 2022-04-29](#v209---2022-04-29)
+    - [Reverts](#reverts-1)
+    - [Pull Requests](#pull-requests-2)
+  - [v2.0.7 - 2022-04-08](#v207---2022-04-08)
+    - [Pull Requests](#pull-requests-3)
+  - [v2.0.6 - 2022-04-01](#v206---2022-04-01)
+    - [Pull Requests](#pull-requests-4)
+  - [v2.0.5 - 2022-03-24](#v205---2022-03-24)
+  - [v2.04 - 2022-03-18](#v204---2022-03-18)
+  - [v2.0.3 - 2022-03-11](#v203---2022-03-11)
+  - [v2.0.2 - 2022-03-04](#v202---2022-03-04)
+    - [Pull Requests](#pull-requests-5)
+  - [v2.0.1 - 2022-02-25](#v201---2022-02-25)
+  - [v2.0.0 - 2022-02-23](#v200---2022-02-23)
+  - [v1.0.7 - 2021-12-17](#v107---2021-12-17)
+  - [v1.0.6 - 2021-12-10](#v106---2021-12-10)
+  - [v1.0.5 - 2021-12-03](#v105---2021-12-03)
+  - [v1.0.4 - 2021-11-25](#v104---2021-11-25)
+  - [v1.0.3 - 2021-11-12](#v103---2021-11-12)
+  - [v1.0.1 - 2021-11-04](#v101---2021-11-04)
+  - [v1.0.0 - 2021-10-28](#v100---2021-10-28)
+    - [Reverts](#reverts-2)
+
+<!-- END MUNGE: GENERATED_TOC -->
+
+<a name="unreleased"></a>
+## [Unreleased]
+
+
+<a name="v2.9.0"></a>
+## [v2.9.0] - 2023-07-04
+### Reverts
+- update etcd to v3.5.2 ([#206](https://github.com/openimsdk/open-im-server/issues/206))
+
+### Pull Requests
+- Merge branch 'tuoyun'
+
+
+<a name="v2.3.3"></a>
+## [v2.3.3] - 2022-09-18
+
+<a name="v2.3.2"></a>
+## [v2.3.2] - 2022-09-09
+
+<a name="v2.3.0-rc2"></a>
+## [v2.3.0-rc2] - 2022-07-29
+
+<a name="v2.3.0-rc1"></a>
+## [v2.3.0-rc1] - 2022-07-25
+
+<a name="v2.3.0-rc0"></a>
+## [v2.3.0-rc0] - 2022-07-15
+
+<a name="v2.2.0"></a>
+## [v2.2.0] - 2022-07-01
+
+<a name="v2.1.0"></a>
+## [v2.1.0] - 2022-06-17
+### Pull Requests
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+
+
+<a name="v2.0.10"></a>
+## [v2.0.10] - 2022-05-13
+
+<a name="v2.0.9"></a>
+## [v2.0.9] - 2022-04-29
+### Reverts
+- update etcd to v3.5.2 ([#206](https://github.com/openimsdk/open-im-server/issues/206))
+
+### Pull Requests
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+
+
+<a name="v2.0.7"></a>
+## [v2.0.7] - 2022-04-08
+### Pull Requests
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+
+
+<a name="v2.0.6"></a>
+## [v2.0.6] - 2022-04-01
+### Pull Requests
+- Merge branch 'tuoyun'
+
+
+<a name="v2.0.5"></a>
+## [v2.0.5] - 2022-03-24
+
+<a name="v2.04"></a>
+## [v2.04] - 2022-03-18
+
+<a name="v2.0.3"></a>
+## [v2.0.3] - 2022-03-11
+
+<a name="v2.0.2"></a>
+## [v2.0.2] - 2022-03-04
+### Pull Requests
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+
+
+<a name="v2.0.1"></a>
+## [v2.0.1] - 2022-02-25
+
+<a name="v2.0.0"></a>
+## [v2.0.0] - 2022-02-23
+
+<a name="v1.0.7"></a>
+## [v1.0.7] - 2021-12-17
+
+<a name="v1.0.6"></a>
+## [v1.0.6] - 2021-12-10
+
+<a name="v1.0.5"></a>
+## [v1.0.5] - 2021-12-03
+
+<a name="v1.0.4"></a>
+## [v1.0.4] - 2021-11-25
+
+<a name="v1.0.3"></a>
+## [v1.0.3] - 2021-11-12
+
+<a name="v1.0.1"></a>
+## [v1.0.1] - 2021-11-04
+
+<a name="v1.0.0"></a>
+## v1.0.0 - 2021-10-28
+### Reverts
+- friend modify
+- update
+
+
+[Unreleased]: https://github.com/openimsdk/open-im-server/compare/v2.9.0...HEAD
+[v2.9.0]: https://github.com/openimsdk/open-im-server/compare/v2.3.3...v2.9.0
+[v2.3.3]: https://github.com/openimsdk/open-im-server/compare/v2.3.2...v2.3.3
+[v2.3.2]: https://github.com/openimsdk/open-im-server/compare/v2.3.0-rc2...v2.3.2
+[v2.3.0-rc2]: https://github.com/openimsdk/open-im-server/compare/v2.3.0-rc1...v2.3.0-rc2
+[v2.3.0-rc1]: https://github.com/openimsdk/open-im-server/compare/v2.3.0-rc0...v2.3.0-rc1
+[v2.3.0-rc0]: https://github.com/openimsdk/open-im-server/compare/v2.2.0...v2.3.0-rc0
+[v2.2.0]: https://github.com/openimsdk/open-im-server/compare/v2.1.0...v2.2.0
+[v2.1.0]: https://github.com/openimsdk/open-im-server/compare/v2.0.10...v2.1.0
+[v2.0.10]: https://github.com/openimsdk/open-im-server/compare/v2.0.9...v2.0.10
+[v2.0.9]: https://github.com/openimsdk/open-im-server/compare/v2.0.7...v2.0.9
+[v2.0.7]: https://github.com/openimsdk/open-im-server/compare/v2.0.6...v2.0.7
+[v2.0.6]: https://github.com/openimsdk/open-im-server/compare/v2.0.5...v2.0.6
+[v2.0.5]: https://github.com/openimsdk/open-im-server/compare/v2.04...v2.0.5
+[v2.04]: https://github.com/openimsdk/open-im-server/compare/v2.0.3...v2.04
+[v2.0.3]: https://github.com/openimsdk/open-im-server/compare/v2.0.2...v2.0.3
+[v2.0.2]: https://github.com/openimsdk/open-im-server/compare/v2.0.1...v2.0.2
+[v2.0.1]: https://github.com/openimsdk/open-im-server/compare/v2.0.0...v2.0.1
+[v2.0.0]: https://github.com/openimsdk/open-im-server/compare/v1.0.7...v2.0.0
+[v1.0.7]: https://github.com/openimsdk/open-im-server/compare/v1.0.6...v1.0.7
+[v1.0.6]: https://github.com/openimsdk/open-im-server/compare/v1.0.5...v1.0.6
+[v1.0.5]: https://github.com/openimsdk/open-im-server/compare/v1.0.4...v1.0.5
+[v1.0.4]: https://github.com/openimsdk/open-im-server/compare/v1.0.3...v1.0.4
+[v1.0.3]: https://github.com/openimsdk/open-im-server/compare/v1.0.1...v1.0.3
+[v1.0.1]: https://github.com/openimsdk/open-im-server/compare/v1.0.0...v1.0.1

CHANGELOG/CHANGELOG-3.1.md

@@ -0,0 +1,20 @@
+# Version logging for OpenIM
+
+<!-- BEGIN MUNGE: GENERATED_TOC -->
+
+<!-- END MUNGE: GENERATED_TOC -->
+
+<a name="unreleased"></a>
+## [Unreleased]
+
+
+<a name="v3.1.0"></a>
+## v3.1.0 - 2023-07-28
+### Reverts
+- update etcd to v3.5.2 ([#206](https://github.com/openimsdk/open-im-server/issues/206))
+
+### Pull Requests
+- Merge branch 'tuoyun'
+
+
+[Unreleased]: https://github.com/openimsdk/open-im-server/compare/v3.1.0...HEAD

CHANGELOG/CHANGELOG-3.2.md

@@ -0,0 +1,32 @@
+# Version logging for OpenIM
+
+<!-- BEGIN MUNGE: GENERATED_TOC -->
+
+<!-- END MUNGE: GENERATED_TOC -->
+
+<a name="unreleased"></a>
+## [Unreleased]
+
+
+<a name="v3.2.2-alpha.0"></a>
+## [v3.2.2-alpha.0] - 2023-08-25
+
+<a name="v3.2.0"></a>
+## [v3.2.0] - 2023-08-19
+
+<a name="v3.2.0-rc.0"></a>
+## [v3.2.0-rc.0] - 2023-08-17
+
+<a name="v3.2.0-alpha.0"></a>
+## v3.2.0-alpha.0 - 2023-08-16
+### Reverts
+- update etcd to v3.5.2 ([#206](https://github.com/openimsdk/open-im-server/issues/206))
+
+### Pull Requests
+- Merge branch 'tuoyun'
+
+
+[Unreleased]: https://github.com/openimsdk/open-im-server/compare/v3.2.2-alpha.0...HEAD
+[v3.2.2-alpha.0]: https://github.com/openimsdk/open-im-server/compare/v3.2.0...v3.2.2-alpha.0
+[v3.2.0]: https://github.com/openimsdk/open-im-server/compare/v3.2.0-rc.0...v3.2.0
+[v3.2.0-rc.0]: https://github.com/openimsdk/open-im-server/compare/v3.2.0-alpha.0...v3.2.0-rc.0

CHANGELOG/CHANGELOG-3.3.md

@@ -0,0 +1,40 @@
+# Version logging for OpenIM
+
+<!-- BEGIN MUNGE: GENERATED_TOC -->
+
+<!-- END MUNGE: GENERATED_TOC -->
+
+<a name="unreleased"></a>
+## [Unreleased]
+
+
+<a name="v3.3.1"></a>
+## [v3.3.1] - 2023-09-13
+
+<a name="v3.3.1-beta.0"></a>
+## [v3.3.1-beta.0] - 2023-09-11
+
+<a name="v3.3.0-rc.1"></a>
+## [v3.3.0-rc.1] - 2023-09-11
+
+<a name="v3.3.0-rc.12"></a>
+## [v3.3.0-rc.12] - 2023-09-11
+
+<a name="v3.3.0"></a>
+## [v3.3.0] - 2023-09-09
+
+<a name="v3.3.0-rc.0"></a>
+## v3.3.0-rc.0 - 2023-09-07
+### Reverts
+- update etcd to v3.5.2 ([#206](https://github.com/openimsdk/open-im-server/issues/206))
+
+### Pull Requests
+- Merge branch 'tuoyun'
+
+
+[Unreleased]: https://github.com/openimsdk/open-im-server/compare/v3.3.1...HEAD
+[v3.3.1]: https://github.com/openimsdk/open-im-server/compare/v3.3.1-beta.0...v3.3.1
+[v3.3.1-beta.0]: https://github.com/openimsdk/open-im-server/compare/v3.3.0-rc.1...v3.3.1-beta.0
+[v3.3.0-rc.1]: https://github.com/openimsdk/open-im-server/compare/v3.3.0-rc.12...v3.3.0-rc.1
+[v3.3.0-rc.12]: https://github.com/openimsdk/open-im-server/compare/v3.3.0...v3.3.0-rc.12
+[v3.3.0]: https://github.com/openimsdk/open-im-server/compare/v3.3.0-rc.0...v3.3.0

CHANGELOG/CHANGELOG.md

@@ -0,0 +1,173 @@
+# Changelog
+
+- [Changelog](#changelog)
+  - [OpenIM versioning policy](#openim-versioning-policy)
+  - [command](#command)
+    - [install](#install)
+  - [User](#user)
+  - [create next tag](#create-next-tag)
+  - [Release version logs](#release-version-logs)
+  - [Introduction](#introduction)
+  - [Naming Format](#naming-format)
+  - [Examples](#examples)
+  - [Version Modifiers](#version-modifiers)
+  - [Versioning Strategy](#versioning-strategy)
+
+
+All notable changes to this project will be documented in this file.
+
++ [https://github.com/openimsdk/open-im-server/releases](https://github.com/openimsdk/open-im-server/releases)
+
+## OpenIM versioning policy
+
++ [OpenIM Version](../docs/conversions/version.md)
+
+## command
+
+To use git-chglog you need to configure:
+
+1. CHANGELOG templates
+2. git-chglog configuration
+
+### install 
+
+```bash
+$ go get github.com/git-chglog/git-chglog/cmd/git-chglog
+```
+
+
+## User
+
+```bash
+$ git-chglog --init
+```
+
+**Options**
+
+- What is the URL of your repository?: https://github.com/openimsdk/open-im-server
+- What is your favorite style?: github
+- Choose the format of your favorite commit message: <type>(<scope>): <subject> -- feat(core): Add new feature
+- What is your favorite template style?: standard
+- Do you include Merge Commit in CHANGELOG?: n
+- Do you include Revert Commit in CHANGELOG?: y
+- In which directory do you output configuration files and templates?: .chglog
+
+```bash
+git-chglog --tag-filter-pattern 'v2.0.*'  -o CHANGELOG-2.0.md
+```
+
+**Other uses:**
+
+```bash
+$ git-chglog
+
+  If <tag query> is not specified, it corresponds to all tags.
+  This is the simplest example.
+
+$ git-chglog 1.0.0..2.0.0
+
+  The above is a command to generate CHANGELOG including commit of 1.0.0 to 2.0.0.
+
+$ git-chglog 1.0.0
+
+  The above is a command to generate CHANGELOG including commit of only 1.0.0.
+
+$ git-chglog $(git describe --tags $(git rev-list --tags --max-count=1))
+
+  The above is a command to generate CHANGELOG with the commit included in the latest tag.
+
+$ git-chglog --output CHANGELOG.md
+
+  The above is a command to output to CHANGELOG.md instead of standard output.
+
+$ git-chglog --config custom/dir/config.yml
+
+  The above is a command that uses a configuration file placed other than ".chglog/config.yml".
+```
+
+
+## create next tag
+
+```bash
+$ git-chglog --next-tag 2.0.0 -o CHANGELOG.md
+$ git commit -am "release 2.0.0"
+$ git tag 2.0.0
+```
+
+| Query          | Description                                    | Example                     |
+| -------------- | ---------------------------------------------- | --------------------------- |
+| `<old>..<new>` | Commit contained in `<new>` tags from `<old>`. | `$ git-chglog 1.0.0..2.0.0` |
+| `<name>..`     | Commit from the `<name>` to the latest tag.    | `$ git-chglog 1.0.0..`      |
+| `..<name>`     | Commit from the oldest tag to `<name>`.        | `$ git-chglog ..2.0.0`      |
+| `<name>`       | Commit contained in `<name>`.                  | `$ git-chglog 1.0.0`        |
+
+
+## Release version logs
+
++ [OpenIM CHANGELOG-V1.0](CHANGELOG-1.0.md)
++ [OpenIM CHANGELOG-V2.0](CHANGELOG-2.0.md)
++ [OpenIM CHANGELOG-V2.1](CHANGELOG-2.1.md)
++ [OpenIM CHANGELOG-V2.2](CHANGELOG-2.2.md)
++ [OpenIM CHANGELOG-V2.3](CHANGELOG-2.3.md)
++ [OpenIM CHANGELOG-V2.9](CHANGELOG-2.9.md)
++ [OpenIM CHANGELOG-V3.0](CHANGELOG-3.0.md)
++ [OpenIM CHANGELOG-V3.1](CHANGELOG-3.1.md)
++ [OpenIM CHANGELOG-V3.2](CHANGELOG-3.2.md)
++ [OpenIM CHANGELOG-V3.3](CHANGELOG-3.3.md)
+
+
+## Introduction
+
+In both the open-source and closed-source software development communities, it is important to follow a consistent and understandable versioning scheme for software projects. This ensures clear communication of changes, compatibility, and stability across different releases. One widely adopted naming convention is the Semantic Versioning 2.0.0.
+
+## Naming Format
+
+The most common format for version numbers is as follows:
+
+```bash
+major.minor[.patch[.build]]
+```
+
+Let's take a closer look at each component:
+
+1. **Major Version**: This is the first number in the versioning scheme and indicates significant changes that may not be backward compatible (specific to each project).
+2. **Minor Version**: The second number signifies the addition of new features while maintaining backward compatibility.
+3. **Patch Version**: The third number represents bug fixes or code optimizations without introducing new features. It is generally backward compatible.
+4. **Build Version**: Typically an automatically generated number that increments with each code commit.
+
+## Examples
+
+Here are a few examples to illustrate the versioning scheme:
+
+1. `1.0`
+2. `2.14.0.1478`
+3. `3.2.1 build-354`
+
+## Version Modifiers
+
+Apart from the version numbers, there are also version modifiers used to indicate specific stages or statuses of a release. Some commonly used version modifiers include:
+
+- **alpha**: An internal testing version with numerous known bugs. It is primarily used for communication among developers.
+- **beta**: A testing version released to enthusiastic users for feedback and bug detection.
+- **rc (release candidate)**: The final testing version before the official release.
+- **ga (general availability)**: The initial stable release for public distribution.
+- **r/release** (or no modifier at all): The final released version intended for general users.
+- **lts (long-term support)**: Designates a version that will receive extended maintenance and bug fixes for a specified number of years.
+
+## Versioning Strategy
+
+To effectively manage version numbers, the following strategies are commonly employed:
+
+- The initial version of a project can be either `0.1` or `1.0`.
+- When fixing bugs, the patch version is incremented by 1.
+- When adding new features, the minor version is incremented by 1, and the patch version is reset to 0.
+- In the case of significant modifications, the major version is incremented by 1.
+- The build version is usually automatically generated by the compilation process and follows a defined format. It does not require manual control.
+
+By adhering to these strategies and guidelines, developers can maintain consistency and clarity in versioning their software projects. This enables users and collaborators to understand the nature of changes between different releases and ensure compatibility with their systems.
+
+(Note: Markdown formatting has been used to structure this article. Markdown is a lightweight markup language used to format text on platforms like GitHub.)
+
+------
+
+**Note**: The above article is based on the given content and aims to provide a Markdown-formatted English article explaining the naming conventions for software project versions, specifically focusing on the Semantic Versioning 2.0.0.

CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+3293172751nss@gmail.com.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

CONTRIBUTING.md

@@ -0,0 +1,376 @@
+#  Contributing to Open-IM-Server
+
+So, you want to hack on Open-IM-Server? Yay!
+
+First of all, thank you for considering contributing to our project! We appreciate your time and effort, and we value any contribution, whether it's reporting a bug, suggesting a new feature, or submitting a pull request.
+
+![Hello OpenIM Image](assets/demo/hello-openim.png)
+
+> Use `make demo` start contributing fast.
+
+This document provides guidelines and best practices to help you contribute effectively.
+
+## 📇Topics
+
+- [Contributing to Open-IM-Server](#contributing-to-open-im-server)
+  - [📇Topics](#topics)
+  - [What we expect of you](#what-we-expect-of-you)
+  - [Code of ConductCode of Conduct](#code-of-conductcode-of-conduct)
+      - [Code and doc contribution](#code-and-doc-contribution)
+      - [Where should I start?](#where-should-i-start)
+      - [Design documents](#design-documents)
+  - [Getting Started](#getting-started)
+  - [Style and Specification](#style-and-specification)
+      - [Reporting security issues](#reporting-security-issues)
+      - [Reporting general issues](#reporting-general-issues)
+      - [Commit Rules](#commit-rules)
+      - [PR Description](#pr-description)
+      - [Docs Contribution](#docs-contribution)
+  - [Engage to help anything](#engage-to-help-anything)
+  - [Release version](#release-version)
+  - [Contact Us](#contact-us)
+
+## What we expect of you
+
+We hope that anyone can join Open-IM-Server , even if you are a student, writer, translator
+
+Please meet the minimum version of the Go language published in [go.mod](./go.mod). If you want to manage the Go language version, we provide tools to install [gvm](https://github.com/moovweb/gvm) in our [Makefile](./Makefile)
+
+You'd better use Linux OR WSL as the development environment, Linux with [Makefile](./Makefile) can help you quickly build and test Open-IM-Server project.
+
+If you are familiar with [Makefile](./Makefile) , you can easily see the clever design of the Open-IM-Server Makefile. Storing the necessary tools such as golangci in the `/tools` directory can avoid some tool version issues.
+
+The [Makefile](./Makefile) is for every developer, even if you don't know how to use the Makefile tool, don't worry, we provide two great commands to get you up to speed with the Makefile architecture, `make help` and `make help-all`, it can reduce problems of the developing environment.
+
+## Code of ConductCode of Conduct
+
+#### Code and doc contribution
+
+Every action to make project Open-IM-Server better is encouraged. On GitHub, every improvement for Open-IM-Server could be via a [PR](https://github.com/openimsdk/open-im-server/pulls) (short for pull request).
+
++ If you find a typo, try to fix it!
++ If you find a bug, try to fix it!
++ If you find some redundant codes, try to remove them!
++ If you find some test cases missing, try to add them!
++ If you could enhance a feature, please **DO NOT** hesitate!
++ If you find code implicit, try to add comments to make it clear!
++ If you find code ugly, try to refactor that!
++ If you can help to improve documents, it could not be better!
++ If you find document incorrect, just do it and fix that!
++ ...
+
+#### Where should I start?
+
++ If you are new to the project, don't know how to contribute Open-IM-Server, please check out the [good first issue](https://github.com/openimsdk/open-im-server/issues?q=is%3Aopen+label%3A"good+first+issue"+sort%3Aupdated-desc) label.
++ You should be good at filtering the Open-IM-Server issue tags and finding the ones you like, such as [RFC](https://github.com/openimsdk/open-im-server/issues?q=is%3Aissue+is%3Aopen+RFC+label%3ARFC) for big initiatives, features for [feature](https://github.com/openimsdk/open-im-server/issues?q=is%3Aissue+label%3Afeature) proposals, and [bug](https://github.com/openimsdk/open-im-server/issues?q=is%3Aissue+label%3Abug+) fixes.
++ If you are looking for something to work on, check out our [open issues](https://github.com/openimsdk/open-im-server/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc).
++ If you have an idea for a new feature, please [open an issue](https://github.com/openimsdk/open-im-server/issues/new/choose), and we can discuss it.
+
+#### Design documents
+
+For any substantial design, there should be a well-crafted design document. This document is not just a simple record, but also a detailed description and manifestation, which can help team members better understand the design thinking and grasp the design direction. In the process of writing the design document, we can choose to use tools such as `Google Docs` or `Notion`, and even mark RFC in [issues](https://github.com/openimsdk/open-im-server/issues?q=is%3Aissue+is%3Aopen+RFC+label%3ARFC) or [discussions](https://github.com/openimsdk/open-im-server/discussions) for better collaboration. Of course, after completing the design document, we should also add it to our [Shared Drive](https://drive.google.com/drive/) and notify the appropriate working group to let everyone know of its existence. Only by doing so can we maximize the effectiveness of the design document and provide strong support for the smooth progress of the project.
+
+Anybody can access the shared Drive for reading. To get access to comment. Once you've done that, head to the [shared Drive](https://drive.google.com/) and behold all the docs.
+
+In addition to that, we'd love to invite you to [join our Slack](https://join.slack.com/t/openimsdk/shared_invite/zt-22720d66b-o_FvKxMTGXtcnnnHiMqe9Q) where you can play with your imagination, tell us what you're working on, and get a quick response.
+
+When documenting a new design, we recommend a 2-step approach:
+
+1. Use the short-form RFC template to outline your ideas and get early feedback.
+2. Once you have received sufficient feedback and consensus, you may use the longer-form design doc template to specify and discuss your design in more details.
+
+In order to contribute a feature to Open-IM-Server you'll need to go through the following steps:
+
++ Discuss your idea with the appropriate [working groups](https://join.slack.com/t/openimsdk/shared_invite/zt-22720d66b-o_FvKxMTGXtcnnnHiMqe9Q) on the working group's Slack channel.
++ Once there is general agreement that the feature is useful, create a GitHub issue to track the discussion. The issue should include information about the requirements and use cases that it is trying to address.
++ Include a discussion of the proposed design and technical details of the implementation in the issue.
+
+But keep in mind that there is no guarantee of it being accepted and so it is usually best to get agreement on the idea/design before time is spent coding it. However, sometimes seeing the exact code change can help focus discussions, so the choice is up to you.
+
+## Getting Started
+
+To propose PR for the Open-IM-Server item, we assume you have registered a GitHub ID. Then you could finish the preparation in the following steps:
+
+1. Fork the repository(Open-IM-Server)
+
+2. **CLONE** your own repository to main locally. Use `git clone https://github.com/<your-username>/Open-IM-Server.git` to clone repository to your local machine. Then you can create new branches to finish the change you wish to make.
+
+3. **Set Remote** upstream to be `https://github.com/openimsdk/open-im-server.git` using the following two commands:
+
+   ```bash
+   ❯ git remote add upstream https://github.com/openimsdk/open-im-server.git
+   ❯ git remote set-url --push upstream no-pushing
+   ```
+
+   With this remote setting, you can check your git remote configuration like this:
+
+   ```bash
+   ❯ git remote -v
+   origin     https://github.com/<your-username>/Open-IM-Server.git (fetch)
+   origin     https://github.com/<your-username>/Open-IM-Server.git (push)
+   upstream   https://github.com/openimsdk/open-im-server.git (fetch)
+   upstream   no-pushing (push)
+   ```
+
+   Adding this, we can easily synchronize local branches with upstream branches.
+
+4. Create a new branch for your changes (use a descriptive name, such as `fix-bug-123` or `add-new-feature`).
+
+   ```bash
+   ❯ cd Open-IM-Server
+   ❯ git fetch upstream
+   ❯ git checkout upstream/main
+   ```
+
+   Create a new branch: 
+
+   ```bash
+   ❯ git checkout -b <new-branch>
+   ```
+
+   Make any change on the `new-branch` then use [Makefile](./Makefile) build and test your codes.
+
+5. **Commit your changes** to your local branch, lint before committing and commit with sign-off
+
+   ```bash
+   ❯ git rebase upstream/main
+   ❯ make lint	  # golangci-lint run -c .golangci.yml
+   ❯ git add -A  # add changes to staging
+   ❯ git commit -a -s -m "message for your changes" # -s adds a Signed-off-by trailer
+   ```
+
+6. **Push your branch**  to your forked repository, it is recommended to have only one commit for a PR.
+
+   ```bash
+   # sync up with upstream
+   ❯ git fetch upstream main
+   ❯ git rebase upstream/main
+   ❯ 
+   ❯ git rebase -i	<commit-id> # rebase with interactive mode to squash your commits into a single one
+   ❯ git push # push to the remote repository, if it's a first time push, run git push --set-upstream origin <new-branch># sync up with upstream
+   ❯ git fetch upstream main
+   git rebase upstream/main
+   
+   ❯ git rebase -i	<commit-id> # rebase with interactive mode to squash your commits into a single one
+   ❯ git push # push to the remote repository, if it's a first time push, run git push --set-upstream origin <new-branch>
+   ```
+
+   You can also use `git commit -s --amend && git push -f` to update modifications on the previous commit.
+
+   If you have developed multiple features in the same branch, you should create PR separately by rebasing to the main branch between each push:
+
+   ```bash
+   # create new branch, for example git checkout -b feature/infra
+   ❯ git checkout -b <new branch>
+   # update some code, feature1
+   ❯ git add -A
+   ❯ git commit -m -s "feat: feature one"
+   ❯ git push # if it's first time push, run git push --set-upstream origin <new-branch>
+   # then create pull request, and merge
+   # update some new feature, feature2, rebase main branch first.
+   ❯ git rebase upstream/main # rebase the current branch to upstream/main branch
+   ❯ git add -A
+   ❯ git commit -m -s "feat: feature two"
+   # then create pull request, and merge
+   ```
+
+7. **Open a pull request** to `openimsdk/open-im-server:main`
+
+   It is recommended to review your changes before filing a pull request. Check if your code doesn't conflict with the main branch and no redundant code is included.
+
+## Style and Specification
+
+We divide the problem into security and general problems:
+
+#### Reporting security issues
+
+Security issues are always treated seriously. As our usual principle, we discourage anyone to spread security issues. If you find a security issue of Open-IM-Server, please do not discuss it in public and even do not open a public issue.
+
+Instead we encourage you to send us a private email to winxu81@gmail.com to report this.
+
+#### Reporting general issues
+
+To be honest, we regard every user of Open-IM-Serveras a very kind contributor. After experiencing Open-IM-Server, you may have some feedback for the project. Then feel free to open an issue via [NEW ISSUE](https://github.com/openimsdk/open-im-server/issues/new/choose).
+
+Since we collaborate project Open-IM-Server in a distributed way, we appreciate **WELL-WRITTEN**, **DETAILED**, **EXPLICIT** issue reports. To make the communication more efficient, we wish everyone could search if your issue is an existing one in the searching list. If you find it existing, please add your details in comments under the existing issue instead of opening a brand new one.
+
+To make the issue details as standard as possible, we setup an [ISSUE TEMPLATE](https://github.com/OpenIMSDK/.github/tree/main/.github/ISSUE_TEMPLATE) for issue reporters. You can find three kinds of issue templates there: question, bug report and feature request. Please **BE SURE** to follow the instructions to fill fields in template.
+
+**There are a lot of cases when you could open an issue:**
+
++ bug report
++ feature request
++ Open-IM-Server performance issues 
++ feature proposal
++ feature design
++ help wanted
++ doc incomplete
++ test improvement
++ any questions on Open-IM-Server project 
++ and so on 
+
+Also, we must be reminded when submitting a new question about Open-IM-Server, please remember to remove the sensitive data from your post. Sensitive data could be password, secret key, network locations, private business data and so on.
+
+#### Commit Rules
+
+Actually in Open-IM-Server, we take two rules serious when committing:
+
+**🥇 Commit Message:**
+
+Commit message could help reviewers better understand what the purpose of submitted PR is. It could help accelerate the code review procedure as well. We encourage contributors to use **EXPLICIT** commit message rather than ambiguous message. In general, we advocate the following commit message type:
+
+We use [Semantic Commits](https://www.conventionalcommits.org/en/v1.0.0/) to make it easier to understand what a commit does and to build pretty changelogs. Please use the following prefixes for your commits:
+
++ `docs: xxxx`. For example, "docs: add docs about storage installation".
++ `feature: xxxx`.For example, "feature: make result show in sorted order".
++ `bugfix: xxxx`. For example, "bugfix: fix panic when input nil parameter".
++ `style: xxxx`. For example, "style: format the code style of Constants.java".
++ `refactor: xxxx.` For example, "refactor: simplify to make codes more readable".
++ `test: xxx`. For example, "test: add unit test case for func InsertIntoArray".
++ `chore: xxx.` For example, "chore: integrate travis-ci". It's the type of mantainance change.
++ other readable and explicit expression ways.
+
+On the other side, we discourage contributors from committing message like the following ways:
+
++ ~~fix bug~~
++ ~~update~~
++ ~~add doc~~
+
+**🥈 Commit Content:**
+
+Commit content represents all content changes included in one commit. We had better include things in one single commit which could support reviewer's complete review without any other commits' help.
+
+In another word, contents in one single commit can pass the CI to avoid code mess. In brief, there are two minor rules for us to keep in mind:
+
+1. avoid very large change in a commit.
+2. complete and reviewable for each commit.
+3. words are written in lowercase English, not uppercase English or other languages such as Chinese.
+
+No matter what the commit message, or commit content is, we do take more emphasis on code review.
+
+An example for this could be:
+
+```bash
+❯ git commit -a -s -m "docs: add a new section to the README"
+```
+
+#### PR Description
+
+PR is the only way to make change to Open-IM-Server project files. To help reviewers better get your purpose, PR description could not be too detailed. We encourage contributors to follow the [PR template](https://github.com/OpenIMSDK/.github/tree/main/.github/PULL_REQUEST_TEMPLATE.md) to finish the pull request.
+
+You can find some very formal PR in [RFC](https://github.com/openimsdk/open-im-server/issues?q=is%3Aissue+is%3Aopen+RFC+label%3ARFC) issues and learn about them.
+
+**📖 Opening PRs:**
+
++ As long as you are working on your PR, please mark it as a draft
++ Please make sure that your PR is up-to-date with the latest changes in `main`
++ Mention the issue that your PR is addressing (Fix: #{ID_1}, #{ID_2})
++ Make sure that your PR passes all checks
+
+**🈴 Reviewing PRs:**
+
++ Be respectful and constructive 
++ Assign yourself to the PR 
++ Check if all checks are passing
++ Suggest changes instead of simply commenting on found issues
++ If you are unsure about something, ask the author
++ If you are not sure if the changes work, try them out
++ Reach out to other reviewers if you are unsure about something
++ If you are happy with the changes, approve the PR
++ Merge the PR once it has all approvals and the checks are passing
+
+**⚠️ DCO check:**
+
+We have a DCO check that runs on every pull request to ensure code quality and maintainability. This check verifies that the commit has been signed off, indicating that you have read and agreed to the provisions of the Developer Certificate of Origin. If you have not yet signed off on the commit, you can use the following command to sign off on the last commit you made:
+
+```bash
+❯ git commit --amend --signoff
+```
+
+Please note that signing off on a commit is a commitment that you have read and agreed to the provisions of the Developer Certificate of Origin. If you have not yet read this document, we strongly recommend that you take some time to read it carefully. If you have any questions about the content of this document, or if you need further assistance, please contact an administrator or relevant personnel.
+
+You can also automate signing off your commits by adding the following to your `.zshrc` or `.bashrc`:
+
+```go
+git() {
+  if [ $# -gt 0 ] && [[ "$1" == "commit" ]] ; then
+     shift
+     command git commit --signoff "$@"
+  else
+     command git "$@"
+  fi
+}
+```
+
+
+#### Docs Contribution
+
+The documentation for Open-IM-Server includes:
+
++ [README.md](https://github.com/openimsdk/open-im-server/blob/main/README.md): This file includes the basic information and instructions for getting started with Open-IM-Server.
++ [CONTRIBUTING.md](https://github.com/openimsdk/open-im-server/blob/main/CONTRIBUTING.md): This file contains guidelines for contributing to Open-IM-Server's codebase, such as how to submit issues, pull requests, and code reviews.
++ [Official Documentation](https://doc.rentsoft.cn/): This is the official documentation for Open-IM-Server, which includes comprehensive information on all of its features, configuration options, and troubleshooting tips.
+
+Please obey the following rules to better format the docs, which would greatly improve the reading experience.
+
+1. Please do not use Chinese punctuations in English docs, and vice versa.
+2. Please use upper case letters where applicable, like the first letter of sentences / headings, etc.
+3. Please specify a language for each Markdown code blocks, unless there's no associated languages.
+4. Please insert a whitespace between Chinese and English words.
+5. Please use the correct case for technical terms, such as using `HTTP` instead of http, `MySQL` rather than mysql, `Kubernetes` instead of kubernetes, etc.
+6. Please check if there's any typos in the docs before submitting PRs.
+
+## Engage to help anything
+
+We choose GitHub as the primary place for Open-IM-Server to collaborate. So the latest updates of Open-IM-Server are always here. Although contributions via PR is an explicit way to help, we still call for any other ways.
+
++ reply to other's [issues](https://github.com/openimsdk/open-im-server/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc) if you could;
++ help solve other user's problems;
++ help review other's [PR](https://github.com/openimsdk/open-im-server/pulls?q=is%3Apr+is%3Aopen+sort%3Aupdated-desc) design; 
++ discuss about Open-IM-Server to make things clearer;
++ advocate [Open-IM-Server](https://google.com/search?q=Open-IM-Server) technology beyond GitHub;
++ write blogs on Open-IM-Server and so on.
+
+In a word, **ANY HELP IS CONTRIBUTION.**
+
+## Release version
+
+Releases of Open-IM-Server are done using [Release Please](https://github.com/googleapis/release-please) and [GoReleaser](https://goreleaser.com/). The workflow looks like this:
+
+🎯 A PR is merged to the `main` branch:
+
++ Release please is triggered, creates or updates a new release PR
++ This is done with every merge to main, the current release PR is updated every time
+
+🎯 Merging the 'release please' PR to `main`:
+
++ Release please is triggered, creates a new release and updates the changelog based on the commit messages
++ GoReleaser is triggered, builds the binaries and attaches them to the release
++ Containers are created and pushed to the container registry
+
+With the next relevant merge, a new release PR will be created and the process starts again
+
+**👀 Manually setting the version:**
+
+If you want to manually set the version, you can create a PR with an empty commit message that contains the version number in the commit message. For example:
+
+Such a commit can get produced as follows: 
+
+````bash
+❯ git commit --allow-empty -m "chore: release 0.0.3" -m "Release-As: 0.0.3
+````
+
+## Contact Us
+
+We value close connections with our users, developers, and contributors here at Open-IM-Server. With a large community and maintainer team, we're always here to help and support you. Whether you're looking to join our community or have any questions or suggestions, we welcome you to get in touch with us.
+
+Our most recommended way to get in touch is through [Slack](https://join.slack.com/t/openimsdk/shared_invite/zt-22720d66b-o_FvKxMTGXtcnnnHiMqe9Q). Even if you're in China, Slack is usually not blocked by firewalls, making it an easy way to connect with us. Our Slack community is the ideal place to discuss and share ideas and suggestions with other users and developers of Open-IM-Server. You can ask technical questions, seek help, or share your experiences with other users of Open-IM-Server.
+
+In addition to Slack, we also offer the following ways to get in touch:
+
++ <a href="https://join.slack.com/t/openimsdk/shared_invite/zt-22720d66b-o_FvKxMTGXtcnnnHiMqe9Q" target="_blank"><img src="https://img.shields.io/badge/slack-%40OpenIMSDKCore-informational?logo=slack&style=flat-square"></a>:  We also have Slack channels for you to communicate and discuss. To join, visit https://slack.com/ and join our [👀 Open-IM-Server slack](https://join.slack.com/t/openimsdk/shared_invite/zt-22720d66b-o_FvKxMTGXtcnnnHiMqe9Q) team channel.
++ <a href="https://mail.google.com/mail/u/0/?fs=1&tf=cm&to=4closetool3@gmail.com" target="_blank"><img src="https://img.shields.io/badge/gmail-%40OOpenIMSDKCore?style=social&logo=gmail"></a>: Get in touch with us on [Gmail](winxu81@gmail.com). If you have any questions or issues that need resolving, or any suggestions and feedback for our open source projects, please feel free to contact us via email.
++ <a href="https://doc.rentsoft.cn/" target="_blank"><img src="https://img.shields.io/badge/%E5%8D%9A%E5%AE%A2-%40OpenIMSDKCore-blue?style=social&logo=Octopus%20Deploy"></a>: Read our [blog](https://doc.rentsoft.cn/). Our blog is a great place to stay up-to-date with Open-IM-Server projects and trends. On the blog, we share our latest developments, tech trends, and other interesting information.
++ <a href="https://github.com/OpenIMSDK/OpenIM-Docs/blob/main/docs/images/WechatIMG20.jpeg" target="_blank"><img src="https://img.shields.io/badge/%E5%BE%AE%E4%BF%A1-OpenIMSDKCore-brightgreen?logo=wechat&style=flat-square"></a>: Add [Wechat](https://github.com/OpenIMSDK/OpenIM-Docs/blob/main/docs/images/WechatIMG20.jpeg) and indicate that you are a user or developer of Open-IM-Server. We will process your request as soon as possible.
+
+Whether you're looking to join our community or have any questions or suggestions, we welcome you to get in touch with us.

Dockerfile

@@ -0,0 +1,31 @@
+# Build Stage
+FROM golang:1.20 AS builder
+
+# Set go mod installation source and proxy
+ARG GO111MODULE=on
+ARG GOPROXY=https://goproxy.cn,direct
+ENV GO111MODULE=$GO111MODULE
+ENV GOPROXY=$GOPROXY
+
+# Set up the working directory
+WORKDIR /openim/openim-server
+
+COPY go.mod go.sum ./
+RUN go mod download
+
+# Copy all files to the container
+ADD . .
+
+RUN make clean
+RUN make build
+
+FROM ghcr.io/openim-sigs/openim-ubuntu-image:latest
+
+WORKDIR ${SERVER_WORKDIR}
+
+# Copy scripts and binary files to the production image
+COPY --from=builder ${OPENIM_SERVER_BINDIR} /openim/openim-server/_output/bin
+# COPY --from=builder ${OPENIM_SERVER_CMDDIR} /openim/openim-server/scripts
+# COPY --from=builder ${SERVER_WORKDIR}/config /openim/openim-server/config
+
+CMD ["/openim/openim-server/scripts/docker-start-all.sh"]

Makefile

@@ -0,0 +1,246 @@
+# ==============================================================================
+# define the default goal
+#
+
+.DEFAULT_GOAL := help
+
+## all: Run tidy, gen, add-copyright, format, lint, cover, build ✨
+.PHONY: all
+all: tidy gen add-copyright verify lint cover restart
+
+# ==============================================================================
+# Build set
+
+ROOT_PACKAGE=github.com/openimsdk/open-im-server
+# TODO: This is version control for the future https://github.com/openimsdk/open-im-server/issues/574
+VERSION_PACKAGE=github.com/openimsdk/open-im-server/v3/pkg/version
+
+# ==============================================================================
+# Includes
+
+include scripts/make-rules/common.mk	# make sure include common.mk at the first include line
+include scripts/make-rules/golang.mk
+include scripts/make-rules/image.mk
+include scripts/make-rules/copyright.mk
+include scripts/make-rules/gen.mk
+include scripts/make-rules/dependencies.mk
+include scripts/make-rules/tools.mk
+include scripts/make-rules/release.mk
+include scripts/make-rules/swagger.mk
+
+# ==============================================================================
+# Usage
+
+define USAGE_OPTIONS
+
+Options:
+
+  DEBUG            Whether or not to generate debug symbols. Default is 0.
+
+  BINS             Binaries to build. Default is all binaries under cmd.
+                   This option is available when using: make {build}(.multiarch)
+                   Example: make build BINS="openim-api openim-cmdutils".
+
+  PLATFORMS        Platform to build for. Default is linux_arm64 and linux_amd64.
+                   This option is available when using: make {build}.multiarch
+                   Example: make multiarch PLATFORMS="linux_s390x linux_mips64
+                   linux_mips64le darwin_amd64 windows_amd64 linux_amd64 linux_arm64".
+
+  V                Set to 1 enable verbose build. Default is 0.
+endef
+export USAGE_OPTIONS
+
+# ==============================================================================
+# Targets
+
+## init: Initialize openim server project ✨
+.PHONY: init
+init:
+	@$(MAKE) gen.init
+
+## init-githooks: Initialize git hooks ✨
+.PHONY: init-githooks
+init-githooks:
+	@$(MAKE) gen.init-githooks
+
+## gen: Generate all necessary files. ✨
+.PHONY: gen
+gen:
+	@$(MAKE) gen.run
+
+## demo: Run demo get started with Makefiles quickly ✨
+.PHONY: demo
+demo:
+	@$(MAKE) go.demo
+
+## versionchecker: Check version of openim. ✨
+.PHONY: versionchecker
+versionchecker:
+	@$(MAKE) go.versionchecker
+
+## build: Build binaries by default ✨
+.PHONY: build
+build:
+	@$(MAKE) go.build
+
+## start: Start openim ✨
+.PHONY: start
+start:
+	@$(MAKE) go.start
+
+## stop: Stop openim ✨
+.PHONY: stop
+stop:
+	@$(MAKE) go.stop
+
+## restart: Restart openim ✨
+.PHONY: restart
+restart: clean stop build init start
+
+## multiarch: Build binaries for multiple platforms. See option PLATFORMS. ✨
+.PHONY: multiarch
+multiarch:
+	@$(MAKE) go.build.multiarch
+
+## verify: execute all verity scripts. ✨
+.PHONY: verify
+verify:
+	@$(MAKE) go.verify
+
+## install: Install deployment openim ✨
+.PHONY: install
+install:
+	@$(MAKE) go.install
+
+## check: Check OpenIM deployment ✨
+.PHONY: check
+check:
+	@$(MAKE) go.check
+
+## check-component: Check OpenIM component deployment ✨
+.PHONY: check-component
+check-component:
+	@$(MAKE) go.check-component
+
+## tidy: tidy go.mod ✨
+.PHONY: tidy
+tidy:
+	@$(GO) mod tidy
+
+## vendor: vendor go.mod ✨
+.PHONY: vendor
+vendor:
+	@$(GO) mod vendor
+
+## style: code style -> fmt,vet,lint ✨
+.PHONY: style
+style: fmt vet lint
+
+## fmt: Run go fmt against code. ✨
+.PHONY: fmt
+fmt:
+	@$(GO) fmt ./...
+
+## vet: Run go vet against code. ✨
+.PHONY: vet
+vet:
+	@$(GO) vet ./...
+
+## lint: Check syntax and styling of go sources. ✨
+.PHONY: lint
+lint:
+	@$(MAKE) go.lint
+
+## format: Gofmt (reformat) package sources (exclude vendor dir if existed). ✨
+.PHONY: format
+format:
+	@$(MAKE) go.format
+
+## test: Run unit test. ✨
+.PHONY: test
+test:
+	@$(MAKE) go.test
+
+## cover: Run unit test and get test coverage. ✨
+.PHONY: cover
+cover:
+	@$(MAKE) go.test.cover
+
+## updates: Check for updates to go.mod dependencies. ✨
+.PHONY: updates
+	@$(MAKE) go.updates
+
+## imports: task to automatically handle import packages in Go files using goimports tool. ✨
+.PHONY: imports
+imports:
+	@$(MAKE) go.imports
+
+## clean: Remove all files that are created by building. ✨
+.PHONY: clean
+clean:
+	@$(MAKE) go.clean
+
+## image: Build docker images for host arch. ✨
+.PHONY: image
+image:
+	@$(MAKE) image.build
+
+## image.multiarch: Build docker images for multiple platforms. See option PLATFORMS. ✨
+.PHONY: image.multiarch
+image.multiarch:
+	@$(MAKE) image.build.multiarch
+
+## push: Build docker images for host arch and push images to registry. ✨
+.PHONY: push
+push:
+	@$(MAKE) image.push
+
+## push.multiarch: Build docker images for multiple platforms and push images to registry. ✨
+.PHONY: push.multiarch
+push.multiarch:
+	@$(MAKE) image.push.multiarch
+
+## tools: Install dependent tools. ✨
+.PHONY: tools
+tools:
+	@$(MAKE) tools.install
+
+## swagger: Generate swagger document. ✨
+.PHONY: swagger
+swagger:
+	@$(MAKE) swagger.run
+
+## serve-swagger: Serve swagger spec and docs. ✨
+.PHONY: swagger.serve
+serve-swagger:
+	@$(MAKE) swagger.serve
+
+## verify-copyright: Verify the license headers for all files. ✨
+.PHONY: verify-copyright
+verify-copyright:
+	@$(MAKE) copyright.verify
+
+## add-copyright: Add copyright ensure source code files have license headers. ✨
+.PHONY: add-copyright
+add-copyright:
+	@$(MAKE) copyright.add
+
+## advertise: Project introduction, become a contributor ✨
+.PHONY: advertise
+advertise:
+	@$(MAKE) copyright.advertise
+
+## release: release the project ✨
+.PHONY: release
+release: release.verify release.ensure-tag
+	@scripts/release.sh
+
+## help: Show this help info. ✨
+.PHONY: help
+help: Makefile
+	$(call makehelp)
+
+## help-all: Show all help details info. ✨
+.PHONY: help-all
+help-all: go.help copyright.help tools.help image.help dependencies.help gen.help release.help swagger.help help
+	$(call makeallhelp)

README-zh_CN.md

@@ -0,0 +1,139 @@
+<p align="center">
+    <a href="https://www.openim.online">
+        <img src="./assets/logo-gif/openim-logo.gif" width="60%" height="30%"/>
+    </a>
+</p>
+
+<h3 align="center" style="border-bottom: none">
+    ⭐️  Open source Instant Messaging Server ⭐️ <br>
+<h3>
+
+
+<p align=center>
+<a href="https://goreportcard.com/report/github.com/openimsdk/open-im-server"><img src="https://goreportcard.com/badge/github.com/openimsdk/open-im-server" alt="A+"></a>
+<a href="https://github.com/openimsdk/open-im-server/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3A%22good+first+issue%22"><img src="https://img.shields.io/github/issues/openimsdk/open-im-server/good%20first%20issue?logo=%22github%22" alt="good first"></a>
+<a href="https://github.com/openimsdk/open-im-server"><img src="https://img.shields.io/github/stars/openimsdk/open-im-server.svg?style=flat&logo=github&colorB=deeppink&label=stars"></a>
+<a href="https://join.slack.com/t/openimsdk/shared_invite/zt-22720d66b-o_FvKxMTGXtcnnnHiMqe9Q"><img src="https://img.shields.io/badge/Slack-300%2B-blueviolet?logo=slack&amp;logoColor=white"></a>
+<a href="https://github.com/openimsdk/open-im-server/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-Apache--2.0-green"></a>
+<a href="https://golang.org/"><img src="https://img.shields.io/badge/Language-Go-blue.svg"></a>
+</p>
+
+</p>
+
+<p align="center">
+    <a href="./README.md"><b> English </b></a> •
+    <a href="./README-zh_CN.md"><b> 简体中文 </b></a> •
+    <a href="https://www.openim.online/en"><b> Docs </b></a>
+</p>
+
+
+</p>
+
+## Ⓜ️ 关于 OpenIM
+
+OpenIM 不仅仅是一个开源的即时消息组件，它是你的应用程序生态系统的一个不可或缺的部分。查看下面的图表，了解 AppServer、AppClient、OpenIMServer 和 OpenIMSDK 是如何交互的。
+
+![App-OpenIM 关系](./docs/images/oepnim-design.png)
+
+## 🚀 关于 OpenIMSDK
+
+**OpenIMSDK** 无缝集成到您的应用中，提供丰富、实时的消息体验，无需复杂的 UI 集成。它提供：
+
++ **本地存储**：用于快速数据检索和消息同步。
++ **监听器回调**：确保实时消息交互性。
++ **API 封装**：简化开发流程。
++ **连接管理**：保证可靠的消息传递。
+
+它使用 Golang 构建，并支持跨平台部署，确保在所有平台上提供一致的消息体验。
+
+👉 **[探索 GO SDK](https://github.com/openimsdk/openim-sdk-core)**
+
+## 🌐 关于 OpenIMServer
+
+精心用 Golang 开发的 **OpenIMServer** 通过多重方式确保了卓越的即时消息服务器能力：
+
++ **模块组成**：它由多个模块组成，例如网关和多个 RPC 服务，提供一个多功能的消息环境。
++ **微服务架构**：支持集群模式，确保出色的性能和可伸缩性，以有效管理各个实例间的通信。
++ **多样的部署选项**：适应你的操作偏好，通过源代码、Kubernetes 或 Docker 提供部署选项。
+
+### 增强的业务功能：
+
++ **REST API**：OpenIMServer 为业务系统提供 REST API，旨在通过后端接口为您的操作提供附加功能，如群组创建和消息推送。
++ **回调**：为了扩展其在各种业务形式中的实用性，OpenIMServer 提供了回调能力。即，在事件发生之前或之后，它向业务服务器发送请求，比如发送消息，丰富通信过程中的交互和数据交换流。
+
+👉 **[了解更多](https://doc.rentsoft.cn/guides/introduction/product)**
+
+## :rocket: 快速开始
+
+你只需要一个简单的命令，就可以快速学习 OpenIM 的工程解决方案：
+
+```
+bashCopy code
+$ make demo
+```
+
+🤲 为了方便用户体验，我们提供了多种部署解决方案，您可以根据下面的列表选择自己的部署方法：
+
++ **[源代码部署指南](https://doc.rentsoft.cn/guides/gettingStarted/imSourceCodeDeployment)**
++ **[Docker 部署指南](https://doc.rentsoft.cn/guides/gettingStarted/dockerCompose)**
++ **[Kubernetes 部署指南](https://github.com/openimsdk/open-im-server/tree/main/deployments)**
+
+## :hammer_and_wrench: 开始开发 OpenIM
+
+OpenIM 我们的目标是建立一个顶级的开源社区。我们有一套标准，在[社区仓库](https://github.com/OpenIMSDK/community)中。
+
+如果你想为这个 Open-IM-Server 仓库做贡献，请阅读我们的[贡献者文档](https://github.com/openimsdk/open-im-server/blob/main/CONTRIBUTING.md)。
+
+在开始之前，请确保你的更改是有需求的。最好的方法是创建一个[新的讨论](https://github.com/openimsdk/open-im-server/discussions/new/choose) 或 [Slack 通信](https://join.slack.com/t/openimsdk/shared_invite/zt-22720d66b-o_FvKxMTGXtcnnnHiMqe9Q)，或者如果你发现一个问题，首先[报告它](https://github.com/openimsdk/open-im-server/issues/new/choose)。
+
++ [代码标准](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/go_code.md)
+
++ [Docker 镜像标准](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/images.md)
+
++ [目录标准](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/directory.md)
+
++ [提交标准](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/commit.md)
+
++ [版本控制标准](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/version.md)
+
++ [接口标准](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/interface.md)
+
++ [OpenIM配置和环境变量设置](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/environment.md)
+
+> **Note**
+> 针对中国的用户，阅读我们的 [Docker 镜像标准](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/images.md) 以便使用国内 aliyun 的镜像地址。OpenIM 也有针对中国的 gitee 同步仓库，你可以在 [gitee.com](https://gitee.com/openimsdk) 上找到它。
+
+## :link: 链接
+
+  + **[完整文档](https://doc.rentsoft.cn/)**
+  + **[更新日志](https://github.com/openimsdk/open-im-server/blob/main/CHANGELOG.md)**
+  + **[FAQ](https://github.com/openimsdk/open-im-server/blob/main/FAQ.md)**
+  + **[代码示例](https://github.com/openimsdk/open-im-server/blob/main/examples)**
+
+## :handshake: 社区
+
+  + **[GitHub Discussions](https://github.com/openimsdk/open-im-server/discussions)**
+  + **[Slack 通信](https://join.slack.com/t/openimsdk/shared_invite/zt-22720d66b-o_FvKxMTGXtcnnnHiMqe9Q)**
+  + **[GitHub Issues](https://github.com/openimsdk/open-im-server/issues)**
+
+  您可以加入这些平台，讨论问题，提出建议，或分享您的成功故事！
+
+## :writing_hand: 贡献
+
+  我们欢迎任何形式的贡献！请确保在提交 Pull Request 之前阅读我们的[贡献者文档](https://github.com/openimsdk/open-im-server/blob/main/CONTRIBUTING.md)。
+
+  + **[报告 Bug](https://github.com/openimsdk/open-im-server/issues/new?assignees=&labels=bug&template=bug_report.md&title=)**
+  + **[提出新特性](https://github.com/openimsdk/open-im-server/issues/new?assignees=&labels=enhancement&template=feature_request.md&title=)**
+  + **[提交 Pull Request](https://github.com/openimsdk/open-im-server/pulls)**
+
+  感谢您的贡献，我们一起打造一个强大的即时通信解决方案！
+
+## :closed_book: 许可证
+
+  OpenIMSDK 在 Apache License 2.0 许可下可用。查看[LICENSE 文件](https://github.com/openimsdk/open-im-server/blob/main/LICENSE)了解更多信息。
+
+## 🔮 Thanks to our contributors!
+
+<a href="https://github.com/openimsdk/open-im-server/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=openimsdk/open-im-server" />
+</a>

README.md

@@ -1,160 +1,247 @@
-# Open-IM-Server 
-![avatar](https://github.com/OpenIMSDK/OpenIM-Docs/blob/main/docs/images/WechatIMG20.jpeg)
+<p align="center">
+    <a href="https://www.openim.online">
+        <img src="./assets/logo-gif/openim-logo.gif" width="60%" height="30%"/>
+    </a>
+</p>
 
-![avatar](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/open-im-logo.png)
+<h3 align="center" style="border-bottom: none">
+    ⭐️  Open source Instant Messaging Server ⭐️ <br>
+<h3>
 
-[![LICENSE](https://img.shields.io/badge/license-Apache--2.0-green)](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/LICENSE) [![Language](https://img.shields.io/badge/Language-Go-blue.svg)](https://golang.org/)
 
-## Open-IM-Server: Open source Instant Messaging Server
+<p align=center>
+<a href="https://goreportcard.com/report/github.com/openimsdk/open-im-server"><img src="https://goreportcard.com/badge/github.com/openimsdk/open-im-server" alt="A+"></a>
+<a href="https://github.com/openimsdk/open-im-server/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3A%22good+first+issue%22"><img src="https://img.shields.io/github/issues/openimsdk/open-im-server/good%20first%20issue?logo=%22github%22" alt="good first"></a>
+<a href="https://github.com/openimsdk/open-im-server"><img src="https://img.shields.io/github/stars/openimsdk/open-im-server.svg?style=flat&logo=github&colorB=deeppink&label=stars"></a>
+<a href="https://join.slack.com/t/openimsdk/shared_invite/zt-22720d66b-o_FvKxMTGXtcnnnHiMqe9Q"><img src="https://img.shields.io/badge/Slack-300%2B-blueviolet?logo=slack&amp;logoColor=white"></a>
+<a href="https://github.com/openimsdk/open-im-server/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-Apache--2.0-green"></a>
+<a href="https://golang.org/"><img src="https://img.shields.io/badge/Language-Go-blue.svg"></a>
+<a href="https://pkg.go.dev/github.com/openimsdk/open-im-server/v3"><img src="https://pkg.go.dev/badge/github.com/openimsdk/open-im-server/v3.svg" alt="Go Reference"></a>
+</p>
 
-Instant messaging server. Backend in pure Golang, wire transport protocol is JSON over websocket.
+</p>
 
-Everything is a message in Open-IM-Server, so you can extend custom messages easily, there is no need to modify the server code.
+<p align="center">
+    <a href="./README.md"><b> English </b></a> •
+    <a href="./README-zh_CN.md"><b> 简体中文 </b></a> •
+<a href="https://www.openim.online/en"><b> Docs </b></a>
+</p>
 
-Using microservice architectures, Open-IM-Server can be deployed using clusters.
+</p>
 
-By deployment of the Open-IM-Server on the customer's server, developers can integrate instant messaging and real-time network capabilities into their own applications free of charge and quickly, and ensure the security and privacy of business data.
+## Ⓜ️ About OpenIM
 
-## Features
+OpenIM isn't just an open-source instant messaging component, it's an integral part of your application ecosystem. Check out this diagram to understand how AppServer, AppClient, OpenIMServer, and OpenIMSDK interact.
 
-- Everything in Free
-- Scalable architecture
-- Easy integration
-- Good scalability
-- High performance
-- Lightweight
-- Supports multiple protocols
+![App-OpenIM Relationship](./docs/images/oepnim-design.png)
 
-## Community
+## 🚀 About OpenIMSDK
 
-- Join the Telegram-OpenIM group: https://t.me/joinchat/zSJLPaHBNLZmODI1
-- 中文官网访问这里：[Open-IM中文开发文档](https://doc.rentsoft.cn/)
+**OpenIMSDK** seamlessly integrates into your application, delivering a rich, real-time messaging experience without requiring intricate UI integration. It provides:
 
-## Quick start
++ **Local Storage**: For quick data retrieval and message synchronization.
++ **Listener Callbacks**: Ensuring real-time message interactivity.
++ **API Encapsulation**: Streamlining development processes.
++ **Connection Management**: Guaranteeing reliable message delivery.
 
-### Installing Open-IM-Server
+It's crafted in Golang and supports cross-platform deployment, ensuring a coherent messaging experience across all platforms.
 
-> Open-IM relies on five open source high-performance components: ETCD, MySQL, MongoDB, Redis, and Kafka. Privatization deployment Before Open-IM-Server, please make sure that the above five components have been installed. If your server does not have the above components, you must first install Missing components. If you have the above components, it is recommended to use them directly. If not, it is recommended to use Docker-compose, no To install dependencies, one-click deployment, faster and more convenient.
+👉 **[Explore GO SDK](https://github.com/openimsdk/openim-sdk-core)**
 
-#### Source code deployment
+## 🌐 About OpenIMServer
 
-1. Install [Go environment](https://golang.org/doc/install). Make sure Go version is at least 1.15.
+**OpenIMServer**, meticulously developed in Golang, ensures a stellar instant messaging server capability with a multifold approach:
 
-2. Clone the Open-IM project to your server.
++ **Modular Composition**: It's comprised of several modules, such as the gateway and multiple RPC services, offering a versatile messaging environment.
++ **Microservices Architecture**: Supporting cluster modes, it assures outstanding performance and scalability to manage communication effectively across various instances.
++ **Diverse Deployment Options**: Adapts to your operational preferences, offering deployment via source code, Kubernetes, or Docker.
 
-   ```
-   git clone https://github.com/OpenIMSDK/Open-IM-Server.git --recursive
-   ```
+### Enhanced Business Functionalities:
 
-3. Build and start Service.
++ **REST API**: OpenIMServer provides REST API for business systems, aiming to empower your operations with additional functionalities like group creation and message push via backend interfaces.
++ **Callbacks**: To expand its utility across varied business forms, OpenIMServer offers callback capabilities. That is, it sends a request to the business server before or after an event occurs, such as sending a message, enriching the interaction and data exchange flow in the communication processes.
 
-    1. Shell authorization
+👉 **[Learn More](https://doc.rentsoft.cn/guides/introduction/product)**
 
-       ```
-       #cd Open-IM-server/script
-       
-       chmod +x *.sh
-       ```
+<!--
 
-    2. Execute the build shell
+## :star2: Why OpenIM
 
-       ```
-       ./build_all_service.sh
-       ```
+**🔍 Function screenshot display**
 
-    3. Start service
+<div align="center">
 
-       ```
-       ./start_all.sh
-       ```
+|            💻🔄📱 Multi Terminal Synchronization 🔄🖥️             |                  📅⚡ Efficient Meetings 🚀💼      |
+| :----------------------------------------------------------: | :---------------------------------------------------------: |
+| ![multiple-message](./assets/demo/multi-terminal-synchronization.png) | ![efficient-meetings](./assets/demo/efficient-meetings.png) |
+|             📲🔄 **One-to-one and Group Chats** 👥🗣️             |        🎁💻 **Special Features - Custom Messages** ✉️🎨|
+|         ![group-chat](./assets/demo/group-chat.png)          |   ![special-function](./assets/demo/special-function.png)      |
 
-    4. Check service
+</div>
 
-       ```
-       ./check_all.sh
-       ```
+**OpenIM** offers a powerful and reliable instant messaging platform, ensuring versatile communication across multiple platforms with the following key features:
 
-       ![OpenIMServersonSystempng](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/Open-IM-Servers-on-System.png)
+✅ **Versatile Messaging:** Support for text, images, emojis, voice, video, and more, alongside one-on-one and multi-person audio/video calls.
 
-#### Docker deployment
+✅ **Robust Chat Capabilities:** Including roles (application administrator, group owner, etc.) and features like muting, group announcements, and dynamic message loading.
 
-All images are available at https://hub.docker.com/r/lyt1123/open_im_server
+✅ **Unique Interaction Features:** Offering read-and-burn private chats and a message editing function to broaden social scenarios.
 
-1. [Install Docker](https://docs.docker.com/install/) 1.13 or above.
+✅ **Open Source:** The code of OpenIM is open source and aims to build a leading global IM open source community. [GitHub Repository](https://github.com/OpenIMSDK)
 
-2. [Install Docker Compose](https://docs.docker.com/compose/install/) 1.22 or above.
+✅ **Extensibility:** Implemented in Golang, OpenIM introduces an "everything is a message" communication model, simplifying custom messages and feature extension.
 
-3. Clone the Open-IM project to your server.
+✅ **High Performance:** Supports a hierarchical governance architecture tested and abstracts the storage model of various message types.
 
-   ```
-   git clone https://github.com/OpenIMSDK/Open-IM-Server.git --recursive
-   ```
+✅ **Full Platform Support:** Native support for iOS, Android, Flutter, uni-app, ReactNative, Electron, and Web.
 
-4. Start docker-compose with one click(Docker automatically pulls all images)
+-->
 
-   ```
-   cd Open-IM-Server
-   docker-compose up -d
-   ```
 
-5. Check service
+## :rocket: Quick Start
 
-   ```
-   ./docker_check_service.sh 
-   ./check_all.sh
-   ```
+You can quickly learn OpenIM engineering solutions, all it takes is one simple command:
 
-   ![OpenIMServersondockerpng](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/Open-IM-Servers-on-docker.png)
+```bash
+$ make demo
+```
 
-### CONFIGURATION INSTRUCTIONS
+🤲 In order to facilitate the user experience, we have provided a variety of deployment solutions, you can choose your own deployment method according to the list below:
 
-> Open-IM configuration is divided into basic component configuration and business internal service configuration. Developers need to fill in the address of each component as the address of their server component when using the product, and ensure that the internal service port of the business is not occupied
+<!--
+<details> <summary>Deploying with Docker Compose</summary>
 
-#### Basic Component Configuration Instructions
+It is recommended to use Docker Compose for deployment, which can easily and quickly deploy the entire OpenIM service on a single node
 
-- ETCD
-    - Etcd is used for the discovery and registration of rpc services, etcd Schema is the prefix of the registered name, it is recommended to modify it to your company name, etcd address (ip+port) supports clustered deployment, you can fill in multiple ETCD addresses separated by commas, and also only one etcd address.
-- MySQL
-    - mysql is used for full storage of messages and user relationships. Cluster deployment is not supported for the time being. Modify addresses and users, passwords, and database names.
-- Mongo
-    - Mongo is used for offline storage of messages. The default storage is 7 days. Cluster deployment is temporarily not supported. Just modify the address and database name.
-- Redis
-    - Redis is currently mainly used for message serial number storage and user token information storage. Cluster deployment is temporarily not supported. Just modify the corresponding redis address and password.
-- Kafka
-    - Kafka is used as a message transfer storage queue to support cluster deployment, just modify the corresponding address
++ [https://github.com/openimsdk/openim-docker](https://github.com/openimsdk/openim-docker)
 
-#### Internal Service Configuration Instructions
 
-- credential&&push
-    - The Open-IM needs to use the three-party offline push function. Currently, Tencent's three-party push is used. It supports IOS, Android and OSX push. This information is some registration information pushed by Tencent. Developers need to go to Tencent Cloud Mobile Push to register the corresponding information. If you do not fill in the corresponding information, you cannot use the offline message push function
-- api&&rpcport&&longconnsvr&&rpcregistername
-    - The api port is the http interface, longconnsvr is the websocket listening port, and rpcport is the internal service startup port. Both support cluster deployment. Make sure that these ports are not used. If you want to open multiple services for a single service, fill in multiple ports separated by commas. rpcregistername is the service name registered by each service to the registry etcd, no need to modify
-- log&&modulename
-    - The log configuration includes the storage path of the log file, and the log is sent to elasticsearch for log viewing. Currently, the log is not supported to be sent to elasticsearch. The configuration does not need to be modified for the time being. The modulename is used to split the log according to the name of the service module. The default configuration is fine.
-- multiloginpolicy&&tokenpolicy
-    - Open-IM supports multi-terminal login. Currently, there are three multi-terminal login policies. The PC terminal and the mobile terminal are online at the same time by default. When multiple policies are configured to be true, the first policy with true is used by default, and the token policy is the generated token policy. , The developer can customize the expiration time of the token
+> **Note**
+>
+> If you don't know OpenIM's versioning policy, 📚Read our release policy: https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/version.md
 
-### SCRIPT DESCRIPTION
 
-> Open-IM script provides service compilation, start, and stop scripts. There are four Open-IM script start modules, one is the http+rpc service start module, the second is the websocket service start module, then the msg_transfer module, and the last is the push module
+</details> 
 
-- path_info.cfg&&style_info.cfg&&functions.sh
-    - Contains the path information of each module, including the path where the source code is located, the name of the service startup, the shell print font style, and some functions for processing shell strings
-- build_all_service.sh
-    - Compile the module, compile all the source code of Open-IM into a binary file and put it into the bin directory
-- start_rpc_api_service.sh&&msg_gateway_start.sh&&msg_transfer_start.sh&&push_start.sh
-    - Independent script startup module, followed by api and rpc modules, message gateway module, message transfer module, and push module
-- start_all.sh&&stop_all.sh
-    - Total script, start all services and close all services
+<details>  <summary>Compile from Source</summary>
 
-## Authentication Clow Chart 
 
-![avatar](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/open-im-server.png)
+Ur need `Go 1.20` or higher version, and `make`.
 
-## Architecture
 
-![avatar](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/Architecture.jpg)
+```bash
+go version && make --version || echo "Error: One of the commands failed."
+```
 
-## License
+Version Details: https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/version.md
 
-Open-IM-Server is under the Apache 2.0 license. See the [LICENSE](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/LICENSE) file for details
+You can get the version number from the command below or from [github releases](https://github.com/openimsdk/open-im-server/tags).
+
+```bash
+$ curl --silent "https://api.github.com/repos/openimsdk/open-im-server/releases" | jq -r '.[].tag_name'
+```
+
+We have our own version management policy, if you are interested in our version management, I recommend reading [📚 OpenIM Version](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/version.md), We recommend using stable versions such as `v3.3.0` and `v3.2.0` whenever possible. `v3.1.1-alpha.3` as well as `v3.3.0-beta.0` and `v3.2.0-rc.0` are pre-release or beta versions and are not recommended.
+
+Set `OPENIM_VERSION` environment variables for the latest `OPENIM_VERSION` number, or replace the `OPENIM_VERSION` for you to install the OpenIM-Server `OPENIM_VERSION`:
+
+```bash
+$ OPENIM_VERSION=`curl -s https://api.github.com/repos/openimsdk/open-im-server/releases/latest | grep -oE '"tag_name": "[^"]+"' | head -n1 | cut -d'"' -f4`
+# OPENIM_VERSION=v3.3.0
+```
+
+Deploy basic components at the click of a command:
+
+```bash
+# install openim dependency
+$ git clone https://github.com/openimsdk/open-im-server openim/openim-server && export openim=$(pwd)/openim/openim-server && cd $openim/openim-server && git checkout $OPENIM_VERSION
+$ make init && docker compose up -d && make start && make check
+```
+
+> `make help` to help you see the instructions supported by OpenIM.
+
+
+You can use the `make help-all` see OpenIM in action.
+
+</details>
+
+<details>  <summary>Component Configuration Instructions</summary>
+
+Read: Configuration center document：https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/environment.md
+
+</details>
+
+
+<details>  <summary>Deployed with kubernetes</summary>
+
++ https://github.com/openimsdk/open-im-server/blob/main/deployments/README.md
+
+</details> 
+-->
+
++ **[Source Code Deployment Guide](https://doc.rentsoft.cn/guides/gettingStarted/imSourceCodeDeployment)**
++ **[Docker Deployment Guide](https://doc.rentsoft.cn/guides/gettingStarted/dockerCompose)**
++ **[Kubernetes Deployment Guide](https://github.com/openimsdk/open-im-server/tree/main/deployments)**
+
+<!-- 
+## :link: OpenIM and your application
+
+OpenIM isn't just an open-source instant messaging component, it's an integral part of your application ecosystem. Check out this diagram to understand how AppServer, AppClient, OpenIMServer, and OpenIMSDK interact.
+
+![App-OpenIM Relationship](./docs/images/oepnim-design.png)
+
+## :building_construction: Overall Architecture
+
+Delve into the heart of Open-IM-Server's functionality with our architecture diagram.
+
+![Overall Architecture](./docs/images/Architecture.jpg) -->
+
+## :hammer_and_wrench: To start developing OpenIM
+
+OpenIM Our goal is to build a top-level open source community. We have a set of standards, in the [Community repository](https://github.com/OpenIMSDK/community).
+
+If you'd like to contribute to this Open-IM-Server repository, please read our [contributor documentation](https://github.com/openimsdk/open-im-server/blob/main/CONTRIBUTING.md).
+
+Before you start, please make sure your changes are in demand. The best for that is to create a [new discussion](https://github.com/openimsdk/open-im-server/discussions/new/choose) OR [Slack Communication](https://join.slack.com/t/openimsdk/shared_invite/zt-22720d66b-o_FvKxMTGXtcnnnHiMqe9Q), or if you find an issue, [report it](https://github.com/openimsdk/open-im-server/issues/new/choose) first.
+
+- [Code Standards](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/go_code.md)
+- [Docker Images Standards](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/images.md)
+- [Directory Standards](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/directory.md)
+- [Commit Standards](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/commit.md)
+- [Versioning Standards](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/version.md)
+- [Interface Standards](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/api.md)
+- [Log Standards](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/logging.md)
+- [Error Code Standards](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/error_code.md)
+- [OpenIM configuration and environment variable Settings](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/environment.md)
+
+
+## :busts_in_silhouette: Community
+
++ 📚 [OpenIM Community](https://github.com/OpenIMSDK/community)
++ 💕 [OpenIM Interest Group](https://github.com/Openim-sigs)
++ 🚀 [Join our Slack community](https://join.slack.com/t/openimsdk/shared_invite/zt-22720d66b-o_FvKxMTGXtcnnnHiMqe9Q)
++ :eyes: [Join our wechat (微信群)](https://openim-1253691595.cos.ap-nanjing.myqcloud.com/WechatIMG20.jpeg)
+
+## :calendar: Community Meetings
+
+We want anyone to get involved in our community and contributing code, we offer gifts and rewards, and we welcome you to join us every Thursday night.
+
+Our conference is in the [OpenIM Slack](https://join.slack.com/t/openimsdk/shared_invite/zt-22720d66b-o_FvKxMTGXtcnnnHiMqe9Q) 🎯, then you can search the Open-IM-Server pipeline to join
+
+We take notes of each [biweekly meeting](https://github.com/orgs/OpenIMSDK/discussions/categories/meeting) in [GitHub discussions](https://github.com/openimsdk/open-im-server/discussions/categories/meeting), Our historical meeting notes, as well as replays of the meetings are available at [Google Docs :bookmark_tabs:](https://docs.google.com/document/d/1nx8MDpuG74NASx081JcCpxPgDITNTpIIos0DS6Vr9GU/edit?usp=sharing).
+
+## :eyes: Who are using OpenIM
+
+Check out our [user case studies](https://github.com/OpenIMSDK/community/blob/main/ADOPTERS.md) page for a list of the project users. Don't hesitate to leave a [📝comment](https://github.com/openimsdk/open-im-server/issues/379) and share your use case.
+
+## :page_facing_up: License
+
+OpenIM is licensed under the Apache 2.0 license. See [LICENSE](https://github.com/openimsdk/open-im-server/tree/main/LICENSE) for the full license text.
+
+The OpenIM logo, including its variations and animated versions, displayed in this repository [OpenIM](https://github.com/openimsdk/open-im-server) under the [assets/logo](./assets/logo) and [assets/logo-gif](assets/logo-gif) directories, are protected by copyright laws.
+
+## 🔮 Thanks to our contributors!
+
+<a href="https://github.com/openimsdk/open-im-server/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=openimsdk/open-im-server" />
+</a>

assets/README.md

@@ -0,0 +1,32 @@
+# `/assets`
+
+The `/assets` directory in the OpenIM repository contains various assets such as images, logos, and animated GIFs. These assets serve different purposes and contribute to the functionality and aesthetics of the OpenIM project.
+
+## Directory Structure:
+
+```bash
+assets/
+├── README.md                     # Documentation for the assets directory
+├── images                        # Directory holding images related to OpenIM
+│   ├── architecture.png          # Image depicting the architecture of OpenIM
+│   └── mvc.png                   # Image illustrating the Model-View-Controller (MVC) pattern
+├── intive-slack.png              # Image displaying the Intive Slack logo
+├── logo                          # Directory containing various logo variations for OpenIM
+│   ├── openim-logo-black.png     # OpenIM logo with a black background
+│   ├── openim-logo-blue.png      # OpenIM logo with a blue background
+│   ├── openim-logo-green.png     # OpenIM logo with a green background
+│   ├── openim-logo-purple.png    # OpenIM logo with a purple background
+│   ├── openim-logo-white.png     # OpenIM logo with a white background
+│   ├── openim-logo-yellow.png    # OpenIM logo with a yellow background
+│   └── openim-logo.png           # OpenIM logo with a transparent background
+└── logo-gif                      # Directory containing animated GIF versions of the OpenIM logo
+    └── openim-log.gif            # Animated OpenIM logo with a transparent background
+```
+
+## Copyright Notice:
+
+The OpenIM logo, including its variations and animated versions, displayed in this repository [OpenIM](https://github.com/OpenIMSDK/openim) under the `/assets/logo` and `/assets/logo-gif` directories, are protected by copyright laws.
+
+The logo design is credited to @Xx(席欣).
+
+Please respect the intellectual property rights and refrain from unauthorized use and distribution of these assets.

assets/demo/README.md

@@ -0,0 +1,14 @@
+## :star2: Why OpenIM
+
+**🔍 Function screenshot display**
+
+<div align="center">
+
+
+|             multiple message              |               Efficient meetings                |
+| :---------------------------------------: | :---------------------------------------------: |
+| ![multiple-message](./multiple-message.png) | ![efficient-meetings](./efficient-meetings.png) |
+|      **One-to-one and group chats**       |     **Special features - Custom messages**      |
+|      ![group-chat](./group-chat.png)      |   ![special-function](./special-function.png)    |
+
+</div>

assets/logo-gif/LICENSE

@@ -0,0 +1 @@
+# The OpenIM logo files are licensed under a choice of either Apache-2.0 or CC-BY-4.0 (Creative Commons Attribution 4.0 International).

assets/logo/LICENSE

@@ -0,0 +1 @@
+# The OpenIM logo files are licensed under a choice of either Apache-2.0 or CC-BY-4.0 (Creative Commons Attribution 4.0 International).