Merge pull request #2304 from withchao/release-v3.7

fix: s3 config

.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/datasource-compose.yaml

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

.docker-compose_cfg/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

@@ -5,9 +5,8 @@
 .git
 
 # Ignore build artifacts
-_output/
 logs/
-
+_output/
 # Ignore non-essential documentation
 README.md
 README-zh_CN.md
@@ -18,9 +17,6 @@ CHANGELOG/
 # Ignore testing and linting configuration
 .golangci.yml
 
-# Ignore deployment-related files
-docker-compose.yaml
-deployments/
 
 # Ignore assets
 assets/

.env

@@ -1,285 +1,17 @@
-# Copyright © 2023 OpenIM. All rights reserved.
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
 
-# ======================================
-# ========= Basic Configuration ========
-# ======================================
+MONGO_IMAGE=mongo:6.0.2
+REDIS_IMAGE=redis:7.0.0
+ZOOKEEPER_IMAGE=bitnami/zookeeper:3.8
+KAFKA_IMAGE=bitnami/kafka:3.5.1
+MINIO_IMAGE=minio/minio:RELEASE.2024-01-11T07-46-16Z
 
-# 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
+OPENIM_WEB_FRONT_IMAGE=openim/openim-web-front:release-v3.5.1
+OPENIM_ADMIN_FRONT_IMAGE=openim/openim-admin-front:release-v1.7
 
-# Endpoint for the MinIO object storage service.
-# Default: MINIO_ENDPOINT=http://172.28.0.1:10005
-MINIO_ENDPOINT=http://172.28.0.1:10005
+#FRONT_IMAGE: use aliyun images
+#OPENIM_WEB_FRONT_IMAGE=registry.cn-hangzhou.aliyuncs.com/openimsdk/openim-web-front:release-v3.5.1
+#OPENIM_ADMIN_FRONT_IMAGE=registry.cn-hangzhou.aliyuncs.com/openimsdk/openim-admin-front:release-v1.7
 
-# Base URL for the application programming interface (API).
-# Default: API_URL=http://172.0.0.1:10002
-API_URL=http://172.0.0.1:10002
-
-# Directory path for storing data files or related information.
-# Default: DATA_DIR=./
 DATA_DIR=./
 
-# Choose the appropriate image address, the default is GITHUB image, 
-# you can choose docker hub, for Chinese users can choose Ali Cloud
-# export IMAGE_REGISTRY="ghcr.io/openimsdk"
-# export IMAGE_REGISTRY="openim"
-# export IMAGE_REGISTRY="registry.cn-hangzhou.aliyuncs.com/openimsdk"
-IMAGE_REGISTRY=ghcr.io/openimsdk
-
-# ======================================
-# ========= Network Configuration ======
-# ======================================
-
-# 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

.gitattributes

@@ -0,0 +1 @@
+*.sh text eol=lf

.github/code-language-detector.yml

@@ -1,5 +1,4 @@
-#!/usr/bin/env bash
-# Copyright © 2023 OpenIM. All rights reserved.
+# 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.
@@ -12,3 +11,12 @@
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.
+
+# https://github.com/marketplace/actions/code-language-detector
+directory: ./
+file_types:
+  - .go
+  - .yaml
+  - .yml
+languages:
+  - Chinese

.github/release-drafter.yml

@@ -48,4 +48,4 @@ template: |
 
   ## Contributors to this $REPOSITORY	release
 
-  $CONTRIBUTORS	
+  $CONTRIBUTORS	

.github/standardizer.yml

@@ -0,0 +1,50 @@
+# https://github.com/marketplace/actions/conformity-checker-for-project
+baseConfig:
+  searchDirectory: "./"
+  ignoreCase: false
+
+directoryNaming:
+  allowHyphens: true
+  allowUnderscores: false
+  mustBeLowercase: true
+
+fileNaming:
+  allowHyphens: true
+  allowUnderscores: true
+  mustBeLowercase: true
+
+ignoreFormats:
+  - "\\.log$"
+  - "\\.env$"
+  - "README\\.md$"
+  - "_test\\.go$"
+  - "\\.md$"
+  - _test\\.txt$
+  - LICENSE
+  - Dockerfile
+  - CODEOWNERS
+  - Makefile
+
+ignoreDirectories:
+  - "vendor"
+  - ".git"
+  - "deployments"
+  - "node_modules"
+  - "logs"
+  - "CHANGELOG"
+  - "components"
+  - "_output"
+  - "tools/openim-web"
+  - "CHANGELOG"
+  - "examples/Test_directory"
+  - test/testdata
+
+fileTypeSpecificNaming:
+  ".yaml":
+    allowHyphens: true
+    allowUnderscores: false
+    mustBeLowercase: true
+  ".go":
+    allowHyphens: false
+    allowUnderscores: true
+    mustBeLowercase: true

.github/workflows/api-test.yml

@@ -1,90 +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 API TEST
-
-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:
-  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@v4
-      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: |
-        curl -o docker-compose.yml https://raw.githubusercontent.com/OpenIMSDK/openim-docker/main/example/basic-openim-server-dependency.yml
-        sudo docker compose up -d
-        sudo sleep 60
-
-    - name: Module Operations
-      run: |
-        sudo make tidy
-        sudo make tools.verify.go-gitlint
-
-    - name: Build, Start, Check Services and Print Logs
-      run: |
-        sudo ./scripts/install/install.sh -i && \
-        sudo ./scripts/install/install.sh -s && \
-        (echo "An error occurred, printing logs:" && sudo cat ./_output/logs/* 2>/dev/null)
-
-    - name: Run Test
-      run: |
-        sudo make test-api && \
-        (echo "An error occurred, printing logs:" && sudo cat ./_output/logs/* 2>/dev/null)
-
-    - name: Stop Services
-      run: |
-        sudo ./scripts/install/install.sh -u && \
-        (echo "An error occurred, printing logs:" && sudo cat ./_output/logs/* 2>/dev/null)

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

@@ -28,7 +28,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
       
       - name: Sync Issue to PR
         if: github.event_name == 'pull_request' && github.event.pull_request.base.ref == 'main'

.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 }}

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

@@ -23,8 +23,9 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Comment cherry-pick command
-        uses: actions/github-script@v6
+        uses: actions/github-script@v7
         with:
+          github-token: ${{ secrets.BOT_GITHUB_TOKEN }}
           script: |
             const pr = context.payload.pull_request;
             if (!pr.merged) {
@@ -63,5 +64,4 @@ jobs:
               repo: context.repo.repo,
               issue_number: pr.number,
               body: cherryPickCmd
-            });
-          github-token: ${{ secrets.BOT_GITHUB_TOKEN }}
+            });

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

@@ -12,23 +12,57 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-name: Github Rebot for Cherry Pick On Comment
+name: Github Robot for Cherry Pick On Comment
+
 on:
   issue_comment:
     types: [created]
+
 jobs:
   cherry-pick:
     name: Cherry Pick
-    # && github.event.comment.user.login=='kubbot'
     if: github.event.issue.pull_request != '' && contains(github.event.comment.body, '/cherry-pick')
     runs-on: ubuntu-latest
+
     steps:
       - name: Checkout the latest code
         uses: actions/checkout@v4
         with:
           token: ${{ secrets.BOT_GITHUB_TOKEN }}
-          fetch-depth: 0 # otherwise, you will fail to push refs to dest repo
+          fetch-depth: 0 # To ensure all history is available for cherry-picking
+
       - name: Automatic Cherry Pick
         uses: vendoo/gha-cherry-pick@v1
+        with:
+          # Assuming the cherry-pick commit SHA is passed in the comment like '/cherry-pick sha'
+          commit-sha: ${{ github.event.comment.body }}
         env:
-          GITHUB_TOKEN: ${{ secrets.BOT_GITHUB_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.BOT_GITHUB_TOKEN }}
+
+      - name: Create a new branch for PR
+        run: |
+          PR_BRANCH="cherry-pick-${GITHUB_SHA}-to-${{ github.base_ref }}"
+          git checkout -b $PR_BRANCH
+          git push origin $PR_BRANCH
+        env:
+          GITHUB_TOKEN: ${{ secrets.BOT_GITHUB_TOKEN }}
+
+      - name: Create Pull Request
+        uses: actions/github-script@v5
+        with:
+          script: |
+            const prTitle = "Cherry-pick to ${{ github.base_ref }}"
+            const prBody = "Automated cherry-pick of ${{ github.event.comment.body }}\n\n/cc @kubbot"
+            const base = "${{ github.base_ref }}"
+            const head = "cherry-pick-${{ github.sha }}-to-${{ github.base_ref }}"
+            const createPr = await github.rest.pulls.create({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              title: prTitle,
+              body: prBody,
+              head: head,
+              base: base,
+              maintainer_can_modify: true, // Allows maintainers to edit the PR
+            })
+        env:
+          GITHUB_TOKEN: ${{ secrets.BOT_GITHUB_TOKEN }}

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

@@ -43,15 +43,17 @@ jobs:
 # docker.io/openim/openim-server:latest
       - name: Extract metadata (tags, labels) for Docker
         id: meta
-        uses: docker/metadata-action@v5.0.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
@@ -84,9 +86,20 @@ jobs:
 # registry.cn-hangzhou.aliyuncs.com/openimsdk/openim-server:latest
       - name: Extract metadata (tags, labels) for Docker
         id: meta2
-        uses: docker/metadata-action@v5.0.0
+        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@v3
@@ -117,15 +130,17 @@ jobs:
 # ghcr.io/openimsdk/openim-server:latest
       - name: Extract metadata (tags, labels) for Docker
         id: meta3
-        uses: docker/metadata-action@v5.0.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

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

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

.github/workflows/check-coverage.yml

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

.github/workflows/cla.yml

@@ -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*,bot-*,bot/*,bot-/*,bot,*[bot]
+  OPEN_IM_SERVER_ALLOWLIST: kubbot,openimbot,bot*,dependabot,sweep-ai,*bot,bot-*,bot/*,bot-/*,bot,*[bot]
 
 jobs:
   CLAAssistant:

.github/workflows/code-language-detector.yml

@@ -1,6 +1,4 @@
-#!/usr/bin/env bash
-
-# Copyright © 2023 OpenIM. All rights reserved.
+# 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.
@@ -14,11 +12,16 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-version="${VERSION}"
-if [ "${version}" == "" ];then
-  version=v`gsemver bump`
-fi
+name: Language Check Workflow Test
 
-if [ -z "`git tag -l ${version}`" ];then
-  git tag -a -m "release version ${version}" ${version}
-fi
+on: [pull_request]
+
+jobs:
+  comment-language-detector:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v4
+
+      - name: Code Language Detector
+        uses: kubecub/comment-lang-detector@v1.0.0

.github/workflows/codeql-analysis.yml

@@ -51,7 +51,7 @@ jobs:
 
       # 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

@@ -1,77 +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: Create Branch on Tag
-
-on:
-  push:
-    tags:
-      - 'v*.*.0'
-
-permissions:
-  contents: write
-  actions: write
-
-jobs:
-  create-branch:
-    runs-on: ubuntu-latest
-    steps:
-    - name: Check out code
-      uses: actions/checkout@v4
-      with:
-        fetch-depth: 0
-
-    - name: Set up Git
-      run: |
-        git config --global user.name 'kubbot'
-        git config --global user.email '3293172751yxy@gmail.com'
-
-    - name: Install git-chglog
-      run: make install.git-chglog
-
-    - name: Create Branch and Push
-      env:
-        TAG_NAME: ${{ github.ref_name }}
-      run: |
-        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: Create and Commit CHANGELOG
-      if: endsWith(github.ref_name, '.0')
-      run: |
-        git fetch --all
-        TAG_NAME=${GITHUB_REF#refs/tags/}
-        IFS='.' read -ra VERSION_PARTS <<< "$TAG_NAME"
-        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 CHANGELOG to Main
-      if: steps.create-and-commit-changelog.outputs.changes == 'true'
-      uses: ad-m/github-push-action@v0.6.0
-      with:
-        github_token: ${{ secrets.BOT_GITHUB_TOKEN }}
-        branch: main
-    continue-on-error: true

.github/workflows/depsreview.yaml

@@ -15,4 +15,4 @@ jobs:
       - name: 'Checkout Repository'
         uses: actions/checkout@v4
       - name: 'Dependency Review'
-        uses: actions/dependency-review-action@v3
+        uses: actions/dependency-review-action@v4

.github/workflows/docker-buildx.yml

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

.github/workflows/e2e-test.yml

@@ -1,100 +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 Linux System E2E Test
-
-on:
-  workflow_dispatch:
-  pull_request:
-  push:
-  schedule:
-    # run e2e test every 4 hours
-    - cron: 0 */4 * * *
-
-jobs:
-  build:
-    name: Test
-    runs-on: ubuntu-latest
-    env:
-      GO111MODULE: on
-    steps:
-
-      - name: Set up Go 1.21
-        uses: actions/setup-go@v4
-        with:
-          go-version: 1.21
-        id: go
-
-      - name: Check out code into the Go module directory
-        uses: actions/checkout@v4
-
-      - name: Create e2e test
-        run: |
-          echo "...test e2e"
-
-  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@v4
-      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: |
-        curl -o docker-compose.yml https://raw.githubusercontent.com/OpenIMSDK/openim-docker/main/example/basic-openim-server-dependency.yml
-        sudo docker compose up -d
-        sudo sleep 60
-
-    - name: Module Operations
-      run: |
-        sudo make tidy
-        sudo make tools.verify.go-gitlint
-
-    - name: Build, Start
-      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
-    
-    - name: Exec OpenIM E2E test
-      run: |
-        sudo make test-e2e
-
-    - name: Exec OpenIM System uninstall
-      run: |
-        sudo ./scripts/install/install.sh -u

.github/workflows/golangci-lint.yml

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

.github/workflows/greetings.yml

@@ -26,7 +26,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - uses: actions/first-interaction@v1.2.0
+      - 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/link-pr.yml

@@ -27,7 +27,7 @@ jobs:
 
       - 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,8 +39,9 @@ jobs:
       statuses: none
 
     steps:
-      - uses: actions/github-script@v6 # v6
+      - uses: actions/github-script@v7 # v6
         with:
+          github-token: ${{ secrets.BOT_GITHUB_TOKEN }}
           script: |
             if (!context.payload.pull_request.merged) {
               console.log('PR was not merged, skipping.');
@@ -56,9 +57,10 @@ jobs:
               owner: context.repo.owner,
               repo: context.repo.repo,
               state: 'open',
-              sort: 'due_on',
-              direction: 'asc'
+              sort: 'title',
+              direction: 'desc'
             })
