Merge pull request #2129 from cubxxw/automated-cherry-pick-of-#2128-upstream-release-v3.6

releasev3.6: Automated cherry pick of #2128 upstream release v3.6

.dockerignore

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

.env

@@ -1,17 +0,0 @@
-
-MONGO_IMAGE=mongo:6.0.2
-REDIS_IMAGE=redis:7.0.0
-ZOOKEEPER_IMAGE=bitnami/zookeeper:3.8
-KAFKA_IMAGE=bitnami/kafka:3.5.1
-MINIO_IMAGE=minio/minio:RELEASE.2024-01-11T07-46-16Z
-ETCD_IMAGE=quay.io/coreos/etcd:v3.5.13
-
-OPENIM_WEB_FRONT_IMAGE=openim/openim-web-front:release-v3.5.1
-OPENIM_ADMIN_FRONT_IMAGE=openim/openim-admin-front:release-v1.7
-
-#FRONT_IMAGE: use aliyun images
-#OPENIM_WEB_FRONT_IMAGE=registry.cn-hangzhou.aliyuncs.com/openimsdk/openim-web-front:release-v3.5.1
-#OPENIM_ADMIN_FRONT_IMAGE=registry.cn-hangzhou.aliyuncs.com/openimsdk/openim-admin-front:release-v1.7
-
-DATA_DIR=./
-

.gitattributes

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

.github/code-language-detector.yml

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

.github/release-drafter.yml

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

.github/standardizer.yml

@@ -1,50 +0,0 @@
-# https://github.com/marketplace/actions/conformity-checker-for-project
-baseConfig:
-  searchDirectory: "./"
-  ignoreCase: false
-
-directoryNaming:
-  allowHyphens: true
-  allowUnderscores: false
-  mustBeLowercase: true
-
-fileNaming:
-  allowHyphens: true
-  allowUnderscores: true
-  mustBeLowercase: true
-
-ignoreFormats:
-  - "\\.log$"
-  - "\\.env$"
-  - "README\\.md$"
-  - "_test\\.go$"
-  - "\\.md$"
-  - _test\\.txt$
-  - LICENSE
-  - Dockerfile
-  - CODEOWNERS
-  - Makefile
-
-ignoreDirectories:
-  - "vendor"
-  - ".git"
-  - "deployments"
-  - "node_modules"
-  - "logs"
-  - "CHANGELOG"
-  - "components"
-  - "_output"
-  - "tools/openim-web"
-  - "CHANGELOG"
-  - "examples/Test_directory"
-  - test/testdata
-
-fileTypeSpecificNaming:
-  ".yaml":
-    allowHyphens: true
-    allowUnderscores: false
-    mustBeLowercase: true
-  ".go":
-    allowHyphens: false
-    allowUnderscores: true
-    mustBeLowercase: true

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

@@ -25,7 +25,6 @@ jobs:
       - name: Comment cherry-pick command
         uses: actions/github-script@v7
         with:
-          github-token: ${{ secrets.BOT_GITHUB_TOKEN }}
           script: |
             const pr = context.payload.pull_request;
             if (!pr.merged) {
@@ -64,4 +63,5 @@ jobs:
               repo: context.repo.repo,
               issue_number: pr.number,
               body: cherryPickCmd
-            });
+            });
+          github-token: ${{ secrets.BOT_GITHUB_TOKEN }}

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

@@ -12,57 +12,23 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-name: Github Robot for Cherry Pick On Comment
-
+name: Github Rebot for Cherry Pick On Comment
 on:
   issue_comment:
     types: [created]
-
 jobs:
   cherry-pick:
     name: Cherry Pick
+    # && github.event.comment.user.login=='kubbot'
     if: github.event.issue.pull_request != '' && contains(github.event.comment.body, '/cherry-pick')
     runs-on: ubuntu-latest
-
     steps:
       - name: Checkout the latest code
         uses: actions/checkout@v4
         with:
           token: ${{ secrets.BOT_GITHUB_TOKEN }}
-          fetch-depth: 0 # To ensure all history is available for cherry-picking
-
+          fetch-depth: 0 # otherwise, you will fail to push refs to dest repo
       - name: Automatic Cherry Pick
         uses: vendoo/gha-cherry-pick@v1
-        with:
-          # Assuming the cherry-pick commit SHA is passed in the comment like '/cherry-pick sha'
-          commit-sha: ${{ github.event.comment.body }}
         env:
-          GITHUB_TOKEN: ${{ secrets.BOT_GITHUB_TOKEN }}
-
-      - name: Create a new branch for PR
-        run: |
-          PR_BRANCH="cherry-pick-${GITHUB_SHA}-to-${{ github.base_ref }}"
-          git checkout -b $PR_BRANCH
-          git push origin $PR_BRANCH
-        env:
-          GITHUB_TOKEN: ${{ secrets.BOT_GITHUB_TOKEN }}
-
-      - name: Create Pull Request
-        uses: actions/github-script@v5
-        with:
-          script: |
-            const prTitle = "Cherry-pick to ${{ github.base_ref }}"
-            const prBody = "Automated cherry-pick of ${{ github.event.comment.body }}\n\n/cc @kubbot"
-            const base = "${{ github.base_ref }}"
-            const head = "cherry-pick-${{ github.sha }}-to-${{ github.base_ref }}"
-            const createPr = await github.rest.pulls.create({
-              owner: context.repo.owner,
-              repo: context.repo.repo,
-              title: prTitle,
-              body: prBody,
-              head: head,
-              base: base,
-              maintainer_can_modify: true, // Allows maintainers to edit the PR
-            })
-        env:
-          GITHUB_TOKEN: ${{ secrets.BOT_GITHUB_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.BOT_GITHUB_TOKEN }}

.github/workflows/check-coverage.yml

@@ -0,0 +1,59 @@
+# Copyright © 2023 OpenIM open source community. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+name: OpenIM Check Coverage
+
+on:
+  workflow_dispatch:
+  push:
+    branches: [ "main" ]
+    paths-ignore:
+      - "docs/**"
+      - "**/*.md"
+      - "**/*.yaml"
+      - "CONTRIBUTORS"
+      - "CHANGELOG/**"
+  pull_request:
+    branches: [ "*" ]
+    paths-ignore:
+      - "docs/**"
+      - "**/*.md"
+      - "**/*.yaml"
+      - "CONTRIBUTORS"
+      - "CHANGELOG/**"
+env:
+  # Common versions
+  GO_VERSION: "1.20"
+
+jobs:
+  coverage:
+    runs-on: ubuntu-20.04
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Golang with cache
+        uses: magnetikonline/action-golang-cache@v4
+        with:
+          go-version: ${{ env.GO_VERSION }}
+
+      - name: Install Dependencies
+        run: sudo apt update && sudo apt install -y libgpgme-dev libbtrfs-dev libdevmapper-dev
+
+      - name: Run Cover
+        run: make cover
+        continue-on-error: true
+
+      - name: Upload Coverage to Codecov
+        uses: codecov/codecov-action@v4

.github/workflows/code-language-detector.yml

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

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

@@ -0,0 +1,77 @@
+# 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:
+  push:
+    tags:
+      - 'v*.*.0'
+
+permissions:
+  contents: write
+  actions: write
+
+jobs:
+  create-branch:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Check out code
+      uses: actions/checkout@v4
+      with:
+        fetch-depth: 0
+
+    - name: Set up Git
+      run: |
+        git config --global user.name 'kubbot'
+        git config --global user.email '3293172751yxy@gmail.com'
+
+    - name: Install git-chglog
+      run: make install.git-chglog
+
+    - name: Create Branch and Push
+      env:
+        TAG_NAME: ${{ github.ref_name }}
+      run: |
+        IFS='.' read -ra VERSION_PARTS <<< "$TAG_NAME"
+        if [[ "${VERSION_PARTS[2]}" = "0" ]]; then
+          BRANCH_NAME="release-v${VERSION_PARTS[0]}.${VERSION_PARTS[1]}"
+          echo "Creating branch $BRANCH_NAME"
+          git checkout -b "$BRANCH_NAME"
+          git push origin "$BRANCH_NAME"
+        else
+          echo "Not a release tag. Skipping branch creation."
+        fi
+      continue-on-error: true
+
+    - name: Create and Commit CHANGELOG
+      if: endsWith(github.ref_name, '.0')
+      run: |
+        git fetch --all
+        TAG_NAME=${GITHUB_REF#refs/tags/}
+        IFS='.' read -ra VERSION_PARTS <<< "$TAG_NAME"
+        git checkout main
+        cd CHANGELOG
+        git-chglog --tag-filter-pattern "v${VERSION_PARTS[0]}.${VERSION_PARTS[1]}.*" -o "CHANGELOG-${VERSION_PARTS[0]}.${VERSION_PARTS[1]}.md"
+        git add "CHANGELOG-${VERSION_PARTS[0]}.${VERSION_PARTS[1]}.md"
+        git commit -m "Update CHANGELOG for $TAG_NAME" || echo "No changes to commit."
+      continue-on-error: true
+
+    - name: Push CHANGELOG to Main
+      if: steps.create-and-commit-changelog.outputs.changes == 'true'
+      uses: ad-m/github-push-action@v0.8.0
+      with:
+        github_token: ${{ secrets.BOT_GITHUB_TOKEN }}
+        branch: main
+    continue-on-error: true

.github/workflows/docker-buildx.yml

@@ -0,0 +1,502 @@
+# 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: Docker Buildx Images CI
+
+on:
+  schedule:
+  - cron: '30 1 * * *'
+  push:
+    branches:
+      - release-*
+    tags:
+      - v*
+  workflow_dispatch:
+
+jobs:
+  build-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
+        with:
+          install: true
+
+      - name: Cache Docker layers
+        uses: actions/cache@v4
+        with:
+          path: /tmp/.buildx-cache
+          key: ${{ runner.os }}-buildx-${{ github.sha }}
+          restore-keys: |
+            ${{ runner.os }}-buildx-
+
+      - 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: Log in to Docker Hub
+        uses: docker/login-action@v3
+        with:
+          username: ${{ secrets.DOCKER_USERNAME }}
+          password: ${{ secrets.DOCKER_PASSWORD }}
+
+      - 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 }}
+
+################################################
+# build/
+# └── docker
+#     ├── openim-api
+#     │   └── Dockerfile
+#     ├── openim-cmdutils
+#     │   └── Dockerfile
+#     ├── openim-crontask
+#     │   └── Dockerfile
+#     ├── openim-msggateway
+#     │   └── Dockerfile
+#     ├── openim-msgtransfer
+#     │   └── Dockerfile
+#     ├── openim-push
+#     │   └── Dockerfile
+#     ├── openim-rpc-auth
+#     │   └── Dockerfile
+#     ├── openim-rpc-conversation
+#     │   └── Dockerfile
+#     ├── openim-rpc-friend
+#     │   └── Dockerfile
+#     ├── openim-rpc-group
+#     │   └── Dockerfile
+#     ├── openim-rpc-msg
+#     │   └── Dockerfile
+#     ├── openim-rpc-third
+#     │   └── Dockerfile
+#     └── openim-rpc-user
+#         └── Dockerfile
+#############################################
+
+      - name: Extract metadata (tags, labels) for Docker openim-api
+        id: meta1
+        uses: docker/metadata-action@v5.5.1
+        with:
+          images: |
+            ghcr.io/openimsdk/openim-api
+            openim/openim-api
+            registry.cn-hangzhou.aliyuncs.com/openimsdk/openim-api
+          tags: |
+            type=ref,event=tag
+            type=schedule
+            type=ref,event=branch
+            type=ref,event=pr
+            type=semver,pattern={{version}}
+            type=semver,pattern=v{{version}}
+            type=semver,pattern={{major}}.{{minor}}
+            type=semver,pattern={{major}}
+            type=sha
+
+      - name: Build and push Docker image for openim-api
+        uses: docker/build-push-action@v5
+        with:
+          context: .
+          file: ./build/images/openim-api/Dockerfile
+          platforms: linux/amd64,linux/arm64
+          push: ${{ github.event_name != 'pull_request' }}
+          tags: ${{ steps.meta1.outputs.tags }}
+          labels: ${{ steps.meta1.outputs.labels }}
+          cache-from: type=local,src=/tmp/.buildx-cache
+          cache-to: type=local,dest=/tmp/.buildx-cache
+
+      - name: Extract metadata (tags, labels) for Docker openim-cmdutils
+        id: meta2
+        uses: docker/metadata-action@v5.5.1
+        with:
+          images: |
+            ghcr.io/openimsdk/openim-cmdutils
+            openim/openim-cmdutils
+            registry.cn-hangzhou.aliyuncs.com/openimsdk/openim-cmdutils
+          tags: |
+            type=ref,event=tag
+            type=schedule
+            type=ref,event=branch
+            type=ref,event=pr
+            type=semver,pattern={{version}}
+            type=semver,pattern=v{{version}}
+            type=semver,pattern={{major}}.{{minor}}
+            type=semver,pattern={{major}}
+            type=sha
+
+      - name: Build and push Docker image for openim-cmdutils
+        uses: docker/build-push-action@v5
+        with:
+          context: .
+          file: ./build/images/openim-cmdutils/Dockerfile
+          platforms: linux/amd64,linux/arm64
+          push: ${{ github.event_name != 'pull_request' }}
+          tags: ${{ steps.meta2.outputs.tags }}
+          labels: ${{ steps.meta2.outputs.labels }}
+          cache-from: type=local,src=/tmp/.buildx-cache
+          cache-to: type=local,dest=/tmp/.buildx-cache
+
+      - name: Extract metadata (tags, labels) for Docker openim-crontask
+        id: meta3
+        uses: docker/metadata-action@v5.5.1
+        with:
+          images: |
+            ghcr.io/openimsdk/openim-crontask
+            openim/openim-crontask
+            registry.cn-hangzhou.aliyuncs.com/openimsdk/openim-crontask
+          tags: |
+            type=ref,event=tag
+            type=schedule
+            type=ref,event=branch
+            type=ref,event=pr
+            type=semver,pattern={{version}}
+            type=semver,pattern=v{{version}}
+            type=semver,pattern={{major}}.{{minor}}
+            type=semver,pattern={{major}}
+            type=sha
+
+      - name: Build and push Docker image for openim-crontask
+        uses: docker/build-push-action@v5
+        with:
+          context: .
+          file: ./build/images/openim-crontask/Dockerfile
+          platforms: linux/amd64,linux/arm64
+          push: ${{ github.event_name != 'pull_request' }}
+          tags: ${{ steps.meta3.outputs.tags }}
+          labels: ${{ steps.meta3.outputs.labels }}
+          cache-from: type=local,src=/tmp/.buildx-cache
+          cache-to: type=local,dest=/tmp/.buildx-cache
+
+      - name: Extract metadata (tags, labels) for Docker openim-msggateway
+        id: meta4
+        uses: docker/metadata-action@v5.5.1
+        with:
+          images: |
+            ghcr.io/openimsdk/openim-msggateway
+            openim/openim-msggateway
+            registry.cn-hangzhou.aliyuncs.com/openimsdk/openim-msggateway
+          tags: |
+            type=ref,event=tag
+            type=schedule
+            type=ref,event=branch
+            type=ref,event=pr
+            type=semver,pattern={{version}}
+            type=semver,pattern=v{{version}}
+            type=semver,pattern={{major}}.{{minor}}
+            type=semver,pattern={{major}}
+            type=sha
+
+      - name: Build and push Docker image for openim-msggateway
+        uses: docker/build-push-action@v5
+        with:
+          context: .
+          file: ./build/images/openim-msggateway/Dockerfile
+          platforms: linux/amd64,linux/arm64
+          push: ${{ github.event_name != 'pull_request' }}
+          tags: ${{ steps.meta4.outputs.tags }}
+          labels: ${{ steps.meta4.outputs.labels }}
+          cache-from: type=local,src=/tmp/.buildx-cache
+          cache-to: type=local,dest=/tmp/.buildx-cache
+
+      - name: Extract metadata (tags, labels) for Docker openim-msgtransfer
+        id: meta5
+        uses: docker/metadata-action@v5.5.1
+        with:
+          images: |
+            ghcr.io/openimsdk/openim-msgtransfer
+            openim/openim-msgtransfer
+            registry.cn-hangzhou.aliyuncs.com/openimsdk/openim-msgtransfer
+          tags: |
+            type=ref,event=tag
+            type=schedule
+            type=ref,event=branch
+            type=ref,event=pr
+            type=semver,pattern={{version}}
+            type=semver,pattern=v{{version}}
+            type=semver,pattern={{major}}.{{minor}}
+            type=semver,pattern={{major}}
+            type=sha
+
+      - name: Build and push Docker image for openim-msgtransfer
+        uses: docker/build-push-action@v5
+        with:
+          context: .
+          file: ./build/images/openim-msgtransfer/Dockerfile
+          platforms: linux/amd64,linux/arm64
+          push: ${{ github.event_name != 'pull_request' }}
+          tags: ${{ steps.meta5.outputs.tags }}
+          labels: ${{ steps.meta5.outputs.labels }}
+          cache-from: type=local,src=/tmp/.buildx-cache
+          cache-to: type=local,dest=/tmp/.buildx-cache
+          
+      - name: Extract metadata (tags, labels) for Docker openim-push
+        id: meta6
+        uses: docker/metadata-action@v5.5.1
+        with:
+          images: |
+            ghcr.io/openimsdk/openim-push
+            openim/openim-push
+            registry.cn-hangzhou.aliyuncs.com/openimsdk/openim-push
+          tags: |
+            type=ref,event=tag
+            type=schedule
+            type=ref,event=branch
+            type=ref,event=pr
+            type=semver,pattern={{version}}
+            type=semver,pattern=v{{version}}
+            type=semver,pattern={{major}}.{{minor}}
+            type=semver,pattern={{major}}
+            type=sha
+
+      - name: Build and push Docker image for openim-push
+        uses: docker/build-push-action@v5
+        with:
+          context: .
+          file: ./build/images/openim-push/Dockerfile
+          platforms: linux/amd64,linux/arm64
+          push: ${{ github.event_name != 'pull_request' }}
+          tags: ${{ steps.meta6.outputs.tags }}
+          labels: ${{ steps.meta6.outputs.labels }}
+          cache-from: type=local,src=/tmp/.buildx-cache
+          cache-to: type=local,dest=/tmp/.buildx-cache
+
+      - name: Extract metadata (tags, labels) for Docker openim-rpc-auth
+        id: meta7
+        uses: docker/metadata-action@v5.5.1
+        with:
+          images: |
+            ghcr.io/openimsdk/openim-rpc-auth
+            openim/openim-rpc-auth
+            registry.cn-hangzhou.aliyuncs.com/openimsdk/openim-rpc-auth
+          tags: |
+            type=ref,event=tag
+            type=schedule
+            type=ref,event=branch
+            type=ref,event=pr
+            type=semver,pattern={{version}}
+            type=semver,pattern=v{{version}}
+            type=semver,pattern={{major}}.{{minor}}
+            type=semver,pattern={{major}}
+            type=sha
+
+      - name: Build and push Docker image for openim-rpc-auth
+        uses: docker/build-push-action@v5
+        with:
+          context: .
+          file: ./build/images/openim-rpc-auth/Dockerfile
+          platforms: linux/amd64,linux/arm64
+          push: ${{ github.event_name != 'pull_request' }}
+          tags: ${{ steps.meta7.outputs.tags }}
+          labels: ${{ steps.meta7.outputs.labels }}
+          cache-from: type=local,src=/tmp/.buildx-cache
+          cache-to: type=local,dest=/tmp/.buildx-cache
+
+      - name: Extract metadata (tags, labels) for Docker openim-rpc-conversation
+        id: meta8
+        uses: docker/metadata-action@v5.5.1
+        with:
+          images: |
+            ghcr.io/openimsdk/openim-rpc-conversation
+            openim/openim-rpc-conversation
+            registry.cn-hangzhou.aliyuncs.com/openimsdk/openim-rpc-conversation
+          tags: |
+            type=ref,event=tag
+            type=schedule
+            type=ref,event=branch
+            type=ref,event=pr
+            type=semver,pattern={{version}}
+            type=semver,pattern=v{{version}}
+            type=semver,pattern={{major}}.{{minor}}
+            type=semver,pattern={{major}}
+            type=sha
+
+      - name: Build and push Docker image for openim-rpc-conversation
+        uses: docker/build-push-action@v5
+        with:
+          context: .
+          file: ./build/images/openim-rpc-conversation/Dockerfile
+          platforms: linux/amd64,linux/arm64
+          push: ${{ github.event_name != 'pull_request' }}
+          tags: ${{ steps.meta8.outputs.tags }}
+          labels: ${{ steps.meta8.outputs.labels }}
+          cache-from: type=local,src=/tmp/.buildx-cache
+          cache-to: type=local,dest=/tmp/.buildx-cache
+
+      - name: Extract metadata (tags, labels) for Docker openim-rpc-friend
+        id: meta9
+        uses: docker/metadata-action@v5.5.1
+        with:
+          images: |
+            ghcr.io/openimsdk/openim-rpc-friend
+            openim/openim-rpc-friend
+            registry.cn-hangzhou.aliyuncs.com/openimsdk/openim-rpc-friend
+          tags: |
+            type=ref,event=tag
+            type=schedule
+            type=ref,event=branch
+            type=ref,event=pr
+            type=semver,pattern={{version}}
+            type=semver,pattern=v{{version}}
+            type=semver,pattern={{major}}.{{minor}}
+            type=semver,pattern={{major}}
+            type=sha
+
+      - name: Build and push Docker image for openim-rpc-friend
+        uses: docker/build-push-action@v5
+        with:
+          context: .
+          file: ./build/images/openim-rpc-friend/Dockerfile
+          platforms: linux/amd64,linux/arm64
+          push: ${{ github.event_name != 'pull_request' }}
+          tags: ${{ steps.meta9.outputs.tags }}
+          labels: ${{ steps.meta9.outputs.labels }}
+          cache-from: type=local,src=/tmp/.buildx-cache
+          cache-to: type=local,dest=/tmp/.buildx-cache
+
+      - name: Extract metadata (tags, labels) for Docker openim-rpc-group
+        id: meta10
+        uses: docker/metadata-action@v5.5.1
+        with:
+          images: |
+            ghcr.io/openimsdk/openim-rpc-group
+            openim/openim-rpc-group
+            registry.cn-hangzhou.aliyuncs.com/openimsdk/openim-rpc-group
+          tags: |
+            type=ref,event=tag
+            type=schedule
+            type=ref,event=branch
+            type=ref,event=pr
+            type=semver,pattern={{version}}
+            type=semver,pattern=v{{version}}
+            type=semver,pattern={{major}}.{{minor}}
+            type=semver,pattern={{major}}
+            type=sha
+
+      - name: Build and push Docker image for openim-rpc-group
+        uses: docker/build-push-action@v5
+        with:
+          context: .
+          file: ./build/images/openim-rpc-group/Dockerfile
+          platforms: linux/amd64,linux/arm64
+          push: ${{ github.event_name != 'pull_request' }}
+          tags: ${{ steps.meta10.outputs.tags }}
+          labels: ${{ steps.meta10.outputs.labels }}
+          cache-from: type=local,src=/tmp/.buildx-cache
+          cache-to: type=local,dest=/tmp/.buildx-cache
+
+      - name: Extract metadata (tags, labels) for Docker openim-rpc-msg
+        id: meta11
+        uses: docker/metadata-action@v5.5.1
+        with:
+          images: |
+            ghcr.io/openimsdk/openim-rpc-msg
+            openim/openim-rpc-msg
+            registry.cn-hangzhou.aliyuncs.com/openimsdk/openim-rpc-msg
+          tags: |
+            type=ref,event=tag
+            type=schedule
+            type=ref,event=branch
+            type=ref,event=pr
+            type=semver,pattern={{version}}
+            type=semver,pattern=v{{version}}
+            type=semver,pattern={{major}}.{{minor}}
+            type=semver,pattern={{major}}
+            type=sha
+
+      - name: Build and push Docker image for openim-rpc-msg
+        uses: docker/build-push-action@v5
+        with:
+          context: .
+          file: ./build/images/openim-rpc-msg/Dockerfile
+          platforms: linux/amd64,linux/arm64
+          push: ${{ github.event_name != 'pull_request' }}
+          tags: ${{ steps.meta11.outputs.tags }}
+          labels: ${{ steps.meta11.outputs.labels }}
+          cache-from: type=local,src=/tmp/.buildx-cache
+          cache-to: type=local,dest=/tmp/.buildx-cache
+
+      - name: Extract metadata (tags, labels) for Docker openim-rpc-third
+        id: meta12
+        uses: docker/metadata-action@v5.5.1
+        with:
+          images: |
+            ghcr.io/openimsdk/openim-rpc-third
+            openim/openim-rpc-third
+            registry.cn-hangzhou.aliyuncs.com/openimsdk/openim-rpc-third
+          tags: |
+            type=ref,event=tag
+            type=schedule
+            type=ref,event=branch
+            type=ref,event=pr
+            type=semver,pattern={{version}}
+            type=semver,pattern=v{{version}}
+            type=semver,pattern={{major}}.{{minor}}
+            type=semver,pattern={{major}}
+            type=sha
+
+      - name: Build and push Docker image for openim-rpc-third
+        uses: docker/build-push-action@v5
+        with:
+          context: .
+          file: ./build/images/openim-rpc-third/Dockerfile
+          platforms: linux/amd64,linux/arm64
+          push: ${{ github.event_name != 'pull_request' }}
+          tags: ${{ steps.meta12.outputs.tags }}
+          labels: ${{ steps.meta12.outputs.labels }}
+          cache-from: type=local,src=/tmp/.buildx-cache
+          cache-to: type=local,dest=/tmp/.buildx-cache
+
+      - name: Extract metadata (tags, labels) for Docker openim-rpc-user
+        id: meta13
+        uses: docker/metadata-action@v5.5.1
+        with:
+          images: |
+            ghcr.io/openimsdk/openim-rpc-user
+            openim/openim-rpc-user
+            registry.cn-hangzhou.aliyuncs.com/openimsdk/openim-rpc-user
+          tags: |
+            type=ref,event=tag
+            type=schedule
+            type=ref,event=branch
+            type=ref,event=pr
+            type=semver,pattern={{version}}
+            type=semver,pattern=v{{version}}
+            type=semver,pattern={{major}}.{{minor}}
+            type=semver,pattern={{major}}
+            type=sha
+
+      - name: Build and push Docker image for openim-rpc-user
+        uses: docker/build-push-action@v5
+        with:
+          context: .
+          file: ./build/images/openim-rpc-user/Dockerfile
+          platforms: linux/amd64,linux/arm64
+          push: ${{ github.event_name != 'pull_request' }}
+          tags: ${{ steps.meta13.outputs.tags }}
+          labels: ${{ steps.meta13.outputs.labels }}
+          cache-from: type=local,src=/tmp/.buildx-cache
+          cache-to: type=local,dest=/tmp/.buildx-cache

