fix: fix openim zk env set

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

.dockerignore

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

.env

@@ -1,20 +0,0 @@
-
-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
-ETCD_IMAGE=quay.io/coreos/etcd:v3.5.13
-PROMETHEUS_IMAGE=prom/prometheus:v2.45.6
-ALERTMANAGER_IMAGE=prom/alertmanager:v0.27.0
-GRAFANA_IMAGE=grafana/grafana:11.0.1
-
-OPENIM_WEB_FRONT_IMAGE=openim/openim-web-front:release-v3.5.1
-OPENIM_ADMIN_FRONT_IMAGE=openim/openim-admin-front:release-v1.7
-
-#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
-
-DATA_DIR=./
-

.gitattributes

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

.github/dependabot.yml

@@ -0,0 +1,59 @@
+# Copyright © 2023 OpenIM. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "gomod"
+    directory: "/"
+    schedule:
+      interval: "daily"
+      time: "08:00"
+    labels:
+      - "dependencies"
+    commit-message:
+      prefix: "feat"
+      include: "scope"
+    groups:
+      gomod-deps:
+        patterns:
+          - "*"
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "daily"
+      time: "08:00"
+    labels:
+      - "dependencies"
+    commit-message:
+      prefix: "chore"
+      include: "scope"
+    groups:
+      github-actions:
+        patterns:
+          - "*"
+  - package-ecosystem: "docker"
+    directory: "/"
+    schedule:
+      interval: "daily"
+      time: "08:00"
+    labels:
+      - "dependencies"
+    commit-message:
+      prefix: "feat"
+      include: "scope"

.github/release-drafter.yml

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

.github/standardizer.yml

@@ -1,50 +0,0 @@
-# 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/auto-gh-pr.yml

@@ -28,7 +28,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout code
-        uses: actions/checkout@v4
+        uses: actions/checkout@v2
       
       - 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@v4
+        uses: peter-evans/create-or-update-comment@v3
         with:
           token: ${{ secrets.BOT_GITHUB_TOKEN }}
           issue-number: ${{ github.event.issue.number }}

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

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

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

@@ -12,57 +12,23 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-name: Github Robot for Cherry Pick On Comment
-
+name: Github Rebot for Cherry Pick On Comment
 on:
   issue_comment:
     types: [created]
-
 jobs:
   cherry-pick:
     name: Cherry Pick
+    # && github.event.comment.user.login=='kubbot'
     if: github.event.issue.pull_request != '' && contains(github.event.comment.body, '/cherry-pick')
     runs-on: ubuntu-latest
-
     steps:
       - name: Checkout the latest code
         uses: actions/checkout@v4
         with:
           token: ${{ secrets.BOT_GITHUB_TOKEN }}
-          fetch-depth: 0 # To ensure all history is available for cherry-picking
-
+          fetch-depth: 0 # otherwise, you will fail to push refs to dest repo
       - 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 }}
-
-      - 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_TOKEN: ${{ secrets.BOT_GITHUB_TOKEN }}

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

@@ -15,6 +15,8 @@
 name: Publish Docker image
 
 on:
+  schedule:
+  - cron: '30 2 * * *'
   push:
     branches:
       - main
@@ -29,7 +31,6 @@ env:
 
 jobs:
   build-dockerhub:
-    if: github.event_name == 'push' || (github.event_name == 'pull_request' && github.event.action == 'closed' && github.event.pull_request.merged == true)
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
@@ -42,7 +43,7 @@ jobs:
 # docker.io/openim/openim-server:latest
       - name: Extract metadata (tags, labels) for Docker
         id: meta
-        uses: docker/metadata-action@v5.5.1
+        uses: docker/metadata-action@v5.0.0
         with:
           images: openim/openim-server
           # generate Docker tags based on the following events/attributes
@@ -85,7 +86,7 @@ jobs:
 # registry.cn-hangzhou.aliyuncs.com/openimsdk/openim-server:latest
       - name: Extract metadata (tags, labels) for Docker
         id: meta2
-        uses: docker/metadata-action@v5.5.1
+        uses: docker/metadata-action@v5.0.0
         with:
           images: registry.cn-hangzhou.aliyuncs.com/openimsdk/openim-server
           # generate Docker tags based on the following events/attributes
@@ -129,7 +130,7 @@ jobs:
 # ghcr.io/openimsdk/openim-server:latest
       - name: Extract metadata (tags, labels) for Docker
         id: meta3
-        uses: docker/metadata-action@v5.5.1
+        uses: docker/metadata-action@v5.0.0
         with:
           images: ghcr.io/openimsdk/openim-server
           # generate Docker tags based on the following events/attributes

.github/workflows/check-coverage.yml

@@ -56,4 +56,4 @@ jobs:
         continue-on-error: true
 
       - name: Upload Coverage to Codecov
