Add files via upload

root user for kafka
refactor: 3.7.0 code conventions. (#2148 )
2026-04-28 22:39:18 +08:00 · 2024-04-20 09:18:27 +08:00 · 2024-04-20 09:17:38 +08:00 · 2024-04-19 22:23:08 +08:00 · 2024-04-15 16:05:30 +00:00 · 2024-04-02 03:31:25 +00:00
632 changed files with 20410 additions and 32191 deletions
@@ -0,0 +1,13 @@
+
+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
+
+
+OPENIM_WEB_FRONT_IMAGE=ghcr.io/openimsdk/openim-web:v3.5.0-docker
+OPENIM_ADMIN_FRONT_IMAGE=ghcr.io/openimsdk/openim-admin:toc-base-open-docker.35
+
+DATA_DIR=./
+
@@ -0,0 +1,22 @@
+# Copyright © 2024 OpenIM. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# https://github.com/marketplace/actions/code-language-detector
+directory: ./
+file_types:
+  - .go
+  - .yaml
+  - .yml
+languages:
+  - Chinese
@@ -48,4 +48,4 @@ template: |

  ## Contributors to this $REPOSITORY	release

-  $CONTRIBUTORS	
+  $CONTRIBUTORS	
@@ -0,0 +1,50 @@
+# https://github.com/marketplace/actions/conformity-checker-for-project
+baseConfig:
+  searchDirectory: "./"
+  ignoreCase: false
+
+directoryNaming:
+  allowHyphens: true
+  allowUnderscores: false
+  mustBeLowercase: true
+
+fileNaming:
+  allowHyphens: true
+  allowUnderscores: true
+  mustBeLowercase: true
+
+ignoreFormats:
+  - "\\.log$"
+  - "\\.env$"
+  - "README\\.md$"
+  - "_test\\.go$"
+  - "\\.md$"
+  - _test\\.txt$
+  - LICENSE
+  - Dockerfile
+  - CODEOWNERS
+  - Makefile
+
+ignoreDirectories:
+  - "vendor"
+  - ".git"
+  - "deployments"
+  - "node_modules"
+  - "logs"
+  - "CHANGELOG"
+  - "components"
+  - "_output"
+  - "tools/openim-web"
+  - "CHANGELOG"
+  - "examples/Test_directory"
+  - test/testdata
+
+fileTypeSpecificNaming:
+  ".yaml":
+    allowHyphens: true
+    allowUnderscores: false
+    mustBeLowercase: true
+  ".go":
+    allowHyphens: false
+    allowUnderscores: true
+    mustBeLowercase: true
@@ -28,7 +28,7 @@ jobs:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
      
      - name: Sync Issue to PR
        if: github.event_name == 'pull_request' && github.event.pull_request.base.ref == 'main'
@@ -27,7 +27,7 @@ jobs:
    steps:

      - name: Invite user to join our group
-        uses: peter-evans/create-or-update-comment@v3
+        uses: peter-evans/create-or-update-comment@v4
        with:
          token: ${{ secrets.BOT_GITHUB_TOKEN }}
          issue-number: ${{ github.event.issue.number }}
@@ -23,8 +23,9 @@ jobs:
    runs-on: ubuntu-latest
    steps:
      - name: Comment cherry-pick command
-        uses: actions/github-script@v6
+        uses: actions/github-script@v7
        with:
+          github-token: ${{ secrets.BOT_GITHUB_TOKEN }}
          script: |
            const pr = context.payload.pull_request;
            if (!pr.merged) {
@@ -63,5 +64,4 @@ jobs:
              repo: context.repo.repo,
              issue_number: pr.number,
              body: cherryPickCmd
-            });
-          github-token: ${{ secrets.BOT_GITHUB_TOKEN }}
+            });
@@ -12,23 +12,57 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.

-name: Github Rebot for Cherry Pick On Comment
+name: Github Robot for Cherry Pick On Comment
+
 on:
  issue_comment:
    types: [created]
+
 jobs:
  cherry-pick:
    name: Cherry Pick
-    # && github.event.comment.user.login=='kubbot'
    if: github.event.issue.pull_request != '' && contains(github.event.comment.body, '/cherry-pick')
    runs-on: ubuntu-latest
+
    steps:
      - name: Checkout the latest code
        uses: actions/checkout@v4
        with:
          token: ${{ secrets.BOT_GITHUB_TOKEN }}
-          fetch-depth: 0 # otherwise, you will fail to push refs to dest repo
+          fetch-depth: 0 # To ensure all history is available for cherry-picking
+
      - name: Automatic Cherry Pick
        uses: vendoo/gha-cherry-pick@v1
+        with:
+          # Assuming the cherry-pick commit SHA is passed in the comment like '/cherry-pick sha'
+          commit-sha: ${{ github.event.comment.body }}
        env:
-          GITHUB_TOKEN: ${{ secrets.BOT_GITHUB_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.BOT_GITHUB_TOKEN }}
+
+      - name: Create a new branch for PR
+        run: |
+          PR_BRANCH="cherry-pick-${GITHUB_SHA}-to-${{ github.base_ref }}"
+          git checkout -b $PR_BRANCH
+          git push origin $PR_BRANCH
+        env:
+          GITHUB_TOKEN: ${{ secrets.BOT_GITHUB_TOKEN }}
+
+      - name: Create Pull Request
+        uses: actions/github-script@v5
+        with:
+          script: |
+            const prTitle = "Cherry-pick to ${{ github.base_ref }}"
+            const prBody = "Automated cherry-pick of ${{ github.event.comment.body }}\n\n/cc @kubbot"
+            const base = "${{ github.base_ref }}"
+            const head = "cherry-pick-${{ github.sha }}-to-${{ github.base_ref }}"
+            const createPr = await github.rest.pulls.create({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              title: prTitle,
+              body: prBody,
+              head: head,
+              base: base,
+              maintainer_can_modify: true, // Allows maintainers to edit the PR
+            })
+        env:
+          GITHUB_TOKEN: ${{ secrets.BOT_GITHUB_TOKEN }}
@@ -43,7 +43,7 @@ jobs:
 # docker.io/openim/openim-server:latest
      - name: Extract metadata (tags, labels) for Docker
        id: meta
-        uses: docker/metadata-action@v5.0.0
+        uses: docker/metadata-action@v5.5.1
        with:
          images: openim/openim-server
          # generate Docker tags based on the following events/attributes
@@ -86,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.0.0
+        uses: docker/metadata-action@v5.5.1
        with:
          images: registry.cn-hangzhou.aliyuncs.com/openimsdk/openim-server
          # generate Docker tags based on the following events/attributes
@@ -130,7 +130,7 @@ jobs:
 # ghcr.io/openimsdk/openim-server:latest
      - name: Extract metadata (tags, labels) for Docker
        id: meta3
-        uses: docker/metadata-action@v5.0.0
+        uses: docker/metadata-action@v5.5.1
        with:
          images: ghcr.io/openimsdk/openim-server
          # generate Docker tags based on the following events/attributes
@@ -56,4 +56,4 @@ jobs:
        continue-on-error: true

      - name: Upload Coverage to Codecov
-        uses: codecov/codecov-action@v3
+        uses: codecov/codecov-action@v4
@@ -0,0 +1,27 @@
+# Copyright © 2024 OpenIM. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+name: Language Check Workflow Test
+
+on: [pull_request]
+
+jobs:
+  comment-language-detector:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v4
+
+      - name: Code Language Detector
+        uses: kubecub/comment-lang-detector@v1.0.0
@@ -51,7 +51,7 @@ jobs:

      # Initializes the CodeQL tools for scanning.
      - name: Initialize CodeQL
-        uses: github/codeql-action/init@v2
+        uses: github/codeql-action/init@v3
        # Override language selection by uncommenting this and choosing your languages
        with:
          languages: go
@@ -59,7 +59,7 @@ jobs:
      # Autobuild attempts to build any compiled languages (C/C++, C#, Go, or Java).
      # If this step fails, then you should remove it and run the build manually (see below).
      - name: Autobuild
-        uses: github/codeql-action/autobuild@v2
+        uses: github/codeql-action/autobuild@v3

      # ℹ️ Command-line programs to run using the OS shell.
      # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
@@ -73,4 +73,4 @@ jobs:
    #       make release

      - name: Perform CodeQL Analysis
-        uses: github/codeql-action/analyze@v2
+        uses: github/codeql-action/analyze@v3
@@ -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.6.0
+      uses: ad-m/github-push-action@v0.8.0
      with:
        github_token: ${{ secrets.BOT_GITHUB_TOKEN }}
        branch: main
@@ -15,4 +15,4 @@ jobs:
      - name: 'Checkout Repository'
        uses: actions/checkout@v4
      - name: 'Dependency Review'
-        uses: actions/dependency-review-action@v3
+        uses: actions/dependency-review-action@v4
@@ -40,7 +40,7 @@ jobs:
          install: true

      - name: Cache Docker layers
-        uses: actions/cache@v3
+        uses: actions/cache@v4
        with:
          path: /tmp/.buildx-cache
          key: ${{ runner.os }}-buildx-${{ github.sha }}
@@ -100,7 +100,7 @@ jobs:

      - name: Extract metadata (tags, labels) for Docker openim-api
        id: meta1
-        uses: docker/metadata-action@v5.0.0
+        uses: docker/metadata-action@v5.5.1
        with:
          images: |
            ghcr.io/openimsdk/openim-api
@@ -131,7 +131,7 @@ jobs:

      - name: Extract metadata (tags, labels) for Docker openim-cmdutils
        id: meta2
-        uses: docker/metadata-action@v5.0.0
+        uses: docker/metadata-action@v5.5.1
        with:
          images: |
            ghcr.io/openimsdk/openim-cmdutils
@@ -162,7 +162,7 @@ jobs:

      - name: Extract metadata (tags, labels) for Docker openim-crontask
        id: meta3
-        uses: docker/metadata-action@v5.0.0
+        uses: docker/metadata-action@v5.5.1
        with:
          images: |
            ghcr.io/openimsdk/openim-crontask
@@ -193,7 +193,7 @@ jobs:

      - name: Extract metadata (tags, labels) for Docker openim-msggateway
        id: meta4
-        uses: docker/metadata-action@v5.0.0
+        uses: docker/metadata-action@v5.5.1
        with:
          images: |
            ghcr.io/openimsdk/openim-msggateway
@@ -224,7 +224,7 @@ jobs:

      - name: Extract metadata (tags, labels) for Docker openim-msgtransfer
        id: meta5
-        uses: docker/metadata-action@v5.0.0
+        uses: docker/metadata-action@v5.5.1
        with:
          images: |
            ghcr.io/openimsdk/openim-msgtransfer
@@ -255,7 +255,7 @@ jobs:
          
      - name: Extract metadata (tags, labels) for Docker openim-push
        id: meta6
-        uses: docker/metadata-action@v5.0.0
+        uses: docker/metadata-action@v5.5.1
        with:
          images: |
            ghcr.io/openimsdk/openim-push
@@ -286,7 +286,7 @@ jobs:

      - name: Extract metadata (tags, labels) for Docker openim-rpc-auth
        id: meta7
-        uses: docker/metadata-action@v5.0.0
+        uses: docker/metadata-action@v5.5.1
        with:
          images: |
            ghcr.io/openimsdk/openim-rpc-auth
@@ -317,7 +317,7 @@ jobs:

      - name: Extract metadata (tags, labels) for Docker openim-rpc-conversation
        id: meta8
-        uses: docker/metadata-action@v5.0.0
+        uses: docker/metadata-action@v5.5.1
        with:
          images: |
            ghcr.io/openimsdk/openim-rpc-conversation
@@ -348,7 +348,7 @@ jobs:

      - name: Extract metadata (tags, labels) for Docker openim-rpc-friend
        id: meta9
-        uses: docker/metadata-action@v5.0.0
+        uses: docker/metadata-action@v5.5.1
        with:
          images: |
            ghcr.io/openimsdk/openim-rpc-friend
@@ -379,7 +379,7 @@ jobs:

      - name: Extract metadata (tags, labels) for Docker openim-rpc-group
        id: meta10
-        uses: docker/metadata-action@v5.0.0
+        uses: docker/metadata-action@v5.5.1
        with:
          images: |
            ghcr.io/openimsdk/openim-rpc-group
@@ -410,7 +410,7 @@ jobs:

      - name: Extract metadata (tags, labels) for Docker openim-rpc-msg
        id: meta11
-        uses: docker/metadata-action@v5.0.0
+        uses: docker/metadata-action@v5.5.1
        with:
          images: |
            ghcr.io/openimsdk/openim-rpc-msg
@@ -441,7 +441,7 @@ jobs:

      - name: Extract metadata (tags, labels) for Docker openim-rpc-third
        id: meta12
-        uses: docker/metadata-action@v5.0.0
+        uses: docker/metadata-action@v5.5.1
        with:
          images: |
            ghcr.io/openimsdk/openim-rpc-third
@@ -472,7 +472,7 @@ jobs:

      - name: Extract metadata (tags, labels) for Docker openim-rpc-user
        id: meta13
-        uses: docker/metadata-action@v5.0.0
+        uses: docker/metadata-action@v5.5.1
        with:
          images: |
            ghcr.io/openimsdk/openim-rpc-user
@@ -12,7 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.

-name: OpenIM Linux System E2E Test
+name: OpenIM E2E And API Test

 on:
  workflow_dispatch:
@@ -34,7 +34,7 @@ jobs:
    steps:

      - name: Set up Go 1.21
-        uses: actions/setup-go@v4
+        uses: actions/setup-go@v5
        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@v4
+      uses: actions/setup-go@v5
      with:
        go-version: ${{ matrix.go_version }}
      id: go
@@ -82,7 +82,7 @@ jobs:
        sudo make tidy
        sudo make tools.verify.go-gitlint

-    - name: Build, Start
+    - name: Build, Start(make build && make start)
      run: |
        sudo ./scripts/install/install.sh -i

@@ -90,7 +90,7 @@ jobs:
      run: |
        sudo ./scripts/install/install.sh -s

-    - name: Exec OpenIM API test
+    - name: Exec OpenIM API test (make test-api)
      run: |
        mkdir -p ./tmp
        touch ./tmp/test.md
@@ -102,7 +102,9 @@ jobs:
        echo "</code></pre>" >> ./tmp/test.md
        echo "</details>" >> ./tmp/test.md

-    - name: Exec OpenIM E2E Test
+        sudo make test-api
+
+    - name: Exec OpenIM E2E Test (make test-e2e)
      run: |
        echo "" >> ./tmp/test.md
        echo "## OpenIM E2E Test" >> ./tmp/test.md
@@ -112,6 +114,8 @@ jobs:
        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:
@@ -141,4 +145,4 @@ jobs:
        PUBLISH_BRANCH: gh-pages
      env:
        GITHUB_TOKEN: ${{ secrets.BOT_GITHUB_TOKEN }}
-      continue-on-error: true
+      continue-on-error: true
@@ -24,12 +24,14 @@ jobs:
      runs-on: ubuntu-latest
      steps:
        - uses: actions/checkout@v4
-        - uses: actions/setup-go@v4
+        - uses: actions/setup-go@v5
          with:
            go-version: '1.21'
            cache: false
+        - name: OpenIM Scripts Verification(make verify)
+          run: sudo make verify
        - name: golangci-lint
-          uses: golangci/golangci-lint-action@v3.7.0
+          uses: golangci/golangci-lint-action@v4.0.0
          with:
            # Require: version of golangci-lint to use in form of v1.2 or v1.2.3 or `latest` to use the latest version
            version: v1.54
@@ -47,4 +49,4 @@ jobs:
            only-new-issues: true

            # Optional:The mode to install golangci-lint. It can be 'binary' or 'goinstall'.
-            # install-mode: "goinstall"
+            # install-mode: "goinstall"
@@ -26,7 +26,7 @@ jobs:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
-      - uses: actions/first-interaction@v1.2.0
+      - uses: actions/first-interaction@v1.3.0
        with:
          repo-token: ${{ secrets.BOT_GITHUB_TOKEN }}
          pr-message: |
@@ -26,7 +26,7 @@ jobs:
      issues: write
    steps:
      - name: Add comment
-        uses: peter-evans/create-or-update-comment@v3
+        uses: peter-evans/create-or-update-comment@v4
        with:
          issue-number: ${{ github.event.issue.number }}
          token: ${{ secrets.BOT_GITHUB_TOKEN }}
@@ -27,7 +27,7 @@ jobs:

      - name: Link Checker
        id: lychee
-        uses: lycheeverse/lychee-action@v1.8.0
+        uses: lycheeverse/lychee-action@v1.9.3
        with:
            # For parameter description, see https://github.com/lycheeverse/lychee#commandline-parameters
            # Actions Link address -> https://github.com/lycheeverse/lychee-action
@@ -45,7 +45,7 @@ jobs:

      - name: Create Issue From File
        if: env.lychee_exit_code != 0
-        uses: peter-evans/create-issue-from-file@v4
+        uses: peter-evans/create-issue-from-file@v5
        with:
          title: Bug reports for links in OpenIM docs
          content-filepath: ./lychee/out.md
@@ -30,7 +30,7 @@ jobs:
  action:
    runs-on: ubuntu-latest
    steps:
-      - uses: dessant/lock-threads@v4
+      - uses: dessant/lock-threads@v5
        with:
          github-token: ${{ secrets.BOT_GITHUB_TOKEN }}
          issue-inactive-days: '365'
@@ -39,8 +39,9 @@ jobs:
      statuses: none

    steps:
-      - uses: actions/github-script@v6 # v6
+      - uses: actions/github-script@v7 # v6
        with:
+          github-token: ${{ secrets.BOT_GITHUB_TOKEN }}
          script: |
            if (!context.payload.pull_request.merged) {
              console.log('PR was not merged, skipping.');
@@ -56,9 +57,10 @@ jobs:
              owner: context.repo.owner,
              repo: context.repo.repo,
              state: 'open',
-              sort: 'due_on',
-              direction: 'asc'
+              sort: 'title',
+              direction: 'desc'
            })