+
             if (milestones.data.length === 0) {
               console.log('There are no milestones, skipping.');
               return;

.github/workflows/opencommit.yml

@@ -28,10 +28,10 @@ jobs:
     permissions: write-all
     steps:
       - name: Setup Node.js Environment
-        uses: actions/setup-node@v2
+        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
@@ -51,4 +51,5 @@ jobs:
           OCO_EMOJI: false
           OCO_MODEL: gpt-3.5-turbo-16k
           OCO_LANGUAGE: en
-          OCO_PROMPT_MODULE: conventional-commit
+          OCO_PROMPT_MODULE: conventional-commit
+        continue-on-error: true

.github/workflows/openimci.yml

@@ -1,3 +1,4 @@
+
 # Copyright © 2023 OpenIM open source community. All rights reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -11,188 +12,180 @@
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.
-
-name: OpenIM CI Aotu Build and Install
+name: OpenIM CI Auto Build
 
 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"
-
+  workflow_dispatch:
 
 jobs:
-  openim:
-    name: Test with go ${{ matrix.go_version }} on ${{ matrix.os }}
-    runs-on: ${{ matrix.os }}
-    permissions:
-        contents: write
-    environment:
-      name: openim
 
-    strategy:
-      matrix:
-        go_version: ["1.19","1.20","1.21"]
-        os: [ubuntu-latest]
-
-    steps:
-    - name: Setup
-      uses: actions/checkout@v4
-      
-    - name: Set up Go ${{ matrix.go_version }}
-      uses: actions/setup-go@v4
-      with:
-        go-version: ${{ matrix.go_version }}
-      id: go
-
-    - name: Install Task
-      uses: arduino/setup-task@v1
-      with:
-        version: '3.x' # If available, use the latest major version that's compatible
-        repo-token: ${{ secrets.GITHUB_TOKEN }}
-
-    - name: Module Operations
-      run: |
-        sudo make tidy
-        sudo make tools.verify.go-gitlint
-
-    - name: Format Code
-      run: sudo make format
-      continue-on-error: true
-
-    - name: Generate Files
-      run: make gen
-      continue-on-error: true
-
-    - name: Build Source
-      run: sudo make build
-
-    - name: Cleanup Build
-      run: sudo make clean
-
-    - name: Push Changes to Main
-      uses: stefanzweifel/git-auto-commit-action@v5
-      with:
-        commit_message: "cicd: robot automated Change"
-        branch: main
-      continue-on-error: true
-
-    - name: Set Current Directory
-      id: set_directory
-      run: echo "::set-output name=directory::$(pwd)"
-      continue-on-error: true
-
-    - name: Collect and Display Test Coverage
-      id: collect_coverage
-      run: |
-        cd ${{ steps.set_directory.outputs.directory }}
-        make cover
-        echo "::set-output name=coverage_file::./_output/tmp/coverage.out"
-        echo "Test Coverage:"
-        cat ${{ steps.collect_coverage.outputs.coverage_file }}
-      continue-on-error: true
-
-  openim-start:
-    name: Test OpenIM install/start on ${{ matrix.os }}
-    runs-on: ${{ matrix.os }}
-    environment:
-      name: openim
-    strategy:
-      matrix:
-        go_version: ["1.21"]
-        os: ["ubuntu-latest"]
-    steps:
-    - name: Checkout and Install OpenIM
-      uses: actions/checkout@v4
-    - name: Install Task
-      uses: arduino/setup-task@v1
-      with:
-        version: '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
-
-  execute-scripts:
-    name: Execute OpenIM script on ${{ matrix.os }}
-    runs-on: ${{ matrix.os }}
-    environment:
-      name: openim
-    strategy:
-      matrix:
-        go_version: ["1.20"]
-        os: ["ubuntu-latest"]
-    steps:
-    - name: Checkout code
-      uses: actions/checkout@v4
-
-    - name: Set up Go ${{ matrix.go_version }}
-      uses: actions/setup-go@v4
-      with:
-        go-version: ${{ matrix.go_version }}
-      id: go
-
-    - name: Install Task
-      uses: arduino/setup-task@v1
-      with:
-        version: '3.x' # If available, use the latest major version that's compatible
-        repo-token: ${{ secrets.GITHUB_TOKEN }}
-
-    - name: Docker Operations
-      run: |
-        curl -o docker-compose.yml https://raw.githubusercontent.com/OpenIMSDK/openim-docker/main/example/basic-openim-server-dependency.yml
-        sudo docker compose up -d
-        sudo sleep 60
-
-    - name: Module Operations
-      run: |
-        sudo make tidy
-        sudo make tools.verify.go-gitlint
-
-    - name: Build, Start, Check Services and Print Logs
-      run: |
-        sudo make init && \
-        sudo make build && \
-        sudo make start && \
-        sudo make check || \
-        (echo "An error occurred, printing logs:" && sudo cat ./_output/logs/* 2>/dev/null)
-
-  openim-test-build-image:
-    name: Build OpenIM Docker Image
+  build-linux:
+    name: Execute OpenIM Script On Linux
     runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      pull-requests: write
     environment:
       name: openim
+    strategy:
+      matrix:
+        arch: [arm64, armv7, amd64]
+    
     steps:
-    - name: Checkout code
-      uses: actions/checkout@v4
-    - name: Set up Go ${{ matrix.go_version }}
+    - uses: actions/checkout@v3
+
+    - name: Set up Go
       uses: actions/setup-go@v4
       with:
-        go-version: ${{ matrix.go_version }}
-      id: go
+        go-version: '1.21'
 
-    - 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
+    - name: Set up Docker for Linux
       run: |
-        sudo make image
+        sudo docker compose up -d
+        sudo sleep 30  # Increased sleep time for better stability
+      timeout-minutes: 20  # Increased timeout for Docker setup
+
+
+    - name: init
+      run: sudo bash bootstrap.sh
+      timeout-minutes: 20
+
+    - name: Build, Start, Check Services and Print Logs for Linux
+      run: |
+        sudo mage
+        sudo mage start
+        sudo mage check
+        
+
+    - name: Restart Services and Print Logs
+      run: |
+        sudo mage stop
+        sudo mage start
+        sudo mage check
+
+
+#  build-mac:
+#    name: Execute OpenIM Script On macOS
+#    runs-on: macos-latest
+#    permissions:
+#      contents: write
+#      pull-requests: write
+#    environment:
+#      name: openim
+#    strategy:
+#      matrix:
+#        arch: [arm64, armv7, amd64]
+#    
+#    steps:
+#    - uses: actions/checkout@v3
+
+#    - name: Set up Go
+#      uses: actions/setup-go@v4
+#      with:
+#        go-version: '1.21'
+
+        
+#        while ! docker system info > /dev/null 2>&1; do
+#          echo "Waiting for Docker to start..."
+#          sleep 10  # Increased delay to ensure Docker starts properly
+#        done
+
+#    - name: Install Docker
+#      run: |
+#        brew install docker
+#        brew install docker-compose
+#        sleep 10
+#        docker-compose up -d
+#        sleep 30
+#      timeout-minutes: 20 
+#        
+
+#    - name: init
+#      run: sudo bash bootstrap.sh
+#      timeout-minutes: 20
+
+#    - name: Build, Start, Check Services and Print Logs for Linux
+#      run: |
+#        sudo mage
+#        sudo mage start
+#        sudo mage check
+        
+#    - name: Restart Services and Print Logs
+#      run: |
+#        sudo mage stop
+#        sudo mage start
+#        sudo mage check
+
+#  build-windows:
+#    name: Execute OpenIM Script On Windows
+#    runs-on: windows-latest
+#    permissions:
+#      contents: write
+#      pull-requests: write
+#    environment:
+#      name: openim
+#    strategy:
+#      matrix:
+#        arch: [arm64, armv7, amd64]
+#    
+#    steps:
+#    - uses: actions/checkout@v3
+
+#    - name: Set up Go
+#      uses: actions/setup-go@v4
+#      with:
+#        go-version: '1.21'
+
+#    - name: Set up Docker for Windows
+#      run: |
+#        $images = @("zookeeper", "redis", "kafka")
+#        foreach ($image in $images) {
+#          $tag = "$image:latest"
+#          docker pull $tag | Out-Null
+#          if ($LASTEXITCODE -ne 0) {
+#            Write-Host "Skipping $image as it is not available for Windows"
+#          } else {
+#            Write-Host "Successfully pulled $image"
+#          }
+#        }
+#        docker compose up -d
+#        Start-Sleep -Seconds 30
+#      timeout-minutes: 20
+#      shell: pwsh
+
+#    - name: init
+#      run: bootstrap.bat
+#      timeout-minutes: 20
+
+#    - name: Build, Start, Check Services and Print Logs for Linux
+#      run: |
+#        mage
+#        mage start
+#        mage check        
+
+#    - name: Restart Services and Print Logs
+#      run: |
+#        mage stop
+#        mage start
+#        mage check

.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.bak

@@ -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 * * *'
@@ -37,24 +31,18 @@ jobs:
         with:
           fetch-depth: 0
 
-      - name: Get League branch Patch
-        run: |
-          git config user.name 'openimbot'
-          git config user.email 'openimsdk@qq.com'
-          BRANCH_NAME="auto-pr-$(date +'%Y%m%d%H%M%S')"
-          git checkout -b $BRANCH_NAME
-
       - 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" 
@@ -68,8 +56,34 @@ jobs:
 
       - name: Generate all necessary files, such as error code files
         run: |
-          make generate
-          echo "Generate all necessary files successfully" 
+          make gen.docgo.doc
+          make gen
+          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 Versions Including Pre-release Identifiers
+        run: |
+          latest_tag=$(git describe --tags `git rev-list --tags --max-count=1`)
+          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
@@ -78,38 +92,39 @@ jobs:
           echo "Run unit test and get test coverage successfully" 
         continue-on-error: true
 
-      - 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: 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"
-          author: kubbot <kubbot@3293172751ysy@gmail.com>
-          signoff: false
-          draft: false
-          branch: ''
+          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: "Bump League Patch auto PR: $(date +'%Y%m%d')"
+          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. @ $(date +'%Y%m%d')
+            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

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

.github/workflows/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

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

.github/workflows/sync.yml

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

.gitignore

@@ -32,10 +32,13 @@ _output/
 deployments/charts/generated-configs/
 
 ### OpenIM Config ###
-config/config.yaml
-./config/config.yaml
 .env
-./.env
+config/config.yaml
+config/alertmanager.yml
+config/prometheus.yml
+config/email.tmpl
+config/notification.yaml
+config/instance-down-rules.yml
 
 ### OpenIM deploy ###
 deployments/openim-server/charts
@@ -388,6 +391,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

@@ -39,15 +39,19 @@ run:
   # from this option's value (see skip-dirs-use-default).
   # "/" will be replaced by current OS file path separator to properly work
   # on Windows.
-  skip-dirs:
-    - util
-    - .*~
-    - api/swagger/docs
-    - server/docs
+  # 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$
-  skip-dirs-use-default: true
+  # skip-dirs-use-default: true
 
   # which files to skip: they will be analyzed, but issues from them
   # won't be reported. Default value is empty list, but there is
@@ -55,9 +59,15 @@ run:
   # autogenerated files. If it's not please let us know.
   # "/" will be replaced by current OS file path separator to properly work
   # on Windows.
-  skip-files:
-    - ".*\\.my\\.go$"
-    - _test.go
+  # 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
@@ -77,7 +87,7 @@ run:
 # output configuration options
 output:
   # colored-line-number|line-number|json|tab|checkstyle|code-climate, default is "colored-line-number"
-  format: colored-line-number
+  # format: colored-line-number
 
   # print lines of code with issue, default is true
   print-issued-lines: true
@@ -108,9 +118,7 @@ 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:
     # tokens count to trigger issue, 150 by default
     threshold: 200
@@ -131,8 +139,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
@@ -142,6 +150,11 @@ linters-settings:
     comparison: true
 
   exhaustive:
+    # Program elements to check for exhaustiveness.
+    # Default: [ switch ]
+    check:
+      - switch
+      - map
     # check switch statements in generated files also
     check-generated: false
     # indicates that switch statements are to be considered exhaustive if a
@@ -153,33 +166,34 @@ linters-settings:
     ignore-enum-members: ""
     # consider enums only in package scopes, not in inner scopes
     package-scope-only: false
-  exhaustivestruct:
-    struct-patterns:
-      - '*.Test'
-      - '*.Test2'
-      - '*.Embedded'
-      - '*.External'
 
-  # forbidigo:
+
+  forbidigo:
   #   # Forbid the following identifiers (identifiers are written using regexp):
-  #   forbid:
-  #     - ^print.*$
-  #     - 'fmt\.Print.*'
-  #     - fmt.Println.* # too much log noise
+    forbid:
+      # - ^print.*$
+      - 'fmt\.Print.*'
+      - fmt.Println.* # too much log noise
+      - ^unsafe\..*$
+      - ^init$
+      - ^os.Exit$
+      - ^fmt.Print.*$
+      - errors.New.*$
+      - ^fmt.Println.*$
+      - ^panic$
+      - painc
   #     - ginkgo\\.F.* # these are used just for local development
   #   # Exclude godoc examples from forbidigo checks.  Default is true.
   #   exclude_godoc_examples: false
+
   funlen:
-    lines: 150
+    lines: 220
     statements: 80
-  gci:
-    # put imports beginning with prefix after 3rd-party packages;
-    # only support one prefix
-    # if not set, use goimports.local-prefixes
-    prefix: github.com/openimsdk/open-im-server
+
   gocognit:
     # minimal code complexity to report, 30 by default (but we recommend 10-20)
     min-complexity: 30
+
   goconst:
     # minimal length of string constant, 3 by default
     min-len: 3
@@ -205,9 +219,6 @@ linters-settings:
     # By default list of stable checks is used.
     enabled-checks:
       #- rangeValCopy
-      - nestingreduce
-      - truncatecmp
-      - unnamedresult
       - ruleguard
 
     # Which checks should be disabled; can't be combined with 'enabled-checks'; default is empty
@@ -236,9 +247,6 @@ linters-settings:
       hugeParam:
         # size in bytes that makes the warning trigger (default 80)
         sizeThreshold: 80
-      nestingReduce:
-        # min number of statements inside a branch to trigger a warning (default 5)
-        bodyWidth: 5
       rangeExprCopy:
         # size in bytes that makes the warning trigger (default 512)
         sizeThreshold: 512
@@ -252,15 +260,10 @@ linters-settings:
       ruleguard:
         # path to a gorules file for the ruleguard checker
         rules: ''
-      truncateCmp:
-        # whether to skip int/uint/uintptr types (default true)
-        skipArchDependent: true
       underef:
         # whether to skip (*x).method() calls where x is a pointer receiver (default true)
         skipRecvDeref: true
-      unnamedResult:
-        # whether to check exported functions
-        checkExported: true
+
   gocyclo:
     # minimal code complexity to report, 30 by default (but we recommend 10-20)
     min-complexity: 30
@@ -277,9 +280,12 @@ linters-settings:
     # list of regexps for excluding particular comment lines from check
     exclude:
       # example: exclude comments which contain numbers
-      # - '[0-9]+'
+      - '[0-9]+'
+      - 'func\s+\w+'
+      - 'FIXME:'
+      - '.*func.*'
     # check that each sentence starts with a capital letter
-    capital: false
+    capital: true
   godox:
     # report any comments starting with keywords, this is useful for TODO or FIXME comments that
     # might be left in the code accidentally and should be resolved before merging
@@ -302,15 +308,15 @@ linters-settings:
     # by default
     extra-rules: false
 
-  goheader:
-    values:
-      const:
+  # goheader:
+    # values:
+      # const:
         # define here const type values in format k:v, for example:
         # COMPANY: MY COMPANY
-      regexp:
+      # regexp:
         # define here regexp type values, for example
         # AUTHOR: .*@mycompany\.com
-    template: # |-
+    # template: # |-
       # put here copyright header template for source code files, for example:
       # Note: {{ YEAR }} is a builtin value that returns the year relative to the current machine time.
       #
@@ -328,21 +334,45 @@ linters-settings:
       # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
       # See the License for the specific language governing permissions and
       # limitations under the License.
-    template-path:
+    # template-path:
       # also as alternative of directive 'template' you may put the path to file with the template source
+
   goimports:
     # put imports beginning with prefix after 3rd-party packages;
     # it's a comma-separated list of prefixes
     local-prefixes: github.com/openimsdk/open-im-server
 
   gomnd:
-    settings:
-      mnd:
-        # the list of enabled checks, see https://github.com/tommy-muehle/go-mnd/#checks for description.
-        checks: argument,case,condition,operation,return,assign
-        # ignored-numbers: 1000
-        # ignored-files: magic_.*.go
-        # ignored-functions: math.*
+    # List of enabled checks, see https://github.com/tommy-muehle/go-mnd/#checks for description.
+    # Default: ["argument", "case", "condition", "operation", "return", "assign"]
+    checks:
+      - argument
+      - case
+      - condition
+      - operation
+      - return
+      - assign
+    # List of numbers to exclude from analysis.
+    # The numbers should be written as string.
+    # Values always ignored: "1", "1.0", "0" and "0.0"
+    # Default: []
+    ignored-numbers:
+      - '0666'
+      - '0755'
+      - '42'
+    # List of file patterns to exclude from analysis.
+    # Values always ignored: `.+_test.go`
+    # Default: []
+    ignored-files:
+      - 'magic1_.+\.go$'
+    # List of function patterns to exclude from analysis.
+    # Following functions are always ignored: `time.Date`,
+    # `strconv.FormatInt`, `strconv.FormatUint`, `strconv.FormatFloat`,
+    # `strconv.ParseInt`, `strconv.ParseUint`, `strconv.ParseFloat`.
+    # Default: []
+    ignored-functions:
+      - '^math\.'
+      - '^webhook\.StatusText$'
   gomoddirectives:
     # Allow local `replace` directives. Default is false.
     replace-local: true
@@ -354,6 +384,7 @@ linters-settings:
     retract-allow-no-explanation: false
     # Forbid the use of the `exclude` directives. Default is false.
     exclude-forbidden: false
+
   gomodguard:
     allowed:
       modules:    
@@ -417,9 +448,6 @@ linters-settings:
     checks: [ "all" ]
 
   govet:
-    # report about shadowed variables
-    check-shadowing: true
-
     # settings per analyzer
     settings:
       printf: # analyzer name, run `go tool vet help` to see all analyzers
@@ -436,15 +464,25 @@ linters-settings:
     disable:
       - shadow
     disable-all: false
-  # depguard:
-  #   list-type: blacklist
-  #   include-go-root: false
-  #   packages:
-  #     - github.com/Sirupsen/logrus
-  #   packages-with-error-message:
-  #     # specify an error message to output when a blacklisted package is used
-  #     - github.com/Sirupsen/logrus: "logging is allowed only by logutils.Log"
 
+  depguard:
+    rules:
+      prevent_unmaintained_packages:
+        list-mode: lax # allow unless explicitely denied
+        files:
+          - $all
+          - "!$test"
+        allow:
+          - $gostd
+        deny:
+          - pkg: io/ioutil
+            desc: "replaced by io and os packages since Go 1.16: https://tip.golang.org/doc/go1.16#ioutil"
+          - pkg: github.com/OpenIMSDK
+            desc: "The OpenIM organization has been replaced with lowercase, please do not use uppercase organization name, you will use openimsdk"
+          - pkg: log
+            desc: "We have a wrapped log package at openim, we recommend you to use our wrapped log package, https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/logging.md"
+          - pkg: errors
+            desc: "We have a wrapped errors package at openim, we recommend you to use our wrapped errors package, https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/error-code.md"
 
   importas:
     # if set to `true`, force to use alias.
@@ -454,6 +492,8 @@ linters-settings:
       # using `servingv1` alias for `knative.dev/serving/pkg/apis/serving/v1` package
       - pkg: knative.dev/serving/pkg/apis/serving/v1
         alias: servingv1
+      - pkg: gopkg.in/yaml.v2
+        alias: yaml
       # using `autoscalingv1alpha1` alias for `knative.dev/serving/pkg/apis/autoscaling/v1alpha1` package
       - pkg: knative.dev/serving/pkg/apis/autoscaling/v1alpha1
         alias: autoscalingv1alpha1
@@ -462,8 +502,6 @@ linters-settings:
       # see https://github.com/julz/importas#use-regular-expression for details
       - pkg: knative.dev/serving/pkg/apis/(\w+)/(v[\w\d]+)
         alias: $1$2
-    # using `jwt` alias for `github.com/appleboy/gin-jwt/v2` package
-    jwt: github.com/appleboy/gin-jwt/v2
 
   ireturn:
     # ireturn allows using `allow` and `reject` settings at the same time.
@@ -489,14 +527,11 @@ 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:
-    # print struct with more effective memory layout or not, false by default
-    suggest-new: true
   misspell:
     # Correct spellings using locale preferences for US or UK.
     # Default is to use a neutral variety of English.
@@ -529,8 +564,6 @@ linters-settings:
   nolintlint:
     # Disable to ensure that all nolint directives actually have an effect. Default is true.
     allow-unused: false
-    # Disable to ensure that nolint directives don't have a leading space. Default is true.
-    allow-leading-space: true
     # Exclude following linters from requiring an explanation.  Default is [].
     allow-no-explanation: [ ]
     # Enable to require an explanation of nonzero length after each nolint directive. Default is false.
@@ -554,14 +587,13 @@ linters-settings:
     strict: false
     # Please refer to https://github.com/yeya24/promlinter#usage for detailed usage.
     disabled-linters:
-    #  - "Help"
-    #  - "MetricUnits"
-    #  - "Counter"
-    #  - "HistogramSummaryReserved"
-    #  - "MetricTypeInName"
-    #  - "ReservedChars"
-    #  - "CamelCase"
-    #  - "lintUnitAbbreviations"
+     - "Help"
+     - "MetricUnits"
+     - "Counter"
+     - "HistogramSummaryReserved"
+     - "MetricTypeInName"
+     - "ReservedChars"
+     - "CamelCase"
     
   predeclared:
     # comma-separated list of predeclared identifiers to not report on
@@ -571,6 +603,7 @@ linters-settings:
   rowserrcheck:
     packages:
       - github.com/jmoiron/sqlx
+
   revive:
     # see https://github.com/mgechev/revive#available-rules for details.
     ignore-generated-header: true
@@ -578,15 +611,27 @@ linters-settings:
     rules:
       - name: indent-error-flow
         severity: warning
+      - name: exported
+        severity: warning
+      - name: var-naming
+        arguments: [ [ "OpenIM"] ]
+        # arguments: [ ["ID", "HTTP", "URL", "URI", "API", "APIKey", "Token", "TokenID", "TokenSecret", "TokenKey", "TokenSecret", "JWT", "JWTToken", "JWTTokenID", "JWTTokenSecret", "JWTTokenKey", "JWTTokenSecret", "OAuth", "OAuthToken", "RPC" ] ]
+      - name: atomic
+      - name: line-length-limit
+        severity: error
+        arguments: [200]
+      - name: unhandled-error
+        arguments : ["fmt.Printf", "myFunction"]
+
   staticcheck:
     # Select the Go version to target. The default is '1.13'.
-    go: "1.16"
+    go: "1.20"
     # https://staticcheck.io/docs/options#checks
     checks: [ "all" ]
 
   stylecheck:
     # Select the Go version to target. The default is '1.13'.
-    go: "1.16"
+    go: "1.20"
 
     # https://staticcheck.io/docs/options#checks
     checks: [ "all", "-ST1000", "-ST1003", "-ST1016", "-ST1020", "-ST1021", "-ST1022" ]
@@ -598,7 +643,6 @@ linters-settings:
     # https://staticcheck.io/docs/options#http_status_code_whitelist
     http-status-code-whitelist: [ "200", "400", "404", "500" ]
 
-
   tagliatelle:
     # check the struck tag name case
     case:
@@ -644,12 +688,11 @@ linters-settings:
     # if it's called for subdir of a project it can't find external interfaces. All text editor integrations
     # with golangci-lint call it on a directory with the changed file.
     check-exported: false
-  unused:
+  # unused:
     # treat code as a program (not a library) and report unused exported identifiers; default is false.
     # XXX: if you enable this setting, unused will report a lot of false-positives in text editors:
     # if it's called for subdir of a project it can't find funcs usages. All text editor integrations
     # with golangci-lint call it on a directory with the changed file.
-    check-exported: false
   whitespace:
     multi-if: false   # Enforces newlines (or comments) after every multi-line if statement
     multi-func: false # Enforces newlines (or comments) after every multi-line function signature
@@ -663,6 +706,7 @@ linters-settings:
       - errors.New(
       - errors.Unwrap(
       - .Wrap(
+      - .WrapMsg(
       - .Wrapf(
       - .WithMessage(
       - .WithMessagef(
@@ -670,6 +714,8 @@ linters-settings:
     ignorePackageGlobs:
         - encoding/*
         - github.com/pkg/*
+        - github.com/openimsdk/*
+        - github.com/OpenIMSDK/*
 
   wsl:
     # If true append is only allowed to be cuddled if appending value is
@@ -696,7 +742,6 @@ linters-settings:
     # Allow only slices initialized with a length of zero. Default is false.
     always: false
 
-
   # The custom section can be used to define linter plugins to be loaded at runtime. See README doc
   #  for more info.
   #custom:
@@ -715,17 +760,38 @@ linters:
   # enable-all: true
   disable-all: true
   enable:
-    - typecheck     # 基本的类型检查
-    - gofmt         # 格式检查
-    - govet         # Go 语言的标准检查工具
-    - gosimple      # 简化代码的建议
-    - misspell      # 拼写错误
-    - staticcheck   # 静态检查
-    - unused        # 未使用的代码检查
-    - goimports     # 检查导入是否正确排序和格式化
-    - godot         # 注释句点检查
-    - bodyclose     # 确保 HTTP response body 被关闭
-    - errcheck      # 检查是否遗漏了错误返回值
+    - typecheck     # Basic type checking
+    - gofmt         # Format check
+    - govet         # Go's standard linting tool
+    - gosimple      # Suggestions for simplifying code
+    - errcheck
+    - decorder
+    - ineffassign
+    - forbidigo
+    - revive
+    - reassign
+    - tparallel
+    - unconvert
+    - fieldalignment
+    - dupl
+    - dupword
+    - errname
+    - gci
+    - exhaustive
+    - gocritic
+    - goprintffuncname
+    - gomnd
+    - goconst
+    - 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:
@@ -736,6 +802,7 @@ issues:
   exclude:
     - tools/.*
     - test/.*
+    - components/*
     - third_party/.*
 
   # Excluding configuration per-path, per-linter, per-text and per-source
@@ -792,6 +859,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`.
@@ -852,4 +924,4 @@ severity:
   rules:
     - linters:
       - dupl
-      severity: info
+      severity: info

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-3.6.md

@@ -0,0 +1,20 @@
+# Version logging for OpenIM
+
+<!-- BEGIN MUNGE: GENERATED_TOC -->
+
+<!-- END MUNGE: GENERATED_TOC -->
+
+<a name="unreleased"></a>
+## [Unreleased]
+
+
+<a name="v3.6.0"></a>
+## v3.6.0 - 2024-03-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.6.0...HEAD

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,13 +64,13 @@ 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.
 
@@ -52,7 +84,7 @@ In accordance with the naming conventions adopted by OpenIM and drawing referenc
 
 #### 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!
@@ -67,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.
 
@@ -85,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.
@@ -95,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
@@ -112,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
    ```
@@ -136,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
@@ -145,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
@@ -177,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
 
@@ -190,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 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.
 
@@ -206,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:**
 
@@ -262,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.
 
@@ -311,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.
 
@@ -328,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:
 
@@ -366,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://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.
++ <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

@@ -1,31 +1,49 @@
-# Build Stage
-FROM golang:1.20 AS builder
+# Use Go 1.21 Alpine as the base image for building the application
+FROM golang:1.21-alpine as builder
 
-# Set go mod installation source and proxy
-ARG GO111MODULE=on
-ARG GOPROXY=https://goproxy.cn,direct
-ENV GO111MODULE=$GO111MODULE
-ENV GOPROXY=$GOPROXY
+# Define the base directory for the application as an environment variable
+ENV SERVER_DIR=/openim-server
 
-# Set up the working directory
-WORKDIR /openim/openim-server
+# Set the working directory inside the container based on the environment variable
+WORKDIR $SERVER_DIR
+
+# Set the Go proxy to improve dependency resolution speed
+ENV GOPROXY=https://goproxy.io,direct
+
+# Copy all files from the current directory into the container
+COPY . .
 
-COPY go.mod go.sum ./
 RUN go mod download
 
-# Copy all files to the container
-ADD . .
+# Install Mage to use for building the application
+RUN go install github.com/magefile/mage@v1.15.0
 
-RUN make clean
-RUN make build
+# Optionally build your application if needed
+RUN mage build
 
-FROM ghcr.io/openim-sigs/openim-ubuntu-image:latest
+# Using Alpine Linux with Go environment for the final image
+FROM golang:1.21-alpine
 
-WORKDIR ${SERVER_WORKDIR}
+# Install necessary packages, such as bash
+RUN apk add --no-cache bash
 
-# Copy scripts and binary files to the production image
-COPY --from=builder ${OPENIM_SERVER_BINDIR} /openim/openim-server/_output/bin
-# COPY --from=builder ${OPENIM_SERVER_CMDDIR} /openim/openim-server/scripts
-# COPY --from=builder ${SERVER_WORKDIR}/config /openim/openim-server/config
+# Set the environment and work directory
+ENV SERVER_DIR=/openim-server
+WORKDIR $SERVER_DIR
 
-CMD ["/openim/openim-server/scripts/docker-start-all.sh"]
+
+# Copy the compiled binaries and mage from the builder image to the final image
+COPY --from=builder $SERVER_DIR/_output $SERVER_DIR/_output
+COPY --from=builder $SERVER_DIR/config $SERVER_DIR/config
+COPY --from=builder /go/bin/mage /usr/local/bin/mage
+COPY --from=builder $SERVER_DIR/magefile_windows.go $SERVER_DIR/
+COPY --from=builder $SERVER_DIR/magefile_unix.go $SERVER_DIR/
+COPY --from=builder $SERVER_DIR/magefile.go $SERVER_DIR/
+COPY --from=builder $SERVER_DIR/start-config.yml $SERVER_DIR/
+COPY --from=builder $SERVER_DIR/go.mod $SERVER_DIR/
+COPY --from=builder $SERVER_DIR/go.sum $SERVER_DIR/
+
+RUN go get github.com/openimsdk/gomake@v0.0.13
+
+# Set the command to run when the container starts
+ENTRYPOINT ["sh", "-c", "mage start && tail -f /dev/null"]

Makefile

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

README-zh_CN.md

@@ -1,143 +0,0 @@
-<p align="center">
-    <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://openim.io/en"><b> Docs </b></a>
-</p>
-
-
-</p>
-
-## 🟢 扫描微信进群交流
-<img src="https://openim-1253691595.cos.ap-nanjing.myqcloud.com/WechatIMG20.jpeg" width="300">
-
-
-## Ⓜ️ 关于 OpenIM
-
-OpenIM 不仅仅是一个开源的即时消息组件，它是你的应用程序生态系统的一个不可或缺的部分。查看下面的图表，了解 AppServer、AppClient、OpenIMServer 和 OpenIMSDK 是如何交互的。
-
-![App-OpenIM 关系](./docs/images/oepnim-design.png)
-
-## 🚀 关于 OpenIMSDK
-
-**OpenIMSDK** 无缝集成到您的应用中，提供丰富、实时的消息体验，无需复杂的 UI 集成。它提供：
-
-+ **本地存储**：用于快速数据检索和消息同步。
-+ **监听器回调**：确保实时消息交互性。
-+ **API 封装**：简化开发流程。
-+ **连接管理**：保证可靠的消息传递。
-
-它使用 Golang 构建，并支持跨平台部署，确保在所有平台上提供一致的消息体验。
-
-👉 **[探索 GO SDK](https://github.com/openimsdk/openim-sdk-core)**
-
-## 🌐 关于 OpenIMServer
-
-精心用 Golang 开发的 **OpenIMServer** 通过多重方式确保了卓越的即时消息服务器能力：
-
-+ **模块组成**：它由多个模块组成，例如网关和多个 RPC 服务，提供一个多功能的消息环境。
-+ **微服务架构**：支持集群模式，确保出色的性能和可伸缩性，以有效管理各个实例间的通信。
-+ **多样的部署选项**：适应你的操作偏好，通过源代码、Kubernetes 或 Docker 提供部署选项。
-
-### 增强的业务功能：
-
-+ **REST API**：OpenIMServer 为业务系统提供 REST API，旨在通过后端接口为您的操作提供附加功能，如群组创建和消息推送。
-+ **回调**：为了扩展其在各种业务形式中的实用性，OpenIMServer 提供了回调能力。即，在事件发生之前或之后，它向业务服务器发送请求，比如发送消息，丰富通信过程中的交互和数据交换流。
-
-👉 **[了解更多](https://doc.rentsoft.cn/guides/introduction/product)**
-
-## :rocket: 快速开始
-
-你只需要一个简单的命令，就可以快速学习 OpenIM 的工程解决方案：
-
-```
-bashCopy code
-$ make demo
-```
-
-🤲 为了方便用户体验，我们提供了多种部署解决方案，您可以根据下面的列表选择自己的部署方法：
-
-+ **[源代码部署指南](https://doc.rentsoft.cn/guides/gettingStarted/imSourceCodeDeployment)**
-+ **[Docker 部署指南](https://doc.rentsoft.cn/guides/gettingStarted/dockerCompose)**
-+ **[Kubernetes 部署指南](https://github.com/openimsdk/open-im-server/tree/main/deployments)**
-
-## :hammer_and_wrench: 开始开发 OpenIM
-
-OpenIM 我们的目标是建立一个顶级的开源社区。我们有一套标准，在[社区仓库](https://github.com/OpenIMSDK/community)中。
-
-如果你想为这个 Open-IM-Server 仓库做贡献，请阅读我们的[贡献者文档](https://github.com/openimsdk/open-im-server/blob/main/CONTRIBUTING.md)。
-
-在开始之前，请确保你的更改是有需求的。最好的方法是创建一个[新的讨论](https://github.com/openimsdk/open-im-server/discussions/new/choose) 或 [Slack 通信](https://join.slack.com/t/openimsdk/shared_invite/zt-22720d66b-o_FvKxMTGXtcnnnHiMqe9Q)，或者如果你发现一个问题，首先[报告它](https://github.com/openimsdk/open-im-server/issues/new/choose)。
-
-+ [代码标准](https://github.com/openimsdk/open-im-server/blob/main/docs/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>

README.md

@@ -17,246 +17,123 @@
 [![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/)
 
-[**English**](./README.md) •
-[**简体中文**](./README-zh_CN.md) •
-[**Docs**](https://openim.io/en)
+
+<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>
 
+## :busts_in_silhouette: Join Our Community
+
++ 💬 [Follow us on Twitter](https://twitter.com/founder_im63606)
++ 🚀 [Join our Slack](https://join.slack.com/t/openimsdk/shared_invite/zt-22720d66b-o_FvKxMTGXtcnnnHiMqe9Q)
++ :eyes: [Join our WeChat Group](https://openim-1253691595.cos.ap-nanjing.myqcloud.com/WechatIMG20.jpeg)
 
 ## Ⓜ️ About 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, OpenIMServer, and OpenIMSDK interact.
+Unlike standalone chat applications such as Telegram, Signal, and Rocket.Chat, OpenIM offers an open-source instant messaging solution designed specifically for developers rather than as a directly installable standalone chat app. Comprising OpenIM SDK and OpenIM Server, it provides developers with a complete set of tools and services to integrate instant messaging functions into their applications, including message sending and receiving, user management, and group management. Overall, OpenIM aims to provide developers with the necessary tools and framework to implement efficient instant messaging solutions in their applications.
 
 ![App-OpenIM Relationship](./docs/images/oepnim-design.png)
 
-## 🚀 About OpenIMSDK
+## 🚀 Introduction to OpenIMSDK
 
-**OpenIMSDK** seamlessly integrates into your application, delivering a rich, real-time messaging experience without requiring intricate UI integration. It provides:
+**OpenIMSDK**, designed for **OpenIMServer**, is an IM SDK created specifically for integration into client applications. It supports various functionalities and modules:
 
-+ **Local Storage**: For quick data retrieval and message synchronization.
-+ **Listener Callbacks**: Ensuring real-time message interactivity.
-+ **API Encapsulation**: Streamlining development processes.
-+ **Connection Management**: Guaranteeing reliable message delivery.
++ 🌟 Main Features:
+  - 📦 Local Storage
+  - 🔔 Listener Callbacks
+  - 🛡️ API Wrapping
+  - 🌐 Connection Management
 
-It's crafted in Golang and supports cross-platform deployment, ensuring a coherent messaging experience across all platforms.
++ 📚 Main Modules:
+  1. 🚀 Initialization and Login
+  2. 👤 User Management
+  3. 👫 Friends Management
+  4. 🤖 Group Functions
+  5. 💬 Session Handling
 
-👉 **[Explore GO SDK](https://github.com/openimsdk/openim-sdk-core)**
+Built with Golang and supports cross-platform deployment to ensure a consistent integration experience across all platforms.
 
-## 🌐 About OpenIMServer
+👉 **[Explore the GO SDK](https://github.com/openimsdk/openim-sdk-core)**
 
-**OpenIMServer**, meticulously developed in Golang, ensures a stellar instant messaging server capability with a multifold approach:
+## 🌐 Introduction to OpenIMServer
 
-+ **Modular Composition**: It's comprised of several modules, such as the gateway and multiple RPC services, offering a versatile messaging environment.
-+ **Microservices Architecture**: Supporting cluster modes, it assures outstanding performance and scalability to manage communication effectively across various instances.
-+ **Diverse Deployment Options**: Adapts to your operational preferences, offering deployment via source code, Kubernetes, or Docker.
++ **OpenIMServer** features include:
+  - 🌐 Microservices Architecture: Supports cluster mode, including a gateway and multiple rpc services.
+  - 🚀 Diverse Deployment Options: Supports source code, Kubernetes, or Docker deployment.
+  - Massive User Support: Supports large-scale groups with hundreds of thousands, millions of users, and billions of messages.
 
-### Enhanced Business Functionalities:
+### Enhanced Business Functions:
 
-+ **REST API**: OpenIMServer provides REST API for business systems, aiming to empower your operations with additional functionalities like group creation and message push via backend interfaces.
-+ **Callbacks**: To expand its utility across varied business forms, OpenIMServer offers callback capabilities. That is, it sends a request to the business server before or after an event occurs, such as sending a message, enriching the interaction and data exchange flow in the communication processes.
++ **REST API**: Provides a REST API for business systems to enhance functionality, such as group creation and message pushing through backend interfaces.
 
-👉 **[Learn More](https://docs.openim.io/guides/introduction/product)**
-
-<!--
-
-## :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)      |
-
-</div>
-
-**OpenIM** offers a powerful and reliable instant messaging platform, ensuring versatile communication across multiple platforms with the following key features:
-
-✅ **Versatile Messaging:** Support for text, images, emojis, voice, video, and more, alongside one-on-one and multi-person audio/video calls.
-
-✅ **Robust Chat Capabilities:** Including roles (application administrator, group owner, etc.) and features like muting, group announcements, and dynamic message loading.
-
-✅ **Unique Interaction Features:** Offering read-and-burn private chats and a message editing function to broaden social scenarios.
-
-✅ **Open Source:** The code of OpenIM is open source and aims to build a leading global IM open source community. [GitHub Repository](https://github.com/OpenIMSDK)
-
-✅ **Extensibility:** Implemented in Golang, OpenIM introduces an "everything is a message" communication model, simplifying custom messages and feature extension.
-
-✅ **High Performance:** Supports a hierarchical governance architecture tested and abstracts the storage model of various message types.
-
-✅ **Full Platform Support:** Native support for iOS, Android, Flutter, uni-app, ReactNative, Electron, and Web.
-
--->
++ **Webhooks**: Expands business forms through callbacks, sending requests to business servers before or after certain events.
 
+  ![Overall Architecture](./docs/images/architecture-layers.png)
 
 ## :rocket: Quick Start
 
-You can quickly learn OpenIM engineering solutions, all it takes is one simple command:
+Experience online for iOS/Android/H5/PC/Web:
 
-```bash
-$ make demo
-```
+👉 **[OpenIM Online Demo](https://www.openim.io/en/commercial)**
 
-🤲 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>
-
-It is recommended to use Docker Compose for deployment, which can easily and quickly deploy the entire OpenIM service on a single node
-
-+ [https://github.com/openimsdk/openim-docker](https://github.com/openimsdk/openim-docker)
-
-
-> **Note**
->
-> If you don't know OpenIM's versioning policy, 📚Read our release policy: https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/version.md
-
-
-</details> 
-
-<details>  <summary>Compile from Source</summary>
-
-
-Ur need `Go 1.20` 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/contrib/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/contrib/version.md), We recommend using stable versions such as `v3.3.0` and `v3.2.0` whenever possible. `v3.1.1-alpha.3` as well as `v3.3.0-beta.0` and `v3.2.0-rc.0` are pre-release or beta versions and are not recommended.
-
-Set `OPENIM_VERSION` environment variables for the latest `OPENIM_VERSION` number, or replace the `OPENIM_VERSION` for you to install the OpenIM-Server `OPENIM_VERSION`:
-
-```bash
-$ OPENIM_VERSION=`curl -s https://api.github.com/repos/openimsdk/open-im-server/releases/latest | grep -oE '"tag_name": "[^"]+"' | head -n1 | cut -d'"' -f4`
-# OPENIM_VERSION=v3.3.0
-```
-
-Deploy basic components at the click of a command:
-
-```bash
-# install openim dependency
-$ git clone https://github.com/openimsdk/open-im-server openim/openim-server && export openim=$(pwd)/openim/openim-server && cd $openim/openim-server && git checkout $OPENIM_VERSION
-$ make init && docker compose up -d && make start && make check
-```
-
-> `make help` to help you see the instructions supported by OpenIM.
-
-
-You can use the `make help-all` see OpenIM in action.
-
-</details>
-
-<details>  <summary>Component Configuration Instructions</summary>
-
-Read: Configuration center document：https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/environment.md
-
-</details>
-
-
-<details>  <summary>Deployed with kubernetes</summary>
-
-+ https://github.com/openimsdk/open-im-server/blob/main/deployments/README.md
-
-</details> 
--->
+To facilitate user experience, we offer various deployment solutions. You can choose your preferred deployment method from the list below:
 
 + **[Source Code Deployment Guide](https://docs.openim.io/guides/gettingStarted/imSourceCodeDeployment)**
-+ **[Production deployment of Linux systems](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/install-openim-linux-system.md)**
 + **[Docker Deployment Guide](https://docs.openim.io/guides/gettingStarted/dockerCompose)**
-+ **[Kubernetes Deployment Guide](https://github.com/openimsdk/open-im-server/tree/main/deployments)**
 
-<!-- 
-## :link: OpenIM and your application
+## System Support
 
-OpenIM isn't just an open-source instant messaging component, it's an integral part of your application ecosystem. Check out this diagram to understand how AppServer, AppClient, OpenIMServer, and OpenIMSDK interact.
+Supports Linux, Windows, Mac systems, and ARM and AMD CPU architectures.
 
-![App-OpenIM Relationship](./docs/images/oepnim-design.png)
+## :link: Links
 
-## :building_construction: Overall Architecture
+  + **[Developer Manual](https://docs.openim.io/)**
+  + **[Changelog](https://github.com/openimsdk/open-im-server/blob/main/CHANGELOG.md)**
 
-Delve into the heart of Open-IM-Server's functionality with our architecture diagram.
+## :writing_hand: How to Contribute
 
-![Overall Architecture](./docs/images/Architecture.jpg) -->
+We welcome contributions of any kind! Please make sure to read our [Contributor Documentation](https://github.com/openimsdk/open-im-server/blob/main/CONTRIBUTING.md) before submitting a Pull Request.
 
-## :hammer_and_wrench: To start developing OpenIM
+  + **[Report a Bug](https://github.com/openimsdk/open-im-server/issues/new?assignees=&labels=bug&template=bug_report.md&title=)**
+  + **[Suggest a Feature](https://github.com/openimsdk/open-im-server/issues/new?assignees=&labels=enhancement&template=feature_request.md&title=)**
+  + **[Submit a Pull Request](https://github.com/openimsdk/open-im-server/pulls)**
 
-[![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)
+Thank you for contributing to building a powerful instant messaging solution!
 
-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).
+## :closed_book: License
 
-If you'd like to contribute to this Open-IM-Server repository, please read our [contributor documentation](https://github.com/openimsdk/open-im-server/blob/main/CONTRIBUTING.md).
-
-Before you start, please make sure your changes are in demand. The best for that is to create a [new discussion](https://github.com/openimsdk/open-im-server/discussions/new/choose) OR [Slack Communication](https://join.slack.com/t/openimsdk/shared_invite/zt-22720d66b-o_FvKxMTGXtcnnnHiMqe9Q), or if you find an issue, [report it](https://github.com/openimsdk/open-im-server/issues/new/choose) first.
-
-- [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)
+OpenIMSDK is available under the Apache License 2.0. See the [LICENSE file](https://github.com/openimsdk/open-im-server/blob/main/LICENSE) for more information.
 
 
-## :busts_in_silhouette: Community
-
-+ 📚 [OpenIM Community](https://github.com/OpenIMSDK/community)
-+ 💕 [OpenIM Interest Group](https://github.com/Openim-sigs)
-+ 🚀 [Join our Slack community](https://join.slack.com/t/openimsdk/shared_invite/zt-22720d66b-o_FvKxMTGXtcnnnHiMqe9Q)
-+ :eyes: [Join our wechat (微信群)](https://openim-1253691595.cos.ap-nanjing.myqcloud.com/WechatIMG20.jpeg)
-
-## :calendar: Community Meetings
-
-We want anyone to get involved in our community and contributing code, we offer gifts and rewards, and we welcome you to join us every Thursday night.
-
-Our conference is in the [OpenIM Slack](https://join.slack.com/t/openimsdk/shared_invite/zt-22720d66b-o_FvKxMTGXtcnnnHiMqe9Q) 🎯, then you can search the Open-IM-Server pipeline to join
-
-We take notes of each [biweekly meeting](https://github.com/orgs/OpenIMSDK/discussions/categories/meeting) in [GitHub discussions](https://github.com/openimsdk/open-im-server/discussions/categories/meeting), Our historical meeting notes, as well as replays of the meetings are available at [Google Docs :bookmark_tabs:](https://docs.google.com/document/d/1nx8MDpuG74NASx081JcCpxPgDITNTpIIos0DS6Vr9GU/edit?usp=sharing).
-
-## :eyes: Who are using OpenIM
-
-Check out our [user case studies](https://github.com/OpenIMSDK/community/blob/main/ADOPTERS.md) page for a list of the project users. Don't hesitate to leave a [📝comment](https://github.com/openimsdk/open-im-server/issues/379) and share your use case.
-
-## :page_facing_up: License
-
-OpenIM is licensed under the Apache 2.0 license. See [LICENSE](https://github.com/openimsdk/open-im-server/tree/main/LICENSE) for the full license text.
-
-The OpenIM logo, including its variations and animated versions, displayed in this repository [OpenIM](https://github.com/openimsdk/open-im-server) under the [assets/logo](./assets/logo) and [assets/logo-gif](assets/logo-gif) directories, are protected by copyright laws.
 
 ## 🔮 Thanks to our contributors!
 

README_zh_CN.md

@@ -0,0 +1,142 @@
+<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>
+
+## :busts_in_silhouette: 加入我们的社区
+
++ 💬 [关注我们的 Twitter](https://twitter.com/founder_im63606)
++ 🚀 [加入我们的 Slack](https://join.slack.com/t/openimsdk/shared_invite/zt-22720d66b-o_FvKxMTGXtcnnnHiMqe9Q)
++ :eyes: [加入我们的微信群](https://openim-1253691595.cos.ap-nanjing.myqcloud.com/WechatIMG20.jpeg)
+
+## Ⓜ️ 关于 OpenIM
+
+与Telegram、Signal、Rocket.Chat等独立聊天应用不同，OpenIM提供了专为开发者设计的开源即时通讯解决方案，而不是直接安装使用的独立聊天应用。OpenIM由OpenIM SDK和OpenIM Server两大部分组成，为开发者提供了一整套集成即时通讯功能的工具和服务，包括消息发送接收、用户管理和群组管理等。总体来说，OpenIM旨在为开发者提供必要的工具和框架，帮助他们在自己的应用中实现高效的即时通讯解决方案。
+
+![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**：为业务系统提供REST API，增加群组创建、消息推送等后台接口功能。
+
++ **Webhooks**：通过事件前后的回调，向业务服务器发送请求，扩展更多的业务形态。
+
+  ![整体架构](./docs/images/architecture-layers.png)
+
+  
+
+## :rocket: 快速入门
+
+在线体验iOS/Android/H5/PC/Web：
+
+👉 **[OpenIM在线演示](https://www.openim.io/en/commercial)**
+
+为了便于用户体验，我们提供了多种部署解决方案，您可以根据以下列表选择适合您的部署方式：
+
++ **[源代码部署指南](https://docs.openim.io/guides/gettingStarted/imSourceCodeDeployment)**
++ **[Docker 部署指南](https://docs.openim.io/guides/gettingStarted/dockerCompose)**
+
+## 系统支持
+
+支持 Linux、Windows、Mac 系统以及 ARM 和 AMD CPU 架构。
+
+## :link: 相关链接
+
+  + **[开发手册](https://docs.openim.io/)**
+  + **[更新日志](https://github.com/openimsdk/open-im-server/blob/main/CHANGELOG.md)**
+
+## :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*.

bootstrap.bat

@@ -0,0 +1,31 @@
+@echo off
+SETLOCAL
+
+mage -version >nul 2>&1
+IF %ERRORLEVEL% EQU 0 (
+    echo Mage is already installed.
+    GOTO DOWNLOAD
+)
+
+go version >nul 2>&1
+IF NOT %ERRORLEVEL% EQU 0 (
+    echo Go is not installed. Please install Go and try again.
+    exit /b 1
+)
+
+echo Installing Mage...
+go install github.com/magefile/mage@latest
+
+mage -version >nul 2>&1
+IF NOT %ERRORLEVEL% EQU 0 (
+    echo Mage installation failed.
+    echo Please ensure that %GOPATH%/bin is in your PATH.
+    exit /b 1
+)
+
+echo Mage installed successfully.
+
+:DOWNLOAD
+go mod download
+
+ENDLOCAL

bootstrap.sh

@@ -0,0 +1,23 @@
+#!/bin/bash
+
+if [[ ":$PATH:" == *":$HOME/.local/bin:"* ]]; then
+    TARGET_DIR="$HOME/.local/bin"
+else
+    TARGET_DIR="/usr/local/bin"
+    echo "Using /usr/local/bin as the installation directory. Might require sudo permissions."
+fi
+
+if ! command -v mage &> /dev/null; then
+    echo "Installing Mage to $TARGET_DIR ..."
+    GOBIN=$TARGET_DIR go install github.com/magefile/mage@latest
+fi
+
+if ! command -v mage &> /dev/null; then
+    echo "Mage installation failed."
+    echo "Please ensure that $TARGET_DIR is in your \$PATH."
+    exit 1
+fi
+
+echo "Mage installed successfully."
+
+go mod download

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"
 
@@ -495,4 +519,4 @@ checksum:
   algorithm: sha256
 
 release:
-  prerelease: auto
+  prerelease: auto

build/images/openim-api/Dockerfile

@@ -19,7 +19,6 @@
 FROM golang:1.20 AS builder
 
 ARG GO111MODULE=on
-ARG GOPROXY=https://goproxy.cn,direct
 
 WORKDIR /openim/openim-server
 

build/images/openim-cmdutils/Dockerfile

@@ -19,7 +19,6 @@
 FROM golang:1.20 AS builder
 
 ARG GO111MODULE=on
-ARG GOPROXY=https://goproxy.cn,direct
 
 WORKDIR /openim/openim-server
 

build/images/openim-crontask/Dockerfile

@@ -19,7 +19,6 @@
 FROM golang:1.20 AS builder
 
 ARG GO111MODULE=on
-ARG GOPROXY=https://goproxy.cn,direct
 
 WORKDIR /openim/openim-server
 

build/images/openim-msggateway/Dockerfile

@@ -19,7 +19,6 @@
 FROM golang:1.20 AS builder
 
 ARG GO111MODULE=on
-ARG GOPROXY=https://goproxy.cn,direct
 
 WORKDIR /openim/openim-server
 

build/images/openim-msgtransfer/Dockerfile

@@ -19,7 +19,6 @@
 FROM golang:1.20 AS builder
 
 ARG GO111MODULE=on
-ARG GOPROXY=https://goproxy.cn,direct
 
 WORKDIR /openim/openim-server
 

build/images/openim-push/Dockerfile

@@ -19,7 +19,6 @@
 FROM golang:1.20 AS builder
 
 ARG GO111MODULE=on
-ARG GOPROXY=https://goproxy.cn,direct
 
 WORKDIR /openim/openim-server
 

build/images/openim-rpc-auth/Dockerfile

@@ -19,7 +19,6 @@
 FROM golang:1.20 AS builder
 
 ARG GO111MODULE=on
-ARG GOPROXY=https://goproxy.cn,direct
 
 WORKDIR /openim/openim-server
 

build/images/openim-rpc-conversation/Dockerfile

@@ -19,7 +19,6 @@
 FROM golang:1.20 AS builder
 
 ARG GO111MODULE=on
-ARG GOPROXY=https://goproxy.cn,direct
 
 WORKDIR /openim/openim-server
 

build/images/openim-rpc-friend/Dockerfile

@@ -19,7 +19,6 @@
 FROM golang:1.20 AS builder
 
 ARG GO111MODULE=on
-ARG GOPROXY=https://goproxy.cn,direct
 
 WORKDIR /openim/openim-server
 

build/images/openim-rpc-group/Dockerfile

@@ -19,7 +19,6 @@
 FROM golang:1.20 AS builder
 
 ARG GO111MODULE=on
-ARG GOPROXY=https://goproxy.cn,direct
 
 WORKDIR /openim/openim-server
 

build/images/openim-rpc-msg/Dockerfile

@@ -19,7 +19,6 @@
 FROM golang:1.20 AS builder
 
 ARG GO111MODULE=on
-ARG GOPROXY=https://goproxy.cn,direct
 
 WORKDIR /openim/openim-server
 

build/images/openim-rpc-third/Dockerfile

@@ -19,7 +19,6 @@
 FROM golang:1.20 AS builder
 
 ARG GO111MODULE=on
-ARG GOPROXY=https://goproxy.cn,direct
 
 WORKDIR /openim/openim-server
 

build/images/openim-rpc-user/Dockerfile

@@ -19,7 +19,6 @@
 FROM golang:1.20 AS builder
 
 ARG GO111MODULE=on
-ARG GOPROXY=https://goproxy.cn,direct
 
 WORKDIR /openim/openim-server
 

build/images/openim-tools/component/Dockerfile

@@ -19,7 +19,6 @@
 FROM golang:1.20 AS builder
 
 ARG GO111MODULE=on
-ARG GOPROXY=https://goproxy.cn,direct
 
 WORKDIR /openim/openim-server
 

build/images/openim-tools/openim-web/Dockerfile

@@ -1,57 +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.
-
-# OpenIM base image: https://github.com/openim-sigs/openim-base-image
-
-# Set go mod installation source and proxy
-
-FROM golang:1.20 AS builder
-
-ARG GO111MODULE=on
-ARG GOPROXY=https://goproxy.cn,direct
-
-WORKDIR /openim/openim-server
-
-ENV GO111MODULE=$GO111MODULE
-ENV GOPROXY=$GOPROXY
-
-RUN apt-get update && apt-get install -y curl unzip
-
-RUN curl -LO https://app-1302656840.cos.ap-nanjing.myqcloud.com/dist.zip \
-   && unzip dist.zip -d ./ \
-   && rm dist.zip
-
-COPY go.mod go.sum ./
-RUN go mod download
-
-COPY . .
-
-RUN make clean
-RUN make build BINS=openim-web
-
-FROM ghcr.io/openim-sigs/openim-ubuntu-image:latest
-
-WORKDIR /openim/openim-server
-
-COPY --from=builder /openim/openim-server/_output/bin/tools /openim/openim-server/_output/bin/tools/
-COPY --from=builder /openim/openim-server/dist /openim/openim-server/dist
-
-ENV PORT 11001
-ENV DISTPATH /openim/openim-server/dist
-
-EXPOSE 11001
-
-RUN mv ${OPENIM_SERVER_BINDIR}/tools/$(get_os)/$(get_arch)/openim-web /usr/bin/openim-web
-
-ENTRYPOINT ["bash", "-c", "openim-web -port $PORT -distPath $DISTPATH"]

cmd/openim-api/main.go

@@ -15,97 +15,15 @@
 package main
 
 import (
-	"context"
-	"fmt"
-	"net"
 	_ "net/http/pprof"
-	"strconv"
 
-	ginProm "github.com/openimsdk/open-im-server/v3/pkg/common/ginprometheus"
-	"github.com/openimsdk/open-im-server/v3/pkg/common/prommetrics"
-
-	"github.com/OpenIMSDK/protocol/constant"
-	"github.com/OpenIMSDK/tools/discoveryregistry"
-	"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"
-	kdisc "github.com/openimsdk/open-im-server/v3/pkg/common/discoveryregister"
+	"github.com/openimsdk/tools/system/program"
 )
 
 func main() {
-	apiCmd := cmd.NewApiCmd()
-	apiCmd.AddPortFlag()
-	apiCmd.AddApi(run)
-	if err := apiCmd.Execute(); err != nil {
-		log.ZError(context.Background(), "API command execution failed", err)
-		panic(err.Error())
+	if err := cmd.NewApiCmd().Exec(); err != nil {
+		program.ExitWithError(err)
 	}
-}
-
-func run(port int, proPort int) error {
-	log.ZInfo(context.Background(), "Openim api port:", "port", port, "proPort", proPort)
-
-	if port == 0 || proPort == 0 {
-		err := "port or proPort is empty:" + strconv.Itoa(port) + "," + strconv.Itoa(proPort)
-		log.ZError(context.Background(), err, nil)
-
-		return fmt.Errorf(err)
-	}
-	rdb, err := cache.NewRedis()
-	if err != nil {
-		log.ZError(context.Background(), "Failed to initialize Redis", err)
-
-		return err
-	}
-	log.ZInfo(context.Background(), "api start init discov client")
-
-	var client discoveryregistry.SvcDiscoveryRegistry
-
-	// Determine whether zk is passed according to whether it is a clustered deployment
-	client, err = kdisc.NewDiscoveryRegister(config.Config.Envs.Discovery)
-	if err != nil {
-		log.ZError(context.Background(), "Failed to initialize discovery register", err)
-
-		return err
-	}
-	if err = client.CreateRpcRootNodes(config.Config.GetServiceNames()); err != nil {
-		log.ZError(context.Background(), "Failed to create RPC root nodes", err)
-
-		return err
-	}
-	log.ZInfo(context.Background(), "api register public config to discov")
-	if err = client.RegisterConf2Registry(constant.OpenIMCommonConfigKey, config.Config.EncodeConfig()); err != nil {
-		log.ZError(context.Background(), "Failed to register public config to discov", err)
-
-		return err
-	}
-	log.ZInfo(context.Background(), "api register public config to discov success")
-	router := api.NewGinRouter(client, rdb)
-	//////////////////////////////
-	if config.Config.Prometheus.Enable {
-		p := ginProm.NewPrometheus("app", prommetrics.GetGinCusMetrics("Api"))
-		p.SetListenAddress(fmt.Sprintf(":%d", proPort))
-		p.Use(router)
-	}
-	/////////////////////////////////
-	log.ZInfo(context.Background(), "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))
-	}
-	log.ZInfo(context.Background(), "start api server", "address", address, "OpenIM 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"
+	"github.com/openimsdk/tools/system/program"
 )
 
 func main() {
@@ -28,6 +29,8 @@ func main() {
 	getCmd.AddCommand(seqCmd.GetSeqCmd(), msgCmd.GetMsgCmd())
 	getCmd.AddSuperGroupIDFlag()
 	getCmd.AddUserIDFlag()
+	getCmd.AddConfigDirFlag()
+	getCmd.AddIndexFlag()
 	getCmd.AddBeginSeqFlag()
 	getCmd.AddLimitFlag()
 	// openIM get seq --userID=xxx
@@ -38,6 +41,8 @@ func main() {
 	fixCmd.AddCommand(seqCmd.FixSeqCmd())
 	fixCmd.AddSuperGroupIDFlag()
 	fixCmd.AddUserIDFlag()
+	fixCmd.AddConfigDirFlag()
+	fixCmd.AddIndexFlag()
 	fixCmd.AddFixAllFlag()
 	// openIM fix seq --userID=xxx
 	// openIM fix seq --superGroupID=xxx
@@ -46,6 +51,8 @@ func main() {
 	clearCmd.AddCommand(msgCmd.ClearMsgCmd())
 	clearCmd.AddSuperGroupIDFlag()
 	clearCmd.AddUserIDFlag()
+	clearCmd.AddConfigDirFlag()
+	clearCmd.AddIndexFlag()
 	clearCmd.AddClearAllFlag()
 	clearCmd.AddBeginSeqFlag()
 	clearCmd.AddLimitFlag()
@@ -54,6 +61,6 @@ func main() {
 	// openIM clear msg --clearAll
 	msgUtilsCmd.AddCommand(&getCmd.Command, &fixCmd.Command, &clearCmd.Command)
 	if err := msgUtilsCmd.Execute(); err != nil {
-		panic(err)
+		program.ExitWithError(err)
 	}
 }

cmd/openim-crontask/main.go

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

cmd/openim-msggateway/main.go

@@ -16,14 +16,11 @@ package main
 
 import (
 	"github.com/openimsdk/open-im-server/v3/pkg/common/cmd"
+	"github.com/openimsdk/tools/system/program"
 )
 
 func main() {
-	msgGatewayCmd := cmd.NewMsgGatewayCmd()
-	msgGatewayCmd.AddWsPortFlag()
-	msgGatewayCmd.AddPortFlag()
-	msgGatewayCmd.AddPrometheusPortFlag()
-	if err := msgGatewayCmd.Exec(); err != nil {
-		panic(err.Error())
+	if err := cmd.NewMsgGatewayCmd().Exec(); err != nil {
+		program.ExitWithError(err)
 	}
 }

cmd/openim-msgtransfer/main.go

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

cmd/openim-push/main.go

@@ -15,19 +15,12 @@
 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"
+	"github.com/openimsdk/tools/system/program"
 )
 
 func main() {
-	pushCmd := cmd.NewRpcCmd(cmd.RpcPushServer)
-	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())
+	if err := cmd.NewPushRpcCmd().Exec(); err != nil {
+		program.ExitWithError(err)
 	}
 }

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

@@ -15,19 +15,12 @@
 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"
+	"github.com/openimsdk/tools/system/program"
 )
 
 func main() {
-	authCmd := cmd.NewRpcCmd(cmd.RpcAuthServer)
-	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())
+	if err := cmd.NewAuthRpcCmd().Exec(); err != nil {
+		program.ExitWithError(err)
 	}
 }

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

@@ -15,19 +15,12 @@
 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"
+	"github.com/openimsdk/tools/system/program"
 )
 
 func main() {
-	rpcCmd := cmd.NewRpcCmd(cmd.RpcConversationServer)
-	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())
+	if err := cmd.NewConversationRpcCmd().Exec(); err != nil {
+		program.ExitWithError(err)
 	}
 }

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

@@ -15,19 +15,12 @@
 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"
+	"github.com/openimsdk/tools/system/program"
 )
 
 func main() {
-	rpcCmd := cmd.NewRpcCmd(cmd.RpcFriendServer)
-	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())
+	if err := cmd.NewFriendRpcCmd().Exec(); err != nil {
+		program.ExitWithError(err)
 	}
 }

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

@@ -15,19 +15,12 @@
 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"
+	"github.com/openimsdk/tools/system/program"
 )
 
 func main() {
-	rpcCmd := cmd.NewRpcCmd(cmd.RpcGroupServer)
-	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())
+	if err := cmd.NewGroupRpcCmd().Exec(); err != nil {
+		program.ExitWithError(err)
 	}
 }

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

@@ -15,19 +15,12 @@
 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"
+	"github.com/openimsdk/tools/system/program"
 )
 
 func main() {
-	rpcCmd := cmd.NewRpcCmd(cmd.RpcMsgServer)
-	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())
+	if err := cmd.NewMsgRpcCmd().Exec(); err != nil {
+		program.ExitWithError(err)
 	}
 }

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

@@ -15,19 +15,12 @@
 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"
+	"github.com/openimsdk/tools/system/program"
 )
 
 func main() {
-	rpcCmd := cmd.NewRpcCmd(cmd.RpcThirdServer)
-	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())
+	if err := cmd.NewThirdRpcCmd().Exec(); err != nil {
+		program.ExitWithError(err)
 	}
 }

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

@@ -15,19 +15,12 @@
 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"
+	"github.com/openimsdk/tools/system/program"
 )
 
 func main() {
-	rpcCmd := cmd.NewRpcCmd(cmd.RpcUserServer)
-	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())
+	if err := cmd.NewUserRpcCmd().Exec(); err != nil {
+		program.ExitWithError(err)
 	}
 }

config/README.md

@@ -0,0 +1,63 @@
+---
+title: 'OpenIM Configuration Files and Common Configuration Item Modifications Guide'
+
+## Configuration Files Explanation
+
+| Configuration File              | Description                                                  |
+| ------------------------------- | ------------------------------------------------------------ |
+| **kafka.yml**                   | Configurations for Kafka username, password, address, etc.   |
+| **redis.yml**                   | Configurations for Redis password, address, etc.             |
+| **minio.yml**                   | Configurations for MinIO username, password, address, and external IP/domain; failing to modify external IP or domain may cause image file sending failures |
+| **zookeeper.yml**               | Configurations for ZooKeeper user, password, address, etc.   |
+| **mongodb.yml**                 | Configurations for MongoDB username, password, address, etc. |
+| **log.yml**                     | Configurations for log level and storage directory.          |
+| **notification.yml**            | Configurations for events like adding friends, creating groups, etc. |
+| **share.yml**                   | Common configurations needed by various OpenIM services, such as secret. |
+| **webhooks.yml**                | Configurations for URLs in Webhook.                          |
+| **local-cache.yml**             | Local cache configurations.                                  |
+| **openim-rpc-third.yml**        | Configurations for listening IP, port, and storage settings for images and videos in openim-rpc-third service. |
+| **openim-rpc-user.yml**         | Configurations for listening IP and port in openim-rpc-user service. |
+| **openim-api.yml**              | Configurations for listening IP, port, etc., in openim-api service. |
+| **openim-crontask.yml**         | Configurations for openim-crontask service.                  |
+| **openim-msggateway.yml**       | Configurations for listening IP, port, etc., in openim-msggateway service. |
+| **openim-msgtransfer.yml**      | Configurations for openim-msgtransfer service.               |
+| **openim-push.yml**             | Configurations for listening IP, port, and offline push settings in openim-push service. |
+| **openim-rpc-auth.yml**         | Configurations for listening IP, port, and token expiration settings in openim-rpc-auth service. |
+| **openim-rpc-conversation.yml** | Configurations for listening IP, port, etc., in openim-rpc-conversation service. |
+| **openim-rpc-friend.yml**       | Configurations for listening IP, port, etc., in openim-rpc-friend service. |
+| **openim-rpc-group.yml**        | Configurations for listening IP, port, etc., in openim-rpc-group service. |
+| **openim-rpc-msg.yml**          | Configurations for listening IP, port, and whether to verify friendship before sending messages in openim-rpc-msg service. |
+
+## Common Configuration Item Modifications
+
+| Configuration Item Modification                       | Configuration File      |
+| ----------------------------------------------------- | ----------------------- |
+| Using MinIO for image and video file object storage   | `minio.yml`             |
+| Adjusting production environment logs                 | `log.yml`               |
+| Verifying friendship before sending messages          | `openim-rpc-msg.yml`    |
+| Modifying secret                                      | `share.yml`             |
+| Using OSS, COS, AWS, Kodo for image and video storage | `openim-rpc-third.yml`  |
+| Setting multiple login policy                         | `openim-msggateway.yml` |
+| Setting up offline push                               | `openim-push.yml`       |
+
+## Starting Multiple Instances of an OpenIM Service
+
+To start multiple instances of an OpenIM service, simply increase the corresponding port numbers and modify the `start-config.yml` file in the project root directory. Restart the service to take effect. For example, the configuration to start 2 instances of `openim-rpc-user` is as follows:
+
+```yaml
+rpc:
+  registerIP: ''
+  listenIP: 0.0.0.0
+  ports: [ 10110, 10111 ]
+
+prometheus:
+  enable: true
+  ports: [ 20100, 20101 ]
+```
+
+Modify `start-config.yml`:
+
+```yaml
+serviceBinaries:
+  openim-rpc-user: 2
+```

config/README_zh_CN.md

@@ -0,0 +1,65 @@
+# 						OpenIM配置文件说明以及常用配置修改说明
+
+## 配置文件说明
+
+| Configuration File              | Description                                                  |
+| ------------------------------- | ------------------------------------------------------------ |
+| **kafka.yml**                   | Kafka用户名、密码、地址等配置                                |
+| **redis.yml**                   | Redis密码、地址等配置                                        |
+| **minio.yml**                   | MinIO用户名、密码、地址及外网IP域名等配置；未修改外网IP或域名可能导致图片文件发送失败 |
+| **zookeeper.yml**               | ZooKeeper用户、密码、地址等配置                              |
+| **mongodb.yml**                 | MongoDB用户名、密码、地址等配置                              |
+| **log.yml**                     | 日志级别及存储目录等配置                                     |
+| **notification.yml**            | 添加好友、创建群组等事件通知配置                             |
+| **share.yml**                   | OpenIM各服务所需的公共配置，如secret等                       |
+| **webhooks.yml**                | Webhook中URL等配置                                           |
+| **local-cache.yml**             | 本地缓存配置                                                 |
+| **openim-rpc-third.yml**        | openim-rpc-third服务的监听IP、端口及图片视频对象存储配置     |
+| **openim-rpc-user.yml**         | openim-rpc-user服务的监听IP、端口配置                        |
+| **openim-api.yml**              | openim-api服务的监听IP、端口等配置项                         |
+| **openim-crontask.yml**         | openim-crontask服务配置                                      |
+| **openim-msggateway.yml**       | openim-msggateway服务的监听IP、端口等配置                    |
+| **openim-msgtransfer.yml**      | openim-msgtransfer服务配置                                   |
+| **openim-push.yml**             | openim-push服务的监听IP、端口及离线推送配置                  |
+| **openim-rpc-auth.yml**         | openim-rpc-auth服务的监听IP、端口及token有效期等配置         |
+| **openim-rpc-conversation.yml** | openim-rpc-conversation服务的监听IP、端口等配置              |
+| **openim-rpc-friend.yml**       | openim-rpc-friend服务的监听IP、端口等配置                    |
+| **openim-rpc-group.yml**        | openim-rpc-group服务的监听IP、端口等配置                     |
+| **openim-rpc-msg.yml**          | openim-rpc-msg服务的监听IP、端口及消息发送是否验证好友关系等配置 |
+
+## 常用配置修改
+
+| 修改配置项                                      | 配置文件                |
+| ----------------------------------------------- | ----------------------- |
+| 使用minio作为图片视频文件对象存储               | `minio.yml`             |
+| 生产环境日志调整                                | `log.yml`               |
+| 发送消息是否验证好友关系                        | `openim-rpc-msg.yml`    |
+| 修改secret                                      | `share.yml`             |
+| 使用oss, cos, aws, kodo作为图片视频文件对象存储 | `openim-rpc-third.yml`  |
+| 设置多端互踢策略                                | `openim-msggateway.yml` |
+| 设置离线推送                                    | `openim-push.yml`       |
+
+## 启动某个OpenIM服务的多个实例
+
+若要启动某个OpenIM的多个实例，只需增加对应的端口数，并修改项目根目录下的`start-config.yml`文件，重启服务即可生效。例如，启动2个`openim-rpc-user`实例的配置如下：
+
+```yaml
+rpc:
+  registerIP: ''
+  listenIP: 0.0.0.0
+  ports: [ 10110, 10111 ]
+
+prometheus:
+  enable: true
+  ports: [ 20100, 20101 ]
+```
+
+修改`start-config.yml`:
+
+```yaml
+serviceBinaries:
+  openim-rpc-user: 2
+```
+
+
+

config/config.yaml

@@ -1,398 +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.
-
-# -----------------------------------------------------------------
-# TODO: This config file is the template file
-# --| source: deployments/templates/openim.yaml
-# --| env: scripts/install/environment
-# --| target: config/config.yaml
-# -----------------------------------------------------------------
-
-envs:
-  discovery: zookeeper
-
-###################### Zookeeper ######################
-# Zookeeper configuration
-# It's not recommended to modify the schema
-# 
-# Zookeeper address
-# Zookeeper username
-# Zookeeper password
-zookeeper:
-  schema: openim
-  address: [ 172.28.0.1:12181 ]
-  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
-mongo:
-  uri: ''
-  address: [ 172.28.0.1:37017 ]
-  database: openIM_v3
-  username: root
-  password: openIM123
-  maxPoolSize: 100
-
-###################### Redis configuration information ######################
-# Redis configuration
-#
-# Username is required only for Redis version 6.0+
-redis:
-  address: [ 172.28.0.1:16379 ]
-  username: ''
-  password: openIM123
-
-###################### Kafka configuration information ######################
-# Kafka configuration
-#
-# Kafka username
-# Kafka password
-# It's not recommended to modify this topic name
-# Consumer group ID, it's not recommended to modify
-kafka:
-  username: ''
-  password: ''
-  addr: [ 172.28.0.1:19094 ]
-  latestMsgToRedis:
-    topic: "latestMsgToRedis"
-  offlineMsgToMongo:
-    topic: "offlineMsgToMongoMysql"
-  msgToPush:
-    topic: "msgToPush"
-  consumerGroupID:
-    msgToRedis: redis
-    msgToMongo: mongo
-    msgToMySql: mysql
-    msgToPush: push
-
-###################### RPC configuration information ######################
-# RPC configuration
-#
-# IP address to register with zookeeper when starting RPC, the IP and corresponding rpcPort should be accessible by api/gateway
-# Default listen IP is 0.0.0.0
-rpc:
-  registerIP: ''
-  listenIP: 0.0.0.0
-
-###################### API configuration information ######################
-# API configuration
-#
-# API service port
-# Default listen IP is 0.0.0.0
-api:
-  openImApiPort: [ 10002 ]
-  listenIP: 0.0.0.0
-
-###################### Object configuration information ######################
-# Object storage configuration
-#
-# Use minio for object storage
-# API URL should be accessible by the app
-# It's not recommended to modify the bucket name
-# Endpoint should be accessible by the app
-# Session token
-# Configuration for Tencent COS
-# Configuration for Aliyun OSS
-# apiURL is the address of the api, the access address of the app, use s3 must be configured
-# minio.endpoint can be configured as an intranet address,
-# minio.signEndpoint is minio public network address
-object:
-  enable: "minio"
-  apiURL: "http://127.0.0.1:10002"
-  minio:
-    bucket: "openim"
-    endpoint: "http://172.28.0.1:10005"
-    accessKeyID: "root"
-    secretAccessKey: "openIM123"
-    sessionToken: ''
-    signEndpoint: "http://127.0.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"
-    bucketURL: "https://demo-9999999.oss-cn-chengdu.aliyuncs.com"
-    accessKeyID: ''
-    accessKeySecret: ''
-    sessionToken: ''
-    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: 
-  openImUserPort: [ 10110 ]
-  openImFriendPort: [ 10120 ]
-  openImMessagePort: [ 10130 ]
-  openImGroupPort: [ 10150 ]
-  openImAuthPort: [ 10160 ]
-  openImPushPort: [ 10170 ]
-  openImConversationPort: [ 10180 ]
-  openImThirdPort: [ 10190 ]
-
-###################### RPC Register Name Configuration ######################
-# RPC service names for registration, it's not recommended to modify these
-rpcRegisterName:
-  openImUserName: User
-  openImFriendName: Friend
-  openImMsgName: Msg
-  openImPushName: Push
-  openImMessageGatewayName: MessageGateway
-  openImGroupName: Group
-  openImAuthName: Auth
-  openImConversationName: Conversation
-  openImThirdName: Third
-
-###################### Log Configuration ######################
-# Log configuration
-#
-# Storage directory
-# Log rotation time
-# Maximum number of logs to retain
-# Log level, 6 means all levels
-# Whether to output to stdout
-# Whether to output in json format
-# Whether to include stack trace in logs
-log:
-  storageLocation: ./logs/
-  rotationTime: 24
-  remainRotationCount: 2
-  remainLogLevel: 6
-  isStdout: false
-  isJson: false
-  withStack: false
-
-###################### Variables definition ######################
-# Long connection server configuration
-#
-# Websocket port for msg_gateway
-# Maximum number of websocket connections
-# Maximum length of websocket request package
-# Websocket connection handshake timeout
-longConnSvr:
-  openImWsPort: [ 10001 ]
-  websocketMaxConnNum: 100000
-  openImMessageGatewayPort: [ 10140 ]
-  websocketMaxMsgLen: 4096
-  websocketTimeout: 10
-
-# Push notification service configuration
-#
-# Use GeTui for push notifications
-# GeTui offline push configuration
-# FCM offline push configuration
-# Account file, place it in the config directory
-# JPush configuration, modify these after applying in JPush backend
-push:
-  enable: getui
-  geTui:
-    pushUrl: "https://restapi.getui.com/v2/$appId"
-    masterSecret: ''
-    appKey: ''
-    intent: ''
-    channelID: ''
-    channelName: ''
-  fcm:
-    serviceAccount: "x.json"
-  jpns:
-    appKey: ''
-    masterSecret: ''
-    pushUrl: ''
-    pushIntent: ''
-
-# App manager configuration
-#
-# Built-in app manager user IDs
-# Built-in app manager nicknames
-manager:
-  userID: [ "openIM123456", "openIM654321", "openIMAdmin" ]
-  nickname: [ "system1", "system2", "system3" ]
-
-# Multi-platform login policy
-# For each platform(Android, iOS, Windows, Mac, web), only one can be online at a time
-multiLoginPolicy: 1
-
-# Whether to store messages in MySQL, messages in MySQL are only used for management background
-chatPersistenceMysql: true
-
-# Message cache timeout in seconds, it's not recommended to modify
-msgCacheTimeout: 86400
-
-# Whether to enable read receipts for group chat
-groupMessageHasReadReceiptEnable: true
-
-# Whether to enable read receipts for single chat
-singleMessageHasReadReceiptEnable: true
-
-# MongoDB offline message retention period in days
-retainChatRecords: 365
-
-# Schedule to clear expired messages(older than retainChatRecords days) in MongoDB every Wednesday at 2am
-# This deletion is just for cleaning up disk usage according to previous configuration retainChatRecords, no notification will be sent
-chatRecordsClearTime: "0 2 * * 3"
-
-# Schedule to auto delete messages every day at 2am
-# This deletion is for messages that have been retained for more than msg_destruct_time (seconds) in the conversation field
-msgDestructTime: "0 2 * * *"
-
-# Secret key
-secret: openIM123
-
-# Token policy
-#
-# Token expiration period in days
-tokenPolicy:
-  expire: 90
-
-# Message verification policy
-#
-# Whether to verify friendship when sending messages
-messageVerify:
-  friendVerify: false
-
-# iOS push notification configuration
-#
-# iOS push notification sound
-# Whether to count badge
-# Whether it's production environment
-iosPush:
-  pushSound: "xxx"
-  badgeCount: true
-  production: false
-
-###################### Third-party service configuration ######################
-# Callback configuration
-#
-# Callback URL
-# Whether to enable this callback event
-# Timeout in seconds
-# Whether to continue execution if callback fails
-callback:
-  url:
-  beforeSendSingleMsg:
-    enable: false
-    timeout: 5
-    failedContinue: true
-  afterSendSingleMsg:
-    enable: false
-    timeout: 5
-  beforeSendGroupMsg:
-    enable: false
-    timeout: 5
-    failedContinue: true
-  afterSendGroupMsg:
-    enable: false
-    timeout: 5
-  msgModify:
-    enable: false
-    timeout: 5
-    failedContinue: true
-  userOnline:
-    enable: false
-    timeout: 5
-  userOffline:
-    enable: false
-    timeout: 5
-  userKickOff:
-    enable: false
-    timeout: 5
-  offlinePush:
-    enable: false
-    timeout: 5
-    failedContinue: true
-  onlinePush:
-    enable: false
-    timeout: 5
-    failedContinue: true
-  superGroupOnlinePush:
-    enable: false
-    timeout: 5
-    failedContinue: true
-  beforeAddFriend:
-    enable: false
-    timeout: 5
-    failedContinue: true
-  beforeUpdateUserInfo:
-    enable: false
-    timeout: 5
-    failedContinue: true
-  beforeCreateGroup:
-    enable: false
-    timeout: 5
-    failedContinue: true
-  beforeMemberJoinGroup:
-    enable: false
-    timeout: 5
-    failedContinue: true
-  beforeSetGroupMemberInfo:
-    enable: false
-    timeout: 5
-    failedContinue: true
-  setMessageReactionExtensions:
-    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: true
-  prometheusUrl: "https://openim.prometheus"
-  apiPrometheusPort: [20100]
-  userPrometheusPort: [ 20110 ]
-  friendPrometheusPort: [ 20120 ]
-  messagePrometheusPort: [ 20130 ]
-  messageGatewayPrometheusPort: [ 20140 ]
-  groupPrometheusPort: [ 20150 ]
-  authPrometheusPort: [ 20160 ]
-  pushPrometheusPort: [ 20170 ]
-  conversationPrometheusPort: [ 20230 ]
-  rtcPrometheusPort: [ 21300 ]
-  thirdPrometheusPort: [ 21301 ]
-  messageTransferPrometheusPort: [ 21400, 21401, 21402, 21403 ] # List of ports

config/kafka.yml

@@ -0,0 +1,36 @@
+# Username for authentication
+username: ''
+# Password for authentication
+password: ''
+# Producer acknowledgment settings
+producerAck: ""
+# Compression type to use (e.g., none, gzip, snappy)
+compressType: "none"
+# List of Kafka broker addresses
+address: [ localhost:19094 ]
+# Kafka topic for Redis integration
+toRedisTopic: "toRedis"
+# Kafka topic for MongoDB integration
+toMongoTopic: "toMongo"
+# Kafka topic for push notifications
+toPushTopic: "toPush"
+# Consumer group ID for Redis topic
+toRedisGroupID: redis
+# Consumer group ID for MongoDB topic
+toMongoGroupID: mongo
+# Consumer group ID for push notifications topic
+toPushGroupID: push
+# TLS (Transport Layer Security) configuration
+tls:
+  # Enable or disable TLS
+  enableTLS: false
+  # CA certificate file path
+  caCrt: ""
+  # Client certificate file path
+  clientCrt: ""
+  # Client key file path
+  clientKey: ""
+  # Client key password
+  clientKeyPwd: ""
+  # Whether to skip TLS verification (not recommended for production)
+  insecureSkipVerify: false

config/local-cache.yml

@@ -0,0 +1,27 @@
+user:
+  topic: DELETE_CACHE_USER
+  slotNum: 100
+  slotSize: 2000
+  successExpire: 300
+  failedExpire: 5
+
+group:
+  topic: DELETE_CACHE_GROUP
+  slotNum: 100
+  slotSize: 2000
+  successExpire: 300
+  failedExpire: 5
+
+friend:
+  topic: DELETE_CACHE_FRIEND
+  slotNum: 100
+  slotSize: 2000
+  successExpire: 300
+  failedExpire: 5
+
+conversation:
+  topic: DELETE_CACHE_CONVERSATION
+  slotNum: 100
+  slotSize: 2000
+  successExpire: 300
+  failedExpire: 5

config/log.yml

@@ -0,0 +1,13 @@
+# Log storage path, default is acceptable, change to a full path if modification is needed
+storageLocation: ../../../../logs/
+# Log rotation period (in hours), default is acceptable
+rotationTime: 24
+# Number of log files to retain, default is acceptable
+remainRotationCount: 2
+# Log level settings: 3 for production environment; 6 for more verbose logging in debugging environments
+remainLogLevel: 6
+# Whether to output to standard output, default is acceptable
+isStdout: false
+# Whether to log in JSON format, default is acceptable
+isJson: false
+

config/minio.yml

@@ -0,0 +1,16 @@
+# Name of the bucket in MinIO
+bucket: "openim"
+# Access key ID for MinIO authentication
+accessKeyID: "root"
+# Secret access key for MinIO authentication
+secretAccessKey: "openIM123"
+# Session token for MinIO authentication (optional)
+sessionToken: ''
+# Internal address of the MinIO server
+internalAddress: "localhost:10005"
+# External address of the MinIO server, accessible from outside. Supports both HTTP and HTTPS using a domain name
+externalAddress: "http://external_ip:10005"
+# Flag to enable or disable public read access to the bucket
+publicRead: false
+
+

config/mongodb.yml

@@ -0,0 +1,14 @@
+# URI for database connection, leave empty if using address and credential settings directly
+uri: ''
+# List of MongoDB server addresses
+address: [ localhost:37017 ]
+# Name of the database
+database: openim_v3
+# Username for database authentication
+username: openIM
+# Password for database authentication
+password: openIM123
+# Maximum number of connections in the connection pool
+maxPoolSize: 100
+# Maximum number of retry attempts for a failed database connection
+maxRetry: 10