-        uses: codecov/codecov-action@v4
+        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,openimbot,bot*,dependabot,sweep-ai,*bot,bot-*,bot/*,bot-/*,bot,*[bot]
+  OPEN_IM_SERVER_ALLOWLIST: kubbot,bot*,bot-*,bot/*,bot-/*,bot,*[bot]
 
 jobs:
   CLAAssistant:

.github/workflows/codeql-analysis.yml

@@ -51,7 +51,7 @@ jobs:
 
       # Initializes the CodeQL tools for scanning.
       - name: Initialize CodeQL
-        uses: github/codeql-action/init@v3
+        uses: github/codeql-action/init@v2
         # 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@v3
+        uses: github/codeql-action/autobuild@v2
 
       # ℹ️ 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@v3
+        uses: github/codeql-action/analyze@v2

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

@@ -70,7 +70,7 @@ jobs:
 
     - name: Push CHANGELOG to Main
       if: steps.create-and-commit-changelog.outputs.changes == 'true'
-      uses: ad-m/github-push-action@v0.8.0
+      uses: ad-m/github-push-action@v0.6.0
       with:
         github_token: ${{ secrets.BOT_GITHUB_TOKEN }}
         branch: main

.github/workflows/depsreview.yaml

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

.github/workflows/docker-buildx.yml

@@ -40,7 +40,7 @@ jobs:
           install: true
 
       - name: Cache Docker layers
-        uses: actions/cache@v4
+        uses: actions/cache@v3
         with:
           path: /tmp/.buildx-cache
           key: ${{ runner.os }}-buildx-${{ github.sha }}
@@ -100,22 +100,12 @@ jobs:
 
       - name: Extract metadata (tags, labels) for Docker openim-api
         id: meta1
-        uses: docker/metadata-action@v5.5.1
+        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
-          tags: |
-            type=ref,event=tag
-            type=schedule
-            type=ref,event=branch
-            type=ref,event=pr
-            type=semver,pattern={{version}}
-            type=semver,pattern=v{{version}}
-            type=semver,pattern={{major}}.{{minor}}
-            type=semver,pattern={{major}}
-            type=sha
 
       - name: Build and push Docker image for openim-api
         uses: docker/build-push-action@v5
@@ -131,22 +121,12 @@ jobs:
 
       - name: Extract metadata (tags, labels) for Docker openim-cmdutils
         id: meta2
-        uses: docker/metadata-action@v5.5.1
+        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
-          tags: |
-            type=ref,event=tag
-            type=schedule
-            type=ref,event=branch
-            type=ref,event=pr
-            type=semver,pattern={{version}}
-            type=semver,pattern=v{{version}}
-            type=semver,pattern={{major}}.{{minor}}
-            type=semver,pattern={{major}}
-            type=sha
 
       - name: Build and push Docker image for openim-cmdutils
         uses: docker/build-push-action@v5
@@ -162,22 +142,12 @@ jobs:
 
       - name: Extract metadata (tags, labels) for Docker openim-crontask
         id: meta3
-        uses: docker/metadata-action@v5.5.1
+        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
-          tags: |
-            type=ref,event=tag
-            type=schedule
-            type=ref,event=branch
-            type=ref,event=pr
-            type=semver,pattern={{version}}
-            type=semver,pattern=v{{version}}
-            type=semver,pattern={{major}}.{{minor}}
-            type=semver,pattern={{major}}
-            type=sha
 
       - name: Build and push Docker image for openim-crontask
         uses: docker/build-push-action@v5
@@ -193,22 +163,12 @@ jobs:
 
       - name: Extract metadata (tags, labels) for Docker openim-msggateway
         id: meta4
-        uses: docker/metadata-action@v5.5.1
+        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
-          tags: |
-            type=ref,event=tag
-            type=schedule
-            type=ref,event=branch
-            type=ref,event=pr
-            type=semver,pattern={{version}}
-            type=semver,pattern=v{{version}}
-            type=semver,pattern={{major}}.{{minor}}
-            type=semver,pattern={{major}}
-            type=sha
 
       - name: Build and push Docker image for openim-msggateway
         uses: docker/build-push-action@v5
@@ -224,22 +184,12 @@ jobs:
 
       - name: Extract metadata (tags, labels) for Docker openim-msgtransfer
         id: meta5
-        uses: docker/metadata-action@v5.5.1
+        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
-          tags: |
-            type=ref,event=tag
-            type=schedule
-            type=ref,event=branch
-            type=ref,event=pr
-            type=semver,pattern={{version}}
-            type=semver,pattern=v{{version}}
-            type=semver,pattern={{major}}.{{minor}}
-            type=semver,pattern={{major}}
-            type=sha
 
       - name: Build and push Docker image for openim-msgtransfer
         uses: docker/build-push-action@v5
@@ -255,22 +205,12 @@ jobs:
           
       - name: Extract metadata (tags, labels) for Docker openim-push
         id: meta6
-        uses: docker/metadata-action@v5.5.1
+        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
-          tags: |
-            type=ref,event=tag
-            type=schedule
-            type=ref,event=branch
-            type=ref,event=pr
-            type=semver,pattern={{version}}
-            type=semver,pattern=v{{version}}
-            type=semver,pattern={{major}}.{{minor}}
-            type=semver,pattern={{major}}
-            type=sha
 
       - name: Build and push Docker image for openim-push
         uses: docker/build-push-action@v5
@@ -286,22 +226,12 @@ jobs:
 
       - name: Extract metadata (tags, labels) for Docker openim-rpc-auth
         id: meta7
-        uses: docker/metadata-action@v5.5.1
+        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
-          tags: |
-            type=ref,event=tag
-            type=schedule
-            type=ref,event=branch
-            type=ref,event=pr
-            type=semver,pattern={{version}}
-            type=semver,pattern=v{{version}}
-            type=semver,pattern={{major}}.{{minor}}
-            type=semver,pattern={{major}}
-            type=sha
 
       - name: Build and push Docker image for openim-rpc-auth
         uses: docker/build-push-action@v5
@@ -317,22 +247,12 @@ jobs:
 
       - name: Extract metadata (tags, labels) for Docker openim-rpc-conversation
         id: meta8
-        uses: docker/metadata-action@v5.5.1
+        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
-          tags: |
-            type=ref,event=tag
-            type=schedule
-            type=ref,event=branch
-            type=ref,event=pr
-            type=semver,pattern={{version}}
-            type=semver,pattern=v{{version}}
-            type=semver,pattern={{major}}.{{minor}}
-            type=semver,pattern={{major}}
-            type=sha
 
       - name: Build and push Docker image for openim-rpc-conversation
         uses: docker/build-push-action@v5
@@ -348,22 +268,12 @@ jobs:
 
       - name: Extract metadata (tags, labels) for Docker openim-rpc-friend
         id: meta9
-        uses: docker/metadata-action@v5.5.1
+        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
-          tags: |
-            type=ref,event=tag
-            type=schedule
-            type=ref,event=branch
-            type=ref,event=pr
-            type=semver,pattern={{version}}
-            type=semver,pattern=v{{version}}
-            type=semver,pattern={{major}}.{{minor}}
-            type=semver,pattern={{major}}
-            type=sha
 
       - name: Build and push Docker image for openim-rpc-friend
         uses: docker/build-push-action@v5
@@ -379,22 +289,12 @@ jobs:
 
       - name: Extract metadata (tags, labels) for Docker openim-rpc-group
         id: meta10
-        uses: docker/metadata-action@v5.5.1
+        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
-          tags: |
-            type=ref,event=tag
-            type=schedule
-            type=ref,event=branch
-            type=ref,event=pr
-            type=semver,pattern={{version}}
-            type=semver,pattern=v{{version}}
-            type=semver,pattern={{major}}.{{minor}}
-            type=semver,pattern={{major}}
-            type=sha
 
       - name: Build and push Docker image for openim-rpc-group
         uses: docker/build-push-action@v5
@@ -410,22 +310,12 @@ jobs:
 
       - name: Extract metadata (tags, labels) for Docker openim-rpc-msg
         id: meta11
-        uses: docker/metadata-action@v5.5.1
+        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
-          tags: |
-            type=ref,event=tag
-            type=schedule
-            type=ref,event=branch
-            type=ref,event=pr
-            type=semver,pattern={{version}}
-            type=semver,pattern=v{{version}}
-            type=semver,pattern={{major}}.{{minor}}
-            type=semver,pattern={{major}}
-            type=sha
 
       - name: Build and push Docker image for openim-rpc-msg
         uses: docker/build-push-action@v5
@@ -441,22 +331,12 @@ jobs:
 
       - name: Extract metadata (tags, labels) for Docker openim-rpc-third
         id: meta12
-        uses: docker/metadata-action@v5.5.1
+        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
-          tags: |
-            type=ref,event=tag
-            type=schedule
-            type=ref,event=branch
-            type=ref,event=pr
-            type=semver,pattern={{version}}
-            type=semver,pattern=v{{version}}
-            type=semver,pattern={{major}}.{{minor}}
-            type=semver,pattern={{major}}
-            type=sha
 
       - name: Build and push Docker image for openim-rpc-third
         uses: docker/build-push-action@v5
@@ -472,22 +352,12 @@ jobs:
 
       - name: Extract metadata (tags, labels) for Docker openim-rpc-user
         id: meta13
-        uses: docker/metadata-action@v5.5.1
+        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
-          tags: |
-            type=ref,event=tag
-            type=schedule
-            type=ref,event=branch
-            type=ref,event=pr
-            type=semver,pattern={{version}}
-            type=semver,pattern=v{{version}}
-            type=semver,pattern={{major}}.{{minor}}
-            type=semver,pattern={{major}}
-            type=sha
 
       - name: Build and push Docker image for openim-rpc-user
         uses: docker/build-push-action@v5

.github/workflows/e2e-test.yml

@@ -12,7 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-name: OpenIM E2E And API Test
+name: OpenIM Linux System E2E Test
 
 on:
   workflow_dispatch:
@@ -34,7 +34,7 @@ jobs:
     steps:
 
       - name: Set up Go 1.21
-        uses: actions/setup-go@v5
+        uses: actions/setup-go@v4
         with:
           go-version: 1.21
         id: go
@@ -60,7 +60,7 @@ jobs:
       uses: actions/checkout@v4
 
     - name: Set up Go ${{ matrix.go_version }}
-      uses: actions/setup-go@v5
+      uses: actions/setup-go@v4
       with:
         go-version: ${{ matrix.go_version }}
       id: go
@@ -73,22 +73,16 @@ jobs:
 
     - name: Docker Operations
       run: |
+        sudo make init
         sudo docker compose up -d
-        sudo bash bootstrap.sh
-        sudo mage
         sudo sleep 20
 
     - name: Module Operations
       run: |
-        echo "===========> Verifying go-gitlint is installed"
-        if [ ! -f ./_output/tools/go-gitlint ]; then
-          export GOBIN=$(pwd)/_output/tools
-          echo "===========> Installing The default installation path is /home/ubuntu/DF/open-im-server/_output/tools/go-gitlint"
-          sudo go install github.com/marmotedu/go-gitlint/cmd/go-gitlint@latest
-          echo "===========> go-gitlint is installed in /home/ubuntu/DF/open-im-server/_output/tools/go-gitlint"
-        fi
+        sudo make tidy
+        sudo make tools.verify.go-gitlint
 
-    - name: Build, Start(make build && make start)
+    - name: Build, Start
       run: |
         sudo ./scripts/install/install.sh -i
 
@@ -96,52 +90,13 @@ jobs:
       run: |
         sudo ./scripts/install/install.sh -s
 
-#    - name: Exec OpenIM API test (make test-api)
-    - name: Exec OpenIM test (make test)
+    - name: Exec OpenIM API test
       run: |
-        mkdir -p ./tmp
-        touch ./tmp/test.md
-        echo "# OpenIM Test" >> ./tmp/test.md
-        echo "## OpenIM API Test" >> ./tmp/test.md
-        echo "<details><summary>Command Output for OpenIM API Test</summary>" >> ./tmp/test.md
-        echo "<pre><code>" >> ./tmp/test.md
-        echo "===========> Run api test"
-        ./scripts/install/test.sh
-        echo "===========> Run api test" >> ./tmp/test.md
-        ./scripts/install/test.sh >> ./tmp/test.md
-        echo "</code></pre>" >> ./tmp/test.md
-        echo "</details>" >> ./tmp/test.md
-
-        echo "===========> Run api test"
-        ./scripts/install/test.sh
-
- #   - name: Exec OpenIM E2E Test (make test-e2e)
- #     run: |
- #       echo "" >> ./tmp/test.md
- #       echo "## OpenIM E2E Test" >> ./tmp/test.md
- #       echo "<details><summary>Command Output for OpenIM E2E Test</summary>" >> ./tmp/test.md
- #       echo "<pre><code>" >> ./tmp/test.md
- #       sudo make test-e2e | tee -a ./tmp/test.md
- #       echo "</code></pre>" >> ./tmp/test.md
- #       echo "</details>" >> ./tmp/test.md
-
- #       sudo make test-e2e
-
-    - name: Comment PR with file
-      uses: thollander/actions-comment-pull-request@v2
-      with:
-        filePath: ./tmp/test.md
-        comment_tag: nrt_file
-        reactions: eyes, rocket
-        mode: recreate
-        GITHUB_TOKEN: ${{ secrets.BOT_GITHUB_TOKEN }}
-      continue-on-error: true
-
-    - name: Check outputs
+        sudo make test-api
+    
+    - name: Exec OpenIM E2E test
       run: |
-        echo "id : ${{ steps.nrt_message.outputs.id }}"
-        echo "body : ${{ steps.nrt_message.outputs.body }}"
-        echo "html_url : ${{ steps.nrt_message.outputs.html_url }}"
+        sudo make test-e2e
 
     - name: Exec OpenIM System uninstall
       run: |
@@ -156,4 +111,4 @@ jobs:
         PUBLISH_BRANCH: gh-pages
       env:
         GITHUB_TOKEN: ${{ secrets.BOT_GITHUB_TOKEN }}
-      continue-on-error: true
+      continue-on-error: true

.github/workflows/golangci-lint.yml

@@ -24,20 +24,12 @@ jobs:
       runs-on: ubuntu-latest
       steps:
         - uses: actions/checkout@v4
-        - uses: actions/setup-go@v5
+        - uses: actions/setup-go@v4
           with:
             go-version: '1.21'
             cache: false
-        - name: OpenIM Scripts Verification(make verify)
-          run: |
-            cd scripts
-            for script in verify-*; do
-              if [ -x "$script" ]; then
-                ./"$script"
-              fi
-            done
         - name: golangci-lint
-          uses: golangci/golangci-lint-action@v4.0.0
+          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
@@ -55,4 +47,4 @@ jobs:
             only-new-issues: true
 
             # Optional:The mode to install golangci-lint. It can be 'binary' or 'goinstall'.
-            # install-mode: "goinstall"
+            # install-mode: "goinstall"

.github/workflows/greetings.yml

@@ -26,7 +26,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - uses: actions/first-interaction@v1.3.0
+      - uses: actions/first-interaction@v1.2.0
         with:
           repo-token: ${{ secrets.BOT_GITHUB_TOKEN }}
           pr-message: |

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

@@ -17,7 +17,6 @@ on:
   issues:
     types:
       - labeled
-
 jobs:
   add-comment:
     if: github.event.label.name == 'help wanted' || github.event.label.name == 'good first issue'
@@ -26,7 +25,7 @@ jobs:
       issues: write
     steps:
       - name: Add comment
-        uses: peter-evans/create-or-update-comment@v4
+        uses: peter-evans/create-or-update-comment@v3
         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.9.3
+        uses: lycheeverse/lychee-action@v1.8.0
         with:
             # For parameter description, see https://github.com/lycheeverse/lychee#commandline-parameters
             # Actions Link address -> https://github.com/lycheeverse/lychee-action
@@ -45,7 +45,7 @@ jobs:
 
       - name: Create Issue From File
         if: env.lychee_exit_code != 0
-        uses: peter-evans/create-issue-from-file@v5
+        uses: peter-evans/create-issue-from-file@v4
         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@v5
+      - uses: dessant/lock-threads@v4
         with:
           github-token: ${{ secrets.BOT_GITHUB_TOKEN }}
           issue-inactive-days: '365'

.github/workflows/milestone.yml

@@ -39,9 +39,8 @@ jobs:
       statuses: none
 
     steps:
-      - uses: actions/github-script@v7 # v6
+      - uses: actions/github-script@v6 # v6
         with:
-          github-token: ${{ secrets.BOT_GITHUB_TOKEN }}
           script: |
             if (!context.payload.pull_request.merged) {
               console.log('PR was not merged, skipping.');
@@ -57,10 +56,9 @@ jobs:
               owner: context.repo.owner,
               repo: context.repo.repo,
               state: 'open',
-              sort: 'title',
-              direction: 'desc'
+              sort: 'due_on',
+              direction: 'asc'
             })
-
             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@v4
+        uses: actions/setup-node@v2
         with:
           node-version: '16'
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v3
         with:
           fetch-depth: 0
       - uses: di-sukharev/opencommit@github-action-v1.0.4

.github/workflows/openimci.yml

@@ -1,4 +1,3 @@
-
 # Copyright © 2023 OpenIM open source community. All rights reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -12,180 +11,238 @@
 # 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 Auto Build
+
+name: OpenIM CI Aotu Build and Install
 
 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/**"
-  workflow_dispatch:
+
+env:
+  GO_VERSION: "1.19"
+  GOLANGCI_VERSION: "v1.50.1"
+
 
 jobs:
-
-  build-linux:
-    name: Execute OpenIM Script On Linux
-    runs-on: ubuntu-latest
+  openim:
+    name: Test with go ${{ matrix.go_version }} on ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
     permissions:
-      contents: write
-      pull-requests: write
+        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:
-        arch: [arm64, armv7, amd64]
-    
+        go_version: ["1.21"]
+        os: ["ubuntu-latest"]
     steps:
-    - uses: actions/checkout@v3
+    - 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
 
-    - name: Set up Go
+  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", "macos-latest"]
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v4
+
+    - name: Set up Go ${{ matrix.go_version }}
       uses: actions/setup-go@v4
       with:
-        go-version: '1.21'
+        go-version: ${{ matrix.go_version }}
+      id: go
 
-    - name: Set up Docker for Linux
+    - 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: Install latest Bash (macOS only)
+    #   if: runner.os == 'macOS'
+    #   run: |
+    #     /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
+    #     brew update
+    
+    #     brew install bash
+    #     brew install gnu-sed
+    
+    #     echo "/usr/local/bin" >> $GITHUB_PATH
+    #     echo "$(brew --prefix)/opt/gnu-sed/libexec/gnubin" >> $GITHUB_PATH
+    #   continue-on-error: true
+
+    - name: Set up Docker for Ubuntu
+      if: runner.os == 'Linux'
       run: |
+        sudo make init
         sudo docker compose up -d
-        sudo sleep 30  # Increased sleep time for better stability
-      timeout-minutes: 20  # Increased timeout for Docker setup
+        sudo sleep 20
 
+    # - name: Set up Docker for macOS
+    #   if: runner.os == 'macOS'
+    #   run: |
+    #     brew install --cask docker
+    #     open /Applications/Docker.app
 
-    - name: init
-      run: sudo bash bootstrap.sh
-      timeout-minutes: 20
+    #     sleep 10
+    #     docker-compose --version || brew install docker-compose
 
-    - name: Build, Start, Check Services and Print Logs for Linux
+    #     docker-compose up -d
+    #     sleep 20
+
+    - name: Module Operations for Ubuntu
+      if: runner.os == 'Linux'
       run: |
-        sudo mage
-        sudo mage start
-        sudo mage check
-        
+        sudo make tidy
+        sudo make tools.verify.go-gitlint
 
-    - name: Restart Services and Print Logs
+    # - name: Module Operations for macOS
+    #   if: runner.os == 'macOS'
+    #   run: |
+    #     make tidy
+    #     make tools.verify.go-gitlint
+
+    - name: Build, Start, Check Services and Print Logs for Ubuntu
+      if: runner.os == 'Linux'
       run: |
-        sudo mage stop
-        sudo mage start
-        sudo mage check
+        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)
 
+    - name: Restart Services and Print Logs for Ubuntu
+      if: runner.os == 'Linux'
+      run: |
+        sudo make restart
+        sudo make 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: Build, Start, Check Services and Print Logs for macOS
+    #   if: runner.os == 'macOS'
+    #   run: |
+    #     make init && \
+    #     make build && \
+    #     make start && \
+    #     make check || \
+    #     (echo "An error occurred, printing logs:" && sudo cat ./_output/logs/* 2>/dev/null)
 
-#    - name: Set up Go
-#      uses: actions/setup-go@v4
-#      with:
-#        go-version: '1.21'
+  openim-test-build-image:
+    name: Build OpenIM Docker Image
+    runs-on: ubuntu-latest
+    environment:
+      name: openim
+    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
 
-        
-#        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 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: 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
+    - name: Test Docker Build
+      run: |
+        sudo make init
+        sudo make image

.github/workflows/project-progress.yml

@@ -24,16 +24,13 @@ 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.9.0
+      - uses: alex-page/github-project-automation-plus@v0.8.3
         with:
           project: openim-powerful
           column: In Progress
-          repo-token: ${{ secrets.BOT_GITHUB_TOKEN }}
+          repo-token: ${{ secrets.BOT_GITHUB_TOKEN }}

.github/workflows/pull-request.yml

@@ -14,6 +14,12 @@
 
 name: Github Pull Request
 on:
+  push:
+    branches: [main]
+    paths-ignore:
+      - 'README.md'
+      - 'CONTRIBUTING.md'
+      - 'docs/**'
   workflow_dispatch:
   schedule:
     - cron: '0 2 * * *'
@@ -31,18 +37,24 @@ 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@v5
+        uses: actions/setup-go@v4
       - 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 and lint
+      - name: Run go format
         run: |
           sudo make format
           echo "Run go format successfully" 
@@ -56,34 +68,8 @@ jobs:
 
       - name: Generate all necessary files, such as error code files
         run: |
-          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 ..
+          make generate
+          echo "Generate all necessary files successfully" 
         continue-on-error: true
 
       - name: Run unit test and get test coverage
@@ -92,39 +78,38 @@ 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@v6
+        uses: peter-evans/create-pull-request@v5
         with:
           token: ${{ secrets.BOT_GITHUB_TOKEN }}
           commit-message: "cicd: bump League Patch"
-          author: kubbot <3293172751ysy@gmail.com>
-          committer: kubbot <3293172751ysy@gmail.com>
-        #   signoff: false
-        #   draft: false
-          branch: "asf-auto-updates"
+          author: kubbot <kubbot@3293172751ysy@gmail.com>
+          signoff: false
+          draft: false
+          branch: ''
           assignees: cubxxw
           reviewers: cubxxw
-          title: "[Auto PR 🤖] Bump League Patch auto PR"
+          delete-branch: true
+          title: "Bump League Patch auto PR: $(date +'%Y%m%d')"
           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. 
+            This is an automated PR. @ $(date +'%Y%m%d')
             <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@v6
+      - uses: release-drafter/release-drafter@v5
         # (Optional) specify config name to use, relative to .github/. Default: release-drafter.yml
         # with:
         #   config-name: my-config.yml

.github/workflows/release.yml

@@ -33,7 +33,7 @@ jobs:
         with:
           fetch-depth: 0
       - run: git fetch --force --tags
-      - uses: actions/setup-go@v5
+      - uses: actions/setup-go@v4
         with:
           go-version: stable
       # More assembly might be required: Docker logins, GPG, etc. It all depends
@@ -71,11 +71,11 @@ jobs:
           version: 3.x
           repo-token: ${{ secrets.GITHUB_TOKEN }}
       - uses: docker/setup-qemu-action@326560df218a7ea9cf6ab49bbc88b8b306bb437e # v2
-      - uses: actions/cache@a2ed59d39b352305bdd2f628719a53b2cc4f9613 # v3
+      - 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 }}
+      - run: task goreleaser:test:${{ matrix.format }}

.github/workflows/stale.yml

@@ -21,7 +21,7 @@ name: Mark stale issues and pull requests
 
 on:
   schedule:
-  - cron: '0 8 * * 1'
+  - cron: '0 8 * * *'
 
 jobs:
   stale:
@@ -32,11 +32,11 @@ jobs:
       pull-requests: write
 
     steps:
-    - uses: actions/stale@v9
+    - uses: actions/stale@v8
       with:
         repo-token: ${{ secrets.BOT_GITHUB_TOKEN }}
         days-before-stale: 60
-        days-before-close: 305
+        days-before-close: 7
         stale-issue-message: 'This issue is stale because it has been open 60 days with no activity. Remove stale label or comment or this will be closed in 7 days.'
         stale-pr-message: 'This issue is stale because it has been open 60 days with no activity.'
         close-issue-message: 'This issue was closed because it has been stalled for 7 days with no activity.'

.github/workflows/sync-release.yml

@@ -3,7 +3,7 @@
 # you may not use this file except in compliance with the License.
 
 # https://github.com/BetaHuhn/repo-file-sync-action
-name: Synchronize OpenIM Release Branch Public Code To Other Repositories
+name: Synchronize kubecub public code to other repositories
 on:
     push:
         paths:
@@ -41,4 +41,3 @@ jobs:
             automerge
           ASSIGNEES: |
             kubbot
-        continue-on-error: true

.github/workflows/sync.yml

@@ -3,7 +3,7 @@
 # you may not use this file except in compliance with the License.
 
 # https://github.com/BetaHuhn/repo-file-sync-action
-name: Synchronize OpenIM Main Branch Public Code To Other Repositories
+name: Synchronize kubecub public code to other repositories
 on:
     push:
         branches:
@@ -36,5 +36,4 @@ jobs:
             file-sync
             automerge
           ASSIGNEES: |
-            kubbot
-        continue-on-error: true
+            kubbot

.gitignore

@@ -34,7 +34,11 @@ deployments/charts/generated-configs/
 ### OpenIM Config ###
 .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

.golangci.yml

@@ -39,19 +39,15 @@ 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:
-  #   - components
-  #   - docs
-  #   - util
-  #   - .*~
-  #   - api/swagger/docs
-  #   - server/docs
-  #   - components/mnt/config/certs
-  #   - logs
+  skip-dirs:
+    - util
+    - .*~
+    - api/swagger/docs
+    - server/docs
 
   # default is true. Enables skipping of directories:
   #   vendor$, third_party$, testdata$, examples$, Godeps$, builtin$
-  # skip-dirs-use-default: true
+  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
@@ -59,15 +55,9 @@ 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
-  #   - ".*_test.go"
-  #   - "mocks/"
-  #   - ".github/"
-  #   - "logs/"
-  #   - "_output/"
-  #   - "components/"
+  skip-files:
+    - ".*\\.my\\.go$"
+    - _test.go
 
   # by default isn't set. If set we pass it to "go list -mod={option}". From "go help modules":
   # If invoked with -mod=readonly, the go command is disallowed from the implicit
@@ -87,7 +77,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
@@ -118,7 +108,9 @@ 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
@@ -139,8 +131,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
@@ -150,11 +142,6 @@ 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
@@ -166,34 +153,33 @@ 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
-      - ^unsafe\..*$
-      - ^init$
-      - ^os.Exit$
-      - ^fmt.Print.*$
-      - errors.New.*$
-      - ^fmt.Println.*$
-      - ^panic$
-      - painc
+  #   forbid:
+  #     - ^print.*$
+  #     - 'fmt\.Print.*'
+  #     - fmt.Println.* # too much log noise
   #     - ginkgo\\.F.* # these are used just for local development
   #   # Exclude godoc examples from forbidigo checks.  Default is true.
   #   exclude_godoc_examples: false
-
   funlen:
-    lines: 220
+    lines: 150
     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
@@ -219,6 +205,9 @@ 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
@@ -247,6 +236,9 @@ 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
@@ -260,10 +252,15 @@ 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
@@ -280,12 +277,9 @@ linters-settings:
     # list of regexps for excluding particular comment lines from check
     exclude:
       # example: exclude comments which contain numbers
-      - '[0-9]+'
-      - 'func\s+\w+'
-      - 'FIXME:'
-      - '.*func.*'
+      # - '[0-9]+'
     # check that each sentence starts with a capital letter
-    capital: true
+    capital: false
   godox:
     # report any comments starting with keywords, this is useful for TODO or FIXME comments that
     # might be left in the code accidentally and should be resolved before merging
@@ -308,15 +302,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.
       #
@@ -334,45 +328,21 @@ 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:
-    # 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$'
+    settings:
+      mnd:
+        # the list of enabled checks, see https://github.com/tommy-muehle/go-mnd/#checks for description.
+        checks: argument,case,condition,operation,return,assign
+        # ignored-numbers: 1000
+        # ignored-files: magic_.*.go
+        # ignored-functions: math.*
   gomoddirectives:
     # Allow local `replace` directives. Default is false.
     replace-local: true
@@ -384,7 +354,6 @@ linters-settings:
     retract-allow-no-explanation: false
     # Forbid the use of the `exclude` directives. Default is false.
     exclude-forbidden: false
-
   gomodguard:
     allowed:
       modules:    
@@ -448,6 +417,9 @@ 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
@@ -464,25 +436,15 @@ 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.
@@ -492,8 +454,6 @@ 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
@@ -502,6 +462,8 @@ 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.
@@ -527,11 +489,14 @@ linters-settings:
     - github.com\/user\/package\/v4\.Type
 
   lll:
-    # max line length, lines longer will be reported. Default is 250.
+    # max line length, lines longer will be reported. Default is 120.
     # '\t' is counted as 1 character by default, and can be changed with the tab-width option
-    line-length: 250
+    line-length: 240
     # tab width in spaces. Default to 1.
     tab-width: 4
+  maligned:
+    # print struct with more effective memory layout or not, false by default
+    suggest-new: true
   misspell:
     # Correct spellings using locale preferences for US or UK.
     # Default is to use a neutral variety of English.
@@ -564,6 +529,8 @@ 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.
@@ -587,13 +554,14 @@ 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"
+    #  - "Help"
+    #  - "MetricUnits"
+    #  - "Counter"
+    #  - "HistogramSummaryReserved"
+    #  - "MetricTypeInName"
+    #  - "ReservedChars"
+    #  - "CamelCase"
+    #  - "lintUnitAbbreviations"
     
   predeclared:
     # comma-separated list of predeclared identifiers to not report on
@@ -603,7 +571,6 @@ linters-settings:
   rowserrcheck:
     packages:
       - github.com/jmoiron/sqlx
-
   revive:
     # see https://github.com/mgechev/revive#available-rules for details.
     ignore-generated-header: true
@@ -611,27 +578,15 @@ 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.20"
+    go: "1.16"
     # https://staticcheck.io/docs/options#checks
     checks: [ "all" ]
 
   stylecheck:
     # Select the Go version to target. The default is '1.13'.
-    go: "1.20"
+    go: "1.16"
 
     # https://staticcheck.io/docs/options#checks
     checks: [ "all", "-ST1000", "-ST1003", "-ST1016", "-ST1020", "-ST1021", "-ST1022" ]
@@ -643,6 +598,7 @@ 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:
@@ -688,11 +644,12 @@ 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
@@ -706,7 +663,6 @@ linters-settings:
       - errors.New(
       - errors.Unwrap(
       - .Wrap(
-      - .WrapMsg(
       - .Wrapf(
       - .WithMessage(
       - .WithMessagef(
@@ -714,8 +670,6 @@ 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
@@ -742,6 +696,7 @@ 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:
@@ -760,38 +715,17 @@ linters:
   # enable-all: true
   disable-all: true
   enable:
-    - 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
+    - typecheck     # 基本的类型检查
+    - gofmt         # 格式检查
+    - govet         # Go 语言的标准检查工具
+    - gosimple      # 简化代码的建议
+    - misspell      # 拼写错误
+    - staticcheck   # 静态检查
+    - unused        # 未使用的代码检查
+    - goimports     # 检查导入是否正确排序和格式化
+    - godot         # 注释句点检查
+    - bodyclose     # 确保 HTTP response body 被关闭
+    - errcheck      # 检查是否遗漏了错误返回值
   fast: true
 
 issues:
@@ -802,7 +736,6 @@ issues:
   exclude:
     - tools/.*
     - test/.*
-    - components/*
     - third_party/.*
 
   # Excluding configuration per-path, per-linter, per-text and per-source
@@ -859,11 +792,6 @@ 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`.
@@ -924,4 +852,4 @@ severity:
   rules:
     - linters:
       - dupl
-      severity: info
+      severity: info

CHANGELOG/CHANGELOG-3.4.md

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

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

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

@@ -1,96 +0,0 @@
-
-
-# 如何给 OpenIM 贡献代码（提交 Pull Request）
-
-<p align="center">
-  <a href="./CONTRIBUTING.md">English</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>
-
-本指南将以 [openimsdk/open-im-server](https://github.com/openimsdk/open-im-server) 为例，详细说明如何为 OpenIM 项目贡献代码。我们采用“一问题一分支”的策略，确保每个 Issue 都对应一个专门的分支，以便有效管理代码变更。
-
-### 1. Fork 仓库
-前往 [openimsdk/open-im-server](https://github.com/openimsdk/open-im-server) GitHub 页面，点击右上角的 "Fork" 按钮，将仓库 Fork 到你的 GitHub 账户下。
-
-### 2. 克隆仓库
-将你 Fork 的仓库克隆到本地：
-```bash
-git clone https://github.com/your-username/open-im-server.git
-```
-
-### 3. 设置远程上游
-添加原始仓库为远程上游以便跟踪其更新：
-```bash
-git remote add upstream https://github.com/openimsdk/open-im-server.git
-```
-
-### 4. 创建 Issue
-在原始仓库中创建一个新的 Issue，详细描述你遇到的问题或希望添加
-
-的新功能。
-
-### 5. 创建新分支
-基于主分支创建一个新分支，并使用描述性的名称与 Issue ID，例如：
-```bash
-git checkout -b fix-bug-123
-```
-
-### 6. 提交更改
-在你的本地分支上进行更改后，提交这些更改：
-```bash
-git add .
-git commit -m "Describe your changes in detail"
-```
-
-### 7. 推送分支
-将你的分支推送回你的 GitHub Fork：
-```bash
-git push origin fix-bug-123
-```
-
-### 8. 创建 Pull Request
-在 GitHub 上转到你的 Fork 仓库，点击 "Pull Request" 按钮。确保 PR 描述清楚，并链接到相关的 Issue。
-
-### 9. 签署 CLA
-如果这是你第一次提交 PR，你需要在 PR 的评论中回复：
-```
-I have read the CLA Document and I hereby sign the CLA
-```
-
-### 编程规范
-请参考以下文档以了解关于 Go 语言编程规范的详细信息：
-- [Go 编码规范](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/go-code.md)
-- [代码约定](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/code-conventions.md)
-
-### 日志规范
-- **禁止使用标准的 `log` 包**。
-- 应使用 `"github.com/openimsdk/tools/log"` 包来打印日志，该包支持多种日志级别：`debug`、`info`、`warn`、`error`。
-- **错误日志应仅在首次调用的函数中打印**，以防止日志重复，并确保错误的上下文清晰。
-
-### 异常及错误处理
-- **禁止使用 `panic`**：程序中不应使用 `panic`，以避免在遇到不可恢复的错误时突然终止。
-- **错误包裹**：使用 `"github.com/openimsdk/tools/errs"` 来包裹错误，保持错误信息的完整性并增加调试便利。
-- **错误传递**：如果函数本身不能处理错误，应将错误返回给调用者，而不是隐藏或忽略这些错误。

CONTRIBUTING.md

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

Dockerfile

@@ -1,49 +1,32 @@
-# Use Go 1.21 Alpine as the base image for building the application
-FROM golang:1.21-alpine as builder
+# Build Stage
+FROM golang:1.20 AS builder
 
-# Define the base directory for the application as an environment variable
-ENV SERVER_DIR=/openim-server
+# Set go mod installation source and proxy
+ARG GO111MODULE=on
+ARG GOPROXY=https://goproxy.cn,direct
+ENV GO111MODULE=$GO111MODULE
+ENV GOPROXY=$GOPROXY
 
-# 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 . .
+# Set up the working directory
+WORKDIR /openim/openim-server
 
+COPY go.mod go.sum ./
 RUN go mod download
 
-# Install Mage to use for building the application
-RUN go install github.com/magefile/mage@v1.15.0
+# Copy all files to the container
+ADD . .
 
-# Optionally build your application if needed
-RUN mage build
+RUN make clean
+RUN make build
 
-# Using Alpine Linux with Go environment for the final image
-FROM golang:1.21-alpine
+FROM ghcr.io/openim-sigs/openim-ubuntu-image:latest
 
-# Install necessary packages, such as bash
-RUN apk add --no-cache bash
+WORKDIR ${SERVER_WORKDIR}
 
-# Set the environment and work directory
-ENV SERVER_DIR=/openim-server
-WORKDIR $SERVER_DIR
+# 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
+COPY --from=builder ${SERVER_WORKDIR}/deployments /openim/openim-server/deployments
 
-
-# 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.14-alpha.5
-
-# Set the command to run when the container starts
-ENTRYPOINT ["sh", "-c", "mage start && tail -f /dev/null"]
+CMD ["/openim/openim-server/scripts/docker-start-all.sh"]

Makefile

@@ -0,0 +1,255 @@
+# ==============================================================================
+# 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 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

@@ -0,0 +1,143 @@
+<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="./docs/images/Wechat.jpg" 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,123 +17,246 @@
 [![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">English</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>
-
+[**English**](./README.md) •
+[**简体中文**](./README-zh_CN.md) •
+[**Docs**](https://openim.io/en)
 
 </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-2ijy1ys1f-O0aEDCr7ExRZ7mwsHAVg9A)
-+ :eyes: [Join our WeChat Group](https://openim-1253691595.cos.ap-nanjing.myqcloud.com/WechatIMG20.jpeg)
 
 ## Ⓜ️ About OpenIM
 
-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.
+OpenIM isn't just an open-source instant messaging component, it's an integral part of your application ecosystem. Check out this diagram to understand how AppServer, AppClient, OpenIMServer, and OpenIMSDK interact.
 
 ![App-OpenIM Relationship](./docs/images/oepnim-design.png)
 
-## 🚀 Introduction to OpenIMSDK
+## 🚀 About OpenIMSDK
 
-**OpenIMSDK**, designed for **OpenIMServer**, is an IM SDK created specifically for integration into client applications. It supports various functionalities and modules:
+**OpenIMSDK** seamlessly integrates into your application, delivering a rich, real-time messaging experience without requiring intricate UI integration. It provides:
 
-+ 🌟 Main Features:
-  - 📦 Local Storage
-  - 🔔 Listener Callbacks
-  - 🛡️ API Wrapping
-  - 🌐 Connection Management
++ **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 Modules:
-  1. 🚀 Initialization and Login
-  2. 👤 User Management
-  3. 👫 Friends Management
-  4. 🤖 Group Functions
-  5. 💬 Session Handling
+It's crafted in Golang and supports cross-platform deployment, ensuring a coherent messaging experience across all platforms.
 
-Built with Golang and supports cross-platform deployment to ensure a consistent integration experience across all platforms.
+👉 **[Explore GO SDK](https://github.com/openimsdk/openim-sdk-core)**
 
-👉 **[Explore the GO SDK](https://github.com/openimsdk/openim-sdk-core)**
+## 🌐 About OpenIMServer
 
-## 🌐 Introduction to OpenIMServer 
+**OpenIMServer**, meticulously developed in Golang, ensures a stellar instant messaging server capability with a multifold approach:
 
-+ **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.
++ **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.
 
-### Enhanced Business Functions:
+### Enhanced Business Functionalities:
 
-+ **REST API**: Provides a REST API for business systems to enhance functionality, such as group creation and message pushing through backend interfaces.
++ **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.
 
-+ **Webhooks**: Expands business forms through callbacks, sending requests to business servers before or after certain events.
+👉 **[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.
+
+-->
 
-  ![Overall Architecture](./docs/images/architecture-layers.png)
 
 ## :rocket: Quick Start
 
-Experience online for iOS/Android/H5/PC/Web:
+You can quickly learn OpenIM engineering solutions, all it takes is one simple command:
 
-👉 **[OpenIM Online Demo](https://www.openim.io/en/commercial)**
+```bash
+$ make demo
+```
 
-To facilitate user experience, we offer various deployment solutions. You can choose your preferred deployment method from the list below:
+🤲 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> 
+-->
 
 + **[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)**
 
-## System Support
+<!-- 
+## :link: OpenIM and your application
 
-Supports Linux, Windows, Mac systems, and ARM and AMD CPU architectures.
+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.
 
-## :link: Links
+![App-OpenIM Relationship](./docs/images/oepnim-design.png)
 
-  + **[Developer Manual](https://docs.openim.io/)**
-  + **[Changelog](https://github.com/openimsdk/open-im-server/blob/main/CHANGELOG.md)**
+## :building_construction: Overall Architecture
 
-## :writing_hand: How to Contribute
+Delve into the heart of Open-IM-Server's functionality with our architecture diagram.
 
-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.
+![Overall Architecture](./docs/images/Architecture.jpg) -->
 
-  + **[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)**
+## :hammer_and_wrench: To start developing OpenIM
 
-Thank you for contributing to building a powerful instant messaging solution!
+[![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)
 
-## :closed_book: License
+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).
 
-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. 
+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)
+- [Manage backend and monitor deployment](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/prometheus-grafana.md)
+
+## :busts_in_silhouette: Community
+
++ 📚 [OpenIM Community](https://github.com/OpenIMSDK/community)
++ 💕 [OpenIM Interest Group](https://github.com/Openim-sigs)
++ 🚀 [Join our Slack community](https://join.slack.com/t/openimsdk/shared_invite/zt-22720d66b-o_FvKxMTGXtcnnnHiMqe9Q)
++ :eyes: [Join our wechat (微信群)](https://openim-1253691595.cos.ap-nanjing.myqcloud.com/WechatIMG20.jpeg)
+
+## :calendar: Community Meetings
+
+We want anyone to get involved in our community and contributing code, we offer gifts and rewards, and we welcome you to join us every Thursday night.
+
+Our conference is in the [OpenIM Slack](https://join.slack.com/t/openimsdk/shared_invite/zt-22720d66b-o_FvKxMTGXtcnnnHiMqe9Q) 🎯, then you can search the Open-IM-Server pipeline to join
+
+We take notes of each [biweekly meeting](https://github.com/orgs/OpenIMSDK/discussions/categories/meeting) in [GitHub discussions](https://github.com/openimsdk/open-im-server/discussions/categories/meeting), Our historical meeting notes, as well as replays of the meetings are available at [Google Docs :bookmark_tabs:](https://docs.google.com/document/d/1nx8MDpuG74NASx081JcCpxPgDITNTpIIos0DS6Vr9GU/edit?usp=sharing).
+
+## :eyes: Who are using OpenIM
+
+Check out our [user case studies](https://github.com/OpenIMSDK/community/blob/main/ADOPTERS.md) page for a list of the project users. Don't hesitate to leave a [📝comment](https://github.com/openimsdk/open-im-server/issues/379) and share your use case.
+
+## :page_facing_up: License
+
+OpenIM is licensed under the Apache 2.0 license. See [LICENSE](https://github.com/openimsdk/open-im-server/tree/main/LICENSE) for the full license text.
+
+The OpenIM logo, including its variations and animated versions, displayed in this repository [OpenIM](https://github.com/openimsdk/open-im-server) under the [assets/logo](./assets/logo) and [assets/logo-gif](assets/logo-gif) directories, are protected by copyright laws.
 
 ## 🔮 Thanks to our contributors!
 

README_zh_CN.md

@@ -1,142 +0,0 @@
-<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">English</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-2hljfom5u-9ZuzP3NfEKW~BJKbpLm0Hw)
-+ :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/open-im-server) 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/openim) under the `/assets/logo` and `/assets/logo-gif` directories, are protected by copyright laws.
 
 The logo design is credited to @Xx(席欣).
 

assets/colors.md

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

@@ -1,31 +0,0 @@
-@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

@@ -1,23 +0,0 @@
-#!/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,36 +3,12 @@
 
 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"
 
@@ -519,4 +495,4 @@ checksum:
   algorithm: sha256
 
 release:
-  prerelease: auto
+  prerelease: auto

build/images/openim-api/Dockerfile

@@ -19,6 +19,7 @@
 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,6 +19,7 @@
 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,6 +19,7 @@
 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,6 +19,7 @@
 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,6 +19,7 @@
 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,6 +19,7 @@
 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,6 +19,7 @@
 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,6 +19,7 @@
 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,6 +19,7 @@
 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,6 +19,7 @@
 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,6 +19,7 @@
 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,6 +19,7 @@
 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,6 +19,7 @@
 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,6 +19,7 @@
 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

@@ -0,0 +1,57 @@
+# 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,14 +15,114 @@
 package main
 
 import (
+	"context"
+	"fmt"
+	"net"
+	"net/http"
 	_ "net/http/pprof"
+	"os"
+	"os/signal"
+	"strconv"
+	"syscall"
+	"time"
 
+	"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/tools/system/program"
+	"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"
+	ginProm "github.com/openimsdk/open-im-server/v3/pkg/common/ginprometheus"
+	"github.com/openimsdk/open-im-server/v3/pkg/common/prommetrics"
 )
 
 func main() {
-	if err := cmd.NewApiCmd().Exec(); err != nil {
-		program.ExitWithError(err)
+	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())
 	}
 }
+
+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)
+
+	server := http.Server{Addr: address, Handler: router}
+	go func() {
+		err = server.ListenAndServe()
+		if err != nil && err != http.ErrServerClosed {
+			log.ZError(context.Background(), "api run failed", err, "address", address)
+			os.Exit(1)
+		}
+	}()
+
+	sigs := make(chan os.Signal, 1)
+	signal.Notify(sigs, syscall.SIGINT, syscall.SIGTERM, syscall.SIGQUIT)
+	<-sigs
+
+	ctx, cancel := context.WithTimeout(context.Background(), 15*time.Second)
+	defer cancel()
+
+	// graceful shutdown operation.
+	if err := server.Shutdown(ctx); err != nil {
+		log.ZError(context.Background(), "failed to api-server shutdown", err)
+		return err
+	}
+
+	return nil
+}

cmd/openim-cmdutils/main.go

@@ -16,7 +16,6 @@ package main
 
 import (
 	"github.com/openimsdk/open-im-server/v3/pkg/common/cmd"
-	"github.com/openimsdk/tools/system/program"
 )
 
 func main() {
@@ -29,8 +28,6 @@ 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
@@ -41,8 +38,6 @@ 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
@@ -51,8 +46,6 @@ func main() {
 	clearCmd.AddCommand(msgCmd.ClearMsgCmd())
 	clearCmd.AddSuperGroupIDFlag()
 	clearCmd.AddUserIDFlag()
-	clearCmd.AddConfigDirFlag()
-	clearCmd.AddIndexFlag()
 	clearCmd.AddClearAllFlag()
 	clearCmd.AddBeginSeqFlag()
 	clearCmd.AddLimitFlag()
@@ -61,6 +54,6 @@ func main() {
 	// openIM clear msg --clearAll
 	msgUtilsCmd.AddCommand(&getCmd.Command, &fixCmd.Command, &clearCmd.Command)
 	if err := msgUtilsCmd.Execute(); err != nil {
-		program.ExitWithError(err)
+		panic(err)
 	}
 }

cmd/openim-crontask/main.go

@@ -15,12 +15,13 @@
 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() {
-	if err := cmd.NewCronTaskCmd().Exec(); err != nil {
-		program.ExitWithError(err)
+	cronTaskCmd := cmd.NewCronTaskCmd()
+	if err := cronTaskCmd.Exec(tools.StartTask); err != nil {
+		panic(err.Error())
 	}
 }

cmd/openim-msggateway/main.go

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

cmd/openim-msgtransfer/main.go

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

cmd/openim-push/main.go

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

config/README.md

@@ -1,63 +0,0 @@
----
-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

@@ -1,65 +0,0 @@
-# 						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/Readme.md

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

config/alertmanager.yml

@@ -1,34 +0,0 @@
-global:
-  resolve_timeout: 5m
-  smtp_from: alert@openim.io
-  smtp_smarthost: smtp.163.com:465
-  smtp_auth_username: alert@openim.io
-  smtp_auth_password: YOURAUTHPASSWORD
-  smtp_require_tls: false
-  smtp_hello: xxx
-
-templates:
-  - /etc/alertmanager/email.tmpl
-
-route:
-  group_by: [ 'alertname' ]
-  group_wait: 5s
-  group_interval: 5s
-  repeat_interval: 5m
-  receiver: email
-  routes:
-    - matchers:
-        - alertname = "XXX"
-      group_by: [ 'instance' ]
-      group_wait: 5s
-      group_interval: 5s
-      repeat_interval: 5m
-      receiver: email
-
-receivers:
-  - name: email
-    email_configs:
-      - to: 'alert@example.com'
-        html: '{{ template "email.to.html" . }}'
-        headers: { Subject: "[OPENIM-SERVER]Alarm" }
-        send_resolved: true

config/discovery.yml

@@ -1,13 +0,0 @@
-enable: "etcd"
-etcd:
-  rootDirectory: openim
-  address: [ localhost:12379 ]
-  username: ''
-  password: ''
-
-zookeeper:
-  schema: openim
-  address: [ localhost:12181 ]
-  username: ''
-  password: ''
-

config/email.tmpl

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

config/kafka.yml

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

@@ -1,27 +0,0 @@
-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

@@ -1,14 +0,0 @@
-# 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
-# output simplify log when KeyAndValues's value len is bigger than 50 in rpc method log
-isSimplify: true

config/minio.yml

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

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

config/openim-api.yml

@@ -1,13 +0,0 @@
-api:
-  # Listening IP; 0.0.0.0 means both internal and external IPs are listened to, default is recommended
-  listenIP: 0.0.0.0
-  # Listening ports; if multiple are configured, multiple instances will be launched, must be consistent with the number of prometheus.ports
-  ports: [ 10002 ]
-
-prometheus:
-  # Whether to enable prometheus
-  enable: true
-  # Prometheus listening ports, must match the number of api.ports
-  ports: [ 20113 ]
-  # This address can be accessed via a browser
-  grafanaURL: http://127.0.0.1:13000/

config/openim-crontask.yml

@@ -1,3 +0,0 @@
-cronExecuteTime: "0 2 * * *"
-retainChatRecords: 365
-fileExpireTime: 90

config/openim-msggateway.yml

@@ -1,30 +0,0 @@
-rpc:
-  # The IP address where this RPC service registers itself; if left blank, it defaults to the internal network IP
-  registerIP: ''
-  # List of ports that the RPC service listens on; configuring multiple ports will launch multiple instances. These must match the number of configured prometheus ports
-  ports: [ 10140 ]
-
-prometheus:
-  # Enable or disable Prometheus monitoring
-  enable: true
-  # List of ports that Prometheus listens on; these must match the number of rpc.ports to ensure correct monitoring setup
-  ports: [ 20112 ]
-
-# IP address that the RPC/WebSocket service listens on; setting to 0.0.0.0 listens on both internal and external IPs. If left blank, it automatically uses the internal network IP
-listenIP: 0.0.0.0
-
-longConnSvr:
-  # WebSocket listening ports, must match the number of rpc.ports
-  ports: [ 10001 ]
-  # Maximum number of WebSocket connections
-  websocketMaxConnNum: 100000
-  # Maximum length of the entire WebSocket message packet
-  websocketMaxMsgLen: 4096
-  # WebSocket connection handshake timeout in seconds
-  websocketTimeout: 10
-
-# 1: For Android, iOS, Windows, Mac, and web platforms, only one instance can be online at a time
-multiLoginPolicy: 1
-
-
-

config/openim-msgtransfer.yml

@@ -1,6 +0,0 @@
-prometheus:
-  # Enable or disable Prometheus monitoring
-  enable: true
-  # List of ports that Prometheus listens on; each port corresponds to an instance of monitoring. Ensure these are managed accordingly
-  # Because four instances have been launched, four ports need to be specified
-  ports: [ 20108, 20109, 20110, 20111 ]

config/openim-push.yml

@@ -1,46 +0,0 @@
-rpc:
-  # The IP address where this RPC service registers itself; if left blank, it defaults to the internal network IP
-  registerIP: ''
-  # IP address that the RPC service listens on; setting to 0.0.0.0 listens on both internal and external IPs. If left blank, it automatically uses the internal network IP
-  listenIP: 0.0.0.0
-  # List of ports that the RPC service listens on; configuring multiple ports will launch multiple instances. These must match the number of configured prometheus ports
-  ports: [ 10170 ]
-
-prometheus:
-  # Enable or disable Prometheus monitoring
-  enable: true
-  # List of ports that Prometheus listens on; these must match the number of rpc.ports to ensure correct monitoring setup
-  ports: [ 20107 ]
-
-maxConcurrentWorkers: 3
-#"Use geTui for offline push notifications, or choose fcm or jpns; corresponding configuration settings must be specified."
-enable: "geTui"
-geTui:
-  pushUrl: "https://restapi.getui.com/v2/$appId"
-  masterSecret: ''
-  appKey: ''
-  intent: ''
-  channelID: ''
-  channelName: ''
-fcm:
-  # Prioritize using file paths. If the file path is empty, use URL
-  filePath: ""  # File path is concatenated with the parameters passed in through - c(`mage` default pass in `config/`) and filePath. 
-  authURL: ""  #  Must start with https or http.
-jpns:
-  appKey: ''
-  masterSecret: ''
-  pushURL: ''
-  pushIntent: ''
-
-# iOS system push sound and badge count
-iosPush:
-      pushSound: "xxx"
-      badgeCount: true
-      production: false
-
-
-
-
-
-
-

config/openim-rpc-auth.yml

@@ -1,18 +0,0 @@
-rpc:
-  # The IP address where this RPC service registers itself; if left blank, it defaults to the internal network IP
-  registerIP: ''
-  # IP address that the RPC service listens on; setting to 0.0.0.0 listens on both internal and external IPs. If left blank, it automatically uses the internal network IP
-  listenIP: 0.0.0.0
-  # List of ports that the RPC service listens on; configuring multiple ports will launch multiple instances. These must match the number of configured prometheus ports
-  ports: [ 10160 ]
-
-prometheus:
-  # Enable or disable Prometheus monitoring
-  enable: true
-  # List of ports that Prometheus listens on; these must match the number of rpc.ports to ensure correct monitoring setup
-  ports: [ 20106 ]
-
-tokenPolicy:
-  # Token validity period, in days
-  expire: 90
-

config/openim-rpc-conversation.yml

@@ -1,13 +0,0 @@
-rpc:
-  # The IP address where this RPC service registers itself; if left blank, it defaults to the internal network IP
-  registerIP: ''
-  # IP address that the RPC service listens on; setting to 0.0.0.0 listens on both internal and external IPs. If left blank, it automatically uses the internal network IP
-  listenIP: 0.0.0.0
-  # List of ports that the RPC service listens on; configuring multiple ports will launch multiple instances. These must match the number of configured prometheus ports
-  ports: [ 10180 ]
-
-prometheus:
-  # Enable or disable Prometheus monitoring
-  enable: true
-  # List of ports that Prometheus listens on; these must match the number of rpc.ports to ensure correct monitoring setup
-  ports: [ 20105 ]

config/openim-rpc-friend.yml

@@ -1,13 +0,0 @@
-rpc:
-  # The IP address where this RPC service registers itself; if left blank, it defaults to the internal network IP
-  registerIP: ''
-  # IP address that the RPC service listens on; setting to 0.0.0.0 listens on both internal and external IPs. If left blank, it automatically uses the internal network IP
-  listenIP: 0.0.0.0
-  # List of ports that the RPC service listens on; configuring multiple ports will launch multiple instances. These must match the number of configured prometheus ports
-  ports: [ 10120 ]
-
-prometheus:
-  # Enable or disable Prometheus monitoring
-  enable: true
-  # List of ports that Prometheus listens on; these must match the number of rpc.ports to ensure correct monitoring setup
-  ports: [ 20104 ]

config/openim-rpc-group.yml

@@ -1,13 +0,0 @@
-rpc:
-  # The IP address where this RPC service registers itself; if left blank, it defaults to the internal network IP
-  registerIP: ''
-  # IP address that the RPC service listens on; setting to 0.0.0.0 listens on both internal and external IPs. If left blank, it automatically uses the internal network IP
-  listenIP: 0.0.0.0
-  # List of ports that the RPC service listens on; configuring multiple ports will launch multiple instances. These must match the number of configured prometheus ports
-  ports: [ 10150 ]
-
-prometheus:
-  # Enable or disable Prometheus monitoring
-  enable: true
-  # List of ports that Prometheus listens on; these must match the number of rpc.ports to ensure correct monitoring setup
-  ports: [ 20103 ]

config/openim-rpc-msg.yml

@@ -1,20 +0,0 @@
-rpc:
-  # The IP address where this RPC service registers itself; if left blank, it defaults to the internal network IP
-  registerIP: ''
-  # IP address that the RPC service listens on; setting to 0.0.0.0 listens on both internal and external IPs. If left blank, it automatically uses the internal network IP
-  listenIP: 0.0.0.0
-  # List of ports that the RPC service listens on; configuring multiple ports will launch multiple instances. These must match the number of configured prometheus ports
-  ports: [ 10130 ]
-
-prometheus:
-  # Enable or disable Prometheus monitoring
-  enable: true
-  # List of ports that Prometheus listens on; these must match the number of rpc.ports to ensure correct monitoring setup
-  ports: [ 20102 ]
-
-
-# Does sending messages require friend verification
-friendVerify: false
-
-
-