+
            if (milestones.data.length === 0) {
              console.log('There are no milestones, skipping.');
              return;
@@ -28,10 +28,10 @@ jobs:
    permissions: write-all
    steps:
      - name: Setup Node.js Environment
-        uses: actions/setup-node@v2
+        uses: actions/setup-node@v4
        with:
          node-version: '16'
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
        with:
          fetch-depth: 0
      - uses: di-sukharev/opencommit@github-action-v1.0.4
@@ -57,9 +57,9 @@ jobs:
    steps:
    - name: Setup
      uses: actions/checkout@v4
-      
+
    - name: Set up Go ${{ matrix.go_version }}
-      uses: actions/setup-go@v4
+      uses: actions/setup-go@v5
      with:
        go-version: ${{ matrix.go_version }}
      id: go
@@ -70,8 +70,11 @@ jobs:
        version: '3.x' # If available, use the latest major version that's compatible
        repo-token: ${{ secrets.GITHUB_TOKEN }}

-    - name: OpenIM Scripts Verification(make verify)
-      run: sudo make verify
+    - name: Code Typecheck Detector
+      uses: kubecub/typecheck@main
+
+    - name: Conformity Checker for Project
+      uses: kubecub/standardizer@main

    - name: Module Operations
      run: |
@@ -194,7 +197,7 @@ jobs:
      uses: actions/checkout@v4

    - name: Set up Go ${{ matrix.go_version }}
-      uses: actions/setup-go@v4
+      uses: actions/setup-go@v5
      with:
        go-version: ${{ matrix.go_version }}
      id: go
@@ -279,7 +282,7 @@ jobs:
    - name: Checkout code
      uses: actions/checkout@v4
    - name: Set up Go ${{ matrix.go_version }}
-      uses: actions/setup-go@v4
+      uses: actions/setup-go@v5
      with:
        go-version: ${{ matrix.go_version }}
      id: go
@@ -24,13 +24,16 @@ on:
  pull_request:
    types: 
      - assigned
+    branches-ignore:
+      - 'asf-auto-updates'
+      - 'ignore'

 jobs:
  move-assigned-card:
    runs-on: ubuntu-latest
    steps:
-      - uses: alex-page/github-project-automation-plus@v0.8.3
+      - uses: alex-page/github-project-automation-plus@v0.9.0
        with:
          project: openim-powerful
          column: In Progress
-          repo-token: ${{ secrets.BOT_GITHUB_TOKEN }}
+          repo-token: ${{ secrets.BOT_GITHUB_TOKEN }}
@@ -14,12 +14,6 @@

 name: Github Pull Request
 on:
-  push:
-    branches: [main]
-    paths-ignore:
-      - 'README.md'
-      - 'CONTRIBUTING.md'
-      - 'docs/**'
  workflow_dispatch:
  schedule:
    - cron: '0 2 * * *'
@@ -37,24 +31,18 @@ jobs:
        with:
          fetch-depth: 0

-      - name: Get League branch Patch
-        run: |
-          git config user.name 'openimbot'
-          git config user.email 'openimsdk@qq.com'
-          BRANCH_NAME="auto-pr-$(date +'%Y%m%d%H%M%S')"
-          git checkout -b $BRANCH_NAME
-
      - uses: actions/setup-node@v4
      - name: Setup Go
-        uses: actions/setup-go@v4
+        uses: actions/setup-go@v5
      - name: Run go modules tidy
        run: |
+          sudo apt-get install jq
          sudo make tidy
          sudo make tools.verify.go-gitlint
          echo "Run go modules tidy successfully" 
        continue-on-error: true

-      - name: Run go format
+      - name: Run go format and lint
        run: |
          sudo make format
          echo "Run go format successfully" 
@@ -68,8 +56,34 @@ jobs:

      - name: Generate all necessary files, such as error code files
        run: |
-          make generate
-          echo "Generate all necessary files successfully" 
+          make gen.docgo.doc
+          make gen
+          echo "Generate all necessary files successfully"
+        continue-on-error: true
+
+      - name: make init
+        run: |
+          export OPENIM_IP=127.0.0.1
+          export LOG_STORAGE_LOCATION="../logs/"
+          ./scripts/init-config.sh --examples --force
+          echo "Generate all necessary files successfully"
+        continue-on-error: true
+
+      - name: Generate Versions Including Pre-release Identifiers
+        run: |
+          latest_tag=$(git describe --tags `git rev-list --tags --max-count=1`)
+          echo $latest_tag > pkg/common/config/version
+        continue-on-error: true
+
+      - name: Gen CHANGELOG file
+        run: |
+          current_tag=$(git describe --tags --abbrev=0)
+          version=$(echo "$current_tag" | sed -E 's/^v?([0-9]+)\.([0-9]+)\..*$/\1.\2/')
+          echo "OpenIM Version: $version"
+          make tools.install.git-chglog
+          cd CHANGELOG
+          git-chglog --tag-filter-pattern "v${version}.*" -o CHANGELOG-${version}.md
+          cd ..
        continue-on-error: true

      - name: Run unit test and get test coverage
@@ -78,38 +92,39 @@ jobs:
          echo "Run unit test and get test coverage successfully" 
        continue-on-error: true

-      - name: Perform CodeQL Analysis
-        uses: github/codeql-action/analyze@v2
-
      - name: OpenIM verify copyright
        run: |
-          sudo make verify-copyright
          sudo make add-copyright
          echo "OpenIM verify successfully" 
        continue-on-error: true

      - name: Create Pull Request
-        uses: peter-evans/create-pull-request@v5
+        uses: peter-evans/create-pull-request@v6
        with:
          token: ${{ secrets.BOT_GITHUB_TOKEN }}
          commit-message: "cicd: bump League Patch"
-          author: kubbot <kubbot@3293172751ysy@gmail.com>
-          signoff: false
-          draft: false
-          branch: ''
+          author: kubbot <3293172751ysy@gmail.com>
+          committer: kubbot <3293172751ysy@gmail.com>
+        #   signoff: false
+        #   draft: false
+          branch: "asf-auto-updates"
          assignees: cubxxw
          reviewers: cubxxw
-          delete-branch: true
-          title: "Bump League Patch auto PR: $(date +'%Y%m%d')"
+          title: "[Auto PR 🤖] Bump League Patch auto PR"
          body: |
+            I am a PR generated by robot automation.
+
            Review criteria:

            - [ ] Disenchanter can connect and issue actions
+
+            Github Actions Status:
+
+            [![Github Pull Request](https://github.com/openimsdk/open-im-server/actions/workflows/pull-request.yml/badge.svg)](https://github.com/openimsdk/open-im-server/actions/workflows/pull-request.yml)
            
-            This is an automated PR. @ $(date +'%Y%m%d')
+            This is an automated PR. 
            <sub>[workflow](https://github.com/openimsdk/open-im-server/blob/main/.github/workflows/pull-request.yml).</sub>
-          base: main
          labels: |
            kind/documentation
            enhancement
-            report
+            report
@@ -46,7 +46,7 @@ jobs:
      #    echo "GHE_HOST=${GITHUB_SERVER_URL##https:\/\/}" >> $GITHUB_ENV

      # Drafts your next Release notes as Pull Requests are merged into "master"
-      - uses: release-drafter/release-drafter@v5
+      - uses: release-drafter/release-drafter@v6
        # (Optional) specify config name to use, relative to .github/. Default: release-drafter.yml
        # with:
        #   config-name: my-config.yml
@@ -33,7 +33,7 @@ jobs:
        with:
          fetch-depth: 0
      - run: git fetch --force --tags
-      - uses: actions/setup-go@v4
+      - uses: actions/setup-go@v5
        with:
          go-version: stable
      # More assembly might be required: Docker logins, GPG, etc. It all depends
@@ -71,7 +71,7 @@ jobs:
          version: 3.x
          repo-token: ${{ secrets.GITHUB_TOKEN }}
      - uses: docker/setup-qemu-action@326560df218a7ea9cf6ab49bbc88b8b306bb437e # v2
-      - uses: actions/cache@88522ab9f39a2ea568f7027eddc7d8d8bc9d59c8 # v3
+      - uses: actions/cache@a2ed59d39b352305bdd2f628719a53b2cc4f9613 # v3
        with:
          path: |
            ./_output/dist/*.deb
@@ -32,7 +32,7 @@ jobs:
      pull-requests: write

    steps:
-    - uses: actions/stale@v8
+    - uses: actions/stale@v9
      with:
        repo-token: ${{ secrets.BOT_GITHUB_TOKEN }}
        days-before-stale: 60
@@ -3,7 +3,7 @@
 # you may not use this file except in compliance with the License.

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

 # https://github.com/BetaHuhn/repo-file-sync-action
-name: Synchronize kubecub public code to other repositories
+name: Synchronize OpenIM Main Branch Public Code To Other Repositories
 on:
    push:
        branches:
@@ -36,4 +36,5 @@ jobs:
            file-sync
            automerge
          ASSIGNEES: |
-            kubbot
+            kubbot
+        continue-on-error: true
@@ -39,15 +39,19 @@ run:
  # from this option's value (see skip-dirs-use-default).
  # "/" will be replaced by current OS file path separator to properly work
  # on Windows.
-  skip-dirs:
-    - util
-    - .*~
-    - api/swagger/docs
-    - server/docs
+  # skip-dirs:
+  #   - components
+  #   - docs
+  #   - util
+  #   - .*~
+  #   - api/swagger/docs
+  #   - server/docs
+  #   - components/mnt/config/certs
+  #   - logs

  # default is true. Enables skipping of directories:
  #   vendor$, third_party$, testdata$, examples$, Godeps$, builtin$
-  skip-dirs-use-default: true
+  # skip-dirs-use-default: true

  # which files to skip: they will be analyzed, but issues from them
  # won't be reported. Default value is empty list, but there is
@@ -55,9 +59,15 @@ run:
  # autogenerated files. If it's not please let us know.
  # "/" will be replaced by current OS file path separator to properly work
  # on Windows.
-  skip-files:
-    - ".*\\.my\\.go$"
-    - _test.go
+  # skip-files:
+  #   - ".*\\.my\\.go$"
+  #   - _test.go
+  #   - ".*_test.go"
+  #   - "mocks/"
+  #   - ".github/"
+  #   - "logs/"
+  #   - "_output/"
+  #   - "components/"

  # by default isn't set. If set we pass it to "go list -mod={option}". From "go help modules":
  # If invoked with -mod=readonly, the go command is disallowed from the implicit
@@ -77,7 +87,7 @@ run:
 # output configuration options
 output:
  # colored-line-number|line-number|json|tab|checkstyle|code-climate, default is "colored-line-number"
-  format: colored-line-number
+  # format: colored-line-number

  # print lines of code with issue, default is true
  print-issued-lines: true
@@ -108,9 +118,7 @@ linters-settings:
    right-to-left-isolate: true
    first-strong-isolate: true
    pop-directional-isolate: true
-  dogsled:
-    # checks assignments with too many blank identifiers; default is 2
-    max-blank-identifiers: 2
+
  dupl:
    # tokens count to trigger issue, 150 by default
    threshold: 200
@@ -131,8 +139,8 @@ linters-settings:

    # path to a file containing a list of functions to exclude from checking
    # see https://github.com/kisielk/errcheck#excluding-functions for details
-    #exclude: errcheck.txt
-    
+    # exclude: errcheck.txt
+
  errorlint:
    # Check whether fmt.Errorf uses the %w verb for formatting errors. See the readme for caveats
    errorf: true
@@ -142,6 +150,11 @@ linters-settings:
    comparison: true

  exhaustive:
+    # Program elements to check for exhaustiveness.
+    # Default: [ switch ]
+    check:
+      - switch
+      - map
    # check switch statements in generated files also
    check-generated: false
    # indicates that switch statements are to be considered exhaustive if a
@@ -153,33 +166,34 @@ linters-settings:
    ignore-enum-members: ""
    # consider enums only in package scopes, not in inner scopes
    package-scope-only: false
-  exhaustivestruct:
-    struct-patterns:
-      - '*.Test'
-      - '*.Test2'
-      - '*.Embedded'
-      - '*.External'

-  # forbidigo:
+
+  forbidigo:
  #   # Forbid the following identifiers (identifiers are written using regexp):
-  #   forbid:
-  #     - ^print.*$
-  #     - 'fmt\.Print.*'
-  #     - fmt.Println.* # too much log noise
+    forbid:
+      # - ^print.*$
+      - 'fmt\.Print.*'
+      - fmt.Println.* # too much log noise
+      - ^unsafe\..*$
+      - ^init$
+      - ^os.Exit$
+      - ^fmt.Print.*$
+      - errors.New.*$
+      - ^fmt.Println.*$
+      - ^panic$
+      - painc
  #     - ginkgo\\.F.* # these are used just for local development
  #   # Exclude godoc examples from forbidigo checks.  Default is true.
  #   exclude_godoc_examples: false
+
  funlen:
-    lines: 150
+    lines: 220
    statements: 80
-  gci:
-    # put imports beginning with prefix after 3rd-party packages;
-    # only support one prefix
-    # if not set, use goimports.local-prefixes
-    prefix: github.com/openimsdk/open-im-server
+
  gocognit:
    # minimal code complexity to report, 30 by default (but we recommend 10-20)
    min-complexity: 30
+
  goconst:
    # minimal length of string constant, 3 by default
    min-len: 3
@@ -205,9 +219,6 @@ linters-settings:
    # By default list of stable checks is used.
    enabled-checks:
      #- rangeValCopy
-      - nestingreduce
-      - truncatecmp
-      - unnamedresult
      - ruleguard

    # Which checks should be disabled; can't be combined with 'enabled-checks'; default is empty
@@ -236,9 +247,6 @@ linters-settings:
      hugeParam:
        # size in bytes that makes the warning trigger (default 80)
        sizeThreshold: 80
-      nestingReduce:
-        # min number of statements inside a branch to trigger a warning (default 5)
-        bodyWidth: 5
      rangeExprCopy:
        # size in bytes that makes the warning trigger (default 512)
        sizeThreshold: 512
@@ -252,15 +260,10 @@ linters-settings:
      ruleguard:
        # path to a gorules file for the ruleguard checker
        rules: ''
-      truncateCmp:
-        # whether to skip int/uint/uintptr types (default true)
-        skipArchDependent: true
      underef:
        # whether to skip (*x).method() calls where x is a pointer receiver (default true)
        skipRecvDeref: true
-      unnamedResult:
-        # whether to check exported functions
-        checkExported: true
+
  gocyclo:
    # minimal code complexity to report, 30 by default (but we recommend 10-20)
    min-complexity: 30
@@ -277,9 +280,12 @@ linters-settings:
    # list of regexps for excluding particular comment lines from check
    exclude:
      # example: exclude comments which contain numbers
-      # - '[0-9]+'
+      - '[0-9]+'
+      - 'func\s+\w+'
+      - 'FIXME:'
+      - '.*func.*'
    # check that each sentence starts with a capital letter
-    capital: false
+    capital: true
  godox:
    # report any comments starting with keywords, this is useful for TODO or FIXME comments that
    # might be left in the code accidentally and should be resolved before merging
@@ -302,15 +308,15 @@ linters-settings:
    # by default
    extra-rules: false

-  goheader:
-    values:
-      const:
+  # goheader:
+    # values:
+      # const:
        # define here const type values in format k:v, for example:
        # COMPANY: MY COMPANY
-      regexp:
+      # regexp:
        # define here regexp type values, for example
        # AUTHOR: .*@mycompany\.com
-    template: # |-
+    # template: # |-
      # put here copyright header template for source code files, for example:
      # Note: {{ YEAR }} is a builtin value that returns the year relative to the current machine time.
      #
@@ -328,21 +334,45 @@ linters-settings:
      # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
      # See the License for the specific language governing permissions and
      # limitations under the License.
-    template-path:
+    # template-path:
      # also as alternative of directive 'template' you may put the path to file with the template source
+
  goimports:
    # put imports beginning with prefix after 3rd-party packages;
    # it's a comma-separated list of prefixes
    local-prefixes: github.com/openimsdk/open-im-server

  gomnd:
-    settings:
-      mnd:
-        # the list of enabled checks, see https://github.com/tommy-muehle/go-mnd/#checks for description.
-        checks: argument,case,condition,operation,return,assign
-        # ignored-numbers: 1000
-        # ignored-files: magic_.*.go
-        # ignored-functions: math.*
+    # List of enabled checks, see https://github.com/tommy-muehle/go-mnd/#checks for description.
+    # Default: ["argument", "case", "condition", "operation", "return", "assign"]
+    checks:
+      - argument
+      - case
+      - condition
+      - operation
+      - return
+      - assign
+    # List of numbers to exclude from analysis.
+    # The numbers should be written as string.
+    # Values always ignored: "1", "1.0", "0" and "0.0"
+    # Default: []
+    ignored-numbers:
+      - '0666'
+      - '0755'
+      - '42'
+    # List of file patterns to exclude from analysis.
+    # Values always ignored: `.+_test.go`
+    # Default: []
+    ignored-files:
+      - 'magic1_.+\.go$'
+    # List of function patterns to exclude from analysis.
+    # Following functions are always ignored: `time.Date`,
+    # `strconv.FormatInt`, `strconv.FormatUint`, `strconv.FormatFloat`,
+    # `strconv.ParseInt`, `strconv.ParseUint`, `strconv.ParseFloat`.
+    # Default: []
+    ignored-functions:
+      - '^math\.'
+      - '^webhook\.StatusText$'
  gomoddirectives:
    # Allow local `replace` directives. Default is false.
    replace-local: true
@@ -354,6 +384,7 @@ linters-settings:
    retract-allow-no-explanation: false
    # Forbid the use of the `exclude` directives. Default is false.
    exclude-forbidden: false
+
  gomodguard:
    allowed:
      modules:    
@@ -417,9 +448,6 @@ linters-settings:
    checks: [ "all" ]

  govet:
-    # report about shadowed variables
-    check-shadowing: true
-
    # settings per analyzer
    settings:
      printf: # analyzer name, run `go tool vet help` to see all analyzers
@@ -436,15 +464,25 @@ linters-settings:
    disable:
      - shadow
    disable-all: false
-  # depguard:
-  #   list-type: blacklist
-  #   include-go-root: false
-  #   packages:
-  #     - github.com/Sirupsen/logrus
-  #   packages-with-error-message:
-  #     # specify an error message to output when a blacklisted package is used
-  #     - github.com/Sirupsen/logrus: "logging is allowed only by logutils.Log"

+  depguard:
+    rules:
+      prevent_unmaintained_packages:
+        list-mode: lax # allow unless explicitely denied
+        files:
+          - $all
+          - "!$test"
+        allow:
+          - $gostd
+        deny:
+          - pkg: io/ioutil
+            desc: "replaced by io and os packages since Go 1.16: https://tip.golang.org/doc/go1.16#ioutil"
+          - pkg: github.com/OpenIMSDK
+            desc: "The OpenIM organization has been replaced with lowercase, please do not use uppercase organization name, you will use openimsdk"
+          - pkg: log
+            desc: "We have a wrapped log package at openim, we recommend you to use our wrapped log package, https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/logging.md"
+          - pkg: errors
+            desc: "We have a wrapped errors package at openim, we recommend you to use our wrapped errors package, https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/error-code.md"

  importas:
    # if set to `true`, force to use alias.
@@ -454,6 +492,8 @@ linters-settings:
      # using `servingv1` alias for `knative.dev/serving/pkg/apis/serving/v1` package
      - pkg: knative.dev/serving/pkg/apis/serving/v1
        alias: servingv1
+      - pkg: gopkg.in/yaml.v2
+        alias: yaml
      # using `autoscalingv1alpha1` alias for `knative.dev/serving/pkg/apis/autoscaling/v1alpha1` package
      - pkg: knative.dev/serving/pkg/apis/autoscaling/v1alpha1
        alias: autoscalingv1alpha1
@@ -462,8 +502,6 @@ linters-settings:
      # see https://github.com/julz/importas#use-regular-expression for details
      - pkg: knative.dev/serving/pkg/apis/(\w+)/(v[\w\d]+)
        alias: $1$2
-    # using `jwt` alias for `github.com/appleboy/gin-jwt/v2` package
-    jwt: github.com/appleboy/gin-jwt/v2

  ireturn:
    # ireturn allows using `allow` and `reject` settings at the same time.
@@ -489,14 +527,11 @@ linters-settings:
    - github.com\/user\/package\/v4\.Type

  lll:
-    # max line length, lines longer will be reported. Default is 120.
+    # max line length, lines longer will be reported. Default is 250.
    # '\t' is counted as 1 character by default, and can be changed with the tab-width option
-    line-length: 240
+    line-length: 250
    # tab width in spaces. Default to 1.
    tab-width: 4
-  maligned:
-    # print struct with more effective memory layout or not, false by default
-    suggest-new: true
  misspell:
    # Correct spellings using locale preferences for US or UK.
    # Default is to use a neutral variety of English.
@@ -529,8 +564,6 @@ linters-settings:
  nolintlint:
    # Disable to ensure that all nolint directives actually have an effect. Default is true.
    allow-unused: false
-    # Disable to ensure that nolint directives don't have a leading space. Default is true.
-    allow-leading-space: true
    # Exclude following linters from requiring an explanation.  Default is [].
    allow-no-explanation: [ ]
    # Enable to require an explanation of nonzero length after each nolint directive. Default is false.
@@ -554,14 +587,13 @@ linters-settings:
    strict: false
    # Please refer to https://github.com/yeya24/promlinter#usage for detailed usage.
    disabled-linters:
-    #  - "Help"
-    #  - "MetricUnits"
-    #  - "Counter"
-    #  - "HistogramSummaryReserved"
-    #  - "MetricTypeInName"
-    #  - "ReservedChars"
-    #  - "CamelCase"
-    #  - "lintUnitAbbreviations"
+     - "Help"
+     - "MetricUnits"
+     - "Counter"
+     - "HistogramSummaryReserved"
+     - "MetricTypeInName"
+     - "ReservedChars"
+     - "CamelCase"
    
  predeclared:
    # comma-separated list of predeclared identifiers to not report on
@@ -571,6 +603,7 @@ linters-settings:
  rowserrcheck:
    packages:
      - github.com/jmoiron/sqlx
+
  revive:
    # see https://github.com/mgechev/revive#available-rules for details.
    ignore-generated-header: true
@@ -578,15 +611,27 @@ linters-settings:
    rules:
      - name: indent-error-flow
        severity: warning
+      - name: exported
+        severity: warning
+      - name: var-naming
+        arguments: [ [ "OpenIM"] ]
+        # arguments: [ ["ID", "HTTP", "URL", "URI", "API", "APIKey", "Token", "TokenID", "TokenSecret", "TokenKey", "TokenSecret", "JWT", "JWTToken", "JWTTokenID", "JWTTokenSecret", "JWTTokenKey", "JWTTokenSecret", "OAuth", "OAuthToken", "RPC" ] ]
+      - name: atomic
+      - name: line-length-limit
+        severity: error
+        arguments: [200]
+      - name: unhandled-error
+        arguments : ["fmt.Printf", "myFunction"]
+
  staticcheck:
    # Select the Go version to target. The default is '1.13'.
-    go: "1.16"
+    go: "1.20"
    # https://staticcheck.io/docs/options#checks
    checks: [ "all" ]

  stylecheck:
    # Select the Go version to target. The default is '1.13'.
-    go: "1.16"
+    go: "1.20"

    # https://staticcheck.io/docs/options#checks
    checks: [ "all", "-ST1000", "-ST1003", "-ST1016", "-ST1020", "-ST1021", "-ST1022" ]
@@ -598,7 +643,6 @@ linters-settings:
    # https://staticcheck.io/docs/options#http_status_code_whitelist
    http-status-code-whitelist: [ "200", "400", "404", "500" ]

-
  tagliatelle:
    # check the struck tag name case
    case:
@@ -644,12 +688,11 @@ linters-settings:
    # if it's called for subdir of a project it can't find external interfaces. All text editor integrations
    # with golangci-lint call it on a directory with the changed file.
    check-exported: false
-  unused:
+  # unused:
    # treat code as a program (not a library) and report unused exported identifiers; default is false.
    # XXX: if you enable this setting, unused will report a lot of false-positives in text editors:
    # if it's called for subdir of a project it can't find funcs usages. All text editor integrations
    # with golangci-lint call it on a directory with the changed file.
-    check-exported: false
  whitespace:
    multi-if: false   # Enforces newlines (or comments) after every multi-line if statement
    multi-func: false # Enforces newlines (or comments) after every multi-line function signature
@@ -663,6 +706,7 @@ linters-settings:
      - errors.New(
      - errors.Unwrap(
      - .Wrap(
+      - .WrapMsg(
      - .Wrapf(
      - .WithMessage(
      - .WithMessagef(
@@ -670,6 +714,8 @@ linters-settings:
    ignorePackageGlobs:
        - encoding/*
        - github.com/pkg/*
+        - github.com/openimsdk/*
+        - github.com/OpenIMSDK/*

  wsl:
    # If true append is only allowed to be cuddled if appending value is
@@ -696,7 +742,6 @@ linters-settings:
    # Allow only slices initialized with a length of zero. Default is false.
    always: false

-
  # The custom section can be used to define linter plugins to be loaded at runtime. See README doc
  #  for more info.
  #custom:
@@ -715,17 +760,38 @@ linters:
  # enable-all: true
  disable-all: true
  enable:
-    - typecheck     # 基本的类型检查
-    - gofmt         # 格式检查
-    - govet         # Go 语言的标准检查工具
-    - gosimple      # 简化代码的建议
-    - misspell      # 拼写错误
-    - staticcheck   # 静态检查
-    - unused        # 未使用的代码检查
-    - goimports     # 检查导入是否正确排序和格式化
-    - godot         # 注释句点检查
-    - bodyclose     # 确保 HTTP response body 被关闭
-    - errcheck      # 检查是否遗漏了错误返回值
+    - typecheck     # Basic type checking
+    - gofmt         # Format check
+    - govet         # Go's standard linting tool
+    - gosimple      # Suggestions for simplifying code
+    - errcheck
+    - decorder
+    - ineffassign
+    - forbidigo
+    - revive
+    - reassign
+    - tparallel
+    - unconvert
+    - fieldalignment
+    - dupl
+    - dupword
+    - errname
+    - gci
+    - exhaustive
+    - gocritic
+    - goprintffuncname
+    - gomnd
+    - goconst
+    - gosec
+    - misspell      # Spelling mistakes
+    - staticcheck   # Static analysis
+    - unused        # Checks for unused code
+    # - goimports     # Checks if imports are correctly sorted and formatted
+    - godot         # Checks for comment punctuation
+    - bodyclose     # Ensures HTTP response body is closed
+    - stylecheck    # Style checker for Go code
+    - unused        # Checks for unused code
+    - errcheck      # Checks for missed error returns
  fast: true

 issues:
@@ -736,6 +802,7 @@ issues:
  exclude:
    - tools/.*
    - test/.*
+    - components/*
    - third_party/.*

  # Excluding configuration per-path, per-linter, per-text and per-source
@@ -792,6 +859,11 @@ issues:
        - lll
      source: "^//go:generate "

+    - text: ".*[\u4e00-\u9fa5]+.*"
+      linters:
+        - golint
+      source: "^//.*$"
+
  # Independently from option `exclude` we use default exclude patterns,
  # it can be disabled by this option. To list all
  # excluded by default patterns execute `golangci-lint run --help`.
@@ -852,4 +924,4 @@ severity:
  rules:
    - linters:
      - dupl
-      severity: info
+      severity: info
@@ -0,0 +1,32 @@
+# Version logging for OpenIM
+
+<!-- BEGIN MUNGE: GENERATED_TOC -->
+
+<!-- END MUNGE: GENERATED_TOC -->
+
+<a name="unreleased"></a>
+## [Unreleased]
+
+
+<a name="v3.4.2"></a>
+## [v3.4.2] - 2023-12-14
+
+<a name="v3.4.0"></a>
+## [v3.4.0] - 2023-11-10
+
+<a name="v3.4.0-rc.1"></a>
+## [v3.4.0-rc.1] - 2023-11-09
+
+<a name="v3.4.0-rc.0"></a>
+## v3.4.0-rc.0 - 2023-11-09
+### Reverts
+- update etcd to v3.5.2 ([#206](https://github.com/openimsdk/open-im-server/issues/206))
+
+### Pull Requests
+- Merge branch 'tuoyun'
+
+
+[Unreleased]: https://github.com/openimsdk/open-im-server/compare/v3.4.2...HEAD
+[v3.4.2]: https://github.com/openimsdk/open-im-server/compare/v3.4.0...v3.4.2
+[v3.4.0]: https://github.com/openimsdk/open-im-server/compare/v3.4.0-rc.1...v3.4.0
+[v3.4.0-rc.1]: https://github.com/openimsdk/open-im-server/compare/v3.4.0-rc.0...v3.4.0-rc.1
@@ -0,0 +1,84 @@
+# Version logging for OpenIM
+
+<!-- BEGIN MUNGE: GENERATED_TOC -->
+
+<!-- END MUNGE: GENERATED_TOC -->
+
+<a name="unreleased"></a>
+## [Unreleased]
+
+
+<a name="v3.5.1-alpha.2"></a>
+## [v3.5.1-alpha.2] - 2024-01-26
+
+<a name="v3.5.1-rc.1"></a>
+## [v3.5.1-rc.1] - 2024-01-23
+
+<a name="v3.5.1-alpha.1"></a>
+## [v3.5.1-alpha.1] - 2024-01-09
+
+<a name="v3.5.0"></a>
+## [v3.5.0] - 2024-01-02
+
+<a name="v3.5.1"></a>
+## [v3.5.1] - 2024-01-02
+
+<a name="v3.5.1-bate.1"></a>
+## [v3.5.1-bate.1] - 2024-01-02
+
+<a name="v3.5.1-rc.0"></a>
+## [v3.5.1-rc.0] - 2023-12-30
+
+<a name="v3.5.0-rc.8"></a>
+## [v3.5.0-rc.8] - 2023-12-28
+
+<a name="v3.5.0-rc.7"></a>
+## [v3.5.0-rc.7] - 2023-12-18
+
+<a name="v3.5.0-rc.6"></a>
+## [v3.5.0-rc.6] - 2023-12-15
+
+<a name="v3.5.0-rc.5"></a>
+## [v3.5.0-rc.5] - 2023-12-15
+
+<a name="v3.5.0-rc.4"></a>
+## [v3.5.0-rc.4] - 2023-12-14
+
+<a name="v3.5.0-rc.3"></a>
+## [v3.5.0-rc.3] - 2023-12-14
+
+<a name="v3.5.0-rc.2"></a>
+## [v3.5.0-rc.2] - 2023-12-14
+
+<a name="v3.5.0-rc.1"></a>
+## [v3.5.0-rc.1] - 2023-12-14
+
+<a name="v3.5.0-rc.0"></a>
+## [v3.5.0-rc.0] - 2023-12-14
+
+<a name="v3.5.0-beta.1"></a>
+## v3.5.0-beta.1 - 2023-11-29
+### Reverts
+- update etcd to v3.5.2 ([#206](https://github.com/openimsdk/open-im-server/issues/206))
+
+### Pull Requests
+- Merge branch 'tuoyun'
+
+
+[Unreleased]: https://github.com/openimsdk/open-im-server/compare/v3.5.1-alpha.2...HEAD
+[v3.5.1-alpha.2]: https://github.com/openimsdk/open-im-server/compare/v3.5.1-rc.1...v3.5.1-alpha.2
+[v3.5.1-rc.1]: https://github.com/openimsdk/open-im-server/compare/v3.5.1-alpha.1...v3.5.1-rc.1
+[v3.5.1-alpha.1]: https://github.com/openimsdk/open-im-server/compare/v3.5.0...v3.5.1-alpha.1
+[v3.5.0]: https://github.com/openimsdk/open-im-server/compare/v3.5.1...v3.5.0
+[v3.5.1]: https://github.com/openimsdk/open-im-server/compare/v3.5.1-bate.1...v3.5.1
+[v3.5.1-bate.1]: https://github.com/openimsdk/open-im-server/compare/v3.5.1-rc.0...v3.5.1-bate.1
+[v3.5.1-rc.0]: https://github.com/openimsdk/open-im-server/compare/v3.5.0-rc.8...v3.5.1-rc.0
+[v3.5.0-rc.8]: https://github.com/openimsdk/open-im-server/compare/v3.5.0-rc.7...v3.5.0-rc.8
+[v3.5.0-rc.7]: https://github.com/openimsdk/open-im-server/compare/v3.5.0-rc.6...v3.5.0-rc.7
+[v3.5.0-rc.6]: https://github.com/openimsdk/open-im-server/compare/v3.5.0-rc.5...v3.5.0-rc.6
+[v3.5.0-rc.5]: https://github.com/openimsdk/open-im-server/compare/v3.5.0-rc.4...v3.5.0-rc.5
+[v3.5.0-rc.4]: https://github.com/openimsdk/open-im-server/compare/v3.5.0-rc.3...v3.5.0-rc.4
+[v3.5.0-rc.3]: https://github.com/openimsdk/open-im-server/compare/v3.5.0-rc.2...v3.5.0-rc.3
+[v3.5.0-rc.2]: https://github.com/openimsdk/open-im-server/compare/v3.5.0-rc.1...v3.5.0-rc.2
+[v3.5.0-rc.1]: https://github.com/openimsdk/open-im-server/compare/v3.5.0-rc.0...v3.5.0-rc.1
+[v3.5.0-rc.0]: https://github.com/openimsdk/open-im-server/compare/v3.5.0-beta.1...v3.5.0-rc.0
@@ -0,0 +1,20 @@
+# Version logging for OpenIM
+
+<!-- BEGIN MUNGE: GENERATED_TOC -->
+
+<!-- END MUNGE: GENERATED_TOC -->
+
+<a name="unreleased"></a>
+## [Unreleased]
+
+
+<a name="v3.6.0"></a>
+## v3.6.0 - 2024-03-07
+### Reverts
+- update etcd to v3.5.2 ([#206](https://github.com/openimsdk/open-im-server/issues/206))
+
+### Pull Requests
+- Merge branch 'tuoyun'
+
+
+[Unreleased]: https://github.com/openimsdk/open-im-server/compare/v3.6.0...HEAD
@@ -0,0 +1,33 @@
+# How do I contribute code to OpenIM
+
+<p align="center">
+  <a href="./CONTRIBUTING.md">Englist</a> · 
+  <a href="./CONTRIBUTING-zh_CN.md">中文</a> · 
+  <a href="docs/contributing/CONTRIBUTING-UA.md">Українська</a> · 
+  <a href="docs/contributing/CONTRIBUTING-CS.md">Česky</a> · 
+  <a href="docs/contributing/CONTRIBUTING-HU.md">Magyar</a> · 
+  <a href="docs/contributing/CONTRIBUTING-ES.md">Español</a> · 
+  <a href="docs/contributing/CONTRIBUTING-FA.md">فارسی</a> · 
+  <a href="docs/contributing/CONTRIBUTING-FR.md">Français</a> · 
+  <a href="docs/contributing/CONTRIBUTING-DE.md">Deutsch</a> · 
+  <a href="docs/contributing/CONTRIBUTING-PL.md">Polski</a> · 
+  <a href="docs/contributing/CONTRIBUTING-ID.md">Indonesian</a> · 
+  <a href="docs/contributing/CONTRIBUTING-FI.md">Suomi</a> · 
+  <a href="docs/contributing/CONTRIBUTING-ML.md">മലയാളം</a> · 
+  <a href="docs/contributing/CONTRIBUTING-JP.md">日本語</a> · 
+  <a href="docs/contributing/CONTRIBUTING-NL.md">Nederlands</a> · 
+  <a href="docs/contributing/CONTRIBUTING-IT.md">Italiano</a> · 
+  <a href="docs/contributing/CONTRIBUTING-RU.md">Русский</a> · 
+  <a href="docs/contributing/CONTRIBUTING-PTBR.md">Português (Brasil)</a> · 
+  <a href="docs/contributing/CONTRIBUTING-EO.md">Esperanto</a> · 
+  <a href="docs/contributing/CONTRIBUTING-KR.md">한국어</a> · 
+  <a href="docs/contributing/CONTRIBUTING-AR.md">العربي</a> · 
+  <a href="docs/contributing/CONTRIBUTING-VN.md">Tiếng Việt</a> · 
+  <a href="docs/contributing/CONTRIBUTING-DA.md">Dansk</a> · 
+  <a href="docs/contributing/CONTRIBUTING-GR.md">Ελληνικά</a> · 
+  <a href="docs/contributing/CONTRIBUTING-TR.md">Türkçe</a>
+</p>
+
+</div>
+
+</p>
@@ -1,6 +1,38 @@
-#  Contributing to Open-IM-Server
+# How do I contribute code to OpenIM

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

 First of all, thank you for considering contributing to our project! We appreciate your time and effort, and we value any contribution, whether it's reporting a bug, suggesting a new feature, or submitting a pull request.

@@ -12,7 +44,7 @@ This document provides guidelines and best practices to help you contribute effe

 ## 📇Topics

- [Contributing to Open-IM-Server](#contributing-to-open-im-server)
+- [How do I contribute code to OpenIM](#how-do-i-contribute-code-to-openim)
  - [📇Topics](#topics)
  - [What we expect of you](#what-we-expect-of-you)
  - [Code of ConductCode of Conduct](#code-of-conductcode-of-conduct)
@@ -32,13 +64,13 @@ This document provides guidelines and best practices to help you contribute effe

 ## What we expect of you

-We hope that anyone can join Open-IM-Server , even if you are a student, writer, translator
+We hope that anyone can join open-im-server , even if you are a student, writer, translator

-Please meet the minimum version of the Go language published in [go.mod](./go.mod). If you want to manage the Go language version, we provide tools to install [gvm](https://github.com/moovweb/gvm) in our [Makefile](./Makefile)
+Please meet the minimum version of the Go language published in [go.mod](./go.mod). If you want to manage the Go language version, we provide tools tHow do I contribute code to OpenIMo install [gvm](https://github.com/moovweb/gvm) in our [Makefile](./Makefile)

-You'd better use Linux OR WSL as the development environment, Linux with [Makefile](./Makefile) can help you quickly build and test Open-IM-Server project.
+You'd better use Linux OR WSL as the development environment, Linux with [Makefile](./Makefile) can help you quickly build and test open-im-server project.

-If you are familiar with [Makefile](./Makefile) , you can easily see the clever design of the Open-IM-Server Makefile. Storing the necessary tools such as golangci in the `/tools` directory can avoid some tool version issues.
+If you are familiar with [Makefile](./Makefile) , you can easily see the clever design of the open-im-server Makefile. Storing the necessary tools such as golangci in the `/tools` directory can avoid some tool version issues.

 The [Makefile](./Makefile) is for every developer, even if you don't know how to use the Makefile tool, don't worry, we provide two great commands to get you up to speed with the Makefile architecture, `make help` and `make help-all`, it can reduce problems of the developing environment.

@@ -52,7 +84,7 @@ In accordance with the naming conventions adopted by OpenIM and drawing referenc

 #### Code and doc contribution

-Every action to make project Open-IM-Server better is encouraged. On GitHub, every improvement for Open-IM-Server could be via a [PR](https://github.com/openimsdk/open-im-server/pulls) (short for pull request).
+Every action to make project open-im-server better is encouraged. On GitHub, every improvement for open-im-server could be via a [PR](https://github.com/openimsdk/open-im-server/pulls) (short for pull request).

 + If you find a typo, try to fix it!
 + If you find a bug, try to fix it!
@@ -67,8 +99,8 @@ Every action to make project Open-IM-Server better is encouraged. On GitHub, eve

 #### Where should I start?

-+ If you are new to the project, don't know how to contribute Open-IM-Server, please check out the [good first issue](https://github.com/openimsdk/open-im-server/issues?q=is%3Aopen+label%3A"good+first+issue"+sort%3Aupdated-desc) label.
-+ You should be good at filtering the Open-IM-Server issue tags and finding the ones you like, such as [RFC](https://github.com/openimsdk/open-im-server/issues?q=is%3Aissue+is%3Aopen+RFC+label%3ARFC) for big initiatives, features for [feature](https://github.com/openimsdk/open-im-server/issues?q=is%3Aissue+label%3Afeature) proposals, and [bug](https://github.com/openimsdk/open-im-server/issues?q=is%3Aissue+label%3Abug+) fixes.
+ If you are new to the project, don't know how to contribute open-im-server, please check out the [good first issue](https://github.com/openimsdk/open-im-server/issues?q=is%3Aopen+label%3A"good+first+issue"+sort%3Aupdated-desc) label.
+ You should be good at filtering the open-im-server issue tags and finding the ones you like, such as [RFC](https://github.com/openimsdk/open-im-server/issues?q=is%3Aissue+is%3Aopen+RFC+label%3ARFC) for big initiatives, features for [feature](https://github.com/openimsdk/open-im-server/issues?q=is%3Aissue+label%3Afeature) proposals, and [bug](https://github.com/openimsdk/open-im-server/issues?q=is%3Aissue+label%3Abug+) fixes.
 + If you are looking for something to work on, check out our [open issues](https://github.com/openimsdk/open-im-server/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc).
 + If you have an idea for a new feature, please [open an issue](https://github.com/openimsdk/open-im-server/issues/new/choose), and we can discuss it.

@@ -85,7 +117,7 @@ When documenting a new design, we recommend a 2-step approach:
 1. Use the short-form RFC template to outline your ideas and get early feedback.
 2. Once you have received sufficient feedback and consensus, you may use the longer-form design doc template to specify and discuss your design in more details.

-In order to contribute a feature to Open-IM-Server you'll need to go through the following steps:
+In order to contribute a feature to open-im-server you'll need to go through the following steps:

 + Discuss your idea with the appropriate [working groups](https://join.slack.com/t/openimsdk/shared_invite/zt-22720d66b-o_FvKxMTGXtcnnnHiMqe9Q) on the working group's Slack channel.
 + Once there is general agreement that the feature is useful, create a GitHub issue to track the discussion. The issue should include information about the requirements and use cases that it is trying to address.
@@ -95,13 +127,27 @@ But keep in mind that there is no guarantee of it being accepted and so it is us

 ## Getting Started

-To propose PR for the Open-IM-Server item, we assume you have registered a GitHub ID. Then you could finish the preparation in the following steps:
+To propose PR for the open-im-server item, we assume you have registered a GitHub ID. Then you could finish the preparation in the following steps:

-1. Fork the repository(Open-IM-Server)
+1. Fork the repository(open-im-server)

-2. **CLONE** your own repository to main locally. Use `git clone https://github.com/<your-username>/Open-IM-Server.git` to clone repository to your local machine. Then you can create new branches to finish the change you wish to make.
+2. **CLONE** your own repository to main locally. Use `git clone https://github.com/<your-username>/open-im-server.git` to clone repository to your local machine. Then you can create new branches to finish the change you wish to make.

-3. **Set Remote** upstream to be `https://github.com/openimsdk/open-im-server.git` using the following two commands:
+3. **Initialize Git Hooks with `make init-githooks`**
+
+   After cloning the repository, it's recommended to set up Git hooks to streamline your workflow and ensure your contributions adhere to OpenIM's community standards. Git hooks are scripts that run automatically every time a particular event occurs in a Git repository, such as before a commit or push. To initialize Git hooks for the OpenIM server repository, use the `make init-githooks` command.
+
+   - **Enabling Git Hooks Mode**: By running `make init-githooks` and entering `1` when prompted, you enable Git hooks mode. This action will generate a series of hooks within the `.git/hooks/` directory. These hooks impose certain checks on your commits and pushes, ensuring they meet the quality and standards expected by the OpenIM community. For instance, commit hooks might enforce a specific commit message format, while push hooks could check for code style or linting issues.
+
+   - **Benefits for First-Time Contributors**: This setup is especially beneficial for new contributors. It guides you to make professional, community-standard-compliant Pull Requests (PRs) and PR descriptions right from your first contribution. By automating checks and balances, it reduces the chances of common mistakes and speeds up the review process.
+
+   - **Disabling Git Hooks**: If for any reason you wish to remove the Git hooks, simply run `make init-githooks` again and enter `2` when prompted. This will delete the existing Git hooks, removing the automatic checks and constraints from your Git operations. However, keep in mind that manually ensuring your contributions adhere to community standards without the aid of Git hooks requires diligence.
+ 
+   > [!NOTE] Utilizing Git hooks through the `make init-githooks` command is a straightforward yet powerful way to ensure your contributions are consistent and high-quality. It's a step towards fostering a professional and efficient development environment in the OpenIM project.
+
+
+
+4. **Set Remote** upstream to be `https://github.com/openimsdk/open-im-server.git` using the following two commands:

   ```bash
   ❯ git remote add upstream https://github.com/openimsdk/open-im-server.git
@@ -112,18 +158,18 @@ To propose PR for the Open-IM-Server item, we assume you have registered a GitHu

   ```bash
   ❯ git remote -v
-   origin     https://github.com/<your-username>/Open-IM-Server.git (fetch)
-   origin     https://github.com/<your-username>/Open-IM-Server.git (push)
+   origin     https://github.com/<your-username>/open-im-server.git (fetch)
+   origin     https://github.com/<your-username>/open-im-server.git (push)
   upstream   https://github.com/openimsdk/open-im-server.git (fetch)
   upstream   no-pushing (push)
   ```

   Adding this, we can easily synchronize local branches with upstream branches.

-4. Create a new branch for your changes (use a descriptive name, such as `fix-bug-123` or `add-new-feature`).
+5. Create a new branch for your changes (use a descriptive name, such as `fix-bug-123` or `add-new-feature`).

   ```bash
-   ❯ cd Open-IM-Server
+   ❯ cd open-im-server
   ❯ git fetch upstream
   ❯ git checkout upstream/main
   ```
@@ -136,7 +182,8 @@ To propose PR for the Open-IM-Server item, we assume you have registered a GitHu

   Make any change on the `new-branch` then use [Makefile](./Makefile) build and test your codes.

-5. **Commit your changes** to your local branch, lint before committing and commit with sign-off
+
+6. **Commit your changes** to your local branch, lint before committing and commit with sign-off

   ```bash
   ❯ git rebase upstream/main
@@ -145,7 +192,7 @@ To propose PR for the Open-IM-Server item, we assume you have registered a GitHu
   ❯ git commit -a -s -m "message for your changes" # -s adds a Signed-off-by trailer
   ```

-6. **Push your branch**  to your forked repository, it is recommended to have only one commit for a PR.
+7. **Push your branch**  to your forked repository, it is recommended to have only one commit for a PR.

   ```bash
   # sync up with upstream
@@ -177,12 +224,78 @@ To propose PR for the Open-IM-Server item, we assume you have registered a GitHu
   ❯ git rebase upstream/main # rebase the current branch to upstream/main branch
   ❯ git add -A
   ❯ git commit -m -s "feat: feature two"
-   # then create pull request, and merge
   ```

-7. **Open a pull request** to `openimsdk/open-im-server:main`
+    **Verifying Your Pull Request with `make all` Command**
+
+   Before verifying, you may need to complete the basic deployment of OpenIM to get familiar with the deployment status of OpenIM. Please read [this deployment document](https://docs.openim.io/zh-Hans/guides/gettingStarted/imSourceCodeDeployment), which will tell you how to deploy OpenIM middleware and OpenIM services in detail
+
+   Before submitting your Pull Request (PR), it's crucial to ensure that it passes all the necessary checks and verifications to maintain the quality and integrity of the OpenIM server project. To facilitate this process, we have encapsulated a series of validation steps into the `make all` command.
+
+   - **Purpose of `make all` Command**: The `make all` command serves as a comprehensive pre-PR verification tool. It sequentially executes a variety of tasks designed to scrutinize your changes from multiple angles, ensuring they are ready for submission.
+
+   - **Included Commands**:
+     - `tidy`: Cleans up the module by removing unused dependencies.
+     - `gen`: Generates necessary files from templates or specifications, ensuring that your codebase is up-to-date with its dependencies.
+     - `add-copyright`: Checks for and adds copyright notices to files, ensuring compliance with legal requirements.
+     - `verify`: Verifies the integrity and consistency of the code, dependencies, and various checks.
+     - `test-api`: Runs API tests to ensure that your changes do not break any existing functionality and adhere to the expected behaviors.
+     - `lint`: Analyzes the code for potential stylistic or programming errors, enforcing the project's coding standards.
+     - `cover`: Measures the code coverage of tests, helping you understand how much of the code is being tested.
+     - `restart`: (Optionally) restarts services or applications to ensure that changes are correctly applied and functioning in a live environment.
+
+   - **Executing the Command**: To run the `make all` command, simply navigate to the root directory of your cloned repository in your terminal and execute:
+     ```bash
+     make all
+     ```
+     This command will sequentially perform all the listed actions, outputting any warnings or errors encountered during the process. It's a vital step to catch any issues early and ensure your contribution meets the quality standards set by the OpenIM community.
+
+   - **Benefits**: By using `make all` for pre-PR verification, you significantly increase the likelihood of your PR being accepted on the first review. It not only demonstrates your commitment to quality but also streamlines the review process by minimizing back-and-forth due to common issues that can be caught automatically.
+
+
+    **Troubleshooting Git Push Failures**
+
+    When working with Git, encountering errors during push operations is not uncommon. Two primary reasons you might face push failures are due to firewall restrictions or authentication issues. Here’s how you can troubleshoot and resolve these problems.
+
+    **Firewall Errors**
+
+    If you're behind a corporate firewall or your network restricts certain types of traffic, you might encounter issues when trying to push your changes via HTTPS. This is because firewalls can block the ports used by the HTTPS protocol. To resolve this issue, you can configure Git to use a proxy.
+
+    If you have a local proxy server set up, you can direct Git to use it by setting the `https_proxy` and `http_proxy` environment variables. Open your terminal or command prompt and run the following commands:
+
+    ```bash
+    export https_proxy="http://127.0.0.1:7890"
+    export http_proxy="http://127.0.0.1:7890"
+    ```
+
+    Replace `127.0.0.1:7890` with the address and port of your proxy server. These commands set the proxy for the current session. If you want to make these changes permanent, add them to your `.bashrc`, `.bash_profile`, or equivalent shell configuration file.
+
+    **Using SSH Instead of HTTPS**
+
+    An alternative to using HTTPS is to set up an SSH connection for Git operations. SSH connections are often not blocked by firewalls and do not require proxy settings. Additionally, SSH provides a secure channel and can simplify the authentication process since it relies on SSH keys rather than username and password credentials.
+
+    To use SSH with Git, you first need to generate an SSH key pair and add the public key to your GitHub account (or another Git hosting service).
+
+    1. **Generate SSH Key Pair**: Open your terminal and run `ssh-keygen -t rsa -b 4096 -C "your_email@example.com"`, replacing `your_email@example.com` with your email. Press enter to accept the default file location and passphrase prompts.
+
+    2. **Add SSH Key to SSH-Agent**: Ensure the ssh-agent is running with `eval "$(ssh-agent -s)"` and then add your SSH private key to the ssh-agent using `ssh-add ~/.ssh/id_rsa`.
+
+    3. **Add SSH Key to GitHub**: Copy your SSH public key to your clipboard with `cat ~/.ssh/id_rsa.pub | clip` (Windows) or `pbcopy < ~/.ssh/id_rsa.pub` (Mac). Go to GitHub, navigate to Settings > SSH and GPG keys, and add a new SSH key, pasting your key into the field provided.
+
+    4. **Switch to SSH in Your Repository**: Change your repository's remote URL from HTTPS to SSH. You can find the SSH URL in your repository settings on GitHub and use `git remote set-url origin git@github.com:username/repository.git` to switch.
+
+    **Authentication Errors**
+
+    If you're experiencing authentication errors, it might be due to missing or incorrect credentials. Ensure you have added your SSH key to your Git hosting service. You can test your SSH connection with `ssh -T git@github.com` (replace `github.com` with your Git hosting service's domain). If successful, you'll receive a welcome message.
+
+    For HTTPS users, check that your username and password (or personal access token for services like GitHub that no longer accept password authentication for Git operations) are correct.
+
+8. **Open a pull request** to `openimsdk/open-im-server:main`

   It is recommended to review your changes before filing a pull request. Check if your code doesn't conflict with the main branch and no redundant code is included.
+   
+   > [!TIP] There is a [good blog post documenting](https://nsddd.top/posts/participating-in-this-project/) the entire push contribution process.
+

 ## Style and Specification

@@ -190,15 +303,15 @@ We divide the problem into security and general problems:

 #### Reporting security issues

-Security issues are always treated seriously. As our usual principle, we discourage anyone to spread security issues. If you find a security issue of Open-IM-Server, please do not discuss it in public and even do not open a public issue.
+Security issues are always treated seriously. As our usual principle, we discourage anyone to spread security issues. If you find a security issue of open-im-server, please do not discuss it in public and even do not open a public issue.

 Instead we encourage you to send us a private email to info@openim.io to report this.

 #### Reporting general issues

-To be honest, we regard every user of Open-IM-Serveras a very kind contributor. After experiencing Open-IM-Server, you may have some feedback for the project. Then feel free to open an issue via [NEW ISSUE](https://github.com/openimsdk/open-im-server/issues/new/choose).
+To be honest, we regard every user of open-im-serveras a very kind contributor. After experiencing open-im-server, you may have some feedback for the project. Then feel free to open an issue via [NEW ISSUE](https://github.com/openimsdk/open-im-server/issues/new/choose).

-Since we collaborate project Open-IM-Server in a distributed way, we appreciate **WELL-WRITTEN**, **DETAILED**, **EXPLICIT** issue reports. To make the communication more efficient, we wish everyone could search if your issue is an existing one in the searching list. If you find it existing, please add your details in comments under the existing issue instead of opening a brand new one.
+Since we collaborate project open-im-server in a distributed way, we appreciate **WELL-WRITTEN**, **DETAILED**, **EXPLICIT** issue reports. To make the communication more efficient, we wish everyone could search if your issue is an existing one in the searching list. If you find it existing, please add your details in comments under the existing issue instead of opening a brand new one.

 To make the issue details as standard as possible, we setup an [ISSUE TEMPLATE](https://github.com/OpenIMSDK/.github/tree/main/.github/ISSUE_TEMPLATE) for issue reporters. You can find three kinds of issue templates there: question, bug report and feature request. Please **BE SURE** to follow the instructions to fill fields in template.

@@ -206,20 +319,20 @@ To make the issue details as standard as possible, we setup an [ISSUE TEMPLATE](

 + bug report
 + feature request
-+ Open-IM-Server performance issues 
+ open-im-server performance issues 
 + feature proposal
 + feature design
 + help wanted
 + doc incomplete
 + test improvement
-+ any questions on Open-IM-Server project 
+ any questions on open-im-server project 
 + and so on 

-Also, we must be reminded when submitting a new question about Open-IM-Server, please remember to remove the sensitive data from your post. Sensitive data could be password, secret key, network locations, private business data and so on.
+Also, we must be reminded when submitting a new question about open-im-server, please remember to remove the sensitive data from your post. Sensitive data could be password, secret key, network locations, private business data and so on.

 #### Commit Rules

-Actually in Open-IM-Server, we take two rules serious when committing:
+Actually in open-im-server, we take two rules serious when committing:

 **🥇 Commit Message:**

@@ -262,7 +375,7 @@ An example for this could be:

 #### PR Description

-PR is the only way to make change to Open-IM-Server project files. To help reviewers better get your purpose, PR description could not be too detailed. We encourage contributors to follow the [PR template](https://github.com/OpenIMSDK/.github/tree/main/.github/PULL_REQUEST_TEMPLATE.md) to finish the pull request.
+PR is the only way to make change to open-im-server project files. To help reviewers better get your purpose, PR description could not be too detailed. We encourage contributors to follow the [PR template](https://github.com/OpenIMSDK/.github/tree/main/.github/PULL_REQUEST_TEMPLATE.md) to finish the pull request.

 You can find some very formal PR in [RFC](https://github.com/openimsdk/open-im-server/issues?q=is%3Aissue+is%3Aopen+RFC+label%3ARFC) issues and learn about them.

@@ -311,11 +424,11 @@ git() {

 #### Docs Contribution

-The documentation for Open-IM-Server includes:
+The documentation for open-im-server includes:

-+ [README.md](https://github.com/openimsdk/open-im-server/blob/main/README.md): This file includes the basic information and instructions for getting started with Open-IM-Server.
-+ [CONTRIBUTING.md](https://github.com/openimsdk/open-im-server/blob/main/CONTRIBUTING.md): This file contains guidelines for contributing to Open-IM-Server's codebase, such as how to submit issues, pull requests, and code reviews.
-+ [Official Documentation](https://doc.rentsoft.cn/): This is the official documentation for Open-IM-Server, which includes comprehensive information on all of its features, configuration options, and troubleshooting tips.
+ [README.md](https://github.com/openimsdk/open-im-server/blob/main/README.md): This file includes the basic information and instructions for getting started with open-im-server.
+ [CONTRIBUTING.md](https://github.com/openimsdk/open-im-server/blob/main/CONTRIBUTING.md): This file contains guidelines for contributing to open-im-server's codebase, such as how to submit issues, pull requests, and code reviews.
+ [Official Documentation](https://doc.rentsoft.cn/): This is the official documentation for open-im-server, which includes comprehensive information on all of its features, configuration options, and troubleshooting tips.

 Please obey the following rules to better format the docs, which would greatly improve the reading experience.

@@ -328,20 +441,20 @@ Please obey the following rules to better format the docs, which would greatly i

 ## Engage to help anything

-We choose GitHub as the primary place for Open-IM-Server to collaborate. So the latest updates of Open-IM-Server are always here. Although contributions via PR is an explicit way to help, we still call for any other ways.
+We choose GitHub as the primary place for open-im-server to collaborate. So the latest updates of open-im-server are always here. Although contributions via PR is an explicit way to help, we still call for any other ways.

 + reply to other's [issues](https://github.com/openimsdk/open-im-server/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc) if you could;
 + help solve other user's problems;
 + help review other's [PR](https://github.com/openimsdk/open-im-server/pulls?q=is%3Apr+is%3Aopen+sort%3Aupdated-desc) design; 
-+ discuss about Open-IM-Server to make things clearer;
-+ advocate [Open-IM-Server](https://google.com/search?q=Open-IM-Server) technology beyond GitHub;
-+ write blogs on Open-IM-Server and so on.
+ discuss about open-im-server to make things clearer;
+ advocate [open-im-server](https://google.com/search?q=open-im-server) technology beyond GitHub;
+ write blogs on open-im-server and so on.

 In a word, **ANY HELP IS CONTRIBUTION.**

 ## Release version

-Releases of Open-IM-Server are done using [Release Please](https://github.com/googleapis/release-please) and [GoReleaser](https://goreleaser.com/). The workflow looks like this:
+Releases of open-im-server are done using [Release Please](https://github.com/googleapis/release-please) and [GoReleaser](https://goreleaser.com/). The workflow looks like this:

 🎯 A PR is merged to the `main` branch:

@@ -366,17 +479,23 @@ Such a commit can get produced as follows:
 ❯ git commit --allow-empty -m "chore: release 0.0.3" -m "Release-As: 0.0.3
 ````

+For the complex release process, in fact, and encapsulation as CICD, you only need to tag locally, and then publish the tag to OpenIM github to complete the entire OpenIM release process.
+
+In addition to CICD, we also do a complex release command locally, which can help you complete the full platform compilation, testing, and release to Minio, just by using the `make release` command.
+Please [read the detailed documents](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/release.md)
+
+
 ## Contact Us

-We value close connections with our users, developers, and contributors here at Open-IM-Server. With a large community and maintainer team, we're always here to help and support you. Whether you're looking to join our community or have any questions or suggestions, we welcome you to get in touch with us.
+We value close connections with our users, developers, and contributors here at open-im-server. With a large community and maintainer team, we're always here to help and support you. Whether you're looking to join our community or have any questions or suggestions, we welcome you to get in touch with us.

-Our most recommended way to get in touch is through [Slack](https://join.slack.com/t/openimsdk/shared_invite/zt-22720d66b-o_FvKxMTGXtcnnnHiMqe9Q). Even if you're in China, Slack is usually not blocked by firewalls, making it an easy way to connect with us. Our Slack community is the ideal place to discuss and share ideas and suggestions with other users and developers of Open-IM-Server. You can ask technical questions, seek help, or share your experiences with other users of Open-IM-Server.
+Our most recommended way to get in touch is through [Slack](https://join.slack.com/t/openimsdk/shared_invite/zt-22720d66b-o_FvKxMTGXtcnnnHiMqe9Q). Even if you're in China, Slack is usually not blocked by firewalls, making it an easy way to connect with us. Our Slack community is the ideal place to discuss and share ideas and suggestions with other users and developers of open-im-server. You can ask technical questions, seek help, or share your experiences with other users of open-im-server.

 In addition to Slack, we also offer the following ways to get in touch:

-+ <a href="https://join.slack.com/t/openimsdk/shared_invite/zt-22720d66b-o_FvKxMTGXtcnnnHiMqe9Q" target="_blank"><img src="https://img.shields.io/badge/slack-%40OpenIMSDKCore-informational?logo=slack&style=flat-square"></a>:  We also have Slack channels for you to communicate and discuss. To join, visit https://slack.com/ and join our [👀 Open-IM-Server slack](https://join.slack.com/t/openimsdk/shared_invite/zt-22720d66b-o_FvKxMTGXtcnnnHiMqe9Q) team channel.
+ <a href="https://join.slack.com/t/openimsdk/shared_invite/zt-22720d66b-o_FvKxMTGXtcnnnHiMqe9Q" target="_blank"><img src="https://img.shields.io/badge/slack-%40OpenIMSDKCore-informational?logo=slack&style=flat-square"></a>:  We also have Slack channels for you to communicate and discuss. To join, visit https://slack.com/ and join our [👀 open-im-server slack](https://join.slack.com/t/openimsdk/shared_invite/zt-22720d66b-o_FvKxMTGXtcnnnHiMqe9Q) team channel.
 + <a href="https://mail.google.com/mail/u/0/?fs=1&tf=cm&to=4closetool3@gmail.com" target="_blank"><img src="https://img.shields.io/badge/gmail-%40OOpenIMSDKCore?style=social&logo=gmail"></a>: Get in touch with us on [Gmail](info@openim.io). If you have any questions or issues that need resolving, or any suggestions and feedback for our open source projects, please feel free to contact us via email.
-+ <a href="https://doc.rentsoft.cn/" target="_blank"><img src="https://img.shields.io/badge/%E5%8D%9A%E5%AE%A2-%40OpenIMSDKCore-blue?style=social&logo=Octopus%20Deploy"></a>: Read our [blog](https://doc.rentsoft.cn/). Our blog is a great place to stay up-to-date with Open-IM-Server projects and trends. On the blog, we share our latest developments, tech trends, and other interesting information.
-+ <a href="https://github.com/OpenIMSDK/OpenIM-Docs/blob/main/docs/images/WechatIMG20.jpeg" target="_blank"><img src="https://img.shields.io/badge/%E5%BE%AE%E4%BF%A1-OpenIMSDKCore-brightgreen?logo=wechat&style=flat-square"></a>: Add [Wechat](https://github.com/OpenIMSDK/OpenIM-Docs/blob/main/docs/images/WechatIMG20.jpeg) and indicate that you are a user or developer of Open-IM-Server. We will process your request as soon as possible.
+ <a href="https://doc.rentsoft.cn/" target="_blank"><img src="https://img.shields.io/badge/%E5%8D%9A%E5%AE%A2-%40OpenIMSDKCore-blue?style=social&logo=Octopus%20Deploy"></a>: Read our [blog](https://doc.rentsoft.cn/). Our blog is a great place to stay up-to-date with open-im-server projects and trends. On the blog, we share our latest developments, tech trends, and other interesting information.
+ <a href="https://github.com/OpenIMSDK/OpenIM-Docs/blob/main/docs/images/WechatIMG20.jpeg" target="_blank"><img src="https://img.shields.io/badge/%E5%BE%AE%E4%BF%A1-OpenIMSDKCore-brightgreen?logo=wechat&style=flat-square"></a>: Add [Wechat](https://github.com/OpenIMSDK/OpenIM-Docs/blob/main/docs/images/WechatIMG20.jpeg) and indicate that you are a user or developer of open-im-server. We will process your request as soon as possible.

 Whether you're looking to join our community or have any questions or suggestions, we welcome you to get in touch with us.
@@ -3,15 +3,13 @@ FROM golang:1.20 AS builder

 # Set go mod installation source and proxy
 ARG GO111MODULE=on
-ARG GOPROXY=https://goproxy.cn,direct
+
 ENV GO111MODULE=$GO111MODULE
 ENV GOPROXY=$GOPROXY

 # Set up the working directory
 WORKDIR /openim/openim-server

-COPY go.mod go.sum ./
-RUN go mod download

 # Copy all files to the container
 ADD . .
@@ -1,255 +0,0 @@
-# ==============================================================================
-# define the default goal
-#
-
-.DEFAULT_GOAL := help
-
-## all: Run tidy, gen, add-copyright, format, lint, cover, build ✨
-.PHONY: all
-all: tidy gen add-copyright verify test-api lint cover restart
-
-# ==============================================================================
-# Build set
-
-ROOT_PACKAGE=github.com/openimsdk/open-im-server
-# TODO: This is version control for the future https://github.com/openimsdk/open-im-server/issues/574
-VERSION_PACKAGE=github.com/openimsdk/open-im-server/v3/pkg/version
-
-# ==============================================================================
-# Includes
-
-include scripts/make-rules/common.mk	# make sure include common.mk at the first include line
-include scripts/make-rules/golang.mk
-include scripts/make-rules/image.mk
-include scripts/make-rules/copyright.mk
-include scripts/make-rules/gen.mk
-include scripts/make-rules/dependencies.mk
-include scripts/make-rules/tools.mk
-include scripts/make-rules/release.mk
-include scripts/make-rules/swagger.mk
-
-# ==============================================================================
-# Usage
-
-define USAGE_OPTIONS
-
-Options:
-
-  DEBUG            Whether or not to generate debug symbols. Default is 0.
-
-  BINS             Binaries to build. Default is all binaries under cmd.
-                   This option is available when using: make {build}(.multiarch)
-                   Example: make build BINS="openim-api openim-cmdutils".
-
-  PLATFORMS        Platform to build for. Default is linux_arm64 and linux_amd64.
-                   This option is available when using: make {build}.multiarch
-                   Example: make multiarch PLATFORMS="linux_s390x linux_mips64
-                   linux_mips64le darwin_amd64 windows_amd64 linux_amd64 linux_arm64".
-
-  V                Set to 1 enable verbose build. Default is 0.
-endef
-export USAGE_OPTIONS
-
-# ==============================================================================
-# Targets
-
-## init: Initialize openim server project ✨
-.PHONY: init
-init:
-	@$(MAKE) gen.init
-
-## init-githooks: Initialize git hooks ✨
-.PHONY: init-githooks
-init-githooks:
-	@$(MAKE) gen.init-githooks
-
-## gen: Generate all necessary files. ✨
-.PHONY: gen
-gen:
-	@$(MAKE) gen.run
-
-## demo: Run demo get started with Makefiles quickly ✨
-.PHONY: demo
-demo:
-	@$(MAKE) go.demo
-
-## version: Check version of openim. ✨
-.PHONY: version
-version:
-	@$(MAKE) go.versionchecker
-
-## build: Build binaries by default ✨
-.PHONY: build
-build:
-	@$(MAKE) go.build
-
-## start: Start openim ✨
-.PHONY: start
-start:
-	@$(MAKE) go.start
-
-## stop: Stop openim ✨
-.PHONY: stop
-stop:
-	@$(MAKE) go.stop
-
-## restart: Restart openim (make init configuration file is initialized) ✨
-.PHONY: restart
-restart: clean stop build 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)
@@ -1,143 +0,0 @@
-<p align="center">
-    <a href="https://openim.io">
-        <img src="./assets/logo-gif/openim-logo.gif" width="60%" height="30%"/>
-    </a>
-</p>
-
-<h3 align="center" style="border-bottom: none">
-    ⭐️  Open source Instant Messaging Server ⭐️ <br>
-<h3>
-
-
-<p align=center>
-<a href="https://goreportcard.com/report/github.com/openimsdk/open-im-server"><img src="https://goreportcard.com/badge/github.com/openimsdk/open-im-server" alt="A+"></a>
-<a href="https://github.com/openimsdk/open-im-server/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3A%22good+first+issue%22"><img src="https://img.shields.io/github/issues/openimsdk/open-im-server/good%20first%20issue?logo=%22github%22" alt="good first"></a>
-<a href="https://github.com/openimsdk/open-im-server"><img src="https://img.shields.io/github/stars/openimsdk/open-im-server.svg?style=flat&logo=github&colorB=deeppink&label=stars"></a>
-<a href="https://join.slack.com/t/openimsdk/shared_invite/zt-22720d66b-o_FvKxMTGXtcnnnHiMqe9Q"><img src="https://img.shields.io/badge/Slack-300%2B-blueviolet?logo=slack&amp;logoColor=white"></a>
-<a href="https://github.com/openimsdk/open-im-server/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-Apache--2.0-green"></a>
-<a href="https://golang.org/"><img src="https://img.shields.io/badge/Language-Go-blue.svg"></a>
-</p>
-
-</p>
-
-<p align="center">
-    <a href="./README.md"><b> English </b></a> •
-    <a href="./README-zh_CN.md"><b> 简体中文 </b></a> •
-    <a href="https://openim.io/en"><b> Docs </b></a>
-</p>
-
-
-</p>
-
-## 🟢 扫描微信进群交流
-<img src="./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>
@@ -17,82 +17,97 @@
 [![Good First Issues](https://img.shields.io/github/issues/openimsdk/open-im-server/good%20first%20issue?style=for-the-badge&logo=github)](https://github.com/openimsdk/open-im-server/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3A%22good+first+issue%22)
 [![Language](https://img.shields.io/badge/Language-Go-blue.svg?style=for-the-badge&logo=go&logoColor=white)](https://golang.org/)

-[**English**](./README.md) •
-[**简体中文**](./README-zh_CN.md) •
-[**Docs**](https://openim.io/en)
+
+<p align="center">
+  <a href="./README.md">Englist</a> · 
+  <a href="./README_zh_CN.md">中文</a> · 
+  <a href="./docs/readme/README_uk.md">Українська</a> · 
+  <a href="./docs/readme/README_cs.md">Česky</a> · 
+  <a href="./docs/readme/README_hu.md">Magyar</a> · 
+  <a href="./docs/readme/README_es.md">Español</a> · 
+  <a href="./docs/readme/README_fa.md">فارسی</a> · 
+  <a href="./docs/readme/README_fr.md">Français</a> · 
+  <a href="./docs/readme/README_de.md">Deutsch</a> · 
+  <a href="./docs/readme/README_pl.md">Polski</a> · 
+  <a href="./docs/readme/README_id.md">Indonesian</a> · 
+  <a href="./docs/readme/README_fi.md">Suomi</a> · 
+  <a href="./docs/readme/README_ml.md">മലയാളം</a> · 
+  <a href="./docs/readme/README_ja.md">日本語</a> · 
+  <a href="./docs/readme/README_nl.md">Nederlands</a> · 
+  <a href="./docs/readme/README_it.md">Italiano</a> · 
+  <a href="./docs/readme/README_ru.md">Русский</a> · 
+  <a href="./docs/readme/README_pt_BR.md">Português (Brasil)</a> · 
+  <a href="./docs/readme/README_eo.md">Esperanto</a> · 
+  <a href="./docs/readme/README_ko.md">한국어</a> · 
+  <a href="./docs/readme/README_ar.md">العربي</a> · 
+  <a href="./docs/readme/README_vi.md">Tiếng Việt</a> · 
+  <a href="./docs/readme/README_da.md">Dansk</a> · 
+  <a href="./docs/readme/README_el.md">Ελληνικά</a> · 
+  <a href="./docs/readme/README_tr.md">Türkçe</a>
+</p>
+

 </div>

 </p>

+## :busts_in_silhouette: Community
+
+ 💬 [Follow our Twitter account](https://twitter.com/founder_im63606)
+ 👫 [Join our Reddit](https://www.reddit.com/r/OpenIMessaging)
+ 🚀 [Join our Slack community](https://join.slack.com/t/openimsdk/shared_invite/zt-22720d66b-o_FvKxMTGXtcnnnHiMqe9Q)
+ :eyes: [Join our wechat (微信群)](https://openim-1253691595.cos.ap-nanjing.myqcloud.com/WechatIMG20.jpeg)
+ 📚 [OpenIM Community](https://github.com/OpenIMSDK/community)
+ 💕 [OpenIM Interest Group](https://github.com/Openim-sigs)

 ## Ⓜ️ About OpenIM

-OpenIM isn't just an open-source instant messaging component, it's an integral part of your application ecosystem. Check out this diagram to understand how AppServer, AppClient, OpenIMServer, and OpenIMSDK interact.
+OpenIM is a service platform specifically designed for integrating chat, audio-video calls, notifications, and AI chatbots into applications. It provides a range of powerful APIs and Webhooks, enabling developers to easily incorporate these interactive features into their applications. OpenIM is not a standalone chat application, but rather serves as a platform to support other applications in achieving rich communication functionalities. The following diagram illustrates the interaction between AppServer, AppClient, OpenIMServer, and OpenIMSDK to explain in detail.

 ![App-OpenIM Relationship](./docs/images/oepnim-design.png)

 ## 🚀 About OpenIMSDK

-**OpenIMSDK** seamlessly integrates into your application, delivering a rich, real-time messaging experience without requiring intricate UI integration. It provides:
+**OpenIMSDK** is an IM SDK designed for **OpenIMServer**, created specifically for embedding in client applications. Its main features and modules are as follows:

-+ **Local Storage**: For quick data retrieval and message synchronization.
-+ **Listener Callbacks**: Ensuring real-time message interactivity.
-+ **API Encapsulation**: Streamlining development processes.
-+ **Connection Management**: Guaranteeing reliable message delivery.
+ 🌟 Main Features:

-It's crafted in Golang and supports cross-platform deployment, ensuring a coherent messaging experience across all platforms.
+  - 📦 Local storage
+  - 🔔 Listener callbacks
+  - 🛡️ API wrapping
+  - 🌐 Connection management
+
+ 📚 Main Modules:
+
+  1. 🚀 Initialization and Login
+  2. 👤 User Management
+  3. 👫 Friend Management
+  4. 🤖 Group Functions
+  5. 💬 Conversation Handling
+
+It is built using Golang and supports cross-platform deployment, ensuring a consistent access experience across all platforms.

 👉 **[Explore GO SDK](https://github.com/openimsdk/openim-sdk-core)**

 ## 🌐 About OpenIMServer

-**OpenIMServer**, meticulously developed in Golang, ensures a stellar instant messaging server capability with a multifold approach:
+ **OpenIMServer** has the following characteristics:
+  - 🌐 Microservice architecture: Supports cluster mode, including a gateway and multiple rpc services.
+  - 🚀 Diverse deployment methods: Supports deployment via source code, Kubernetes, or Docker.
+  - Support for massive user base: Super large groups with hundreds of thousands of users, tens of millions of users, and billions of messages.

-+ **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 Functionality:

-### Enhanced Business Functionalities:
+ **REST API**: OpenIMServer offers REST APIs for business systems, aimed at empowering businesses with more functionalities, such as creating groups and sending push messages through backend interfaces.
+ **Webhooks**: OpenIMServer provides callback capabilities to extend more business forms. A callback means that OpenIMServer sends a request to the business server before or after a certain event, like callbacks before or after sending a message.

-+ **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.
+👉 **[Learn more](https://docs.openim.io/guides/introduction/product)**

-👉 **[Learn More](https://docs.openim.io/guides/introduction/product)**
+## :building_construction: Overall Architecture

-<!--
+Delve into the heart of Open-IM-Server's functionality with our architecture diagram.

-## :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
@@ -101,107 +116,19 @@ We support many platforms. Here are the addresses for quick experience on the we

 👉 **[OpenIM online web demo](https://web-enterprise.rentsoft.cn/)**

-You can quickly learn OpenIM engineering solutions, all it takes is one simple command:
-
-```bash
-$ make demo
-```
-
-🤲 In order to facilitate the user experience, we have provided a variety of deployment solutions, you can choose your own deployment method according to the list below:
-
-<!--
-<details> <summary>Deploying with Docker Compose</summary>
-
-It is recommended to use Docker Compose for deployment, which can easily and quickly deploy the entire OpenIM service on a single node
-
-+ [https://github.com/openimsdk/openim-docker](https://github.com/openimsdk/openim-docker)
-
-
-> **Note**
->
-> If you don't know OpenIM's versioning policy, 📚Read our release policy: https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/version.md
-
-
-</details> 
-
-<details>  <summary>Compile from Source</summary>
-
-
-Ur need `Go 1.20` or higher version, and `make`.
-
-
-```bash
-go version && make --version || echo "Error: One of the commands failed."
-```
-
-Version Details: https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/version.md
-
-You can get the version number from the command below or from [github releases](https://github.com/openimsdk/open-im-server/tags).
-
-```bash
-$ curl --silent "https://api.github.com/repos/openimsdk/open-im-server/releases" | jq -r '.[].tag_name'
-```
-
-We have our own version management policy, if you are interested in our version management, I recommend reading [📚 OpenIM Version](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/version.md), We recommend using stable versions such as `v3.3.0` and `v3.2.0` whenever possible. `v3.1.1-alpha.3` as well as `v3.3.0-beta.0` and `v3.2.0-rc.0` are pre-release or beta versions and are not recommended.
-
-Set `OPENIM_VERSION` environment variables for the latest `OPENIM_VERSION` number, or replace the `OPENIM_VERSION` for you to install the OpenIM-Server `OPENIM_VERSION`:
-
-```bash
-$ OPENIM_VERSION=`curl -s https://api.github.com/repos/openimsdk/open-im-server/releases/latest | grep -oE '"tag_name": "[^"]+"' | head -n1 | cut -d'"' -f4`
-# OPENIM_VERSION=v3.3.0
-```
-
-Deploy basic components at the click of a command:
-
-```bash
-# install openim dependency
-$ git clone https://github.com/openimsdk/open-im-server openim/openim-server && export openim=$(pwd)/openim/openim-server && cd $openim/openim-server && git checkout $OPENIM_VERSION
-$ make init && docker compose up -d && make start && make check
-```
-
-> `make help` to help you see the instructions supported by OpenIM.
-
-
-You can use the `make help-all` see OpenIM in action.
-
-</details>
-
-<details>  <summary>Component Configuration Instructions</summary>
-
-Read: Configuration center document：https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/environment.md
-
-</details>
-
-
-<details>  <summary>Deployed with kubernetes</summary>
-
-+ https://github.com/openimsdk/open-im-server/blob/main/deployments/README.md
-
-</details> 
-->
+🤲 To facilitate user experience, we offer various deployment solutions. You can choose your deployment method from the list below:

 + **[Source Code Deployment Guide](https://docs.openim.io/guides/gettingStarted/imSourceCodeDeployment)**
-+ **[Production deployment of Linux systems](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/install-openim-linux-system.md)**
 + **[Docker Deployment Guide](https://docs.openim.io/guides/gettingStarted/dockerCompose)**
-+ **[Kubernetes Deployment Guide](https://github.com/openimsdk/open-im-server/tree/main/deployments)**
+ **[Kubernetes Deployment Guide](https://docs.openim.io/guides/gettingStarted/k8s-deployment)**
+ **[Mac Developer Deployment Guide](https://docs.openim.io/guides/gettingstarted/mac-deployment-guide)**

-<!-- 
-## :link: OpenIM and your application
-
-OpenIM isn't just an open-source instant messaging component, it's an integral part of your application ecosystem. Check out this diagram to understand how AppServer, AppClient, OpenIMServer, and OpenIMSDK interact.
-
-![App-OpenIM Relationship](./docs/images/oepnim-design.png)
-
-## :building_construction: Overall Architecture
-
-Delve into the heart of Open-IM-Server's functionality with our architecture diagram.
-
-![Overall Architecture](./docs/images/Architecture.jpg) -->
-
-## :hammer_and_wrench: To start developing OpenIM
+## :hammer_and_wrench: To Start Developing OpenIM

 [![Open in Dev Container](https://img.shields.io/static/v1?label=Dev%20Container&message=Open&color=blue&logo=visualstudiocode)](https://vscode.dev/github/openimsdk/open-im-server)

+[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/openimsdk/open-im-server)
+
 OpenIM Our goal is to build a top-level open source community. We have a set of standards, in the [Community repository](https://github.com/OpenIMSDK/community).

 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).
@@ -236,13 +163,7 @@ Before you start, please make sure your changes are in demand. The best for that
 - [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)
+- [Mac Developer Deployment Guide for OpenIM](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/mac-developer-deployment-guide.md)

 ## :calendar: Community Meetings

@@ -252,7 +173,7 @@ Our conference is in the [OpenIM Slack](https://join.slack.com/t/openimsdk/share

 We take notes of each [biweekly meeting](https://github.com/orgs/OpenIMSDK/discussions/categories/meeting) in [GitHub discussions](https://github.com/openimsdk/open-im-server/discussions/categories/meeting), Our historical meeting notes, as well as replays of the meetings are available at [Google Docs :bookmark_tabs:](https://docs.google.com/document/d/1nx8MDpuG74NASx081JcCpxPgDITNTpIIos0DS6Vr9GU/edit?usp=sharing).

-## :eyes: Who are using OpenIM
+## :eyes: Who Are Using OpenIM

 Check out our [user case studies](https://github.com/OpenIMSDK/community/blob/main/ADOPTERS.md) page for a list of the project users. Don't hesitate to leave a [📝comment](https://github.com/openimsdk/open-im-server/issues/379) and share your use case.

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

 ## Copyright Notice:

-The OpenIM logo, including its variations and animated versions, displayed in this repository [OpenIM](https://github.com/OpenIMSDK/openim) under the `/assets/logo` and `/assets/logo-gif` directories, are protected by copyright laws.
+The OpenIM logo, including its variations and animated versions, displayed in this repository [OpenIM](https://github.com/openimsdk/open-im-server) under the `/assets/logo` and `/assets/logo-gif` directories, are protected by copyright laws.

 The logo design is credited to @Xx(席欣).

@@ -0,0 +1,11 @@
+# Official Colors
+
+The openim logo has an official blue color.  When reproducing the logo, please use the official color, when possible.
+
+## Pantone
+
+When possible, the Pantone color is preferred for print material.  The official Pantone color is *285C*.
+
+## RGB
+
+When used digitally, the official RGB color code is *#326CE5*.
@@ -0,0 +1,31 @@
+@echo off
+SETLOCAL
+
+mage -version >nul 2>&1
+IF %ERRORLEVEL% EQU 0 (
+    echo Mage is already installed.
+    GOTO DOWNLOAD
+)
+
+go version >nul 2>&1
+IF NOT %ERRORLEVEL% EQU 0 (
+    echo Go is not installed. Please install Go and try again.
+    exit /b 1
+)
+
+echo Installing Mage...
+go install github.com/magefile/mage@latest
+
+mage -version >nul 2>&1
+IF NOT %ERRORLEVEL% EQU 0 (
+    echo Mage installation failed.
+    echo Please ensure that %GOPATH%/bin is in your PATH.
+    exit /b 1
+)
+
+echo Mage installed successfully.
+
+:DOWNLOAD
+go mod download
+
+ENDLOCAL
@@ -0,0 +1,23 @@
+#!/bin/bash
+
+if [[ ":$PATH:" == *":$HOME/.local/bin:"* ]]; then
+    TARGET_DIR="$HOME/.local/bin"
+else
+    TARGET_DIR="/usr/local/bin"
+    echo "Using /usr/local/bin as the installation directory. Might require sudo permissions."
+fi
+
+if ! command -v mage &> /dev/null; then
+    echo "Installing Mage to $TARGET_DIR ..."
+    GOBIN=$TARGET_DIR go install github.com/magefile/mage@latest
+fi
+
+if ! command -v mage &> /dev/null; then
+    echo "Mage installation failed."
+    echo "Please ensure that $TARGET_DIR is in your \$PATH."
+    exit 1
+fi
+
+echo "Mage installed successfully."
+
+go mod download
@@ -19,7 +19,6 @@
 FROM golang:1.20 AS builder

 ARG GO111MODULE=on
-ARG GOPROXY=https://goproxy.cn,direct

 WORKDIR /openim/openim-server

@@ -19,7 +19,6 @@
 FROM golang:1.20 AS builder

 ARG GO111MODULE=on
-ARG GOPROXY=https://goproxy.cn,direct

 WORKDIR /openim/openim-server

@@ -19,7 +19,6 @@
 FROM golang:1.20 AS builder

 ARG GO111MODULE=on
-ARG GOPROXY=https://goproxy.cn,direct

 WORKDIR /openim/openim-server

@@ -19,7 +19,6 @@
 FROM golang:1.20 AS builder

 ARG GO111MODULE=on
-ARG GOPROXY=https://goproxy.cn,direct

 WORKDIR /openim/openim-server

@@ -19,7 +19,6 @@
 FROM golang:1.20 AS builder

 ARG GO111MODULE=on
-ARG GOPROXY=https://goproxy.cn,direct

 WORKDIR /openim/openim-server

@@ -19,7 +19,6 @@
 FROM golang:1.20 AS builder

 ARG GO111MODULE=on
-ARG GOPROXY=https://goproxy.cn,direct

 WORKDIR /openim/openim-server

@@ -19,7 +19,6 @@
 FROM golang:1.20 AS builder

 ARG GO111MODULE=on
-ARG GOPROXY=https://goproxy.cn,direct

 WORKDIR /openim/openim-server

@@ -19,7 +19,6 @@
 FROM golang:1.20 AS builder

 ARG GO111MODULE=on
-ARG GOPROXY=https://goproxy.cn,direct

 WORKDIR /openim/openim-server

@@ -1,45 +0,0 @@
-# Copyright © 2023 OpenIM. All rights reserved.
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-# OpenIM base image: https://github.com/openim-sigs/openim-base-image
-
-# Set go mod installation source and proxy
-
-FROM golang:1.20 AS builder
-
-ARG GO111MODULE=on
-ARG GOPROXY=https://goproxy.cn,direct
-
-WORKDIR /openim/openim-server
-
-ENV GO111MODULE=$GO111MODULE
-ENV GOPROXY=$GOPROXY
-
-COPY go.mod go.sum ./
-RUN go mod download
-
-COPY . .
-
-RUN make build BINS=openim-rpc-encryption
-
-RUN cp /openim/openim-server/_output/bin/platforms/$(go env GOOS)/$(go env GOARCH)/openim-rpc-encryption /usr/bin/openim-rpc-encryption
-
-# FROM ghcr.io/openim-sigs/openim-bash-image:latest
-FROM ghcr.io/openim-sigs/openim-bash-image:latest
-
-WORKDIR /openim/openim-server
-
-COPY --from=builder /usr/bin/openim-rpc-encryption ./bin/openim-rpc-encryption
-
-ENTRYPOINT ["./bin/openim-rpc-encryption"]
@@ -1,45 +0,0 @@
-# Copyright © 2023 OpenIM. All rights reserved.
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-# OpenIM base image: https://github.com/openim-sigs/openim-base-image
-
-# Set go mod installation source and proxy
-
-FROM golang:1.20 AS builder
-
-ARG GO111MODULE=on
-ARG GOPROXY=https://goproxy.cn,direct
-
-WORKDIR /openim/openim-server
-
-ENV GO111MODULE=$GO111MODULE
-ENV GOPROXY=$GOPROXY
-
-COPY go.mod go.sum ./
-RUN go mod download
-
-COPY . .
-
-RUN make build BINS=openim-rpc-extend-msg
-
-RUN cp /openim/openim-server/_output/bin/platforms/$(go env GOOS)/$(go env GOARCH)/openim-rpc-extend-msg /usr/bin/openim-rpc-extend-msg
-
-# FROM ghcr.io/openim-sigs/openim-bash-image:latest
-FROM ghcr.io/openim-sigs/openim-bash-image:latest
-
-WORKDIR /openim/openim-server
-
-COPY --from=builder /usr/bin/openim-rpc-extend-msg ./bin/openim-rpc-extend-msg
-
-ENTRYPOINT ["./bin/openim-rpc-extend-msg"]
@@ -19,7 +19,6 @@
 FROM golang:1.20 AS builder

 ARG GO111MODULE=on
-ARG GOPROXY=https://goproxy.cn,direct

 WORKDIR /openim/openim-server

@@ -19,7 +19,6 @@
 FROM golang:1.20 AS builder

 ARG GO111MODULE=on
-ARG GOPROXY=https://goproxy.cn,direct

 WORKDIR /openim/openim-server

@@ -19,7 +19,6 @@
 FROM golang:1.20 AS builder

 ARG GO111MODULE=on
-ARG GOPROXY=https://goproxy.cn,direct

 WORKDIR /openim/openim-server

@@ -19,7 +19,6 @@
 FROM golang:1.20 AS builder

 ARG GO111MODULE=on
-ARG GOPROXY=https://goproxy.cn,direct

 WORKDIR /openim/openim-server

@@ -19,7 +19,6 @@
 FROM golang:1.20 AS builder

 ARG GO111MODULE=on
-ARG GOPROXY=https://goproxy.cn,direct

 WORKDIR /openim/openim-server

@@ -19,7 +19,6 @@
 FROM golang:1.20 AS builder

 ARG GO111MODULE=on
-ARG GOPROXY=https://goproxy.cn,direct

 WORKDIR /openim/openim-server

@@ -1,57 +0,0 @@
-# Copyright © 2023 OpenIM. All rights reserved.
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-# OpenIM base image: https://github.com/openim-sigs/openim-base-image
-
-# Set go mod installation source and proxy
-
-FROM golang:1.20 AS builder
-
-ARG GO111MODULE=on
-ARG GOPROXY=https://goproxy.cn,direct
-
-WORKDIR /openim/openim-server
-
-ENV GO111MODULE=$GO111MODULE
-ENV GOPROXY=$GOPROXY
-
-RUN apt-get update && apt-get install -y curl unzip
-
-RUN curl -LO https://app-1302656840.cos.ap-nanjing.myqcloud.com/dist.zip \
-   && unzip dist.zip -d ./ \
-   && rm dist.zip
-
-COPY go.mod go.sum ./
-RUN go mod download
-
-COPY . .
-
-RUN make clean
-RUN make build BINS=openim-web
-
-FROM ghcr.io/openim-sigs/openim-ubuntu-image:latest
-
-WORKDIR /openim/openim-server
-
-COPY --from=builder /openim/openim-server/_output/bin/tools /openim/openim-server/_output/bin/tools/
-COPY --from=builder /openim/openim-server/dist /openim/openim-server/dist
-
-ENV PORT 11001
-ENV DISTPATH /openim/openim-server/dist
-
-EXPOSE 11001
-
-RUN mv ${OPENIM_SERVER_BINDIR}/tools/$(get_os)/$(get_arch)/openim-web /usr/bin/openim-web
-
-ENTRYPOINT ["bash", "-c", "openim-web -port $PORT -distPath $DISTPATH"]
@@ -15,114 +15,15 @@
 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/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"
+	"github.com/openimsdk/tools/system/program"
 )

 func main() {
-	apiCmd := cmd.NewApiCmd()
-	apiCmd.AddPortFlag()
-	apiCmd.AddApi(run)
-	if err := apiCmd.Execute(); err != nil {
-		log.ZError(context.Background(), "API command execution failed", err)
-		panic(err.Error())
+	if err := cmd.NewApiCmd().Exec(); err != nil {
+		program.ExitWithError(err)
 	}
-}
-
-func run(port int, proPort int) error {
-	log.ZInfo(context.Background(), "Openim api port:", "port", port, "proPort", proPort)
-
-	if port == 0 || proPort == 0 {
-		err := "port or proPort is empty:" + strconv.Itoa(port) + "," + strconv.Itoa(proPort)
-		log.ZError(context.Background(), err, nil)
-		return fmt.Errorf(err)
-	}
-
-	rdb, err := cache.NewRedis()
-	if err != nil {
-		log.ZError(context.Background(), "Failed to initialize Redis", err)
-		return err
-	}
-	log.ZInfo(context.Background(), "api start init discov client")
-
-	var client discoveryregistry.SvcDiscoveryRegistry
-
-	// Determine whether zk is passed according to whether it is a clustered deployment
-	client, err = kdisc.NewDiscoveryRegister(config.Config.Envs.Discovery)
-	if err != nil {
-		log.ZError(context.Background(), "Failed to initialize discovery register", err)
-		return err
-	}
-
-	if err = client.CreateRpcRootNodes(config.Config.GetServiceNames()); err != nil {
-		log.ZError(context.Background(), "Failed to create RPC root nodes", err)
-		return err
-	}
-
-	log.ZInfo(context.Background(), "api register public config to discov")
-	if err = client.RegisterConf2Registry(constant.OpenIMCommonConfigKey, config.Config.EncodeConfig()); err != nil {
-		log.ZError(context.Background(), "Failed to register public config to discov", err)
-		return err
-	}
-
-	log.ZInfo(context.Background(), "api register public config to discov success")
-	router := api.NewGinRouter(client, rdb)
-	if config.Config.Prometheus.Enable {
-		p := ginProm.NewPrometheus("app", prommetrics.GetGinCusMetrics("Api"))
-		p.SetListenAddress(fmt.Sprintf(":%d", proPort))
-		p.Use(router)
-	}
-	log.ZInfo(context.Background(), "api init router success")
-
-	var address string
-	if config.Config.Api.ListenIP != "" {
-		address = net.JoinHostPort(config.Config.Api.ListenIP, strconv.Itoa(port))
-	} else {
-		address = net.JoinHostPort("0.0.0.0", strconv.Itoa(port))
-	}
-	log.ZInfo(context.Background(), "start api server", "address", address, "OpenIM version", config.Version)
-
-	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
+
 }
@@ -16,6 +16,7 @@ package main

 import (
 	"github.com/openimsdk/open-im-server/v3/pkg/common/cmd"
+	"github.com/openimsdk/tools/system/program"
 )

 func main() {
@@ -28,6 +29,8 @@ func main() {
 	getCmd.AddCommand(seqCmd.GetSeqCmd(), msgCmd.GetMsgCmd())
 	getCmd.AddSuperGroupIDFlag()
 	getCmd.AddUserIDFlag()
+	getCmd.AddConfigDirFlag()
+	getCmd.AddIndexFlag()
 	getCmd.AddBeginSeqFlag()
 	getCmd.AddLimitFlag()
 	// openIM get seq --userID=xxx
@@ -38,6 +41,8 @@ func main() {
 	fixCmd.AddCommand(seqCmd.FixSeqCmd())
 	fixCmd.AddSuperGroupIDFlag()
 	fixCmd.AddUserIDFlag()
+	fixCmd.AddConfigDirFlag()
+	fixCmd.AddIndexFlag()
 	fixCmd.AddFixAllFlag()
 	// openIM fix seq --userID=xxx
 	// openIM fix seq --superGroupID=xxx
@@ -46,6 +51,8 @@ func main() {
 	clearCmd.AddCommand(msgCmd.ClearMsgCmd())
 	clearCmd.AddSuperGroupIDFlag()
 	clearCmd.AddUserIDFlag()
+	clearCmd.AddConfigDirFlag()
+	clearCmd.AddIndexFlag()
 	clearCmd.AddClearAllFlag()
 	clearCmd.AddBeginSeqFlag()
 	clearCmd.AddLimitFlag()
@@ -54,6 +61,6 @@ func main() {
 	// openIM clear msg --clearAll
 	msgUtilsCmd.AddCommand(&getCmd.Command, &fixCmd.Command, &clearCmd.Command)
 	if err := msgUtilsCmd.Execute(); err != nil {
-		panic(err)
+		program.ExitWithError(err)
 	}
 }
@@ -15,13 +15,12 @@
 package main

 import (
-	"github.com/openimsdk/open-im-server/v3/internal/tools"
 	"github.com/openimsdk/open-im-server/v3/pkg/common/cmd"
+	"github.com/openimsdk/tools/system/program"
 )

 func main() {
-	cronTaskCmd := cmd.NewCronTaskCmd()
-	if err := cronTaskCmd.Exec(tools.StartTask); err != nil {
-		panic(err.Error())
+	if err := cmd.NewCronTaskCmd().Exec(); err != nil {
+		program.ExitWithError(err)
 	}
 }
@@ -16,15 +16,11 @@ package main

 import (
 	"github.com/openimsdk/open-im-server/v3/pkg/common/cmd"
+	"github.com/openimsdk/tools/system/program"
 )

 func main() {
-	msgGatewayCmd := cmd.NewMsgGatewayCmd()
-	msgGatewayCmd.AddWsPortFlag()
-	msgGatewayCmd.AddPortFlag()
-	msgGatewayCmd.AddPrometheusPortFlag()
-
-	if err := msgGatewayCmd.Exec(); err != nil {
-		panic(err.Error())
+	if err := cmd.NewMsgGatewayCmd().Exec(); err != nil {
+		program.ExitWithError(err)
 	}
 }
@@ -16,13 +16,11 @@ package main

 import (
 	"github.com/openimsdk/open-im-server/v3/pkg/common/cmd"
+	"github.com/openimsdk/tools/system/program"
 )

 func main() {
-	msgTransferCmd := cmd.NewMsgTransferCmd()
-	msgTransferCmd.AddPrometheusPortFlag()
-	msgTransferCmd.AddTransferProgressFlag()
-	if err := msgTransferCmd.Exec(); err != nil {
-		panic(err.Error())
+	if err := cmd.NewMsgTransferCmd().Exec(); err != nil {
+		program.ExitWithError(err)
 	}
 }
@@ -15,19 +15,12 @@
 package main

 import (
-	"github.com/openimsdk/open-im-server/v3/internal/push"
 	"github.com/openimsdk/open-im-server/v3/pkg/common/cmd"
-	"github.com/openimsdk/open-im-server/v3/pkg/common/config"
+	"github.com/openimsdk/tools/system/program"
 )

 func main() {
-	pushCmd := cmd.NewRpcCmd(cmd.RpcPushServer)
-	pushCmd.AddPortFlag()
-	pushCmd.AddPrometheusPortFlag()
-	if err := pushCmd.Exec(); err != nil {
-		panic(err.Error())
-	}
-	if err := pushCmd.StartSvr(config.Config.RpcRegisterName.OpenImPushName, push.Start); err != nil {
-		panic(err.Error())
+	if err := cmd.NewPushRpcCmd().Exec(); err != nil {
+		program.ExitWithError(err)
 	}
 }
@@ -15,19 +15,12 @@
 package main

 import (
-	"github.com/openimsdk/open-im-server/v3/internal/rpc/auth"
 	"github.com/openimsdk/open-im-server/v3/pkg/common/cmd"
-	"github.com/openimsdk/open-im-server/v3/pkg/common/config"
+	"github.com/openimsdk/tools/system/program"
 )

 func main() {
-	authCmd := cmd.NewRpcCmd(cmd.RpcAuthServer)
-	authCmd.AddPortFlag()
-	authCmd.AddPrometheusPortFlag()
-	if err := authCmd.Exec(); err != nil {
-		panic(err.Error())
-	}
-	if err := authCmd.StartSvr(config.Config.RpcRegisterName.OpenImAuthName, auth.Start); err != nil {
-		panic(err.Error())
+	if err := cmd.NewAuthRpcCmd().Exec(); err != nil {
+		program.ExitWithError(err)
 	}
 }
@@ -15,19 +15,12 @@
 package main

 import (
-	"github.com/openimsdk/open-im-server/v3/internal/rpc/conversation"
 	"github.com/openimsdk/open-im-server/v3/pkg/common/cmd"
-	"github.com/openimsdk/open-im-server/v3/pkg/common/config"
+	"github.com/openimsdk/tools/system/program"
 )

 func main() {
-	rpcCmd := cmd.NewRpcCmd(cmd.RpcConversationServer)
-	rpcCmd.AddPortFlag()
-	rpcCmd.AddPrometheusPortFlag()
-	if err := rpcCmd.Exec(); err != nil {
-		panic(err.Error())
-	}
-	if err := rpcCmd.StartSvr(config.Config.RpcRegisterName.OpenImConversationName, conversation.Start); err != nil {
-		panic(err.Error())
+	if err := cmd.NewConversationRpcCmd().Exec(); err != nil {
+		program.ExitWithError(err)
 	}
 }
@@ -15,19 +15,12 @@
 package main

 import (
-	"github.com/openimsdk/open-im-server/v3/internal/rpc/friend"
 	"github.com/openimsdk/open-im-server/v3/pkg/common/cmd"
-	"github.com/openimsdk/open-im-server/v3/pkg/common/config"
+	"github.com/openimsdk/tools/system/program"
 )

 func main() {
-	rpcCmd := cmd.NewRpcCmd(cmd.RpcFriendServer)
-	rpcCmd.AddPortFlag()
-	rpcCmd.AddPrometheusPortFlag()
-	if err := rpcCmd.Exec(); err != nil {
-		panic(err.Error())
-	}
-	if err := rpcCmd.StartSvr(config.Config.RpcRegisterName.OpenImFriendName, friend.Start); err != nil {
-		panic(err.Error())
+	if err := cmd.NewFriendRpcCmd().Exec(); err != nil {
+		program.ExitWithError(err)
 	}
 }
@@ -15,19 +15,12 @@
 package main

 import (
-	"github.com/openimsdk/open-im-server/v3/internal/rpc/group"
 	"github.com/openimsdk/open-im-server/v3/pkg/common/cmd"
-	"github.com/openimsdk/open-im-server/v3/pkg/common/config"
+	"github.com/openimsdk/tools/system/program"
 )

 func main() {
-	rpcCmd := cmd.NewRpcCmd(cmd.RpcGroupServer)
-	rpcCmd.AddPortFlag()
-	rpcCmd.AddPrometheusPortFlag()
-	if err := rpcCmd.Exec(); err != nil {
-		panic(err.Error())
-	}
-	if err := rpcCmd.StartSvr(config.Config.RpcRegisterName.OpenImGroupName, group.Start); err != nil {
-		panic(err.Error())
+	if err := cmd.NewGroupRpcCmd().Exec(); err != nil {
+		program.ExitWithError(err)
 	}
 }
@@ -15,19 +15,12 @@
 package main

 import (
-	"github.com/openimsdk/open-im-server/v3/internal/rpc/msg"
 	"github.com/openimsdk/open-im-server/v3/pkg/common/cmd"
-	"github.com/openimsdk/open-im-server/v3/pkg/common/config"
+	"github.com/openimsdk/tools/system/program"
 )

 func main() {
-	rpcCmd := cmd.NewRpcCmd(cmd.RpcMsgServer)
-	rpcCmd.AddPortFlag()
-	rpcCmd.AddPrometheusPortFlag()
-	if err := rpcCmd.Exec(); err != nil {
-		panic(err.Error())
-	}
-	if err := rpcCmd.StartSvr(config.Config.RpcRegisterName.OpenImMsgName, msg.Start); err != nil {
-		panic(err.Error())
+	if err := cmd.NewMsgRpcCmd().Exec(); err != nil {
+		program.ExitWithError(err)
 	}
 }
@@ -15,19 +15,12 @@
 package main

 import (
-	"github.com/openimsdk/open-im-server/v3/internal/rpc/third"
 	"github.com/openimsdk/open-im-server/v3/pkg/common/cmd"
-	"github.com/openimsdk/open-im-server/v3/pkg/common/config"
+	"github.com/openimsdk/tools/system/program"
 )

 func main() {
-	rpcCmd := cmd.NewRpcCmd(cmd.RpcThirdServer)
-	rpcCmd.AddPortFlag()
-	rpcCmd.AddPrometheusPortFlag()
-	if err := rpcCmd.Exec(); err != nil {
-		panic(err.Error())
-	}
-	if err := rpcCmd.StartSvr(config.Config.RpcRegisterName.OpenImThirdName, third.Start); err != nil {
-		panic(err.Error())
+	if err := cmd.NewThirdRpcCmd().Exec(); err != nil {
+		program.ExitWithError(err)
 	}
 }
@@ -15,19 +15,12 @@
 package main

 import (
-	"github.com/openimsdk/open-im-server/v3/internal/rpc/user"
 	"github.com/openimsdk/open-im-server/v3/pkg/common/cmd"
-	"github.com/openimsdk/open-im-server/v3/pkg/common/config"
+	"github.com/openimsdk/tools/system/program"
 )

 func main() {
-	rpcCmd := cmd.NewRpcCmd(cmd.RpcUserServer)
-	rpcCmd.AddPortFlag()
-	rpcCmd.AddPrometheusPortFlag()
-	if err := rpcCmd.Exec(); err != nil {
-		panic(err.Error())
-	}
-	if err := rpcCmd.StartSvr(config.Config.RpcRegisterName.OpenImUserName, user.Start); err != nil {
-		panic(err.Error())
+	if err := cmd.NewUserRpcCmd().Exec(); err != nil {
+		program.ExitWithError(err)
 	}
 }
@@ -0,0 +1,65 @@
+# 						OpenIM配置文件说明以及常用配置修改说明
+
+## 配置文件说明
+
+| Configuration File              | Description                                                  |
+| ------------------------------- | ------------------------------------------------------------ |
+| **kafka.yml**                   | Kafka用户名、密码、地址等配置                                |
+| **redis.yml**                   | Redis密码、地址等配置                                        |
+| **minio.yml**                   | MinIO用户名、密码、地址及外网IP域名等配置；未修改外网IP或域名可能导致图片文件发送失败 |
+| **zookeeper.yml**               | ZooKeeper用户、密码、地址等配置                              |
+| **mongodb.yml**                 | MongoDB用户名、密码、地址等配置                              |
+| **log.yml**                     | 日志级别及存储目录等配置                                     |
+| **notification.yml**            | 添加好友、创建群组等事件通知配置                             |
+| **share.yml**                   | OpenIM各服务所需的公共配置，如secret等                       |
+| **webhooks.yml**                | Webhook中URL等配置                                           |
+| **local-cache.yml**             | 本地缓存配置                                                 |
+| **openim-rpc-third.yml**        | openim-rpc-third服务的监听IP、端口及图片视频对象存储配置     |
+| **openim-rpc-user.yml**         | openim-rpc-user服务的监听IP、端口配置                        |
+| **openim-api.yml**              | openim-api服务的监听IP、端口等配置项                         |
+| **openim-crontask.yml**         | openim-crontask服务配置                                      |
+| **openim-msggateway.yml**       | openim-msggateway服务的监听IP、端口等配置                    |
+| **openim-msgtransfer.yml**      | openim-msgtransfer服务配置                                   |
+| **openim-push.yml**             | openim-push服务的监听IP、端口及离线推送配置                  |
+| **openim-rpc-auth.yml**         | openim-rpc-auth服务的监听IP、端口及token有效期等配置         |
+| **openim-rpc-conversation.yml** | openim-rpc-conversation服务的监听IP、端口等配置              |
+| **openim-rpc-friend.yml**       | openim-rpc-friend服务的监听IP、端口等配置                    |
+| **openim-rpc-group.yml**        | openim-rpc-group服务的监听IP、端口等配置                     |
+| **openim-rpc-msg.yml**          | openim-rpc-msg服务的监听IP、端口及消息发送是否验证好友关系等配置 |
+
+## 常用配置修改
+
+| 修改配置项                                      | 配置文件                |
+| ----------------------------------------------- | ----------------------- |
+| 使用minio作为图片视频文件对象存储               | `minio.yml`             |
+| 生产环境日志调整                                | `log.yml`               |
+| 发送消息是否验证好友关系                        | `openim-rpc-msg.yml`    |
+| 修改secret                                      | `share.yml`             |
+| 使用oss, cos, aws, kodo作为图片视频文件对象存储 | `openim-rpc-third.yml`  |
+| 设置多端互踢策略                                | `openim-msggateway.yml` |
+| 设置离线推送                                    | `openim-push.yml`       |
+
+## 启动某个OpenIM服务的多个实例
+
+若要启动某个OpenIM的多个实例，只需增加对应的端口数，并修改项目根目录下的`start-config.yml`文件，重启服务即可生效。例如，启动2个`openim-rpc-user`实例的配置如下：
+
+```yaml
+rpc:
+  registerIP: ''
+  listenIP: 0.0.0.0
+  ports: [ 10110, 10111 ]
+
+prometheus:
+  enable: true
+  ports: [ 20100, 20101 ]
+```
+
+修改`start-config.yml`:
+
+```yaml
+serviceBinaries:
+  openim-rpc-user: 2
+```
+
+
+
@@ -1,243 +0,0 @@
-# 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.
@@ -0,0 +1,18 @@
+username: ''
+password: ''
+producerAck: ""
+compressType: "none"
+address: [ localhost:19094 ]
+toRedisTopic: "toRedis"
+toMongoTopic: "toMongo"
+toPushTopic: "toPush"
+toRedisGroupID: redis
+toMongoGroupID: mongo
+toPushGroupID: push
+tls:
+  enableTLS: false
+  caCrt: ""
+  clientCrt: ""
+  clientKey: ""
+  clientKeyPwd: ""
+  insecureSkipVerify: false
@@ -0,0 +1,27 @@
+user:
+  topic: DELETE_CACHE_USER
+  slotNum: 100
+  slotSize: 2000
+  successExpire: 300
+  failedExpire: 5
+
+group:
+  topic: DELETE_CACHE_GROUP
+  slotNum: 100
+  slotSize: 2000
+  successExpire: 300
+  failedExpire: 5
+
+friend:
+  topic: DELETE_CACHE_FRIEND
+  slotNum: 100
+  slotSize: 2000
+  successExpire: 300
+  failedExpire: 5
+
+conversation:
+  topic: DELETE_CACHE_CONVERSATION
+  slotNum: 100
+  slotSize: 2000
+  successExpire: 300
+  failedExpire: 5
@@ -0,0 +1,13 @@
+# Log storage path, default is acceptable, change to a full path if modification is needed
+storageLocation: ../../../../logs/
+# Log rotation period (in hours), default is acceptable
+rotationTime: 24
+# Number of log files to retain, default is acceptable
+remainRotationCount: 2
+# Log level settings: 3 for production environment; 6 for more verbose logging in debugging environments
+remainLogLevel: 6
+# Whether to output to standard output, default is acceptable
+isStdout: false
+# Whether to log in JSON format, default is acceptable
+isJson: false
+
@@ -0,0 +1,9 @@
+bucket: "openim"
+port: 10005
+accessKeyID: "root"
+secretAccessKey: "openIM123"
+sessionToken: ''
+internalIP: localhost
+externalIP: 150.109.93.151
+url: https://image.rentsoft.cn/
+publicRead: false
@@ -0,0 +1,7 @@
+uri: ''
+address: [ localhost:37017 ]
+database: openim_v3
+username: openIM
+password: openIM123
+maxPoolSize: 100
+maxRetry: 10
@@ -0,0 +1,354 @@
+# Copyright © 2023 OpenIM. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Determines if a message should be sent. If set to false, it triggers a silent sync without a message. If true, it requires triggering a conversation.
+# For rpc notification, send twice: once as a message and once as a notification.
+# The options field 'isNotification' indicates if it's a notification.
+groupCreated:
+  isSendMsg: true
+
+# Reliability level of the message sending.
+# Set to 1 to send only when online, 2 for guaranteed delivery.
+  reliabilityLevel: 1
+
+# This setting is effective only when 'isSendMsg' is true.
+# It controls whether to count unread messages.
+  unreadCount: false
+
+# Configuration for offline push notifications.
+  offlinePush:
+    # Enables or disables offline push notifications.
+    enable: false
+
+    # Title for the notification when a group is created.
+    title: "create group title"
+
+    # Description for the notification.
+    desc: "create group desc"
+
+    # Additional information for the notification.
+    ext: "create group ext"
+
+# Content type is not added here.
+# Content should use a JSON structure conforming to the protobuf format.
+
+groupInfoSet:
+  isSendMsg: false
+  reliabilityLevel: 1
+  unreadCount: false
+  offlinePush:
+    enable: false
+    title: "groupInfoSet title"
+    desc: "groupInfoSet desc"
+    ext: "groupInfoSet ext"
+
+
+joinGroupApplication:
+  isSendMsg: false
+  reliabilityLevel: 1
+  unreadCount: false
+  offlinePush:
+    enable: false
+    title: "joinGroupApplication title"
+    desc: "joinGroupApplication desc"
+    ext: "joinGroupApplication ext"
+
+memberQuit:
+  isSendMsg: true
+  reliabilityLevel: 1
+  unreadCount: false
+  offlinePush:
+    enable: false
+    title: "memberQuit title"
+    desc: "memberQuit desc"
+    ext: "memberQuit ext"
+
+groupApplicationAccepted:
+  isSendMsg: false
+  reliabilityLevel: 1
+  unreadCount: false
+  offlinePush:
+    enable: false
+    title: "groupApplicationAccepted title"
+    desc: "groupApplicationAccepted desc"
+    ext: "groupApplicationAccepted ext"
+
+groupApplicationRejected:
+  isSendMsg: false
+  reliabilityLevel: 1
+  unreadCount: false
+  offlinePush:
+    enable: false
+    title: "groupApplicationRejected title"
+    desc: "groupApplicationRejected desc"
+    ext: "groupApplicationRejected ext"
+
+
+groupOwnerTransferred:
+  isSendMsg: true
+  reliabilityLevel: 1
+  unreadCount: false
+  offlinePush:
+    enable: false
+    title: "groupOwnerTransferred title"
+    desc: "groupOwnerTransferred desc"
+    ext: "groupOwnerTransferred ext"
+
+memberKicked:
+  isSendMsg: true
+  reliabilityLevel: 1
+  unreadCount: false
+  offlinePush:
+    enable: false
+    title: "memberKicked title"
+    desc: "memberKicked desc"
+    ext: "memberKicked ext"
+
+memberInvited:
+  isSendMsg: true
+  reliabilityLevel: 1
+  unreadCount: false
+  offlinePush:
+    enable: false
+    title: "memberInvited title"
+    desc: "memberInvited desc"
+    ext: "memberInvited ext"
+
+memberEnter:
+  isSendMsg: true
+  reliabilityLevel: 1
+  unreadCount: false
+  offlinePush:
+    enable: false
+    title: "memberEnter title"
+    desc: "memberEnter desc"
+    ext: "memberEnter ext"
+
+groupDismissed:
+  isSendMsg: true
+  reliabilityLevel: 1
+  unreadCount: false
+  offlinePush:
+    enable: false
+    title: "groupDismissed title"
+    desc: "groupDismissed desc"
+    ext: "groupDismissed ext"
+
+groupMuted:
+  isSendMsg: true
+  reliabilityLevel: 1
+  unreadCount: false
+  offlinePush:
+    enable: false
+    title: "groupMuted title"
+    desc: "groupMuted desc"
+    ext: "groupMuted ext"
+
+groupCancelMuted:
+  isSendMsg: true
+  reliabilityLevel: 1
+  unreadCount: false
+  offlinePush:
+    enable: false
+    title: "groupCancelMuted title"
+    desc: "groupCancelMuted desc"
+    ext: "groupCancelMuted ext"
+  defaultTips:
+    tips: "group Cancel Muted"
+
+
+groupMemberMuted:
+  isSendMsg: true
+  reliabilityLevel: 1
+  unreadCount: false
+  offlinePush:
+    enable: false
+    title: "groupMemberMuted title"
+    desc: "groupMemberMuted desc"
+    ext: "groupMemberMuted ext"
+
+groupMemberCancelMuted:
+  isSendMsg: true
+  reliabilityLevel: 1
+  unreadCount: false
+  offlinePush:
+    enable: false
+    title: "groupMemberCancelMuted title"
+    desc: "groupMemberCancelMuted desc"
+    ext: "groupMemberCancelMuted ext"
+
+groupMemberInfoSet:
+  isSendMsg: false
+  reliabilityLevel: 1
+  unreadCount: false
+  offlinePush:
+    enable: false
+    title: "groupMemberInfoSet title"
+    desc: "groupMemberInfoSet desc"
+    ext: "groupMemberInfoSet ext"
+
+groupInfoSetAnnouncement:
+  isSendMsg: true
+  reliabilityLevel: 1
+  unreadCount: false
+  offlinePush:
+    enable: false
+    title: "groupInfoSetAnnouncement title"
+    desc: "groupInfoSetAnnouncement desc"
+    ext: "groupInfoSetAnnouncement ext"
+
+
+groupInfoSetName:
+  isSendMsg: true
+  reliabilityLevel: 1
+  unreadCount: false
+  offlinePush:
+    enable: false
+    title: "groupInfoSetName title"
+    desc: "groupInfoSetName desc"
+    ext: "groupInfoSetName ext"
+
+
+#############################friend#################################
+friendApplicationAdded:
+  isSendMsg: false
+  reliabilityLevel: 1
+  unreadCount: false
+  offlinePush:
+    enable: false
+    title: "Somebody applies to add you as a friend"
+    desc: "Somebody applies to add you as a friend"
+    ext: "Somebody applies to add you as a friend"
+
+friendApplicationApproved:
+  isSendMsg: true
+  reliabilityLevel: 1
+  unreadCount: false
+  offlinePush:
+    enable: true
+    title: "Someone applies to add your friend application"
+    desc: "Someone applies to add your friend application"
+    ext: "Someone applies to add your friend application"
+
+friendApplicationRejected:
+  isSendMsg: false
+  reliabilityLevel: 1
+  unreadCount: false
+  offlinePush:
+    enable: true
+    title: "Someone rejected your friend application"
+    desc: "Someone rejected your friend application"
+    ext: "Someone rejected your friend application"
+
+friendAdded:
+  isSendMsg: false
+  reliabilityLevel: 1
+  unreadCount: false
+  offlinePush:
+    enable: true
+    title: "We have become friends"
+    desc: "We have become friends"
+    ext: "We have become friends"
+
+friendDeleted:
+  isSendMsg: false
+  reliabilityLevel: 1
+  unreadCount: false
+  offlinePush:
+    enable: true
+    title: "deleted a friend"
+    desc: "deleted a friend"
+    ext: "deleted a friend"
+
+friendRemarkSet:
+  isSendMsg: false
+  reliabilityLevel: 1
+  unreadCount: false
+  offlinePush:
+    enable: true
+    title: "Your friend's profile has been changed"
+    desc: "Your friend's profile has been changed"
+    ext: "Your friend's profile has been changed"
+
+blackAdded:
+  isSendMsg: false
+  reliabilityLevel: 1
+  unreadCount: false
+  offlinePush:
+    enable: true
+    title: "blocked a user"
+    desc: "blocked a user"
+    ext: "blocked a user"
+
+blackDeleted:
+  isSendMsg: false
+  reliabilityLevel: 1
+  unreadCount: false
+  offlinePush:
+    enable: true
+    title: "Remove a blocked user"
+    desc: "Remove a blocked user"
+    ext: "Remove a blocked user"
+
+friendInfoUpdated:
+  isSendMsg: false
+  reliabilityLevel: 1
+  unreadCount: false
+  offlinePush:
+    enable: true
+    title: "friend info updated"
+    desc: "friend info updated"
+    ext: "friend info updated"
+
+#####################user#########################
+userInfoUpdated:
+  isSendMsg: false
+  reliabilityLevel: 1
+  unreadCount: false
+  offlinePush:
+    enable: true
+    title: "Remove a blocked user"
+    desc: "Remove a blocked user"
+    ext: "Remove a blocked user"
+
+userStatusChanged:
+  isSendMsg: false
+  reliabilityLevel: 1
+  unreadCount: false
+  offlinePush:
+    enable: false
+    title: "user status changed"
+    desc: "user status changed"
+    ext: "user status changed"
+
+#####################conversation#########################
+conversationChanged:
+  isSendMsg: false
+  reliabilityLevel: 1
+  unreadCount: false
+  offlinePush:
+    enable: true
+    title: "conversation changed"
+    desc: "conversation changed"
+    ext: "conversation changed"
+
+conversationSetPrivate:
+  isSendMsg: true
+  reliabilityLevel: 1
+  unreadCount: false
+  offlinePush:
+    enable: true
+    title: "burn after reading"
+    desc: "burn after reading"
+    ext: "burn after reading"
@@ -0,0 +1,13 @@
+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/
@@ -0,0 +1,4 @@
+chatRecordsClearTime: "0 2 * * 3"
+msgDestructTime: "0 2 * * *"
+retainChatRecords: 365
+enableCronLocker: false
@@ -0,0 +1,19 @@
+rpc:
+  registerIP: ''
+  ports: [ 10140 ]
+
+prometheus:
+  enable: true
+  ports: [ 20112 ]
+
+listenIP: 0.0.0.0
+
+longConnSvr:
+  ports: [ 10001 ]
+  websocketMaxConnNum: 100000
+  websocketMaxMsgLen: 4096
+  websocketTimeout: 10
+
+multiLoginPolicy: 1
+
+
@@ -0,0 +1,3 @@
+prometheus:
+  enable: true
+  ports: [ 20108, 20109, 20110, 20111 ]
@@ -0,0 +1,37 @@
+rpc:
+  registerIP: ''
+  listenIP: 0.0.0.0
+  ports: [ 10170 ]
+
+prometheus:
+  enable: true
+  ports: [ 20107 ]
+
+maxConcurrentWorkers: 3
+enable: getui
+geTui:
+  pushUrl: "https://restapi.getui.com/v2/$appId"
+  masterSecret: ''
+  appKey: ''
+  intent: ''
+  channelID: ''
+  channelName: ''
+fcm:
+  serviceAccount: "x.json"
+jpns:
+  appKey: ''
+  masterSecret: ''
+  pushURL: ''
+  pushIntent: ''
+
+iosPush:
+      pushSound: "xxx"
+      badgeCount: true
+      production: false
+
+
+
+
+
+
+
@@ -0,0 +1,13 @@
+rpc:
+  registerIP: ''
+  listenIP: 0.0.0.0
+  ports: [ 10160 ]
+
+prometheus:
+  enable: true
+  ports: [ 20106 ]
+
+tokenPolicy:
+  #token有效期，单位（天）
+  expire: 90
+
@@ -0,0 +1,11 @@
+rpc:
+  registerIP: ''
+  listenIP: 0.0.0.0
+  ports: [ 10180 ]
+
+prometheus:
+  enable: true
+  ports: [ 20105 ]
+
+
+
@@ -0,0 +1,8 @@
+rpc:
+  registerIP: ''
+  listenIP: 0.0.0.0
+  ports: [ 10120 ]
+
+prometheus:
+  enable: true
+  ports: [ 20104 ]
@@ -0,0 +1,9 @@
+rpc:
+  registerIP: ''
+  listenIP: 0.0.0.0
+  ports: [ 10150 ]
+
+prometheus:
+  enable: true
+  ports: [ 20103 ]
+
@@ -0,0 +1,14 @@
+rpc:
+  registerIP: ''
+  listenIP: 0.0.0.0
+  ports: [ 10130 ]
+
+prometheus:
+  enable: true
+  ports: [ 20102 ]
+
+#发消息是否需要好友验证
+friendVerify: false
+
+
+
@@ -0,0 +1,40 @@
+rpc:
+  registerIP: ''
+  listenIP: 0.0.0.0
+  ports: [ 10190 ]
+
+prometheus:
+  enable: true
+  ports: [ 20101 ]
+
+object:
+  enable: "minio"
+  cos:
+    bucketURL: https://temp-1252357374.cos.ap-chengdu.myqcloud.com
+    secretID: ''
+    secretKey: ''
+    sessionToken: ''
+    publicRead: false
+  oss:
+    endpoint: "https://oss-cn-chengdu.aliyuncs.com"
+    bucket: "demo-9999999"
+    bucketURL: "https://demo-9999999.oss-cn-chengdu.aliyuncs.com"
+    accessKeyID: ''
+    accessKeySecret: ''
+    sessionToken: ''
+    publicRead: false
+  kodo:
+    endpoint: "webhook://s3.cn-east-1.qiniucs.com"
+    bucket: "demo-9999999"
+    bucketURL: "webhook://your.domain.com"
+    accessKeyID: ''
+    accessKeySecret: ''
+    sessionToken: ''
+    publicRead: false
+  aws:
+    endpoint: "''"
+    region: "us-east-1"
+    bucket: "demo-9999999"
+    accessKeyID: ''
+    accessKeySecret: ''
+    publicRead: false
@@ -0,0 +1,17 @@
+rpc:
+  # API or other RPCs can access this RPC through this IP; if left blank, the internal network IP is obtained by default
+  registerIP: ''
+  # Listening IP; 0.0.0.0 means both internal and external IPs are listened to, if blank, the internal network IP is automatically obtained by default
+  listenIP: 0.0.0.0
+  # Listening ports; if multiple are configured, multiple instances will be launched, and must be consistent with the number of prometheus.ports
+  ports: [ 10110 ]
+
+prometheus:
+  # Whether to enable prometheus
+  enable: true
+  # Prometheus listening ports, must be consistent with the number of rpc.ports
+  ports: [ 20100 ]
+
+
+
+
@@ -0,0 +1,7 @@
+address: [ localhost:16379 ]
+username: ''
+password: openIM123
+enablePipeline: false
+clusterMode: false
+db: 0
+maxRetry: 10
@@ -0,0 +1,15 @@
+secret: openIM123
+env: zookeeper
+rpcRegisterName:
+  user: user
+  friend: friend
+  msg: msg
+  push: push
+  messageGateway: messageGateway
+  group: group
+  auth: auth
+  conversation: conversation
+  third: third
+
+imAdminUserID: [ "imAdmin" ]
+
@@ -1,24 +1,3 @@
-# Copyright © 2023 OpenIM. All rights reserved.
-#
-# Licensed under the Apache License, Version 2.0 (the License);
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-# -----------------------------------------------------------------
-# TODO: This config file is the template file
-# --| source: deployments/templates/openim.yaml
-# --| env: scripts/install/environment
-# --| target: config/config.yaml
-# -----------------------------------------------------------------
-
 envs:
  discovery: zookeeper

@@ -52,8 +31,8 @@ mongo:
 # Default MongoDB database name
 # Maximum connection pool size
  address: [ 172.28.0.1:37017 ]
-  database: openIM_v3
-  username: root
+  database: openim_v3
+  username: openIM
  password: openIM123
  maxPoolSize: 100

@@ -122,14 +101,14 @@ api:
 # minio.signEndpoint is minio public network address
 object:
  enable: "minio"
-  apiURL: "http://14.155.64.202:10002"
+  apiURL: "http://127.0.0.1:10002"
  minio:
    bucket: "openim"
    endpoint: "http://172.28.0.1:10005"
    accessKeyID: "root"
    secretAccessKey: "openIM123"
    sessionToken: ''
-    signEndpoint: "http://14.155.64.202:10005"
+    signEndpoint: "http://127.0.0.1:10005"
    publicRead: false
  cos:
    bucketURL: https://temp-1252357374.cos.ap-chengdu.myqcloud.com
@@ -153,6 +132,13 @@ object:
    accessKeySecret: ''
    sessionToken: ''
    publicRead: false
+  aws:
+    endpoint: "''" # This might not be necessary unless you're using a custom endpoint
+    region: "us-east-1"
+    bucket: "demo-9999999"
+    accessKeyID: ''
+    accessKeySecret: ''
+    publicRead: false

 ###################### RPC Port Configuration ######################
 # RPC service ports
@@ -193,7 +179,7 @@ rpcRegisterName:
 # Whether to output in json format
 # Whether to include stack trace in logs
 log:
-  storageLocation: /data/workspaces/open-im-server/logs/
+  storageLocation: /data/workspaces/open-im-server/_output/logs/
  rotationTime: 24
  remainRotationCount: 2
  remainLogLevel: 6
@@ -243,9 +229,18 @@ push:
 #
 # Built-in app manager user IDs
 # Built-in app manager nicknames
+# Attention, this configure is discarded. If you have used him before, configure your own
 manager:
-  userID: [ "openIM123456", "openIM654321", "openIMAdmin" ]
-  nickname: [ "system1", "system2", "system3" ]
+  userID:
+  nickname:
+
+# chatAdmin, use for send notification
+#
+# Built-in app system notification account ID
+# Built-in app system notification account nickname
+im-admin:
+  userID: [ "imAdmin" ]
+  nickname: [ "imAdmin" ]

 # Multi-platform login policy
 # For each platform(Android, iOS, Windows, Mac, web), only one can be online at a time
@@ -307,17 +302,17 @@ iosPush:
 # Timeout in seconds
 # Whether to continue execution if callback fails
 callback:
-  url: ""
+  url: "http://127.0.0.1:10008/callbackExample"
  beforeSendSingleMsg:
    enable: false
    timeout: 5
    failedContinue: true
  beforeUpdateUserInfoEx:
-    enable: false
+    enable:  false
    timeout: 5
    failedContinue: true
  afterUpdateUserInfoEx:
-    enable: false
+    enable:  false
    timeout: 5
    failedContinue: true
  afterSendSingleMsg:
@@ -505,8 +500,8 @@ callback:
 # The number of Prometheus ports per service needs to correspond to rpcPort
 # The number of ports needs to be consistent with msg_transfer_service_num in script/path_info.sh
 prometheus:
-  enable: false
-  grafanaUrl: 172.28.0.1:13000
+  enable: true
+  grafanaUrl: http://127.0.0.1:13000/
  apiPrometheusPort: [20100]
  userPrometheusPort: [ 20110 ]
  friendPrometheusPort: [ 20120 ]
@@ -519,3 +514,39 @@ prometheus:
  rtcPrometheusPort: [ 21300 ]
  thirdPrometheusPort: [ 21301 ]
  messageTransferPrometheusPort: [ 21400, 21401, 21402, 21403 ] # List of ports
+
+###################### LocalCache configuration information ######################
+# topic: redis subscriber channel
+# slotNum: number of slots, multiple slots can prevent too many keys from competing for a lock
+# slotSize: number of slots, the number of cached keys per slot, the overall cache quantity is slotNum * slotSize
+# successExpire: successful cache time seconds
+# failedExpire: failed cache time seconds
+# disable local caching and annotate topic, slotNum, and slotSize
+localCache:
+  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
@@ -1,4 +1,4 @@
-# Copyright © 2023 OpenIM. All rights reserved.
+# Copyright © 2024 OpenIM. All rights reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -12,31 +12,26 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.

-# ======================================
-# ========= Basic Configuration ========
-# ======================================
+# -----------------------------------------------------------------------------
+# General Configuration
+# This section contains general configuration options for the entire environment.
+# These options can be set via environment variables. If both environment variables 
+# and settings in this .env file exist, the environment variables take precedence.
+# -----------------------------------------------------------------------------
+# ==========================
+# General Configuration
+# ==========================
+# These settings apply to the overall environment.

-# The user for authentication or system operations.
-# Default: OPENIM_USER=root
-USER=root
-
-# Password associated with the specified user for authentication.
-# Default: PASSWORD=openIM123
-PASSWORD=openIM123
-
-# Base URL for the application programming interface (API).
-# Default: API_URL=http://172.28.0.1:10002
-API_URL=http://14.155.64.202:10002
-
-# Directory path for storing data files or related information.
-# Default: DATA_DIR=./
+# Data storage directory for persistent data.
+# Example: DATA_DIR=/path/to/data
 DATA_DIR=/data/workspaces/open-im-server

-# Choose the appropriate image address, the default is GITHUB image, 
-# you can choose docker hub, for Chinese users can choose Ali Cloud
-# export IMAGE_REGISTRY="ghcr.io/openimsdk"
-# export IMAGE_REGISTRY="openim"
-# export IMAGE_REGISTRY="registry.cn-hangzhou.aliyuncs.com/openimsdk"
+# Docker image registry. Uncomment the preferred one.
+# Options: ghcr.io/openimsdk, openim, registry.cn-hangzhou.aliyuncs.com/openimsdk
+# IMAGE_REGISTRY="ghcr.io/openimsdk"
+# IMAGE_REGISTRY="openim"
+# IMAGE_REGISTRY="registry.cn-hangzhou.aliyuncs.com/openimsdk"
 IMAGE_REGISTRY=ghcr.io/openimsdk

 # ======================================
@@ -47,10 +42,9 @@ IMAGE_REGISTRY=ghcr.io/openimsdk
 # Default: DOCKER_BRIDGE_SUBNET=172.28.0.0/16
 DOCKER_BRIDGE_SUBNET=172.28.0.0/16

-# Gateway for the Docker network.
-# Default: DOCKER_BRIDGE_GATEWAY=172.28.0.1
+# Set and specify the IP addresses of some containers. Generally speaking, 
+# you do not need to modify these configurations to facilitate debugging
 DOCKER_BRIDGE_GATEWAY=172.28.0.1
-
 MONGO_NETWORK_ADDRESS=172.28.0.2
 REDIS_NETWORK_ADDRESS=172.28.0.3
 KAFKA_NETWORK_ADDRESS=172.28.0.4
@@ -65,45 +59,67 @@ NODE_EXPORTER_NETWORK_ADDRESS=172.28.0.12
 OPENIM_ADMIN_FRONT_NETWORK_ADDRESS=172.28.0.13
 ALERT_MANAGER_NETWORK_ADDRESS=172.28.0.14

-# ===============================================
-# = Component Extension Configuration =
-# ===============================================
+# ==============================================================================
+# Configuration Update Instructions
+# ==============================================================================
+# This header outlines the methods to update common variables in config.yaml and .env files.
+# These instructions are vital for maintaining the OpenIM environment's configuration.
+#
+# METHOD 1: Regenerate All Configurations
+# ----------------------------------------
+# Use this method to regenerate all configurations.
+# Steps:
+#   1. Delete existing config files:
+#      - openim-server/config/config.yaml
+#      - openim-chat/config/config.yaml
+#   2. Modify the .env file as required.
+#   3. Run 'docker compose up -d'. This will regenerate:
+#       - config/config.yaml
+#
+# METHOD 2: Modify Individual Configuration Files
+# -----------------------------------------------
+# Use this method to update specific configuration files.
+# Steps:
+#   1. Modify the .env file as necessary.
+#   2. Update the corresponding entries in:
+#      - config/config.yaml
+#   3. Restart the services with 'docker compose up -d'.
+#   4. Special Note: If you modify OPENIM_IP, API_OPENIM_PORT, or MINIO_PORT in .env,
+#      ensure to update the corresponding services and configurations accordingly.
+#
+# It is essential to follow these methods to ensure consistent and correct application behavior.
+# ==============================================================================
+# Local IP address of the service. Modify if necessary.
+# Example: OPENIM_IP=172.28.0.1，
+OPENIM_IP=127.0.0.1

-# ============ Component Extension Configuration ==========
 # ----- ZooKeeper Configuration -----
-# Address or hostname for the ZooKeeper service.
-# Default: ZOOKEEPER_ADDRESS=172.28.0.1
-ZOOKEEPER_ADDRESS=172.28.0.5
-
 # Port for ZooKeeper service.
 # Default: ZOOKEEPER_PORT=12181
 ZOOKEEPER_PORT=12181

-# ----- MongoDB Configuration -----
-# Address or hostname for the MongoDB service.
-# Default: MONGO_ADDRESS=172.28.0.1
-MONGO_ADDRESS=172.28.0.2
-
-# Port on which MongoDB service is running.
+# MongoDB service port configuration.
 # Default: MONGO_PORT=37017
-# MONGO_PORT=37017
+MONGO_PORT=37017

-# Username to authenticate with the MongoDB service.
-# Default: MONGO_USERNAME=root
-# MONGO_USERNAME=root
-
-# Password to authenticate with the MongoDB service.
+# Password for MongoDB admin user. Used for service authentication.
 # Default: MONGO_PASSWORD=openIM123
 MONGO_PASSWORD=openIM123

-# Name of the database in MongoDB to be used.
-# Default: MONGO_DATABASE=openIM_v3
-MONGO_DATABASE=openIM_v3
+# Username for a regular OpenIM user in MongoDB.
+# Default: MONGO_OPENIM_USERNAME=openIM
+MONGO_OPENIM_USERNAME=openIM

+# Password for a regular OpenIM user in MongoDB.
+# Default: MONGO_OPENIM_PASSWORD=openIM123456
+MONGO_OPENIM_PASSWORD=openIM123
+
+# Specifies the database name to be used within MongoDB.
+# Default: MONGO_DATABASE=openim_v3
+MONGO_DATABASE=openim_v3
+
+MONGO_MAX_POOL_SIZE=100
 # ----- Redis Configuration -----
-# Address or hostname for the Redis service.
-# Default: REDIS_ADDRESS=172.28.0.1
-REDIS_ADDRESS=172.28.0.3

 # Port on which Redis in-memory data structure store is running.
 # Default: REDIS_PORT=16379
@@ -113,11 +129,6 @@ REDIS_PORT=16379
 # Default: REDIS_PASSWORD=openIM123
 REDIS_PASSWORD=openIM123

-# ----- Kafka Configuration -----
-# Address or hostname for the Kafka service.
-# Default: KAFKA_ADDRESS=172.28.0.1
-KAFKA_ADDRESS=172.28.0.4
-
 # Kakfa username to authenticate with the Kafka service.
 # KAFKA_USERNAME=''

@@ -129,20 +140,13 @@ KAFKA_PORT=19094
 # Default: KAFKA_LATESTMSG_REDIS_TOPIC=latestMsgToRedis
 KAFKA_LATESTMSG_REDIS_TOPIC=latestMsgToRedis

-# Topic in Kafka for pushing messages (e.g. notifications or updates).
-# Default: KAFKA_MSG_PUSH_TOPIC=msgToPush
-KAFKA_MSG_PUSH_TOPIC=msgToPush
-
-# Topic in Kafka for storing offline messages in MongoDB.
-# Default: KAFKA_OFFLINEMSG_MONGO_TOPIC=offlineMsgToMongoMysql
-KAFKA_OFFLINEMSG_MONGO_TOPIC=offlineMsgToMongoMysql
-
-# ----- MinIO Configuration ----
-# Address or hostname for the MinIO object storage service.
-# Default: MINIO_ADDRESS=172.28.0.1
-MINIO_ADDRESS=172.28.0.6
-
-# Port on which MinIO object storage service is running.
+# MINIO_PORT
+# ----------
+# MINIO_PORT sets the port for the MinIO object storage service.
+# Upon changing this port, the MinIO endpoint URLs in the config/config.yaml file must be updated
+# to reflect this change. The endpoints include both the 'endpoint' and 'signEndpoint' 
+# under the MinIO configuration.
+#
 # Default: MINIO_PORT=10005
 MINIO_PORT=10005

@@ -155,19 +159,11 @@ MINIO_PORT=10005
 MINIO_SECRET_KEY=openIM123

 # ----- Prometheus Configuration -----
-# Address or hostname for the Prometheus service.
-# Default: PROMETHEUS_ADDRESS=172.28.0.1
-PROMETHEUS_ADDRESS=172.28.0.10
-
 # Port on which Prometheus service is running.
 # Default: PROMETHEUS_PORT=19090
 PROMETHEUS_PORT=19090

 # ----- Grafana Configuration -----
-# Address or hostname for the Grafana service.
-# Default: GRAFANA_ADDRESS=172.28.0.1
-GRAFANA_ADDRESS=172.28.0.11
-
 # Port on which Grafana service is running.
 # Default: GRAFANA_PORT=13000
 GRAFANA_PORT=13000
@@ -176,56 +172,41 @@ GRAFANA_PORT=13000
 # ============ OpenIM Web ===============
 # ======================================

-# Path to the OpenIM web distribution.
-# Default: OPENIM_WEB_DIST_PATH=/app/dist
-OPENIM_WEB_DIST_PATH=/app/dist
-
 # Port on which OpenIM web service is running.
 # Default: OPENIM_WEB_PORT=11001
 OPENIM_WEB_PORT=11001

-# Address or hostname for the OpenIM web service.
-# Default: OPENIM_WEB_ADDRESS=172.28.0.1
-OPENIM_WEB_ADDRESS=172.28.0.7
-
 # ======================================
 # ========= OpenIM Server ==============
 # ======================================
-
-# Address or hostname for the OpenIM server.
-# Default: OPENIM_SERVER_ADDRESS=172.28.0.1
-OPENIM_SERVER_ADDRESS=172.28.0.8
-
 # Port for the OpenIM WebSockets.
 # Default: OPENIM_WS_PORT=10001
 OPENIM_WS_PORT=10001

-# Port for the OpenIM API.
+# API_OPENIM_PORT
+# ---------------
+# This variable defines the port on which the OpenIM API service will listen.
+# When changing this port, it's essential to update the apiURL in the config.yaml file
+# to ensure the API service is accessible at the new port.
+#
 # Default: API_OPENIM_PORT=10002
 API_OPENIM_PORT=10002

-
 # ======================================
 # ========== OpenIM Chat ===============
 # ======================================

 # Branch name for OpenIM chat.
 # Default: CHAT_IMAGE_VERSION=main
-# https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/version.md
 CHAT_IMAGE_VERSION=main

-# Address or hostname for the OpenIM chat service.
-# Default: OPENIM_CHAT_ADDRESS=172.28.0.1
-OPENIM_CHAT_ADDRESS=172.28.0.9
-
 # Port for the OpenIM chat API.
 # Default: OPENIM_CHAT_API_PORT=10008
 OPENIM_CHAT_API_PORT=10008

-# Directory path for storing data files or related information for OpenIM chat.
-# Default: OPENIM_CHAT_DATA_DIR=./openim-chat/main
-OPENIM_CHAT_DATA_DIR=./openim-chat/main
-
+# Port for the OpenIM admin API.
+# Default: OPENIM_ADMIN_API_PORT=10009
+OPENIM_ADMIN_API_PORT=10009

 # ======================================
 # ========== OpenIM Admin ==============
@@ -234,10 +215,6 @@ OPENIM_CHAT_DATA_DIR=./openim-chat/main
 # Branch name for OpenIM server.
 # Default: SERVER_IMAGE_VERSION=main
 SERVER_IMAGE_VERSION=main
-
-# Port for the OpenIM admin API.
-# Default: OPENIM_ADMIN_API_PORT=10009
-OPENIM_ADMIN_API_PORT=10009
  
 # Port for the node exporter.
 # Default: NODE_EXPORTER_PORT=19100
--- a/Show More
+++ b/Show More