feat: add openim docker

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

.docker-compose_cfg/config.yaml

@@ -1,79 +0,0 @@
-# Copyright © 2023 OpenIM. All rights reserved.
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-#---------------Infrastructure configuration---------------------#
-etcd:
-  etcdSchema: openim  #默认即可
-  etcdAddr: [ 127.0.0.1:2379 ] #单机部署时，默认即可
-  userName:
-  password:
-  secret: openIM123
-
-mysql:
-  dbMysqlDatabaseName: admin_chat # 数据库名字 默认即可
-
-# 默认管理员账号
-admin:
-  defaultAccount:
-    account: [ "admin1", "admin2" ]
-    defaultPassword: [ "password1", "password2" ]
-    openIMUserID: [ "openIM123456", "openIMAdmin" ]
-    faceURL: [ "", "" ]
-    nickname: [ "admin1", "admin2" ]
-    level: [ 1, 100 ]
-
-
-adminapi:
-  openImAdminApiPort: [ 10009 ] #管理后台api服务端口，默认即可，需要开放此端口或做nginx转发
-  listenIP: 0.0.0.0
-
-chatapi:
-  openImChatApiPort: [ 10008 ] #登录注册，默认即可，需要开放此端口或做nginx转发
-  listenIP: 0.0.0.0
-
-rpcport: # rpc服务端口 默认即可
-  openImAdminPort: [ 30200 ]
-  openImChatPort: [ 30300 ]
-
-
-rpcregistername: #rpc注册服务名，默认即可
-  openImChatName: Chat
-  openImAdminCMSName: Admin
-
-chat:
-  codeTTL: 300 #短信验证码有效时间(秒)
-  superVerificationCode: 666666 # 超级验证码
-  alismsverify: #阿里云短信配置，在阿里云申请成功后修改以下四项
-    accessKeyId:
-    accessKeySecret:
-    signName:
-    verificationCodeTemplateCode:
-
-
-oss:
-  tempDir: enterprise-temp # 临时密钥上传的目录
-  dataDir: enterprise-data # 最终存放目录
-  aliyun:
-    endpoint: https://oss-cn-chengdu.aliyuncs.com
-    accessKeyID: ""
-    accessKeySecret: ""
-    bucket: ""
-  tencent:
-    BucketURL: ""
-    serviceURL: https://cos.COS_REGION.myqcloud.com
-    secretID: ""
-    secretKey: ""
-    sessionToken: ""
-    bucket: ""
-  use: "minio"

.docker-compose_cfg/datasource-compose.yaml

@@ -1,27 +0,0 @@
-# Copyright © 2023 OpenIM. All rights reserved.
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-#more datasource-compose.yaml 
-apiVersion: 1
-
-datasources:
-- name: Prometheus
-  type: prometheus
-  access: proxy
-  orgId: 1
-  url: http://127.0.0.1:9091
-  basicAuth: false
-  isDefault: true
-  version: 1
-  editable: true

.docker-compose_cfg/prometheus-compose.yml

@@ -1,85 +0,0 @@
-# Copyright © 2023 OpenIM. All rights reserved.
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-#more prometheus-compose.yml 
-global:
-  scrape_interval:     15s 
-  evaluation_interval: 15s 
-  external_labels:
-    monitor: 'openIM-monitor'
-
-scrape_configs:
-    - job_name: 'prometheus'
-      static_configs:
-      - targets: ['localhost:9091']
-
-    - job_name: 'openIM-server'
-      metrics_path: /metrics
-      static_configs:
-      - targets: ['localhost:10002']
-        labels:
-          group: 'api'
-
-      - targets: ['localhost:20110']
-        labels:
-          group: 'user'
-
-      - targets: ['localhost:20120']
-        labels:
-          group: 'friend'
-
-      - targets: ['localhost:20130']
-        labels:
-          group: 'message'
-
-      - targets: ['localhost:20140']
-        labels:
-          group: 'msg-gateway'    
-
-      - targets: ['localhost:20150']
-        labels:
-          group: 'group'
-
-      - targets: ['localhost:20160']
-        labels:
-          group: 'auth'
-
-      - targets: ['localhost:20170']
-        labels:
-          group: 'push'
-
-      - targets: ['localhost:20120']
-        labels:
-          group: 'friend'
-
-      
-      - targets: ['localhost:20230']
-        labels:
-          group: 'conversation' 
-
-      
-      - targets: ['localhost:21400', 'localhost:21401', 'localhost:21402', 'localhost:21403']
-        labels:
-          group: 'msg-transfer'
-       
- 
-
-
-      
-
-    - job_name: 'node'  
-      scrape_interval: 8s
-      static_configs:
-      - targets: ['localhost:9100']
-     

.dockerignore

@@ -20,7 +20,6 @@ CHANGELOG/
 
 # Ignore deployment-related files
 docker-compose.yaml
-deployments/
 
 # Ignore assets
 assets/

.github/.codecov.yml

@@ -20,4 +20,20 @@ coverage:
         paths:
           - pkg/* # only include coverage in "pkg/" folder
         informational: true # Always pass check
-    patch: off # disable the commit only checks
+      tools: # declare a new status context "tools"
+        paths:
+          - tools/* # only include coverage in "tools/" folder
+        informational: true # Always pass check
+      test: # declare a new status context "test"
+        paths:
+          - test/* # only include coverage in "test/" folder
+        informational: true # Always pass check
+      # internal: # declare a new status context "internal"
+      #   paths:
+      #     - internal/* # only include coverage in "internal/" folder
+      #   informational: true # Always pass check
+      # cmd: # declare a new status context "cmd"
+      #   paths:
+      #     - cmd/* # only include coverage in "cmd/" folder
+      #   informational: true # Always pass check
+    patch: off # disable the commit only checks

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

@@ -52,6 +52,7 @@ jobs:
             type=ref,event=branch
             type=ref,event=pr
             type=semver,pattern={{version}}
+            type=semver,pattern=v{{version}}
             type=semver,pattern={{major}}.{{minor}}
             type=semver,pattern={{major}}
             type=sha
@@ -87,6 +88,16 @@ jobs:
         uses: docker/metadata-action@v5.0.0
         with:
           images: registry.cn-hangzhou.aliyuncs.com/openimsdk/openim-server
+          # generate Docker tags based on the following events/attributes
+          tags: |
+            type=schedule
+            type=ref,event=branch
+            type=ref,event=pr
+            type=semver,pattern={{version}}
+            type=semver,pattern=v{{version}}
+            type=semver,pattern={{major}}.{{minor}}
+            type=semver,pattern={{major}}
+            type=sha
 
       - name: Log in to AliYun Docker Hub
         uses: docker/login-action@v3
@@ -126,6 +137,7 @@ jobs:
             type=ref,event=branch
             type=ref,event=pr
             type=semver,pattern={{version}}
+            type=semver,pattern=v{{version}}
             type=semver,pattern={{major}}.{{minor}}
             type=semver,pattern={{major}}
             type=sha

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

@@ -1,139 +0,0 @@
-# Copyright © 2023 OpenIM open source community. All rights reserved.
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-name: Build OpenIM Web Docker image
-
-on:
-  schedule:
-  - cron: '30 3 * * *'
-  push:
-    branches:
-      - main
-      - release-*
-    tags:
-      - v*
-  workflow_dispatch:
-
-env:
-  # Common versions
-  GO_VERSION: "1.20"
-
-jobs:
-  build-openim-web-dockerhub:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-      - name: Set up QEMU
-        uses: docker/setup-qemu-action@v3
-      - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v3
-
-# docker.io/openim/openim-web:latest
-      - name: Extract metadata (tags, labels) for Docker
-        id: meta
-        uses: docker/metadata-action@v5.0.0
-        with:
-          images: openim/openim-web
-          # generate Docker tags based on the following events/attributes
-          tags: |
-            type=schedule
-            type=ref,event=branch
-            type=ref,event=pr
-            type=semver,pattern={{version}}
-            type=semver,pattern={{major}}.{{minor}}
-            type=semver,pattern={{major}}
-            type=sha
-
-      - name: Log in to Docker Hub
-        uses: docker/login-action@v3
-        with:
-          username: ${{ secrets.DOCKER_USERNAME }}
-          password: ${{ secrets.DOCKER_PASSWORD }}
-
-      - name: Build and push Docker image
-        uses: docker/build-push-action@v5
-        with:
-          context: .
-          file: ./build/images/openim-tools/openim-web/Dockerfile
-          platforms: linux/amd64,linux/arm64
-          push: ${{ github.event_name != 'pull_request' }}
-          tags: ${{ steps.meta.outputs.tags }}
-          labels: ${{ steps.meta.outputs.labels }}
-
-  build-openim-web-aliyun:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-      - name: Set up QEMU
-        uses: docker/setup-qemu-action@v3
-      - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v3
-# registry.cn-hangzhou.aliyuncs.com/openimsdk/openim-web:latest
-      - name: Extract metadata (tags, labels) for Docker
-        id: meta2
-        uses: docker/metadata-action@v5.0.0
-        with:
-          images: registry.cn-hangzhou.aliyuncs.com/openimsdk/openim-web
-
-      - name: Log in to AliYun Docker Hub
-        uses: docker/login-action@v3
-        with:
-          registry: registry.cn-hangzhou.aliyuncs.com
-          username: ${{ secrets.ALIREGISTRY_USERNAME }}
-          password: ${{ secrets.ALIREGISTRY_TOKEN }}
-      
-      - name: Build and push Docker image
-        uses: docker/build-push-action@v5
-        with:
-          context: .
-          file: ./build/images/openim-tools/openim-web/Dockerfile
-          platforms: linux/amd64,linux/arm64
-          push: ${{ github.event_name != 'pull_request' }}
-          tags: ${{ steps.meta2.outputs.tags }}
-          labels: ${{ steps.meta2.outputs.labels }}
-
-  build-openim-web-ghcr:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-      - name: Set up QEMU
-        uses: docker/setup-qemu-action@v3
-      - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v3
-# ghcr.io/openimsdk/openim-web:latest
-      - name: Extract metadata (tags, labels) for Docker
-        id: meta2
-        uses: docker/metadata-action@v5.0.0
-        with:
-          images: ghcr.io/openimsdk/openim-web
-
-      - name: Log in to GitHub Container Registry
-        uses: docker/login-action@v3
-        with:
-          registry: ghcr.io
-          username: ${{ github.repository_owner }}
-          password: ${{ secrets.GITHUB_TOKEN }}
-
-      - name: Build and push Docker image
-        uses: docker/build-push-action@v5
-        with:
-          context: .
-          file: ./build/images/openim-tools/openim-web/Dockerfile
-          platforms: linux/amd64,linux/arm64
-          push: ${{ github.event_name != 'pull_request' }}
-          tags: ${{ steps.meta2.outputs.tags }}
-          labels: ${{ steps.meta2.outputs.labels }}

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

@@ -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.
+
 name: Create Branch on Tag
 
 on:

.github/workflows/e2e-test.yml

@@ -12,7 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-name: OpenIM E2E Test
+name: OpenIM Linux System E2E Test
 
 on:
   workflow_dispatch:
@@ -22,6 +22,9 @@ on:
     # run e2e test every 4 hours
     - cron: 0 */4 * * *
 
+env:
+  CALLBACK_ENABLE: true
+
 jobs:
   build:
     name: Test
@@ -41,4 +44,71 @@ jobs:
 
       - name: Create e2e test
         run: |
-          echo "...test e2e"
+          echo "...test e2e"
+
+  execute-linux-systemd-scripts:
+    name: Execute OpenIM script on ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    environment:
+      name: openim
+    strategy:
+      matrix:
+        go_version: ["1.20"]
+        os: ["ubuntu-latest"]
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v4
+
+    - name: Set up Go ${{ matrix.go_version }}
+      uses: actions/setup-go@v4
+      with:
+        go-version: ${{ matrix.go_version }}
+      id: go
+
+    - name: Install Task
+      uses: arduino/setup-task@v1
+      with:
+        version: '3.x' # If available, use the latest major version that's compatible
+        repo-token: ${{ secrets.GITHUB_TOKEN }}
+
+    - name: Docker Operations
+      run: |
+        sudo make init
+        sudo docker compose up -d
+        sudo sleep 20
+
+    - name: Module Operations
+      run: |
+        sudo make tidy
+        sudo make tools.verify.go-gitlint
+
+    - name: Build, Start
+      run: |
+        sudo ./scripts/install/install.sh -i
+
+    - name: Exec OpenIM System Status Chack
+      run: |
+        sudo ./scripts/install/install.sh -s
+
+    - name: Exec OpenIM API test
+      run: |
+        sudo make test-api
+    
+    - name: Exec OpenIM E2E test
+      run: |
+        sudo make test-e2e
+
+    - name: Exec OpenIM System uninstall
+      run: |
+        sudo ./scripts/install/install.sh -u
+
+    - name: gobenchdata publish
+      uses: bobheadxi/gobenchdata@v1
+      with:
+        PRUNE_COUNT: 30
+        GO_TEST_FLAGS: -cpu 1,2
+        PUBLISH: true
+        PUBLISH_BRANCH: gh-pages
+      env:
+        GITHUB_TOKEN: ${{ secrets.BOT_GITHUB_TOKEN }}
+      continue-on-error: true

.github/workflows/link-pr.yml

@@ -41,7 +41,7 @@ jobs:
             # ./*.md all markdown files in the root directory
           args: --verbose  -E -i --no-progress --exclude-path './CHANGELOG' './**/*.md'
         env:
-          GITHUB_TOKEN: ${{secrets.GH_PAT}}
+          GITHUB_TOKEN: ${{secrets.BOT_GITHUB_TOKEN}}
 
       - name: Create Issue From File
         if: env.lychee_exit_code != 0

.github/workflows/opencommit.yml

@@ -51,4 +51,5 @@ jobs:
           OCO_EMOJI: false
           OCO_MODEL: gpt-3.5-turbo-16k
           OCO_LANGUAGE: en
-          OCO_PROMPT_MODULE: conventional-commit
+          OCO_PROMPT_MODULE: conventional-commit
+        continue-on-error: true

.github/workflows/openimci.yml

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

.gitignore

@@ -391,3 +391,5 @@ Sessionx.vim
 dist/
 .env
 config/config.yaml
+config/alertmanager.yml
+config/prometheus.yml

CHANGELOG/CHANGELOG.md

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

CONTRIBUTING.md

@@ -42,6 +42,12 @@ If you are familiar with [Makefile](./Makefile) , you can easily see the clever
 
 The [Makefile](./Makefile) is for every developer, even if you don't know how to use the Makefile tool, don't worry, we provide two great commands to get you up to speed with the Makefile architecture, `make help` and `make help-all`, it can reduce problems of the developing environment.
 
+In accordance with the naming conventions adopted by OpenIM and drawing reference from the Google Naming Conventions as per the guidelines available at https://google.github.io/styleguide/go/, the following expectations for naming practices within the project are set forth: 
+
++ https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/code-conventions.md
++ https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/go-code.md
+
+
 ## Code of ConductCode of Conduct
 
 #### Code and doc contribution
