feat: add openim images config path

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

.env

@@ -29,12 +29,12 @@ PASSWORD=openIM123
 MINIO_ENDPOINT=http://172.28.0.1:10005
 
 # Base URL for the application programming interface (API).
-# Default: API_URL=http://172.28.0.1:10002
-API_URL=http://14.155.86.214:10002
+# Default: API_URL=http://172.0.0.1:10002
+API_URL=http://172.0.0.1:10002
 
 # Directory path for storing data files or related information.
 # Default: DATA_DIR=./
-DATA_DIR=/root/workspaces/openim/Open-IM-Server
+DATA_DIR=./
 
 # Choose the appropriate image address, the default is GITHUB image, 
 # you can choose docker hub, for Chinese users can choose Ali Cloud

.github/workflows/api-test.yml

@@ -0,0 +1,90 @@
+# Copyright © 2023 OpenIM. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+name: OpenIM API TEST
+
+on: 
+  push:
+    branches:
+        - main
+    paths-ignore:
+        - "docs/**"
+        - "README.md"
+        - "README_zh-CN.md"
+        - "CONTRIBUTING.md"
+  pull_request:
+    branches:
+        - main
+    paths-ignore:
+        - "README.md"
+        - "README_zh-CN.md"
+        - "CONTRIBUTING.md"
+        - "docs/**"
+
+env:
+  GO_VERSION: "1.19"
+  GOLANGCI_VERSION: "v1.50.1"
+
+jobs:
+  execute-linux-systemd-scripts:
+    name: Execute OpenIM script on ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    environment:
+      name: openim
+    strategy:
+      matrix:
+        go_version: ["1.20"]
+        os: ["ubuntu-latest"]
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v4
+
+    - name: Set up Go ${{ matrix.go_version }}
+      uses: actions/setup-go@v4
+      with:
+        go-version: ${{ matrix.go_version }}
+      id: go
+
+    - name: Install Task
+      uses: arduino/setup-task@v1
+      with:
+        version: '3.x' # If available, use the latest major version that's compatible
+        repo-token: ${{ secrets.GITHUB_TOKEN }}
+
+    - name: Docker Operations
+      run: |
+        curl -o docker-compose.yml https://raw.githubusercontent.com/OpenIMSDK/openim-docker/main/example/basic-openim-server-dependency.yml
+        sudo docker compose up -d
+        sudo sleep 60
+
+    - name: Module Operations
+      run: |
+        sudo make tidy
+        sudo make tools.verify.go-gitlint
+
+    - name: Build, Start, Check Services and Print Logs
+      run: |
+        sudo ./scripts/install/install.sh -i && \
+        sudo ./scripts/install/install.sh -s && \
+        (echo "An error occurred, printing logs:" && sudo cat ./_output/logs/* 2>/dev/null)
+
+    - name: Run Test
+      run: |
+        sudo make test-api && \
+        (echo "An error occurred, printing logs:" && sudo cat ./_output/logs/* 2>/dev/null)
+
+    - name: Stop Services
+      run: |
+        sudo ./scripts/install/install.sh -u && \
+        (echo "An error occurred, printing logs:" && sudo cat ./_output/logs/* 2>/dev/null)

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

@@ -24,38 +24,49 @@ on:
     types: [created]
 
 jobs:
-  create-pr:
+  sync-issue-to-pr:
     runs-on: ubuntu-latest
-    if: github.event.pull_request.base.ref == 'main'
-    # && github.event.pull_request.merged == true
     steps:
-        - name: Check out code
-          uses: actions/checkout@v4
-          with:
-            fetch-depth: 0
+      - name: Checkout code
+        uses: actions/checkout@v2
+      
+      - name: Sync Issue to PR
+        if: github.event_name == 'pull_request' && github.event.pull_request.base.ref == 'main'
+        run: |
+          PR_BODY="${{ github.event.pull_request.body }}"
 
-        - name: Create PR to release branch
-          run: |
-            ISSUEID=$(gh pr view ${{ github.event.pull_request.number }} --repo $OWNER/$REPO | grep -oP 'Fixes #\K\d+')
-            echo "===========> $ISSUEID"
-            ISSUE=$(gh issue view $ISSUEID --repo $OWNER/$REPO --json labels,assignees,milestone,title)
-            echo "===========> $ISSUE"
+          ISSUE_NUMBER=$(echo "$PR_BODY" | grep -oP 'Fixes #\K\d+')
+          if [[ -z "$ISSUE_NUMBER" ]]; then
+            echo "No Issue number found."
+            exit 1
+          fi
 
-            LABELS=$(echo $ISSUE | jq -r '.labels[] | select(.name) | .name' | jq -R -r -s -c 'split("\n")[:-1] | join(",")')
-            ASSIGNEES=$(echo $ISSUE | jq -r '.assignees[] | select(.login) | .login' | jq -R -s -c 'split("\n")[:-1] | join(",")')
-            MILESTONE=$(echo $ISSUE | jq -r '.milestone | select(.title) | .title')
-            TITLE=$(echo $ISSUE | jq -r '.title')
+          echo "Issue number found: $ISSUE_NUMBER"
 
-            gh pr edit ${{ github.event.pull_request.number }} --repo $OWNER/$REPO --add-label "$LABELS" --add-assignee "$ASSIGNEES" --milestone "$MILESTONE"
+          # Using GitHub CLI to get issue details
+          gh issue view "$ISSUE_NUMBER" --repo "${{ github.repository }}" --json labels,assignees,milestone,title > issue_data.json
 
-            # git checkout -b bot/merge-to-release-$ISSUEID
-            # git push origin bot/merge-to-release-$ISSUEID
-            # gh pr create --base release --head bot/merge-to-release-$ISSUEID --title "Merge main to release" --body ""
-            # gh pr create --base main --head feat/auto-release-pr-624  --title "The bug is fixed" --body "$x" --repo openimsdk/open-im-server --reviewer "cubxxw"
-          continue-on-error: true
-          env:
-              GITHUB_TOKEN: ${{ secrets.BOT_GITHUB_TOKEN }}
-              GH_TOKEN: ${{ github.token }}
-              ISSUE: ${{ github.event.issue.html_url }}
-              OWNER: ${{ github.repository_owner }}
-              REPO: ${{ github.event.repository.name }}
+          # Check if jq is installed
+          if ! command -v jq &> /dev/null; then
+            echo "Installing jq..."
+            sudo apt-get install -y jq
+          fi
+
+          # Parse data with jq
+          LABELS=$(jq -r '.labels | map(.name) | join(",")' issue_data.json)
+          ASSIGNEES=$(jq -r '.assignees | map(.login) | join(",")' issue_data.json)
+          MILESTONE=$(jq -r '.milestone.title' issue_data.json)
+
+          # Check if any of the fields are empty and set them to None
+          LABELS=${LABELS:-None}
+          ASSIGNEES=${ASSIGNEES:-None}
+          MILESTONE=${MILESTONE:-None}
+
+          # Edit the PR with issue details, handling empty fields
+          gh pr edit "${{ github.event.pull_request.number }}" --repo "${{ github.repository }}" \
+            ${LABELS:+--add-label "$LABELS"} \
+            ${ASSIGNEES:+--add-assignee "$ASSIGNEES"} \
+            ${MILESTONE:+--milestone "$MILESTONE"}
+        continue-on-error: true
+        env:
+          GITHUB_TOKEN: ${{ secrets.BOT_GITHUB_TOKEN }}

.github/workflows/auto-invite.yml

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

.github/workflows/auto-tag.yml

@@ -12,7 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-name: Create Tag
+name: OpenIM Create Tag
 
 on:
   issue_comment:

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

@@ -12,7 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-name: 'Github Rebot for Cherry Pick when PR is merged'
+name: Github Rebot for Cherry Pick when PR is merged
 on:
   pull_request_target:
     types:

.github/workflows/check-coverage.yml

@@ -12,7 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-name: Check-Coverage
+name: OpenIM Check Coverage
 
 on:
   workflow_dispatch:

.github/workflows/cla.yml

@@ -12,7 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-name: "OpenIM CLA Assistant"
+name: OpenIM CLA Assistant
 on:
   issue_comment:
     types: [created]
@@ -33,7 +33,7 @@ env:
   OPEN_IM_SERVER_CLA_DOCUMENT: https://github.com/openim-sigs/cla/blob/main/README.md
   OPEN_IM_SERVER_SIGNATURES_PATH: signatures/${{ github.event.repository.name }}/cla.json
 
-  OPEN_IM_SERVER_ALLOWLIST: kubbot,bot* 
+  OPEN_IM_SERVER_ALLOWLIST: kubbot,bot*,bot-*,bot/*,bot-/*,bot,*[bot]
 
 jobs:
   CLAAssistant:

.github/workflows/create_branch_on_tag.yml

@@ -19,6 +19,10 @@ on:
     tags:
       - 'v*.*.0'
 
+permissions:
+  contents: write
+  actions: write
+
 jobs:
   create-branch:
     runs-on: ubuntu-latest
@@ -36,41 +40,38 @@ jobs:
     - name: Install git-chglog
       run: make install.git-chglog
 
-    - name: Create Branch
+    - name: Create Branch and Push
+      env:
+        TAG_NAME: ${{ github.ref_name }}
       run: |
-        TAG_NAME=${GITHUB_REF/refs\/tags\//}
         IFS='.' read -ra VERSION_PARTS <<< "$TAG_NAME"
         if [[ "${VERSION_PARTS[2]}" = "0" ]]; then
           BRANCH_NAME="release-v${VERSION_PARTS[0]}.${VERSION_PARTS[1]}"
           echo "Creating branch $BRANCH_NAME"
           git checkout -b "$BRANCH_NAME"
           git push origin "$BRANCH_NAME"
+        else
+          echo "Not a release tag. Skipping branch creation."
         fi
+      continue-on-error: true
 
-    - name: Push Changes
-      uses: stefanzweifel/git-auto-commit-action@v5
-      with:
-        commit_message: "Auto Commit CHANGELOG"
-        branch: release-v${VERSION_PARTS[0]}.${VERSION_PARTS[1]}
-      env:
-        GITHUB_TOKEN: ${{ secrets.BOT_GITHUB_TOKEN }}
-
-    - name: Create and Push CHANGELOG
+    - name: Create and Commit CHANGELOG
+      if: endsWith(github.ref_name, '.0')
       run: |
-        git checkout main
-        TAG_NAME=${GITHUB_REF/refs\/tags\//}
+        git fetch --all
+        TAG_NAME=${GITHUB_REF#refs/tags/}
         IFS='.' read -ra VERSION_PARTS <<< "$TAG_NAME"
-        if [[ "${VERSION_PARTS[2]}" = "0" ]]; then
-          cd CHANGELOG
-          git-chglog --tag-filter-pattern "v${VERSION_PARTS[0]}.${VERSION_PARTS[1]}.*"  -o "CHANGELOG-${VERSION_PARTS[0]}.${VERSION_PARTS[1]}.md"
-          git add "CHANGELOG-${VERSION_PARTS[0]}.${VERSION_PARTS[1]}.md"
-          git commit -m "Update CHANGELOG for $TAG_NAME"
-        fi
+        git checkout main
+        cd CHANGELOG
+        git-chglog --tag-filter-pattern "v${VERSION_PARTS[0]}.${VERSION_PARTS[1]}.*" -o "CHANGELOG-${VERSION_PARTS[0]}.${VERSION_PARTS[1]}.md"
+        git add "CHANGELOG-${VERSION_PARTS[0]}.${VERSION_PARTS[1]}.md"
+        git commit -m "Update CHANGELOG for $TAG_NAME" || echo "No changes to commit."
+      continue-on-error: true
 
-    - name: Push Changes
-      uses: stefanzweifel/git-auto-commit-action@v5
+    - name: Push CHANGELOG to Main
+      if: steps.create-and-commit-changelog.outputs.changes == 'true'
+      uses: ad-m/github-push-action@v0.6.0
       with:
-        commit_message: "Auto Commit CHANGELOG"
+        github_token: ${{ secrets.BOT_GITHUB_TOKEN }}
         branch: main
-      env:
-        GITHUB_TOKEN: ${{ secrets.BOT_GITHUB_TOKEN }}
+    continue-on-error: true

.github/workflows/deploy.yml

@@ -1,55 +0,0 @@
-# Copyright © 2023 OpenIM open source community. All rights reserved.
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-name: OpenIM Deploy for dev
-
-on:
-  push:
-    branches:
-      - 'devops' # Only for the dev branch
-      - 'main'
-    paths:
-      - '.github/workflows/*'
-      # - '__test__/**' # dev No immediate testing is required
-      - 'src/**'
-      - 'Dockerfile'
-      - 'docker-compose.yml'
-      - 'bin/*'
-
-jobs:
-  deploy-dev:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - name: executing remote ssh commands using password
-        uses: appleboy/ssh-action@v1.0.0
-        env:
-            OWNER: ${{ github.repository_owner }}
-            REPO: ${{ github.event.repository.name }}
-        with:
-          host: "${{ secrets.SG_M1_HOST }}, ${{ secrets.SG_N1_HOST }}, ${{ secrets.SG_N2_HOST}}"
-          username: ${{ secrets.SG_USERNAME }}
-          password: ${{ secrets.SG_PASSWORD }}
-          port: ${{ secrets.SG_PORT }}
-          envs: OWNER,REPO
-          script_stop: true
-          script: |
-            mkdir -p /test/openim
-            cd /test/openim
-            pwd;ls -al
-            echo "OWNER: $OWNER"
-            echo "REPO: $REPO"
-            git clone -b develop https://github.com/${OWNER}/${REPO}.git; cd ${REPO}
-            docker compose up -d
-        continue-on-error: true

.github/workflows/depsreview.yaml

@@ -2,7 +2,7 @@
 # Licensed under the MIT License (the "License");
 # you may not use this file except in compliance with the License.
 
-name: Dependency Review
+name: OpenIM Dependency Review
 on: [pull_request]
 
 permissions:

.github/workflows/e2e-test.yml

@@ -12,7 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-name: e2e
+name: OpenIM Linux System E2E Test
 
 on:
   workflow_dispatch:
@@ -41,4 +41,48 @@ jobs:
 
       - name: Create e2e test
         run: |
-          echo "...test e2e"
+          echo "...test e2e"
+
+  execute-linux-systemd-scripts:
+    name: Execute OpenIM script on ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    environment:
+      name: openim
+    strategy:
+      matrix:
+        go_version: ["1.20"]
+        os: ["ubuntu-latest"]
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v4
+
+    - name: Set up Go ${{ matrix.go_version }}
+      uses: actions/setup-go@v4
+      with:
+        go-version: ${{ matrix.go_version }}
+      id: go
+
+    - name: Install Task
+      uses: arduino/setup-task@v1
+      with:
+        version: '3.x' # If available, use the latest major version that's compatible
+        repo-token: ${{ secrets.GITHUB_TOKEN }}
+
+    - name: Docker Operations
+      run: |
+        curl -o docker-compose.yml https://raw.githubusercontent.com/OpenIMSDK/openim-docker/main/example/basic-openim-server-dependency.yml
+        sudo docker compose up -d
+        sudo sleep 60
+
+    - name: Module Operations
+      run: |
+        sudo make tidy
+        sudo make tools.verify.go-gitlint
+
+    - name: Build, Start, Test, Check Services and Print Logs
+      run: |
+        sudo ./scripts/install/install.sh -i && \
+        sudo make test-api && \
+        sudo ./scripts/install/install.sh -s && \
+        sudo ./scripts/install/install.sh -u || \
+        (echo "An error occurred, printing logs:" && sudo cat ./_output/logs/* 2>/dev/null)

.github/workflows/greetings.yml

@@ -12,7 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-name: first-interaction
+name: OpenIM First Interaction
 
 on:
   issues:

.github/workflows/issue-robot.yml

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

.github/workflows/opencommit.yml

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

.github/workflows/openimci.yml

@@ -64,7 +64,8 @@ jobs:
     - name: Install Task
       uses: arduino/setup-task@v1
       with:
-        version: 2.x
+        version: '3.x' # If available, use the latest major version that's compatible
+        repo-token: ${{ secrets.GITHUB_TOKEN }}
 
     - name: Module Operations
       run: |
@@ -122,7 +123,8 @@ jobs:
     - name: Install Task
       uses: arduino/setup-task@v1
       with:
-        version: 2.x
+        version: '3.x' # If available, use the latest major version that's compatible
+        repo-token: ${{ secrets.GITHUB_TOKEN }}
     - name: Run OpenIM make install start
       run: |
         sudo make install
@@ -145,10 +147,13 @@ jobs:
       with:
         go-version: ${{ matrix.go_version }}
       id: go
+
     - name: Install Task
       uses: arduino/setup-task@v1
       with:
-        version: 2.x
+        version: '3.x' # If available, use the latest major version that's compatible
+        repo-token: ${{ secrets.GITHUB_TOKEN }}
+
     - name: Docker Operations
       run: |
         curl -o docker-compose.yml https://raw.githubusercontent.com/OpenIMSDK/openim-docker/main/example/basic-openim-server-dependency.yml
@@ -160,18 +165,15 @@ jobs:
         sudo make tidy
         sudo make tools.verify.go-gitlint
 
-    - name: Build, Start and Check Services
+    - name: Build, Start, Check Services and Print Logs
       run: |
-        sudo make init
-        sudo make build
-        sudo make start
-        sudo make check
+        sudo make init && \
+        sudo make build && \
+        sudo make start && \
+        sudo make check || \
+        (echo "An error occurred, printing logs:" && sudo cat ./_output/logs/* 2>/dev/null)
 
-    - name: Print OpenIM Logs
-      run: sudo cat ./_output/logs/* 2>/dev/null
-      continue-on-error: true
-
-  openim-build-image:
+  openim-test-build-image:
     name: Build OpenIM Docker Image
     runs-on: ubuntu-latest
     environment:
@@ -184,10 +186,13 @@ jobs:
       with:
         go-version: ${{ matrix.go_version }}
       id: go
+
     - name: Install Task
       uses: arduino/setup-task@v1
       with:
-        version: 2.x
+        version: '3.x' # If available, use the latest major version that's compatible
+        repo-token: ${{ secrets.GITHUB_TOKEN }}
+
     - name: Test Docker Build
       run: |
         sudo make image

.github/workflows/pull-request.yml

@@ -41,8 +41,10 @@ jobs:
         run: |
           git config user.name 'openimbot'
           git config user.email 'openimsdk@qq.com'
-          git checkout -b cicd/patch-${{ github.event.number }}
-      - uses: actions/setup-node@v3
+          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
       - name: Run go modules tidy
@@ -50,6 +52,7 @@ jobs:
           sudo make tidy
           sudo make tools.verify.go-gitlint
           echo "Run go modules tidy successfully" 
+        continue-on-error: true
 
       - name: Run go format
         run: |
@@ -75,13 +78,8 @@ jobs:
           echo "Run unit test and get test coverage successfully" 
         continue-on-error: true
 
-    #   - name: Initialize CodeQL
-    #     uses: github/codeql-action/init@v2
-    #     with:
-    #       languages: go
-
-    #   - name: Perform CodeQL Analysis
-        # uses: github/codeql-action/analyze@v2
+      - name: Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@v2
 
       - name: OpenIM verify copyright
         run: |
@@ -89,31 +87,26 @@ jobs:
           sudo make add-copyright
           echo "OpenIM verify successfully" 
         continue-on-error: true
-      
-    #   - name: Commit code
-    #     run: |
-    #         git add .
-    #         git commit -m "cicd: bump League Patch to cicd/patch-${{ github.event.number }}"
-    
+
       - name: Create Pull Request
         uses: peter-evans/create-pull-request@v5
         with:
           token: ${{ secrets.BOT_GITHUB_TOKEN }}
-          commit-message: "cicd: bump League Patch to cicd/patch-${{ github.event.number }}"
-          title: Bump League Patch to cicd/patch-${{ github.event.number }}
+          commit-message: "cicd: bump League Patch"
           author: kubbot <kubbot@3293172751ysy@gmail.com>
           signoff: false
           draft: false
-          branch: "cicd/patch-${{ github.event.number }}"
+          branch: ''
           assignees: cubxxw
           reviewers: cubxxw
           delete-branch: true
+          title: "Bump League Patch auto PR: $(date +'%Y%m%d')"
           body: |
             Review criteria:
 
             - [ ] Disenchanter can connect and issue actions
             
-            This is an automated PR. @ ${{ github.actor }}
+            This is an automated PR. @ $(date +'%Y%m%d')
             <sub>[workflow](https://github.com/openimsdk/open-im-server/blob/main/.github/workflows/pull-request.yml).</sub>
           base: main
           labels: |

.github/workflows/scripts-verify.yml

@@ -1,76 +0,0 @@
-# Copyright © 2023 OpenIM. All rights reserved.
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-name: OpenIM executes the script validation code
-
-on: 
-  push:
-    branches:
-        - main
-    paths-ignore:
-        - "docs/**"
-        - "README.md"
-        - "README_zh-CN.md"
-        - "CONTRIBUTING.md"
-  pull_request:
-    branches:
-        - main
-    paths-ignore:
-        - "README.md"
-        - "README_zh-CN.md"
-        - "CONTRIBUTING.md"
-        - "docs/**"
-
-env:
-  GO_VERSION: "1.19"
-  GOLANGCI_VERSION: "v1.50.1"
-
-jobs:
-  openim:
-    name: Test with go ${{ matrix.go_version }} on ${{ matrix.os }}
-    runs-on: ${{ matrix.os }}
-    permissions:
-        contents: write
-    environment:
-      name: openim
-
-    strategy:
-      matrix:
-        go_version: ["1.21"]
-        os: [ubuntu-latest]
-
-    steps:
-    - name: Setup
-      uses: actions/checkout@v4
-      
-    - name: In ${{ matrix.os }} Execute the script validation code
-      uses: actions/setup-go@v4
-      with:
-        go-version: ${{ matrix.go_version }}
-      id: go
-
-    - name: scripts validation
-      run: |
-        sudo make verify
-      continue-on-error: true
-
-    - name: verify format
-      run: |
-        sudo make format
-      continue-on-error: true
-
-    - name: verify license
-      run: |
-        sudo make verify-copyright
-      continue-on-error: true

CHANGELOG/CHANGELOG.md

@@ -20,7 +20,7 @@ All notable changes to this project will be documented in this file.
 
 ## OpenIM versioning policy
 
-+ [OpenIM Version](../docs/conversions/version.md)
++ [OpenIM Version](../docs/contrib/version.md)
 
 ## command
 

CODE_OF_CONDUCT.md

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

CONTRIBUTING.md

@@ -42,6 +42,12 @@ If you are familiar with [Makefile](./Makefile) , you can easily see the clever
 
 The [Makefile](./Makefile) is for every developer, even if you don't know how to use the Makefile tool, don't worry, we provide two great commands to get you up to speed with the Makefile architecture, `make help` and `make help-all`, it can reduce problems of the developing environment.
 
+In accordance with the naming conventions adopted by OpenIM and drawing reference from the Google Naming Conventions as per the guidelines available at https://google.github.io/styleguide/go/, the following expectations for naming practices within the project are set forth: 
+
++ https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/code-conventions.md
++ https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/go-code.md
+
+
 ## Code of ConductCode of Conduct
 
 #### Code and doc contribution
@@ -186,7 +192,7 @@ We divide the problem into security and general problems:
 
 Security issues are always treated seriously. As our usual principle, we discourage anyone to spread security issues. If you find a security issue of Open-IM-Server, please do not discuss it in public and even do not open a public issue.
 
-Instead we encourage you to send us a private email to winxu81@gmail.com to report this.
+Instead we encourage you to send us a private email to info@openim.io to report this.
 
 #### Reporting general issues
 
@@ -270,7 +276,7 @@ You can find some very formal PR in [RFC](https://github.com/openimsdk/open-im-s
 **🈴 Reviewing PRs:**
 
 + Be respectful and constructive 
-+ Assign yourself to the PR 
++ Assign yourself to the PR (comment `/assign`)
 + Check if all checks are passing
 + Suggest changes instead of simply commenting on found issues
 + If you are unsure about something, ask the author
@@ -369,7 +375,7 @@ Our most recommended way to get in touch is through [Slack](https://join.slack.c
 In addition to Slack, we also offer the following ways to get in touch:
 
 + <a href="https://join.slack.com/t/openimsdk/shared_invite/zt-22720d66b-o_FvKxMTGXtcnnnHiMqe9Q" target="_blank"><img src="https://img.shields.io/badge/slack-%40OpenIMSDKCore-informational?logo=slack&style=flat-square"></a>:  We also have Slack channels for you to communicate and discuss. To join, visit https://slack.com/ and join our [👀 Open-IM-Server slack](https://join.slack.com/t/openimsdk/shared_invite/zt-22720d66b-o_FvKxMTGXtcnnnHiMqe9Q) team channel.
-+ <a href="https://mail.google.com/mail/u/0/?fs=1&tf=cm&to=4closetool3@gmail.com" target="_blank"><img src="https://img.shields.io/badge/gmail-%40OOpenIMSDKCore?style=social&logo=gmail"></a>: Get in touch with us on [Gmail](winxu81@gmail.com). If you have any questions or issues that need resolving, or any suggestions and feedback for our open source projects, please feel free to contact us via email.
++ <a href="https://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.
 

Makefile

@@ -6,7 +6,7 @@
 
 ## all: Run tidy, gen, add-copyright, format, lint, cover, build ✨
 .PHONY: all
-all: tidy gen add-copyright verify lint cover restart
+all: tidy gen add-copyright verify test-api lint cover restart
 
 # ==============================================================================
 # Build set
@@ -93,7 +93,7 @@ start:
 stop:
 	@$(MAKE) go.stop
 
-## restart: Restart openim ✨
+## restart: Restart openim (make init configuration file is initialized) ✨
 .PHONY: restart
 restart: clean stop build init start check
 
@@ -166,6 +166,11 @@ test:
 cover:
 	@$(MAKE) go.test.cover
 
+## test-api: Run api test. ✨
+.PHONY: test-api
+test-api:
+	@$(MAKE) go.test.api
+
 ## updates: Check for updates to go.mod dependencies. ✨
 .PHONY: updates
 	@$(MAKE) go.updates

README-zh_CN.md

@@ -86,22 +86,22 @@ OpenIM 我们的目标是建立一个顶级的开源社区。我们有一套标
 
 在开始之前，请确保你的更改是有需求的。最好的方法是创建一个[新的讨论](https://github.com/openimsdk/open-im-server/discussions/new/choose) 或 [Slack 通信](https://join.slack.com/t/openimsdk/shared_invite/zt-22720d66b-o_FvKxMTGXtcnnnHiMqe9Q)，或者如果你发现一个问题，首先[报告它](https://github.com/openimsdk/open-im-server/issues/new/choose)。
 
-+ [代码标准](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/go_code.md)
++ [代码标准](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/conversions/images.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/conversions/directory.md)
++ [目录标准](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/directory.md)
 
-+ [提交标准](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/commit.md)
++ [提交标准](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/commit.md)
 
-+ [版本控制标准](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/version.md)
++ [版本控制标准](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/version.md)
 
-+ [接口标准](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/interface.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/conversions/images.md) 以便使用国内 aliyun 的镜像地址。OpenIM 也有针对中国的 gitee 同步仓库，你可以在 [gitee.com](https://gitee.com/openimsdk) 上找到它。
+> 针对中国的用户，阅读我们的 [Docker 镜像标准](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/images.md) 以便使用国内 aliyun 的镜像地址。OpenIM 也有针对中国的 gitee 同步仓库，你可以在 [gitee.com](https://gitee.com/openimsdk) 上找到它。
 
 ## :link: 链接
 

README.md

@@ -4,30 +4,27 @@
     </a>
 </p>
 
-<h3 align="center" style="border-bottom: none">
-    ⭐️  Open source Instant Messaging Server ⭐️ <br>
-<h3>
+<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="https://goreportcard.com/report/github.com/openimsdk/open-im-server"><img src="https://goreportcard.com/badge/github.com/openimsdk/open-im-server" alt="A+"></a>
-<a href="https://github.com/openimsdk/open-im-server/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3A%22good+first+issue%22"><img src="https://img.shields.io/github/issues/openimsdk/open-im-server/good%20first%20issue?logo=%22github%22" alt="good first"></a>
-<a href="https://github.com/openimsdk/open-im-server"><img src="https://img.shields.io/github/stars/openimsdk/open-im-server.svg?style=flat&logo=github&colorB=deeppink&label=stars"></a>
-<a href="https://join.slack.com/t/openimsdk/shared_invite/zt-22720d66b-o_FvKxMTGXtcnnnHiMqe9Q"><img src="https://img.shields.io/badge/Slack-300%2B-blueviolet?logo=slack&amp;logoColor=white"></a>
-<a href="https://github.com/openimsdk/open-im-server/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-Apache--2.0-green"></a>
-<a href="https://golang.org/"><img src="https://img.shields.io/badge/Language-Go-blue.svg"></a>
-<a href="https://pkg.go.dev/github.com/openimsdk/open-im-server/v3"><img src="https://pkg.go.dev/badge/github.com/openimsdk/open-im-server/v3.svg" alt="Go Reference"></a>
-</p>
+[**English**](./README.md) •
+[**简体中文**](./README-zh_CN.md) •
+[**Docs**](https://openim.io/en)
+
+</div>
 
 </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>
 
 ## Ⓜ️ About OpenIM
 
@@ -61,7 +58,7 @@ It's crafted in Golang and supports cross-platform deployment, ensuring a cohere
 + **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://doc.rentsoft.cn/guides/introduction/product)**
+👉 **[Learn More](https://docs.openim.io/guides/introduction/product)**
 
 <!--
 
@@ -118,7 +115,7 @@ It is recommended to use Docker Compose for deployment, which can easily and qui
 
 > **Note**
 >
-> If you don't know OpenIM's versioning policy, 📚Read our release policy: https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/version.md
+> 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> 
@@ -133,7 +130,7 @@ Ur need `Go 1.20` or higher version, and `make`.
 go version && make --version || echo "Error: One of the commands failed."
 ```
 
-Version Details: https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/version.md
+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).
 
@@ -141,7 +138,7 @@ You can get the version number from the command below or from [github releases](
 $ curl --silent "https://api.github.com/repos/openimsdk/open-im-server/releases" | jq -r '.[].tag_name'
 ```
 
-We have our own version management policy, if you are interested in our version management, I recommend reading [📚 OpenIM Version](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/version.md), We recommend using stable versions such as `v3.3.0` and `v3.2.0` whenever possible. `v3.1.1-alpha.3` as well as `v3.3.0-beta.0` and `v3.2.0-rc.0` are pre-release or beta versions and are not recommended.
+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`:
 
@@ -179,8 +176,9 @@ Read: Configuration center document：https://github.com/openimsdk/open-im-serve
 </details> 
 -->
 
-+ **[Source Code Deployment Guide](https://doc.rentsoft.cn/guides/gettingStarted/imSourceCodeDeployment)**
-+ **[Docker Deployment Guide](https://doc.rentsoft.cn/guides/gettingStarted/dockerCompose)**
++ **[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)**
 
 <!-- 
@@ -198,21 +196,41 @@ Delve into the heart of Open-IM-Server's functionality with our architecture dia
 
 ## :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)
+
 OpenIM Our goal is to build a top-level open source community. We have a set of standards, in the [Community repository](https://github.com/OpenIMSDK/community).
 
 If you'd like to contribute to this Open-IM-Server repository, please read our [contributor documentation](https://github.com/openimsdk/open-im-server/blob/main/CONTRIBUTING.md).
 
 Before you start, please make sure your changes are in demand. The best for that is to create a [new discussion](https://github.com/openimsdk/open-im-server/discussions/new/choose) OR [Slack Communication](https://join.slack.com/t/openimsdk/shared_invite/zt-22720d66b-o_FvKxMTGXtcnnnHiMqe9Q), or if you find an issue, [report it](https://github.com/openimsdk/open-im-server/issues/new/choose) first.
 
-- [Code Standards](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/go_code.md)
-- [Docker Images Standards](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/images.md)
-- [Directory Standards](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/directory.md)
-- [Commit Standards](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/commit.md)
-- [Versioning Standards](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/version.md)
-- [Interface Standards](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/api.md)
-- [Log Standards](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/logging.md)
-- [Error Code Standards](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/error_code.md)
-- [OpenIM configuration and environment variable Settings](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/environment.md)
+- [OpenIM API Reference](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/api.md)
+- [OpenIM Bash Logging](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/bash-log.md)
+- [OpenIM CI/CD Actions](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/cicd-actions.md)
+- [OpenIM Code Conventions](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/code-conventions.md)
+- [OpenIM Commit Guidelines](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/commit.md)
+- [OpenIM Development Guide](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/development.md)
+- [OpenIM Directory Structure](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/directory.md)
+- [OpenIM Environment Setup](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/environment.md)
+- [OpenIM Error Code Reference](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/error-code.md)
+- [OpenIM Git Workflow](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/git-workflow.md)
+- [OpenIM Git Cherry Pick Guide](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/gitcherry-pick.md)
+- [OpenIM GitHub Workflow](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/github-workflow.md)
+- [OpenIM Go Code Standards](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/go-code.md)
+- [OpenIM Image Guidelines](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/images.md)
+- [OpenIM Initial Configuration](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/init-config.md)
+- [OpenIM Docker Installation Guide](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/install-docker.md)
+- [OpenIM OpenIM Linux System Installation](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/install-openim-linux-system.md)
+- [OpenIM Linux Development Guide](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/linux-development.md)
+- [OpenIM Local Actions Guide](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/local-actions.md)
+- [OpenIM Logging Conventions](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/logging.md)
+- [OpenIM Offline Deployment](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/offline-deployment.md)
+- [OpenIM Protoc Tools](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/protoc-tools.md)
+- [OpenIM Testing Guide](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/test.md)
+- [OpenIM Utility Go](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/util-go.md)
+- [OpenIM Makefile Utilities](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/util-makefile.md)
+- [OpenIM Script Utilities](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/util-scripts.md)
+- [OpenIM Versioning](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/version.md)
 
 
 ## :busts_in_silhouette: Community

build/images/Dockerfile

@@ -1,3 +1,17 @@
+# Copyright © 2023 OpenIM. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
 FROM BASE_IMAGE
 
 WORKDIR ${SERVER_WORKDIR}
@@ -5,6 +19,6 @@ WORKDIR ${SERVER_WORKDIR}
 # Set HTTP proxy
 ARG BINARY_NAME
 
-COPY BINARY_NAME ./BINARY_NAME
+COPY BINARY_NAME ./bin/BINARY_NAME
 
-ENTRYPOINT ["./BINARY_NAME"]
+ENTRYPOINT ["./bin/BINARY_NAME"]

build/images/openim-api/Dockerfile

@@ -21,7 +21,7 @@ FROM golang:1.20 AS builder
 ARG GO111MODULE=on
 ARG GOPROXY=https://goproxy.cn,direct
 
-WORKDIR /openim/openim-server/bin
+WORKDIR /openim/openim-server
 
 ENV GO111MODULE=$GO111MODULE
 ENV GOPROXY=$GOPROXY
@@ -38,8 +38,8 @@ RUN cp /openim/openim-server/_output/bin/platforms/$(go env GOOS)/$(go env GOARC
 # FROM ghcr.io/openim-sigs/openim-bash-image:latest
 FROM ghcr.io/openim-sigs/openim-bash-image:latest
 
-WORKDIR /openim/openim-server/bin
+WORKDIR /openim/openim-server
 
-COPY --from=builder /usr/bin/openim-api ./openim-api
+COPY --from=builder /usr/bin/openim-api ./bin/openim-api
 
-ENTRYPOINT ["./openim-api"]
+ENTRYPOINT ["./bin/openim-api"]

build/images/openim-cmdutils/Dockerfile

@@ -21,7 +21,7 @@ FROM golang:1.20 AS builder
 ARG GO111MODULE=on
 ARG GOPROXY=https://goproxy.cn,direct
 
-WORKDIR /openim/openim-server/bin
+WORKDIR /openim/openim-server
 
 ENV GO111MODULE=$GO111MODULE
 ENV GOPROXY=$GOPROXY
@@ -36,10 +36,10 @@ RUN cp /openim/openim-server/_output/bin/platforms/$(go env GOOS)/$(go env GOARC
 
 FROM ghcr.io/openim-sigs/openim-bash-image:latest
 
-WORKDIR /openim/openim-server/bin
+WORKDIR /openim/openim-server
 
-COPY --from=builder /usr/bin/openim-cmdutils ./openim-cmdutils
+COPY --from=builder /usr/bin/openim-cmdutils ./bin/openim-cmdutils
 
-ENTRYPOINT ["./openim-cmdutils"]
+ENTRYPOINT ["./bin/openim-cmdutils"]
 
 CMD ["--help"]

build/images/openim-crontask/Dockerfile

@@ -21,7 +21,7 @@ FROM golang:1.20 AS builder
 ARG GO111MODULE=on
 ARG GOPROXY=https://goproxy.cn,direct
 
-WORKDIR /openim/openim-server/bin
+WORKDIR /openim/openim-server
 
 ENV GO111MODULE=$GO111MODULE
 ENV GOPROXY=$GOPROXY
@@ -38,8 +38,8 @@ RUN cp /openim/openim-server/_output/bin/platforms/$(go env GOOS)/$(go env GOARC
 # FROM ghcr.io/openim-sigs/openim-bash-image:latest
 FROM ghcr.io/openim-sigs/openim-bash-image:latest
 
-WORKDIR /openim/openim-server/bin
+WORKDIR /openim/openim-server
 
-COPY --from=builder /usr/bin/openim-crontask ./openim-crontask
+COPY --from=builder /usr/bin/openim-crontask ./bin/openim-crontask
 
-ENTRYPOINT ["./openim-crontask"]
+ENTRYPOINT ["./bin/openim-crontask"]

build/images/openim-msggateway/Dockerfile

@@ -21,7 +21,7 @@ FROM golang:1.20 AS builder
 ARG GO111MODULE=on
 ARG GOPROXY=https://goproxy.cn,direct
 
-WORKDIR /openim/openim-server/bin
+WORKDIR /openim/openim-server
 
 ENV GO111MODULE=$GO111MODULE
 ENV GOPROXY=$GOPROXY
@@ -38,8 +38,8 @@ RUN cp /openim/openim-server/_output/bin/platforms/$(go env GOOS)/$(go env GOARC
 # FROM ghcr.io/openim-sigs/openim-bash-image:latest
 FROM ghcr.io/openim-sigs/openim-bash-image:latest
 
-WORKDIR /openim/openim-server/bin
+WORKDIR /openim/openim-server
 
-COPY --from=builder /usr/bin/openim-msggateway ./openim-msggateway
+COPY --from=builder /usr/bin/openim-msggateway ./bin/openim-msggateway
 
-ENTRYPOINT ["./openim-msggateway"]
+ENTRYPOINT ["./bin/openim-msggateway"]

build/images/openim-msgtransfer/Dockerfile

@@ -21,7 +21,7 @@ FROM golang:1.20 AS builder
 ARG GO111MODULE=on
 ARG GOPROXY=https://goproxy.cn,direct
 
-WORKDIR /openim/openim-server/bin
+WORKDIR /openim/openim-server
 
 ENV GO111MODULE=$GO111MODULE
 ENV GOPROXY=$GOPROXY
@@ -38,8 +38,8 @@ RUN cp /openim/openim-server/_output/bin/platforms/$(go env GOOS)/$(go env GOARC
 # FROM ghcr.io/openim-sigs/openim-bash-image:latest
 FROM ghcr.io/openim-sigs/openim-bash-image:latest
 
-WORKDIR /openim/openim-server/bin
+WORKDIR /openim/openim-server
 
-COPY --from=builder /usr/bin/openim-msgtransfer ./openim-msgtransfer
+COPY --from=builder /usr/bin/openim-msgtransfer ./bin/openim-msgtransfer
 
-ENTRYPOINT ["./openim-msgtransfer"]
+ENTRYPOINT ["./bin/openim-msgtransfer"]

build/images/openim-push/Dockerfile

@@ -21,7 +21,7 @@ FROM golang:1.20 AS builder
 ARG GO111MODULE=on
 ARG GOPROXY=https://goproxy.cn,direct
 
-WORKDIR /openim/openim-server/bin
+WORKDIR /openim/openim-server
 
 ENV GO111MODULE=$GO111MODULE
 ENV GOPROXY=$GOPROXY
@@ -38,8 +38,8 @@ RUN cp /openim/openim-server/_output/bin/platforms/$(go env GOOS)/$(go env GOARC
 # FROM ghcr.io/openim-sigs/openim-bash-image:latest
 FROM ghcr.io/openim-sigs/openim-bash-image:latest
 
-WORKDIR /openim/openim-server/bin
+WORKDIR /openim/openim-server
 
-COPY --from=builder /usr/bin/openim-push ./openim-push
+COPY --from=builder /usr/bin/openim-push ./bin/openim-push
 
-ENTRYPOINT ["./openim-push"]
+ENTRYPOINT ["./bin/openim-push"]

build/images/openim-rpc-auth/Dockerfile

@@ -21,7 +21,7 @@ FROM golang:1.20 AS builder
 ARG GO111MODULE=on
 ARG GOPROXY=https://goproxy.cn,direct
 
-WORKDIR /openim/openim-server/bin
+WORKDIR /openim/openim-server
 
 ENV GO111MODULE=$GO111MODULE
 ENV GOPROXY=$GOPROXY
@@ -38,8 +38,8 @@ RUN cp /openim/openim-server/_output/bin/platforms/$(go env GOOS)/$(go env GOARC
 # FROM ghcr.io/openim-sigs/openim-bash-image:latest
 FROM ghcr.io/openim-sigs/openim-bash-image:latest
 
-WORKDIR /openim/openim-server/bin
+WORKDIR /openim/openim-server
 
-COPY --from=builder /usr/bin/openim-rpc-auth ./openim-rpc-auth
+COPY --from=builder /usr/bin/openim-rpc-auth ./bin/openim-rpc-auth
 
-ENTRYPOINT ["./openim-rpc-auth"]
+ENTRYPOINT ["./bin/openim-rpc-auth"]

build/images/openim-rpc-conversation/Dockerfile

@@ -21,7 +21,7 @@ FROM golang:1.20 AS builder
 ARG GO111MODULE=on
 ARG GOPROXY=https://goproxy.cn,direct
 
-WORKDIR /openim/openim-server/bin
+WORKDIR /openim/openim-server
 
 ENV GO111MODULE=$GO111MODULE
 ENV GOPROXY=$GOPROXY
@@ -38,8 +38,8 @@ RUN cp /openim/openim-server/_output/bin/platforms/$(go env GOOS)/$(go env GOARC
 # FROM ghcr.io/openim-sigs/openim-bash-image:latest
 FROM ghcr.io/openim-sigs/openim-bash-image:latest
 
-WORKDIR /openim/openim-server/bin
+WORKDIR /openim/openim-server
 
-COPY --from=builder /usr/bin/openim-rpc-conversation ./openim-rpc-conversation
+COPY --from=builder /usr/bin/openim-rpc-conversation ./bin/openim-rpc-conversation
 
-ENTRYPOINT ["./openim-rpc-conversation"]
+ENTRYPOINT ["./bin/openim-rpc-conversation"]

build/images/openim-rpc-friend/Dockerfile

@@ -21,7 +21,7 @@ FROM golang:1.20 AS builder
 ARG GO111MODULE=on
 ARG GOPROXY=https://goproxy.cn,direct
 
-WORKDIR /openim/openim-server/bin
+WORKDIR /openim/openim-server
 
 ENV GO111MODULE=$GO111MODULE
 ENV GOPROXY=$GOPROXY
@@ -38,8 +38,8 @@ RUN cp /openim/openim-server/_output/bin/platforms/$(go env GOOS)/$(go env GOARC
 # FROM ghcr.io/openim-sigs/openim-bash-image:latest
 FROM ghcr.io/openim-sigs/openim-bash-image:latest
 
-WORKDIR /openim/openim-server/bin
+WORKDIR /openim/openim-server
 
-COPY --from=builder /usr/bin/openim-rpc-friend ./openim-rpc-friend
+COPY --from=builder /usr/bin/openim-rpc-friend ./bin/openim-rpc-friend
 
-ENTRYPOINT ["./openim-rpc-friend"]
+ENTRYPOINT ["./bin/openim-rpc-friend"]

build/images/openim-rpc-group/Dockerfile

@@ -21,7 +21,7 @@ FROM golang:1.20 AS builder
 ARG GO111MODULE=on
 ARG GOPROXY=https://goproxy.cn,direct
 
-WORKDIR /openim/openim-server/bin
+WORKDIR /openim/openim-server
 
 ENV GO111MODULE=$GO111MODULE
 ENV GOPROXY=$GOPROXY
@@ -38,8 +38,8 @@ RUN cp /openim/openim-server/_output/bin/platforms/$(go env GOOS)/$(go env GOARC
 # FROM ghcr.io/openim-sigs/openim-bash-image:latest
 FROM ghcr.io/openim-sigs/openim-bash-image:latest
 
-WORKDIR /openim/openim-server/bin
+WORKDIR /openim/openim-server
 
-COPY --from=builder /usr/bin/openim-rpc-group ./openim-rpc-group
+COPY --from=builder /usr/bin/openim-rpc-group ./bin/openim-rpc-group
 
-ENTRYPOINT ["./openim-rpc-group"]
+ENTRYPOINT ["./bin/openim-rpc-group"]

build/images/openim-rpc-msg/Dockerfile

@@ -21,7 +21,7 @@ FROM golang:1.20 AS builder
 ARG GO111MODULE=on
 ARG GOPROXY=https://goproxy.cn,direct
 
-WORKDIR /openim/openim-server/bin
+WORKDIR /openim/openim-server
 
 ENV GO111MODULE=$GO111MODULE
 ENV GOPROXY=$GOPROXY
@@ -38,8 +38,8 @@ RUN cp /openim/openim-server/_output/bin/platforms/$(go env GOOS)/$(go env GOARC
 # FROM ghcr.io/openim-sigs/openim-bash-image:latest
 FROM ghcr.io/openim-sigs/openim-bash-image:latest
 
-WORKDIR /openim/openim-server/bin
+WORKDIR /openim/openim-server
 
-COPY --from=builder /usr/bin/openim-rpc-msg ./openim-rpc-msg
+COPY --from=builder /usr/bin/openim-rpc-msg ./bin/openim-rpc-msg
 
-ENTRYPOINT ["./openim-rpc-msg"]
+ENTRYPOINT ["./bin/openim-rpc-msg"]

build/images/openim-rpc-third/Dockerfile

@@ -21,7 +21,7 @@ FROM golang:1.20 AS builder
 ARG GO111MODULE=on
 ARG GOPROXY=https://goproxy.cn,direct
 
-WORKDIR /openim/openim-server/bin
+WORKDIR /openim/openim-server
 
 ENV GO111MODULE=$GO111MODULE
 ENV GOPROXY=$GOPROXY
@@ -38,8 +38,8 @@ RUN cp /openim/openim-server/_output/bin/platforms/$(go env GOOS)/$(go env GOARC
 # FROM ghcr.io/openim-sigs/openim-bash-image:latest
 FROM ghcr.io/openim-sigs/openim-bash-image:latest
 
-WORKDIR /openim/openim-server/bin
+WORKDIR /openim/openim-server
 
-COPY --from=builder /usr/bin/openim-rpc-third ./openim-rpc-third
+COPY --from=builder /usr/bin/openim-rpc-third ./bin/openim-rpc-third
 
-ENTRYPOINT ["./openim-rpc-third"]
+ENTRYPOINT ["./bin/openim-rpc-third"]

build/images/openim-rpc-user/Dockerfile

@@ -21,7 +21,7 @@ FROM golang:1.20 AS builder
 ARG GO111MODULE=on
 ARG GOPROXY=https://goproxy.cn,direct
 
-WORKDIR /openim/openim-server/bin
+WORKDIR /openim/openim-server
 
 ENV GO111MODULE=$GO111MODULE
 ENV GOPROXY=$GOPROXY
@@ -38,8 +38,8 @@ RUN cp /openim/openim-server/_output/bin/platforms/$(go env GOOS)/$(go env GOARC
 # FROM ghcr.io/openim-sigs/openim-bash-image:latest
 FROM ghcr.io/openim-sigs/openim-bash-image:latest
 
-WORKDIR /openim/openim-server/bin
+WORKDIR /openim/openim-server
 
-COPY --from=builder /usr/bin/openim-rpc-user ./openim-rpc-user
+COPY --from=builder /usr/bin/openim-rpc-user ./bin/openim-rpc-user
 
-ENTRYPOINT ["./openim-rpc-user"]
+ENTRYPOINT ["./bin/openim-rpc-user"]

build/images/openim-tools/component/Dockerfile

@@ -21,7 +21,7 @@ FROM golang:1.20 AS builder
 ARG GO111MODULE=on
 ARG GOPROXY=https://goproxy.cn,direct
 
-WORKDIR /openim/openim-server/bin
+WORKDIR /openim/openim-server
 
 ENV GO111MODULE=$GO111MODULE
 ENV GOPROXY=$GOPROXY
@@ -37,7 +37,7 @@ RUN make build BINS=component
 # FROM ghcr.io/openim-sigs/openim-bash-image:latest
 FROM ghcr.io/openim-sigs/openim-bash-image:latest
 
-WORKDIR /openim/openim-server/bin
+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/config /openim/openim-server/config

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

@@ -21,7 +21,7 @@ FROM golang:1.20 AS builder
 ARG GO111MODULE=on
 ARG GOPROXY=https://goproxy.cn,direct
 
-WORKDIR /openim/openim-server/bin
+WORKDIR /openim/openim-server
 
 ENV GO111MODULE=$GO111MODULE
 ENV GOPROXY=$GOPROXY
@@ -42,7 +42,7 @@ RUN make build BINS=openim-web
 
 FROM ghcr.io/openim-sigs/openim-ubuntu-image:latest
 
-WORKDIR /openim/openim-server/bin
+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

cmd/openim-api/main.go

@@ -21,11 +21,15 @@ import (
 	_ "net/http/pprof"
 	"strconv"
 
-	"github.com/openimsdk/open-im-server/v3/pkg/common/discovery_register"
+	ginProm "github.com/openimsdk/open-im-server/v3/pkg/common/ginprom"
+	"github.com/openimsdk/open-im-server/v3/pkg/common/metrics"
+
+	"github.com/openimsdk/open-im-server/v3/pkg/common/kdisc"
 
 	"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"
@@ -42,11 +46,11 @@ func main() {
 	}
 }
 
-func run(port int) error {
-	log.ZInfo(context.Background(), "Openim api port:", "port", port)
+func run(port int, proPort int) error {
+	log.ZInfo(context.Background(), "Openim api port:", "port", port, "proPort", proPort)
 
-	if port == 0 {
-		err := "port is empty"
+	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)
@@ -62,7 +66,7 @@ func run(port int) error {
 	var client discoveryregistry.SvcDiscoveryRegistry
 
 	// Determine whether zk is passed according to whether it is a clustered deployment
-	client, err = discovery_register.NewDiscoveryRegister(config.Config.Envs.Discovery)
+	client, err = kdisc.NewDiscoveryRegister(config.Config.Envs.Discovery)
 	if err != nil {
 		log.ZError(context.Background(), "Failed to initialize discovery register", err)
 
@@ -81,6 +85,13 @@ func run(port int) error {
 	}
 	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", metrics.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 != "" {

cmd/openim-msgtransfer/main.go

@@ -21,6 +21,7 @@ import (
 func main() {
 	msgTransferCmd := cmd.NewMsgTransferCmd()
 	msgTransferCmd.AddPrometheusPortFlag()
+	msgTransferCmd.AddTransferProgressFlag()
 	if err := msgTransferCmd.Exec(); err != nil {
 		panic(err.Error())
 	}

config/config.yaml

@@ -135,14 +135,14 @@ api:
 # minio.signEndpoint is minio public network address
 object:
   enable: "minio"
-  apiURL: "http://14.155.86.214: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.86.214:10005"
+    signEndpoint: "http://127.0.0.1:10005"
     publicRead: false
   cos:
     bucketURL: https://temp-1252357374.cos.ap-chengdu.myqcloud.com
@@ -198,7 +198,7 @@ rpcRegisterName:
 # Whether to output in json format
 # Whether to include stack trace in logs
 log:
-  storageLocation: /root/workspaces/openim/Open-IM-Server/logs/
+  storageLocation: ./logs/
   rotationTime: 24
   remainRotationCount: 2
   remainLogLevel: 6
@@ -382,7 +382,9 @@ 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
+  enable: true
+  prometheusUrl: "https://openim.prometheus"
+  apiPrometheusPort: [20100]
   userPrometheusPort: [ 20110 ]
   friendPrometheusPort: [ 20120 ]
   messagePrometheusPort: [ 20130 ]

deployments/README.md

@@ -106,7 +106,7 @@ $ helm repo add brigade https://openimsdk.github.io/openim-charts
 
 ### OpenIM Image Strategy
 
-Automated offerings include aliyun, ghcr, docker hub: [Image Documentation](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/images.md)
+Automated offerings include aliyun, ghcr, docker hub: [Image Documentation](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/images.md)
 
 **Local Test Build Method:**
 
@@ -121,15 +121,27 @@ $ make image
 Explore our Helm-Charts repository and read through: [Helm-Charts Repository](https://github.com/openimsdk/helm-charts)
 
 
+Using the helm charts repository, you can ignore the following configuration, but if you want to just use the server and scale on top of it, you can go ahead:
+
 **Use Helmfile:**
 
 ```bash
 GO111MODULE=on go get github.com/roboll/helmfile@latest
 ```
 
-**Install OpenIM:**
-
 ```bash
+export MYSQL_ADDRESS=im-mysql
+export MYSQL_PORT=3306
+export MONGO_ADDRESS=im-mongo
+export MONGO_PORT=27017
+export REDIS_ADDRESS=im-redis-master
+export REDIS_PORT=6379
+export KAFKA_ADDRESS=im-kafka
+export KAFKA_PORT=9092
+export OBJECT_APIURL="https://openim.server.com/api"
+export MINIO_ENDPOINT="http://im-minio:9000"
+export MINIO_SIGN_ENDPOINT="https://openim.server.com/im-minio-api"
+
 mkdir ./charts/generated-configs
 ../scripts/genconfig.sh ../scripts/install/environment.sh ./templates/openim.yaml > ./charts/generated-configs/config.yaml
 cp ../config/notification.yaml ./charts/generated-configs/notification.yaml

deployments/charts/helmfile.yaml

@@ -1,94 +1,20 @@
-repositories:
-  - name: stable
-    url: https://charts.helm.sh/stable
+{{- define "defaultValues" -}}
+- ./generated-configs/helm-image.yaml
+- ./generated-configs/config.yaml
+- ./generated-configs/notification.yaml
+{{- end -}}
+
+{{- define "defaultRelease" -}}
+namespace: openim
+chart: ./{{ .name }}
+values:
+  - ./{{ .name }}/values.yaml
+  {{- template "defaultValues" . }}
+{{- end -}}
 
 releases:
-  - name: openim-api
-    namespace: openim
-    chart: ./openim-api
-    values:
-      - openim-api/values.yaml
-      - generated-configs/helm-image.yaml
-      - generated-configs/config.yaml
-      - generated-configs/notification.yaml
-  - name: openim-msggateway
-    namespace: openim
-    chart: ./openim-msggateway
-    values:
-      - openim-msggateway/values.yaml
-      - generated-configs/helm-image.yaml
-      - generated-configs/config.yaml
-      - generated-configs/notification.yaml
-  - name: openim-msgtransfer
-    namespace: openim
-    chart: ./openim-msgtransfer
-    values:
-      - openim-msgtransfer/values.yaml
-      - generated-configs/helm-image.yaml
-      - generated-configs/config.yaml
-      - generated-configs/notification.yaml
-  - name: openim-push
-    namespace: openim
-    chart: ./openim-push
-    values:
-      - openim-push/values.yaml
-      - generated-configs/helm-image.yaml
-      - generated-configs/config.yaml
-      - generated-configs/notification.yaml
-
-  - name: openim-rpc-auth
-    namespace: openim
-    chart: ./openim-rpc-auth
-    values:
-      - openim-rpc-auth/values.yaml
-      - generated-configs/helm-image.yaml
-      - generated-configs/config.yaml
-      - generated-configs/notification.yaml
-  - name: openim-rpc-conversation
-    namespace: openim
-    chart: ./openim-rpc-conversation
-    values:
-      - openim-rpc-conversation/values.yaml
-      - generated-configs/helm-image.yaml
-      - generated-configs/config.yaml
-      - generated-configs/notification.yaml
-  - name: openim-rpc-friend
-    namespace: openim
-    chart: ./openim-rpc-friend
-    values:
-      - openim-rpc-friend/values.yaml
-      - generated-configs/helm-image.yaml
-      - generated-configs/config.yaml
-      - generated-configs/notification.yaml
-  - name: openim-rpc-group
-    namespace: openim
-    chart: ./openim-rpc-group
-    values:
-      - openim-rpc-group/values.yaml
-      - generated-configs/helm-image.yaml
-      - generated-configs/config.yaml
-      - generated-configs/notification.yaml
-  - name: openim-rpc-msg
-    namespace: openim
-    chart: ./openim-rpc-msg
-    values:
-      - openim-rpc-msg/values.yaml
-      - generated-configs/helm-image.yaml
-      - generated-configs/config.yaml
-      - generated-configs/notification.yaml
-  - name: openim-rpc-third
-    namespace: openim
-    chart: ./openim-rpc-third
-    values:
-      - openim-rpc-third/values.yaml
-      - generated-configs/helm-image.yaml
-      - generated-configs/config.yaml
-      - generated-configs/notification.yaml
-  - name: openim-rpc-user
-    namespace: openim
-    chart: ./openim-rpc-user
-    values:
-      - openim-rpc-user/values.yaml
-      - generated-configs/helm-image.yaml
-      - generated-configs/config.yaml
-      - generated-configs/notification.yaml
+{{- $apps := list "openim-api" "openim-msggateway" "openim-msgtransfer" "openim-push" "openim-rpc-auth" "openim-rpc-conversation" "openim-rpc-friend" "openim-rpc-group" "openim-rpc-msg" "openim-rpc-third" "openim-rpc-user" }}
+{{- range $app := $apps }}
+  - name: {{ $app }}
+    {{- template "defaultRelease" dict "name" $app }}
+{{- end }}

deployments/charts/openim-api/templates/deployment.yaml

@@ -48,10 +48,10 @@ spec:
           resources:
             {{- toYaml .Values.resources | nindent 12 }}
           volumeMounts:
-            - mountPath: /oepnim/openim-server/config/config.yaml
+            - mountPath: /openim/openim-server/config/config.yaml
               name: config
               subPath: config.yaml
-            - mountPath: /oepnim/openim-server/config/notification.yaml
+            - mountPath: /openim/openim-server/config/
               name: config
               subPath: notification.yaml
       volumes:

deployments/charts/openim-msggateway/templates/deployment.yaml

@@ -1,3 +1,17 @@
+# Copyright © 2023 OpenIM. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
 apiVersion: apps/v1
 kind: Deployment
 metadata:
@@ -51,10 +65,10 @@ spec:
           resources:
             {{- toYaml .Values.resources | nindent 12 }}
           volumeMounts:
-            - mountPath: /oepnim/openim-server/config/config.yaml
+            - mountPath: /openim/openim-server/config/config.yaml
               name: config
               subPath: config.yaml
-            - mountPath: /oepnim/openim-server/config/notification.yaml
+            - mountPath: /openim/openim-server/config/
               name: config
               subPath: notification.yaml
       volumes:

deployments/charts/openim-msgtransfer/templates/deployment.yaml

@@ -48,10 +48,10 @@ spec:
           resources:
             {{- toYaml .Values.resources | nindent 12 }}
           volumeMounts:
-            - mountPath: /oepnim/openim-server/config/config.yaml
+            - mountPath: /openim/openim-server/config/config.yaml
               name: config
               subPath: config.yaml
-            - mountPath: /oepnim/openim-server/config/notification.yaml
+            - mountPath: /openim/openim-server/config/
               name: config
               subPath: notification.yaml
       volumes:

deployments/charts/openim-push/templates/deployment.yaml

@@ -48,10 +48,10 @@ spec:
           resources:
             {{- toYaml .Values.resources | nindent 12 }}
           volumeMounts:
-            - mountPath: /oepnim/openim-server/config/config.yaml
+            - mountPath: /openim/openim-server/config/config.yaml
               name: config
               subPath: config.yaml
-            - mountPath: /oepnim/openim-server/config/notification.yaml
+            - mountPath: /openim/openim-server/config/
               name: config
               subPath: notification.yaml
       volumes:

deployments/charts/openim-rpc-auth/templates/deployment.yaml

@@ -48,10 +48,10 @@ spec:
           resources:
             {{- toYaml .Values.resources | nindent 12 }}
           volumeMounts:
-            - mountPath: /oepnim/openim-server/config/config.yaml
+            - mountPath: /openim/openim-server/config/config.yaml
               name: config
               subPath: config.yaml
-            - mountPath: /oepnim/openim-server/config/notification.yaml
+            - mountPath: /openim/openim-server/config/
               name: config
               subPath: notification.yaml
       volumes:

deployments/charts/openim-rpc-conversation/templates/deployment.yaml

@@ -48,10 +48,10 @@ spec:
           resources:
             {{- toYaml .Values.resources | nindent 12 }}
           volumeMounts:
-            - mountPath: /oepnim/openim-server/config/config.yaml
+            - mountPath: /openim/openim-server/config/config.yaml
               name: config
               subPath: config.yaml
-            - mountPath: /oepnim/openim-server/config/notification.yaml
+            - mountPath: /openim/openim-server/config/
               name: config
               subPath: notification.yaml
       volumes:

deployments/charts/openim-rpc-friend/templates/deployment.yaml

@@ -48,10 +48,10 @@ spec:
           resources:
             {{- toYaml .Values.resources | nindent 12 }}
           volumeMounts:
-            - mountPath: /oepnim/openim-server/config/config.yaml
+            - mountPath: /openim/openim-server/config/config.yaml
               name: config
               subPath: config.yaml
-            - mountPath: /oepnim/openim-server/config/notification.yaml
+            - mountPath: /openim/openim-server/config/
               name: config
               subPath: notification.yaml
       volumes:

deployments/charts/openim-rpc-group/templates/deployment.yaml

@@ -48,10 +48,10 @@ spec:
           resources:
             {{- toYaml .Values.resources | nindent 12 }}
           volumeMounts:
-            - mountPath: /oepnim/openim-server/config/config.yaml
+            - mountPath: /openim/openim-server/config/config.yaml
               name: config
               subPath: config.yaml
-            - mountPath: /oepnim/openim-server/config/notification.yaml
+            - mountPath: /openim/openim-server/config/
               name: config
               subPath: notification.yaml
       volumes:

deployments/charts/openim-rpc-msg/templates/deployment.yaml

@@ -48,10 +48,10 @@ spec:
           resources:
             {{- toYaml .Values.resources | nindent 12 }}
           volumeMounts:
-            - mountPath: /oepnim/openim-server/config/config.yaml
+            - mountPath: /openim/openim-server/config/config.yaml
               name: config
               subPath: config.yaml
-            - mountPath: /oepnim/openim-server/config/notification.yaml
+            - mountPath: /openim/openim-server/config/
               name: config
               subPath: notification.yaml
       volumes:

deployments/charts/openim-rpc-third/templates/deployment.yaml

@@ -48,10 +48,10 @@ spec:
           resources:
             {{- toYaml .Values.resources | nindent 12 }}
           volumeMounts:
-            - mountPath: /oepnim/openim-server/config/config.yaml
+            - mountPath: /openim/openim-server/config/config.yaml
               name: config
               subPath: config.yaml
-            - mountPath: /oepnim/openim-server/config/notification.yaml
+            - mountPath: /openim/openim-server/config/
               name: config
               subPath: notification.yaml
       volumes:

deployments/charts/openim-rpc-user/templates/deployment.yaml

@@ -48,10 +48,10 @@ spec:
           resources:
             {{- toYaml .Values.resources | nindent 12 }}
           volumeMounts:
-            - mountPath: /oepnim/openim-server/config/config.yaml
+            - mountPath: /openim/openim-server/config/config.yaml
               name: config
               subPath: config.yaml
-            - mountPath: /oepnim/openim-server/config/notification.yaml
+            - mountPath: /openim/openim-server/config/
               name: config
               subPath: notification.yaml
       volumes:

deployments/templates/openim.yaml

@@ -383,6 +383,8 @@ callback:
 # The number of ports needs to be consistent with msg_transfer_service_num in script/path_info.sh
 prometheus:
   enable: ${PROMETHEUS_ENABLE}
+  prometheusUrl: ${PROMETHEUS_URL}
+  apiPrometheusPort: [${API_PROM_PORT}]
   userPrometheusPort: [ ${USER_PROM_PORT} ]
   friendPrometheusPort: [ ${FRIEND_PROM_PORT} ]
   messagePrometheusPort: [ ${MESSAGE_PROM_PORT} ]

docker-compose.yml

@@ -89,11 +89,11 @@ services:
     ports:
     - "${KAFKA_PORT}:9094"
     volumes:
-      - ./scripts/create_topic.sh:/opt/bitnami/kafka/create_topic.sh
+      - ./scripts/create-topic.sh:/opt/bitnami/kafka/create-topic.sh
       - ${DATA_DIR}/components/kafka:/bitnami/kafka
     command: >
       bash -c "
-      /opt/bitnami/scripts/kafka/run.sh & sleep 5; /opt/bitnami/kafka/create_topic.sh; wait
+      /opt/bitnami/scripts/kafka/run.sh & sleep 5; /opt/bitnami/kafka/create-topic.sh; wait
       "
     environment:
        - TZ=Asia/Shanghai

docs/README.md

@@ -5,7 +5,7 @@ Welcome to the OpenIM Documentation hub! This center provides a comprehensive ra
 ## Table of Contents
 
 1. [Contrib](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib) - Guidance on contributing and configurations for developers
-2. [Conversions](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions) - Coding conventions, logging policies, and other transformation tools
+2. [Conversions](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib) - Coding conventions, logging policies, and other transformation tools
 
 ------
 
@@ -13,34 +13,34 @@ Welcome to the OpenIM Documentation hub! This center provides a comprehensive ra
 
 This section offers developers a detailed guide on how to contribute code, set up their environment, and follow the associated processes.
 
-- [Code Conventions](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/code_conventions.md) - Rules and conventions for writing code in OpenIM.
+- [Code Conventions](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/code-conventions.md) - Rules and conventions for writing code in OpenIM.
 - [Development Guide](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/development.md) - A guide on how to carry out development within OpenIM.
-- [Git Cherry Pick](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/git_cherry-pick.md) - Guidelines on cherry-picking operations.
-- [Git Workflow](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/git_workflow.md) - The git workflow in OpenIM.
-- [Initialization Configurations](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/init_config.md) - Guidance on setting up and initializing OpenIM.
-- [Docker Installation](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/install_docker.md) - How to install Docker on your machine.
-- [Linux Development Environment](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/linux_development.md) - Guide to set up the development environment on Linux.
-- [Local Actions](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/local_actions.md) - Guidelines on how to carry out certain common actions locally.
+- [Git Cherry Pick](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/gitcherry-pick.md) - Guidelines on cherry-picking operations.
+- [Git Workflow](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/git-workflow.md) - The git workflow in OpenIM.
+- [Initialization Configurations](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/init-config.md) - Guidance on setting up and initializing OpenIM.
+- [Docker Installation](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/install-docker.md) - How to install Docker on your machine.
+- [Linux Development Environment](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/linux-development.md) - Guide to set up the development environment on Linux.
+- [Local Actions](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/local-actions.md) - Guidelines on how to carry out certain common actions locally.
 - [Offline Deployment](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/offline-deployment.md) - Methods of deploying OpenIM offline.
-- [Protoc Tools](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/protoc_tools.md) - Guide on using protoc tools.
-- [Go Tools](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/util_go.md) - Tools and libraries in OpenIM for Go.
-- [Makefile Tools](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/util_makefile.md) - Best practices and tools for Makefile.
-- [Script Tools](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/util_scripts.md) - Best practices and tools for scripts.
+- [Protoc Tools](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/protoc-tools.md) - Guide on using protoc tools.
+- [Go Tools](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/util-go.md) - Tools and libraries in OpenIM for Go.
+- [Makefile Tools](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/util-makefile.md) - Best practices and tools for Makefile.
+- [Script Tools](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/util-scripts.md) - Best practices and tools for scripts.
 
 ## Conversions
 
 This section introduces various conventions and policies within OpenIM, encompassing code, logs, versions, and more.
 
-- [API Conversions](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/api.md) - Guidelines and methods for API conversions.
-- [Logging Policy](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/bash_log.md) - Logging policies and conventions in OpenIM.
-- [CI/CD Actions](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/cicd_actions.md) - Procedures and conventions for CI/CD.
-- [Commit Conventions](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/commit.md) - Conventions for code commits in OpenIM.
-- [Directory Conventions](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/directory.md) - Directory structure and conventions within OpenIM.
-- [Error Codes](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/error_code.md) - List and descriptions of error codes.
-- [Go Code Conversions](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/go_code.md) - Conventions and conversions for Go code.
-- [Docker Image Strategy](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/images.md) - Management strategies for OpenIM Docker images, spanning multiple architectures and image repositories.
-- [Logging Conventions](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/logging.md) - Further detailed conventions on logging.
-- [Version Conventions](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/version.md) - Naming and management strategies for OpenIM versions.
+- [API Conversions](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/api.md) - Guidelines and methods for API conversions.
+- [Logging Policy](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/bash-log.md) - Logging policies and conventions in OpenIM.
+- [CI/CD Actions](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/cicd-actions.md) - Procedures and conventions for CI/CD.
+- [Commit Conventions](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/commit.md) - Conventions for code commits in OpenIM.
+- [Directory Conventions](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/directory.md) - Directory structure and conventions within OpenIM.
+- [Error Codes](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/error-code.md) - List and descriptions of error codes.
+- [Go Code Conversions](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/go-code.md) - Conventions and conversions for Go code.
+- [Docker Image Strategy](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/images.md) - Management strategies for OpenIM Docker images, spanning multiple architectures and image repositories.
+- [Logging Conventions](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/logging.md) - Further detailed conventions on logging.
+- [Version Conventions](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/version.md) - Naming and management strategies for OpenIM versions.
 
 
 ## For Developers, Contributors, and Community Maintainers
@@ -49,7 +49,7 @@ This section introduces various conventions and policies within OpenIM, encompas
 
 If you're a developer or someone keen on contributing:
 
-- Familiarize yourself with our [Code Conventions](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/code_conventions.md) and [Git Workflow](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/git_workflow.md) to ensure smooth contributions.
+- Familiarize yourself with our [Code Conventions](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/code-conventions.md) and [Git Workflow](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/git-workflow.md) to ensure smooth contributions.
 - Dive into the [Development Guide](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/development.md) to get a hang of the development practices in OpenIM.
 
 ### Community Maintainers
@@ -57,11 +57,11 @@ If you're a developer or someone keen on contributing:
 As a community maintainer:
 
 - Ensure that contributions align with the standards outlined in our documentation.
-- Regularly review the [Logging Policy](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/bash_log.md) and [Error Codes](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/error_code.md) to stay updated.
+- Regularly review the [Logging Policy](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/bash-log.md) and [Error Codes](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/error-code.md) to stay updated.
 
 ## For Users
 
 Users should pay particular attention to:
 
-- [Docker Installation](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/install_docker.md) - Necessary if you're planning to use Docker images of OpenIM.
-- [Docker Image Strategy](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/images.md) - To understand the different images available and how to choose the right one for your architecture.
+- [Docker Installation](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/install-docker.md) - Necessary if you're planning to use Docker images of OpenIM.
+- [Docker Image Strategy](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/images.md) - To understand the different images available and how to choose the right one for your architecture.

docs/contrib/README.md

@@ -0,0 +1,42 @@
+# Contrib Documentation Index
+
+## 📚 General Information
+- [📄 README](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/README.md) - General introduction to the contribution documentation.
+- [📑 Development Guide](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/development.md) - Guidelines for setting up a development environment.
+
+## 🛠 Setup and Installation
+- [🌍 Environment Setup](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/environment.md) - Instructions on setting up the development environment.
+- [🐳 Docker Installation Guide](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/install-docker.md) - Steps to install Docker for container management.
+- [🔧 OpenIM Linux System Installation](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/install-openim-linux-system.md) - Guide for installing OpenIM on a Linux system.
+
+## 💻 Development Practices
+- [👨‍💻 Code Conventions](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/code-conventions.md) - Coding standards to follow for consistency.
+- [📐 Directory Structure](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/directory.md) - Explanation of the repository's directory layout.
+- [🔀 Git Workflow](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/git-workflow.md) - The workflow for using Git in this project (note the file extension error).
+- [💾 GitHub Workflow](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/github-workflow.md) - Workflow guidelines for GitHub.
+
+## 🧪 Testing and Deployment
+- [⚙️ CI/CD Actions](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/cicd-actions.md) - Continuous integration and deployment configurations.
+- [🚀 Offline Deployment](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/offline-deployment.md) - How to deploy the application offline.
+
+## 🔧 Utilities and Tools
+- [📦 Protoc Tools](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/protoc-tools.md) - Protobuf compiler-related utilities.
+- [🔨 Utility Go](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/util-go.md) - Go utilities and helper functions.
+- [🛠 Makefile Utilities](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/util-makefile.md) - Makefile scripts for automation.
+- [📜 Script Utilities](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/util-scripts.md) - Utility scripts for development.
+
+## 📋 Standards and Conventions
+- [🚦 Commit Guidelines](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/commit.md) - Standards for writing commit messages.
+- [✅ Testing Guide](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/test.md) - Guidelines and conventions for writing tests.
+- [📈 Versioning](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/version.md) - Version management for the project.
+
+## 🖼 Additional Resources
+- [🌐 API Reference](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/api.md) - Detailed API documentation.
+- [📚 Go Code Standards](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/go-code.md) - Go programming language standards.
+- [🖼 Image Guidelines](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/images.md) - Guidelines for image assets.
+
+## 🐛 Troubleshooting
+- [🔍 Error Code Reference](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/error-code.md) - List of error codes and their meanings.
+- [🐚 Bash Logging](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/bash-log.md) - Logging standards for bash scripts.
+- [📈 Logging Conventions](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/logging.md) - Conventions for application logging.
+- [🛠 Local Actions Guide](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/local-actions.md) - How to perform local actions for troubleshooting.

docs/contrib/code-conventions.md

@@ -24,7 +24,48 @@
   - Do not use uppercase characters, underscores, or dashes in package names.
   - Please consider parent directory name when choosing a package name. For example, `pkg/controllers/autoscaler/foo.go` should say `package autoscaler` not `package autoscalercontroller`.
     - Unless there's a good reason, the `package foo` line should match the name of the directory in which the `.go` file exists.
-    - Importers can use a different name if they need to disambiguate.
+    - Importers can use a different name if they need to disambiguate.Ⓜ️
+
+## OpenIM Naming Conventions Guide
+
+Welcome to the OpenIM Naming Conventions Guide. This document outlines the best practices and standardized naming conventions that our project follows to maintain clarity, consistency, and alignment with industry standards, specifically taking cues from the Google Naming Conventions.
+
+### 1. General File Naming
+
+Files within the OpenIM project should adhere to the following rules:
+
++ Both hyphens (`-`) and underscores (`_`) are acceptable in file names.
++ Underscores (`_`) are preferred for general files to enhance readability and compatibility.
++ For example: `data_processor.py`, `user_profile_generator.go`
+
+### 2. Special File Types
+
+#### a. Script and Markdown Files
+
++ Bash scripts and Markdown files should use hyphens (`-`) to facilitate better searchability and compatibility in web browsers.
++ For example: `deploy-script.sh`, `project-overview.md`
+
+#### b. Uppercase Markdown Documentation
+
++ Markdown files with uppercase names, such as `README`, may include underscores (`_`) to separate words if necessary.
++ For example: `README_SETUP.md`, `CONTRIBUTING_GUIDELINES.md`
+
+### 3. Directory Naming
+
++ Directories must use hyphens (`-`) exclusively to maintain a clean and organized file structure.
++ For example: `image-assets`, `user-data`
+
+### 4. Configuration Files
+
++ Configuration files, including but not limited to `.yaml` files, should use hyphens (`-`).
++ For example: `app-config.yaml`, `logging-config.yaml`
+
+### Best Practices
+
++ Keep names concise but descriptive enough to convey the file's purpose or contents at a glance.
++ Avoid using spaces in names; use hyphens or underscores instead to improve compatibility across different operating systems and environments.
++ Stick to lowercase naming where possible for consistency and to prevent issues with case-sensitive systems.
++ Include version numbers or dates in file names if the file is subject to updates, following the format: `project-plan-v1.2.md` or `backup-2023-03-15.sql`.
 
 ## Directory and file conventions
 

docs/contrib/environment.md

@@ -136,13 +136,13 @@ For convenience, configuration through modifying environment variables is recomm
   export PASSWORD="openIM123"
   ```
 
-+ USER
++ OPENIM_USER
 
   + **Description**: Username for mysql, mongodb, redis, and minio.
   + **Default**: `root`
 
   ```bash
-  export USER="root"
+  export OPENIM_USER="root"
   ```
 
 + API_URL

docs/contrib/github-workflow.md

@@ -83,7 +83,7 @@ You may now edit files on the `myfeature` branch.
 
 ### Building open-im-server
 
-This workflow is process-specific. For quick-start build instructions for [openimsdk/open-im-server](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/util_makefile.md)
+This workflow is process-specific. For quick-start build instructions for [openimsdk/open-im-server](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/util-makefile.md)
 
 ## 4. Keep your branch in sync
 

docs/contrib/go-code.md

@@ -312,6 +312,18 @@ The naming convention is a very important part of the code specification. A unif
 - The function name is in camel case, and the first letter is uppercase or lowercase according to the access control decision,For example: `MixedCaps` or `mixedCaps`.
 - Code automatically generated by code generation tools (such as `xxxx.pb.go`) and underscores used to group related test cases (such as `TestMyFunction_WhatIsBeingTested`) exclude this rule.
 
+In accordance with the naming conventions adopted by OpenIM and drawing reference from the Google Naming Conventions as per the guidelines available at https://google.github.io/styleguide/go/, the following expectations for naming practices within the project are set forth:
+
+1. **File Names:**
+   + Both hyphens (`-`) and underscores (`_`) are permitted when naming files.
+   + A preference is established for the use of underscores (`_`), suggesting it as the best practice in general scenarios.
+2. **Script and Markdown Files:**
+   + For shell scripts (bash files) and Markdown (`.md`) documents, the use of hyphens (`-`) is recommended.
+   + This recommendation is based on the improved searchability and compatibility in web browsers when hyphens are used in names.
+3. **Directories:**
+   + A consistent approach is mandated for naming directories, exclusively using hyphens (`-`) to separate words within directory names.
+
+
 ### 2.3 File Naming
 
 - Keep the filename short and meaningful.

docs/contrib/offline-deployment.md

@@ -26,11 +26,11 @@ docker pull minio/minio
 
 ## 2. OpenIM & Chat Images
 
-**For detailed understanding of version management and storage of OpenIM and Chat**: [version.md](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/version.md)
+**For detailed understanding of version management and storage of OpenIM and Chat**: [version.md](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/version.md)
 
 ### OpenIM Image
 
-- Get image version info: [images.md](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/images.md)
+- Get image version info: [images.md](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/images.md)
 - Depending on the required version, execute the following command:
 
 ```bash

docs/contrib/test.md

@@ -0,0 +1,183 @@
+# OpenIM RPC Service Test Control Script Documentation
+
+This document serves as a comprehensive guide to understanding and utilizing the `test.sh` script for testing OpenIM RPC services. The `test.sh` script is a collection of bash functions designed to test various aspects of the OpenIM RPC services, ensuring that each part of the API is functioning as expected.
+
++ Scripts：https://github.com/OpenIMSDK/Open-IM-Server/tree/main/scripts/install/test.sh
+
+For some complex, bulky functional tests, performance tests, and various e2e tests, We are all in the current warehouse to https://github.com/OpenIMSDK/Open-IM-Server/tree/main/test or https://github.com/openim-sigs/test-infra directory In the.
+
++ About OpenIM Feature [Test Docs](https://docs.google.com/spreadsheets/d/1zELWkwxgOOZ7u5pmYCqqaFnvZy2SVajv/edit?usp=sharing&ouid=103266350914914783293&rtpof=true&sd=true)
+
+
+## Usage
+
+The `test.sh` script is located within the `./scripts/install/` directory of the OpenIM service's codebase. To use the script, navigate to this directory from your terminal:
+
+```bash
+cd ./scripts/install/
+chmod +x test.sh
+```
+
+### Running the Entire Test Suite
+
+To execute all available tests, you can either call the script directly or use the `make` command:
+
+```
+./test.sh openim::test::test
+```
+
+Or, if you have a `Makefile` that defines the `test-api` target:
+
+```bash
+make test-api
+```
+
+Alternatively, you can invoke specific test functions by passing them as arguments:
+
+```
+./test.sh openim::test::<function_name>
+```
+
+This `make` command should be equivalent to running `./test.sh openim::test::test`, provided that the `Makefile` is configured accordingly.
+
+
+
+### Executing Individual Test Functions
+
+If you wish to run a specific set of tests, you can call the relevant function by passing it as an argument to the script. Here are some examples:
+
+**Message Tests:**
+
+```bash
+./test.sh openim::test::msg
+```
+
+**Authentication Tests:**
+
+```bash
+./test.sh openim::test::auth
+```
+
+**User Tests:**
+
+```bash
+./test.sh openim::test::user
+```
+
+**Friend Tests:**
+
+```bash
+./test.sh openim::test::friend
+```
+
+**Group Tests:**
+
+```bash
+./test.sh openim::test::group
+```
+
+Each of these commands will run the test suite associated with the specific functionality of the OpenIM service.
+
+
+
+### Detailed Function Test Examples
+
+T**esting Message Sending and Receiving:**
+
+To test message functionality, the `openim::test::msg` function is called. It will register a user, send a message, and clear messages to ensure that the messaging service is operational.
+
+```bash
+./test.sh openim::test::msg
+```
+
+**Testing User Registration and Account Checks:**
+
+The `openim::test::user` function will create new user accounts and perform a series of checks on these accounts to verify that user registration and account queries are functioning properly.
+
+```bash
+./test.sh openim::test::user
+```
+
+**Testing Friend Management:**
+
+By invoking `openim::test::friend`, the script will test adding friends, checking friendship status, managing friend requests, and handling blacklisting.
+
+```bash
+./test.sh openim::test::friend
+```
+
+**Testing Group Operations:**
+
+The `openim::test::group` function tests group creation, member addition, information retrieval, and member management within groups.
+
+```bash
+./test.sh openim::test::group
+```
+
+### Log Output
+
+Each test function will output logs to the terminal to confirm the success or failure of the tests. These logs are crucial for identifying issues and verifying that each part of the service is tested thoroughly.
+
+Each function logs its success upon completion, which aids in debugging and understanding the test flow. The success message is standardized across functions:
+
+```
+openim::log::success "<Test suite name> completed successfully."
+```
+
+By following the guidelines and instructions outlined in this document, you can effectively utilize the `test.sh` script to test and verify the OpenIM RPC services' functionality.
+
+
+
+## Function feature
+
+| Function Name                                        | Corresponding API/Action                      | Function Purpose                                             |
+| ---------------------------------------------------- | --------------------------------------------- | ------------------------------------------------------------ |
+| `openim::test::msg`                                  | Messaging Operations                          | Tests all aspects of messaging, including sending, receiving, and managing messages. |
+| `openim::test::auth`                                 | Authentication Operations                     | Validates the authentication process and session management, including token handling and forced logout. |
+| `openim::test::user`                                 | User Account Operations                       | Covers testing for user account creation, retrieval, updating, and overall management. |
+| `openim::test::friend`                               | Friend Relationship Operations                | Ensures friend management functions correctly, including requests, listing, and blacklisting. |
+| `openim::test::group`                                | Group Management Operations                   | Checks group-related functionalities like creation, invitation, information retrieval, and member management. |
+| `openim::test::send_msg`                             | Send Message API                              | Simulates sending a message from one user to another or within a group. |
+| `openim::test::revoke_msg`                           | Revoke Message API (TODO)                     | (Planned) Will test the revocation of a previously sent message. |
+| `openim::test::user_register`                        | User Registration API                         | Registers a new user in the system to validate the registration process. |
+| `openim::test::check_account`                        | Account Check API                             | Checks if an account exists for a given user ID.             |
+| `openim::test::user_clear_all_msg`                   | Clear All Messages API                        | Clears all messages for a given user to validate message history management. |
+| `openim::test::get_token`                            | Token Retrieval API                           | Retrieves an authentication token to validate token management. |
+| `openim::test::force_logout`                         | Force Logout API                              | Forces a logout for a test user to validate session control. |
+| `openim::test::check_user_account`                   | User Account Existence Check API              | Confirms the existence of a test user's account.             |
+| `openim::test::get_users`                            | Get Users API                                 | Retrieves a list of users to validate user query functionality. |
+| `openim::test::get_users_info`                       | Get User Information API                      | Obtains detailed information for a given user.               |
+| `openim::test::get_users_online_status`              | Get User Online Status API                    | Checks the online status of a user to validate presence functionality. |
+| `openim::test::update_user_info`                     | Update User Information API                   | Updates a user's information to validate account update capabilities. |
+| `openim::test::get_subscribe_users_status`           | Get Subscribed Users' Status API              | Retrieves the status of users that a test user has subscribed to. |
+| `openim::test::subscribe_users_status`               | Subscribe to Users' Status API                | Subscribes a test user to a set of user statuses.            |
+| `openim::test::set_global_msg_recv_opt`              | Set Global Message Receiving Option API       | Sets the message receiving option for a test user.           |
+| `openim::test::is_friend`                            | Check Friendship Status API                   | Verifies if two users are friends within the system.         |
+| `openim::test::add_friend`                           | Send Friend Request API                       | Sends a friend request from one user to another.             |
+| `openim::test::get_friend_list`                      | Get Friend List API                           | Retrieves the friend list of a test user.                    |
+| `openim::test::get_friend_apply_list`                | Get Friend Application List API               | Retrieves friend applications for a test user.               |
+| `openim::test::get_self_friend_apply_list`           | Get Self-Friend Application List API          | Retrieves the friend applications that the user has applied for. |
+| `openim::test::add_black`                            | Add User to Blacklist API                     | Adds a user to the test user's blacklist to validate blacklist functionality. |
+| `openim::test::remove_black`                         | Remove User from Blacklist API                | Removes a user from the test user's blacklist.               |
+| `openim::test::get_black_list`                       | Get Blacklist API                             | Retrieves the blacklist for a test user.                     |
+| `openim::test::create_group`                         | Group Creation API                            | Creates a new group with test users to validate group creation. |
+| `openim::test::invite_user_to_group`                 | Invite User to Group API                      | Invites a user to join a group to test invitation functionality. |
+| `openim::test::transfer_group`                       | Group Ownership Transfer API                  | Tests the transfer of group ownership from one member to another. |
+| `openim::test::get_groups_info`                      | Get Group Information API                     | Retrieves information for specified groups to validate group query functionality. |
+| `openim::test::kick_group`                           | Kick User from Group API                      | Simulates kicking a user from a group to test group membership management. |
+| `openim::test::get_group_members_info`               | Get Group Members Information API             | Obtains detailed information for members of a specified group. |
+| `openim::test::get_group_member_list`                | Get Group Member List API                     | Retrieves a list of members for a given group to ensure member listing is functional. |
+| `openim::test::get_joined_group_list`                | Get Joined Group List API                     | Retrieves a list of groups that a user has joined to validate user's group memberships. |
+| `openim::test::set_group_member_info`                | Set Group Member Information API              | Updates the information for a group member to test the update functionality. |
+| `openim::test::mute_group`                           | Mute Group API                                | Tests the ability to mute a group, disabling message notifications for its members. |
+| `openim::test::cancel_mute_group`                    | Cancel Mute Group API                         | Tests the ability to cancel the mute status of a group, re-enabling message notifications. |
+| `openim::test::dismiss_group`                        | Dismiss Group API                             | Tests the ability to dismiss and delete a group from the system. |
+| `openim::test::cancel_mute_group_member`             | Cancel Mute Group Member API                  | Tests the ability to cancel mute status for a specific group member. |
+| `openim::test::join_group`                           | Join Group API (TODO)                         | (Planned) Will test the functionality for a user to join a specified group. |
+| `openim::test::set_group_info`                       | Set Group Information API                     | Tests the ability to update the group information, such as the name or description. |
+| `openim::test::quit_group`                           | Quit Group API                                | Tests the functionality for a user to leave a specified group. |
+| `openim::test::get_recv_group_applicationList`       | Get Received Group Application List API       | Retrieves the list of group applications received by a user to validate application management. |
+| `openim::test::group_application_response`           | Group Application Response API (TODO)         | (Planned) Will test the functionality to respond to a group join request. |
+| `openim::test::get_user_req_group_applicationList`   | Get User Requested Group Application List API | Retrieves the list of group applications requested by a user to validate tracking of user's applications. |
+| `openim::test::mute_group_member`                    | Mute Group Member API                         | Tests the ability to mute a specific member within a group, disabling their ability to send messages. |
+| `openim::test::get_group_users_req_application_list` | Get Group Users Request Application List API  | Retrieves a list of user requests for group applications to validate group request management. |

docs/contrib/version.md

@@ -212,4 +212,4 @@ Throughout this process, active communication within the team is pivotal to main
 
 ## Docker Images Version Management
 
-For more details on managing Docker image versions, visit [OpenIM Docker Images Administration](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/images.md).
+For more details on managing Docker image versions, visit [OpenIM Docker Images Administration](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/images.md).

docs/conversions/README.md

@@ -1,10 +0,0 @@
-##  OpenIM Project Development Standards
-
-- [Code Standards](./go_code.md)
-- [Docker Images Standards](./images.md)
-- [Directory Standards](./directory.md)
-- [Commit Standards](./commit.md)
-- [Versioning Standards](./version.md)
-- [Interface Standards](./api.md)
-- [Log Standards](./log.md)
-- [Error Code Standards](./error_code.md)

go.mod

@@ -37,14 +37,15 @@ require github.com/google/uuid v1.3.1
 
 require (
 	github.com/IBM/sarama v1.41.3
-	github.com/OpenIMSDK/protocol v0.0.30
-	github.com/OpenIMSDK/tools v0.0.15
+	github.com/OpenIMSDK/protocol v0.0.31
+	github.com/OpenIMSDK/tools v0.0.16
 	github.com/aliyun/aliyun-oss-go-sdk v2.2.9+incompatible
 	github.com/go-redis/redis v6.15.9+incompatible
 	github.com/go-sql-driver/mysql v1.7.1
 	github.com/redis/go-redis/v9 v9.2.1
 	github.com/tencentyun/cos-go-sdk-v5 v0.7.45
 	gopkg.in/src-d/go-git.v4 v4.13.1
+	gotest.tools v2.2.0+incompatible
 )
 
 require (
@@ -73,6 +74,7 @@ require (
 	github.com/go-zookeeper/zk v1.0.3 // indirect
 	github.com/golang/groupcache v0.0.0-20210331224755-41bb18bfe9da // indirect
 	github.com/golang/snappy v0.0.4 // indirect
+	github.com/google/go-cmp v0.6.0 // indirect
 	github.com/google/go-querystring v1.1.0 // indirect
 	github.com/google/s2a-go v0.1.7 // indirect
 	github.com/googleapis/enterprise-certificate-proxy v0.3.1 // indirect
@@ -116,6 +118,7 @@ require (
 	github.com/sergi/go-diff v1.0.0 // indirect
 	github.com/spf13/pflag v1.0.5 // indirect
 	github.com/src-d/gcfg v1.4.0 // indirect
+	github.com/stretchr/objx v0.5.0 // indirect
 	github.com/twitchyliquid64/golang-asm v0.15.1 // indirect
 	github.com/xanzy/ssh-agent v0.2.1 // indirect
 	github.com/xdg-go/pbkdf2 v1.0.0 // indirect

go.sum

@@ -18,10 +18,10 @@ firebase.google.com/go v3.13.0+incompatible/go.mod h1:xlah6XbEyW6tbfSklcfe5FHJIw
 github.com/BurntSushi/toml v0.3.1/go.mod h1:xHWCNGjB5oqiDr8zfno3MHue2Ht5sIBksp03qcyfWMU=
 github.com/IBM/sarama v1.41.3 h1:MWBEJ12vHC8coMjdEXFq/6ftO6DUZnQlFYcxtOJFa7c=
 github.com/IBM/sarama v1.41.3/go.mod h1:Xxho9HkHd4K/MDUo/T/sOqwtX/17D33++E9Wib6hUdQ=
-github.com/OpenIMSDK/protocol v0.0.30 h1:MiHO6PyQMR9ojBHNnSFxCHLmsoE2xZqaiYj975JiZnM=
-github.com/OpenIMSDK/protocol v0.0.30/go.mod h1:F25dFrwrIx3lkNoiuf6FkCfxuwf8L4Z8UIsdTHP/r0Y=
-github.com/OpenIMSDK/tools v0.0.15 h1:FF3m0TQUG56pJC15a11jmBG6Y1EjXarEW4JV3CBF/Jc=
-github.com/OpenIMSDK/tools v0.0.15/go.mod h1:eg+q4A34Qmu73xkY0mt37FHGMCMfC6CtmOnm0kFEGFI=
+github.com/OpenIMSDK/protocol v0.0.31 h1:ax43x9aqA6EKNXNukS5MT5BSTqkUmwO4uTvbJLtzCgE=
+github.com/OpenIMSDK/protocol v0.0.31/go.mod h1:F25dFrwrIx3lkNoiuf6FkCfxuwf8L4Z8UIsdTHP/r0Y=
+github.com/OpenIMSDK/tools v0.0.16 h1:te/GIq2imCMsrRPgU9OObYKbzZ3rT08Lih/o+3QFIz0=
+github.com/OpenIMSDK/tools v0.0.16/go.mod h1:eg+q4A34Qmu73xkY0mt37FHGMCMfC6CtmOnm0kFEGFI=
 github.com/QcloudApi/qcloud_sign_golang v0.0.0-20141224014652-e4130a326409/go.mod h1:1pk82RBxDY/JZnPQrtqHlUFfCctgdorsd9M06fMynOM=
 github.com/alcortesm/tgz v0.0.0-20161220082320-9c5fe88206d7 h1:uSoVVbwJiQipAclBbw+8quDsfcvFjOpI5iCf4p/cqCs=
 github.com/alcortesm/tgz v0.0.0-20161220082320-9c5fe88206d7/go.mod h1:6zEj6s6u/ghQa61ZWa/C2Aw3RkjiTBOix7dkqa1VLIs=
@@ -144,6 +144,7 @@ github.com/google/go-cmp v0.5.2/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/
 github.com/google/go-cmp v0.5.3/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
 github.com/google/go-cmp v0.5.5/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
 github.com/google/go-cmp v0.6.0 h1:ofyhxvXcZhMsU5ulbFiLKl/XBFqE1GSq7atu8tAmTRI=
+github.com/google/go-cmp v0.6.0/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY=
 github.com/google/go-querystring v1.0.0/go.mod h1:odCYkC5MyYFN7vkCjXpyrEuKhc/BUO6wN/zVPAxq5ck=
 github.com/google/go-querystring v1.1.0 h1:AnCroh3fv4ZBgVIf1Iwtovgjaw/GiKJo8M8yD/fhyJ8=
 github.com/google/go-querystring v1.1.0/go.mod h1:Kcdr2DB4koayq7X8pmAG4sNG59So17icRSOU623lUBU=
@@ -311,6 +312,7 @@ github.com/src-d/gcfg v1.4.0/go.mod h1:p/UMsR43ujA89BJY9duynAwIpvqEujIH/jFlfL7jW
 github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
 github.com/stretchr/objx v0.2.0/go.mod h1:qt09Ya8vawLte6SNmTgCsAVtYtaKzEcn8ATUoHMkEqE=
 github.com/stretchr/objx v0.4.0/go.mod h1:YvHI0jy2hoMjB+UWwv71VJQ9isScKT/TqJzVSSt89Yw=
+github.com/stretchr/objx v0.5.0 h1:1zr/of2m5FGMsad5YfcqgdqdWrIhu+EBEJRhR1U7z/c=
 github.com/stretchr/objx v0.5.0/go.mod h1:Yh+to48EsGEfYuaHDzXPcE3xhTkx73EhmCGUpEOglKo=
 github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI=
 github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81PSLYec5m4=
@@ -531,6 +533,8 @@ gorm.io/driver/mysql v1.5.2/go.mod h1:pQLhh1Ut/WUAySdTHwBpBv6+JKcj+ua4ZFx1QQTBzb
 gorm.io/gorm v1.25.2-0.20230530020048-26663ab9bf55/go.mod h1:L4uxeKpfBml98NYqVqwAdmV1a2nBtAec/cf3fpucW/k=
 gorm.io/gorm v1.25.5 h1:zR9lOiiYf09VNh5Q1gphfyia1JpiClIWG9hQaxB/mls=
 gorm.io/gorm v1.25.5/go.mod h1:hbnx/Oo0ChWMn1BIhpy1oYozzpM15i4YPuHDmfYtwg8=
+gotest.tools v2.2.0+incompatible h1:VsBPFP1AI068pPrMxtb/S8Zkgf9xEmTLJjfM+P5UIEo=
+gotest.tools v2.2.0+incompatible/go.mod h1:DsYFclhRJ6vuDpmuTbkuFWG+y2sxOXAzmJt81HFBacw=
 honnef.co/go/tools v0.0.0-20190102054323-c2f93a96b099/go.mod h1:rf3lG4BRIbNafJWhAfAdb/ePZxsR/4RtNHQocxwk9r4=
 honnef.co/go/tools v0.0.0-20190523083050-ea95bdfd59fc/go.mod h1:rf3lG4BRIbNafJWhAfAdb/ePZxsR/4RtNHQocxwk9r4=
 rsc.io/pdf v0.1.1/go.mod h1:n8OzWcQ6Sp37PL01nO98y4iUCRdTGarVfzxY20ICaU4=

install.sh

@@ -458,25 +458,20 @@ function openim_color() {
 }
 
 # --- helper functions for logs ---
-info()
-{
+info() {
     echo -e "[${GREEN_PREFIX}INFO${COLOR_SUFFIX}] " "$@"
 }
-warn()
-{
+warn() {
     echo -e "[${YELLOW_PREFIX}WARN${COLOR_SUFFIX}] " "$@" >&2
 }
-fatal()
-{
+fatal() {
     echo -e "[${RED_PREFIX}ERROR${COLOR_SUFFIX}] " "$@" >&2
     exit 1
 }
-debug()
-{
+debug() {
     echo -e "[${BLUE_PREFIX}DEBUG${COLOR_SUFFIX}]===> " "$@"
 }
-success()
-{
+success() {
     echo -e "${BRIGHT_GREEN_PREFIX}=== [SUCCESS] ===${COLOR_SUFFIX}\n=> " "$@"
 }
 

install_guide.sh

@@ -147,7 +147,7 @@ EOF
     
     cd scripts;
     chmod +x *.sh;
-    ./init_pwd.sh;
+    ./init-pwd.sh;
     ./env_check.sh;
     cd ..;
     docker-compose up -d;

internal/api/msg.go

@@ -53,7 +53,7 @@ func (MessageApi) SetOptions(options map[string]bool, value bool) {
 	utils.SetSwitchFromOptions(options, constant.IsConversationUpdate, value)
 }
 
-func (m MessageApi) newUserSendMsgReq(c *gin.Context, params *apistruct.SendMsg) *msg.SendMsgReq {
+func (m MessageApi) newUserSendMsgReq(_ *gin.Context, params *apistruct.SendMsg) *msg.SendMsgReq {
 	var newContent string
 	options := make(map[string]bool, 5)
 	switch params.ContentType {

internal/api/route.go

@@ -39,7 +39,6 @@ import (
 	"github.com/OpenIMSDK/tools/mw"
 
 	"github.com/openimsdk/open-im-server/v3/pkg/common/config"
-	"github.com/openimsdk/open-im-server/v3/pkg/common/prome"
 	"github.com/openimsdk/open-im-server/v3/pkg/rpcclient"
 )
 
@@ -63,13 +62,6 @@ func NewGinRouter(discov discoveryregistry.SvcDiscoveryRegistry, rdb redis.Unive
 
 	u := NewUserApi(*userRpc)
 	m := NewMessageApi(messageRpc, userRpc)
-	if config.Config.Prometheus.Enable {
-		prome.NewApiRequestCounter()
-		prome.NewApiRequestFailedCounter()
-		prome.NewApiRequestSuccessCounter()
-		r.Use(prome.PrometheusMiddleware)
-		r.GET("/metrics", prome.PrometheusHandler())
-	}
 	ParseToken := GinParseToken(rdb)
 	userRouterGroup := r.Group("/user")
 	{
@@ -151,6 +143,7 @@ func NewGinRouter(discov discoveryregistry.SvcDiscoveryRegistry, rdb redis.Unive
 	// Third service
 	thirdGroup := r.Group("/third", ParseToken)
 	{
+		thirdGroup.GET("/prometheus", GetPrometheus)
 		t := NewThirdApi(*thirdRpc)
 		thirdGroup.POST("/fcm_update_token", t.FcmUpdateToken)
 		thirdGroup.POST("/set_app_badge", t.SetAppBadge)

internal/api/third.go

@@ -15,6 +15,7 @@
 package api
 
 import (
+	config2 "github.com/openimsdk/open-im-server/v3/pkg/common/config"
 	"math/rand"
 	"net/http"
 	"strconv"
@@ -118,3 +119,7 @@ func (o *ThirdApi) DeleteLogs(c *gin.Context) {
 func (o *ThirdApi) SearchLogs(c *gin.Context) {
 	a2r.Call(third.ThirdClient.SearchLogs, o.Client, c)
 }
+
+func GetPrometheus(c *gin.Context) {
+	c.Redirect(http.StatusFound, config2.Config.Prometheus.PrometheusUrl)
+}

internal/msggateway/client.go

@@ -20,6 +20,7 @@ import (
 	"fmt"
 	"runtime/debug"
 	"sync"
+	"sync/atomic"
 
 	"github.com/openimsdk/open-im-server/v3/pkg/msgprocessor"
 
@@ -70,7 +71,7 @@ type Client struct {
 	IsBackground   bool   `json:"isBackground"`
 	ctx            *UserConnContext
 	longConnServer LongConnServer
-	closed         bool
+	closed         atomic.Bool
 	closedErr      error
 	token          string
 }
@@ -102,18 +103,14 @@ func (c *Client) ResetClient(
 	c.ctx = ctx
 	c.longConnServer = longConnServer
 	c.IsBackground = false
-	c.closed = false
+	c.closed.Store(false)
 	c.closedErr = nil
 	c.token = token
 }
 
 func (c *Client) pingHandler(_ string) error {
-	c.conn.SetReadDeadline(pongWait)
-	err := c.writePongMsg()
-	if err != nil {
-		return err
-	}
-	return nil
+	_ = c.conn.SetReadDeadline(pongWait)
+	return c.writePongMsg()
 }
 
 func (c *Client) readMessage() {
@@ -124,9 +121,11 @@ func (c *Client) readMessage() {
 		}
 		c.close()
 	}()
+
 	c.conn.SetReadLimit(maxMessageSize)
 	_ = c.conn.SetReadDeadline(pongWait)
 	c.conn.SetPingHandler(c.pingHandler)
+
 	for {
 		messageType, message, returnErr := c.conn.ReadMessage()
 		if returnErr != nil {
@@ -134,11 +133,13 @@ func (c *Client) readMessage() {
 			c.closedErr = returnErr
 			return
 		}
+
 		log.ZDebug(c.ctx, "readMessage", "messageType", messageType)
-		if c.closed == true { // 连接刚置位已经关闭，但是协程还没退出的场景
+		if c.closed.Load() { // 连接刚置位已经关闭，但是协程还没退出的场景
 			c.closedErr = ErrConnClosed
 			return
 		}
+
 		switch messageType {
 		case MessageBinary:
 			_ = c.conn.SetReadDeadline(pongWait)
@@ -150,9 +151,11 @@ func (c *Client) readMessage() {
 		case MessageText:
 			c.closedErr = ErrNotSupportMessageProtocol
 			return
+
 		case PingMessage:
 			err := c.writePongMsg()
 			log.ZError(c.ctx, "writePongMsg", err)
+
 		case CloseMessage:
 			c.closedErr = ErrClientClosed
 			return
@@ -163,29 +166,40 @@ func (c *Client) readMessage() {
 
 func (c *Client) handleMessage(message []byte) error {
 	if c.IsCompress {
-		var decompressErr error
-		message, decompressErr = c.longConnServer.DeCompress(message)
-		if decompressErr != nil {
-			return utils.Wrap(decompressErr, "")
+		var err error
+		message, err = c.longConnServer.DeCompress(message)
+		if err != nil {
+			return utils.Wrap(err, "")
 		}
 	}
-	var binaryReq Req
-	err := c.longConnServer.Decode(message, &binaryReq)
+
+	var binaryReq = getReq()
+	defer freeReq(binaryReq)
+
+	err := c.longConnServer.Decode(message, binaryReq)
 	if err != nil {
 		return utils.Wrap(err, "")
 	}
+
 	if err := c.longConnServer.Validate(binaryReq); err != nil {
 		return utils.Wrap(err, "")
 	}
+
 	if binaryReq.SendID != c.UserID {
 		return utils.Wrap(errors.New("exception conn userID not same to req userID"), binaryReq.String())
 	}
+
 	ctx := mcontext.WithMustInfoCtx(
 		[]string{binaryReq.OperationID, binaryReq.SendID, constant.PlatformIDToName(c.PlatformID), c.ctx.GetConnID()},
 	)
+
 	log.ZDebug(ctx, "gateway req message", "req", binaryReq.String())
-	var messageErr error
-	var resp []byte
+
+	var (
+		resp       []byte
+		messageErr error
+	)
+
 	switch binaryReq.ReqIdentifier {
 	case WSGetNewestSeq:
 		resp, messageErr = c.longConnServer.GetSeq(ctx, binaryReq)
@@ -208,23 +222,29 @@ func (c *Client) handleMessage(message []byte) error {
 		)
 	}
 
-	return c.replyMessage(ctx, &binaryReq, messageErr, resp)
+	return c.replyMessage(ctx, binaryReq, messageErr, resp)
 }
 
-func (c *Client) setAppBackgroundStatus(ctx context.Context, req Req) ([]byte, error) {
+func (c *Client) setAppBackgroundStatus(ctx context.Context, req *Req) ([]byte, error) {
 	resp, isBackground, messageErr := c.longConnServer.SetUserDeviceBackground(ctx, req)
 	if messageErr != nil {
 		return nil, messageErr
 	}
+
 	c.IsBackground = isBackground
 	// todo callback
 	return resp, nil
 }
 
 func (c *Client) close() {
+	if c.closed.Load() {
+		return
+	}
+
 	c.w.Lock()
 	defer c.w.Unlock()
-	c.closed = true
+
+	c.closed.Store(true)
 	c.conn.Close()
 	c.longConnServer.UnRegister(c)
 }
@@ -244,6 +264,7 @@ func (c *Client) replyMessage(ctx context.Context, binaryReq *Req, err error, re
 	if err != nil {
 		log.ZWarn(ctx, "wireBinaryMsg replyMessage", err, "resp", mReply.String())
 	}
+
 	if binaryReq.ReqIdentifier == WsLogoutMsg {
 		return errors.New("user logout")
 	}
@@ -276,40 +297,48 @@ func (c *Client) KickOnlineMessage() error {
 	resp := Resp{
 		ReqIdentifier: WSKickOnlineMsg,
 	}
-	return c.writeBinaryMsg(resp)
+	err := c.writeBinaryMsg(resp)
+	c.close()
+	return err
 }
 
 func (c *Client) writeBinaryMsg(resp Resp) error {
-	c.w.Lock()
-	defer c.w.Unlock()
-	if c.closed == true {
+	if c.closed.Load() {
 		return nil
 	}
-	encodedBuf := bufferPool.Get().([]byte)
-	resultBuf := bufferPool.Get().([]byte)
+
 	encodedBuf, err := c.longConnServer.Encode(resp)
 	if err != nil {
 		return utils.Wrap(err, "")
 	}
+
+	c.w.Lock()
+	defer c.w.Unlock()
+
 	_ = c.conn.SetWriteDeadline(writeWait)
 	if c.IsCompress {
-		var compressErr error
-		resultBuf, compressErr = c.longConnServer.Compress(encodedBuf)
+		resultBuf, compressErr := c.longConnServer.Compress(encodedBuf)
 		if compressErr != nil {
 			return utils.Wrap(compressErr, "")
 		}
 		return c.conn.WriteMessage(MessageBinary, resultBuf)
-	} else {
-		return c.conn.WriteMessage(MessageBinary, encodedBuf)
 	}
+
+	return c.conn.WriteMessage(MessageBinary, encodedBuf)
 }
 
 func (c *Client) writePongMsg() error {
-	c.w.Lock()
-	defer c.w.Unlock()
-	if c.closed == true {
+	if c.closed.Load() {
 		return nil
 	}
-	_ = c.conn.SetWriteDeadline(writeWait)
+
+	c.w.Lock()
+	defer c.w.Unlock()
+
+	err := c.conn.SetWriteDeadline(writeWait)
+	if err != nil {
+		return utils.Wrap(err, "")
+	}
+
 	return c.conn.WriteMessage(PongMessage, nil)
 }

internal/msggateway/context.go

@@ -124,7 +124,9 @@ func (c *UserConnContext) GetOperationID() string {
 }
 
 func (c *UserConnContext) SetOperationID(operationID string) {
-	c.Req.URL.Query().Set(OperationID, operationID)
+	values := c.Req.URL.Query()
+	values.Set(OperationID, operationID)
+	c.Req.URL.RawQuery = values.Encode()
 }
 
 func (c *UserConnContext) GetToken() string {

internal/msggateway/hub_server.go

@@ -33,7 +33,6 @@ import (
 	"github.com/OpenIMSDK/tools/utils"
 
 	"github.com/openimsdk/open-im-server/v3/pkg/common/config"
-	"github.com/openimsdk/open-im-server/v3/pkg/common/prome"
 	"github.com/openimsdk/open-im-server/v3/pkg/common/startrpc"
 )
 
@@ -69,9 +68,10 @@ func (s *Server) SetLongConnServer(LongConnServer LongConnServer) {
 	s.LongConnServer = LongConnServer
 }
 
-func NewServer(rpcPort int, longConnServer LongConnServer) *Server {
+func NewServer(rpcPort int, proPort int, longConnServer LongConnServer) *Server {
 	return &Server{
 		rpcPort:        rpcPort,
+		prometheusPort: proPort,
 		LongConnServer: longConnServer,
 		pushTerminal:   []int{constant.IOSPlatformID, constant.AndroidPlatformID},
 	}
@@ -158,7 +158,6 @@ func (s *Server) SuperGroupOnlineBatchPushOneMsg(
 					} else {
 						if utils.IsContainInt(client.PlatformID, s.pushTerminal) {
 							tempT.OnlinePush = true
-							prome.Inc(prome.MsgOnlinePushSuccessCounter)
 							resp = append(resp, temp)
 						}
 					}

internal/msggateway/init.go

@@ -41,7 +41,7 @@ func RunWsAndServer(rpcPort, wsPort, prometheusPort int) error {
 	if err != nil {
 		return err
 	}
-	hubServer := NewServer(rpcPort, longServer)
+	hubServer := NewServer(rpcPort, prometheusPort, longServer)
 	go func() {
 		err := hubServer.Start()
 		if err != nil {

internal/msggateway/message_handler.go

@@ -16,6 +16,7 @@ package msggateway
 
 import (
 	"context"
+	"sync"
 
 	"github.com/OpenIMSDK/protocol/push"
 	"github.com/OpenIMSDK/tools/discoveryregistry"
@@ -49,6 +50,27 @@ func (r *Req) String() string {
 	return utils.StructToJsonString(tReq)
 }
 
+var reqPool = sync.Pool{
+	New: func() any {
+		return new(Req)
+	},
+}
+
+func getReq() *Req {
+	req := reqPool.Get().(*Req)
+	req.Data = nil
+	req.MsgIncr = ""
+	req.OperationID = ""
+	req.ReqIdentifier = 0
+	req.SendID = ""
+	req.Token = ""
+	return req
+}
+
+func freeReq(req *Req) {
+	reqPool.Put(req)
+}
+
 type Resp struct {
 	ReqIdentifier int32  `json:"reqIdentifier"`
 	MsgIncr       string `json:"msgIncr"`
@@ -69,12 +91,12 @@ func (r *Resp) String() string {
 }
 
 type MessageHandler interface {
-	GetSeq(context context.Context, data Req) ([]byte, error)
-	SendMessage(context context.Context, data Req) ([]byte, error)
-	SendSignalMessage(context context.Context, data Req) ([]byte, error)
-	PullMessageBySeqList(context context.Context, data Req) ([]byte, error)
-	UserLogout(context context.Context, data Req) ([]byte, error)
-	SetUserDeviceBackground(context context.Context, data Req) ([]byte, bool, error)
+	GetSeq(context context.Context, data *Req) ([]byte, error)
+	SendMessage(context context.Context, data *Req) ([]byte, error)
+	SendSignalMessage(context context.Context, data *Req) ([]byte, error)
+	PullMessageBySeqList(context context.Context, data *Req) ([]byte, error)
+	UserLogout(context context.Context, data *Req) ([]byte, error)
+	SetUserDeviceBackground(context context.Context, data *Req) ([]byte, bool, error)
 }
 
 var _ MessageHandler = (*GrpcHandler)(nil)
@@ -94,7 +116,7 @@ func NewGrpcHandler(validate *validator.Validate, client discoveryregistry.SvcDi
 	}
 }
 
-func (g GrpcHandler) GetSeq(context context.Context, data Req) ([]byte, error) {
+func (g GrpcHandler) GetSeq(context context.Context, data *Req) ([]byte, error) {
 	req := sdkws.GetMaxSeqReq{}
 	if err := proto.Unmarshal(data.Data, &req); err != nil {
 		return nil, err
@@ -113,7 +135,7 @@ func (g GrpcHandler) GetSeq(context context.Context, data Req) ([]byte, error) {
 	return c, nil
 }
 
-func (g GrpcHandler) SendMessage(context context.Context, data Req) ([]byte, error) {
+func (g GrpcHandler) SendMessage(context context.Context, data *Req) ([]byte, error) {
 	msgData := sdkws.MsgData{}
 	if err := proto.Unmarshal(data.Data, &msgData); err != nil {
 		return nil, err
@@ -133,7 +155,7 @@ func (g GrpcHandler) SendMessage(context context.Context, data Req) ([]byte, err
 	return c, nil
 }
 
-func (g GrpcHandler) SendSignalMessage(context context.Context, data Req) ([]byte, error) {
+func (g GrpcHandler) SendSignalMessage(context context.Context, data *Req) ([]byte, error) {
 	resp, err := g.msgRpcClient.SendMsg(context, nil)
 	if err != nil {
 		return nil, err
@@ -145,7 +167,7 @@ func (g GrpcHandler) SendSignalMessage(context context.Context, data Req) ([]byt
 	return c, nil
 }
 
-func (g GrpcHandler) PullMessageBySeqList(context context.Context, data Req) ([]byte, error) {
+func (g GrpcHandler) PullMessageBySeqList(context context.Context, data *Req) ([]byte, error) {
 	req := sdkws.PullMessageBySeqsReq{}
 	if err := proto.Unmarshal(data.Data, &req); err != nil {
 		return nil, err
@@ -164,7 +186,7 @@ func (g GrpcHandler) PullMessageBySeqList(context context.Context, data Req) ([]
 	return c, nil
 }
 
-func (g GrpcHandler) UserLogout(context context.Context, data Req) ([]byte, error) {
+func (g GrpcHandler) UserLogout(context context.Context, data *Req) ([]byte, error) {
 	req := push.DelUserPushTokenReq{}
 	if err := proto.Unmarshal(data.Data, &req); err != nil {
 		return nil, err
@@ -180,7 +202,7 @@ func (g GrpcHandler) UserLogout(context context.Context, data Req) ([]byte, erro
 	return c, nil
 }
 
-func (g GrpcHandler) SetUserDeviceBackground(_ context.Context, data Req) ([]byte, bool, error) {
+func (g GrpcHandler) SetUserDeviceBackground(_ context.Context, data *Req) ([]byte, bool, error) {
 	req := sdkws.SetAppBackgroundStatusReq{}
 	if err := proto.Unmarshal(data.Data, &req); err != nil {
 		return nil, false, err

internal/msggateway/n_ws_server.go

@@ -23,6 +23,8 @@ import (
 	"sync/atomic"
 	"time"
 
+	"github.com/openimsdk/open-im-server/v3/pkg/common/metrics"
+
 	"github.com/OpenIMSDK/protocol/msggateway"
 
 	"github.com/openimsdk/open-im-server/v3/pkg/authverify"
@@ -74,8 +76,8 @@ type WsServer struct {
 	kickHandlerChan   chan *kickHandler
 	clients           *UserMap
 	clientPool        sync.Pool
-	onlineUserNum     int64
-	onlineUserConnNum int64
+	onlineUserNum     atomic.Int64
+	onlineUserConnNum atomic.Int64
 	handshakeTimeout  time.Duration
 	hubServer         *Server
 	validate          *validator.Validate
@@ -220,36 +222,45 @@ func (ws *WsServer) registerClient(client *Client) {
 	if !userOK {
 		ws.clients.Set(client.UserID, client)
 		log.ZDebug(client.ctx, "user not exist", "userID", client.UserID, "platformID", client.PlatformID)
-		atomic.AddInt64(&ws.onlineUserNum, 1)
-		atomic.AddInt64(&ws.onlineUserConnNum, 1)
+		metrics.OnlineUserGauge.Add(1)
+		ws.onlineUserNum.Add(1)
+		ws.onlineUserConnNum.Add(1)
 	} else {
-		i := &kickHandler{
-			clientOK:   clientOK,
-			oldClients: oldClients,
-			newClient:  client,
-		}
-		ws.kickHandlerChan <- i
+		ws.multiTerminalLoginChecker(clientOK, oldClients, client)
 		log.ZDebug(client.ctx, "user exist", "userID", client.UserID, "platformID", client.PlatformID)
 		if clientOK {
 			ws.clients.Set(client.UserID, client)
 			// 已经有同平台的连接存在
 			log.ZInfo(client.ctx, "repeat login", "userID", client.UserID, "platformID", client.PlatformID, "old remote addr", getRemoteAdders(oldClients))
-			atomic.AddInt64(&ws.onlineUserConnNum, 1)
+			ws.onlineUserConnNum.Add(1)
 		} else {
 			ws.clients.Set(client.UserID, client)
-
-			atomic.AddInt64(&ws.onlineUserConnNum, 1)
+			ws.onlineUserConnNum.Add(1)
 		}
 	}
-	ws.sendUserOnlineInfoToOtherNode(client.ctx, client)
-	ws.SetUserOnlineStatus(client.ctx, client, constant.Online)
+
+	wg := sync.WaitGroup{}
+	wg.Add(1)
+	go func() {
+		defer wg.Done()
+		_ = ws.sendUserOnlineInfoToOtherNode(client.ctx, client)
+	}()
+
+	wg.Add(1)
+	go func() {
+		defer wg.Done()
+		ws.SetUserOnlineStatus(client.ctx, client, constant.Online)
+	}()
+
+	wg.Wait()
+
 	log.ZInfo(
 		client.ctx,
 		"user online",
 		"online user Num",
-		ws.onlineUserNum,
+		ws.onlineUserNum.Load(),
 		"online user conn Num",
-		ws.onlineUserConnNum,
+		ws.onlineUserConnNum.Load(),
 	)
 }
 
@@ -282,7 +293,7 @@ func (ws *WsServer) multiTerminalLoginChecker(clientOK bool, oldClients []*Clien
 		if clientOK {
 			isDeleteUser := ws.clients.deleteClients(newClient.UserID, oldClients)
 			if isDeleteUser {
-				atomic.AddInt64(&ws.onlineUserNum, -1)
+				ws.onlineUserNum.Add(-1)
 			}
 			for _, c := range oldClients {
 				err := c.KickOnlineMessage()
@@ -350,18 +361,19 @@ func (ws *WsServer) unregisterClient(client *Client) {
 	defer ws.clientPool.Put(client)
 	isDeleteUser := ws.clients.delete(client.UserID, client.ctx.GetRemoteAddr())
 	if isDeleteUser {
-		atomic.AddInt64(&ws.onlineUserNum, -1)
+		ws.onlineUserNum.Add(-1)
+		metrics.OnlineUserGauge.Dec()
 	}
-	atomic.AddInt64(&ws.onlineUserConnNum, -1)
+	ws.onlineUserConnNum.Add(-1)
 	ws.SetUserOnlineStatus(client.ctx, client, constant.Offline)
 	log.ZInfo(client.ctx, "user offline", "close reason", client.closedErr, "online user Num", ws.onlineUserNum, "online user conn Num",
-		ws.onlineUserConnNum,
+		ws.onlineUserConnNum.Load(),
 	)
 }
 
 func (ws *WsServer) wsHandler(w http.ResponseWriter, r *http.Request) {
 	connContext := newContext(w, r)
-	if ws.onlineUserConnNum >= ws.wsMaxConnNum {
+	if ws.onlineUserConnNum.Load() >= ws.wsMaxConnNum {
 		httpError(connContext, errs.ErrConnOverMaxNumLimit)
 		return
 	}

internal/msgtransfer/init.go

@@ -15,11 +15,19 @@
 package msgtransfer
 
 import (
+	"errors"
 	"fmt"
-	"github.com/openimsdk/open-im-server/v3/pkg/common/discovery_register"
+	"log"
+	"net/http"
+	"sync"
+
+	"github.com/openimsdk/open-im-server/v3/pkg/common/kdisc"
+	"github.com/openimsdk/open-im-server/v3/pkg/common/metrics"
+	"github.com/prometheus/client_golang/prometheus"
+	"github.com/prometheus/client_golang/prometheus/collectors"
+	"github.com/prometheus/client_golang/prometheus/promhttp"
 	"google.golang.org/grpc"
 	"google.golang.org/grpc/credentials/insecure"
-	"sync"
 
 	"github.com/OpenIMSDK/tools/mw"
 
@@ -29,7 +37,6 @@ import (
 	"github.com/openimsdk/open-im-server/v3/pkg/common/db/relation"
 	relationtb "github.com/openimsdk/open-im-server/v3/pkg/common/db/table/relation"
 	"github.com/openimsdk/open-im-server/v3/pkg/common/db/unrelation"
-	"github.com/openimsdk/open-im-server/v3/pkg/common/prome"
 	"github.com/openimsdk/open-im-server/v3/pkg/rpcclient"
 )
 
@@ -59,7 +66,7 @@ func StartTransfer(prometheusPort int) error {
 	if err := mongo.CreateMsgIndex(); err != nil {
 		return err
 	}
-	client, err := discovery_register.NewDiscoveryRegister(config.Config.Envs.Discovery)
+	client, err := kdisc.NewDiscoveryRegister(config.Config.Envs.Discovery)
 	/*
 		client, err := openkeeper.NewClient(config.Config.Zookeeper.ZkAddr, config.Config.Zookeeper.Schema,
 			openkeeper.WithFreq(time.Hour), openkeeper.WithRoundRobin(), openkeeper.WithUserNameAndPassword(config.Config.Zookeeper.Username,
@@ -79,7 +86,6 @@ func StartTransfer(prometheusPort int) error {
 	conversationRpcClient := rpcclient.NewConversationRpcClient(client)
 	groupRpcClient := rpcclient.NewGroupRpcClient(client)
 	msgTransfer := NewMsgTransfer(chatLogDatabase, msgDatabase, &conversationRpcClient, &groupRpcClient)
-	msgTransfer.initPrometheus()
 	return msgTransfer.Start(prometheusPort)
 }
 
@@ -93,21 +99,13 @@ func NewMsgTransfer(chatLogDatabase controller.ChatLogDatabase,
 	}
 }
 
-func (m *MsgTransfer) initPrometheus() {
-	prome.NewSeqGetSuccessCounter()
-	prome.NewSeqGetFailedCounter()
-	prome.NewSeqSetSuccessCounter()
-	prome.NewSeqSetFailedCounter()
-	prome.NewMsgInsertRedisSuccessCounter()
-	prome.NewMsgInsertRedisFailedCounter()
-	prome.NewMsgInsertMongoSuccessCounter()
-	prome.NewMsgInsertMongoFailedCounter()
-}
-
 func (m *MsgTransfer) Start(prometheusPort int) error {
 	var wg sync.WaitGroup
 	wg.Add(1)
 	fmt.Println("start msg transfer", "prometheusPort:", prometheusPort)
+	if prometheusPort <= 0 {
+		return errors.New("prometheusPort not correct")
+	}
 	if config.Config.ChatPersistenceMysql {
 		// go m.persistentCH.persistentConsumerGroup.RegisterHandleAndConsumer(m.persistentCH)
 	} else {
@@ -116,10 +114,21 @@ func (m *MsgTransfer) Start(prometheusPort int) error {
 	go m.historyCH.historyConsumerGroup.RegisterHandleAndConsumer(m.historyCH)
 	go m.historyMongoCH.historyConsumerGroup.RegisterHandleAndConsumer(m.historyMongoCH)
 	// go m.modifyCH.modifyMsgConsumerGroup.RegisterHandleAndConsumer(m.modifyCH)
-	err := prome.StartPrometheusSrv(prometheusPort)
+	/*err := prome.StartPrometheusSrv(prometheusPort)
 	if err != nil {
 		return err
+	}*/
+	////////////////////////////
+	if config.Config.Prometheus.Enable {
+		reg := prometheus.NewRegistry()
+		reg.MustRegister(
+			collectors.NewGoCollector(),
+		)
+		reg.MustRegister(metrics.GetGrpcCusMetrics("Transfer")...)
+		http.Handle("/metrics", promhttp.HandlerFor(reg, promhttp.HandlerOpts{Registry: reg}))
+		log.Fatal(http.ListenAndServe(fmt.Sprintf(":%d", prometheusPort), nil))
 	}
+	////////////////////////////////////////
 	wg.Wait()
 	return nil
 }