cicd: bump League Patch (#2012)

* Optimize script logs

* Optimizing Docker Log Output Detection

* Optimizing Docker Log Output Detection

* Optimizing Docker Log Output Detection

* Optimizing Docker Log Output Detection

* Optimizing Docker Log Output Detection

* Optimizing Docker Log Output Detection

* Optimizing Docker Log Output Detection

* Optimizing Docker Log Output Detection

* Optimizing Docker Log Output Detection

* Optimizing Docker Log Output Detection

* Optimizing Docker Log Output Detection

* Optimizing Docker Log Output Detection

.docker-compose_cfg/config.yaml

@@ -1,79 +0,0 @@
-# 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/prometheus-compose.yml

@@ -1,85 +0,0 @@
-# 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 
-  evaluation_interval: 15s 
-  external_labels:
-    monitor: 'openIM-monitor'
-
-scrape_configs:
-    - job_name: 'prometheus'
-      static_configs:
-      - targets: ['localhost:9091']
-
-    - job_name: 'openIM-server'
-      metrics_path: /metrics
-      static_configs:
-      - targets: ['localhost:10002']
-        labels:
-          group: 'api'
-
-      - targets: ['localhost:20110']
-        labels:
-          group: 'user'
-
-      - targets: ['localhost:20120']
-        labels:
-          group: 'friend'
-
-      - targets: ['localhost:20130']
-        labels:
-          group: 'message'
-
-      - targets: ['localhost:20140']
-        labels:
-          group: 'msg-gateway'    
-
-      - targets: ['localhost:20150']
-        labels:
-          group: 'group'
-
-      - targets: ['localhost:20160']
-        labels:
-          group: 'auth'
-
-      - targets: ['localhost:20170']
-        labels:
-          group: 'push'
-
-      - targets: ['localhost:20120']
-        labels:
-          group: 'friend'
-
-      
-      - targets: ['localhost:20230']
-        labels:
-          group: 'conversation' 
-
-      
-      - targets: ['localhost:21400', 'localhost:21401', 'localhost:21402', 'localhost:21403']
-        labels:
-          group: 'msg-transfer'
-       
- 
-
-
-      
-
-    - job_name: 'node'  
-      scrape_interval: 8s
-      static_configs:
-      - targets: ['localhost:9100']
-     

.dockerignore

@@ -1,4 +1,4 @@
-<!-- # Ignore files and directories starting with a dot
+# Ignore files and directories starting with a dot
 
 # Ignore specific files
 .dockerignore
@@ -20,7 +20,6 @@ CHANGELOG/
 
 # Ignore deployment-related files
 docker-compose.yaml
-deployments/
 
 # Ignore assets
 assets/
@@ -29,4 +28,4 @@ assets/
 components/
 
 # Ignore tools and scripts
-.github/ -->
+.github/

.env

@@ -1,279 +0,0 @@
-# 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://172.28.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

@@ -20,4 +20,20 @@ coverage:
         paths:
           - pkg/* # only include coverage in "pkg/" folder
         informational: true # Always pass check
-    patch: off # disable the commit only checks
+      tools: # declare a new status context "tools"
+        paths:
+          - tools/* # only include coverage in "tools/" folder
+        informational: true # Always pass check
+      test: # declare a new status context "test"
+        paths:
+          - test/* # only include coverage in "test/" folder
+        informational: true # Always pass check
+      # internal: # declare a new status context "internal"
+      #   paths:
+      #     - internal/* # only include coverage in "internal/" folder
+      #   informational: true # Always pass check
+      # cmd: # declare a new status context "cmd"
+      #   paths:
+      #     - cmd/* # only include coverage in "cmd/" folder
+      #   informational: true # Always pass check
+    patch: off # disable the commit only checks

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

@@ -27,7 +27,7 @@ jobs:
       issues: write
     steps:
       - name: Checkout code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Assign the issue
         run: |

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

@@ -24,38 +24,49 @@ on:
     types: [created]
 
 jobs:
-  create-pr:
+  sync-issue-to-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@v3
-          with:
-            fetch-depth: 0
+      - name: Checkout code
+        uses: actions/checkout@v4
+      
+      - name: Sync Issue to PR
+        if: github.event_name == 'pull_request' && github.event.pull_request.base.ref == 'main'
+        run: |
+          PR_BODY="${{ github.event.pull_request.body }}"
 
-        - 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"
+          ISSUE_NUMBER=$(echo "$PR_BODY" | grep -oP 'Fixes #\K\d+')
+          if [[ -z "$ISSUE_NUMBER" ]]; then
+            echo "No Issue number found."
+            exit 1
+          fi
 
-            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')
+          echo "Issue number found: $ISSUE_NUMBER"
 
-            gh pr edit ${{ github.event.pull_request.number }} --repo $OWNER/$REPO --add-label "$LABELS" --add-assignee "$ASSIGNEES" --milestone "$MILESTONE"
+          # Using GitHub CLI to get issue details
+          gh issue view "$ISSUE_NUMBER" --repo "${{ github.repository }}" --json labels,assignees,milestone,title > issue_data.json
 
-            # 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 }}
+          # Check if jq is installed
+          if ! command -v jq &> /dev/null; then
+            echo "Installing jq..."
+            sudo apt-get install -y jq
+          fi
+
+          # Parse data with jq
+          LABELS=$(jq -r '.labels | map(.name) | join(",")' issue_data.json)
+          ASSIGNEES=$(jq -r '.assignees | map(.login) | join(",")' issue_data.json)
+          MILESTONE=$(jq -r '.milestone.title' issue_data.json)
+
+          # Check if any of the fields are empty and set them to None
+          LABELS=${LABELS:-None}
+          ASSIGNEES=${ASSIGNEES:-None}
+          MILESTONE=${MILESTONE:-None}
+
+          # Edit the PR with issue details, handling empty fields
+          gh pr edit "${{ github.event.pull_request.number }}" --repo "${{ github.repository }}" \
+            ${LABELS:+--add-label "$LABELS"} \
+            ${ASSIGNEES:+--add-assignee "$ASSIGNEES"} \
+            ${MILESTONE:+--milestone "$MILESTONE"}
+        continue-on-error: true
+        env:
+          GITHUB_TOKEN: ${{ secrets.BOT_GITHUB_TOKEN }}

.github/workflows/auto-invite.yml

@@ -27,7 +27,7 @@ jobs:
     steps:
 
       - name: Invite user to join our group
-        uses: peter-evans/create-or-update-comment@v3
+        uses: peter-evans/create-or-update-comment@v4
         with:
           token: ${{ secrets.BOT_GITHUB_TOKEN }}
           issue-number: ${{ github.event.issue.number }}
@@ -39,7 +39,7 @@ jobs:
             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://mail.google.com/mail/u/0/?fs=1&tf=cm&to=info@openim.io" 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.
 

.github/workflows/auto-tag.yml

@@ -12,7 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-name: Create Tag
+name: OpenIM Create Tag
 
 on:
   issue_comment:
@@ -26,7 +26,7 @@ jobs:
     if: startsWith(github.event.comment.body, '/create tag')
     steps:
       - name: Checkout code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Validate version number and get comment
         id: validate

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

@@ -12,7 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-name: 'Github Rebot for Cherry Pick when PR is merged'
+name: Github Rebot for Cherry Pick when PR is merged
 on:
   pull_request_target:
     types:
@@ -23,7 +23,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Comment cherry-pick command
-        uses: actions/github-script@v6
+        uses: actions/github-script@v7
         with:
           script: |
             const pr = context.payload.pull_request;

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

@@ -19,11 +19,12 @@ on:
 jobs:
   cherry-pick:
     name: Cherry Pick
-    if: github.event.issue.pull_request != '' && contains(github.event.comment.body, '/cherry-pick') && github.event.comment.user.login=='kubbot'
+    # && 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@v3
+        uses: actions/checkout@v4
         with:
           token: ${{ secrets.BOT_GITHUB_TOKEN }}
           fetch-depth: 0 # otherwise, you will fail to push refs to dest repo

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

@@ -15,6 +15,8 @@
 name: Publish Docker image
 
 on:
+  schedule:
+  - cron: '30 2 * * *'
   push:
     branches:
       - main
@@ -32,36 +34,38 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Set up QEMU
-        uses: docker/setup-qemu-action@v2
+        uses: docker/setup-qemu-action@v3
       - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v2
+        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@v4.6.0
+        uses: docker/metadata-action@v5.5.1
         with:
           images: openim/openim-server
           # generate Docker tags based on the following events/attributes
           tags: |
+            type=ref,event=tag
             type=schedule
             type=ref,event=branch
             type=ref,event=pr
             type=semver,pattern={{version}}
+            type=semver,pattern=v{{version}}
             type=semver,pattern={{major}}.{{minor}}
             type=semver,pattern={{major}}
             type=sha
 
       - name: Log in to Docker Hub
-        uses: docker/login-action@v2
+        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@v4
+        uses: docker/build-push-action@v5
         with:
           context: .
           # linux/ppc64le,linux/s390x
@@ -74,27 +78,38 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Set up QEMU
-        uses: docker/setup-qemu-action@v2
+        uses: docker/setup-qemu-action@v3
       - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v2
+        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@v4.6.0
+        uses: docker/metadata-action@v5.5.1
         with:
           images: registry.cn-hangzhou.aliyuncs.com/openimsdk/openim-server
+          # generate Docker tags based on the following events/attributes
+          tags: |
+            type=ref,event=tag
+            type=schedule
+            type=ref,event=branch
+            type=ref,event=pr
+            type=semver,pattern={{version}}
+            type=semver,pattern=v{{version}}
+            type=semver,pattern={{major}}.{{minor}}
+            type=semver,pattern={{major}}
+            type=sha
 
       - name: Log in to AliYun Docker Hub
-        uses: docker/login-action@v2
+        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@v4
+        uses: docker/build-push-action@v5
         with:
           context: .
           # linux/ppc64le,linux/s390x
@@ -107,27 +122,38 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Set up QEMU
-        uses: docker/setup-qemu-action@v2
+        uses: docker/setup-qemu-action@v3
       - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v2
+        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@v4.6.0
+        uses: docker/metadata-action@v5.5.1
         with:
           images: ghcr.io/openimsdk/openim-server
+          # generate Docker tags based on the following events/attributes
+          tags: |
+            type=ref,event=tag
+            type=schedule
+            type=ref,event=branch
+            type=ref,event=pr
+            type=semver,pattern={{version}}
+            type=semver,pattern=v{{version}}
+            type=semver,pattern={{major}}.{{minor}}
+            type=semver,pattern={{major}}
+            type=sha
 
       - name: Log in to GitHub Container Registry
-        uses: docker/login-action@v2
+        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@v4
+        uses: docker/build-push-action@v5
         with:
           context: .
           # linux/ppc64le,linux/s390x

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

@@ -1,274 +0,0 @@
-# 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:
-  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@v3
-      - name: Set up QEMU
-        uses: docker/setup-qemu-action@v2
-      - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v2
-
-# docker.io/openim/openim-server:latest
-      - name: Extract metadata (tags, labels) for Docker
-        id: meta
-        uses: docker/metadata-action@v4.6.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@v2
-        with:
-          username: ${{ secrets.DOCKER_USERNAME }}
-          password: ${{ secrets.DOCKER_PASSWORD }}
-
-      - name: Build and push Docker image
-        uses: docker/build-push-action@v4
-        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@v3
-      - name: Set up QEMU
-        uses: docker/setup-qemu-action@v2
-      - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v2
-# registry.cn-hangzhou.aliyuncs.com/openimsdk/openim-server:latest
-      - name: Extract metadata (tags, labels) for Docker
-        id: meta2
-        uses: docker/metadata-action@v4.6.0
-        with:
-          images: registry.cn-hangzhou.aliyuncs.com/openimsdk/openim-server
-
-      - name: Log in to AliYun Docker Hub
-        uses: docker/login-action@v2
-        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@v4
-        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@v3
-      - name: Set up QEMU
-        uses: docker/setup-qemu-action@v2
-      - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v2
-# ghcr.io/openimsdk/openim-server:latest
-      - name: Extract metadata (tags, labels) for Docker
-        id: meta3
-        uses: docker/metadata-action@v4.6.0
-        with:
-          images: ghcr.io/openimsdk/openim-server
-
-      - name: Log in to GitHub Container Registry
-        uses: docker/login-action@v2
-        with:
-          registry: ghcr.io
-          username: ${{ github.repository_owner }}
-          password: ${{ secrets.GITHUB_TOKEN }}
-
-      - name: Build and push Docker image
-        uses: docker/build-push-action@v4
-        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 }}
-
-  build-openim-web-dockerhub:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v3
-      - name: Set up QEMU
-        uses: docker/setup-qemu-action@v2
-      - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v2
-
-# docker.io/openim/openim-server:latest
-      - name: Extract metadata (tags, labels) for Docker
-        id: meta
-        uses: docker/metadata-action@v4.6.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@v2
-        with:
-          username: ${{ secrets.DOCKER_USERNAME }}
-          password: ${{ secrets.DOCKER_PASSWORD }}
-
-      - name: Build and push Docker image
-        uses: docker/build-push-action@v4
-        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@v3
-      - name: Set up QEMU
-        uses: docker/setup-qemu-action@v2
-      - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v2
-# registry.cn-hangzhou.aliyuncs.com/openimsdk/openim-server:latest
-      - name: Extract metadata (tags, labels) for Docker
-        id: meta2
-        uses: docker/metadata-action@v4.6.0
-        with:
-          images: registry.cn-hangzhou.aliyuncs.com/openimsdk/openim-server
-
-      - name: Log in to AliYun Docker Hub
-        uses: docker/login-action@v2
-        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@v4
-        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@v3
-      - name: Set up QEMU
-        uses: docker/setup-qemu-action@v2
-      - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v2
-        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@v2
-        with:
-          registry: ghcr.io
-          username: ${{ github.repository_owner }}
-          password: ${{ secrets.GITHUB_TOKEN }}
-
-      - name: Extract metadata (tags, labels) for Docker openim-web
-        id: meta1
-        uses: docker/metadata-action@v4.6.0
-        with:
-          images: ghcr.io/openimsdk/openim-web
-
-      - name: Build and push Docker image for openim-web
-        uses: docker/build-push-action@v4
-        with:
-          context: .
-          file: ./build/images/openim-tools/openim-web/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-web
-        id: meta2
-        uses: docker/metadata-action@v4.6.0
-        with:
-          images: ghcr.io/openimsdk/component
-
-      - name: Build and push Docker image for component
-        uses: docker/build-push-action@v4
-        with:
-          context: .
-          file: ./build/images/openim-tools/component/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

.github/workflows/check-coverage.yml

@@ -12,7 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-name: Check-Coverage
+name: OpenIM Check Coverage
 
 on:
   workflow_dispatch:
@@ -41,7 +41,7 @@ jobs:
     runs-on: ubuntu-20.04
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Setup Golang with cache
         uses: magnetikonline/action-golang-cache@v4
@@ -56,4 +56,4 @@ jobs:
         continue-on-error: true
 
       - name: Upload Coverage to Codecov
-        uses: codecov/codecov-action@v3
+        uses: codecov/codecov-action@v4

.github/workflows/cla.yml

@@ -12,7 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-name: "OpenIM CLA Assistant"
+name: OpenIM CLA Assistant
 on:
   issue_comment:
     types: [created]
@@ -33,7 +33,7 @@ env:
   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* 
+  OPEN_IM_SERVER_ALLOWLIST: kubbot,openimbot,bot*,dependabot,sweep-ai,*bot,bot-*,bot/*,bot-/*,bot,*[bot]
 
 jobs:
   CLAAssistant:
@@ -41,7 +41,7 @@ jobs:
     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.0
+        uses: contributor-assistant/github-action@v2.3.1
         env:
           GITHUB_TOKEN: ${{ secrets.BOT_GITHUB_TOKEN }}
           PERSONAL_ACCESS_TOKEN: ${{ secrets.REDBOT_GITHUB_TOKEN }}

.github/workflows/codeql-analysis.yml

@@ -47,11 +47,11 @@ jobs:
 
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       # Initializes the CodeQL tools for scanning.
       - name: Initialize CodeQL
-        uses: github/codeql-action/init@v2
+        uses: github/codeql-action/init@v3
         # Override language selection by uncommenting this and choosing your languages
         with:
           languages: go
@@ -59,7 +59,7 @@ jobs:
       # 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
+        uses: github/codeql-action/autobuild@v3
 
       # ℹ️ 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
@@ -73,4 +73,4 @@ jobs:
     #       make release
 
       - name: Perform CodeQL Analysis
-        uses: github/codeql-action/analyze@v2
+        uses: github/codeql-action/analyze@v3

.github/workflows/create-branch-on-tag.yml

@@ -19,12 +19,16 @@ on:
     tags:
       - 'v*.*.0'
 
+permissions:
+  contents: write
+  actions: write
+
 jobs:
   create-branch:
     runs-on: ubuntu-latest
     steps:
     - name: Check out code
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
       with:
         fetch-depth: 0
 
@@ -36,41 +40,38 @@ jobs:
     - name: Install git-chglog
       run: make install.git-chglog
 
-    - name: Create Branch
+    - name: Create Branch and Push
+      env:
+        TAG_NAME: ${{ github.ref_name }}
       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"
+        else
+          echo "Not a release tag. Skipping branch creation."
         fi
+      continue-on-error: true
 
-    - name: Push Changes
-      uses: stefanzweifel/git-auto-commit-action@v4
-      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
+    - name: Create and Commit CHANGELOG
+      if: endsWith(github.ref_name, '.0')
       run: |
-        git checkout main
-        TAG_NAME=${GITHUB_REF/refs\/tags\//}
+        git fetch --all
+        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
+        git checkout main
+        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" || echo "No changes to commit."
+      continue-on-error: true
 
-    - name: Push Changes
-      uses: stefanzweifel/git-auto-commit-action@v4
+    - name: Push CHANGELOG to Main
+      if: steps.create-and-commit-changelog.outputs.changes == 'true'
+      uses: ad-m/github-push-action@v0.8.0
       with:
-        commit_message: "Auto Commit CHANGELOG"
+        github_token: ${{ secrets.BOT_GITHUB_TOKEN }}
         branch: main
-      env:
-        GITHUB_TOKEN: ${{ secrets.BOT_GITHUB_TOKEN }}
+    continue-on-error: true

.github/workflows/deploy.yml

@@ -1,55 +0,0 @@
-# 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@v3
-      - 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

@@ -2,7 +2,7 @@
 # Licensed under the MIT License (the "License");
 # you may not use this file except in compliance with the License.
 
-name: Dependency Review
+name: OpenIM Dependency Review
 on: [pull_request]
 
 permissions:
@@ -13,6 +13,6 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: 'Checkout Repository'
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: 'Dependency Review'
-        uses: actions/dependency-review-action@v3
+        uses: actions/dependency-review-action@v4

.github/workflows/docker-buildx.yml

@@ -29,18 +29,18 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         
       - name: Set up QEMU
-        uses: docker/setup-qemu-action@v2
+        uses: docker/setup-qemu-action@v3
         
       - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v2
+        uses: docker/setup-buildx-action@v3
         with:
           install: true
 
       - name: Cache Docker layers
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         with:
           path: /tmp/.buildx-cache
           key: ${{ runner.os }}-buildx-${{ github.sha }}
@@ -48,12 +48,25 @@ jobs:
             ${{ runner.os }}-buildx-
 
       - name: Log in to GitHub Container Registry
-        uses: docker/login-action@v2
+        uses: docker/login-action@v3
         with:
           registry: ghcr.io
           username: ${{ github.repository_owner }}
           password: ${{ secrets.GITHUB_TOKEN }}
 
+      - name: Log in to Docker Hub
+        uses: docker/login-action@v3
+        with:
+          username: ${{ secrets.DOCKER_USERNAME }}
+          password: ${{ secrets.DOCKER_PASSWORD }}
+
+      - 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 }}
+
 ################################################
 # build/
 # └── docker
@@ -87,12 +100,25 @@ jobs:
 
       - name: Extract metadata (tags, labels) for Docker openim-api
         id: meta1
-        uses: docker/metadata-action@v4.6.0
+        uses: docker/metadata-action@v5.5.1
         with:
-          images: ghcr.io/openimsdk/openim-api
+          images: |
+            ghcr.io/openimsdk/openim-api
+            openim/openim-api
+            registry.cn-hangzhou.aliyuncs.com/openimsdk/openim-api
+          tags: |
+            type=ref,event=tag
+            type=schedule
+            type=ref,event=branch
+            type=ref,event=pr
+            type=semver,pattern={{version}}
+            type=semver,pattern=v{{version}}
+            type=semver,pattern={{major}}.{{minor}}
+            type=semver,pattern={{major}}
+            type=sha
 
       - name: Build and push Docker image for openim-api
-        uses: docker/build-push-action@v4
+        uses: docker/build-push-action@v5
         with:
           context: .
           file: ./build/images/openim-api/Dockerfile
@@ -105,12 +131,25 @@ jobs:
 
       - name: Extract metadata (tags, labels) for Docker openim-cmdutils
         id: meta2
-        uses: docker/metadata-action@v4.6.0
+        uses: docker/metadata-action@v5.5.1
         with:
-          images: ghcr.io/openimsdk/openim-cmdutils
+          images: |
+            ghcr.io/openimsdk/openim-cmdutils
+            openim/openim-cmdutils
+            registry.cn-hangzhou.aliyuncs.com/openimsdk/openim-cmdutils
+          tags: |
+            type=ref,event=tag
+            type=schedule
+            type=ref,event=branch
+            type=ref,event=pr
+            type=semver,pattern={{version}}
+            type=semver,pattern=v{{version}}
+            type=semver,pattern={{major}}.{{minor}}
+            type=semver,pattern={{major}}
+            type=sha
 
       - name: Build and push Docker image for openim-cmdutils
-        uses: docker/build-push-action@v4
+        uses: docker/build-push-action@v5
         with:
           context: .
           file: ./build/images/openim-cmdutils/Dockerfile
@@ -123,12 +162,25 @@ jobs:
 
       - name: Extract metadata (tags, labels) for Docker openim-crontask
         id: meta3
-        uses: docker/metadata-action@v4.6.0
+        uses: docker/metadata-action@v5.5.1
         with:
-          images: ghcr.io/openimsdk/openim-crontask
+          images: |
+            ghcr.io/openimsdk/openim-crontask
+            openim/openim-crontask
+            registry.cn-hangzhou.aliyuncs.com/openimsdk/openim-crontask
+          tags: |
+            type=ref,event=tag
+            type=schedule
+            type=ref,event=branch
+            type=ref,event=pr
+            type=semver,pattern={{version}}
+            type=semver,pattern=v{{version}}
+            type=semver,pattern={{major}}.{{minor}}
+            type=semver,pattern={{major}}
+            type=sha
 
       - name: Build and push Docker image for openim-crontask
-        uses: docker/build-push-action@v4
+        uses: docker/build-push-action@v5
         with:
           context: .
           file: ./build/images/openim-crontask/Dockerfile
@@ -141,12 +193,25 @@ jobs:
 
       - name: Extract metadata (tags, labels) for Docker openim-msggateway
         id: meta4
-        uses: docker/metadata-action@v4.6.0
+        uses: docker/metadata-action@v5.5.1
         with:
-          images: ghcr.io/openimsdk/openim-msggateway
+          images: |
+            ghcr.io/openimsdk/openim-msggateway
+            openim/openim-msggateway
+            registry.cn-hangzhou.aliyuncs.com/openimsdk/openim-msggateway
+          tags: |
+            type=ref,event=tag
+            type=schedule
+            type=ref,event=branch
+            type=ref,event=pr
+            type=semver,pattern={{version}}
+            type=semver,pattern=v{{version}}
+            type=semver,pattern={{major}}.{{minor}}
+            type=semver,pattern={{major}}
+            type=sha
 
       - name: Build and push Docker image for openim-msggateway
-        uses: docker/build-push-action@v4
+        uses: docker/build-push-action@v5
         with:
           context: .
           file: ./build/images/openim-msggateway/Dockerfile
@@ -159,12 +224,25 @@ jobs:
 
       - name: Extract metadata (tags, labels) for Docker openim-msgtransfer
         id: meta5
-        uses: docker/metadata-action@v4.6.0
+        uses: docker/metadata-action@v5.5.1
         with:
-          images: ghcr.io/openimsdk/openim-msgtransfer
+          images: |
+            ghcr.io/openimsdk/openim-msgtransfer
+            openim/openim-msgtransfer
+            registry.cn-hangzhou.aliyuncs.com/openimsdk/openim-msgtransfer
+          tags: |
+            type=ref,event=tag
+            type=schedule
+            type=ref,event=branch
+            type=ref,event=pr
+            type=semver,pattern={{version}}
+            type=semver,pattern=v{{version}}
+            type=semver,pattern={{major}}.{{minor}}
+            type=semver,pattern={{major}}
+            type=sha
 
       - name: Build and push Docker image for openim-msgtransfer
-        uses: docker/build-push-action@v4
+        uses: docker/build-push-action@v5
         with:
           context: .
           file: ./build/images/openim-msgtransfer/Dockerfile
@@ -177,12 +255,25 @@ jobs:
           
       - name: Extract metadata (tags, labels) for Docker openim-push
         id: meta6
-        uses: docker/metadata-action@v4.6.0
+        uses: docker/metadata-action@v5.5.1
         with:
-          images: ghcr.io/openimsdk/openim-push
+          images: |
+            ghcr.io/openimsdk/openim-push
+            openim/openim-push
+            registry.cn-hangzhou.aliyuncs.com/openimsdk/openim-push
+          tags: |
+            type=ref,event=tag
+            type=schedule
+            type=ref,event=branch
+            type=ref,event=pr
+            type=semver,pattern={{version}}
+            type=semver,pattern=v{{version}}
+            type=semver,pattern={{major}}.{{minor}}
+            type=semver,pattern={{major}}
+            type=sha
 
       - name: Build and push Docker image for openim-push
-        uses: docker/build-push-action@v4
+        uses: docker/build-push-action@v5
         with:
           context: .
           file: ./build/images/openim-push/Dockerfile
@@ -195,12 +286,25 @@ jobs:
 
       - name: Extract metadata (tags, labels) for Docker openim-rpc-auth
         id: meta7
-        uses: docker/metadata-action@v4.6.0
+        uses: docker/metadata-action@v5.5.1
         with:
-          images: ghcr.io/openimsdk/openim-rpc-auth
+          images: |
+            ghcr.io/openimsdk/openim-rpc-auth
+            openim/openim-rpc-auth
+            registry.cn-hangzhou.aliyuncs.com/openimsdk/openim-rpc-auth
+          tags: |
+            type=ref,event=tag
+            type=schedule
+            type=ref,event=branch
+            type=ref,event=pr
+            type=semver,pattern={{version}}
+            type=semver,pattern=v{{version}}
+            type=semver,pattern={{major}}.{{minor}}
+            type=semver,pattern={{major}}
+            type=sha
 
       - name: Build and push Docker image for openim-rpc-auth
-        uses: docker/build-push-action@v4
+        uses: docker/build-push-action@v5
         with:
           context: .
           file: ./build/images/openim-rpc-auth/Dockerfile
@@ -213,12 +317,25 @@ jobs:
 
       - name: Extract metadata (tags, labels) for Docker openim-rpc-conversation
         id: meta8
-        uses: docker/metadata-action@v4.6.0
+        uses: docker/metadata-action@v5.5.1
         with:
-          images: ghcr.io/openimsdk/openim-rpc-conversation
+          images: |
+            ghcr.io/openimsdk/openim-rpc-conversation
+            openim/openim-rpc-conversation
+            registry.cn-hangzhou.aliyuncs.com/openimsdk/openim-rpc-conversation
+          tags: |
+            type=ref,event=tag
+            type=schedule
+            type=ref,event=branch
+            type=ref,event=pr
+            type=semver,pattern={{version}}
+            type=semver,pattern=v{{version}}
+            type=semver,pattern={{major}}.{{minor}}
+            type=semver,pattern={{major}}
+            type=sha
 
       - name: Build and push Docker image for openim-rpc-conversation
-        uses: docker/build-push-action@v4
+        uses: docker/build-push-action@v5
         with:
           context: .
           file: ./build/images/openim-rpc-conversation/Dockerfile
@@ -231,12 +348,25 @@ jobs:
 
       - name: Extract metadata (tags, labels) for Docker openim-rpc-friend
         id: meta9
-        uses: docker/metadata-action@v4.6.0
+        uses: docker/metadata-action@v5.5.1
         with:
-          images: ghcr.io/openimsdk/openim-rpc-friend
+          images: |
+            ghcr.io/openimsdk/openim-rpc-friend
+            openim/openim-rpc-friend
+            registry.cn-hangzhou.aliyuncs.com/openimsdk/openim-rpc-friend
+          tags: |
+            type=ref,event=tag
+            type=schedule
+            type=ref,event=branch
+            type=ref,event=pr
+            type=semver,pattern={{version}}
+            type=semver,pattern=v{{version}}
+            type=semver,pattern={{major}}.{{minor}}
+            type=semver,pattern={{major}}
+            type=sha
 
       - name: Build and push Docker image for openim-rpc-friend
-        uses: docker/build-push-action@v4
+        uses: docker/build-push-action@v5
         with:
           context: .
           file: ./build/images/openim-rpc-friend/Dockerfile
@@ -249,12 +379,25 @@ jobs:
 
       - name: Extract metadata (tags, labels) for Docker openim-rpc-group
         id: meta10
-        uses: docker/metadata-action@v4.6.0
+        uses: docker/metadata-action@v5.5.1
         with:
-          images: ghcr.io/openimsdk/openim-rpc-group
+          images: |
+            ghcr.io/openimsdk/openim-rpc-group
+            openim/openim-rpc-group
+            registry.cn-hangzhou.aliyuncs.com/openimsdk/openim-rpc-group
+          tags: |
+            type=ref,event=tag
+            type=schedule
+            type=ref,event=branch
+            type=ref,event=pr
+            type=semver,pattern={{version}}
+            type=semver,pattern=v{{version}}
+            type=semver,pattern={{major}}.{{minor}}
+            type=semver,pattern={{major}}
+            type=sha
 
       - name: Build and push Docker image for openim-rpc-group
-        uses: docker/build-push-action@v4
+        uses: docker/build-push-action@v5
         with:
           context: .
           file: ./build/images/openim-rpc-group/Dockerfile
@@ -267,12 +410,25 @@ jobs:
 
       - name: Extract metadata (tags, labels) for Docker openim-rpc-msg
         id: meta11
-        uses: docker/metadata-action@v4.6.0
+        uses: docker/metadata-action@v5.5.1
         with:
-          images: ghcr.io/openimsdk/openim-rpc-msg
+          images: |
+            ghcr.io/openimsdk/openim-rpc-msg
+            openim/openim-rpc-msg
+            registry.cn-hangzhou.aliyuncs.com/openimsdk/openim-rpc-msg
+          tags: |
+            type=ref,event=tag
+            type=schedule
+            type=ref,event=branch
+            type=ref,event=pr
+            type=semver,pattern={{version}}
+            type=semver,pattern=v{{version}}
+            type=semver,pattern={{major}}.{{minor}}
+            type=semver,pattern={{major}}
+            type=sha
 
       - name: Build and push Docker image for openim-rpc-msg
-        uses: docker/build-push-action@v4
+        uses: docker/build-push-action@v5
         with:
           context: .
           file: ./build/images/openim-rpc-msg/Dockerfile
@@ -285,12 +441,25 @@ jobs:
 
       - name: Extract metadata (tags, labels) for Docker openim-rpc-third
         id: meta12
-        uses: docker/metadata-action@v4.6.0
+        uses: docker/metadata-action@v5.5.1
         with:
-          images: ghcr.io/openimsdk/openim-rpc-third
+          images: |
+            ghcr.io/openimsdk/openim-rpc-third
+            openim/openim-rpc-third
+            registry.cn-hangzhou.aliyuncs.com/openimsdk/openim-rpc-third
+          tags: |
+            type=ref,event=tag
+            type=schedule
+            type=ref,event=branch
+            type=ref,event=pr
+            type=semver,pattern={{version}}
+            type=semver,pattern=v{{version}}
+            type=semver,pattern={{major}}.{{minor}}
+            type=semver,pattern={{major}}
+            type=sha
 
       - name: Build and push Docker image for openim-rpc-third
-        uses: docker/build-push-action@v4
+        uses: docker/build-push-action@v5
         with:
           context: .
           file: ./build/images/openim-rpc-third/Dockerfile
@@ -303,12 +472,25 @@ jobs:
 
       - name: Extract metadata (tags, labels) for Docker openim-rpc-user
         id: meta13
-        uses: docker/metadata-action@v4.6.0
+        uses: docker/metadata-action@v5.5.1
         with:
-          images: ghcr.io/openimsdk/openim-rpc-user
+          images: |
+            ghcr.io/openimsdk/openim-rpc-user
+            openim/openim-rpc-user
+            registry.cn-hangzhou.aliyuncs.com/openimsdk/openim-rpc-user
+          tags: |
+            type=ref,event=tag
+            type=schedule
+            type=ref,event=branch
+            type=ref,event=pr
+            type=semver,pattern={{version}}
+            type=semver,pattern=v{{version}}
+            type=semver,pattern={{major}}.{{minor}}
+            type=semver,pattern={{major}}
+            type=sha
 
       - name: Build and push Docker image for openim-rpc-user
-        uses: docker/build-push-action@v4
+        uses: docker/build-push-action@v5
         with:
           context: .
           file: ./build/images/openim-rpc-user/Dockerfile
@@ -318,4 +500,3 @@ jobs:
           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

@@ -12,7 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-name: e2e
+name: OpenIM Linux System E2E Test
 
 on:
   workflow_dispatch:
@@ -22,6 +22,9 @@ on:
     # run e2e test every 4 hours
     - cron: 0 */4 * * *
 
+env:
+  CALLBACK_ENABLE: true
+
 jobs:
   build:
     name: Test
@@ -31,14 +34,113 @@ jobs:
     steps:
 
       - name: Set up Go 1.21
-        uses: actions/setup-go@v2
+        uses: actions/setup-go@v5
         with:
           go-version: 1.21
         id: go
 
       - name: Check out code into the Go module directory
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
 
       - name: Create e2e test
         run: |
-          echo "...test e2e"
+          echo "...test e2e"
+
+  execute-linux-systemd-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@v5
+      with:
+        go-version: ${{ matrix.go_version }}
+      id: go
+
+    - name: Install Task
+      uses: arduino/setup-task@v1
+      with:
+        version: '3.x' # If available, use the latest major version that's compatible
+        repo-token: ${{ secrets.GITHUB_TOKEN }}
+
+    - name: Docker Operations
+      run: |
+        sudo make init
+        sudo docker compose up -d
+        sudo sleep 20
+
+    - name: Module Operations
+      run: |
+        sudo make tidy
+        sudo make tools.verify.go-gitlint
+
+    - name: Build, Start
+      run: |
+        sudo ./scripts/install/install.sh -i
+
+    - name: Exec OpenIM System Status Chack
+      run: |
+        sudo ./scripts/install/install.sh -s
+
+    - name: Exec OpenIM API test
+      run: |
+        sudo make test-api
+        mkdir -p ./tmp
+        touch ./tmp/test.md
+        echo "# OpenIM Test" >> ./tmp/test.md
+        echo "## OpenIM API Test" >> ./tmp/test.md
+        echo "<details><summary>Command Output for OpenIM API Test</summary>" >> ./tmp/test.md
+        echo "<pre><code>" >> ./tmp/test.md
+        sudo make test-api | tee -a ./tmp/test.md
+        echo "</code></pre>" >> ./tmp/test.md
+        echo "</details>" >> ./tmp/test.md
+
+    - name: Exec OpenIM E2E Test
+      run: |
+        sudo make test-e2e
+        echo "" >> ./tmp/test.md
+        echo "## OpenIM E2E Test" >> ./tmp/test.md
+        echo "<details><summary>Command Output for OpenIM E2E Test</summary>" >> ./tmp/test.md
+        echo "<pre><code>" >> ./tmp/test.md
+        sudo make test-e2e | tee -a ./tmp/test.md
+        echo "</code></pre>" >> ./tmp/test.md
+        echo "</details>" >> ./tmp/test.md
+
+    - name: Comment PR with file
+      uses: thollander/actions-comment-pull-request@v2
+      with:
+        filePath: ./tmp/test.md
+        comment_tag: nrt_file
+        reactions: eyes, rocket
+        mode: recreate
+        GITHUB_TOKEN: ${{ secrets.BOT_GITHUB_TOKEN }}
+      continue-on-error: true
+
+    - name: Check outputs
+      run: |
+        echo "id : ${{ steps.nrt_message.outputs.id }}"
+        echo "body : ${{ steps.nrt_message.outputs.body }}"
+        echo "html_url : ${{ steps.nrt_message.outputs.html_url }}"
+
+    - name: Exec OpenIM System uninstall
+      run: |
+        sudo ./scripts/install/install.sh -u
+
+    - name: gobenchdata publish
+      uses: bobheadxi/gobenchdata@v1
+      with:
+        PRUNE_COUNT: 30
+        GO_TEST_FLAGS: -cpu 1,2
+        PUBLISH: true
+        PUBLISH_BRANCH: gh-pages
+      env:
+        GITHUB_TOKEN: ${{ secrets.BOT_GITHUB_TOKEN }}
+      continue-on-error: true

.github/workflows/golangci-lint.yml

@@ -23,13 +23,15 @@ jobs:
       name: lint
       runs-on: ubuntu-latest
       steps:
-        - uses: actions/checkout@v3
-        - uses: actions/setup-go@v4
+        - uses: actions/checkout@v4
+        - uses: actions/setup-go@v5
           with:
             go-version: '1.21'
             cache: false
+        - name: OpenIM Scripts Verification(make verify)
+          run: sudo make verify
         - name: golangci-lint
-          uses: golangci/golangci-lint-action@v3.7.0
+          uses: golangci/golangci-lint-action@v4.0.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
@@ -47,4 +49,4 @@ jobs:
             only-new-issues: true
 
             # Optional:The mode to install golangci-lint. It can be 'binary' or 'goinstall'.
-            # install-mode: "goinstall"
+            # install-mode: "goinstall"

.github/workflows/gosec.yml

@@ -37,7 +37,7 @@ jobs:
       GO111MODULE: on
     steps:
       - name: Check out code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Run Gosec Security Scanner
         uses: securego/gosec@master
         with:

.github/workflows/greetings.yml

@@ -12,7 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-name: first-interaction
+name: OpenIM First Interaction
 
 on:
   issues:
@@ -25,8 +25,8 @@ jobs:
   check_for_first_interaction:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/first-interaction@v1.1.1
+      - uses: actions/checkout@v4
+      - uses: actions/first-interaction@v1.3.0
         with:
           repo-token: ${{ secrets.BOT_GITHUB_TOKEN }}
           pr-message: |

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

@@ -17,6 +17,7 @@ on:
   issues:
     types:
       - labeled
+
 jobs:
   add-comment:
     if: github.event.label.name == 'help wanted' || github.event.label.name == 'good first issue'
@@ -25,7 +26,7 @@ jobs:
       issues: write
     steps:
       - name: Add comment
-        uses: peter-evans/create-or-update-comment@v3
+        uses: peter-evans/create-or-update-comment@v4
         with:
           issue-number: ${{ github.event.issue.number }}
           token: ${{ secrets.BOT_GITHUB_TOKEN }}

.github/workflows/issue-robot.yml

@@ -12,7 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-name: 'issue translator'
+name: OpenIM Issue Aotu Translator
 on:
   issue_comment:
     types: [created]

.github/workflows/link-pr.yml

@@ -23,11 +23,11 @@ jobs:
   linkChecker:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - name: Link Checker
         id: lychee
-        uses: lycheeverse/lychee-action@v1.8.0
+        uses: lycheeverse/lychee-action@v1.9.3
         with:
             # For parameter description, see https://github.com/lycheeverse/lychee#commandline-parameters
             # Actions Link address -> https://github.com/lycheeverse/lychee-action
@@ -41,11 +41,11 @@ jobs:
             # ./*.md all markdown files in the root directory
           args: --verbose  -E -i --no-progress --exclude-path './CHANGELOG' './**/*.md'
         env:
-          GITHUB_TOKEN: ${{secrets.GH_PAT}}
+          GITHUB_TOKEN: ${{secrets.BOT_GITHUB_TOKEN}}
 
       - name: Create Issue From File
         if: env.lychee_exit_code != 0
-        uses: peter-evans/create-issue-from-file@v4
+        uses: peter-evans/create-issue-from-file@v5
         with:
           title: Bug reports for links in OpenIM docs
           content-filepath: ./lychee/out.md

.github/workflows/lock-issue.yml

@@ -30,7 +30,7 @@ jobs:
   action:
     runs-on: ubuntu-latest
     steps:
-      - uses: dessant/lock-threads@v4
+      - uses: dessant/lock-threads@v5
         with:
           github-token: ${{ secrets.BOT_GITHUB_TOKEN }}
           issue-inactive-days: '365'

.github/workflows/milestone.yml

@@ -39,7 +39,7 @@ jobs:
       statuses: none
 
     steps:
-      - uses: actions/github-script@v6 # v6
+      - uses: actions/github-script@v7 # v6
         with:
           script: |
             if (!context.payload.pull_request.merged) {

.github/workflows/opencommit.yml

@@ -12,12 +12,13 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-name: 'OpenIM Commit Action'
+name: OpenIM OpenCommit Action
 
 on:
   push:
-    branches:
-      - main
+    # this list of branches is often enough,
+    # but you may still ignore other public branches
+    branches-ignore: [main master dev development release]
 
 jobs:
   opencommit:
@@ -27,20 +28,20 @@ jobs:
     permissions: write-all
     steps:
       - name: Setup Node.js Environment
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version: '16'
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           fetch-depth: 0
       - uses: di-sukharev/opencommit@github-action-v1.0.4
         with:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.BOT_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
+          # for repo secret go to: <your_repo_url>/settings/secrets/actions
           OCO_OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
 
           # customization
@@ -48,5 +49,7 @@ jobs:
           OCO_OPENAI_BASE_PATH: ''
           OCO_DESCRIPTION: false
           OCO_EMOJI: false
-          OCO_MODEL: gpt-3.5-turbo
-          OCO_LANGUAGE: en
+          OCO_MODEL: gpt-3.5-turbo-16k
+          OCO_LANGUAGE: en
+          OCO_PROMPT_MODULE: conventional-commit
+        continue-on-error: true

.github/workflows/openimci.yml

@@ -18,45 +18,48 @@ on:
   push:
     branches:
         - main
+        - release-*
     paths-ignore:
         - "docs/**"
         - "README.md"
         - "README_zh-CN.md"
+        - "**.md"
+        - "docs/**"
         - "CONTRIBUTING.md"
   pull_request:
     branches:
         - main
+        - release-*
     paths-ignore:
         - "README.md"
         - "README_zh-CN.md"
-        - "CONTRIBUTING.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
+        pull-requests: write
     environment:
       name: openim
-
     strategy:
       matrix:
-        go_version: ["1.18","1.19","1.20","1.21"]
+        go_version: ["1.19","1.20","1.21"]
         os: [ubuntu-latest]
-
     steps:
     - name: Setup
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
       
     - name: Set up Go ${{ matrix.go_version }}
-      uses: actions/setup-go@v4
+      uses: actions/setup-go@v5
       with:
         go-version: ${{ matrix.go_version }}
       id: go
@@ -64,7 +67,8 @@ jobs:
     - name: Install Task
       uses: arduino/setup-task@v1
       with:
-        version: 2.x
+        version: '3.x' # If available, use the latest major version that's compatible
+        repo-token: ${{ secrets.GITHUB_TOKEN }}
 
     - name: Module Operations
       run: |
@@ -82,16 +86,14 @@ jobs:
     - name: Build Source
       run: sudo make build
 
+    - name: Build multiarch PLATFORMS
+      if: startsWith(github.ref, 'refs/heads/release-')
+      run: |
+        sudo make multiarch
+
     - name: Cleanup Build
       run: sudo make clean
 
-    - name: Push Changes to Main
-      uses: stefanzweifel/git-auto-commit-action@v4
-      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)"
@@ -108,8 +110,11 @@ jobs:
       continue-on-error: true
 
   openim-start:
-    name: Test OpenIM install/start on ${{ matrix.os }}
+    name: Test OpenIM install/start on ${{ matrix.os }}-${{ matrix.arch }}
     runs-on: ${{ matrix.os }}
+    permissions:
+        contents: write
+        pull-requests: write
     environment:
       name: openim
     strategy:
@@ -118,55 +123,177 @@ jobs:
         os: ["ubuntu-latest"]
     steps:
     - name: Checkout and Install OpenIM
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
     - name: Install Task
       uses: arduino/setup-task@v1
       with:
-        version: 2.x
+        version: '3.x' # If available, use the latest major version that's compatible
+        repo-token: ${{ secrets.GITHUB_TOKEN }}
     - name: Run OpenIM make install start
       run: |
         sudo make install
 
+    # - name: Check the OpenIM environment and status
+    #   run: |
+    #     sudo docker images
+    #     sudo docker ps
+
+    - name: Check the OpenIM environment and status
+      if: runner.os == 'Linux' && matrix.arch == 'amd64'
+      id: docker_info
+      run: |
+        sleep 30
+        echo "images<<EOF" >> $GITHUB_ENV
+        sudo docker images >> $GITHUB_ENV
+        echo "EOF" >> $GITHUB_ENV
+        echo "containers<<EOF" >> $GITHUB_ENV
+        sudo docker ps >> $GITHUB_ENV
+        echo "EOF" >> $GITHUB_ENV
+
+    - name: Comment PR
+      uses: thollander/actions-comment-pull-request@v2
+      if: runner.os == 'Linux' && matrix.arch == 'amd64'
+      with:
+        message: |
+          > [!TIP]
+          > Run make install to check the status
+
+          ### Docker Images:
+          <details><summary>Click to expand docker images</summary>
+          ```bash
+          ${{ env.images }}
+          ```
+          </details>
+
+          ### Docker Processes:
+          <details><summary>Click to expand docker ps</summary>
+          ```bash
+          ${{ env.containers }}
+          ```
+          </details>
+        GITHUB_TOKEN: ${{ secrets.BOT_GITHUB_TOKEN }}
+
   execute-scripts:
-    name: Execute OpenIM script on ${{ matrix.os }}
+    name: Execute OpenIM Script On ${{ matrix.os }}-${{ matrix.arch }}
     runs-on: ${{ matrix.os }}
+    permissions:
+        contents: write
+        pull-requests: write
     environment:
       name: openim
     strategy:
       matrix:
-        go_version: ["1.20"]
-        os: ["ubuntu-latest"]
+        go_version: ["1.21"]
+        os: ["ubuntu-latest", "macos-latest"]
+        arch: [arm64, armv7, amd64]
     steps:
     - name: Checkout code
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
 
     - name: Set up Go ${{ matrix.go_version }}
-      uses: actions/setup-go@v4
+      uses: actions/setup-go@v5
       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.yaml https://raw.githubusercontent.com/OpenIMSDK/openim-docker/main/example/basic-openim-server-dependency.yml
-        sudo docker compose up -d
-        sudo sleep 60
+        version: '3.x' # If available, use the latest major version that's compatible
+        repo-token: ${{ secrets.GITHUB_TOKEN }}
 
-    - name: Module Operations
+    # - name: Install latest Bash (macOS only)
+    #   if: runner.os == 'macOS' && matrix.arch == 'arm64'
+    #   run: |
+    #     /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
+    #     brew update
+    
+    #     brew install bash
+    #     brew install gnu-sed
+    
+    #     echo "/usr/local/bin" >> $GITHUB_PATH
+    #     echo "$(brew --prefix)/opt/gnu-sed/libexec/gnubin" >> $GITHUB_PATH
+    #   continue-on-error: true
+
+    - name: Set up Docker for Ubuntu
+      if: runner.os == 'Linux'
+      run: |
+        sudo make init
+        sudo docker compose up -d
+        sudo sleep 20
+
+    # - name: Set up Docker for macOS
+    #   if: runner.os == 'macOS' && matrix.arch == 'arm64'
+    #   run: |
+    #     brew install --cask docker
+    #     open /Applications/Docker.app
+
+    #     sleep 10
+    #     docker-compose --version || brew install docker-compose
+
+    #     docker-compose up -d
+    #     sleep 20
+
+    - name: Module Operations for Ubuntu
+      if: runner.os == 'Linux'
       run: |
         sudo make tidy
         sudo make tools.verify.go-gitlint
 
-    - name: Build, Start and Check Services
+    # - name: Module Operations for macOS
+    #   if: runner.os == 'macOS'
+    #   run: |
+    #     make tidy
+    #     make tools.verify.go-gitlint
+
+    - name: Build, Start, Check Services and Print Logs for Ubuntu
+      if: runner.os == 'Linux'
       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
+    - name: Restart Services and Print Logs for Ubuntu
+      if: runner.os == 'Linux' && matrix.arch == 'amd64'
+      run: |
+        sudo make restart
+        sudo make check
+
+    - name: Build, Start, Check Services and Print Logs for macOS
+      if: runner.os == 'macOS' && matrix.arch == 'arm64'
+      run: |
+        make build
+
+  openim-test-build-image:
+    name: Build OpenIM Docker Image
+    runs-on: ubuntu-latest
+    permissions:
+        contents: write
+        pull-requests: write
+    environment:
+      name: openim
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v4
+    - name: Set up Go ${{ matrix.go_version }}
+      uses: actions/setup-go@v5
+      with:
+        go-version: ${{ matrix.go_version }}
+      id: go
+
+    - name: Install Task
+      uses: arduino/setup-task@v1
+      with:
+        version: '3.x' # If available, use the latest major version that's compatible
+        repo-token: ${{ secrets.GITHUB_TOKEN }}
+
+    - name: Test Docker Build
+      run: |
+        sudo make init
+        sudo make image
+
+    - name: Get OpenIM Docker Images Status
+      id: docker_processes
+      run: |
+        sudo docker images
+        sudo docker ps

.github/workflows/project-progress.yml

@@ -24,13 +24,16 @@ on:
   pull_request:
     types: 
       - assigned
+    branches-ignore:
+      - 'asf-auto-updates'
+      - 'ignore'
 
 jobs:
   move-assigned-card:
     runs-on: ubuntu-latest
     steps:
-      - uses: alex-page/github-project-automation-plus@v0.8.3
+      - uses: alex-page/github-project-automation-plus@v0.9.0
         with:
           project: openim-powerful
           column: In Progress
-          repo-token: ${{ secrets.BOT_GITHUB_TOKEN }}
+          repo-token: ${{ secrets.BOT_GITHUB_TOKEN }}

.github/workflows/pull-request.yml

@@ -14,12 +14,6 @@
 
 name: Github Pull Request
 on:
-  push:
-    branches: [main]
-    paths-ignore:
-      - 'README.md'
-      - 'CONTRIBUTING.md'
-      - 'docs/**'
   workflow_dispatch:
   schedule:
     - cron: '0 2 * * *'
@@ -33,25 +27,22 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: checkout
-        uses: actions/checkout@v3
+        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
+      - uses: actions/setup-node@v4
       - name: Setup Go
-        uses: actions/setup-go@v4
+        uses: actions/setup-go@v5
       - name: Run go modules tidy
         run: |
+          sudo apt-get install jq
           sudo make tidy
           sudo make tools.verify.go-gitlint
           echo "Run go modules tidy successfully" 
+        continue-on-error: true
 
-      - name: Run go format
+      - name: Run go format and lint
         run: |
           sudo make format
           echo "Run go format successfully" 
@@ -66,7 +57,32 @@ jobs:
       - name: Generate all necessary files, such as error code files
         run: |
           make generate
-          echo "Generate all necessary files successfully" 
+          echo "Generate all necessary files successfully"
+        continue-on-error: true
+
+      - name: make init
+        run: |
+          export OPENIM_IP=127.0.0.1
+          export LOG_STORAGE_LOCATION="../logs/"
+          ./scripts/init-config.sh --examples --force
+          echo "Generate all necessary files successfully"
+        continue-on-error: true
+
+      - name: Generate Vertions
+        run: |
+          latest_tag=$(git describe --tags `git rev-list --tags --max-count=1` | grep -oE '[0-9]+\.[0-9]+\.[0-9]+')
+          echo $latest_tag > pkg/common/config/version
+        continue-on-error: true
+
+      - name: Gen CHANGELOG file
+        run: |
+          current_tag=$(git describe --tags --abbrev=0)
+          version=$(echo "$current_tag" | sed -E 's/^v?([0-9]+)\.([0-9]+)\..*$/\1.\2/')
+          echo "OpenIM Version: $version"
+          make tools.install.git-chglog
+          cd CHANGELOG
+          git-chglog --tag-filter-pattern "v${version}.*" -o CHANGELOG-${version}.md
+          cd ..
         continue-on-error: true
 
       - name: Run unit test and get test coverage
@@ -75,48 +91,39 @@ jobs:
           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
+        uses: peter-evans/create-pull-request@v6
         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 }}"