.github/workflows/e2e-test.yml

@@ -0,0 +1,146 @@
+# Copyright © 2023 OpenIM. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+name: OpenIM Linux System E2E Test
+
+on:
+  workflow_dispatch:
+  pull_request:
+  push:
+  schedule:
+    # run e2e test every 4 hours
+    - cron: 0 */4 * * *
+
+env:
+  CALLBACK_ENABLE: true
+
+jobs:
+  build:
+    name: Test
+    runs-on: ubuntu-latest
+    env:
+      GO111MODULE: on
+    steps:
+
+      - name: Set up Go 1.21
+        uses: actions/setup-go@v5
+        with:
+          go-version: 1.21
+        id: go
+
+      - name: Check out code into the Go module directory
+        uses: actions/checkout@v4
+
+      - name: Create e2e test
+        run: |
+          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@v5
+      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
+        mkdir -p ./tmp
+        touch ./tmp/test.md
+        echo "# OpenIM Test" >> ./tmp/test.md
+        echo "## OpenIM API Test" >> ./tmp/test.md
+        echo "<details><summary>Command Output for OpenIM API Test</summary>" >> ./tmp/test.md
+        echo "<pre><code>" >> ./tmp/test.md
+        sudo make test-api | tee -a ./tmp/test.md
+        echo "</code></pre>" >> ./tmp/test.md
+        echo "</details>" >> ./tmp/test.md
+
+    - name: Exec OpenIM E2E Test
+      run: |
+        sudo make test-e2e
+        echo "" >> ./tmp/test.md
+        echo "## OpenIM E2E Test" >> ./tmp/test.md
+        echo "<details><summary>Command Output for OpenIM E2E Test</summary>" >> ./tmp/test.md
+        echo "<pre><code>" >> ./tmp/test.md
+        sudo make test-e2e | tee -a ./tmp/test.md
+        echo "</code></pre>" >> ./tmp/test.md
+        echo "</details>" >> ./tmp/test.md
+
+    - name: Comment PR with file
+      uses: thollander/actions-comment-pull-request@v2
+      with:
+        filePath: ./tmp/test.md
+        comment_tag: nrt_file
+        reactions: eyes, rocket
+        mode: recreate
+        GITHUB_TOKEN: ${{ secrets.BOT_GITHUB_TOKEN }}
+      continue-on-error: true
+
+    - name: Check outputs
+      run: |
+        echo "id : ${{ steps.nrt_message.outputs.id }}"
+        echo "body : ${{ steps.nrt_message.outputs.body }}"
+        echo "html_url : ${{ steps.nrt_message.outputs.html_url }}"
+
+    - 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/golangci-lint.yml

@@ -0,0 +1,52 @@
+# Copyright © 2023 OpenIM open source community. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+name: OpenIM golangci-lint
+on:
+  push:
+    branches: [main]
+  pull_request:
+jobs:
+    golangci:
+      name: lint
+      runs-on: ubuntu-latest
+      steps:
+        - uses: actions/checkout@v4
+        - uses: actions/setup-go@v5
+          with:
+            go-version: '1.21'
+            cache: false
+        - name: OpenIM Scripts Verification(make verify)
+          run: sudo make verify
+        - name: golangci-lint
+          uses: golangci/golangci-lint-action@v4.0.0
+          with:
+            # Require: version of golangci-lint to use in form of v1.2 or v1.2.3 or `latest` to use the latest version
+            version: v1.54
+
+            # Optional: working directory, useful for monorepos
+            # working-directory: server
+
+            # Optional: golangci-lint command line arguments.
+            # 
+            # Note: by default the `.golangci.yml` file should be at the root of the repository.
+            # The location of the configuration file can be changed by using `--config=`
+            # args: --timeout=30m --config=/scripts/.golangci.yml --issues-exit-code=0
+
+            # Optional: show only new issues if it's a pull request. The default value is `false`.
+            only-new-issues: true
+
+            # Optional:The mode to install golangci-lint. It can be 'binary' or 'goinstall'.
+            # install-mode: "goinstall"

.github/workflows/milestone.yml

@@ -41,7 +41,6 @@ jobs:
     steps:
       - uses: actions/github-script@v7 # v6
         with:
-          github-token: ${{ secrets.BOT_GITHUB_TOKEN }}
           script: |
             if (!context.payload.pull_request.merged) {
               console.log('PR was not merged, skipping.');
@@ -57,10 +56,9 @@ jobs:
               owner: context.repo.owner,
               repo: context.repo.repo,
               state: 'open',
-              sort: 'title',
-              direction: 'desc'
+              sort: 'due_on',
+              direction: 'asc'
             })