@@ -270,7 +276,7 @@ You can find some very formal PR in [RFC](https://github.com/openimsdk/open-im-s
 **🈴 Reviewing PRs:**
 
 + Be respectful and constructive 
-+ Assign yourself to the PR 
++ Assign yourself to the PR (comment `/assign`)
 + Check if all checks are passing
 + Suggest changes instead of simply commenting on found issues
 + If you are unsure about something, ask the author

Dockerfile

@@ -25,7 +25,8 @@ 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
+COPY --from=builder ${SERVER_WORKDIR}/deployments /openim/openim-server/deployments
 
 CMD ["/openim/openim-server/scripts/docker-start-all.sh"]

Makefile

@@ -6,7 +6,7 @@
 
 ## all: Run tidy, gen, add-copyright, format, lint, cover, build ✨
 .PHONY: all
-all: tidy gen add-copyright verify lint cover restart
+all: tidy gen add-copyright verify test-api lint cover restart
 
 # ==============================================================================
 # Build set
@@ -166,6 +166,15 @@ test:
 cover:
 	@$(MAKE) go.test.cover
 
+## test-api: Run api test. ✨
+.PHONY: test-api
+test-api:
+	@$(MAKE) go.test.api
+
+## test-e2e: Run e2e test
+test-e2e:
+	@$(MAKE) go.test.e2e
+
 ## updates: Check for updates to go.mod dependencies. ✨
 .PHONY: updates
 	@$(MAKE) go.updates

README-zh_CN.md

@@ -29,6 +29,10 @@
 
 </p>
 
+## 🟢 扫描微信进群交流
+<img src="./docs/images/Wechat.jpg" width="300">
+
+
 ## Ⓜ️ 关于 OpenIM
 
 OpenIM 不仅仅是一个开源的即时消息组件，它是你的应用程序生态系统的一个不可或缺的部分。查看下面的图表，了解 AppServer、AppClient、OpenIMServer 和 OpenIMSDK 是如何交互的。
@@ -86,22 +90,22 @@ OpenIM 我们的目标是建立一个顶级的开源社区。我们有一套标
 
 在开始之前，请确保你的更改是有需求的。最好的方法是创建一个[新的讨论](https://github.com/openimsdk/open-im-server/discussions/new/choose) 或 [Slack 通信](https://join.slack.com/t/openimsdk/shared_invite/zt-22720d66b-o_FvKxMTGXtcnnnHiMqe9Q)，或者如果你发现一个问题，首先[报告它](https://github.com/openimsdk/open-im-server/issues/new/choose)。
 
-+ [代码标准](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/go_code.md)
++ [代码标准](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/go-code.md)
 
-+ [Docker 镜像标准](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/images.md)
++ [Docker 镜像标准](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/images.md)
 
-+ [目录标准](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/directory.md)
++ [目录标准](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/directory.md)
 
-+ [提交标准](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/commit.md)
++ [提交标准](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/commit.md)
 
-+ [版本控制标准](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/version.md)
++ [版本控制标准](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/version.md)
 
-+ [接口标准](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/interface.md)
++ [接口标准](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/interface.md)
 
 + [OpenIM配置和环境变量设置](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/environment.md)
 
 > **Note**
-> 针对中国的用户，阅读我们的 [Docker 镜像标准](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/images.md) 以便使用国内 aliyun 的镜像地址。OpenIM 也有针对中国的 gitee 同步仓库，你可以在 [gitee.com](https://gitee.com/openimsdk) 上找到它。
+> 针对中国的用户，阅读我们的 [Docker 镜像标准](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/images.md) 以便使用国内 aliyun 的镜像地址。OpenIM 也有针对中国的 gitee 同步仓库，你可以在 [gitee.com](https://gitee.com/openimsdk) 上找到它。
 
 ## :link: 链接
 

README.md

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

build/images/Dockerfile

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

cmd/openim-api/main.go

@@ -17,13 +17,14 @@ package main
 import (
 	"context"
 	"fmt"
-	ginProm "github.com/openimsdk/open-im-server/v3/pkg/common/ginPrometheus"
-	"github.com/openimsdk/open-im-server/v3/pkg/common/prom_metrics"
 	"net"
+	"net/http"
 	_ "net/http/pprof"
+	"os"
+	"os/signal"
 	"strconv"
-
-	"github.com/openimsdk/open-im-server/v3/pkg/common/discovery_register"
+	"syscall"
+	"time"
 
 	"github.com/OpenIMSDK/protocol/constant"
 	"github.com/OpenIMSDK/tools/discoveryregistry"
@@ -33,6 +34,9 @@ import (
 	"github.com/openimsdk/open-im-server/v3/pkg/common/cmd"
 	"github.com/openimsdk/open-im-server/v3/pkg/common/config"
 	"github.com/openimsdk/open-im-server/v3/pkg/common/db/cache"
+	kdisc "github.com/openimsdk/open-im-server/v3/pkg/common/discoveryregister"
+	ginProm "github.com/openimsdk/open-im-server/v3/pkg/common/ginprometheus"
+	"github.com/openimsdk/open-im-server/v3/pkg/common/prommetrics"
 )
 
 func main() {
@@ -51,13 +55,12 @@ func run(port int, proPort int) error {
 	if port == 0 || proPort == 0 {
 		err := "port or proPort is empty:" + strconv.Itoa(port) + "," + strconv.Itoa(proPort)
 		log.ZError(context.Background(), err, nil)
-
 		return fmt.Errorf(err)
 	}
+
 	rdb, err := cache.NewRedis()
 	if err != nil {
 		log.ZError(context.Background(), "Failed to initialize Redis", err)
-
 		return err
 	}
 	log.ZInfo(context.Background(), "api start init discov client")
@@ -65,33 +68,32 @@ func run(port int, proPort int) error {
 	var client discoveryregistry.SvcDiscoveryRegistry
 
 	// Determine whether zk is passed according to whether it is a clustered deployment
-	client, err = discovery_register.NewDiscoveryRegister(config.Config.Envs.Discovery)
+	client, err = kdisc.NewDiscoveryRegister(config.Config.Envs.Discovery)
 	if err != nil {
 		log.ZError(context.Background(), "Failed to initialize discovery register", err)
-
 		return err
 	}
+
 	if err = client.CreateRpcRootNodes(config.Config.GetServiceNames()); err != nil {
 		log.ZError(context.Background(), "Failed to create RPC root nodes", err)
-
 		return err
 	}
+
 	log.ZInfo(context.Background(), "api register public config to discov")
 	if err = client.RegisterConf2Registry(constant.OpenIMCommonConfigKey, config.Config.EncodeConfig()); err != nil {
 		log.ZError(context.Background(), "Failed to register public config to discov", err)
-
 		return err
 	}
+
 	log.ZInfo(context.Background(), "api register public config to discov success")
 	router := api.NewGinRouter(client, rdb)
-	//////////////////////////////
 	if config.Config.Prometheus.Enable {
-		p := ginProm.NewPrometheus("app", prom_metrics.GetGinCusMetrics("Api"))
+		p := ginProm.NewPrometheus("app", prommetrics.GetGinCusMetrics("Api"))
 		p.SetListenAddress(fmt.Sprintf(":%d", proPort))
 		p.Use(router)
 	}
-	/////////////////////////////////
 	log.ZInfo(context.Background(), "api init router success")
+
 	var address string
 	if config.Config.Api.ListenIP != "" {
 		address = net.JoinHostPort(config.Config.Api.ListenIP, strconv.Itoa(port))
@@ -100,10 +102,25 @@ func run(port int, proPort int) error {
 	}
 	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)
+	server := http.Server{Addr: address, Handler: router}
+	go func() {
+		err = server.ListenAndServe()
+		if err != nil && err != http.ErrServerClosed {
+			log.ZError(context.Background(), "api run failed", err, "address", address)
+			os.Exit(1)
+		}
+	}()
 
+	sigs := make(chan os.Signal, 1)
+	signal.Notify(sigs, syscall.SIGINT, syscall.SIGTERM, syscall.SIGQUIT)
+	<-sigs
+
+	ctx, cancel := context.WithTimeout(context.Background(), 15*time.Second)
+	defer cancel()
+
+	// graceful shutdown operation.
+	if err := server.Shutdown(ctx); err != nil {
+		log.ZError(context.Background(), "failed to api-server shutdown", err)
 		return err
 	}
 

cmd/openim-msggateway/main.go

@@ -23,6 +23,7 @@ func main() {
 	msgGatewayCmd.AddWsPortFlag()
 	msgGatewayCmd.AddPortFlag()
 	msgGatewayCmd.AddPrometheusPortFlag()
+
 	if err := msgGatewayCmd.Exec(); err != nil {
 		panic(err.Error())
 	}

config/email.tmpl

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

config/instance-down-rules.yml

@@ -0,0 +1,22 @@
+groups:
+  - name: instance_down
+    rules:
+      - alert: InstanceDown
+        expr: up == 0
+        for: 1m
+        labels:
+          severity: critical
+        annotations:
+          summary: "Instance {{ $labels.instance }} down"
+          description: "{{ $labels.instance }} of job {{ $labels.job }} has been down for more than 1 minutes."
+
+  - name: database_insert_failure_alerts
+    rules:
+      - alert: DatabaseInsertFailed
+        expr: (increase(msg_insert_redis_failed_total[5m]) > 0) or (increase(msg_insert_mongo_failed_total[5m]) > 0)
+        for: 1m
+        labels:
+          severity: critical
+        annotations:
+          summary: "Increase in MsgInsertRedisFailedCounter or MsgInsertMongoFailedCounter detected"
+          description: "Either MsgInsertRedisFailedCounter or MsgInsertMongoFailedCounter has increased in the last 5 minutes, indicating failures in message insert operations to Redis or MongoDB,maybe the redis or mongodb is crash."

config/templates/README.md

@@ -0,0 +1,36 @@
+# Examples Directory
+
+Welcome to the `examples` directory of our project! This directory contains a collection of example files that demonstrate various configurations and setups for our software. These examples are designed to provide you with templates that can be used as a starting point for your own configurations.
+
+## Overview
+
+In this directory, you'll find examples for a variety of use cases. Each file is a template with default values and configurations that illustrate best practices and typical scenarios. Whether you're just getting started or looking to implement a complex setup, these examples should help you get on the right track.
+
+## Structure
+
+Here's a quick overview of what you'll find in this directory:
+
++ `env-example.yaml`: Demonstrates how to set up environment variables.
++ `openim-example.yaml`: A sample configuration file for the OpenIM application.
++ `prometheus-example.yml`: An example Prometheus configuration for monitoring.
++ `alertmanager-example.yml`: A template for setting up Alertmanager configurations.
+
+## How to Use These Examples
+
+To use these examples, simply copy the relevant file to your working directory and rename it as needed (e.g., removing the `-example` suffix). Then, modify the file according to your requirements.
+
+### Tips for Using Example Files:
+
+1. **Read the Comments**: Each file contains comments that explain various sections and settings. Make sure to read these comments for a better understanding of how to customize the file.
+2. **Check for Required Changes**: Some examples might require mandatory changes (like setting specific environment variables) before they can be used effectively.
+3. **Version Compatibility**: Ensure that the example files are compatible with the version of the software you are using.
+
+## Contributing
+
+If you have a configuration that you believe would be beneficial to others, please feel free to contribute by opening a pull request with your proposed changes. We appreciate contributions that expand our examples with new scenarios and use cases.
+
+## Support
+
+If you encounter any issues or have questions regarding the example files, please open an issue on our repository. Our community is here to help you navigate through any challenges you might face.
+
+Thank you for exploring our examples, and we hope they will be helpful in setting up and configuring your environment!

config/templates/alertmanager.yml.template

@@ -0,0 +1,33 @@
+###################### AlertManager Configuration ######################
+# AlertManager configuration using environment variables
+#
+# Resolve timeout
+# SMTP configuration for sending alerts
+# Templates for email notifications
+# Routing configurations for alerts
+# Receiver configurations
+global:
+  resolve_timeout: 5m
+  smtp_from: alert@openim.io
+  smtp_smarthost: smtp.163.com:465
+  smtp_auth_username: alert@openim.io
+  smtp_auth_password: YOURAUTHPASSWORD
+  smtp_require_tls: false
+  smtp_hello: xxx监控告警
+
+templates:
+  - /etc/alertmanager/email.tmpl
+
+route:
+  group_by: ['alertname']
+  group_wait: 5s
+  group_interval: 5s
+  repeat_interval: 5m
+  receiver: email
+receivers:
+  - name: email
+    email_configs:
+      - to: 'alert@example.com'
+        html: '{{ template "email.to.html" . }}'
+        headers: { Subject: "[OPENIM-SERVER]Alarm" }
+        send_resolved: true

config/templates/config.yaml.template

@@ -35,26 +35,6 @@ zookeeper:
   username: ''
   password: ''
 
-###################### Mysql ######################
-# MySQL configuration
-# Currently, only single machine setup is supported
-#
-# Maximum number of open connections
-# Maximum number of idle connections
-# Maximum lifetime in seconds a connection can be reused
-# Log level: 1=slient, 2=error, 3=warn, 4=info
-# Slow query threshold in milliseconds
-mysql:
-  address: [ 172.28.0.1:13306 ]
-  username: root
-  password: openIM123
-  database: openIM_v3
-  maxOpenConn: 1000
-  maxIdleConn: 100
-  maxLifeTime: 60
-  logLevel: 4
-  slowThreshold: 500
-
 ###################### Mongo ######################
 # MongoDB configuration
 # If uri is not empty, it will be used directly
@@ -135,14 +115,14 @@ api:
 # minio.signEndpoint is minio public network address
 object:
   enable: "minio"
-  apiURL: "http://127.0.0.1:10002"
+  apiURL: "http://172.28.0.1:10002"
   minio:
     bucket: "openim"
     endpoint: "http://172.28.0.1:10005"
     accessKeyID: "root"
     secretAccessKey: "openIM123"
     sessionToken: ''
-    signEndpoint: "http://127.0.0.1:10005"
+    signEndpoint: "http://172.28.0.1:10005"
     publicRead: false
   cos:
     bucketURL: https://temp-1252357374.cos.ap-chengdu.myqcloud.com
@@ -158,13 +138,21 @@ object:
     accessKeySecret: ''
     sessionToken: ''
     publicRead: false
+  kodo:
+    endpoint: "http://s3.cn-east-1.qiniucs.com"
+    bucket: "demo-9999999"
+    bucketURL: "http://your.domain.com"
+    accessKeyID: ''
+    accessKeySecret: ''
+    sessionToken: ''
+    publicRead: false
 
 ###################### RPC Port Configuration ######################
 # RPC service ports
 # These ports are passed into the program by the script and are not recommended to modify
 # For launching multiple programs, just fill in multiple ports separated by commas
 # For example, [10110, 10111]
-rpcPort: 
+rpcPort:
   openImUserPort: [ 10110 ]
   openImFriendPort: [ 10120 ]
   openImMessagePort: [ 10130 ]
@@ -312,7 +300,7 @@ iosPush:
 # Timeout in seconds
 # Whether to continue execution if callback fails
 callback:
-  url:
+  url: ""
   beforeSendSingleMsg:
     enable: false
     timeout: 5
@@ -320,6 +308,7 @@ callback:
   afterSendSingleMsg:
     enable: false
     timeout: 5
+    failedContinue: true
   beforeSendGroupMsg:
     enable: false
     timeout: 5
@@ -327,6 +316,7 @@ callback:
   afterSendGroupMsg:
     enable: false
     timeout: 5
+    failedContinue: true
   msgModify:
     enable: false
     timeout: 5
@@ -334,12 +324,15 @@ callback:
   userOnline:
     enable: false
     timeout: 5
+    failedContinue: true
   userOffline:
     enable: false
     timeout: 5
+    failedContinue: true
   userKickOff:
     enable: false
     timeout: 5
+    failedContinue: true
   offlinePush:
     enable: false
     timeout: 5
@@ -364,6 +357,10 @@ callback:
     enable: false
     timeout: 5
     failedContinue: true
+  afterCreateGroup:
+    enable: false
+    timeout: 5
+    failedContinue: true
   beforeMemberJoinGroup:
     enable: false
     timeout: 5
@@ -372,18 +369,129 @@ callback:
     enable: false
     timeout: 5
     failedContinue: true
+  afterSetGroupMemberInfo:
+    enable: false
+    timeout: 5
+    failedContinue: true
   setMessageReactionExtensions:
     enable: false
     timeout: 5
     failedContinue: true
-
+  quitGroup:
+    enable: false
+    timeout: 5
+    failedContinue: true
+  killGroupMember:
+    enable: false
+    timeout: 5
+    failedContinue: true
+  dismissGroup:
+    enable: false
+    timeout: 5
+    failedContinue: true
+  joinGroup:
+    enable: false
+    timeout: 5
+    failedContinue: true
+  groupMsgRead:
+    enable: false
+    timeout: 5
+    failedContinue: true
+  singleMsgRead:
+    enable: false
+    timeout: 5
+    failedContinue: true
+  updateUserInfo:
+    enable: false
+    timeout: 5
+    failedContinue: true
+  beforeUserRegister:
+    enable: false
+    timeout: 5
+    failedContinue: true
+  afterUserRegister:
+    enable: false
+    timeout: 5
+    failedContinue: true
+  transferGroupOwner:
+    enable: false
+    timeout: 5
+    failedContinue: true
+  beforeSetFriendRemark:
+    enable: false
+    timeout: 5
+    failedContinue: true
+  afterSetFriendRemark:
+    enable: false
+    timeout: 5
+    failedContinue: true
+  afterGroupMsgRead:
+    enable: false
+    timeout: 5
+    failedContinue: true
+  afterGroupMsgRevoke:
+    enable: false
+    timeout: 5
+    failedContinue: true
+  afterJoinGroup:
+    enable: false
+    timeout: 5
+    failedContinue: true
+  beforeInviteUserToGroup:
+    enable: false
+    timeout: 5
+    failedContinue: true
+  joinGroupAfter:
+    enable: false
+    timeout: 5
+    failedContinue: true
+  setGroupInfoAfter:
+    enable: false
+    timeout: 5
+    failedContinue: true
+  setGroupInfoBefore:
+    enable: false
+    timeout: 5
+    failedContinue: true
+  revokeMsgAfter:
+    enable: false
+    timeout: 5
+    failedContinue: true
+  addBlackBefore:
+    enable: false
+    timeout: 5
+    failedContinue: true
+  addFriendAfter:
+    enable: false
+    timeout: 5
+    failedContinue: true
+  addFriendAgreeBefore:
+    enable: false
+    timeout: 5
+    failedContinue: true
+  deleteFriendAfter:
+    enable: false
+    timeout: 5
+    failedContinue: true
+  importFriendsBefore:
+    enable: false
+    timeout: 5
+    failedContinue: true
+  importFriendsAfter:
+    enable: false
+    timeout: 5
+    failedContinue: true
+  removeBlackAfter:
+    enable: false
+    timeout: 5
+    failedContinue: true
 ###################### Prometheus ######################
 # Prometheus configuration for various services
 # The number of Prometheus ports per service needs to correspond to rpcPort
 # The number of ports needs to be consistent with msg_transfer_service_num in script/path_info.sh
 prometheus:
-  enable: true
-  prometheusUrl: "https://openim.prometheus"
+  enable: false
+  prometheusUrl: 172.28.0.1:13000
   apiPrometheusPort: [20100]
   userPrometheusPort: [ 20110 ]
   friendPrometheusPort: [ 20120 ]

config/templates/env.template

@@ -1,23 +1,9 @@
-# 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 ========
 # ======================================
 
 # The user for authentication or system operations.
-# Default: USER=root
+# Default: OPENIM_USER=root
 USER=root
 
 # Password associated with the specified user for authentication.
@@ -55,50 +41,19 @@ DOCKER_BRIDGE_SUBNET=172.28.0.0/16
 # Default: DOCKER_BRIDGE_GATEWAY=172.28.0.1
 DOCKER_BRIDGE_GATEWAY=172.28.0.1
 
-# Address or hostname for the MySQL network.
-# Default: MYSQL_NETWORK_ADDRESS=172.28.0.2
-MYSQL_NETWORK_ADDRESS=172.28.0.2
-
-# Address or hostname for the MongoDB network.
-# Default: MONGO_NETWORK_ADDRESS=172.28.0.3
-MONGO_NETWORK_ADDRESS=172.28.0.3
-
-# Address or hostname for the Redis network.
-# Default: REDIS_NETWORK_ADDRESS=172.28.0.4
-REDIS_NETWORK_ADDRESS=172.28.0.4
-
-# Address or hostname for the Kafka network.
-# Default: KAFKA_NETWORK_ADDRESS=172.28.0.5
-KAFKA_NETWORK_ADDRESS=172.28.0.5
-
-# Address or hostname for the ZooKeeper network.
-# Default: ZOOKEEPER_NETWORK_ADDRESS=172.28.0.6
-ZOOKEEPER_NETWORK_ADDRESS=172.28.0.6
-
-# Address or hostname for the MinIO network.
-# Default: MINIO_NETWORK_ADDRESS=172.28.0.7
-MINIO_NETWORK_ADDRESS=172.28.0.7
-
-# Address or hostname for the OpenIM web network.
-# Default: OPENIM_WEB_NETWORK_ADDRESS=172.28.0.8
-OPENIM_WEB_NETWORK_ADDRESS=172.28.0.8
-
-# Address or hostname for the OpenIM server network.
-# Default: OPENIM_SERVER_NETWORK_ADDRESS=172.28.0.9
-OPENIM_SERVER_NETWORK_ADDRESS=172.28.0.9
-
-# Address or hostname for the OpenIM chat network.
-# Default: OPENIM_CHAT_NETWORK_ADDRESS=172.28.0.10
-OPENIM_CHAT_NETWORK_ADDRESS=172.28.0.10
-
-# Address or hostname for the Prometheus network.
-# Default: PROMETHEUS_NETWORK_ADDRESS=172.28.0.11
-PROMETHEUS_NETWORK_ADDRESS=172.28.0.11
-
-# Address or hostname for the Grafana network.
-# Default: GRAFANA_NETWORK_ADDRESS=172.28.0.12
-GRAFANA_NETWORK_ADDRESS=172.28.0.12
-
+MONGO_NETWORK_ADDRESS=172.28.0.2
+REDIS_NETWORK_ADDRESS=172.28.0.3
+KAFKA_NETWORK_ADDRESS=172.28.0.4
+ZOOKEEPER_NETWORK_ADDRESS=172.28.0.5
+MINIO_NETWORK_ADDRESS=172.28.0.6
+OPENIM_WEB_NETWORK_ADDRESS=172.28.0.7
+OPENIM_SERVER_NETWORK_ADDRESS=172.28.0.8
+OPENIM_CHAT_NETWORK_ADDRESS=172.28.0.9
+PROMETHEUS_NETWORK_ADDRESS=172.28.0.10
+GRAFANA_NETWORK_ADDRESS=172.28.0.11
+NODE_EXPORTER_NETWORK_ADDRESS=172.28.0.12
+OPENIM_ADMIN_FRONT_NETWORK_ADDRESS=172.28.0.13
+ALERT_MANAGER_NETWORK_ADDRESS=172.28.0.14
 
 # ===============================================
 # = Component Extension Configuration =
@@ -108,38 +63,24 @@ GRAFANA_NETWORK_ADDRESS=172.28.0.12
 # ----- ZooKeeper Configuration -----
 # Address or hostname for the ZooKeeper service.
 # Default: ZOOKEEPER_ADDRESS=172.28.0.1
-ZOOKEEPER_ADDRESS=172.28.0.6
+ZOOKEEPER_ADDRESS=172.28.0.5
 
 # Port for ZooKeeper service.
 # Default: ZOOKEEPER_PORT=12181
 ZOOKEEPER_PORT=12181
 
-# ----- MySQL Configuration -----
-
-# Address or hostname for the MySQL service.
-# Default: MYSQL_ADDRESS=172.28.0.1
-MYSQL_ADDRESS=172.28.0.2
-
-# Port on which MySQL database service is running.
-# Default: MYSQL_PORT=13306
-MYSQL_PORT=13306
-
-# Password to authenticate with the MySQL database service.
-# Default: MYSQL_PASSWORD=openIM123
-MYSQL_PASSWORD=openIM123
-
 # ----- MongoDB Configuration -----
 # Address or hostname for the MongoDB service.
 # Default: MONGO_ADDRESS=172.28.0.1
-MONGO_ADDRESS=172.28.0.3
+MONGO_ADDRESS=172.28.0.2
 
 # Port on which MongoDB service is running.
 # Default: MONGO_PORT=37017
-MONGO_PORT=37017
+# MONGO_PORT=37017
 
 # Username to authenticate with the MongoDB service.
 # Default: MONGO_USERNAME=root
-MONGO_USERNAME=root
+# MONGO_USERNAME=root
 
 # Password to authenticate with the MongoDB service.
 # Default: MONGO_PASSWORD=openIM123
@@ -152,7 +93,7 @@ MONGO_DATABASE=openIM_v3
 # ----- Redis Configuration -----
 # Address or hostname for the Redis service.
 # Default: REDIS_ADDRESS=172.28.0.1
-REDIS_ADDRESS=172.28.0.4
+REDIS_ADDRESS=172.28.0.3
 
 # Port on which Redis in-memory data structure store is running.
 # Default: REDIS_PORT=16379
@@ -165,7 +106,10 @@ REDIS_PASSWORD=openIM123
 # ----- Kafka Configuration -----
 # Address or hostname for the Kafka service.
 # Default: KAFKA_ADDRESS=172.28.0.1
-KAFKA_ADDRESS=172.28.0.5
+KAFKA_ADDRESS=172.28.0.4
+
+# Kakfa username to authenticate with the Kafka service.
+# KAFKA_USERNAME=''
 
 # Port on which Kafka distributed streaming platform is running.
 # Default: KAFKA_PORT=19092
@@ -186,7 +130,7 @@ KAFKA_OFFLINEMSG_MONGO_TOPIC=offlineMsgToMongoMysql
 # ----- MinIO Configuration ----
 # Address or hostname for the MinIO object storage service.
 # Default: MINIO_ADDRESS=172.28.0.1
-MINIO_ADDRESS=172.28.0.7
+MINIO_ADDRESS=172.28.0.6
 
 # Port on which MinIO object storage service is running.
 # Default: MINIO_PORT=10005
@@ -194,7 +138,7 @@ MINIO_PORT=10005
 
 # Access key to authenticate with the MinIO service.
 # Default: MINIO_ACCESS_KEY=root
-MINIO_ACCESS_KEY=root
+# MINIO_ACCESS_KEY=root
 
 # Secret key corresponding to the access key for MinIO authentication.
 # Default: MINIO_SECRET_KEY=openIM123
@@ -203,7 +147,7 @@ MINIO_SECRET_KEY=openIM123
 # ----- Prometheus Configuration -----
 # Address or hostname for the Prometheus service.
 # Default: PROMETHEUS_ADDRESS=172.28.0.1
-PROMETHEUS_ADDRESS=172.28.0.11
+PROMETHEUS_ADDRESS=172.28.0.10
 
 # Port on which Prometheus service is running.
 # Default: PROMETHEUS_PORT=19090
@@ -212,11 +156,11 @@ PROMETHEUS_PORT=19090
 # ----- Grafana Configuration -----
 # Address or hostname for the Grafana service.
 # Default: GRAFANA_ADDRESS=172.28.0.1
-GRAFANA_ADDRESS=172.28.0.12
+GRAFANA_ADDRESS=172.28.0.11
 
 # Port on which Grafana service is running.
-# Default: GRAFANA_PORT=3000
-GRAFANA_PORT=3000
+# Default: GRAFANA_PORT=13000
+GRAFANA_PORT=13000
 
 # ======================================
 # ============ OpenIM Web ===============
@@ -232,7 +176,7 @@ OPENIM_WEB_PORT=11001
 
 # Address or hostname for the OpenIM web service.
 # Default: OPENIM_WEB_ADDRESS=172.28.0.1
-OPENIM_WEB_ADDRESS=172.28.0.8
+OPENIM_WEB_ADDRESS=172.28.0.7
 
 # ======================================
 # ========= OpenIM Server ==============
@@ -240,7 +184,7 @@ OPENIM_WEB_ADDRESS=172.28.0.8
 
 # Address or hostname for the OpenIM server.
 # Default: OPENIM_SERVER_ADDRESS=172.28.0.1
-OPENIM_SERVER_ADDRESS=172.28.0.9
+OPENIM_SERVER_ADDRESS=172.28.0.8
 
 # Port for the OpenIM WebSockets.
 # Default: OPENIM_WS_PORT=10001
@@ -261,7 +205,7 @@ CHAT_BRANCH=main
 
 # Address or hostname for the OpenIM chat service.
 # Default: OPENIM_CHAT_ADDRESS=172.28.0.1
-OPENIM_CHAT_ADDRESS=172.28.0.10
+OPENIM_CHAT_ADDRESS=172.28.0.9
 
 # Port for the OpenIM chat API.
 # Default: OPENIM_CHAT_API_PORT=10008
@@ -283,3 +227,23 @@ SERVER_BRANCH=main
 # Port for the OpenIM admin API.
 # Default: OPENIM_ADMIN_API_PORT=10009
 OPENIM_ADMIN_API_PORT=10009
+  
+# Port for the node exporter.
+# Default: NODE_EXPORTER_PORT=19100
+NODE_EXPORTER_PORT=19100
+  
+# Port for the prometheus.
+# Default: PROMETHEUS_PORT=19090
+PROMETHEUS_PORT=19090
+  
+# Port for the grafana.
+# Default: GRAFANA_PORT=13000
+GRAFANA_PORT=13000
+  
+# Port for the admin front.
+# Default: OPENIM_ADMIN_FRONT_PORT=11002
+OPENIM_ADMIN_FRONT_PORT=11002
+
+# Port for the alertmanager.
+# Default: ALERT_MANAGER_PORT=19093
+ALERT_MANAGER_PORT=19093

config/templates/prometheus.yml.template

@@ -0,0 +1,85 @@
+# my global config
+global:
+  scrape_interval:     15s # Set the scrape interval to every 15 seconds. Default is every 1 minute.
+  evaluation_interval: 15s # Evaluate rules every 15 seconds. The default is every 1 minute.
+  # scrape_timeout is set to the global default (10s).
+
+# Alertmanager configuration
+alerting:
+  alertmanagers:
+    - static_configs:
+        - targets: ['172.28.0.1:19093']
+
+# Load rules once and periodically evaluate them according to the global 'evaluation_interval'.
+rule_files:
+  - "instance-down-rules.yml"
+# - "first_rules.yml"
+# - "second_rules.yml"
+
+# A scrape configuration containing exactly one endpoint to scrape:
+# Here it's Prometheus itself.
+scrape_configs:
+  # The job name is added as a label "job='job_name'"" to any timeseries scraped from this config.
+  # Monitored information captured by prometheus
+  - job_name: 'node-exporter'
+    static_configs:
+      - targets: [ '172.28.0.1:19100' ]
+        labels:
+          namespace: 'default'
+
+  # prometheus fetches application services
+  - job_name: 'openimserver-openim-api'
+    static_configs:
+      - targets: [ '172.28.0.1:20100' ]
+        labels:
+          namespace: 'default'
+  - job_name: 'openimserver-openim-msggateway'
+    static_configs:
+      - targets: [ '172.28.0.1:20140' ]
+        labels:
+          namespace: 'default'
+  - job_name: 'openimserver-openim-msgtransfer'
+    static_configs:
+      - targets: [ 172.28.0.1:21400, 172.28.0.1:21401, 172.28.0.1:21402, 172.28.0.1:21403 ]
+        labels:
+          namespace: 'default'
+  - job_name: 'openimserver-openim-push'
+    static_configs:
+      - targets: [ '172.28.0.1:20170' ]
+        labels:
+          namespace: 'default'
+  - job_name: 'openimserver-openim-rpc-auth'
+    static_configs:
+      - targets: [ '172.28.0.1:20160' ]
+        labels:
+          namespace: 'default'
+  - job_name: 'openimserver-openim-rpc-conversation'
+    static_configs:
+      - targets: [ '172.28.0.1:20230' ]
+        labels:
+          namespace: 'default'
+  - job_name: 'openimserver-openim-rpc-friend'
+    static_configs:
+      - targets: [ '172.28.0.1:20120' ]
+        labels:
+          namespace: 'default'
+  - job_name: 'openimserver-openim-rpc-group'
+    static_configs:
+      - targets: [ '172.28.0.1:20150' ]
+        labels:
+          namespace: 'default'
+  - job_name: 'openimserver-openim-rpc-msg'
+    static_configs:
+      - targets: [ '172.28.0.1:20130' ]
+        labels:
+          namespace: 'default'
+  - job_name: 'openimserver-openim-rpc-third'
+    static_configs:
+      - targets: [ '172.28.0.1:21301' ]
+        labels:
+          namespace: 'default'
+  - job_name: 'openimserver-openim-rpc-user'
+    static_configs:
+      - targets: [ '172.28.0.1:20110' ]
+        labels:
+          namespace: 'default'

deployments/README.md

@@ -84,8 +84,8 @@ $ sudo sealos run labring/kubernetes:v1.25.0 labring/helm:v3.8.2 labring/calico:
 If you are local, you can also use Kind and Minikube to test, for example, using Kind:
 
 ```bash
-$ sGO111MODULE="on" go get sigs.k8s.io/kind@v0.11.1
-$ skind create cluster
+$ GO111MODULE="on" go get sigs.k8s.io/kind@v0.11.1
+$ kind create cluster
 ```
 
 ### Installing helm
@@ -106,7 +106,7 @@ $ helm repo add brigade https://openimsdk.github.io/openim-charts
 
 ### OpenIM Image Strategy
 
-Automated offerings include aliyun, ghcr, docker hub: [Image Documentation](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/images.md)
+Automated offerings include aliyun, ghcr, docker hub: [Image Documentation](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/images.md)
 
 **Local Test Build Method:**
 
@@ -123,6 +123,30 @@ Explore our Helm-Charts repository and read through: [Helm-Charts Repository](ht
 
 Using the helm charts repository, you can ignore the following configuration, but if you want to just use the server and scale on top of it, you can go ahead:
 
+**Use the Helm template to generate the deployment yaml file: `openim-charts.yaml`**
+
+**Gen Image:**
+
+```bash
+../scripts/genconfig.sh ../scripts/install/environment.sh ./templates/helm-image.yaml > ./charts/generated-configs/helm-image.yaml
+```
+
+**Gen Charts:**
+
+```bash
+for chart in ./charts/*/; do
+    if [[ "$chart" == *"generated-configs"* || "$chart" == *"helmfile.yaml"* ]]; then
+        continue
+    fi
+
+    if [ -f "${chart}values.yaml" ]; then
+        helm template "$chart" -f "./charts/generated-configs/helm-image.yaml" -f "./charts/generated-configs/config.yaml" -f "./charts/generated-configs/notification.yaml" >> openim-charts.yaml
+    else
+        helm template "$chart" >> openim-charts.yaml
+    fi
+done
+```
+
 **Use Helmfile:**
 
 ```bash
@@ -130,8 +154,6 @@ GO111MODULE=on go get github.com/roboll/helmfile@latest
 ```
 
 ```bash
-export MYSQL_ADDRESS=im-mysql
-export MYSQL_PORT=3306
 export MONGO_ADDRESS=im-mongo
 export MONGO_PORT=27017
 export REDIS_ADDRESS=im-redis-master
@@ -150,4 +172,4 @@ cp ../config/notification.yaml ./charts/generated-configs/notification.yaml
 
 ```bash
 helmfile apply
-```
+```

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

deployments/templates/alertmanager.yml

@@ -0,0 +1,33 @@
+###################### AlertManager Configuration ######################
+# AlertManager configuration using environment variables
+#
+# Resolve timeout
+# SMTP configuration for sending alerts
+# Templates for email notifications
+# Routing configurations for alerts
+# Receiver configurations
+global:
+  resolve_timeout: ${ALERTMANAGER_RESOLVE_TIMEOUT}
+  smtp_from: ${ALERTMANAGER_SMTP_FROM}
+  smtp_smarthost: ${ALERTMANAGER_SMTP_SMARTHOST}
+  smtp_auth_username: ${ALERTMANAGER_SMTP_AUTH_USERNAME}
+  smtp_auth_password: ${ALERTMANAGER_SMTP_AUTH_PASSWORD}
+  smtp_require_tls: ${ALERTMANAGER_SMTP_REQUIRE_TLS}
+  smtp_hello: ${ALERTMANAGER_SMTP_HELLO}
+
+templates:
+  - /etc/alertmanager/email.tmpl
+
+route:
+  group_by: ['alertname']
+  group_wait: 5s
+  group_interval: 5s
+  repeat_interval: 5m
+  receiver: email
+receivers:
+  - name: email
+    email_configs:
+      - to: '${ALERTMANAGER_EMAIL_TO}'
+        html: '{{ template "email.to.html" . }}'
+        headers: { Subject: "[OPENIM-SERVER]Alarm" }
+        send_resolved: true

deployments/templates/chat.yaml

@@ -53,19 +53,6 @@ rpcRegisterName:
   openImAdminName: ${OPENIM_ADMIN_NAME}
   openImChatName: ${OPENIM_CHAT_NAME}
 
-###################### MySQL ######################
-mysql:
-  #  address: [ 127.0.0.1:13306 ]            #目前仅支持单机
-  #  username: root                          #用户名
-  #  password: openIM123                     #密码
-  #  database: openIM_v2                     #不建议修改
-  #  maxOpenConn: 1000                       #最大连接数
-  #  maxIdleConn: 100                        #最大空闲连接数
-  #  maxLifeTime: 60                         #连接可以重复使用的最长时间（秒）
-  #  logLevel: 4                             #日志级别 1=slient 2=error 3=warn 4=info
-  #  slowThreshold: 500                      #慢语句阈值 （毫秒）
-  database: openim_enterprise
-
 ###################### Log ######################
 log:
   storageLocation: ../logs/           #存放目录
@@ -96,7 +83,14 @@ verifyCode:
     accessKeySecret: ""
     signName: ""
     verificationCodeTemplateCode: ""
-
+  mail: # 根据对应的发件邮箱更改 sendMail、senderAuthorizationCode、smtpAddr、smtpPort 即可
+    title: ""
+    senderMail: "" # 发送者
+    senderAuthorizationCode: "" # 授权码
+    smtpAddr: "smtp.qq.com"  # smtp 服务器地址
+    smtpPort: 25   # smtp 服务器邮件发送端口
+  testDepartMentID: 001
+  imAPIURL: http://127.0.0.1:10002
 
 ###################### Proxy Header ######################
 # 获取ip的header,没有配置直接获取远程地址

deployments/templates/env-template.yaml

@@ -1,24 +1,10 @@
-# 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 ========
 # ======================================
 
 # The user for authentication or system operations.
-# Default: USER=root
-USER=${USER}
+# Default: OPENIM_USER=root
+USER=${OPENIM_USER}
 
 # Password associated with the specified user for authentication.
 # Default: PASSWORD=openIM123
@@ -55,50 +41,19 @@ DOCKER_BRIDGE_SUBNET=${DOCKER_BRIDGE_SUBNET}
 # Default: DOCKER_BRIDGE_GATEWAY=172.28.0.1
 DOCKER_BRIDGE_GATEWAY=${DOCKER_BRIDGE_GATEWAY}
 
-# Address or hostname for the MySQL network.
-# Default: MYSQL_NETWORK_ADDRESS=172.28.0.2
-MYSQL_NETWORK_ADDRESS=${MYSQL_NETWORK_ADDRESS}
-
-# Address or hostname for the MongoDB network.
-# Default: MONGO_NETWORK_ADDRESS=172.28.0.3
 MONGO_NETWORK_ADDRESS=${MONGO_NETWORK_ADDRESS}
-
-# Address or hostname for the Redis network.
-# Default: REDIS_NETWORK_ADDRESS=172.28.0.4
 REDIS_NETWORK_ADDRESS=${REDIS_NETWORK_ADDRESS}
-
-# Address or hostname for the Kafka network.
-# Default: KAFKA_NETWORK_ADDRESS=172.28.0.5
 KAFKA_NETWORK_ADDRESS=${KAFKA_NETWORK_ADDRESS}
-
-# Address or hostname for the ZooKeeper network.
-# Default: ZOOKEEPER_NETWORK_ADDRESS=172.28.0.6
 ZOOKEEPER_NETWORK_ADDRESS=${ZOOKEEPER_NETWORK_ADDRESS}
-
-# Address or hostname for the MinIO network.
-# Default: MINIO_NETWORK_ADDRESS=172.28.0.7
 MINIO_NETWORK_ADDRESS=${MINIO_NETWORK_ADDRESS}
-
-# Address or hostname for the OpenIM web network.
-# Default: OPENIM_WEB_NETWORK_ADDRESS=172.28.0.8
 OPENIM_WEB_NETWORK_ADDRESS=${OPENIM_WEB_NETWORK_ADDRESS}
-
-# Address or hostname for the OpenIM server network.
-# Default: OPENIM_SERVER_NETWORK_ADDRESS=172.28.0.9
 OPENIM_SERVER_NETWORK_ADDRESS=${OPENIM_SERVER_NETWORK_ADDRESS}
-
-# Address or hostname for the OpenIM chat network.
-# Default: OPENIM_CHAT_NETWORK_ADDRESS=172.28.0.10
 OPENIM_CHAT_NETWORK_ADDRESS=${OPENIM_CHAT_NETWORK_ADDRESS}
-
-# Address or hostname for the Prometheus network.
-# Default: PROMETHEUS_NETWORK_ADDRESS=172.28.0.11
 PROMETHEUS_NETWORK_ADDRESS=${PROMETHEUS_NETWORK_ADDRESS}
-
-# Address or hostname for the Grafana network.
-# Default: GRAFANA_NETWORK_ADDRESS=172.28.0.12
 GRAFANA_NETWORK_ADDRESS=${GRAFANA_NETWORK_ADDRESS}
-
+NODE_EXPORTER_NETWORK_ADDRESS=${NODE_EXPORTER_NETWORK_ADDRESS}
+OPENIM_ADMIN_FRONT_NETWORK_ADDRESS=${OPENIM_ADMIN_FRONT_NETWORK_ADDRESS}
+ALERT_MANAGER_NETWORK_ADDRESS=${ALERT_MANAGER_NETWORK_ADDRESS}
 
 # ===============================================
 # = Component Extension Configuration =
@@ -114,20 +69,6 @@ ZOOKEEPER_ADDRESS=${ZOOKEEPER_NETWORK_ADDRESS}
 # Default: ZOOKEEPER_PORT=12181
 ZOOKEEPER_PORT=${ZOOKEEPER_PORT}
 
-# ----- MySQL Configuration -----
-
-# Address or hostname for the MySQL service.
-# Default: MYSQL_ADDRESS=172.28.0.1
-MYSQL_ADDRESS=${MYSQL_NETWORK_ADDRESS}
-
-# Port on which MySQL database service is running.
-# Default: MYSQL_PORT=13306
-MYSQL_PORT=${MYSQL_PORT}
-
-# Password to authenticate with the MySQL database service.
-# Default: MYSQL_PASSWORD=openIM123
-MYSQL_PASSWORD=${MYSQL_PASSWORD}
-
 # ----- MongoDB Configuration -----
 # Address or hostname for the MongoDB service.
 # Default: MONGO_ADDRESS=172.28.0.1
@@ -135,11 +76,11 @@ MONGO_ADDRESS=${MONGO_NETWORK_ADDRESS}
 
 # Port on which MongoDB service is running.
 # Default: MONGO_PORT=37017
-MONGO_PORT=${MONGO_PORT}
+# MONGO_PORT=${MONGO_PORT}
 
 # Username to authenticate with the MongoDB service.
 # Default: MONGO_USERNAME=root
-MONGO_USERNAME=${MONGO_USERNAME}
+# MONGO_USERNAME=${MONGO_USERNAME}
 
 # Password to authenticate with the MongoDB service.
 # Default: MONGO_PASSWORD=openIM123
@@ -167,6 +108,9 @@ REDIS_PASSWORD=${REDIS_PASSWORD}
 # Default: KAFKA_ADDRESS=172.28.0.1
 KAFKA_ADDRESS=${KAFKA_NETWORK_ADDRESS}
 
+# Kakfa username to authenticate with the Kafka service.
+# KAFKA_USERNAME=${KAFKA_USERNAME}
+
 # Port on which Kafka distributed streaming platform is running.
 # Default: KAFKA_PORT=19092
 KAFKA_PORT=${KAFKA_PORT}
@@ -194,7 +138,7 @@ MINIO_PORT=${MINIO_PORT}
 
 # Access key to authenticate with the MinIO service.
 # Default: MINIO_ACCESS_KEY=root
-MINIO_ACCESS_KEY=${MINIO_ACCESS_KEY}
+# MINIO_ACCESS_KEY=${MINIO_ACCESS_KEY}
 
 # Secret key corresponding to the access key for MinIO authentication.
 # Default: MINIO_SECRET_KEY=openIM123
@@ -215,7 +159,7 @@ PROMETHEUS_PORT=${PROMETHEUS_PORT}
 GRAFANA_ADDRESS=${GRAFANA_NETWORK_ADDRESS}
 
 # Port on which Grafana service is running.
-# Default: GRAFANA_PORT=3000
+# Default: GRAFANA_PORT=13000
 GRAFANA_PORT=${GRAFANA_PORT}
 
 # ======================================
@@ -283,3 +227,23 @@ SERVER_BRANCH=${SERVER_BRANCH}
 # Port for the OpenIM admin API.
 # Default: OPENIM_ADMIN_API_PORT=10009
 OPENIM_ADMIN_API_PORT=${OPENIM_ADMIN_API_PORT}
+  
+# Port for the node exporter.
+# Default: NODE_EXPORTER_PORT=19100
+NODE_EXPORTER_PORT=${NODE_EXPORTER_PORT}
+  
+# Port for the prometheus.
+# Default: PROMETHEUS_PORT=19090
+PROMETHEUS_PORT=${PROMETHEUS_PORT}
+  
+# Port for the grafana.
+# Default: GRAFANA_PORT=13000
+GRAFANA_PORT=${GRAFANA_PORT}
+  
+# Port for the admin front.
+# Default: OPENIM_ADMIN_FRONT_PORT=11002
+OPENIM_ADMIN_FRONT_PORT=${OPENIM_ADMIN_FRONT_PORT}
+
+# Port for the alertmanager.
+# Default: ALERT_MANAGER_PORT=19093
+ALERT_MANAGER_PORT=${ALERT_MANAGER_PORT}

deployments/templates/openim.yaml

@@ -35,35 +35,22 @@ zookeeper:
   username: ${ZOOKEEPER_USERNAME}
   password: ${ZOOKEEPER_PASSWORD}
 
-###################### Mysql ######################
-# MySQL configuration
-# Currently, only single machine setup is supported
-#
-# Maximum number of open connections
-# Maximum number of idle connections
-# Maximum lifetime in seconds a connection can be reused
-# Log level: 1=slient, 2=error, 3=warn, 4=info
-# Slow query threshold in milliseconds
-mysql:
-  address: [ ${MYSQL_ADDRESS}:${MYSQL_PORT} ]
-  username: ${MYSQL_USERNAME}
-  password: ${MYSQL_PASSWORD}
-  database: ${MYSQL_DATABASE}
-  maxOpenConn: ${MYSQL_MAX_OPEN_CONN}
-  maxIdleConn: ${MYSQL_MAX_IDLE_CONN}
-  maxLifeTime: ${MYSQL_MAX_LIFETIME}
-  logLevel: ${MYSQL_LOG_LEVEL}
-  slowThreshold: ${MYSQL_SLOW_THRESHOLD}
-
 ###################### Mongo ######################
 # MongoDB configuration
-# If uri is not empty, it will be used directly
-#
-# MongoDB address for standalone setup, Mongos address for sharded cluster setup
-# Default MongoDB database name
-# Maximum connection pool size
+
+# If uri is not empty, it will be used directly for the MongoDB connection.
+# This is a complete MongoDB URI string.
+# Example: mongodb://user:password@host1:port1,host2:port2/dbname?options
 mongo:
   uri: ${MONGO_URI}
+
+# List of MongoDB server addresses.
+# Used for constructing the MongoDB URI if 'uri' above is empty.
+# For a standalone setup, specify the address of the single server.
+# For a sharded cluster, specify the addresses of the Mongos servers.
+# Example: [ '172.28.0.1:37017', '172.28.0.2:37017' ]
+# Default MongoDB database name
+# Maximum connection pool size
   address: [ ${MONGO_ADDRESS}:${MONGO_PORT} ]
   database: ${MONGO_DATABASE}
   username: ${MONGO_USERNAME}
@@ -158,13 +145,21 @@ object:
     accessKeySecret: ${OSS_ACCESS_KEY_SECRET}
     sessionToken: ${OSS_SESSION_TOKEN}
     publicRead: ${OSS_PUBLIC_READ}
+  kodo:
+    endpoint: "${KODO_ENDPOINT}"
+    bucket: "${KODO_BUCKET}"
+    bucketURL: "${KODO_BUCKET_URL}"
+    accessKeyID: ${KODO_ACCESS_KEY_ID}
+    accessKeySecret: ${KODO_ACCESS_KEY_SECRET}
+    sessionToken: ${KODO_SESSION_TOKEN}
+    publicRead: ${KODO_PUBLIC_READ}
 
 ###################### RPC Port Configuration ######################
 # RPC service ports
 # These ports are passed into the program by the script and are not recommended to modify
 # For launching multiple programs, just fill in multiple ports separated by commas
 # For example, [10110, 10111]
-rpcPort: 
+rpcPort:
   openImUserPort: [ ${OPENIM_USER_PORT} ]
   openImFriendPort: [ ${OPENIM_FRIEND_PORT} ]
   openImMessagePort: [ ${OPENIM_MESSAGE_PORT} ]
@@ -312,71 +307,191 @@ iosPush:
 # Timeout in seconds
 # Whether to continue execution if callback fails
 callback:
-  url:
+  url: ""
   beforeSendSingleMsg:
-    enable: false
-    timeout: 5
-    failedContinue: true
+    enable: ${CALLBACK_ENABLE}
+    timeout: ${CALLBACK_TIMEOUT}
+    failedContinue: ${CALLBACK_FAILED_CONTINUE}
   afterSendSingleMsg:
-    enable: false
-    timeout: 5
+    enable: ${CALLBACK_ENABLE}
+    timeout: ${CALLBACK_TIMEOUT}
+    failedContinue: ${CALLBACK_FAILED_CONTINUE}
   beforeSendGroupMsg:
-    enable: false
-    timeout: 5
-    failedContinue: true
+    enable: ${CALLBACK_ENABLE}
+    timeout: ${CALLBACK_TIMEOUT}
+    failedContinue: ${CALLBACK_FAILED_CONTINUE}
   afterSendGroupMsg:
-    enable: false
-    timeout: 5
+    enable: ${CALLBACK_ENABLE}
+    timeout: ${CALLBACK_TIMEOUT}
+    failedContinue: ${CALLBACK_FAILED_CONTINUE}
   msgModify:
-    enable: false
-    timeout: 5
-    failedContinue: true
+    enable: ${CALLBACK_ENABLE}
+    timeout: ${CALLBACK_TIMEOUT}
+    failedContinue: ${CALLBACK_FAILED_CONTINUE}
   userOnline:
-    enable: false
-    timeout: 5
+    enable: ${CALLBACK_ENABLE}
+    timeout: ${CALLBACK_TIMEOUT}
+    failedContinue: ${CALLBACK_FAILED_CONTINUE}
   userOffline:
-    enable: false
-    timeout: 5
+    enable: ${CALLBACK_ENABLE}
+    timeout: ${CALLBACK_TIMEOUT}
+    failedContinue: ${CALLBACK_FAILED_CONTINUE}
   userKickOff:
-    enable: false
-    timeout: 5
+    enable: ${CALLBACK_ENABLE}
+    timeout: ${CALLBACK_TIMEOUT}
+    failedContinue: ${CALLBACK_FAILED_CONTINUE}
   offlinePush:
-    enable: false
-    timeout: 5
-    failedContinue: true
+    enable: ${CALLBACK_ENABLE}
+    timeout: ${CALLBACK_TIMEOUT}
+    failedContinue: ${CALLBACK_FAILED_CONTINUE}
   onlinePush:
-    enable: false
-    timeout: 5
-    failedContinue: true
+    enable: ${CALLBACK_ENABLE}
+    timeout: ${CALLBACK_TIMEOUT}
+    failedContinue: ${CALLBACK_FAILED_CONTINUE}
   superGroupOnlinePush:
-    enable: false
-    timeout: 5
-    failedContinue: true
+    enable: ${CALLBACK_ENABLE}
+    timeout: ${CALLBACK_TIMEOUT}
+    failedContinue: ${CALLBACK_FAILED_CONTINUE}
   beforeAddFriend:
-    enable: false
-    timeout: 5
-    failedContinue: true
+    enable: ${CALLBACK_ENABLE}
+    timeout: ${CALLBACK_TIMEOUT}
+    failedContinue: ${CALLBACK_FAILED_CONTINUE}
   beforeUpdateUserInfo:
-    enable: false
-    timeout: 5
-    failedContinue: true
+    enable: ${CALLBACK_ENABLE}
+    timeout: ${CALLBACK_TIMEOUT}
+    failedContinue: ${CALLBACK_FAILED_CONTINUE}
   beforeCreateGroup:
-    enable: false
-    timeout: 5
-    failedContinue: true
+    enable: ${CALLBACK_ENABLE}
+    timeout: ${CALLBACK_TIMEOUT}
+    failedContinue: ${CALLBACK_FAILED_CONTINUE}
+  afterCreateGroup:
+    enable: ${CALLBACK_ENABLE}
+    timeout: ${CALLBACK_TIMEOUT}
+    failedContinue: ${CALLBACK_FAILED_CONTINUE}
   beforeMemberJoinGroup:
-    enable: false
-    timeout: 5
-    failedContinue: true
+    enable: ${CALLBACK_ENABLE}
+    timeout: ${CALLBACK_TIMEOUT}
+    failedContinue: ${CALLBACK_FAILED_CONTINUE}
   beforeSetGroupMemberInfo:
-    enable: false
-    timeout: 5
-    failedContinue: true
+    enable: ${CALLBACK_ENABLE}
+    timeout: ${CALLBACK_TIMEOUT}
+    failedContinue: ${CALLBACK_FAILED_CONTINUE}
+  afterSetGroupMemberInfo:
+    enable: ${CALLBACK_ENABLE}
+    timeout: ${CALLBACK_TIMEOUT}
+    failedContinue: ${CALLBACK_FAILED_CONTINUE}
   setMessageReactionExtensions:
-    enable: false
-    timeout: 5
-    failedContinue: true
-
+    enable: ${CALLBACK_ENABLE}
+    timeout: ${CALLBACK_TIMEOUT}
+    failedContinue: ${CALLBACK_FAILED_CONTINUE}
+  quitGroup:
+    enable: ${CALLBACK_ENABLE}
+    timeout: ${CALLBACK_TIMEOUT}
+    failedContinue: ${CALLBACK_FAILED_CONTINUE}
+  killGroupMember:
+    enable: ${CALLBACK_ENABLE}
+    timeout: ${CALLBACK_TIMEOUT}
+    failedContinue: ${CALLBACK_FAILED_CONTINUE}
+  dismissGroup:
+    enable: ${CALLBACK_ENABLE}
+    timeout: ${CALLBACK_TIMEOUT}
+    failedContinue: ${CALLBACK_FAILED_CONTINUE}
+  joinGroup:
+    enable: ${CALLBACK_ENABLE}
+    timeout: ${CALLBACK_TIMEOUT}
+    failedContinue: ${CALLBACK_FAILED_CONTINUE}
+  groupMsgRead:
+    enable: ${CALLBACK_ENABLE}
+    timeout: ${CALLBACK_TIMEOUT}
+    failedContinue: ${CALLBACK_FAILED_CONTINUE}
+  singleMsgRead:
+    enable: ${CALLBACK_ENABLE}
+    timeout: ${CALLBACK_TIMEOUT}
+    failedContinue: ${CALLBACK_FAILED_CONTINUE}
+  updateUserInfo:
+    enable: ${CALLBACK_ENABLE}
+    timeout: ${CALLBACK_TIMEOUT}
+    failedContinue: ${CALLBACK_FAILED_CONTINUE}
+  beforeUserRegister:
+    enable: ${CALLBACK_ENABLE}
+    timeout: ${CALLBACK_TIMEOUT}
+    failedContinue: ${CALLBACK_FAILED_CONTINUE}
+  afterUserRegister:
+    enable: ${CALLBACK_ENABLE}
+    timeout: ${CALLBACK_TIMEOUT}
+    failedContinue: ${CALLBACK_FAILED_CONTINUE}
+  transferGroupOwner:
+    enable: ${CALLBACK_ENABLE}
+    timeout: ${CALLBACK_TIMEOUT}
+    failedContinue: ${CALLBACK_FAILED_CONTINUE}
+  beforeSetFriendRemark:
+    enable: ${CALLBACK_ENABLE}
+    timeout: ${CALLBACK_TIMEOUT}
+    failedContinue: ${CALLBACK_FAILED_CONTINUE}
+  afterSetFriendRemark:
+    enable: ${CALLBACK_ENABLE}
+    timeout: ${CALLBACK_TIMEOUT}
+    failedContinue: ${CALLBACK_FAILED_CONTINUE}
+  afterGroupMsgRead:
+    enable: ${CALLBACK_ENABLE}
+    timeout: ${CALLBACK_TIMEOUT}
+    failedContinue: ${CALLBACK_FAILED_CONTINUE}
+  afterGroupMsgRevoke:
+    enable: ${CALLBACK_ENABLE}
+    timeout: ${CALLBACK_TIMEOUT}
+    failedContinue: ${CALLBACK_FAILED_CONTINUE}
+  afterJoinGroup:
+    enable: ${CALLBACK_ENABLE}
+    timeout: ${CALLBACK_TIMEOUT}
+    failedContinue: ${CALLBACK_FAILED_CONTINUE}
+  beforeInviteUserToGroup:
+    enable: ${CALLBACK_ENABLE}
+    timeout: ${CALLBACK_TIMEOUT}
+    failedContinue: ${CALLBACK_FAILED_CONTINUE}
+  joinGroupAfter:
+    enable: ${CALLBACK_ENABLE}
+    timeout: ${CALLBACK_TIMEOUT}
+    failedContinue: ${CALLBACK_FAILED_CONTINUE}
+  setGroupInfoAfter:
+    enable: ${CALLBACK_ENABLE}
+    timeout: ${CALLBACK_TIMEOUT}
+    failedContinue: ${CALLBACK_FAILED_CONTINUE}
+  setGroupInfoBefore:
+    enable: ${CALLBACK_ENABLE}
+    timeout: ${CALLBACK_TIMEOUT}
+    failedContinue: ${CALLBACK_FAILED_CONTINUE}
+  revokeMsgAfter:
+    enable: ${CALLBACK_ENABLE}
+    timeout: ${CALLBACK_TIMEOUT}
+    failedContinue: ${CALLBACK_FAILED_CONTINUE}
+  addBlackBefore:
+    enable: ${CALLBACK_ENABLE}
+    timeout: ${CALLBACK_TIMEOUT}
+    failedContinue: ${CALLBACK_FAILED_CONTINUE}
+  addFriendAfter:
+    enable: ${CALLBACK_ENABLE}
+    timeout: ${CALLBACK_TIMEOUT}
+    failedContinue: ${CALLBACK_FAILED_CONTINUE}
+  addFriendAgreeBefore:
+    enable: ${CALLBACK_ENABLE}
+    timeout: ${CALLBACK_TIMEOUT}
+    failedContinue: ${CALLBACK_FAILED_CONTINUE}
+  deleteFriendAfter:
+    enable: ${CALLBACK_ENABLE}
+    timeout: ${CALLBACK_TIMEOUT}
+    failedContinue: ${CALLBACK_FAILED_CONTINUE}
+  importFriendsBefore:
+    enable: ${CALLBACK_ENABLE}
+    timeout: ${CALLBACK_TIMEOUT}
+    failedContinue: ${CALLBACK_FAILED_CONTINUE}
+  importFriendsAfter:
+    enable: ${CALLBACK_ENABLE}
+    timeout: ${CALLBACK_TIMEOUT}
+    failedContinue: ${CALLBACK_FAILED_CONTINUE}
+  removeBlackAfter:
+    enable: ${CALLBACK_ENABLE}
+    timeout: ${CALLBACK_TIMEOUT}
+    failedContinue: ${CALLBACK_FAILED_CONTINUE}
 ###################### Prometheus ######################
 # Prometheus configuration for various services
 # The number of Prometheus ports per service needs to correspond to rpcPort
@@ -395,4 +510,4 @@ prometheus:
   conversationPrometheusPort: [ ${CONVERSATION_PROM_PORT} ]
   rtcPrometheusPort: [ ${RTC_PROM_PORT} ]
   thirdPrometheusPort: [ ${THIRD_PROM_PORT} ]
-  messageTransferPrometheusPort: [ ${MSG_TRANSFER_PROM_PORT} ] # List of ports
+  messageTransferPrometheusPort: [ ${MSG_TRANSFER_PROM_PORT} ] # List of ports

deployments/templates/prometheus.yml

@@ -0,0 +1,85 @@
+# my global config
+global:
+  scrape_interval:     15s # Set the scrape interval to every 15 seconds. Default is every 1 minute.
+  evaluation_interval: 15s # Evaluate rules every 15 seconds. The default is every 1 minute.
+  # scrape_timeout is set to the global default (10s).
+
+# Alertmanager configuration
+alerting:
+  alertmanagers:
+    - static_configs:
+        - targets: ['${ALERT_MANAGER_ADDRESS}:${ALERT_MANAGER_PORT}']
+
+# Load rules once and periodically evaluate them according to the global 'evaluation_interval'.
+rule_files:
+  - "instance-down-rules.yml"
+# - "first_rules.yml"
+# - "second_rules.yml"
+
+# A scrape configuration containing exactly one endpoint to scrape:
+# Here it's Prometheus itself.
+scrape_configs:
+  # The job name is added as a label "job='job_name'"" to any timeseries scraped from this config.
+  # Monitored information captured by prometheus
+  - job_name: 'node-exporter'
+    static_configs:
+      - targets: [ '${NODE_EXPORTER_ADDRESS}:${NODE_EXPORTER_PORT}' ]
+        labels:
+          namespace: 'default'
+
+  # prometheus fetches application services
+  - job_name: 'openimserver-openim-api'
+    static_configs:
+      - targets: [ '${OPENIM_SERVER_ADDRESS}:${API_PROM_PORT}' ]
+        labels:
+          namespace: 'default'
+  - job_name: 'openimserver-openim-msggateway'
+    static_configs:
+      - targets: [ '${OPENIM_SERVER_ADDRESS}:${MSG_GATEWAY_PROM_PORT}' ]
+        labels:
+          namespace: 'default'
+  - job_name: 'openimserver-openim-msgtransfer'
+    static_configs:
+      - targets: [ ${MSG_TRANSFER_PROM_ADDRESS_PORT} ]
+        labels:
+          namespace: 'default'
+  - job_name: 'openimserver-openim-push'
+    static_configs:
+      - targets: [ '${OPENIM_SERVER_ADDRESS}:${PUSH_PROM_PORT}' ]
+        labels:
+          namespace: 'default'
+  - job_name: 'openimserver-openim-rpc-auth'
+    static_configs:
+      - targets: [ '${OPENIM_SERVER_ADDRESS}:${AUTH_PROM_PORT}' ]
+        labels:
+          namespace: 'default'
+  - job_name: 'openimserver-openim-rpc-conversation'
+    static_configs:
+      - targets: [ '${OPENIM_SERVER_ADDRESS}:${CONVERSATION_PROM_PORT}' ]
+        labels:
+          namespace: 'default'
+  - job_name: 'openimserver-openim-rpc-friend'
+    static_configs:
+      - targets: [ '${OPENIM_SERVER_ADDRESS}:${FRIEND_PROM_PORT}' ]
+        labels:
+          namespace: 'default'
+  - job_name: 'openimserver-openim-rpc-group'
+    static_configs:
+      - targets: [ '${OPENIM_SERVER_ADDRESS}:${GROUP_PROM_PORT}' ]
+        labels:
+          namespace: 'default'
+  - job_name: 'openimserver-openim-rpc-msg'
+    static_configs:
+      - targets: [ '${OPENIM_SERVER_ADDRESS}:${MESSAGE_PROM_PORT}' ]
+        labels:
+          namespace: 'default'
+  - job_name: 'openimserver-openim-rpc-third'
+    static_configs:
+      - targets: [ '${OPENIM_SERVER_ADDRESS}:${THIRD_PROM_PORT}' ]
+        labels:
+          namespace: 'default'
+  - job_name: 'openimserver-openim-rpc-user'
+    static_configs:
+      - targets: [ '${OPENIM_SERVER_ADDRESS}:${USER_PROM_PORT}' ]
+        labels:
+          namespace: 'default'

docker-compose.yml

@@ -7,202 +7,181 @@ networks:
     ipam:
       driver: default
       config:
-        - subnet: '${DOCKER_BRIDGE_SUBNET}'
-          gateway: '${DOCKER_BRIDGE_GATEWAY}'
+        - subnet: '${DOCKER_BRIDGE_SUBNET:-172.28.0.0/16}'
+          gateway: '${DOCKER_BRIDGE_GATEWAY:-172.28.0.1}'
 
 services:
-  mysql:
-    image: mysql:5.7
-    ports:
-      - "${MYSQL_PORT}:3306"
-    container_name: mysql
-    volumes:
-      - "${DATA_DIR}/components/mysql/data:/var/lib/mysql"
-      - "/etc/localtime:/etc/localtime"
-    environment:
-      MYSQL_ROOT_PASSWORD: "${MYSQL_PASSWORD}"
-    restart: always
-    networks:
-      server:
-        ipv4_address: ${MYSQL_NETWORK_ADDRESS}
-
   mongodb:
-    image: mongo:6.0.2
+    image: mongo:${MONGODB_IMAGE_VERSION-6.0.2}
     ports:
-      - "${MONGO_PORT}:27017"
+      - "${MONGO_PORT:-37017}:27017"
     container_name: mongo
     command: --wiredTigerCacheSizeGB 1 --auth
     volumes:
-      - "${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"
+      - "${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
-      - MONGO_INITDB_ROOT_USERNAME=${MONGO_USERNAME}
-      - MONGO_INITDB_ROOT_PASSWORD=${MONGO_PASSWORD}
-      - MONGO_INITDB_DATABASE=${MONGO_DATABASE}
+      - MONGO_INITDB_ROOT_USERNAME=${MONGO_USERNAME:-root}
+      - MONGO_INITDB_ROOT_PASSWORD=${MONGO_PASSWORD:-openIM123}
+      - MONGO_INITDB_DATABASE=${MONGO_DATABASE:-openIM_v3}
     restart: always
     networks:
       server:
-        ipv4_address: ${MONGO_NETWORK_ADDRESS}
+        ipv4_address: ${MONGO_NETWORK_ADDRESS:-172.28.0.2}
 
   redis:
-    image: redis:7.0.0
+    image: redis:${REDIS_IMAGE_VERSION:-7.0.0}
     container_name: redis
     ports:
-      - "${REDIS_PORT}:6379"
+      - "${REDIS_PORT:-16379}:6379"
     volumes:
-      - "${DATA_DIR}/components/redis/data:/data"
-      - "${DATA_DIR}/components/redis/config/redis.conf:/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
     sysctls:
       net.core.somaxconn: 1024
-    command: redis-server --requirepass ${REDIS_PASSWORD} --appendonly yes
+    command: redis-server --requirepass ${REDIS_PASSWORD:-openIM123} --appendonly yes
     networks:
       server:
-        ipv4_address: ${REDIS_NETWORK_ADDRESS}
+        ipv4_address: ${REDIS_NETWORK_ADDRESS:-172.28.0.3}
 
   zookeeper:
-   image: bitnami/zookeeper:3.8
-   container_name: zookeeper
-   ports:
-    - "${ZOOKEEPER_PORT}:2181"
-   volumes:
-     - "/etc/localtime:/etc/localtime"
-   environment:
-     - ALLOW_ANONYMOUS_LOGIN=yes
-     - TZ="Asia/Shanghai"
-   restart: always
-   networks:
+    image: bitnami/zookeeper:${ZOOKEEPER_IMAGE_VERSION:-3.8}
+    container_name: zookeeper
+    ports:
+     - "${ZOOKEEPER_PORT:-12181}:2181"
+    volumes:
+      - "/etc/localtime:/etc/localtime"
+    environment:
+      - ALLOW_ANONYMOUS_LOGIN=yes
+      - TZ="Asia/Shanghai"
+    restart: always
+    networks:
       server:
-        ipv4_address: ${ZOOKEEPER_NETWORK_ADDRESS}
+        ipv4_address: ${ZOOKEEPER_NETWORK_ADDRESS:-172.28.0.5}
 
   kafka:
-    image: 'bitnami/kafka:3.5.1'
+    image: 'bitnami/kafka:${KAFKA_IMAGE_VERSION:-3.5.1}'
     container_name: kafka
-    user: root
     restart: always
+    user: ${KAFKA_USER:-root}
     ports:
-    - "${KAFKA_PORT}:9094"
+      - "${KAFKA_PORT:-19094}:9094"
     volumes:
-      - ./scripts/create_topic.sh:/opt/bitnami/kafka/create_topic.sh
-      - ${DATA_DIR}/components/kafka:/bitnami/kafka
+      - ./scripts/create-topic.sh:/opt/bitnami/kafka/create-topic.sh
+      - "${DATA_DIR:-./}/components/kafka:/bitnami/kafka"
     command: >
-      bash -c "
-      /opt/bitnami/scripts/kafka/run.sh & sleep 5; /opt/bitnami/kafka/create_topic.sh; wait
-      "
+      bash -c "/opt/bitnami/scripts/kafka/run.sh & sleep 5; /opt/bitnami/kafka/create-topic.sh; wait"
     environment:
        - TZ=Asia/Shanghai
        - KAFKA_CFG_NODE_ID=0
        - KAFKA_CFG_PROCESS_ROLES=controller,broker
        - KAFKA_CFG_CONTROLLER_QUORUM_VOTERS=0@<your_host>:9093
        - KAFKA_CFG_LISTENERS=PLAINTEXT://:9092,CONTROLLER://:9093,EXTERNAL://:9094
-       - KAFKA_CFG_ADVERTISED_LISTENERS=PLAINTEXT://kafka:9092,EXTERNAL://${DOCKER_BRIDGE_GATEWAY}:${KAFKA_PORT}
+       - KAFKA_CFG_ADVERTISED_LISTENERS=PLAINTEXT://kafka:9092,EXTERNAL://${DOCKER_BRIDGE_GATEWAY:-172.28.0.1}:${KAFKA_PORT:-19094}
        - KAFKA_CFG_LISTENER_SECURITY_PROTOCOL_MAP=CONTROLLER:PLAINTEXT,EXTERNAL:PLAINTEXT,PLAINTEXT:PLAINTEXT
        - KAFKA_CFG_CONTROLLER_LISTENER_NAMES=CONTROLLER
     networks:
       server:
-        ipv4_address: ${KAFKA_NETWORK_ADDRESS}
+        ipv4_address: ${KAFKA_NETWORK_ADDRESS:-172.28.0.4}
 
   minio:
-    image: minio/minio
+    image: minio/minio:${MINIO_IMAGE_VERSION:-latest}
     ports:
-      - "${MINIO_PORT}:9000"
+      - "${MINIO_PORT:-10005}:9000"
       - "9090:9090"
     container_name: minio
     volumes:
-      - "${DATA_DIR}/components/mnt/data:/data"
-      - "${DATA_DIR}/components/mnt/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}"
+      MINIO_ROOT_USER: "${MINIO_ACCESS_KEY:-root}"
+      MINIO_ROOT_PASSWORD: "${MINIO_SECRET_KEY:-openIM123}"
     restart: always
     command: minio server /data --console-address ':9090'
     networks:
       server:
-        ipv4_address: ${MINIO_NETWORK_ADDRESS}
+        ipv4_address: ${MINIO_NETWORK_ADDRESS:-172.28.0.6}
 
   openim-web:
-    # 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
+    image: ${IMAGE_REGISTRY:-ghcr.io/openimsdk}/openim-web:${OPENIM_WEB_IMAGE_VERSION:-latest}
     container_name: openim-web
     environment:
-      - OPENIM_WEB_DIST_PATH=${OPENIM_WEB_DIST_PATH}
-      - OPENIM_WEB_PORT=${OPENIM_WEB_PORT}
+      - OPENIM_WEB_DIST_PATH=${OPENIM_WEB_DIST_PATH:-/app/dist}
+      - OPENIM_WEB_PORT=${OPENIM_WEB_PORT:-11001}
     restart: always
     ports:
-      - "${OPENIM_WEB_PORT}:11001"
+      - "${OPENIM_WEB_PORT:-11001}:11001"
     networks:
       server:
-        ipv4_address: ${OPENIM_WEB_NETWORK_ADDRESS}
+        ipv4_address: ${OPENIM_WEB_NETWORK_ADDRESS:-172.28.0.7}
 
-#   openim-server:
-#     # image: ghcr.io/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:
-#       - ${OPENIM_WS_PORT}:10001
-#       - ${API_OPENIM_PORT}:10002
-#     healthcheck:
-#       test: ["CMD", "/openim/openim-server/scripts/check-all.sh"]
-#       interval: 300s
-#       timeout: 10s
-#       retries: 5
-#     volumes:
-#       - ./logs:/openim/openim-server/logs
-#       - ./_output/logs:/openim/openim-server/_output/logs
-#       - ./config:/openim/openim-server/config
-#       - ./scripts:/openim/openim-server/scripts
-#     restart: always
-#     depends_on:
-#       - kafka
-#       - mysql
-#       - mongodb
-#       - redis
-#       - minio
-#     logging:
-#       driver: json-file
-#       options:
-#         max-size: "1g"
-#         max-file: "2"
-#     networks:
-#       server:
-#         ipv4_address: ${OPENIM_SERVER_NETWORK_ADDRESS}
+  # Uncomment and configure the following services as needed
+  # openim-admin:
+  #   image: ${IMAGE_REGISTRY:-ghcr.io/openimsdk}/openim-admin-front:v3.4.0
+  #   container_name: openim-admin
+  #   restart: always
+  #   ports:
+  #     - "${OPENIM_ADMIN_FRONT_PORT:-11002}:80"
+  #   networks:
+  #     server:
+  #       ipv4_address: ${OPENIM_ADMIN_FRONT_NETWORK_ADDRESS:-172.28.0.13}
 
-#   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
+  #   container_name: prometheus
+  #   hostname: prometheus
+  #   restart: always
+  #   volumes:
+  #     - ./config/prometheus.yml:/etc/prometheus/prometheus.yml
+  #     - ./config/instance-down-rules.yml:/etc/prometheus/instance-down-rules.yml
+  #   ports:
+  #     - "${PROMETHEUS_PORT:-19090}:9090"
+  #   networks:
+  #     server:
+  #       ipv4_address: ${PROMETHEUS_NETWORK_ADDRESS:-172.28.0.10}
 
-#   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}
+  # alertmanager:
+  #   image: prom/alertmanager
+  #   container_name: alertmanager
+  #   hostname: alertmanager
+  #   restart: always
+  #   volumes:
+  #     - ./config/alertmanager.yml:/etc/alertmanager/alertmanager.yml
+  #     - ./config/email.tmpl:/etc/alertmanager/email.tmpl
+  #   ports:
+  #     - "${ALERT_MANAGER_PORT:-19093}:9093"
+  #   networks:
+  #     server:
+  #       ipv4_address: ${ALERT_MANAGER_NETWORK_ADDRESS:-172.28.0.14}
+
+  # grafana:
+  #   image: grafana/grafana
+  #   container_name: grafana
+  #   hostname: grafana
+  #   user: root
+  #   restart: always
+  #   ports:
+  #     - "${GRAFANA_PORT:-13000}:3000"
+  #   volumes:
+  #     - ${DATA_DIR:-./}/components/grafana:/var/lib/grafana
+  #   networks:
+  #     server:
+  #       ipv4_address: ${GRAFANA_NETWORK_ADDRESS:-172.28.0.11}
+
+  # node-exporter:
+  #   image: quay.io/prometheus/node-exporter
+  #   container_name: node-exporter
+  #   hostname: node-exporter
+  #   restart: always
+  #   ports:
+  #     - "${NODE_EXPORTER_PORT:-19100}:9100"
+  #   networks:
+  #     server:
+  #       ipv4_address: ${NODE_EXPORTER_NETWORK_ADDRESS:-172.28.0.12}

docs/CODEOWNERS

@@ -2,28 +2,28 @@
 # Each line is a file pattern followed by one or more owners.
 
 # README files
-README.md @openimsdk/openim @cubxxw @openimsdk/bot @Bloomingg @FGadvancer  @skiffer-git  @wangchuxiao-dev @withchao
+README.md @openimsdk/openim @cubxxw @openimsdk/bot @Bloomingg @FGadvancer  @skiffer-git  @rfyiamcool @withchao
 
 # Contributing guidelines
-CONTRIBUTING.md @cubxxw @openimsdk/bot @Bloomingg @FGadvancer  @skiffer-git  @wangchuxiao-dev @withchao
+CONTRIBUTING.md @cubxxw @openimsdk/bot @Bloomingg @FGadvancer  @skiffer-git  @rfyiamcool @withchao
 
 # License files
-LICENSE    @cubxxw @openimsdk/bot @Bloomingg @FGadvancer  @skiffer-git  @wangchuxiao-dev @withchao
+LICENSE    @cubxxw @openimsdk/bot @Bloomingg @FGadvancer  @skiffer-git  @rfyiamcool @withchao
 
 # Makefile
-Makefile    @cubxxw @openimsdk/bot @Bloomingg @FGadvancer  @skiffer-git  @wangchuxiao-dev @withchao
+Makefile    @cubxxw @openimsdk/bot @Bloomingg @FGadvancer  @skiffer-git  @rfyiamcool @withchao
 
 # These owners will be the default owners for everything in
 # the repo. Unless a later match takes precedence,
 # @cubxxw and @openimsdk/bot will be requested for
 # review when someone opens a pull request.
-* @openimsdk/openim @cubxxw @openimsdk/bot @Bloomingg @FGadvancer  @skiffer-git  @wangchuxiao-dev @withchao
+* @openimsdk/openim @cubxxw @openimsdk/bot @Bloomingg @FGadvancer  @skiffer-git  @rfyiamcool @withchao
 
 # Order is important; the last matching pattern takes the most
 # precedence. When someone opens a pull request that only
 # modifies JS files, only @js-owner and not the global
 # owner(s) will be requested for a review.
-*.js   @cubxxw @openimsdk/bot @Bloomingg @FGadvancer  @skiffer-git  @wangchuxiao-dev @withchao
+*.js   @cubxxw @openimsdk/bot @Bloomingg @FGadvancer  @skiffer-git  @rfyiamcool @withchao
 
 # You can also use email addresses if you prefer. They'll be
 # used to look up users just like we do for commit author
@@ -35,7 +35,7 @@ Makefile    @cubxxw @openimsdk/bot @Bloomingg @FGadvancer  @skiffer-git  @wangch
 # be identified in the format @org/team-name. Teams must have
 # explicit write access to the repository. In this example,
 # the OpenIMSDK team in the github organization owns all .txt files.
-*.txt @cubxxw @openimsdk/bot @Bloomingg @FGadvancer  @skiffer-git  @wangchuxiao-dev @withchao
+*.txt @cubxxw @openimsdk/bot @Bloomingg @FGadvancer  @skiffer-git  @rfyiamcool @withchao
 
 # The `docs/*` pattern will match files like
 # `docs/getting-started.md` but not further nested files like

docs/README.md

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

docs/contrib/README.md

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

docs/contrib/bash-log.md

@@ -11,7 +11,7 @@ OpenIM, an intricate project, requires a robust logging mechanism to diagnose is
 1. **Initialization**: The system begins by determining the verbosity level through the `OPENIM_VERBOSE` variable. If it's not set, a default value of 5 is assigned. This verbosity level dictates the depth of the log details.
 2. **Log File Setup**: Logs are stored in the directory specified by `OPENIM_OUTPUT`. If this variable isn't explicitly set, it defaults to the `_output` directory relative to the script location. Each log file is named based on the date to facilitate easy identification.
 3. **Logging Function**: The `echo_log()` function plays a pivotal role by writing messages to both the console (stdout) and the log file.
-4. **Logging to a file**: The `echo_log()` function writes to the log file by appending the message to the file. It also adds a timestamp to the message. path: `_output/logs/*`, Enable logging by default. Set to false to disable. If you wish to turn off output to log files set `ENABLE_LOGGING=flase`. 
+4. **Logging to a file**: The `echo_log()` function writes to the log file by appending the message to the file. It also adds a timestamp to the message. path: `_output/logs/*`, Enable logging by default. Set to false to disable. If you wish to turn off output to log files set `export ENABLE_LOGGING=flase`. 
 
 ### Key Functions & Their Usages
 

docs/contrib/code-conventions.md

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

docs/contrib/environment.md

@@ -37,6 +37,7 @@
 	* 2.20. [Prometheus Configuration](#PrometheusConfiguration-1)
 		* 2.20.1. [General Configuration](#GeneralConfiguration)
 		* 2.20.2. [Service-Specific Prometheus Ports](#Service-SpecificPrometheusPorts)
+	* 2.21. [Qiniu Cloud Kodo Configuration](#QiniuCloudKODOConfiguration)
 
 ## 0. <a name='TableofContents'></a>OpenIM Config File
 
@@ -136,13 +137,13 @@ For convenience, configuration through modifying environment variables is recomm
   export PASSWORD="openIM123"
   ```
 
-+ USER
++ OPENIM_USER
 
   + **Description**: Username for mysql, mongodb, redis, and minio.
   + **Default**: `root`
 
   ```bash
-  export USER="root"
+  export OPENIM_USER="root"
   ```
 
 + API_URL
@@ -150,7 +151,7 @@ For convenience, configuration through modifying environment variables is recomm
   + **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.
 
-  ```
+  ```bash
   export API_URL="http://ip:10002"
   ```
 
@@ -295,19 +296,6 @@ Feel free to explore the MinIO documentation for more advanced configurations an
 | `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.
@@ -412,7 +400,7 @@ Configuration for Grafana, including its port and address.
 
 | Parameter       | Example Value              | Description           |
 | --------------- | -------------------------- | --------------------- |
-| GRAFANA_PORT    | "3000"                     | Port used by Grafana. |
+| GRAFANA_PORT    | "13000"                     | Port used by Grafana. |
 | GRAFANA_ADDRESS | "${DOCKER_BRIDGE_GATEWAY}" | Address for Grafana.  |
 
 ###  2.16. <a name='RPCPortConfigurationVariables'></a>RPC Port Configuration Variables
@@ -466,7 +454,7 @@ This section involves configuring the log settings, including storage location,
 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                  |
@@ -500,9 +488,9 @@ This section involves setting up additional configuration variables for Websocke
 | TOKEN_EXPIRE            | "90"              | Token Expiry Time                  |
 | FRIEND_VERIFY           | "false"           | Friend Verification Enable         |
 | IOS_PUSH_SOUND          | "xxx"             | iOS                                |
-
-
-
+| CALLBACK_ENABLE         | "false"            | Enable callback                    | 
+| CALLBACK_TIMEOUT        | "5"               | Maximum timeout for callback call  |
+| CALLBACK_FAILED_CONTINUE| "true"            | fails to continue to the next step |
 ###  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.
@@ -528,3 +516,18 @@ This section involves configuring Prometheus, including enabling/disabling it an
 | 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. |
+
+
+###  2.21. <a name='QiniuCloudKODOConfiguration'></a>Qiniu Cloud Kodo Configuration
+
+This section involves setting up Qiniu Cloud Kodo, including its endpoint, bucket name, and credentials.
+
+| Parameter             | Example Value                                                | Description                              |
+| --------------------- | ------------------------------------------------------------ | ---------------------------------------- |
+| KODO_ENDPOINT          | "[http://s3.cn-east-1.qiniucs.com](http://s3.cn-east-1.qiniucs.com)" | Endpoint URL for Qiniu Cloud Kodo.      |
+| KODO_BUCKET            | "demo-9999999"                                               | Bucket name for Qiniu Cloud Kodo.       |
+| KODO_BUCKET_URL        | "[http://your.domain.com](http://your.domain.com)" | Bucket URL for Qiniu Cloud Kodo.        |
+| KODO_ACCESS_KEY_ID     | [User Defined]                                               | Access key ID for Qiniu Cloud Kodo.     |
+| KODO_ACCESS_KEY_SECRET | [User Defined]                                               | Access key secret for Qiniu Cloud Kodo. |
+| KODO_SESSION_TOKEN     | [User Defined]                                               | Session token for Qiniu Cloud Kodo.     |
+| KODO_PUBLIC_READ       | "false"                                                      | Public read access.                      |

docs/contrib/github-workflow.md

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

docs/contrib/go-code.md

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

docs/contrib/offline-deployment.md

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

docs/contrib/prometheus-grafana.md

@@ -0,0 +1,323 @@
+# Deployment and Design of OpenIM's Management Backend and Monitoring
+
+<!-- vscode-markdown-toc -->
+* 1. [Source Code & Docker](#SourceCodeDocker)
+	* 1.1. [Deployment](#Deployment)
+	* 1.2. [Configuration](#Configuration)
+	* 1.3. [Monitoring Running in Docker Guide](#MonitoringRunninginDockerGuide)
+		* 1.3.1. [Introduction](#Introduction)
+		* 1.3.2. [Prerequisites](#Prerequisites)
+		* 1.3.3. [Step 1: Clone the Repository](#Step1:ClonetheRepository)
+		* 1.3.4. [Step 2: Start Docker Compose](#Step2:StartDockerCompose)
+		* 1.3.5. [Step 3: Use the OpenIM Web Interface](#Step3:UsetheOpenIMWebInterface)
+		* 1.3.6. [Running Effect](#RunningEffect)
+		* 1.3.7. [Step 4: Access the Admin Panel](#Step4:AccesstheAdminPanel)
+		* 1.3.8. [Step 5: Access the Monitoring Interface](#Step5:AccesstheMonitoringInterface)
+		* 1.3.9. [Next Steps](#NextSteps)
+		* 1.3.10. [Troubleshooting](#Troubleshooting)
+* 2. [Kubernetes](#Kubernetes)
+	* 2.1. [Middleware Monitoring](#MiddlewareMonitoring)
+	* 2.2. [Custom OpenIM Metrics](#CustomOpenIMMetrics)
+	* 2.3. [Node Exporter](#NodeExporter)
+* 3. [Setting Up and Configuring AlertManager Using Environment Variables and `make init`](#SettingUpandConfiguringAlertManagerUsingEnvironmentVariablesandmakeinit)
+	* 3.1. [Introduction](#Introduction-1)
+	* 3.2. [Prerequisites](#Prerequisites-1)
+	* 3.3. [Configuration Steps](#ConfigurationSteps)
+		* 3.3.1. [Exporting Environment Variables](#ExportingEnvironmentVariables)
+		* 3.3.2. [Initializing AlertManager](#InitializingAlertManager)
+		* 3.3.3. [Key Configuration Fields](#KeyConfigurationFields)
+		* 3.3.4. [Configuring SMTP Authentication Password](#ConfiguringSMTPAuthenticationPassword)
+		* 3.3.5. [Useful Links for Common Email Servers](#UsefulLinksforCommonEmailServers)
+	* 3.4. [Conclusion](#Conclusion)
+
+<!-- vscode-markdown-toc-config
+	numbering=true
+	autoSave=true
+	/vscode-markdown-toc-config -->
+<!-- /vscode-markdown-toc -->
+
+OpenIM offers various flexible deployment options to suit different environments and requirements. Here is a simplified and optimized description of these deployment options:
+
+1. Source Code Deployment:
+   + **Regular Source Code Deployment**: Deployment using the `nohup` method. This is a basic deployment method suitable for development and testing environments. For details, refer to the [Regular Source Code Deployment Guide](https://docs.openim.io/).
+   + **Production-Level Deployment**: Deployment using the `system` method, more suitable for production environments. This method provides higher stability and reliability. For details, refer to the [Production-Level Deployment Guide](https://docs.openim.io/guides/gettingStarted/install-openim-linux-system).
+2. Cluster Deployment:
+   + **Kubernetes Deployment**: Provides two deployment methods, including deployment through Helm and sealos. This is suitable for environments that require high availability and scalability. Specific methods can be found in the [Kubernetes Deployment Guide](https://docs.openim.io/guides/gettingStarted/k8s-deployment).
+3. Docker Deployment:
+   + **Regular Docker Deployment**: Suitable for quick deployments and small projects. For detailed information, refer to the [Docker Deployment Guide](https://docs.openim.io/guides/gettingStarted/dockerCompose).
+   + **Docker Compose Deployment**: Provides more convenient service management and configuration, suitable for complex multi-container applications.
+
+Next, we will introduce the specific steps, monitoring, and management backend configuration for each of these deployment methods, as well as usage tips to help you choose the most suitable deployment option according to your needs.
+
+##  1. <a name='SourceCodeDocker'></a>Source Code & Docker
+
+###  1.1. <a name='Deployment'></a>Deployment
+
+OpenIM deploys openim-server and openim-chat from source code, while other components are deployed via Docker.
+
+For Docker deployment, you can deploy all components with a single command using the [openimsdk/openim-docker](https://github.com/openimsdk/openim-docker) repository. The deployment configuration can be found in the [environment.sh](https://github.com/openimsdk/open-im-server/blob/main/scripts/install/environment.sh) document, which provides information on how to learn and familiarize yourself with various environment variables.
+
+For Prometheus, it is not enabled by default. To enable it, set the environment variable before executing `make init`:
+
+```bash
+export PROMETHEUS_ENABLE=true   # Default is false
+```
+
+Then, execute:
+
+```bash
+make init
+docker compose up -d
+```
+
+###  1.2. <a name='Configuration'></a>Configuration
+
+To configure Prometheus data sources in Grafana, follow these steps:
+
+1. **Log in to Grafana**: First, open your web browser and access the Grafana URL. If you haven't changed the port, the address is typically [http://localhost:13000](http://localhost:13000/).
+
+2. **Log in with default credentials**: Grafana's default username and password are both `admin`. You will be prompted to change the password on your first login.
+
+3. **Access Data Sources Settings**:
+
+   + In the left menu of Grafana, look for and click the "gear" icon representing "Configuration."
+   + In the configuration menu, select "Data Sources."
+
+4. **Add a New Data Source**:
+
+   + On the Data Sources page, click the "Add data source" button.
+   + In the list, find and select "Prometheus."
+
+   ![image-20231114175117374](http://sm.nsddd.top/sm202311141751692.png)
+
+   Click `Add New connection` to add more data sources, such as Loki (responsible for log storage and query processing).
+
+5. **Configure the Prometheus Data Source**:
+
+   + On the configuration page, fill in the details of the Prometheus server. This typically includes the URL of the Prometheus service (e.g., if Prometheus is running on the same machine as OpenIM, the URL might be `http://172.28.0.1:19090`, with the address matching the `DOCKER_BRIDGE_GATEWAY` variable address). OpenIM and the components are linked via a gateway. The default port used by OpenIM is `19090`.
+   + Adjust other settings as needed, such as authentication and TLS settings.
+
+   ![image-20231114180351923](http://sm.nsddd.top/sm202311141803076.png)
+
+6. **Save and Test**:
+
+   + After completing the configuration, click the "Save & Test" button to ensure that Grafana can successfully connect to Prometheus.
+
+**Importing Dashboards in Grafana**
+
+Importing Grafana Dashboards is a straightforward process and is applicable to OpenIM Server application services and Node Exporter. Here are detailed steps and necessary considerations:
+
+**Key Metrics Overview and Deployment Steps**
+
+To monitor OpenIM in Grafana, you need to focus on three categories of key metrics, each with its specific deployment and configuration steps:
+
+1. **OpenIM Metrics (`prometheus-dashboard.yaml`)**:
+   + **Configuration File Path**: Located at `config/prometheus-dashboard.yaml`.
+   + **Enabling Monitoring**: Set the environment variable `export PROMETHEUS_ENABLE=true` to enable Prometheus monitoring.
+   + **More Information**: Refer to the [OpenIM Configuration Guide](https://docs.openim.io/configurations/prometheus-integration).
+2. **Node Exporter**:
+   + **Container Deployment**: Deploy the `quay.io/prometheus/node-exporter` container for node monitoring.
+   + **Get Dashboard**: Access the [Node Exporter Full Feature Dashboard](https://grafana.com/grafana/dashboards/1860-node-exporter-full/) and import it using YAML file download or ID import.
+   + **Deployment Guide**: Refer to the [Node Exporter Deployment Documentation](https://prometheus.io/docs/guides/node-exporter/).
+3. **Middleware Metrics**: Each middleware requires specific steps and configurations to enable monitoring. Here is a list of common middleware and links to their respective setup guides:
+   + MySQL:
+     + **Configuration**: Ensure MySQL has performance monitoring enabled.
+     + **Link**: Refer to the [MySQL Monitoring Configuration Guide](https://grafana.com/docs/grafana/latest/datasources/mysql/).
+   + Redis:
+     + **Configuration**: Configure Redis to allow monitoring data export.
+     + **Link**: Refer to the [Redis Monitoring Guide](https://grafana.com/docs/grafana/latest/datasources/redis/).
+   + MongoDB:
+     + **Configuration**: Set up monitoring metrics for MongoDB.
+     + **Link**: Refer to the [MongoDB Monitoring Guide](https://grafana.com/grafana/plugins/grafana-mongodb-datasource/).
+   + Kafka:
+     + **Configuration**: Integrate Kafka with Prometheus monitoring.
+     + **Link**: Refer to the [Kafka Monitoring Guide](https://grafana.com/grafana/plugins/grafana-kafka-datasource/).
+   + Zookeeper:
+     + **Configuration**: Ensure Zookeeper can be monitored by Prometheus.
+     + **Link**: Refer to the [Zookeeper Monitoring Configuration](https://grafana.com/docs/grafana/latest/datasources/zookeeper/).
+
+
+
+**Importing Steps**:
+
+1. Access the Dashboard Import Interface:
+
+   + Click the `+` icon on the left menu or in the top right corner of Grafana, then select "Create."
+   + Choose "Import" to access the dashboard import interface.
+
+2. **Perform Dashboard Import**:
+   + **Upload via File**: Directly upload your YAML file.
+   + **Paste Content**: Open the YAML file, copy its content, and paste it into the import interface.
+   + **Import via Grafana.com Dashboard**: Visit [Grafana Dashboards](https://grafana.com/grafana/dashboards/), search for the desired dashboard, and import it using its ID.
+3. **Configure the Dashboard**:
+   + Select the appropriate data source, such as the previously configured Prometheus.
+   + Adjust other settings, such as the dashboard name or folder.
+4. **Save and View the Dashboard**:
+   + After configuring, click "Import" to complete the process.
+   + Immediately view the new dashboard after successful import.
+
+**Graph Examples:**
+
+![image-20231114194451673](http://sm.nsddd.top/sm202311141944953.png)
+
+
+
+###  1.3. <a name='MonitoringRunninginDockerGuide'></a>Monitoring Running in Docker Guide
+
+####  1.3.1. <a name='Introduction'></a>Introduction
+
+This guide provides the steps to run OpenIM using Docker. OpenIM is an open-source instant messaging solution that can be quickly deployed using Docker. For more information, please refer to the [OpenIM Docker GitHub](https://github.com/openimsdk/openim-docker).
+
+####  1.3.2. <a name='Prerequisites'></a>Prerequisites
+
++ Ensure that Docker and Docker Compose are installed.
++ Basic understanding of Docker and containerization technology.
+
+####  1.3.3. <a name='Step1:ClonetheRepository'></a>Step 1: Clone the Repository
+
+First, clone the OpenIM Docker repository:
+
+```bash
+git clone https://github.com/openimsdk/openim-docker.git
+```
+
+Navigate to the repository directory and check the `README` file for more information and configuration options.
+
+####  1.3.4. <a name='Step2:StartDockerCompose'></a>Step 2: Start Docker Compose
+
+In the repository directory, run the following command to start the service:
+
+```bash
+docker-compose up -d
+```
+
+This will download the required Docker images and start the OpenIM service.
+
+####  1.3.5. <a name='Step3:UsetheOpenIMWebInterface'></a>Step 3: Use the OpenIM Web Interface
+
++ Open a browser in private mode and access [OpenIM Web](http://localhost:11001/).
++ Register two users and try adding friends.
++ Test sending messages and pictures.
+
+####  1.3.6. <a name='RunningEffect'></a>Running Effect
+
+![image-20231115100811208](http://sm.nsddd.top/sm202311151008639.png)
+
+####  1.3.7. <a name='Step4:AccesstheAdminPanel'></a>Step 4: Access the Admin Panel
+
++ Access the [OpenIM Admin Panel](http://localhost:11002/).
++ Log in using the default username and password (`admin1:admin1`).
+
+Running Effect Image:
+
+![image-20231115101039837](http://sm.nsddd.top/sm202311151010116.png)
+
+####  1.3.8. <a name='Step5:AccesstheMonitoringInterface'></a>Step 5: Access the Monitoring Interface
+
++ Log in to the [Monitoring Interface](http://localhost:3000/login) using the credentials (`admin:admin`).
+
+####  1.3.9. <a name='NextSteps'></a>Next Steps
+
++ Configure and manage the services following the steps provided in the OpenIM source code.
++ Refer to the `README` file for advanced configuration and management.
+
+####  1.3.10. <a name='Troubleshooting'></a>Troubleshooting
+
++ If you encounter any issues, please check the documentation on [OpenIM Docker GitHub](https://github.com/openimsdk/openim-docker) or search for related issues in the Issues section.
++ If the problem persists, you can create an issue on the [openim-docker](https://github.com/openimsdk/openim-docker/issues/new/choose) repository or the [openim-server](https://github.com/openimsdk/open-im-server/issues/new/choose) repository.
+
+
+
+##  2. <a name='Kubernetes'></a>Kubernetes
+
+Refer to [openimsdk/helm-charts](https://github.com/openimsdk/helm-charts).
+
+When deploying and monitoring OpenIM in a Kubernetes environment, you will focus on three main metrics: middleware, custom OpenIM metrics, and Node Exporter. Here are detailed steps and guidelines:
+
+###  2.1. <a name='MiddlewareMonitoring'></a>Middleware Monitoring
+
+Middleware monitoring is crucial to ensure the overall system's stability. Typically, this includes monitoring the following components:
+
++ **MySQL**: Monitor database performance, query latency, and more.
++ **Redis**: Track operation latency, memory usage, and more.
++ **MongoDB**: Observe database operations, resource usage, and more.
++ **Kafka**: Monitor message throughput, latency, and more.
++ **Zookeeper**: Keep an eye on cluster status, performance metrics, and more.
+
+For Kubernetes environments, you can use the corresponding Prometheus Exporters to collect monitoring data for these middleware components.
+
+###  2.2. <a name='CustomOpenIMMetrics'></a>Custom OpenIM Metrics
+
+Custom OpenIM metrics provide essential information about the OpenIM application itself, such as user activity, message traffic, system performance, and more. To monitor these metrics in Kubernetes:
+
++ Ensure OpenIM application configurations expose Prometheus metrics.
++ When deploying using Helm charts (refer to [OpenIM Helm Charts](https://github.com/openimsdk/helm-charts)), pay attention to configuring relevant monitoring settings.
+
+###  2.3. <a name='NodeExporter'></a>Node Exporter
+
+Node Exporter is used to collect hardware and operating system-level metrics for Kubernetes nodes, such as CPU, memory, disk usage, and more. To integrate Node Exporter in Kubernetes:
+
++ Deploy Node Exporter using the appropriate Helm chart. You can find information and guides on [Prometheus Community](https://prometheus.io/docs/guides/node-exporter/).
++ Ensure Node Exporter's data is collected by Prometheus instances within your cluster.
+
+
+
+##  3. <a name='SettingUpandConfiguringAlertManagerUsingEnvironmentVariablesandmakeinit'></a>Setting Up and Configuring AlertManager Using Environment Variables and `make init`
+
+###  3.1. <a name='Introduction-1'></a>Introduction
+
+AlertManager, a component of the Prometheus monitoring system, handles alerts sent by client applications such as the Prometheus server. It takes care of deduplicating, grouping, and routing them to the correct receiver. This document outlines how to set up and configure AlertManager using environment variables and the `make init` command. We will focus on configuring key fields like the sender's email, SMTP settings, and SMTP authentication password.
+
+###  3.2. <a name='Prerequisites-1'></a>Prerequisites
+
++ Basic knowledge of terminal and command-line operations.
++ AlertManager installed on your system.
++ Access to an SMTP server for sending emails.
+
+###  3.3. <a name='ConfigurationSteps'></a>Configuration Steps
+
+####  3.3.1. <a name='ExportingEnvironmentVariables'></a>Exporting Environment Variables
+
+Before initializing AlertManager, you need to set environment variables. These variables are used to configure the AlertManager settings without altering the code. Use the `export` command in your terminal. Here are some key variables you might set:
+
++ `export ALERTMANAGER_RESOLVE_TIMEOUT='5m'`
++ `export ALERTMANAGER_SMTP_FROM='alert@example.com'`
++ `export ALERTMANAGER_SMTP_SMARTHOST='smtp.example.com:465'`
++ `export ALERTMANAGER_SMTP_AUTH_USERNAME='alert@example.com'`
++ `export ALERTMANAGER_SMTP_AUTH_PASSWORD='your_password'`
++ `export ALERTMANAGER_SMTP_REQUIRE_TLS='false'`
+
+####  3.3.2. <a name='InitializingAlertManager'></a>Initializing AlertManager
+
+After setting the necessary environment variables, you can initialize AlertManager by running the `make init` command. This command typically runs a script that prepares AlertManager with the provided configuration.
+
+####  3.3.3. <a name='KeyConfigurationFields'></a>Key Configuration Fields
+
+##### a. Sender's Email (`ALERTMANAGER_SMTP_FROM`)
+
+This variable sets the email address that will appear as the sender in the notifications sent by AlertManager.
+
+##### b. SMTP Configuration
+
++ **SMTP Server (`ALERTMANAGER_SMTP_SMARTHOST`):** Specifies the address and port of the SMTP server used for sending emails.
++ **SMTP Authentication Username (`ALERTMANAGER_SMTP_AUTH_USERNAME`):** The username for authenticating with the SMTP server.
++ **SMTP Authentication Password (`ALERTMANAGER_SMTP_AUTH_PASSWORD`):** The password for SMTP server authentication. It's crucial to keep this value secure.
+
+####  3.3.4. <a name='ConfiguringSMTPAuthenticationPassword'></a>Configuring SMTP Authentication Password
+
+The SMTP authentication password can be set using the `ALERTMANAGER_SMTP_AUTH_PASSWORD` environment variable. It's recommended to use a secure method to set this variable to avoid exposing sensitive information. For instance, you might read the password from a secure file or a secret management tool.
+
+####  3.3.5. <a name='UsefulLinksforCommonEmailServers'></a>Useful Links for Common Email Servers
+
+For specific configurations related to common email servers, you may refer to their respective documentation:
+
++ Gmail SMTP Settings:
+  + [Gmail SMTP Configuration](https://support.google.com/mail/answer/7126229?hl=en)
++ Microsoft Outlook SMTP Settings:
+  + [Outlook Email Settings](https://support.microsoft.com/en-us/office/pop-imap-and-smtp-settings-8361e398-8af4-4e97-b147-6c6c4ac95353)
++ Yahoo Mail SMTP Settings:
+  + [Yahoo SMTP Configuration](https://help.yahoo.com/kb/SLN4724.html)
+
+###  3.4. <a name='Conclusion'></a>Conclusion
+
+Setting up and configuring AlertManager with environment variables provides a flexible and secure way to manage alert settings. By following the above steps, you can easily configure AlertManager for your monitoring needs. Always ensure to secure sensitive information, especially when dealing with SMTP authentication credentials.

docs/contrib/test.md

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

docs/contrib/util-makefile.md

@@ -30,7 +30,7 @@ Executing `make tools` ensures verification and installation of the default tool
 - go-junit-report
 - go-gitlint
 
-The installation path is situated at `/root/workspaces/openim/Open-IM-Server/_output/tools/`.
+The installation path is situated at `./_output/tools/`.
 
 ## Toolset Categories
 

docs/contrib/version.md

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

docs/conversions/README.md

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

go.mod

@@ -4,16 +4,16 @@ go 1.19
 
 require (
 	firebase.google.com/go v3.13.0+incompatible
+	github.com/OpenIMSDK/protocol v0.0.31
+	github.com/OpenIMSDK/tools v0.0.20
 	github.com/bwmarrin/snowflake v0.3.0 // indirect
 	github.com/dtm-labs/rockscache v0.1.1
 	github.com/gin-gonic/gin v1.9.1
 	github.com/go-playground/validator/v10 v10.15.5
 	github.com/gogo/protobuf v1.3.2
 	github.com/golang-jwt/jwt/v4 v4.5.0
-	github.com/golang/protobuf v1.5.3
 	github.com/gorilla/websocket v1.5.0
 	github.com/grpc-ecosystem/go-grpc-prometheus v1.2.0
-	github.com/jinzhu/copier v0.4.0
 	github.com/lestrrat-go/file-rotatelogs v2.4.0+incompatible // indirect
 	github.com/minio/minio-go/v7 v7.0.63
 	github.com/mitchellh/mapstructure v1.5.0
@@ -29,22 +29,20 @@ require (
 	google.golang.org/grpc v1.59.0
 	google.golang.org/protobuf v1.31.0
 	gopkg.in/yaml.v3 v3.0.1
-	gorm.io/driver/mysql v1.5.2
-	gorm.io/gorm v1.25.5
 )
 
 require github.com/google/uuid v1.3.1
 
 require (
 	github.com/IBM/sarama v1.41.3
-	github.com/OpenIMSDK/protocol v0.0.31
-	github.com/OpenIMSDK/tools v0.0.16
 	github.com/aliyun/aliyun-oss-go-sdk v2.2.9+incompatible
 	github.com/go-redis/redis v6.15.9+incompatible
-	github.com/go-sql-driver/mysql v1.7.1
 	github.com/redis/go-redis/v9 v9.2.1
 	github.com/tencentyun/cos-go-sdk-v5 v0.7.45
+	go.uber.org/automaxprocs v1.5.3
+	golang.org/x/sync v0.4.0
 	gopkg.in/src-d/go-git.v4 v4.13.1
+	gotest.tools v2.2.0+incompatible
 )
 
 require (
@@ -72,7 +70,9 @@ require (
 	github.com/go-playground/universal-translator v0.18.1 // indirect
 	github.com/go-zookeeper/zk v1.0.3 // indirect
 	github.com/golang/groupcache v0.0.0-20210331224755-41bb18bfe9da // indirect
+	github.com/golang/protobuf v1.5.3 // indirect
 	github.com/golang/snappy v0.0.4 // indirect
+	github.com/google/go-cmp v0.6.0 // indirect
 	github.com/google/go-querystring v1.1.0 // indirect
 	github.com/google/s2a-go v0.1.7 // indirect
 	github.com/googleapis/enterprise-certificate-proxy v0.3.1 // indirect
@@ -87,6 +87,7 @@ require (
 	github.com/jcmturner/gofork v1.7.6 // indirect
 	github.com/jcmturner/gokrb5/v8 v8.4.4 // indirect
 	github.com/jcmturner/rpc/v2 v2.0.3 // indirect
+	github.com/jinzhu/copier v0.3.5 // indirect
 	github.com/jinzhu/inflection v1.0.0 // indirect
 	github.com/jinzhu/now v1.1.5 // indirect
 	github.com/json-iterator/go v1.1.12 // indirect
@@ -116,6 +117,7 @@ require (
 	github.com/sergi/go-diff v1.0.0 // indirect
 	github.com/spf13/pflag v1.0.5 // indirect
 	github.com/src-d/gcfg v1.4.0 // indirect
+	github.com/stretchr/objx v0.5.0 // indirect
 	github.com/twitchyliquid64/golang-asm v0.15.1 // indirect
 	github.com/xanzy/ssh-agent v0.2.1 // indirect
 	github.com/xdg-go/pbkdf2 v1.0.0 // indirect
@@ -128,8 +130,7 @@ require (
 	golang.org/x/arch v0.3.0 // indirect
 	golang.org/x/net v0.17.0 // indirect
 	golang.org/x/oauth2 v0.13.0 // indirect
-	golang.org/x/sync v0.4.0 // indirect
-	golang.org/x/sys v0.13.0 // indirect
+	golang.org/x/sys v0.14.0 // indirect
 	golang.org/x/text v0.13.0 // indirect
 	golang.org/x/time v0.3.0 // indirect
 	golang.org/x/xerrors v0.0.0-20220907171357-04be3eba64a2 // indirect
@@ -139,6 +140,7 @@ require (
 	google.golang.org/genproto/googleapis/rpc v0.0.0-20231012201019-e917dd12ba7a // indirect
 	gopkg.in/src-d/go-billy.v4 v4.3.2 // indirect
 	gopkg.in/warnings.v0 v0.1.2 // indirect
+	gorm.io/gorm v1.23.8 // indirect
 )
 
 require (

go.sum

@@ -20,8 +20,8 @@ github.com/IBM/sarama v1.41.3 h1:MWBEJ12vHC8coMjdEXFq/6ftO6DUZnQlFYcxtOJFa7c=
 github.com/IBM/sarama v1.41.3/go.mod h1:Xxho9HkHd4K/MDUo/T/sOqwtX/17D33++E9Wib6hUdQ=
 github.com/OpenIMSDK/protocol v0.0.31 h1:ax43x9aqA6EKNXNukS5MT5BSTqkUmwO4uTvbJLtzCgE=
 github.com/OpenIMSDK/protocol v0.0.31/go.mod h1:F25dFrwrIx3lkNoiuf6FkCfxuwf8L4Z8UIsdTHP/r0Y=
-github.com/OpenIMSDK/tools v0.0.16 h1:te/GIq2imCMsrRPgU9OObYKbzZ3rT08Lih/o+3QFIz0=
-github.com/OpenIMSDK/tools v0.0.16/go.mod h1:eg+q4A34Qmu73xkY0mt37FHGMCMfC6CtmOnm0kFEGFI=
+github.com/OpenIMSDK/tools v0.0.20 h1:zBTjQZRJ5lR1FIzP9mtWyAvh5dKsmJXQugi4p8X/97k=
+github.com/OpenIMSDK/tools v0.0.20/go.mod h1:eg+q4A34Qmu73xkY0mt37FHGMCMfC6CtmOnm0kFEGFI=
 github.com/QcloudApi/qcloud_sign_golang v0.0.0-20141224014652-e4130a326409/go.mod h1:1pk82RBxDY/JZnPQrtqHlUFfCctgdorsd9M06fMynOM=
 github.com/alcortesm/tgz v0.0.0-20161220082320-9c5fe88206d7 h1:uSoVVbwJiQipAclBbw+8quDsfcvFjOpI5iCf4p/cqCs=
 github.com/alcortesm/tgz v0.0.0-20161220082320-9c5fe88206d7/go.mod h1:6zEj6s6u/ghQa61ZWa/C2Aw3RkjiTBOix7dkqa1VLIs=
@@ -100,9 +100,6 @@ github.com/go-playground/validator/v10 v10.15.5 h1:LEBecTWb/1j5TNY1YYG2RcOUN3R7N
 github.com/go-playground/validator/v10 v10.15.5/go.mod h1:9iXMNT7sEkjXb0I+enO7QXmzG6QCsPWY4zveKFVRSyU=
 github.com/go-redis/redis v6.15.9+incompatible h1:K0pv1D7EQUjfyoMql+r/jZqCLizCGKFlFgcHWWmHQjg=
 github.com/go-redis/redis v6.15.9+incompatible/go.mod h1:NAIEuMOZ/fxfXJIrKDQDz8wamY7mA7PouImQ2Jvg6kA=
-github.com/go-sql-driver/mysql v1.7.0/go.mod h1:OXbVy3sEdcQ2Doequ6Z5BW6fXNQTmx+9S1MCJN5yJMI=
-github.com/go-sql-driver/mysql v1.7.1 h1:lUIinVbN1DY0xBg0eMOzmmtGoHwWBbvnWubQUrtU8EI=
-github.com/go-sql-driver/mysql v1.7.1/go.mod h1:OXbVy3sEdcQ2Doequ6Z5BW6fXNQTmx+9S1MCJN5yJMI=
 github.com/go-task/slim-sprig v0.0.0-20210107165309-348f09dbbbc0/go.mod h1:fyg7847qk6SyHyPtNmDHnmrv/HOrqktSC+C9fM+CJOE=
 github.com/go-zookeeper/zk v1.0.3 h1:7M2kwOsc//9VeeFiPtf+uSJlVpU66x9Ba5+8XK7/TDg=
 github.com/go-zookeeper/zk v1.0.3/go.mod h1:nOB03cncLtlp4t+UAkGSV+9beXP/akpekBwL+UX1Qcw=
@@ -144,6 +141,7 @@ github.com/google/go-cmp v0.5.2/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/
 github.com/google/go-cmp v0.5.3/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
 github.com/google/go-cmp v0.5.5/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
 github.com/google/go-cmp v0.6.0 h1:ofyhxvXcZhMsU5ulbFiLKl/XBFqE1GSq7atu8tAmTRI=
+github.com/google/go-cmp v0.6.0/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY=
 github.com/google/go-querystring v1.0.0/go.mod h1:odCYkC5MyYFN7vkCjXpyrEuKhc/BUO6wN/zVPAxq5ck=
 github.com/google/go-querystring v1.1.0 h1:AnCroh3fv4ZBgVIf1Iwtovgjaw/GiKJo8M8yD/fhyJ8=
 github.com/google/go-querystring v1.1.0/go.mod h1:Kcdr2DB4koayq7X8pmAG4sNG59So17icRSOU623lUBU=
@@ -192,10 +190,11 @@ github.com/jcmturner/gokrb5/v8 v8.4.4/go.mod h1:1btQEpgT6k+unzCwX1KdWMEwPPkkgBtP
 github.com/jcmturner/rpc/v2 v2.0.3 h1:7FXXj8Ti1IaVFpSAziCZWNzbNuZmnvw/i6CqLNdWfZY=
 github.com/jcmturner/rpc/v2 v2.0.3/go.mod h1:VUJYCIDm3PVOEHw8sgt091/20OJjskO/YJki3ELg/Hc=
 github.com/jessevdk/go-flags v1.4.0/go.mod h1:4FA24M0QyGHXBuZZK/XkWh8h0e1EYbRYJSGM75WSRxI=
-github.com/jinzhu/copier v0.4.0 h1:w3ciUoD19shMCRargcpm0cm91ytaBhDvuRpz1ODO/U8=
-github.com/jinzhu/copier v0.4.0/go.mod h1:DfbEm0FYsaqBcKcFuvmOZb218JkPGtvSHsKg8S8hyyg=
+github.com/jinzhu/copier v0.3.5 h1:GlvfUwHk62RokgqVNvYsku0TATCF7bAHVwEXoBh3iJg=
+github.com/jinzhu/copier v0.3.5/go.mod h1:DfbEm0FYsaqBcKcFuvmOZb218JkPGtvSHsKg8S8hyyg=
 github.com/jinzhu/inflection v1.0.0 h1:K317FqzuhWc8YvSVlFMCCUb36O/S9MCKRDI7QkRKD/E=
 github.com/jinzhu/inflection v1.0.0/go.mod h1:h+uFLlag+Qp1Va5pdKtLDYj+kHp5pxUVkryuEj+Srlc=
+github.com/jinzhu/now v1.1.4/go.mod h1:d3SSVoowX0Lcu0IBviAWJpolVfI5UJVZZ7cO71lE/z8=
 github.com/jinzhu/now v1.1.5 h1:/o9tlHleP7gOFmsnYNz3RGnqzefHA47wQpKrrdTIwXQ=
 github.com/jinzhu/now v1.1.5/go.mod h1:d3SSVoowX0Lcu0IBviAWJpolVfI5UJVZZ7cO71lE/z8=
 github.com/jonboulle/clockwork v0.4.0 h1:p4Cf1aMWXnXAUh8lVfewRBx1zaTSYKrKMF2g3ST4RZ4=
@@ -279,6 +278,7 @@ github.com/pkg/errors v0.9.1 h1:FEBLx1zS214owpjy7qsBeixbURkuhQAwrK5UwLGTwt4=
 github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0=
 github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
+github.com/prashantv/gostub v1.1.0 h1:BTyx3RfQjRHnUWaGF9oQos79AlQ5k8WNktv7VGvVH4g=
 github.com/prometheus/client_golang v1.17.0 h1:rl2sfwZMtSthVU752MqfjQozy7blglC+1SOtjMAMh+Q=
 github.com/prometheus/client_golang v1.17.0/go.mod h1:VeL+gMmOAxkS2IqfCq0ZmHSL+LjWfWDUmp1mBz9JgUY=
 github.com/prometheus/client_model v0.0.0-20190812154241-14fe0d1b01d4/go.mod h1:xMI15A0UPsDsEKsMN9yxemIoYk6Tm2C1GtYGdfGttqA=
@@ -311,6 +311,7 @@ github.com/src-d/gcfg v1.4.0/go.mod h1:p/UMsR43ujA89BJY9duynAwIpvqEujIH/jFlfL7jW
 github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
 github.com/stretchr/objx v0.2.0/go.mod h1:qt09Ya8vawLte6SNmTgCsAVtYtaKzEcn8ATUoHMkEqE=
 github.com/stretchr/objx v0.4.0/go.mod h1:YvHI0jy2hoMjB+UWwv71VJQ9isScKT/TqJzVSSt89Yw=
+github.com/stretchr/objx v0.5.0 h1:1zr/of2m5FGMsad5YfcqgdqdWrIhu+EBEJRhR1U7z/c=
 github.com/stretchr/objx v0.5.0/go.mod h1:Yh+to48EsGEfYuaHDzXPcE3xhTkx73EhmCGUpEOglKo=
 github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI=
 github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81PSLYec5m4=
@@ -350,6 +351,8 @@ go.opencensus.io v0.24.0 h1:y73uSU6J157QMP2kn2r30vwW1A2W2WFwSCGnAVxeaD0=
 go.opencensus.io v0.24.0/go.mod h1:vNK8G9p7aAivkbmorf4v+7Hgx+Zs0yY+0fOtgBfjQKo=
 go.uber.org/atomic v1.7.0 h1:ADUqmZGgLDDfbSL9ZmPxKTybcoEYHgpYfELNoN+7hsw=
 go.uber.org/atomic v1.7.0/go.mod h1:fEN4uk6kAWBTFdckzkM89CLk9XfWZrxpCo0nPH17wJc=
+go.uber.org/automaxprocs v1.5.3 h1:kWazyxZUrS3Gs4qUpbwo5kEIMGe/DAvi5Z4tl2NW4j8=
+go.uber.org/automaxprocs v1.5.3/go.mod h1:eRbA25aqJrxAbsLO0xy5jVwPt7FQnRgjW+efnwa1WM0=
 go.uber.org/goleak v1.1.11 h1:wy28qYRKZgnJTxGxvye5/wgWr1EKjmUDGYox5mGlRlI=
 go.uber.org/multierr v1.6.0 h1:y6IPFStTAIT5Ytl7/XYmHvzXQ7S3g/IeZW9hyZ5thw4=
 go.uber.org/multierr v1.6.0/go.mod h1:cdWPpRnG4AhwMwsgIHip0KRBQjJy5kYEpYjJxpXp9iU=
@@ -433,8 +436,8 @@ golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8/go.mod h1:oPkhp1MJrh7nUepCBc
 golang.org/x/sys v0.0.0-20220722155257-8c9f86f7a55f/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.5.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
-golang.org/x/sys v0.13.0 h1:Af8nKPmuFypiUBjVoU9V20FiaFXOcuZI21p0ycVYYGE=
-golang.org/x/sys v0.13.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/sys v0.14.0 h1:Vz7Qs629MkJkGyHxUlRHizWJRG2j8fbQKjELVSNhy7Q=
+golang.org/x/sys v0.14.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
 golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo=
 golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8=
 golang.org/x/term v0.5.0/go.mod h1:jMB1sMXY+tzblOD4FWmEbocvup2/aLOaQEp7JmGp78k=
@@ -526,11 +529,10 @@ gopkg.in/yaml.v2 v2.4.0/go.mod h1:RDklbk79AGWmwhnvt/jBztapEOGDOx6ZbXqjP6csGnQ=
 gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
 gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
 gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
-gorm.io/driver/mysql v1.5.2 h1:QC2HRskSE75wBuOxe0+iCkyJZ+RqpudsQtqkp+IMuXs=
-gorm.io/driver/mysql v1.5.2/go.mod h1:pQLhh1Ut/WUAySdTHwBpBv6+JKcj+ua4ZFx1QQTBzb8=
-gorm.io/gorm v1.25.2-0.20230530020048-26663ab9bf55/go.mod h1:L4uxeKpfBml98NYqVqwAdmV1a2nBtAec/cf3fpucW/k=
-gorm.io/gorm v1.25.5 h1:zR9lOiiYf09VNh5Q1gphfyia1JpiClIWG9hQaxB/mls=
-gorm.io/gorm v1.25.5/go.mod h1:hbnx/Oo0ChWMn1BIhpy1oYozzpM15i4YPuHDmfYtwg8=
+gorm.io/gorm v1.23.8 h1:h8sGJ+biDgBA1AD1Ha9gFCx7h8npU7AsLdlkX0n2TpE=
+gorm.io/gorm v1.23.8/go.mod h1:l2lP/RyAtc1ynaTjFksBde/O8v9oOGIApu2/xRitmZk=
+gotest.tools v2.2.0+incompatible h1:VsBPFP1AI068pPrMxtb/S8Zkgf9xEmTLJjfM+P5UIEo=
+gotest.tools v2.2.0+incompatible/go.mod h1:DsYFclhRJ6vuDpmuTbkuFWG+y2sxOXAzmJt81HFBacw=
 honnef.co/go/tools v0.0.0-20190102054323-c2f93a96b099/go.mod h1:rf3lG4BRIbNafJWhAfAdb/ePZxsR/4RtNHQocxwk9r4=
 honnef.co/go/tools v0.0.0-20190523083050-ea95bdfd59fc/go.mod h1:rf3lG4BRIbNafJWhAfAdb/ePZxsR/4RtNHQocxwk9r4=
 rsc.io/pdf v0.1.1/go.mod h1:n8OzWcQ6Sp37PL01nO98y4iUCRdTGarVfzxY20ICaU4=

go.work

@@ -13,4 +13,5 @@ use (
 	./tools/component
 	./tools/url2im
 	./tools/data-conversion
+	./tools/up35
 )

install.sh

@@ -63,7 +63,7 @@ PROXY=
 GITHUB_TOKEN=
 
 # Default user is "root". If you need to modify it, uncomment and replace accordingly.
-# USER=root 
+# OPENIM_USER=root 
 
 # Default password for redis, mysql, mongo, as well as accessSecret in config/config.yaml.
 # Remember, it should be a combination of 8 or more numbers and letters. If you want to set a different password, uncomment and replace "openIM123".
@@ -244,10 +244,10 @@ function download_source_code() {
 function set_openim_env() {
     warn "This command can only be executed once. It will modify the component passwords in docker-compose based on the PASSWORD variable in .env, and modify the component passwords in config/config.yaml. If the password in .env changes, you need to first execute docker-compose down; rm components -rf and then execute this command."
     # Set default values for user input
-    # If the USER environment variable is not set, it defaults to 'root'
-    if [ -z "$USER" ]; then
-        USER="root"
-        debug "USER is not set. Defaulting to 'root'."
+    # If the OPENIM_USER environment variable is not set, it defaults to 'root'
+    if [ -z "$OPENIM_USER" ]; then
+        OPENIM_USER="root"
+        debug "OPENIM_USER is not set. Defaulting to 'root'."
     fi
 
     # If the PASSWORD environment variable is not set, it defaults to 'openIM123'
@@ -321,7 +321,7 @@ function cmd_help() {
 
 function parseinput() {
     # set default values
-    # USER=root
+    # OPENIM_USER=root
     # PASSWORD=openIM123
     # ENDPOINT=http://127.0.0.1:10005
     # API=http://127.0.0.1:10002/object/
@@ -347,7 +347,7 @@ function parseinput() {
                 ;;
             -u|--user)
                 shift
-                USER=$1
+                OPENIM_USER=$1
                 ;;
             -p|--password)
                 shift
@@ -458,25 +458,20 @@ function openim_color() {
 }
 
 # --- helper functions for logs ---
-info()
-{
+info() {
     echo -e "[${GREEN_PREFIX}INFO${COLOR_SUFFIX}] " "$@"
 }
-warn()
-{
+warn() {
     echo -e "[${YELLOW_PREFIX}WARN${COLOR_SUFFIX}] " "$@" >&2
 }
-fatal()
-{
+fatal() {
     echo -e "[${RED_PREFIX}ERROR${COLOR_SUFFIX}] " "$@" >&2
     exit 1
 }
-debug()
-{
+debug() {
     echo -e "[${BLUE_PREFIX}DEBUG${COLOR_SUFFIX}]===> " "$@"
 }
-success()
-{
+success() {
     echo -e "${BRIGHT_GREEN_PREFIX}=== [SUCCESS] ===${COLOR_SUFFIX}\n=> " "$@"
 }
 

install_guide.sh

@@ -1,176 +0,0 @@
-#!/usr/bin/env bash
-
-echo "Welcome to the Open-IM-Server installation scripts."
-echo "Please select an deploy option:"
-echo "1. docker-compose install"
-echo "2. exit"
-
-clear_openimlog() {
-  rm -rf ./logs/*
-}
-
-is_path() {
-  if [ -e "$1" ]; then   
-    return 1
-  else
-    return 0
-  fi
-}
-
-is_empty() {
-  if [ -z "$1" ]; then
-    return 1
-  else
-    return 0
-  fi
-}
-
-is_directory_exists() {
-  if [ -d "$1" ]; then
-    return 1
-  else
-    return 0 
-  fi
-}
-
-edit_config() {
-    echo "Is edit config.yaml?"
-    echo "1. vi edit config"
-    echo "2. do not edit config"
-    read choice
-    case $choice in
-    1)
-      vi config/config.yaml
-    ;;
-    2)
-      echo "do not edit config"
-    ;;
-    esac
-}
-
-edit_enterprise_config() {
-    echo "Is edit enterprise config.yaml?"
-    echo "1. vi edit enterprise config"
-    echo "2. do not edit enterprise config"
-    read choice
-    case $choice in
-    1)
-      vi ./.docker-compose_cfg/config.yaml
-    ;;
-    2)
-      echo "Do not edit enterprise config"    
-    ;;
-    esac
-}
-
-install_docker_compose() {
-    echo "Please input the installation path, default is $(pwd)/Open-IM-Server, press enter to use default"
-    read install_path 
-    is_empty $install_path
-    if [ $? -eq 1 ]; then 
-        install_path="."
-    fi
-    echo "Installing Open-IM-Server to ${install_path}/Open-IM-Server..."
-    is_path $install_path
-    mkdir -p $install_path
-    cd $install_path
-    is_directory_exists "${install_path}/Open-IM-Server"
-    if [ $? -eq 1 ]; then
-        echo "WARNING: Directory $install_path/Open-IM-Server exist, please ensure your path"
-        echo "1. delete the directory and install"
-        echo "2. exit"
-        read choice
-        case $choice in
-        1)
-          rm -rf "${install_path}/Open-IM-Server"
-        ;;
-        2)
-          exit 1
-        ;;
-        esac
-    fi
-    rm -rf ./Open-IM-Server
-    set -e
-    git clone https://github.com/openimsdk/open-im-server.git --recursive;
-    set +e
-    cd ./Open-IM-Server
-    git checkout errcode
-    echo "======== git clone success ========"
-    source .env
-    if [ $DATA_DIR = "./" ]; then
-        DATA_DIR=$(pwd)/components
-    fi
-    echo "Please input the components data directory, deault is ${DATA_DIR}, press enter to use default"
-    read NEW_DATA_DIR
-    is_empty $NEW_DATA_DIR
-    if [ $? -eq 0 ]; then 
-        DATA_DIR=$NEW_DATA_DIR
-    fi 
-    echo "Please input the user, deault is root, press enter to use default"
-    read NEW_USER
-    is_empty $NEW_USER
-    if [ $? -eq 0 ]; then 
-        USER=$NEW_USER
-    fi 
-
-    echo "Please input the password, default is openIM123, press enter to use default"
-    read NEW_PASSWORD
-    is_empty $NEW_PASSWORD
-     if [ $? -eq 0 ]; then 
-        PASSWORD=$NEW_PASSWORD
-    fi 
-
-    echo "Please input the minio_endpoint, default will detect auto, press enter to use default"
-    read NEW_MINIO_ENDPOINT
-    is_empty $NEW_MINIO_ENDPOINT
-    if [ $? -eq 1 ]; then
-        internet_ip=`curl ifconfig.me -s`
-        MINIO_ENDPOINT="http://${internet_ip}:10005"
-    else 
-        MINIO_ENDPOINT=$NEW_MINIO_ENDPOINT  
-    fi
-    set -e
-    export MINIO_ENDPOINT
-    export USER
-    export PASSWORD
-    export DATA_DIR
-
-    cat <<EOF > .env
-USER=${USER}
-PASSWORD=${PASSWORD}
-MINIO_ENDPOINT=${MINIO_ENDPOINT}
-DATA_DIR=${DATA_DIR}
-EOF
-
-    edit_config
-    edit_enterprise_config
-    
-    cd scripts;
-    chmod +x *.sh;
-    ./init_pwd.sh;
-    ./env_check.sh;
-    cd ..;
-    docker-compose up -d;
-    cd scripts;
-    ./docker-check-service.sh;
-}
-
-read choice
-
-case $choice in
-  1)
-    install_docker_compose
-    ;;
-  2)
-    
-    ;;
-  3)
-    ;;
-  4)
-    echo "Exiting installation scripts..."
-    exit 0
-    ;;
-  *)
-    echo "Invalid option, please try again."
-    ;;
-esac

internal/api/msg.go

@@ -15,14 +15,6 @@
 package api
 
 import (
-	"github.com/OpenIMSDK/tools/mcontext"
-	"github.com/gin-gonic/gin"
-	"github.com/go-playground/validator/v10"
-	"github.com/mitchellh/mapstructure"
-
-	"github.com/openimsdk/open-im-server/v3/pkg/authverify"
-	"github.com/openimsdk/open-im-server/v3/pkg/common/config"
-
 	"github.com/OpenIMSDK/protocol/constant"
 	"github.com/OpenIMSDK/protocol/msg"
 	"github.com/OpenIMSDK/protocol/sdkws"
@@ -30,7 +22,13 @@ import (
 	"github.com/OpenIMSDK/tools/apiresp"
 	"github.com/OpenIMSDK/tools/errs"
 	"github.com/OpenIMSDK/tools/log"
+	"github.com/OpenIMSDK/tools/mcontext"
 	"github.com/OpenIMSDK/tools/utils"
+	"github.com/gin-gonic/gin"
+	"github.com/go-playground/validator/v10"
+	"github.com/mitchellh/mapstructure"
+	"github.com/openimsdk/open-im-server/v3/pkg/authverify"
+	"github.com/openimsdk/open-im-server/v3/pkg/common/config"
 
 	"github.com/openimsdk/open-im-server/v3/pkg/apistruct"
 	"github.com/openimsdk/open-im-server/v3/pkg/rpcclient"
@@ -152,7 +150,7 @@ func (m *MessageApi) DeleteMsgPhysical(c *gin.Context) {
 }
 
 func (m *MessageApi) getSendMsgReq(c *gin.Context, req apistruct.SendMsg) (sendMsgReq *msg.SendMsgReq, err error) {
-	var data interface{}
+	var data any
 	log.ZDebug(c, "getSendMsgReq", "req", req.Content)
 	switch req.ContentType {
 	case constant.Text:

internal/api/third.go

@@ -15,11 +15,12 @@
 package api
 
 import (
-	config2 "github.com/openimsdk/open-im-server/v3/pkg/common/config"
 	"math/rand"
 	"net/http"
 	"strconv"
 
+	config2 "github.com/openimsdk/open-im-server/v3/pkg/common/config"
+
 	"github.com/gin-gonic/gin"
 
 	"github.com/OpenIMSDK/protocol/third"

internal/msggateway/callback.go

@@ -37,7 +37,7 @@ func CallbackUserOnline(ctx context.Context, userID string, platformID int, isAp
 	req := cbapi.CallbackUserOnlineReq{
 		UserStatusCallbackReq: cbapi.UserStatusCallbackReq{
 			UserStatusBaseCallback: cbapi.UserStatusBaseCallback{
-				CallbackCommand: constant.CallbackUserOnlineCommand,
+				CallbackCommand: cbapi.CallbackUserOnlineCommand,
 				OperationID:     mcontext.GetOperationID(ctx),
 				PlatformID:      platformID,
 				Platform:        constant.PlatformIDToName(platformID),
@@ -49,7 +49,10 @@ func CallbackUserOnline(ctx context.Context, userID string, platformID int, isAp
 		ConnID:          connID,
 	}
 	resp := cbapi.CommonCallbackResp{}
-	return http.CallBackPostReturn(ctx, callBackURL(), &req, &resp, config.Config.Callback.CallbackUserOnline)
+	if err := http.CallBackPostReturn(ctx, callBackURL(), &req, &resp, config.Config.Callback.CallbackUserOnline); err != nil {
+		return err
+	}
+	return nil
 }
 
 func CallbackUserOffline(ctx context.Context, userID string, platformID int, connID string) error {
@@ -59,7 +62,7 @@ func CallbackUserOffline(ctx context.Context, userID string, platformID int, con
 	req := &cbapi.CallbackUserOfflineReq{
 		UserStatusCallbackReq: cbapi.UserStatusCallbackReq{
 			UserStatusBaseCallback: cbapi.UserStatusBaseCallback{
-				CallbackCommand: constant.CallbackUserOfflineCommand,
+				CallbackCommand: cbapi.CallbackUserOfflineCommand,
 				OperationID:     mcontext.GetOperationID(ctx),
 				PlatformID:      platformID,
 				Platform:        constant.PlatformIDToName(platformID),
@@ -70,7 +73,10 @@ func CallbackUserOffline(ctx context.Context, userID string, platformID int, con
 		ConnID: connID,
 	}
 	resp := &cbapi.CallbackUserOfflineResp{}
-	return http.CallBackPostReturn(ctx, callBackURL(), req, resp, config.Config.Callback.CallbackUserOffline)
+	if err := http.CallBackPostReturn(ctx, callBackURL(), req, resp, config.Config.Callback.CallbackUserOffline); err != nil {
+		return err
+	}
+	return nil
 }
 
 func CallbackUserKickOff(ctx context.Context, userID string, platformID int) error {
@@ -80,7 +86,7 @@ func CallbackUserKickOff(ctx context.Context, userID string, platformID int) err
 	req := &cbapi.CallbackUserKickOffReq{
 		UserStatusCallbackReq: cbapi.UserStatusCallbackReq{
 			UserStatusBaseCallback: cbapi.UserStatusBaseCallback{
-				CallbackCommand: constant.CallbackUserKickOffCommand,
+				CallbackCommand: cbapi.CallbackUserKickOffCommand,
 				OperationID:     mcontext.GetOperationID(ctx),
 				PlatformID:      platformID,
 				Platform:        constant.PlatformIDToName(platformID),
@@ -90,7 +96,10 @@ func CallbackUserKickOff(ctx context.Context, userID string, platformID int) err
 		Seq: time.Now().UnixMilli(),
 	}
 	resp := &cbapi.CommonCallbackResp{}
-	return http.CallBackPostReturn(ctx, callBackURL(), req, resp, config.Config.Callback.CallbackUserOffline)
+	if err := http.CallBackPostReturn(ctx, callBackURL(), req, resp, config.Config.Callback.CallbackUserOffline); err != nil {
+		return err
+	}
+	return nil
 }
 
 // func callbackUserOnline(operationID, userID string, platformID int, token string, isAppBackground bool, connID

internal/msggateway/client.go

@@ -167,7 +167,7 @@ func (c *Client) readMessage() {
 func (c *Client) handleMessage(message []byte) error {
 	if c.IsCompress {
 		var err error
-		message, err = c.longConnServer.DeCompress(message)
+		message, err = c.longConnServer.DecompressWithPool(message)
 		if err != nil {
 			return utils.Wrap(err, "")
 		}
@@ -317,7 +317,7 @@ func (c *Client) writeBinaryMsg(resp Resp) error {
 
 	_ = c.conn.SetWriteDeadline(writeWait)
 	if c.IsCompress {
-		resultBuf, compressErr := c.longConnServer.Compress(encodedBuf)
+		resultBuf, compressErr := c.longConnServer.CompressWithPool(encodedBuf)
 		if compressErr != nil {
 			return utils.Wrap(compressErr, "")
 		}

internal/msggateway/compressor.go

@@ -17,14 +17,23 @@ package msggateway
 import (
 	"bytes"
 	"compress/gzip"
+	"errors"
 	"io"
+	"sync"
 
 	"github.com/OpenIMSDK/tools/utils"
 )
 
+var (
+	gzipWriterPool = sync.Pool{New: func() any { return gzip.NewWriter(nil) }}
+	gzipReaderPool = sync.Pool{New: func() any { return new(gzip.Reader) }}
+)
+
 type Compressor interface {
 	Compress(rawData []byte) ([]byte, error)
+	CompressWithPool(rawData []byte) ([]byte, error)
 	DeCompress(compressedData []byte) ([]byte, error)
+	DecompressWithPool(compressedData []byte) ([]byte, error)
 }
 type GzipCompressor struct {
 	compressProtocol string
@@ -46,6 +55,22 @@ func (g *GzipCompressor) Compress(rawData []byte) ([]byte, error) {
 	return gzipBuffer.Bytes(), nil
 }
 
+func (g *GzipCompressor) CompressWithPool(rawData []byte) ([]byte, error) {
+	gz := gzipWriterPool.Get().(*gzip.Writer)
+	defer gzipWriterPool.Put(gz)
+
+	gzipBuffer := bytes.Buffer{}
+	gz.Reset(&gzipBuffer)
+
+	if _, err := gz.Write(rawData); err != nil {
+		return nil, utils.Wrap(err, "")
+	}
+	if err := gz.Close(); err != nil {
+		return nil, utils.Wrap(err, "")
+	}
+	return gzipBuffer.Bytes(), nil
+}
+
 func (g *GzipCompressor) DeCompress(compressedData []byte) ([]byte, error) {
 	buff := bytes.NewBuffer(compressedData)
 	reader, err := gzip.NewReader(buff)
@@ -59,3 +84,23 @@ func (g *GzipCompressor) DeCompress(compressedData []byte) ([]byte, error) {
 	_ = reader.Close()
 	return compressedData, nil
 }
+
+func (g *GzipCompressor) DecompressWithPool(compressedData []byte) ([]byte, error) {
+	reader := gzipReaderPool.Get().(*gzip.Reader)
+	if reader == nil {
+		return nil, errors.New("NewReader failed")
+	}
+	defer gzipReaderPool.Put(reader)
+
+	err := reader.Reset(bytes.NewReader(compressedData))
+	if err != nil {
+		return nil, utils.Wrap(err, "NewReader failed")
+	}
+
+	compressedData, err = io.ReadAll(reader)
+	if err != nil {
+		return nil, utils.Wrap(err, "ReadAll failed")
+	}
+	_ = reader.Close()
+	return compressedData, nil
+}

internal/msggateway/compressor_test.go

@@ -0,0 +1,107 @@
+package msggateway
+
+import (
+	"crypto/rand"
+	"sync"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func mockRandom() []byte {
+	bs := make([]byte, 50)
+	rand.Read(bs)
+	return bs
+}
+
+func TestCompressDecompress(t *testing.T) {
+
+	compressor := NewGzipCompressor()
+
+	for i := 0; i < 2000; i++ {
+		src := mockRandom()
+
+		// compress
+		dest, err := compressor.CompressWithPool(src)
+		assert.Equal(t, nil, err)
+
+		// decompress
+		res, err := compressor.DecompressWithPool(dest)
+		assert.Equal(t, nil, err)
+
+		// check
+		assert.EqualValues(t, src, res)
+	}
+}
+
+func TestCompressDecompressWithConcurrency(t *testing.T) {
+	wg := sync.WaitGroup{}
+	compressor := NewGzipCompressor()
+
+	for i := 0; i < 200; i++ {
+		wg.Add(1)
+		go func() {
+			defer wg.Done()
+			src := mockRandom()
+
+			// compress
+			dest, err := compressor.CompressWithPool(src)
+			assert.Equal(t, nil, err)
+
+			// decompress
+			res, err := compressor.DecompressWithPool(dest)
+			assert.Equal(t, nil, err)
+
+			// check
+			assert.EqualValues(t, src, res)
+
+		}()
+	}
+	wg.Wait()
+}
+
+func BenchmarkCompress(b *testing.B) {
+	src := mockRandom()
+	compressor := NewGzipCompressor()
+
+	for i := 0; i < b.N; i++ {
+		_, err := compressor.Compress(src)
+		assert.Equal(b, nil, err)
+	}
+}
+
+func BenchmarkCompressWithSyncPool(b *testing.B) {
+	src := mockRandom()
+
+	compressor := NewGzipCompressor()
+	for i := 0; i < b.N; i++ {
+		_, err := compressor.CompressWithPool(src)
+		assert.Equal(b, nil, err)
+	}
+}
+
+func BenchmarkDecompress(b *testing.B) {
+	src := mockRandom()
+
+	compressor := NewGzipCompressor()
+	comdata, err := compressor.Compress(src)
+	assert.Equal(b, nil, err)
+
+	for i := 0; i < b.N; i++ {
+		_, err := compressor.DeCompress(comdata)
+		assert.Equal(b, nil, err)
+	}
+}
+
+func BenchmarkDecompressWithSyncPool(b *testing.B) {
+	src := mockRandom()
+
+	compressor := NewGzipCompressor()
+	comdata, err := compressor.Compress(src)
+	assert.Equal(b, nil, err)
+
+	for i := 0; i < b.N; i++ {
+		_, err := compressor.DecompressWithPool(comdata)
+		assert.Equal(b, nil, err)
+	}
+}

internal/msggateway/encoder.go

@@ -22,8 +22,8 @@ import (
 )
 
 type Encoder interface {
-	Encode(data interface{}) ([]byte, error)
-	Decode(encodeData []byte, decodeData interface{}) error
+	Encode(data any) ([]byte, error)
+	Decode(encodeData []byte, decodeData any) error
 }
 
 type GobEncoder struct{}
@@ -32,7 +32,7 @@ func NewGobEncoder() *GobEncoder {
 	return &GobEncoder{}
 }
 
-func (g *GobEncoder) Encode(data interface{}) ([]byte, error) {
+func (g *GobEncoder) Encode(data any) ([]byte, error) {
 	buff := bytes.Buffer{}
 	enc := gob.NewEncoder(&buff)
 	err := enc.Encode(data)
@@ -42,7 +42,7 @@ func (g *GobEncoder) Encode(data interface{}) ([]byte, error) {
 	return buff.Bytes(), nil
 }
 
-func (g *GobEncoder) Decode(encodeData []byte, decodeData interface{}) error {
+func (g *GobEncoder) Decode(encodeData []byte, decodeData any) error {
 	buff := bytes.NewBuffer(encodeData)
 	dec := gob.NewDecoder(buff)
 	err := dec.Decode(decodeData)

internal/msggateway/hub_server.go

@@ -17,22 +17,19 @@ package msggateway
 import (
 	"context"
 
-	"github.com/OpenIMSDK/tools/mcontext"
-
-	"github.com/openimsdk/open-im-server/v3/pkg/authverify"
-
-	"github.com/OpenIMSDK/tools/errs"
 	"google.golang.org/grpc"
 
-	"github.com/openimsdk/open-im-server/v3/pkg/common/db/cache"
-
 	"github.com/OpenIMSDK/protocol/constant"
 	"github.com/OpenIMSDK/protocol/msggateway"
 	"github.com/OpenIMSDK/tools/discoveryregistry"
+	"github.com/OpenIMSDK/tools/errs"
 	"github.com/OpenIMSDK/tools/log"
+	"github.com/OpenIMSDK/tools/mcontext"
 	"github.com/OpenIMSDK/tools/utils"
 
+	"github.com/openimsdk/open-im-server/v3/pkg/authverify"
 	"github.com/openimsdk/open-im-server/v3/pkg/common/config"
+	"github.com/openimsdk/open-im-server/v3/pkg/common/db/cache"
 	"github.com/openimsdk/open-im-server/v3/pkg/common/startrpc"
 )
 
@@ -41,6 +38,7 @@ func (s *Server) InitServer(disCov discoveryregistry.SvcDiscoveryRegistry, serve
 	if err != nil {
 		return err
 	}
+
 	msgModel := cache.NewMsgCacheModel(rdb)
 	s.LongConnServer.SetDiscoveryRegistry(disCov)
 	s.LongConnServer.SetCacheHandler(msgModel)
@@ -97,22 +95,25 @@ func (s *Server) GetUsersOnlineStatus(
 		if !ok {
 			continue
 		}
-		temp := new(msggateway.GetUsersOnlineStatusResp_SuccessResult)
-		temp.UserID = userID
+
+		uresp := new(msggateway.GetUsersOnlineStatusResp_SuccessResult)
+		uresp.UserID = userID
 		for _, client := range clients {
-			if client != nil {
-				ps := new(msggateway.GetUsersOnlineStatusResp_SuccessDetail)
-				ps.Platform = constant.PlatformIDToName(client.PlatformID)
-				ps.Status = constant.OnlineStatus
-				ps.ConnID = client.ctx.GetConnID()
-				ps.Token = client.token
-				ps.IsBackground = client.IsBackground
-				temp.Status = constant.OnlineStatus
-				temp.DetailPlatformStatus = append(temp.DetailPlatformStatus, ps)
+			if client == nil {
+				continue
 			}
+
+			ps := new(msggateway.GetUsersOnlineStatusResp_SuccessDetail)
+			ps.Platform = constant.PlatformIDToName(client.PlatformID)
+			ps.Status = constant.OnlineStatus
+			ps.ConnID = client.ctx.GetConnID()
+			ps.Token = client.token
+			ps.IsBackground = client.IsBackground
+			uresp.Status = constant.OnlineStatus
+			uresp.DetailPlatformStatus = append(uresp.DetailPlatformStatus, ps)
 		}
-		if temp.Status == constant.OnlineStatus {
-			resp.SuccessResult = append(resp.SuccessResult, temp)
+		if uresp.Status == constant.OnlineStatus {
+			resp.SuccessResult = append(resp.SuccessResult, uresp)
 		}
 	}
 	return &resp, nil
@@ -129,50 +130,55 @@ func (s *Server) SuperGroupOnlineBatchPushOneMsg(
 	ctx context.Context,
 	req *msggateway.OnlineBatchPushOneMsgReq,
 ) (*msggateway.OnlineBatchPushOneMsgResp, error) {
-	var singleUserResult []*msggateway.SingleMsgToUserResults
+
+	var singleUserResults []*msggateway.SingleMsgToUserResults
+
 	for _, v := range req.PushToUserIDs {
 		var resp []*msggateway.SingleMsgToUserPlatform
-		tempT := &msggateway.SingleMsgToUserResults{
+		results := &msggateway.SingleMsgToUserResults{
 			UserID: v,
 		}
 		clients, ok := s.LongConnServer.GetUserAllCons(v)
 		if !ok {
 			log.ZDebug(ctx, "push user not online", "userID", v)
-			tempT.Resp = resp
-			singleUserResult = append(singleUserResult, tempT)
+			results.Resp = resp
+			singleUserResults = append(singleUserResults, results)
 			continue
 		}
+
 		log.ZDebug(ctx, "push user online", "clients", clients, "userID", v)
 		for _, client := range clients {
-			if client != nil {
-				temp := &msggateway.SingleMsgToUserPlatform{
-					RecvID:         v,
-					RecvPlatFormID: int32(client.PlatformID),
-				}
-				if !client.IsBackground ||
-					(client.IsBackground == true && client.PlatformID != constant.IOSPlatformID) {
-					err := client.PushMessage(ctx, req.MsgData)
-					if err != nil {
-						temp.ResultCode = -2
-						resp = append(resp, temp)
-					} else {
-						if utils.IsContainInt(client.PlatformID, s.pushTerminal) {
-							tempT.OnlinePush = true
-							resp = append(resp, temp)
-						}
-					}
+			if client == nil {
+				continue
+			}
+
+			userPlatform := &msggateway.SingleMsgToUserPlatform{
+				RecvID:         v,
+				RecvPlatFormID: int32(client.PlatformID),
+			}
+			if !client.IsBackground ||
+				(client.IsBackground && client.PlatformID != constant.IOSPlatformID) {
+				err := client.PushMessage(ctx, req.MsgData)
+				if err != nil {
+					userPlatform.ResultCode = -2
+					resp = append(resp, userPlatform)
 				} else {
-					temp.ResultCode = -3
-					resp = append(resp, temp)
+					if utils.IsContainInt(client.PlatformID, s.pushTerminal) {
+						results.OnlinePush = true
+						resp = append(resp, userPlatform)
+					}
 				}
+			} else {
+				userPlatform.ResultCode = -3
+				resp = append(resp, userPlatform)
 			}
 		}
-		tempT.Resp = resp
-		singleUserResult = append(singleUserResult, tempT)
+		results.Resp = resp
+		singleUserResults = append(singleUserResults, results)
 	}
 
 	return &msggateway.OnlineBatchPushOneMsgResp{
-		SinglePushResult: singleUserResult,
+		SinglePushResult: singleUserResults,
 	}, nil
 }
 
@@ -181,17 +187,21 @@ func (s *Server) KickUserOffline(
 	req *msggateway.KickUserOfflineReq,
 ) (*msggateway.KickUserOfflineResp, error) {
 	for _, v := range req.KickUserIDList {
-		if clients, _, ok := s.LongConnServer.GetUserPlatformCons(v, int(req.PlatformID)); ok {
-			for _, client := range clients {
-				log.ZDebug(ctx, "kick user offline", "userID", v, "platformID", req.PlatformID, "client", client)
-				if err := client.longConnServer.KickUserConn(client); err != nil {
-					log.ZWarn(ctx, "kick user offline failed", err, "userID", v, "platformID", req.PlatformID)
-				}
-			}
-		} else {
+		clients, _, ok := s.LongConnServer.GetUserPlatformCons(v, int(req.PlatformID))
+		if !ok {
 			log.ZInfo(ctx, "conn not exist", "userID", v, "platformID", req.PlatformID)
+			continue
 		}
+
+		for _, client := range clients {
+			log.ZDebug(ctx, "kick user offline", "userID", v, "platformID", req.PlatformID, "client", client)
+			if err := client.longConnServer.KickUserConn(client); err != nil {
+				log.ZWarn(ctx, "kick user offline failed", err, "userID", v, "platformID", req.PlatformID)
+			}
+		}
+		continue
 	}
+
 	return &msggateway.KickUserOfflineResp{}, nil
 }
 

internal/msggateway/init.go

@@ -19,11 +19,12 @@ import (
 	"time"
 
 	"github.com/OpenIMSDK/tools/utils"
+	"golang.org/x/sync/errgroup"
 
 	"github.com/openimsdk/open-im-server/v3/pkg/common/config"
 )
 
-// RunWsAndServer run ws server
+// RunWsAndServer run ws server.
 func RunWsAndServer(rpcPort, wsPort, prometheusPort int) error {
 	fmt.Println(
 		"start rpc/msg_gateway server, port: ",
@@ -37,16 +38,28 @@ func RunWsAndServer(rpcPort, wsPort, prometheusPort int) error {
 		WithPort(wsPort),
 		WithMaxConnNum(int64(config.Config.LongConnSvr.WebsocketMaxConnNum)),
 		WithHandshakeTimeout(time.Duration(config.Config.LongConnSvr.WebsocketTimeout)*time.Second),
-		WithMessageMaxMsgLength(config.Config.LongConnSvr.WebsocketMaxMsgLen))
+		WithMessageMaxMsgLength(config.Config.LongConnSvr.WebsocketMaxMsgLen),
+		WithWriteBufferSize(config.Config.LongConnSvr.WebsocketWriteBufferSize),
+	)
 	if err != nil {
 		return err
 	}
+
 	hubServer := NewServer(rpcPort, prometheusPort, longServer)
-	go func() {
-		err := hubServer.Start()
+
+	wg := errgroup.Group{}
+	wg.Go(func() error {
+		err = hubServer.Start()
 		if err != nil {
-			panic(utils.Wrap1(err))
+			return utils.Wrap1(err)
 		}
-	}()
-	return hubServer.LongConnServer.Run()
+		return err
+	})
+
+	wg.Go(func() error {
+		return hubServer.LongConnServer.Run()
+	})
+
+	err = wg.Wait()
+	return err
 }

internal/msggateway/long_conn.go

@@ -50,10 +50,11 @@ type GWebSocket struct {
 	protocolType     int
 	conn             *websocket.Conn
 	handshakeTimeout time.Duration
+	writeBufferSize  int
 }
 
-func newGWebSocket(protocolType int, handshakeTimeout time.Duration) *GWebSocket {
-	return &GWebSocket{protocolType: protocolType, handshakeTimeout: handshakeTimeout}
+func newGWebSocket(protocolType int, handshakeTimeout time.Duration, wbs int) *GWebSocket {
+	return &GWebSocket{protocolType: protocolType, handshakeTimeout: handshakeTimeout, writeBufferSize: wbs}
 }
 
 func (d *GWebSocket) Close() error {
@@ -65,6 +66,10 @@ func (d *GWebSocket) GenerateLongConn(w http.ResponseWriter, r *http.Request) er
 		HandshakeTimeout: d.handshakeTimeout,
 		CheckOrigin:      func(r *http.Request) bool { return true },
 	}
+	if d.writeBufferSize > 0 { // default is 4kb.
+		upgrader.WriteBufferSize = d.writeBufferSize
+	}
+
 	conn, err := upgrader.Upgrade(w, r, nil)
 	if err != nil {
 		return err

internal/msggateway/n_ws_server.go

@@ -17,32 +17,31 @@ package msggateway
 import (
 	"context"
 	"errors"
-	"github.com/openimsdk/open-im-server/v3/pkg/common/prom_metrics"
 	"net/http"
+	"os"
+	"os/signal"
 	"strconv"
 	"sync"
 	"sync/atomic"
+	"syscall"
 	"time"
 
-	"github.com/OpenIMSDK/protocol/msggateway"
-
-	"github.com/openimsdk/open-im-server/v3/pkg/authverify"
-	"github.com/openimsdk/open-im-server/v3/pkg/rpcclient"
+	"github.com/go-playground/validator/v10"
+	"github.com/redis/go-redis/v9"
+	"golang.org/x/sync/errgroup"
 
 	"github.com/OpenIMSDK/protocol/constant"
-
-	"github.com/openimsdk/open-im-server/v3/pkg/common/config"
-	"github.com/openimsdk/open-im-server/v3/pkg/common/db/cache"
-
-	"github.com/redis/go-redis/v9"
-
+	"github.com/OpenIMSDK/protocol/msggateway"
 	"github.com/OpenIMSDK/tools/discoveryregistry"
-
-	"github.com/go-playground/validator/v10"
-
 	"github.com/OpenIMSDK/tools/errs"
 	"github.com/OpenIMSDK/tools/log"
 	"github.com/OpenIMSDK/tools/utils"
+
+	"github.com/openimsdk/open-im-server/v3/pkg/authverify"
+	"github.com/openimsdk/open-im-server/v3/pkg/common/config"
+	"github.com/openimsdk/open-im-server/v3/pkg/common/db/cache"
+	"github.com/openimsdk/open-im-server/v3/pkg/common/prommetrics"
+	"github.com/openimsdk/open-im-server/v3/pkg/rpcclient"
 )
 
 type LongConnServer interface {
@@ -50,7 +49,7 @@ type LongConnServer interface {
 	wsHandler(w http.ResponseWriter, r *http.Request)
 	GetUserAllCons(userID string) ([]*Client, bool)
 	GetUserPlatformCons(userID string, platform int) ([]*Client, bool, bool)
-	Validate(s interface{}) error
+	Validate(s any) error
 	SetCacheHandler(cache cache.MsgModel)
 	SetDiscoveryRegistry(client discoveryregistry.SvcDiscoveryRegistry)
 	KickUserConn(client *Client) error
@@ -62,7 +61,7 @@ type LongConnServer interface {
 }
 
 var bufferPool = sync.Pool{
-	New: func() interface{} {
+	New: func() any {
 		return make([]byte, 1024)
 	},
 }
@@ -78,7 +77,7 @@ type WsServer struct {
 	onlineUserNum     atomic.Int64
 	onlineUserConnNum atomic.Int64
 	handshakeTimeout  time.Duration
-	hubServer         *Server
+	writeBufferSize   int
 	validate          *validator.Validate
 	cache             cache.MsgModel
 	userClient        *rpcclient.UserRpcClient
@@ -127,7 +126,8 @@ func (ws *WsServer) UnRegister(c *Client) {
 	ws.unregisterChan <- c
 }
 
-func (ws *WsServer) Validate(s interface{}) error {
+func (ws *WsServer) Validate(s any) error {
+	//?question?
 	return nil
 }
 
@@ -148,9 +148,10 @@ func NewWsServer(opts ...Option) (*WsServer, error) {
 	return &WsServer{
 		port:             config.port,
 		wsMaxConnNum:     config.maxConnNum,
+		writeBufferSize:  config.writeBufferSize,
 		handshakeTimeout: config.handshakeTimeout,
 		clientPool: sync.Pool{
-			New: func() interface{} {
+			New: func() any {
 				return new(Client)
 			},
 		},
@@ -165,10 +166,22 @@ func NewWsServer(opts ...Option) (*WsServer, error) {
 }
 
 func (ws *WsServer) Run() error {
-	var client *Client
-	go func() {
+	var (
+		client *Client
+		wg     errgroup.Group
+
+		sigs = make(chan os.Signal, 1)
+		done = make(chan struct{}, 1)
+	)
+
+	server := http.Server{Addr: ":" + utils.IntToString(ws.port), Handler: nil}
+
+	wg.Go(func() error {
 		for {
 			select {
+			case <-done:
+				return nil
+
 			case client = <-ws.registerChan:
 				ws.registerClient(client)
 			case client = <-ws.unregisterChan:
@@ -177,33 +190,69 @@ func (ws *WsServer) Run() error {
 				ws.multiTerminalLoginChecker(onlineInfo.clientOK, onlineInfo.oldClients, onlineInfo.newClient)
 			}
 		}
+	})
+
+	wg.Go(func() error {
+		http.HandleFunc("/", ws.wsHandler)
+		return server.ListenAndServe()
+	})
+
+	signal.Notify(sigs, syscall.SIGINT, syscall.SIGTERM, syscall.SIGQUIT)
+	<-sigs
+
+	go func() {
+		ctx, cancel := context.WithTimeout(context.Background(), 15*time.Second)
+		defer cancel()
+
+		// graceful exit operation for server
+		_ = server.Shutdown(ctx)
+		_ = wg.Wait()
+		close(done)
 	}()
-	http.HandleFunc("/", ws.wsHandler)
-	// http.HandleFunc("/metrics", func(w http.ResponseWriter, r *http.Request) {})
-	return http.ListenAndServe(":"+utils.IntToString(ws.port), nil) // Start listening
+
+	select {
+	case <-done:
+		return nil
+
+	case <-time.After(15 * time.Second):
+		return utils.Wrap1(errors.New("timeout exit"))
+	}
+
 }
 
+var concurrentRequest = 3
+
 func (ws *WsServer) sendUserOnlineInfoToOtherNode(ctx context.Context, client *Client) error {
 	conns, err := ws.disCov.GetConns(ctx, config.Config.RpcRegisterName.OpenImMessageGatewayName)
 	if err != nil {
 		return err
 	}
+
+	wg := errgroup.Group{}
+	wg.SetLimit(concurrentRequest)
+
 	// Online push user online message to other node
 	for _, v := range conns {
+		v := v // safe closure var
 		if v.Target() == ws.disCov.GetSelfConnTarget() {
 			log.ZDebug(ctx, "Filter out this node", "node", v.Target())
 			continue
 		}
-		msgClient := msggateway.NewMsgGatewayClient(v)
-		_, err := msgClient.MultiTerminalLoginCheck(ctx, &msggateway.MultiTerminalLoginCheckReq{
-			UserID:     client.UserID,
-			PlatformID: int32(client.PlatformID), Token: client.token,
+
+		wg.Go(func() error {
+			msgClient := msggateway.NewMsgGatewayClient(v)
+			_, err := msgClient.MultiTerminalLoginCheck(ctx, &msggateway.MultiTerminalLoginCheckReq{
+				UserID:     client.UserID,
+				PlatformID: int32(client.PlatformID), Token: client.token,
+			})
+			if err != nil {
+				log.ZWarn(ctx, "MultiTerminalLoginCheck err", err, "node", v.Target())
+			}
+			return nil
 		})
-		if err != nil {
-			log.ZWarn(ctx, "MultiTerminalLoginCheck err", err, "node", v.Target())
-			continue
-		}
 	}
+
+	_ = wg.Wait()
 	return nil
 }
 
@@ -221,7 +270,7 @@ func (ws *WsServer) registerClient(client *Client) {
 	if !userOK {
 		ws.clients.Set(client.UserID, client)
 		log.ZDebug(client.ctx, "user not exist", "userID", client.UserID, "platformID", client.PlatformID)
-		prom_metrics.OnlineUserGauge.Add(1)
+		prommetrics.OnlineUserGauge.Add(1)
 		ws.onlineUserNum.Add(1)
 		ws.onlineUserConnNum.Add(1)
 	} else {
@@ -289,70 +338,72 @@ func (ws *WsServer) multiTerminalLoginChecker(clientOK bool, oldClients []*Clien
 		}
 		fallthrough
 	case constant.AllLoginButSameTermKick:
-		if clientOK {
-			isDeleteUser := ws.clients.deleteClients(newClient.UserID, oldClients)
-			if isDeleteUser {
-				ws.onlineUserNum.Add(-1)
+		if !clientOK {
+			return
+		}
+
+		isDeleteUser := ws.clients.deleteClients(newClient.UserID, oldClients)
+		if isDeleteUser {
+			ws.onlineUserNum.Add(-1)
+		}
+		for _, c := range oldClients {
+			err := c.KickOnlineMessage()
+			if err != nil {
+				log.ZWarn(c.ctx, "KickOnlineMessage", err)
 			}
-			for _, c := range oldClients {
-				err := c.KickOnlineMessage()
-				if err != nil {
-					log.ZWarn(c.ctx, "KickOnlineMessage", err)
-				}
-			}
-			m, err := ws.cache.GetTokensWithoutError(
+		}
+		m, err := ws.cache.GetTokensWithoutError(
+			newClient.ctx,
+			newClient.UserID,
+			newClient.PlatformID,
+		)
+		if err != nil && err != redis.Nil {
+			log.ZWarn(
 				newClient.ctx,
-				newClient.UserID,
-				newClient.PlatformID,
-			)
-			if err != nil && err != redis.Nil {
-				log.ZWarn(
-					newClient.ctx,
-					"get token from redis err",
-					err,
-					"userID",
-					newClient.UserID,
-					"platformID",
-					newClient.PlatformID,
-				)
-				return
-			}
-			if m == nil {
-				log.ZWarn(
-					newClient.ctx,
-					"m is nil",
-					errors.New("m is nil"),
-					"userID",
-					newClient.UserID,
-					"platformID",
-					newClient.PlatformID,
-				)
-				return
-			}
-			log.ZDebug(
-				newClient.ctx,
-				"get token from redis",
+				"get token from redis err",
+				err,
 				"userID",
 				newClient.UserID,
 				"platformID",
 				newClient.PlatformID,
-				"tokenMap",
-				m,
 			)
+			return
+		}
+		if m == nil {
+			log.ZWarn(
+				newClient.ctx,
+				"m is nil",
+				errors.New("m is nil"),
+				"userID",
+				newClient.UserID,
+				"platformID",
+				newClient.PlatformID,
+			)
+			return
+		}
+		log.ZDebug(
+			newClient.ctx,
+			"get token from redis",
+			"userID",
+			newClient.UserID,
+			"platformID",
+			newClient.PlatformID,
+			"tokenMap",
+			m,
+		)
 
-			for k := range m {
-				if k != newClient.ctx.GetToken() {
-					m[k] = constant.KickedToken
-				}
-			}
-			log.ZDebug(newClient.ctx, "set token map is ", "token map", m, "userID",
-				newClient.UserID, "token", newClient.ctx.GetToken())
-			err = ws.cache.SetTokenMapByUidPid(newClient.ctx, newClient.UserID, newClient.PlatformID, m)
-			if err != nil {
-				log.ZWarn(newClient.ctx, "SetTokenMapByUidPid err", err, "userID", newClient.UserID, "platformID", newClient.PlatformID)
-				return
+		for k := range m {
+			if k != newClient.ctx.GetToken() {
+				m[k] = constant.KickedToken
 			}
 		}
+		log.ZDebug(newClient.ctx, "set token map is ", "token map", m, "userID",
+			newClient.UserID, "token", newClient.ctx.GetToken())
+		err = ws.cache.SetTokenMapByUidPid(newClient.ctx, newClient.UserID, newClient.PlatformID, m)
+		if err != nil {
+			log.ZWarn(newClient.ctx, "SetTokenMapByUidPid err", err, "userID", newClient.UserID, "platformID", newClient.PlatformID)
+			return
+		}
 	}
 }
 
@@ -361,11 +412,11 @@ func (ws *WsServer) unregisterClient(client *Client) {
 	isDeleteUser := ws.clients.delete(client.UserID, client.ctx.GetRemoteAddr())
 	if isDeleteUser {
 		ws.onlineUserNum.Add(-1)
-		prom_metrics.OnlineUserGauge.Dec()
+		prommetrics.OnlineUserGauge.Dec()
 	}
 	ws.onlineUserConnNum.Add(-1)
 	ws.SetUserOnlineStatus(client.ctx, client, constant.Offline)
-	log.ZInfo(client.ctx, "user offline", "close reason", client.closedErr, "online user Num", ws.onlineUserNum, "online user conn Num",
+	log.ZInfo(client.ctx, "user offline", "close reason", client.closedErr, "online user Num", ws.onlineUserNum.Load(), "online user conn Num",
 		ws.onlineUserConnNum.Load(),
 	)
 }
@@ -404,7 +455,7 @@ func (ws *WsServer) wsHandler(w http.ResponseWriter, r *http.Request) {
 		httpError(connContext, errs.ErrConnArgsErr)
 		return
 	}
-	if err := authverify.WsVerifyToken(token, userID, platformID); err != nil {
+	if err = authverify.WsVerifyToken(token, userID, platformID); err != nil {
 		httpError(connContext, err)
 		return
 	}
@@ -427,7 +478,8 @@ func (ws *WsServer) wsHandler(w http.ResponseWriter, r *http.Request) {
 		httpError(connContext, errs.ErrTokenNotExist.Wrap())
 		return
 	}
-	wsLongConn := newGWebSocket(WebSocket, ws.handshakeTimeout)
+
+	wsLongConn := newGWebSocket(WebSocket, ws.handshakeTimeout, ws.writeBufferSize)
 	err = wsLongConn.GenerateLongConn(w, r)
 	if err != nil {
 		httpError(connContext, err)

internal/msggateway/options.go

@@ -27,6 +27,8 @@ type (
 		handshakeTimeout time.Duration
 		// 允许消息最大长度
 		messageMaxMsgLength int
+		// websocket write buffer, default: 4096, 4kb.
+		writeBufferSize int
 	}
 )
 
@@ -53,3 +55,9 @@ func WithMessageMaxMsgLength(length int) Option {
 		opt.messageMaxMsgLength = length
 	}
 }
+
+func WithWriteBufferSize(size int) Option {
+	return func(opt *configs) {
+		opt.writeBufferSize = size
+	}
+}