+          commit-message: "cicd: bump League Patch"
+          author: kubbot <3293172751ysy@gmail.com>
+          committer: kubbot <3293172751ysy@gmail.com>
+        #   signoff: false
+        #   draft: false
+          branch: "asf-auto-updates"
           assignees: cubxxw
           reviewers: cubxxw
-          delete-branch: true
+          title: "[Auto PR 🤖] Bump League Patch auto PR"
           body: |
+            I am a PR generated by robot automation.
+
             Review criteria:
 
             - [ ] Disenchanter can connect and issue actions
+
+            Github Actions Status:
+
+            [![Github Pull Request](https://github.com/openimsdk/open-im-server/actions/workflows/pull-request.yml/badge.svg)](https://github.com/openimsdk/open-im-server/actions/workflows/pull-request.yml)
             
-            This is an automated PR. @ ${{ github.actor }}
+            This is an automated PR. 
             <sub>[workflow](https://github.com/openimsdk/open-im-server/blob/main/.github/workflows/pull-request.yml).</sub>
-          base: main
           labels: |
             kind/documentation
             enhancement
-            report
+            report

.github/workflows/release-drafter.yml

@@ -46,7 +46,7 @@ jobs:
       #    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
+      - uses: release-drafter/release-drafter@v6
         # (Optional) specify config name to use, relative to .github/. Default: release-drafter.yml
         # with:
         #   config-name: my-config.yml

.github/workflows/release.yml

@@ -29,16 +29,16 @@ jobs:
   goreleaser:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           fetch-depth: 0
       - run: git fetch --force --tags
-      - uses: actions/setup-go@v4
+      - uses: actions/setup-go@v5
         with:
           go-version: stable
       # More assembly might be required: Docker logins, GPG, etc. It all depends
       # on your needs.
-      - uses: goreleaser/goreleaser-action@v4
+      - uses: goreleaser/goreleaser-action@v5
         with:
           # either 'goreleaser' (default) or 'goreleaser-pro':
           distribution: goreleaser
@@ -63,15 +63,15 @@ jobs:
       matrix:
         format: [ deb, rpm, apk ]
     steps:
-      - uses: actions/checkout@v3 # v3
+      - 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@2b82ce82d56a2a04d2637cd93a637ae1b359c0a7 # v2
-      - uses: actions/cache@88522ab9f39a2ea568f7027eddc7d8d8bc9d59c8 # v3
+      - uses: docker/setup-qemu-action@326560df218a7ea9cf6ab49bbc88b8b306bb437e # v2
+      - uses: actions/cache@a2ed59d39b352305bdd2f628719a53b2cc4f9613 # v3
         with:
           path: |
             ./_output/dist/*.deb

.github/workflows/scripts-verify.yml

@@ -1,76 +0,0 @@
-# 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@v3
-      
-    - 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

@@ -32,7 +32,7 @@ jobs:
       pull-requests: write
 
     steps:
-    - uses: actions/stale@v8
+    - uses: actions/stale@v9
       with:
         repo-token: ${{ secrets.BOT_GITHUB_TOKEN }}
         days-before-stale: 60

.github/workflows/sync-release.yml

@@ -3,7 +3,7 @@
 # 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
+name: Synchronize OpenIM Release Branch Public Code To Other Repositories
 on:
     push:
         paths:
@@ -19,7 +19,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Run GitHub File Sync
         uses: BetaHuhn/repo-file-sync-action@latest
@@ -41,3 +41,4 @@ jobs:
             automerge
           ASSIGNEES: |
             kubbot
+        continue-on-error: true

.github/workflows/sync.yml

@@ -3,7 +3,7 @@
 # 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
+name: Synchronize OpenIM Main Branch Public Code To Other Repositories
 on:
     push:
         branches:
@@ -15,7 +15,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Run GitHub File Sync
         uses: BetaHuhn/repo-file-sync-action@latest
@@ -36,4 +36,5 @@ jobs:
             file-sync
             automerge
           ASSIGNEES: |
-            kubbot
+            kubbot
+        continue-on-error: true

.gitignore

@@ -29,26 +29,20 @@ tmp/
 bin/
 output/
 _output/
+deployments/charts/generated-configs/
 
 ### OpenIM Config ###
-config/config.yaml
-./config/config.yaml
 .env
-./.env
+config/config.yaml
+config/openim.yaml
+config/alertmanager.yml
+config/prometheus.yml
+config/email.tmpl
+config/notification.yaml
+config/instance-down-rules.yml
 
 ### 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
+deployments/openim-server/charts
 
 # files used by the developer
 .idea.md
@@ -160,7 +154,6 @@ flycheck_*.el
 
 # Dependency directories (remove the comment below to include it)
 vendor/
-tools/imctl
 
 # Go workspace file
 # go.work
@@ -399,6 +392,4 @@ Sessionx.vim
 
 # End of https://www.toptal.com/developers/gitignore/api/go,git,vim,tags,test,emacs,backup,jetbrains
 .idea
-dist/
-.env
-config/config.yaml
+dist/

.golangci.yml

@@ -40,10 +40,14 @@ run:
   # "/" will be replaced by current OS file path separator to properly work
   # on Windows.
   skip-dirs:
+    - components
+    - docs
     - util
     - .*~
     - api/swagger/docs
     - server/docs
+    - components/mnt/config/certs
+    - logs
 
   # default is true. Enables skipping of directories:
   #   vendor$, third_party$, testdata$, examples$, Godeps$, builtin$
@@ -58,6 +62,12 @@ run:
   skip-files:
     - ".*\\.my\\.go$"
     - _test.go
+    - ".*_test.go"
+    - "mocks/"
+    - ".github/"
+    - "logs/"
+    - "_output/"
+    - "components/"
 
   # 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
@@ -108,7 +118,6 @@ linters-settings:
     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:
@@ -131,8 +140,8 @@ linters-settings:
 
     # 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
-    
+    # exclude: errcheck.txt
+
   errorlint:
     # Check whether fmt.Errorf uses the %w verb for formatting errors. See the readme for caveats
     errorf: true
@@ -171,7 +180,7 @@ linters-settings:
   #   exclude_godoc_examples: false
   funlen:
     lines: 150
-    statements: 50
+    statements: 80
   gci:
     # put imports beginning with prefix after 3rd-party packages;
     # only support one prefix
@@ -361,13 +370,17 @@ linters-settings:
         - 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:
@@ -414,7 +427,7 @@ linters-settings:
 
   govet:
     # report about shadowed variables
-    check-shadowing: true
+    check-shadowing: false
 
     # settings per analyzer
     settings:
@@ -485,9 +498,9 @@ linters-settings:
     - github.com\/user\/package\/v4\.Type
 
   lll:
-    # max line length, lines longer will be reported. Default is 120.
+    # max line length, lines longer will be reported. Default is 250.
     # '\t' is counted as 1 character by default, and can be changed with the tab-width option
-    line-length: 240
+    line-length: 250
     # tab width in spaces. Default to 1.
     tab-width: 4
   maligned:
@@ -711,83 +724,34 @@ linters:
   # enable-all: true
   disable-all: true
   enable:
-    - typecheck
-    - asciicheck
-    - bodyclose
-    - cyclop
-    # - depguard
-    - dogsled
-    - dupl
-    - durationcheck
+    - typecheck     # Basic type checking
+    - gofmt         # Format check
+    - govet         # Go's standard linting tool
+    - gosimple      # Suggestions for simplifying code
     - errcheck
-    - errorlint
-    - exhaustive
-    - exportloopref
-    # - forbidigo
-    - funlen
-    # - gci
-    # - gochecknoinits
-    - gocognit
-    - goconst
-    - gocyclo
-    - godot
-    - godox
-    - gofmt
-    - gofumpt
-    - goheader
-    - goimports
-    - gomoddirectives
-    - gomodguard
-    - goprintffuncname
-    - gosec
-    - gosimple
-    - govet
-    - importas
+    - decorder
     - ineffassign
-    - lll
-    - makezero
-    - misspell
-    - nakedret
-    - nestif
-    - nilerr
-    - nlreturn
-    - noctx
-    - nolintlint
-    - paralleltest
-    - prealloc
-    - predeclared
-    - promlinter
     - revive
-    - rowserrcheck
-    - sqlclosecheck
-    - staticcheck
-    - stylecheck
-    - thelper
+    - reassign
     - 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
+    - dupl
+    - dupword
+    - errname
+    - gci
+    - goheader
+    - goprintffuncname
+    - gosec
+    - misspell      # Spelling mistakes
+    - staticcheck   # Static analysis
+    - unused        # Checks for unused code
+    - goimports     # Checks if imports are correctly sorted and formatted
+    - godot         # Checks for comment punctuation
+    - bodyclose     # Ensures HTTP response body is closed
+    - stylecheck    # Style checker for Go code
+    - unused        # Checks for unused code
+    - errcheck      # Checks for missed error returns
+  fast: true
 
 issues:
   # List of regexps of issue texts to exclude, empty list by default.
@@ -853,6 +817,11 @@ issues:
         - lll
       source: "^//go:generate "
 
+    - text: ".*[\u4e00-\u9fa5]+.*"
+      linters:
+        - golint
+      source: "^//.*$"
+
   # 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`.
@@ -913,4 +882,4 @@ severity:
   rules:
     - linters:
       - dupl
-      severity: info
+      severity: info

CHANGELOG/CHANGELOG-3.1.md

@@ -8,24 +8,6 @@
 ## [Unreleased]
 
 
-<a name="v3.1.3-beta.1"></a>
-## [v3.1.3-beta.1] - 2023-08-14
-
-<a name="v3.1.3"></a>
-## [v3.1.3] - 2023-08-14
-
-<a name="v3.1.2-beta.3"></a>
-## [v3.1.2-beta.3] - 2023-08-09
-
-<a name="v3.1.2-beta.2"></a>
-## [v3.1.2-beta.2] - 2023-08-09
-
-<a name="v3.1.2-beta.1"></a>
-## [v3.1.2-beta.1] - 2023-08-09
-
-<a name="v3.1.2-beta.0"></a>
-## [v3.1.2-beta.0] - 2023-08-08
-
 <a name="v3.1.0"></a>
 ## v3.1.0 - 2023-07-28
 ### Reverts
@@ -35,10 +17,4 @@
 - Merge branch 'tuoyun'
 
 
-[Unreleased]: https://github.com/openimsdk/open-im-server/compare/v3.1.3-beta.1...HEAD
-[v3.1.3-beta.1]: https://github.com/openimsdk/open-im-server/compare/v3.1.3...v3.1.3-beta.1
-[v3.1.3]: https://github.com/openimsdk/open-im-server/compare/v3.1.2-beta.3...v3.1.3
-[v3.1.2-beta.3]: https://github.com/openimsdk/open-im-server/compare/v3.1.2-beta.2...v3.1.2-beta.3
-[v3.1.2-beta.2]: https://github.com/openimsdk/open-im-server/compare/v3.1.2-beta.1...v3.1.2-beta.2
-[v3.1.2-beta.1]: https://github.com/openimsdk/open-im-server/compare/v3.1.2-beta.0...v3.1.2-beta.1
-[v3.1.2-beta.0]: https://github.com/openimsdk/open-im-server/compare/v3.1.0...v3.1.2-beta.0
+[Unreleased]: https://github.com/openimsdk/open-im-server/compare/v3.1.0...HEAD

CHANGELOG/CHANGELOG-3.2.md

@@ -8,39 +8,15 @@
 ## [Unreleased]
 
 
-<a name="v3.2.2"></a>
-## [v3.2.2] - 2023-09-03
-
-<a name="v3.2.3"></a>
-## [v3.2.3] - 2023-09-03
-
-<a name="v3.2.1"></a>
-## [v3.2.1] - 2023-09-03
-
-<a name="v3.2.2-beta.4"></a>
-## [v3.2.2-beta.4] - 2023-08-28
-
 <a name="v3.2.2-alpha.0"></a>
 ## [v3.2.2-alpha.0] - 2023-08-25
 
-<a name="v3.2.2-beta.3"></a>
-## [v3.2.2-beta.3] - 2023-08-22
-
-<a name="v3.2.2-beta.2"></a>
-## [v3.2.2-beta.2] - 2023-08-21
-
-<a name="v3.2.2-beta.1"></a>
-## [v3.2.2-beta.1] - 2023-08-19
-
 <a name="v3.2.0"></a>
-## [v3.2.0] - 2023-08-18
+## [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.2-beta.0"></a>
-## [v3.2.2-beta.0] - 2023-08-17
-
 <a name="v3.2.0-alpha.0"></a>
 ## v3.2.0-alpha.0 - 2023-08-16
 ### Reverts
@@ -50,15 +26,7 @@
 - Merge branch 'tuoyun'
 
 
-[Unreleased]: https://github.com/openimsdk/open-im-server/compare/v3.2.2...HEAD
-[v3.2.2]: https://github.com/openimsdk/open-im-server/compare/v3.2.3...v3.2.2
-[v3.2.3]: https://github.com/openimsdk/open-im-server/compare/v3.2.1...v3.2.3
-[v3.2.1]: https://github.com/openimsdk/open-im-server/compare/v3.2.2-beta.4...v3.2.1
-[v3.2.2-beta.4]: https://github.com/openimsdk/open-im-server/compare/v3.2.2-alpha.0...v3.2.2-beta.4
-[v3.2.2-alpha.0]: https://github.com/openimsdk/open-im-server/compare/v3.2.2-beta.3...v3.2.2-alpha.0
-[v3.2.2-beta.3]: https://github.com/openimsdk/open-im-server/compare/v3.2.2-beta.2...v3.2.2-beta.3
-[v3.2.2-beta.2]: https://github.com/openimsdk/open-im-server/compare/v3.2.2-beta.1...v3.2.2-beta.2
-[v3.2.2-beta.1]: https://github.com/openimsdk/open-im-server/compare/v3.2.0...v3.2.2-beta.1
+[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.2-beta.0...v3.2.0-rc.0
-[v3.2.2-beta.0]: https://github.com/openimsdk/open-im-server/compare/v3.2.0-alpha.0...v3.2.2-beta.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-3.4.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.4.2"></a>
+## [v3.4.2] - 2023-12-14
+
+<a name="v3.4.0"></a>
+## [v3.4.0] - 2023-11-10
+
+<a name="v3.4.0-rc.1"></a>
+## [v3.4.0-rc.1] - 2023-11-09
+
+<a name="v3.4.0-rc.0"></a>
+## v3.4.0-rc.0 - 2023-11-09
+### 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.4.2...HEAD
+[v3.4.2]: https://github.com/openimsdk/open-im-server/compare/v3.4.0...v3.4.2
+[v3.4.0]: https://github.com/openimsdk/open-im-server/compare/v3.4.0-rc.1...v3.4.0
+[v3.4.0-rc.1]: https://github.com/openimsdk/open-im-server/compare/v3.4.0-rc.0...v3.4.0-rc.1

CHANGELOG/CHANGELOG-3.5.md

@@ -0,0 +1,84 @@
+# Version logging for OpenIM
+
+<!-- BEGIN MUNGE: GENERATED_TOC -->
+
+<!-- END MUNGE: GENERATED_TOC -->
+
+<a name="unreleased"></a>
+## [Unreleased]
+
+
+<a name="v3.5.1-alpha.2"></a>
+## [v3.5.1-alpha.2] - 2024-01-26
+
+<a name="v3.5.1-rc.1"></a>
+## [v3.5.1-rc.1] - 2024-01-23
+
+<a name="v3.5.1-alpha.1"></a>
+## [v3.5.1-alpha.1] - 2024-01-09
+
+<a name="v3.5.0"></a>
+## [v3.5.0] - 2024-01-02
+
+<a name="v3.5.1"></a>
+## [v3.5.1] - 2024-01-02
+
+<a name="v3.5.1-bate.1"></a>
+## [v3.5.1-bate.1] - 2024-01-02
+
+<a name="v3.5.1-rc.0"></a>
+## [v3.5.1-rc.0] - 2023-12-30
+
+<a name="v3.5.0-rc.8"></a>
+## [v3.5.0-rc.8] - 2023-12-28
+
+<a name="v3.5.0-rc.7"></a>
+## [v3.5.0-rc.7] - 2023-12-18
+
+<a name="v3.5.0-rc.6"></a>
+## [v3.5.0-rc.6] - 2023-12-15
+
+<a name="v3.5.0-rc.5"></a>
+## [v3.5.0-rc.5] - 2023-12-15
+
+<a name="v3.5.0-rc.4"></a>
+## [v3.5.0-rc.4] - 2023-12-14
+
+<a name="v3.5.0-rc.3"></a>
+## [v3.5.0-rc.3] - 2023-12-14
+
+<a name="v3.5.0-rc.2"></a>
+## [v3.5.0-rc.2] - 2023-12-14
+
+<a name="v3.5.0-rc.1"></a>
+## [v3.5.0-rc.1] - 2023-12-14
+
+<a name="v3.5.0-rc.0"></a>
+## [v3.5.0-rc.0] - 2023-12-14
+
+<a name="v3.5.0-beta.1"></a>
+## v3.5.0-beta.1 - 2023-11-29
+### 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.5.1-alpha.2...HEAD
+[v3.5.1-alpha.2]: https://github.com/openimsdk/open-im-server/compare/v3.5.1-rc.1...v3.5.1-alpha.2
+[v3.5.1-rc.1]: https://github.com/openimsdk/open-im-server/compare/v3.5.1-alpha.1...v3.5.1-rc.1
+[v3.5.1-alpha.1]: https://github.com/openimsdk/open-im-server/compare/v3.5.0...v3.5.1-alpha.1
+[v3.5.0]: https://github.com/openimsdk/open-im-server/compare/v3.5.1...v3.5.0
+[v3.5.1]: https://github.com/openimsdk/open-im-server/compare/v3.5.1-bate.1...v3.5.1
+[v3.5.1-bate.1]: https://github.com/openimsdk/open-im-server/compare/v3.5.1-rc.0...v3.5.1-bate.1
+[v3.5.1-rc.0]: https://github.com/openimsdk/open-im-server/compare/v3.5.0-rc.8...v3.5.1-rc.0
+[v3.5.0-rc.8]: https://github.com/openimsdk/open-im-server/compare/v3.5.0-rc.7...v3.5.0-rc.8
+[v3.5.0-rc.7]: https://github.com/openimsdk/open-im-server/compare/v3.5.0-rc.6...v3.5.0-rc.7
+[v3.5.0-rc.6]: https://github.com/openimsdk/open-im-server/compare/v3.5.0-rc.5...v3.5.0-rc.6
+[v3.5.0-rc.5]: https://github.com/openimsdk/open-im-server/compare/v3.5.0-rc.4...v3.5.0-rc.5
+[v3.5.0-rc.4]: https://github.com/openimsdk/open-im-server/compare/v3.5.0-rc.3...v3.5.0-rc.4
+[v3.5.0-rc.3]: https://github.com/openimsdk/open-im-server/compare/v3.5.0-rc.2...v3.5.0-rc.3
+[v3.5.0-rc.2]: https://github.com/openimsdk/open-im-server/compare/v3.5.0-rc.1...v3.5.0-rc.2
+[v3.5.0-rc.1]: https://github.com/openimsdk/open-im-server/compare/v3.5.0-rc.0...v3.5.0-rc.1
+[v3.5.0-rc.0]: https://github.com/openimsdk/open-im-server/compare/v3.5.0-beta.1...v3.5.0-rc.0

CHANGELOG/CHANGELOG.md

@@ -20,7 +20,7 @@ All notable changes to this project will be documented in this file.
 
 ## OpenIM versioning policy
 
-+ [OpenIM Version](../docs/conversions/version.md)
++ [OpenIM Version](../docs/contrib/version.md)
 
 ## command
 
@@ -89,9 +89,9 @@ $ git-chglog --config custom/dir/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
+$ 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                     |
@@ -112,6 +112,9 @@ git tag 2.0.0
 + [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
 
@@ -121,7 +124,7 @@ In both the open-source and closed-source software development communities, it i
 
 The most common format for version numbers is as follows:
 
-```
+```bash
 major.minor[.patch[.build]]
 ```
 

CODE_OF_CONDUCT.md

@@ -60,7 +60,7 @@ representative at an online or offline event.
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
 reported to the community leaders responsible for enforcement at
-3293172751nss@gmail.com.
+`security@openim.io`.
 All complaints will be reviewed and investigated promptly and fairly.
 
 All community leaders are obligated to respect the privacy and security of the

CONTRIBUTING-zh_CN.md

@@ -0,0 +1,33 @@
+# How do I contribute code to OpenIM
+
+<p align="center">
+  <a href="./CONTRIBUTING.md">Englist</a> · 
+  <a href="./CONTRIBUTING-zh_CN.md">中文</a> · 
+  <a href="docs/contributing/CONTRIBUTING-UA.md">Українська</a> · 
+  <a href="docs/contributing/CONTRIBUTING-CS.md">Česky</a> · 
+  <a href="docs/contributing/CONTRIBUTING-HU.md">Magyar</a> · 
+  <a href="docs/contributing/CONTRIBUTING-ES.md">Español</a> · 
+  <a href="docs/contributing/CONTRIBUTING-FA.md">فارسی</a> · 
+  <a href="docs/contributing/CONTRIBUTING-FR.md">Français</a> · 
+  <a href="docs/contributing/CONTRIBUTING-DE.md">Deutsch</a> · 
+  <a href="docs/contributing/CONTRIBUTING-PL.md">Polski</a> · 
+  <a href="docs/contributing/CONTRIBUTING-ID.md">Indonesian</a> · 
+  <a href="docs/contributing/CONTRIBUTING-FI.md">Suomi</a> · 
+  <a href="docs/contributing/CONTRIBUTING-ML.md">മലയാളം</a> · 
+  <a href="docs/contributing/CONTRIBUTING-JP.md">日本語</a> · 
+  <a href="docs/contributing/CONTRIBUTING-NL.md">Nederlands</a> · 
+  <a href="docs/contributing/CONTRIBUTING-IT.md">Italiano</a> · 
+  <a href="docs/contributing/CONTRIBUTING-RU.md">Русский</a> · 
+  <a href="docs/contributing/CONTRIBUTING-PTBR.md">Português (Brasil)</a> · 
+  <a href="docs/contributing/CONTRIBUTING-EO.md">Esperanto</a> · 
+  <a href="docs/contributing/CONTRIBUTING-KR.md">한국어</a> · 
+  <a href="docs/contributing/CONTRIBUTING-AR.md">العربي</a> · 
+  <a href="docs/contributing/CONTRIBUTING-VN.md">Tiếng Việt</a> · 
+  <a href="docs/contributing/CONTRIBUTING-DA.md">Dansk</a> · 
+  <a href="docs/contributing/CONTRIBUTING-GR.md">Ελληνικά</a> · 
+  <a href="docs/contributing/CONTRIBUTING-TR.md">Türkçe</a>
+</p>
+
+</div>
+
+</p>

CONTRIBUTING.md

@@ -1,6 +1,38 @@
-#  Contributing to Open-IM-Server
+# How do I contribute code to OpenIM
 
-So, you want to hack on Open-IM-Server? Yay!
+<p align="center">
+  <a href="./CONTRIBUTING.md">Englist</a> · 
+  <a href="./CONTRIBUTING-zh_CN.md">中文</a> · 
+  <a href="docs/contributing/CONTRIBUTING-UA.md">Українська</a> · 
+  <a href="docs/contributing/CONTRIBUTING-CS.md">Česky</a> · 
+  <a href="docs/contributing/CONTRIBUTING-HU.md">Magyar</a> · 
+  <a href="docs/contributing/CONTRIBUTING-ES.md">Español</a> · 
+  <a href="docs/contributing/CONTRIBUTING-FA.md">فارسی</a> · 
+  <a href="docs/contributing/CONTRIBUTING-FR.md">Français</a> · 
+  <a href="docs/contributing/CONTRIBUTING-DE.md">Deutsch</a> · 
+  <a href="docs/contributing/CONTRIBUTING-PL.md">Polski</a> · 
+  <a href="docs/contributing/CONTRIBUTING-ID.md">Indonesian</a> · 
+  <a href="docs/contributing/CONTRIBUTING-FI.md">Suomi</a> · 
+  <a href="docs/contributing/CONTRIBUTING-ML.md">മലയാളം</a> · 
+  <a href="docs/contributing/CONTRIBUTING-JP.md">日本語</a> · 
+  <a href="docs/contributing/CONTRIBUTING-NL.md">Nederlands</a> · 
+  <a href="docs/contributing/CONTRIBUTING-IT.md">Italiano</a> · 
+  <a href="docs/contributing/CONTRIBUTING-RU.md">Русский</a> · 
+  <a href="docs/contributing/CONTRIBUTING-PTBR.md">Português (Brasil)</a> · 
+  <a href="docs/contributing/CONTRIBUTING-EO.md">Esperanto</a> · 
+  <a href="docs/contributing/CONTRIBUTING-KR.md">한국어</a> · 
+  <a href="docs/contributing/CONTRIBUTING-AR.md">العربي</a> · 
+  <a href="docs/contributing/CONTRIBUTING-VN.md">Tiếng Việt</a> · 
+  <a href="docs/contributing/CONTRIBUTING-DA.md">Dansk</a> · 
+  <a href="docs/contributing/CONTRIBUTING-GR.md">Ελληνικά</a> · 
+  <a href="docs/contributing/CONTRIBUTING-TR.md">Türkçe</a>
+</p>
+
+</div>
+
+</p>
+
+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.
 
@@ -12,7 +44,7 @@ This document provides guidelines and best practices to help you contribute effe
 
 ## 📇Topics
 
-- [Contributing to Open-IM-Server](#contributing-to-open-im-server)
+- [How do I contribute code to OpenIM](#how-do-i-contribute-code-to-openim)
   - [📇Topics](#topics)
   - [What we expect of you](#what-we-expect-of-you)
   - [Code of ConductCode of Conduct](#code-of-conductcode-of-conduct)
@@ -32,21 +64,27 @@ This document provides guidelines and best practices to help you contribute effe
 
 ## What we expect of you
 
-We hope that anyone can join Open-IM-Server , even if you are a student, writer, translator
+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)
+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 tHow do I contribute code to OpenIMo 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.
+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.
+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.
 
+In accordance with the naming conventions adopted by OpenIM and drawing reference from the Google Naming Conventions as per the guidelines available at https://google.github.io/styleguide/go/, the following expectations for naming practices within the project are set forth: 
+
++ https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/code-conventions.md
++ https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/go-code.md
+
+
 ## 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).
+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!
@@ -61,8 +99,8 @@ Every action to make project Open-IM-Server better is encouraged. On GitHub, eve
 
 #### 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 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.
 
@@ -79,7 +117,7 @@ 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:
+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.
@@ -89,13 +127,27 @@ But keep in mind that there is no guarantee of it being accepted and so it is us
 
 ## 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:
+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)
+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.
+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:
+3. **Initialize Git Hooks with `make init-githooks`**
+
+   After cloning the repository, it's recommended to set up Git hooks to streamline your workflow and ensure your contributions adhere to OpenIM's community standards. Git hooks are scripts that run automatically every time a particular event occurs in a Git repository, such as before a commit or push. To initialize Git hooks for the OpenIM server repository, use the `make init-githooks` command.
+
+   - **Enabling Git Hooks Mode**: By running `make init-githooks` and entering `1` when prompted, you enable Git hooks mode. This action will generate a series of hooks within the `.git/hooks/` directory. These hooks impose certain checks on your commits and pushes, ensuring they meet the quality and standards expected by the OpenIM community. For instance, commit hooks might enforce a specific commit message format, while push hooks could check for code style or linting issues.
+
+   - **Benefits for First-Time Contributors**: This setup is especially beneficial for new contributors. It guides you to make professional, community-standard-compliant Pull Requests (PRs) and PR descriptions right from your first contribution. By automating checks and balances, it reduces the chances of common mistakes and speeds up the review process.
+
+   - **Disabling Git Hooks**: If for any reason you wish to remove the Git hooks, simply run `make init-githooks` again and enter `2` when prompted. This will delete the existing Git hooks, removing the automatic checks and constraints from your Git operations. However, keep in mind that manually ensuring your contributions adhere to community standards without the aid of Git hooks requires diligence.
+ 
+   > [!NOTE] Utilizing Git hooks through the `make init-githooks` command is a straightforward yet powerful way to ensure your contributions are consistent and high-quality. It's a step towards fostering a professional and efficient development environment in the OpenIM project.
+
+
+
+4. **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
@@ -106,18 +158,18 @@ To propose PR for the Open-IM-Server item, we assume you have registered a GitHu
 
    ```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)
+   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`).
+5. 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
+   ❯ cd open-im-server
    ❯ git fetch upstream
    ❯ git checkout upstream/main
    ```
@@ -130,7 +182,8 @@ To propose PR for the Open-IM-Server item, we assume you have registered a GitHu
 
    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
+
+6. **Commit your changes** to your local branch, lint before committing and commit with sign-off
 
    ```bash
    ❯ git rebase upstream/main
@@ -139,7 +192,7 @@ To propose PR for the Open-IM-Server item, we assume you have registered a GitHu
    ❯ 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.
+7. **Push your branch**  to your forked repository, it is recommended to have only one commit for a PR.
 
    ```bash
    # sync up with upstream
@@ -171,12 +224,78 @@ To propose PR for the Open-IM-Server item, we assume you have registered a GitHu
    ❯ 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`
+    **Verifying Your Pull Request with `make all` Command**
+
+   Before verifying, you may need to complete the basic deployment of OpenIM to get familiar with the deployment status of OpenIM. Please read [this deployment document](https://docs.openim.io/zh-Hans/guides/gettingStarted/imSourceCodeDeployment), which will tell you how to deploy OpenIM middleware and OpenIM services in detail
+
+   Before submitting your Pull Request (PR), it's crucial to ensure that it passes all the necessary checks and verifications to maintain the quality and integrity of the OpenIM server project. To facilitate this process, we have encapsulated a series of validation steps into the `make all` command.
+
+   - **Purpose of `make all` Command**: The `make all` command serves as a comprehensive pre-PR verification tool. It sequentially executes a variety of tasks designed to scrutinize your changes from multiple angles, ensuring they are ready for submission.
+
+   - **Included Commands**:
+     - `tidy`: Cleans up the module by removing unused dependencies.
+     - `gen`: Generates necessary files from templates or specifications, ensuring that your codebase is up-to-date with its dependencies.
+     - `add-copyright`: Checks for and adds copyright notices to files, ensuring compliance with legal requirements.
+     - `verify`: Verifies the integrity and consistency of the code, dependencies, and various checks.
+     - `test-api`: Runs API tests to ensure that your changes do not break any existing functionality and adhere to the expected behaviors.
+     - `lint`: Analyzes the code for potential stylistic or programming errors, enforcing the project's coding standards.
+     - `cover`: Measures the code coverage of tests, helping you understand how much of the code is being tested.
+     - `restart`: (Optionally) restarts services or applications to ensure that changes are correctly applied and functioning in a live environment.
+
+   - **Executing the Command**: To run the `make all` command, simply navigate to the root directory of your cloned repository in your terminal and execute:
+     ```bash
+     make all
+     ```
+     This command will sequentially perform all the listed actions, outputting any warnings or errors encountered during the process. It's a vital step to catch any issues early and ensure your contribution meets the quality standards set by the OpenIM community.
+
+   - **Benefits**: By using `make all` for pre-PR verification, you significantly increase the likelihood of your PR being accepted on the first review. It not only demonstrates your commitment to quality but also streamlines the review process by minimizing back-and-forth due to common issues that can be caught automatically.
+
+
+    **Troubleshooting Git Push Failures**
+
+    When working with Git, encountering errors during push operations is not uncommon. Two primary reasons you might face push failures are due to firewall restrictions or authentication issues. Here’s how you can troubleshoot and resolve these problems.
+
+    **Firewall Errors**
+
+    If you're behind a corporate firewall or your network restricts certain types of traffic, you might encounter issues when trying to push your changes via HTTPS. This is because firewalls can block the ports used by the HTTPS protocol. To resolve this issue, you can configure Git to use a proxy.
+
+    If you have a local proxy server set up, you can direct Git to use it by setting the `https_proxy` and `http_proxy` environment variables. Open your terminal or command prompt and run the following commands:
+
+    ```bash
+    export https_proxy="http://127.0.0.1:7890"
+    export http_proxy="http://127.0.0.1:7890"
+    ```
+
+    Replace `127.0.0.1:7890` with the address and port of your proxy server. These commands set the proxy for the current session. If you want to make these changes permanent, add them to your `.bashrc`, `.bash_profile`, or equivalent shell configuration file.
+
+    **Using SSH Instead of HTTPS**
+
+    An alternative to using HTTPS is to set up an SSH connection for Git operations. SSH connections are often not blocked by firewalls and do not require proxy settings. Additionally, SSH provides a secure channel and can simplify the authentication process since it relies on SSH keys rather than username and password credentials.
+
+    To use SSH with Git, you first need to generate an SSH key pair and add the public key to your GitHub account (or another Git hosting service).
+
+    1. **Generate SSH Key Pair**: Open your terminal and run `ssh-keygen -t rsa -b 4096 -C "your_email@example.com"`, replacing `your_email@example.com` with your email. Press enter to accept the default file location and passphrase prompts.
+
+    2. **Add SSH Key to SSH-Agent**: Ensure the ssh-agent is running with `eval "$(ssh-agent -s)"` and then add your SSH private key to the ssh-agent using `ssh-add ~/.ssh/id_rsa`.
+
+    3. **Add SSH Key to GitHub**: Copy your SSH public key to your clipboard with `cat ~/.ssh/id_rsa.pub | clip` (Windows) or `pbcopy < ~/.ssh/id_rsa.pub` (Mac). Go to GitHub, navigate to Settings > SSH and GPG keys, and add a new SSH key, pasting your key into the field provided.
+
+    4. **Switch to SSH in Your Repository**: Change your repository's remote URL from HTTPS to SSH. You can find the SSH URL in your repository settings on GitHub and use `git remote set-url origin git@github.com:username/repository.git` to switch.
+
+    **Authentication Errors**
+
+    If you're experiencing authentication errors, it might be due to missing or incorrect credentials. Ensure you have added your SSH key to your Git hosting service. You can test your SSH connection with `ssh -T git@github.com` (replace `github.com` with your Git hosting service's domain). If successful, you'll receive a welcome message.
+
+    For HTTPS users, check that your username and password (or personal access token for services like GitHub that no longer accept password authentication for Git operations) are correct.
+
+8. **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.
+   
+   > [!TIP] There is a [good blog post documenting](https://nsddd.top/posts/participating-in-this-project/) the entire push contribution process.
+
 
 ## Style and Specification
 
@@ -184,15 +303,15 @@ 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.
+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.
+Instead we encourage you to send us a private email to info@openim.io 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).
+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.
+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.
 
@@ -200,20 +319,20 @@ To make the issue details as standard as possible, we setup an [ISSUE TEMPLATE](
 
 + bug report
 + feature request
-+ Open-IM-Server performance issues 
++ open-im-server performance issues 
 + feature proposal
 + feature design
 + help wanted
 + doc incomplete
 + test improvement
-+ any questions on Open-IM-Server project 
++ 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.
+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:
+Actually in open-im-server, we take two rules serious when committing:
 
 **🥇 Commit Message:**
 
@@ -256,7 +375,7 @@ An example for this could be:
 
 #### 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.
+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.
 
@@ -270,7 +389,7 @@ You can find some very formal PR in [RFC](https://github.com/openimsdk/open-im-s
 **🈴 Reviewing PRs:**
 
 + Be respectful and constructive 
-+ Assign yourself to the PR 
++ Assign yourself to the PR (comment `/assign`)
 + Check if all checks are passing
 + Suggest changes instead of simply commenting on found issues
 + If you are unsure about something, ask the author
@@ -305,11 +424,11 @@ git() {
 
 #### Docs Contribution
 
-The documentation for Open-IM-Server includes:
+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.
++ [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.
 
@@ -322,20 +441,20 @@ Please obey the following rules to better format the docs, which would greatly i
 
 ## 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.
+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.
++ 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:
+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:
 
@@ -360,17 +479,23 @@ Such a commit can get produced as follows:
 ❯ git commit --allow-empty -m "chore: release 0.0.3" -m "Release-As: 0.0.3
 ````
 
+For the complex release process, in fact, and encapsulation as CICD, you only need to tag locally, and then publish the tag to OpenIM github to complete the entire OpenIM release process.
+
+In addition to CICD, we also do a complex release command locally, which can help you complete the full platform compilation, testing, and release to Minio, just by using the `make release` command.
+Please [read the detailed documents](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/release.md)
+
+
 ## 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.
+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.
+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.
++ <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](info@openim.io). 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

@@ -27,5 +27,6 @@ WORKDIR ${SERVER_WORKDIR}
 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
+COPY --from=builder ${SERVER_WORKDIR}/deployments /openim/openim-server/deployments
 
 CMD ["/openim/openim-server/scripts/docker-start-all.sh"]

Makefile

@@ -6,7 +6,7 @@
 
 ## all: Run tidy, gen, add-copyright, format, lint, cover, build ✨
 .PHONY: all
-all: tidy gen add-copyright verify lint cover restart
+all: tidy gen add-copyright verify test-api lint cover restart
 
 # ==============================================================================
 # Build set
@@ -73,6 +73,11 @@ gen:
 demo:
 	@$(MAKE) go.demo
 
+## version: Check version of openim. ✨
+.PHONY: version
+version:
+	@$(MAKE) go.versionchecker
+
 ## build: Build binaries by default ✨
 .PHONY: build
 build:
@@ -88,9 +93,9 @@ start:
 stop:
 	@$(MAKE) go.stop
 
-## restart: Restart openim ✨
+## restart: Restart openim (make init configuration file is initialized) ✨
 .PHONY: restart
-restart: clean stop build init start
+restart: clean stop build start check
 
 ## multiarch: Build binaries for multiple platforms. See option PLATFORMS. ✨
 .PHONY: multiarch
@@ -161,6 +166,15 @@ test:
 cover:
 	@$(MAKE) go.test.cover
 
+## test-api: Run api test. ✨
+.PHONY: test-api
+test-api:
+	@$(MAKE) go.test.api
+
+## test-e2e: Run e2e test
+test-e2e:
+	@$(MAKE) go.test.e2e
+
 ## updates: Check for updates to go.mod dependencies. ✨
 .PHONY: updates
 	@$(MAKE) go.updates
@@ -170,7 +184,7 @@ cover:
 imports:
 	@$(MAKE) go.imports
 
-## clean: Remove all files that are created by building. ✨
+## clean: Delete all files created by the build, as well as all log files. ✨
 .PHONY: clean
 clean:
 	@$(MAKE) go.clean

README-zh_CN.md

@@ -1,357 +0,0 @@
-<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
-
-Open-IM-Server 是使用纯 Golang 精心制作的强大的即时消息服务器。其通过 JSON over WebSocket 进行通信的独特方法将每次交互都视为消息。这简化了定制并消除了修改服务器代码的需求。通过利用微服务架构，服务器可以通过集群部署，保证出色的性能和可伸缩性。
-
-Open-IM-Server 不仅仅是一个即时消息服务器；它是将实时网络集成到您的应用程序中的强大工具，定位为您集成的首选选择！🚀
-
-请注意，Open-IM-Server 不作为独立产品运行，也不提供内置的帐户注册或登录服务。为了简化您的实施过程，我们已开源了 [chat repository](https://github.com/OpenIMSDK/chat)，其中包括这些功能。与 Open-IM-Server 一起部署此聊天业务服务器可加快全面的聊天产品的设置。👥
-
-为了进一步增强您的体验，我们还提供了 SDK 客户端，在其中实现了大多数复杂逻辑。可以在 [此链接](https://github.com/OpenIMSDK/openim-sdk-core) 找到 [SDK repository](https://github.com/OpenIMSDK/openim-sdk-core)。[chat repository](https://github.com/OpenIMSDK/chat) 是我们的业务服务器，而 'core' 代表 SDK 的高级封装，它们协同工作以提供卓越的结果。✨
-
-## :star2: 为什么选择 OpenIM
-
-**🔍 功能截图显示**
-
-<div align="center">
-
-|                      💻🔄📱 多终端同步 🔄🖥️                       |                        📅⚡ 高效会议 🚀💼                        |
-| :----------------------------------------------------------: | :----------------------------------------------------------: |
-| ![multiple-message](./assets/demo/multi-terminal-synchronization.png) | ![efficient-meetings](./assets/demo/efficient-meetings.png) |
-|                    📲🔄 **一对一和群聊** 👥🗣️                    |               🎁💻 **特殊功能 - 自定义消息** ✉️🎨                |
-| ![group-chat](./assets/demo/group-chat.png) | ![special-function](./assets/demo/special-function.png) |
-
-</div>
-
-1. **全面的消息类型支持 :speech_balloon:**
-
-   ✅ 支持几乎所有类型的消息，包括文本、图片、表情符号、语音、视频、地理位置、文件、报价、名片、系统通知、自定义消息等
-
-   ✅ 支持一对一和多人音视频通话
-
-   ✅ 为 iOS、Android、Flutter、uni-app、ReactNative、Electron、Web、H5 等多个平台提供终端支持
-
-2. **随时随地的高效会议 :earth_americas:**
-
-   ✅ 基于具有 100% 可靠强制信令功能的 IM (Instant Messaging)，为与聊天应用程序深度集成的 IM 系统铺平了道路
-
-   ✅ 支持单次会议中的数百人，订阅人数达到数千，以及服务器端音视频录制
-
-3. **适用于各种社交场景的一对一和群聊 :busts_in_silhouette:**
-
-   ✅ OpenIM 有四种角色：应用程序管理员、群主、群管理员和普通成员
-
-   ✅ 强大的群特性，如静音、群公告、群验证、无限群成员和根据需要加载群消息
-
-4. **独特的功能 :star2:**
-
-   ✅ 支持读取并烧毁私人聊天，可自定义时长
-
-   ✅ 消息编辑功能扩大了社交场景，使即时通讯变得更加多样化和有趣
-
-5. **开源 :open_hands:**
-
-   ✅ OpenIM 的代码是开源的，数据自控，旨在构建一个全球领先的 IM 开源社区，包括客户端 SDK 和服务器
-
-   ✅ 基于开源服务器，已经开发了许多出色的开源项目，例如 [OpenKF](https://github.com/OpenIMSDK/OpenKF) (开源 AI 客户服务系统)
-
-6. **易于扩展 :wrench:**
-
-   ✅ OpenIM 服务器是用 Golang 实现的，引入了创新的 "一切都是消息" 通信模型，简化了自定义消息和扩展功能的实现
-
-7. **高性能 :racing_car:**
-
-   ✅ OpenIM 支持集群中的分层治理架构，经过大量用户的测试，并抽象了在线消息、离线消息和历史消息的存储模型
-
-8. **全平台支持 :tv:**
-
-   ✅ 支持原生 iOS、Android；跨平台 Flutter、uni-app、ReactNative；主要的 Web 前端框架如 React、Vue；小程序和 Electron 支持的 PC 平台
-
-9. **终极部署体验 🤖**
-
-   ✅ 支持 [集群部署](https://github.com/openimsdk/open-im-server/edit/main/deployments/README.md)
-
-   ✅ 支持多架构镜像，我们的 Docker 镜像不仅托管在 GitHub 上，而且还在阿里云和 Docker Hub 上支持多个架构。请访问 [我们的 GitHub packages](https://github.com/orgs/OpenIMSDK/packages?repo_name=Open-IM-Server) 并阅读我们的 [版本管理文档](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/version.md) 以获取更多信息。
-
-10. **开源社区的大生态系统 🤲**
-
-    ✅ 我们有数万用户和许多解决方案来解决问题。 
-
-    ✅  我们有一个大型的开源社区叫 [OpenIMSDK](https://github.com/OpenIMSDK)，它运行核心模块，我们还有一个开源社区叫 [openim-sigs](https://github.com/openim-sigs) 以探索更多基于 IM 的基础设施产品。
-
-## :rocket: 快速开始
-
-<details>   <summary>使用 Docker Compose 部署</summary>
-
-1. 克隆项目
-
-```
-# 选择您需要的
-BRANCH=release-v3.1
-git clone -b $BRANCH https://github.com/openimsdk/open-im-server openim && export openim=$(pwd)/openim && cd $openim && make build
-```
-
-> **注意** 阅读我们的发布策略：https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/version.md
-
-1. 修改 `.env`
-
-```
-USER=root #无需修改
-PASSWORD=openIM123  #8位或更多数字和字母的组合，此密码适用于redis、mysql、mongo，以及config/config.yaml中的accessSecret
-ENDPOINT=http://127.0.0.1:10005 #minio的外部服务IP和端口，或使用域名storage.xx.xx，应用程序必须能够访问此IP和端口或域名，
-API_URL=http://127.0.0.1:10002/object/ #应用程序必须能够访问此IP和端口或域名，
-DATA_DIR=./  #指定大磁盘目录
-```
-
-1. 部署并启动
-
-> **注意** 此命令只能执行一次。它会基于 `.env` 中的 `PASSWORD` 变量修改 docker-compose 中的组件密码，并修改 `config/config.yaml` 中的组件密码。如果 `.env` 中的密码发生变化，您需要首先执行 `docker-compose down`；`rm components -rf` 然后执行此命令。
-
-```
-
-make install
-```
-
-1. 检查服务
-
-```
-
-make check
-```
-
-![https://github.com/openimsdk/open-im-server/blob/main/docs/images/docker_build.png](https://github.com/openimsdk/open-im-server/blob/main/docs/images/docker_build.png)
-
-</details>  <details>  <summary>从源码编译</summary>
-
-您需要 `Go 1.18` 或更高版本，以及 `make`。
-
-版本详情：https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/version.md
-
-```
-# 选择您需要的
-BRANCH=release-v3.1
-git clone -b $BRANCH https://github.com/openimsdk/open-im-server openim && export openim=$(pwd)/openim && cd $openim && make build
-```
-
-阅读关于 [OpenIM 版本策略](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/version.md)
-
-使用 `make help` 来查看 OpenIM 支持的指令。
-
-如图所示，所有服务已成功构建
-
-![成功编译](https://github.com/openimsdk/open-im-server/blob/main/docs/images/build.png)
-
-</details> <details>  <summary>组件配置说明</summary>
-
-config/config.yaml 文件为存储组件提供了详细的配置说明。
-
-- Zookeeper
-
-  - 用于 RPC 服务发现和注册，支持集群。
-
-    ```
-    zookeeper:
-      schema: openim                          #不建议修改
-      address: [ 127.0.0.1:2181 ]             #地址
-      username:                               #用户名
-      password:                               #密码
-    ```
-
-- MySQL
-
-  - 用于存储用户、关系和群组，支持主从数据库。
-
-    ```
-    mysql:
-      address: [ 127.0.0.1:13306 ]            #地址
-      username: root                          #用户名
-      password: openIM123                     #密码
-      database: openIM_v2                     #不建议修改
-      maxOpenConn: 1000                       #最大连接
-      maxIdleConn: 100                        #最大空闲连接
-      maxLifeTime: 60                         #连接可重用的最大时间(秒)
-      logLevel: 4                             #日志级别 1=静音 2=错误 3=警告 4=信息
-      slowThreshold: 500                      #慢语句阈值(毫秒)
-    ```
-
-- Mongo
-
-  - 用于存储离线消息，支持 mongo 分片集群。
-
-    ```
-    mongo:
-      uri:                                    #如果不为空，则直接使用此值
-      address: [ 127.0.0.1:37017 ]            #地址
-      database: openIM                        #默认 mongo 数据库
-      username: root                          #用户名
-      password: openIM123                     #密码
-      maxPoolSize: 100                        #最大连接数
-    ```
-
-- Redis
-
-  - 用于存储消息序列号、最新消息、用户令牌和 mysql 缓存，支持集群部署。
-
-    ```
-    redis:
-      address: [ 127.0.0.1:16379 ]            #地址
-      username:                               #用户名
-      password: openIM123                     #密码
-    ```
-
-- Kafka
-
-  - 用于消息队列，用于消息解耦，支持集群部署。
-
-    ```
-    kafka:
-      username:                               #用户名
-      password:                               #密码
-      addr: [ 127.0.0.1:9092 ]                #地址
-      latestMsgToRedis:
-        topic: "latestMsgToRedis"
-      offlineMsgToMongo:
-        topic: "offlineMsgToMongoMysql"
-      msgToPush:
-        topic: "msqToPush"
-      msgToModify:
-        topic: "msgToModify"
-      consumerGroupID:
-        msgToRedis: redis
-        msgToMongo: mongo
-        msgToMySql: mysql
-        msgToPush: push
-        msgToModify: modify
-    ```
-
-</details> <details>  <summary>启动和停止服务</summary>
-
-启动服务
-
-```
-
-./scripts/start-all.sh;
-```
-
-检查服务
-
-```
-
-./scripts/check-all.sh
-```
-
-停止服务
-
-```
-
-./scripts/stop-all.sh
-```
-
-</details>
-
-<details>  <summary>开放 IM 端口</summary>
-
-| TCP 端口  | 描述                                                | 操作                                    |
-| --------- | --------------------------------------------------- | --------------------------------------- |
-| TCP:10001 | ws 协议，消息端口如消息发送、推送等，用于客户端 SDK | 端口释放或 nginx 反向代理，并关闭防火墙 |
-| TCP:10002 | api 端口，如用户、朋友、组、消息接口。              | 端口释放或 nginx 反向代理，并关闭防火墙 |
-| TCP:10005 | 选择 minio 存储时所需 (openIM 默认使用 minio 存储)  | 端口释放或 nginx 反向代理，并关闭防火墙 |
-
-</details>  <details>  <summary>开放聊天端口</summary>
-
-- 聊天仓库: https://github.com/OpenIMSDK/chat
-
-| TCP 端口  | 描述                     | 操作                                    |
-| --------- | ------------------------ | --------------------------------------- |
-| TCP:10008 | 业务系统，如注册、登录等 | 端口释放或 nginx 反向代理，并关闭防火墙 |
-| TCP:10009 | 管理后台，如统计、封禁等 | 端口释放或 nginx 反向代理，并关闭防火墙 |
-
-</details>
-
-## :link: APP 和 OpenIM 之间的关系
-
-OpenIM 不仅仅是一个开源的即时消息组件，它是您的应用程序生态系统的一个不可分割的部分。查看此图表以了解 AppServer、AppClient、Open-IM-Server 和 Open-IM-SDK 如何互动。
-
-![App-OpenIM 关系](https://github.com/openimsdk/open-im-server/blob/main/docs/images/open-im-server.png)
-
-## :building_construction: 总体架构
-
-深入了解 Open-IM-Server 的功能与我们的架构图。
-
-![总体架构](https://github.com/openimsdk/open-im-server/blob/main/docs/images/Architecture.jpg)
-
-## :hammer_and_wrench: 开始开发 OpenIM
-
-OpenIM 我们的目标是建立一个顶级的开源社区。我们有一套标准，在 [Community repository](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/api.md)
-- [日志标准](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/)
-- [错误代码标准](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/error_code.md)
-
-## :busts_in_silhouette: 社区
-
-- 📚 [OpenIM 社区](https://github.com/OpenIMSDK/community)
-- 💕 [OpenIM 兴趣小组](https://github.com/Openim-sigs)
-- 🚀 [加入我们的 Slack 社区](https://join.slack.com/t/openimsdk/shared_invite/zt-22720d66b-o_FvKxMTGXtcnnnHiMqe9Q)
-- :eyes: [加入我们的微信群 (微信群)](https://openim-1253691595.cos.ap-nanjing.myqcloud.com/WechatIMG20.jpeg)
-
-## :calendar: 社区会议
-
-我们希望任何人都可以参与我们的社区并贡献代码，我们提供礼物和奖励，欢迎您每周四晚上加入我们。
-
-我们的会议在 [OpenIM Slack](https://join.slack.com/t/openimsdk/shared_invite/zt-22720d66b-o_FvKxMTGXtcnnnHiMqe9Q) 🎯，然后您可以搜索 Open-IM-Server 管道加入。
-
-我们在 [GitHub 讨论](https://github.com/openimsdk/open-im-server/discussions/categories/meeting) 中记下每次 [双周会议](https://github.com/orgs/OpenIMSDK/discussions/categories/meeting) 的笔记，我们的历史会议记录以及会议回放都可在 [Google Docs :bookmark_tabs:](https://docs.google.com/document/d/1nx8MDpuG74NASx081JcCpxPgDITNTpIIos0DS6Vr9GU/edit?usp=sharing) 中找到。
-
-## :eyes: 谁在使用 OpenIM
-
-查看我们的 [用户案例研究](https://github.com/OpenIMSDK/community/blob/main/ADOPTERS.md) 页面以获取项目用户列表。不要犹豫，留下一个 [📝评论](https://github.com/openimsdk/open-im-server/issues/379) 并分享您的使用案例。
-
-## :page_facing_up: 许可证
-
-OpenIM 根据 Apache 2.0 许可证授权。请查看 [LICENSE](https://github.com/openimsdk/open-im-server/tree/main/LICENSE) 以获取完整的许可证文本。
-
-OpenIM logo，包括其变体和动画版本，在此存储库 [OpenIM](https://github.com/openimsdk/open-im-server) 下的 [assets/logo](./assets/logo) 和 [assets/logo-gif](./assets/logo-gif) 目录中显示，受版权法保护。
-
-## 🔮 感谢我们的贡献者！
-
-<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,282 +1,133 @@
 <p align="center">
-    <a href="https://www.openim.online">
+    <a href="https://openim.io">
         <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>
-
-## ✨ About OpenIM
-
-Open-IM-Server, meticulously developed in pure Golang, is a powerful instant messaging server. Its distinct communication method, employing pb+websocket, views every interaction as a message, streamlining customization without altering server code. Built on a microservice architecture, it offers deployment through clusters for outstanding performance and scalability.
-
-Open-IM-Server is more than an instant messaging server; it's a powerful tool for incorporating real-time networking into your applications, positioning itself as your premier choice for integration! 🚀
-
-Please be aware that Open-IM-Server does not function as a standalone product and does not offer built-in account registration or login services. To ease your implementation process, we've open-sourced the [chat repository](https://github.com/OpenIMSDK/chat), which comprises these features. Deploying this chat business server in conjunction with Open-IM-Server expedites the setup of a comprehensive chat product. 👥
-
-Further enhancing your experience, we also provide an SDK client, wherein most complex logics are implemented. The [SDK repository](https://github.com/OpenIMSDK/openim-sdk-core) can be found at [this link](https://github.com/OpenIMSDK/openim-sdk-core). The [chat repository](https://github.com/OpenIMSDK/chat) is our business server while the 'core' represents the high-level encapsulation of the SDK, synergistically working together to deliver superior results. ✨
-
-## :star2: Why OpenIM
-
-**🔍 Function screenshot display**
-
 <div align="center">
 
-|            💻🔄📱 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)      |
+[![Stars](https://img.shields.io/github/stars/openimsdk/open-im-server?style=for-the-badge&logo=github&colorB=ff69b4)](https://github.com/openimsdk/open-im-server/stargazers)
+[![Forks](https://img.shields.io/github/forks/openimsdk/open-im-server?style=for-the-badge&logo=github&colorB=blue)](https://github.com/openimsdk/open-im-server/network/members)
+[![Codecov](https://img.shields.io/codecov/c/github/openimsdk/open-im-server?style=for-the-badge&logo=codecov&colorB=orange)](https://app.codecov.io/gh/openimsdk/open-im-server)
+[![Go Report Card](https://goreportcard.com/badge/github.com/openimsdk/open-im-server?style=for-the-badge)](https://goreportcard.com/report/github.com/openimsdk/open-im-server)
+[![Go Reference](https://img.shields.io/badge/Go%20Reference-blue.svg?style=for-the-badge&logo=go&logoColor=white)](https://pkg.go.dev/github.com/openimsdk/open-im-server/v3)
+[![License](https://img.shields.io/badge/license-Apache--2.0-green?style=for-the-badge)](https://github.com/openimsdk/open-im-server/blob/main/LICENSE)
+[![Slack](https://img.shields.io/badge/Slack-500%2B-blueviolet?style=for-the-badge&logo=slack&logoColor=white)](https://join.slack.com/t/openimsdk/shared_invite/zt-22720d66b-o_FvKxMTGXtcnnnHiMqe9Q)
+[![Best Practices](https://img.shields.io/badge/Best%20Practices-purple?style=for-the-badge)](https://www.bestpractices.dev/projects/8045)
+[![Good First Issues](https://img.shields.io/github/issues/openimsdk/open-im-server/good%20first%20issue?style=for-the-badge&logo=github)](https://github.com/openimsdk/open-im-server/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3A%22good+first+issue%22)
+[![Language](https://img.shields.io/badge/Language-Go-blue.svg?style=for-the-badge&logo=go&logoColor=white)](https://golang.org/)
+
+
+<p align="center">
+  <a href="./README.md">Englist</a> · 
+  <a href="./README_zh_CN.md">中文</a> · 
+  <a href="./docs/readme/README_uk.md">Українська</a> · 
+  <a href="./docs/readme/README_cs.md">Česky</a> · 
+  <a href="./docs/readme/README_hu.md">Magyar</a> · 
+  <a href="./docs/readme/README_es.md">Español</a> · 
+  <a href="./docs/readme/README_fa.md">فارسی</a> · 
+  <a href="./docs/readme/README_fr.md">Français</a> · 
+  <a href="./docs/readme/README_de.md">Deutsch</a> · 
+  <a href="./docs/readme/README_pl.md">Polski</a> · 
+  <a href="./docs/readme/README_id.md">Indonesian</a> · 
+  <a href="./docs/readme/README_fi.md">Suomi</a> · 
+  <a href="./docs/readme/README_ml.md">മലയാളം</a> · 
+  <a href="./docs/readme/README_ja.md">日本語</a> · 
+  <a href="./docs/readme/README_nl.md">Nederlands</a> · 
+  <a href="./docs/readme/README_it.md">Italiano</a> · 
+  <a href="./docs/readme/README_ru.md">Русский</a> · 
+  <a href="./docs/readme/README_pt_BR.md">Português (Brasil)</a> · 
+  <a href="./docs/readme/README_eo.md">Esperanto</a> · 
+  <a href="./docs/readme/README_ko.md">한국어</a> · 
+  <a href="./docs/readme/README_ar.md">العربي</a> · 
+  <a href="./docs/readme/README_vi.md">Tiếng Việt</a> · 
+  <a href="./docs/readme/README_da.md">Dansk</a> · 
+  <a href="./docs/readme/README_el.md">Ελληνικά</a> · 
+  <a href="./docs/readme/README_tr.md">Türkçe</a>
+</p>
+
 
 </div>
 
-1. **Comprehensive Message Type Support :speech_balloon:**
+</p>
 
-   ✅ Supports almost all types of messages, including text, images, emojis, voice, video, geographical location, files, quotes, business cards, system notifications, custom messages and more
+## :busts_in_silhouette: Community
 
-   ✅ Supports one-on-one and multi-person audio and video calls
++ 💬 [Follow our Twitter account](https://twitter.com/founder_im63606)
++ 👫 [Join our Reddit](https://www.reddit.com/r/OpenIMessaging)
++ 🚀 [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)
++ 📚 [OpenIM Community](https://github.com/OpenIMSDK/community)
++ 💕 [OpenIM Interest Group](https://github.com/Openim-sigs)
 
-   ✅ Provides terminal support for multiple platforms such as iOS, Android, Flutter, uni-app, ReactNative, Electron, Web, H5 
+## Ⓜ️ About OpenIM
 
-2. **Efficient Meetings Anytime, Anywhere :earth_americas:**
+OpenIM is a service platform specifically designed for integrating chat, audio-video calls, notifications, and AI chatbots into applications. It provides a range of powerful APIs and Webhooks, enabling developers to easily incorporate these interactive features into their applications. OpenIM is not a standalone chat application, but rather serves as a platform to support other applications in achieving rich communication functionalities. The following diagram illustrates the interaction between AppServer, AppClient, OpenIMServer, and OpenIMSDK to explain in detail.
 
-   ✅ Based on IM (Instant Messaging) with 100% reliable forced signaling capabilities, it paves the way for IM systems, deeply integrated with chat applications 
+![App-OpenIM Relationship](./docs/images/oepnim-design.png)
 
-   ✅ Supports hundreds of people in a single meeting, with subscription numbers reaching thousands, and server-side audio and video recording 
+## 🚀 About OpenIMSDK
 
-3. **One-on-one and Group Chats for Various Social Scenarios :busts_in_silhouette:**
+**OpenIMSDK** is an IM SDK designed for **OpenIMServer**, created specifically for embedding in client applications. Its main features and modules are as follows:
 
-   ✅ OpenIM has four roles: application administrator, group owner, group administrator, and regular member 
++ 🌟 Main Features:
 
-   ✅ Powerful group features such as muting, group announcements, group validation, unlimited group members, and loading group messages as needed 
+  - 📦 Local storage
+  - 🔔 Listener callbacks
+  - 🛡️ API wrapping
+  - 🌐 Connection management
 
-4. **Unique Features :star2:**
++ 📚 Main Modules:
 
-   ✅ Supports read-and-burn private chats, customizable duration
+  1. 🚀 Initialization and Login
+  2. 👤 User Management
+  3. 👫 Friend Management
+  4. 🤖 Group Functions
+  5. 💬 Conversation Handling
 
-   ✅ Message editing function broadens social scenarios, making instant communication more diverse and interesting
+It is built using Golang and supports cross-platform deployment, ensuring a consistent access experience across all platforms.
 
-5. **Open Source :open_hands:**
+👉 **[Explore GO SDK](https://github.com/openimsdk/openim-sdk-core)**
 
-   ✅ The code of OpenIM is open source, self-controlled data, aimed at building a globally leading IM open source community, including client SDK and server 
+## 🌐 About OpenIMServer
 
-   ✅ Based on open source Server, many excellent open source projects have been developed, such as [OpenKF](https://github.com/OpenIMSDK/OpenKF) (Open source AI customer service system) 
++ **OpenIMServer** has the following characteristics:
+  - 🌐 Microservice architecture: Supports cluster mode, including a gateway and multiple rpc services.
+  - 🚀 Diverse deployment methods: Supports deployment via source code, Kubernetes, or Docker.
+  - Support for massive user base: Super large groups with hundreds of thousands of users, tens of millions of users, and billions of messages.
 
-6. **Easy to Expand :wrench:**
+### Enhanced Business Functionality:
 
-   ✅ The OpenIM server is implemented in Golang, introducing an innovative "everything is a message" communication model, simplifying the implementation of custom messages and extended features 
++ **REST API**: OpenIMServer offers REST APIs for business systems, aimed at empowering businesses with more functionalities, such as creating groups and sending push messages through backend interfaces.
++ **Webhooks**: OpenIMServer provides callback capabilities to extend more business forms. A callback means that OpenIMServer sends a request to the business server before or after a certain event, like callbacks before or after sending a message.
 
-7. **High Performance :racing_car:**
-
-   ✅ OpenIM supports a hierarchical governance architecture in the cluster, tested by a large number of users, and abstracts the storage model of online messages, offline messages, and historical messages 
-
-8. **Full Platform Support :tv:**
-
-   ✅ Supports native iOS, Android; cross-platform Flutter, uni-app, ReactNative; major web front-end frameworks such as React, Vue; applets; and PC platforms supported by Electron
-
-9. **The ultimate deployment experience 🤖** 
-
-   ✅  Supports [cluster deployment](https://github.com/openimsdk/open-im-server/edit/main/deployments/README.md)
-
-   ✅  Supports multi-architecture mirroring, our Docker images are hosted not only on GitHub but also on Alibaba Cloud and Docker Hub supporting multiple architectures. Visit [our GitHub packages](https://github.com/orgs/OpenIMSDK/packages?repo_name=Open-IM-Server) and read our [version management document](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/version.md) for more information.
-
-11. **A large ecosystem of open source communities 🤲**
-
-    ✅  We have tens of thousands of users and many solutions to problems.
-
-    ✅  We have a large open source community called [OpenIMSDK](https://github.com/OpenIMSDK) that runs the core modules, we have an open source community called [openim-sigs](https://github.com/openim-sigs) to explore more IM-based infrastructure products.
-
-## :rocket: Quick Start
-
-You can quickly learn OpenIM engineering solutions,  all it takes is one simple command:
-
-```bash
-$ make demo
-```
-
-🤲 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:
-
-<details>   <summary>Deploying with Docker Compose</summary>
-
-
-> docker compose will not be maintained in future versions, but it is still the easiest and most convenient way to organize docker compose deployments into a separate project https://github.com/openim-sigs/openim-docker to maintain.
-
-**1. Clone the project**
-
-
-```bash
-git clone -b main https://github.com/openim-sigs/openim-docker openim/openim-docker && export openim=$(pwd)/openim && cd $openim/openim-docker  && ./scripts/init-config.sh && docker-compose up -d
-```
-
-> **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
-
-
-**2. Configure the config file**
-
-If you tried to get started quickly with `make demo`, then you know that our config file is generated by automation.
-
-You can use `make init` to quickly initialize a configuration file
-
-Modify the automation script:
-
-```bash
-cat scripts/install/environment.sh
-```
-
-1. Recommended using environment variables:
-
-```bash
-export PASSWORD="openIM123" # Set password
-export USER="root" # Set username
-# Choose chat version and server version https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/images.md, eg: main, release-v*.*
-export CHAT_BRANCH="main"
-export SERVER_BRANCH="main"
-#... Other environment variables
-# MONGO_USERNAME: This sets the MongoDB username
-# MONGO_PASSWORD: Set the MongoDB password
-# MONGO_DATABASE: Sets the MongoDB database name
-# MINIO_ENDPOINT: set the MinIO service address
-# DOCKER_BRIDGE_SUBNET: set the docker bridge network address
-export DOCKER_BRIDGE_SUBNET="172.28.0.0/16"
-# API_URL: under network environment, set OpenIM Server API address
-export API_URL="http://127.0.0.1:10002"
-```
-
-If you wish to use more custom features, read our [config documentation](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/environment.md).
-
-
-Next, update the configuration using make init:
-
-```bash
-$ make init
-$ git diff
-```
-
-
-</details> 
-
-<details>  <summary>Compile from Source</summary>
-
-
-Ur need `Go 1.18` or higher version, and `make`.
-
-
-```bash
-go version && make --version || echo "Error: One of the commands failed."
-```
-
-Version Details: https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/version.md
-
-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
-$ curl https://raw.githubusercontent.com/OpenIMSDK/openim-docker/main/example/basic-openim-server-dependency.yml -o basic-openim-server-dependency.yml && make init && docker compose -f basic-openim-server-dependency.yml up -d && make start
-```
-
-> `make help` to help you see the instructions supported by OpenIM.
-
-Use `make check` to check all component starts
-
-```bash
-$ make check
-```
-
-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>
-
-
-Read: https://github.com/openimsdk/open-im-server/blob/main/deployments/README.md
-
-</details> 
-
-<details>  <summary>Open IM Ports</summary>
-
-
-| TCP Port  | Description                                                  | Operation                                             |
-| --------- | ------------------------------------------------------------ | ----------------------------------------------------- |
-| TCP:10001 | ws protocol, message port such as message sending, pushing etc, used for client SDK | Port release or nginx reverse proxy, and firewall off |
-| TCP:10002 | api port, such as user, friend, group, message interfaces.   | Port release or nginx reverse proxy, and firewall off |
-| TCP:10005 | Required when choosing minio storage (openIM uses minio storage by default) | Port release or nginx reverse proxy, and firewall off |
-
-</details> 
-
-<details>  <summary>Open Chat Ports</summary>
-
-
-+ chat warehouse: https://github.com/OpenIMSDK/chat 
-
-| TCP Port  | Description                                         | Operation                                             |
-| --------- | --------------------------------------------------- | ----------------------------------------------------- |
-| TCP:10008 | Business system, such as registration, login etc    | Port release or nginx reverse proxy, and firewall off |
-| TCP:10009 | Management backend, such as statistics, banning etc | Port release or nginx reverse proxy, and firewall off |
-
-</details>
-
-
-## :link: Relationship Between APP and OpenIM
-
-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, Open-IM-Server, and Open-IM-SDK interact.
-
-![App-OpenIM Relationship](https://github.com/openimsdk/open-im-server/blob/main/docs/images/open-im-server.png)
+👉 **[Learn more](https://docs.openim.io/guides/introduction/product)**
 
 ## :building_construction: Overall Architecture
 
 Delve into the heart of Open-IM-Server's functionality with our architecture diagram.
 
-![Overall Architecture](https://github.com/openimsdk/open-im-server/blob/main/docs/images/Architecture.jpg)
+![Overall Architecture](./docs/images/architecture-layers.png)
 
-## :hammer_and_wrench: To start developing OpenIM
+
+## :rocket: Quick Start
+
+We support many platforms. Here are the addresses for quick experience on the web side：
+
+👉 **[OpenIM online web demo](https://web-enterprise.rentsoft.cn/)**
+
+🤲 To facilitate user experience, we offer various deployment solutions. You can choose your deployment method from the list below:
+
++ **[Source Code Deployment Guide](https://docs.openim.io/guides/gettingStarted/imSourceCodeDeployment)**
++ **[Docker Deployment Guide](https://docs.openim.io/guides/gettingStarted/dockerCompose)**
++ **[Kubernetes Deployment Guide](https://docs.openim.io/guides/gettingStarted/k8s-deployment)**
++ **[Mac Developer Deployment Guide](https://docs.openim.io/guides/gettingstarted/mac-deployment-guide)**
+
+## :hammer_and_wrench: To Start Developing OpenIM
+
+[![Open in Dev Container](https://img.shields.io/static/v1?label=Dev%20Container&message=Open&color=blue&logo=visualstudiocode)](https://vscode.dev/github/openimsdk/open-im-server)
+
+[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/openimsdk/open-im-server)
 
 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).
 
@@ -284,21 +135,35 @@ If you'd like to contribute to this Open-IM-Server repository, please read our [
 
 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)
-
-## :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)
+- [OpenIM API Reference](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/api.md)
+- [OpenIM Bash Logging](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/bash-log.md)
+- [OpenIM CI/CD Actions](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/cicd-actions.md)
+- [OpenIM Code Conventions](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/code-conventions.md)
+- [OpenIM Commit Guidelines](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/commit.md)
+- [OpenIM Development Guide](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/development.md)
+- [OpenIM Directory Structure](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/directory.md)
+- [OpenIM Environment Setup](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/environment.md)
+- [OpenIM Error Code Reference](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/error-code.md)
+- [OpenIM Git Workflow](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/git-workflow.md)
+- [OpenIM Git Cherry Pick Guide](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/gitcherry-pick.md)
+- [OpenIM GitHub Workflow](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/github-workflow.md)
+- [OpenIM Go Code Standards](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/go-code.md)
+- [OpenIM Image Guidelines](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/images.md)
+- [OpenIM Initial Configuration](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/init-config.md)
+- [OpenIM Docker Installation Guide](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/install-docker.md)
+- [OpenIM OpenIM Linux System Installation](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/install-openim-linux-system.md)
+- [OpenIM Linux Development Guide](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/linux-development.md)
+- [OpenIM Local Actions Guide](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/local-actions.md)
+- [OpenIM Logging Conventions](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/logging.md)
+- [OpenIM Offline Deployment](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/offline-deployment.md)
+- [OpenIM Protoc Tools](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/protoc-tools.md)
+- [OpenIM Testing Guide](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/test.md)
+- [OpenIM Utility Go](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/util-go.md)
+- [OpenIM Makefile Utilities](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/util-makefile.md)
+- [OpenIM Script Utilities](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/util-scripts.md)
+- [OpenIM Versioning](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/version.md)
+- [Manage backend and monitor deployment](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/prometheus-grafana.md)
+- [Mac Developer Deployment Guide for OpenIM](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/mac-developer-deployment-guide.md)
 
 ## :calendar: Community Meetings
 
@@ -308,7 +173,7 @@ Our conference is in the [OpenIM Slack](https://join.slack.com/t/openimsdk/share
 
 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
+## :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.
 

README_zh_CN.md

@@ -0,0 +1,173 @@
+<p align="center">
+    <a href="https://openim.io">
+        <img src="./assets/logo-gif/openim-logo.gif" width="60%" height="30%"/>
+    </a>
+</p>
+
+<div align="center">
+
+[![Stars](https://img.shields.io/github/stars/openimsdk/open-im-server?style=for-the-badge&logo=github&colorB=ff69b4)](https://github.com/openimsdk/open-im-server/stargazers)
+[![Forks](https://img.shields.io/github/forks/openimsdk/open-im-server?style=for-the-badge&logo=github&colorB=blue)](https://github.com/openimsdk/open-im-server/network/members)
+[![Codecov](https://img.shields.io/codecov/c/github/openimsdk/open-im-server?style=for-the-badge&logo=codecov&colorB=orange)](https://app.codecov.io/gh/openimsdk/open-im-server)
+[![Go Report Card](https://goreportcard.com/badge/github.com/openimsdk/open-im-server?style=for-the-badge)](https://goreportcard.com/report/github.com/openimsdk/open-im-server)
+[![Go Reference](https://img.shields.io/badge/Go%20Reference-blue.svg?style=for-the-badge&logo=go&logoColor=white)](https://pkg.go.dev/github.com/openimsdk/open-im-server/v3)
+[![License](https://img.shields.io/badge/license-Apache--2.0-green?style=for-the-badge)](https://github.com/openimsdk/open-im-server/blob/main/LICENSE)
+[![Slack](https://img.shields.io/badge/Slack-500%2B-blueviolet?style=for-the-badge&logo=slack&logoColor=white)](https://join.slack.com/t/openimsdk/shared_invite/zt-22720d66b-o_FvKxMTGXtcnnnHiMqe9Q)
+[![Best Practices](https://img.shields.io/badge/Best%20Practices-purple?style=for-the-badge)](https://www.bestpractices.dev/projects/8045)
+[![Good First Issues](https://img.shields.io/github/issues/openimsdk/open-im-server/good%20first%20issue?style=for-the-badge&logo=github)](https://github.com/openimsdk/open-im-server/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3A%22good+first+issue%22)
+[![Language](https://img.shields.io/badge/Language-Go-blue.svg?style=for-the-badge&logo=go&logoColor=white)](https://golang.org/)
+
+
+<p align="center">
+  <a href="./README.md">Englist</a> · 
+  <a href="./README_zh_CN.md">中文</a> · 
+  <a href="./docs/readme/README_uk.md">Українська</a> · 
+  <a href="./docs/readme/README_cs.md">Česky</a> · 
+  <a href="./docs/readme/README_hu.md">Magyar</a> · 
+  <a href="./docs/readme/README_es.md">Español</a> · 
+  <a href="./docs/readme/README_fa.md">فارسی</a> · 
+  <a href="./docs/readme/README_fr.md">Français</a> · 
+  <a href="./docs/readme/README_de.md">Deutsch</a> · 
+  <a href="./docs/readme/README_pl.md">Polski</a> · 
+  <a href="./docs/readme/README_id.md">Indonesian</a> · 
+  <a href="./docs/readme/README_fi.md">Suomi</a> · 
+  <a href="./docs/readme/README_ml.md">മലയാളം</a> · 
+  <a href="./docs/readme/README_ja.md">日本語</a> · 
+  <a href="./docs/readme/README_nl.md">Nederlands</a> · 
+  <a href="./docs/readme/README_it.md">Italiano</a> · 
+  <a href="./docs/readme/README_ru.md">Русский</a> · 
+  <a href="./docs/readme/README_pt_BR.md">Português (Brasil)</a> · 
+  <a href="./docs/readme/README_eo.md">Esperanto</a> · 
+  <a href="./docs/readme/README_ko.md">한국어</a> · 
+  <a href="./docs/readme/README_ar.md">العربي</a> · 
+  <a href="./docs/readme/README_vi.md">Tiếng Việt</a> · 
+  <a href="./docs/readme/README_da.md">Dansk</a> · 
+  <a href="./docs/readme/README_el.md">Ελληνικά</a> · 
+  <a href="./docs/readme/README_tr.md">Türkçe</a>
+</p>
+
+
+</div>
+
+</p>
+
+## 🟢 扫描微信进群交流
+<img src="./docs/images/Wechat.jpg" width="300">
+
+
+## Ⓜ️ 关于 OpenIM
+
+OpenIM 是一个专门设计用于在应用程序中集成聊天、音视频通话、通知以及AI聊天机器人等通信功能的服务平台。它通过提供一系列强大的API和Webhooks，使开发者可以轻松地在他们的应用中加入这些交互特性。OpenIM 本身并不是一个独立运行的聊天应用，而是作为一个平台，为其他应用提供支持，实现丰富的通信功能。下图展示 AppServer、AppClient、OpenIMServer 和 OpenIMSDK 之间的交互关系来具体说明。
+
+
+
+![App-OpenIM 关系](./docs/images/oepnim-design.png)
+
+## 🚀 关于 OpenIMSDK
+
+**OpenIMSDK** 是为 **OpenIMServer** 设计的IM SDK，专为嵌入客户端应用而生。其主要功能及模块如下：
+
++ 🌟 主要功能：
+
+  - 📦 本地存储
+  - 🔔 监听器回调
+  - 🛡️ API封装
+  - 🌐 连接管理
+
+  ## 📚 主要模块：
+
+  1. 🚀 初始化及登录
+  2. 👤 用户管理
+  3. 👫 好友管理
+  4. 🤖 群组功能
+  5. 💬 会话处理
+
+它使用 Golang 构建，并支持跨平台部署，确保在所有平台上提供一致的接入体验。
+
+👉 **[探索 GO SDK](https://github.com/openimsdk/openim-sdk-core)**
+
+## 🌐 关于 OpenIMServer
+
++ **OpenIMServer** 具有以下特点：
+  - 🌐 微服务架构：支持集群模式，包括网关(gateway)和多个rpc服务。
+  - 🚀 部署方式多样：支持源代码、kubernetes或docker部署。
+  - 海量用户支持：十万超级大群，千万用户，及百亿消息
+
+### 增强的业务功能：
+
++ **REST API**：OpenIMServer 提供了REST API供业务系统使用，旨在赋予业务更多功能，例如通过后台接口建立群组、发送推送消息等。
++ **Webhooks**：OpenIMServer提供了回调能力以扩展更多的业务形态，所谓回调，即OpenIMServer会在某一事件发生之前或者之后，向业务服务器发送请求，如发送消息之前或之后的回调。
+
+👉 **[了解更多](https://docs.openim.io/guides/introduction/product)**
+
+## :rocket: 快速开始
+
+在线体验iOS/Android/H5/PC/Web：
+
+👉 **[OpenIM online demo](https://www.openim.io/zh/commercial)**
+
+🤲 为了方便用户体验，我们提供了多种部署解决方案，您可以根据下面的列表选择自己的部署方法：
+
++ **[源代码部署指南](https://docs.openim.io/guides/gettingStarted/imSourceCodeDeployment)**
++ **[Docker 部署指南](https://docs.openim.io/guides/gettingStarted/dockerCompose)**
++ **[Kubernetes 部署指南](https://docs.openim.io/guides/gettingStarted/k8s-deployment)**
+
+## :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/contrib/go-code.md)
+
++ [Docker 镜像标准](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/images.md)
+
++ [目录标准](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/directory.md)
+
++ [提交标准](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/commit.md)
+
++ [版本控制标准](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/version.md)
+
++ [接口标准](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/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/contrib/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>

assets/README.md

@@ -25,7 +25,7 @@ assets/
 
 ## 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 OpenIM logo, including its variations and animated versions, displayed in this repository [OpenIM](https://github.com/openimsdk/open-im-server) under the `/assets/logo` and `/assets/logo-gif` directories, are protected by copyright laws.
 
 The logo design is credited to @Xx(席欣).
 

assets/colors.md

@@ -0,0 +1,11 @@
+# Official Colors
+
+The openim logo has an official blue color.  When reproducing the logo, please use the official color, when possible.
+
+## Pantone
+
+When possible, the Pantone color is preferred for print material.  The official Pantone color is *285C*.
+
+## RGB
+
+When used digitally, the official RGB color code is *#326CE5*.

build/README.md

@@ -49,17 +49,17 @@ While it is possible to build OpenIM using a local golang installation, we have
 
 ## Basic Flow
 
-The scripts directly under [`build/`](.) are used to build and test.  They will ensure that the `kube-build` Docker image is built (based on [`build/build-image/Dockerfile`](build-image/Dockerfile) and after base image's `KUBE_BUILD_IMAGE_CROSS_TAG` from Dockerfile is replaced with one of those actual tags of the base image, like `v1.13.9-2`) and then execute the appropriate command in that container.  These scripts will both ensure that the right data is cached from run to run for incremental builds and will copy the results back out of the container. You can specify a different registry/name and version for `kube-cross` by setting `KUBE_CROSS_IMAGE` and `KUBE_CROSS_VERSION`, see [`common.sh`](common.sh) for more details.
+The scripts directly under [`build/`](.) are used to build and test.  They will ensure that the `openim-build` Docker image is built (based on [`build/build-image/Dockerfile`](../Dockerfile) and after base image's `OPENIM_BUILD_IMAGE_CROSS_TAG` from Dockerfile is replaced with one of those actual tags of the base image, like `v1.13.9-2`) and then execute the appropriate command in that container.  These scripts will both ensure that the right data is cached from run to run for incremental builds and will copy the results back out of the container. You can specify a different registry/name and version for `openim-cross` by setting `OPENIM_CROSS_IMAGE` and `OPENIM_CROSS_VERSION`, see [`common.sh`](common.sh) for more details.
 
-The `kube-build` container image is built by first creating a "context" directory in `_output/images/build-image`.  It is done there instead of at the root of the OpenIM repo to minimize the amount of data we need to package up when building the image.
+The `openim-build` container image is built by first creating a "context" directory in `_output/images/build-image`.  It is done there instead of at the root of the OpenIM repo to minimize the amount of data we need to package up when building the image.
 
 There are 3 different containers instances that are run from this image.  The first is a "data" container to store all data that needs to persist across to support incremental builds. Next there is an "rsync" container that is used to transfer data in and out to the data container.  Lastly there is a "build" container that is used for actually doing build actions.  The data container persists across runs while the rsync and build containers are deleted after each use.
 
-`rsync` is used transparently behind the scenes to efficiently move data in and out of the container.  This will use an ephemeral port picked by Docker.  You can modify this by setting the `KUBE_RSYNC_PORT` env variable.
+`rsync` is used transparently behind the scenes to efficiently move data in and out of the container.  This will use an ephemeral port picked by Docker.  You can modify this by setting the `OPENIM_RSYNC_PORT` env variable.
 
 All Docker names are suffixed with a hash derived from the file path (to allow concurrent usage on things like CI machines) and a version number.  When the version number changes all state is cleared and clean build is started.  This allows the build infrastructure to be changed and signal to CI systems that old artifacts need to be deleted.
 
 ## Build artifacts
 The build system output all its products to a top level directory in the source repository named `_output`.
-These include the binary compiled packages (e.g. kubectl, kube-scheduler etc.) and archived Docker images.
+These include the binary compiled packages (e.g. imctl, openim-api etc.) and archived Docker images.
 If you intend to run a component with a docker image you will need to import it from this directory with

build/goreleaser.yaml

@@ -3,12 +3,36 @@
 
 before:
   hooks:
+    - make clean
     # You may remove this if you don't use go modules.
     - make tidy
     - make copyright.add
     # you may remove this if you don't need go generate
     - go generate ./...
 
+git:
+  # What should be used to sort tags when gathering the current and previous
+  # tags if there are more than one tag in the same commit.
+  #
+  # Default: '-version:refname'
+  tag_sort: -version:creatordate
+
+  # What should be used to specify prerelease suffix while sorting tags when gathering
+  # the current and previous tags if there are more than one tag in the same commit.
+  #
+  # Since: v1.17
+  prerelease_suffix: "-"
+
+  # Tags to be ignored by GoReleaser.
+  # This means that GoReleaser will not pick up tags that match any of the
+  # provided values as either previous or current tags.
+  #
+  # Templates: allowed.
+  # Since: v1.21.
+  ignore_tags:
+    - nightly
+    # - "{{.Env.IGNORE_TAG}}"
+  
 snapshot:
   name_template: "{{ incpatch .Version }}-next"
 
@@ -255,131 +279,6 @@ builds:
       - "6"
       - "7"
 
-  - binary: infra
-    id: infra
-    main: ./tools/infra/infra.go
-    goos:
-      - darwin
-      - windows
-      - linux
-    goarch:
-      - s390x
-      - mips64
-      - mips64le
-      - amd64
-      - ppc64le
-      - arm64
-    goarm:
-      - "6"
-      - "7"
-
-  - binary: ncpu
-    id: ncpu
-    main: ./tools/ncpu/ncpu.go
-    goos:
-      - darwin
-      - windows
-      - linux
-    goarch:
-      - s390x
-      - mips64
-      - mips64le
-      - amd64
-      - ppc64le
-      - arm64
-    goarm:
-      - "6"
-      - "7"
-
-  - binary: openim-web
-    id: openim-web
-    main: ./tools/openim-web/openim-web.go
-    goos:
-      - darwin
-      - windows
-      - linux
-    goarch:
-      - s390x
-      - mips64
-      - mips64le
-      - amd64
-      - ppc64le
-      - arm64
-    goarm:
-      - "6"
-      - "7"
-
-  - binary: component
-    id: component
-    main: ./tools/component/component.go
-    goos:
-      - darwin
-      - windows
-      - linux
-    goarch:
-      - s390x
-      - mips64
-      - mips64le
-      - amd64
-      - ppc64le
-      - arm64
-    goarm:
-      - "6"
-      - "7"
-    
-  - binary: versionchecker
-    id: versionchecker
-    main: ./tools/versionchecker/versionchecker.go
-    goos:
-      - darwin
-      - windows
-      - linux
-    goarch:
-      - s390x
-      - mips64
-      - mips64le
-      - amd64
-      - ppc64le
-      - arm64
-    goarm:
-      - "6"
-      - "7"
-
-  - binary: changelog
-    id: changelog
-    main: ./tools/changelog/changelog.go
-    goos:
-      - darwin
-      - windows
-      - linux
-    goarch:
-      - s390x
-      - mips64
-      - mips64le
-      - amd64
-      - ppc64le
-      - arm64
-    goarm:
-      - "6"
-      - "7"
-
-  - binary: yamlfmt
-    id: yamlfmt
-    main: ./tools/yamlfmt/yamlfmt.go
-    goos:
-      - darwin
-      - windows
-      - linux
-    goarch:
-      - s390x
-      - mips64
-      - mips64le
-      - amd64
-      - ppc64le
-      - arm64
-    goarm:
-      - "6"
-      - "7"
 
 # TODO：Need a script, such as the init - release to help binary to find the right directory
 # ,which can be compiled binary
@@ -620,4 +519,4 @@ checksum:
   algorithm: sha256
 
 release:
-  prerelease: auto
+  prerelease: auto

build/images/Dockerfile

@@ -12,16 +12,13 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-#more datasource-compose.yaml 
-apiVersion: 1
+FROM BASE_IMAGE
 
-datasources:
-- name: Prometheus
-  type: prometheus
-  access: proxy
-  orgId: 1
-  url: http://127.0.0.1:9091
-  basicAuth: false
-  isDefault: true
-  version: 1
-  editable: true
+WORKDIR ${SERVER_WORKDIR}
+
+# Set HTTP proxy
+ARG BINARY_NAME
+
+COPY BINARY_NAME ./bin/BINARY_NAME
+
+ENTRYPOINT ["./bin/BINARY_NAME"]

build/images/openim-api/Dockerfile

@@ -31,20 +31,15 @@ RUN go mod download
 
 COPY . .
 
-RUN make clean
 RUN make build BINS=openim-api
 
+RUN cp /openim/openim-server/_output/bin/platforms/$(go env GOOS)/$(go env GOARCH)/openim-api /usr/bin/openim-api
+
 # FROM ghcr.io/openim-sigs/openim-bash-image:latest
 FROM ghcr.io/openim-sigs/openim-bash-image:latest
 
 WORKDIR /openim/openim-server
 
-COPY --from=builder /openim/openim-server/_output/bin/platforms /openim/openim-server/_output/bin/platforms
-COPY --from=builder /openim/openim-server/config /openim/openim-server/config
+COPY --from=builder /usr/bin/openim-api ./bin/openim-api
 
-ENV PORT 10002
-EXPOSE 10002
-
-RUN mv ${OPENIM_SERVER_BINDIR}/platforms/$(get_os)/$(get_arch)/openim-api /usr/bin/openim-api
-
-ENTRYPOINT ["bash", "-c", "openim-api -c $OPENIM_SERVER_CONFIG_NAME --port $PORT"]
+ENTRYPOINT ["./bin/openim-api"]

build/images/openim-api/Dockerfile.release

@@ -1,8 +0,0 @@
-FROM ghcr.io/openim-sigs/openim-bash-image:latest
-
-COPY openim-api /usr/bin/
-
-# nosemgrep: dockerfile.security.missing-user.missing-user
-ENTRYPOINT ["/usr/bin/openim-api"]
-# nosemgrep: dockerfile.security.missing-user.missing-user
-CMD ["--help"]

build/images/openim-cmdutils/Dockerfile

@@ -31,19 +31,15 @@ RUN go mod download
 
 COPY . .
 
-RUN go mod download
-RUN make clean
 RUN make build BINS=openim-cmdutils
+RUN cp /openim/openim-server/_output/bin/platforms/$(go env GOOS)/$(go env GOARCH)/openim-cmdutils /usr/bin/openim-cmdutils
 
 FROM ghcr.io/openim-sigs/openim-bash-image:latest
 
 WORKDIR /openim/openim-server
 
-COPY --from=builder $OPENIM_SERVER_BINDIR/platforms /openim/openim-server/_output/bin/platforms
-COPY --from=builder ${SERVER_WORKDIR}/config /openim/openim-server/config
+COPY --from=builder /usr/bin/openim-cmdutils ./bin/openim-cmdutils
 
-RUN mv ${OPENIM_SERVER_BINDIR}/platforms/$(get_os)/$(get_arch)/openim-cmdutils /usr/bin/openim-cmdutils
-
-ENTRYPOINT ["openim-cmdutils"]
+ENTRYPOINT ["./bin/openim-cmdutils"]
 
 CMD ["--help"]

build/images/openim-crontask/Dockerfile

@@ -31,18 +31,15 @@ RUN go mod download
 
 COPY . .
 
-RUN make clean
 RUN make build BINS=openim-crontask
 
+RUN cp /openim/openim-server/_output/bin/platforms/$(go env GOOS)/$(go env GOARCH)/openim-crontask /usr/bin/openim-crontask
+
+# FROM ghcr.io/openim-sigs/openim-bash-image:latest
 FROM ghcr.io/openim-sigs/openim-bash-image:latest
 
 WORKDIR /openim/openim-server
 
-COPY --from=builder /openim/openim-server/_output/bin/platforms /openim/openim-server/_output/bin/platforms
-COPY --from=builder /openim/openim-server/config /openim/openim-server/config
+COPY --from=builder /usr/bin/openim-crontask ./bin/openim-crontask
 
-ENV OPENIM_SERVER_CONFIG_NAME=/openim/openim-server/config
-
-RUN mv ${OPENIM_SERVER_BINDIR}/platforms/$(get_os)/$(get_arch)/openim-crontask /usr/bin/openim-crontask
-
-CMD ["bash", "-c", "openim-crontask -c $OPENIM_SERVER_CONFIG_NAME"]
+ENTRYPOINT ["./bin/openim-crontask"]

build/images/openim-msggateway/Dockerfile

@@ -31,22 +31,15 @@ RUN go mod download
 
 COPY . .
 
-RUN make clean
 RUN make build BINS=openim-msggateway
 
+RUN cp /openim/openim-server/_output/bin/platforms/$(go env GOOS)/$(go env GOARCH)/openim-msggateway /usr/bin/openim-msggateway
+
+# FROM ghcr.io/openim-sigs/openim-bash-image:latest
 FROM ghcr.io/openim-sigs/openim-bash-image:latest
 
 WORKDIR /openim/openim-server
 
-COPY --from=builder /openim/openim-server/_output/bin/platforms /openim/openim-server/_output/bin/platforms
-COPY --from=builder /openim/openim-server/config /openim/openim-server/config
+COPY --from=builder /usr/bin/openim-msggateway ./bin/openim-msggateway
 
-ENV PORT 10140 \
-    WS_PORT 10001
-
-EXPOSE 10140
-EXPOSE 10001
-
-RUN mv ${OPENIM_SERVER_BINDIR}/platforms/$(get_os)/$(get_arch)/openim-msggateway /usr/bin/openim-msggateway
-
-CMD ["bash", "-c", "openim-msggateway -c $OPENIM_SERVER_CONFIG_NAME --port $PORT --ws_port $WS_PORT"]
+ENTRYPOINT ["./bin/openim-msggateway"]

build/images/openim-msgtransfer/Dockerfile

@@ -31,16 +31,15 @@ RUN go mod download
 
 COPY . .
 
-RUN make clean
 RUN make build BINS=openim-msgtransfer
 
+RUN cp /openim/openim-server/_output/bin/platforms/$(go env GOOS)/$(go env GOARCH)/openim-msgtransfer /usr/bin/openim-msgtransfer
+
+# FROM ghcr.io/openim-sigs/openim-bash-image:latest
 FROM ghcr.io/openim-sigs/openim-bash-image:latest
 
 WORKDIR /openim/openim-server
 
-COPY --from=builder /openim/openim-server/_output/bin/platforms /openim/openim-server/_output/bin/platforms
-COPY --from=builder /openim/openim-server/config /openim/openim-server/config
+COPY --from=builder /usr/bin/openim-msgtransfer ./bin/openim-msgtransfer
 
-RUN mv ${OPENIM_SERVER_BINDIR}/platforms/$(get_os)/$(get_arch)/openim-msgtransfer /usr/bin/openim-msgtransfer
-
-ENTRYPOINT ["bash", "-c", "if [[ -n $PROMETHEUS_PORT ]]; then openim-msgtransfer -c $OPENIM_SERVER_CONFIG_NAME --prometheus_port $PROMETHEUS_PORT; else openim-msgtransfer -c $OPENIM_SERVER_CONFIG_NAME; fi"]
+ENTRYPOINT ["./bin/openim-msgtransfer"]

build/images/openim-push/Dockerfile

@@ -15,7 +15,6 @@
 # OpenIM base image: https://github.com/openim-sigs/openim-base-image
 
 # Set go mod installation source and proxy
-# docker run -e "PORT=10003" -e "PROMETHEUSORT=4321"  --network host  -it 67ef891ad1ff
 
 FROM golang:1.20 AS builder
 
@@ -32,21 +31,15 @@ RUN go mod download
 
 COPY . .
 
-RUN make clean
 RUN make build BINS=openim-push
 
+RUN cp /openim/openim-server/_output/bin/platforms/$(go env GOOS)/$(go env GOARCH)/openim-push /usr/bin/openim-push
+
+# FROM ghcr.io/openim-sigs/openim-bash-image:latest
 FROM ghcr.io/openim-sigs/openim-bash-image:latest
 
 WORKDIR /openim/openim-server
 
-COPY --from=builder /openim/openim-server/_output/bin/platforms /openim/openim-server/_output/bin/platforms
-COPY --from=builder /openim/openim-server/config /openim/openim-server/config
+COPY --from=builder /usr/bin/openim-push ./bin/openim-push
 
-ENV PORT 10170 \
-    PROMETHEUS_PORT 20170
-
-EXPOSE 10170
-
-RUN mv ${OPENIM_SERVER_BINDIR}/platforms/$(get_os)/$(get_arch)/openim-push /usr/bin/openim-push
-
-ENTRYPOINT ["bash", "-c", "if [[ -n $PROMETHEUS_PORT ]]; then openim-push -c $OPENIM_SERVER_CONFIG_NAME --port $PORT --prometheus_port $PROMETHEUS_PORT; else openim-push -c $OPENIM_SERVER_CONFIG_NAME --port $PORT; fi"]
+ENTRYPOINT ["./bin/openim-push"]

build/images/openim-rpc-auth/Dockerfile

@@ -31,22 +31,15 @@ RUN go mod download
 
 COPY . .
 
-RUN make clean
-
 RUN make build BINS=openim-rpc-auth
 
+RUN cp /openim/openim-server/_output/bin/platforms/$(go env GOOS)/$(go env GOARCH)/openim-rpc-auth /usr/bin/openim-rpc-auth
+
+# FROM ghcr.io/openim-sigs/openim-bash-image:latest
 FROM ghcr.io/openim-sigs/openim-bash-image:latest
 
 WORKDIR /openim/openim-server
 
-COPY --from=builder /openim/openim-server/_output/bin/platforms /openim/openim-server/_output/bin/platforms/
-COPY --from=builder /openim/openim-server/config /openim/openim-server/config
+COPY --from=builder /usr/bin/openim-rpc-auth ./bin/openim-rpc-auth
 
-ENV PORT 10160 \
-    PROMETHEUS_PORT 20160
-
-EXPOSE 10160
-
-RUN mv ${OPENIM_SERVER_BINDIR}/platforms/$(get_os)/$(get_arch)/openim-rpc-auth /usr/bin/openim-rpc-auth
-
-ENTRYPOINT ["bash", "-c", "if [[ -n $PROMETHEUS_PORT ]]; then "openim-rpc-auth --port $PORT -c $OPENIM_SERVER_CONFIG_NAME" --prometheus_port $PROMETHEUS_PORT; else "openim-rpc-auth --port $PORT -c $OPENIM_SERVER_CONFIG_NAME"; fi"]
+ENTRYPOINT ["./bin/openim-rpc-auth"]

build/images/openim-rpc-conversation/Dockerfile

@@ -31,22 +31,15 @@ RUN go mod download
 
 COPY . .
 
-RUN make clean
-
 RUN make build BINS=openim-rpc-conversation
 
+RUN cp /openim/openim-server/_output/bin/platforms/$(go env GOOS)/$(go env GOARCH)/openim-rpc-conversation /usr/bin/openim-rpc-conversation
+
+# FROM ghcr.io/openim-sigs/openim-bash-image:latest
 FROM ghcr.io/openim-sigs/openim-bash-image:latest
 
 WORKDIR /openim/openim-server
 
-COPY --from=builder /openim/openim-server/_output/bin/platforms /openim/openim-server/_output/bin/platforms/
-COPY --from=builder /openim/openim-server/config /openim/openim-server/config
+COPY --from=builder /usr/bin/openim-rpc-conversation ./bin/openim-rpc-conversation
 
-ENV PORT 10230 \
-    PROMETHEUS_PORT 20230
-
-EXPOSE 10230
-
-RUN mv ${OPENIM_SERVER_BINDIR}/platforms/$(get_os)/$(get_arch)/openim-rpc-conversation /usr/bin/openim-rpc-conversation
-
-ENTRYPOINT ["bash", "-c", "if [[ -n $PROMETHEUS_PORT ]]; then "openim-rpc-conversation --port $PORT -c $OPENIM_SERVER_CONFIG_NAME" --prometheus_port $PROMETHEUS_PORT; else "openim-rpc-conversation --port $PORT -c $OPENIM_SERVER_CONFIG_NAME"; fi"]
+ENTRYPOINT ["./bin/openim-rpc-conversation"]

build/images/openim-rpc-friend/Dockerfile

@@ -31,22 +31,15 @@ RUN go mod download
 
 COPY . .
 
-RUN make clean
-
 RUN make build BINS=openim-rpc-friend
 
+RUN cp /openim/openim-server/_output/bin/platforms/$(go env GOOS)/$(go env GOARCH)/openim-rpc-friend /usr/bin/openim-rpc-friend
+
+# FROM ghcr.io/openim-sigs/openim-bash-image:latest
 FROM ghcr.io/openim-sigs/openim-bash-image:latest
 
 WORKDIR /openim/openim-server
 
-COPY --from=builder /openim/openim-server/_output/bin/platforms /openim/openim-server/_output/bin/platforms/
-COPY --from=builder /openim/openim-server/config /openim/openim-server/config
+COPY --from=builder /usr/bin/openim-rpc-friend ./bin/openim-rpc-friend
 
-ENV PORT 10120 \
-    PROMETHEUS_PORT 20120
-
-EXPOSE 10120
-
-RUN mv ${OPENIM_SERVER_BINDIR}/platforms/$(get_os)/$(get_arch)/openim-rpc-friend /usr/bin/openim-rpc-friend
-
-ENTRYPOINT ["bash", "-c", "if [[ -n $PROMETHEUS_PORT ]]; then "openim-rpc-friend --port $PORT -c $OPENIM_SERVER_CONFIG_NAME" --prometheus_port $PROMETHEUS_PORT; else "openim-rpc-friend --port $PORT -c $OPENIM_SERVER_CONFIG_NAME"; fi"]
+ENTRYPOINT ["./bin/openim-rpc-friend"]

build/images/openim-rpc-group/Dockerfile

@@ -31,22 +31,15 @@ RUN go mod download
 
 COPY . .
 
-RUN make clean
-
 RUN make build BINS=openim-rpc-group
 
+RUN cp /openim/openim-server/_output/bin/platforms/$(go env GOOS)/$(go env GOARCH)/openim-rpc-group /usr/bin/openim-rpc-group
+
+# FROM ghcr.io/openim-sigs/openim-bash-image:latest
 FROM ghcr.io/openim-sigs/openim-bash-image:latest
 
 WORKDIR /openim/openim-server
 
-COPY --from=builder /openim/openim-server/_output/bin/platforms /openim/openim-server/_output/bin/platforms/
-COPY --from=builder /openim/openim-server/config /openim/openim-server/config
+COPY --from=builder /usr/bin/openim-rpc-group ./bin/openim-rpc-group
 
-ENV PORT 10150 \
-    PROMETHEUS_PORT 20150
-
-EXPOSE 10150
-
-RUN mv ${OPENIM_SERVER_BINDIR}/platforms/$(get_os)/$(get_arch)/openim-rpc-group /usr/bin/openim-rpc-group
-
-ENTRYPOINT ["bash", "-c", "if [[ -n $PROMETHEUS_PORT ]]; then "openim-rpc-group --port $PORT -c $OPENIM_SERVER_CONFIG_NAME" --prometheus_port $PROMETHEUS_PORT; else "openim-rpc-group --port $PORT -c $OPENIM_SERVER_CONFIG_NAME"; fi"]
+ENTRYPOINT ["./bin/openim-rpc-group"]

build/images/openim-rpc-msg/Dockerfile

@@ -31,22 +31,15 @@ RUN go mod download
 
 COPY . .
 
-RUN make clean
-
 RUN make build BINS=openim-rpc-msg
 
+RUN cp /openim/openim-server/_output/bin/platforms/$(go env GOOS)/$(go env GOARCH)/openim-rpc-msg /usr/bin/openim-rpc-msg
+
+# FROM ghcr.io/openim-sigs/openim-bash-image:latest
 FROM ghcr.io/openim-sigs/openim-bash-image:latest
 
 WORKDIR /openim/openim-server
 
-COPY --from=builder /openim/openim-server/_output/bin/platforms /openim/openim-server/_output/bin/platforms/
-COPY --from=builder /openim/openim-server/config /openim/openim-server/config
+COPY --from=builder /usr/bin/openim-rpc-msg ./bin/openim-rpc-msg
 
-ENV PORT 10130 \
-    PROMETHEUS_PORT 20130
-
-EXPOSE 10130
-
-RUN mv ${OPENIM_SERVER_BINDIR}/platforms/$(get_os)/$(get_arch)/openim-rpc-msg /usr/bin/openim-rpc-msg
-
-ENTRYPOINT ["bash", "-c", "if [[ -n $PROMETHEUS_PORT ]]; then "openim-rpc-msg --port $PORT -c $OPENIM_SERVER_CONFIG_NAME" --prometheus_port $PROMETHEUS_PORT; else "openim-rpc-msg --port $PORT -c $OPENIM_SERVER_CONFIG_NAME"; fi"]
+ENTRYPOINT ["./bin/openim-rpc-msg"]

build/images/openim-rpc-third/Dockerfile

@@ -31,23 +31,15 @@ RUN go mod download
 
 COPY . .
 
-RUN make clean
-
 RUN make build BINS=openim-rpc-third
 
+RUN cp /openim/openim-server/_output/bin/platforms/$(go env GOOS)/$(go env GOARCH)/openim-rpc-third /usr/bin/openim-rpc-third
 
+# FROM ghcr.io/openim-sigs/openim-bash-image:latest
 FROM ghcr.io/openim-sigs/openim-bash-image:latest
 
 WORKDIR /openim/openim-server
 
-COPY --from=builder /openim/openim-server/_output/bin/platforms /openim/openim-server/_output/bin/platforms/
-COPY --from=builder /openim/openim-server/config /openim/openim-server/config
+COPY --from=builder /usr/bin/openim-rpc-third ./bin/openim-rpc-third
 
-ENV PORT 10190 \
-    PROMETHEUS_PORT 21301
-
-EXPOSE 10190
-
-RUN mv ${OPENIM_SERVER_BINDIR}/platforms/$(get_os)/$(get_arch)/openim-rpc-third /usr/bin/openim-rpc-third
-
-ENTRYPOINT ["bash", "-c", "if [[ -n $PROMETHEUS_PORT ]]; then "openim-rpc-third --port $PORT -c $OPENIM_SERVER_CONFIG_NAME" --prometheus_port $PROMETHEUS_PORT; else "openim-rpc-third --port $PORT -c $OPENIM_SERVER_CONFIG_NAME"; fi"]
+ENTRYPOINT ["./bin/openim-rpc-third"]

build/images/openim-rpc-user/Dockerfile

@@ -31,22 +31,15 @@ RUN go mod download
 
 COPY . .
 
-RUN make clean
-
 RUN make build BINS=openim-rpc-user
 
+RUN cp /openim/openim-server/_output/bin/platforms/$(go env GOOS)/$(go env GOARCH)/openim-rpc-user /usr/bin/openim-rpc-user
+
+# FROM ghcr.io/openim-sigs/openim-bash-image:latest
 FROM ghcr.io/openim-sigs/openim-bash-image:latest
 
 WORKDIR /openim/openim-server
 
-COPY --from=builder /openim/openim-server/_output/bin/platforms /openim/openim-server/_output/bin/platforms/
-COPY --from=builder /openim/openim-server/config /openim/openim-server/config
+COPY --from=builder /usr/bin/openim-rpc-user ./bin/openim-rpc-user
 
-ENV PORT 10110 \
-    PROMETHEUS_PORT 20110
-
-EXPOSE 10110
-
-RUN mv ${OPENIM_SERVER_BINDIR}/platforms/$(get_os)/$(get_arch)/openim-rpc-user /usr/bin/openim-rpc-user
-
-ENTRYPOINT ["bash", "-c", "if [[ -n $PROMETHEUS_PORT ]]; then "openim-rpc-user --port $PORT -c $OPENIM_SERVER_CONFIG_NAME" --prometheus_port $PROMETHEUS_PORT; else "openim-rpc-user --port $PORT -c $OPENIM_SERVER_CONFIG_NAME"; fi"]
+ENTRYPOINT ["./bin/openim-rpc-user"]

cmd/openim-api/main.go

@@ -15,74 +15,17 @@
 package main
 
 import (
-	"context"
-	"fmt"
-	"net"
-	"strconv"
-	"time"
-
 	_ "net/http/pprof"
 
-	"github.com/OpenIMSDK/protocol/constant"
-	"github.com/OpenIMSDK/tools/discoveryregistry"
-	openkeeper "github.com/OpenIMSDK/tools/discoveryregistry/zookeeper"
-	"github.com/OpenIMSDK/tools/log"
-
-	"github.com/openimsdk/open-im-server/v3/internal/api"
 	"github.com/openimsdk/open-im-server/v3/pkg/common/cmd"
-	"github.com/openimsdk/open-im-server/v3/pkg/common/config"
-	"github.com/openimsdk/open-im-server/v3/pkg/common/db/cache"
+	util "github.com/openimsdk/open-im-server/v3/pkg/util/genutil"
 )
 
 func main() {
 	apiCmd := cmd.NewApiCmd()
 	apiCmd.AddPortFlag()
-	apiCmd.AddApi(run)
+	apiCmd.AddPrometheusPortFlag()
 	if err := apiCmd.Execute(); err != nil {
-		panic(err.Error())
+		util.ExitWithError(err)
 	}
 }
-
-func run(port int) error {
-	if port == 0 {
-		return fmt.Errorf("port is empty")
-	}
-	rdb, err := cache.NewRedis()
-	if err != nil {
-		return err
-	}
-	fmt.Println("api start init discov client")
-	var client discoveryregistry.SvcDiscoveryRegistry
-	client, err = openkeeper.NewClient(config.Config.Zookeeper.ZkAddr, config.Config.Zookeeper.Schema,
-		openkeeper.WithFreq(time.Hour), openkeeper.WithUserNameAndPassword(
-			config.Config.Zookeeper.Username,
-			config.Config.Zookeeper.Password,
-		), openkeeper.WithRoundRobin(), openkeeper.WithTimeout(10), openkeeper.WithLogger(log.NewZkLogger()))
-	if err != nil {
-		return err
-	}
-	if err := client.CreateRpcRootNodes(config.Config.GetServiceNames()); err != nil {
-		return err
-	}
-	fmt.Println("api register public config to discov")
-	if err := client.RegisterConf2Registry(constant.OpenIMCommonConfigKey, config.Config.EncodeConfig()); err != nil {
-		return err
-	}
-	fmt.Println("api register public config to discov success")
-	router := api.NewGinRouter(client, rdb)
-	fmt.Println("api init router success")
-	var address string
-	if config.Config.Api.ListenIP != "" {
-		address = net.JoinHostPort(config.Config.Api.ListenIP, strconv.Itoa(port))
-	} else {
-		address = net.JoinHostPort("0.0.0.0", strconv.Itoa(port))
-	}
-	fmt.Println("start api server, address: ", address, ", OpenIM version: ", config.Version)
-	log.ZInfo(context.Background(), "start server success", "address", address, "version", config.Version)
-	err = router.Run(address)
-	if err != nil {
-		log.ZError(context.Background(), "api run failed ", err, "address", address)
-		return err
-	}
-	return nil
-}

cmd/openim-cmdutils/main.go

@@ -16,6 +16,7 @@ package main
 
 import (
 	"github.com/openimsdk/open-im-server/v3/pkg/common/cmd"
+	util "github.com/openimsdk/open-im-server/v3/pkg/util/genutil"
 )
 
 func main() {
@@ -54,6 +55,6 @@ func main() {
 	// openIM clear msg --clearAll
 	msgUtilsCmd.AddCommand(&getCmd.Command, &fixCmd.Command, &clearCmd.Command)
 	if err := msgUtilsCmd.Execute(); err != nil {
-		panic(err)
+		util.ExitWithError(err)
 	}
 }

cmd/openim-crontask/main.go

@@ -15,13 +15,13 @@
 package main
 
 import (
-	"github.com/openimsdk/open-im-server/v3/internal/tools"
 	"github.com/openimsdk/open-im-server/v3/pkg/common/cmd"
+	util "github.com/openimsdk/open-im-server/v3/pkg/util/genutil"
 )
 
 func main() {
 	cronTaskCmd := cmd.NewCronTaskCmd()
-	if err := cronTaskCmd.Exec(tools.StartTask); err != nil {
-		panic(err.Error())
+	if err := cronTaskCmd.Exec(); err != nil {
+		util.ExitWithError(err)
 	}
 }

cmd/openim-msggateway/main.go

@@ -16,6 +16,7 @@ package main
 
 import (
 	"github.com/openimsdk/open-im-server/v3/pkg/common/cmd"
+	util "github.com/openimsdk/open-im-server/v3/pkg/util/genutil"
 )
 
 func main() {
@@ -24,6 +25,6 @@ func main() {
 	msgGatewayCmd.AddPortFlag()
 	msgGatewayCmd.AddPrometheusPortFlag()
 	if err := msgGatewayCmd.Exec(); err != nil {
-		panic(err.Error())
+		util.ExitWithError(err)
 	}
 }

cmd/openim-msgtransfer/main.go

@@ -16,12 +16,14 @@ package main
 
 import (
 	"github.com/openimsdk/open-im-server/v3/pkg/common/cmd"
+	util "github.com/openimsdk/open-im-server/v3/pkg/util/genutil"
 )
 
 func main() {
 	msgTransferCmd := cmd.NewMsgTransferCmd()
 	msgTransferCmd.AddPrometheusPortFlag()
+	msgTransferCmd.AddTransferProgressFlag()
 	if err := msgTransferCmd.Exec(); err != nil {
-		panic(err.Error())
+		util.ExitWithError(err)
 	}
 }

cmd/openim-push/main.go

@@ -17,17 +17,14 @@ package main
 import (
 	"github.com/openimsdk/open-im-server/v3/internal/push"
 	"github.com/openimsdk/open-im-server/v3/pkg/common/cmd"
-	"github.com/openimsdk/open-im-server/v3/pkg/common/config"
+	util "github.com/openimsdk/open-im-server/v3/pkg/util/genutil"
 )
 
 func main() {
-	pushCmd := cmd.NewRpcCmd("push")
+	pushCmd := cmd.NewRpcCmd(cmd.RpcPushServer, push.Start)
 	pushCmd.AddPortFlag()
 	pushCmd.AddPrometheusPortFlag()
 	if err := pushCmd.Exec(); err != nil {
-		panic(err.Error())
-	}
-	if err := pushCmd.StartSvr(config.Config.RpcRegisterName.OpenImPushName, push.Start); err != nil {
-		panic(err.Error())
+		util.ExitWithError(err)
 	}
 }

cmd/openim-rpc/openim-rpc-auth/main.go

@@ -17,17 +17,14 @@ package main
 import (
 	"github.com/openimsdk/open-im-server/v3/internal/rpc/auth"
 	"github.com/openimsdk/open-im-server/v3/pkg/common/cmd"
-	"github.com/openimsdk/open-im-server/v3/pkg/common/config"
+	util "github.com/openimsdk/open-im-server/v3/pkg/util/genutil"
 )
 
 func main() {
-	authCmd := cmd.NewRpcCmd("auth")
+	authCmd := cmd.NewRpcCmd(cmd.RpcAuthServer, auth.Start)
 	authCmd.AddPortFlag()
 	authCmd.AddPrometheusPortFlag()
 	if err := authCmd.Exec(); err != nil {
-		panic(err.Error())
-	}
-	if err := authCmd.StartSvr(config.Config.RpcRegisterName.OpenImAuthName, auth.Start); err != nil {
-		panic(err.Error())
+		util.ExitWithError(err)
 	}
 }

cmd/openim-rpc/openim-rpc-conversation/main.go

@@ -17,17 +17,14 @@ package main
 import (
 	"github.com/openimsdk/open-im-server/v3/internal/rpc/conversation"
 	"github.com/openimsdk/open-im-server/v3/pkg/common/cmd"
-	"github.com/openimsdk/open-im-server/v3/pkg/common/config"
+	util "github.com/openimsdk/open-im-server/v3/pkg/util/genutil"
 )
 
 func main() {
-	rpcCmd := cmd.NewRpcCmd("conversation")
+	rpcCmd := cmd.NewRpcCmd(cmd.RpcConversationServer, conversation.Start)
 	rpcCmd.AddPortFlag()
 	rpcCmd.AddPrometheusPortFlag()
 	if err := rpcCmd.Exec(); err != nil {
-		panic(err.Error())
-	}
-	if err := rpcCmd.StartSvr(config.Config.RpcRegisterName.OpenImConversationName, conversation.Start); err != nil {
-		panic(err.Error())
+		util.ExitWithError(err)
 	}
 }

cmd/openim-rpc/openim-rpc-friend/main.go

@@ -17,17 +17,14 @@ package main
 import (
 	"github.com/openimsdk/open-im-server/v3/internal/rpc/friend"
 	"github.com/openimsdk/open-im-server/v3/pkg/common/cmd"
-	"github.com/openimsdk/open-im-server/v3/pkg/common/config"
+	util "github.com/openimsdk/open-im-server/v3/pkg/util/genutil"
 )
 
 func main() {
-	rpcCmd := cmd.NewRpcCmd("friend")
+	rpcCmd := cmd.NewRpcCmd(cmd.RpcFriendServer, friend.Start)
 	rpcCmd.AddPortFlag()
 	rpcCmd.AddPrometheusPortFlag()
 	if err := rpcCmd.Exec(); err != nil {
-		panic(err.Error())
-	}
-	if err := rpcCmd.StartSvr(config.Config.RpcRegisterName.OpenImFriendName, friend.Start); err != nil {
-		panic(err.Error())
+		util.ExitWithError(err)
 	}
 }

cmd/openim-rpc/openim-rpc-group/main.go

@@ -17,17 +17,14 @@ package main
 import (
 	"github.com/openimsdk/open-im-server/v3/internal/rpc/group"
 	"github.com/openimsdk/open-im-server/v3/pkg/common/cmd"
-	"github.com/openimsdk/open-im-server/v3/pkg/common/config"
+	util "github.com/openimsdk/open-im-server/v3/pkg/util/genutil"
 )
 
 func main() {
-	rpcCmd := cmd.NewRpcCmd("group")
+	rpcCmd := cmd.NewRpcCmd(cmd.RpcGroupServer, group.Start)
 	rpcCmd.AddPortFlag()
 	rpcCmd.AddPrometheusPortFlag()
 	if err := rpcCmd.Exec(); err != nil {
-		panic(err.Error())
-	}
-	if err := rpcCmd.StartSvr(config.Config.RpcRegisterName.OpenImGroupName, group.Start); err != nil {
-		panic(err.Error())
+		util.ExitWithError(err)
 	}
 }

cmd/openim-rpc/openim-rpc-msg/main.go

@@ -17,17 +17,14 @@ package main
 import (
 	"github.com/openimsdk/open-im-server/v3/internal/rpc/msg"
 	"github.com/openimsdk/open-im-server/v3/pkg/common/cmd"
-	"github.com/openimsdk/open-im-server/v3/pkg/common/config"
+	util "github.com/openimsdk/open-im-server/v3/pkg/util/genutil"
 )
 
 func main() {
-	rpcCmd := cmd.NewRpcCmd("msg")
+	rpcCmd := cmd.NewRpcCmd(cmd.RpcMsgServer, msg.Start)
 	rpcCmd.AddPortFlag()
 	rpcCmd.AddPrometheusPortFlag()
 	if err := rpcCmd.Exec(); err != nil {
-		panic(err.Error())
-	}
-	if err := rpcCmd.StartSvr(config.Config.RpcRegisterName.OpenImMsgName, msg.Start); err != nil {
-		panic(err.Error())
+		util.ExitWithError(err)
 	}
 }

cmd/openim-rpc/openim-rpc-third/main.go

@@ -17,17 +17,14 @@ package main
 import (
 	"github.com/openimsdk/open-im-server/v3/internal/rpc/third"
 	"github.com/openimsdk/open-im-server/v3/pkg/common/cmd"
-	"github.com/openimsdk/open-im-server/v3/pkg/common/config"
+	util "github.com/openimsdk/open-im-server/v3/pkg/util/genutil"
 )
 
 func main() {
-	rpcCmd := cmd.NewRpcCmd("third")
+	rpcCmd := cmd.NewRpcCmd(cmd.RpcThirdServer, third.Start)
 	rpcCmd.AddPortFlag()
 	rpcCmd.AddPrometheusPortFlag()
 	if err := rpcCmd.Exec(); err != nil {
-		panic(err.Error())
-	}
-	if err := rpcCmd.StartSvr(config.Config.RpcRegisterName.OpenImThirdName, third.Start); err != nil {
-		panic(err.Error())
+		util.ExitWithError(err)
 	}
 }

cmd/openim-rpc/openim-rpc-user/main.go

@@ -17,17 +17,14 @@ package main
 import (
 	"github.com/openimsdk/open-im-server/v3/internal/rpc/user"
 	"github.com/openimsdk/open-im-server/v3/pkg/common/cmd"
-	"github.com/openimsdk/open-im-server/v3/pkg/common/config"
+	util "github.com/openimsdk/open-im-server/v3/pkg/util/genutil"
 )
 
 func main() {
-	rpcCmd := cmd.NewRpcCmd("user")
+	rpcCmd := cmd.NewRpcCmd(cmd.RpcUserServer, user.Start)
 	rpcCmd.AddPortFlag()
 	rpcCmd.AddPrometheusPortFlag()
 	if err := rpcCmd.Exec(); err != nil {
-		panic(err.Error())
-	}
-	if err := rpcCmd.StartSvr(config.Config.RpcRegisterName.OpenImUserName, user.Start); err != nil {
-		panic(err.Error())
+		util.ExitWithError(err)
 	}
 }

config/Readme.md

@@ -0,0 +1,243 @@
+# OpenIM Configuration Guide
+
+<!-- vscode-markdown-toc -->
+* 1. [Directory Structure and File Descriptions](#DirectoryStructureandFileDescriptions)
+	* 1.1. [Directory Structure](#DirectoryStructure)
+	* 1.2. [Directory Structure Explanation](#DirectoryStructureExplanation)
+* 2. [File Descriptions](#FileDescriptions)
+	* 2.1. [Files in the Root Directory](#FilesintheRootDirectory)
+	* 2.2. [Files in the `templates/` Directory](#FilesinthetemplatesDirectory)
+* 3. [Configuration File Generation](#ConfigurationFileGeneration)
+	* 3.1. [How to Use `init-config.sh` Script](#HowtoUseinit-config.shScript)
+	* 3.2. [Examples of Operations](#ExamplesofOperations)
+	* 3.3. [Points to Note](#PointstoNote)
+* 4. [Example Directory](#ExampleDirectory)
+	* 4.1. [Overview](#Overview)
+	* 4.2. [Structure](#Structure)
+	* 4.3. [How to Use These Examples](#HowtoUseTheseExamples)
+	* 4.4. [Tips for Using Example Files:](#TipsforUsingExampleFiles:)
+* 5. [Configuration Item Descriptions](#ConfigurationItemDescriptions)
+* 6. [Version Management and Upgrading](#VersionManagementandUpgrading)
+	* 6.1. [Pulling the Latest Code](#PullingtheLatestCode)
+	* 6.2. [Generating the Latest Example Configuration Files](#GeneratingtheLatestExampleConfigurationFiles)
+	* 6.3. [Comparing Configuration File Differences](#ComparingConfigurationFileDifferences)
+	* 6.4. [Updating Configuration Files](#UpdatingConfigurationFiles)
+	* 6.5. [Updating Binary Files and Restarting Services](#UpdatingBinaryFilesandRestartingServices)
+	* 6.6. [Best Practices for Version Management](#BestPracticesforVersionManagement)
+* 7. [How to Contribute](#HowtoContribute)
+	* 7.1. [OpenIM Configuration Item Descriptions](#OpenIMConfigurationItemDescriptions)
+	* 7.2. [Modifying Template Files](#ModifyingTemplateFiles)
+	* 7.3. [Updating Configuration Center Scripts](#UpdatingConfigurationCenterScripts)
+	* 7.4. [Configuration File Generation Process](#ConfigurationFileGenerationProcess)
+	* 7.5. [Contribution Guidelines](#ContributionGuidelines)
+	* 7.6. [Submission and Review](#SubmissionandReview)
+
+<!-- vscode-markdown-toc-config
+	numbering=true
+	autoSave=true
+	/vscode-markdown-toc-config -->
+<!-- /vscode-markdown-toc -->
+
+
+##  1. <a name='DirectoryStructureandFileDescriptions'></a>Directory Structure and File Descriptions
+
+This document details the structure of the `config` directory, aiding users in understanding and managing configuration files.
+
+###  1.1. <a name='DirectoryStructure'></a>Directory Structure
+
+```bash
+$ tree config
+├── alertmanager.yml
+├── config.yaml
+├── email.tmpl
+├── instance-down-rules.yml
+├── notification.yaml
+├── prometheus.yml
+├── Readme.md
+└── templates
+    ├── alertmanager.yml.template
+    ├── config.yaml.template
+    ├── email.tmpl.template
+    ├── env.template
+    ├── instance-down-rules.yml.template
+    ├── notification.yaml.template
+    ├── open-im-ng-example.conf
+    ├── prometheus-dashboard.yaml
+    └── prometheus.yml.template
+```
+
+###  1.2. <a name='DirectoryStructureExplanation'></a>Directory Structure Explanation
+
+- **Root Directory (`config/`)**: Contains actual configuration files and the `templates` subdirectory.
+- **`templates/` Subdirectory**: Stores configuration templates for generating or updating configuration files in the root directory.
+
+##  2. <a name='FileDescriptions'></a>File Descriptions
+
+###  2.1. <a name='FilesintheRootDirectory'></a>Files in the Root Directory
+
+- **`alertmanager.yml`**: Configuration file for AlertManager, managing and setting up the alert system.
+- **`config.yaml`**: The main application configuration file, covering service settings.
+- **`email.tmpl`**: Template file for email notifications, defining email format and content.
+- **`instance-down-rules.yml`**: Instance downtime rules configuration file for the monitoring system.
+- **`notification.yaml`**: Configuration file for notification settings, defining different types of notifications.
+- **`prometheus.yml`**: Configuration file for the Prometheus monitoring system, setting monitoring metrics and rules.
+
+###  2.2. <a name='FilesinthetemplatesDirectory'></a>Files in the `templates/` Directory
+
+- **`alertmanager.yml.template`**: Template for AlertManager configuration.
+- **`config.yaml.template`**: Main configuration template for the application.
+- **`email.tmpl.template`**: Template for email notifications.
+- **`env.template`**: Template for environmental variable configurations, setting environment-related configurations.
+- **`instance-down-rules.yml.template`**: Template for instance downtime rules.
+- **`notification.yaml.template`**: Template for notification settings.
+- **`open-im-ng-example.conf`**: Example configuration file for the application.
+- **`prometheus-dashboard.yaml`**: Prometheus dashboard configuration file, specific to the OpenIM application.
+- **`prometheus.yml.template`**: Template for Prometheus configuration.
+
+##  3. <a name='ConfigurationFileGeneration'></a>Configuration File Generation
+
+Configuration files can be automatically generated using the `make init` command or the `./scripts/init-config.sh` script. These scripts conveniently extract templates from the `templates` directory and generate or update actual configuration files in the root directory.
+
+###  3.1. <a name='HowtoUseinit-config.shScript'></a>How to Use `init-config.sh` Script
+
+```bash
+$ ./scripts/init-config.sh --help
+Usage: init-config.sh [options]
+Options:
+  -h, --help             Show this help message
+  --force                Overwrite existing files without prompt
+  --skip                 Skip generation if file exists
+  --examples             Generate example files
+  --clean-config         Clean all configuration files
+  --clean-examples       Clean all example files
+```
+
+###  3.2. <a name='ExamplesofOperations'></a>Examples of Operations
+
+- Generate all template configuration files:
+
+  ```bash
+  $ ./scripts/init-config.sh --examples
+  ```
+
+- Force overwrite existing configuration files:
+
+  ```bash
+  $ ./scripts/init-config.sh --force
+  ```
+
+###  3.3. <a name='PointstoNote'></a>Points to Note
+
+- **Template files should not be directly modified**: Files in the `template` directory are templates included in source code management. Direct modification may lead to version conflicts or management issues.
+- **Operations for Windows Users**: Windows users can use the `cp` command to copy files from the `template` directory to the `config/` directory and then modify the configuration items as needed.
+
+##  4. <a name='ExampleDirectory'></a>Example Directory
+
+Welcome to our project's `examples` directory! This directory contains a range of example files, showcasing various configurations and settings of our software. These examples are intended to provide you with templates that can serve as a starting point for your own configurations.
+
+###  4.1. <a name='Overview'></a>Overview
+
+In this directory, you'll find examples suitable for a variety of use cases. Each file is a template with default values and configurations, demonstrating best practices and typical scenarios. Whether you're just getting started or looking to implement complex settings, these examples should help you get on the right track.
+
+###  4.2. <a name='Structure'></a>Structure
+
+Here's a quick overview of the contents in this directory:
+
+- `env-example.yaml`: Demonstrates how to set up environmental variables.
+- `openim-example.yaml`: Example configuration file for the OpenIM application.
+- `prometheus-example.yml`: Example configuration for monitoring with Prometheus.
+- `alertmanager-example.yml`: Template for setting up Alertmanager configuration.
+
+###  4.3. <a name='HowtoUseTheseExamples'></a>How to Use These Examples
+
+To use these examples, simply copy the relevant files to your working directory and rename them as needed (for example, removing the `-example` suffix). Then, modify the files according to your needs.
+
+###  4.4. <a name='TipsforUsingExampleFiles:'></a>Tips for Using Example Files:
+
+1. **Read Comments**: Each file contains comments explaining the various sections and settings. Make sure to read these comments for a better understanding of how to customize the file.
+2. **Check Required Changes**: Some examples might require mandatory changes before they can be used effectively (such as setting specific environmental variables).
+3. **Version Compatibility**: Ensure that the example files are compatible with the version of the software you are using.
+
+##  5. <a name='ConfigurationItemDescriptions'></a>Configuration Item Descriptions
+
+##  6. <a name='VersionManagementandUpgrading'></a>Version Management and Upgrading
+
+When managing and upgrading the `config` directory's versions, it is crucial to ensure that the configuration files in both the local `config/` and `config/templates/` directories are kept in sync. This process can ensure that your configuration files are consistent with the latest standard templates, while also maintaining custom settings.
+
+###  6.1. <a name='PullingtheLatestCode'></a>Pulling the Latest Code
+
+First, ensure that your local repository is in sync with the remote repository. This can be achieved by pulling the latest code:
+
+```bash
+$ git pull
+```
+
+###  6.2. <a name='GeneratingtheLatestExampleConfigurationFiles'></a>Generating the Latest Example Configuration Files
+
+Next, generate the latest example configuration files. This can be done by running the `init-config.sh` script, using the `--examples` option to generate example files, and the `--skip` option to avoid overwriting existing configuration files:
+
+```bash
+$ ./scripts/init-config.sh --examples --skip
+```
+
+###  6.3. <a name='ComparingConfigurationFileDifferences'></a>Comparing Configuration File Differences
+
+Once the latest example configuration files are generated, you need to compare the configuration files in the `config/` and `config/templates/` directories to find any potential differences. This step ensures that you can identify and integrate any important updates or changes. Tools like `diff` can be helpful in completing this step:
+
+```bash
+$ diff -ur config/ config/templates/
+```
+
+###  6.4. <a name='UpdatingConfigurationFiles'></a>Updating Configuration Files
+
+Based on the comparison results, manually update the configuration files in the `config/` directory to reflect the latest configurations in `config/templates/`. During this process, ensure to retain any custom configuration settings.
+
+###  6.5. <a name='UpdatingBinaryFilesandRestartingServices'></a>Updating Binary Files and Restarting Services
+
+After updating the configuration files, the next step is to update any related binary files. This typically involves downloading and installing the latest version of the application or service. Depending on the specific application or service, this might involve running specific update scripts or directly downloading the latest version from official sources.
+
+Once the binary files are updated, the services need to be restarted to apply the new configurations. Make sure to conduct necessary checks before restarting to ensure the correctness of the configurations.
+
+###  6.6. <a name='BestPracticesforVersionManagement'></a>Best Practices for Version Management
+
+- **Record Changes**: When committing changes to a version control system, ensure to log detailed change logs.
+- **Stay Synced**: Regularly sync with the remote repository to ensure that your local configurations are in line with the latest developments.
+- **Backup**: Backup your current configurations before making any significant changes, so that you can revert to a previous state if necessary.
+
+By following these steps and best practices, you can ensure effective management and smooth upgrading of your `config` directory.
+
+##  7. <a name='HowtoContribute'></a>How to Contribute
+
+If you have an understanding of the logic behind OpenIM's configuration generation, then you will clearly know where to make modifications to contribute code.
+
+###  7.1. <a name='OpenIMConfigurationItemDescriptions'></a>OpenIM Configuration Item Descriptions
+
+First, it is recommended to read the [OpenIM Configuration Items Document](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/environment.md). This will help you understand the roles of various configuration items and how they affect the operation of OpenIM.
+
+###  7.2. <a name='ModifyingTemplateFiles'></a>Modifying Template Files
+
+To contribute to OpenIM, focus on the `./deployments/templates` directory. This contains various configuration template files, which are the basis for generating the final configuration files.
+
+When making modifications, ensure that your changes align with OpenIM's configuration requirements and logic. This may involve adding new template files or modifying existing files to reflect new configuration options or structural changes.
+
+###  7.3. <a name='UpdatingConfigurationCenterScripts'></a>Updating Configuration Center Scripts
+
+In addition to modifying template files, pay attention to the `./scripts/install/environment.sh` script. In this script, you may need to add or modify environment variables.
+
+This script is responsible for defining environment variables that influence configuration generation. Therefore, any new configuration items or modifications to existing items need to be reflected here.
+
+###  7.4. <a name='ConfigurationFileGenerationProcess'></a>Configuration File Generation Process
+
+The essence of the `make init` command is to use the environment variables defined in `/scripts/install/environment.sh` to render the template files in the `./deployments/templates` directory, thereby generating the final configuration files.
+
+When contributing code, ensure that your changes work smoothly in this process and do not cause errors during configuration file generation.
+
+###  7.5. <a name='ContributionGuidelines'></a>Contribution Guidelines
+
+- **Code Review**: Ensure your changes have passed code review. This typically means that the code should be clear, easy to understand, and adhere to the project's coding style and best practices.
+- **Testing**: Before submitting changes, conduct thorough tests to ensure new or modified configurations work as expected and do not negatively impact existing functionalities.
+- **Documentation**: If you have added a new configuration option or made significant changes to an existing one, update the relevant documentation to assist other users and developers in understanding and utilizing these changes.
+
+###  7.6. <a name='SubmissionandReview'></a>Submission and Review
+
+After completing your changes, submit your code to the OpenIM repository in the form of a Pull Request (PR). The PR will be reviewed by the project maintainers and you may be asked to make further modifications or provide additional information.

config/templates/alertmanager.yml.template

@@ -0,0 +1,47 @@
+# 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.
+
+###################### AlertManager Configuration ######################
+# AlertManager configuration using environment variables
+#
+# Resolve timeout
+# SMTP configuration for sending alerts
+# Templates for email notifications
+# Routing configurations for alerts
+# Receiver configurations
+global:
+  resolve_timeout: 5m
+  smtp_from: alert@openim.io
+  smtp_smarthost: smtp.163.com:465
+  smtp_auth_username: alert@openim.io
+  smtp_auth_password: YOURAUTHPASSWORD
+  smtp_require_tls: false
+  smtp_hello: xxx监控告警
+
+templates:
+  - /etc/alertmanager/email.tmpl
+
+route:
+  group_by: ['alertname']
+  group_wait: 5s
+  group_interval: 5s
+  repeat_interval: 5m
+  receiver: email
+receivers:
+  - name: email
+    email_configs:
+      - to: 'alert@example.com'
+        html: '{{ template "email.to.html" . }}'
+        headers: { Subject: "[OPENIM-SERVER]Alarm" }
+        send_resolved: true

config/templates/config.yaml.template

@@ -14,11 +14,14 @@
 
 # -----------------------------------------------------------------
 # TODO: This config file is the template file
-# --| source: deployments/templates/openim.yaml
+# --| source: deployments/templates/config.yaml
 # --| env: scripts/install/environment
 # --| target: config/config.yaml
 # -----------------------------------------------------------------
 
+envs:
+  discovery: zookeeper
+
 ###################### Zookeeper ######################
 # Zookeeper configuration
 # It's not recommended to modify the schema
@@ -32,38 +35,25 @@ zookeeper:
   username: ''
   password: ''
 
-###################### Mysql ######################
-# MySQL configuration
-# Currently, only single machine setup is supported
-#
-# Maximum number of open connections
-# Maximum number of idle connections
-# Maximum lifetime in seconds a connection can be reused
-# Log level: 1=slient, 2=error, 3=warn, 4=info
-# Slow query threshold in milliseconds
-mysql:
-  address: [ 172.28.0.1:13306 ]
-  username: root
-  password: openIM123
-  database: openIM_v3
-  maxOpenConn: 1000
-  maxIdleConn: 100
-  maxLifeTime: 60
-  logLevel: 4
-  slowThreshold: 500
-
 ###################### Mongo ######################
 # MongoDB configuration
-# If uri is not empty, it will be used directly
-#
-# MongoDB address for standalone setup, Mongos address for sharded cluster setup
-# Default MongoDB database name
-# Maximum connection pool size
+
+# If uri is not empty, it will be used directly for the MongoDB connection.
+# This is a complete MongoDB URI string.
+# Example: mongodb://user:password@host1:port1,host2:port2/dbname?options
 mongo:
   uri: ''
+
+# List of MongoDB server addresses.
+# Used for constructing the MongoDB URI if 'uri' above is empty.
+# For a standalone setup, specify the address of the single server.
+# For a sharded cluster, specify the addresses of the Mongos servers.
+# Example: [ '172.28.0.1:37017', '172.28.0.2:37017' ]
+# Default MongoDB database name
+# Maximum connection pool size
   address: [ 172.28.0.1:37017 ]
-  database: openIM_v3
-  username: root
+  database: openim_v3
+  username: openIM
   password: openIM123
   maxPoolSize: 100
 
@@ -140,11 +130,13 @@ object:
     secretAccessKey: "openIM123"
     sessionToken: ''
     signEndpoint: "http://172.28.0.1:10005"
+    publicRead: false
   cos:
     bucketURL: https://temp-1252357374.cos.ap-chengdu.myqcloud.com
     secretID: ''
     secretKey: ''
     sessionToken: ''
+    publicRead: false
   oss:
     endpoint: "https://oss-cn-chengdu.aliyuncs.com"
     bucket: "demo-9999999"
@@ -152,18 +144,32 @@ object:
     accessKeyID: ''
     accessKeySecret: ''
     sessionToken: ''
-
+    publicRead: false
+  kodo:
+    endpoint: "http://s3.cn-east-1.qiniucs.com"
+    bucket: "demo-9999999"
+    bucketURL: "http://your.domain.com"
+    accessKeyID: ''
+    accessKeySecret: ''
+    sessionToken: ''
+    publicRead: false
+  aws:
+    endpoint: ""
+    region: ""
+    bucket: "demo-9999999"
+    accessKeyID: ''
+    accessKeySecret: ''
+    publicRead: false
 
 ###################### RPC Port Configuration ######################
 # RPC service ports
 # These ports are passed into the program by the script and are not recommended to modify
 # For launching multiple programs, just fill in multiple ports separated by commas
 # For example, [10110, 10111]
-rpcPort: 
+rpcPort:
   openImUserPort: [ 10110 ]
   openImFriendPort: [ 10120 ]
   openImMessagePort: [ 10130 ]
-  openImMessageGatewayPort: [ 10140 ]
   openImGroupPort: [ 10150 ]
   openImAuthPort: [ 10160 ]
   openImPushPort: [ 10170 ]
@@ -194,7 +200,7 @@ rpcRegisterName:
 # Whether to output in json format
 # Whether to include stack trace in logs
 log:
-  storageLocation: /root/workspaces/openim/openim-server/logs/
+  storageLocation: /workspaces/open-im-server/logs/
   rotationTime: 24
   remainRotationCount: 2
   remainLogLevel: 6
@@ -212,6 +218,7 @@ log:
 longConnSvr:
   openImWsPort: [ 10001 ]
   websocketMaxConnNum: 100000
+  openImMessageGatewayPort: [ 10140 ]
   websocketMaxMsgLen: 4096
   websocketTimeout: 10
 
@@ -226,18 +233,18 @@ push:
   enable: getui
   geTui:
     pushUrl: "https://restapi.getui.com/v2/$appId"
-    masterSecret: ""
-    appKey: ""
-    intent: ""
-    channelID: ""
-    channelName: ""
+    masterSecret: ''
+    appKey: ''
+    intent: ''
+    channelID: ''
+    channelName: ''
   fcm:
     serviceAccount: "x.json"
   jpns:
-    appKey:
-    masterSecret:
-    pushUrl:
-    pushIntent:
+    appKey: ''
+    masterSecret: ''
+    pushUrl: ''
+    pushIntent: ''
 
 # App manager configuration
 #
@@ -247,6 +254,14 @@ manager:
   userID: [ "openIM123456", "openIM654321", "openIMAdmin" ]
   nickname: [ "system1", "system2", "system3" ]
 
+# chatAdmin, use for send notification
+#
+# Built-in app system notification account ID
+# Built-in app system notification account nickname
+im-admin:
+  userID: [ "imAdmin" ]
+  nickname: [ "imAdmin" ]
+
 # Multi-platform login policy
 # For each platform(Android, iOS, Windows, Mac, web), only one can be online at a time
 multiLoginPolicy: 1
@@ -307,14 +322,23 @@ iosPush:
 # Timeout in seconds
 # Whether to continue execution if callback fails
 callback:
-  url:
+  url: "http://127.0.0.1:10008/callbackExample"
   beforeSendSingleMsg:
     enable: false
     timeout: 5
     failedContinue: true
-  afterSendSingleMsg:
-    enable: false
+  beforeUpdateUserInfoEx:
+    enable:  false
     timeout: 5
+    failedContinue: true
+  afterUpdateUserInfoEx:
+    enable:  false
+    timeout: 5
+    failedContinue: true
+  afterSendSingleMsg:
+    enable: true
+    timeout: 5
+    failedContinue: true
   beforeSendGroupMsg:
     enable: false
     timeout: 5
@@ -322,6 +346,7 @@ callback:
   afterSendGroupMsg:
     enable: false
     timeout: 5
+    failedContinue: true
   msgModify:
     enable: false
     timeout: 5
@@ -329,12 +354,15 @@ callback:
   userOnline:
     enable: false
     timeout: 5
+    failedContinue: true
   userOffline:
     enable: false
     timeout: 5
+    failedContinue: true
   userKickOff:
     enable: false
     timeout: 5
+    failedContinue: true
   offlinePush:
     enable: false
     timeout: 5
@@ -351,10 +379,18 @@ callback:
     enable: false
     timeout: 5
     failedContinue: true
+  beforeUpdateUserInfo:
+    enable: false
+    timeout: 5
+    failedContinue: true
   beforeCreateGroup:
     enable: false
     timeout: 5
     failedContinue: true
+  afterCreateGroup:
+    enable: false
+    timeout: 5
+    failedContinue: true
   beforeMemberJoinGroup:
     enable: false
     timeout: 5
@@ -363,17 +399,130 @@ callback:
     enable: false
     timeout: 5
     failedContinue: true
+  afterSetGroupMemberInfo:
+    enable: false
+    timeout: 5
+    failedContinue: true
   setMessageReactionExtensions:
     enable: false
     timeout: 5
     failedContinue: true
-
+  quitGroup:
+    enable: false
+    timeout: 5
+    failedContinue: true
+  killGroupMember:
+    enable: false
+    timeout: 5
+    failedContinue: true
+  dismissGroup:
+    enable: false
+    timeout: 5
+    failedContinue: true
+  joinGroup:
+    enable: false
+    timeout: 5
+    failedContinue: true
+  groupMsgRead:
+    enable: false
+    timeout: 5
+    failedContinue: true
+  singleMsgRead:
+    enable: false
+    timeout: 5
+    failedContinue: true
+  updateUserInfo:
+    enable: false
+    timeout: 5
+    failedContinue: true
+  beforeUserRegister:
+    enable: false
+    timeout: 5
+    failedContinue: true
+  afterUserRegister:
+    enable: false
+    timeout: 5
+    failedContinue: true
+  transferGroupOwner:
+    enable: false
+    timeout: 5
+    failedContinue: true
+  beforeSetFriendRemark:
+    enable: false
+    timeout: 5
+    failedContinue: true
+  afterSetFriendRemark:
+    enable: false
+    timeout: 5
+    failedContinue: true
+  afterGroupMsgRead:
+    enable: false
+    timeout: 5
+    failedContinue: true
+  afterGroupMsgRevoke:
+    enable: false
+    timeout: 5
+    failedContinue: true
+  afterJoinGroup:
+    enable: false
+    timeout: 5
+    failedContinue: true
+  beforeInviteUserToGroup:
+    enable: false
+    timeout: 5
+    failedContinue: true
+  joinGroupAfter:
+    enable: false
+    timeout: 5
+    failedContinue: true
+  setGroupInfoAfter:
+    enable: false
+    timeout: 5
+    failedContinue: true
+  setGroupInfoBefore:
+    enable: false
+    timeout: 5
+    failedContinue: true
+  revokeMsgAfter:
+    enable: false
+    timeout: 5
+    failedContinue: true
+  addBlackBefore:
+    enable: false
+    timeout: 5
+    failedContinue: true
+  addFriendAfter:
+    enable: false
+    timeout: 5
+    failedContinue: true
+  addFriendAgreeBefore:
+    enable: false
+    timeout: 5
+    failedContinue: true
+  deleteFriendAfter:
+    enable: false
+    timeout: 5
+    failedContinue: true
+  importFriendsBefore:
+    enable: false
+    timeout: 5
+    failedContinue: true
+  importFriendsAfter:
+    enable: false
+    timeout: 5
+    failedContinue: true
+  removeBlackAfter:
+    enable: false
+    timeout: 5
+    failedContinue: true
 ###################### Prometheus ######################
 # Prometheus configuration for various services
 # The number of Prometheus ports per service needs to correspond to rpcPort
 # The number of ports needs to be consistent with msg_transfer_service_num in script/path_info.sh
 prometheus:
-  enable: false
+  enable: true
+  grafanaUrl: http://172.28.0.1:13000/
+  apiPrometheusPort: [20100]
   userPrometheusPort: [ 20110 ]
   friendPrometheusPort: [ 20120 ]
   messagePrometheusPort: [ 20130 ]

config/templates/email.tmpl.template

@@ -0,0 +1,16 @@
+{{ define "email.to.html" }}
+{{ range .Alerts }}
+<!-- Begin of OpenIM Alert -->
+<div style="border:1px solid #ccc; padding:10px; margin-bottom:10px;">
+    <h3>OpenIM Alert</h3>
+    <p><strong>Alert Program:</strong> Prometheus Alert</p>
+    <p><strong>Severity Level:</strong> {{ .Labels.severity }}</p>
+    <p><strong>Alert Type:</strong> {{ .Labels.alertname }}</p>
+    <p><strong>Affected Host:</strong> {{ .Labels.instance }}</p>
+    <p><strong>Affected Service:</strong> {{ .Labels.job }}</p>
+    <p><strong>Alert Subject:</strong> {{ .Annotations.summary }}</p>
+    <p><strong>Trigger Time:</strong> {{ .StartsAt.Format "2006-01-02 15:04:05" }}</p>
+</div>
+<!-- End of OpenIM Alert -->
+{{ end }}
+{{ end }}

config/templates/env.template

@@ -0,0 +1,236 @@
+# Copyright © 2024 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.
+
+# -----------------------------------------------------------------------------
+# General Configuration
+# This section contains general configuration options for the entire environment.
+# These options can be set via environment variables. If both environment variables 
+# and settings in this .env file exist, the environment variables take precedence.
+# -----------------------------------------------------------------------------
+# ==========================
+# General Configuration
+# ==========================
+# These settings apply to the overall environment.
+
+# Data storage directory for persistent data.
+# Example: DATA_DIR=/path/to/data
+DATA_DIR=/workspaces/open-im-server
+
+# Docker image registry. Uncomment the preferred one.
+# Options: ghcr.io/openimsdk, openim, registry.cn-hangzhou.aliyuncs.com/openimsdk
+# IMAGE_REGISTRY="ghcr.io/openimsdk"
+# IMAGE_REGISTRY="openim"
+# IMAGE_REGISTRY="registry.cn-hangzhou.aliyuncs.com/openimsdk"
+IMAGE_REGISTRY=ghcr.io/openimsdk
+
+# ======================================
+# ========= Network Configuration ======
+# ======================================
+
+# Subnet for the Docker network.
+# Default: DOCKER_BRIDGE_SUBNET=172.28.0.0/16
+DOCKER_BRIDGE_SUBNET=172.28.0.0/16
+
+# Set and specify the IP addresses of some containers. Generally speaking, 
+# you do not need to modify these configurations to facilitate debugging
+DOCKER_BRIDGE_GATEWAY=172.28.0.1
+MONGO_NETWORK_ADDRESS=172.28.0.2
+REDIS_NETWORK_ADDRESS=172.28.0.3
+KAFKA_NETWORK_ADDRESS=172.28.0.4
+ZOOKEEPER_NETWORK_ADDRESS=172.28.0.5
+MINIO_NETWORK_ADDRESS=172.28.0.6
+OPENIM_WEB_NETWORK_ADDRESS=172.28.0.7
+OPENIM_SERVER_NETWORK_ADDRESS=172.28.0.8
+OPENIM_CHAT_NETWORK_ADDRESS=172.28.0.9
+PROMETHEUS_NETWORK_ADDRESS=172.28.0.10
+GRAFANA_NETWORK_ADDRESS=172.28.0.11
+NODE_EXPORTER_NETWORK_ADDRESS=172.28.0.12
+OPENIM_ADMIN_FRONT_NETWORK_ADDRESS=172.28.0.13
+ALERT_MANAGER_NETWORK_ADDRESS=172.28.0.14
+
+# ==============================================================================
+# Configuration Update Instructions
+# ==============================================================================
+# This header outlines the methods to update common variables in config.yaml and .env files.
+# These instructions are vital for maintaining the OpenIM environment's configuration.
+#
+# METHOD 1: Regenerate All Configurations
+# ----------------------------------------
+# Use this method to regenerate all configurations.
+# Steps:
+#   1. Delete existing config files:
+#      - openim-server/config/config.yaml
+#      - openim-chat/config/config.yaml
+#   2. Modify the .env file as required.
+#   3. Run 'docker compose up -d'. This will regenerate:
+#       - config/config.yaml
+#
+# METHOD 2: Modify Individual Configuration Files
+# -----------------------------------------------
+# Use this method to update specific configuration files.
+# Steps:
+#   1. Modify the .env file as necessary.
+#   2. Update the corresponding entries in:
+#      - config/config.yaml
+#   3. Restart the services with 'docker compose up -d'.
+#   4. Special Note: If you modify OPENIM_IP, API_OPENIM_PORT, or MINIO_PORT in .env,
+#      ensure to update the corresponding services and configurations accordingly.
+#
+# It is essential to follow these methods to ensure consistent and correct application behavior.
+# ==============================================================================
+# Local IP address of the service. Modify if necessary.
+# Example: OPENIM_IP=172.28.0.1，
+OPENIM_IP=172.28.0.1
+
+# ----- ZooKeeper Configuration -----
+# Port for ZooKeeper service.
+# Default: ZOOKEEPER_PORT=12181
+ZOOKEEPER_PORT=12181
+
+# MongoDB service port configuration.
+# Default: MONGO_PORT=37017
+# MONGO_PORT=37017
+
+# Password for MongoDB admin user. Used for service authentication.
+# Default: MONGO_PASSWORD=openIM123
+MONGO_PASSWORD=openIM123
+
+# Username for a regular OpenIM user in MongoDB.
+# Default: MONGO_OPENIM_USERNAME=openIM
+MONGO_OPENIM_USERNAME=openIM
+
+# Password for a regular OpenIM user in MongoDB.
+# Default: MONGO_OPENIM_PASSWORD=openIM123456
+MONGO_OPENIM_PASSWORD=openIM123
+
+# Specifies the database name to be used within MongoDB.
+# Default: MONGO_DATABASE=openim_v3
+MONGO_DATABASE=openim_v3
+
+# ----- Redis Configuration -----
+
+# 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
+
+# Kakfa username to authenticate with the Kafka service.
+# KAFKA_USERNAME=''
+
+# 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
+
+# MINIO_PORT
+# ----------
+# MINIO_PORT sets the port for the MinIO object storage service.
+# Upon changing this port, the MinIO endpoint URLs in the  file must be updated
+# to reflect this change. The endpoints include both the 'endpoint' and 'signEndpoint' 
+# under the MinIO configuration.
+#
+# 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 -----
+# Port on which Prometheus service is running.
+# Default: PROMETHEUS_PORT=19090
+PROMETHEUS_PORT=19090
+
+# ----- Grafana Configuration -----
+# Port on which Grafana service is running.
+# Default: GRAFANA_PORT=13000
+GRAFANA_PORT=13000
+
+# ======================================
+# ============ OpenIM Web ===============
+# ======================================
+
+# Port on which OpenIM web service is running.
+# Default: OPENIM_WEB_PORT=11001
+OPENIM_WEB_PORT=11001
+
+# ======================================
+# ========= OpenIM Server ==============
+# ======================================
+# Port for the OpenIM WebSockets.
+# Default: OPENIM_WS_PORT=10001
+OPENIM_WS_PORT=10001
+
+# API_OPENIM_PORT
+# ---------------
+# This variable defines the port on which the OpenIM API service will listen.
+# When changing this port, it's essential to update the apiURL in the config.yaml file
+# to ensure the API service is accessible at the new port.
+#
+# Default: API_OPENIM_PORT=10002
+API_OPENIM_PORT=10002
+
+# ======================================
+# ========== OpenIM Chat ===============
+# ======================================
+
+# Branch name for OpenIM chat.
+# Default: CHAT_IMAGE_VERSION=main
+CHAT_IMAGE_VERSION=main
+
+# Port for the OpenIM chat API.
+# Default: OPENIM_CHAT_API_PORT=10008
+OPENIM_CHAT_API_PORT=10008
+
+# Port for the OpenIM admin API.
+# Default: OPENIM_ADMIN_API_PORT=10009
+OPENIM_ADMIN_API_PORT=10009
+
+# ======================================
+# ========== OpenIM Admin ==============
+# ======================================
+
+# Branch name for OpenIM server.
+# Default: SERVER_IMAGE_VERSION=main
+SERVER_IMAGE_VERSION=main
+  
+# Port for the node exporter.
+# Default: NODE_EXPORTER_PORT=19100
+NODE_EXPORTER_PORT=19100
+  
+# Port for the prometheus.
+# Default: PROMETHEUS_PORT=19090
+PROMETHEUS_PORT=19090
+  
+# Port for the grafana.
+# Default: GRAFANA_PORT=13000
+GRAFANA_PORT=13000
+  
+# Port for the admin front.
+# Default: OPENIM_ADMIN_FRONT_PORT=11002
+OPENIM_ADMIN_FRONT_PORT=11002
+
+# Port for the alertmanager.
+# Default: ALERT_MANAGER_PORT=19093
+ALERT_MANAGER_PORT=19093

config/templates/instance-down-rules.yml.template

@@ -0,0 +1,36 @@
+# 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.
+
+groups:
+  - name: instance_down
+    rules:
+      - alert: InstanceDown
+        expr: up == 0
+        for: 1m
+        labels:
+          severity: critical
+        annotations:
+          summary: "Instance {{ $labels.instance }} down"
+          description: "{{ $labels.instance }} of job {{ $labels.job }} has been down for more than 1 minutes."
+
+  - name: database_insert_failure_alerts
+    rules:
+      - alert: DatabaseInsertFailed
+        expr: (increase(msg_insert_redis_failed_total[5m]) > 0) or (increase(msg_insert_mongo_failed_total[5m]) > 0)
+        for: 1m
+        labels:
+          severity: critical
+        annotations:
+          summary: "Increase in MsgInsertRedisFailedCounter or MsgInsertMongoFailedCounter detected"
+          description: "Either MsgInsertRedisFailedCounter or MsgInsertMongoFailedCounter has increased in the last 5 minutes, indicating failures in message insert operations to Redis or MongoDB,maybe the redis or mongodb is crash."

config/templates/notification.yaml.template

@@ -0,0 +1,354 @@
+# 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.
+
+# Determines if a message should be sent. If set to false, it triggers a silent sync without a message. If true, it requires triggering a conversation.
+# For rpc notification, send twice: once as a message and once as a notification.
+# The options field 'isNotification' indicates if it's a notification.
+groupCreated:
+  isSendMsg: true
+
+# Reliability level of the message sending.
+# Set to 1 to send only when online, 2 for guaranteed delivery.
+  reliabilityLevel: 1
+
+# This setting is effective only when 'isSendMsg' is true.
+# It controls whether to count unread messages.
+  unreadCount: false
+
+# Configuration for offline push notifications.
+  offlinePush:
+    # Enables or disables offline push notifications.
+    enable: false
+
+    # Title for the notification when a group is created.
+    title: "create group title"
+
+    # Description for the notification.
+    desc: "create group desc"
+
+    # Additional information for the notification.
+    ext: "create group ext"
+
+# Content type is not added here.
+# Content should use a JSON structure conforming to the protobuf format.
+
+groupInfoSet:
+  isSendMsg: false
+  reliabilityLevel: 1
+  unreadCount: false
+  offlinePush:
+    enable: false
+    title: "groupInfoSet title"
+    desc: "groupInfoSet desc"
+    ext: "groupInfoSet ext"
+
+
+joinGroupApplication:
+  isSendMsg: false
+  reliabilityLevel: 1
+  unreadCount: false
+  offlinePush:
+    enable: false
+    title: "joinGroupApplication title"
+    desc: "joinGroupApplication desc"
+    ext: "joinGroupApplication ext"
+
+memberQuit:
+  isSendMsg: true
+  reliabilityLevel: 1
+  unreadCount: false
+  offlinePush:
+    enable: false
+    title: "memberQuit title"
+    desc: "memberQuit desc"
+    ext: "memberQuit ext"
+
+groupApplicationAccepted:
+  isSendMsg: false
+  reliabilityLevel: 1
+  unreadCount: false
+  offlinePush:
+    enable: false
+    title: "groupApplicationAccepted title"
+    desc: "groupApplicationAccepted desc"
+    ext: "groupApplicationAccepted ext"
+
+groupApplicationRejected:
+  isSendMsg: false
+  reliabilityLevel: 1
+  unreadCount: false
+  offlinePush:
+    enable: false
+    title: " title"
+    desc: " desc"
+    ext: " ext"
+
+
+groupOwnerTransferred:
+  isSendMsg: true
+  reliabilityLevel: 1
+  unreadCount: false
+  offlinePush:
+    enable: false
+    title: "groupOwnerTransferred title"
+    desc: "groupOwnerTransferred desc"
+    ext: "groupOwnerTransferred ext"
+
+memberKicked:
+  isSendMsg: true
+  reliabilityLevel: 1
+  unreadCount: false
+  offlinePush:
+    enable: false
+    title: "memberKicked title"
+    desc: "memberKicked desc"
+    ext: "memberKicked ext"
+
+memberInvited:
+  isSendMsg: true
+  reliabilityLevel: 1
+  unreadCount: false
+  offlinePush:
+    enable: false
+    title: "memberInvited title"
+    desc: "memberInvited desc"
+    ext: "memberInvited ext"
+
+memberEnter:
+  isSendMsg: true
+  reliabilityLevel: 1
+  unreadCount: false
+  offlinePush:
+    enable: false
+    title: "memberEnter title"
+    desc: "memberEnter desc"
+    ext: "memberEnter ext"
+
+groupDismissed:
+  isSendMsg: true
+  reliabilityLevel: 1
+  unreadCount: false
+  offlinePush:
+    enable: false
+    title: "groupDismissed title"
+    desc: "groupDismissed desc"
+    ext: "groupDismissed ext"
+
+groupMuted:
+  isSendMsg: true
+  reliabilityLevel: 1
+  unreadCount: false
+  offlinePush:
+    enable: false
+    title: "groupMuted title"
+    desc: "groupMuted desc"
+    ext: "groupMuted ext"
+
+groupCancelMuted:
+  isSendMsg: true
+  reliabilityLevel: 1
+  unreadCount: false
+  offlinePush:
+    enable: false
+    title: "groupCancelMuted title"
+    desc: "groupCancelMuted desc"
+    ext: "groupCancelMuted ext"
+  defaultTips:
+    tips: "group Cancel Muted"
+
+
+groupMemberMuted:
+  isSendMsg: true
+  reliabilityLevel: 1
+  unreadCount: false
+  offlinePush:
+    enable: false
+    title: "groupMemberMuted title"
+    desc: "groupMemberMuted desc"
+    ext: "groupMemberMuted ext"
+
+groupMemberCancelMuted:
+  isSendMsg: true
+  reliabilityLevel: 1
+  unreadCount: false
+  offlinePush:
+    enable: false
+    title: "groupMemberCancelMuted title"
+    desc: "groupMemberCancelMuted desc"
+    ext: "groupMemberCancelMuted ext"
+
+groupMemberInfoSet:
+  isSendMsg: false
+  reliabilityLevel: 1
+  unreadCount: false
+  offlinePush:
+    enable: false
+    title: "groupMemberInfoSet title"
+    desc: "groupMemberInfoSet desc"
+    ext: "groupMemberInfoSet ext"
+
+groupInfoSetAnnouncement:
+  isSendMsg: true
+  reliabilityLevel: 1
+  unreadCount: false
+  offlinePush:
+    enable: false
+    title: "groupInfoSetAnnouncement title"
+    desc: "groupInfoSetAnnouncement desc"
+    ext: "groupInfoSetAnnouncement ext"
+
+
+groupInfoSetName:
+  isSendMsg: true
+  reliabilityLevel: 1
+  unreadCount: false
+  offlinePush:
+    enable: false
+    title: "groupInfoSetName title"
+    desc: "groupInfoSetName desc"
+    ext: "groupInfoSetName ext"
+
+
+#############################friend#################################
+friendApplicationAdded:
+  isSendMsg: false
+  reliabilityLevel: 1
+  unreadCount: false
+  offlinePush:
+    enable: false
+    title: "Somebody applies to add you as a friend"
+    desc: "Somebody applies to add you as a friend"
+    ext: "Somebody applies to add you as a friend"
+
+friendApplicationApproved:
+  isSendMsg: true
+  reliabilityLevel: 1
+  unreadCount: false
+  offlinePush:
+    enable: true
+    title: "Someone applies to add your friend application"
+    desc: "Someone applies to add your friend application"
+    ext: "Someone applies to add your friend application"
+
+friendApplicationRejected:
+  isSendMsg: false
+  reliabilityLevel: 1
+  unreadCount: false
+  offlinePush:
+    enable: true
+    title: "Someone rejected your friend application"
+    desc: "Someone rejected your friend application"
+    ext: "Someone rejected your friend application"
+
+friendAdded:
+  isSendMsg: false
+  reliabilityLevel: 1
+  unreadCount: false
+  offlinePush:
+    enable: true
+    title: "We have become friends"
+    desc: "We have become friends"
+    ext: "We have become friends"
+
+friendDeleted:
+  isSendMsg: false
+  reliabilityLevel: 1
+  unreadCount: false
+  offlinePush:
+    enable: true
+    title: "deleted a friend"
+    desc: "deleted a friend"
+    ext: "deleted a friend"
+
+friendRemarkSet:
+  isSendMsg: false
+  reliabilityLevel: 1
+  unreadCount: false
+  offlinePush:
+    enable: true
+    title: "Your friend's profile has been changed"
+    desc: "Your friend's profile has been changed"
+    ext: "Your friend's profile has been changed"
+
+blackAdded:
+  isSendMsg: false
+  reliabilityLevel: 1
+  unreadCount: false
+  offlinePush:
+    enable: true
+    title: "blocked a user"
+    desc: "blocked a user"
+    ext: "blocked a user"
+
+blackDeleted:
+  isSendMsg: false
+  reliabilityLevel: 1
+  unreadCount: false
+  offlinePush:
+    enable: true
+    title: "Remove a blocked user"
+    desc: "Remove a blocked user"
+    ext: "Remove a blocked user"
+
+friendInfoUpdated:
+  isSendMsg: false
+  reliabilityLevel: 1
+  unreadCount: false
+  offlinePush:
+    enable: true
+    title: "friend info updated"
+    desc: "friend info updated"
+    ext: "friend info updated"
+
+#####################user#########################
+userInfoUpdated:
+  isSendMsg: false
+  reliabilityLevel: 1
+  unreadCount: false
+  offlinePush:
+    enable: true
+    title: "Remove a blocked user"
+    desc: "Remove a blocked user"
+    ext: "Remove a blocked user"
+
+userStatusChanged:
+  isSendMsg: false
+  reliabilityLevel: 1
+  unreadCount: false
+  offlinePush:
+    enable: false
+    title: "user status changed"
+    desc: "user status changed"
+    ext: "user status changed"
+
+#####################conversation#########################
+conversationChanged:
+  isSendMsg: false
+  reliabilityLevel: 1
+  unreadCount: false
+  offlinePush:
+    enable: true
+    title: "conversation changed"
+    desc: "conversation changed"
+    ext: "conversation changed"
+
+conversationSetPrivate:
+  isSendMsg: true
+  reliabilityLevel: 1
+  unreadCount: false
+  offlinePush:
+    enable: true
+    title: "burn after reading"
+    desc: "burn after reading"
+    ext: "burn after reading"

config/templates/open-im-ng-example.conf

@@ -169,4 +169,4 @@ server {
 
         proxy_pass http://minio_console_2; # This uses the upstream directive definition to load balance
     }
-}
+}

config/templates/prometheus.yml.template

@@ -0,0 +1,99 @@
+# 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.
+
+# my global config
+global:
+  scrape_interval:     15s # Set the scrape interval to every 15 seconds. Default is every 1 minute.
+  evaluation_interval: 15s # Evaluate rules every 15 seconds. The default is every 1 minute.
+  # scrape_timeout is set to the global default (10s).
+
+# Alertmanager configuration
+alerting:
+  alertmanagers:
+    - static_configs:
+        - targets: ['172.28.0.1:19093']
+
+# Load rules once and periodically evaluate them according to the global 'evaluation_interval'.
+rule_files:
+  - "instance-down-rules.yml"
+# - "first_rules.yml"
+# - "second_rules.yml"
+
+# A scrape configuration containing exactly one endpoint to scrape:
+# Here it's Prometheus itself.
+scrape_configs:
+  # The job name is added as a label "job='job_name'"" to any timeseries scraped from this config.
+  # Monitored information captured by prometheus
+  - job_name: 'node-exporter'
+    static_configs:
+      - targets: [ '172.28.0.1:19100' ]
+        labels:
+          namespace: 'default'
+
+  # prometheus fetches application services
+  - job_name: 'openimserver-openim-api'
+    static_configs:
+      - targets: [ '172.28.0.1:20100' ]
+        labels:
+          namespace: 'default'
+  - job_name: 'openimserver-openim-msggateway'
+    static_configs:
+      - targets: [ '172.28.0.1:20140' ]
+        labels:
+          namespace: 'default'
+  - job_name: 'openimserver-openim-msgtransfer'
+    static_configs:
+      - targets: [ 172.28.0.1:21400, 172.28.0.1:21401, 172.28.0.1:21402, 172.28.0.1:21403 ]
+        labels:
+          namespace: 'default'
+  - job_name: 'openimserver-openim-push'
+    static_configs:
+      - targets: [ '172.28.0.1:20170' ]
+        labels:
+          namespace: 'default'
+  - job_name: 'openimserver-openim-rpc-auth'
+    static_configs:
+      - targets: [ '172.28.0.1:20160' ]
+        labels:
+          namespace: 'default'
+  - job_name: 'openimserver-openim-rpc-conversation'
+    static_configs:
+      - targets: [ '172.28.0.1:20230' ]
+        labels:
+          namespace: 'default'
+  - job_name: 'openimserver-openim-rpc-friend'
+    static_configs:
+      - targets: [ '172.28.0.1:20120' ]
+        labels:
+          namespace: 'default'
+  - job_name: 'openimserver-openim-rpc-group'
+    static_configs:
+      - targets: [ '172.28.0.1:20150' ]
+        labels:
+          namespace: 'default'
+  - job_name: 'openimserver-openim-rpc-msg'
+    static_configs:
+      - targets: [ '172.28.0.1:20130' ]
+        labels:
+          namespace: 'default'
+  - job_name: 'openimserver-openim-rpc-third'
+    static_configs:
+      - targets: [ '172.28.0.1:21301' ]
+        labels:
+          namespace: 'default'
+  - job_name: 'openimserver-openim-rpc-user'
+    static_configs:
+      - targets: [ '172.28.0.1:20110' ]
+        labels:
+          namespace: 'default'