fix update user.FaceURL do not trigger GroupMemberInfoSetNotification (#1267)

* fix update user.FaceURL do not trigger GroupMemberInfoSetNotification

* cicd: robot automated Change

---------

Co-authored-by: a3d21 <a3d21@users.noreply.github.com>

.dockerignore

@@ -1,4 +1,4 @@
-<!-- # Ignore files and directories starting with a dot
+# Ignore files and directories starting with a dot
 
 # Ignore specific files
 .dockerignore
@@ -29,4 +29,4 @@ assets/
 components/
 
 # Ignore tools and scripts
-.github/ -->
+.github/

.env

@@ -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.
+
 # ======================================
 # ========= Basic Configuration ========
 # ======================================
@@ -16,7 +30,7 @@ MINIO_ENDPOINT=http://172.28.0.1:10005
 
 # Base URL for the application programming interface (API).
 # Default: API_URL=http://172.28.0.1:10002
-API_URL=http://172.28.0.1:10002
+API_URL=http://127.0.0.1:10002
 
 # Directory path for storing data files or related information.
 # Default: DATA_DIR=./
@@ -213,7 +227,6 @@ OPENIM_WEB_PORT=11001
 # Default: OPENIM_WEB_ADDRESS=172.28.0.1
 OPENIM_WEB_ADDRESS=172.28.0.8
 
-
 # ======================================
 # ========= OpenIM Server ==============
 # ======================================

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

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

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

@@ -30,7 +30,7 @@ jobs:
     # && github.event.pull_request.merged == true
     steps:
         - name: Check out code
-          uses: actions/checkout@v3
+          uses: actions/checkout@v4
           with:
             fetch-depth: 0
 
@@ -51,7 +51,7 @@ jobs:
             # 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"
+            # 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 }}

.github/workflows/auto-tag.yml

@@ -26,7 +26,7 @@ jobs:
     if: startsWith(github.event.comment.body, '/create tag')
     steps:
       - name: Checkout code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Validate version number and get comment
         id: validate

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

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

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

@@ -15,6 +15,8 @@
 name: Publish Docker image
 
 on:
+  schedule:
+  - cron: '30 2 * * *'
   push:
     branches:
       - main
@@ -32,16 +34,16 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Set up QEMU
-        uses: docker/setup-qemu-action@v2
+        uses: docker/setup-qemu-action@v3
       - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v2
+        uses: docker/setup-buildx-action@v3
 
 # docker.io/openim/openim-server:latest
       - name: Extract metadata (tags, labels) for Docker
         id: meta
-        uses: docker/metadata-action@v4.6.0
+        uses: docker/metadata-action@v5.0.0
         with:
           images: openim/openim-server
           # generate Docker tags based on the following events/attributes
@@ -55,13 +57,13 @@ jobs:
             type=sha
 
       - name: Log in to Docker Hub
-        uses: docker/login-action@v2
+        uses: docker/login-action@v3
         with:
           username: ${{ secrets.DOCKER_USERNAME }}
           password: ${{ secrets.DOCKER_PASSWORD }}
 
       - name: Build and push Docker image
-        uses: docker/build-push-action@v4
+        uses: docker/build-push-action@v5
         with:
           context: .
           # linux/ppc64le,linux/s390x
@@ -74,27 +76,27 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Set up QEMU
-        uses: docker/setup-qemu-action@v2
+        uses: docker/setup-qemu-action@v3
       - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v2
+        uses: docker/setup-buildx-action@v3
 # registry.cn-hangzhou.aliyuncs.com/openimsdk/openim-server:latest
       - name: Extract metadata (tags, labels) for Docker
         id: meta2
-        uses: docker/metadata-action@v4.6.0
+        uses: docker/metadata-action@v5.0.0
         with:
           images: registry.cn-hangzhou.aliyuncs.com/openimsdk/openim-server
 
       - name: Log in to AliYun Docker Hub
-        uses: docker/login-action@v2
+        uses: docker/login-action@v3
         with:
           registry: registry.cn-hangzhou.aliyuncs.com
           username: ${{ secrets.ALIREGISTRY_USERNAME }}
           password: ${{ secrets.ALIREGISTRY_TOKEN }}
       
       - name: Build and push Docker image
-        uses: docker/build-push-action@v4
+        uses: docker/build-push-action@v5
         with:
           context: .
           # linux/ppc64le,linux/s390x
@@ -107,27 +109,36 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Set up QEMU
-        uses: docker/setup-qemu-action@v2
+        uses: docker/setup-qemu-action@v3
       - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v2
+        uses: docker/setup-buildx-action@v3
 # ghcr.io/openimsdk/openim-server:latest
       - name: Extract metadata (tags, labels) for Docker
         id: meta3
-        uses: docker/metadata-action@v4.6.0
+        uses: docker/metadata-action@v5.0.0
         with:
           images: ghcr.io/openimsdk/openim-server
+          # generate Docker tags based on the following events/attributes
+          tags: |
+            type=schedule
+            type=ref,event=branch
+            type=ref,event=pr
+            type=semver,pattern={{version}}
+            type=semver,pattern={{major}}.{{minor}}
+            type=semver,pattern={{major}}
+            type=sha
 
       - name: Log in to GitHub Container Registry
-        uses: docker/login-action@v2
+        uses: docker/login-action@v3
         with:
           registry: ghcr.io
           username: ${{ github.repository_owner }}
           password: ${{ secrets.GITHUB_TOKEN }}
 
       - name: Build and push Docker image
-        uses: docker/build-push-action@v4
+        uses: docker/build-push-action@v5
         with:
           context: .
           # linux/ppc64le,linux/s390x

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

@@ -15,6 +15,8 @@
 name: Build OpenIM Web Docker image
 
 on:
+  schedule:
+  - cron: '30 3 * * *'
   push:
     branches:
       - main
@@ -28,130 +30,22 @@ env:
   GO_VERSION: "1.20"
 
 jobs:
-  build-dockerhub:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v3
-      - name: Set up QEMU
-        uses: docker/setup-qemu-action@v2
-      - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v2
-
-# docker.io/openim/openim-server:latest
-      - name: Extract metadata (tags, labels) for Docker
-        id: meta
-        uses: docker/metadata-action@v4.6.0
-        with:
-          images: openim/openim-server
-          # generate Docker tags based on the following events/attributes
-          tags: |
-            type=schedule
-            type=ref,event=branch
-            type=ref,event=pr
-            type=semver,pattern={{version}}
-            type=semver,pattern={{major}}.{{minor}}
-            type=semver,pattern={{major}}
-            type=sha
-
-      - name: Log in to Docker Hub
-        uses: docker/login-action@v2
-        with:
-          username: ${{ secrets.DOCKER_USERNAME }}
-          password: ${{ secrets.DOCKER_PASSWORD }}
-
-      - name: Build and push Docker image
-        uses: docker/build-push-action@v4
-        with:
-          context: .
-          # linux/ppc64le,linux/s390x
-          platforms: linux/amd64,linux/arm64
-          push: ${{ github.event_name != 'pull_request' }}
-          tags: ${{ steps.meta.outputs.tags }}
-          labels: ${{ steps.meta.outputs.labels }}
-
-  build-aliyun:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v3
-      - name: Set up QEMU
-        uses: docker/setup-qemu-action@v2
-      - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v2
-# registry.cn-hangzhou.aliyuncs.com/openimsdk/openim-server:latest
-      - name: Extract metadata (tags, labels) for Docker
-        id: meta2
-        uses: docker/metadata-action@v4.6.0
-        with:
-          images: registry.cn-hangzhou.aliyuncs.com/openimsdk/openim-server
-
-      - name: Log in to AliYun Docker Hub
-        uses: docker/login-action@v2
-        with:
-          registry: registry.cn-hangzhou.aliyuncs.com
-          username: ${{ secrets.ALIREGISTRY_USERNAME }}
-          password: ${{ secrets.ALIREGISTRY_TOKEN }}
-      
-      - name: Build and push Docker image
-        uses: docker/build-push-action@v4
-        with:
-          context: .
-          # linux/ppc64le,linux/s390x
-          platforms: linux/amd64,linux/arm64
-          push: ${{ github.event_name != 'pull_request' }}
-          tags: ${{ steps.meta2.outputs.tags }}
-          labels: ${{ steps.meta2.outputs.labels }}
-
-  build-ghcr:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v3
-      - name: Set up QEMU
-        uses: docker/setup-qemu-action@v2
-      - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v2
-# ghcr.io/openimsdk/openim-server:latest
-      - name: Extract metadata (tags, labels) for Docker
-        id: meta3
-        uses: docker/metadata-action@v4.6.0
-        with:
-          images: ghcr.io/openimsdk/openim-server
-
-      - name: Log in to GitHub Container Registry
-        uses: docker/login-action@v2
-        with:
-          registry: ghcr.io
-          username: ${{ github.repository_owner }}
-          password: ${{ secrets.GITHUB_TOKEN }}
-
-      - name: Build and push Docker image
-        uses: docker/build-push-action@v4
-        with:
-          context: .
-          # linux/ppc64le,linux/s390x
-          platforms: linux/amd64,linux/arm64
-          push: ${{ github.event_name != 'pull_request' }}
-          tags: ${{ steps.meta3.outputs.tags }}
-          labels: ${{ steps.meta3.outputs.labels }}
-
   build-openim-web-dockerhub:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Set up QEMU
-        uses: docker/setup-qemu-action@v2
+        uses: docker/setup-qemu-action@v3
       - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v2
+        uses: docker/setup-buildx-action@v3
 
-# docker.io/openim/openim-server:latest
+# docker.io/openim/openim-web:latest
       - name: Extract metadata (tags, labels) for Docker
         id: meta
-        uses: docker/metadata-action@v4.6.0
+        uses: docker/metadata-action@v5.0.0
         with:
-          images: openim/openim-server
+          images: openim/openim-web
           # generate Docker tags based on the following events/attributes
           tags: |
             type=schedule
@@ -163,13 +57,13 @@ jobs:
             type=sha
 
       - name: Log in to Docker Hub
-        uses: docker/login-action@v2
+        uses: docker/login-action@v3
         with:
           username: ${{ secrets.DOCKER_USERNAME }}
           password: ${{ secrets.DOCKER_PASSWORD }}
 
       - name: Build and push Docker image
-        uses: docker/build-push-action@v4
+        uses: docker/build-push-action@v5
         with:
           context: .
           file: ./build/images/openim-tools/openim-web/Dockerfile
@@ -182,27 +76,27 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Set up QEMU
-        uses: docker/setup-qemu-action@v2
+        uses: docker/setup-qemu-action@v3
       - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v2
-# registry.cn-hangzhou.aliyuncs.com/openimsdk/openim-server:latest
+        uses: docker/setup-buildx-action@v3
+# registry.cn-hangzhou.aliyuncs.com/openimsdk/openim-web:latest
       - name: Extract metadata (tags, labels) for Docker
         id: meta2
-        uses: docker/metadata-action@v4.6.0
+        uses: docker/metadata-action@v5.0.0
         with:
-          images: registry.cn-hangzhou.aliyuncs.com/openimsdk/openim-server
+          images: registry.cn-hangzhou.aliyuncs.com/openimsdk/openim-web
 
       - name: Log in to AliYun Docker Hub
-        uses: docker/login-action@v2
+        uses: docker/login-action@v3
         with:
           registry: registry.cn-hangzhou.aliyuncs.com
           username: ${{ secrets.ALIREGISTRY_USERNAME }}
           password: ${{ secrets.ALIREGISTRY_TOKEN }}
       
       - name: Build and push Docker image
-        uses: docker/build-push-action@v4
+        uses: docker/build-push-action@v5
         with:
           context: .
           file: ./build/images/openim-tools/openim-web/Dockerfile
@@ -215,60 +109,31 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Set up QEMU
-        uses: docker/setup-qemu-action@v2
+        uses: docker/setup-qemu-action@v3
       - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v2
+        uses: docker/setup-buildx-action@v3
+# ghcr.io/openimsdk/openim-web:latest
+      - name: Extract metadata (tags, labels) for Docker
+        id: meta2
+        uses: docker/metadata-action@v5.0.0
         with:
-          install: true
-      - name: Cache Docker layers
-        uses: actions/cache@v3
-        with:
-          path: /tmp/.buildx-cache
-          key: ${{ runner.os }}-buildx-${{ github.sha }}
-          restore-keys: |
-            ${{ runner.os }}-buildx-
+          images: ghcr.io/openimsdk/openim-web
 
       - name: Log in to GitHub Container Registry
-        uses: docker/login-action@v2
+        uses: docker/login-action@v3
         with:
           registry: ghcr.io
           username: ${{ github.repository_owner }}
           password: ${{ secrets.GITHUB_TOKEN }}
 
-      - name: Extract metadata (tags, labels) for Docker openim-web
-        id: meta1
-        uses: docker/metadata-action@v4.6.0
-        with:
-          images: ghcr.io/openimsdk/openim-web
-
-      - name: Build and push Docker image for openim-web
-        uses: docker/build-push-action@v4
+      - name: Build and push Docker image
+        uses: docker/build-push-action@v5
         with:
           context: .
           file: ./build/images/openim-tools/openim-web/Dockerfile
           platforms: linux/amd64,linux/arm64
           push: ${{ github.event_name != 'pull_request' }}
-          tags: ${{ steps.meta1.outputs.tags }}
-          labels: ${{ steps.meta1.outputs.labels }}
-          cache-from: type=local,src=/tmp/.buildx-cache
-          cache-to: type=local,dest=/tmp/.buildx-cache
-
-      - name: Extract metadata (tags, labels) for Docker openim-web
-        id: meta2
-        uses: docker/metadata-action@v4.6.0
-        with:
-          images: ghcr.io/openimsdk/component
-
-      - name: Build and push Docker image for component
-        uses: docker/build-push-action@v4
-        with:
-          context: .
-          file: ./build/images/openim-tools/component/Dockerfile
-          platforms: linux/amd64,linux/arm64
-          push: ${{ github.event_name != 'pull_request' }}
           tags: ${{ steps.meta2.outputs.tags }}
-          labels: ${{ steps.meta2.outputs.labels }}
-          cache-from: type=local,src=/tmp/.buildx-cache
-          cache-to: type=local,dest=/tmp/.buildx-cache
+          labels: ${{ steps.meta2.outputs.labels }}

.github/workflows/check-coverage.yml

@@ -41,7 +41,7 @@ jobs:
     runs-on: ubuntu-20.04
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Setup Golang with cache
         uses: magnetikonline/action-golang-cache@v4

.github/workflows/cla.yml

@@ -41,7 +41,7 @@ jobs:
     steps:
       - name: "CLA Assistant"
         if: (github.event.comment.body == 'recheck' || github.event.comment.body == 'I have read the CLA Document and I hereby sign the CLA') || github.event_name == 'pull_request_target'
-        uses: contributor-assistant/github-action@v2.3.0
+        uses: contributor-assistant/github-action@v2.3.1
         env:
           GITHUB_TOKEN: ${{ secrets.BOT_GITHUB_TOKEN }}
           PERSONAL_ACCESS_TOKEN: ${{ secrets.REDBOT_GITHUB_TOKEN }}

.github/workflows/codeql-analysis.yml

@@ -47,7 +47,7 @@ jobs:
 
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       # Initializes the CodeQL tools for scanning.
       - name: Initialize CodeQL

.github/workflows/create_branch_on_tag.yml

@@ -24,7 +24,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - name: Check out code
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
       with:
         fetch-depth: 0
 
@@ -48,7 +48,7 @@ jobs:
         fi
 
     - name: Push Changes
-      uses: stefanzweifel/git-auto-commit-action@v4
+      uses: stefanzweifel/git-auto-commit-action@v5
       with:
         commit_message: "Auto Commit CHANGELOG"
         branch: release-v${VERSION_PARTS[0]}.${VERSION_PARTS[1]}
@@ -68,7 +68,7 @@ jobs:
         fi
 
     - name: Push Changes
-      uses: stefanzweifel/git-auto-commit-action@v4
+      uses: stefanzweifel/git-auto-commit-action@v5
       with:
         commit_message: "Auto Commit CHANGELOG"
         branch: main

.github/workflows/deploy.yml

@@ -31,7 +31,7 @@ jobs:
   deploy-dev:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: executing remote ssh commands using password
         uses: appleboy/ssh-action@v1.0.0
         env:

.github/workflows/depsreview.yaml

@@ -13,6 +13,6 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: 'Checkout Repository'
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: 'Dependency Review'
         uses: actions/dependency-review-action@v3

.github/workflows/docker-buildx.yml

@@ -29,13 +29,13 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         
       - name: Set up QEMU
-        uses: docker/setup-qemu-action@v2
+        uses: docker/setup-qemu-action@v3
         
       - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v2
+        uses: docker/setup-buildx-action@v3
         with:
           install: true
 
@@ -48,7 +48,7 @@ jobs:
             ${{ runner.os }}-buildx-
 
       - name: Log in to GitHub Container Registry
-        uses: docker/login-action@v2
+        uses: docker/login-action@v3
         with:
           registry: ghcr.io
           username: ${{ github.repository_owner }}
@@ -87,12 +87,12 @@ jobs:
 
       - name: Extract metadata (tags, labels) for Docker openim-api
         id: meta1
-        uses: docker/metadata-action@v4.6.0
+        uses: docker/metadata-action@v5.0.0
         with:
           images: ghcr.io/openimsdk/openim-api
 
       - name: Build and push Docker image for openim-api
-        uses: docker/build-push-action@v4
+        uses: docker/build-push-action@v5
         with:
           context: .
           file: ./build/images/openim-api/Dockerfile
@@ -105,12 +105,12 @@ jobs:
 
       - name: Extract metadata (tags, labels) for Docker openim-cmdutils
         id: meta2
-        uses: docker/metadata-action@v4.6.0
+        uses: docker/metadata-action@v5.0.0
         with:
           images: ghcr.io/openimsdk/openim-cmdutils
 
       - name: Build and push Docker image for openim-cmdutils
-        uses: docker/build-push-action@v4
+        uses: docker/build-push-action@v5
         with:
           context: .
           file: ./build/images/openim-cmdutils/Dockerfile
@@ -123,12 +123,12 @@ jobs:
 
       - name: Extract metadata (tags, labels) for Docker openim-crontask
         id: meta3
-        uses: docker/metadata-action@v4.6.0
+        uses: docker/metadata-action@v5.0.0
         with:
           images: ghcr.io/openimsdk/openim-crontask
 
       - name: Build and push Docker image for openim-crontask
-        uses: docker/build-push-action@v4
+        uses: docker/build-push-action@v5
         with:
           context: .
           file: ./build/images/openim-crontask/Dockerfile
@@ -141,12 +141,12 @@ jobs:
 
       - name: Extract metadata (tags, labels) for Docker openim-msggateway
         id: meta4
-        uses: docker/metadata-action@v4.6.0
+        uses: docker/metadata-action@v5.0.0
         with:
           images: ghcr.io/openimsdk/openim-msggateway
 
       - name: Build and push Docker image for openim-msggateway
-        uses: docker/build-push-action@v4
+        uses: docker/build-push-action@v5
         with:
           context: .
           file: ./build/images/openim-msggateway/Dockerfile
@@ -159,12 +159,12 @@ jobs:
 
       - name: Extract metadata (tags, labels) for Docker openim-msgtransfer
         id: meta5
-        uses: docker/metadata-action@v4.6.0
+        uses: docker/metadata-action@v5.0.0
         with:
           images: ghcr.io/openimsdk/openim-msgtransfer
 
       - name: Build and push Docker image for openim-msgtransfer
-        uses: docker/build-push-action@v4
+        uses: docker/build-push-action@v5
         with:
           context: .
           file: ./build/images/openim-msgtransfer/Dockerfile
@@ -177,12 +177,12 @@ jobs:
           
       - name: Extract metadata (tags, labels) for Docker openim-push
         id: meta6
-        uses: docker/metadata-action@v4.6.0
+        uses: docker/metadata-action@v5.0.0
         with:
           images: ghcr.io/openimsdk/openim-push
 
       - name: Build and push Docker image for openim-push
-        uses: docker/build-push-action@v4
+        uses: docker/build-push-action@v5
         with:
           context: .
           file: ./build/images/openim-push/Dockerfile
@@ -195,12 +195,12 @@ jobs:
 
       - name: Extract metadata (tags, labels) for Docker openim-rpc-auth
         id: meta7
-        uses: docker/metadata-action@v4.6.0
+        uses: docker/metadata-action@v5.0.0
         with:
           images: ghcr.io/openimsdk/openim-rpc-auth
 
       - name: Build and push Docker image for openim-rpc-auth
-        uses: docker/build-push-action@v4
+        uses: docker/build-push-action@v5
         with:
           context: .
           file: ./build/images/openim-rpc-auth/Dockerfile
@@ -213,12 +213,12 @@ jobs:
 
       - name: Extract metadata (tags, labels) for Docker openim-rpc-conversation
         id: meta8
-        uses: docker/metadata-action@v4.6.0
+        uses: docker/metadata-action@v5.0.0
         with:
           images: ghcr.io/openimsdk/openim-rpc-conversation
 
       - name: Build and push Docker image for openim-rpc-conversation
-        uses: docker/build-push-action@v4
+        uses: docker/build-push-action@v5
         with:
           context: .
           file: ./build/images/openim-rpc-conversation/Dockerfile
@@ -231,12 +231,12 @@ jobs:
 
       - name: Extract metadata (tags, labels) for Docker openim-rpc-friend
         id: meta9
-        uses: docker/metadata-action@v4.6.0
+        uses: docker/metadata-action@v5.0.0
         with:
           images: ghcr.io/openimsdk/openim-rpc-friend
 
       - name: Build and push Docker image for openim-rpc-friend
-        uses: docker/build-push-action@v4
+        uses: docker/build-push-action@v5
         with:
           context: .
           file: ./build/images/openim-rpc-friend/Dockerfile
@@ -249,12 +249,12 @@ jobs:
 
       - name: Extract metadata (tags, labels) for Docker openim-rpc-group
         id: meta10
-        uses: docker/metadata-action@v4.6.0
+        uses: docker/metadata-action@v5.0.0
         with:
           images: ghcr.io/openimsdk/openim-rpc-group
 
       - name: Build and push Docker image for openim-rpc-group
-        uses: docker/build-push-action@v4
+        uses: docker/build-push-action@v5
         with:
           context: .
           file: ./build/images/openim-rpc-group/Dockerfile
@@ -267,12 +267,12 @@ jobs:
 
       - name: Extract metadata (tags, labels) for Docker openim-rpc-msg
         id: meta11
-        uses: docker/metadata-action@v4.6.0
+        uses: docker/metadata-action@v5.0.0
         with:
           images: ghcr.io/openimsdk/openim-rpc-msg
 
       - name: Build and push Docker image for openim-rpc-msg
-        uses: docker/build-push-action@v4
+        uses: docker/build-push-action@v5
         with:
           context: .
           file: ./build/images/openim-rpc-msg/Dockerfile
@@ -285,12 +285,12 @@ jobs:
 
       - name: Extract metadata (tags, labels) for Docker openim-rpc-third
         id: meta12
-        uses: docker/metadata-action@v4.6.0
+        uses: docker/metadata-action@v5.0.0
         with:
           images: ghcr.io/openimsdk/openim-rpc-third
 
       - name: Build and push Docker image for openim-rpc-third
-        uses: docker/build-push-action@v4
+        uses: docker/build-push-action@v5
         with:
           context: .
           file: ./build/images/openim-rpc-third/Dockerfile
@@ -303,12 +303,12 @@ jobs:
 
       - name: Extract metadata (tags, labels) for Docker openim-rpc-user
         id: meta13
-        uses: docker/metadata-action@v4.6.0
+        uses: docker/metadata-action@v5.0.0
         with:
           images: ghcr.io/openimsdk/openim-rpc-user
 
       - name: Build and push Docker image for openim-rpc-user
-        uses: docker/build-push-action@v4
+        uses: docker/build-push-action@v5
         with:
           context: .
           file: ./build/images/openim-rpc-user/Dockerfile

.github/workflows/e2e-test.yml

@@ -31,13 +31,13 @@ jobs:
     steps:
 
       - name: Set up Go 1.21
-        uses: actions/setup-go@v2
+        uses: actions/setup-go@v4
         with:
           go-version: 1.21
         id: go
 
       - name: Check out code into the Go module directory
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
 
       - name: Create e2e test
         run: |

.github/workflows/golangci-lint.yml

@@ -23,7 +23,7 @@ jobs:
       name: lint
       runs-on: ubuntu-latest
       steps:
-        - uses: actions/checkout@v3
+        - uses: actions/checkout@v4
         - uses: actions/setup-go@v4
           with:
             go-version: '1.21'

.github/workflows/gosec.yml

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

.github/workflows/greetings.yml

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

.github/workflows/link-pr.yml

@@ -23,7 +23,7 @@ jobs:
   linkChecker:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - name: Link Checker
         id: lychee

.github/workflows/opencommit.yml

@@ -30,7 +30,7 @@ jobs:
         uses: actions/setup-node@v3
         with:
           node-version: '16'
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           fetch-depth: 0
       - uses: di-sukharev/opencommit@github-action-v1.0.4

.github/workflows/openimci.yml

@@ -48,12 +48,12 @@ jobs:
 
     strategy:
       matrix:
-        go_version: ["1.18","1.19","1.20","1.21"]
+        go_version: ["1.19","1.20","1.21"]
         os: [ubuntu-latest]
 
     steps:
     - name: Setup
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
       
     - name: Set up Go ${{ matrix.go_version }}
       uses: actions/setup-go@v4
@@ -86,7 +86,7 @@ jobs:
       run: sudo make clean
 
     - name: Push Changes to Main
-      uses: stefanzweifel/git-auto-commit-action@v4
+      uses: stefanzweifel/git-auto-commit-action@v5
       with:
         commit_message: "cicd: robot automated Change"
         branch: main
@@ -118,7 +118,7 @@ jobs:
         os: ["ubuntu-latest"]
     steps:
     - name: Checkout and Install OpenIM
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
     - name: Install Task
       uses: arduino/setup-task@v1
       with:
@@ -138,7 +138,7 @@ jobs:
         os: ["ubuntu-latest"]
     steps:
     - name: Checkout code
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
 
     - name: Set up Go ${{ matrix.go_version }}
       uses: actions/setup-go@v4
@@ -151,7 +151,7 @@ jobs:
         version: 2.x
     - name: Docker Operations
       run: |
-        curl -o docker-compose.yaml https://raw.githubusercontent.com/OpenIMSDK/openim-docker/main/example/basic-openim-server-dependency.yml
+        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
 

.github/workflows/pull-request.yml

@@ -33,7 +33,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           fetch-depth: 0
 
@@ -114,7 +114,7 @@ jobs:
             - [ ] Disenchanter can connect and issue actions
             
             This is an automated PR. @ ${{ github.actor }}
-            <sub>[workflow](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/.github/workflows/pull-request.yml).</sub>
+            <sub>[workflow](https://github.com/openimsdk/open-im-server/blob/main/.github/workflows/pull-request.yml).</sub>
           base: main
           labels: |
             kind/documentation

.github/workflows/release.yml

@@ -29,7 +29,7 @@ jobs:
   goreleaser:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           fetch-depth: 0
       - run: git fetch --force --tags
@@ -38,7 +38,7 @@ jobs:
           go-version: stable
       # More assembly might be required: Docker logins, GPG, etc. It all depends
       # on your needs.
-      - uses: goreleaser/goreleaser-action@v4
+      - uses: goreleaser/goreleaser-action@v5
         with:
           # either 'goreleaser' (default) or 'goreleaser-pro':
           distribution: goreleaser
@@ -63,14 +63,14 @@ jobs:
       matrix:
         format: [ deb, rpm, apk ]
     steps:
-      - uses: actions/checkout@v3 # v3
+      - uses: actions/checkout@v4 # v3
         with:
           fetch-depth: 0
       - uses: arduino/setup-task@e26d8975574116b0097a1161e0fe16ba75d84c1c # v1
         with:
           version: 3.x
           repo-token: ${{ secrets.GITHUB_TOKEN }}
-      - uses: docker/setup-qemu-action@2b82ce82d56a2a04d2637cd93a637ae1b359c0a7 # v2
+      - uses: docker/setup-qemu-action@326560df218a7ea9cf6ab49bbc88b8b306bb437e # v2
       - uses: actions/cache@88522ab9f39a2ea568f7027eddc7d8d8bc9d59c8 # v3
         with:
           path: |

.github/workflows/scripts-verify.yml

@@ -52,7 +52,7 @@ jobs:
 
     steps:
     - name: Setup
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
       
     - name: In ${{ matrix.os }} Execute the script validation code
       uses: actions/setup-go@v4

.github/workflows/sync-release.yml

@@ -19,7 +19,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Run GitHub File Sync
         uses: BetaHuhn/repo-file-sync-action@latest

.github/workflows/sync.yml

@@ -15,7 +15,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Run GitHub File Sync
         uses: BetaHuhn/repo-file-sync-action@latest

.golangci.yml

@@ -171,12 +171,12 @@ linters-settings:
   #   exclude_godoc_examples: false
   funlen:
     lines: 150
-    statements: 50
+    statements: 80
   gci:
     # put imports beginning with prefix after 3rd-party packages;
     # only support one prefix
     # if not set, use goimports.local-prefixes
-    prefix: github.com/OpenIMSDK/Open-IM-Server
+    prefix: github.com/openimsdk/open-im-server
   gocognit:
     # minimal code complexity to report, 30 by default (but we recommend 10-20)
     min-complexity: 30
@@ -333,7 +333,7 @@ linters-settings:
   goimports:
     # put imports beginning with prefix after 3rd-party packages;
     # it's a comma-separated list of prefixes
-    local-prefixes: github.com/OpenIMSDK/Open-IM-Server
+    local-prefixes: github.com/openimsdk/open-im-server
 
   gomnd:
     settings:
@@ -361,13 +361,17 @@ linters-settings:
         - gorm.io/gorm
         - gorm.io/driver/mysql
         - k8s.io/klog
+        - github.com/allowed/module
+        - go.mongodb.org/mongo-driver/mongo
         # - gopkg.in/yaml.v2
       domains:                                                        # List of allowed module domains
         - google.golang.org
         - gopkg.in
         - golang.org
         - github.com
+        - go.mongodb.org
         - go.uber.org
+        - openim.io
         - go.etcd.io
     blocked:
       versions:
@@ -506,7 +510,7 @@ linters-settings:
 
   nestif:
     # minimal complexity of if statements to report, 5 by default
-    min-complexity: 4
+    min-complexity: 6
 
   nilnil:
     # By default, nilnil checks all returned types below.

CHANGELOG/.chglog/config.yml

@@ -3,7 +3,7 @@ style: github
 template: CHANGELOG.tpl.md
 info:
   title: CHANGELOG
-  repository_url: https://github.com/OpenIMSDK/Open-IM-Server
+  repository_url: https://github.com/openimsdk/open-im-server
 options:
   tag_filter_pattern: '^v'
   sort: "date"

CHANGELOG/CHANGELOG-1.0.md

@@ -47,10 +47,10 @@
 - update
 
 
-[Unreleased]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v1.0.7...HEAD
-[v1.0.7]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v1.0.6...v1.0.7
-[v1.0.6]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v1.0.5...v1.0.6
-[v1.0.5]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v1.0.4...v1.0.5
-[v1.0.4]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v1.0.3...v1.0.4
-[v1.0.3]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v1.0.1...v1.0.3
-[v1.0.1]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v1.0.0...v1.0.1
+[Unreleased]: https://github.com/openimsdk/open-im-server/compare/v1.0.7...HEAD
+[v1.0.7]: https://github.com/openimsdk/open-im-server/compare/v1.0.6...v1.0.7
+[v1.0.6]: https://github.com/openimsdk/open-im-server/compare/v1.0.5...v1.0.6
+[v1.0.5]: https://github.com/openimsdk/open-im-server/compare/v1.0.4...v1.0.5
+[v1.0.4]: https://github.com/openimsdk/open-im-server/compare/v1.0.3...v1.0.4
+[v1.0.3]: https://github.com/openimsdk/open-im-server/compare/v1.0.1...v1.0.3
+[v1.0.1]: https://github.com/openimsdk/open-im-server/compare/v1.0.0...v1.0.1

CHANGELOG/CHANGELOG-2.0.md

@@ -14,7 +14,7 @@
 <a name="v2.0.9"></a>
 ## [v2.0.9] - 2022-04-29
 ### Reverts
-- update etcd to v3.5.2 ([#206](https://github.com/OpenIMSDK/Open-IM-Server/issues/206))
+- update etcd to v3.5.2 ([#206](https://github.com/openimsdk/open-im-server/issues/206))
 
 ### Pull Requests
 - Merge branch 'tuoyun'
@@ -74,14 +74,14 @@
 - update
 
 
-[Unreleased]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.0.10...HEAD
-[v2.0.10]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.0.9...v2.0.10
-[v2.0.9]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.0.8...v2.0.9
-[v2.0.8]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.0.7...v2.0.8
-[v2.0.7]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.0.6...v2.0.7
-[v2.0.6]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.0.5...v2.0.6
-[v2.0.5]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.04...v2.0.5
-[v2.04]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.0.3...v2.04
-[v2.0.3]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.0.2...v2.0.3
-[v2.0.2]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.0.1...v2.0.2
-[v2.0.1]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.0.0...v2.0.1
+[Unreleased]: https://github.com/openimsdk/open-im-server/compare/v2.0.10...HEAD
+[v2.0.10]: https://github.com/openimsdk/open-im-server/compare/v2.0.9...v2.0.10
+[v2.0.9]: https://github.com/openimsdk/open-im-server/compare/v2.0.8...v2.0.9
+[v2.0.8]: https://github.com/openimsdk/open-im-server/compare/v2.0.7...v2.0.8
+[v2.0.7]: https://github.com/openimsdk/open-im-server/compare/v2.0.6...v2.0.7
+[v2.0.6]: https://github.com/openimsdk/open-im-server/compare/v2.0.5...v2.0.6
+[v2.0.5]: https://github.com/openimsdk/open-im-server/compare/v2.04...v2.0.5
+[v2.04]: https://github.com/openimsdk/open-im-server/compare/v2.0.3...v2.04
+[v2.0.3]: https://github.com/openimsdk/open-im-server/compare/v2.0.2...v2.0.3
+[v2.0.2]: https://github.com/openimsdk/open-im-server/compare/v2.0.1...v2.0.2
+[v2.0.1]: https://github.com/openimsdk/open-im-server/compare/v2.0.0...v2.0.1

CHANGELOG/CHANGELOG-2.1.md

@@ -21,7 +21,7 @@
 <a name="v2.1.0"></a>
 ## v2.1.0 - 2022-06-17
 ### Reverts
-- update etcd to v3.5.2 ([#206](https://github.com/OpenIMSDK/Open-IM-Server/issues/206))
+- update etcd to v3.5.2 ([#206](https://github.com/openimsdk/open-im-server/issues/206))
 - friend modify
 - update
 
@@ -47,4 +47,4 @@
 - Merge branch 'tuoyun'
 
 
-[Unreleased]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.1.0...HEAD
+[Unreleased]: https://github.com/openimsdk/open-im-server/compare/v2.1.0...HEAD

CHANGELOG/CHANGELOG-2.2.md

@@ -21,7 +21,7 @@
 <a name="v2.2.0"></a>
 ## v2.2.0 - 2022-07-01
 ### Reverts
-- update etcd to v3.5.2 ([#206](https://github.com/OpenIMSDK/Open-IM-Server/issues/206))
+- update etcd to v3.5.2 ([#206](https://github.com/openimsdk/open-im-server/issues/206))
 - friend modify
 - update
 
@@ -47,4 +47,4 @@
 - Merge branch 'tuoyun'
 
 
-[Unreleased]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.2.0...HEAD
+[Unreleased]: https://github.com/openimsdk/open-im-server/compare/v2.2.0...HEAD

CHANGELOG/CHANGELOG-2.3.md

@@ -37,7 +37,7 @@
 <a name="v2.3.0-rc0"></a>
 ## v2.3.0-rc0 - 2022-07-15
 ### Reverts
-- update etcd to v3.5.2 ([#206](https://github.com/OpenIMSDK/Open-IM-Server/issues/206))
+- update etcd to v3.5.2 ([#206](https://github.com/openimsdk/open-im-server/issues/206))
 - friend modify
 - update
 
@@ -63,8 +63,8 @@
 - Merge branch 'tuoyun'
 
 
-[Unreleased]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.3.3...HEAD
-[v2.3.3]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.3.2...v2.3.3
-[v2.3.2]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.3.0-rc2...v2.3.2
-[v2.3.0-rc2]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.3.0-rc1...v2.3.0-rc2
-[v2.3.0-rc1]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.3.0-rc0...v2.3.0-rc1
+[Unreleased]: https://github.com/openimsdk/open-im-server/compare/v2.3.3...HEAD
+[v2.3.3]: https://github.com/openimsdk/open-im-server/compare/v2.3.2...v2.3.3
+[v2.3.2]: https://github.com/openimsdk/open-im-server/compare/v2.3.0-rc2...v2.3.2
+[v2.3.0-rc2]: https://github.com/openimsdk/open-im-server/compare/v2.3.0-rc1...v2.3.0-rc2
+[v2.3.0-rc1]: https://github.com/openimsdk/open-im-server/compare/v2.3.0-rc0...v2.3.0-rc1

CHANGELOG/CHANGELOG-2.9.md

@@ -38,15 +38,15 @@
 <a name="v2.9.0"></a>
 ## v2.9.0 - 2023-07-04
 ### Reverts
-- update etcd to v3.5.2 ([#206](https://github.com/OpenIMSDK/Open-IM-Server/issues/206))
+- update etcd to v3.5.2 ([#206](https://github.com/openimsdk/open-im-server/issues/206))
 
 ### Pull Requests
 - Merge branch 'tuoyun'
 
 
-[Unreleased]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.9.0+1.839643f...HEAD
-[v2.9.0+1.839643f]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.9.0+2.35f07fe...v2.9.0+1.839643f
-[v2.9.0+2.35f07fe]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.9.0+1.b5072b1...v2.9.0+2.35f07fe
-[v2.9.0+1.b5072b1]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.9.0+3.2667a3a...v2.9.0+1.b5072b1
-[v2.9.0+3.2667a3a]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.9.0+7.04818ca...v2.9.0+3.2667a3a
-[v2.9.0+7.04818ca]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.9.0...v2.9.0+7.04818ca
+[Unreleased]: https://github.com/openimsdk/open-im-server/compare/v2.9.0+1.839643f...HEAD
+[v2.9.0+1.839643f]: https://github.com/openimsdk/open-im-server/compare/v2.9.0+2.35f07fe...v2.9.0+1.839643f
+[v2.9.0+2.35f07fe]: https://github.com/openimsdk/open-im-server/compare/v2.9.0+1.b5072b1...v2.9.0+2.35f07fe
+[v2.9.0+1.b5072b1]: https://github.com/openimsdk/open-im-server/compare/v2.9.0+3.2667a3a...v2.9.0+1.b5072b1
+[v2.9.0+3.2667a3a]: https://github.com/openimsdk/open-im-server/compare/v2.9.0+7.04818ca...v2.9.0+3.2667a3a
+[v2.9.0+7.04818ca]: https://github.com/openimsdk/open-im-server/compare/v2.9.0...v2.9.0+7.04818ca

CHANGELOG/CHANGELOG-3.0.md

@@ -47,7 +47,7 @@
 <a name="v2.9.0"></a>
 ## [v2.9.0] - 2023-07-04
 ### Reverts
-- update etcd to v3.5.2 ([#206](https://github.com/OpenIMSDK/Open-IM-Server/issues/206))
+- update etcd to v3.5.2 ([#206](https://github.com/openimsdk/open-im-server/issues/206))
 
 ### Pull Requests
 - Merge branch 'tuoyun'
@@ -85,7 +85,7 @@
 <a name="v2.0.9"></a>
 ## [v2.0.9] - 2022-04-29
 ### Reverts
-- update etcd to v3.5.2 ([#206](https://github.com/OpenIMSDK/Open-IM-Server/issues/206))
+- update etcd to v3.5.2 ([#206](https://github.com/openimsdk/open-im-server/issues/206))
 
 ### Pull Requests
 - Merge branch 'tuoyun'
@@ -161,28 +161,28 @@
 - update
 
 
-[Unreleased]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.9.0...HEAD
-[v2.9.0]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.3.3...v2.9.0
-[v2.3.3]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.3.2...v2.3.3
-[v2.3.2]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.3.0-rc2...v2.3.2
-[v2.3.0-rc2]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.3.0-rc1...v2.3.0-rc2
-[v2.3.0-rc1]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.3.0-rc0...v2.3.0-rc1
-[v2.3.0-rc0]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.2.0...v2.3.0-rc0
-[v2.2.0]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.1.0...v2.2.0
-[v2.1.0]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.0.10...v2.1.0
-[v2.0.10]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.0.9...v2.0.10
-[v2.0.9]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.0.7...v2.0.9
-[v2.0.7]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.0.6...v2.0.7
-[v2.0.6]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.0.5...v2.0.6
-[v2.0.5]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.04...v2.0.5
-[v2.04]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.0.3...v2.04
-[v2.0.3]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.0.2...v2.0.3
-[v2.0.2]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.0.1...v2.0.2
-[v2.0.1]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.0.0...v2.0.1
-[v2.0.0]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v1.0.7...v2.0.0
-[v1.0.7]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v1.0.6...v1.0.7
-[v1.0.6]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v1.0.5...v1.0.6
-[v1.0.5]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v1.0.4...v1.0.5
-[v1.0.4]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v1.0.3...v1.0.4
-[v1.0.3]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v1.0.1...v1.0.3
-[v1.0.1]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v1.0.0...v1.0.1
+[Unreleased]: https://github.com/openimsdk/open-im-server/compare/v2.9.0...HEAD
+[v2.9.0]: https://github.com/openimsdk/open-im-server/compare/v2.3.3...v2.9.0
+[v2.3.3]: https://github.com/openimsdk/open-im-server/compare/v2.3.2...v2.3.3
+[v2.3.2]: https://github.com/openimsdk/open-im-server/compare/v2.3.0-rc2...v2.3.2
+[v2.3.0-rc2]: https://github.com/openimsdk/open-im-server/compare/v2.3.0-rc1...v2.3.0-rc2
+[v2.3.0-rc1]: https://github.com/openimsdk/open-im-server/compare/v2.3.0-rc0...v2.3.0-rc1
+[v2.3.0-rc0]: https://github.com/openimsdk/open-im-server/compare/v2.2.0...v2.3.0-rc0
+[v2.2.0]: https://github.com/openimsdk/open-im-server/compare/v2.1.0...v2.2.0
+[v2.1.0]: https://github.com/openimsdk/open-im-server/compare/v2.0.10...v2.1.0
+[v2.0.10]: https://github.com/openimsdk/open-im-server/compare/v2.0.9...v2.0.10
+[v2.0.9]: https://github.com/openimsdk/open-im-server/compare/v2.0.7...v2.0.9
+[v2.0.7]: https://github.com/openimsdk/open-im-server/compare/v2.0.6...v2.0.7
+[v2.0.6]: https://github.com/openimsdk/open-im-server/compare/v2.0.5...v2.0.6
+[v2.0.5]: https://github.com/openimsdk/open-im-server/compare/v2.04...v2.0.5
+[v2.04]: https://github.com/openimsdk/open-im-server/compare/v2.0.3...v2.04
+[v2.0.3]: https://github.com/openimsdk/open-im-server/compare/v2.0.2...v2.0.3
+[v2.0.2]: https://github.com/openimsdk/open-im-server/compare/v2.0.1...v2.0.2
+[v2.0.1]: https://github.com/openimsdk/open-im-server/compare/v2.0.0...v2.0.1
+[v2.0.0]: https://github.com/openimsdk/open-im-server/compare/v1.0.7...v2.0.0
+[v1.0.7]: https://github.com/openimsdk/open-im-server/compare/v1.0.6...v1.0.7
+[v1.0.6]: https://github.com/openimsdk/open-im-server/compare/v1.0.5...v1.0.6
+[v1.0.5]: https://github.com/openimsdk/open-im-server/compare/v1.0.4...v1.0.5
+[v1.0.4]: https://github.com/openimsdk/open-im-server/compare/v1.0.3...v1.0.4
+[v1.0.3]: https://github.com/openimsdk/open-im-server/compare/v1.0.1...v1.0.3
+[v1.0.1]: https://github.com/openimsdk/open-im-server/compare/v1.0.0...v1.0.1

CHANGELOG/CHANGELOG-3.1.md

@@ -2,86 +2,19 @@
 
 <!-- BEGIN MUNGE: GENERATED_TOC -->
 
-- [Version logging for OpenIM](#version-logging-for-openim)
-  - [Unreleased](#unreleased)
-  - [v3.1.2-beta.3 - 2023-08-09](#v312-beta3---2023-08-09)
-  - [v3.1.2-beta.2 - 2023-08-09](#v312-beta2---2023-08-09)
-  - [v3.1.2-beta.1 - 2023-08-09](#v312-beta1---2023-08-09)
-  - [v3.1.2-beta.0 - 2023-08-08](#v312-beta0---2023-08-08)
-  - [v3.1.2.beta.0 - 2023-08-08](#v312beta0---2023-08-08)
-  - [v3.1.1-beta.4 - 2023-08-07](#v311-beta4---2023-08-07)
-  - [v3.1.1-beta.3 - 2023-08-05](#v311-beta3---2023-08-05)
-  - [v3.1.1-beta.2 - 2023-08-04](#v311-beta2---2023-08-04)
-  - [v3.1.1-beta.1 - 2023-08-04](#v311-beta1---2023-08-04)
-  - [v3.1.1-alpha.3 - 2023-08-03](#v311-alpha3---2023-08-03)
-  - [v3.1.1-alpha.2 - 2023-08-03](#v311-alpha2---2023-08-03)
-  - [v3.1.1-alpha.1 - 2023-08-02](#v311-alpha1---2023-08-02)
-  - [v3.1.0 - 2023-07-28](#v310---2023-07-28)
-    - [Reverts](#reverts)
-    - [Pull Requests](#pull-requests)
-
-
 <!-- END MUNGE: GENERATED_TOC -->
 
 <a name="unreleased"></a>
 ## [Unreleased]
 
 
-<a name="v3.1.2-beta.3"></a>
-## [v3.1.2-beta.3] - 2023-08-09
-
-<a name="v3.1.2-beta.2"></a>
-## [v3.1.2-beta.2] - 2023-08-09
-
-<a name="v3.1.2-beta.1"></a>
-## [v3.1.2-beta.1] - 2023-08-09
-
-<a name="v3.1.2-beta.0"></a>
-## [v3.1.2-beta.0] - 2023-08-08
-
-<a name="v3.1.2.beta.0"></a>
-## [v3.1.2.beta.0] - 2023-08-08
-
-<a name="v3.1.1-beta.4"></a>
-## [v3.1.1-beta.4] - 2023-08-07
-
-<a name="v3.1.1-beta.3"></a>
-## [v3.1.1-beta.3] - 2023-08-05
-
-<a name="v3.1.1-beta.2"></a>
-## [v3.1.1-beta.2] - 2023-08-04
-
-<a name="v3.1.1-beta.1"></a>
-## [v3.1.1-beta.1] - 2023-08-04
-
-<a name="v3.1.1-alpha.3"></a>
-## [v3.1.1-alpha.3] - 2023-08-03
-
-<a name="v3.1.1-alpha.2"></a>
-## [v3.1.1-alpha.2] - 2023-08-03
-
-<a name="v3.1.1-alpha.1"></a>
-## [v3.1.1-alpha.1] - 2023-08-02
-
 <a name="v3.1.0"></a>
 ## v3.1.0 - 2023-07-28
 ### Reverts
-- update etcd to v3.5.2 ([#206](https://github.com/OpenIMSDK/Open-IM-Server/issues/206))
+- update etcd to v3.5.2 ([#206](https://github.com/openimsdk/open-im-server/issues/206))
 
 ### Pull Requests
 - Merge branch 'tuoyun'
 
 
-[Unreleased]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v3.1.2-beta.3...HEAD
-[v3.1.2-beta.3]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v3.1.2-beta.2...v3.1.2-beta.3
-[v3.1.2-beta.2]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v3.1.2-beta.1...v3.1.2-beta.2
-[v3.1.2-beta.1]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v3.1.2-beta.0...v3.1.2-beta.1
-[v3.1.2-beta.0]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v3.1.2.beta.0...v3.1.2-beta.0
-[v3.1.2.beta.0]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v3.1.1-beta.4...v3.1.2.beta.0
-[v3.1.1-beta.4]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v3.1.1-beta.3...v3.1.1-beta.4
-[v3.1.1-beta.3]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v3.1.1-beta.2...v3.1.1-beta.3
-[v3.1.1-beta.2]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v3.1.1-beta.1...v3.1.1-beta.2
-[v3.1.1-beta.1]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v3.1.1-alpha.3...v3.1.1-beta.1
-[v3.1.1-alpha.3]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v3.1.1-alpha.2...v3.1.1-alpha.3
-[v3.1.1-alpha.2]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v3.1.1-alpha.1...v3.1.1-alpha.2
-[v3.1.1-alpha.1]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v3.1.0...v3.1.1-alpha.1
+[Unreleased]: https://github.com/openimsdk/open-im-server/compare/v3.1.0...HEAD

CHANGELOG/CHANGELOG-3.2.md

@@ -8,37 +8,25 @@
 ## [Unreleased]
 
 
-<a name="v3.2.2-beta.3"></a>
-## [v3.2.2-beta.3] - 2023-08-22
-
-<a name="v3.2.2-beta.2"></a>
-## [v3.2.2-beta.2] - 2023-08-21
-
-<a name="v3.2.2-beta.1"></a>
-## [v3.2.2-beta.1] - 2023-08-19
+<a name="v3.2.2-alpha.0"></a>
+## [v3.2.2-alpha.0] - 2023-08-25
 
 <a name="v3.2.0"></a>
-## [v3.2.0] - 2023-08-18
+## [v3.2.0] - 2023-08-19
 
 <a name="v3.2.0-rc.0"></a>
 ## [v3.2.0-rc.0] - 2023-08-17
 
-<a name="v3.2.2-beta.0"></a>
-## [v3.2.2-beta.0] - 2023-08-17
-
 <a name="v3.2.0-alpha.0"></a>
 ## v3.2.0-alpha.0 - 2023-08-16
 ### Reverts
-- update etcd to v3.5.2 ([#206](https://github.com/OpenIMSDK/Open-IM-Server/issues/206))
+- update etcd to v3.5.2 ([#206](https://github.com/openimsdk/open-im-server/issues/206))
 
 ### Pull Requests
 - Merge branch 'tuoyun'
 
 
-[Unreleased]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v3.2.2-beta.3...HEAD
-[v3.2.2-beta.3]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v3.2.2-beta.2...v3.2.2-beta.3
-[v3.2.2-beta.2]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v3.2.2-beta.1...v3.2.2-beta.2
-[v3.2.2-beta.1]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v3.2.0...v3.2.2-beta.1
-[v3.2.0]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v3.2.0-rc.0...v3.2.0
-[v3.2.0-rc.0]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v3.2.2-beta.0...v3.2.0-rc.0
-[v3.2.2-beta.0]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v3.2.0-alpha.0...v3.2.2-beta.0
+[Unreleased]: https://github.com/openimsdk/open-im-server/compare/v3.2.2-alpha.0...HEAD
+[v3.2.2-alpha.0]: https://github.com/openimsdk/open-im-server/compare/v3.2.0...v3.2.2-alpha.0
+[v3.2.0]: https://github.com/openimsdk/open-im-server/compare/v3.2.0-rc.0...v3.2.0
+[v3.2.0-rc.0]: https://github.com/openimsdk/open-im-server/compare/v3.2.0-alpha.0...v3.2.0-rc.0

CHANGELOG/CHANGELOG-3.3.md

@@ -0,0 +1,40 @@
+# Version logging for OpenIM
+
+<!-- BEGIN MUNGE: GENERATED_TOC -->
+
+<!-- END MUNGE: GENERATED_TOC -->
+
+<a name="unreleased"></a>
+## [Unreleased]
+
+
+<a name="v3.3.1"></a>
+## [v3.3.1] - 2023-09-13
+
+<a name="v3.3.1-beta.0"></a>
+## [v3.3.1-beta.0] - 2023-09-11
+
+<a name="v3.3.0-rc.1"></a>
+## [v3.3.0-rc.1] - 2023-09-11
+
+<a name="v3.3.0-rc.12"></a>
+## [v3.3.0-rc.12] - 2023-09-11
+
+<a name="v3.3.0"></a>
+## [v3.3.0] - 2023-09-09
+
+<a name="v3.3.0-rc.0"></a>
+## v3.3.0-rc.0 - 2023-09-07
+### Reverts
+- update etcd to v3.5.2 ([#206](https://github.com/openimsdk/open-im-server/issues/206))
+
+### Pull Requests
+- Merge branch 'tuoyun'
+
+
+[Unreleased]: https://github.com/openimsdk/open-im-server/compare/v3.3.1...HEAD
+[v3.3.1]: https://github.com/openimsdk/open-im-server/compare/v3.3.1-beta.0...v3.3.1
+[v3.3.1-beta.0]: https://github.com/openimsdk/open-im-server/compare/v3.3.0-rc.1...v3.3.1-beta.0
+[v3.3.0-rc.1]: https://github.com/openimsdk/open-im-server/compare/v3.3.0-rc.12...v3.3.0-rc.1
+[v3.3.0-rc.12]: https://github.com/openimsdk/open-im-server/compare/v3.3.0...v3.3.0-rc.12
+[v3.3.0]: https://github.com/openimsdk/open-im-server/compare/v3.3.0-rc.0...v3.3.0

CHANGELOG/CHANGELOG.md

@@ -16,7 +16,7 @@
 
 All notable changes to this project will be documented in this file.
 
-+ [https://github.com/OpenIMSDK/Open-IM-Server/releases](https://github.com/OpenIMSDK/Open-IM-Server/releases)
++ [https://github.com/openimsdk/open-im-server/releases](https://github.com/openimsdk/open-im-server/releases)
 
 ## OpenIM versioning policy
 
@@ -44,7 +44,7 @@ $ git-chglog --init
 
 **Options**
 
-- What is the URL of your repository?: https://github.com/OpenIMSDK/Open-IM-Server
+- What is the URL of your repository?: https://github.com/openimsdk/open-im-server
 - What is your favorite style?: github
 - Choose the format of your favorite commit message: <type>(<scope>): <subject> -- feat(core): Add new feature
 - What is your favorite template style?: standard
@@ -89,9 +89,9 @@ $ git-chglog --config custom/dir/config.yml
 ## create next tag
 
 ```bash
-git-chglog --next-tag 2.0.0 -o CHANGELOG.md
-git commit -am "release 2.0.0"
-git tag 2.0.0
+$ git-chglog --next-tag 2.0.0 -o CHANGELOG.md
+$ git commit -am "release 2.0.0"
+$ git tag 2.0.0
 ```
 
 | Query          | Description                                    | Example                     |
@@ -112,6 +112,9 @@ git tag 2.0.0
 + [OpenIM CHANGELOG-V2.9](CHANGELOG-2.9.md)
 + [OpenIM CHANGELOG-V3.0](CHANGELOG-3.0.md)
 + [OpenIM CHANGELOG-V3.1](CHANGELOG-3.1.md)
++ [OpenIM CHANGELOG-V3.2](CHANGELOG-3.2.md)
++ [OpenIM CHANGELOG-V3.3](CHANGELOG-3.3.md)
+
 
 ## Introduction
 
@@ -121,7 +124,7 @@ In both the open-source and closed-source software development communities, it i
 
 The most common format for version numbers is as follows:
 
-```
+```bash
 major.minor[.patch[.build]]
 ```
 

CONTRIBUTING.md

@@ -46,7 +46,7 @@ The [Makefile](./Makefile) is for every developer, even if you don't know how to
 
 #### Code and doc contribution
 
-Every action to make project Open-IM-Server better is encouraged. On GitHub, every improvement for Open-IM-Server could be via a [PR](https://github.com/OpenIMSDK/Open-IM-Server/pulls) (short for pull request).
+Every action to make project Open-IM-Server better is encouraged. On GitHub, every improvement for Open-IM-Server could be via a [PR](https://github.com/openimsdk/open-im-server/pulls) (short for pull request).
 
 + If you find a typo, try to fix it!
 + If you find a bug, try to fix it!
@@ -61,14 +61,14 @@ Every action to make project Open-IM-Server better is encouraged. On GitHub, eve
 
 #### Where should I start?
 
-+ If you are new to the project, don't know how to contribute Open-IM-Server, please check out the [good first issue](https://github.com/OpenIMSDK/Open-IM-Server/issues?q=is%3Aopen+label%3A"good+first+issue"+sort%3Aupdated-desc) label.
-+ You should be good at filtering the Open-IM-Server issue tags and finding the ones you like, such as [RFC](https://github.com/OpenIMSDK/Open-IM-Server/issues?q=is%3Aissue+is%3Aopen+RFC+label%3ARFC) for big initiatives, features for [feature](https://github.com/OpenIMSDK/Open-IM-Server/issues?q=is%3Aissue+label%3Afeature) proposals, and [bug](https://github.com/OpenIMSDK/Open-IM-Server/issues?q=is%3Aissue+label%3Abug+) fixes.
-+ If you are looking for something to work on, check out our [open issues](https://github.com/OpenIMSDK/Open-IM-Server/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc).
-+ If you have an idea for a new feature, please [open an issue](https://github.com/OpenIMSDK/Open-IM-Server/issues/new/choose), and we can discuss it.
++ If you are new to the project, don't know how to contribute Open-IM-Server, please check out the [good first issue](https://github.com/openimsdk/open-im-server/issues?q=is%3Aopen+label%3A"good+first+issue"+sort%3Aupdated-desc) label.
++ You should be good at filtering the Open-IM-Server issue tags and finding the ones you like, such as [RFC](https://github.com/openimsdk/open-im-server/issues?q=is%3Aissue+is%3Aopen+RFC+label%3ARFC) for big initiatives, features for [feature](https://github.com/openimsdk/open-im-server/issues?q=is%3Aissue+label%3Afeature) proposals, and [bug](https://github.com/openimsdk/open-im-server/issues?q=is%3Aissue+label%3Abug+) fixes.
++ If you are looking for something to work on, check out our [open issues](https://github.com/openimsdk/open-im-server/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc).
++ If you have an idea for a new feature, please [open an issue](https://github.com/openimsdk/open-im-server/issues/new/choose), and we can discuss it.
 
 #### Design documents
 
-For any substantial design, there should be a well-crafted design document. This document is not just a simple record, but also a detailed description and manifestation, which can help team members better understand the design thinking and grasp the design direction. In the process of writing the design document, we can choose to use tools such as `Google Docs` or `Notion`, and even mark RFC in [issues](https://github.com/OpenIMSDK/Open-IM-Server/issues?q=is%3Aissue+is%3Aopen+RFC+label%3ARFC) or [discussions](https://github.com/OpenIMSDK/Open-IM-Server/discussions) for better collaboration. Of course, after completing the design document, we should also add it to our [Shared Drive](https://drive.google.com/drive/) and notify the appropriate working group to let everyone know of its existence. Only by doing so can we maximize the effectiveness of the design document and provide strong support for the smooth progress of the project.
+For any substantial design, there should be a well-crafted design document. This document is not just a simple record, but also a detailed description and manifestation, which can help team members better understand the design thinking and grasp the design direction. In the process of writing the design document, we can choose to use tools such as `Google Docs` or `Notion`, and even mark RFC in [issues](https://github.com/openimsdk/open-im-server/issues?q=is%3Aissue+is%3Aopen+RFC+label%3ARFC) or [discussions](https://github.com/openimsdk/open-im-server/discussions) for better collaboration. Of course, after completing the design document, we should also add it to our [Shared Drive](https://drive.google.com/drive/) and notify the appropriate working group to let everyone know of its existence. Only by doing so can we maximize the effectiveness of the design document and provide strong support for the smooth progress of the project.
 
 Anybody can access the shared Drive for reading. To get access to comment. Once you've done that, head to the [shared Drive](https://drive.google.com/) and behold all the docs.
 
@@ -95,10 +95,10 @@ To propose PR for the Open-IM-Server item, we assume you have registered a GitHu
 
 2. **CLONE** your own repository to main locally. Use `git clone https://github.com/<your-username>/Open-IM-Server.git` to clone repository to your local machine. Then you can create new branches to finish the change you wish to make.
 
-3. **Set Remote** upstream to be `https://github.com/OpenIMSDK/Open-IM-Server.git` using the following two commands:
+3. **Set Remote** upstream to be `https://github.com/openimsdk/open-im-server.git` using the following two commands:
 
    ```bash
-   ❯ git remote add upstream https://github.com/OpenIMSDK/Open-IM-Server.git
+   ❯ git remote add upstream https://github.com/openimsdk/open-im-server.git
    ❯ git remote set-url --push upstream no-pushing
    ```
 
@@ -108,7 +108,7 @@ To propose PR for the Open-IM-Server item, we assume you have registered a GitHu
    ❯ git remote -v
    origin     https://github.com/<your-username>/Open-IM-Server.git (fetch)
    origin     https://github.com/<your-username>/Open-IM-Server.git (push)
-   upstream   https://github.com/OpenIMSDK/Open-IM-Server.git (fetch)
+   upstream   https://github.com/openimsdk/open-im-server.git (fetch)
    upstream   no-pushing (push)
    ```
 
@@ -174,7 +174,7 @@ To propose PR for the Open-IM-Server item, we assume you have registered a GitHu
    # then create pull request, and merge
    ```
 
-7. **Open a pull request** to `OpenIMSDK/Open-IM-Server:main`
+7. **Open a pull request** to `openimsdk/open-im-server:main`
 
    It is recommended to review your changes before filing a pull request. Check if your code doesn't conflict with the main branch and no redundant code is included.
 
@@ -190,7 +190,7 @@ Instead we encourage you to send us a private email to winxu81@gmail.com to repo
 
 #### Reporting general issues
 
-To be honest, we regard every user of Open-IM-Serveras a very kind contributor. After experiencing Open-IM-Server, you may have some feedback for the project. Then feel free to open an issue via [NEW ISSUE](https://github.com/OpenIMSDK/Open-IM-Server/issues/new/choose).
+To be honest, we regard every user of Open-IM-Serveras a very kind contributor. After experiencing Open-IM-Server, you may have some feedback for the project. Then feel free to open an issue via [NEW ISSUE](https://github.com/openimsdk/open-im-server/issues/new/choose).
 
 Since we collaborate project Open-IM-Server in a distributed way, we appreciate **WELL-WRITTEN**, **DETAILED**, **EXPLICIT** issue reports. To make the communication more efficient, we wish everyone could search if your issue is an existing one in the searching list. If you find it existing, please add your details in comments under the existing issue instead of opening a brand new one.
 
@@ -258,7 +258,7 @@ An example for this could be:
 
 PR is the only way to make change to Open-IM-Server project files. To help reviewers better get your purpose, PR description could not be too detailed. We encourage contributors to follow the [PR template](https://github.com/OpenIMSDK/.github/tree/main/.github/PULL_REQUEST_TEMPLATE.md) to finish the pull request.
 
-You can find some very formal PR in [RFC](https://github.com/OpenIMSDK/Open-IM-Server/issues?q=is%3Aissue+is%3Aopen+RFC+label%3ARFC) issues and learn about them.
+You can find some very formal PR in [RFC](https://github.com/openimsdk/open-im-server/issues?q=is%3Aissue+is%3Aopen+RFC+label%3ARFC) issues and learn about them.
 
 **📖 Opening PRs:**
 
@@ -307,8 +307,8 @@ git() {
 
 The documentation for Open-IM-Server includes:
 
-+ [README.md](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/README.md): This file includes the basic information and instructions for getting started with Open-IM-Server.
-+ [CONTRIBUTING.md](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/CONTRIBUTING.md): This file contains guidelines for contributing to Open-IM-Server's codebase, such as how to submit issues, pull requests, and code reviews.
++ [README.md](https://github.com/openimsdk/open-im-server/blob/main/README.md): This file includes the basic information and instructions for getting started with Open-IM-Server.
++ [CONTRIBUTING.md](https://github.com/openimsdk/open-im-server/blob/main/CONTRIBUTING.md): This file contains guidelines for contributing to Open-IM-Server's codebase, such as how to submit issues, pull requests, and code reviews.
 + [Official Documentation](https://doc.rentsoft.cn/): This is the official documentation for Open-IM-Server, which includes comprehensive information on all of its features, configuration options, and troubleshooting tips.
 
 Please obey the following rules to better format the docs, which would greatly improve the reading experience.
@@ -324,9 +324,9 @@ Please obey the following rules to better format the docs, which would greatly i
 
 We choose GitHub as the primary place for Open-IM-Server to collaborate. So the latest updates of Open-IM-Server are always here. Although contributions via PR is an explicit way to help, we still call for any other ways.
 
-+ reply to other's [issues](https://github.com/OpenIMSDK/Open-IM-Server/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc) if you could;
++ reply to other's [issues](https://github.com/openimsdk/open-im-server/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc) if you could;
 + help solve other user's problems;
-+ help review other's [PR](https://github.com/OpenIMSDK/Open-IM-Server/pulls?q=is%3Apr+is%3Aopen+sort%3Aupdated-desc) design; 
++ help review other's [PR](https://github.com/openimsdk/open-im-server/pulls?q=is%3Apr+is%3Aopen+sort%3Aupdated-desc) design; 
 + discuss about Open-IM-Server to make things clearer;
 + advocate [Open-IM-Server](https://google.com/search?q=Open-IM-Server) technology beyond GitHub;
 + write blogs on Open-IM-Server and so on.

Dockerfile

@@ -25,7 +25,7 @@ WORKDIR ${SERVER_WORKDIR}
 
 # Copy scripts and binary files to the production image
 COPY --from=builder ${OPENIM_SERVER_BINDIR} /openim/openim-server/_output/bin
-COPY --from=builder ${OPENIM_SERVER_CMDDIR} /openim/openim-server/scripts
-COPY --from=builder ${SERVER_WORKDIR}/config /openim/openim-server/config
+# COPY --from=builder ${OPENIM_SERVER_CMDDIR} /openim/openim-server/scripts
+# COPY --from=builder ${SERVER_WORKDIR}/config /openim/openim-server/config
 
 CMD ["/openim/openim-server/scripts/docker-start-all.sh"]

Makefile

@@ -11,9 +11,9 @@ all: tidy gen add-copyright verify lint cover restart
 # ==============================================================================
 # Build set
 
-ROOT_PACKAGE=github.com/OpenIMSDK/Open-IM-Server
-# TODO: This is version control for the future https://github.com/OpenIMSDK/Open-IM-Server/issues/574
-VERSION_PACKAGE=github.com/OpenIMSDK/Open-IM-Server/pkg/version
+ROOT_PACKAGE=github.com/openimsdk/open-im-server
+# TODO: This is version control for the future https://github.com/openimsdk/open-im-server/issues/574
+VERSION_PACKAGE=github.com/openimsdk/open-im-server/v3/pkg/version
 
 # ==============================================================================
 # Includes
@@ -73,6 +73,11 @@ gen:
 demo:
 	@$(MAKE) go.demo
 
+## versionchecker: Check version of openim. ✨
+.PHONY: versionchecker
+versionchecker:
+	@$(MAKE) go.versionchecker
+
 ## build: Build binaries by default ✨
 .PHONY: build
 build:
@@ -112,7 +117,7 @@ install:
 check:
 	@$(MAKE) go.check
 
-## check-component
+## check-component: Check OpenIM component deployment ✨
 .PHONY: check-component
 check-component:
 	@$(MAKE) go.check-component

README-zh_CN.md

@@ -10,11 +10,11 @@
 
 
 <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://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://github.com/openimsdk/open-im-server/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-Apache--2.0-green"></a>
 <a href="https://golang.org/"><img src="https://img.shields.io/badge/Language-Go-blue.svg"></a>
 </p>
 
@@ -29,329 +29,111 @@
 
 </p>
 
-## ✨ 关于 OpenIM
+## Ⓜ️ 关于 OpenIM
 
-Open-IM-Server 是使用纯 Golang 精心制作的强大的即时消息服务器。其通过 JSON over WebSocket 进行通信的独特方法将每次交互都视为消息。这简化了定制并消除了修改服务器代码的需求。通过利用微服务架构，服务器可以通过集群部署，保证出色的性能和可伸缩性。
+OpenIM 不仅仅是一个开源的即时消息组件，它是你的应用程序生态系统的一个不可或缺的部分。查看下面的图表，了解 AppServer、AppClient、OpenIMServer 和 OpenIMSDK 是如何交互的。
 
-Open-IM-Server 不仅仅是一个即时消息服务器；它是将实时网络集成到您的应用程序中的强大工具，定位为您集成的首选选择！🚀
+![App-OpenIM 关系](./docs/images/oepnim-design.png)
 
-请注意，Open-IM-Server 不作为独立产品运行，也不提供内置的帐户注册或登录服务。为了简化您的实施过程，我们已开源了 [chat repository](https://github.com/OpenIMSDK/chat)，其中包括这些功能。与 Open-IM-Server 一起部署此聊天业务服务器可加快全面的聊天产品的设置。👥
+## 🚀 关于 OpenIMSDK
 
-为了进一步增强您的体验，我们还提供了 SDK 客户端，在其中实现了大多数复杂逻辑。可以在 [此链接](https://github.com/OpenIMSDK/openim-sdk-core) 找到 [SDK repository](https://github.com/OpenIMSDK/openim-sdk-core)。[chat repository](https://github.com/OpenIMSDK/chat) 是我们的业务服务器，而 'core' 代表 SDK 的高级封装，它们协同工作以提供卓越的结果。✨
+**OpenIMSDK** 无缝集成到您的应用中，提供丰富、实时的消息体验，无需复杂的 UI 集成。它提供：
 
-## :star2: 为什么选择 OpenIM
++ **本地存储**：用于快速数据检索和消息同步。
++ **监听器回调**：确保实时消息交互性。
++ **API 封装**：简化开发流程。
++ **连接管理**：保证可靠的消息传递。
 
-**🔍 功能截图显示**
+它使用 Golang 构建，并支持跨平台部署，确保在所有平台上提供一致的消息体验。
 
-<div align="center">
+👉 **[探索 GO SDK](https://github.com/openimsdk/openim-sdk-core)**
 
-|                      💻🔄📱 多终端同步 🔄🖥️                       |                        📅⚡ 高效会议 🚀💼                        |
-| :----------------------------------------------------------: | :----------------------------------------------------------: |
-| ![multiple-message](./assets/demo/multi-terminal-synchronization.png) | ![efficient-meetings](./assets/demo/efficient-meetings.png) |
-|                    📲🔄 **一对一和群聊** 👥🗣️                    |               🎁💻 **特殊功能 - 自定义消息** ✉️🎨                |
-| ![group-chat](./assets/demo/group-chat.png) | ![special-function](./assets/demo/special-function.png) |
+## 🌐 关于 OpenIMServer
 
-</div>
+精心用 Golang 开发的 **OpenIMServer** 通过多重方式确保了卓越的即时消息服务器能力：
 
-1. **全面的消息类型支持 :speech_balloon:**
++ **模块组成**：它由多个模块组成，例如网关和多个 RPC 服务，提供一个多功能的消息环境。
++ **微服务架构**：支持集群模式，确保出色的性能和可伸缩性，以有效管理各个实例间的通信。
++ **多样的部署选项**：适应你的操作偏好，通过源代码、Kubernetes 或 Docker 提供部署选项。
 
-   ✅ 支持几乎所有类型的消息，包括文本、图片、表情符号、语音、视频、地理位置、文件、报价、名片、系统通知、自定义消息等
+### 增强的业务功能：
 
-   ✅ 支持一对一和多人音视频通话
++ **REST API**：OpenIMServer 为业务系统提供 REST API，旨在通过后端接口为您的操作提供附加功能，如群组创建和消息推送。
++ **回调**：为了扩展其在各种业务形式中的实用性，OpenIMServer 提供了回调能力。即，在事件发生之前或之后，它向业务服务器发送请求，比如发送消息，丰富通信过程中的交互和数据交换流。
 
-   ✅ 为 iOS、Android、Flutter、uni-app、ReactNative、Electron、Web、H5 等多个平台提供终端支持
-
-2. **随时随地的高效会议 :earth_americas:**
-
-   ✅ 基于具有 100% 可靠强制信令功能的 IM (Instant Messaging)，为与聊天应用程序深度集成的 IM 系统铺平了道路
-
-   ✅ 支持单次会议中的数百人，订阅人数达到数千，以及服务器端音视频录制
-
-3. **适用于各种社交场景的一对一和群聊 :busts_in_silhouette:**
-
-   ✅ OpenIM 有四种角色：应用程序管理员、群主、群管理员和普通成员
-
-   ✅ 强大的群特性，如静音、群公告、群验证、无限群成员和根据需要加载群消息
-
-4. **独特的功能 :star2:**
-
-   ✅ 支持读取并烧毁私人聊天，可自定义时长
-
-   ✅ 消息编辑功能扩大了社交场景，使即时通讯变得更加多样化和有趣
-
-5. **开源 :open_hands:**
-
-   ✅ OpenIM 的代码是开源的，数据自控，旨在构建一个全球领先的 IM 开源社区，包括客户端 SDK 和服务器
-
-   ✅ 基于开源服务器，已经开发了许多出色的开源项目，例如 [OpenKF](https://github.com/OpenIMSDK/OpenKF) (开源 AI 客户服务系统)
-
-6. **易于扩展 :wrench:**
-
-   ✅ OpenIM 服务器是用 Golang 实现的，引入了创新的 "一切都是消息" 通信模型，简化了自定义消息和扩展功能的实现
-
-7. **高性能 :racing_car:**
-
-   ✅ OpenIM 支持集群中的分层治理架构，经过大量用户的测试，并抽象了在线消息、离线消息和历史消息的存储模型
-
-8. **全平台支持 :tv:**
-
-   ✅ 支持原生 iOS、Android；跨平台 Flutter、uni-app、ReactNative；主要的 Web 前端框架如 React、Vue；小程序和 Electron 支持的 PC 平台
-
-9. **终极部署体验 🤖**
-
-   ✅ 支持 [集群部署](https://github.com/OpenIMSDK/Open-IM-Server/edit/main/deployments/README.md)
-
-   ✅ 支持多架构镜像，我们的 Docker 镜像不仅托管在 GitHub 上，而且还在阿里云和 Docker Hub 上支持多个架构。请访问 [我们的 GitHub packages](https://github.com/orgs/OpenIMSDK/packages?repo_name=Open-IM-Server) 并阅读我们的 [版本管理文档](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/version.md) 以获取更多信息。
-
-10. **开源社区的大生态系统 🤲**
-
-    ✅ 我们有数万用户和许多解决方案来解决问题。 
-
-    ✅  我们有一个大型的开源社区叫 [OpenIMSDK](https://github.com/OpenIMSDK)，它运行核心模块，我们还有一个开源社区叫 [openim-sigs](https://github.com/openim-sigs) 以探索更多基于 IM 的基础设施产品。
+👉 **[了解更多](https://doc.rentsoft.cn/guides/introduction/product)**
 
 ## :rocket: 快速开始
 
-<details>   <summary>使用 Docker Compose 部署</summary>
-
-1. 克隆项目
+你只需要一个简单的命令，就可以快速学习 OpenIM 的工程解决方案：
 
 ```
-# 选择您需要的
-BRANCH=release-v3.1
-git clone -b $BRANCH https://github.com/OpenIMSDK/Open-IM-Server openim && export openim=$(pwd)/openim && cd $openim && make build
+bashCopy code
+$ make demo
 ```
 
-> **注意** 阅读我们的发布策略：https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/version.md
+🤲 为了方便用户体验，我们提供了多种部署解决方案，您可以根据下面的列表选择自己的部署方法：
 
-1. 修改 `.env`
-
-```
-USER=root #无需修改
-PASSWORD=openIM123  #8位或更多数字和字母的组合，此密码适用于redis、mysql、mongo，以及config/config.yaml中的accessSecret
-ENDPOINT=http://127.0.0.1:10005 #minio的外部服务IP和端口，或使用域名storage.xx.xx，应用程序必须能够访问此IP和端口或域名，
-API_URL=http://127.0.0.1:10002/object/ #应用程序必须能够访问此IP和端口或域名，
-DATA_DIR=./  #指定大磁盘目录
-```
-
-1. 部署并启动
-
-> **注意** 此命令只能执行一次。它会基于 `.env` 中的 `PASSWORD` 变量修改 docker-compose 中的组件密码，并修改 `config/config.yaml` 中的组件密码。如果 `.env` 中的密码发生变化，您需要首先执行 `docker-compose down`；`rm components -rf` 然后执行此命令。
-
-```
-
-make install
-```
-
-1. 检查服务
-
-```
-
-make check
-```
-
-![https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/images/docker_build.png](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/images/docker_build.png)
-
-</details>  <details>  <summary>从源码编译</summary>
-
-您需要 `Go 1.18` 或更高版本，以及 `make`。
-
-版本详情：https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/version.md
-
-```
-# 选择您需要的
-BRANCH=release-v3.1
-git clone -b $BRANCH https://github.com/OpenIMSDK/Open-IM-Server openim && export openim=$(pwd)/openim && cd $openim && make build
-```
-
-阅读关于 [OpenIM 版本策略](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/version.md)
-
-使用 `make help` 来查看 OpenIM 支持的指令。
-
-如图所示，所有服务已成功构建
-
-![成功编译](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/images/build.png)
-
-</details> <details>  <summary>组件配置说明</summary>
-
-config/config.yaml 文件为存储组件提供了详细的配置说明。
-
-- Zookeeper
-
-  - 用于 RPC 服务发现和注册，支持集群。
-
-    ```
-    zookeeper:
-      schema: openim                          #不建议修改
-      address: [ 127.0.0.1:2181 ]             #地址
-      username:                               #用户名
-      password:                               #密码
-    ```
-
-- MySQL
-
-  - 用于存储用户、关系和群组，支持主从数据库。
-
-    ```
-    mysql:
-      address: [ 127.0.0.1:13306 ]            #地址
-      username: root                          #用户名
-      password: openIM123                     #密码
-      database: openIM_v2                     #不建议修改
-      maxOpenConn: 1000                       #最大连接
-      maxIdleConn: 100                        #最大空闲连接
-      maxLifeTime: 60                         #连接可重用的最大时间(秒)
-      logLevel: 4                             #日志级别 1=静音 2=错误 3=警告 4=信息
-      slowThreshold: 500                      #慢语句阈值(毫秒)
-    ```
-
-- Mongo
-
-  - 用于存储离线消息，支持 mongo 分片集群。
-
-    ```
-    mongo:
-      uri:                                    #如果不为空，则直接使用此值
-      address: [ 127.0.0.1:37017 ]            #地址
-      database: openIM                        #默认 mongo 数据库
-      username: root                          #用户名
-      password: openIM123                     #密码
-      maxPoolSize: 100                        #最大连接数
-    ```
-
-- Redis
-
-  - 用于存储消息序列号、最新消息、用户令牌和 mysql 缓存，支持集群部署。
-
-    ```
-    redis:
-      address: [ 127.0.0.1:16379 ]            #地址
-      username:                               #用户名
-      password: openIM123                     #密码
-    ```
-
-- Kafka
-
-  - 用于消息队列，用于消息解耦，支持集群部署。
-
-    ```
-    kafka:
-      username:                               #用户名
-      password:                               #密码
-      addr: [ 127.0.0.1:9092 ]                #地址
-      latestMsgToRedis:
-        topic: "latestMsgToRedis"
-      offlineMsgToMongo:
-        topic: "offlineMsgToMongoMysql"
-      msgToPush:
-        topic: "msqToPush"
-      msgToModify:
-        topic: "msgToModify"
-      consumerGroupID:
-        msgToRedis: redis
-        msgToMongo: mongo
-        msgToMySql: mysql
-        msgToPush: push
-        msgToModify: modify
-    ```
-
-</details> <details>  <summary>启动和停止服务</summary>
-
-启动服务
-
-```
-
-./scripts/start-all.sh;
-```
-
-检查服务
-
-```
-
-./scripts/check-all.sh
-```
-
-停止服务
-
-```
-
-./scripts/stop-all.sh
-```
-
-</details>
-
-<details>  <summary>开放 IM 端口</summary>
-
-| TCP 端口  | 描述                                                | 操作                                    |
-| --------- | --------------------------------------------------- | --------------------------------------- |
-| TCP:10001 | ws 协议，消息端口如消息发送、推送等，用于客户端 SDK | 端口释放或 nginx 反向代理，并关闭防火墙 |
-| TCP:10002 | api 端口，如用户、朋友、组、消息接口。              | 端口释放或 nginx 反向代理，并关闭防火墙 |
-| TCP:10005 | 选择 minio 存储时所需 (openIM 默认使用 minio 存储)  | 端口释放或 nginx 反向代理，并关闭防火墙 |
-
-</details>  <details>  <summary>开放聊天端口</summary>
-
-- 聊天仓库: https://github.com/OpenIMSDK/chat
-
-| TCP 端口  | 描述                     | 操作                                    |
-| --------- | ------------------------ | --------------------------------------- |
-| TCP:10008 | 业务系统，如注册、登录等 | 端口释放或 nginx 反向代理，并关闭防火墙 |
-| TCP:10009 | 管理后台，如统计、封禁等 | 端口释放或 nginx 反向代理，并关闭防火墙 |
-
-</details>
-
-## :link: APP 和 OpenIM 之间的关系
-
-OpenIM 不仅仅是一个开源的即时消息组件，它是您的应用程序生态系统的一个不可分割的部分。查看此图表以了解 AppServer、AppClient、Open-IM-Server 和 Open-IM-SDK 如何互动。
-
-![App-OpenIM 关系](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/images/open-im-server.png)
-
-## :building_construction: 总体架构
-
-深入了解 Open-IM-Server 的功能与我们的架构图。
-
-![总体架构](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/images/Architecture.jpg)
++ **[源代码部署指南](https://doc.rentsoft.cn/guides/gettingStarted/imSourceCodeDeployment)**
++ **[Docker 部署指南](https://doc.rentsoft.cn/guides/gettingStarted/dockerCompose)**
++ **[Kubernetes 部署指南](https://github.com/openimsdk/open-im-server/tree/main/deployments)**
 
 ## :hammer_and_wrench: 开始开发 OpenIM
 
-OpenIM 我们的目标是建立一个顶级的开源社区。我们有一套标准，在 [Community repository](https://github.com/OpenIMSDK/community) 中。
+OpenIM 我们的目标是建立一个顶级的开源社区。我们有一套标准，在[社区仓库](https://github.com/OpenIMSDK/community)中。
 
-如果您想为这个 Open-IM-Server 仓库做贡献，请阅读我们的 [贡献者文档](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/CONTRIBUTING.md)。
+如果你想为这个 Open-IM-Server 仓库做贡献，请阅读我们的[贡献者文档](https://github.com/openimsdk/open-im-server/blob/main/CONTRIBUTING.md)。
 
-在您开始之前，请确保您的更改是需要的。最好的方法是创建一个 [新的讨论](https://github.com/OpenIMSDK/Open-IM-Server/discussions/new/choose) 或 [Slack 通讯](https://join.slack.com/t/openimsdk/shared_invite/zt-22720d66b-o_FvKxMTGXtcnnnHiMqe9Q)，或者如果您发现一个问题，首先 [报告它](https://github.com/OpenIMSDK/Open-IM-Server/issues/new/choose)。
+在开始之前，请确保你的更改是有需求的。最好的方法是创建一个[新的讨论](https://github.com/openimsdk/open-im-server/discussions/new/choose) 或 [Slack 通信](https://join.slack.com/t/openimsdk/shared_invite/zt-22720d66b-o_FvKxMTGXtcnnnHiMqe9Q)，或者如果你发现一个问题，首先[报告它](https://github.com/openimsdk/open-im-server/issues/new/choose)。
 
-- [代码标准](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/go_code.md)
-- [Docker 图像标准](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/images.md)
-- [目录标准](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/directory.md)
-- [提交标准](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/commit.md)
-- [版本控制标准](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/version.md)
-- [接口标准](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/api.md)
-- [日志标准](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/)
-- [错误代码标准](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/error_code.md)
++ [代码标准](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/go_code.md)
 
-## :busts_in_silhouette: 社区
++ [Docker 镜像标准](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/images.md)
 
-- 📚 [OpenIM 社区](https://github.com/OpenIMSDK/community)
-- 💕 [OpenIM 兴趣小组](https://github.com/Openim-sigs)
-- 🚀 [加入我们的 Slack 社区](https://join.slack.com/t/openimsdk/shared_invite/zt-22720d66b-o_FvKxMTGXtcnnnHiMqe9Q)
-- :eyes: [加入我们的微信群 (微信群)](https://openim-1253691595.cos.ap-nanjing.myqcloud.com/WechatIMG20.jpeg)
++ [目录标准](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/directory.md)
 
-## :calendar: 社区会议
++ [提交标准](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/commit.md)
 
-我们希望任何人都可以参与我们的社区并贡献代码，我们提供礼物和奖励，欢迎您每周四晚上加入我们。
++ [版本控制标准](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/version.md)
 
-我们的会议在 [OpenIM Slack](https://join.slack.com/t/openimsdk/shared_invite/zt-22720d66b-o_FvKxMTGXtcnnnHiMqe9Q) 🎯，然后您可以搜索 Open-IM-Server 管道加入。
++ [接口标准](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/interface.md)
 
-我们在 [GitHub 讨论](https://github.com/OpenIMSDK/Open-IM-Server/discussions/categories/meeting) 中记下每次 [双周会议](https://github.com/orgs/OpenIMSDK/discussions/categories/meeting) 的笔记，我们的历史会议记录以及会议回放都可在 [Google Docs :bookmark_tabs:](https://docs.google.com/document/d/1nx8MDpuG74NASx081JcCpxPgDITNTpIIos0DS6Vr9GU/edit?usp=sharing) 中找到。
++ [OpenIM配置和环境变量设置](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/environment.md)
 
-## :eyes: 谁在使用 OpenIM
+> **Note**
+> 针对中国的用户，阅读我们的 [Docker 镜像标准](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/images.md) 以便使用国内 aliyun 的镜像地址。OpenIM 也有针对中国的 gitee 同步仓库，你可以在 [gitee.com](https://gitee.com/openimsdk) 上找到它。
 
-查看我们的 [用户案例研究](https://github.com/OpenIMSDK/community/blob/main/ADOPTERS.md) 页面以获取项目用户列表。不要犹豫，留下一个 [📝评论](https://github.com/OpenIMSDK/Open-IM-Server/issues/379) 并分享您的使用案例。
+## :link: 链接
 
-## :page_facing_up: 许可证
+  + **[完整文档](https://doc.rentsoft.cn/)**
+  + **[更新日志](https://github.com/openimsdk/open-im-server/blob/main/CHANGELOG.md)**
+  + **[FAQ](https://github.com/openimsdk/open-im-server/blob/main/FAQ.md)**
+  + **[代码示例](https://github.com/openimsdk/open-im-server/blob/main/examples)**
 
-OpenIM 根据 Apache 2.0 许可证授权。请查看 [LICENSE](https://github.com/OpenIMSDK/Open-IM-Server/tree/main/LICENSE) 以获取完整的许可证文本。
+## :handshake: 社区
 
-OpenIM logo，包括其变体和动画版本，在此存储库 [OpenIM](https://github.com/OpenIMSDK/Open-IM-Server) 下的 [assets/logo](./assets/logo) 和 [assets/logo-gif](./assets/logo-gif) 目录中显示，受版权法保护。
+  + **[GitHub Discussions](https://github.com/openimsdk/open-im-server/discussions)**
+  + **[Slack 通信](https://join.slack.com/t/openimsdk/shared_invite/zt-22720d66b-o_FvKxMTGXtcnnnHiMqe9Q)**
+  + **[GitHub Issues](https://github.com/openimsdk/open-im-server/issues)**
 
-## 🔮 感谢我们的贡献者！
+  您可以加入这些平台，讨论问题，提出建议，或分享您的成功故事！
 
-<a href="https://github.com/OpenIMSDK/Open-IM-Server/graphs/contributors">   <img src="https://contrib.rocks/image?repo=OpenIMSDK/Open-IM-Server" /> </a>
+## :writing_hand: 贡献
+
+  我们欢迎任何形式的贡献！请确保在提交 Pull Request 之前阅读我们的[贡献者文档](https://github.com/openimsdk/open-im-server/blob/main/CONTRIBUTING.md)。
+
+  + **[报告 Bug](https://github.com/openimsdk/open-im-server/issues/new?assignees=&labels=bug&template=bug_report.md&title=)**
+  + **[提出新特性](https://github.com/openimsdk/open-im-server/issues/new?assignees=&labels=enhancement&template=feature_request.md&title=)**
+  + **[提交 Pull Request](https://github.com/openimsdk/open-im-server/pulls)**
+
+  感谢您的贡献，我们一起打造一个强大的即时通信解决方案！
+
+## :closed_book: 许可证
+
+  OpenIMSDK 在 Apache License 2.0 许可下可用。查看[LICENSE 文件](https://github.com/openimsdk/open-im-server/blob/main/LICENSE)了解更多信息。
+
+## 🔮 Thanks to our contributors!
+
+<a href="https://github.com/openimsdk/open-im-server/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=openimsdk/open-im-server" />
+</a>

README.md

@@ -10,12 +10,13 @@
 
 
 <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://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://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>
 
 </p>
@@ -23,21 +24,46 @@
 <p align="center">
     <a href="./README.md"><b> English </b></a> •
     <a href="./README-zh_CN.md"><b> 简体中文 </b></a> •
-    <a href="https://www.openim.online/en"><b> Docs </b></a>
+<a href="https://www.openim.online/en"><b> Docs </b></a>
 </p>
 
-
 </p>
 
-## ✨ About OpenIM
+## Ⓜ️ About OpenIM
 
-Open-IM-Server, meticulously developed in pure Golang, is a powerful instant messaging server. Its distinct communication method, employing pb+websocket, views every interaction as a message, streamlining customization without altering server code. Built on a microservice architecture, it offers deployment through clusters for outstanding performance and scalability.
+OpenIM isn't just an open-source instant messaging component, it's an integral part of your application ecosystem. Check out this diagram to understand how AppServer, AppClient, OpenIMServer, and OpenIMSDK interact.
 
-Open-IM-Server is more than an instant messaging server; it's a powerful tool for incorporating real-time networking into your applications, positioning itself as your premier choice for integration! 🚀
+![App-OpenIM Relationship](./docs/images/oepnim-design.png)
 
-Please be aware that Open-IM-Server does not function as a standalone product and does not offer built-in account registration or login services. To ease your implementation process, we've open-sourced the [chat repository](https://github.com/OpenIMSDK/chat), which comprises these features. Deploying this chat business server in conjunction with Open-IM-Server expedites the setup of a comprehensive chat product. 👥
+## 🚀 About OpenIMSDK
 
-Further enhancing your experience, we also provide an SDK client, wherein most complex logics are implemented. The [SDK repository](https://github.com/OpenIMSDK/openim-sdk-core) can be found at [this link](https://github.com/OpenIMSDK/openim-sdk-core). The [chat repository](https://github.com/OpenIMSDK/chat) is our business server while the 'core' represents the high-level encapsulation of the SDK, synergistically working together to deliver superior results. ✨
+**OpenIMSDK** seamlessly integrates into your application, delivering a rich, real-time messaging experience without requiring intricate UI integration. It provides:
+
++ **Local Storage**: For quick data retrieval and message synchronization.
++ **Listener Callbacks**: Ensuring real-time message interactivity.
++ **API Encapsulation**: Streamlining development processes.
++ **Connection Management**: Guaranteeing reliable message delivery.
+
+It's crafted in Golang and supports cross-platform deployment, ensuring a coherent messaging experience across all platforms.
+
+👉 **[Explore GO SDK](https://github.com/openimsdk/openim-sdk-core)**
+
+## 🌐 About OpenIMServer
+
+**OpenIMServer**, meticulously developed in Golang, ensures a stellar instant messaging server capability with a multifold approach:
+
++ **Modular Composition**: It's comprised of several modules, such as the gateway and multiple RPC services, offering a versatile messaging environment.
++ **Microservices Architecture**: Supporting cluster modes, it assures outstanding performance and scalability to manage communication effectively across various instances.
++ **Diverse Deployment Options**: Adapts to your operational preferences, offering deployment via source code, Kubernetes, or Docker.
+
+### Enhanced Business Functionalities:
+
++ **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)**
+
+<!--
 
 ## :star2: Why OpenIM
 
@@ -53,65 +79,28 @@ Further enhancing your experience, we also provide an SDK client, wherein most c
 
 </div>
 
-1. **Comprehensive Message Type Support :speech_balloon:**
+**OpenIM** offers a powerful and reliable instant messaging platform, ensuring versatile communication across multiple platforms with the following key features:
 
-   ✅ Supports almost all types of messages, including text, images, emojis, voice, video, geographical location, files, quotes, business cards, system notifications, custom messages and more
+✅ **Versatile Messaging:** Support for text, images, emojis, voice, video, and more, alongside one-on-one and multi-person audio/video calls.
 
-   ✅ Supports one-on-one and multi-person audio and video calls
+✅ **Robust Chat Capabilities:** Including roles (application administrator, group owner, etc.) and features like muting, group announcements, and dynamic message loading.
 
-   ✅ Provides terminal support for multiple platforms such as iOS, Android, Flutter, uni-app, ReactNative, Electron, Web, H5 
+✅ **Unique Interaction Features:** Offering read-and-burn private chats and a message editing function to broaden social scenarios.
 
-2. **Efficient Meetings Anytime, Anywhere :earth_americas:**
+✅ **Open Source:** The code of OpenIM is open source and aims to build a leading global IM open source community. [GitHub Repository](https://github.com/OpenIMSDK)
 
-   ✅ Based on IM (Instant Messaging) with 100% reliable forced signaling capabilities, it paves the way for IM systems, deeply integrated with chat applications 
+✅ **Extensibility:** Implemented in Golang, OpenIM introduces an "everything is a message" communication model, simplifying custom messages and feature extension.
 
-   ✅ Supports hundreds of people in a single meeting, with subscription numbers reaching thousands, and server-side audio and video recording 
+✅ **High Performance:** Supports a hierarchical governance architecture tested and abstracts the storage model of various message types.
 
-3. **One-on-one and Group Chats for Various Social Scenarios :busts_in_silhouette:**
+✅ **Full Platform Support:** Native support for iOS, Android, Flutter, uni-app, ReactNative, Electron, and Web.
 
-   ✅ OpenIM has four roles: application administrator, group owner, group administrator, and regular member 
+-->
 
-   ✅ Powerful group features such as muting, group announcements, group validation, unlimited group members, and loading group messages as needed 
-
-4. **Unique Features :star2:**
-
-   ✅ Supports read-and-burn private chats, customizable duration
-
-   ✅ Message editing function broadens social scenarios, making instant communication more diverse and interesting
-
-5. **Open Source :open_hands:**
-
-   ✅ The code of OpenIM is open source, self-controlled data, aimed at building a globally leading IM open source community, including client SDK and server 
-
-   ✅ Based on open source Server, many excellent open source projects have been developed, such as [OpenKF](https://github.com/OpenIMSDK/OpenKF) (Open source AI customer service system) 
-
-6. **Easy to Expand :wrench:**
-
-   ✅ The OpenIM server is implemented in Golang, introducing an innovative "everything is a message" communication model, simplifying the implementation of custom messages and extended features 
-
-7. **High Performance :racing_car:**
-
-   ✅ OpenIM supports a hierarchical governance architecture in the cluster, tested by a large number of users, and abstracts the storage model of online messages, offline messages, and historical messages 
-
-8. **Full Platform Support :tv:**
-
-   ✅ Supports native iOS, Android; cross-platform Flutter, uni-app, ReactNative; major web front-end frameworks such as React, Vue; applets; and PC platforms supported by Electron
-
-9. **The ultimate deployment experience 🤖** 
-
-   ✅  Supports [cluster deployment](https://github.com/OpenIMSDK/Open-IM-Server/edit/main/deployments/README.md)
-
-   ✅  Supports multi-architecture mirroring, our Docker images are hosted not only on GitHub but also on Alibaba Cloud and Docker Hub supporting multiple architectures. Visit [our GitHub packages](https://github.com/orgs/OpenIMSDK/packages?repo_name=Open-IM-Server) and read our [version management document](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/version.md) for more information.
-
-11. **A large ecosystem of open source communities 🤲**
-
-    ✅  We have tens of thousands of users and many solutions to problems.
-
-    ✅  We have a large open source community called [OpenIMSDK](https://github.com/OpenIMSDK) that runs the core modules, we have an open source community called [openim-sigs](https://github.com/openim-sigs) to explore more IM-based infrastructure products.
 
 ## :rocket: Quick Start
 
-You can quickly learn OpenIM engineering solutions,  all it takes is one simple command:
+You can quickly learn OpenIM engineering solutions, all it takes is one simple command:
 
 ```bash
 $ make demo
@@ -119,62 +108,17 @@ $ make demo
 
 🤲 In order to facilitate the user experience, we have provided a variety of deployment solutions, you can choose your own deployment method according to the list below:
 
-<details>   <summary>Deploying with Docker Compose</summary>
+<!--
+<details> <summary>Deploying with Docker Compose</summary>
 
+It is recommended to use Docker Compose for deployment, which can easily and quickly deploy the entire OpenIM service on a single node
 
-> docker compose will not be maintained in future versions, but it is still the easiest and most convenient way to organize docker compose deployments into a separate project https://github.com/openim-sigs/openim-docker to maintain.
++ [https://github.com/openimsdk/openim-docker](https://github.com/openimsdk/openim-docker)
 
-**1. Clone the project**
-
-
-```bash
-git clone -b main https://github.com/openim-sigs/openim-docker openim/openim-docker && export openim=$(pwd)/openim && cd $openim/openim-docker  && ./scripts/init-config.sh && docker-compose up -d
-```
 
 > **Note**
-> If you don't know OpenIM's versioning policy, 📚Read our release policy: https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/version.md
-
-
-**2. Configure the config file**
-
-If you tried to get started quickly with `make demo`, then you know that our config file is generated by automation.
-
-You can use `make init` to quickly initialize a configuration file
-
-Modify the automation script:
-
-```bash
-cat scripts/install/environment.sh
-```
-
-1. Recommended using environment variables:
-
-```bash
-export PASSWORD="openIM123" # Set password
-export USER="root" # Set username
-# Choose chat version and server version https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/images.md, eg: main, release-v*.*
-export CHAT_BRANCH="main"
-export SERVER_BRANCH="main"
-#... Other environment variables
-# MONGO_USERNAME: This sets the MongoDB username
-# MONGO_PASSWORD: Set the MongoDB password
-# MONGO_DATABASE: Sets the MongoDB database name
-# MINIO_ENDPOINT: set the MinIO service address
-# DOCKER_BRIDGE_SUBNET: set the docker bridge network address
-export DOCKER_BRIDGE_SUBNET="172.28.0.0/16"
-# API_URL: under network environment, set OpenIM Server API address
-export API_URL="http://127.0.0.1:10002"
-```
-
-If you wish to use more custom features, read our [config documentation](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/contrib/environment.md).
-
-
-Next, update the configuration using make init:
-
-```bash
-$ make init
-$ git diff
-```
+>
+> 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
 
 
 </details> 
@@ -182,27 +126,27 @@ $ git diff
 <details>  <summary>Compile from Source</summary>
 
 
-Ur need `Go 1.18` or higher version, and `make`.
+Ur need `Go 1.20` or higher version, and `make`.
 
 
 ```bash
 go version && make --version || echo "Error: One of the commands failed."
 ```
 
-Version Details: https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/version.md
+Version Details: https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/version.md
 
-You can get the version number from the command below or from [github releases](https://github.com/OpenIMSDK/Open-IM-Server/tags).
+You can get the version number from the command below or from [github releases](https://github.com/openimsdk/open-im-server/tags).
 
 ```bash
-$ curl --silent "https://api.github.com/repos/OpenIMSDK/Open-IM-Server/releases" | jq -r '.[].tag_name'
+$ 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/conversions/version.md), We recommend using stable versions such as `v3.3.0` and `v3.2.0` whenever possible. `v3.1.1-alpha.3` as well as `v3.3.0-beta.0` and `v3.2.0-rc.0` are pre-release or beta versions and are not recommended.
 
 Set `OPENIM_VERSION` environment variables for the latest `OPENIM_VERSION` number, or replace the `OPENIM_VERSION` for you to install the OpenIM-Server `OPENIM_VERSION`:
 
 ```bash
-$ OPENIM_VERSION=`curl -s https://api.github.com/repos/OpenIMSDK/Open-IM-Server/releases/latest | grep -oE '"tag_name": "[^"]+"' | head -n1 | cut -d'"' -f4`
+$ OPENIM_VERSION=`curl -s https://api.github.com/repos/openimsdk/open-im-server/releases/latest | grep -oE '"tag_name": "[^"]+"' | head -n1 | cut -d'"' -f4`
 # OPENIM_VERSION=v3.3.0
 ```
 
@@ -210,17 +154,12 @@ Deploy basic components at the click of a command:
 
 ```bash
 # install openim dependency
-$ git clone https://github.com/OpenIMSDK/Open-IM-Server openim/openim-server && export openim=$(pwd)/openim/openim-server && cd $openim/openim-server && git checkout $OPENIM_VERSION
-$ curl https://raw.githubusercontent.com/OpenIMSDK/openim-docker/main/example/basic-openim-server-dependency.yml -o basic-openim-server-dependency.yml && make init && docker compose -f basic-openim-server-dependency.yml up -d && make start
+$ git clone https://github.com/openimsdk/open-im-server openim/openim-server && export openim=$(pwd)/openim/openim-server && cd $openim/openim-server && git checkout $OPENIM_VERSION
+$ make init && docker compose up -d && make start && make check
 ```
 
 > `make help` to help you see the instructions supported by OpenIM.
 
-Use `make check` to check all component starts
-
-```bash
-$ make check
-```
 
 You can use the `make help-all` see OpenIM in action.
 
@@ -228,70 +167,53 @@ You can use the `make help-all` see OpenIM in action.
 
 <details>  <summary>Component Configuration Instructions</summary>
 
-Read: Configuration center document：https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/contrib/environment.md
+Read: Configuration center document：https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/environment.md
 
 </details>
 
 
 <details>  <summary>Deployed with kubernetes</summary>
 
-
-Read: https://github.com/OpenIMSDK/Open-IM-Server/blob/main/deployments/README.md
++ https://github.com/openimsdk/open-im-server/blob/main/deployments/README.md
 
 </details> 
+-->
 
-<details>  <summary>Open IM Ports</summary>
++ **[Source Code Deployment Guide](https://doc.rentsoft.cn/guides/gettingStarted/imSourceCodeDeployment)**
++ **[Docker Deployment Guide](https://doc.rentsoft.cn/guides/gettingStarted/dockerCompose)**
++ **[Kubernetes Deployment Guide](https://github.com/openimsdk/open-im-server/tree/main/deployments)**
 
+<!-- 
+## :link: OpenIM and your application
 
-| TCP Port  | Description                                                  | Operation                                             |
-| --------- | ------------------------------------------------------------ | ----------------------------------------------------- |
-| TCP:10001 | ws protocol, message port such as message sending, pushing etc, used for client SDK | Port release or nginx reverse proxy, and firewall off |
-| TCP:10002 | api port, such as user, friend, group, message interfaces.   | Port release or nginx reverse proxy, and firewall off |
-| TCP:10005 | Required when choosing minio storage (openIM uses minio storage by default) | Port release or nginx reverse proxy, and firewall off |
+OpenIM isn't just an open-source instant messaging component, it's an integral part of your application ecosystem. Check out this diagram to understand how AppServer, AppClient, OpenIMServer, and OpenIMSDK interact.
 
-</details> 
-
-<details>  <summary>Open Chat Ports</summary>
-
-
-+ chat warehouse: https://github.com/OpenIMSDK/chat 
-
-| TCP Port  | Description                                         | Operation                                             |
-| --------- | --------------------------------------------------- | ----------------------------------------------------- |
-| TCP:10008 | Business system, such as registration, login etc    | Port release or nginx reverse proxy, and firewall off |
-| TCP:10009 | Management backend, such as statistics, banning etc | Port release or nginx reverse proxy, and firewall off |
-
-</details>
-
-
-## :link: Relationship Between APP and OpenIM
-
-OpenIM isn't just an open-source instant messaging component, it's an integral part of your application ecosystem. Check out this diagram to understand how AppServer, AppClient, Open-IM-Server, and Open-IM-SDK interact.
-
-![App-OpenIM Relationship](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/images/open-im-server.png)
+![App-OpenIM Relationship](./docs/images/oepnim-design.png)
 
 ## :building_construction: Overall Architecture
 
 Delve into the heart of Open-IM-Server's functionality with our architecture diagram.
 
-![Overall Architecture](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/images/Architecture.jpg)
+![Overall Architecture](./docs/images/Architecture.jpg) -->
 
 ## :hammer_and_wrench: To start developing OpenIM
 
 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).
+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.
+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)
 
-- [Code Standards](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/go_code.md)
-- [Docker Images Standards](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/images.md)
-- [Directory Standards](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/directory.md)
-- [Commit Standards](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/commit.md)
-- [Versioning Standards](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/version.md)
-- [Interface Standards](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/api.md)
-- [Log Standards](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/logging.md)
-- [Error Code Standards](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/error_code.md)
 
 ## :busts_in_silhouette: Community
 
@@ -306,20 +228,20 @@ We want anyone to get involved in our community and contributing code, we offer
 
 Our conference is in the [OpenIM Slack](https://join.slack.com/t/openimsdk/shared_invite/zt-22720d66b-o_FvKxMTGXtcnnnHiMqe9Q) 🎯, then you can search the Open-IM-Server pipeline to join
 
-We take notes of each [biweekly meeting](https://github.com/orgs/OpenIMSDK/discussions/categories/meeting) in [GitHub discussions](https://github.com/OpenIMSDK/Open-IM-Server/discussions/categories/meeting), Our historical meeting notes, as well as replays of the meetings are available at [Google Docs :bookmark_tabs:](https://docs.google.com/document/d/1nx8MDpuG74NASx081JcCpxPgDITNTpIIos0DS6Vr9GU/edit?usp=sharing).
+We take notes of each [biweekly meeting](https://github.com/orgs/OpenIMSDK/discussions/categories/meeting) in [GitHub discussions](https://github.com/openimsdk/open-im-server/discussions/categories/meeting), Our historical meeting notes, as well as replays of the meetings are available at [Google Docs :bookmark_tabs:](https://docs.google.com/document/d/1nx8MDpuG74NASx081JcCpxPgDITNTpIIos0DS6Vr9GU/edit?usp=sharing).
 
 ## :eyes: Who are using OpenIM
 
-Check out our [user case studies](https://github.com/OpenIMSDK/community/blob/main/ADOPTERS.md) page for a list of the project users. Don't hesitate to leave a [📝comment](https://github.com/OpenIMSDK/Open-IM-Server/issues/379) and share your use case.
+Check out our [user case studies](https://github.com/OpenIMSDK/community/blob/main/ADOPTERS.md) page for a list of the project users. Don't hesitate to leave a [📝comment](https://github.com/openimsdk/open-im-server/issues/379) and share your use case.
 
 ## :page_facing_up: License
 
-OpenIM is licensed under the Apache 2.0 license. See [LICENSE](https://github.com/OpenIMSDK/Open-IM-Server/tree/main/LICENSE) for the full license text.
+OpenIM is licensed under the Apache 2.0 license. See [LICENSE](https://github.com/openimsdk/open-im-server/tree/main/LICENSE) for the full license text.
 
-The OpenIM logo, including its variations and animated versions, displayed in this repository [OpenIM](https://github.com/OpenIMSDK/Open-IM-Server) under the [assets/logo](./assets/logo) and [assets/logo-gif](assets/logo-gif) directories, are protected by copyright laws.
+The OpenIM logo, including its variations and animated versions, displayed in this repository [OpenIM](https://github.com/openimsdk/open-im-server) under the [assets/logo](./assets/logo) and [assets/logo-gif](assets/logo-gif) directories, are protected by copyright laws.
 
 ## 🔮 Thanks to our contributors!
 
-<a href="https://github.com/OpenIMSDK/Open-IM-Server/graphs/contributors">
-  <img src="https://contrib.rocks/image?repo=OpenIMSDK/Open-IM-Server" />
+<a href="https://github.com/openimsdk/open-im-server/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=openimsdk/open-im-server" />
 </a>

build/README.md

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

build/goreleaser.yaml

@@ -484,8 +484,8 @@ changelog:
 #     use: buildx
 #     build_flag_templates:
 #       - "--pull"
-#       - "--label=io.artifacthub.package.readme-url=https://raw.githubusercontent.com/OpenIMSDK/Open-IM-Server/main/README.md"
-#       - "--label=io.artifacthub.package.logo-url=hhttps://github.com/OpenIMSDK/Open-IM-Server/blob/main/assets/logo/openim-logo-green.png"
+#       - "--label=io.artifacthub.package.readme-url=https://raw.githubusercontent.com/openimsdk/open-im-server/main/README.md"
+#       - "--label=io.artifacthub.package.logo-url=hhttps://github.com/openimsdk/open-im-server/blob/main/assets/logo/openim-logo-green.png"
 #       - '--label=io.artifacthub.package.maintainers=[{"name":"Xinwei Xiong","email":"3293172751nss@gmail.com"}]'
 #       - "--label=io.artifacthub.package.license=Apace-2.0"
 #       - "--label=org.opencontainers.image.description=OpenIM Open source top instant messaging system"
@@ -504,8 +504,8 @@ changelog:
 #     use: buildx
 #     build_flag_templates:
 #       - "--pull"
-#       - "--label=io.artifacthub.package.readme-url=https://raw.githubusercontent.com/OpenIMSDK/Open-IM-Server/main/README.md"
-#       - "--label=io.artifacthub.package.logo-url=hhttps://github.com/OpenIMSDK/Open-IM-Server/blob/main/assets/logo/openim-logo-green.png"
+#       - "--label=io.artifacthub.package.readme-url=https://raw.githubusercontent.com/openimsdk/open-im-server/main/README.md"
+#       - "--label=io.artifacthub.package.logo-url=hhttps://github.com/openimsdk/open-im-server/blob/main/assets/logo/openim-logo-green.png"
 #       - '--label=io.artifacthub.package.maintainers=[{"name":"Xinwei Xiong","email":"3293172751nss@gmail.com"}]'
 #       - "--label=io.artifacthub.package.license=Apace-2.0"
 #       - "--label=org.opencontainers.image.description=OpenIM Open source top instant messaging system"
@@ -555,7 +555,7 @@ nfpms:
       - openim-rpc-user
     # Your app's vendor.
     vendor: OpenIMSDK
-    homepage: https://github.com/OpenIMSDK/Open-IM-Server
+    homepage: https://github.com/openimsdk/open-im-server
     maintainer: kubbot <https://github.com/kubbot>
     description: |-
       Auto sync github labels

build/images/Dockerfile

@@ -0,0 +1,10 @@
+FROM BASE_IMAGE
+
+WORKDIR ${SERVER_WORKDIR}
+
+# Set HTTP proxy
+ARG BINARY_NAME
+
+COPY BINARY_NAME ./bin/BINARY_NAME
+
+ENTRYPOINT ["./bin/BINARY_NAME"]

build/images/openim-api/Dockerfile

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

build/images/openim-api/Dockerfile.release

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

build/images/openim-cmdutils/Dockerfile

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

build/images/openim-crontask/Dockerfile

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

build/images/openim-msggateway/Dockerfile

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

build/images/openim-msgtransfer/Dockerfile

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

build/images/openim-push/Dockerfile

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

build/images/openim-rpc-auth/Dockerfile

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

build/images/openim-rpc-conversation/Dockerfile

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

build/images/openim-rpc-friend/Dockerfile

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

build/images/openim-rpc-group/Dockerfile

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

build/images/openim-rpc-msg/Dockerfile

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

build/images/openim-rpc-third/Dockerfile

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

build/images/openim-rpc-user/Dockerfile

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

cmd/openim-api/main.go

@@ -18,14 +18,13 @@ import (
 	"context"
 	"fmt"
 	"net"
-	"strconv"
-	"time"
-
 	_ "net/http/pprof"
+	"strconv"
+
+	"github.com/openimsdk/open-im-server/v3/pkg/common/discovery_register"
 
 	"github.com/OpenIMSDK/protocol/constant"
 	"github.com/OpenIMSDK/tools/discoveryregistry"
-	openkeeper "github.com/OpenIMSDK/tools/discoveryregistry/zookeeper"
 	"github.com/OpenIMSDK/tools/log"
 
 	"github.com/openimsdk/open-im-server/v3/internal/api"
@@ -39,50 +38,65 @@ func main() {
 	apiCmd.AddPortFlag()
 	apiCmd.AddApi(run)
 	if err := apiCmd.Execute(); err != nil {
+		log.ZError(context.Background(), "API command execution failed", err)
 		panic(err.Error())
 	}
 }
 
 func run(port int) error {
+	log.ZInfo(context.Background(), "Openim api port:", "port", port)
+
 	if port == 0 {
-		return fmt.Errorf("port is empty")
+		err := "port is empty"
+		log.ZError(context.Background(), err, nil)
+
+		return fmt.Errorf(err)
 	}
 	rdb, err := cache.NewRedis()
 	if err != nil {
+		log.ZError(context.Background(), "Failed to initialize Redis", err)
+
 		return err
 	}
-	fmt.Println("api start init discov client")
+	log.ZInfo(context.Background(), "api start init discov client")
+
 	var client discoveryregistry.SvcDiscoveryRegistry
-	client, err = openkeeper.NewClient(config.Config.Zookeeper.ZkAddr, config.Config.Zookeeper.Schema,
-		openkeeper.WithFreq(time.Hour), openkeeper.WithUserNameAndPassword(
-			config.Config.Zookeeper.Username,
-			config.Config.Zookeeper.Password,
-		), openkeeper.WithRoundRobin(), openkeeper.WithTimeout(10), openkeeper.WithLogger(log.NewZkLogger()))
+
+	// Determine whether zk is passed according to whether it is a clustered deployment
+	client, err = discovery_register.NewDiscoveryRegister(config.Config.Envs.Discovery)
 	if err != nil {
+		log.ZError(context.Background(), "Failed to initialize discovery register", err)
+
 		return err
 	}
-	if err := client.CreateRpcRootNodes(config.Config.GetServiceNames()); err != nil {
+	if err = client.CreateRpcRootNodes(config.Config.GetServiceNames()); err != nil {
+		log.ZError(context.Background(), "Failed to create RPC root nodes", err)
+
 		return err
 	}
-	fmt.Println("api register public config to discov")
-	if err := client.RegisterConf2Registry(constant.OpenIMCommonConfigKey, config.Config.EncodeConfig()); err != nil {
+	log.ZInfo(context.Background(), "api register public config to discov")
+	if err = client.RegisterConf2Registry(constant.OpenIMCommonConfigKey, config.Config.EncodeConfig()); err != nil {
+		log.ZError(context.Background(), "Failed to register public config to discov", err)
+
 		return err
 	}
-	fmt.Println("api register public config to discov success")
+	log.ZInfo(context.Background(), "api register public config to discov success")
 	router := api.NewGinRouter(client, rdb)
-	fmt.Println("api init router success")
+	log.ZInfo(context.Background(), "api init router success")
 	var address string
 	if config.Config.Api.ListenIP != "" {
 		address = net.JoinHostPort(config.Config.Api.ListenIP, strconv.Itoa(port))
 	} else {
 		address = net.JoinHostPort("0.0.0.0", strconv.Itoa(port))
 	}
-	fmt.Println("start api server, address: ", address, ", OpenIM version: ", config.Version)
-	log.ZInfo(context.Background(), "start server success", "address", address, "version", config.Version)
+	log.ZInfo(context.Background(), "start api server", "address", address, "OpenIM version", config.Version)
+
 	err = router.Run(address)
 	if err != nil {
-		log.ZError(context.Background(), "api run failed ", err, "address", address)
+		log.ZError(context.Background(), "api run failed", err, "address", address)
+
 		return err
 	}
+
 	return nil
 }

cmd/openim-push/main.go

@@ -21,7 +21,7 @@ import (
 )
 
 func main() {
-	pushCmd := cmd.NewRpcCmd("push")
+	pushCmd := cmd.NewRpcCmd(cmd.RpcPushServer)
 	pushCmd.AddPortFlag()
 	pushCmd.AddPrometheusPortFlag()
 	if err := pushCmd.Exec(); err != nil {

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

@@ -21,7 +21,7 @@ import (
 )
 
 func main() {
-	authCmd := cmd.NewRpcCmd("auth")
+	authCmd := cmd.NewRpcCmd(cmd.RpcAuthServer)
 	authCmd.AddPortFlag()
 	authCmd.AddPrometheusPortFlag()
 	if err := authCmd.Exec(); err != nil {

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

@@ -21,7 +21,7 @@ import (
 )
 
 func main() {
-	rpcCmd := cmd.NewRpcCmd("conversation")
+	rpcCmd := cmd.NewRpcCmd(cmd.RpcConversationServer)
 	rpcCmd.AddPortFlag()
 	rpcCmd.AddPrometheusPortFlag()
 	if err := rpcCmd.Exec(); err != nil {

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

@@ -21,7 +21,7 @@ import (
 )
 
 func main() {
-	rpcCmd := cmd.NewRpcCmd("friend")
+	rpcCmd := cmd.NewRpcCmd(cmd.RpcFriendServer)
 	rpcCmd.AddPortFlag()
 	rpcCmd.AddPrometheusPortFlag()
 	if err := rpcCmd.Exec(); err != nil {

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

@@ -21,7 +21,7 @@ import (
 )
 
 func main() {
-	rpcCmd := cmd.NewRpcCmd("group")
+	rpcCmd := cmd.NewRpcCmd(cmd.RpcGroupServer)
 	rpcCmd.AddPortFlag()
 	rpcCmd.AddPrometheusPortFlag()
 	if err := rpcCmd.Exec(); err != nil {

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

@@ -21,7 +21,7 @@ import (
 )
 
 func main() {
-	rpcCmd := cmd.NewRpcCmd("msg")
+	rpcCmd := cmd.NewRpcCmd(cmd.RpcMsgServer)
 	rpcCmd.AddPortFlag()
 	rpcCmd.AddPrometheusPortFlag()
 	if err := rpcCmd.Exec(); err != nil {

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

@@ -21,7 +21,7 @@ import (
 )
 
 func main() {
-	rpcCmd := cmd.NewRpcCmd("third")
+	rpcCmd := cmd.NewRpcCmd(cmd.RpcThirdServer)
 	rpcCmd.AddPortFlag()
 	rpcCmd.AddPrometheusPortFlag()
 	if err := rpcCmd.Exec(); err != nil {

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

@@ -21,7 +21,7 @@ import (
 )
 
 func main() {
-	rpcCmd := cmd.NewRpcCmd("user")
+	rpcCmd := cmd.NewRpcCmd(cmd.RpcUserServer)
 	rpcCmd.AddPortFlag()
 	rpcCmd.AddPrometheusPortFlag()
 	if err := rpcCmd.Exec(); err != nil {

config/config.yaml

@@ -26,6 +26,9 @@
 # Zookeeper address
 # Zookeeper username
 # Zookeeper password
+envs:
+  discovery: zookeeper
+
 zookeeper:
   schema: openim
   address: [ 172.28.0.1:12181 ]
@@ -132,19 +135,21 @@ api:
 # minio.signEndpoint is minio public network address
 object:
   enable: "minio"
-  apiURL: "http://14.153.6.114: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.153.6.114:10005"
+    signEndpoint: "http://127.0.0.1:10005"
+    publicRead: false
   cos:
     bucketURL: https://temp-1252357374.cos.ap-chengdu.myqcloud.com
     secretID: ''
     secretKey: ''
     sessionToken: ''
+    publicRead: false
   oss:
     endpoint: "https://oss-cn-chengdu.aliyuncs.com"
     bucket: "demo-9999999"
@@ -152,7 +157,7 @@ object:
     accessKeyID: ''
     accessKeySecret: ''
     sessionToken: ''
-
+    publicRead: false
 
 ###################### RPC Port Configuration ######################
 # RPC service ports
@@ -194,7 +199,7 @@ rpcRegisterName:
 # Whether to output in json format
 # Whether to include stack trace in logs
 log:
-  storageLocation: ../logs
+  storageLocation: ../../logs/
   rotationTime: 24
   remainRotationCount: 2
   remainLogLevel: 6
@@ -211,6 +216,7 @@ log:
 # Websocket connection handshake timeout
 longConnSvr:
   openImWsPort: [ 10001 ]
+  openImMessageGatewayPort: [ 10140 ]
   websocketMaxConnNum: 100000
   websocketMaxMsgLen: 4096
   websocketTimeout: 10
@@ -226,18 +232,18 @@ push:
   enable: getui
   geTui:
     pushUrl: "https://restapi.getui.com/v2/$appId"
-    masterSecret: ""
-    appKey: ""
-    intent: ""
-    channelID: ""
-    channelName: ""
+    masterSecret: ''
+    appKey: ''
+    intent: ''
+    channelID: ''
+    channelName: ''
   fcm:
     serviceAccount: "x.json"
   jpns:
-    appKey:
-    masterSecret:
-    pushUrl:
-    pushIntent:
+    appKey: ''
+    masterSecret: ''
+    pushUrl: ''
+    pushIntent: ''
 
 # App manager configuration
 #
@@ -351,6 +357,10 @@ callback:
     enable: false
     timeout: 5
     failedContinue: true
+  beforeUpdateUserInfo:
+    enable: false
+    timeout: 5
+    failedContinue: true
   beforeCreateGroup:
     enable: false
     timeout: 5

deployments/README.md

@@ -7,7 +7,7 @@ OpenIM 支持很多种集群化部署方式，包括但不限于 helm, sealos, k
 目前各个贡献者，以及之前的官方有出过一些可以参考的方案：
 
 - https://github.com/OpenIMSDK/k8s-jenkins
-- https://github.com/OpenIMSDK/Open-IM-Server-k8s-deploy
+- https://github.com/openimsdk/open-im-server-k8s-deploy
 - https://github.com/OpenIMSDK/openim-charts
 - https://github.com/showurl/deploy-openim
 
@@ -73,13 +73,19 @@ $ SEALOS_VERSION=`curl -s https://api.github.com/repos/labring/sealos/releases/l
 ```bash
 $ export CLUSTER_USERNAME=ubuntu
 $ export CLUSTER_PASSWORD=123456
-$ sealos run labring/kubernetes:v1.25.0 labring/helm:v3.8.2 labring/calico:v3.24.1 \
+$ sudo sealos run labring/kubernetes:v1.25.0 labring/helm:v3.8.2 labring/calico:v3.24.1 \
     --masters 10.0.0.9 \
     --nodes 10.0.0.4,10.0.0.10 \
     -u "$CLUSTER_USERNAME" \
     -p "$CLUSTER_PASSWORD"
 ```
 
+> **Node**
+> 卸载的方式：使用 `kubeadm` 卸载并不会清除 `etcd` 和 `cni` 相关，所以需要手动清除，或者使用 `sealos` 卸载。
+> ```bash
+> sealos reset
+> ```
+
 ### 安装 helm
 
 helm通过打包的方式，支持发布的版本管理和控制，很大程度上简化了Kubernetes应用的部署和管理。
@@ -97,11 +103,17 @@ $ curl https://raw.githubusercontent.com/helm/helm/main/scripts/get-helm-3 | bas
 $ helm repo add brigade https://openimsdk.github.io/openim-charts
 ```
 
+### OpenIM 的镜像策略
+
+自动化提供的 aliyun, ghcr, docker hub: https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/images.md
+
+**本地化测试构建方法：**
+
+```bash
+$ make image
+```
+
 
 ### 容器化安装
 
 具体安装步骤如下：
-
-
-
-### Helm安装

deployments/openim-chat/.helmignore

@@ -1,23 +0,0 @@
-# Patterns to ignore when building packages.
-# This supports shell glob matching, relative path matching, and
-# negation (prefixed with !). Only one pattern per line.
-.DS_Store
-# Common VCS dirs
-.git/
-.gitignore
-.bzr/
-.bzrignore
-.hg/
-.hgignore
-.svn/
-# Common backup files
-*.swp
-*.bak
-*.tmp
-*.orig
-*~
-# Various IDEs
-.project
-.idea/
-*.tmproj
-.vscode/

deployments/openim-chat/Chart.yaml

@@ -1,38 +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.
-
-apiVersion: v2
-name: openim-chat
-description: A Helm chart for Kubernetes
-
-# A chart can be either an 'application' or a 'library' chart.
-#
-# Application charts are a collection of templates that can be packaged into versioned archives
-# to be deployed.
-#
-# Library charts provide useful utilities or functions for the chart developer. They're included as
-# a dependency of application charts to inject those utilities and functions into the rendering
-# pipeline. Library charts do not define any templates and therefore cannot be deployed.
-type: application
-
-# This is the chart version. This version number should be incremented each time you make changes
-# to the chart and its templates, including the app version.
-# Versions are expected to follow Semantic Versioning (https://semver.org/)
-version: 0.1.0
-
-# This is the version number of the application being deployed. This version number should be
-# incremented each time you make changes to the application. Versions are not expected to
-# follow Semantic Versioning. They should reflect the version the application is using.
-# It is recommended to use it with quotes.
-appVersion: "1.16.0"

deployments/openim-chat/templates/NOTES.txt

@@ -1,22 +0,0 @@
-1. Get the application URL by running these commands:
-{{- if .Values.ingress.enabled }}
-{{- range $host := .Values.ingress.hosts }}
-  {{- range .paths }}
-  http{{ if $.Values.ingress.tls }}s{{ end }}://{{ $host.host }}{{ .path }}
-  {{- end }}
-{{- end }}
-{{- else if contains "NodePort" .Values.service.type }}
-  export NODE_PORT=$(kubectl get --namespace {{ .Release.Namespace }} -o jsonpath="{.spec.ports[0].nodePort}" services {{ include "openim-chat.fullname" . }})
-  export NODE_IP=$(kubectl get nodes --namespace {{ .Release.Namespace }} -o jsonpath="{.items[0].status.addresses[0].address}")
-  echo http://$NODE_IP:$NODE_PORT
-{{- else if contains "LoadBalancer" .Values.service.type }}
-     NOTE: It may take a few minutes for the LoadBalancer IP to be available.
-           You can watch the status of by running 'kubectl get --namespace {{ .Release.Namespace }} svc -w {{ include "openim-chat.fullname" . }}'
-  export SERVICE_IP=$(kubectl get svc --namespace {{ .Release.Namespace }} {{ include "openim-chat.fullname" . }} --template "{{"{{ range (index .status.loadBalancer.ingress 0) }}{{.}}{{ end }}"}}")
-  echo http://$SERVICE_IP:{{ .Values.service.port }}
-{{- else if contains "ClusterIP" .Values.service.type }}
-  export POD_NAME=$(kubectl get pods --namespace {{ .Release.Namespace }} -l "app.kubernetes.io/name={{ include "openim-chat.name" . }},app.kubernetes.io/instance={{ .Release.Name }}" -o jsonpath="{.items[0].metadata.name}")
-  export CONTAINER_PORT=$(kubectl get pod --namespace {{ .Release.Namespace }} $POD_NAME -o jsonpath="{.spec.containers[0].ports[0].containerPort}")
-  echo "Visit http://127.0.0.1:8080 to use your application"
-  kubectl --namespace {{ .Release.Namespace }} port-forward $POD_NAME 8080:$CONTAINER_PORT
-{{- end }}

deployments/openim-chat/templates/_helpers.tpl

@@ -1,62 +0,0 @@
-{{/*
-Expand the name of the chart.
-*/}}
-{{- define "openim-chat.name" -}}
-{{- default .Chart.Name .Values.nameOverride | trunc 63 | trimSuffix "-" }}
-{{- end }}
-
-{{/*
-Create a default fully qualified app name.
-We truncate at 63 chars because some Kubernetes name fields are limited to this (by the DNS naming spec).
-If release name contains chart name it will be used as a full name.
-*/}}
-{{- define "openim-chat.fullname" -}}
-{{- if .Values.fullnameOverride }}
-{{- .Values.fullnameOverride | trunc 63 | trimSuffix "-" }}
-{{- else }}
-{{- $name := default .Chart.Name .Values.nameOverride }}
-{{- if contains $name .Release.Name }}
-{{- .Release.Name | trunc 63 | trimSuffix "-" }}
-{{- else }}
-{{- printf "%s-%s" .Release.Name $name | trunc 63 | trimSuffix "-" }}
-{{- end }}
-{{- end }}
-{{- end }}
-
-{{/*
-Create chart name and version as used by the chart label.
-*/}}
-{{- define "openim-chat.chart" -}}
-{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" }}
-{{- end }}
-
-{{/*
-Common labels
-*/}}
-{{- define "openim-chat.labels" -}}
-helm.sh/chart: {{ include "openim-chat.chart" . }}
-{{ include "openim-chat.selectorLabels" . }}
-{{- if .Chart.AppVersion }}
-app.kubernetes.io/version: {{ .Chart.AppVersion | quote }}
-{{- end }}
-app.kubernetes.io/managed-by: {{ .Release.Service }}
-{{- end }}
-
-{{/*
-Selector labels
-*/}}
-{{- define "openim-chat.selectorLabels" -}}
-app.kubernetes.io/name: {{ include "openim-chat.name" . }}
-app.kubernetes.io/instance: {{ .Release.Name }}
-{{- end }}
-
-{{/*
-Create the name of the service account to use
-*/}}
-{{- define "openim-chat.serviceAccountName" -}}
-{{- if .Values.serviceAccount.create }}
-{{- default (include "openim-chat.fullname" .) .Values.serviceAccount.name }}
-{{- else }}
-{{- default "default" .Values.serviceAccount.name }}
-{{- end }}
-{{- end }}

deployments/openim-chat/templates/deployment.yaml

@@ -1,75 +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.
-
-apiVersion: apps/v1
-kind: Deployment
-metadata:
-  name: {{ include "openim-chat.fullname" . }}
-  labels:
-    {{- include "openim-chat.labels" . | nindent 4 }}
-spec:
-  {{- if not .Values.autoscaling.enabled }}
-  replicas: {{ .Values.replicaCount }}
-  {{- end }}
-  selector:
-    matchLabels:
-      {{- include "openim-chat.selectorLabels" . | nindent 6 }}
-  template:
-    metadata:
-      {{- with .Values.podAnnotations }}
-      annotations:
-        {{- toYaml . | nindent 8 }}
-      {{- end }}
-      labels:
-        {{- include "openim-chat.selectorLabels" . | nindent 8 }}
-    spec:
-      {{- with .Values.imagePullSecrets }}
-      imagePullSecrets:
-        {{- toYaml . | nindent 8 }}
-      {{- end }}
-      serviceAccountName: {{ include "openim-chat.serviceAccountName" . }}
-      securityContext:
-        {{- toYaml .Values.podSecurityContext | nindent 8 }}
-      containers:
-        - name: {{ .Chart.Name }}
-          securityContext:
-            {{- toYaml .Values.securityContext | nindent 12 }}
-          image: "{{ .Values.image.repository }}:{{ .Values.image.tag | default .Chart.AppVersion }}"
-          imagePullPolicy: {{ .Values.image.pullPolicy }}
-          ports:
-            - name: http
-              containerPort: 80
-              protocol: TCP
-          livenessProbe:
-            httpGet:
-              path: /
-              port: http
-          readinessProbe:
-            httpGet:
-              path: /
-              port: http
-          resources:
-            {{- toYaml .Values.resources | nindent 12 }}
-      {{- with .Values.nodeSelector }}
-      nodeSelector:
-        {{- toYaml . | nindent 8 }}
-      {{- end }}
-      {{- with .Values.affinity }}
-      affinity:
-        {{- toYaml . | nindent 8 }}
-      {{- end }}
-      {{- with .Values.tolerations }}
-      tolerations:
-        {{- toYaml . | nindent 8 }}
-      {{- end }}

deployments/openim-chat/templates/hpa.yaml

@@ -1,42 +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.
-
-{{- if .Values.autoscaling.enabled }}
-apiVersion: autoscaling/v2beta1
-kind: HorizontalPodAutoscaler
-metadata:
-  name: {{ include "openim-chat.fullname" . }}
-  labels:
-    {{- include "openim-chat.labels" . | nindent 4 }}
-spec:
-  scaleTargetRef:
-    apiVersion: apps/v1
-    kind: Deployment
-    name: {{ include "openim-chat.fullname" . }}
-  minReplicas: {{ .Values.autoscaling.minReplicas }}
-  maxReplicas: {{ .Values.autoscaling.maxReplicas }}
-  metrics:
-    {{- if .Values.autoscaling.targetCPUUtilizationPercentage }}
-    - type: Resource
-      resource:
-        name: cpu
-        targetAverageUtilization: {{ .Values.autoscaling.targetCPUUtilizationPercentage }}
-    {{- end }}
-    {{- if .Values.autoscaling.targetMemoryUtilizationPercentage }}
-    - type: Resource
-      resource:
-        name: memory
-        targetAverageUtilization: {{ .Values.autoscaling.targetMemoryUtilizationPercentage }}
-    {{- end }}
-{{- end }}

deployments/openim-chat/templates/ingress.yaml

@@ -1,75 +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.
-
-{{- if .Values.ingress.enabled -}}
-{{- $fullName := include "openim-chat.fullname" . -}}
-{{- $svcPort := .Values.service.port -}}
-{{- if and .Values.ingress.className (not (semverCompare ">=1.18-0" .Capabilities.KubeVersion.GitVersion)) }}
-  {{- if not (hasKey .Values.ingress.annotations "kubernetes.io/ingress.class") }}
-  {{- $_ := set .Values.ingress.annotations "kubernetes.io/ingress.class" .Values.ingress.className}}
-  {{- end }}
-{{- end }}
-{{- if semverCompare ">=1.19-0" .Capabilities.KubeVersion.GitVersion -}}
-apiVersion: networking.k8s.io/v1
-{{- else if semverCompare ">=1.14-0" .Capabilities.KubeVersion.GitVersion -}}
-apiVersion: networking.k8s.io/v1beta1
-{{- else -}}
-apiVersion: extensions/v1beta1
-{{- end }}
-kind: Ingress
-metadata:
-  name: {{ $fullName }}
-  labels:
-    {{- include "openim-chat.labels" . | nindent 4 }}
-  {{- with .Values.ingress.annotations }}
-  annotations:
-    {{- toYaml . | nindent 4 }}
-  {{- end }}
-spec:
-  {{- if and .Values.ingress.className (semverCompare ">=1.18-0" .Capabilities.KubeVersion.GitVersion) }}
-  ingressClassName: {{ .Values.ingress.className }}
-  {{- end }}
-  {{- if .Values.ingress.tls }}
-  tls:
-    {{- range .Values.ingress.tls }}
-    - hosts:
-        {{- range .hosts }}
-        - {{ . | quote }}
-        {{- end }}
-      secretName: {{ .secretName }}
-    {{- end }}
-  {{- end }}
-  rules:
-    {{- range .Values.ingress.hosts }}
-    - host: {{ .host | quote }}
-      http:
-        paths:
-          {{- range .paths }}
-          - path: {{ .path }}
-            {{- if and .pathType (semverCompare ">=1.18-0" $.Capabilities.KubeVersion.GitVersion) }}
-            pathType: {{ .pathType }}
-            {{- end }}
-            backend:
-              {{- if semverCompare ">=1.19-0" $.Capabilities.KubeVersion.GitVersion }}
-              service:
-                name: {{ $fullName }}
-                port:
-                  number: {{ $svcPort }}
-              {{- else }}
-              serviceName: {{ $fullName }}
-              servicePort: {{ $svcPort }}
-              {{- end }}
-          {{- end }}
-    {{- end }}
-{{- end }}

deployments/openim-chat/templates/service.yaml

@@ -1,29 +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.
-
-apiVersion: v1
-kind: Service
-metadata:
-  name: {{ include "openim-chat.fullname" . }}
-  labels:
-    {{- include "openim-chat.labels" . | nindent 4 }}
-spec:
-  type: {{ .Values.service.type }}
-  ports:
-    - port: {{ .Values.service.port }}
-      targetPort: http
-      protocol: TCP
-      name: http
-  selector:
-    {{- include "openim-chat.selectorLabels" . | nindent 4 }}

deployments/openim-chat/templates/serviceaccount.yaml

@@ -1,26 +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.
-
-{{- if .Values.serviceAccount.create -}}
-apiVersion: v1
-kind: ServiceAccount
-metadata:
-  name: {{ include "openim-chat.serviceAccountName" . }}
-  labels:
-    {{- include "openim-chat.labels" . | nindent 4 }}
-  {{- with .Values.serviceAccount.annotations }}
-  annotations:
-    {{- toYaml . | nindent 4 }}
-  {{- end }}
-{{- end }}

deployments/openim-chat/values.yaml

@@ -1,96 +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.
-
-# Default values for openim-chat.
-# This is a YAML-formatted file.
-# Declare variables to be passed into your templates.
-
-replicaCount: 1
-
-image:
-  repository: nginx
-  pullPolicy: IfNotPresent
-  # Overrides the image tag whose default is the chart appVersion.
-  tag: ""
-
-imagePullSecrets: []
-nameOverride: ""
-fullnameOverride: ""
-
-serviceAccount:
-  # Specifies whether a service account should be created
-  create: true
-  # Annotations to add to the service account
-  annotations: {}
-  # The name of the service account to use.
-  # If not set and create is true, a name is generated using the fullname template
-  name: ""
-
-podAnnotations: {}
-
-podSecurityContext: {}
-  # fsGroup: 2000
-
-securityContext: {}
-  # capabilities:
-  #   drop:
-  #   - ALL
-  # readOnlyRootFilesystem: true
-  # runAsNonRoot: true
-  # runAsUser: 1000
-
-service:
-  type: ClusterIP
-  port: 80
-
-ingress:
-  enabled: false
-  className: ""
-  annotations: {}
-    # kubernetes.io/ingress.class: nginx
-    # kubernetes.io/tls-acme: "true"
-  hosts:
-    - host: chart-example.local
-      paths:
-        - path: /
-          pathType: ImplementationSpecific
-  tls: []
-  #  - secretName: chart-example-tls
-  #    hosts:
-  #      - chart-example.local
-
-resources: {}
-  # We usually recommend not to specify default resources and to leave this as a conscious
-  # choice for the user. This also increases chances charts run on environments with little
-  # resources, such as Minikube. If you do want to specify resources, uncomment the following
-  # lines, adjust them as necessary, and remove the curly braces after 'resources:'.
-  # limits:
-  #   cpu: 100m
-  #   memory: 128Mi
-  # requests:
-  #   cpu: 100m
-  #   memory: 128Mi
-
-autoscaling:
-  enabled: false
-  minReplicas: 1
-  maxReplicas: 100
-  targetCPUUtilizationPercentage: 80
-  # targetMemoryUtilizationPercentage: 80
-
-nodeSelector: {}
-
-tolerations: []
-
-affinity: {}

deployments/openim-server/Chart.yaml

@@ -35,4 +35,40 @@ version: 0.1.0
 # incremented each time you make changes to the application. Versions are not expected to
 # follow Semantic Versioning. They should reflect the version the application is using.
 # It is recommended to use it with quotes.
-appVersion: "1.16.0"
+appVersion: "default"
+
+icon: https://raw.githubusercontent.com/openimsdk/open-im-server/main/assets/openim-logo-gradient.svg
+
+maintainers:
+  - name: "OpenIM"
+    url: "https://github.com/openimsdk"
+
+keywords:
+  - openim
+  - im
+  - chat
+
+sources:
+  - "https://github.com/openimsdk/open-im-server"
+  - "https://github.com/openimsdk/openim-sdk-core"
+  - "https://github.com/openimsdk/openim-docker"
+
+dependencies:
+  - name: mysql
+    version: 8.0.25
+    repository: https://charts.bitnami.com/bitnami
+  - name: redis
+    version: 14.6.1
+    repository: https://charts.bitnami.com/bitnami
+  - name: mongodb
+    version: 10.1.0
+    repository: https://charts.bitnami.com/bitnami
+  - name: kafka
+    version: 14.1.0
+    repository: https://charts.bitnami.com/bitnami
+  - name: minio
+    version: 8.1.2
+    repository: https://charts.bitnami.com/bitnami
+  - name: zookeeper
+    version: 5.17.0
+    repository: https://charts.bitnami.com/bitnami

deployments/openim-server/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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.

deployments/openim-server/README.md

@@ -0,0 +1,15 @@
+# OpenIM Server Chat
+
+## 目录结构
+
+```bash
+openim-server/
+  Chart.yaml          # 包含了chart信息的YAML文件
+  LICENSE             # 包含OpenIM Chart许可证的纯文本文件
+  README.md           # OpenIM 可读的README文件
+  values.yaml         # chart 默认的配置值
+  charts/             # 包含chart依赖的其他chart
+  crds/               # 自定义资源的定义
+  templates/          # 模板目录， 当和values 结合时，可生成有效的Kubernetes manifest文件
+  templates/NOTES.txt # 包含简要使用说明的纯文本文件
+```

deployments/templates/env_template.yaml

@@ -36,6 +36,13 @@ API_URL=${API_URL}
 # Default: DATA_DIR=./
 DATA_DIR=${DATA_DIR}
 
+# Choose the appropriate image address, the default is GITHUB image, 
+# you can choose docker hub, for Chinese users can choose Ali Cloud
+# export IMAGE_REGISTRY="ghcr.io/openimsdk"
+# export IMAGE_REGISTRY="openim"
+# export IMAGE_REGISTRY="registry.cn-hangzhou.aliyuncs.com/openimsdk"
+IMAGE_REGISTRY=${IMAGE_REGISTRY}
+
 # ======================================
 # ========= Network Configuration ======
 # ======================================
@@ -227,7 +234,6 @@ OPENIM_WEB_PORT=${OPENIM_WEB_PORT}
 # Default: OPENIM_WEB_ADDRESS=172.28.0.1
 OPENIM_WEB_ADDRESS=${OPENIM_WEB_NETWORK_ADDRESS}
 
-
 # ======================================
 # ========= OpenIM Server ==============
 # ======================================

deployments/templates/init/openim-api.service

@@ -1,7 +1,7 @@
 [Unit]
 Description=OPENIM OPENIM API
 Documentation=Control interface for the OpenIM API service.
-Documentation=https://github.com/OpenIMSDK/Open-IM-Server/blob/main/deployment/init/README.md
+Documentation=https://github.com/openimsdk/open-im-server/blob/main/deployment/init/README.md
 
 [Service]
 WorkingDirectory=${OPENIM_DATA_DIR}/openim-api

deployments/templates/init/openim-cmdutils.service

@@ -1,7 +1,7 @@
 [Unit]
 Description=OPENIM OPENIM CMDUTILS
 Documentation=Utility toolkit for common OpenIM command-line operations.
-Documentation=https://github.com/OpenIMSDK/Open-IM-Server/blob/main/deployment/init/README.md
+Documentation=https://github.com/openimsdk/open-im-server/blob/main/deployment/init/README.md
 
 [Service]
 WorkingDirectory=${OPENIM_DATA_DIR}/openim-cmdutils

deployments/templates/init/openim-crontask.service

@@ -1,7 +1,7 @@
 [Unit]
 Description=OPENIM OPENIM CRONTASK
 Documentation=Manages the OpenIM CronTask service, with both direct and systemctl installation methods.
-Documentation=https://github.com/OpenIMSDK/Open-IM-Server/blob/main/deployment/init/README.md
+Documentation=https://github.com/openimsdk/open-im-server/blob/main/deployment/init/README.md
 
 [Service]
 WorkingDirectory=${OPENIM_DATA_DIR}/openim-crontask

deployments/templates/init/openim-msggateway.service

@@ -1,6 +1,6 @@
 [Unit]
 Description=OPENIM OPENIM MSGGATEWAY
-Documentation=https://github.com/OpenIMSDK/Open-IM-Server/blob/main/deployment/init/README.md
+Documentation=https://github.com/openimsdk/open-im-server/blob/main/deployment/init/README.md
 
 [Service]
 WorkingDirectory=${OPENIM_DATA_DIR}/openim-msggateway

deployments/templates/init/openim-msgtransfer.service

@@ -1,6 +1,6 @@
 [Unit]
 Description=OPENIM OPENIM MSGTRANSFER
-Documentation=https://github.com/OpenIMSDK/Open-IM-Server/blob/main/deployment/init/README.md
+Documentation=https://github.com/openimsdk/open-im-server/blob/main/deployment/init/README.md
 
 [Service]
 WorkingDirectory=${OPENIM_DATA_DIR}/openim-msgtransfer

deployments/templates/init/openim-push.service

@@ -1,7 +1,7 @@
 [Unit]
 Description=OPENIM OPENIM PUSH
 Documentation=Interface for controlling the OpenIM Push Notification service.
-Documentation=https://github.com/OpenIMSDK/Open-IM-Server/blob/main/deployment/init/README.md
+Documentation=https://github.com/openimsdk/open-im-server/blob/main/deployment/init/README.md
 
 [Service]
 WorkingDirectory=${OPENIM_DATA_DIR}/openim-push

deployments/templates/init/openim-rpc.service

@@ -1,6 +1,6 @@
 [Unit]
 Description=OPENIM OPENIM RPC AUTH
-Documentation=https://github.com/OpenIMSDK/Open-IM-Server/blob/main/deployment/init/README.md
+Documentation=https://github.com/openimsdk/open-im-server/blob/main/deployment/init/README.md
 
 [Service]
 WorkingDirectory=${OPENIM_DATA_DIR}/openim-rpc-auth

deployments/templates/openim.yaml

@@ -19,6 +19,9 @@
 # --| target: config/config.yaml
 # -----------------------------------------------------------------
 
+envs:
+  discovery: ${ENVS_DISCOVERY}
+
 ###################### Zookeeper ######################
 # Zookeeper configuration
 # It's not recommended to modify the schema
@@ -140,11 +143,13 @@ object:
     secretAccessKey: "${MINIO_SECRET_KEY}"
     sessionToken: ${MINIO_SESSION_TOKEN}
     signEndpoint: "${MINIO_SIGN_ENDPOINT}"
+    publicRead: ${MINIO_PUBLIC_READ}
   cos:
     bucketURL: ${COS_BUCKET_URL}
     secretID: ${COS_SECRET_ID}
     secretKey: ${COS_SECRET_KEY}
     sessionToken: ${COS_SESSION_TOKEN}
+    publicRead: ${COS_PUBLIC_READ}
   oss:
     endpoint: "${OSS_ENDPOINT}"
     bucket: "${OSS_BUCKET}"
@@ -152,7 +157,7 @@ object:
     accessKeyID: ${OSS_ACCESS_KEY_ID}
     accessKeySecret: ${OSS_ACCESS_KEY_SECRET}
     sessionToken: ${OSS_SESSION_TOKEN}
-
+    publicRead: ${OSS_PUBLIC_READ}
 
 ###################### RPC Port Configuration ######################
 # RPC service ports
@@ -226,18 +231,18 @@ push:
   enable: ${PUSH_ENABLE}
   geTui:
     pushUrl: "${GETUI_PUSH_URL}"
-    masterSecret: ""
-    appKey: ""
-    intent: ""
-    channelID: ""
-    channelName: ""
+    masterSecret: ${GETUI_MASTER_SECRET}
+    appKey: ${GETUI_APP_KEY}
+    intent: ${GETUI_INTENT}
+    channelID: ${GETUI_CHANNEL_ID}
+    channelName: ${GETUI_CHANNEL_NAME}
   fcm:
     serviceAccount: "${FCM_SERVICE_ACCOUNT}"
   jpns:
-    appKey:
-    masterSecret:
-    pushUrl:
-    pushIntent:
+    appKey: ${JPNS_APP_KEY}
+    masterSecret: ${JPNS_MASTER_SECRET}
+    pushUrl: ${JPNS_PUSH_URL}
+    pushIntent: ${JPNS_PUSH_INTENT}
 
 # App manager configuration
 #
@@ -351,6 +356,10 @@ callback:
     enable: false
     timeout: 5
     failedContinue: true
+  beforeUpdateUserInfo:
+    enable: false
+    timeout: 5
+    failedContinue: true
   beforeCreateGroup:
     enable: false
     timeout: 5

docker-compose.yml

@@ -10,29 +10,6 @@ networks:
         - subnet: '${DOCKER_BRIDGE_SUBNET}'
           gateway: '${DOCKER_BRIDGE_GATEWAY}'
 
-volumes:
-  mysql_data:
-  mongodb_data:
-  mongodb_logs:
-  mongodb_config:
-  redis_data:
-  redis_config:
-  kafka_data:
-  minio_data:
-  minio_config:
-  openim_server_logs:
-  openim_server_output:
-  openim_server_config:
-  openim_server_scripts:
-  openim_chat_logs:
-  openim_chat_output:
-  openim_chat_config:
-  openim_chat_scripts:
-  openim_server_prometheus_config:
-  openim_server_grafana_datasource:
-  openim_server_grafana_config:
-  openim_server_grafana_dashboard:
-
 services:
   mysql:
     image: mysql:5.7
@@ -40,7 +17,7 @@ services:
       - "${MYSQL_PORT}:3306"
     container_name: mysql
     volumes:
-      - mysql_data:/var/lib/mysql
+      - "${DATA_DIR}/components/mysql/data:/var/lib/mysql"
       - "/etc/localtime:/etc/localtime"
     environment:
       MYSQL_ROOT_PASSWORD: "${MYSQL_PASSWORD}"
@@ -56,10 +33,10 @@ services:
     container_name: mongo
     command: --wiredTigerCacheSizeGB 1 --auth
     volumes:
-      - mongodb_data:/data/db
-      - mongodb_logs:/data/logs
-      - mongodb_config:/etc/mongo
-      - "./scripts/mongo-init.sh:/docker-entrypoint-initdb.d/mongo-init.sh:ro"
+      - "${DATA_DIR}/components/mongodb/data/db:/data/db"
+      - "${DATA_DIR}/components/mongodb/data/logs:/data/logs"
+      - "${DATA_DIR}/components/mongodb/data/conf:/etc/mongo"
+      - ./scripts/mongo-init.sh:/docker-entrypoint-initdb.d/mongo-init.sh:ro"
     environment:
       - TZ=Asia/Shanghai
       - wiredTigerCacheSizeGB=1
@@ -77,8 +54,8 @@ services:
     ports:
       - "${REDIS_PORT}:6379"
     volumes:
-      - redis_data:/data
-      - redis_config:/usr/local/redis/config/redis.conf
+      - "${DATA_DIR}/components/redis/data:/data"
+      - "${DATA_DIR}/components/redis/config/redis.conf:/usr/local/redis/config/redis.conf"
     environment:
       TZ: Asia/Shanghai
     restart: always
@@ -118,8 +95,6 @@ services:
       bash -c "
       /opt/bitnami/scripts/kafka/run.sh & sleep 5; /opt/bitnami/kafka/create_topic.sh; wait
       "
-    extra_hosts:
-      - "host.docker.internal:host-gateway"
     environment:
        - TZ=Asia/Shanghai
        - KAFKA_CFG_NODE_ID=0
@@ -140,8 +115,8 @@ services:
       - "9090:9090"
     container_name: minio
     volumes:
-      - minio_data:/data
-      - minio_config:/root/.minio
+      - "${DATA_DIR}/components/mnt/data:/data"
+      - "${DATA_DIR}/components/mnt/config:/root/.minio"
     environment:
       MINIO_ROOT_USER: "${MINIO_ACCESS_KEY}"
       MINIO_ROOT_PASSWORD: "${MINIO_SECRET_KEY}"
@@ -152,7 +127,10 @@ services:
         ipv4_address: ${MINIO_NETWORK_ADDRESS}
 
   openim-web:
-    image: ghcr.io/openimsdk/openim-web:latest
+    # image: ghcr.io/openimsdk/openim-web:latest
+    # image: registry.cn-hangzhou.aliyuncs.com/openimsdk/openim-web:latest
+    # image: openim/openim-web:latest
+    image: ${IMAGE_REGISTRY}/openim-web:latest
     container_name: openim-web
     environment:
       - OPENIM_WEB_DIST_PATH=${OPENIM_WEB_DIST_PATH}
@@ -166,8 +144,9 @@ services:
 
 #   openim-server:
 #     # image: ghcr.io/openimsdk/openim-server:main
-#     image: registry.cn-hangzhou.aliyuncs.com/openimsdk/openim-server:main
+#     # image: registry.cn-hangzhou.aliyuncs.com/openimsdk/openim-server:main
 #     # image: openim/openim-server:main
+#     image: ${IMAGE_REGISTRY}/openim-server:main
 # #    build: .
 #     container_name: openim-server
 #     ports:
@@ -180,7 +159,7 @@ services:
 #       retries: 5
 #     volumes:
 #       - ./logs:/openim/openim-server/logs
-#       - ./_output:/openim/openim-server/_output
+#       - ./_output/logs:/openim/openim-server/_output/logs
 #       - ./config:/openim/openim-server/config
 #       - ./scripts:/openim/openim-server/scripts
 #     restart: always
@@ -199,69 +178,31 @@ services:
 #       server:
 #         ipv4_address: ${OPENIM_SERVER_NETWORK_ADDRESS}
 
-  # openim-chat:
-  #   # image: ghcr.io/openimsdk/openim-chat:main
-  #   image: registry.cn-hangzhou.aliyuncs.com/openimsdk/openim-chat:main
-  #   # image: ghcr.io/openimsdk/openim-chat:main
-  #   container_name: openim-chat
-  #   healthcheck:
-  #     test: ["CMD", "/openim/openim-chat/scripts/check_all.sh"]
-  #     interval: 300s
-  #     timeout: 10s
-  #     retries: 5
-  #   ports:
-  #     - ${OPENIM_CHAT_API_PORT}:10008
-  #     - ${OPENIM_ADMIN_API_PORT}:10009
-  #   volumes:
-  #     - openim_chat_logs:/openim/openim-chat/logs
-  #     - openim_chat_output:/openim/openim-chat/_output
-  #     - openim_chat_config:/openim/openim-chat/config
-  #     - openim_chat_scripts:/openim/openim-chat/scripts
-  #   restart: always
-  #   user: root:root
-  #   depends_on:
-  #     - mysql
-  #     - mongodb
-  #     - redis
-  #     - minio
-  #     - server
-  #   logging:
-  #     driver: json-file
-  #     options:
-  #       max-size: "1g"
-  #       max-file: "2"
-  #   networks:
-  #     server:
-  #       ipv4_address: ${OPENIM_CHAT_NETWORK_ADDRESS}
+#   prometheus:
+#     image: prom/prometheus
+#     volumes:
+#       - ./.docker-compose_cfg/prometheus-compose.yml:/etc/prometheus/prometheus.yml
+#     container_name: prometheus
+#     ports:
+#       - ${PROMETHEUS_PORT}:9091
+#     depends_on:
+#       - openim-server
+#     command: --web.listen-address=:9091 --config.file="/etc/prometheus/prometheus.yml"
+#     networks:
+#       openim-server:
+#         ipv4_address: ${PROMETHEUS_NETWORK_ADDRESS}
 
-  # prometheus:
-  #   image: prom/prometheus
-  #   volumes:
-  #     - openim_server_prometheus_config:/etc/prometheus
-  #   container_name: prometheus
-  #   ports:
-  #     - ${PROMETHEUS_PORT}:9091
-  #   command: --web.listen-address=:9091 --config.file="/etc/prometheus"
-  #   networks:
-  #     server:
-  #       ipv4_address: ${PROMETHEUS_NETWORK_ADDRESS}
-
-  # grafana:
-  #   image: grafana/grafana
-  #   volumes:
-  #     - openim_server_grafana_datasource:/etc/grafana/provisioning/datasources
-  #     - openim_server_grafana_config:/etc/grafana
-  #     - openim_server_grafana_dashboard:/var/lib/grafana/dashboards
-  #   container_name: grafana
-  #   ports:
-  #     - ${GRAFANA_PORT}:3000
-  #   networks:
-  #     server:
-  #       ipv4_address: ${GRAFANA_NETWORK_ADDRESS}
-
-  # node-exporter:
-  #   image: quay.io/prometheus/node-exporter
-  #   container_name: node-exporter
-  #   restart: always
-  #   ports:
-  #     - "9100:9100"
+#   grafana:
+#     image: grafana/grafana
+#     volumes:
+#       - ./.docker-compose_cfg/datasource-compose.yaml:/etc/grafana/provisioning/datasources/datasource.yaml
+#       - ./.docker-compose_cfg/grafana.ini:/etc/grafana/grafana.ini
+#       - ./.docker-compose_cfg/node-exporter-full_rev1.json:/var/lib/grafana/dashboards/node-exporter-full_rev1.json
+#     container_name: grafana
+#     ports:
+#       - ${GRAFANA_PORT}:3000
+#     depends_on:
+#       - prometheus
+#     networks:
+#       openim-server:
+#         ipv4_address: ${GRAFANA_NETWORK_ADDRESS}

docs/README.md

@@ -4,8 +4,8 @@ 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
+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
 
 ------
 
@@ -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.
-- [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.
-- [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.
+- [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.
+- [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.
 
 ## 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/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.
 
 
 ## For Developers, Contributors, and Community Maintainers
@@ -49,19 +49,19 @@ 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.
-- 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.
+- 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
 
 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/conversions/bash_log.md) and [Error Codes](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/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/conversions/images.md) - To understand the different images available and how to choose the right one for your architecture.

docs/contrib/code_conventions.md

@@ -35,4 +35,4 @@
 
 ## Testing conventions
 
-Please refer to [TESTING.md](https://github.com/OpenIMSDK/Open-IM-Server/tree/main/test/readme) document.
+Please refer to [TESTING.md](https://github.com/openimsdk/open-im-server/tree/main/test/readme) document.

docs/contrib/development.md

@@ -61,7 +61,7 @@ OpenIM build and test processes development require Docker to run certain steps.
 
 ### Vagrant
 
-As described in the [Testing documentation](https://github.com/OpenIMSDK/Open-IM-Server/tree/main/test/readme), all the smoke tests are run in virtual machines managed by Vagrant.  To install Vagrant in the development environment, [follow the instructions from the Hashicorp website](https://www.vagrantup.com/downloads), alongside any of the following hypervisors:
+As described in the [Testing documentation](https://github.com/openimsdk/open-im-server/tree/main/test/readme), all the smoke tests are run in virtual machines managed by Vagrant.  To install Vagrant in the development environment, [follow the instructions from the Hashicorp website](https://www.vagrantup.com/downloads), alongside any of the following hypervisors:
 
 - [VirtualBox](https://www.virtualbox.org/)
 - [libvirt](https://libvirt.org/) and the [vagrant-libvirt plugin](https://github.com/vagrant-libvirt/vagrant-libvirt#installation)

docs/contrib/environment.md

@@ -1,138 +1,530 @@
-# OpenIM enviroment
+# OpenIM ENVIRONMENT CONFIGURATION
+
+<!-- vscode-markdown-toc -->
+* 1. [OpenIM Deployment Guide](#OpenIMDeploymentGuide)
+	* 1.1. [Deployment Strategies](#DeploymentStrategies)
+	* 1.2. [Source Code Deployment](#SourceCodeDeployment)
+	* 1.3. [Docker Compose Deployment](#DockerComposeDeployment)
+	* 1.4. [Environment Variable Configuration](#EnvironmentVariableConfiguration)
+		* 1.4.1. [Recommended using environment variables](#Recommendedusingenvironmentvariables)
+		* 1.4.2. [Additional Configuration](#AdditionalConfiguration)
+		* 1.4.3. [Security Considerations](#SecurityConsiderations)
+		* 1.4.4. [Data Management](#DataManagement)
+		* 1.4.5. [Monitoring and Logging](#MonitoringandLogging)
+		* 1.4.6. [Troubleshooting](#Troubleshooting)
+		* 1.4.7. [Conclusion](#Conclusion)
+		* 1.4.8. [Additional Resources](#AdditionalResources)
+* 2. [Further Configuration](#FurtherConfiguration)
+	* 2.1. [Image Registry Configuration](#ImageRegistryConfiguration)
+	* 2.2. [OpenIM Docker Network Configuration](#OpenIMDockerNetworkConfiguration)
+	* 2.3. [OpenIM Configuration](#OpenIMConfiguration)
+	* 2.4. [OpenIM Chat Configuration](#OpenIMChatConfiguration)
+	* 2.5. [Zookeeper Configuration](#ZookeeperConfiguration)
+	* 2.6. [MySQL Configuration](#MySQLConfiguration)
+	* 2.7. [MongoDB Configuration](#MongoDBConfiguration)
+	* 2.8. [Tencent Cloud COS Configuration](#TencentCloudCOSConfiguration)
+	* 2.9. [Alibaba Cloud OSS Configuration](#AlibabaCloudOSSConfiguration)
+	* 2.10. [Redis Configuration](#RedisConfiguration)
+	* 2.11. [Kafka Configuration](#KafkaConfiguration)
+	* 2.12. [OpenIM Web Configuration](#OpenIMWebConfiguration)
+	* 2.13. [RPC Configuration](#RPCConfiguration)
+	* 2.14. [Prometheus Configuration](#PrometheusConfiguration)
+	* 2.15. [Grafana Configuration](#GrafanaConfiguration)
+	* 2.16. [RPC Port Configuration Variables](#RPCPortConfigurationVariables)
+	* 2.17. [RPC Register Name Configuration](#RPCRegisterNameConfiguration)
+	* 2.18. [Log Configuration](#LogConfiguration)
+	* 2.19. [Additional Configuration Variables](#AdditionalConfigurationVariables)
+	* 2.20. [Prometheus Configuration](#PrometheusConfiguration-1)
+		* 2.20.1. [General Configuration](#GeneralConfiguration)
+		* 2.20.2. [Service-Specific Prometheus Ports](#Service-SpecificPrometheusPorts)
+
+## 0. <a name='TableofContents'></a>OpenIM Config File
+
+Ensuring that OpenIM operates smoothly requires clear direction on the configuration file's location. Here's a detailed step-by-step guide on how to provide this essential path to OpenIM:
+
+1. **Using the Command-line Argument**:
+
+   + **For Configuration Path**: When initializing OpenIM, you can specify the path to the configuration file directly using the `-c` or `--config_folder_path` option.
+
+     ```bash
+     ❯ _output/bin/platforms/linux/amd64/openim-api --config_folder_path="/your/config/folder/path"
+     ```
+
+   + **For Port Specification**: Similarly, if you wish to designate a particular port, utilize the `-p` option followed by the desired port number.
+
+     ```bash
+     ❯ _output/bin/platforms/linux/amd64/openim-api -p 1234
+     ```
+
+     Note: If the port is not specified here, OpenIM will fetch it from the configuration file. Setting the port via environment variables isn't supported. We recommend consolidating settings in the configuration file for a more consistent and streamlined setup.
+
+2. **Leveraging the Environment Variable**:
+
+   You have the flexibility to determine OpenIM's configuration path by setting an `OPENIMCONFIG` environment variable. This method provides a seamless way to instruct OpenIM without command-line parameters every time.
+
+   ```bash
+   export OPENIMCONFIG="/path/to/your/config"
+   ```
+
+3. **Relying on the Default Path**:
+
+   In scenarios where neither command-line arguments nor environment variables are provided, OpenIM will intuitively revert to the `config/` directory to locate its configuration.
 
 
-## How to change the configuration
 
+##  1. <a name='OpenIMDeploymentGuide'></a>OpenIM Deployment Guide
 
-**Modify the configuration files:**
+Welcome to the OpenIM Deployment Guide! OpenIM offers a versatile and robust instant messaging server, and deploying it can be achieved through various methods. This guide will walk you through the primary deployment strategies, ensuring you can set up OpenIM in a way that best suits your needs.
 
-Three ways to modify the configuration:
+###  1.1. <a name='DeploymentStrategies'></a>Deployment Strategies
 
-#### **1. Recommended using environment variables:**
+OpenIM provides multiple deployment methods, each tailored to different use cases and technical preferences:
+
+1. **[Source Code Deployment Guide](https://doc.rentsoft.cn/guides/gettingStarted/imSourceCodeDeployment)**
+2. **[Docker Deployment Guide](https://doc.rentsoft.cn/guides/gettingStarted/dockerCompose)**
+3. **[Kubernetes Deployment Guide](https://github.com/openimsdk/open-im-server/tree/main/deployments)**
+
+While the first two methods will be our main focus, it's worth noting that the third method, Kubernetes deployment, is also viable and can be rendered via the `environment.sh` script variables.
+
+###  1.2. <a name='SourceCodeDeployment'></a>Source Code Deployment
+
+In the source code deployment method, the configuration generation process involves executing `make init`, which fundamentally runs the script `./scripts/init-config.sh`. This script utilizes variables defined in the [`environment.sh`](https://github.com/openimsdk/open-im-server/blob/main/scripts/install/environment.sh) script to render the [`openim.yaml`](https://github.com/openimsdk/open-im-server/blob/main/deployments/templates/openim.yaml) template file, subsequently generating the [`config.yaml`](https://github.com/openimsdk/open-im-server/blob/main/config/config.yaml) configuration file.
+
+###  1.3. <a name='DockerComposeDeployment'></a>Docker Compose Deployment
+
+Docker deployment offers a slightly more intricate template. Within the [openim-server](https://github.com/openimsdk/openim-docker/tree/main/openim-server) directory, multiple subdirectories correspond to various versions, each aligning with `openim-chat` as illustrated below:
+
+| openim-server                                                | openim-chat                                                  |
+| ------------------------------------------------------------ | ------------------------------------------------------------ |
+| [main](https://github.com/openimsdk/openim-docker/tree/main/openim-server/main) | [main](https://github.com/openimsdk/openim-docker/tree/main/openim-chat/main) |
+| [release-v3.2](https://github.com/openimsdk/openim-docker/tree/main/openim-server/release-v3.3) | [release-v3.2](https://github.com/openimsdk/openim-docker/tree/main/openim-chat/release-v1.3) |
+| [release-v3.2](https://github.com/openimsdk/openim-docker/tree/main/openim-server/release-v3.2) | [release-v3.2](https://github.com/openimsdk/openim-docker/tree/main/openim-chat/release-v1.2) |
+
+Configuration file modifications can be made by specifying corresponding environment variables, for instance:
 
 ```bash
-export PASSWORD="openIM123" # Set password
-export USER="root" # Set username
-# Choose chat version and server version https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/images.md, eg: main, release-v*.*
-export CHAT_BRANCH="main"
-export SERVER_BRANCH="main"
-#... Other environment variables
-# MONGO_USERNAME: This sets the MongoDB username
-# MONGO_PASSWORD: Set the MongoDB password
-# MONGO_DATABASE: Sets the MongoDB database name
-# MINIO_ENDPOINT: set the MinIO service address
-# API_URL: under network environment, set OpenIM Server API address
-export API_URL="http://127.0.0.1:10002"
+export CHAT_BRANCH="main"   
+export SERVER_BRANCH="main" 
 ```
 
-Next, update the configuration using `make init`:
+These variables are stored within the [`environment.sh`](https://github.com/OpenIMSDK/openim-docker/blob/main/scripts/install/environment.sh) configuration:
 
 ```bash
-make init
+readonly CHAT_BRANCH=${CHAT_BRANCH:-'main'}
+readonly SERVER_BRANCH=${SERVER_BRANCH:-'main'}
 ```
 
-#### **2. Modify the automation script:**
+Setting a variable, e.g., `export CHAT_BRANCH="release-v1.3"`, will prioritize `CHAT_BRANCH="release-v1.3"` as the variable value. Ultimately, the chosen image version is determined, and rendering is achieved through `make init` (or `./scripts/init-config.sh`).
+
+> Note: Direct modifications to the `config.yaml` file are also permissible without utilizing `make init`.
+
+###  1.4. <a name='EnvironmentVariableConfiguration'></a>Environment Variable Configuration
+
+For convenience, configuration through modifying environment variables is recommended:
+
+####  1.4.1. <a name='Recommendedusingenvironmentvariables'></a>Recommended using environment variables
+
++ PASSWORD
+
+  + **Description**: Password for mysql, mongodb, redis, and minio.
+  + **Default**: `openIM123`
+  + Notes:
+    + Minimum password length: 8 characters.
+    + Special characters are not allowed.
+
+  ```bash
+  export PASSWORD="openIM123"
+  ```
+
++ USER
+
+  + **Description**: Username for mysql, mongodb, redis, and minio.
+  + **Default**: `root`
+
+  ```bash
+  export USER="root"
+  ```
+
++ API_URL
+
+  + **Description**: API address.
+  + **Note**: If the server has an external IP, it will be automatically obtained. For internal networks, set this variable to the IP serving internally.
+
+  ```
+  export API_URL="http://ip:10002"
+  ```
+
++ DATA_DIR
+
+  + **Description**: Data mount directory for components.
+  + **Default**: `/data/openim`
+
+  ```bash
+  export DATA_DIR="/data/openim"
+  ```
+
+####  1.4.2. <a name='AdditionalConfiguration'></a>Additional Configuration
+
+##### MinIO Access and Secret Key
+
+To secure your MinIO server, you should set up an access key and secret key. These credentials are used to authenticate requests to your MinIO server.
 
 ```bash
-scripts/install/environment.sh
+export MINIO_ACCESS_KEY="YourAccessKey"
+export MINIO_SECRET_KEY="YourSecretKey"
 ```
 
-Next, update the configuration using `make init`:
+##### MinIO Browser
+
+MinIO comes with an embedded web-based object browser. You can control the availability of the MinIO browser by setting the `MINIO_BROWSER` environment variable.
 
 ```bash
-make init
+export MINIO_BROWSER="on"
 ```
 
-#### 3. Modify `config.yaml` and `.env` files (but will be overwritten when using `make init` again).
+####  1.4.3. <a name='SecurityConsiderations'></a>Security Considerations
 
-The `config/config.yaml` file has detailed configuration instructions for the storage components.
+##### TLS/SSL Configuration
 
+For secure communication, it's recommended to enable TLS/SSL for your MinIO server. You can do this by providing the path to the SSL certificate and key files.
 
-The config file is available via [environment.sh](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/scripts/install/environment.sh) configuration [openim.yaml](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/deployments/templates/openim.yaml) template, and then through the `make init` to automatically generate a new configuration.
+```bash
+export MINIO_CERTS_DIR="/path/to/certs/directory"
+```
+
+####  1.4.4. <a name='DataManagement'></a>Data Management
+
+##### Data Retention Policy
+
+You may want to set up a data retention policy to automatically delete objects after a specified period.
+
+```bash
+export MINIO_RETENTION_DAYS="30"
+```
+
+####  1.4.5. <a name='MonitoringandLogging'></a>Monitoring and Logging
+
+##### [Audit Logging](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/environment.md#audit-logging)
+
+Enable audit logging to keep track of access and changes to your data.
+
+```bash
+export MINIO_AUDIT="on"
+```
+
+####  1.4.6. <a name='Troubleshooting'></a>Troubleshooting
+
+##### Debug Mode
+
+In case of issues, you may enable debug mode to get more detailed logs to assist in troubleshooting.
+
+```bash
+export MINIO_DEBUG="on"
+```
+
+####  1.4.7. <a name='Conclusion'></a>Conclusion
+
+With the environment variables configured as per your requirements, your MinIO server should be ready to securely store and manage your object data. Ensure to verify the setup and monitor the logs for any unusual activities or errors. Regularly update the MinIO server and review your configuration to adapt to any changes or improvements in the MinIO system.
+
+####  1.4.8. <a name='AdditionalResources'></a>Additional Resources
+
++ [MinIO Client Quickstart Guide](https://docs.min.io/docs/minio-client-quickstart-guide)
++ [MinIO Admin Complete Guide](https://docs.min.io/docs/minio-admin-complete-guide)
++ [MinIO Docker Quickstart Guide](https://docs.min.io/docs/minio-docker-quickstart-guide)
+
+Feel free to explore the MinIO documentation for more advanced configurations and usage scenarios.
 
 
 
+##  2. <a name='FurtherConfiguration'></a>Further Configuration
 
-## Configuration Details
+###  2.1. <a name='ImageRegistryConfiguration'></a>Image Registry Configuration
 
-###### Zookeeper
+**Description**: The image registry configuration allows users to select an image address for use. The default is set to use GITHUB images, but users can opt for Docker Hub or Ali Cloud, especially beneficial for Chinese users due to its local proximity.
 
-- **Purpose**: Used for RPC service discovery and registration, cluster support.
-  
-    ```bash
-    zookeeper:
-      schema: openim                          # Not recommended to modify
-      address: [ 127.0.0.1:2181 ]            # Address
-      username:                               # Username
-      password:                               # Password
-    ```
+| Parameter        | Default Value         | Description                                                  |
+| ---------------- | --------------------- | ------------------------------------------------------------ |
+| `IMAGE_REGISTRY` | `"ghcr.io/openimsdk"` | The registry from which Docker images will be pulled. Other options include `"openim"` and `"registry.cn-hangzhou.aliyuncs.com/openimsdk"`. |
 
-###### MySQL
+###  2.2. <a name='OpenIMDockerNetworkConfiguration'></a>OpenIM Docker Network Configuration
 
-- **Purpose**: Used for storing users, relationships, and groups. Supports master-slave database.
+**Description**: This section configures the Docker network subnet and generates IP addresses for various services within the defined subnet.
 
-    ```bash
-    mysql:
-      address: [ 127.0.0.1:13306 ]            # Address
-      username: root                          # Username
-      password: openIM123                     # Password
-      database: openIM_v2                     # Not recommended to modify
-      maxOpenConn: 1000                       # Maximum connection
-      maxIdleConn: 100                        # Maximum idle connection
-      maxLifeTime: 60                         # Max time a connection can be reused (seconds)
-      logLevel: 4                             # Log level (1=silent, 2=error, 3=warn, 4=info)
-      slowThreshold: 500                      # Slow statement threshold (milliseconds)
-    ```
+| Parameter                   | Example Value     | Description                                                  |
+| --------------------------- | ----------------- | ------------------------------------------------------------ |
+| `DOCKER_BRIDGE_SUBNET`      | `'172.28.0.0/16'` | The subnet for the Docker network.                           |
+| `DOCKER_BRIDGE_GATEWAY`     | Generated IP      | The gateway IP address within the Docker subnet.             |
+| `[SERVICE]_NETWORK_ADDRESS` | Generated IP      | The network IP address for a specific service (e.g., MYSQL, MONGO, REDIS, etc.) within the Docker subnet. |
 
-###### Mongo
+###  2.3. <a name='OpenIMConfiguration'></a>OpenIM Configuration
 
-- **Purpose**: Used for storing offline messages. Supports mongo sharded clusters.
+**Description**: OpenIM configuration involves setting up directories for data, installation, configuration, and logs. It also involves configuring the OpenIM server address and ports for WebSocket and API.
 
-    ```bash
-    mongo:
-      uri:                                    # Use this value directly if not empty
-      address: [ 127.0.0.1:37017 ]            # Address
-      database: openIM                        # Default mongo db
-      username: root                          # Username
-      password: openIM123                     # Password
-      maxPoolSize: 100                        # Maximum connections
-    ```
+| Parameter               | Default Value            | Description                               |
+| ----------------------- | ------------------------ | ----------------------------------------- |
+| `OPENIM_DATA_DIR`       | `"/data/openim"`         | Directory for OpenIM data.                |
+| `OPENIM_INSTALL_DIR`    | `"/opt/openim"`          | Directory where OpenIM is installed.      |
+| `OPENIM_CONFIG_DIR`     | `"/etc/openim"`          | Directory for OpenIM configuration files. |
+| `OPENIM_LOG_DIR`        | `"/var/log/openim"`      | Directory for OpenIM logs.                |
+| `OPENIM_SERVER_ADDRESS` | Docker Bridge Gateway IP | OpenIM server address.                    |
+| `OPENIM_WS_PORT`        | `'10001'`                | Port for OpenIM WebSocket.                |
+| `API_OPENIM_PORT`       | `'10002'`                | Port for OpenIM API.                      |
 
-###### Redis
+###  2.4. <a name='OpenIMChatConfiguration'></a>OpenIM Chat Configuration
 
-- **Purpose**: Used for storing message sequence numbers, latest messages, user tokens, and MySQL cache. Supports cluster deployment.
+**Description**: Configuration for OpenIM chat, including data directory, server address, and ports for API and chat functionalities.
 
-    ```bash
-    redis:
-      address: [ 127.0.0.1:16379 ]            # Address
-      username:                               # Username
-      password: openIM123                     # Password
-    ```
+| Parameter               | Example Value              | Description                     |
+| ----------------------- | -------------------------- | ------------------------------- |
+| `OPENIM_CHAT_DATA_DIR`  | `"./openim-chat/[BRANCH]"` | Directory for OpenIM chat data. |
+| `OPENIM_CHAT_ADDRESS`   | Docker Bridge Gateway IP   | OpenIM chat service address.    |
+| `OPENIM_CHAT_API_PORT`  | `"10008"`                  | Port for OpenIM chat API.       |
+| `OPENIM_ADMIN_API_PORT` | `"10009"`                  | Port for OpenIM Admin API.      |
+| `OPENIM_ADMIN_PORT`     | `"30200"`                  | Port for OpenIM chat Admin.     |
+| `OPENIM_CHAT_PORT`      | `"30300"`                  | Port for OpenIM chat.           |
 
-###### Kafka
+###  2.5. <a name='ZookeeperConfiguration'></a>Zookeeper Configuration
 
-- **Purpose**: Used for message queues for decoupling. Supports cluster deployment.
+**Description**: Configuration for Zookeeper, including schema, port, address, and credentials.
 
-    ```bash
-    kafka:
-      username:                               # Username
-      password:                               # Password
-      addr: [ 127.0.0.1:9092 ]                # Address
-      topics:
-        latestMsgToRedis: "latestMsgToRedis"
-        offlineMsgToMongo: "offlineMsgToMongoMysql"
-        msgToPush: "msgToPush"
-        msgToModify: "msgToModify"
-      consumerGroupID:
-        msgToRedis: redis
-        msgToMongo: mongo
-        msgToMySql: mysql
-        msgToPush: push
-        msgToModify: modify
-    ```
+| Parameter            | Example Value            | Description             |
+| -------------------- | ------------------------ | ----------------------- |
+| `ZOOKEEPER_SCHEMA`   | `"openim"`               | Schema for Zookeeper.   |
+| `ZOOKEEPER_PORT`     | `"12181"`                | Port for Zookeeper.     |
+| `ZOOKEEPER_ADDRESS`  | Docker Bridge Gateway IP | Address for Zookeeper.  |
+| `ZOOKEEPER_USERNAME` | `""`                     | Username for Zookeeper. |
+| `ZOOKEEPER_PASSWORD` | `""`                     | Password for Zookeeper. |
+
+###  2.6. <a name='MySQLConfiguration'></a>MySQL Configuration
+
+**Description**: Configuration for MySQL, including port, address, and credentials.
+
+| Parameter        | Example Value            | Description         |
+| ---------------- | ------------------------ | ------------------- |
+| `MYSQL_PORT`     | `"13306"`                | Port for MySQL.     |
+| `MYSQL_ADDRESS`  | Docker Bridge Gateway IP | Address for MySQL.  |
+| `MYSQL_USERNAME` | User-defined             | Username for MySQL. |
+| `MYSQL_PASSWORD` | User-defined             | Password for MySQL. |
+
+Note: The configurations for other services (e.g., MONGO, REDIS, KAFKA, etc.) follow a similar pattern to MySQL and can be documented in a similar manner.
+
+###  2.7. <a name='MongoDBConfiguration'></a>MongoDB Configuration
+
+This section involves setting up MongoDB, including its port, address, and credentials.
+
+| Parameter      | Example Value  | Description             |
+| -------------- | -------------- | ----------------------- |
+| MONGO_PORT     | "27017"        | Port used by MongoDB.   |
+| MONGO_ADDRESS  | [Generated IP] | IP address for MongoDB. |
+| MONGO_USERNAME | [User Defined] | Username for MongoDB.   |
+| MONGO_PASSWORD | [User Defined] | Password for MongoDB.   |
+
+###  2.8. <a name='TencentCloudCOSConfiguration'></a>Tencent Cloud COS Configuration
+
+This section involves setting up Tencent Cloud COS, including its bucket URL and credentials.
+
+| Parameter         | Example Value                                                | Description                          |
+| ----------------- | ------------------------------------------------------------ | ------------------------------------ |
+| COS_BUCKET_URL    | "[https://temp-1252357374.cos.ap-chengdu.myqcloud.com](https://temp-1252357374.cos.ap-chengdu.myqcloud.com/)" | Tencent Cloud COS bucket URL.        |
+| COS_SECRET_ID     | [User Defined]                                               | Secret ID for Tencent Cloud COS.     |
+| COS_SECRET_KEY    | [User Defined]                                               | Secret key for Tencent Cloud COS.    |
+| COS_SESSION_TOKEN | [User Defined]                                               | Session token for Tencent Cloud COS. |
+| COS_PUBLIC_READ   | "false"                                                      | Public read access.                  |
+
+###  2.9. <a name='AlibabaCloudOSSConfiguration'></a>Alibaba Cloud OSS Configuration
+
+This section involves setting up Alibaba Cloud OSS, including its endpoint, bucket name, and credentials.
+
+| Parameter             | Example Value                                                | Description                              |
+| --------------------- | ------------------------------------------------------------ | ---------------------------------------- |
+| OSS_ENDPOINT          | "[https://oss-cn-chengdu.aliyuncs.com](https://oss-cn-chengdu.aliyuncs.com/)" | Endpoint URL for Alibaba Cloud OSS.      |
+| OSS_BUCKET            | "demo-9999999"                                               | Bucket name for Alibaba Cloud OSS.       |
+| OSS_BUCKET_URL        | "[https://demo-9999999.oss-cn-chengdu.aliyuncs.com](https://demo-9999999.oss-cn-chengdu.aliyuncs.com/)" | Bucket URL for Alibaba Cloud OSS.        |
+| OSS_ACCESS_KEY_ID     | [User Defined]                                               | Access key ID for Alibaba Cloud OSS.     |
+| OSS_ACCESS_KEY_SECRET | [User Defined]                                               | Access key secret for Alibaba Cloud OSS. |
+| OSS_SESSION_TOKEN     | [User Defined]                                               | Session token for Alibaba Cloud OSS.     |
+| OSS_PUBLIC_READ       | "false"                                                      | Public read access.                      |
+
+###  2.10. <a name='RedisConfiguration'></a>Redis Configuration
+
+This section involves setting up Redis, including its port, address, and credentials.
+
+| Parameter      | Example Value              | Description           |
+| -------------- | -------------------------- | --------------------- |
+| REDIS_PORT     | "16379"                    | Port used by Redis.   |
+| REDIS_ADDRESS  | "${DOCKER_BRIDGE_GATEWAY}" | IP address for Redis. |
+| REDIS_USERNAME | [User Defined]             | Username for Redis.   |
+| REDIS_PASSWORD | "${PASSWORD}"              | Password for Redis.   |
+
+###  2.11. <a name='KafkaConfiguration'></a>Kafka Configuration
+
+This section involves setting up Kafka, including its port, address, credentials, and topics.
+
+| Parameter                    | Example Value              | Description                         |
+| ---------------------------- | -------------------------- | ----------------------------------- |
+| KAFKA_USERNAME               | [User Defined]             | Username for Kafka.                 |
+| KAFKA_PASSWORD               | [User Defined]             | Password for Kafka.                 |
+| KAFKA_PORT                   | "19094"                    | Port used by Kafka.                 |
+| KAFKA_ADDRESS                | "${DOCKER_BRIDGE_GATEWAY}" | IP address for Kafka.               |
+| KAFKA_LATESTMSG_REDIS_TOPIC  | "latestMsgToRedis"         | Topic for latest message to Redis.  |
+| KAFKA_OFFLINEMSG_MONGO_TOPIC | "offlineMsgToMongoMysql"   | Topic for offline message to Mongo. |
+| KAFKA_MSG_PUSH_TOPIC         | "msgToPush"                | Topic for message to push.          |
+| KAFKA_CONSUMERGROUPID_REDIS  | "redis"                    | Consumer group ID to Redis.         |
+| KAFKA_CONSUMERGROUPID_MONGO  | "mongo"                    | Consumer group ID to Mongo.         |
+| KAFKA_CONSUMERGROUPID_MYSQL  | "mysql"                    | Consumer group ID to MySQL.         |
+| KAFKA_CONSUMERGROUPID_PUSH   | "push"                     | Consumer group ID to push.          |
+
+Note: Ensure to replace placeholder values (like [User Defined], `${DOCKER_BRIDGE_GATEWAY}`, and `${PASSWORD}`) with actual values before deploying the configuration.
 
 
 
-## Config options
+###  2.12. <a name='OpenIMWebConfiguration'></a>OpenIM Web Configuration
 
-...
+This section involves setting up OpenIM Web, including its port, address, and dist path.
+
+| Parameter            | Example Value              | Description               |
+| -------------------- | -------------------------- | ------------------------- |
+| OPENIM_WEB_PORT      | "11001"                    | Port used by OpenIM Web.  |
+| OPENIM_WEB_ADDRESS   | "${DOCKER_BRIDGE_GATEWAY}" | Address for OpenIM Web.   |
+| OPENIM_WEB_DIST_PATH | "/app/dist"                | Dist path for OpenIM Web. |
+
+###  2.13. <a name='RPCConfiguration'></a>RPC Configuration
+
+Configuration for RPC, including the register and listen IP.
+
+| Parameter       | Example Value  | Description          |
+| --------------- | -------------- | -------------------- |
+| RPC_REGISTER_IP | [User Defined] | Register IP for RPC. |
+| RPC_LISTEN_IP   | "0.0.0.0"      | Listen IP for RPC.   |
+
+###  2.14. <a name='PrometheusConfiguration'></a>Prometheus Configuration
+
+Setting up Prometheus, including its port and address.
+
+| Parameter          | Example Value              | Description              |
+| ------------------ | -------------------------- | ------------------------ |
+| PROMETHEUS_PORT    | "19090"                    | Port used by Prometheus. |
+| PROMETHEUS_ADDRESS | "${DOCKER_BRIDGE_GATEWAY}" | Address for Prometheus.  |
+
+###  2.15. <a name='GrafanaConfiguration'></a>Grafana Configuration
+
+Configuration for Grafana, including its port and address.
+
+| Parameter       | Example Value              | Description           |
+| --------------- | -------------------------- | --------------------- |
+| GRAFANA_PORT    | "3000"                     | Port used by Grafana. |
+| GRAFANA_ADDRESS | "${DOCKER_BRIDGE_GATEWAY}" | Address for Grafana.  |
+
+###  2.16. <a name='RPCPortConfigurationVariables'></a>RPC Port Configuration Variables
+
+Configuration for various RPC ports. Note: For launching multiple programs, just fill in multiple ports separated by commas. Try not to have spaces.
+
+| Parameter                   | Example Value | Description                         |
+| --------------------------- | ------------- | ----------------------------------- |
+| OPENIM_USER_PORT            | '10110'       | OpenIM User Service Port.           |
+| OPENIM_FRIEND_PORT          | '10120'       | OpenIM Friend Service Port.         |
+| OPENIM_MESSAGE_PORT         | '10130'       | OpenIM Message Service Port.        |
+| OPENIM_MESSAGE_GATEWAY_PORT | '10140'       | OpenIM Message Gateway Service Port |
+| OPENIM_GROUP_PORT           | '10150'       | OpenIM Group Service Port.          |
+| OPENIM_AUTH_PORT            | '10160'       | OpenIM Authorization Service Port.  |
+| OPENIM_PUSH_PORT            | '10170'       | OpenIM Push Service Port.           |
+| OPENIM_CONVERSATION_PORT    | '10180'       | OpenIM Conversation Service Port.   |
+| OPENIM_THIRD_PORT           | '10190'       | OpenIM Third-Party Service Port.    |
+
+###  2.17. <a name='RPCRegisterNameConfiguration'></a>RPC Register Name Configuration
+
+This section involves setting up the RPC Register Names for various OpenIM services.
+
+| Parameter                   | Example Value    | Description                         |
+| --------------------------- | ---------------- | ----------------------------------- |
+| OPENIM_USER_NAME            | "User"           | OpenIM User Service Name            |
+| OPENIM_FRIEND_NAME          | "Friend"         | OpenIM Friend Service Name          |
+| OPENIM_MSG_NAME             | "Msg"            | OpenIM Message Service Name         |
+| OPENIM_PUSH_NAME            | "Push"           | OpenIM Push Service Name            |
+| OPENIM_MESSAGE_GATEWAY_NAME | "MessageGateway" | OpenIM Message Gateway Service Name |
+| OPENIM_GROUP_NAME           | "Group"          | OpenIM Group Service Name           |
+| OPENIM_AUTH_NAME            | "Auth"           | OpenIM Authorization Service Name   |
+| OPENIM_CONVERSATION_NAME    | "Conversation"   | OpenIM Conversation Service Name    |
+| OPENIM_THIRD_NAME           | "Third"          | OpenIM Third-Party Service Name     |
+
+###  2.18. <a name='LogConfiguration'></a>Log Configuration
+
+This section involves configuring the log settings, including storage location, rotation time, and log level.
+
+| Parameter                 | Example Value            | Description                       |
+| ------------------------- | ------------------------ | --------------------------------- |
+| LOG_STORAGE_LOCATION      | ""${OPENIM_ROOT}"/logs/" | Location for storing logs         |
+| LOG_ROTATION_TIME         | "24"                     | Log rotation time (in hours)      |
+| LOG_REMAIN_ROTATION_COUNT | "2"                      | Number of log rotations to retain |
+| LOG_REMAIN_LOG_LEVEL      | "6"                      | Log level to retain               |
+| LOG_IS_STDOUT             | "false"                  | Output log to standard output     |
+| LOG_IS_JSON               | "false"                  | Log in JSON format                |
+| LOG_WITH_STACK            | "false"                  | Include stack info in logs        |
+
+###  2.19. <a name='AdditionalConfigurationVariables'></a>Additional Configuration Variables
+
+This section involves setting up additional configuration variables for Websocket, Push Notifications, and Chat.
+
+| Parameter               | Example Value     | Description                        |
+| ----------------------- | ----------------- | ---------------------------------- |
+| WEBSOCKET_MAX_CONN_NUM  | "100000"          | Maximum Websocket connections      |
+| WEBSOCKET_MAX_MSG_LEN   | "4096"            | Maximum Websocket message length   |
+| WEBSOCKET_TIMEOUT       | "10"              | Websocket timeout                  |
+| PUSH_ENABLE             | "getui"           | Push notification enable status    |
+| GETUI_PUSH_URL          | [Generated URL]   | GeTui Push Notification URL        |
+| GETUI_MASTER_SECRET     | [User Defined]    | GeTui Master Secret                |
+| GETUI_APP_KEY           | [User Defined]    | GeTui Application Key              |
+| GETUI_INTENT            | [User Defined]    | GeTui Push Intent                  |
+| GETUI_CHANNEL_ID        | [User Defined]    | GeTui Channel ID                   |
+| GETUI_CHANNEL_NAME      | [User Defined]    | GeTui Channel Name                 |
+| FCM_SERVICE_ACCOUNT     | "x.json"          | FCM Service Account                |
+| JPNS_APP_KEY            | [User Defined]    | JPNS Application Key               |
+| JPNS_MASTER_SECRET      | [User Defined]    | JPNS Master Secret                 |
+| JPNS_PUSH_URL           | [User Defined]    | JPNS Push Notification URL         |
+| JPNS_PUSH_INTENT        | [User Defined]    | JPNS Push Intent                   |
+| MANAGER_USERID_1        | "openIM123456"    | Administrator ID 1                 |
+| MANAGER_USERID_2        | "openIM654321"    | Administrator ID 2                 |
+| MANAGER_USERID_3        | "openIMAdmin"     | Administrator ID 3                 |
+| NICKNAME_1              | "system1"         | Nickname 1                         |
+| NICKNAME_2              | "system2"         | Nickname 2                         |
+| NICKNAME_3              | "system3"         | Nickname 3                         |
+| MULTILOGIN_POLICY       | "1"               | Multi-login Policy                 |
+| CHAT_PERSISTENCE_MYSQL  | "true"            | Chat Persistence in MySQL          |
+| MSG_CACHE_TIMEOUT       | "86400"           | Message Cache Timeout              |
+| GROUP_MSG_READ_RECEIPT  | "true"            | Group Message Read Receipt Enable  |
+| SINGLE_MSG_READ_RECEIPT | "true"            | Single Message Read Receipt Enable |
+| RETAIN_CHAT_RECORDS     | "365"             | Retain Chat Records (in days)      |
+| CHAT_RECORDS_CLEAR_TIME | [Cron Expression] | Chat Records Clear Time            |
+| MSG_DESTRUCT_TIME       | [Cron Expression] | Message Destruct Time              |
+| SECRET                  | "${PASSWORD}"     | Secret Key                         |
+| TOKEN_EXPIRE            | "90"              | Token Expiry Time                  |
+| FRIEND_VERIFY           | "false"           | Friend Verification Enable         |
+| IOS_PUSH_SOUND          | "xxx"             | iOS                                |
+
+
+
+###  2.20. <a name='PrometheusConfiguration-1'></a>Prometheus Configuration
+
+This section involves configuring Prometheus, including enabling/disabling it and setting up ports for various services.
+
+####  2.20.1. <a name='GeneralConfiguration'></a>General Configuration
+
+| Parameter           | Example Value | Description                   |
+| ------------------- | ------------- | ----------------------------- |
+| `PROMETHEUS_ENABLE` | "false"       | Whether to enable Prometheus. |
+
+####  2.20.2. <a name='Service-SpecificPrometheusPorts'></a>Service-Specific Prometheus Ports
+
+| Service                  | Parameter                | Default Port Value           | Description                                        |
+| ------------------------ | ------------------------ | ---------------------------- | -------------------------------------------------- |
+| User Service             | `USER_PROM_PORT`         | '20110'                      | Prometheus port for the User service.              |
+| Friend Service           | `FRIEND_PROM_PORT`       | '20120'                      | Prometheus port for the Friend service.            |
+| Message Service          | `MESSAGE_PROM_PORT`      | '20130'                      | Prometheus port for the Message service.           |
+| Message Gateway          | `MSG_GATEWAY_PROM_PORT`  | '20140'                      | Prometheus port for the Message Gateway.           |
+| Group Service            | `GROUP_PROM_PORT`        | '20150'                      | Prometheus port for the Group service.             |
+| Auth Service             | `AUTH_PROM_PORT`         | '20160'                      | Prometheus port for the Auth service.              |
+| Push Service             | `PUSH_PROM_PORT`         | '20170'                      | Prometheus port for the Push service.              |
+| Conversation Service     | `CONVERSATION_PROM_PORT` | '20230'                      | Prometheus port for the Conversation service.      |
+| RTC Service              | `RTC_PROM_PORT`          | '21300'                      | Prometheus port for the RTC service.               |
+| Third Service            | `THIRD_PROM_PORT`        | '21301'                      | Prometheus port for the Third service.             |
+| Message Transfer Service | `MSG_TRANSFER_PROM_PORT` | '21400, 21401, 21402, 21403' | Prometheus ports for the Message Transfer service. |