-
             if (milestones.data.length === 0) {
               console.log('There are no milestones, skipping.');
               return;

.github/workflows/openimci.yml

@@ -1,4 +1,3 @@
-
 # Copyright © 2023 OpenIM open source community. All rights reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -12,7 +11,8 @@
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.
-name: OpenIM CI Auto Build
+
+name: OpenIM CI Aotu Build and Install
 
 on: 
   push:
@@ -36,156 +36,264 @@ on:
         - "CONTRIBUTING/**"
         - "**.md"
         - "docs/**"
-  workflow_dispatch:
+
+env:
+  GO_VERSION: "1.19"
+  GOLANGCI_VERSION: "v1.50.1"
 
 jobs:
-
-  build-linux:
-    name: Execute OpenIM Script On Linux
-    runs-on: ubuntu-latest
+  openim:
+    name: Test with go ${{ matrix.go_version }} on ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
     permissions:
-      contents: write
-      pull-requests: write
+        contents: write
+        pull-requests: write
     environment:
       name: openim
     strategy:
       matrix:
-        arch: [arm64, armv7, amd64]
-    
+        go_version: ["1.19","1.20","1.21"]
+        os: [ubuntu-latest]
     steps:
-    - uses: actions/checkout@v3
-
-    - name: Set up Go
-      uses: actions/setup-go@v4
+    - name: Setup
+      uses: actions/checkout@v4
+      
+    - name: Set up Go ${{ matrix.go_version }}
+      uses: actions/setup-go@v5
       with:
-        go-version: '1.21'
+        go-version: ${{ matrix.go_version }}
+      id: go
 
-    - name: Set up Docker for Linux
+    - name: Install Task
+      uses: arduino/setup-task@v1
+      with:
+        version: '3.x' # If available, use the latest major version that's compatible
+        repo-token: ${{ secrets.GITHUB_TOKEN }}
+
+    - name: Module Operations
       run: |
+        sudo make tidy
+        sudo make tools.verify.go-gitlint
+
+    - name: Format Code
+      run: sudo make format
+      continue-on-error: true
+
+    - name: Generate Files
+      run: make gen
+      continue-on-error: true
+
+    - name: Build Source
+      run: sudo make build
+
+    - name: Build multiarch PLATFORMS
+      if: startsWith(github.ref, 'refs/heads/release-')
+      run: |
+        sudo make multiarch
+
+    - name: Cleanup Build
+      run: sudo make clean
+
+    - name: Set Current Directory
+      id: set_directory
+      run: echo "::set-output name=directory::$(pwd)"
+      continue-on-error: true
+
+    - name: Collect and Display Test Coverage
+      id: collect_coverage
+      run: |
+        cd ${{ steps.set_directory.outputs.directory }}
+        make cover
+        echo "::set-output name=coverage_file::./_output/tmp/coverage.out"
+        echo "Test Coverage:"
+        cat ${{ steps.collect_coverage.outputs.coverage_file }}
+      continue-on-error: true
+
+  openim-start:
+    name: Test OpenIM install/start on ${{ matrix.os }}-${{ matrix.arch }}
+    runs-on: ${{ matrix.os }}
+    permissions:
+        contents: write
+        pull-requests: write
+    environment:
+      name: openim
+    strategy:
+      matrix:
+        go_version: ["1.21"]
+        os: ["ubuntu-latest"]
+    steps:
+    - name: Checkout and Install OpenIM
+      uses: actions/checkout@v4
+    - name: Install Task
+      uses: arduino/setup-task@v1
+      with:
+        version: '3.x' # If available, use the latest major version that's compatible
+        repo-token: ${{ secrets.GITHUB_TOKEN }}
+    - name: Run OpenIM make install start
+      run: |
+        sudo make install
+
+    # - name: Check the OpenIM environment and status
+    #   run: |
+    #     sudo docker images
+    #     sudo docker ps
+
+    - name: Check the OpenIM environment and status
+      if: runner.os == 'Linux' && matrix.arch == 'amd64'
+      id: docker_info
+      run: |
+        sleep 30
+        echo "images<<EOF" >> $GITHUB_ENV
+        sudo docker images >> $GITHUB_ENV
+        echo "EOF" >> $GITHUB_ENV
+        echo "containers<<EOF" >> $GITHUB_ENV
+        sudo docker ps >> $GITHUB_ENV
+        echo "EOF" >> $GITHUB_ENV
+
+    - name: Comment PR
+      uses: thollander/actions-comment-pull-request@v2
+      if: runner.os == 'Linux' && matrix.arch == 'amd64'
+      with:
+        message: |
+          > [!TIP]
+          > Run make install to check the status
+
+          ### Docker Images:
+          <details><summary>Click to expand docker images</summary>
+          ```bash
+          ${{ env.images }}
+          ```
+          </details>
+
+          ### Docker Processes:
+          <details><summary>Click to expand docker ps</summary>
+          ```bash
+          ${{ env.containers }}
+          ```
+          </details>
+        GITHUB_TOKEN: ${{ secrets.BOT_GITHUB_TOKEN }}
+
+  execute-scripts:
+    name: Execute OpenIM Script On ${{ matrix.os }}-${{ matrix.arch }}
+    runs-on: ${{ matrix.os }}
+    permissions:
+        contents: write
+        pull-requests: write
+    environment:
+      name: openim
+    strategy:
+      matrix:
+        go_version: ["1.21"]
+        os: ["ubuntu-latest", "macos-latest"]
+        arch: [arm64, armv7, amd64]
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v4
+
+    - name: Set up Go ${{ matrix.go_version }}
+      uses: actions/setup-go@v5
+      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: Install latest Bash (macOS only)
+    #   if: runner.os == 'macOS' && matrix.arch == 'arm64'
+    #   run: |
+    #     /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
+    #     brew update
+    
+    #     brew install bash
+    #     brew install gnu-sed
+    
+    #     echo "/usr/local/bin" >> $GITHUB_PATH
+    #     echo "$(brew --prefix)/opt/gnu-sed/libexec/gnubin" >> $GITHUB_PATH
+    #   continue-on-error: true
+
+    - name: Set up Docker for Ubuntu
+      if: runner.os == 'Linux'
+      run: |
+        sudo make init
         sudo docker compose up -d
-        sudo sleep 30  # Increased sleep time for better stability
-      timeout-minutes: 20  # Increased timeout for Docker setup
+        sudo sleep 20
 
+    # - name: Set up Docker for macOS
+    #   if: runner.os == 'macOS' && matrix.arch == 'arm64'
+    #   run: |
+    #     brew install --cask docker
+    #     open /Applications/Docker.app
 
-    - name: init
-      run: sudo bash bootstrap.sh
-      timeout-minutes: 20
+    #     sleep 10
+    #     docker-compose --version || brew install docker-compose
 
-    - name: Build, Start, Check Services and Print Logs for Linux
+    #     docker-compose up -d
+    #     sleep 20
+
+    - name: Module Operations for Ubuntu
+      if: runner.os == 'Linux'
       run: |
-        sudo mage
-        sudo mage start
-        sudo mage check
-        
+        sudo make tidy
+        sudo make tools.verify.go-gitlint
 
-    - name: Restart Services and Print Logs
+    # - name: Module Operations for macOS
+    #   if: runner.os == 'macOS'
+    #   run: |
+    #     make tidy
+    #     make tools.verify.go-gitlint
+
+    - name: Build, Start, Check Services and Print Logs for Ubuntu
+      if: runner.os == 'Linux'
       run: |
-        sudo mage stop
-        sudo mage start
-        sudo mage check
+        sudo make build
+        sudo make start
+        sudo make check
 
+    - name: Restart Services and Print Logs for Ubuntu
+      if: runner.os == 'Linux' && matrix.arch == 'amd64'
+      run: |
+        sudo make restart
+        sudo make check
 
-#  build-mac:
-#    name: Execute OpenIM Script On macOS
-#    runs-on: macos-latest
-#    permissions:
-#      contents: write
-#      pull-requests: write
-#    environment:
-#      name: openim
-#    strategy:
-#      matrix:
-#        arch: [arm64, armv7, amd64]
-#    
-#    steps:
-#    - uses: actions/checkout@v3
+    - name: Build, Start, Check Services and Print Logs for macOS
+      if: runner.os == 'macOS' && matrix.arch == 'arm64'
+      run: |
+        make build
 
-#    - name: Set up Go
-#      uses: actions/setup-go@v4
-#      with:
-#        go-version: '1.21'
+  openim-test-build-image:
+    name: Build OpenIM Docker Image
+    runs-on: ubuntu-latest
+    permissions:
+        contents: write
+        pull-requests: write
+    environment:
+      name: openim
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v4
+    - name: Set up Go ${{ matrix.go_version }}
+      uses: actions/setup-go@v5
+      with:
+        go-version: ${{ matrix.go_version }}
+      id: go
 
-        
-#        while ! docker system info > /dev/null 2>&1; do
-#          echo "Waiting for Docker to start..."
-#          sleep 10  # Increased delay to ensure Docker starts properly
-#        done
+    - name: Install Task
+      uses: arduino/setup-task@v1
+      with:
+        version: '3.x' # If available, use the latest major version that's compatible
+        repo-token: ${{ secrets.GITHUB_TOKEN }}
 
-#    - name: Install Docker
-#      run: |
-#        brew install docker
-#        brew install docker-compose
-#        sleep 10
-#        docker-compose up -d
-#        sleep 30
-#      timeout-minutes: 20 
-#        
+    - name: Test Docker Build
+      run: |
+        sudo make init
+        sudo make image
 
-#    - name: init
-#      run: sudo bash bootstrap.sh
-#      timeout-minutes: 20
-
-#    - name: Build, Start, Check Services and Print Logs for Linux
-#      run: |
-#        sudo mage
-#        sudo mage start
-#        sudo mage check
-        
-#    - name: Restart Services and Print Logs
-#      run: |
-#        sudo mage stop
-#        sudo mage start
-#        sudo mage check
-
-#  build-windows:
-#    name: Execute OpenIM Script On Windows
-#    runs-on: windows-latest
-#    permissions:
-#      contents: write
-#      pull-requests: write
-#    environment:
-#      name: openim
-#    strategy:
-#      matrix:
-#        arch: [arm64, armv7, amd64]
-#    
-#    steps:
-#    - uses: actions/checkout@v3
-
-#    - name: Set up Go
-#      uses: actions/setup-go@v4
-#      with:
-#        go-version: '1.21'
-
-#    - name: Set up Docker for Windows
-#      run: |
-#        $images = @("zookeeper", "redis", "kafka")
-#        foreach ($image in $images) {
-#          $tag = "$image:latest"
-#          docker pull $tag | Out-Null
-#          if ($LASTEXITCODE -ne 0) {
-#            Write-Host "Skipping $image as it is not available for Windows"
-#          } else {
-#            Write-Host "Successfully pulled $image"
-#          }
-#        }
-#        docker compose up -d
-#        Start-Sleep -Seconds 30
-#      timeout-minutes: 20
-#      shell: pwsh
-
-#    - name: init
-#      run: bootstrap.bat
-#      timeout-minutes: 20
-
-#    - name: Build, Start, Check Services and Print Logs for Linux
-#      run: |
-#        mage
-#        mage start
-#        mage check        
-
-#    - name: Restart Services and Print Logs
-#      run: |
-#        mage stop
-#        mage start
-#        mage check
+    - name: Get OpenIM Docker Images Status
+      id: docker_processes
+      run: |
+        sudo docker images
+        sudo docker ps

.github/workflows/pull-request.yml

@@ -56,8 +56,7 @@ jobs:
 
       - name: Generate all necessary files, such as error code files
         run: |
-          make gen.docgo.doc
-          make gen
+          make generate
           echo "Generate all necessary files successfully"
         continue-on-error: true
 
@@ -69,9 +68,9 @@ jobs:
           echo "Generate all necessary files successfully"
         continue-on-error: true
 
-      - name: Generate Versions Including Pre-release Identifiers
+      - name: Generate Vertions
         run: |
-          latest_tag=$(git describe --tags `git rev-list --tags --max-count=1`)
+          latest_tag=$(git describe --tags `git rev-list --tags --max-count=1` | grep -oE '[0-9]+\.[0-9]+\.[0-9]+')
           echo $latest_tag > pkg/common/config/version
         continue-on-error: true
 

.github/workflows/release.yml

@@ -0,0 +1,81 @@
+# Copyright © 2023 OpenIM. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+name: OpenIM Server Release Workflow
+
+on:
+  push:
+    # run only against tags
+    tags:
+      - '*'
+
+permissions:
+  contents: write
+  packages: write
+  issues: write
+
+jobs:
+  goreleaser:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - run: git fetch --force --tags
+      - uses: actions/setup-go@v5
+        with:
+          go-version: stable
+      # More assembly might be required: Docker logins, GPG, etc. It all depends
+      # on your needs.
+      - uses: goreleaser/goreleaser-action@v5
+        with:
+          # either 'goreleaser' (default) or 'goreleaser-pro':
+          distribution: goreleaser
+          version: latest
+          workdir: .
+          args: release -f ./build/goreleaser.yaml --clean --release-footer-tmpl=scripts/template/footer.md.tmpl --release-header-tmpl=scripts/template/head.md.tmpl
+        env:
+          USERNAME: ${{ github.repository_owner }}
+          GITHUB_TOKEN: ${{ secrets.BOT_GITHUB_TOKEN }}
+          FURY_TOKEN: ${{ secrets.FURY_TOKEN }}
+          # Your GoReleaser Pro key, if you are using the 'goreleaser-pro'
+          # distribution:
+          # GORELEASER_KEY: ${{ secrets.GORELEASER_KEY }}
+
+  goreleaser-check-pkgs:
+    runs-on: ubuntu-latest
+    env:
+      DOCKER_CLI_EXPERIMENTAL: "enabled"
+    needs: [ goreleaser ]
+    if: github.ref == 'refs/heads/main'
+    strategy:
+      matrix:
+        format: [ deb, rpm, apk ]
+    steps:
+      - uses: actions/checkout@v4 # v3
+        with:
+          fetch-depth: 0
+      - uses: arduino/setup-task@e26d8975574116b0097a1161e0fe16ba75d84c1c # v1
+        with:
+          version: 3.x
+          repo-token: ${{ secrets.GITHUB_TOKEN }}
+      - uses: docker/setup-qemu-action@326560df218a7ea9cf6ab49bbc88b8b306bb437e # v2
+      - uses: actions/cache@a2ed59d39b352305bdd2f628719a53b2cc4f9613 # v3
+        with:
+          path: |
+            ./_output/dist/*.deb
+            ./_output/dist/*.rpm
+            ./_output/dist/*.apk
+          key: ${{ github.ref }}
+      - run: task goreleaser:test:${{ matrix.format }}

.github/workflows/sync-release.yml

@@ -0,0 +1,44 @@
+# Copyright © 2023 KubeCub open source community. All rights reserved.
+# Licensed under the MIT License (the "License");
+# you may not use this file except in compliance with the License.
+
+# https://github.com/BetaHuhn/repo-file-sync-action
+name: Synchronize OpenIM Release Branch Public Code To Other Repositories
+on:
+    push:
+        paths:
+            - scripts/*
+            - docs/*
+            - config/*
+        branches:
+          - release-v*.*
+    workflow_dispatch:
+
+jobs:
+  sync:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Run GitHub File Sync
+        uses: BetaHuhn/repo-file-sync-action@latest
+        with:
+          GH_INSTALLATION_TOKEN: "${{ secrets.BOT_GITHUB_TOKEN }}"
+          CONFIG_PATH: .github/sync-release.yml
+          ORIGINAL_MESSAGE: true
+          SKIP_PR: true
+          COMMIT_EACH_FILE: false
+          COMMIT_BODY: "🤖 kubbot to synchronize the warehouse"
+          GIT_EMAIL: "3293172751ysy@gmail.com"
+          GIT_USERNAME: "kubbot"
+          PR_BODY: 👌 kubecub provides automated community services
+          REVIEWERS: |
+            kubbot
+            cubxxw
+          PR_LABELS: |
+            file-sync
+            automerge
+          ASSIGNEES: |
+            kubbot
+        continue-on-error: true

.github/workflows/sync.yml

@@ -0,0 +1,40 @@
+# Copyright © 2023 KubeCub open source community. All rights reserved.
+# Licensed under the MIT License (the "License");
+# you may not use this file except in compliance with the License.
+
+# https://github.com/BetaHuhn/repo-file-sync-action
+name: Synchronize OpenIM Main Branch Public Code To Other Repositories
+on:
+    push:
+        branches:
+          - main
+    workflow_dispatch:
+
+jobs:
+  sync:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Run GitHub File Sync
+        uses: BetaHuhn/repo-file-sync-action@latest
+        with:
+          GH_INSTALLATION_TOKEN: "${{ secrets.BOT_GITHUB_TOKEN }}"
+          CONFIG_PATH: .github/sync.yml
+          ORIGINAL_MESSAGE: true
+          SKIP_PR: true
+          COMMIT_EACH_FILE: false
+          COMMIT_BODY: "🤖 kubbot to synchronize the warehouse"
+          GIT_EMAIL: "3293172751ysy@gmail.com"
+          GIT_USERNAME: "kubbot"
+          PR_BODY: 👌 kubecub provides automated community services
+          REVIEWERS: |
+            kubbot
+            cubxxw
+          PR_LABELS: |
+            file-sync
+            automerge
+          ASSIGNEES: |
+            kubbot
+        continue-on-error: true

.gitignore

@@ -34,6 +34,7 @@ deployments/charts/generated-configs/
 ### OpenIM Config ###
 .env
 config/config.yaml
+config/openim.yaml
 config/alertmanager.yml
 config/prometheus.yml
 config/email.tmpl

.golangci.yml

@@ -39,19 +39,19 @@ run:
   # from this option's value (see skip-dirs-use-default).
   # "/" will be replaced by current OS file path separator to properly work
   # on Windows.
-  # skip-dirs:
-  #   - components
-  #   - docs
-  #   - util
-  #   - .*~
-  #   - api/swagger/docs
-  #   - server/docs
-  #   - components/mnt/config/certs
-  #   - logs
+  skip-dirs:
+    - components
+    - docs
+    - util
+    - .*~
+    - api/swagger/docs
+    - server/docs
+    - components/mnt/config/certs
+    - logs
 
   # default is true. Enables skipping of directories:
   #   vendor$, third_party$, testdata$, examples$, Godeps$, builtin$
-  # skip-dirs-use-default: true
+  skip-dirs-use-default: true
 
   # which files to skip: they will be analyzed, but issues from them
   # won't be reported. Default value is empty list, but there is
@@ -59,15 +59,15 @@ run:
   # autogenerated files. If it's not please let us know.
   # "/" will be replaced by current OS file path separator to properly work
   # on Windows.
-  # skip-files:
-  #   - ".*\\.my\\.go$"
-  #   - _test.go
-  #   - ".*_test.go"
-  #   - "mocks/"
-  #   - ".github/"
-  #   - "logs/"
-  #   - "_output/"
-  #   - "components/"
+  skip-files:
+    - ".*\\.my\\.go$"
+    - _test.go
+    - ".*_test.go"
+    - "mocks/"
+    - ".github/"
+    - "logs/"
+    - "_output/"
+    - "components/"
 
   # by default isn't set. If set we pass it to "go list -mod={option}". From "go help modules":
   # If invoked with -mod=readonly, the go command is disallowed from the implicit
@@ -87,7 +87,7 @@ run:
 # output configuration options
 output:
   # colored-line-number|line-number|json|tab|checkstyle|code-climate, default is "colored-line-number"
-  # format: colored-line-number
+  format: colored-line-number
 
   # print lines of code with issue, default is true
   print-issued-lines: true
@@ -118,7 +118,8 @@ linters-settings:
     right-to-left-isolate: true
     first-strong-isolate: true
     pop-directional-isolate: true
-
+    # checks assignments with too many blank identifiers; default is 2
+    max-blank-identifiers: 2
   dupl:
     # tokens count to trigger issue, 150 by default
     threshold: 200
@@ -150,11 +151,6 @@ linters-settings:
     comparison: true
 
   exhaustive:
-    # Program elements to check for exhaustiveness.
-    # Default: [ switch ]
-    check:
-      - switch
-      - map
     # check switch statements in generated files also
     check-generated: false
     # indicates that switch statements are to be considered exhaustive if a
@@ -166,34 +162,33 @@ linters-settings:
     ignore-enum-members: ""
     # consider enums only in package scopes, not in inner scopes
     package-scope-only: false
+  exhaustivestruct:
+    struct-patterns:
+      - '*.Test'
+      - '*.Test2'
+      - '*.Embedded'
+      - '*.External'
 
-
-  forbidigo:
+  # forbidigo:
   #   # Forbid the following identifiers (identifiers are written using regexp):
-    forbid:
-      # - ^print.*$
-      - 'fmt\.Print.*'
-      - fmt.Println.* # too much log noise
-      - ^unsafe\..*$
-      - ^init$
-      - ^os.Exit$
-      - ^fmt.Print.*$
-      - errors.New.*$
-      - ^fmt.Println.*$
-      - ^panic$
-      - painc
+  #   forbid:
+  #     - ^print.*$
+  #     - 'fmt\.Print.*'
+  #     - fmt.Println.* # too much log noise
   #     - ginkgo\\.F.* # these are used just for local development
   #   # Exclude godoc examples from forbidigo checks.  Default is true.
   #   exclude_godoc_examples: false
-
   funlen:
-    lines: 220
+    lines: 150
     statements: 80
-
+  gci:
+    # put imports beginning with prefix after 3rd-party packages;
+    # only support one prefix
+    # if not set, use goimports.local-prefixes
+    prefix: github.com/openimsdk/open-im-server
   gocognit:
     # minimal code complexity to report, 30 by default (but we recommend 10-20)
     min-complexity: 30
-
   goconst:
     # minimal length of string constant, 3 by default
     min-len: 3
@@ -219,6 +214,9 @@ linters-settings:
     # By default list of stable checks is used.
     enabled-checks:
       #- rangeValCopy
+      - nestingreduce
+      - truncatecmp
+      - unnamedresult
       - ruleguard
 
     # Which checks should be disabled; can't be combined with 'enabled-checks'; default is empty
@@ -247,6 +245,9 @@ linters-settings:
       hugeParam:
         # size in bytes that makes the warning trigger (default 80)
         sizeThreshold: 80
+      nestingReduce:
+        # min number of statements inside a branch to trigger a warning (default 5)
+        bodyWidth: 5
       rangeExprCopy:
         # size in bytes that makes the warning trigger (default 512)
         sizeThreshold: 512
@@ -260,10 +261,15 @@ linters-settings:
       ruleguard:
         # path to a gorules file for the ruleguard checker
         rules: ''
+      truncateCmp:
+        # whether to skip int/uint/uintptr types (default true)
+        skipArchDependent: true
       underef:
         # whether to skip (*x).method() calls where x is a pointer receiver (default true)
         skipRecvDeref: true
-
+      unnamedResult:
+        # whether to check exported functions
+        checkExported: true
   gocyclo:
     # minimal code complexity to report, 30 by default (but we recommend 10-20)
     min-complexity: 30
@@ -280,12 +286,9 @@ linters-settings:
     # list of regexps for excluding particular comment lines from check
     exclude:
       # example: exclude comments which contain numbers
-      - '[0-9]+'
-      - 'func\s+\w+'
-      - 'FIXME:'
-      - '.*func.*'
+      # - '[0-9]+'
     # check that each sentence starts with a capital letter
-    capital: true
+    capital: false
   godox:
     # report any comments starting with keywords, this is useful for TODO or FIXME comments that
     # might be left in the code accidentally and should be resolved before merging
@@ -308,15 +311,15 @@ linters-settings:
     # by default
     extra-rules: false
 
-  # goheader:
-    # values:
-      # const:
+  goheader:
+    values:
+      const:
         # define here const type values in format k:v, for example:
         # COMPANY: MY COMPANY
-      # regexp:
+      regexp:
         # define here regexp type values, for example
         # AUTHOR: .*@mycompany\.com
-    # template: # |-
+    template: # |-
       # put here copyright header template for source code files, for example:
       # Note: {{ YEAR }} is a builtin value that returns the year relative to the current machine time.
       #
@@ -334,45 +337,21 @@ linters-settings:
       # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
       # See the License for the specific language governing permissions and
       # limitations under the License.
-    # template-path:
+    template-path:
       # also as alternative of directive 'template' you may put the path to file with the template source
-
   goimports:
     # put imports beginning with prefix after 3rd-party packages;
     # it's a comma-separated list of prefixes
     local-prefixes: github.com/openimsdk/open-im-server
 
   gomnd:
-    # List of enabled checks, see https://github.com/tommy-muehle/go-mnd/#checks for description.
-    # Default: ["argument", "case", "condition", "operation", "return", "assign"]
-    checks:
-      - argument
-      - case
-      - condition
-      - operation
-      - return
-      - assign
-    # List of numbers to exclude from analysis.
-    # The numbers should be written as string.
-    # Values always ignored: "1", "1.0", "0" and "0.0"
-    # Default: []
-    ignored-numbers:
-      - '0666'
-      - '0755'
-      - '42'
-    # List of file patterns to exclude from analysis.
-    # Values always ignored: `.+_test.go`
-    # Default: []
-    ignored-files:
-      - 'magic1_.+\.go$'
-    # List of function patterns to exclude from analysis.
-    # Following functions are always ignored: `time.Date`,
-    # `strconv.FormatInt`, `strconv.FormatUint`, `strconv.FormatFloat`,
-    # `strconv.ParseInt`, `strconv.ParseUint`, `strconv.ParseFloat`.
-    # Default: []
-    ignored-functions:
-      - '^math\.'
-      - '^webhook\.StatusText$'
+    settings:
+      mnd:
+        # the list of enabled checks, see https://github.com/tommy-muehle/go-mnd/#checks for description.
+        checks: argument,case,condition,operation,return,assign
+        # ignored-numbers: 1000
+        # ignored-files: magic_.*.go
+        # ignored-functions: math.*
   gomoddirectives:
     # Allow local `replace` directives. Default is false.
     replace-local: true
@@ -384,7 +363,6 @@ linters-settings:
     retract-allow-no-explanation: false
     # Forbid the use of the `exclude` directives. Default is false.
     exclude-forbidden: false
-
   gomodguard:
     allowed:
       modules:    
@@ -448,6 +426,9 @@ linters-settings:
     checks: [ "all" ]
 
   govet:
+    # report about shadowed variables
+    check-shadowing: false
+
     # settings per analyzer
     settings:
       printf: # analyzer name, run `go tool vet help` to see all analyzers
@@ -464,25 +445,15 @@ linters-settings:
     disable:
       - shadow
     disable-all: false
+  # depguard:
+  #   list-type: blacklist
+  #   include-go-root: false
+  #   packages:
+  #     - github.com/Sirupsen/logrus
+  #   packages-with-error-message:
+  #     # specify an error message to output when a blacklisted package is used
+  #     - github.com/Sirupsen/logrus: "logging is allowed only by logutils.Log"
 
-  depguard:
-    rules:
-      prevent_unmaintained_packages:
-        list-mode: lax # allow unless explicitely denied
-        files:
-          - $all
-          - "!$test"
-        allow:
-          - $gostd
-        deny:
-          - pkg: io/ioutil
-            desc: "replaced by io and os packages since Go 1.16: https://tip.golang.org/doc/go1.16#ioutil"
-          - pkg: github.com/OpenIMSDK
-            desc: "The OpenIM organization has been replaced with lowercase, please do not use uppercase organization name, you will use openimsdk"
-          - pkg: log
-            desc: "We have a wrapped log package at openim, we recommend you to use our wrapped log package, https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/logging.md"
-          - pkg: errors
-            desc: "We have a wrapped errors package at openim, we recommend you to use our wrapped errors package, https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/error-code.md"
 
   importas:
     # if set to `true`, force to use alias.
@@ -492,8 +463,6 @@ linters-settings:
       # using `servingv1` alias for `knative.dev/serving/pkg/apis/serving/v1` package
       - pkg: knative.dev/serving/pkg/apis/serving/v1
         alias: servingv1
-      - pkg: gopkg.in/yaml.v2
-        alias: yaml
       # using `autoscalingv1alpha1` alias for `knative.dev/serving/pkg/apis/autoscaling/v1alpha1` package
       - pkg: knative.dev/serving/pkg/apis/autoscaling/v1alpha1
         alias: autoscalingv1alpha1
@@ -502,6 +471,8 @@ linters-settings:
       # see https://github.com/julz/importas#use-regular-expression for details
       - pkg: knative.dev/serving/pkg/apis/(\w+)/(v[\w\d]+)
         alias: $1$2
+    # using `jwt` alias for `github.com/appleboy/gin-jwt/v2` package
+    jwt: github.com/appleboy/gin-jwt/v2
 
   ireturn:
     # ireturn allows using `allow` and `reject` settings at the same time.
@@ -532,6 +503,9 @@ linters-settings:
     line-length: 250
     # tab width in spaces. Default to 1.
     tab-width: 4
+  maligned:
+    # print struct with more effective memory layout or not, false by default
+    suggest-new: true
   misspell:
     # Correct spellings using locale preferences for US or UK.
     # Default is to use a neutral variety of English.
@@ -564,6 +538,8 @@ linters-settings:
   nolintlint:
     # Disable to ensure that all nolint directives actually have an effect. Default is true.
     allow-unused: false
+    # Disable to ensure that nolint directives don't have a leading space. Default is true.
+    allow-leading-space: true
     # Exclude following linters from requiring an explanation.  Default is [].
     allow-no-explanation: [ ]
     # Enable to require an explanation of nonzero length after each nolint directive. Default is false.
@@ -587,13 +563,14 @@ linters-settings:
     strict: false
     # Please refer to https://github.com/yeya24/promlinter#usage for detailed usage.
     disabled-linters:
-     - "Help"
-     - "MetricUnits"
-     - "Counter"
-     - "HistogramSummaryReserved"
-     - "MetricTypeInName"
-     - "ReservedChars"
-     - "CamelCase"
+    #  - "Help"
+    #  - "MetricUnits"
+    #  - "Counter"
+    #  - "HistogramSummaryReserved"
+    #  - "MetricTypeInName"
+    #  - "ReservedChars"
+    #  - "CamelCase"
+    #  - "lintUnitAbbreviations"
     
   predeclared:
     # comma-separated list of predeclared identifiers to not report on
@@ -603,7 +580,6 @@ linters-settings:
   rowserrcheck:
     packages:
       - github.com/jmoiron/sqlx
-
   revive:
     # see https://github.com/mgechev/revive#available-rules for details.
     ignore-generated-header: true
@@ -611,27 +587,15 @@ linters-settings:
     rules:
       - name: indent-error-flow
         severity: warning
-      - name: exported
-        severity: warning
-      - name: var-naming
-        arguments: [ [ "OpenIM"] ]
-        # arguments: [ ["ID", "HTTP", "URL", "URI", "API", "APIKey", "Token", "TokenID", "TokenSecret", "TokenKey", "TokenSecret", "JWT", "JWTToken", "JWTTokenID", "JWTTokenSecret", "JWTTokenKey", "JWTTokenSecret", "OAuth", "OAuthToken", "RPC" ] ]
-      - name: atomic
-      - name: line-length-limit
-        severity: error
-        arguments: [200]
-      - name: unhandled-error
-        arguments : ["fmt.Printf", "myFunction"]
-
   staticcheck:
     # Select the Go version to target. The default is '1.13'.
-    go: "1.20"
+    go: "1.16"
     # https://staticcheck.io/docs/options#checks
     checks: [ "all" ]
 
   stylecheck:
     # Select the Go version to target. The default is '1.13'.
-    go: "1.20"
+    go: "1.16"
 
     # https://staticcheck.io/docs/options#checks
     checks: [ "all", "-ST1000", "-ST1003", "-ST1016", "-ST1020", "-ST1021", "-ST1022" ]
@@ -643,6 +607,7 @@ linters-settings:
     # https://staticcheck.io/docs/options#http_status_code_whitelist
     http-status-code-whitelist: [ "200", "400", "404", "500" ]
 
+
   tagliatelle:
     # check the struck tag name case
     case:
@@ -688,11 +653,12 @@ linters-settings:
     # if it's called for subdir of a project it can't find external interfaces. All text editor integrations
     # with golangci-lint call it on a directory with the changed file.
     check-exported: false
-  # unused:
+  unused:
     # treat code as a program (not a library) and report unused exported identifiers; default is false.
     # XXX: if you enable this setting, unused will report a lot of false-positives in text editors:
     # if it's called for subdir of a project it can't find funcs usages. All text editor integrations
     # with golangci-lint call it on a directory with the changed file.
+    check-exported: false
   whitespace:
     multi-if: false   # Enforces newlines (or comments) after every multi-line if statement
     multi-func: false # Enforces newlines (or comments) after every multi-line function signature
@@ -706,7 +672,6 @@ linters-settings:
       - errors.New(
       - errors.Unwrap(
       - .Wrap(
-      - .WrapMsg(
       - .Wrapf(
       - .WithMessage(
       - .WithMessagef(
@@ -714,8 +679,6 @@ linters-settings:
     ignorePackageGlobs:
         - encoding/*
         - github.com/pkg/*
-        - github.com/openimsdk/*
-        - github.com/OpenIMSDK/*
 
   wsl:
     # If true append is only allowed to be cuddled if appending value is
@@ -742,6 +705,7 @@ linters-settings:
     # Allow only slices initialized with a length of zero. Default is false.
     always: false
 
+
   # The custom section can be used to define linter plugins to be loaded at runtime. See README doc
   #  for more info.
   #custom:
@@ -767,26 +731,21 @@ linters:
     - errcheck
     - decorder
     - ineffassign
-    - forbidigo
     - revive
     - reassign
     - tparallel
     - unconvert
-    - fieldalignment
     - dupl
     - dupword
     - errname
     - gci
-    - exhaustive
-    - gocritic
+    - goheader
     - goprintffuncname
-    - gomnd
-    - goconst
     - gosec
     - misspell      # Spelling mistakes
     - staticcheck   # Static analysis
     - unused        # Checks for unused code
-    # - goimports     # Checks if imports are correctly sorted and formatted
+    - goimports     # Checks if imports are correctly sorted and formatted
     - godot         # Checks for comment punctuation
     - bodyclose     # Ensures HTTP response body is closed
     - stylecheck    # Style checker for Go code
@@ -802,7 +761,6 @@ issues:
   exclude:
     - tools/.*
     - test/.*
-    - components/*
     - third_party/.*
 
   # Excluding configuration per-path, per-linter, per-text and per-source

Dockerfile

@@ -1,49 +1,30 @@
-# Use Go 1.21 Alpine as the base image for building the application
-FROM golang:1.21-alpine as builder
+# Build Stage
+FROM golang:1.20 AS builder
 
-# Define the base directory for the application as an environment variable
-ENV SERVER_DIR=/openim-server
+# Set go mod installation source and proxy
+ARG GO111MODULE=on
+ARG GOPROXY=https://goproxy.io,direct
 
-# Set the working directory inside the container based on the environment variable
-WORKDIR $SERVER_DIR
+ENV GO111MODULE=$GO111MODULE
+ENV GOPROXY=$GOPROXY
 
-# Set the Go proxy to improve dependency resolution speed
-ENV GOPROXY=https://goproxy.io,direct
+# Set up the working directory
+WORKDIR /openim/openim-server
 
-# Copy all files from the current directory into the container
-COPY . .
+# Copy all files to the container
+ADD . .
 
-RUN go mod download
+RUN make clean
+RUN make build
 
-# Install Mage to use for building the application
-RUN go install github.com/magefile/mage@v1.15.0
+FROM ghcr.io/openim-sigs/openim-ubuntu-image:latest
 
-# Optionally build your application if needed
-RUN mage build
+WORKDIR ${SERVER_WORKDIR}
 
-# Using Alpine Linux with Go environment for the final image
-FROM golang:1.21-alpine
+# Copy scripts and binary files to the production image
+COPY --from=builder ${OPENIM_SERVER_BINDIR} /openim/openim-server/_output/bin
+COPY --from=builder ${OPENIM_SERVER_CMDDIR} /openim/openim-server/scripts
+COPY --from=builder ${SERVER_WORKDIR}/config /openim/openim-server/config
+COPY --from=builder ${SERVER_WORKDIR}/deployments /openim/openim-server/deployments
 
-# Install necessary packages, such as bash
-RUN apk add --no-cache bash
-
-# Set the environment and work directory
-ENV SERVER_DIR=/openim-server
-WORKDIR $SERVER_DIR
-
-
-# Copy the compiled binaries and mage from the builder image to the final image
-COPY --from=builder $SERVER_DIR/_output $SERVER_DIR/_output
-COPY --from=builder $SERVER_DIR/config $SERVER_DIR/config
-COPY --from=builder /go/bin/mage /usr/local/bin/mage
-COPY --from=builder $SERVER_DIR/magefile_windows.go $SERVER_DIR/
-COPY --from=builder $SERVER_DIR/magefile_unix.go $SERVER_DIR/
-COPY --from=builder $SERVER_DIR/magefile.go $SERVER_DIR/
-COPY --from=builder $SERVER_DIR/start-config.yml $SERVER_DIR/
-COPY --from=builder $SERVER_DIR/go.mod $SERVER_DIR/
-COPY --from=builder $SERVER_DIR/go.sum $SERVER_DIR/
-
-RUN go get github.com/openimsdk/gomake@v0.0.13
-
-# Set the command to run when the container starts
-ENTRYPOINT ["sh", "-c", "mage start && tail -f /dev/null"]
+CMD ["/openim/openim-server/scripts/docker-start-all.sh"]

Makefile

@@ -0,0 +1,255 @@
+# ==============================================================================
+# define the default goal
+#
+
+.DEFAULT_GOAL := help
+
+## all: Run tidy, gen, add-copyright, format, lint, cover, build ✨
+.PHONY: all
+all: tidy gen add-copyright verify test-api lint cover restart
+
+# ==============================================================================
+# Build set
+
+ROOT_PACKAGE=github.com/openimsdk/open-im-server
+# TODO: This is version control for the future https://github.com/openimsdk/open-im-server/issues/574
+VERSION_PACKAGE=github.com/openimsdk/open-im-server/v3/pkg/version
+
+# ==============================================================================
+# Includes
+
+include scripts/make-rules/common.mk	# make sure include common.mk at the first include line
+include scripts/make-rules/golang.mk
+include scripts/make-rules/image.mk
+include scripts/make-rules/copyright.mk
+include scripts/make-rules/gen.mk
+include scripts/make-rules/dependencies.mk
+include scripts/make-rules/tools.mk
+include scripts/make-rules/release.mk
+include scripts/make-rules/swagger.mk
+
+# ==============================================================================
+# Usage
+
+define USAGE_OPTIONS
+
+Options:
+
+  DEBUG            Whether or not to generate debug symbols. Default is 0.
+
+  BINS             Binaries to build. Default is all binaries under cmd.
+                   This option is available when using: make {build}(.multiarch)
+                   Example: make build BINS="openim-api openim-cmdutils".
+
+  PLATFORMS        Platform to build for. Default is linux_arm64 and linux_amd64.
+                   This option is available when using: make {build}.multiarch
+                   Example: make multiarch PLATFORMS="linux_s390x linux_mips64
+                   linux_mips64le darwin_amd64 windows_amd64 linux_amd64 linux_arm64".
+
+  V                Set to 1 enable verbose build. Default is 0.
+endef
+export USAGE_OPTIONS
+
+# ==============================================================================
+# Targets
+
+## init: Initialize openim server project ✨
+.PHONY: init
+init:
+	@$(MAKE) gen.init
+
+## init-githooks: Initialize git hooks ✨
+.PHONY: init-githooks
+init-githooks:
+	@$(MAKE) gen.init-githooks
+
+## gen: Generate all necessary files. ✨
+.PHONY: gen
+gen:
+	@$(MAKE) gen.run
+
+## demo: Run demo get started with Makefiles quickly ✨
+.PHONY: demo
+demo:
+	@$(MAKE) go.demo
+
+## version: Check version of openim. ✨
+.PHONY: version
+version:
+	@$(MAKE) go.versionchecker
+
+## build: Build binaries by default ✨
+.PHONY: build
+build:
+	@$(MAKE) go.build
+
+## start: Start openim ✨
+.PHONY: start
+start:
+	@$(MAKE) go.start
+
+## stop: Stop openim ✨
+.PHONY: stop
+stop:
+	@$(MAKE) go.stop
+
+## restart: Restart openim (make init configuration file is initialized) ✨
+.PHONY: restart
+restart: clean stop build start check
+
+## multiarch: Build binaries for multiple platforms. See option PLATFORMS. ✨
+.PHONY: multiarch
+multiarch:
+	@$(MAKE) go.build.multiarch
+
+## verify: execute all verity scripts. ✨
+.PHONY: verify
+verify:
+	@$(MAKE) go.verify
+
+## install: Install deployment openim ✨
+.PHONY: install
+install:
+	@$(MAKE) go.install
+
+## check: Check OpenIM deployment ✨
+.PHONY: check
+check:
+	@$(MAKE) go.check
+
+## check-component: Check OpenIM component deployment ✨
+.PHONY: check-component
+check-component:
+	@$(MAKE) go.check-component
+
+## tidy: tidy go.mod ✨
+.PHONY: tidy
+tidy:
+	@$(GO) mod tidy
+
+## vendor: vendor go.mod ✨
+.PHONY: vendor
+vendor:
+	@$(GO) mod vendor
+
+## style: code style -> fmt,vet,lint ✨
+.PHONY: style
+style: fmt vet lint
+
+## fmt: Run go fmt against code. ✨
+.PHONY: fmt
+fmt:
+	@$(GO) fmt ./...
+
+## vet: Run go vet against code. ✨
+.PHONY: vet
+vet:
+	@$(GO) vet ./...
+
+## lint: Check syntax and styling of go sources. ✨
+.PHONY: lint
+lint:
+	@$(MAKE) go.lint
+
+## format: Gofmt (reformat) package sources (exclude vendor dir if existed). ✨
+.PHONY: format
+format:
+	@$(MAKE) go.format
+
+## test: Run unit test. ✨
+.PHONY: test
+test:
+	@$(MAKE) go.test
+
+## cover: Run unit test and get test coverage. ✨
+.PHONY: cover
+cover:
+	@$(MAKE) go.test.cover
+
+## test-api: Run api test. ✨
+.PHONY: test-api
+test-api:
+	@$(MAKE) go.test.api
+
+## test-e2e: Run e2e test
+test-e2e:
+	@$(MAKE) go.test.e2e
+
+## updates: Check for updates to go.mod dependencies. ✨
+.PHONY: updates
+	@$(MAKE) go.updates
+
+## imports: task to automatically handle import packages in Go files using goimports tool. ✨
+.PHONY: imports
+imports:
+	@$(MAKE) go.imports
+
+## clean: Delete all files created by the build, as well as all log files. ✨
+.PHONY: clean
+clean:
+	@$(MAKE) go.clean
+
+## image: Build docker images for host arch. ✨
+.PHONY: image
+image:
+	@$(MAKE) image.build
+
+## image.multiarch: Build docker images for multiple platforms. See option PLATFORMS. ✨
+.PHONY: image.multiarch
+image.multiarch:
+	@$(MAKE) image.build.multiarch
+
+## push: Build docker images for host arch and push images to registry. ✨
+.PHONY: push
+push:
+	@$(MAKE) image.push
+
+## push.multiarch: Build docker images for multiple platforms and push images to registry. ✨
+.PHONY: push.multiarch
+push.multiarch:
+	@$(MAKE) image.push.multiarch
+
+## tools: Install dependent tools. ✨
+.PHONY: tools
+tools:
+	@$(MAKE) tools.install
+
+## swagger: Generate swagger document. ✨
+.PHONY: swagger
+swagger:
+	@$(MAKE) swagger.run
+
+## serve-swagger: Serve swagger spec and docs. ✨
+.PHONY: swagger.serve
+serve-swagger:
+	@$(MAKE) swagger.serve
+
+## verify-copyright: Verify the license headers for all files. ✨
+.PHONY: verify-copyright
+verify-copyright:
+	@$(MAKE) copyright.verify
+
+## add-copyright: Add copyright ensure source code files have license headers. ✨
+.PHONY: add-copyright
+add-copyright:
+	@$(MAKE) copyright.add
+
+## advertise: Project introduction, become a contributor ✨
+.PHONY: advertise
+advertise:
+	@$(MAKE) copyright.advertise
+
+## release: release the project ✨
+.PHONY: release
+release: release.verify release.ensure-tag
+	@scripts/release.sh
+
+## help: Show this help info. ✨
+.PHONY: help
+help: Makefile
+	$(call makehelp)
+
+## help-all: Show all help details info. ✨
+.PHONY: help-all
+help-all: go.help copyright.help tools.help image.help dependencies.help gen.help release.help swagger.help help
+	$(call makeallhelp)

README.md

@@ -51,89 +51,137 @@
 
 </p>
 
-## :busts_in_silhouette: Join Our Community
+## :busts_in_silhouette: Community
 
-+ 💬 [Follow us on Twitter](https://twitter.com/founder_im63606)
-+ 🚀 [Join our Slack](https://join.slack.com/t/openimsdk/shared_invite/zt-22720d66b-o_FvKxMTGXtcnnnHiMqe9Q)
-+ :eyes: [Join our WeChat Group](https://openim-1253691595.cos.ap-nanjing.myqcloud.com/WechatIMG20.jpeg)
++ 💬 [Follow our Twitter account](https://twitter.com/founder_im63606)
++ 👫 [Join our Reddit](https://www.reddit.com/r/OpenIMessaging)
++ 🚀 [Join our Slack community](https://join.slack.com/t/openimsdk/shared_invite/zt-22720d66b-o_FvKxMTGXtcnnnHiMqe9Q)
++ :eyes: [Join our wechat (微信群)](https://openim-1253691595.cos.ap-nanjing.myqcloud.com/WechatIMG20.jpeg)
++ 📚 [OpenIM Community](https://github.com/OpenIMSDK/community)
++ 💕 [OpenIM Interest Group](https://github.com/Openim-sigs)
 
 ## Ⓜ️ About OpenIM
 
-Unlike standalone chat applications such as Telegram, Signal, and Rocket.Chat, OpenIM offers an open-source instant messaging solution designed specifically for developers rather than as a directly installable standalone chat app. Comprising OpenIM SDK and OpenIM Server, it provides developers with a complete set of tools and services to integrate instant messaging functions into their applications, including message sending and receiving, user management, and group management. Overall, OpenIM aims to provide developers with the necessary tools and framework to implement efficient instant messaging solutions in their applications.
+OpenIM is a service platform specifically designed for integrating chat, audio-video calls, notifications, and AI chatbots into applications. It provides a range of powerful APIs and Webhooks, enabling developers to easily incorporate these interactive features into their applications. OpenIM is not a standalone chat application, but rather serves as a platform to support other applications in achieving rich communication functionalities. The following diagram illustrates the interaction between AppServer, AppClient, OpenIMServer, and OpenIMSDK to explain in detail.
 
 ![App-OpenIM Relationship](./docs/images/oepnim-design.png)
 
-## 🚀 Introduction to OpenIMSDK
+## 🚀 About OpenIMSDK
 
-**OpenIMSDK**, designed for **OpenIMServer**, is an IM SDK created specifically for integration into client applications. It supports various functionalities and modules:
+**OpenIMSDK** is an IM SDK designed for **OpenIMServer**, created specifically for embedding in client applications. Its main features and modules are as follows:
 
 + 🌟 Main Features:
-  - 📦 Local Storage
-  - 🔔 Listener Callbacks
-  - 🛡️ API Wrapping
-  - 🌐 Connection Management
+
+  - 📦 Local storage
+  - 🔔 Listener callbacks
+  - 🛡️ API wrapping
+  - 🌐 Connection management
 
 + 📚 Main Modules:
+
   1. 🚀 Initialization and Login
   2. 👤 User Management
-  3. 👫 Friends Management
+  3. 👫 Friend Management
   4. 🤖 Group Functions
-  5. 💬 Session Handling
+  5. 💬 Conversation Handling
 
-Built with Golang and supports cross-platform deployment to ensure a consistent integration experience across all platforms.
+It is built using Golang and supports cross-platform deployment, ensuring a consistent access experience across all platforms.
 
-👉 **[Explore the GO SDK](https://github.com/openimsdk/openim-sdk-core)**
+👉 **[Explore GO SDK](https://github.com/openimsdk/openim-sdk-core)**
 
-## 🌐 Introduction to OpenIMServer
+## 🌐 About OpenIMServer
 
-+ **OpenIMServer** features include:
-  - 🌐 Microservices Architecture: Supports cluster mode, including a gateway and multiple rpc services.
-  - 🚀 Diverse Deployment Options: Supports source code, Kubernetes, or Docker deployment.
-  - Massive User Support: Supports large-scale groups with hundreds of thousands, millions of users, and billions of messages.
++ **OpenIMServer** has the following characteristics:
+  - 🌐 Microservice architecture: Supports cluster mode, including a gateway and multiple rpc services.
+  - 🚀 Diverse deployment methods: Supports deployment via source code, Kubernetes, or Docker.
+  - Support for massive user base: Super large groups with hundreds of thousands of users, tens of millions of users, and billions of messages.
 
-### Enhanced Business Functions:
+### Enhanced Business Functionality:
 
-+ **REST API**: Provides a REST API for business systems to enhance functionality, such as group creation and message pushing through backend interfaces.
++ **REST API**: OpenIMServer offers REST APIs for business systems, aimed at empowering businesses with more functionalities, such as creating groups and sending push messages through backend interfaces.
++ **Webhooks**: OpenIMServer provides callback capabilities to extend more business forms. A callback means that OpenIMServer sends a request to the business server before or after a certain event, like callbacks before or after sending a message.
 
-+ **Webhooks**: Expands business forms through callbacks, sending requests to business servers before or after certain events.
+👉 **[Learn more](https://docs.openim.io/guides/introduction/product)**
+
+## :building_construction: Overall Architecture
+
+Delve into the heart of Open-IM-Server's functionality with our architecture diagram.
+
+![Overall Architecture](./docs/images/architecture-layers.png)
 
-  ![Overall Architecture](./docs/images/architecture-layers.png)
 
 ## :rocket: Quick Start
 
-Experience online for iOS/Android/H5/PC/Web:
+We support many platforms. Here are the addresses for quick experience on the web side：
 
-👉 **[OpenIM Online Demo](https://www.openim.io/en/commercial)**
+👉 **[OpenIM online web demo](https://web-enterprise.rentsoft.cn/)**
 
-To facilitate user experience, we offer various deployment solutions. You can choose your preferred deployment method from the list below:
+🤲 To facilitate user experience, we offer various deployment solutions. You can choose your deployment method from the list below:
 
 + **[Source Code Deployment Guide](https://docs.openim.io/guides/gettingStarted/imSourceCodeDeployment)**
 + **[Docker Deployment Guide](https://docs.openim.io/guides/gettingStarted/dockerCompose)**
++ **[Kubernetes Deployment Guide](https://docs.openim.io/guides/gettingStarted/k8s-deployment)**
++ **[Mac Developer Deployment Guide](https://docs.openim.io/guides/gettingstarted/mac-deployment-guide)**
 
-## System Support
+## :hammer_and_wrench: To Start Developing OpenIM
 
-Supports Linux, Windows, Mac systems, and ARM and AMD CPU architectures.
+[![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)
 
-## :link: Links
+[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/openimsdk/open-im-server)
 
-  + **[Developer Manual](https://docs.openim.io/)**
-  + **[Changelog](https://github.com/openimsdk/open-im-server/blob/main/CHANGELOG.md)**
+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).
 
-## :writing_hand: How to Contribute
+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).
 
-We welcome contributions of any kind! Please make sure to read our [Contributor Documentation](https://github.com/openimsdk/open-im-server/blob/main/CONTRIBUTING.md) before submitting a Pull Request.
+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.
 
-  + **[Report a Bug](https://github.com/openimsdk/open-im-server/issues/new?assignees=&labels=bug&template=bug_report.md&title=)**
-  + **[Suggest a Feature](https://github.com/openimsdk/open-im-server/issues/new?assignees=&labels=enhancement&template=feature_request.md&title=)**
-  + **[Submit a Pull Request](https://github.com/openimsdk/open-im-server/pulls)**
+- [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)
+- [Mac Developer Deployment Guide for OpenIM](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/mac-developer-deployment-guide.md)
 
-Thank you for contributing to building a powerful instant messaging solution!
+## :calendar: Community Meetings
 
-## :closed_book: License
+We want anyone to get involved in our community and contributing code, we offer gifts and rewards, and we welcome you to join us every Thursday night.
 
-OpenIMSDK is available under the Apache License 2.0. See the [LICENSE file](https://github.com/openimsdk/open-im-server/blob/main/LICENSE) for more information.
+Our conference is in the [OpenIM Slack](https://join.slack.com/t/openimsdk/shared_invite/zt-22720d66b-o_FvKxMTGXtcnnnHiMqe9Q) 🎯, then you can search the Open-IM-Server pipeline to join
 
+We take notes of each [biweekly meeting](https://github.com/orgs/OpenIMSDK/discussions/categories/meeting) in [GitHub discussions](https://github.com/openimsdk/open-im-server/discussions/categories/meeting), Our historical meeting notes, as well as replays of the meetings are available at [Google Docs :bookmark_tabs:](https://docs.google.com/document/d/1nx8MDpuG74NASx081JcCpxPgDITNTpIIos0DS6Vr9GU/edit?usp=sharing).
 
+## :eyes: Who Are Using OpenIM
+
+Check out our [user case studies](https://github.com/OpenIMSDK/community/blob/main/ADOPTERS.md) page for a list of the project users. Don't hesitate to leave a [📝comment](https://github.com/openimsdk/open-im-server/issues/379) and share your use case.
+
+## :page_facing_up: License
+
+OpenIM is licensed under the Apache 2.0 license. See [LICENSE](https://github.com/openimsdk/open-im-server/tree/main/LICENSE) for the full license text.
+
+The OpenIM logo, including its variations and animated versions, displayed in this repository [OpenIM](https://github.com/openimsdk/open-im-server) under the [assets/logo](./assets/logo) and [assets/logo-gif](assets/logo-gif) directories, are protected by copyright laws.
 
 ## 🔮 Thanks to our contributors!
 

README_zh_CN.md

@@ -51,29 +51,31 @@
 
 </p>
 
-## :busts_in_silhouette: 加入我们的社区
+## 🟢 扫描微信进群交流
+<img src="./docs/images/Wechat.jpg" width="300">
 
-+ 💬 [关注我们的 Twitter](https://twitter.com/founder_im63606)
-+ 🚀 [加入我们的 Slack](https://join.slack.com/t/openimsdk/shared_invite/zt-22720d66b-o_FvKxMTGXtcnnnHiMqe9Q)
-+ :eyes: [加入我们的微信群](https://openim-1253691595.cos.ap-nanjing.myqcloud.com/WechatIMG20.jpeg)
 
 ## Ⓜ️ 关于 OpenIM
 
-与Telegram、Signal、Rocket.Chat等独立聊天应用不同，OpenIM提供了专为开发者设计的开源即时通讯解决方案，而不是直接安装使用的独立聊天应用。OpenIM由OpenIM SDK和OpenIM Server两大部分组成，为开发者提供了一整套集成即时通讯功能的工具和服务，包括消息发送接收、用户管理和群组管理等。总体来说，OpenIM旨在为开发者提供必要的工具和框架，帮助他们在自己的应用中实现高效的即时通讯解决方案。
+OpenIM 是一个专门设计用于在应用程序中集成聊天、音视频通话、通知以及AI聊天机器人等通信功能的服务平台。它通过提供一系列强大的API和Webhooks，使开发者可以轻松地在他们的应用中加入这些交互特性。OpenIM 本身并不是一个独立运行的聊天应用，而是作为一个平台，为其他应用提供支持，实现丰富的通信功能。下图展示 AppServer、AppClient、OpenIMServer 和 OpenIMSDK 之间的交互关系来具体说明。
+
+
 
 ![App-OpenIM 关系](./docs/images/oepnim-design.png)
 
-## 🚀 OpenIMSDK 介绍
+## 🚀 关于 OpenIMSDK
 
-**OpenIMSDK** 是为 **OpenIMServer** 设计的IM SDK，专为集成到客户端应用而生。它支持多种功能和模块：
+**OpenIMSDK** 是为 **OpenIMServer** 设计的IM SDK，专为嵌入客户端应用而生。其主要功能及模块如下：
 
 + 🌟 主要功能：
+
   - 📦 本地存储
   - 🔔 监听器回调
   - 🛡️ API封装
   - 🌐 连接管理
 
-+ 📚 主要模块：
+  ## 📚 主要模块：
+
   1. 🚀 初始化及登录
   2. 👤 用户管理
   3. 👫 好友管理
@@ -84,52 +86,81 @@
 
 👉 **[探索 GO SDK](https://github.com/openimsdk/openim-sdk-core)**
 
-## 🌐 OpenIMServer 介绍
+## 🌐 关于 OpenIMServer
 
-+ **OpenIMServer** 的特点包括：
++ **OpenIMServer** 具有以下特点：
   - 🌐 微服务架构：支持集群模式，包括网关(gateway)和多个rpc服务。
-  - 🚀 多样的部署方式：支持源代码、Kubernetes或Docker部署。
-  - 海量用户支持：支持十万级超大群组，千万级用户和百亿级消息。
+  - 🚀 部署方式多样：支持源代码、kubernetes或docker部署。
+  - 海量用户支持：十万超级大群，千万用户，及百亿消息
 
 ### 增强的业务功能：
 
-+ **REST API**：为业务系统提供REST API，增加群组创建、消息推送等后台接口功能。
++ **REST API**：OpenIMServer 提供了REST API供业务系统使用，旨在赋予业务更多功能，例如通过后台接口建立群组、发送推送消息等。
++ **Webhooks**：OpenIMServer提供了回调能力以扩展更多的业务形态，所谓回调，即OpenIMServer会在某一事件发生之前或者之后，向业务服务器发送请求，如发送消息之前或之后的回调。
 
-+ **Webhooks**：通过事件前后的回调，向业务服务器发送请求，扩展更多的业务形态。
+👉 **[了解更多](https://docs.openim.io/guides/introduction/product)**
 
-  ![整体架构](./docs/images/architecture-layers.png)
-
-  
-
-## :rocket: 快速入门
+## :rocket: 快速开始
 
 在线体验iOS/Android/H5/PC/Web：
 
-👉 **[OpenIM在线演示](https://www.openim.io/en/commercial)**
+👉 **[OpenIM online demo](https://www.openim.io/zh/commercial)**
 
-为了便于用户体验，我们提供了多种部署解决方案，您可以根据以下列表选择适合您的部署方式：
+🤲 为了方便用户体验，我们提供了多种部署解决方案，您可以根据下面的列表选择自己的部署方法：
 
 + **[源代码部署指南](https://docs.openim.io/guides/gettingStarted/imSourceCodeDeployment)**
 + **[Docker 部署指南](https://docs.openim.io/guides/gettingStarted/dockerCompose)**
++ **[Kubernetes 部署指南](https://docs.openim.io/guides/gettingStarted/k8s-deployment)**
 
-## 系统支持
+## :hammer_and_wrench: 开始开发 OpenIM
 
-支持 Linux、Windows、Mac 系统以及 ARM 和 AMD CPU 架构。
+OpenIM 我们的目标是建立一个顶级的开源社区。我们有一套标准，在[社区仓库](https://github.com/OpenIMSDK/community)中。
 
-## :link: 相关链接
+如果你想为这个 Open-IM-Server 仓库做贡献，请阅读我们的[贡献者文档](https://github.com/openimsdk/open-im-server/blob/main/CONTRIBUTING.md)。
 
-  + **[开发手册](https://docs.openim.io/)**
+在开始之前，请确保你的更改是有需求的。最好的方法是创建一个[新的讨论](https://github.com/openimsdk/open-im-server/discussions/new/choose) 或 [Slack 通信](https://join.slack.com/t/openimsdk/shared_invite/zt-22720d66b-o_FvKxMTGXtcnnnHiMqe9Q)，或者如果你发现一个问题，首先[报告它](https://github.com/openimsdk/open-im-server/issues/new/choose)。
+
++ [代码标准](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/go-code.md)
+
++ [Docker 镜像标准](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/images.md)
+
++ [目录标准](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/directory.md)
+
++ [提交标准](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/commit.md)
+
++ [版本控制标准](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/version.md)
+
++ [接口标准](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/interface.md)
+
++ [OpenIM配置和环境变量设置](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/environment.md)
+
+> **Note**
+> 针对中国的用户，阅读我们的 [Docker 镜像标准](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/images.md) 以便使用国内 aliyun 的镜像地址。OpenIM 也有针对中国的 gitee 同步仓库，你可以在 [gitee.com](https://gitee.com/openimsdk) 上找到它。
+
+## :link: 链接
+
+  + **[完整文档](https://doc.rentsoft.cn/)**
   + **[更新日志](https://github.com/openimsdk/open-im-server/blob/main/CHANGELOG.md)**
+  + **[FAQ](https://github.com/openimsdk/open-im-server/blob/main/FAQ.md)**
+  + **[代码示例](https://github.com/openimsdk/open-im-server/blob/main/examples)**
 
-## :writing_hand: 如何贡献
+## :handshake: 社区
 
-我们欢迎任何形式的贡献！在提交 Pull Request 之前，请确保阅读我们的[贡献者文档](https://github.com/openimsdk/open-im-server/blob/main/CONTRIBUTING.md)
+  + **[GitHub Discussions](https://github.com/openimsdk/open-im-server/discussions)**
+  + **[Slack 通信](https://join.slack.com/t/openimsdk/shared_invite/zt-22720d66b-o_FvKxMTGXtcnnnHiMqe9Q)**
+  + **[GitHub Issues](https://github.com/openimsdk/open-im-server/issues)**
+
+  您可以加入这些平台，讨论问题，提出建议，或分享您的成功故事！
+
+## :writing_hand: 贡献
+
+  我们欢迎任何形式的贡献！请确保在提交 Pull Request 之前阅读我们的[贡献者文档](https://github.com/openimsdk/open-im-server/blob/main/CONTRIBUTING.md)。
 
   + **[报告 Bug](https://github.com/openimsdk/open-im-server/issues/new?assignees=&labels=bug&template=bug_report.md&title=)**
   + **[提出新特性](https://github.com/openimsdk/open-im-server/issues/new?assignees=&labels=enhancement&template=feature_request.md&title=)**
   + **[提交 Pull Request](https://github.com/openimsdk/open-im-server/pulls)**
 
-感谢您的贡献，一起来打造强大的即时通讯解决方案！
+  感谢您的贡献，我们一起打造一个强大的即时通信解决方案！
 
 ## :closed_book: 许可证
 

bootstrap.bat

@@ -1,31 +0,0 @@
-@echo off
-SETLOCAL
-
-mage -version >nul 2>&1
-IF %ERRORLEVEL% EQU 0 (
-    echo Mage is already installed.
-    GOTO DOWNLOAD
-)
-
-go version >nul 2>&1
-IF NOT %ERRORLEVEL% EQU 0 (
-    echo Go is not installed. Please install Go and try again.
-    exit /b 1
-)
-
-echo Installing Mage...
-go install github.com/magefile/mage@latest
-
-mage -version >nul 2>&1
-IF NOT %ERRORLEVEL% EQU 0 (
-    echo Mage installation failed.
-    echo Please ensure that %GOPATH%/bin is in your PATH.
-    exit /b 1
-)
-
-echo Mage installed successfully.
-
-:DOWNLOAD
-go mod download
-
-ENDLOCAL

bootstrap.sh

@@ -1,23 +0,0 @@
-#!/bin/bash
-
-if [[ ":$PATH:" == *":$HOME/.local/bin:"* ]]; then
-    TARGET_DIR="$HOME/.local/bin"
-else
-    TARGET_DIR="/usr/local/bin"
-    echo "Using /usr/local/bin as the installation directory. Might require sudo permissions."
-fi
-
-if ! command -v mage &> /dev/null; then
-    echo "Installing Mage to $TARGET_DIR ..."
-    GOBIN=$TARGET_DIR go install github.com/magefile/mage@latest
-fi
-
-if ! command -v mage &> /dev/null; then
-    echo "Mage installation failed."
-    echo "Please ensure that $TARGET_DIR is in your \$PATH."
-    exit 1
-fi
-
-echo "Mage installed successfully."
-
-go mod download

build/images/openim-api/Dockerfile

@@ -19,6 +19,7 @@
 FROM golang:1.20 AS builder
 
 ARG GO111MODULE=on
+ARG GOPROXY=https://goproxy.io,direct
 
 WORKDIR /openim/openim-server
 

build/images/openim-cmdutils/Dockerfile

@@ -19,6 +19,7 @@
 FROM golang:1.20 AS builder
 
 ARG GO111MODULE=on
+ARG GOPROXY=https://goproxy.io,direct
 
 WORKDIR /openim/openim-server
 

build/images/openim-crontask/Dockerfile

@@ -19,6 +19,7 @@
 FROM golang:1.20 AS builder
 
 ARG GO111MODULE=on
+ARG GOPROXY=https://goproxy.io,direct
 
 WORKDIR /openim/openim-server
 

build/images/openim-msggateway/Dockerfile

@@ -19,6 +19,7 @@
 FROM golang:1.20 AS builder
 
 ARG GO111MODULE=on
+ARG GOPROXY=https://goproxy.io,direct
 
 WORKDIR /openim/openim-server
 

build/images/openim-msgtransfer/Dockerfile

@@ -19,6 +19,7 @@
 FROM golang:1.20 AS builder
 
 ARG GO111MODULE=on
+ARG GOPROXY=https://goproxy.io,direct
 
 WORKDIR /openim/openim-server
 

build/images/openim-push/Dockerfile

@@ -19,6 +19,7 @@
 FROM golang:1.20 AS builder
 
 ARG GO111MODULE=on
+ARG GOPROXY=https://goproxy.io,direct
 
 WORKDIR /openim/openim-server
 

build/images/openim-rpc-auth/Dockerfile

@@ -19,6 +19,7 @@
 FROM golang:1.20 AS builder
 
 ARG GO111MODULE=on
+ARG GOPROXY=https://goproxy.io,direct
 
 WORKDIR /openim/openim-server
 

build/images/openim-rpc-conversation/Dockerfile

@@ -19,6 +19,7 @@
 FROM golang:1.20 AS builder
 
 ARG GO111MODULE=on
+ARG GOPROXY=https://goproxy.io,direct
 
 WORKDIR /openim/openim-server
 

build/images/openim-rpc-friend/Dockerfile

@@ -19,6 +19,7 @@
 FROM golang:1.20 AS builder
 
 ARG GO111MODULE=on
+ARG GOPROXY=https://goproxy.io,direct
 
 WORKDIR /openim/openim-server
 

build/images/openim-rpc-group/Dockerfile

@@ -19,6 +19,7 @@
 FROM golang:1.20 AS builder
 
 ARG GO111MODULE=on
+ARG GOPROXY=https://goproxy.io,direct
 
 WORKDIR /openim/openim-server
 

build/images/openim-rpc-msg/Dockerfile

@@ -19,6 +19,7 @@
 FROM golang:1.20 AS builder
 
 ARG GO111MODULE=on
+ARG GOPROXY=https://goproxy.io,direct
 
 WORKDIR /openim/openim-server
 

build/images/openim-rpc-third/Dockerfile

@@ -19,6 +19,7 @@
 FROM golang:1.20 AS builder
 
 ARG GO111MODULE=on
+ARG GOPROXY=https://goproxy.io,direct
 
 WORKDIR /openim/openim-server
 

build/images/openim-rpc-user/Dockerfile

@@ -19,6 +19,7 @@
 FROM golang:1.20 AS builder
 
 ARG GO111MODULE=on
+ARG GOPROXY=https://goproxy.io,direct
 
 WORKDIR /openim/openim-server
 

build/images/openim-tools/component/Dockerfile

@@ -19,6 +19,7 @@
 FROM golang:1.20 AS builder
 
 ARG GO111MODULE=on
+ARG GOPROXY=https://goproxy.io,direct
 
 WORKDIR /openim/openim-server
 

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

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

cmd/openim-api/main.go

@@ -18,12 +18,14 @@ import (
 	_ "net/http/pprof"
 
 	"github.com/openimsdk/open-im-server/v3/pkg/common/cmd"
-	"github.com/openimsdk/tools/system/program"
+	util "github.com/openimsdk/open-im-server/v3/pkg/util/genutil"
 )
 
 func main() {
-	if err := cmd.NewApiCmd().Exec(); err != nil {
-		program.ExitWithError(err)
+	apiCmd := cmd.NewApiCmd()
+	apiCmd.AddPortFlag()
+	apiCmd.AddPrometheusPortFlag()
+	if err := apiCmd.Execute(); err != nil {
+		util.ExitWithError(err)
 	}
-
 }

cmd/openim-cmdutils/main.go

@@ -16,7 +16,7 @@ package main
 
 import (
 	"github.com/openimsdk/open-im-server/v3/pkg/common/cmd"
-	"github.com/openimsdk/tools/system/program"
+	util "github.com/openimsdk/open-im-server/v3/pkg/util/genutil"
 )
 
 func main() {
@@ -29,8 +29,6 @@ func main() {
 	getCmd.AddCommand(seqCmd.GetSeqCmd(), msgCmd.GetMsgCmd())
 	getCmd.AddSuperGroupIDFlag()
 	getCmd.AddUserIDFlag()
-	getCmd.AddConfigDirFlag()
-	getCmd.AddIndexFlag()
 	getCmd.AddBeginSeqFlag()
 	getCmd.AddLimitFlag()
 	// openIM get seq --userID=xxx
@@ -41,8 +39,6 @@ func main() {
 	fixCmd.AddCommand(seqCmd.FixSeqCmd())
 	fixCmd.AddSuperGroupIDFlag()
 	fixCmd.AddUserIDFlag()
-	fixCmd.AddConfigDirFlag()
-	fixCmd.AddIndexFlag()
 	fixCmd.AddFixAllFlag()
 	// openIM fix seq --userID=xxx
 	// openIM fix seq --superGroupID=xxx
@@ -51,8 +47,6 @@ func main() {
 	clearCmd.AddCommand(msgCmd.ClearMsgCmd())
 	clearCmd.AddSuperGroupIDFlag()
 	clearCmd.AddUserIDFlag()
-	clearCmd.AddConfigDirFlag()
-	clearCmd.AddIndexFlag()
 	clearCmd.AddClearAllFlag()
 	clearCmd.AddBeginSeqFlag()
 	clearCmd.AddLimitFlag()
@@ -61,6 +55,6 @@ func main() {
 	// openIM clear msg --clearAll
 	msgUtilsCmd.AddCommand(&getCmd.Command, &fixCmd.Command, &clearCmd.Command)
 	if err := msgUtilsCmd.Execute(); err != nil {
-		program.ExitWithError(err)
+		util.ExitWithError(err)
 	}
 }

cmd/openim-crontask/main.go

@@ -16,11 +16,12 @@ package main
 
 import (
 	"github.com/openimsdk/open-im-server/v3/pkg/common/cmd"
-	"github.com/openimsdk/tools/system/program"
+	util "github.com/openimsdk/open-im-server/v3/pkg/util/genutil"
 )
 
 func main() {
-	if err := cmd.NewCronTaskCmd().Exec(); err != nil {
-		program.ExitWithError(err)
+	cronTaskCmd := cmd.NewCronTaskCmd()
+	if err := cronTaskCmd.Exec(); err != nil {
+		util.ExitWithError(err)
 	}
 }

cmd/openim-msggateway/main.go

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

cmd/openim-msgtransfer/main.go

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

cmd/openim-push/main.go

@@ -15,12 +15,16 @@
 package main
 
 import (
+	"github.com/openimsdk/open-im-server/v3/internal/push"
 	"github.com/openimsdk/open-im-server/v3/pkg/common/cmd"
-	"github.com/openimsdk/tools/system/program"
+	util "github.com/openimsdk/open-im-server/v3/pkg/util/genutil"
 )
 
 func main() {
-	if err := cmd.NewPushRpcCmd().Exec(); err != nil {
-		program.ExitWithError(err)
+	pushCmd := cmd.NewRpcCmd(cmd.RpcPushServer, push.Start)
+	pushCmd.AddPortFlag()
+	pushCmd.AddPrometheusPortFlag()
+	if err := pushCmd.Exec(); err != nil {
+		util.ExitWithError(err)
 	}
 }

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

@@ -15,12 +15,16 @@
 package main
 
 import (
+	"github.com/openimsdk/open-im-server/v3/internal/rpc/auth"
 	"github.com/openimsdk/open-im-server/v3/pkg/common/cmd"
-	"github.com/openimsdk/tools/system/program"
+	util "github.com/openimsdk/open-im-server/v3/pkg/util/genutil"
 )
 
 func main() {
-	if err := cmd.NewAuthRpcCmd().Exec(); err != nil {
-		program.ExitWithError(err)
+	authCmd := cmd.NewRpcCmd(cmd.RpcAuthServer, auth.Start)
+	authCmd.AddPortFlag()
+	authCmd.AddPrometheusPortFlag()
+	if err := authCmd.Exec(); err != nil {
+		util.ExitWithError(err)
 	}
 }

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

@@ -15,12 +15,16 @@
 package main
 
 import (
+	"github.com/openimsdk/open-im-server/v3/internal/rpc/conversation"
 	"github.com/openimsdk/open-im-server/v3/pkg/common/cmd"
-	"github.com/openimsdk/tools/system/program"
+	util "github.com/openimsdk/open-im-server/v3/pkg/util/genutil"
 )
 
 func main() {
-	if err := cmd.NewConversationRpcCmd().Exec(); err != nil {
-		program.ExitWithError(err)
+	rpcCmd := cmd.NewRpcCmd(cmd.RpcConversationServer, conversation.Start)
+	rpcCmd.AddPortFlag()
+	rpcCmd.AddPrometheusPortFlag()
+	if err := rpcCmd.Exec(); err != nil {
+		util.ExitWithError(err)
 	}
 }

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

@@ -15,12 +15,16 @@
 package main
 
 import (
+	"github.com/openimsdk/open-im-server/v3/internal/rpc/friend"
 	"github.com/openimsdk/open-im-server/v3/pkg/common/cmd"
-	"github.com/openimsdk/tools/system/program"
+	util "github.com/openimsdk/open-im-server/v3/pkg/util/genutil"
 )
 
 func main() {
-	if err := cmd.NewFriendRpcCmd().Exec(); err != nil {
-		program.ExitWithError(err)
+	rpcCmd := cmd.NewRpcCmd(cmd.RpcFriendServer, friend.Start)
+	rpcCmd.AddPortFlag()
+	rpcCmd.AddPrometheusPortFlag()
+	if err := rpcCmd.Exec(); err != nil {
+		util.ExitWithError(err)
 	}
 }

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

@@ -15,12 +15,16 @@
 package main
 
 import (
+	"github.com/openimsdk/open-im-server/v3/internal/rpc/group"
 	"github.com/openimsdk/open-im-server/v3/pkg/common/cmd"
-	"github.com/openimsdk/tools/system/program"
+	util "github.com/openimsdk/open-im-server/v3/pkg/util/genutil"
 )
 
 func main() {
-	if err := cmd.NewGroupRpcCmd().Exec(); err != nil {
-		program.ExitWithError(err)
+	rpcCmd := cmd.NewRpcCmd(cmd.RpcGroupServer, group.Start)
+	rpcCmd.AddPortFlag()
+	rpcCmd.AddPrometheusPortFlag()
+	if err := rpcCmd.Exec(); err != nil {
+		util.ExitWithError(err)
 	}
 }

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

@@ -15,12 +15,16 @@
 package main
 
 import (
+	"github.com/openimsdk/open-im-server/v3/internal/rpc/msg"
 	"github.com/openimsdk/open-im-server/v3/pkg/common/cmd"
-	"github.com/openimsdk/tools/system/program"
+	util "github.com/openimsdk/open-im-server/v3/pkg/util/genutil"
 )
 
 func main() {
-	if err := cmd.NewMsgRpcCmd().Exec(); err != nil {
-		program.ExitWithError(err)
+	rpcCmd := cmd.NewRpcCmd(cmd.RpcMsgServer, msg.Start)
+	rpcCmd.AddPortFlag()
+	rpcCmd.AddPrometheusPortFlag()
+	if err := rpcCmd.Exec(); err != nil {
+		util.ExitWithError(err)
 	}
 }

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

@@ -15,12 +15,16 @@
 package main
 
 import (
+	"github.com/openimsdk/open-im-server/v3/internal/rpc/third"
 	"github.com/openimsdk/open-im-server/v3/pkg/common/cmd"
-	"github.com/openimsdk/tools/system/program"
+	util "github.com/openimsdk/open-im-server/v3/pkg/util/genutil"
 )
 
 func main() {
-	if err := cmd.NewThirdRpcCmd().Exec(); err != nil {
-		program.ExitWithError(err)
+	rpcCmd := cmd.NewRpcCmd(cmd.RpcThirdServer, third.Start)
+	rpcCmd.AddPortFlag()
+	rpcCmd.AddPrometheusPortFlag()
+	if err := rpcCmd.Exec(); err != nil {
+		util.ExitWithError(err)
 	}
 }

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

@@ -15,12 +15,16 @@
 package main
 
 import (
+	"github.com/openimsdk/open-im-server/v3/internal/rpc/user"
 	"github.com/openimsdk/open-im-server/v3/pkg/common/cmd"
-	"github.com/openimsdk/tools/system/program"
+	util "github.com/openimsdk/open-im-server/v3/pkg/util/genutil"
 )
 
 func main() {
-	if err := cmd.NewUserRpcCmd().Exec(); err != nil {
-		program.ExitWithError(err)
+	rpcCmd := cmd.NewRpcCmd(cmd.RpcUserServer, user.Start)
+	rpcCmd.AddPortFlag()
+	rpcCmd.AddPrometheusPortFlag()
+	if err := rpcCmd.Exec(); err != nil {
+		util.ExitWithError(err)
 	}
 }

config/README.md

@@ -1,63 +0,0 @@
----
-title: 'OpenIM Configuration Files and Common Configuration Item Modifications Guide'
-
-## Configuration Files Explanation
-
-| Configuration File              | Description                                                  |
-| ------------------------------- | ------------------------------------------------------------ |
-| **kafka.yml**                   | Configurations for Kafka username, password, address, etc.   |
-| **redis.yml**                   | Configurations for Redis password, address, etc.             |
-| **minio.yml**                   | Configurations for MinIO username, password, address, and external IP/domain; failing to modify external IP or domain may cause image file sending failures |
-| **zookeeper.yml**               | Configurations for ZooKeeper user, password, address, etc.   |
-| **mongodb.yml**                 | Configurations for MongoDB username, password, address, etc. |
-| **log.yml**                     | Configurations for log level and storage directory.          |
-| **notification.yml**            | Configurations for events like adding friends, creating groups, etc. |
-| **share.yml**                   | Common configurations needed by various OpenIM services, such as secret. |
-| **webhooks.yml**                | Configurations for URLs in Webhook.                          |
-| **local-cache.yml**             | Local cache configurations.                                  |
-| **openim-rpc-third.yml**        | Configurations for listening IP, port, and storage settings for images and videos in openim-rpc-third service. |
-| **openim-rpc-user.yml**         | Configurations for listening IP and port in openim-rpc-user service. |
-| **openim-api.yml**              | Configurations for listening IP, port, etc., in openim-api service. |
-| **openim-crontask.yml**         | Configurations for openim-crontask service.                  |
-| **openim-msggateway.yml**       | Configurations for listening IP, port, etc., in openim-msggateway service. |
-| **openim-msgtransfer.yml**      | Configurations for openim-msgtransfer service.               |
-| **openim-push.yml**             | Configurations for listening IP, port, and offline push settings in openim-push service. |
-| **openim-rpc-auth.yml**         | Configurations for listening IP, port, and token expiration settings in openim-rpc-auth service. |
-| **openim-rpc-conversation.yml** | Configurations for listening IP, port, etc., in openim-rpc-conversation service. |
-| **openim-rpc-friend.yml**       | Configurations for listening IP, port, etc., in openim-rpc-friend service. |
-| **openim-rpc-group.yml**        | Configurations for listening IP, port, etc., in openim-rpc-group service. |
-| **openim-rpc-msg.yml**          | Configurations for listening IP, port, and whether to verify friendship before sending messages in openim-rpc-msg service. |
-
-## Common Configuration Item Modifications
-
-| Configuration Item Modification                       | Configuration File      |
-| ----------------------------------------------------- | ----------------------- |
-| Using MinIO for image and video file object storage   | `minio.yml`             |
-| Adjusting production environment logs                 | `log.yml`               |
-| Verifying friendship before sending messages          | `openim-rpc-msg.yml`    |
-| Modifying secret                                      | `share.yml`             |
-| Using OSS, COS, AWS, Kodo for image and video storage | `openim-rpc-third.yml`  |
-| Setting multiple login policy                         | `openim-msggateway.yml` |
-| Setting up offline push                               | `openim-push.yml`       |
-
-## Starting Multiple Instances of an OpenIM Service
-
-To start multiple instances of an OpenIM service, simply increase the corresponding port numbers and modify the `start-config.yml` file in the project root directory. Restart the service to take effect. For example, the configuration to start 2 instances of `openim-rpc-user` is as follows:
-
-```yaml
-rpc:
-  registerIP: ''
-  listenIP: 0.0.0.0
-  ports: [ 10110, 10111 ]
-
-prometheus:
-  enable: true
-  ports: [ 20100, 20101 ]
-```
-
-Modify `start-config.yml`:
-
-```yaml
-serviceBinaries:
-  openim-rpc-user: 2
-```

config/README_zh_CN.md

@@ -1,65 +0,0 @@
-# 						OpenIM配置文件说明以及常用配置修改说明
-
-## 配置文件说明
-
-| Configuration File              | Description                                                  |
-| ------------------------------- | ------------------------------------------------------------ |
-| **kafka.yml**                   | Kafka用户名、密码、地址等配置                                |
-| **redis.yml**                   | Redis密码、地址等配置                                        |
-| **minio.yml**                   | MinIO用户名、密码、地址及外网IP域名等配置；未修改外网IP或域名可能导致图片文件发送失败 |
-| **zookeeper.yml**               | ZooKeeper用户、密码、地址等配置                              |
-| **mongodb.yml**                 | MongoDB用户名、密码、地址等配置                              |
-| **log.yml**                     | 日志级别及存储目录等配置                                     |
-| **notification.yml**            | 添加好友、创建群组等事件通知配置                             |
-| **share.yml**                   | OpenIM各服务所需的公共配置，如secret等                       |
-| **webhooks.yml**                | Webhook中URL等配置                                           |
-| **local-cache.yml**             | 本地缓存配置                                                 |
-| **openim-rpc-third.yml**        | openim-rpc-third服务的监听IP、端口及图片视频对象存储配置     |
-| **openim-rpc-user.yml**         | openim-rpc-user服务的监听IP、端口配置                        |
-| **openim-api.yml**              | openim-api服务的监听IP、端口等配置项                         |
-| **openim-crontask.yml**         | openim-crontask服务配置                                      |
-| **openim-msggateway.yml**       | openim-msggateway服务的监听IP、端口等配置                    |
-| **openim-msgtransfer.yml**      | openim-msgtransfer服务配置                                   |
-| **openim-push.yml**             | openim-push服务的监听IP、端口及离线推送配置                  |
-| **openim-rpc-auth.yml**         | openim-rpc-auth服务的监听IP、端口及token有效期等配置         |
-| **openim-rpc-conversation.yml** | openim-rpc-conversation服务的监听IP、端口等配置              |
-| **openim-rpc-friend.yml**       | openim-rpc-friend服务的监听IP、端口等配置                    |
-| **openim-rpc-group.yml**        | openim-rpc-group服务的监听IP、端口等配置                     |
-| **openim-rpc-msg.yml**          | openim-rpc-msg服务的监听IP、端口及消息发送是否验证好友关系等配置 |
-
-## 常用配置修改
-
-| 修改配置项                                      | 配置文件                |
-| ----------------------------------------------- | ----------------------- |
-| 使用minio作为图片视频文件对象存储               | `minio.yml`             |
-| 生产环境日志调整                                | `log.yml`               |
-| 发送消息是否验证好友关系                        | `openim-rpc-msg.yml`    |
-| 修改secret                                      | `share.yml`             |
-| 使用oss, cos, aws, kodo作为图片视频文件对象存储 | `openim-rpc-third.yml`  |
-| 设置多端互踢策略                                | `openim-msggateway.yml` |
-| 设置离线推送                                    | `openim-push.yml`       |
-
-## 启动某个OpenIM服务的多个实例
-
-若要启动某个OpenIM的多个实例，只需增加对应的端口数，并修改项目根目录下的`start-config.yml`文件，重启服务即可生效。例如，启动2个`openim-rpc-user`实例的配置如下：
-
-```yaml
-rpc:
-  registerIP: ''
-  listenIP: 0.0.0.0
-  ports: [ 10110, 10111 ]
-
-prometheus:
-  enable: true
-  ports: [ 20100, 20101 ]
-```
-
-修改`start-config.yml`:
-
-```yaml
-serviceBinaries:
-  openim-rpc-user: 2
-```
-
-
-

config/Readme.md

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

config/discovery.yml

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

config/kafka.yml

@@ -1,36 +0,0 @@
-# Username for authentication
-username: ''
-# Password for authentication
-password: ''
-# Producer acknowledgment settings
-producerAck: ""
-# Compression type to use (e.g., none, gzip, snappy)
-compressType: "none"
-# List of Kafka broker addresses
-address: [ localhost:19094 ]
-# Kafka topic for Redis integration
-toRedisTopic: "toRedis"
-# Kafka topic for MongoDB integration
-toMongoTopic: "toMongo"
-# Kafka topic for push notifications
-toPushTopic: "toPush"
-# Consumer group ID for Redis topic
-toRedisGroupID: redis
-# Consumer group ID for MongoDB topic
-toMongoGroupID: mongo
-# Consumer group ID for push notifications topic
-toPushGroupID: push
-# TLS (Transport Layer Security) configuration
-tls:
-  # Enable or disable TLS
-  enableTLS: false
-  # CA certificate file path
-  caCrt: ""
-  # Client certificate file path
-  clientCrt: ""
-  # Client key file path
-  clientKey: ""
-  # Client key password
-  clientKeyPwd: ""
-  # Whether to skip TLS verification (not recommended for production)
-  insecureSkipVerify: false

config/local-cache.yml

@@ -1,27 +0,0 @@
-user:
-  topic: DELETE_CACHE_USER
-  slotNum: 100
-  slotSize: 2000
-  successExpire: 300
-  failedExpire: 5
-
-group:
-  topic: DELETE_CACHE_GROUP
-  slotNum: 100
-  slotSize: 2000
-  successExpire: 300
-  failedExpire: 5
-
-friend:
-  topic: DELETE_CACHE_FRIEND
-  slotNum: 100
-  slotSize: 2000
-  successExpire: 300
-  failedExpire: 5
-
-conversation:
-  topic: DELETE_CACHE_CONVERSATION
-  slotNum: 100
-  slotSize: 2000
-  successExpire: 300
-  failedExpire: 5

config/log.yml

@@ -1,13 +0,0 @@
-# Log storage path, default is acceptable, change to a full path if modification is needed
-storageLocation: ../../../../logs/
-# Log rotation period (in hours), default is acceptable
-rotationTime: 24
-# Number of log files to retain, default is acceptable
-remainRotationCount: 2
-# Log level settings: 3 for production environment; 6 for more verbose logging in debugging environments
-remainLogLevel: 6
-# Whether to output to standard output, default is acceptable
-isStdout: false
-# Whether to log in JSON format, default is acceptable
-isJson: false
-

config/minio.yml

@@ -1,16 +0,0 @@
-# Name of the bucket in MinIO
-bucket: "openim"
-# Access key ID for MinIO authentication
-accessKeyID: "root"
-# Secret access key for MinIO authentication
-secretAccessKey: "openIM123"
-# Session token for MinIO authentication (optional)
-sessionToken: ''
-# Internal address of the MinIO server
-internalAddress: "localhost:10005"
-# External address of the MinIO server, accessible from outside. Supports both HTTP and HTTPS using a domain name
-externalAddress: "http://external_ip:10005"
-# Flag to enable or disable public read access to the bucket
-publicRead: false
-
-

config/mongodb.yml

@@ -1,14 +0,0 @@
-# URI for database connection, leave empty if using address and credential settings directly
-uri: ''
-# List of MongoDB server addresses
-address: [ localhost:37017 ]
-# Name of the database
-database: openim_v3
-# Username for database authentication
-username: openIM
-# Password for database authentication
-password: openIM123
-# Maximum number of connections in the connection pool
-maxPoolSize: 100
-# Maximum number of retry attempts for a failed database connection
-maxRetry: 10

config/openim-api.yml

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

config/openim-crontask.yml

@@ -1,2 +0,0 @@
-chatRecordsClearTime: "0 2 * * *"
-retainChatRecords: 365

config/openim-msggateway.yml

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

config/openim-msgtransfer.yml

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

config/openim-push.yml

@@ -1,44 +0,0 @@
-rpc:
-  # The IP address where this RPC service registers itself; if left blank, it defaults to the internal network IP
-  registerIP: ''
-  # IP address that the RPC service listens on; setting to 0.0.0.0 listens on both internal and external IPs. If left blank, it automatically uses the internal network IP
-  listenIP: 0.0.0.0
-  # List of ports that the RPC service listens on; configuring multiple ports will launch multiple instances. These must match the number of configured prometheus ports
-  ports: [ 10170 ]
-
-prometheus:
-  # Enable or disable Prometheus monitoring
-  enable: true
-  # List of ports that Prometheus listens on; these must match the number of rpc.ports to ensure correct monitoring setup
-  ports: [ 20107 ]
-
-maxConcurrentWorkers: 3
-#"Use geTui for offline push notifications, or choose fcm or jpns; corresponding configuration settings must be specified."
-enable: "geTui"
-geTui:
-  pushUrl: "https://restapi.getui.com/v2/$appId"
-  masterSecret: ''
-  appKey: ''
-  intent: ''
-  channelID: ''
-  channelName: ''
-fcm:
-  serviceAccount: "x.json"
-jpns:
-  appKey: ''
-  masterSecret: ''
-  pushURL: ''
-  pushIntent: ''
-
-# iOS system push sound and badge count
-iosPush:
-      pushSound: "xxx"
-      badgeCount: true
-      production: false
-
-
-
-
-
-
-

config/openim-rpc-auth.yml

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

config/openim-rpc-conversation.yml

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

config/openim-rpc-friend.yml

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

config/openim-rpc-group.yml

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

config/openim-rpc-msg.yml

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

config/openim-rpc-third.yml

@@ -1,32 +0,0 @@
-rpc:
-  # The IP address where this RPC service registers itself; if left blank, it defaults to the internal network IP
-  registerIP: ''
-  # IP address that the RPC service listens on; setting to 0.0.0.0 listens on both internal and external IPs. If left blank, it automatically uses the internal network IP
-  listenIP: 0.0.0.0
-  # List of ports that the RPC service listens on; configuring multiple ports will launch multiple instances. These must match the number of configured prometheus ports
-  ports: [ 10190 ]
-
-prometheus:
-  # Enable or disable Prometheus monitoring
-  enable: true
-  # List of ports that Prometheus listens on; these must match the number of rpc.ports to ensure correct monitoring setup
-  ports: [ 20101 ]
-
-
-object:
-  # Use MinIO as object storage, or set to "cos", "oss", "kodo", "aws", while also configuring the corresponding settings
-  enable: "minio"
-  cos:
-    bucketURL: https://temp-1252357374.cos.ap-chengdu.myqcloud.com
-    secretID: ''
-    secretKey: ''
-    sessionToken: ''
-    publicRead: false
-  oss:
-    endpoint: "https://oss-cn-chengdu.aliyuncs.com"
-    bucket: "demo-9999999"
-    bucketURL: "https://demo-9999999.oss-cn-chengdu.aliyuncs.com"
-    accessKeyID: ''
-    accessKeySecret: ''
-    sessionToken: ''
-    publicRead: false

config/openim-rpc-user.yml

@@ -1,17 +0,0 @@
-rpc:
-  # API or other RPCs can access this RPC through this IP; if left blank, the internal network IP is obtained by default
-  registerIP: ''
-  # Listening IP; 0.0.0.0 means both internal and external IPs are listened to, if blank, the internal network IP is automatically obtained by default
-  listenIP: 0.0.0.0
-  # Listening ports; if multiple are configured, multiple instances will be launched, and must be consistent with the number of prometheus.ports
-  ports: [ 10110 ]
-
-prometheus:
-  # Whether to enable prometheus
-  enable: true
-  # Prometheus listening ports, must be consistent with the number of rpc.ports
-  ports: [ 20100 ]
-
-
-
-

config/redis.yml

@@ -1,7 +0,0 @@
-address: [ localhost:16379 ]
-username: ''
-password: openIM123
-enablePipeline: false
-clusterMode: false
-db: 0
-maxRetry: 10

config/share.yml

@@ -1,14 +0,0 @@
-secret: openIM123
-rpcRegisterName:
-  user: user
-  friend: friend
-  msg: msg
-  push: push
-  messageGateway: messageGateway
-  group: group
-  auth: auth
-  conversation: conversation
-  third: third
-
-imAdminUserID: [ "imAdmin" ]
-

config/templates/alertmanager.yml.template

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

@@ -0,0 +1,536 @@
+# Copyright © 2023 OpenIM. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the License);
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# -----------------------------------------------------------------
+# TODO: This config file is the template file
+# --| source: deployments/templates/config.yaml
+# --| env: scripts/install/environment
+# --| target: config/config.yaml
+# -----------------------------------------------------------------
+
+envs:
+  discovery: zookeeper
+
+###################### Zookeeper ######################
+# Zookeeper configuration
+# It's not recommended to modify the schema
+# 
+# Zookeeper address
+# Zookeeper username
+# Zookeeper password
+zookeeper:
+  schema: openim
+  address: [ 172.28.0.1:12181 ]
+  username: ''
+  password: ''
+
+###################### Mongo ######################
+# MongoDB configuration
+
+# 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: ''
+
+# 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: [ 172.28.0.1:37017 ]
+  database: openim_v3
+  username: openIM
+  password: openIM123
+  maxPoolSize: 100
+
+###################### Redis configuration information ######################
+# Redis configuration
+#
+# Username is required only for Redis version 6.0+
+redis:
+  address: [ 172.28.0.1:16379 ]
+  username: ''
+  password: openIM123
+
+###################### Kafka configuration information ######################
+# Kafka configuration
+#
+# Kafka username
+# Kafka password
+# It's not recommended to modify this topic name
+# Consumer group ID, it's not recommended to modify
+kafka:
+  username: ''
+  password: ''
+  addr: [ 172.28.0.1:19094 ]
+  latestMsgToRedis:
+    topic: "latestMsgToRedis"
+  offlineMsgToMongo:
+    topic: "offlineMsgToMongoMysql"
+  msgToPush:
+    topic: "msgToPush"
+  consumerGroupID:
+    msgToRedis: redis
+    msgToMongo: mongo
+    msgToMySql: mysql
+    msgToPush: push
+
+###################### RPC configuration information ######################
+# RPC configuration
+#
+# IP address to register with zookeeper when starting RPC, the IP and corresponding rpcPort should be accessible by api/gateway
+# Default listen IP is 0.0.0.0
+rpc:
+  registerIP: ''
+  listenIP: 0.0.0.0
+
+###################### API configuration information ######################
+# API configuration
+#
+# API service port
+# Default listen IP is 0.0.0.0
+api:
+  openImApiPort: [ 10002 ]
+  listenIP: 0.0.0.0
+
+###################### Object configuration information ######################
+# Object storage configuration
+#
+# Use minio for object storage
+# API URL should be accessible by the app
+# It's not recommended to modify the bucket name
+# Endpoint should be accessible by the app
+# Session token
+# Configuration for Tencent COS
+# Configuration for Aliyun OSS
+# apiURL is the address of the api, the access address of the app, use s3 must be configured
+# minio.endpoint can be configured as an intranet address,
+# minio.signEndpoint is minio public network address
+object:
+  enable: "minio"
+  apiURL: "http://172.28.0.1:10002"
+  minio:
+    bucket: "openim"
+    endpoint: "http://172.28.0.1:10005"
+    accessKeyID: "root"
+    secretAccessKey: "openIM123"
+    sessionToken: ''
+    signEndpoint: "http://172.28.0.1:10005"
+    publicRead: false
+  cos:
+    bucketURL: https://temp-1252357374.cos.ap-chengdu.myqcloud.com
+    secretID: ''
+    secretKey: ''
+    sessionToken: ''
+    publicRead: false
+  oss:
+    endpoint: "https://oss-cn-chengdu.aliyuncs.com"
+    bucket: "demo-9999999"
+    bucketURL: "https://demo-9999999.oss-cn-chengdu.aliyuncs.com"
+    accessKeyID: ''
+    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
+  aws:
+    endpoint: ""
+    region: ""
+    bucket: "demo-9999999"
+    accessKeyID: ''
+    accessKeySecret: ''
+    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:
+  openImUserPort: [ 10110 ]
+  openImFriendPort: [ 10120 ]
+  openImMessagePort: [ 10130 ]
+  openImGroupPort: [ 10150 ]
+  openImAuthPort: [ 10160 ]
+  openImPushPort: [ 10170 ]
+  openImConversationPort: [ 10180 ]
+  openImThirdPort: [ 10190 ]
+
+###################### RPC Register Name Configuration ######################
+# RPC service names for registration, it's not recommended to modify these
+rpcRegisterName:
+  openImUserName: User
+  openImFriendName: Friend
+  openImMsgName: Msg
+  openImPushName: Push
+  openImMessageGatewayName: MessageGateway
+  openImGroupName: Group
+  openImAuthName: Auth
+  openImConversationName: Conversation
+  openImThirdName: Third
+
+###################### Log Configuration ######################
+# Log configuration
+#
+# Storage directory
+# Log rotation time
+# Maximum number of logs to retain
+# Log level, 6 means all levels
+# Whether to output to stdout
+# Whether to output in json format
+# Whether to include stack trace in logs
+log:
+  storageLocation: /workspaces/open-im-server/logs/
+  rotationTime: 24
+  remainRotationCount: 2
+  remainLogLevel: 6
+  isStdout: false
+  isJson: false
+  withStack: false
+
+###################### Variables definition ######################
+# Long connection server configuration
+#
+# Websocket port for msg_gateway
+# Maximum number of websocket connections
+# Maximum length of websocket request package
+# Websocket connection handshake timeout
+longConnSvr:
+  openImWsPort: [ 10001 ]
+  websocketMaxConnNum: 100000
+  openImMessageGatewayPort: [ 10140 ]
+  websocketMaxMsgLen: 4096
+  websocketTimeout: 10
+
+# Push notification service configuration
+#
+# Use GeTui for push notifications
+# GeTui offline push configuration
+# FCM offline push configuration
+# Account file, place it in the config directory
+# JPush configuration, modify these after applying in JPush backend
+push:
+  enable: getui
+  geTui:
+    pushUrl: "https://restapi.getui.com/v2/$appId"
+    masterSecret: ''
+    appKey: ''
+    intent: ''
+    channelID: ''
+    channelName: ''
+  fcm:
+    serviceAccount: "x.json"
+  jpns:
+    appKey: ''
+    masterSecret: ''
+    pushUrl: ''
+    pushIntent: ''
+
+# App manager configuration
+#
+# Built-in app manager user IDs
+# Built-in app manager nicknames
+manager:
+  userID: [ "openIM123456", "openIM654321", "openIMAdmin" ]
+  nickname: [ "system1", "system2", "system3" ]
+
+# chatAdmin, use for send notification
+#
+# Built-in app system notification account ID
+# Built-in app system notification account nickname
+im-admin:
+  userID: [ "imAdmin" ]
+  nickname: [ "imAdmin" ]
+
+# Multi-platform login policy
+# For each platform(Android, iOS, Windows, Mac, web), only one can be online at a time
+multiLoginPolicy: 1
+
+# Whether to store messages in MySQL, messages in MySQL are only used for management background
+chatPersistenceMysql: true
+
+# Message cache timeout in seconds, it's not recommended to modify
+msgCacheTimeout: 86400
+
+# Whether to enable read receipts for group chat
+groupMessageHasReadReceiptEnable: true
+
+# Whether to enable read receipts for single chat
+singleMessageHasReadReceiptEnable: true
+
+# MongoDB offline message retention period in days
+retainChatRecords: 365
+
+# Schedule to clear expired messages(older than retainChatRecords days) in MongoDB every Wednesday at 2am
+# This deletion is just for cleaning up disk usage according to previous configuration retainChatRecords, no notification will be sent
+chatRecordsClearTime: "0 2 * * 3"
+
+# Schedule to auto delete messages every day at 2am
+# This deletion is for messages that have been retained for more than msg_destruct_time (seconds) in the conversation field
+msgDestructTime: "0 2 * * *"
+
+# Secret key
+secret: openIM123
+
+# Token policy
+#
+# Token expiration period in days
+tokenPolicy:
+  expire: 90
+
+# Message verification policy
+#
+# Whether to verify friendship when sending messages
+messageVerify:
+  friendVerify: false
+
+# iOS push notification configuration
+#
+# iOS push notification sound
+# Whether to count badge
+# Whether it's production environment
+iosPush:
+  pushSound: "xxx"
+  badgeCount: true
+  production: false
+
+###################### Third-party service configuration ######################
+# Callback configuration
+#
+# Callback URL
+# Whether to enable this callback event
+# Timeout in seconds
+# Whether to continue execution if callback fails
+callback:
+  url: "http://127.0.0.1:10008/callbackExample"
+  beforeSendSingleMsg:
+    enable: false
+    timeout: 5
+    failedContinue: true
+  beforeUpdateUserInfoEx:
+    enable:  false
+    timeout: 5
+    failedContinue: true
+  afterUpdateUserInfoEx:
+    enable:  false
+    timeout: 5
+    failedContinue: true
+  afterSendSingleMsg:
+    enable: true
+    timeout: 5
+    failedContinue: true
+  beforeSendGroupMsg:
+    enable: false
+    timeout: 5
+    failedContinue: true
+  afterSendGroupMsg:
+    enable: false
+    timeout: 5
+    failedContinue: true
+  msgModify:
+    enable: false
+    timeout: 5
+    failedContinue: true
+  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
+    failedContinue: true
+  onlinePush:
+    enable: false
+    timeout: 5
+    failedContinue: true
+  superGroupOnlinePush:
+    enable: false
+    timeout: 5
+    failedContinue: true
+  beforeAddFriend:
+    enable: false
+    timeout: 5
+    failedContinue: true
+  beforeUpdateUserInfo:
+    enable: false
+    timeout: 5
+    failedContinue: true
+  beforeCreateGroup:
+    enable: false
+    timeout: 5
+    failedContinue: true
+  afterCreateGroup:
+    enable: false
+    timeout: 5
+    failedContinue: true
+  beforeMemberJoinGroup:
+    enable: false
+    timeout: 5
+    failedContinue: true
+  beforeSetGroupMemberInfo:
+    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
+  grafanaUrl: http://172.28.0.1:13000/
+  apiPrometheusPort: [20100]
+  userPrometheusPort: [ 20110 ]
+  friendPrometheusPort: [ 20120 ]
+  messagePrometheusPort: [ 20130 ]
+  messageGatewayPrometheusPort: [ 20140 ]
+  groupPrometheusPort: [ 20150 ]
+  authPrometheusPort: [ 20160 ]
+  pushPrometheusPort: [ 20170 ]
+  conversationPrometheusPort: [ 20230 ]
+  rtcPrometheusPort: [ 21300 ]
+  thirdPrometheusPort: [ 21301 ]
+  messageTransferPrometheusPort: [ 21400, 21401, 21402, 21403 ] # List of ports

config/templates/email.tmpl.template

@@ -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/templates/env.template

@@ -0,0 +1,237 @@
+# Copyright © 2024 OpenIM. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# -----------------------------------------------------------------------------
+# General Configuration
+# This section contains general configuration options for the entire environment.
+# These options can be set via environment variables. If both environment variables 
+# and settings in this .env file exist, the environment variables take precedence.
+# -----------------------------------------------------------------------------
+# ==========================
+# General Configuration
+# ==========================
+# These settings apply to the overall environment.
+
+# Data storage directory for persistent data.
+# Example: DATA_DIR=/path/to/data
+DATA_DIR=/workspaces/open-im-server
+
+# Docker image registry. Uncomment the preferred one.
+# Options: ghcr.io/openimsdk, openim, registry.cn-hangzhou.aliyuncs.com/openimsdk
+# IMAGE_REGISTRY="ghcr.io/openimsdk"
+# IMAGE_REGISTRY="openim"
+# IMAGE_REGISTRY="registry.cn-hangzhou.aliyuncs.com/openimsdk"
+IMAGE_REGISTRY=ghcr.io/openimsdk
+
+# ======================================
+# ========= Network Configuration ======
+# ======================================
+
+# Subnet for the Docker network.
+# Default: DOCKER_BRIDGE_SUBNET=172.28.0.0/16
+DOCKER_BRIDGE_SUBNET=172.28.0.0/16
+
+# Set and specify the IP addresses of some containers. Generally speaking, 
+# you do not need to modify these configurations to facilitate debugging
+DOCKER_BRIDGE_GATEWAY=172.28.0.1
+MONGO_NETWORK_ADDRESS=172.28.0.2
+REDIS_NETWORK_ADDRESS=172.28.0.3
+KAFKA_NETWORK_ADDRESS=172.28.0.4
+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
+
+# ==============================================================================
+# Configuration Update Instructions
+# ==============================================================================
+# This header outlines the methods to update common variables in config.yaml and .env files.
+# These instructions are vital for maintaining the OpenIM environment's configuration.
+#
+# METHOD 1: Regenerate All Configurations
+# ----------------------------------------
+# Use this method to regenerate all configurations.
+# Steps:
+#   1. Delete existing config files:
+#      - openim-server/config/config.yaml
+#      - openim-chat/config/config.yaml
+#   2. Modify the .env file as required.
+#   3. Run 'docker compose up -d'. This will regenerate:
+#       - config/config.yaml
+#
+# METHOD 2: Modify Individual Configuration Files
+# -----------------------------------------------
+# Use this method to update specific configuration files.
+# Steps:
+#   1. Modify the .env file as necessary.
+#   2. Update the corresponding entries in:
+#      - config/config.yaml
+#   3. Restart the services with 'docker compose up -d'.
+#   4. Special Note: If you modify OPENIM_IP, API_OPENIM_PORT, or MINIO_PORT in .env,
+#      ensure to update the corresponding services and configurations accordingly.
+#
+# It is essential to follow these methods to ensure consistent and correct application behavior.
+# ==============================================================================
+# Local IP address of the service. Modify if necessary.
+# Example: OPENIM_IP=172.28.0.1，
+OPENIM_IP=172.28.0.1
+
+# ----- ZooKeeper Configuration -----
+# Port for ZooKeeper service.
+# Default: ZOOKEEPER_PORT=12181
+ZOOKEEPER_PORT=12181
+
+# MongoDB service port configuration.
+# Default: MONGO_PORT=37017
+# MONGO_PORT=37017
+
+# Password for MongoDB admin user. Used for service authentication.
+# Default: MONGO_PASSWORD=openIM123
+MONGO_PASSWORD=openIM123
+
+# Username for a regular OpenIM user in MongoDB.
+# Default: MONGO_OPENIM_USERNAME=openIM
+MONGO_OPENIM_USERNAME=openIM
+
+# Password for a regular OpenIM user in MongoDB.
+# Default: MONGO_OPENIM_PASSWORD=openIM123456
+MONGO_OPENIM_PASSWORD=openIM123
+
+# Specifies the database name to be used within MongoDB.
+# Default: MONGO_DATABASE=openim_v3
+MONGO_DATABASE=openim_v3
+
+MONGO_MAX_POOL_SIZE=100
+# ----- Redis Configuration -----
+
+# Port on which Redis in-memory data structure store is running.
+# Default: REDIS_PORT=16379
+REDIS_PORT=16379
+
+# Password to authenticate with the Redis service.
+# Default: REDIS_PASSWORD=openIM123
+REDIS_PASSWORD=openIM123
+
+# Kakfa username to authenticate with the Kafka service.
+# KAFKA_USERNAME=''
+
+# Port on which Kafka distributed streaming platform is running.
+# Default: KAFKA_PORT=19092
+KAFKA_PORT=19094
+
+# Topic in Kafka for storing the latest messages in Redis.
+# Default: KAFKA_LATESTMSG_REDIS_TOPIC=latestMsgToRedis
+KAFKA_LATESTMSG_REDIS_TOPIC=latestMsgToRedis
+
+# MINIO_PORT
+# ----------
+# MINIO_PORT sets the port for the MinIO object storage service.
+# Upon changing this port, the MinIO endpoint URLs in the  file must be updated
+# to reflect this change. The endpoints include both the 'endpoint' and 'signEndpoint' 
+# under the MinIO configuration.
+#
+# Default: MINIO_PORT=10005
+MINIO_PORT=10005
+
+# Access key to authenticate with the MinIO service.
+# Default: MINIO_ACCESS_KEY=root
+# MINIO_ACCESS_KEY=root
+
+# Secret key corresponding to the access key for MinIO authentication.
+# Default: MINIO_SECRET_KEY=openIM123
+MINIO_SECRET_KEY=openIM123
+
+# ----- Prometheus Configuration -----
+# Port on which Prometheus service is running.
+# Default: PROMETHEUS_PORT=19090
+PROMETHEUS_PORT=19090
+
+# ----- Grafana Configuration -----
+# Port on which Grafana service is running.
+# Default: GRAFANA_PORT=13000
+GRAFANA_PORT=13000
+
+# ======================================
+# ============ OpenIM Web ===============
+# ======================================
+
+# Port on which OpenIM web service is running.
+# Default: OPENIM_WEB_PORT=11001
+OPENIM_WEB_PORT=11001
+
+# ======================================
+# ========= OpenIM Server ==============
+# ======================================
+# Port for the OpenIM WebSockets.
+# Default: OPENIM_WS_PORT=10001
+OPENIM_WS_PORT=10001
+
+# API_OPENIM_PORT
+# ---------------
+# This variable defines the port on which the OpenIM API service will listen.
+# When changing this port, it's essential to update the apiURL in the config.yaml file
+# to ensure the API service is accessible at the new port.
+#
+# Default: API_OPENIM_PORT=10002
+API_OPENIM_PORT=10002
+
+# ======================================
+# ========== OpenIM Chat ===============
+# ======================================
+
+# Branch name for OpenIM chat.
+# Default: CHAT_IMAGE_VERSION=main
+CHAT_IMAGE_VERSION=main
+
+# Port for the OpenIM chat API.
+# Default: OPENIM_CHAT_API_PORT=10008
+OPENIM_CHAT_API_PORT=10008
+
+# Port for the OpenIM admin API.
+# Default: OPENIM_ADMIN_API_PORT=10009
+OPENIM_ADMIN_API_PORT=10009
+
+# ======================================
+# ========== OpenIM Admin ==============
+# ======================================
+
+# Branch name for OpenIM server.
+# Default: SERVER_IMAGE_VERSION=main
+SERVER_IMAGE_VERSION=main
+  
+# 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/instance-down-rules.yml.template

@@ -0,0 +1,36 @@
+# 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.
+
+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/notification.yaml.template

@@ -17,23 +17,32 @@
 # The options field 'isNotification' indicates if it's a notification.
 groupCreated:
   isSendMsg: true
+
 # Reliability level of the message sending.
 # Set to 1 to send only when online, 2 for guaranteed delivery.
   reliabilityLevel: 1
+
 # This setting is effective only when 'isSendMsg' is true.
 # It controls whether to count unread messages.
   unreadCount: false
+
 # Configuration for offline push notifications.
   offlinePush:
     # Enables or disables offline push notifications.
     enable: false
+
     # Title for the notification when a group is created.
     title: "create group title"
+
     # Description for the notification.
     desc: "create group desc"
+
     # Additional information for the notification.
     ext: "create group ext"
 
+# Content type is not added here.
+# Content should use a JSON structure conforming to the protobuf format.
+
 groupInfoSet:
   isSendMsg: false
   reliabilityLevel: 1
@@ -81,9 +90,9 @@ groupApplicationRejected:
   unreadCount: false
   offlinePush:
     enable: false
-    title: "groupApplicationRejected title"
-    desc: "groupApplicationRejected desc"
-    ext: "groupApplicationRejected ext"
+    title: " title"
+    desc: " desc"
+    ext: " ext"
 
 
 groupOwnerTransferred:

config/templates/open-im-ng-example.conf

@@ -0,0 +1,172 @@
+upstream im_msg_gateway{
+            server 127.0.0.1:10001;        #IM Message server address Multiple can be specified according to the deployment
+            }
+upstream im_api{
+            server 127.0.0.1:10002;        #IM Group user api server address Multiple can be specified according to the deployment
+            }
+upstream im_grafana{
+            server 127.0.0.1:10007;        #IM Statistical server address The machine where docker-compose starts
+            }
+upstream im_chat_api{
+            server 127.0.0.1:10008;        #IM Business version login registration server address Multiple can be specified according to the deployment
+            }
+upstream im_admin_api{
+            server 127.0.0.1:10009;         #IM The admin address of the commercial version can specify multiple units according to the deployment situation
+            }
+upstream im_open_rtc{
+            server 127.0.0.1:7880;          #rtc Audio and video call server address Multiple devices can be specified according to the deployment
+            }
+upstream minio_s3_2 {
+            least_conn;
+            server 127.0.0.1:10005;
+}
+
+upstream minio_console_2 {
+           least_conn;
+           server 127.0.0.1:9090;
+}
+server {
+        listen 443;
+        server_name your-domain.com;   #your-domain.com
+
+        ssl on;
+        ssl_certificate /etc/nginx/conf.d/ssl/your-domain.com.crt; #2 Certificate
+        ssl_certificate_key /etc/nginx/conf.d/ssl/your-domain.com.key; #3 Certificate
+        ssl_session_timeout 5m;
+		gzip on;
+		gzip_min_length 1k;
+		gzip_buffers 4 16k;
+		gzip_comp_level 2;
+		gzip_types text/plain application/javascript application/x-javascript text/css application/xml text/javascript application/x-httpd-php image/jpeg image/gif image/png application/wasm;
+		gzip_vary off;
+		gzip_disable "MSIE [1-6]\.";
+        error_page 405 =200 $uri;
+
+	default_type application/wasm;
+        location /{ #web demo
+                proxy_set_header Host $host;
+                proxy_set_header X-Real-Ip $remote_addr;
+                proxy_set_header X-Forwarded-For $remote_addr;
+                proxy_set_header X-NginX-Proxy true;
+                root /data1/online/Pc-Web-Demo/build/; # web im static resource storage path
+                index index.html;
+                try_files $uri $uri/ /index.html;
+        }
+        location /msg_gateway { #10001 ws
+                proxy_http_version 1.1;
+                proxy_set_header Upgrade $http_upgrade;
+                proxy_set_header Connection "Upgrade";
+                proxy_set_header X-real-ip $remote_addr;
+                proxy_set_header X-Forwarded-For $remote_addr;
+                proxy_pass http://im_msg_gateway/;
+        }
+        location ^~/api/ { #10002 api
+                proxy_http_version 1.1;
+                proxy_set_header Upgrade $http_upgrade;
+                proxy_set_header Connection "Upgrade";
+                proxy_set_header X-real-ip $remote_addr;
+                proxy_set_header X-Forwarded-For $remote_addr;
+                proxy_pass http://im_api/;
+               }
+        location ^~/grafana/ { #10007  prometheus
+                proxy_http_version 1.1;
+                proxy_set_header Upgrade $http_upgrade;
+                proxy_set_header Connection "Upgrade";
+                proxy_set_header X-real-ip $remote_addr;
+                proxy_set_header X-Forwarded-For $remote_addr;
+                proxy_pass http://im_grafana/;
+               }
+        location ^~/chat/ { #10008 im_chat_api
+                    proxy_http_version 1.1;
+                    proxy_set_header Upgrade $http_upgrade;
+                    proxy_set_header Connection "Upgrade";
+                    proxy_set_header X-real-ip $remote_addr;
+                    proxy_set_header X-Forwarded-For $remote_addr;
+                    proxy_pass http://im_chat_api/;
+                   }
+        location ^~/complete_admin/ { #10009  admin
+                proxy_http_version 1.1;
+                proxy_set_header Upgrade $http_upgrade;
+                proxy_set_header Connection "Upgrade";
+                proxy_set_header X-real-ip $remote_addr;
+                proxy_set_header X-Forwarded-For $remote_addr;
+                proxy_pass http://im_admin_api/;
+               }
+        location ^~/open_rtc/ {  #7880 rtc
+                proxy_http_version 1.1;
+                proxy_set_header Upgrade $http_upgrade;
+                proxy_set_header Connection "Upgrade";
+                proxy_set_header X-real-ip $remote_addr;
+                proxy_set_header X-Forwarded-For $remote_addr;
+                proxy_pass http://im_open_rtc/;
+              }
+}
+
+server {
+        listen 80;
+        server_name test-web.rentsoft.cn ; #1 web im end domain name
+        rewrite ^(.*)$ https://${server_name}$1 permanent;
+}
+
+
+server {
+    listen   443;
+
+    server_name your-domain.com; #your-domain.com
+    ssl on;
+    ssl_certificate /etc/nginx/conf.d/ssl/your-domain.com.crt; #Certificate
+    ssl_certificate_key /etc/nginx/conf.d/ssl/your-domain.com.key;    #Certificate
+    gzip on;
+    gzip_min_length 1k;
+    gzip_buffers 4 16k;
+    gzip_comp_level 2;
+    gzip_types text/plain application/javascript application/x-javascript text/css application/xml text/javascript application/x-httpd-php image/jpeg image/gif image/png application/wasm;
+    gzip_vary off;
+    gzip_disable "MSIE [1-6]\.";
+    # Allow special characters in headers
+    ignore_invalid_headers off;
+    # Allow any size file to be uploaded.
+    # Set to a value such as 1000m; to restrict file size to a specific value
+    client_max_body_size 0;
+    # Disable buffering
+    proxy_buffering off;
+    proxy_request_buffering off;
+
+    location / {
+        proxy_set_header Host $http_host;
+        proxy_set_header X-Real-IP $remote_addr;
+        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+        proxy_set_header X-Forwarded-Proto $scheme;
+
+        proxy_connect_timeout 300;
+        # Default is HTTP/1, keepalive is only enabled in HTTP/1.1
+        proxy_http_version 1.1;
+        proxy_set_header Connection "";
+        chunked_transfer_encoding off;
+
+        proxy_pass http://minio_s3_2; # This uses the upstream directive definition to load balance
+    }
+
+    location /minio/ui {
+        rewrite ^/minio/ui/(.*) /$1 break;
+        proxy_set_header Host $http_host;
+        proxy_set_header X-Real-IP $remote_addr;
+        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+        proxy_set_header X-Forwarded-Proto $scheme;
+        proxy_set_header X-NginX-Proxy true;
+
+        # This is necessary to pass the correct IP to be hashed
+        real_ip_header X-Real-IP;
+
+        proxy_connect_timeout 300;
+
+        # To support websockets in MinIO versions released after January 2023
+        proxy_http_version 1.1;
+        proxy_set_header Upgrade $http_upgrade;
+        proxy_set_header Connection "upgrade";
+
+        chunked_transfer_encoding off;
+
+        proxy_pass http://minio_console_2; # This uses the upstream directive definition to load balance
+    }
+}

config/templates/prometheus.yml.template

@@ -0,0 +1,99 @@
+# 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.
+
+# 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'

config/webhooks.yml

@@ -1,156 +0,0 @@
-url: "webhook://127.0.0.1:10008/callbackExample"
-beforeSendSingleMsg:
-  enable: false
-  timeout: 5
-  failedContinue: true
-beforeUpdateUserInfoEx:
-  enable:  false
-  timeout: 5
-  failedContinue: true
-afterUpdateUserInfoEx:
-  enable:  false
-  timeout: 5
-afterSendSingleMsg:
-  enable: false
-  timeout: 5
-beforeSendGroupMsg:
-  enable: false
-  timeout: 5
-  failedContinue: true
-beforeMsgModify:
-  enable: false
-  timeout: 5
-  failedContinue: true
-afterSendGroupMsg:
-  enable: false
-  timeout: 5
-afterUserOnline:
-  enable: false
-  timeout: 5
-afterUserOffline:
-  enable: false
-  timeout: 5
-afterUserKickOff:
-  enable: false
-  timeout: 5
-beforeOfflinePush:
-  enable: false
-  timeout: 5
-  failedContinue: true
-beforeOnlinePush:
-  enable: false
-  timeout: 5
-  failedContinue: true
-beforeGroupOnlinePush:
-  enable: false
-  timeout: 5
-  failedContinue: true
-beforeAddFriend:
-  enable: false
-  timeout: 5
-  failedContinue: true
-beforeUpdateUserInfo:
-  enable: false
-  timeout: 5
-  failedContinue: true
-afterUpdateUserInfo:
-  enable: false
-  timeout: 5
-beforeCreateGroup:
-  enable: false
-  timeout: 5
-  failedContinue: true
-afterCreateGroup:
-  enable: false
-  timeout: 5
-beforeMemberJoinGroup:
-  enable: false
-  timeout: 5
-  failedContinue: true
-beforeSetGroupMemberInfo:
-  enable: false
-  timeout: 5
-  failedContinue: true
-afterSetGroupMemberInfo:
-  enable: false
-  timeout: 5
-afterQuitGroup:
-  enable: false
-  timeout: 5
-afterKickGroupMember:
-  enable: false
-  timeout: 5
-afterDismissGroup:
-  enable: false
-  timeout: 5
-beforeApplyJoinGroup:
-  enable: false
-  timeout: 5
-  failedContinue: true
-afterGroupMsgRead:
-  enable: false
-  timeout: 5
-afterSingleMsgRead:
-  enable: false
-  timeout: 5
-beforeUserRegister:
-  enable: false
-  timeout: 5
-  failedContinue: true
-afterUserRegister:
-  enable: false
-  timeout: 5
-afterTransferGroupOwner:
-  enable: false
-  timeout: 5
-beforeSetFriendRemark:
-  enable: false
-  timeout: 5
-  failedContinue: true
-afterSetFriendRemark:
-  enable: false
-  timeout: 5
-afterGroupMsgRevoke:
-  enable: false
-  timeout: 5
-afterJoinGroup:
-  enable: false
-  timeout: 5
-beforeInviteUserToGroup:
-  enable: false
-  timeout: 5
-  failedContinue: true
-afterSetGroupInfo:
-  enable: false
-  timeout: 5
-beforeSetGroupInfo:
-  enable: false
-  timeout: 5
-  failedContinue: true
-afterRevokeMsg:
-  enable: false
-  timeout: 5
-beforeAddBlack:
-  enable: false
-  timeout: 5
-  failedContinue:
-afterAddFriend:
-  enable: false
-  timeout: 5
-beforeAddFriendAgree:
-  enable: false
-  timeout: 5
-  failedContinue: true
-afterDeleteFriend:
-  enable: false
-  timeout: 5
-beforeImportFriends:
-  enable: false
-  timeout: 5
-  failedContinue: true
-afterImportFriends:
-  enable: false
-  timeout: 5
-afterRemoveBlack:
-  enable: false
-  timeout: 5

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

@@ -48,17 +48,17 @@ spec:
           image: "{{ .Values.image.repository }}:{{ .Values.image.tag | default .Chart.AppVersion }}"
           imagePullPolicy: {{ .Values.image.pullPolicy }}
           ports:
-            - name: webhook
+            - name: http
               containerPort: 80
               protocol: TCP
           #livenessProbe:
           #  httpGet:
           #    path: /
-          #    port: webhook
+          #    port: http
           #readinessProbe:
           #  httpGet:
           #    path: /
-          #    port: webhook
+          #    port: http
           resources:
             {{- toYaml .Values.resources | nindent 12 }}
           volumeMounts:

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

@@ -22,8 +22,8 @@ spec:
   type: {{ .Values.service.type }}
   ports:
     - port: {{ .Values.service.port }}
-      targetPort: webhook
+      targetPort: http
       protocol: TCP
-      name: webhook
+      name: http
   selector:
     {{- include "openim-api.selectorLabels" . | nindent 4 }}

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

@@ -48,7 +48,7 @@ spec:
           image: "{{ .Values.image.repository }}:{{ .Values.image.tag | default .Chart.AppVersion }}"
           imagePullPolicy: {{ .Values.image.pullPolicy }}
           ports:
-            - name: webhook
+            - name: http
               containerPort: 80
               protocol: TCP
             - name: rpc
@@ -57,11 +57,11 @@ spec:
           #livenessProbe:
           #  httpGet:
           #    path: /
-          #    port: webhook
+          #    port: http
           #readinessProbe:
           #  httpGet:
           #    path: /
-          #    port: webhook
+          #    port: http
           resources:
             {{- toYaml .Values.resources | nindent 12 }}
           volumeMounts:

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

@@ -22,9 +22,9 @@ spec:
   type: {{ .Values.service.type }}
   ports:
     - port: {{ .Values.service.port }}
-      targetPort: webhook
+      targetPort: http
       protocol: TCP
-      name: webhook
+      name: http
     - port: 88
       targetPort: rpc
       protocol: TCP

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

@@ -48,17 +48,17 @@ spec:
           image: "{{ .Values.image.repository }}:{{ .Values.image.tag | default .Chart.AppVersion }}"
           imagePullPolicy: {{ .Values.image.pullPolicy }}
           ports:
-            - name: webhook
+            - name: http
               containerPort: 80
               protocol: TCP
           #livenessProbe:
           #  httpGet:
           #    path: /
-          #    port: webhook
+          #    port: http
           #readinessProbe:
           #  httpGet:
           #    path: /
-          #    port: webhook
+          #    port: http
           resources:
             {{- toYaml .Values.resources | nindent 12 }}
           volumeMounts:

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

@@ -22,8 +22,8 @@ spec:
   type: {{ .Values.service.type }}
   ports:
     - port: {{ .Values.service.port }}
-      targetPort: webhook
+      targetPort: http
       protocol: TCP
-      name: webhook
+      name: http
   selector:
     {{- include "openim-msgtransfer.selectorLabels" . | nindent 4 }}

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

@@ -48,17 +48,17 @@ spec:
           image: "{{ .Values.image.repository }}:{{ .Values.image.tag | default .Chart.AppVersion }}"
           imagePullPolicy: {{ .Values.image.pullPolicy }}
           ports:
-            - name: webhook
+            - name: http
               containerPort: 80
               protocol: TCP
           #livenessProbe:
           #  httpGet:
           #    path: /
-          #    port: webhook
+          #    port: http
           #readinessProbe:
           #  httpGet:
           #    path: /
-          #    port: webhook
+          #    port: http
           resources:
             {{- toYaml .Values.resources | nindent 12 }}
           volumeMounts:

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

@@ -22,8 +22,8 @@ spec:
   type: {{ .Values.service.type }}
   ports:
     - port: {{ .Values.service.port }}
-      targetPort: webhook
+      targetPort: http
       protocol: TCP
-      name: webhook
+      name: http
   selector:
     {{- include "openim-push.selectorLabels" . | nindent 4 }}