feat: add docker compose file

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

.dockerignore

@@ -0,0 +1,31 @@
+# Ignore files and directories starting with a dot
+
+# Ignore specific files
+.dockerignore
+
+# Ignore build artifacts
+_output/
+logs/
+
+# Ignore non-essential documentation
+README.md
+README-zh_CN.md
+CONTRIBUTING.md
+CHANGELOG/
+# LICENSE
+
+# Ignore testing and linting configuration
+.golangci.yml
+
+# Ignore deployment-related files
+docker-compose.yaml
+deployments/
+
+# Ignore assets
+assets/
+
+# Ignore components
+components/
+
+# Ignore tools and scripts
+.github/

.env

@@ -1,4 +1,5 @@
 USER=root
 PASSWORD=openIM123
 MINIO_ENDPOINT=http://127.0.0.1:10005
-DATA_DIR=./
+API_URL=http://127.0.0.1:10002/object/
+DATA_DIR=./

.github/.codecov.yml

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

.github/dependabot.yml

@@ -0,0 +1,59 @@
+# 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.
+
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "gomod"
+    directory: "/"
+    schedule:
+      interval: "daily"
+      time: "08:00"
+    labels:
+      - "dependencies"
+    commit-message:
+      prefix: "feat"
+      include: "scope"
+    groups:
+      gomod-deps:
+        patterns:
+          - "*"
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "daily"
+      time: "08:00"
+    labels:
+      - "dependencies"
+    commit-message:
+      prefix: "chore"
+      include: "scope"
+    groups:
+      github-actions:
+        patterns:
+          - "*"
+  - package-ecosystem: "docker"
+    directory: "/"
+    schedule:
+      interval: "daily"
+      time: "08:00"
+    labels:
+      - "dependencies"
+    commit-message:
+      prefix: "feat"
+      include: "scope"

.github/labels.yml

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

.github/sync.yml

@@ -1,3 +1,17 @@
+# Copyright © 2023 OpenIM. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
 # https://github.com/BetaHuhn/repo-file-sync-action
 # Synchronization for the.github repository
 OpenIMSDK/.github:
@@ -67,6 +81,10 @@ group:
   - repos: |
       OpenIMSDK/OpenKF@main
       OpenIMSDK/openim-miniprogram-demo@main
+      OpenIMSDK/docs
+      OpenIMSDK/chat
+      OpenIMSDK/community
+      OpenIMSDK/openim-charts
       OpenIMSDK/openim-sdk-cpp@main
     files: 
       - source: LICENSE
@@ -80,13 +98,22 @@ group:
         replace: false
       - source: .github/workflows/project-progress.yml
         dest: .github/workflows/project-progress.yml
-        replace: false
+        replace: false 
       - source: .github/workflows/help-comment-issue.yml
         dest: .github/workflows/help-comment-issue.yml
         replace: false
       - source: .github/.codecov.yml
         dest: .github/.codecov.yml
         replace: false
+      - source: .github/workflows/cla.yml
+        dest: .github/workflows/cla.yml
+        replace: false
+      - source: .github/workflows/auto-assign-issue.yml
+        dest: .github/workflows/auto-assign-issue.yml
+        replace: false
+      - source: .github/workflows/release.yml
+        dest: .github/workflows/release.yml
+        replace: false
       - source: ./scripts/githooks/
         dest: ./scripts/githooks/
         replace: true

.github/weekly-digest.yml

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

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

@@ -0,0 +1,43 @@
+# 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: Assign issue to comment author
+on:
+  issue_comment:
+    types: [created]
+jobs:
+  assign-issue:
+    if: |
+      contains(github.event.comment.body, '/assign') || contains(github.event.comment.body, '/accept') &&
+      !contains(github.event.comment.user.login, 'openimbot') &&
+      !contains(github.event.comment.user.login, 'kubbot')
+    runs-on: ubuntu-latest
+    permissions:
+      issues: write
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Assign the issue
+        run: |
+          export LETASE_MILESTONES=$(curl 'https://api.github.com/repos/$OWNER/$PEPO/milestones' | jq -r 'last(.[]).title')
+          gh issue edit ${{ github.event.issue.number }} --add-assignee "${{ github.event.comment.user.login }}"
+          gh issue edit ${{ github.event.issue.number }} --add-label "triage/accepted"
+          gh issue edit ${{ github.event.issue.number }} --milestone "$LETASE_MILESTONES"
+          gh issue comment $ISSUE --body "@${{ github.event.comment.user.login }} Glad to see you accepted this issue🤲, this issue has been assigned to you. I set the milestones for this issue to [$LETASE_MILESTONES](https://github.com/$OWNER/$PEPO/milestones), We are looking forward to your PR!"
+        env:
+          GH_TOKEN: ${{ secrets.REDBOT_GITHUB_TOKEN }}
+          ISSUE: ${{ github.event.issue.html_url }}
+          OWNER: ${{ github.repository_owner }}
+          REPO: ${{ github.event.repository.name }}

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

@@ -0,0 +1,60 @@
+# 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: Auto PR to release
+
+on:
+  pull_request:
+    # types:
+    #   - closed
+  issue_comment:
+    types: [created]
+  pull_request_review_comment:
+    types: [created]
+
+jobs:
+  create-pr:
+    runs-on: ubuntu-latest
+    if: github.event.pull_request.base.ref == 'main' && github.event.pull_request.merged == true
+    steps:
+        - name: Check out code
+          uses: actions/checkout@v3
+          with:
+            fetch-depth: 0
+
+        - name: Create PR to release branch
+          run: |
+            ISSUEID=$(gh pr view ${{ github.event.pull_request.number }} --repo $OWNER/$REPO | grep -oP 'Fixes #\K\d+')
+            echo "===========> $ISSUEID"
+            ISSUE=$(gh issue view $ISSUEID --repo $OWNER/$REPO --json labels,assignees,milestone,title)
+            echo "===========> $ISSUE"
+
+            LABELS=$(echo $ISSUE | jq -r '.labels[] | select(.name) | .name' | jq -R -r -s -c 'split("\n")[:-1] | join(",")')
+            ASSIGNEES=$(echo $ISSUE | jq -r '.assignees[] | select(.login) | .login' | jq -R -s -c 'split("\n")[:-1] | join(",")')
+            MILESTONE=$(echo $ISSUE | jq -r '.milestone | select(.title) | .title')
+            TITLE=$(echo $ISSUE | jq -r '.title')
+
+            gh pr edit ${{ github.event.pull_request.number }} --repo $OWNER/$REPO --add-label "$LABELS" --add-assignee "$ASSIGNEES" --milestone "$MILESTONE"
+
+            # git checkout -b bot/merge-to-release-$ISSUEID
+            # git push origin bot/merge-to-release-$ISSUEID
+            # gh pr create --base release --head bot/merge-to-release-$ISSUEID --title "Merge main to release" --body ""
+            # gh pr create --base main --head feat/auto-release-pr-624  --title "The bug is fixed" --body "$x" --repo OpenIMSDK/Open-IM-Server --reviewer "cubxxw"
+          continue-on-error: true
+          env:
+              GITHUB_TOKEN: ${{ secrets.BOT_GITHUB_TOKEN }}
+              GH_TOKEN: ${{ github.token }}
+              ISSUE: ${{ github.event.issue.html_url }}
+              OWNER: ${{ github.repository_owner }}
+              REPO: ${{ github.event.repository.name }}

.github/workflows/auto-invite.yml

@@ -1,3 +1,17 @@
+# 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: Invite users to join our group
 on:
   issue_comment:
@@ -13,7 +27,7 @@ jobs:
     steps:
 
       - name: Invite user to join our group
-        uses: peter-evans/create-or-update-comment@v1
+        uses: peter-evans/create-or-update-comment@v3
         with:
           token: ${{ secrets.BOT_GITHUB_TOKEN }}
           issue-number: ${{ github.event.issue.number }}

.github/workflows/auto-tag.yml

@@ -0,0 +1,52 @@
+# 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 Tag
+
+on:
+  issue_comment:
+    types: [created]
+  pull_request_review_comment:
+    types: [created]
+
+jobs:
+  create_tag:
+    runs-on: ubuntu-latest
+    if: startsWith(github.event.comment.body, '/create tag')
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Validate version number and get comment
+        id: validate
+        run: |
+          COMMENT="${{ github.event.comment.body }}"
+          VERSION=$(echo $COMMENT | cut -d ' ' -f 3)
+          TAG_COMMENT=$(echo $COMMENT | cut -d '"' -f 2)
+          if [[ $VERSION =~ ^v([0-9]+\.){2}[0-9]+$ ]]; then
+            echo "version=$VERSION" >> $GITHUB_STATE
+            echo "tag_comment=$TAG_COMMENT" >> $GITHUB_STATE
+          else
+            echo "Invalid version number."
+            exit 1
+          fi
+
+      - name: Create a new tag
+        env:
+          GH_TOKEN: ${{ secrets.BOT_GITHUB_TOKEN }}
+        run: |
+          source $GITHUB_STATE
+          git tag -a $VERSION -m "$tag_comment"
+          git push origin $VERSION
+          echo "tag_created=$VERSION" >> $GITHUB_OUTPUT

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

@@ -0,0 +1,67 @@
+# 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: 'Github Rebot for Cherry Pick when PR is merged'
+on:
+  pull_request_target:
+    types:
+      - closed
+
+jobs:
+  comment:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Comment cherry-pick command
+        uses: actions/github-script@v6
+        with:
+          script: |
+            const pr = context.payload.pull_request;
+            if (!pr.merged) {
+              console.log("PR is not merged. Skipping...");
+              return;
+            }
+            if (!pr.milestone || !pr.milestone.title) {
+              console.log("Milestone is not set. Skipping...");
+              return;
+            }
+            const milestone = pr.milestone.title;
+            const ref = `heads/release-${milestone}`;
+            let branchExists;
+            try {
+              await github.rest.git.getRef({
+                owner: context.repo.owner,
+                repo: context.repo.repo,
+                ref: ref
+              });
+              branchExists = true;
+            } catch (error) {
+              if (error.status === 404) {
+                console.log(`Branch ${ref} does not exist. Skipping...`);
+                branchExists = false;
+              } else {
+                throw error; // Rethrow if it's another error
+              }
+            }
+            if (!branchExists) {
+              return;
+            }
+            const cherryPickCmd = `/cherry-pick release-${milestone}`;
+            console.log(`Adding comment: ${cherryPickCmd}`);
+            await github.rest.issues.createComment({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              issue_number: pr.number,
+              body: cherryPickCmd
+            });
+          github-token: ${{ secrets.BOT_GITHUB_TOKEN }}

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

@@ -0,0 +1,33 @@
+# 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: Github Rebot for Cherry Pick On Comment
+on:
+  issue_comment:
+    types: [created]
+jobs:
+  cherry-pick:
+    name: Cherry Pick
+    if: github.event.issue.pull_request != '' && contains(github.event.comment.body, '/cherry-pick') && github.event.comment.user.login=='kubbot'
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout the latest code
+        uses: actions/checkout@v3
+        with:
+          token: ${{ secrets.BOT_GITHUB_TOKEN }}
+          fetch-depth: 0 # otherwise, you will fail to push refs to dest repo
+      - name: Automatic Cherry Pick
+        uses: vendoo/gha-cherry-pick@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.BOT_GITHUB_TOKEN }}

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

@@ -0,0 +1,137 @@
+# 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: Publish Docker image
+
+on:
+  push:
+    branches:
+      - main
+      - release-*
+    tags:
+      - v*
+  workflow_dispatch:
+
+env:
+  # Common versions
+  GO_VERSION: "1.20"
+
+jobs:
+  build-dockerhub:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v2
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v2
+
+# docker.io/openim/openim-server:latest
+      - name: Extract metadata (tags, labels) for Docker
+        id: meta
+        uses: docker/metadata-action@v4.6.0
+        with:
+          images: openim/openim-server
+          # generate Docker tags based on the following events/attributes
+          tags: |
+            type=schedule
+            type=ref,event=branch
+            type=ref,event=pr
+            type=semver,pattern={{version}}
+            type=semver,pattern={{major}}.{{minor}}
+            type=semver,pattern={{major}}
+            type=sha
+
+      - name: Log in to Docker Hub
+        uses: docker/login-action@v2
+        with:
+          username: ${{ secrets.DOCKER_USERNAME }}
+          password: ${{ secrets.DOCKER_PASSWORD }}
+
+      - name: Build and push Docker image
+        uses: docker/build-push-action@v4
+        with:
+          context: .
+          # linux/ppc64le,linux/s390x
+          platforms: linux/amd64,linux/arm64
+          push: ${{ github.event_name != 'pull_request' }}
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+
+  build-aliyun:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v2
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v2
+# registry.cn-hangzhou.aliyuncs.com/openimsdk/openim-server:latest
+      - name: Extract metadata (tags, labels) for Docker
+        id: meta2
+        uses: docker/metadata-action@v4.6.0
+        with:
+          images: registry.cn-hangzhou.aliyuncs.com/openimsdk/openim-server
+
+      - name: Log in to AliYun Docker Hub
+        uses: docker/login-action@v2
+        with:
+          registry: registry.cn-hangzhou.aliyuncs.com
+          username: ${{ secrets.ALIREGISTRY_USERNAME }}
+          password: ${{ secrets.ALIREGISTRY_TOKEN }}
+      
+      - name: Build and push Docker image
+        uses: docker/build-push-action@v4
+        with:
+          context: .
+          # linux/ppc64le,linux/s390x
+          platforms: linux/amd64,linux/arm64
+          push: ${{ github.event_name != 'pull_request' }}
+          tags: ${{ steps.meta2.outputs.tags }}
+          labels: ${{ steps.meta2.outputs.labels }}
+
+  build-ghcr:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v2
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v2
+# ghcr.io/openimsdk/openim-server:latest
+      - name: Extract metadata (tags, labels) for Docker
+        id: meta3
+        uses: docker/metadata-action@v4.6.0
+        with:
+          images: ghcr.io/openimsdk/openim-server
+
+      - name: Log in to GitHub Container Registry
+        uses: docker/login-action@v2
+        with:
+          registry: ghcr.io
+          username: ${{ github.repository_owner }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Build and push Docker image
+        uses: docker/build-push-action@v4
+        with:
+          context: .
+          # linux/ppc64le,linux/s390x
+          platforms: linux/amd64,linux/arm64
+          push: ${{ github.event_name != 'pull_request' }}
+          tags: ${{ steps.meta3.outputs.tags }}
+          labels: ${{ steps.meta3.outputs.labels }}

.github/workflows/check-coverage.yml

@@ -1,45 +1,59 @@
-# name: Check-Coverage
+# 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.
 
-# 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"
+name: Check-Coverage
 
-# jobs:
-#   coverage:
-#     runs-on: ubuntu-20.04
-#     steps:
-#       - name: Checkout
-#         uses: actions/checkout@v3
+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"
 
-#       - name: Setup Golang with cache
-#         uses: magnetikonline/action-golang-cache@v3
-#         with:
-#           go-version: ${{ env.GO_VERSION }}
-#           token: ${{ secrets.BOT_GITHUB_TOKEN }}
+jobs:
+  coverage:
+    runs-on: ubuntu-20.04
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
 
-#       - name: Install Dependencies
-#         run: sudo apt update && sudo apt install -y libgpgme-dev libbtrfs-dev libdevmapper-dev
+      - name: Setup Golang with cache
+        uses: magnetikonline/action-golang-cache@v4
+        with:
+          go-version: ${{ env.GO_VERSION }}
 
-#       - name: Run Cover
-#         run: make cover
+      - name: Install Dependencies
+        run: sudo apt update && sudo apt install -y libgpgme-dev libbtrfs-dev libdevmapper-dev
 
-#       - name: Upload Coverage to Codecov
-#         uses: codecov/codecov-action@v3
+      - name: Run Cover
+        run: make cover
+        continue-on-error: true
+
+      - name: Upload Coverage to Codecov
+        uses: codecov/codecov-action@v3

.github/workflows/cla.yml

@@ -0,0 +1,62 @@
+# 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 CLA Assistant"
+on:
+  issue_comment:
+    types: [created]
+  pull_request_target:
+    types: [opened,closed,synchronize]
+
+# explicitly configure permissions, in case your GITHUB_TOKEN workflow permissions are set to read-only in repository settings
+permissions:
+  actions: write
+  contents: write
+  pull-requests: write
+  statuses: write
+
+env:
+  # Define Open-IM-Server variables here
+  OPEN_IM_SERVER_REMOTE_ORGANIZATION: openim-sigs
+  REMOTE_REPOSITORY: cla
+  OPEN_IM_SERVER_CLA_DOCUMENT: https://github.com/openim-sigs/cla/blob/main/README.md
+  OPEN_IM_SERVER_SIGNATURES_PATH: signatures/${{ github.event.repository.name }}/cla.json
+
+  OPEN_IM_SERVER_ALLOWLIST: kubbot,bot* 
+
+jobs:
+  CLAAssistant:
+    runs-on: ubuntu-latest
+    steps:
+      - name: "CLA Assistant"
+        if: (github.event.comment.body == 'recheck' || github.event.comment.body == 'I have read the CLA Document and I hereby sign the CLA') || github.event_name == 'pull_request_target'
+        uses: contributor-assistant/github-action@v2.3.0
+        env:
+          GITHUB_TOKEN: ${{ secrets.BOT_GITHUB_TOKEN }}
+          PERSONAL_ACCESS_TOKEN: ${{ secrets.REDBOT_GITHUB_TOKEN }}
+        with:
+          path-to-signatures: ${{ env.OPEN_IM_SERVER_SIGNATURES_PATH }}
+          path-to-document: ${{ env.OPEN_IM_SERVER_CLA_DOCUMENT }}
+          branch: 'main'
+          allowlist: ${{ env.OPEN_IM_SERVER_ALLOWLIST }}
+
+          remote-organization-name: ${{ env.OPEN_IM_SERVER_REMOTE_ORGANIZATION }}
+          remote-repository-name: ${{ env.REMOTE_REPOSITORY }}
+
+          create-file-commit-message: '📚 Docs: Creating file for storing ${{ github.event.repository.name }} CLA Signatures'
+          custom-notsigned-prcomment: '💕 Thank you for your contribution and please kindly read and sign our [🎯https://github.com/openim-sigs/cla/blob/main/README.md](https://github.com/openim-sigs/cla/blob/main/README.md). <br> If you wish to sign the CRA, **Please copy and comment on the following sentence:**'
+          custom-pr-sign-comment: 'I have read the CLA Document and I hereby sign the CLA'
+          custom-allsigned-prcomment: '🤖 All Contributors have signed the [${{ github.event.repository.name }} CLA](https://github.com/openim-sigs/cla/blob/main/README.md).<br> The signed information is recorded [🤖here](https://github.com/openim-sigs/cla/tree/main/signatures/${{ github.event.repository.name }}/cla.json)'
+        #   lock-pullrequest-aftermerge: false - if you don't want this bot to automatically lock the pull request after merging (default - true)
+        #   use-dco-flag: true - If you are using DCO instead of CLA

.github/workflows/codeql-analysis.yml

@@ -13,7 +13,7 @@
 # limitations under the License.
 
 
-name: "Code Scanning - Action"
+name: "OpenIM Code Scanning - Action"
 
 on:
   push:
@@ -42,8 +42,8 @@ jobs:
       security-events: write
 
       # only required for workflows in private repositories
-      actions: read
-      contents: read
+      actions: write
+      contents: write
 
     steps:
       - name: Checkout repository
@@ -53,8 +53,8 @@ jobs:
       - name: Initialize CodeQL
         uses: github/codeql-action/init@v2
         # Override language selection by uncommenting this and choosing your languages
-        # with:
-        #   languages: go, javascript, csharp, python, cpp, java, ruby
+        with:
+          languages: go
 
       # Autobuild attempts to build any compiled languages (C/C++, C#, Go, or Java).
       # If this step fails, then you should remove it and run the build manually (see below).
@@ -68,9 +68,9 @@ jobs:
       #    three lines and modify them (or add more) to build your code if your
       #    project uses a compiled language
 
-      #- run: |
-      #     make bootstrap
-      #     make release
+    #   - run: |
+    #       make bootstrap
+    #       make release
 
       - name: Perform CodeQL Analysis
         uses: github/codeql-action/analyze@v2

.github/workflows/create_branch_on_tag.yml

@@ -0,0 +1,76 @@
+# 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'
+
+jobs:
+  create-branch:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Check out code
+      uses: actions/checkout@v3
+      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
+      run: |
+        TAG_NAME=${GITHUB_REF/refs\/tags\//}
+        IFS='.' read -ra VERSION_PARTS <<< "$TAG_NAME"
+        if [[ "${VERSION_PARTS[2]}" = "0" ]]; then
+          BRANCH_NAME="release-v${VERSION_PARTS[0]}.${VERSION_PARTS[1]}"
+          echo "Creating branch $BRANCH_NAME"
+          git checkout -b "$BRANCH_NAME"
+          git push origin "$BRANCH_NAME"
+        fi
+
+    - name: Push Changes
+      uses: stefanzweifel/git-auto-commit-action@v4
+      with:
+        commit_message: "Auto Commit CHANGELOG"
+        branch: release-v${VERSION_PARTS[0]}.${VERSION_PARTS[1]}
+      env:
+        GITHUB_TOKEN: ${{ secrets.BOT_GITHUB_TOKEN }}
+
+    - name: Create and Push CHANGELOG
+      run: |
+        git checkout main
+        TAG_NAME=${GITHUB_REF/refs\/tags\//}
+        IFS='.' read -ra VERSION_PARTS <<< "$TAG_NAME"
+        if [[ "${VERSION_PARTS[2]}" = "0" ]]; then
+          cd CHANGELOG
+          git-chglog --tag-filter-pattern "v${VERSION_PARTS[0]}.${VERSION_PARTS[1]}.*"  -o "CHANGELOG-${VERSION_PARTS[0]}.${VERSION_PARTS[1]}.md"
+          git add "CHANGELOG-${VERSION_PARTS[0]}.${VERSION_PARTS[1]}.md"
+          git commit -m "Update CHANGELOG for $TAG_NAME"
+        fi
+
+    - name: Push Changes
+      uses: stefanzweifel/git-auto-commit-action@v4
+      with:
+        commit_message: "Auto Commit CHANGELOG"
+        branch: main
+      env:
+        GITHUB_TOKEN: ${{ secrets.BOT_GITHUB_TOKEN }}

.github/workflows/deploy.yml

@@ -0,0 +1,73 @@
+# Copyright © 2023 OpenIM open source community. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+name: OpenIM Deploy for dev
+
+on:
+  push:
+    branches:
+      - 'devops' # Only for the dev branch
+      - 'main'
+    paths:
+      - '.github/workflows/*'
+      # - '__test__/**' # dev No immediate testing is required
+      - 'src/**'
+      - 'Dockerfile'
+      - 'docker-compose.yml'
+      - 'bin/*'
+
+jobs:
+  deploy-dev:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: executing remote ssh commands using password
+        uses: appleboy/ssh-action@v1.0.0
+        env:
+            OWNER: ${{ github.repository_owner }}
+            REPO: ${{ github.event.repository.name }}
+        with:
+          host: "${{ secrets.SG_M1_HOST }}, ${{ secrets.SG_N1_HOST }}, ${{ secrets.SG_N2_HOST}}"
+          username: ${{ secrets.SG_USERNAME }}
+          password: ${{ secrets.SG_PASSWORD }}
+          port: ${{ secrets.SG_PORT }}
+          envs: OWNER,REPO
+          script_stop: true
+          script: |
+            mkdir -p /test/openim
+            cd /test/openim
+            pwd;ls -al
+            echo "OWNER: $OWNER"
+            echo "REPO: $REPO"
+            git clone -b develop https://github.com/${OWNER}/${REPO}.git; cd ${REPO}
+            docker compose up -d
+
+
+    #   - name: deploy # Deployment
+    #     run: |
+    #       ssh work@182.92.xxx.xxx "
+    #         # 【Attention】Log in with the 'work' account, manually create /home/work/imooc-lego directory
+    #         # Then git clone https://username:password@github.com/imooc-lego/biz-editor-server.git -b dev (private repository, use GitHub username and password)
+    #         # Remember to delete origin to avoid exposing GitHub password
+    #         cd /home/work/imooc-lego/biz-editor-server;
+    #         git remote add origin https://openimbot:${{secrets.WFP_PASSWORD}}@github.com/OpenIMSDK/open-im-server.git;
+    #         git checkout dev;
+    #         git pull origin dev; # Download the latest code again
+    #         git remote remove origin; # Remove origin to avoid exposing GitHub password
+    #         # Start docker
+    #         docker-compose build editor-server; # Same as the service name in docker-compose.yml
+    #         docker-compose up -d;
+    #       "
+    #   - name: delete ssh key # Delete ssh key
+    #     run: rm -rf ~/.ssh/id_rsa

.github/workflows/depsreview.yaml

@@ -0,0 +1,18 @@
+# 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.
+
+name: Dependency Review
+on: [pull_request]
+
+permissions:
+  contents: read
+
+jobs:
+  dependency-review:
+    runs-on: ubuntu-latest
+    steps:
+      - name: 'Checkout Repository'
+        uses: actions/checkout@v3
+      - name: 'Dependency Review'
+        uses: actions/dependency-review-action@v3

.github/workflows/docker-buildx.yml

@@ -0,0 +1,320 @@
+# 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@v3
+        
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v2
+        
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v2
+        with:
+          install: true
+
+      - name: Cache Docker layers
+        uses: actions/cache@v3
+        with:
+          path: /tmp/.buildx-cache
+          key: ${{ runner.os }}-buildx-${{ github.sha }}
+          restore-keys: |
+            ${{ runner.os }}-buildx-
+
+      - name: Log in to GitHub Container Registry
+        uses: docker/login-action@v2
+        with:
+          registry: ghcr.io
+          username: ${{ github.repository_owner }}
+          password: ${{ secrets.GITHUB_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@v4.6.0
+        with:
+          images: ghcr.io/openimsdk/openim-api
+
+      - name: Build and push Docker image for openim-api
+        uses: docker/build-push-action@v4
+        with:
+          context: .
+          file: ./build/docker/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@v4.6.0
+        with:
+          images: ghcr.io/openimsdk/openim-cmdutils
+
+      - name: Build and push Docker image for openim-cmdutils
+        uses: docker/build-push-action@v4
+        with:
+          context: .
+          file: ./build/docker/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@v4.6.0
+        with:
+          images: ghcr.io/openimsdk/openim-crontask
+
+      - name: Build and push Docker image for openim-crontask
+        uses: docker/build-push-action@v4
+        with:
+          context: .
+          file: ./build/docker/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@v4.6.0
+        with:
+          images: ghcr.io/openimsdk/openim-msggateway
+
+      - name: Build and push Docker image for openim-msggateway
+        uses: docker/build-push-action@v4
+        with:
+          context: .
+          file: ./build/docker/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@v4.6.0
+        with:
+          images: ghcr.io/openimsdk/openim-msgtransfer
+
+      - name: Build and push Docker image for openim-msgtransfer
+        uses: docker/build-push-action@v4
+        with:
+          context: .
+          file: ./build/docker/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@v4.6.0
+        with:
+          images: ghcr.io/openimsdk/openim-push
+
+      - name: Build and push Docker image for openim-push
+        uses: docker/build-push-action@v4
+        with:
+          context: .
+          file: ./build/docker/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@v4.6.0
+        with:
+          images: ghcr.io/openimsdk/openim-rpc-auth
+
+      - name: Build and push Docker image for openim-rpc-auth
+        uses: docker/build-push-action@v4
+        with:
+          context: .
+          file: ./build/docker/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@v4.6.0
+        with:
+          images: ghcr.io/openimsdk/openim-rpc-conversation
+
+      - name: Build and push Docker image for openim-rpc-conversation
+        uses: docker/build-push-action@v4
+        with:
+          context: .
+          file: ./build/docker/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@v4.6.0
+        with:
+          images: ghcr.io/openimsdk/openim-rpc-friend
+
+      - name: Build and push Docker image for openim-rpc-friend
+        uses: docker/build-push-action@v4
+        with:
+          context: .
+          file: ./build/docker/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@v4.6.0
+        with:
+          images: ghcr.io/openimsdk/openim-rpc-group
+
+      - name: Build and push Docker image for openim-rpc-group
+        uses: docker/build-push-action@v4
+        with:
+          context: .
+          file: ./build/docker/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@v4.6.0
+        with:
+          images: ghcr.io/openimsdk/openim-rpc-msg
+
+      - name: Build and push Docker image for openim-rpc-msg
+        uses: docker/build-push-action@v4
+        with:
+          context: .
+          file: ./build/docker/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@v4.6.0
+        with:
+          images: ghcr.io/openimsdk/openim-rpc-third
+
+      - name: Build and push Docker image for openim-rpc-third
+        uses: docker/build-push-action@v4
+        with:
+          context: .
+          file: ./build/docker/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@v4.6.0
+        with:
+          images: ghcr.io/openimsdk/openim-rpc-user
+
+      - name: Build and push Docker image for openim-rpc-user
+        uses: docker/build-push-action@v4
+        with:
+          context: .
+          file: ./build/docker/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,16 @@
+# 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 e2e Test
+

.github/workflows/golangci-lint.yml

@@ -13,12 +13,12 @@
 # limitations under the License.
 
 
-name: OpenKF golangci-lint
+name: OpenIM golangci-lint
 on:
   push:
     branches: [main]
-#   pull_request:
-#     branches: [main]
+  pull_request:
+    branches: [main]
 jobs:
     golangci:
       name: lint
@@ -45,7 +45,7 @@ jobs:
             # args: --timeout=30m --config=/my/path/.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
+            # only-new-issues: true
 
             # Optional:The mode to install golangci-lint. It can be 'binary' or 'goinstall'.
-            install-mode: "goinstall"
+            install-mode: "goinstall"

.github/workflows/gosec.yml

@@ -1,30 +1,45 @@
-# name: Run gosec
+# 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.
 
-# # gosec is a source code security audit tool for the Go language. It performs a static 
-# # analysis of the Go code, looking for potential security problems. The main functions of gosec are:
-# #     1. Find common security vulnerabilities, such as SQL injection, command injection, and cross-site scripting (XSS).
-# #     2. Audit codes according to common security standards and find non-standard codes.
-# #     3. Assist the Go language engineer to write safe and reliable code.
+name: OpenIM Run Gosec
 
-# on:
-#   push:
-#     branches: "*"
-#   pull_request:
-#     branches: "*"
-#     paths-ignore:
-#       - '*.md'
-#       - '*.yml'
-#       - '.github'
+# gosec is a source code security audit tool for the Go language. It performs a static 
+# analysis of the Go code, looking for potential security problems. The main functions of gosec are:
+#     1. Find common security vulnerabilities, such as SQL injection, command injection, and cross-site scripting (XSS).
+#     2. Audit codes according to common security standards and find non-standard codes.
+#     3. Assist the Go language engineer to write safe and reliable code.
+# https://github.com/securego/gosec/
+on:
+  push:
+    branches: "*"
+  pull_request:
+    branches: "*"
+    paths-ignore:
+      - '*.md'
+      - '*.yml'
+      - '.github'
 
-# jobs:
-#   golang-security-action:
-#     runs-on: ubuntu-latest
-#     env:
-#       GO111MODULE: on
-#     steps:
-#       - name: Check out code
-#         uses: actions/checkout@v3
-#       - name: Run Gosec Security Scanner
-#         uses: securego/gosec@master
-#         with:
-#           args: ./...
+jobs:
+  golang-security-action:
+    runs-on: ubuntu-latest
+    env:
+      GO111MODULE: on
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v3
+      - name: Run Gosec Security Scanner
+        uses: securego/gosec@master
+        with:
+          args: ./...
+        continue-on-error: true

.github/workflows/help-comment-issue.yml

@@ -1,3 +1,17 @@
+# Copyright © 2023 OpenIM. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
 name: Good frist issue add comment
 on:
   issues:
@@ -18,4 +32,4 @@ jobs:
           body: |
             This issue is available for anyone to work on. **Make sure to reference this issue in your pull request.** :sparkles: Thank you for your contribution! :sparkles:
             [Join slack 🤖](https://join.slack.com/t/openimsdk/shared_invite/zt-1tmoj26uf-_FDy3dowVHBiGvLk9e5Xkg) to connect and communicate with our developers.
-            If you wish to accept this assignment, please leave a comment in the comments section: `/accept`.🎯
+            If you wish to accept this assignment, please leave a comment in the comments section: `/accept`.🎯

.github/workflows/image.yml

@@ -1,81 +0,0 @@
-name: Build Image
-
-on:
-  push:
-    branches:
-      - main
-    paths:
-      - "**.go"
-      - "!**_test.go"
-      - "build/**"
-    tags:
-      - v*
-
-jobs:
-  release:
-    strategy:
-      matrix:
-        components: [core, swagger]
-    runs-on: ubuntu-20.04
-    steps:
-      - uses: actions/checkout@v3
-        with:
-          fetch-depth: 20
-      - uses: dorny/paths-filter@v2
-        if: ${{ !startsWith(github.ref_name, 'v') }}
-        id: changes
-        with:
-          filters: |
-            go:
-              - '**.go'
-              - 'build/core/Dockerfile'
-            api:
-              - 'openapi/**'
-              - 'build/swagger/build.sh'
-              - 'build/swagger/Dockerfile'
-      - name: Docker meta
-        id: meta
-        uses: docker/metadata-action@v4
-        with:
-          flavor: |
-            latest=false
-          images: |
-            ${{ secrets.DOCKERHUB_USERNAME }}/openimsdk-${{ matrix.components }}
-            registry.cn-hangzhou.aliyuncs.com/${{ secrets.ALIREGISTRY_NAMESPACE }}/openimsdk-${{ matrix.components }}
-          tags: |
-            type=ref,event=branch
-            type=sha,prefix={{branch}}-,enable=${{ github.ref_type == 'branch' }}
-            type=ref,event=tag
-      - name: Login to Docker Hub
-        uses: docker/login-action@v2
-        with:
-          username: ${{ secrets.DOCKERHUB_USERNAME }}
-          password: ${{ secrets.DOCKERHUB_TOKEN }}
-
-      - name: Login to Ali Container Registry
-        uses: docker/login-action@v2
-        with:
-          registry: registry.cn-hangzhou.aliyuncs.com
-          username: ${{ secrets.ALIREGISTRY_USERNAME }}
-          password: ${{ secrets.ALIREGISTRY_TOKEN }}
-
-      - name: Condition
-        id: condition
-        run: |
-          echo "run=${{ startsWith(github.ref_name, 'v') || ((steps.changes.outputs.go == 'true' && (matrix.components == 'core' || matrix.components == 'job')) || (steps.changes.outputs.api == 'true' && matrix.components == 'swagger')) }}" >> $GITHUB_OUTPUT
-
-      - name: Set up QEMU
-        if: ${{ steps.condition.outputs.run == 'true' }}
-        uses: docker/setup-qemu-action@v2
-      - name: Set up Docker Buildx
-        if: ${{ steps.condition.outputs.run == 'true' }}
-        uses: docker/setup-buildx-action@v2
-      - name: Build and push
-        if: ${{ steps.condition.outputs.run == 'true' }}
-        uses: docker/build-push-action@v3
-        with:
-          context: .
-          file: ./build/${{ matrix.components }}/Dockerfile
-          platforms: linux/amd64
-          push: true
-          tags: ${{ steps.meta.outputs.tags }}

.github/workflows/issue-robot.yml

@@ -1,3 +1,17 @@
+# 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: 'issue translator'
 on:
   issue_comment:

.github/workflows/link-pr.yml

@@ -1,3 +1,17 @@
+# 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: Github Rebot for Link check error
 
 # Every Monday at 12:30 p.m
@@ -13,7 +27,7 @@ jobs:
 
       - name: Link Checker
         id: lychee
-        uses: lycheeverse/lychee-action@v1.7.0
+        uses: lycheeverse/lychee-action@v1.8.0
         with:
             # For parameter description, see https://github.com/lycheeverse/lychee#commandline-parameters
             # Actions Link address -> https://github.com/lycheeverse/lychee-action

.github/workflows/lock-issue.yml

@@ -0,0 +1,65 @@
+# 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: 'Lock Threads'
+
+on:
+  schedule:
+    - cron: '0 * * * *'
+  workflow_dispatch:
+
+permissions:
+  issues: write
+  pull-requests: write
+
+concurrency:
+  group: lock
+
+jobs:
+  action:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: dessant/lock-threads@v4
+        with:
+          github-token: ${{ secrets.BOT_GITHUB_TOKEN }}
+          issue-inactive-days: '365'
+          exclude-issue-created-before: ''
+          exclude-issue-created-after: ''
+          exclude-issue-created-between: ''
+          exclude-issue-closed-before: ''
+          exclude-issue-closed-after: ''
+          exclude-issue-closed-between: ''
+          include-any-issue-labels: ''
+          include-all-issue-labels: ''
+          exclude-any-issue-labels: ''
+          add-issue-labels: ''
+          remove-issue-labels: ''
+          issue-comment: ''
+          issue-lock-reason: 'resolved'
+          pr-inactive-days: '365'
+          exclude-pr-created-before: ''
+          exclude-pr-created-after: ''
+          exclude-pr-created-between: ''
+          exclude-pr-closed-before: ''
+          exclude-pr-closed-after: ''
+          exclude-pr-closed-between: ''
+          include-any-pr-labels: ''
+          include-all-pr-labels: ''
+          exclude-any-pr-labels: ''
+          add-pr-labels: ''
+          remove-pr-labels: ''
+          pr-comment: ''
+          pr-lock-reason: 'resolved'
+          process-only: ''
+          log-output: false

.github/workflows/milestone.yml

@@ -0,0 +1,72 @@
+# 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.
+
+# shamelessly copied from https://github.com/sigstore/cosign/blob/main/.github/workflows/milestone.yaml
+
+name: milestone
+
+on:
+  pull_request_target:
+    types: [closed]
+    branches:
+      - main
+
+jobs:
+  milestone:
+    runs-on: ubuntu-latest
+
+    permissions:
+      actions: none
+      checks: none
+      contents: read
+      deployments: none
+      issues: write
+      packages: none
+      pull-requests: write
+      repository-projects: none
+      security-events: none
+      statuses: none
+
+    steps:
+      - uses: actions/github-script@v6 # v6
+        with:
+          script: |
+            if (!context.payload.pull_request.merged) {
+              console.log('PR was not merged, skipping.');
+              return;
+            }
+
+            if (!!context.payload.pull_request.milestone) {
+              console.log('PR has existing milestone, skipping.');
+              return;
+            }
+
+            milestones = await github.rest.issues.listMilestones({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              state: 'open',
+              sort: 'due_on',
+              direction: 'asc'
+            })
+            if (milestones.data.length === 0) {
+              console.log('There are no milestones, skipping.');
+              return;
+            }
+
+            await github.rest.issues.update({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              issue_number: context.payload.pull_request.number,
+              milestone: milestones.data[0].number
+            });

.github/workflows/opencommit.yml

@@ -1,4 +1,18 @@
-name: 'OpenCommit Action'
+# 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 Commit Action'
 
 on:
   push:
@@ -13,7 +27,7 @@ jobs:
     permissions: write-all
     steps:
       - name: Setup Node.js Environment
-        uses: actions/setup-node@v2
+        uses: actions/setup-node@v3
         with:
           node-version: '16'
       - uses: actions/checkout@v3

.github/workflows/openim-ci.yml

@@ -1,152 +0,0 @@
-# Copyright © 2023 OpenIM open source community. All rights reserved.
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-name: OpenIM CI
-
-on: 
-  push:
-    branches:
-        - main
-    paths-ignore:
-        - "docs/**"
-        - "README.md"
-        - "README_zh-CN.md"
-        - "CONTRIBUTING.md"
-  pull_request:
-    branches:
-        - main
-    paths-ignore:
-        - "README.md"
-        - "README_zh-CN.md"
-        - "CONTRIBUTING.md"
-        - "docs/**"
-
-env:
-  GO_VERSION: "1.19"
-  GOLANGCI_VERSION: "v1.50.1"
-
-jobs:
-  openim:
-    name: Test with go ${{ matrix.go_version }} on ${{ matrix.os }}
-    runs-on: ${{ matrix.os }}
-    environment:
-      name: openim
-
-    strategy:
-      matrix:
-        go_version: ["1.18","1.19","1.20"]
-        os: [ubuntu-latest]
-
-    steps:
-      - name: Set up Go ${{ matrix.go_version }}
-        uses: actions/setup-go@v2
-        with:
-          go-version: ${{ matrix.go_version }}
-        id: go
-
-      - name: Check out code into the Go module directory
-        uses: actions/checkout@v2
-
-      - name: Run go modules tidy
-        run: |
-          make tidy
-
-      - name: Run go format
-        run: |
-          make format
-          echo "Run go format successfully"
-
-    #   - name: Generate all necessary files, such as error code files
-    #     run: |
-    #       make generate
-
-    #   - name: Check syntax and styling of go sources
-    #     run: |
-    #       set -e
-    #       make lint
-
-    #   - name: Run unit test and get test coverage
-    #     run: |
-    #       make cover
-
-      - name: Build source code for host platform
-        run: |
-          make multiarch
-          echo "Build source code for host platform successfully"
-
-    #   - name: Collect Test Coverage File
-    #     uses: actions/upload-artifact@v1.0.0
-    #     with:
-    #       name: main-output
-    #       path: _output/tmp/coverage.out
-
-    #   - name: Set up Docker Buildx
-    #     uses: docker/setup-buildx-action@v1
-
-#   lint:
-#       runs-on: ubuntu-20.04
-#       steps:
-#         - name: Checkout
-#           uses: actions/checkout@v3
-#           with:
-#             fetch-depth: 0
-  
-#         - name: Set up Go
-#           uses: actions/setup-go@v3
-#           with:
-#             go-version: ${{ env.GO_VERSION }}
-  
-#         - name: golangci-lint
-#           uses: golangci/golangci-lint-action@v3
-#           with:
-#             version: ${{ env.GOLANGCI_VERSION }}
-
-#   docker-image-tests:
-#     runs-on: ubuntu-20.04
-#     steps:
-#       - name: Checkout
-#         uses: actions/checkout@v3
-#         with:
-#           fetch-depth: 0
-      
-#       - name: Set up Go
-#         uses: actions/setup-go@v3
-#         with:
-#           go-version: ${{ env.GO_VERSION }}
-
-#       - name: Run tests
-#         run: make build
-      
-#       - name: Test docker image
-#         run: |
-#           docker build -t openim:ci-build .
-
-#   goreleaser-test:
-#     runs-on: ubuntu-20.04
-#     steps:
-#       - name: Checkout
-#         uses: actions/checkout@v3
-#         with:
-#           fetch-depth: 0
-
-#       - name: Set up Go
-#         uses: actions/setup-go@v3
-#         with:
-#           go-version: ${{ env.GO_VERSION }}
-
-#       - name: Run GoReleaser
-#         uses: goreleaser/goreleaser-action@v4
-#         with:
-#           version: latest
-#           args: release --clean --skip-publish --snapshot

.github/workflows/openimci.yml

@@ -0,0 +1,176 @@
+# 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 CI Aotu Build and Install
+
+on: 
+  push:
+    branches:
+        - main
+    paths-ignore:
+        - "docs/**"
+        - "README.md"
+        - "README_zh-CN.md"
+        - "CONTRIBUTING.md"
+  pull_request:
+    branches:
+        - main
+    paths-ignore:
+        - "README.md"
+        - "README_zh-CN.md"
+        - "CONTRIBUTING.md"
+        - "docs/**"
+
+env:
+  GO_VERSION: "1.19"
+  GOLANGCI_VERSION: "v1.50.1"
+
+jobs:
+  openim:
+    name: Test with go ${{ matrix.go_version }} on ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    permissions:
+        # Give the default GITHUB_TOKEN write permission to commit and push the changed files back to the repository.
+        contents: write
+    environment:
+      name: openim
+
+    strategy:
+      matrix:
+        go_version: ["1.18","1.19","1.20"]
+        os: [ubuntu-latest]
+
+    steps:
+      - name: Set up Go ${{ matrix.go_version }}
+        uses: actions/setup-go@v4
+        with:
+          go-version: ${{ matrix.go_version }}
+        id: go
+
+      - name: Check out code into the Go module directory
+        uses: actions/checkout@v3
+
+      - name: Install Task
+        uses: arduino/setup-task@v1
+        with:
+          version: 2.x
+
+      - name: Run go modules tidy
+        run: |
+          sudo make tidy
+          sudo make tools.verify.go-gitlint
+          echo "Run go modules tidy successfully" 
+
+      - name: Run go format
+        run: |
+          sudo make format
+          echo "Run go format successfully" 
+        continue-on-error: true
+
+      - name: Generate all necessary files, such as error code files
+        run: |
+          make generate
+          echo "Generate all necessary files successfully" 
+        continue-on-error: true
+
+      - name: Run unit test and get test coverage
+        run: |
+          make cover
+          echo "Run unit test and get test coverage successfully" 
+        continue-on-error: true
+
+      - name: Build source code for host platform
+        run: |
+          sudo make build
+          echo "Build source code for host platform successfully" 
+
+      - name: OpenIM verify copyright
+        run: |
+          sudo make verify-copyright
+          sudo make add-copyright
+          echo "OpenIM verify successfully" 
+        continue-on-error: true
+
+      - name: Clean all build
+        run: |
+          sudo make clean
+          echo "Clean all build successfully" 
+
+      - name: push OpenIM 
+        uses: stefanzweifel/git-auto-commit-action@v4
+        with:
+          commit_message: "cicd: robot automated Change"
+        #   commit_options: '--no-verify --signoff'
+          branch: main
+        #   create_branch: true
+        #   # Optional commit user and author settings
+        #   commit_user_name: kubbot # defaults to "github-actions[bot]"
+        #   commit_user_email: 3293172751ysy@gmail.com # defaults to "41898282+github-actions[bot]@users.noreply.github.com"
+        #   commit_author: Kubbot # defaults to author of the commit that triggered the run
+        continue-on-error: true
+
+      - name: Commit Changes
+        uses: stefanzweifel/git-auto-commit-action@v4
+        with:
+          commit_message: "chore(fmt): robot automated format and lint Change"
+          commit_options: '--no-verify --signoff'
+          branch: main
+        continue-on-error: true
+
+      - name: Set Current Directory
+        id: set_directory
+        run: |
+          echo "::set-output name=directory::$(pwd)"
+        continue-on-error: true
+
+      - name: Collect Test Coverage File
+        id: collect_coverage
+        run: |
+          cd ${{ steps.set_directory.outputs.directory }}
+          make cover
+          echo "::set-output name=coverage_file::./_output/tmp/coverage.out"
+        continue-on-error: true
+
+      - name: Display Test Coverage
+        run: |
+          echo "Test Coverage:"
+          cat ${{ steps.collect_coverage.outputs.coverage_file }}
+        continue-on-error: true
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v2
+        continue-on-error: true
+
+  openim-start:
+    name: Teat OpenIM make install start on ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    environment:
+      name: openim
+    strategy:
+      matrix:
+        go_version: ["1.20"]
+        os: ["ubuntu-latest"]
+    steps:
+      - name: Set up Go ${{ matrix.go_version }}
+        uses: actions/setup-go@v4
+        with:
+          go-version: ${{ matrix.go_version }}
+        id: go
+
+      - name: Check out code into the Go module directory
+        uses: actions/checkout@v3
+
+      - name: Run OpenIM make install start
+        run: |
+          sudo make install

.github/workflows/project-progress.yml

@@ -1,3 +1,17 @@
+# 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.
+
 # GitHub recommends pinning actions to a commit SHA.
 # To get a newer version, you will need to update the SHA.
 # You can also reference a tag or branch, but the action may change without warning.
@@ -17,6 +31,6 @@ jobs:
     steps:
       - uses: alex-page/github-project-automation-plus@v0.8.3
         with:
-          project: OpenIM 2023 Sprint 🔥
+          project: OpenIM-V3.1
           column: In Progress
           repo-token: ${{ secrets.BOT_GITHUB_TOKEN }}

.github/workflows/pull-request.yml

@@ -0,0 +1,114 @@
+# 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: Github Pull Request
+on:
+  push:
+    branches: [main]
+    paths-ignore:
+      - 'README.md'
+      - 'CONTRIBUTING.md'
+      - 'docs/**'
+  pull_request:
+    branches: [main]
+    paths-ignore:
+      - 'README.md'
+      - 'CONTRIBUTING.md'
+      - 'docs/**'
+
+permissions:
+  pull-requests: write
+  contents: write
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: checkout
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: Get League branch Patch
+        run: |
+          git config user.name 'openimbot'
+          git config user.email 'openimsdk@qq.com'
+          git checkout -b cicd/patch-${{ github.event.number }}
+      - uses: actions/setup-node@v3
+      - name: Setup Go
+        uses: actions/setup-go@v4
+      - name: Run go modules tidy
+        run: |
+          sudo make tidy
+          sudo make tools.verify.go-gitlint
+          echo "Run go modules tidy successfully" 
+
+      - name: Run go format
+        run: |
+          sudo make format
+          echo "Run go format successfully" 
+        continue-on-error: true
+
+      - name: Generate all necessary files, such as error code files
+        run: |
+          make generate
+          echo "Generate all necessary files successfully" 
+        continue-on-error: true
+
+      - name: Run unit test and get test coverage
+        run: |
+          make cover
+          echo "Run unit test and get test coverage successfully" 
+        continue-on-error: true
+
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@v2
+        with:
+          languages: go
+
+      - name: Build source code for host platform
+        run: |
+          sudo make build
+          echo "Build source code for host platform successfully" 
+
+      - name: Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@v2
+
+      - name: OpenIM verify copyright
+        run: |
+          sudo make verify-copyright
+          sudo make add-copyright
+          echo "OpenIM verify successfully" 
+        continue-on-error: true
+      
+      - name: Commit code
+        run: |
+            git add .
+    
+      - name: Create Pull Request
+        uses: peter-evans/create-pull-request@v5
+        with:
+          commit-message: "cicd: bump League Patch to cicd/patch-${{ github.event.number }}"
+          title: Bump League Patch to cicd/patch-${{ github.event.number }}
+          body: |
+            Review criteria:
+            
+            - [ ] Disenchanter can connect and issue actions
+            
+            This is an automated PR.
+            <sub>[workflow](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/.github/workflows/pull-request.yml).</sub>
+          base: main
+          branch: cicd/patch-${{ github.event.number }}
+          labels: kind/documentation, area/test, ok-to-test
+          token: ${{ secrets.REDBOT_GITHUB_TOKEN }}

.github/workflows/release.yml

@@ -0,0 +1,78 @@
+# 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
+
+on:
+  push:
+    # run only against tags
+    tags:
+      - '*'
+
+permissions:
+  contents: write
+  packages: write
+  issues: write
+
+jobs:
+  goreleaser:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - run: git fetch --force --tags
+      - uses: actions/setup-go@v4
+        with:
+          go-version: stable
+      # More assembly might be required: Docker logins, GPG, etc. It all depends
+      # on your needs.
+      - uses: goreleaser/goreleaser-action@v4
+        with:
+          # either 'goreleaser' (default) or 'goreleaser-pro':
+          distribution: goreleaser
+          version: latest
+          args: release --clean
+        env:
+          GITHUB_TOKEN: ${{ secrets.BOT_GITHUB_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@v3 # v3
+        with:
+          fetch-depth: 0
+      - uses: arduino/setup-task@e26d8975574116b0097a1161e0fe16ba75d84c1c # v1
+        with:
+          version: 3.x
+          repo-token: ${{ secrets.GITHUB_TOKEN }}
+      - uses: docker/setup-qemu-action@2b82ce82d56a2a04d2637cd93a637ae1b359c0a7 # v2
+      - uses: actions/cache@88522ab9f39a2ea568f7027eddc7d8d8bc9d59c8 # v3
+        with:
+          path: |
+            ./_output/dist/*.deb
+            ./_output/dist/*.rpm
+            ./_output/dist/*.apk
+          key: ${{ github.ref }}
+      - run: task goreleaser:test:${{ matrix.format }}

.github/workflows/scripts-test.yml

@@ -1,3 +1,17 @@
+# Copyright © 2023 OpenIM. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
 name: OpenIM Start Execute Scripts
 
 on: 
@@ -24,46 +38,52 @@ jobs:
 
     steps:
     - name: Checkout code
-      uses: actions/checkout@v2
+      uses: actions/checkout@v3
+
+    - name: Download Docker Compose
+      run: |
+        curl -o docker-compose.yaml https://gist.githubusercontent.com/cubxxw/b1d5cbd2edfa23fee911118aa3e8249e/raw/openim-server.sh
+      shell: bash
 
     - name: Start Docker Compose
       run: |
-        docker-compose stop
-        docker-compose up -d
-        sleep 60
+        sudo docker compose up -d
+        sudo sleep 60
+      continue-on-error: true
 
     - name: Stop all services
       run: |
-        chmod +x ./scripts/stop_all.sh
-        ./scripts/stop_all.sh
+        sudo chmod +x ./scripts/stop_all.sh
+        sudo ./scripts/stop_all.sh
+        sudo cat logs/openIM.log 2>/dev/null
       shell: bash
+      continue-on-error: true
 
     - name: Build all services
       run: |
-        chmod +x ./scripts/build_all_service.sh
-        ./scripts/build_all_service.sh
-        cat logs/openIM.log
+        sudo chmod +x ./scripts/build_all_service.sh
+        sudo ./scripts/build_all_service.sh
+        sudo cat logs/openIM.log 2>/dev/null
       shell: bash
 
     - name: Start all services
       run: |
-        chmod +x ./scripts/start_all.sh
-        ./scripts/start_all.sh
-        cat logs/openIM.log
+        sudo chmod +x ./scripts/start_all.sh
+        sudo ./scripts/start_all.sh
+        sudo cat logs/openIM.log 2>/dev/null
       continue-on-error: true
       shell: bash
 
     - name: Check all services
       run: |
-        chmod +x ./scripts/check_all.sh
-        ./scripts/check_all.sh
-        cat logs/openIM.log
+        sudo chmod +x ./scripts/check_all.sh
+        sudo ./scripts/check_all.sh
+        sudo cat logs/openIM.log 2>/dev/null
       shell: bash
-      continue-on-error: true
 
     - name: Print openIM.log
       run: |
-        cat logs/openIM.log
-        cat logs/openIM.log  >> "$GITHUB_OUTPUT"
+        sudo cat logs/* 2>/dev/null
+        sudo cat logs/* 2>/dev/null >> "$GITHUB_OUTPUT"
       shell: bash
       continue-on-error: true

.github/workflows/stale.yml

@@ -1,3 +1,17 @@
+# Copyright © 2023 OpenIM. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
 # This workflow warns and then closes issues and PRs that have had no activity for a specified amount of time.
 #
 # You can adjust the behavior by modifying this file.
@@ -18,7 +32,7 @@ jobs:
       pull-requests: write
 
     steps:
-    - uses: actions/stale@v5
+    - uses: actions/stale@v8
       with:
         repo-token: ${{ secrets.BOT_GITHUB_TOKEN }}
         days-before-stale: 60

.gitignore

@@ -22,6 +22,7 @@ logs
 .devcontainer
 components
 out-test
+Dockerfile.cross
 
 ### Makefile ###
 tmp/
@@ -163,7 +164,6 @@ go.work
 
 # User-specific stuff
 .idea/
-.idea
 .idea/**/workspace.xml
 .idea/**/tasks.xml
 .idea/**/usage.statistics.xml
@@ -353,7 +353,6 @@ cscope.po.out
 *testsdir
 *testsfile
 *testsfiles
-*test
 *testdir
 *testfile
 *testfiles
@@ -391,3 +390,5 @@ Sessionx.vim
 [._]*.un~
 
 # End of https://www.toptal.com/developers/gitignore/api/go,git,vim,tags,test,emacs,backup,jetbrains
+.idea
+dist/

.golangci.yml

@@ -1,10 +1,27 @@
+# Copyright © 2023 OpenIMSDK 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.
+
+# This file contains all available configuration options
+# with their default values.
+
 # options for analysis running
 run:
   # default concurrency is a available CPU number
   concurrency: 4
 
   # timeout for analysis, e.g. 30s, 5m, default is 1m
-  timeout: 1m
+  timeout: 5m
 
   # exit code when at least one issue was found, default is 1
   issues-exit-code: 1
@@ -12,10 +29,37 @@ run:
   # include test files or not, default is true
   tests: true
 
+  # list of build tags, all linters use it. Default is empty list.
+  build-tags:
+    - mytag
+
+  # which dirs to skip: issues from them won't be reported;
+  # can use regexp here: generated.*, regexp is applied on full path;
+  # default value is empty list, but default dirs are skipped independently
+  # from this option's value (see skip-dirs-use-default).
+  # "/" will be replaced by current OS file path separator to properly work
+  # on Windows.
+  skip-dirs:
+    - util
+    - .*~
+    - api/swagger/docs
+    - server/docs
+
   # default is true. Enables skipping of directories:
   #   vendor$, third_party$, testdata$, examples$, Godeps$, builtin$
   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
+  # no need to include all autogenerated files, we confidently recognize
+  # 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
+    - ".*\\.pb\\.go"
+
   # 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
   # automatic updating of go.mod described above. Instead, it fails when any changes
@@ -30,6 +74,7 @@ run:
   # If false (default) - golangci-lint acquires file lock on start.
   allow-parallel-runners: true
 
+
 # output configuration options
 output:
   # colored-line-number|line-number|json|tab|checkstyle|code-climate, default is "colored-line-number"
@@ -44,15 +89,32 @@ output:
   # make issues output unique by line, default is true
   uniq-by-line: true
 
+  # add a prefix to the output file references; default is no prefix
+  path-prefix: ""
+
+  # sorts results by: filepath, line and column
+  sort-results: true
 
 # all available settings of specific linters
 linters-settings:
+  bidichk:
+    # The following configurations check for all mentioned invisible unicode
+    # runes. It can be omitted because all runes are enabled by default.
+    left-to-right-embedding: true
+    right-to-left-embedding: true
+    pop-directional-formatting: true
+    left-to-right-override: true
+    right-to-left-override: true
+    left-to-right-isolate: true
+    right-to-left-isolate: true
+    first-strong-isolate: true
+    pop-directional-isolate: true
   dogsled:
     # checks assignments with too many blank identifiers; default is 2
     max-blank-identifiers: 2
   dupl:
     # tokens count to trigger issue, 150 by default
-    threshold: 100
+    threshold: 200
   errcheck:
     # report about not checking of errors in type assertions: `a := b.(MyStruct)`;
     # default is false: such cases aren't reported by default.
@@ -62,47 +124,217 @@ linters-settings:
     # default is false: such cases aren't reported by default.
     check-blank: false
 
+    # [deprecated] comma-separated list of pairs of the form pkg:regex
+    # the regex is used to ignore names within pkg. (default "fmt:.*").
+    # see https://github.com/kisielk/errcheck#the-deprecated-method for details
+    #ignore: GenMarkdownTree,os:.*,BindPFlags,WriteTo,Help
+    #ignore: (os\.)?std(out|err)\..*|.*Close|.*Flush|os\.Remove(All)?|.*print(f|ln)?|os\.(Un)?Setenv
+
     # path to a file containing a list of functions to exclude from checking
     # see https://github.com/kisielk/errcheck#excluding-functions for details
     #exclude: errcheck.txt
+    
+  errorlint:
+    # Check whether fmt.Errorf uses the %w verb for formatting errors. See the readme for caveats
+    errorf: true
+    # Check for plain type assertions and type switches
+    asserts: true
+    # Check for plain error comparisons
+    comparison: true
+
   exhaustive:
+    # check switch statements in generated files also
+    check-generated: false
     # indicates that switch statements are to be considered exhaustive if a
     # 'default' case is present, even if all enum members aren't listed in the
     # switch
     default-signifies-exhaustive: false
+    # enum members matching the supplied regex do not have to be listed in
+    # switch statements to satisfy exhaustiveness
+    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:
+  #   # Forbid the following identifiers (identifiers are written using regexp):
+  #   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: 150
-    statements: 40
+    statements: 50
+  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/OpenKF
   gocognit:
     # minimal code complexity to report, 30 by default (but we recommend 10-20)
     min-complexity: 30
-  nestif:
-    # minimal complexity of if statements to report, 5 by default
-    min-complexity: 4
   goconst:
     # minimal length of string constant, 3 by default
-    min-len: 5
+    min-len: 3
     # minimal occurrences count to trigger, 3 by default
-    min-occurrences: 5
+    min-occurrences: 3
+    # ignore test files, false by default
+    ignore-tests: false
+    # look for existing constants matching the values, true by default
+    match-constant: true
+    # search also for duplicated numbers, false by default
+    numbers: false
+    # minimum value, only works with goconst.numbers, 3 by default
+    min: 3
+    # maximum value, only works with goconst.numbers, 3 by default
+    max: 3
+    # ignore when constant is not used as function argument, true by default
+    ignore-calls: true
+
+  gocritic:
+    # Which checks should be enabled; can't be combined with 'disabled-checks';
+    # See https://go-critic.github.io/overview#checks-overview
+    # To check which checks are enabled run `GL_DEBUG=gocritic golangci-lint run`
+    # 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
+    disabled-checks:
+      - regexpMust
+      - ifElseChain
+      #- exitAfterDefer
+
+    # Enable multiple checks by tags, run `GL_DEBUG=gocritic golangci-lint run` to see all tags and checks.
+    # Empty list by default. See https://github.com/go-critic/go-critic#usage -> section "Tags".
+    enabled-tags:
+      - performance
+    disabled-tags:
+      - experimental
+
+    # Settings passed to gocritic.
+    # The settings key is the name of a supported gocritic checker.
+    # The list of supported checkers can be find in https://go-critic.github.io/overview.
+    settings:
+      captLocal: # must be valid enabled check name
+        # whether to restrict checker to params only (default true)
+        paramsOnly: true
+      elseif:
+        # whether to skip balanced if-else pairs (default true)
+        skipBalanced: true
+      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
+        # whether to check test functions (default true)
+        skipTestFuncs: true
+      rangeValCopy:
+        # size in bytes that makes the warning trigger (default 128)
+        sizeThreshold: 32
+        # whether to check test functions (default true)
+        skipTestFuncs: true
+      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
+  cyclop:
+    # the maximal code complexity to report
+    max-complexity: 50
+    # the maximal average package complexity. If it's higher than 0.0 (float) the check is enabled (default 0.0)
+    package-average: 0.0
+    # should ignore tests (default false)
+    skip-tests: false
   godot:
-    # check all top-level comments, not only declarations
-    check-all: false
+    # comments to be checked: `declarations`, `toplevel`, or `all`
+    scope: declarations
+    # list of regexps for excluding particular comment lines from check
+    exclude:
+      # example: exclude comments which contain numbers
+      # - '[0-9]+'
+    # check that each sentence starts with a capital letter
+    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
     keywords: # default keywords are TODO, BUG, and FIXME, these can be overwritten by this setting
+      #- TODO
+      - BUG
+      - FIXME
+      #- NOTE
       - OPTIMIZE # marks code that should be optimized before merging
       - HACK # marks hack-arounds that should be removed before merging
   gofmt:
     # simplify code: gofmt with `-s` option, true by default
     simplify: true
+
+  gofumpt:
+    # Select the Go version to target. The default is `1.18`.
+    lang-version: "1.20"
+
+    # Choose whether or not to use the extra rules that are disabled
+    # by default
+    extra-rules: false
+
+  goheader:
+    values:
+      const:
+        # define here const type values in format k:v, for example:
+        # COMPANY: MY COMPANY
+      regexp:
+        # define here regexp type values, for example
+        # AUTHOR: .*@mycompany\.com
+    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.
+      #
+      # {{ AUTHOR }} {{ COMPANY }} {{ YEAR }}
+      # SPDX-License-Identifier: Apache-2.0
+
+      # 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.
+    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/org/project
+    local-prefixes: github.com/OpenIMSDK/OpenKF
   golint:
     # minimal confidence for issues, default is 0.8
     min-confidence: 0.9
@@ -111,16 +343,91 @@ linters-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
+    # List of allowed `replace` directives. Default is empty.
+    replace-allow-list:
+      - google.golang.org/grpc
+
+    # Allow to not explain why the version has been retracted in the `retract` directives. Default is false.
+    retract-allow-no-explanation: false
+    # Forbid the use of the `exclude` directives. Default is false.
+    exclude-forbidden: false
   gomodguard:
     allowed:
-      modules:                                                        # List of allowed modules
+      modules:    
+        - gorm.io/gen                                                    # List of allowed modules
+        - gorm.io/gorm
+        - gorm.io/driver/mysql
+        - k8s.io/klog
         # - gopkg.in/yaml.v2
       domains:                                                        # List of allowed module domains
-        # - golang.org
+        - google.golang.org
+        - gopkg.in
+        - golang.org
+        - github.com
+        - go.uber.org
+        - go.etcd.io
+    blocked:
+      versions:
+        - github.com/MakeNowJust/heredoc:
+            version: "> 2.0.9"
+            reason: "use the latest version"
+      local_replace_directives: false     # Set to true to raise lint issues for packages that are loaded from a local path via replace directive
+
+  gosec:
+    # To select a subset of rules to run.
+    # Available rules: https://github.com/securego/gosec#available-rules
+    includes:
+      - G401
+      - G306
+      - G101
+    # To specify a set of rules to explicitly exclude.
+    # Available rules: https://github.com/securego/gosec#available-rules
+    excludes:
+      - G204
+    # Exclude generated files
+    exclude-generated: true
+    # Filter out the issues with a lower severity than the given value. Valid options are: low, medium, high.
+    severity: "low"
+    # Filter out the issues with a lower confidence than the given value. Valid options are: low, medium, high.
+    confidence: "low"
+    # To specify the configuration of rules.
+    # The configuration of rules is not fully documented by gosec:
+    # https://github.com/securego/gosec#configuration
+    # https://github.com/securego/gosec/blob/569328eade2ccbad4ce2d0f21ee158ab5356a5cf/rules/rulelist.go#L60-L102
+    config:
+      G306: "0600"
+      G101:
+        pattern: "(?i)example"
+        ignore_entropy: false
+        entropy_threshold: "80.0"
+        per_char_threshold: "3.0"
+        truncate: "32"
+
+  gosimple:
+    # Select the Go version to target. The default is '1.13'.
+    go: "1.20"
+    # https://staticcheck.io/docs/options#checks
+    checks: [ "all" ]
+
   govet:
     # report about shadowed variables
     check-shadowing: true
 
+    # settings per analyzer
+    settings:
+      printf: # analyzer name, run `go tool vet help` to see all analyzers
+        funcs: # run `go tool vet help printf` to see available settings for `printf` analyzer
+          - (github.com/golangci/golangci-lint/pkg/logutils.Log).Infof
+          - (github.com/golangci/golangci-lint/pkg/logutils.Log).Warnf
+          - (github.com/golangci/golangci-lint/pkg/logutils.Log).Errorf
+          - (github.com/golangci/golangci-lint/pkg/logutils.Log).Fatalf
+
     # enable or disable analyzers by name
     enable:
       - atomicalign
@@ -128,17 +435,69 @@ linters-settings:
     disable:
       - shadow
     disable-all: false
-  depguard:
-    list-type: blacklist
-    include-go-root: false
-    packages:
-    packages-with-error-message:
+  # 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"
+  ifshort:
+    # Maximum length of variable declaration measured in number of lines, after which linter won't suggest using short syntax.
+    # Has higher priority than max-decl-chars.
+    max-decl-lines: 1
+    # Maximum length of variable declaration measured in number of characters, after which linter won't suggest using short syntax.
+    max-decl-chars: 30
+
+  importas:
+    # if set to `true`, force to use alias.
+    no-unaliased: true
+    # List of aliases
+    alias:
+      # using `servingv1` alias for `knative.dev/serving/pkg/apis/serving/v1` package
+      - pkg: knative.dev/serving/pkg/apis/serving/v1
+        alias: servingv1
+      # using `autoscalingv1alpha1` alias for `knative.dev/serving/pkg/apis/autoscaling/v1alpha1` package
+      - pkg: knative.dev/serving/pkg/apis/autoscaling/v1alpha1
+        alias: autoscalingv1alpha1
+      # You can specify the package path by regular expression,
+      # and alias by regular expression expansion syntax like below.
+      # 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.
+    # Both settings are lists of the keywords and regular expressions matched to interface or package names.
+    # keywords:
+    # - `empty` for `interface{}`
+    # - `error` for errors
+    # - `stdlib` for standard library
+    # - `anon` for anonymous interfaces
+
+    # By default, it allows using errors, empty interfaces, anonymous interfaces,
+    # and interfaces provided by the standard library.
+    allow:
+    - anon
+    - error
+    - empty
+    - stdlib
+    # You can specify idiomatic endings for interface
+    - (or|er)$
+
+    # Reject patterns
+    reject:
+    - github.com\/user\/package\/v4\.Type
+
   lll:
     # max line length, lines longer will be reported. Default is 120.
     # '\t' is counted as 1 character by default, and can be changed with the tab-width option
-    line-length: 120
+    line-length: 240
     # tab width in spaces. Default to 1.
-    tab-width: 1
+    tab-width: 4
   maligned:
     # print struct with more effective memory layout or not, false by default
     suggest-new: true
@@ -152,6 +511,37 @@ linters-settings:
   nakedret:
     # make an issue if func has more lines of code than this setting and it has naked returns; default is 30
     max-func-lines: 30
+
+  nestif:
+    # minimal complexity of if statements to report, 5 by default
+    min-complexity: 4
+
+  nilnil:
+    # By default, nilnil checks all returned types below.
+    checked-types:
+      - ptr
+      - func
+      - iface
+      - map
+      - chan
+
+  nlreturn:
+    # size of the block (including return statement that is still "OK")
+    # so no return split required.
+    block-size: 1
+
+  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.
+    require-explanation: false
+    # Enable to require nolint directives to mention the specific linter being suppressed. Default is false.
+    require-specific: true
+
   prealloc:
     # XXX: we don't recommend using this linter before doing performance profiling.
     # For most programs usage of prealloc will be a premature optimization.
@@ -161,17 +551,97 @@ linters-settings:
     simple: true
     range-loops: true # Report preallocation suggestions on range loops, true by default
     for-loops: false # Report preallocation suggestions on for loops, false by default
-  nolintlint:
-    # Enable to ensure that nolint directives are all used. 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.
-    require-explanation: true
-    # Enable to require nolint directives to mention the specific linter being suppressed. Default is false.
-    require-specific: true
+
+  promlinter:
+    # Promlinter cannot infer all metrics name in static analysis.
+    # Enable strict mode will also include the errors caused by failing to parse the args.
+    strict: false
+    # Please refer to https://github.com/yeya24/promlinter#usage for detailed usage.
+    disabled-linters:
+    #  - "Help"
+    #  - "MetricUnits"
+    #  - "Counter"
+    #  - "HistogramSummaryReserved"
+    #  - "MetricTypeInName"
+    #  - "ReservedChars"
+    #  - "CamelCase"
+    #  - "lintUnitAbbreviations"
+    
+  predeclared:
+    # comma-separated list of predeclared identifiers to not report on
+    ignore: ""
+    # include method names and field names (i.e., qualified names) in checks
+    q: false
+  rowserrcheck:
+    packages:
+      - github.com/jmoiron/sqlx
+  revive:
+    # see https://github.com/mgechev/revive#available-rules for details.
+    ignore-generated-header: true
+    severity: warning
+    rules:
+      - name: indent-error-flow
+        severity: warning
+  staticcheck:
+    # Select the Go version to target. The default is '1.13'.
+    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.16"
+
+    # https://staticcheck.io/docs/options#checks
+    checks: [ "all", "-ST1000", "-ST1003", "-ST1016", "-ST1020", "-ST1021", "-ST1022" ]
+    # https://staticcheck.io/docs/options#dot_import_whitelist
+    dot-import-whitelist:
+      - fmt
+    # https://staticcheck.io/docs/options#initialisms
+    initialisms: [ "ACL", "API", "ASCII", "CPU", "CSS", "DNS", "EOF", "GUID", "HTML", "HTTP", "HTTPS", "ID", "IP", "JSON", "QPS", "RAM", "RPC", "SLA", "SMTP", "SQL", "SSH", "TCP", "TLS", "TTL", "UDP", "UI", "GID", "UID", "UUID", "URI", "URL", "UTF8", "VM", "XML", "XMPP", "XSRF", "XSS" ]
+    # 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:
+      # use the struct field name to check the name of the struct tag
+      use-field-name: true
+      rules:
+        # any struct tag type can be used.
+        # support string case: `camel`, `pascal`, `kebab`, `snake`, `goCamel`, `goPascal`, `goKebab`, `goSnake`, `upper`, `lower`
+        json: camel
+        yaml: camel
+        xml: camel
+        bson: camel
+        avro: snake
+        mapstructure: kebab
+
+  testpackage:
+    # regexp pattern to skip files
+    skip-regexp: (id|export|internal)_test\.go
+  thelper:
+    # The following configurations enable all checks. It can be omitted because all checks are enabled by default.
+    # You can enable only required checks deleting unnecessary checks.
+    test:
+      first: true
+      name: true
+      begin: true
+    benchmark:
+      first: true
+      name: true
+      begin: true
+    tb:
+      first: true
+      name: true
+      begin: true
+
+  tenv:
+    # The option `all` will run against whole test files (`_test.go`) regardless of method/function signatures.
+    # By default, only methods that take `*testing.T`, `*testing.B`, and `testing.TB` as arguments are checked.
+    all: false
+
   unparam:
     # Inspect exported functions, default is false. Set to true if no external program/library imports your code.
     # XXX: if you enable this setting, unparam will report a lot of false-positives in text editors:
@@ -187,6 +657,24 @@ linters-settings:
   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
+
+  wrapcheck:
+    # An array of strings that specify substrings of signatures to ignore.
+    # If this set, it will override the default set of ignored signatures.
+    # See https://github.com/tomarrell/wrapcheck#configuration for more information.
+    ignoreSigs:
+      - .Errorf(
+      - errors.New(
+      - errors.Unwrap(
+      - .Wrap(
+      - .Wrapf(
+      - .WithMessage(
+      - .WithMessagef(
+      - .WithStack(
+    ignorePackageGlobs:
+        - encoding/*
+        - github.com/pkg/*
+
   wsl:
     # If true append is only allowed to be cuddled if appending value is
     # matching variables, fields or types on line above. Default is true.
@@ -194,6 +682,8 @@ linters-settings:
     # Allow calls and assignments to be cuddled as long as the lines have any
     # matching variables, fields or types. Default is true.
     allow-assign-and-call: true
+    # Allow assignments to be cuddled with anything. Default is false.
+    allow-assign-and-anything: false
     # Allow multiline assignments to be cuddled. Default is true.
     allow-multiline-assign: true
     # Allow declarations (var) to be cuddled.
@@ -206,65 +696,181 @@ linters-settings:
     force-err-cuddling: false
     # Allow leading comments to be separated with empty liens
     allow-separated-leading-comment: false
+  makezero:
+    # 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:
+    # Each custom linter should have a unique name.
+    #example:
+      # The path to the plugin *.so. Can be absolute or local. Required for each custom linter
+      #path: /path/to/example.so
+      # The description of the linter. Optional, just for documentation purposes.
+      #description: This is an example usage of a plugin linter.
+      # Intended to point to the repo location of the linter. Optional, just for documentation purposes.
+      #original-url: github.com/golangci/example-linter
 
 linters:
   # please, do not use `enable-all`: it's deprecated and will be removed soon.
   # inverted configuration with `enable-all` and `disable` is not scalable during updates of golangci-lint
+  # enable-all: true
   disable-all: true
   enable:
+    - typecheck
+    - asciicheck
     - bodyclose
+    - cyclop
     - deadcode
-    - depguard
+    # - depguard
     - dogsled
     - dupl
+    - durationcheck
     - errcheck
+    - errorlint
+    - exhaustive
+    - exportloopref
+    # - forbidigo
     - funlen
-    - gochecknoinits
+    # - gci
+    # - gochecknoinits
+    - gocognit
     - goconst
-    - gocritic
     - gocyclo
+    - godot
+    - godox
     - gofmt
+    - gofumpt
+    - goheader
     - goimports
-    - golint
+    - gomoddirectives
+    - gomodguard
     - goprintffuncname
     - gosec
     - gosimple
     - govet
+    - ifshort
+    - importas
     - ineffassign
-    - interfacer
     - lll
+    - makezero
     - misspell
     - nakedret
+    - nestif
+    - nilerr
+    - nlreturn
+    - noctx
     - nolintlint
+    - paralleltest
+    - prealloc
+    - predeclared
+    - promlinter
+    - revive
     - rowserrcheck
-    - scopelint
+    - sqlclosecheck
     - staticcheck
     - structcheck
     - stylecheck
-    - typecheck
+    - thelper
+    - tparallel
     - unconvert
     - unparam
     - unused
     - varcheck
+    - wastedassign
     - whitespace
-    - asciicheck
-    - gocognit
-    - godot
-    - godox
-    - maligned
-    - nestif
-    - prealloc
-    - gomodguard
-  # don't enable:
-      #- goerr113
-      #- wsl
-      #- testpackage
-      #- exhaustive (TODO: enable after next release; current release at time of writing is v1.27)
-      #- gochecknoglobals
-      #- gomnd
+    - bidichk
+    - wastedassign
+    - golint
+    - execinquery
+    - nosprintfhostport
+    - grouper
+    - decorder
+    - errchkjson
+    - maintidx
+      #- containedctx
+      #- tagliatelle
+      #- nonamedreturns
+      #- nilnil
+      #- tenv
+      #- varnamelen
+      #- contextcheck
+      #- errname
+      #- ForceTypeAssert
+      #- nilassign
+  fast: false
 
 issues:
+  # List of regexps of issue texts to exclude, empty list by default.
+  # But independently from this option we use default exclude patterns,
+  # it can be disabled by `exclude-use-default: false`. To list all
+  # excluded by default patterns execute `golangci-lint run --help`
+  exclude:
+    - tools/.*
+    - test/.*
+    - third_party/.*
+
   # Excluding configuration per-path, per-linter, per-text and per-source
+  exclude-rules:
+    - linters:
+      - golint
+      path: (internal/api/.*)\.go # exclude golint for internal/api/... files
+
+    - linters:
+      - revive
+      path: (log/.*)\.go
+
+    - linters:
+      - wrapcheck
+      path: (cmd/.*|pkg/.*)\.go
+
+    - linters:
+      - typecheck
+        #path: (pkg/storage/.*)\.go
+      path: (internal/.*|pkg/.*)\.go
+
+    - path: (cmd/.*|test/.*|tools/.*|internal/pump/pumps/.*)\.go
+      linters:
+        - forbidigo
+
+    - path: (cmd/[a-z]*/.*|store/.*)\.go
+      linters:
+        - dupl
+
+    - linters:
+        - gocritic
+      text: (hugeParam:|rangeValCopy:)
+
+    - path: (cmd/[a-z]*/.*)\.go
+      linters:
+        - lll
+
+    - path: (validator/.*|code/.*|validator/.*|watcher/watcher/.*)
+      linters:
+        - gochecknoinits
+
+    - path: (internal/.*/options|internal/pump|pkg/log/options.go|internal/authzserver|tools/)
+      linters:
+        - tagliatelle
+
+    - path: (pkg/app/.*)\.go
+      linters:
+        - deadcode
+        - unused
+        - varcheck
+        - forbidigo
+
+    # Exclude some staticcheck messages
+    - linters:
+        - staticcheck
+      text: "SA9003:"
+
+    # Exclude lll issues for long lines with go:generate
+    - linters:
+        - lll
+      source: "^//go:generate "
 
   # Independently from option `exclude` we use default exclude patterns,
   # it can be disabled by this option. To list all
@@ -300,24 +906,27 @@ issues:
   # Show only new issues created in git patch with set file path.
   #new-from-patch: path/to/patch/file
 
+  # Fix found issues (if it's supported by the linter)
+  fix: true
+
 severity:
   # Default value is empty string.
-  # Set the default severity for issues. If severity rules are defined and the issues 
-  # do not match or no severity is provided to the rule this will be the default 
-  # severity applied. Severities should match the supported severity names of the 
+  # Set the default severity for issues. If severity rules are defined and the issues
+  # do not match or no severity is provided to the rule this will be the default
+  # severity applied. Severities should match the supported severity names of the
   # selected out format.
   # - Code climate: https://docs.codeclimate.com/docs/issues#issue-severity
   # -   Checkstyle: https://checkstyle.sourceforge.io/property_types.html#severity
   # -       Github: https://help.github.com/en/actions/reference/workflow-commands-for-github-actions#setting-an-error-message
   default-severity: error
 
-  # The default value is false. 
+  # The default value is false.
   # If set to true severity-rules regular expressions become case sensitive.
   case-sensitive: false
 
   # Default value is empty list.
   # When a list of severity rules are provided, severity information will be added to lint
-  # issues. Severity rules have the same filtering capability as exclude rules except you 
+  # issues. Severity rules have the same filtering capability as exclude rules except you
   # are allowed to specify one matcher per severity rule.
   # Only affects out formats that support setting severity information.
   rules:

.goreleaser.yaml

@@ -0,0 +1,531 @@
+# This is an example .goreleaser.yml file with some sensible defaults.
+# Make sure to check the documentation at https://goreleaser.com
+
+before:
+  hooks:
+    # You may remove this if you don't use go modules.
+    - make tidy
+    - make copyright.add
+    # you may remove this if you don't need go generate
+    - go generate ./...
+
+snapshot:
+  name_template: "{{ incpatch .Version }}-next"
+
+# gomod:
+#   proxy: true
+
+report_sizes: true
+
+# metadata:
+#   mod_timestamp: "{{ .CommitTimestamp }}"
+
+builds:
+  - binary: openim-api
+    id: openim-api
+    main: ./cmd/openim-api/main.go
+    goos:
+      - darwin
+      - windows
+      - linux
+    goarch:
+      - s390x
+      - mips64
+      - mips64le
+      - amd64
+      - ppc64le
+      - arm64
+    goarm:
+      - "6"
+      - "7"
+
+  - binary: openim-cmdutils
+    id: openim-cmdutils
+    main: ./cmd/openim-cmdutils/main.go
+    goos:
+      - darwin
+      - windows
+      - linux
+    goarch:
+      - s390x
+      - mips64
+      - mips64le
+      - amd64
+      - ppc64le
+      - arm64
+    goarm:
+      - "6"
+      - "7"
+
+  - binary: openim-crontask
+    id: openim-crontask
+    main: ./cmd/openim-crontask/main.go
+    goos:
+      - darwin
+      - windows
+      - linux
+    goarch:
+      - s390x
+      - mips64
+      - mips64le
+      - amd64
+      - ppc64le
+      - arm64
+    goarm:
+      - "6"
+      - "7"
+
+  - binary: openim-msggateway
+    id: openim-msggateway
+    main: ./cmd/openim-msggateway/main.go
+    goos:
+      - darwin
+      - windows
+      - linux
+    goarch:
+      - s390x
+      - mips64
+      - mips64le
+      - amd64
+      - ppc64le
+      - arm64
+    goarm:
+      - "6"
+      - "7"
+
+  - binary: openim-msgtransfer
+    id: openim-msgtransfer
+    main: ./cmd/openim-msgtransfer/main.go
+    goos:
+      - darwin
+      - windows
+      - linux
+    goarch:
+      - s390x
+      - mips64
+      - mips64le
+      - amd64
+      - ppc64le
+      - arm64
+    goarm:
+      - "6"
+      - "7"
+
+  - binary: openim-push
+    id: openim-push
+    main: ./cmd/openim-push/main.go
+    goos:
+      - darwin
+      - windows
+      - linux
+    goarch:
+      - s390x
+      - mips64
+      - mips64le
+      - amd64
+      - ppc64le
+      - arm64
+    goarm:
+      - "6"
+      - "7"
+
+  - binary: openim-rpc-auth
+    id: openim-rpc-auth
+    main: ./cmd/openim-rpc/openim-rpc-auth/main.go
+    goos:
+      - darwin
+      - windows
+      - linux
+    goarch:
+      - s390x
+      - mips64
+      - mips64le
+      - amd64
+      - ppc64le
+      - arm64
+    goarm:
+      - "6"
+      - "7"
+
+  - binary: openim-rpc-conversation
+    id: openim-rpc-conversation
+    main: ./cmd/openim-rpc/openim-rpc-conversation/main.go
+    goos:
+      - darwin
+      - windows
+      - linux
+    goarch:
+      - s390x
+      - mips64
+      - mips64le
+      - amd64
+      - ppc64le
+      - arm64
+    goarm:
+      - "6"
+      - "7"
+
+  - binary: openim-rpc-friend
+    id: openim-rpc-friend
+    main: ./cmd/openim-rpc/openim-rpc-friend/main.go
+    goos:
+      - darwin
+      - windows
+      - linux
+    goarch:
+      - s390x
+      - mips64
+      - mips64le
+      - amd64
+      - ppc64le
+      - arm64
+    goarm:
+      - "6"
+      - "7"
+
+  - binary: openim-rpc-group
+    id: openim-rpc-group
+    main: ./cmd/openim-rpc/openim-rpc-group/main.go
+    goos:
+      - darwin
+      - windows
+      - linux
+    goarch:
+      - s390x
+      - mips64
+      - mips64le
+      - amd64
+      - ppc64le
+      - arm64
+    goarm:
+      - "6"
+      - "7"
+
+  - binary: openim-rpc-msg
+    id: openim-rpc-msg
+    main: ./cmd/openim-rpc/openim-rpc-msg/main.go
+    goos:
+      - darwin
+      - windows
+      - linux
+    goarch:
+      - s390x
+      - mips64
+      - mips64le
+      - amd64
+      - ppc64le
+      - arm64
+    goarm:
+      - "6"
+      - "7"
+
+  - binary: openim-rpc-third
+    id: openim-rpc-third
+    main: ./cmd/openim-rpc/openim-rpc-third/main.go
+    goos:
+      - darwin
+      - windows
+      - linux
+    goarch:
+      - s390x
+      - mips64
+      - mips64le
+      - amd64
+      - ppc64le
+      - arm64
+    goarm:
+      - "6"
+      - "7"
+
+  - binary: openim-rpc-user
+    id: openim-rpc-user
+    main: ./cmd/openim-rpc/openim-rpc-user/main.go
+    goos:
+      - darwin
+      - windows
+      - linux
+    goarch:
+      - s390x
+      - mips64
+      - mips64le
+      - amd64
+      - ppc64le
+      - arm64
+    goarm:
+      - "6"
+      - "7"
+
+archives:
+  - format: tar.gz
+    # this name template makes the OS and Arch compatible with the results of uname.
+    name_template: >-
+      {{ .ProjectName }}_
+      {{- title .Os }}_
+      {{- if eq .Arch "amd64" }}x86_64
+      {{- else if eq .Arch "386" }}i386
+      {{- else }}{{ .Arch }}{{ end }}
+      {{- if .Arm }}v{{ .Arm }}{{ end }}
+    # use zip for windows archives
+    files:
+      - LICENSE
+      - README.md
+      - CHANGELOG/*
+      - CONTRIBUTING.md
+      - docs/*
+      - src: "*.md"
+        dst: docs
+
+        # Strip parent folders when adding files to the archive.
+        strip_parent: true
+
+        # File info.
+        # Not all fields are supported by all formats available formats.
+        #
+        # Default: copied from the source file
+        info:
+          # Templates: allowed (since v1.14)
+          owner: root
+
+          # Templates: allowed (since v1.14)
+          group: root
+
+          # Must be in time.RFC3339Nano format.
+          #
+          # Templates: allowed (since v1.14)
+          mtime: "{{ .CommitDate }}"
+
+          # File mode.
+          mode: 0644
+
+    format_overrides:
+    - goos: windows
+      format: zip
+
+changelog:
+  sort: asc
+  use: github
+  filters:
+    exclude:
+      - "^test:"
+      - "^chore"
+      - "merge conflict"
+      - Merge pull request
+      - Merge remote-tracking branch
+      - Merge branch
+      - go mod tidy
+  groups:
+    - title: Dependency updates
+      regexp: '^.*?(feat|fix)\(deps\)!?:.+$'
+      order: 300
+    - title: "New Features"
+      regexp: '^.*?feat(\([[:word:]]+\))??!?:.+$'
+      order: 100
+    - title: "Security updates"
+      regexp: '^.*?sec(\([[:word:]]+\))??!?:.+$'
+      order: 150
+    - title: "Bug fixes"
+      regexp: '^.*?fix(\([[:word:]]+\))??!?:.+$'
+      order: 200
+    - title: "Documentation updates"
+      regexp: ^.*?doc(\([[:word:]]+\))??!?:.+$
+      order: 400
+    - title: "Build process updates"
+      regexp: ^.*?build(\([[:word:]]+\))??!?:.+$
+      order: 400
+    - title: Other work
+      order: 9999
+
+# dockers:
+#   - image_templates:
+#       - "openimsdk/open-im-server:{{ .Tag }}-amd64"
+#       - "ghcr.io/goreleaser/goreleaser:{{ .Tag }}-amd64"
+#     dockerfile: Dockerfile
+#     use: buildx
+#     build_flag_templates:
+#       - "--pull"
+#       - "--label=io.artifacthub.package.readme-url=https://raw.githubusercontent.com/OpenIMSDK/Open-IM-Server/main/README.md"
+#       - "--label=io.artifacthub.package.logo-url=hhttps://github.com/OpenIMSDK/Open-IM-Server/blob/main/assets/logo/openim-logo-green.png"
+#       - '--label=io.artifacthub.package.maintainers=[{"name":"Xinwei Xiong","email":"3293172751nss@gmail.com"}]'
+#       - "--label=io.artifacthub.package.license=Apace-2.0"
+#       - "--label=org.opencontainers.image.description=OpenIM Open source top instant messaging system"
+#       - "--label=org.opencontainers.image.created={{.Date}}"
+#       - "--label=org.opencontainers.image.name={{.ProjectName}}"
+#       - "--label=org.opencontainers.image.revision={{.FullCommit}}"
+#       - "--label=org.opencontainers.image.version={{.Version}}"
+#       - "--label=org.opencontainers.image.source={{.GitURL}}"
+#       - "--platform=linux/amd64"
+#     extra_files:
+#       - scripts/entrypoint.sh
+#   - image_templates:
+#       - "goreleaser/goreleaser:{{ .Tag }}-arm64"
+#       - "ghcr.io/goreleaser/goreleaser:{{ .Tag }}-arm64"
+#     dockerfile: Dockerfile
+#     use: buildx
+#     build_flag_templates:
+#       - "--pull"
+#       - "--label=io.artifacthub.package.readme-url=https://raw.githubusercontent.com/OpenIMSDK/Open-IM-Server/main/README.md"
+#       - "--label=io.artifacthub.package.logo-url=hhttps://github.com/OpenIMSDK/Open-IM-Server/blob/main/assets/logo/openim-logo-green.png"
+#       - '--label=io.artifacthub.package.maintainers=[{"name":"Xinwei Xiong","email":"3293172751nss@gmail.com"}]'
+#       - "--label=io.artifacthub.package.license=Apace-2.0"
+#       - "--label=org.opencontainers.image.description=OpenIM Open source top instant messaging system"
+#       - "--label=org.opencontainers.image.created={{.Date}}"
+#       - "--label=org.opencontainers.image.name={{.ProjectName}}"
+#       - "--label=org.opencontainers.image.revision={{.FullCommit}}"
+#       - "--label=org.opencontainers.image.version={{.Version}}"
+#       - "--label=org.opencontainers.image.source={{.GitURL}}"
+#       - "--platform=linux/arm64"
+#     goarch: arm64
+#     extra_files:
+#       - scripts/entrypoint.sh
+
+# docker_manifests:
+#   - name_template: "goreleaser/goreleaser:{{ .Tag }}"
+#     image_templates:
+#       - "goreleaser/goreleaser:{{ .Tag }}-amd64"
+#       - "goreleaser/goreleaser:{{ .Tag }}-arm64"
+#   - name_template: "ghcr.io/goreleaser/goreleaser:{{ .Tag }}"
+#     image_templates:
+#       - "ghcr.io/goreleaser/goreleaser:{{ .Tag }}-amd64"
+#       - "ghcr.io/goreleaser/goreleaser:{{ .Tag }}-arm64"
+#   - name_template: "goreleaser/goreleaser:latest"
+#     image_templates:
+#       - "goreleaser/goreleaser:{{ .Tag }}-amd64"
+#       - "goreleaser/goreleaser:{{ .Tag }}-arm64"
+#   - name_template: "ghcr.io/goreleaser/goreleaser:latest"
+#     image_templates:
+#       - "ghcr.io/goreleaser/goreleaser:{{ .Tag }}-amd64"
+#       - "ghcr.io/goreleaser/goreleaser:{{ .Tag }}-arm64"
+
+nfpms:
+  - id: packages
+    builds:
+      - openim-api
+      - openim-cmdutils
+      - openim-crontask
+      - openim-msggateway
+      - openim-msgtransfer
+      - openim-push
+      - openim-rpc-auth
+      - openim-rpc-conversation
+      - openim-rpc-friend
+      - openim-rpc-group
+      - openim-rpc-msg
+      - openim-rpc-third
+      - openim-rpc-user
+    # Your app's vendor.
+    vendor: OpenIMSDK
+    homepage: https://github.com/OpenIMSDK/Open-IM-Server
+    maintainer: kubbot <https://github.com/kubbot>
+    description: |-
+      Auto sync github labels
+      kubbot && openimbot
+    license: MIT
+    formats:
+      - apk
+      - deb
+      - rpm
+      - termux.deb # Since: v1.11
+      - archlinux # Since: v1.13
+    dependencies:
+      - git
+    recommends:
+      - golang
+
+
+# The lines beneath this are called `modelines`. See `:help modeline`
+# Feel free to remove those if you don't want/use them.
+# yaml-language-server: $schema=https://goreleaser.com/static/schema.json
+# vim: set ts=2 sw=2 tw=0 fo=cnqoj
+
+# Default: './dist'
+dist: ./_output/dist
+
+# .goreleaser.yaml
+milestones:
+  # You can have multiple milestone configs
+  -
+    # Repository for the milestone
+    # Default is extracted from the origin remote URL
+    repo:
+      owner: OpenIMSDK
+      name: Open-IM-Server
+
+    # Whether to close the milestone
+    close: true
+
+    # Fail release on errors, such as missing milestone.
+    fail_on_error: false
+
+    # Name of the milestone
+    #
+    # Default: '{{ .Tag }}'
+    name_template: "Current Release"
+
+# publishers:
+#   - name: "fury.io"
+#     ids:
+#       - packages
+#     dir: "{{ dir .ArtifactPath }}"
+#     cmd: |
+#       bash -c '
+#       if [[ "{{ .Tag }}" =~ ^v[0-9]+\.[0-9]+\.[0-9]+$ ]]; then
+#         curl -F package=@{{ .ArtifactName }} https://{{ .Env.FURY_TOKEN }}@push.fury.io/{{ .Env.USERNAME }}/
+#       else
+#         echo "Skipping deployment: Non-production release detected"
+#       fi'
+
+checksum:
+  name_template: "{{ .ProjectName }}_checksums.txt"
+  algorithm: sha256
+
+release:
+
+  prerelease: auto
+  
+  footer: |
+  
+    ## Welcome to the {{ .Tag }} release of [chat](https://github.com/OpenIMSDK/chat)!🎉🎉!
+
+    **Full Changelog**: https://github.com/OpenIMSDK/Open-IM-Server/compare/{{ .PreviousTag }}...{{ .Tag }}
+
+    ## Helping out
+
+    + We release logs are recorded on [✨CHANGELOG](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/CHANGELOG/CHANGELOG.md)
+
+    + For information on versions of OpenIM and how to maintain branches, read [📚this article](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/version.md)
+
+    + If you wish to use mirroring, read OpenIM's [image management policy](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/images.md)
+
+    **Want to be one of them 😘?**
+
+    <p align="center">
+        <a href="https://github.com/kubbot" style="float: left; margin-right: 10px;">
+            <img src="https://github.com/openimbot/openimbot/blob/main/assets/icon/blue%E9%80%8F%E6%98%8E.png" width="50" height="50" />
+        </a>
+        <a href="https://www.openim.online">
+            <img src="https://github.com/OpenIMSDK/Open-IM-Server/blob/main/assets/logo/openim-logo.png" />
+        </a>
+        <a href="https://github.com/openimbot" style="float: right; margin-left: 10px;">
+            <img src="https://github.com/openimbot/openimbot/blob/main/assets/icon/red%E9%80%8F%E6%98%8E.png" width="50" height="50" />
+        </a>
+    </p>
+
+    > **Note**
+    > @openimbot and @kubbot have made great contributions to the community as community 🤖robots(@openimsdk/bot), respectively.
+    > Thanks to the @openimsdk/openim team for all their hard work on this release.
+    > Thank you to all the [💕developers and contributors](https://github.com/OpenIMSDK/Open-IM-Server/graphs/contributors), people from all over the world, OpenIM brings us together
+    > Contributions to this project are welcome! Please see [CONTRIBUTING.md](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/CONTRIBUTING.md) for details.
+
+    ## Get Involved with OpenIM!
+
+    **Here are some ways to get involved with the OpenIM community:**
+
+    📢 **Slack Channel**: Join our Slack channels for discussions, communication, and support. Click [here](https://join.slack.com/t/openimsdk/shared_invite/zt-1tmoj26uf-_FDy3dowVHBiGvLk9e5Xkg) to join the Open-IM-Server Slack team channel.
+
+    📧 **Gmail Contact**: If you have any questions, suggestions, or feedback for our open-source projects, please feel free to [contact us via email](https://mail.google.com/mail/?view=cm&fs=1&tf=1&to=winxu81@gmail.com).
+
+    📖 **Blog**: Stay up-to-date with OpenIM-Server projects and trends by reading our [blog](https://doc.rentsoft.cn/). We share the latest developments, tech trends, and other interesting information related to OpenIM.
+
+    📱 **WeChat**: Add us on WeChat (QR Code) and indicate that you are a user or developer of Open-IM-Server. We'll process your request as soon as possible.
+
+    Remember, your contributions play a vital role in making OpenIM successful, and we look forward to your active participation in our community! 🙌

CHANGELOG/CHANGELOG-3.0.md

@@ -1,23 +1,9 @@
 # Version logging for OpenIM
 
-**3.0 Major refactoring**
-
 <!-- BEGIN MUNGE: GENERATED_TOC -->
-
 - [Version logging for OpenIM](#version-logging-for-openim)
-  - [\[v3.0\]](#v30)
-  - [v3.0.0 - 2023-07-10](#v300---2023-07-10)
-  - [v2.9.0+1.839643f - 2023-07-07](#v2901839643f---2023-07-07)
-  - [v2.9.0+2.35f07fe - 2023-07-06](#v290235f07fe---2023-07-06)
-  - [v2.9.0+1.b5072b1 - 2023-07-05](#v2901b5072b1---2023-07-05)
-  - [v2.9.0+3.2667a3a - 2023-07-05](#v29032667a3a---2023-07-05)
-  - [v2.9.0+7.04818ca - 2023-07-05](#v290704818ca---2023-07-05)
+  - [Unreleased](#unreleased)
   - [v2.9.0 - 2023-07-04](#v290---2023-07-04)
-  - [v0.0.0+1.3714b4f - 2023-07-04](#v00013714b4f---2023-07-04)
-  - [v0.0.0+635.8b92c90 - 2023-07-04](#v0006358b92c90---2023-07-04)
-  - [v0.0.0+1.78a6d03 - 2023-07-04](#v000178a6d03---2023-07-04)
-  - [v0.0.0+2.e057c18 - 2023-07-04](#v0002e057c18---2023-07-04)
-  - [v0.0.0+630.b55ac4a - 2023-07-04](#v000630b55ac4a---2023-07-04)
     - [Reverts](#reverts)
     - [Pull Requests](#pull-requests)
   - [v2.3.3 - 2022-09-18](#v233---2022-09-18)
@@ -32,17 +18,15 @@
   - [v2.0.9 - 2022-04-29](#v209---2022-04-29)
     - [Reverts](#reverts-1)
     - [Pull Requests](#pull-requests-2)
-  - [v2.0.8 - 2022-04-24](#v208---2022-04-24)
-    - [Pull Requests](#pull-requests-3)
   - [v2.0.7 - 2022-04-08](#v207---2022-04-08)
-    - [Pull Requests](#pull-requests-4)
+    - [Pull Requests](#pull-requests-3)
   - [v2.0.6 - 2022-04-01](#v206---2022-04-01)
-    - [Pull Requests](#pull-requests-5)
+    - [Pull Requests](#pull-requests-4)
   - [v2.0.5 - 2022-03-24](#v205---2022-03-24)
   - [v2.04 - 2022-03-18](#v204---2022-03-18)
   - [v2.0.3 - 2022-03-11](#v203---2022-03-11)
   - [v2.0.2 - 2022-03-04](#v202---2022-03-04)
-    - [Pull Requests](#pull-requests-6)
+    - [Pull Requests](#pull-requests-5)
   - [v2.0.1 - 2022-02-25](#v201---2022-02-25)
   - [v2.0.0 - 2022-02-23](#v200---2022-02-23)
   - [v1.0.7 - 2021-12-17](#v107---2021-12-17)
@@ -54,48 +38,14 @@
   - [v1.0.0 - 2021-10-28](#v100---2021-10-28)
     - [Reverts](#reverts-2)
 
-
 <!-- END MUNGE: GENERATED_TOC -->
 
 <a name="unreleased"></a>
-## [v3.0]
+## [Unreleased]
 
 
-<a name="v3.0.0"></a>
-## [v3.0.0] - 2023-07-10
-
-<a name="v2.9.0+1.839643f"></a>
-## [v2.9.0+1.839643f] - 2023-07-07
-
-<a name="v2.9.0+2.35f07fe"></a>
-## [v2.9.0+2.35f07fe] - 2023-07-06
-
-<a name="v2.9.0+1.b5072b1"></a>
-## [v2.9.0+1.b5072b1] - 2023-07-05
-
-<a name="v2.9.0+3.2667a3a"></a>
-## [v2.9.0+3.2667a3a] - 2023-07-05
-
-<a name="v2.9.0+7.04818ca"></a>
-## [v2.9.0+7.04818ca] - 2023-07-05
-
 <a name="v2.9.0"></a>
 ## [v2.9.0] - 2023-07-04
-
-<a name="v0.0.0+1.3714b4f"></a>
-## [v0.0.0+1.3714b4f] - 2023-07-04
-
-<a name="v0.0.0+635.8b92c90"></a>
-## [v0.0.0+635.8b92c90] - 2023-07-04
-
-<a name="v0.0.0+1.78a6d03"></a>
-## [v0.0.0+1.78a6d03] - 2023-07-04
-
-<a name="v0.0.0+2.e057c18"></a>
-## [v0.0.0+2.e057c18] - 2023-07-04
-
-<a name="v0.0.0+630.b55ac4a"></a>
-## [v0.0.0+630.b55ac4a] - 2023-07-04
 ### Reverts
 - update etcd to v3.5.2 ([#206](https://github.com/OpenIMSDK/Open-IM-Server/issues/206))
 
@@ -144,11 +94,6 @@
 - Merge branch 'tuoyun'
 - Merge branch 'tuoyun'
 - Merge branch 'tuoyun'
-
-
-<a name="v2.0.8"></a>
-## [v2.0.8] - 2022-04-24
-### Pull Requests
 - Merge branch 'tuoyun'
 - Merge branch 'tuoyun'
 
@@ -216,19 +161,8 @@
 - update
 
 
-[Unreleased]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v3.0.0...HEAD
-[v3.0.0]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.9.0+1.839643f...v3.0.0
-[v2.9.0+1.839643f]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.9.0+2.35f07fe...v2.9.0+1.839643f
-[v2.9.0+2.35f07fe]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.9.0+1.b5072b1...v2.9.0+2.35f07fe
-[v2.9.0+1.b5072b1]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.9.0+3.2667a3a...v2.9.0+1.b5072b1
-[v2.9.0+3.2667a3a]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.9.0+7.04818ca...v2.9.0+3.2667a3a
-[v2.9.0+7.04818ca]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.9.0...v2.9.0+7.04818ca
-[v2.9.0]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v0.0.0+1.3714b4f...v2.9.0
-[v0.0.0+1.3714b4f]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v0.0.0+635.8b92c90...v0.0.0+1.3714b4f
-[v0.0.0+635.8b92c90]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v0.0.0+1.78a6d03...v0.0.0+635.8b92c90
-[v0.0.0+1.78a6d03]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v0.0.0+2.e057c18...v0.0.0+1.78a6d03
-[v0.0.0+2.e057c18]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v0.0.0+630.b55ac4a...v0.0.0+2.e057c18
-[v0.0.0+630.b55ac4a]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.3.3...v0.0.0+630.b55ac4a
+[Unreleased]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.9.0...HEAD
+[v2.9.0]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.3.3...v2.9.0
 [v2.3.3]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.3.2...v2.3.3
 [v2.3.2]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.3.0-rc2...v2.3.2
 [v2.3.0-rc2]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.3.0-rc1...v2.3.0-rc2
@@ -237,8 +171,7 @@
 [v2.2.0]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.1.0...v2.2.0
 [v2.1.0]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.0.10...v2.1.0
 [v2.0.10]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.0.9...v2.0.10
-[v2.0.9]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.0.8...v2.0.9
-[v2.0.8]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.0.7...v2.0.8
+[v2.0.9]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.0.7...v2.0.9
 [v2.0.7]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.0.6...v2.0.7
 [v2.0.6]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.0.5...v2.0.6
 [v2.0.5]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.04...v2.0.5

CHANGELOG/CHANGELOG.md

@@ -1,9 +1,25 @@
 # Changelog
 
+- [Changelog](#changelog)
+  - [OpenIM versioning policy](#openim-versioning-policy)
+  - [command](#command)
+  - [create next tag](#create-next-tag)
+  - [Release version logs](#release-version-logs)
+  - [Introduction](#introduction)
+  - [Naming Format](#naming-format)
+  - [Examples](#examples)
+  - [Version Modifiers](#version-modifiers)
+  - [Versioning Strategy](#versioning-strategy)
+
+
 All notable changes to this project will be documented in this file.
 
 + [https://github.com/OpenIMSDK/Open-IM-Server/releases](https://github.com/OpenIMSDK/Open-IM-Server/releases)
 
+## OpenIM versioning policy
+
++ [OpenIM Version](../docs/conversions/version.md)
+
 ## command
 
 ```bash
@@ -18,6 +34,14 @@ git commit -am "release 2.0.0"
 git tag 2.0.0
 ```
 
+| Query          | Description                                    | Example                     |
+| -------------- | ---------------------------------------------- | --------------------------- |
+| `<old>..<new>` | Commit contained in `<new>` tags from `<old>`. | `$ git-chglog 1.0.0..2.0.0` |
+| `<name>..`     | Commit from the `<name>` to the latest tag.    | `$ git-chglog 1.0.0..`      |
+| `..<name>`     | Commit from the oldest tag to `<name>`.        | `$ git-chglog ..2.0.0`      |
+| `<name>`       | Commit contained in `<name>`.                  | `$ git-chglog 1.0.0`        |
+
+
 ## Release version logs
 
 + [OpenIM CHANGELOG-V1.0](CHANGELOG-1.0.md)
@@ -26,4 +50,60 @@ git tag 2.0.0
 + [OpenIM CHANGELOG-V2.2](CHANGELOG-2.2.md)
 + [OpenIM CHANGELOG-V2.3](CHANGELOG-2.3.md)
 + [OpenIM CHANGELOG-V2.9](CHANGELOG-2.9.md)
-+ [OpenIM CHANGELOG-V3.0](CHANGELOG-3.0.md)
++ [OpenIM CHANGELOG-V3.0](CHANGELOG-3.0.md)
+
+## Introduction
+
+In both the open-source and closed-source software development communities, it is important to follow a consistent and understandable versioning scheme for software projects. This ensures clear communication of changes, compatibility, and stability across different releases. One widely adopted naming convention is the Semantic Versioning 2.0.0.
+
+## Naming Format
+
+The most common format for version numbers is as follows:
+
+```
+major.minor[.patch[.build]]
+```
+
+Let's take a closer look at each component:
+
+1. **Major Version**: This is the first number in the versioning scheme and indicates significant changes that may not be backward compatible (specific to each project).
+2. **Minor Version**: The second number signifies the addition of new features while maintaining backward compatibility.
+3. **Patch Version**: The third number represents bug fixes or code optimizations without introducing new features. It is generally backward compatible.
+4. **Build Version**: Typically an automatically generated number that increments with each code commit.
+
+## Examples
+
+Here are a few examples to illustrate the versioning scheme:
+
+1. `1.0`
+2. `2.14.0.1478`
+3. `3.2.1 build-354`
+
+## Version Modifiers
+
+Apart from the version numbers, there are also version modifiers used to indicate specific stages or statuses of a release. Some commonly used version modifiers include:
+
+- **alpha**: An internal testing version with numerous known bugs. It is primarily used for communication among developers.
+- **beta**: A testing version released to enthusiastic users for feedback and bug detection.
+- **rc (release candidate)**: The final testing version before the official release.
+- **ga (general availability)**: The initial stable release for public distribution.
+- **r/release** (or no modifier at all): The final released version intended for general users.
+- **lts (long-term support)**: Designates a version that will receive extended maintenance and bug fixes for a specified number of years.
+
+## Versioning Strategy
+
+To effectively manage version numbers, the following strategies are commonly employed:
+
+- The initial version of a project can be either `0.1` or `1.0`.
+- When fixing bugs, the patch version is incremented by 1.
+- When adding new features, the minor version is incremented by 1, and the patch version is reset to 0.
+- In the case of significant modifications, the major version is incremented by 1.
+- The build version is usually automatically generated by the compilation process and follows a defined format. It does not require manual control.
+
+By adhering to these strategies and guidelines, developers can maintain consistency and clarity in versioning their software projects. This enables users and collaborators to understand the nature of changes between different releases and ensure compatibility with their systems.
+
+(Note: Markdown formatting has been used to structure this article. Markdown is a lightweight markup language used to format text on platforms like GitHub.)
+
+------
+
+**Note**: The above article is based on the given content and aims to provide a Markdown-formatted English article explaining the naming conventions for software project versions, specifically focusing on the Semantic Versioning 2.0.0.

CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+3293172751nss@gmail.com.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

CONTRIBUTING.md

@@ -130,7 +130,7 @@ To propose PR for the Open-IM-Server item, we assume you have registered a GitHu
 
    ```bash
    ❯ git rebase upstream/main
-   ❯ make link	  # golangci-lint run -c .golangci.yml
+   ❯ make lint	  # golangci-lint run -c .golangci.yml
    ❯ git add -A  # add changes to staging
    ❯ git commit -a -s -m "message for your changes" # -s adds a Signed-off-by trailer
    ```

Dockerfile

@@ -1,39 +1,33 @@
-FROM golang as build
+# Build Stage
+FROM golang:1.20 AS builder
 
-# go mod Installation source, container environment variable addition will override the default variable value
-ENV GO111MODULE=on
-ENV GOPROXY=https://goproxy.cn,direct
+# Set go mod installation source and proxy
+ARG GO111MODULE=on
+ARG GOPROXY=https://goproxy.cn,direct
+ENV GO111MODULE=$GO111MODULE
+ENV GOPROXY=$GOPROXY
 
 # Set up the working directory
-WORKDIR /Open-IM-Server
-# add all files to the container
-COPY . .
+WORKDIR /openim/openim-server
 
-WORKDIR /Open-IM-Server/scripts
-RUN chmod +x *.sh
+COPY go.mod go.sum ./
+RUN go mod download
 
-RUN /bin/sh -c ./build_all_service.sh
+# Copy all files to the container
+ADD . .
 
-#Blank image Multi-Stage Build
-FROM ubuntu
+RUN /bin/sh -c "make clean"
+RUN /bin/sh -c "make build"
 
-RUN rm -rf /var/lib/apt/lists/*
-RUN apt-get update && apt-get install apt-transport-https && apt-get install procps\
-&&apt-get install net-tools
-#Non-interactive operation
-ENV DEBIAN_FRONTEND=noninteractive
-RUN apt-get install -y vim curl tzdata gawk
-#Time zone adjusted to East eighth District
-RUN ln -fs /usr/share/zoneinfo/Asia/Shanghai /etc/localtime && dpkg-reconfigure -f noninteractive tzdata
+FROM ghcr.io/openim-sigs/openim-bash-image:latest
 
+WORKDIR ${SERVER_WORKDIR}
 
-#set directory to map logs,config file,scripts file.
-VOLUME ["/Open-IM-Server/logs","/Open-IM-Server/config","/Open-IM-Server/scripts","/Open-IM-Server/db/sdk"]
+# Copy scripts and binary files to the production image
+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}/_output/bin/platforms /openim/openim-server/_output/bin/platforms
 
-#Copy scripts files and binary files to the blank image
-COPY --from=build /Open-IM-Server/scripts /Open-IM-Server/scripts
-COPY --from=build /Open-IM-Server/_output/bin/platforms/linux/amd64 /Open-IM-Server/_output/bin/platforms/linux/amd64  
+VOLUME ["/openim/openim-server/logs","/openim/openim-server/config","/openim/openim-server/scripts"]
 
-WORKDIR /Open-IM-Server/scripts
-
-CMD ["./docker_start_all.sh"]
+CMD ["bash","-c","${OPENIM_SERVER_CMDDIR}/docker_start_all.sh"]

Makefile

@@ -63,6 +63,16 @@ build:
 multiarch:
 	@$(MAKE) go.build.multiarch
 
+## install: Install deployment openim ✨
+.PHONY: install
+install:
+	@$(MAKE) go.install
+
+## check: Check OpenIM deployment ✨
+.PHONY: check
+check:
+	@$(MAKE) go.check
+
 ## tidy: tidy go.mod ✨
 .PHONY: tidy
 tidy:
@@ -171,6 +181,11 @@ verify-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

README-zh_CN.md

@@ -26,12 +26,14 @@
 
 ## Open-IM-Server 是什么
 
-Open-IM-Server 是一款即时通讯服务器，使用纯 Golang 开发，采用 JSON over WebSocket 传输协议。在 Open-IM-Server 中，所有东西都是消息，因此您可以轻松扩展自定义消息，而无需修改服务器代码。使用微服务架构，Open-IM-Server 可以使用集群进行部署。通过在客户端服务器上部署 Open-IM-Server，开发人员可以免费快速地将即时通讯和实时网络功能集成到自己的应用程序中，并确保业务数据的安全性和隐私性。
+Open-IM-Server 是一款即时通讯服务器，使用纯 Golang 开发，采用 JSON over WebSocket 传输协议。在 Open-IM-Server 中，所有东西都是消息，因此您可以轻松扩展自定义消息，而无需修改服务器代码。使用微服务架构，Open-IM-Server 可以使用集群进行部署。通过在服务器上部署 Open-IM-Server，开发人员可以快速地将即时通讯和实时网络功能集成到自己的应用程序中，并确保业务数据的安全性和隐私性。
+
+Open-IM-Server并不是一个独立的产品，本身不包含账号的注册和登录服务。
+为方便大家测试，我们开源了包括登录注册功能的 [chat 仓库](https://github.com/OpenIMSDK/chat)，chat 业务服务端和 Open-IM-Server 一起部署，即可搭建一个聊天产品。
 
 ## 特点
 
-+ 免费
-+ 可扩展架构
++ 开源
 + 易于集成
 + 良好的可扩展性
 + 高性能
@@ -40,137 +42,207 @@ Open-IM-Server 是一款即时通讯服务器，使用纯 Golang 开发，采用
 
 ## 社区
 
-+ 访问中文官方网站：[Open-IM中文开发文档](https://doc.rentsoft.cn/)
++ 访问中文官方网站：[OpenIM中文开发文档](https://doc.rentsoft.cn/)
 
 ## 快速开始
 
-### 安装Open-IM-Server
+### 使用 docker-compose 部署
 
-> Open-IM 依赖于五个开源高性能组件：ETCD、MySQL、MongoDB、Redis 和 Kafka。在部署 Open-IM-Server 之前，请确保已安装上述五个组件。如果您的服务器没有上述组件，则必须首先安装缺失组件。如果您已经拥有上述组件，则建议直接使用它们。如果没有，则建议使用 Docker-compose，无需安装依赖项，一键部署，更快更方便。
+1. 克隆项目
 
-### 使用 Docker 部署
+```
+git clone https://github.com/OpenIMSDK/Open-IM-Server 
+cd Open-IM-Server
+git checkout release-v3.0 #or other release branch
+```
 
-1. 安装 [Go 环境](https://golang.org/doc/install)。确保 Go 版本至少为 1.17。
+2. 修改 .env
 
-2. 克隆 Open-IM 项目到您的服务器
+```
+此处主要修改相关组件密码
+USER=root #不用修改
+PASSWORD=openIM123  #8位以上的数字和字母组合密码，密码对redis mysql mongo生效，以及config/config.yaml中的accessSecret
+ENDPOINT=http://127.0.0.1:10005 #minio对外服务的ip和端口，或用域名storage.xx.xx，app要能访问到此ip和端口或域名，
+API_URL=http://127.0.0.1:10002/object/ #app要能访问到此ip和端口或域名，
+DATA_DIR=./  #指定大磁盘目录
+```
 
-   `git clone <https://github.com/OpenIMSDK/Open-IM-Server.git> --recursive`
+3. 部署和启动
 
-3. 部署
+注意：此命令只能执行一次，它会根据.env 中的 PASSWORD 变量修改 docker-compose 中组件密码，并修改 config/config.yaml 中的组件密码
+如果.env 中的密码变了，需要先 docker-compose down ; rm components -rf 后再执行此命令。
 
-   1. 修改 env
+```
+chmod +x install_im_server.sh;
+./install_im_server.sh;
+```
 
-      ```
-      #cd Open-IM-server
-      USER=root
-      PASSWORD=openIM123    #密码至少8位数字，不包括特殊字符
-      ENDPOINT=http://127.0.0.1:10005 #请用互联网IP替换127.0.0.1
-      DATA_DIR=./
-      ```
+4. 检查服务
 
-   2. 部署和启动
+```
+cd scripts;
+./docker_check_service.sh
+```
 
-      ```
-      chmod +x install_im_server.sh;
-      ./install_im_server.sh;
-      ```
+![https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/images/docker_build.png](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/images/docker_build.png)
 
-   3. 检查服务
+### 使用源码编译
 
-      ```
-      cd scripts;
-      ./docker_check_service.sh
-      ./check_all.sh
-      ```
-
-      ![https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/Open-IM-Servers-on-System.png](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/Open-IM-Servers-on-System.png)
-
-### 使用源代码部署
-
-1. Go 1.17 或更高版本。
+1. Go 1.18或更高版本。
 
 2. 克隆
 
    ```
-   git clone <https://github.com/OpenIMSDK/Open-IM-Server.git> --recursive
-   cd cmd/openim-sdk-core
-   git checkout main
+   git clone https://github.com/OpenIMSDK/Open-IM-Server 
+   cd Open-IM-Server
+   git checkout release-v3.0 #or other release branch
    ```
 
-3. 设置可执行权限
+3. 编译
 
    ```
-   cd ../../scripts/
+   cd Open-IM-server/scripts
    chmod +x *.sh
+   ./build_all_service.sh
    ```
 
-4. 构建
+所有服务已成功构建如图所示
 
-   ```
-   ./batch_build_all_service.sh
-   ```
+![编译成功](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/images/build.png)
 
-所有服务已成功构建
+### 组件配置说明
 
-### 配置说明
+config/config.yaml中针对存储组件有详细的配置说明
 
-> Open-IM 配置分为基本组件配置和业务内部服务配置。当使用产品时，开发人员需要将每个组件的地址填写为其服务器组件的地址，并确保业务内部服务端口未被占用。
-
-### 基本组件配置说明
-
-+ ETCD
-  + Etcd 用于 RPC 服务的发现和注册，Etcd Schema 是注册名称的前缀，建议将其修改为公司名称，Etcd 地址(ip+port)支持集群部署，可以填写多个 ETCD 地址，也可以只有一个 etcd 地址。
++ Zookeeper
+  + 用于RPC 服务发现和注册，支持集群。
+  
+    ````
+    ```
+    zookeeper:
+      schema: openim                          #不建议修改
+      address: [ 127.0.0.1:2181 ]             #地址
+      username:                               #用户名
+      password:                               #密码
+    ```
+    ````
+  
+    
+  
 + MySQL
-  + MySQL 用于消息和用户关系的全存储，暂时不支持集群部署。修改地址、用户、密码和数据库名称。
+  
+  + 用于存储用户、关系链、群组，支持数据库主备。
+  
+    ```
+    mysql:
+      address: [ 127.0.0.1:13306 ]            #地址
+      username: root                          #用户名
+      password: openIM123                     #密码
+      database: openIM_v2                     #不建议修改
+      maxOpenConn: 1000                       #最大连接数
+      maxIdleConn: 100                        #最大空闲连接数
+      maxLifeTime: 60                         #连接可以重复使用的最长时间（秒）
+      logLevel: 4                             #日志级别 1=slient 2=error 3=warn 4=info
+      slowThreshold: 500                      #慢语句阈值 （毫秒）
+    ```
+  
+    
+  
 + Mongo
-  + Mongo 用于消息的离线存储，默认存储 7 天。暂时不支持集群部署。只需修改地址和数据库名称即可。
+  + 用于存储离线消息，支持mongo分片集群。
+  
+    ```
+    mongo:
+      uri:                                    #不为空则直接使用该值
+      address: [ 127.0.0.1:37017 ]            #地址
+      database: openIM                        #mongo db 默认即可
+      username: root                          #用户名
+      password: openIM123                     #密码
+      maxPoolSize: 100                        #最大连接数
+    ```
+  
 + Redis
-  + Redis 目前主要用于消息序列号存储和用户令牌信息存储。暂时不支持集群部署。只需修改相应的 Redis 地址和密码即可。
+  + 用于存储消息序列号、最新消息、用户token及mysql缓存，支持集群部署。
+  
+    ```
+    redis:
+      address: [ 127.0.0.1:16379 ]            #地址
+      username:                               #用户名
+      password: openIM123                     #密码
+    ```
+  
 + Kafka
-  + Kafka 用作消息传输存储队列，支持集群部署，只需修改相应的地址。
+  + 用于消息队列，用于消息解耦，支持集群部署。
+  
+    ```
+    kafka:
+      username:                               #用户名
+      password:                               #密码
+      addr: [ 127.0.0.1:9092 ]                #地址
+      latestMsgToRedis:
+        topic: "latestMsgToRedis"
+      offlineMsgToMongo:
+        topic: "offlineMsgToMongoMysql"
+      msgToPush:
+        topic: "msqToPush"
+      msgToModify:
+        topic: "msgToModify"
+      consumerGroupID:
+        msgToRedis: redis
+        msgToMongo: mongo
+        msgToMySql: mysql
+        msgToPush: push
+        msgToModify: modify
+    ```
 
-### 内部服务配置说明
+### 启停服务
 
-+ credential&&push
-  + Open-IM 需要使用三方离线推送功能。目前使用的是腾讯的三方推送，支持 IOS、Android 和 OSX 推送。这些信息是腾讯推送的一些注册信息，开发人员需要去腾讯云移动推送注册相应的信息。如果您没有填写相应的信息，则无法使用离线消息推送功能。
-+ api&&rpcport&&longconnsvr&&rpcregistername
-  + API 端口是 HTTP 接口，longconnsvr 是 WebSocket 监听端口，rpcport 是内部服务启动端口。两者都支持集群部署。请确保这些端口未被使用。如果要为单个服务打开多个服务，请填写多个以逗号分隔的端口。rpcregistername 是每个服务在注册表 Etcd 中注册的服务名称，无需修改。
-+ log&&modulename
-  + 日志配置包括日志文件的存储路径，日志发送到 Elasticsearch 进行日志查看。目前不支持将日志发送到 Elasticsearch。暂时不需要修改配置。modulename 用于根据服务模块的名称拆分日志。默认配置可以。
+启动服务
 
-### 脚本说明
+```
+./start_all.sh;
+```
 
-> Open-IM 脚本提供服务编译、启动和停止脚本。有四个 Open-IM 脚本启动模块，一个是 http+rpc 服务启动模块，第二个是 WebSocket 服务启动模块，然后是 msg_transfer 模块，最后是 push 模块。
+检查服务
 
-+ path_info.sh&&style_info.sh&&
+```
+./check_all.sh
+```
 
-  functions.sh
+停止服务
 
-  + 包含每个模块的路径信息，包括源代码所在的路径、服务启动名称、shell 打印字体样式以及一些用于处理 shell 字符串的函数。
+```
+./stop_all.sh
+```
 
-+ build_all_service.sh
+### 开放 IM 端口
 
-  + 编译模块，将 Open-IM 的所有源代码编译为二进制文件并放入 bin 目录。
+| TCP 端口  | 说明                                                  | 操作                                    |
+| --------- | ----------------------------------------------------- | --------------------------------------- |
+| TCP:10001 | ws 协议，消息端口，如消息发送、推送等，用于客户端 SDK | 端口放行或 nginx 反向代理，并关闭防火墙 |
+| TCP:10002 | api 端口，如用户、好友、群组、消息等接口。            | 端口放行或 nginx 反向代理，并关闭防火墙 |
+| TCP:10005 | 选择 minio 存储时需要(openIM 默认使用 minio 存储)     | 端口放行或 nginx 反向代理，并关闭防火墙 |
 
-+ start_rpc_api_service.sh&&msg_gateway_start.sh&&msg_transfer_start.sh&&push_start.sh
+### 开放 Chat 端口
 
-  + 独立脚本启动模块，后跟 API 和 RPC 模块、消息网关模块、消息传输模块和推送模块。
+| TCP 端口  | 说明                     | 操作                                    |
+| --------- | ------------------------ | --------------------------------------- |
+| TCP:10008 | 业务系统，如注册、登录等 | 端口放行或 nginx 反向代理，并关闭防火墙 |
+| TCP:10009 | 管理后台，如统计、封号等 | 端口放行或 nginx 反向代理，并关闭防火墙 |
 
-+ start_all.sh&&stop_all.sh
+## APP和OpenIM关系
 
-  + 总脚本，启动所有服务和关闭所有服务。
+OpenIM 是开源的即时通讯组件，它并不是一个独立的产品，此图展示了AppServer、AppClient、Open-IM-Server以及Open-IM-SDK之间的关系
 
-## 认证流程图
+![https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/open-im-server.png](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/images/open-im-server.png)
 
-![https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/open-im-server.png](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/open-im-server.png)
+## 整体架构
 
-## 架构
-
-![https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/Architecture.jpg](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/Architecture.jpg)
+![https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/Architecture.jpg](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/images/Architecture.jpg)
 
 ## 开始开发 OpenIM
 
-[社区存储库](https://github.com/OpenIMSDK/community)包含有关从源代码构建 Kubernetes、如何贡献代码和文档、有关什么的联系人等所有信息。
+[社区存储库](https://github.com/OpenIMSDK/community)包含有关从源代码构建 Kubernetes、如何贡献代码和文档。
 
 ## 贡献
 

README.md

@@ -3,6 +3,7 @@
         <img src="./assets/logo-gif/openim-logo.gif" width="60%" height="30%"/>
     </a>
 </p>
+
 <h3 align="center" style="border-bottom: none">
     ⭐️  Open source Instant Messaging Server ⭐️ <br>
 <h3>
@@ -12,7 +13,7 @@
 <a href="https://goreportcard.com/report/github.com/OpenIMSDK/Open-IM-Server"><img src="https://goreportcard.com/badge/github.com/OpenIMSDK/Open-IM-Server" alt="A+"></a>
 <a href="https://github.com/OpenIMSDK/Open-IM-Server/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3A%22good+first+issue%22"><img src="https://img.shields.io/github/issues/OpenIMSDK/Open-IM-Server/good%20first%20issue?logo=%22github%22" alt="good first"></a>
 <a href="https://github.com/OpenIMSDK/Open-IM-Server"><img src="https://img.shields.io/github/stars/OpenIMSDK/Open-IM-Server.svg?style=flat&logo=github&colorB=deeppink&label=stars"></a>
-<a href="https://join.slack.com/t/openimsdk/shared_invite/zt-1tmoj26uf-_FDy3dowVHBiGvLk9e5Xkg"><img src="https://img.shields.io/badge/Slack-100%2B-blueviolet?logo=slack&amp;logoColor=white"></a>
+<a href="https://join.slack.com/t/openimsdk/shared_invite/zt-1tmoj26uf-_FDy3dowVHBiGvLk9e5Xkg"><img src="https://img.shields.io/badge/Slack-300%2B-blueviolet?logo=slack&amp;logoColor=white"></a>
 <a href="https://github.com/OpenIMSDK/Open-IM-Server/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-Apache--2.0-green"></a>
 <a href="https://golang.org/"><img src="https://img.shields.io/badge/Language-Go-blue.svg"></a>
 </p>
@@ -28,142 +29,209 @@
 
 ## What is Open-IM-Server
 
-Instant messaging server. Backend in pure Golang, wire transport protocol is JSON over websocket.
-Everything is a message in Open-IM-Server, so you can extend custom messages easily, there is no need to modify the server code.
-Using microservice architectures, Open-IM-Server can be deployed using clusters.
-By deployment of the Open-IM-Server on the customer's server, developers can integrate instant messaging and real-time network capabilities into their own applications free of charge and quickly, and ensure the security and privacy of business data.
+Open-IM-Server is an instant messaging server developed using pure Golang, adopting JSON over WebSocket as the communication protocol. In Open-IM-Server, everything is a message, so you can easily extend custom messages without modifying the server code. With a microservice architecture, Open-IM-Server can be deployed using clusters. By deploying Open-IM-Server on a server, developers can quickly integrate instant messaging and real-time networking features into their applications, ensuring the security and privacy of business data.
+
+Open-IM-Server is not a standalone product and does not include account registration and login services. For your convenience, we have open-sourced the [chat repository](https://github.com/OpenIMSDK/chat) which includes login and registration functionality. By deploying the chat business server alongside Open-IM-Server, a chat product can be set up.
 
 ## Features
 
-- Everything in Free
-- Scalable architecture
-- Easy integration
-- Good scalability
+- Open source
+- Easy to integrate
+- Excellent scalability
 - High performance
 - Lightweight
 - Supports multiple protocols
 
 ## Community
-- Visit the Chinese official website here: [📚 Open-IM docs](https://www.openim.online/zh)
+- Visit the official website: [OpenIM  Developer Documentation](https://www.openim.online/)
 
-## Quick start
+## Quick Start
 
-### Installing Open-IM-Server
+### Deploying with docker-compose
 
-> Open-IM relies on five open source high-performance components: ETCD, MySQL, MongoDB, Redis, and Kafka. Privatization deployment Before Open-IM-Server, please make sure that the above five components have been installed. If your server does not have the above components, you must first install Missing components. If you have the above components, it is recommended to use them directly. If not, it is recommended to use Docker-compose, no To install dependencies, one-click deployment, faster and more convenient.
+1. Clone the project
 
-#### Deploy using Docker
-
-1. Install [Go environment](https://golang.org/doc/install). Make sure Go version is at least 1.17
-
-2. Clone the Open-IM project to your server
-
-   ```
-   git clone https://github.com/OpenIMSDK/Open-IM-Server.git --recursive
-   ```
-
-3. Deploy
-
-    1. Modify env
-
-       ```
-       #cd Open-IM-server
-       USER=root  
-       PASSWORD=openIM123    #Password with more than 8 digits, excluding special characters
-       ENDPOINT=http://127.0.0.1:10005 #Replace 127.0.0.1 with Internet IP
-       DATA_DIR=./ 
-       ```
-
-    2. Deploy && Start
-    
-       ```
-       chmod +x install_im_server.sh;
-       ./install_im_server.sh;
-       ```
-    
-    4. Check service
-    
-       ```
-       cd scripts;
-       ./docker_check_service.sh./check_all.sh
-       ```
-       
-       ![OpenIMServersonSystempng](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/images/Open-IM-Servers-on-System.png)
-
-#### Deploy using source code
-
-1. Go 1.17 or above.
-2. Clone
-
-```shell
-git clone https://github.com/OpenIMSDK/Open-IM-Server.git --recursive 
-cd cmd/openim-sdk-core
-git checkout main
+```bash
+# choose what you need
+BRANCH=release-v3.0
+git clone -b $BRANCH https://github.com/OpenIMSDK/Open-IM-Server openim && export openim=$(pwd)/openim && cd $openim && make build
 ```
 
-1. Set executable permissions
+2. Modify .env
 
-```shell
-cd ../../scripts/
-chmod +x *.sh
+```bash
+USER=root #no need to modify
+PASSWORD=openIM123  #A combination of 8 or more numbers and letters, this password applies to redis, mysql, mongo, as well as accessSecret in config/config.yaml
+ENDPOINT=http://127.0.0.1:10005 #minio's external service IP and port, or use the domain name storage.xx.xx, the app must be able to access this IP and port or domain,
+API_URL=http://127.0.0.1:10002/object/ #the app must be able to access this IP and port or domain,
+DATA_DIR=./  #designate large disk directory
 ```
 
-1. build
+3. Deploy and start
 
-```shell
-./batch_build_all_service.sh
+> **Note**
+> This command can only be executed once. It will modify the component passwords in docker-compose based on the PASSWORD variable in .env, and modify the component passwords in config/config.yaml. If the password in .env changes, you need to first execute docker-compose down; rm components -rf and then execute this command.
+
+```
+make install
 ```
 
-all services build success
+4. Check the service
 
-### CONFIGURATION INSTRUCTIONS
+```bash
+make check
+```
 
-> Open-IM configuration is divided into basic component configuration and business internal service configuration. Developers need to fill in the address of each component as the address of their server component when using the product, and ensure that the internal service port of the business is not occupied
+![https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/images/docker_build.png](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/images/docker_build.png)
 
-#### Basic Component Configuration Instructions
 
-- ETCD
-    - Etcd is used for the discovery and registration of rpc services, etcd Schema is the prefix of the registered name, it is recommended to modify it to your company name, etcd address (ip+port) supports clustered deployment, you can fill in multiple ETCD addresses separated by commas, and also only one etcd address.
+
+### Compile from source
+
+Ur need `Go 1.18` or higher version, and `make`.
+
+Version Details: https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/version.md
+
+```bash
+# choose what you need
+BRANCH=release-v3.1
+git clone -b $BRANCH https://github.com/OpenIMSDK/Open-IM-Server openim && export openim=$(pwd)/openim && cd $openim && make build
+```
+Read about the [OpenIM Version Policy](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/version.md)
+
+`make help` to help you see the instructions supported by OpenIM.
+
+All services have been successfully built as shown in the figure
+
+![Successful Compilation](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/images/build.png)
+
+### Component Configuration Instructions
+
+The config/config.yaml file has detailed configuration instructions for the storage components.
+
+- Zookeeper
+
+  - Used for RPC service discovery and registration, cluster support.
+
+    ```
+    zookeeper:
+      schema: openim                          #Not recommended to modify
+      address: [ 127.0.0.1:2181 ]             #address
+      username:                               #username
+      password:                               #password
+    ```
+
 - MySQL
-    - mysql is used for full storage of messages and user relationships. Cluster deployment is not supported for the time being. Modify addresses and users, passwords, and database names.
+
+  - Used for storing users, relationships, and groups, supports master-slave database.
+
+    ```
+    mysql:
+      address: [ 127.0.0.1:13306 ]            #address
+      username: root                          #username
+      password: openIM123                     #password
+      database: openIM_v2                     #Not recommended to modify
+      maxOpenConn: 1000                       #maximum connection
+      maxIdleConn: 100                        #maximum idle connection
+      maxLifeTime: 60                         #maximum time a connection can be reused (seconds)
+      logLevel: 4                             #log level 1=slient 2=error 3=warn 4=info
+      slowThreshold: 500                      #slow statement threshold (milliseconds)
+    ```
+
 - Mongo
-    - Mongo is used for offline storage of messages. The default storage is 7 days. Cluster deployment is temporarily not supported. Just modify the address and database name.
+
+  - Used for storing offline messages, supports mongo sharded clusters.
+
+    ```
+    mongo:
+      uri:                                    #Use this value directly if not empty
+      address: [ 127.0.0.1:37017 ]            #address
+      database: openIM                        #default mongo db
+      username: root                          #username
+      password: openIM123                     #password
+      maxPoolSize: 100                        #maximum connections
+    ```
+
 - Redis
-    - Redis is currently mainly used for message serial number storage and user token information storage. Cluster deployment is temporarily not supported. Just modify the corresponding redis address and password.
+
+  - Used for storing message sequence numbers, latest messages, user tokens, and mysql cache, supports cluster deployment.
+
+    ```
+    redis:
+      address: [ 127.0.0.1:16379 ]            #address
+      username:                               #username
+      password: openIM123                     #password
+    ```
+
 - Kafka
-    - Kafka is used as a message transfer storage queue to support cluster deployment, just modify the corresponding address
 
-#### Internal Service Configuration Instructions
+  - Used for message queues, for message decoupling, supports cluster deployment.
 
-- credential&&push
-    - The Open-IM needs to use the three-party offline push function. Currently, Tencent's three-party push is used. It supports IOS, Android and OSX push. This information is some registration information pushed by Tencent. Developers need to go to Tencent Cloud Mobile Push to register the corresponding information. If you do not fill in the corresponding information, you cannot use the offline message push function
-- api&&rpcport&&longconnsvr&&rpcregistername
-    - The api port is the http interface, longconnsvr is the websocket listening port, and rpcport is the internal service startup port. Both support cluster deployment. Make sure that these ports are not used. If you want to open multiple services for a single service, fill in multiple ports separated by commas. rpcregistername is the service name registered by each service to the registry etcd, no need to modify
-- log&&modulename
-    - The log configuration includes the storage path of the log file, and the log is sent to elasticsearch for log viewing. Currently, the log is not supported to be sent to elasticsearch. The configuration does not need to be modified for the time being. The modulename is used to split the log according to the name of the service module. The default configuration is fine.
-- multiloginpolicy&&tokenpolicy
-    - Open-IM supports multi-terminal login. Currently, there are three multi-terminal login policies. The PC terminal and the mobile terminal are online at the same time by default. When multiple policies are configured to be true, the first policy with true is used by default, and the token policy is the generated token policy. , The developer can customize the expiration time of the token
+    ```
+    kafka:
+      username:                               #username
+      password:                               #password
+      addr: [ 127.0.0.1:9092 ]                #address
+      latestMsgToRedis:
+        topic: "latestMsgToRedis"
+      offlineMsgToMongo:
+        topic: "offlineMsgToMongoMysql"
+      msgToPush:
+        topic: "msqToPush"
+      msgToModify:
+        topic: "msgToModify"
+      consumerGroupID:
+        msgToRedis: redis
+        msgToMongo: mongo
+        msgToMySql: mysql
+        msgToPush: push
+        msgToModify: modify
+    ```
 
-### scripts DESCRIPTION
+### Start and Stop Services
 
-> Open-IM scripts provides service compilation, start, and stop scripts. There are four Open-IM scripts start modules, one is the http+rpc service start module, the second is the websocket service start module, then the msg_transfer module, and the last is the push module
+Start services
 
-- path_info.sh&&style_info.sh&&functions.sh
-    - Contains the path information of each module, including the path where the source code is located, the name of the service startup, the shell print font style, and some functions for processing shell strings
-- build_all_service.sh
-    - Compile the module, compile all the source code of Open-IM into a binary file and put it into the bin directory
-- start_rpc_api_service.sh&&msg_gateway_start.sh&&msg_transfer_start.sh&&push_start.sh
-    - Independent scripts startup module, followed by api and rpc modules, message gateway module, message transfer module, and push module
-- start_all.sh&&stop_all.sh
-    - Total scripts, start all services and close all services
+```
+./start_all.sh;
+```
 
-## Authentication Clow Chart 
+Check services
 
-![avatar](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/images/open-im-server.png)
+```
+./check_all.sh
+```
 
-## Architecture
+Stop services
 
-![avatar](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/images/Architecture.jpg)
+```
+./stop_all.sh
+```
+
+### Open IM Ports
+
+| TCP Port  | Description                                                  | Operation                                             |
+| --------- | ------------------------------------------------------------ | ----------------------------------------------------- |
+| TCP:10001 | ws protocol, message port such as message sending, pushing etc, used for client SDK | Port release or nginx reverse proxy, and firewall off |
+| TCP:10002 | api port, such as user, friend, group, message interfaces.   | Port release or nginx reverse proxy, and firewall off |
+| TCP:10005 | Required when choosing minio storage (openIM uses minio storage by default) | Port release or nginx reverse proxy, and firewall off |
+
+### Open Chat Ports
+
+| TCP Port  | Description                                         | Operation                                             |
+| --------- | --------------------------------------------------- | ----------------------------------------------------- |
+| TCP:10008 | Business system, such as registration, login etc    | Port release or nginx reverse proxy, and firewall off |
+| TCP:10009 | Management backend, such as statistics, banning etc | Port release or nginx reverse proxy, and firewall off |
+
+## Relationship Between APP and OpenIM
+
+OpenIM is an open source instant messaging component, it is not an independent product. This image shows the relationship between AppServer, AppClient, Open-IM-Server and Open-IM-SDK.
+
+![https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/open-im-server.png](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/images/open-im-server.png)
+
+## Overall Architecture
+
+![https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/Architecture.jpg](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/images/Architecture.jpg)
 
 ## To start developing OpenIM
 The [community repository](https://github.com/OpenIMSDK/community) hosts all information about building Kubernetes from source, how to contribute code and documentation, who to contact about what, etc.
@@ -182,7 +250,7 @@ We take notes of each [biweekly meeting](https://github.com/OpenIMSDK/Open-IM-Se
 ## Who are using Open-IM-Server
 The [user case studies](https://github.com/OpenIMSDK/community/blob/main/ADOPTERS.md) page includes the user list of the project. You can leave a [📝comment](https://github.com/OpenIMSDK/Open-IM-Server/issues/379) to let us know your use case.
 
-![avatar](https://github.com/OpenIMSDK/OpenIM-Docs/blob/main/docs/images/WechatIMG20.jpeg)
+![avatar](https://openim-1253691595.cos.ap-nanjing.myqcloud.com/WechatIMG20.jpeg)
 
 ## License
 

build/docker/openim-api/Dockerfile

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

build/docker/openim-cmdutils/Dockerfile

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

build/docker/openim-crontask/Dockerfile

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

build/docker/openim-msggateway/Dockerfile

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

build/docker/openim-msgtransfer/Dockerfile

@@ -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.
+
+# OpenIM base image: https://github.com/openim-sigs/openim-base-image
+
+# Set go mod installation source and proxy
+
+FROM golang:1.20 AS builder
+
+ARG GO111MODULE=on
+ARG GOPROXY=https://goproxy.cn,direct
+
+WORKDIR /openim/openim-server
+
+ENV GO111MODULE=$GO111MODULE
+ENV GOPROXY=$GOPROXY
+
+COPY go.mod go.sum ./
+RUN go mod download
+
+COPY . .
+
+RUN make clean
+RUN make build BINS=openim-msgtransfer
+
+FROM ghcr.io/openim-sigs/openim-bash-image:latest
+
+ENV OS ${OS}
+ENV ARCH ${ARCH}
+
+WORKDIR /openim/openim-server
+
+COPY --from=builder /openim/openim-server/_output/bin/platforms /openim/openim-server/_output/bin/platforms
+COPY --from=builder /openim/openim-server/config /openim/openim-server/config
+
+CMD ${OPENIM_SERVER_BINDIR}/platforms/${OS}/${ARCH}/openim-msgtransfer

build/docker/openim-push/Dockerfile

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

build/docker/openim-rpc-auth/Dockerfile

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

build/docker/openim-rpc-conversation/Dockerfile

@@ -0,0 +1,59 @@
+# Copyright © 2023 OpenIM. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# OpenIM base image: https://github.com/openim-sigs/openim-base-image
+
+# Set go mod installation source and proxy
+
+FROM golang:1.20 AS builder
+
+ARG GO111MODULE=on
+ARG GOPROXY=https://goproxy.cn,direct
+
+WORKDIR /openim/openim-server
+
+ENV GO111MODULE=$GO111MODULE
+ENV GOPROXY=$GOPROXY
+
+COPY go.mod go.sum ./
+RUN go mod download
+
+COPY . .
+
+RUN make clean
+
+RUN make build BINS=openim-rpc
+# RUN CGO_ENABLED=0 go build -ldflags="-w -s" -o ./_output/bin/platforms/$(go env GOOS)/$(go env GOARCH)/openim-rpc-conversation ./cmd/openim-rpc/openim-rpc-conversation
+
+RUN rm -rf ./_output/bin/platforms/$(go env GOOS)/$(go env GOARCH)/openim-rpc-friend && \
+    rm -rf ./_output/bin/platforms/$(go env GOOS)/$(go env GOARCH)/openim-rpc-group && \
+    rm -rf ./_output/bin/platforms/$(go env GOOS)/$(go env GOARCH)/openim-rpc-msg && \
+    rm -rf ./_output/bin/platforms/$(go env GOOS)/$(go env GOARCH)/openim-rpc-third && \
+    rm -rf ./_output/bin/platforms/$(go env GOOS)/$(go env GOARCH)/openim-rpc-user && \
+    rm -rf ./_output/bin/platforms/$(go env GOOS)/$(go env GOARCH)/openim-rpc-auth
+
+FROM ghcr.io/openim-sigs/openim-bash-image:latest
+
+WORKDIR /openim/openim-server
+
+ENV OS ${OS}
+ENV ARCH ${ARCH}
+
+COPY --from=builder /openim/openim-server/_output/bin/platforms /openim/openim-server/_output/bin/platforms/
+COPY --from=builder /openim/openim-server/config /openim/openim-server/config
+
+EXPOSE 10230
+EXPOSE 20230
+
+CMD ["sh","-c","${OPENIM_SERVER_BINDIR}/platforms/${OS}/${ARCH}/openim-rpc-conversation --port 10230 --prometheus_port 20230 -c ${SERVER_WORKDIR}/config"]

build/docker/openim-rpc-friend/Dockerfile

@@ -0,0 +1,59 @@
+# Copyright © 2023 OpenIM. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# OpenIM base image: https://github.com/openim-sigs/openim-base-image
+
+# Set go mod installation source and proxy
+
+FROM golang:1.20 AS builder
+
+ARG GO111MODULE=on
+ARG GOPROXY=https://goproxy.cn,direct
+
+WORKDIR /openim/openim-server
+
+ENV GO111MODULE=$GO111MODULE
+ENV GOPROXY=$GOPROXY
+
+COPY go.mod go.sum ./
+RUN go mod download
+
+COPY . .
+
+RUN make clean
+
+RUN make build BINS=openim-rpc
+# RUN CGO_ENABLED=0 go build -ldflags="-w -s" -o ./_output/bin/platforms/$(go env GOOS)/$(go env GOARCH)/openim-rpc-friend ./cmd/openim-rpc/openim-rpc-friend
+
+RUN rm -rf ./_output/bin/platforms/$(go env GOOS)/$(go env GOARCH)/openim-rpc-group && \
+    rm -rf ./_output/bin/platforms/$(go env GOOS)/$(go env GOARCH)/openim-rpc-msg && \
+    rm -rf ./_output/bin/platforms/$(go env GOOS)/$(go env GOARCH)/openim-rpc-third && \
+    rm -rf ./_output/bin/platforms/$(go env GOOS)/$(go env GOARCH)/openim-rpc-user && \
+    rm -rf ./_output/bin/platforms/$(go env GOOS)/$(go env GOARCH)/openim-rpc-conversation && \
+    rm -rf ./_output/bin/platforms/$(go env GOOS)/$(go env GOARCH)/openim-rpc-auth
+
+FROM ghcr.io/openim-sigs/openim-bash-image:latest
+
+WORKDIR /openim/openim-server
+
+ENV OS ${OS}
+ENV ARCH ${ARCH}
+
+COPY --from=builder /openim/openim-server/_output/bin/platforms /openim/openim-server/_output/bin/platforms/
+COPY --from=builder /openim/openim-server/config /openim/openim-server/config
+
+EXPOSE 10120
+EXPOSE 20120
+
+CMD ["sh","-c","${OPENIM_SERVER_BINDIR}/platforms/${OS}/${ARCH}/openim-rpc-friend --port 10120 --prometheus_port 20120 -c ${SERVER_WORKDIR}/config"]

build/docker/openim-rpc-group/Dockerfile

@@ -0,0 +1,59 @@
+# Copyright © 2023 OpenIM. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# OpenIM base image: https://github.com/openim-sigs/openim-base-image
+
+# Set go mod installation source and proxy
+
+FROM golang:1.20 AS builder
+
+ARG GO111MODULE=on
+ARG GOPROXY=https://goproxy.cn,direct
+
+WORKDIR /openim/openim-server
+
+ENV GO111MODULE=$GO111MODULE
+ENV GOPROXY=$GOPROXY
+
+COPY go.mod go.sum ./
+RUN go mod download
+
+COPY . .
+
+RUN make clean
+
+RUN make build BINS=openim-rpc
+# RUN CGO_ENABLED=0 go build -ldflags="-w -s" -o ./_output/bin/platforms/$(go env GOOS)/$(go env GOARCH)/openim-rpc-group ./cmd/openim-rpc/openim-rpc-group
+
+RUN rm -rf ./_output/bin/platforms/$(go env GOOS)/$(go env GOARCH)/openim-rpc-friend && \
+    rm -rf ./_output/bin/platforms/$(go env GOOS)/$(go env GOARCH)/openim-rpc-msg && \
+    rm -rf ./_output/bin/platforms/$(go env GOOS)/$(go env GOARCH)/openim-rpc-third && \
+    rm -rf ./_output/bin/platforms/$(go env GOOS)/$(go env GOARCH)/openim-rpc-user && \
+    rm -rf ./_output/bin/platforms/$(go env GOOS)/$(go env GOARCH)/openim-rpc-conversation && \
+    rm -rf ./_output/bin/platforms/$(go env GOOS)/$(go env GOARCH)/openim-rpc-auth
+
+FROM ghcr.io/openim-sigs/openim-bash-image:latest
+
+WORKDIR /openim/openim-server
+
+ENV OS ${OS}
+ENV ARCH ${ARCH}
+
+COPY --from=builder /openim/openim-server/_output/bin/platforms /openim/openim-server/_output/bin/platforms/
+COPY --from=builder /openim/openim-server/config /openim/openim-server/config
+
+EXPOSE 10150
+EXPOSE 20150
+
+CMD ["sh","-c","${OPENIM_SERVER_BINDIR}/platforms/${OS}/${ARCH}/openim-rpc-group --port 10150 --prometheus_port 20150 -c ${SERVER_WORKDIR}/config"]

build/docker/openim-rpc-msg/Dockerfile

@@ -0,0 +1,59 @@
+# Copyright © 2023 OpenIM. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# OpenIM base image: https://github.com/openim-sigs/openim-base-image
+
+# Set go mod installation source and proxy
+
+FROM golang:1.20 AS builder
+
+ARG GO111MODULE=on
+ARG GOPROXY=https://goproxy.cn,direct
+
+WORKDIR /openim/openim-server
+
+ENV GO111MODULE=$GO111MODULE
+ENV GOPROXY=$GOPROXY
+
+COPY go.mod go.sum ./
+RUN go mod download
+
+COPY . .
+
+RUN make clean
+
+RUN make build BINS=openim-rpc
+# RUN CGO_ENABLED=0 go build -ldflags="-w -s" -o ./_output/bin/platforms/$(go env GOOS)/$(go env GOARCH)/openim-rpc-msg ./cmd/openim-rpc/openim-rpc-msg
+
+RUN rm -rf ./_output/bin/platforms/$(go env GOOS)/$(go env GOARCH)/openim-rpc-friend && \
+    rm -rf ./_output/bin/platforms/$(go env GOOS)/$(go env GOARCH)/openim-rpc-group && \
+    rm -rf ./_output/bin/platforms/$(go env GOOS)/$(go env GOARCH)/openim-rpc-third && \
+    rm -rf ./_output/bin/platforms/$(go env GOOS)/$(go env GOARCH)/openim-rpc-user && \
+    rm -rf ./_output/bin/platforms/$(go env GOOS)/$(go env GOARCH)/openim-rpc-conversation && \
+    rm -rf ./_output/bin/platforms/$(go env GOOS)/$(go env GOARCH)/openim-rpc-auth
+
+FROM ghcr.io/openim-sigs/openim-bash-image:latest
+
+WORKDIR /openim/openim-server
+
+ENV OS ${OS}
+ENV ARCH ${ARCH}
+
+COPY --from=builder /openim/openim-server/_output/bin/platforms /openim/openim-server/_output/bin/platforms/
+COPY --from=builder /openim/openim-server/config /openim/openim-server/config
+
+EXPOSE 10130
+EXPOSE 20130
+
+CMD ["sh","-c","${OPENIM_SERVER_BINDIR}/platforms/${OS}/${ARCH}/openim-rpc-msg --port 10130 --prometheus_port 20130 -c ${SERVER_WORKDIR}/config"]

build/docker/openim-rpc-third/Dockerfile

@@ -0,0 +1,58 @@
+# Copyright © 2023 OpenIM. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# OpenIM base image: https://github.com/openim-sigs/openim-base-image
+
+# Set go mod installation source and proxy
+
+FROM golang:1.20 AS builder
+
+ARG GO111MODULE=on
+ARG GOPROXY=https://goproxy.cn,direct
+
+WORKDIR /openim/openim-server
+
+ENV GO111MODULE=$GO111MODULE
+ENV GOPROXY=$GOPROXY
+
+COPY go.mod go.sum ./
+RUN go mod download
+
+COPY . .
+
+RUN make clean
+
+RUN make build BINS=openim-rpc
+# RUN CGO_ENABLED=0 go build -ldflags="-w -s" -o ./_output/bin/platforms/$(go env GOOS)/$(go env GOARCH)/openim-rpc-third ./cmd/openim-rpc/openim-rpc-third
+
+RUN rm -rf ./_output/bin/platforms/$(go env GOOS)/$(go env GOARCH)/openim-rpc-friend && \
+    rm -rf ./_output/bin/platforms/$(go env GOOS)/$(go env GOARCH)/openim-rpc-group && \
+    rm -rf ./_output/bin/platforms/$(go env GOOS)/$(go env GOARCH)/openim-rpc-msg && \
+    rm -rf ./_output/bin/platforms/$(go env GOOS)/$(go env GOARCH)/openim-rpc-user && \
+    rm -rf ./_output/bin/platforms/$(go env GOOS)/$(go env GOARCH)/openim-rpc-conversation && \
+    rm -rf ./_output/bin/platforms/$(go env GOOS)/$(go env GOARCH)/openim-rpc-auth
+
+FROM ghcr.io/openim-sigs/openim-bash-image:latest
+
+WORKDIR /openim/openim-server
+
+ENV OS ${OS}
+ENV ARCH ${ARCH}
+
+COPY --from=builder /openim/openim-server/_output/bin/platforms /openim/openim-server/_output/bin/platforms/
+COPY --from=builder /openim/openim-server/config /openim/openim-server/config
+
+EXPOSE 10200
+
+CMD ["sh","-c","${OPENIM_SERVER_BINDIR}/platforms/${OS}/${ARCH}/openim-rpc-third --port 10200 -c ${SERVER_WORKDIR}/config"]

build/docker/openim-rpc-user/Dockerfile

@@ -0,0 +1,58 @@
+# Copyright © 2023 OpenIM. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# OpenIM base image: https://github.com/openim-sigs/openim-base-image
+
+# Set go mod installation source and proxy
+
+FROM golang:1.20 AS builder
+
+ARG GO111MODULE=on
+ARG GOPROXY=https://goproxy.cn,direct
+
+WORKDIR /openim/openim-server
+
+ENV GO111MODULE=$GO111MODULE
+ENV GOPROXY=$GOPROXY
+
+COPY go.mod go.sum ./
+RUN go mod download
+
+COPY . .
+
+RUN make clean
+
+RUN make build BINS=openim-rpc
+# RUN CGO_ENABLED=0 go build -ldflags="-w -s" -o ./_output/bin/platforms/$(go env GOOS)/$(go env GOARCH)/openim-rpc-user ./cmd/openim-rpc/openim-rpc-user
+
+RUN rm -rf ./_output/bin/platforms/$(go env GOOS)/$(go env GOARCH)/openim-rpc-friend && \
+    rm -rf ./_output/bin/platforms/$(go env GOOS)/$(go env GOARCH)/openim-rpc-group && \
+    rm -rf ./_output/bin/platforms/$(go env GOOS)/$(go env GOARCH)/openim-rpc-msg && \
+    rm -rf ./_output/bin/platforms/$(go env GOOS)/$(go env GOARCH)/openim-rpc-third && \
+    rm -rf ./_output/bin/platforms/$(go env GOOS)/$(go env GOARCH)/openim-rpc-conversation && \
+    rm -rf ./_output/bin/platforms/$(go env GOOS)/$(go env GOARCH)/openim-rpc-auth
+
+FROM ghcr.io/openim-sigs/openim-bash-image:latest
+
+WORKDIR /openim/openim-server
+
+ENV OS ${OS}
+ENV ARCH ${ARCH}
+
+COPY --from=builder /openim/openim-server/_output/bin/platforms /openim/openim-server/_output/bin/platforms/
+COPY --from=builder /openim/openim-server/config /openim/openim-server/config
+
+EXPOSE 10110
+
+CMD ["sh","-c","${OPENIM_SERVER_BINDIR}/platforms/${OS}/${ARCH}/openim-rpc-user --port 10110 -c ${SERVER_WORKDIR}/config"]

cmd/openim-api/Makefile

@@ -1,34 +0,0 @@
-.PHONY: all build run gotool install clean help
-
-NAME=openim-api
-BIN_DIR=../../bin/
-
-OS:= $(or $(os),linux)
-ARCH:=$(or $(arch),amd64)
-all: gotool build
-
-ifeq ($(OS),windows)
-
-BINARY_NAME=${NAME}.exe
-
-else
-
-BINARY_NAME=${NAME}
-
-endif
-
-build:
-	CGO_ENABLED=0 GOOS=${OS} GOARCH=${ARCH}; go build -ldflags="-w -s" -o ${BINARY_NAME}
-
-run:
-	@go run ./
-
-gotool:
-	go fmt ./
-	go vet ./
-
-install:build
-	mv ${BINARY_NAME} ${BIN_DIR}
-
-clean:
-	@if [ -f ${BINARY_NAME} ] ; then rm ${BINARY_NAME} ; fi

cmd/openim-api/deploy.Dockerfile

@@ -14,7 +14,7 @@
 
 FROM ubuntu
 
-WORKDIR /Open-IM-Server/bin
+WORKDIR /openim/openim-server/bin
 
 RUN apt-get update && apt-get install apt-transport-https && apt-get install procps\
 &&apt-get install net-tools
@@ -27,6 +27,6 @@ RUN apt-get -qq update \
     && apt-get -qq install -y --no-install-recommends ca-certificates curl
 COPY ./openim-api ./
 
-VOLUME ["/Open-IM-Server/logs","/Open-IM-Server/config"]
+VOLUME ["/openim/openim-server/logs","/openim/openim-server/config"]
 
 CMD ["./openim-api","--port", "10002"]

cmd/openim-api/main.go

@@ -18,22 +18,23 @@ import (
 	"context"
 	"fmt"
 	"net"
+	"net/http"
 	"os"
 	"runtime"
 	"strconv"
 	"time"
 
-	"net/http"
 	_ "net/http/pprof"
 
+	"github.com/OpenIMSDK/protocol/constant"
+	"github.com/OpenIMSDK/tools/discoveryregistry"
+	openKeeper "github.com/OpenIMSDK/tools/discoveryregistry/zookeeper"
+	"github.com/OpenIMSDK/tools/log"
+
 	"github.com/OpenIMSDK/Open-IM-Server/internal/api"
 	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/cmd"
 	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/config"
-	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/constant"
 	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/db/cache"
-	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/log"
-	"github.com/OpenIMSDK/Open-IM-Server/pkg/discoveryregistry"
-	openKeeper "github.com/OpenIMSDK/Open-IM-Server/pkg/discoveryregistry/zookeeper"
 )
 
 func main() {
@@ -73,12 +74,11 @@ func run(port int) error {
 	if err != nil {
 		return err
 	}
-	if err := client.CreateRpcRootNodes(config.GetServiceNames()); err != nil {
+	if err := client.CreateRpcRootNodes(config.Config.GetServiceNames()); err != nil {
 		return err
 	}
-	fmt.Println("api init discov client success")
 	fmt.Println("api register public config to discov")
-	if err := client.RegisterConf2Registry(constant.OpenIMCommonConfigKey, config.EncodeConfig()); err != nil {
+	if err := client.RegisterConf2Registry(constant.OpenIMCommonConfigKey, config.Config.EncodeConfig()); err != nil {
 		return err
 	}
 	fmt.Println("api register public config to discov success")

cmd/openim-cmdutils/Makefile

@@ -1,34 +0,0 @@
-.PHONY: all build run gotool install clean help
-
-NAME=openim-cmdutils
-BIN_DIR=../../bin/
-
-OS:= $(or $(os),linux)
-ARCH:=$(or $(arch),amd64)
-all: gotool build
-
-ifeq ($(OS),windows)
-
-BINARY_NAME=${NAME}.exe
-
-else
-
-BINARY_NAME=${NAME}
-
-endif
-
-build:
-	CGO_ENABLED=0 GOOS=${OS} GOARCH=${ARCH}; go build -ldflags="-w -s" -o ${BINARY_NAME}
-
-run:
-	@go run ./
-
-gotool:
-	go fmt ./
-	go vet ./
-
-install:build
-	mv ${BINARY_NAME} ${BIN_DIR}
-
-clean:
-	@if [ -f ${BINARY_NAME} ] ; then rm ${BINARY_NAME} ; fi

cmd/openim-crontask/Makefile

@@ -1,34 +0,0 @@
-.PHONY: all build run gotool install clean help
-
-NAME=openim-crontask
-BIN_DIR=../../bin/
-
-OS:= $(or $(os),linux)
-ARCH:=$(or $(arch),amd64)
-all: gotool build
-
-ifeq ($(OS),windows)
-
-BINARY_NAME=${NAME}.exe
-
-else
-
-BINARY_NAME=${NAME}
-
-endif
-
-build:
-	CGO_ENABLED=0 GOOS=${OS} GOARCH=${ARCH}; go build -ldflags="-w -s" -o ${BINARY_NAME}
-
-run:
-	@go run ./
-
-gotool:
-	go fmt ./
-	go vet ./
-
-install:build
-	mv ${BINARY_NAME} ${BIN_DIR}
-
-clean:
-	@if [ -f ${BINARY_NAME} ] ; then rm ${BINARY_NAME} ; fi

cmd/openim-crontask/deploy.Dockerfile

@@ -14,7 +14,7 @@
 
 FROM ubuntu
 
-WORKDIR /Open-IM-Server/bin
+WORKDIR /openim/openim-server/bin
 
 RUN apt-get update && apt-get install apt-transport-https && apt-get install procps\
 &&apt-get install net-tools
@@ -27,6 +27,6 @@ RUN apt-get -qq update \
     && apt-get -qq install -y --no-install-recommends ca-certificates curl
 COPY ./openim-crontask ./
 
-VOLUME ["/Open-IM-Server/logs","/Open-IM-Server/config"]
+VOLUME ["/openim/openim-server/logs","/openim/openim-server/config"]
 
 CMD ["./openim-crontask"]

cmd/openim-msggateway/Makefile

@@ -1,34 +0,0 @@
-.PHONY: all build run gotool install clean help
-
-NAME=openim-rpc-msg_gateway
-BIN_DIR=../../bin/
-
-OS:= $(or $(os),linux)
-ARCH:=$(or $(arch),amd64)
-all: gotool build
-
-ifeq ($(OS),windows)
-
-BINARY_NAME=${NAME}.exe
-
-else
-
-BINARY_NAME=${NAME}
-
-endif
-
-build:
-	CGO_ENABLED=0 GOOS=${OS} GOARCH=${ARCH}; go build -ldflags="-w -s" -o ${BINARY_NAME}
-
-run:
-	@go run ./
-
-gotool:
-	go fmt ./
-	go vet ./
-
-install:build
-	mv ${BINARY_NAME} ${BIN_DIR}
-
-clean:
-	@if [ -f ${BINARY_NAME} ] ; then rm ${BINARY_NAME} ; fi

cmd/openim-msggateway/deploy.Dockerfile

@@ -14,7 +14,7 @@
 
 FROM ubuntu
 
-WORKDIR /Open-IM-Server/bin
+WORKDIR /openim/openim-server/bin
 
 RUN apt-get update && apt-get install apt-transport-https && apt-get install procps\
 &&apt-get install net-tools
@@ -27,6 +27,6 @@ RUN apt-get -qq update \
     && apt-get -qq install -y --no-install-recommends ca-certificates curl
 COPY ./openim-rpc-msg_gateway ./
 
-VOLUME ["/Open-IM-Server/logs","/Open-IM-Server/config"]
+VOLUME ["/openim/openim-server/logs","/openim/openim-server/config"]
 
 CMD ["./openim-rpc-msg_gateway","--port", "10140" "--ws_port", "10001", "--prometheus_port", "20240"]

cmd/openim-msgtransfer/Makefile

@@ -1,34 +0,0 @@
-.PHONY: all build run gotool install clean help
-
-NAME=openim-msgtransfer
-BIN_DIR=../../bin/
-
-OS:= $(or $(os),linux)
-ARCH:=$(or $(arch),amd64)
-all: gotool build
-
-ifeq ($(OS),windows)
-
-BINARY_NAME=${NAME}.exe
-
-else
-
-BINARY_NAME=${NAME}
-
-endif
-
-build:
-	CGO_ENABLED=0 GOOS=${OS} GOARCH=${ARCH}; go build -ldflags="-w -s" -o ${BINARY_NAME}
-
-run:
-	@go run ./
-
-gotool:
-	go fmt ./
-	go vet ./
-
-install:build
-	mv ${BINARY_NAME} ${BIN_DIR}
-
-clean:
-	@if [ -f ${BINARY_NAME} ] ; then rm ${BINARY_NAME} ; fi

cmd/openim-msgtransfer/deploy.Dockerfile

@@ -14,7 +14,7 @@
 
 FROM ubuntu
 
-WORKDIR /Open-IM-Server/bin
+WORKDIR /openim/openim-server/bin
 
 RUN apt-get update && apt-get install apt-transport-https && apt-get install procps\
 &&apt-get install net-tools
@@ -27,6 +27,6 @@ RUN apt-get -qq update \
     && apt-get -qq install -y --no-install-recommends ca-certificates curl
 COPY ./openim-msgtransfer ./
 
-VOLUME ["/Open-IM-Server/logs","/Open-IM-Server/config"]
+VOLUME ["/openim/openim-server/logs","/openim/openim-server/config"]
 
 CMD ["./openim-msgtransfer","--prometheus_port", "21400"]

cmd/openim-msgtransfer/main.go

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

cmd/openim-push/Makefile

@@ -1,34 +0,0 @@
-.PHONY: all build run gotool install clean help
-
-NAME=openim-push
-BIN_DIR=../../bin/
-
-OS:= $(or $(os),linux)
-ARCH:=$(or $(arch),amd64)
-all: gotool build
-
-ifeq ($(OS),windows)
-
-BINARY_NAME=${NAME}.exe
-
-else
-
-BINARY_NAME=${NAME}
-
-endif
-
-build:
-	CGO_ENABLED=0 GOOS=${OS} GOARCH=${ARCH}; go build -ldflags="-w -s" -o ${BINARY_NAME}
-
-run:
-	@go run ./
-
-gotool:
-	go fmt ./
-	go vet ./
-
-install:build
-	mv ${BINARY_NAME} ${BIN_DIR}
-
-clean:
-	@if [ -f ${BINARY_NAME} ] ; then rm ${BINARY_NAME} ; fi

cmd/openim-push/deploy.Dockerfile

@@ -14,7 +14,7 @@
 
 FROM ubuntu
 
-WORKDIR /Open-IM-Server/bin
+WORKDIR /openim/openim-server/bin
 
 RUN apt-get update && apt-get install apt-transport-https && apt-get install procps\
 &&apt-get install net-tools
@@ -27,6 +27,6 @@ RUN apt-get -qq update \
     && apt-get -qq install -y --no-install-recommends ca-certificates curl
 COPY ./openim-push ./
 
-VOLUME ["/Open-IM-Server/logs","/Open-IM-Server/config"]
+VOLUME ["/openim/openim-server/logs","/openim/openim-server/config"]
 
 CMD ["./openim-push", "--port", "10170", "--prometheus_port", "20170"]

cmd/openim-rpc/openim-rpc-auth/Makefile

@@ -1,34 +0,0 @@
-.PHONY: all build run gotool install clean help
-
-NAME=openim-rpc-auth
-BIN_DIR=../../../bin/
-
-OS:= $(or $(os),linux)
-ARCH:=$(or $(arch),amd64)
-all: gotool build
-
-ifeq ($(OS),windows)
-
-BINARY_NAME=${NAME}.exe
-
-else
-
-BINARY_NAME=${NAME}
-
-endif
-
-build:
-	CGO_ENABLED=0 GOOS=${OS} GOARCH=${ARCH}; go build -ldflags="-w -s" -o ${BINARY_NAME}
-
-run:
-	@go run ./
-
-gotool:
-	go fmt ./
-	go vet ./
-
-install:build
-	mv ${BINARY_NAME} ${BIN_DIR}
-
-clean:
-	@if [ -f ${BINARY_NAME} ] ; then rm ${BINARY_NAME} ; fi

cmd/openim-rpc/openim-rpc-auth/deploy.Dockerfile

@@ -14,7 +14,7 @@
 
 FROM ubuntu
 
-WORKDIR /Open-IM-Server/bin
+WORKDIR /openim/openim-server/bin
 
 RUN apt-get update && apt-get install apt-transport-https && apt-get install procps\
 &&apt-get install net-tools
@@ -27,6 +27,6 @@ RUN apt-get -qq update \
     && apt-get -qq install -y --no-install-recommends ca-certificates curl
 COPY ./openim-rpc-auth ./
 
-VOLUME ["/Open-IM-Server/logs","/Open-IM-Server/config"]
+VOLUME ["/openim/openim-server/logs","/openim/openim-server/config"]
 
 CMD ["./openim-rpc-auth", "--port", "10160"]

cmd/openim-rpc/openim-rpc-conversation/Makefile

@@ -1,34 +0,0 @@
-.PHONY: all build run gotool install clean help
-
-NAME=openim-rpc-conversation
-BIN_DIR=../../../bin/
-
-OS:= $(or $(os),linux)
-ARCH:=$(or $(arch),amd64)
-all: gotool build
-
-ifeq ($(OS),windows)
-
-BINARY_NAME=${NAME}.exe
-
-else
-
-BINARY_NAME=${NAME}
-
-endif
-
-build:
-	CGO_ENABLED=0 GOOS=${OS} GOARCH=${ARCH}; go build -ldflags="-w -s" -o ${BINARY_NAME}
-
-run:
-	@go run ./
-
-gotool:
-	go fmt ./
-	go vet ./
-
-install:build
-	mv ${BINARY_NAME} ${BIN_DIR}
-
-clean:
-	@if [ -f ${BINARY_NAME} ] ; then rm ${BINARY_NAME} ; fi

cmd/openim-rpc/openim-rpc-conversation/deploy.Dockerfile

@@ -14,7 +14,7 @@
 
 FROM ubuntu
 
-WORKDIR /Open-IM-Server/bin
+WORKDIR /openim/openim-server/bin
 
 RUN apt-get update && apt-get install apt-transport-https && apt-get install procps\
 &&apt-get install net-tools
@@ -27,6 +27,6 @@ RUN apt-get -qq update \
     && apt-get -qq install -y --no-install-recommends ca-certificates curl
 COPY ./openim-rpc-conversation ./
 
-VOLUME ["/Open-IM-Server/logs","/Open-IM-Server/config"]
+VOLUME ["/openim/openim-server/logs","/openim/openim-server/config"]
 
 CMD ["./openim-rpc-conversation", "--port", "10230", "--prometheus_port","20230"]

cmd/openim-rpc/openim-rpc-friend/Makefile

@@ -1,34 +0,0 @@
-.PHONY: all build run gotool install clean help
-
-NAME=openim-rpc-friend
-BIN_DIR=../../../bin/
-
-OS:= $(or $(os),linux)
-ARCH:=$(or $(arch),amd64)
-all: gotool build
-
-ifeq ($(OS),windows)
-
-BINARY_NAME=${NAME}.exe
-
-else
-
-BINARY_NAME=${NAME}
-
-endif
-
-build:
-	CGO_ENABLED=0 GOOS=${OS} GOARCH=${ARCH}; go build -ldflags="-w -s" -o ${BINARY_NAME}
-
-run:
-	@go run ./
-
-gotool:
-	go fmt ./
-	go vet ./
-
-install:build
-	mv ${BINARY_NAME} ${BIN_DIR}
-
-clean:
-	@if [ -f ${BINARY_NAME} ] ; then rm ${BINARY_NAME} ; fi

cmd/openim-rpc/openim-rpc-friend/deploy.Dockerfile

@@ -14,7 +14,7 @@
 
 FROM ubuntu
 
-WORKDIR /Open-IM-Server/bin
+WORKDIR /openim/openim-server/bin
 
 RUN apt-get update && apt-get install apt-transport-https && apt-get install procps\
 &&apt-get install net-tools
@@ -27,6 +27,6 @@ RUN apt-get -qq update \
     && apt-get -qq install -y --no-install-recommends ca-certificates curl
 COPY ./openim-rpc-friend ./
 
-VOLUME ["/Open-IM-Server/logs","/Open-IM-Server/config"]
+VOLUME ["/openim/openim-server/logs","/openim/openim-server/config"]
 
 CMD ["./openim-rpc-friend", "--port", "10120", "--prometheus_port","20120"]

cmd/openim-rpc/openim-rpc-group/Makefile

@@ -1,34 +0,0 @@
-.PHONY: all build run gotool install clean help
-
-NAME=openim-rpc-group
-BIN_DIR=../../../bin/
-
-OS:= $(or $(os),linux)
-ARCH:=$(or $(arch),amd64)
-all: gotool build
-
-ifeq ($(OS),windows)
-
-BINARY_NAME=${NAME}.exe
-
-else
-
-BINARY_NAME=${NAME}
-
-endif
-
-build:
-	CGO_ENABLED=0 GOOS=${OS} GOARCH=${ARCH}; go build -ldflags="-w -s" -o ${BINARY_NAME}
-
-run:
-	@go run ./
-
-gotool:
-	go fmt ./
-	go vet ./
-
-install:build
-	mv ${BINARY_NAME} ${BIN_DIR}
-
-clean:
-	@if [ -f ${BINARY_NAME} ] ; then rm ${BINARY_NAME} ; fi

cmd/openim-rpc/openim-rpc-group/deploy.Dockerfile

@@ -14,7 +14,7 @@
 
 FROM ubuntu
 
-WORKDIR /Open-IM-Server/bin
+WORKDIR /openim/openim-server/bin
 
 RUN apt-get update && apt-get install apt-transport-https && apt-get install procps\
 &&apt-get install net-tools
@@ -27,6 +27,6 @@ RUN apt-get -qq update \
     && apt-get -qq install -y --no-install-recommends ca-certificates curl
 COPY ./openim-rpc-group ./
 
-VOLUME ["/Open-IM-Server/logs","/Open-IM-Server/config"]
+VOLUME ["/openim/openim-server/logs","/openim/openim-server/config"]
 
 CMD ["./openim-rpc-group", "--port", "10150", "--prometheus_port","20150"]

cmd/openim-rpc/openim-rpc-msg/Makefile

@@ -1,34 +0,0 @@
-.PHONY: all build run gotool install clean help
-
-NAME=openim-rpc-msg
-BIN_DIR=../../../bin/
-
-OS:= $(or $(os),linux)
-ARCH:=$(or $(arch),amd64)
-all: gotool build
-
-ifeq ($(OS),windows)
-
-BINARY_NAME=${NAME}.exe
-
-else
-
-BINARY_NAME=${NAME}
-
-endif
-
-build:
-	CGO_ENABLED=0 GOOS=${OS} GOARCH=${ARCH}; go build -ldflags="-w -s" -o ${BINARY_NAME}
-
-run:
-	@go run ./
-
-gotool:
-	go fmt ./
-	go vet ./
-
-install:build
-	mv ${BINARY_NAME} ${BIN_DIR}
-
-clean:
-	@if [ -f ${BINARY_NAME} ] ; then rm ${BINARY_NAME} ; fi

cmd/openim-rpc/openim-rpc-msg/deploy.Dockerfile

@@ -14,7 +14,7 @@
 
 FROM ubuntu
 
-WORKDIR /Open-IM-Server/bin
+WORKDIR /openim/openim-server/bin
 
 RUN apt-get update && apt-get install apt-transport-https && apt-get install procps\
 &&apt-get install net-tools
@@ -27,6 +27,6 @@ RUN apt-get -qq update \
     && apt-get -qq install -y --no-install-recommends ca-certificates curl
 COPY ./openim-rpc-msg ./
 
-VOLUME ["/Open-IM-Server/logs","/Open-IM-Server/config"]
+VOLUME ["/openim/openim-server/logs","/openim/openim-server/config"]
 
 CMD ["./openim-rpc-msg", "--port", "10130", "--prometheus_port","20130"]

cmd/openim-rpc/openim-rpc-third/Makefile

@@ -1,34 +0,0 @@
-.PHONY: all build run gotool install clean help
-
-NAME=openim-rpc-third
-BIN_DIR=../../../bin/
-
-OS:= $(or $(os),linux)
-ARCH:=$(or $(arch),amd64)
-all: gotool build
-
-ifeq ($(OS),windows)
-
-BINARY_NAME=${NAME}.exe
-
-else
-
-BINARY_NAME=${NAME}
-
-endif
-
-build:
-	CGO_ENABLED=0 GOOS=${OS} GOARCH=${ARCH}; go build -ldflags="-w -s" -o ${BINARY_NAME}
-
-run:
-	@go run ./
-
-gotool:
-	go fmt ./
-	go vet ./
-
-install:build
-	mv ${BINARY_NAME} ${BIN_DIR}
-
-clean:
-	@if [ -f ${BINARY_NAME} ] ; then rm ${BINARY_NAME} ; fi

cmd/openim-rpc/openim-rpc-third/deploy.Dockerfile

@@ -14,7 +14,7 @@
 
 FROM ubuntu
 
-WORKDIR /Open-IM-Server/bin
+WORKDIR /openim/openim-server/bin
 
 RUN apt-get update && apt-get install apt-transport-https && apt-get install procps\
 &&apt-get install net-tools
@@ -27,6 +27,6 @@ RUN apt-get -qq update \
     && apt-get -qq install -y --no-install-recommends ca-certificates curl
 COPY ./openim-rpc-third ./
 
-VOLUME ["/Open-IM-Server/logs","/Open-IM-Server/config"]
+VOLUME ["/openim/openim-server/logs","/openim/openim-server/config"]
 
 CMD ["./openim-rpc-third", "--port", "10200"]

cmd/openim-rpc/openim-rpc-user/Makefile

@@ -1,34 +0,0 @@
-.PHONY: all build run gotool install clean help
-
-NAME=openim-rpc-user
-BIN_DIR=../../../bin/
-
-OS:= $(or $(os),linux)
-ARCH:=$(or $(arch),amd64)
-all: gotool build
-
-ifeq ($(OS),windows)
-
-BINARY_NAME=${NAME}.exe
-
-else
-
-BINARY_NAME=${NAME}
-
-endif
-
-build:
-	CGO_ENABLED=0 GOOS=${OS} GOARCH=${ARCH}; go build -ldflags="-w -s" -o ${BINARY_NAME}
-
-run:
-	@go run ./
-
-gotool:
-	go fmt ./
-	go vet ./
-
-install:build
-	mv ${BINARY_NAME} ${BIN_DIR}
-
-clean:
-	@if [ -f ${BINARY_NAME} ] ; then rm ${BINARY_NAME} ; fi

cmd/openim-rpc/openim-rpc-user/deploy.Dockerfile

@@ -14,7 +14,7 @@
 
 FROM ubuntu
 
-WORKDIR /Open-IM-Server/bin
+WORKDIR /openim/openim-server/bin
 
 RUN apt-get update && apt-get install apt-transport-https && apt-get install procps\
 &&apt-get install net-tools
@@ -27,6 +27,6 @@ RUN apt-get -qq update \
     && apt-get -qq install -y --no-install-recommends ca-certificates curl
 COPY ./openim-rpc-user ./
 
-VOLUME ["/Open-IM-Server/logs","/Open-IM-Server/config"]
+VOLUME ["/openim/openim-server/logs","/openim/openim-server/config"]
 
 CMD ["./openim-rpc-user", "--port", "10110"]

config/config.yaml

@@ -12,89 +12,145 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-#OpenIM config
+# -----------------------------------------------------------------
+# Infrastructural configurations, please modify based on your setup
+# -----------------------------------------------------------------
 
-
-#---------------Infrastructure configuration---------------------#
+###################### Zookeeper ######################
+# Zookeeper configuration
+# It's not recommended to modify the schema
+# 
+# Zookeeper address
+# Zookeeper username
+# Zookeeper password
 zookeeper:
-  schema: openim                          #不建议修改
-  address: [ 127.0.0.1:2181 ]             #
-  username:                               #用户名
-  password:                               #密码
+  schema: openim                          
+  address: [ 127.0.0.1:2181 ]            
+  username:                               
+  password:   
 
+###################### Mysql ######################
+# MySQL configuration
+# Currently, only single machine setup is supported
+#
+# Maximum number of open connections
+# Maximum number of idle connections
+# Maximum lifetime in seconds a connection can be reused
+# Log level: 1=slient, 2=error, 3=warn, 4=info
+# Slow query threshold in milliseconds
 mysql:
-  address: [ 127.0.0.1:13306 ]            #目前仅支持单机
-  username: root                          #用户名
-  password: openIM123                     #密码
-  database: openIM_v3                     #不建议修改
-  maxOpenConn: 1000                       #最大连接数
-  maxIdleConn: 100                        #最大空闲连接数
-  maxLifeTime: 60                         #连接可以重复使用的最长时间（秒）
-  logLevel: 4                             #日志级别 1=slient 2=error 3=warn 4=info
-  slowThreshold: 500                      #慢语句阈值 （毫秒）
+  address: [ 127.0.0.1:13306 ]
+  username: root
+  password: openIM123
+  database: openIM_v3                     
+  maxOpenConn: 1000                       
+  maxIdleConn: 100                        
+  maxLifeTime: 60                         
+  logLevel: 4                             
+  slowThreshold: 500    
 
+###################### Mongo ######################
+# MongoDB configuration
+# If uri is not empty, it will be used directly
+#
+# MongoDB address for standalone setup, Mongos address for sharded cluster setup
+# Default MongoDB database name
+# Maximum connection pool size
 mongo:
-  uri:                                    #不为空则直接使用该值
-  address: [ 127.0.0.1:37017 ]            #单机时为mongo地址，使用分片集群时，为mongos地址
-  database: openIM_v3                      #mongo db 默认即可
-  username: root                          #用户名
-  password: openIM123                     #密码
-  maxPoolSize: 100
+  uri:
+  address: [ 127.0.0.1:37017 ]
+  database: openIM_v3
+  username: root
+  password: openIM123
+  maxPoolSize: 100  
 
+###################### Redis ######################
+# Redis configuration
+#
+# Username is required only for Redis version 6.0+
 redis:
-  address: [ 127.0.0.1:16379 ]            #
-  username:                               #only redis version 6.0+ need username
-  password: openIM123                     #密码
+  address: [ 127.0.0.1:16379 ]
+  username:                               
+  password: openIM123
 
+###################### Kafka ######################
+# 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: [ 127.0.0.1:9092 ]                #
+  username:                               
+  password:                               
+  addr: [ 127.0.0.1:9092 ]
   latestMsgToRedis:
-    topic: "latestMsgToRedis"             #不建议修改
+    topic: "latestMsgToRedis"             
   offlineMsgToMongo:
-    topic: "offlineMsgToMongoMysql"       #不建议修改
+    topic: "offlineMsgToMongoMysql"       
   msgToPush:
-    topic: "msgToPush"                    #不建议修改
-  consumerGroupID: #消费者组，不建议修改
-    msgToRedis: redis                     #
-    msgToMongo: mongo                     #
-    msgToMySql: mysql                     #
-    msgToPush: push                       #
-
+    topic: "msgToPush"
+  consumerGroupID:
+    msgToRedis: redis
+    msgToMongo: mongo
+    msgToMySql: mysql
+    msgToPush: push
 
+###################### RPC ######################
+# 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:                             #作为rpc启动时，注册到zookeeper的IP，api/gateway能访问到此ip和对应的rpcPort中的端口
-  listenIP:                               #默认为0.0.0.0
-
+  registerIP:
+  listenIP: 0.0.0.0
 
+###################### API ######################
+# API configuration
+#
+# API service port
+# Default listen IP is 0.0.0.0
 api:
-  openImApiPort: [ 10002 ]                #api服务端口
-  listenIP:                               #默认为0.0.0.0
+  openImApiPort: [ 10002 ]                
+  listenIP: 0.0.0.0    
 
+###################### Gateway ######################
+# 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
 object:
-  enable: "minio"                           #使用minio
-  apiURL: "http://127.0.0.1:10002/object/"
+  enable: "minio"                         
+  apiURL: http://127.0.0.1:10002/object/
   minio:
-    bucket: "openim"                      #不建议修改
-    endpoint: "http://127.0.0.1:10005"      #minio对外服务的ip和端口，app要能访问此ip和端口
-    accessKeyID: "root"                     #ID
-    secretAccessKey: "openIM123"            #秘钥
-    sessionToken: ""            #token
-  cos: #tencent cos
+    bucket: "openim"                      
+    endpoint: http://127.0.0.1:10005
+    accessKeyID: root
+    secretAccessKey: openIM123
+    sessionToken: ""                      
+  cos:                                    
     bucketURL: "https://temp-1252357374.cos.ap-chengdu.myqcloud.com"
     secretID: ""
     secretKey: ""
     sessionToken: ""
-  oss: #ali oss
+  oss:                                    
     endpoint: "https://oss-cn-chengdu.aliyuncs.com"
     bucket: "demo-9999999"
     bucketURL: "https://demo-9999999.oss-cn-chengdu.aliyuncs.com"
-    accessKeyID: ""
+    accessKeyID: root
     accessKeySecret: ""
     sessionToken: ""
 
-rpcPort: #rpc服务端口，不建议修改，端口由脚本读取后传入程序，如启动多个程序，只需要填入多个端口，用逗号隔开，如  [10110, 10111]
+# 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 ]
@@ -105,7 +161,8 @@ rpcPort: #rpc服务端口，不建议修改，端口由脚本读取后传入程
   openImConversationPort: [ 10180 ]
   openImThirdPort: [ 10190 ]
 
-rpcRegisterName: #rpc注册服务名，不建议修改
+# RPC service names for registration, it's not recommended to modify these
+rpcRegisterName:
   openImUserName: User
   openImFriendName: Friend
   openImMsgName: Msg
@@ -116,78 +173,132 @@ rpcRegisterName: #rpc注册服务名，不建议修改
   openImConversationName: Conversation
   openImThirdName: Third
 
+# 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: ../logs/           #存放目录
-  rotationTime: 24                    #日志旋转时间
-  remainRotationCount: 2              #日志数量
-  remainLogLevel: 6                   #日志级别 6表示全都打印，
-  isStdout: false
-  isJson: false
+  storageLocation: ../../../../../logs/  
+  rotationTime: 24                        
+  remainRotationCount: 2                  
+  remainLogLevel: 6                       
+  isStdout: false                         
+  isJson: false                           
   withStack: false
 
+# 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 ]             #msg_gateway的websocket端口
-  websocketMaxConnNum: 100000         #websocket最大连接数
-  websocketMaxMsgLen: 4096            #websocket请求包最大长度
-  websocketTimeout: 10                #websocket连接握手超时时间
+  openImWsPort: [ 10001 ]                 
+  websocketMaxConnNum: 100000             
+  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: #个推离线推送
+  geTui:
     pushUrl: "https://restapi.getui.com/v2/$appId"
     masterSecret: ""
     appKey: ""
     intent: ""
     channelID: ""
     channelName: ""
-  fcm: #fcm离线推送
-    serviceAccount: "x.json"          #帐号文件，并放在 config目录下
-  jpns: #极光推送 在极光后台申请后，修改以下四项
+  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" ]   #内置的app管理员userID
-  nickname: [ "system1","system2", "system3" ]              #内置的app管理员nickname
+  userID: [ "openIM123456","openIM654321","openIMAdmin" ]
+  nickname: [ "system1","system2", "system3" ]
 
+# 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
 
-multiLoginPolicy: 1                                     #多平台登录：Android、iOS、Windows、Mac、web 每种平台只能有一个在线
+# Whether to enable read receipts for group chat
+groupMessageHasReadReceiptEnable: true
 
+# Whether to enable read receipts for single chat
+singleMessageHasReadReceiptEnable: true
 
-chatPersistenceMysql: true                              #消息是否存入mysql，mysql中的消息仅用于管理后台使用
-msgCacheTimeout: 86400                                  #信消息缓存时间秒，不建议修改
-groupMessageHasReadReceiptEnable: true                  #群聊已读是否开启
-singleMessageHasReadReceiptEnable: true                 #单聊已读是否开启
+# MongoDB offline message retention period in days
+retainChatRecords: 365
 
-retainChatRecords: 365                                  #mongo保存离线消息时间（天）
-chatRecordsClearTime: "0 2 * * 3"                       #每周三凌晨2点清理mongo中的过期（超过retainChatRecords时间）消息，这个删除是为了清理满足上个配置retainChatRecords的过期消息，不会发送通知，仅仅作为清理磁盘使用
-msgDestructTime: "0 2 * * *"                            #消息自动删除时间，每天凌晨2点删除过期消息，这个删除是为了删除保留时间超过超过会话字段msg_destruct_time（秒）的消息。
+# 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"
 
-secret: tuoyun #秘钥，获取token时校验
+# 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                                     #过期时间（天）
+  expire: 90
 
+# Message verification policy
+#
+# Whether to verify friendship when sending messages
 messageVerify:
-  friendVerify: false                                  #发送消息时是否验证好友关系
+  friendVerify: false
 
-#ios系统推送声音以及标记计数
+# iOS push notification configuration
+#
+# iOS push notification sound
+# Whether to count badge
+# Whether it's production environment
 iosPush:
   pushSound: "xxx"
   badgeCount: true
   production: false
 
+# Callback configuration
+#
+# Callback URL
+# Whether to enable this callback event
+# Timeout in seconds
+# Whether to continue execution if callback fails
 callback:
-  # 回调callback
   url:
   beforeSendSingleMsg:
-    enable: false                                     #是否启用此回调事件
-    timeout: 5                                        #超时时间（秒）
-    failedContinue: true                              #如回调失败是否继续往后执行
+    enable: false
+    timeout: 5
+    failedContinue: true
   afterSendSingleMsg:
     enable: false
     timeout: 5
@@ -244,8 +355,11 @@ callback:
     timeout: 5
     failedContinue: true
 
-
-prometheus: #prometheus每个服务的端口数量需要和rpcPort保持对应
+###################### Prometheus ######################
+# Prometheus configuration
+# The number of Prometheus ports per service needs to correspond to rpcPort
+# The number of ports needs to be consistent with msg_transfer_service_num in script/path_info.sh
+prometheus:
   enable: false
   userPrometheusPort: [ 20110 ]
   friendPrometheusPort: [ 20120 ]
@@ -257,4 +371,4 @@ prometheus: #prometheus每个服务的端口数量需要和rpcPort保持对应
   conversationPrometheusPort: [ 20230 ]
   rtcPrometheusPort: [ 21300 ]
   thirdPrometheusPort: [ 21301 ]
-  messageTransferPrometheusPort: [ 21400, 21401, 21402, 21403 ] #端口数量需要和script/path_info.sh中的msg_transfer_service_num保持一致
+  messageTransferPrometheusPort: [ 21400, 21401, 21402, 21403 ]

config/open-im-ng-example.conf

@@ -1,41 +1,37 @@
 upstream im_msg_gateway{
-            server 127.0.0.1:10001;        #IM消息服务器地址 根据部署情况可指定多台
+            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群组用户api服务器地址 根据部署情况可指定多台
-            }
-upstream im_jssdk_gateway{
-            server 127.0.0.1:10003;        #IM jssdk服务器地址 根据部署情况可指定多台
-            }
-upstream storage {
-            server 127.0.0.1:10005;                #MinIO服务器地址 暂时支持1台
-            }
-upstream im_admin{
-            server 127.0.0.1:10006;        #IM admin服务器地址 根据部署情况可指定多台
+            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 统计服务器地址 docker-compose启动所在机器
+            server 127.0.0.1:10007;        #IM Statistical server address The machine where docker-compose starts
             }
-upstream im_chat{
-            server 127.0.0.1:10008;        #IM 商业版登录注册服务器地址 根据部署情况可指定多台
+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_complete_admin{
-            server 127.0.0.1:10009;         #IM 商业版admin地址 根据部署情况可指定多台
-            }
-upstream im_organization{
-            server 127.0.0.1:10010;        #IM 商业版组织架构服务器地址 根据部署情况可指定多台
+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 音视频通话 服务器地址 根据部署情况可指定多台
+            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 web.rentsoft.cn;   #1 web im 端 域名
+        server_name your-domain.com;   #your-domain.com
 
         ssl on;
-        ssl_certificate /etc/nginx/conf.d/ssl/web.rentsoft.cn.crt; #2 证书
-        ssl_certificate_key /etc/nginx/conf.d/ssl/web.rentsoft.cn.key; #3 证书
+        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;
@@ -52,7 +48,7 @@ server {
                 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静态资源存放路径
+                root /data1/online/Pc-Web-Demo/build/; # web im static resource storage path
                 index index.html;
                 try_files $uri $uri/ /index.html;
         }
@@ -72,22 +68,6 @@ server {
                 proxy_set_header X-Forwarded-For $remote_addr;
                 proxy_pass http://im_api/;
                }
-        location /jssdk_gateway { #10003 jssdk
-                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_jssdk_gateway/;
-               }
-        location ^~/admin/ { #10006 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/;
-               }
         location ^~/grafana/ { #10007  prometheus
                 proxy_http_version 1.1;
                 proxy_set_header Upgrade $http_upgrade;
@@ -96,29 +76,21 @@ server {
                 proxy_set_header X-Forwarded-For $remote_addr;
                 proxy_pass http://im_grafana/;
                }
-        location ^~/chat/ { #10008 chat login
-                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/;
-               }
+        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_complete_admin/;
-               }
-        location ^~/organization/ { #10010 organization
-                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_organization/;
+                proxy_pass http://im_admin_api/;
                }
         location ^~/open_rtc/ {  #7880 rtc
                 proxy_http_version 1.1;
@@ -132,63 +104,69 @@ server {
 
 server {
         listen 80;
-        server_name web.rentsoft.cn ; #1 web im 端 域名
+        server_name test-web.rentsoft.cn ; #1 web im end domain name
         rewrite ^(.*)$ https://${server_name}$1 permanent;
 }
 
+
 server {
-        ssl_session_timeout 5m;
-	listen 443;
-        server_name storage.rentsoft.cn; #1 MinIO存储域名
-        ssl on;
-        ssl_certificate /etc/nginx/conf.d/ssl/storage.rentsoft.cn.crt; #证书
-        ssl_certificate_key /etc/nginx/conf.d/ssl/storage.rentsoft.cn.key;    #证书
-        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;
-        gzip_vary off;
-        gzip_disable "MSIE [1-6]\.";
+    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_pass http://storage;
-            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 Host $http_host;
-            proxy_http_version 1.1;
-            client_max_body_size 8000M;
+        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
     }
 }
-
-
-server {
-        listen 443;
-        server_name admin.rentsoft.cn; #后台管理域名
-        ssl on;
-        ssl_certificate /etc/nginx/conf.d/ssl/admin.rentsoft.cn.crt; # 证书
-        ssl_certificate_key /etc/nginx/conf.d/ssl/admin.rentsoft.cn.key; #证书
-        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;
-        gzip_vary off;
-        gzip_disable "MSIE [1-6]\.";
-        location / {
-                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/Open-IM-Admin/dist/; #管理后台web静态资源存放路径
-                index index.html;
-                try_files $uri $uri/ /index.html;
-        }
-}
-
-server {
-        listen 80;
-        server_name admin.rentsoft.cn; #管理后台 域名
-        rewrite ^(.*)$ https://${server_name}$1 permanent;
-}

docker-compose.yaml

@@ -52,7 +52,6 @@ services:
       net.core.somaxconn: 1024
     command: redis-server --requirepass ${PASSWORD} --appendonly yes
 
-
   zookeeper:
     image: wurstmeister/zookeeper
     ports:
@@ -64,7 +63,6 @@ services:
       TZ: Asia/Shanghai
     restart: always
 
-
   kafka:
     image: wurstmeister/kafka
     container_name: kafka
@@ -98,18 +96,16 @@ services:
     restart: always
     command: minio server /data --console-address ':9090'
 
-
   openim_server:
-    image: ghcr.io/openimsdk/openim-server:v3.0.0
+    image: ghcr.io/openimsdk/openim-server:main
     container_name: openim-server
     volumes:
-      - ./logs:/Open-IM-Server/logs
-      - ./config/config.yaml:/Open-IM-Server/config/config.yaml
-      - ./config/notification.yaml:/Open-IM-Server/config/notification.yaml
-      - ${DATA_DIR}/db/sdk:/Open-IM-Server/db/sdk
-      - ./scripts:/Open-IM-Server/scripts
+      - ./logs:/openim/openim-server/logs
+      - ./config:/openim/openim-server/config
+      - ./scripts:/openim/openim-server/scripts
     restart: always
     depends_on:
+      - zookeeper
       - kafka
       - mysql
       - mongodb
@@ -122,9 +118,13 @@ services:
         max-size: "1g"
         max-file: "2"
 
-  openim_chat:
-    image: openim/openim_chat:v1.1.0
-    container_name: openim_chat
+  openim-chat:
+    image: ghcr.io/openimsdk/openim-chat:main
+    container_name: openim-chat
+    volumes:
+      - ./_output/openim/openim-chat/logs:/openim/openim-chat/logs
+      - ./_output/openim/openim-chat/config:/openim/openim-chat/config
+      - ./_output/openim/openim-chat/scripts:/openim/openim-chat/scripts
     restart: always
     depends_on:
       - mysql

docs/CODEOWNERS

@@ -2,28 +2,28 @@
 # Each line is a file pattern followed by one or more owners.
 
 # README files
-README.md @cubxxw @kubbot @Bloomingg @FGadvancer @hrxiang @Oliver-WJ @skiffer-git @std-s @wangchuxiao-dev @withchao
+README.md @openimsdk/openim @cubxxw @openimsdk/bot @Bloomingg @FGadvancer  @skiffer-git  @wangchuxiao-dev @withchao
 
 # Contributing guidelines
-CONTRIBUTING.md @cubxxw @kubbot @Bloomingg @FGadvancer @hrxiang @Oliver-WJ @skiffer-git @std-s @wangchuxiao-dev @withchao
+CONTRIBUTING.md @cubxxw @openimsdk/bot @Bloomingg @FGadvancer  @skiffer-git  @wangchuxiao-dev @withchao
 
 # License files
-LICENSE    @cubxxw @kubbot @Bloomingg @FGadvancer @hrxiang @Oliver-WJ @skiffer-git @std-s @wangchuxiao-dev @withchao
+LICENSE    @cubxxw @openimsdk/bot @Bloomingg @FGadvancer  @skiffer-git  @wangchuxiao-dev @withchao
 
 # Makefile
-Makefile    @cubxxw @kubbot @Bloomingg @FGadvancer @hrxiang @Oliver-WJ @skiffer-git @std-s @wangchuxiao-dev @withchao
+Makefile    @cubxxw @openimsdk/bot @Bloomingg @FGadvancer  @skiffer-git  @wangchuxiao-dev @withchao
 
 # These owners will be the default owners for everything in
 # the repo. Unless a later match takes precedence,
-# @cubxxw and @kubbot will be requested for
+# @cubxxw and @openimsdk/bot will be requested for
 # review when someone opens a pull request.
-* @cubxxw @kubbot @Bloomingg @FGadvancer @hrxiang @Oliver-WJ @skiffer-git @std-s @wangchuxiao-dev @withchao
+* @openimsdk/openim @cubxxw @openimsdk/bot @Bloomingg @FGadvancer  @skiffer-git  @wangchuxiao-dev @withchao
 
 # Order is important; the last matching pattern takes the most
 # precedence. When someone opens a pull request that only
 # modifies JS files, only @js-owner and not the global
 # owner(s) will be requested for a review.
-*.js   @cubxxw @kubbot @Bloomingg @FGadvancer @hrxiang @Oliver-WJ @skiffer-git @std-s @wangchuxiao-dev @withchao
+*.js   @cubxxw @openimsdk/bot @Bloomingg @FGadvancer  @skiffer-git  @wangchuxiao-dev @withchao
 
 # You can also use email addresses if you prefer. They'll be
 # used to look up users just like we do for commit author
@@ -35,16 +35,16 @@ Makefile    @cubxxw @kubbot @Bloomingg @FGadvancer @hrxiang @Oliver-WJ @skiffer-
 # be identified in the format @org/team-name. Teams must have
 # explicit write access to the repository. In this example,
 # the OpenIMSDK team in the github organization owns all .txt files.
-*.txt @cubxxw @kubbot @Bloomingg @FGadvancer @hrxiang @Oliver-WJ @skiffer-git @std-s @wangchuxiao-dev @withchao
+*.txt @cubxxw @openimsdk/bot @Bloomingg @FGadvancer  @skiffer-git  @wangchuxiao-dev @withchao
 
 # The `docs/*` pattern will match files like
 # `docs/getting-started.md` but not further nested files like
 # `docs/build-app/troubleshooting.md`.
-docs/*  3293172751nss@gmail.com @kubbot @skiffer-git
+docs/* 3293172751nss@gmail.com @openimsdk/bot @skiffer-git
 
 # In this example, @octocat owns any file in an apps directory
 # anywhere in your repository.
-api/ @cubxxw @IRONICBo @skiffer-git
+api/ @openimsdk/openim @cubxxw @skiffer-git
 
 # This is a comment.
 # Each line is a file pattern followed by one or more owners.
@@ -65,24 +65,24 @@ cmd/*
 config/*    @skiffer-git
 
 # db directory
-db/sdk    @77caleb @BanTanger @cubxxw @Gordon  
+db/sdk  @cubxxw @FGadvancer  
 
 # internal directory
-internal/ @skiffer-git @FGadvancer
+internal/ @openimsdk/openim @skiffer-git @FGadvancer
 
 # logs directory
-logs/*    @skiffer-git @FGadvancer
+logs/*  @skiffer-git @FGadvancer
 
 # pkg directory
-pkg/a2r    @skiffer-git
+pkg/a2r  @openimsdk/openim @skiffer-git @cubxxw @openimsdk/bot
 
 # scripts directory
-scripts/LICENSE/*   @cubxxw @skiffer-git @FGadvancer
-scripts/enterprise/*  @FGadvancer @cubxxw @skiffer-git @kubbot
-scripts/githooks/*    @cubxxw @skiffer-git @FGadvancer
-scripts/lib/*    @FGadvancer @cubxxw @skiffer-git @kubbot
-scripts/make-rules/* @FGadvancer @cubxxw @skiffer-git @kubbot
+scripts/LICENSE/*   @openimsdk/openim @cubxxw @skiffer-git @FGadvancer
+scripts/enterprise/*  @openimsdk/openim @FGadvancer @cubxxw @skiffer-git @openimsdk/bot
+scripts/githooks/*   @openimsdk/openim @cubxxw @skiffer-git @FGadvancer
+scripts/lib/*   @openimsdk/openim @FGadvancer @cubxxw @skiffer-git @openimsdk/bot
+scripts/make-rules/* @openimsdk/openim @FGadvancer @cubxxw @skiffer-git @openimsdk/bot
 
 # test directory
-test/mongo    @FGadvancer @cubxxw @skiffer-git @kubbot
-test/mysql    @FGadvancer @cubxxw @skiffer-git @kubbot
+test/mongo    @FGadvancer @cubxxw @skiffer-git @openimsdk/bot
+test/mysql    @FGadvancer @cubxxw @skiffer-git @openimsdk/bot

docs/conversions/README.md

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

docs/conversions/api.md

@@ -0,0 +1,5 @@
+## Interface Standards
+
+Our project, OpenIM, adheres to the [OpenAPI 3.0](https://spec.openapis.org/oas/latest.html) interface standards.
+
+> Chinese translation: [OpenAPI Specification Chinese Translation](https://fishead.gitbook.io/openapi-specification-zhcn-translation/3.0.0.zhcn)

docs/conversions/commit.md

@@ -0,0 +1,9 @@
+## Commit Standards
+
+Our project, OpenIM, follows the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0) standards.
+
+> Chinese translation: [Conventional Commits: A Specification Making Commit Logs More Human and Machine-friendly](https://tool.lu/en_US/article/2ac/preview)
+
+In addition to adhering to these standards, we encourage all contributors to the OpenIM project to ensure that their commit messages are clear and descriptive. This helps in maintaining a clean and meaningful project history. Each commit message should succinctly describe the changes made and, where necessary, the reasoning behind those changes.
+
+To facilitate a streamlined process, we also recommend using appropriate commit type based on Conventional Commits guidelines such as `fix:` for bug fixes, `feat:` for new features, and so forth. Understanding and using these conventions helps in generating automatic release notes, making versioning easier, and improving overall readability of commit history.

docs/conversions/directory.md

@@ -0,0 +1,3 @@
+## Catalog Service Interface Specification
+
++ [https://github.com/kubecub/go-project-layout](https://github.com/kubecub/go-project-layout)

docs/conversions/error_code.md

@@ -0,0 +1,22 @@
+## Error Code Standards
+
+Error codes are one of the important means for users to locate and solve problems. When an application encounters an exception, users can quickly locate and resolve the problem based on the error code and the description and solution of the error code in the documentation.
+
+### Error Code Naming Standards
+
+- Follow CamelCase notation;
+- Error codes are divided into two levels. For example, `InvalidParameter.BindError`, separated by a `.`. The first-level error code is platform-level, and the second-level error code is resource-level, which can be customized according to the scenario;
+- The second-level error code can only use English letters or numbers ([a-zA-Z0-9]), and should use standard English word spelling, standard abbreviations, RFC term abbreviations, etc.;
+- The error code should avoid multiple definitions of the same semantics, for example: `InvalidParameter.ErrorBind`, `InvalidParameter.BindError`.
+
+### First-Level Common Error Codes
+
+| Error Code       | Error Description                                            | Error Type |
+| ---------------- | ------------------------------------------------------------ | ---------- |
+| InternalError    | Internal error                                               | 1          |
+| InvalidParameter | Parameter error (including errors in parameter type, format, value, etc.) | 0          |
+| AuthFailure      | Authentication / Authorization error                         | 0          |
+| ResourceNotFound | Resource does not exist                                      | 0          |
+| FailedOperation  | Operation failed                                             | 2          |
+
+> Error Type: 0 represents the client, 1 represents the server, 2 represents both the client / server.

docs/conversions/go_code.md

@@ -0,0 +1,901 @@
+## Go 代码开发规范
+在Go 项目开发中，一个好的编码规范可以极大的提高代码质量。为了帮你节省时间和精力，这里我整理了一份清晰、可直接套用的 Go 编码规范，供你参考。
+
+这份规范，是我参考了 Go 官方提供的编码规范，以及 Go 社区沉淀的一些比较合理的规范之后，加入自己的理解总结出的，它比很多公司内部的规范更全面，你掌握了，以后在面试大厂的时候，或者在大厂里写代码的时候，都会让人高看你一眼，觉得你code很专业。
+
+这份编码规范中包含代码风格、命名规范、注释规范、类型、控制结构、函数、GOPATH 设置规范、依赖管理和最佳实践九类规范。如果你觉得这些规范内容太多了，看完一遍也记不住，这完全没关系。你可以多看几遍，也可以在用到时把它翻出来，在实际应用中掌握。这篇特别放送的内容，更多是作为写代码时候的一个参考手册。
+
+## 1. 代码风格
+
+### 1.1 代码格式
+
+- 代码都必须用 `gofmt` 进行格式化。
+- 运算符和操作数之间要留空格。
+- 建议一行代码不超过120个字符，超过部分，请采用合适的换行方式换行。但也有些例外场景，例如import行、工具自动生成的代码、带tag的struct字段。
+- 文件长度不能超过800行。
+- 函数长度不能超过80行。
+- import规范
+	- 代码都必须用`goimports`进行格式化（建议将代码Go代码编辑器设置为：保存时运行 `goimports`）。
+	- 不要使用相对路径引入包，例如 `import ../util/net` 。
+	- 包名称与导入路径的最后一个目录名不匹配时，或者多个相同包名冲突时，则必须使用导入别名。
+
+```go
+	// bad
+	"github.com/dgrijalva/jwt-go/v4"
+
+	//good
+	jwt "github.com/dgrijalva/jwt-go/v4"
+```
+	- 导入的包建议进行分组，匿名包的引用使用一个新的分组，并对匿名包引用进行说明。
+
+```go
+	import (
+		// go 标准包
+		"fmt"
+
+		// 第三方包
+	    "github.com/jinzhu/gorm"
+	    "github.com/spf13/cobra"
+	    "github.com/spf13/viper"
+
+		// 匿名包单独分组，并对匿名包引用进行说明
+	    // import mysql driver
+	    _ "github.com/jinzhu/gorm/dialects/mysql"
+
+		// 内部包
+	    v1 "github.com/marmotedu/api/apiserver/v1"
+	    metav1 "github.com/marmotedu/apimachinery/pkg/meta/v1"
+	    "github.com/marmotedu/iam/pkg/cli/genericclioptions"
+	)
+```
+
+### 1.2 声明、初始化和定义
+
+当函数中需要使用到多个变量时，可以在函数开始处使用`var`声明。在函数外部声明必须使用 `var` ，不要采用 `:=` ，容易踩到变量的作用域的问题。
+
+```go
+var (
+	Width  int
+	Height int
+)
+```
+
+- 在初始化结构引用时，请使用`&T{}`代替`new(T)`，以使其与结构体初始化一致。
+
+```go
+// bad
+sptr := new(T)
+sptr.Name = "bar"
+
+// good
+sptr := &T{Name: "bar"}
+```
+
+- struct 声明和初始化格式采用多行，定义如下。
+
+```go
+type User struct{
+    Username  string
+    Email     string
+}
+
+user := User{
+	Username: "belm",
+	Email: "nosbelm@qq.com",
+}
+```
+
+- 相似的声明放在一组，同样适用于常量、变量和类型声明。
+
+```go
+// bad
+import "a"
+import "b"
+
+// good
+import (
+  "a"
+  "b"
+)
+```
+
+- 尽可能指定容器容量，以便为容器预先分配内存，例如：
+
+```go
+v := make(map[int]string, 4)
+v := make([]string, 0, 4)
+```
+
+- 在顶层，使用标准var关键字。请勿指定类型，除非它与表达式的类型不同。
+
+```go
+// bad
+var _s string = F()
+
+func F() string { return "A" }
+
+// good
+var _s = F()
+// 由于 F 已经明确了返回一个字符串类型，因此我们没有必要显式指定_s 的类型
+// 还是那种类型
+
+func F() string { return "A" }
+```
+
+- 对于未导出的顶层常量和变量，使用`_`作为前缀。
+
+```go
+// bad
+const (
+  defaultHost = "127.0.0.1"
+  defaultPort = 8080
+)
+
+// good
+const (
+  _defaultHost = "127.0.0.1"
+  _defaultPort = 8080
+)
+```
+
+- 嵌入式类型（例如 mutex）应位于结构体内的字段列表的顶部，并且必须有一个空行将嵌入式字段与常规字段分隔开。
+
+```go
+// bad
+type Client struct {
+  version int
+  http.Client
+}
+
+// good
+type Client struct {
+  http.Client
+
+  version int
+}
+```
+
+### 1.3 错误处理
+
+- `error`作为函数的值返回，必须对`error`进行处理，或将返回值赋值给明确忽略。对于`defer xx.Close()`可以不用显式处理。
+
+```go
+func load() error {
+	// normal code
+}
+
+// bad
+load()
+
+// good
+ _ = load()
+```
+
+- `error`作为函数的值返回且有多个返回值的时候，`error`必须是最后一个参数。
+
+```go
+// bad
+func load() (error, int) {
+	// normal code
+}
+
+// good
+func load() (int, error) {
+	// normal code
+}
+```
+
+- 尽早进行错误处理，并尽早返回，减少嵌套。
+
+```go
+// bad
+if err != nil {
+	// error code
+} else {
+	// normal code
+}
+
+// good
+if err != nil {
+	// error handling
+	return err
+}
+// normal code
+```
+
+- 如果需要在 if 之外使用函数调用的结果，则应采用下面的方式。
+
+```go
+// bad
+if v, err := foo(); err != nil {
+	// error handling
+}
+
+// good
+v, err := foo()
+if err != nil {
+	// error handling
+}
+```
+
+- 错误要单独判断，不与其他逻辑组合判断。
+
+```go
+// bad
+v, err := foo()
+if err != nil || v  == nil {
+	// error handling
+	return err
+}
+
+// good
+v, err := foo()
+if err != nil {
+	// error handling
+	return err
+}
+
+if v == nil {
+	// error handling
+	return errors.New("invalid value v")
+}
+```
+
+- 如果返回值需要初始化，则采用下面的方式。
+
+```go
+v, err := f()
+if err != nil {
+    // error handling
+    return // or continue.
+}
+```
+
+- 错误描述建议
+	- 错误描述用小写字母开头，结尾不要加标点符号，例如：
+```go
+	// bad
+	errors.New("Redis connection failed")
+	errors.New("redis connection failed.")
+
+	// good
+	errors.New("redis connection failed")
+```
+	- 告诉用户他们可以做什么，而不是告诉他们不能做什么。
+	- 当声明一个需求时，用must 而不是should。例如，`must be greater than 0、must match regex '[a-z]+'`。
+	- 当声明一个格式不对时，用must not。例如，`must not contain`。
+	- 当声明一个动作时用may not。例如，`may not be specified when otherField is empty、only name may be specified`。
+	- 引用文字字符串值时，请在单引号中指示文字。例如，`ust not contain '..'`。
+	- 当引用另一个字段名称时，请在反引号中指定该名称。例如，must be greater than `request`。
+	- 指定不等时，请使用单词而不是符号。例如，`must be less than 256、must be greater than or equal to 0 (不要用 larger than、bigger than、more than、higher than)`。
+	- 指定数字范围时，请尽可能使用包含范围。
+	- 建议 Go 1.13 以上，error 生成方式为 `fmt.Errorf("module xxx: %w", err)`。
+
+### 1.4 panic处理
+
+- 在业务逻辑处理中禁止使用panic。
+- 在main包中，只有当程序完全不可运行时使用panic，例如无法打开文件、无法连接数据库导致程序无法正常运行。
+- 在main包中，使用 `log.Fatal` 来记录错误，这样就可以由log来结束程序，或者将panic抛出的异常记录到日志文件中，方便排查问题。
+- 可导出的接口一定不能有panic。
+- 包内建议采用error而不是panic来传递错误。
+
+### 1.5 单元测试
+
+- 单元测试文件名命名规范为 `example_test.go`。
+- 每个重要的可导出函数都要编写测试用例。
+- 因为单元测试文件内的函数都是不对外的，所以可导出的结构体、函数等可以不带注释。
+- 如果存在 `func (b *Bar) Foo` ，单测函数可以为 `func TestBar_Foo`。
+
+### 1.6 类型断言失败处理
+
+- type assertion 的单个返回值针对不正确的类型将产生 panic。请始终使用 “comma ok”的惯用法。
+
+```go
+// bad
+t := n.(int)
+
+// good
+t, ok := n.(int)
+if !ok {
+	// error handling
+}
+```
+
+## 2. 命名规范
+
+命名规范是代码规范中非常重要的一部分，一个统一的、短小的、精确的命名规范可以大大提高代码的可读性，也可以借此规避一些不必要的Bug。
+
+### 2.1 包命名
+
+- 包名必须和目录名一致，尽量采取有意义、简短的包名，不要和标准库冲突。
+- 包名全部小写，没有大写或下划线，使用多级目录来划分层级。
+- 项目名可以通过中划线来连接多个单词。
+- 包名以及包所在的目录名，不要使用复数，例如，是`net/url`，而不是`net/urls`。
+- 不要用 common、util、shared 或者 lib 这类宽泛的、无意义的包名。
+- 包名要简单明了，例如 net、time、log。
+
+### 2.2 函数命名
+
+- 函数名采用驼峰式，首字母根据访问控制决定使用大写或小写，例如：`MixedCaps`或者`mixedCaps`。
+- 代码生成工具自动生成的代码(如`xxxx.pb.go`)和为了对相关测试用例进行分组，而采用的下划线(如`TestMyFunction_WhatIsBeingTested`)排除此规则。
+
+### 2.3 文件命名
+
+- 文件名要简短有意义。
+- 文件名应小写，并使用下划线分割单词。
+
+### 2.4 结构体命名
+
+- 采用驼峰命名方式，首字母根据访问控制决定使用大写或小写，例如`MixedCaps`或者`mixedCaps`。
+- 结构体名不应该是动词，应该是名词，比如 `Node`、`NodeSpec`。
+- 避免使用Data、Info这类无意义的结构体名。
+- 结构体的声明和初始化应采用多行，例如：
+
+```go
+// User 多行声明
+type User struct {
+    Name  string
+    Email string
+}
+
+// 多行初始化
+u := User{
+    UserName: "belm",
+    Email:    "nosbelm@qq.com",
+}
+```
+
+### 2.5 接口命名
+
+- 接口命名的规则，基本和结构体命名规则保持一致：
+	- 单个函数的接口名以 “er"”作为后缀（例如Reader，Writer），有时候可能导致蹩脚的英文，但是没关系。
+	- 两个函数的接口名以两个函数名命名，例如ReadWriter。
+	- 三个以上函数的接口名，类似于结构体名。
+
+例如：
+
+```
+	// Seeking to an offset before the start of the file is an error.
+	// Seeking to any positive offset is legal, but the behavior of subsequent
+	// I/O operations on the underlying object is implementation-dependent.
+	type Seeker interface {
+	    Seek(offset int64, whence int) (int64, error)
+	}
+
+	// ReadWriter is the interface that groups the basic Read and Write methods.
+	type ReadWriter interface {
+	    Reader
+	    Writer
+	}
+```
+
+### 2.6 变量命名
+
+- 变量名必须遵循驼峰式，首字母根据访问控制决定使用大写或小写。
+- 在相对简单（对象数量少、针对性强）的环境中，可以将一些名称由完整单词简写为单个字母，例如：
+	- user 可以简写为 u；
+	- userID 可以简写 uid。
+- 特有名词时，需要遵循以下规则：
+	- 如果变量为私有，且特有名词为首个单词，则使用小写，如 apiClient。
+	- 其他情况都应当使用该名词原有的写法，如 APIClient、repoID、UserID。
+
+下面列举了一些常见的特有名词。
+
+```
+// A GonicMapper that contains a list of common initialisms taken from golang/lint
+var LintGonicMapper = GonicMapper{
+    "API":   true,
+    "ASCII": true,
+    "CPU":   true,
+    "CSS":   true,
+    "DNS":   true,
+    "EOF":   true,
+    "GUID":  true,
+    "HTML":  true,
+    "HTTP":  true,
+    "HTTPS": true,
+    "ID":    true,
+    "IP":    true,
+    "JSON":  true,
+    "LHS":   true,
+    "QPS":   true,
+    "RAM":   true,
+    "RHS":   true,
+    "RPC":   true,
+    "SLA":   true,
+    "SMTP":  true,
+    "SSH":   true,
+    "TLS":   true,
+    "TTL":   true,
+    "UI":    true,
+    "UID":   true,
+    "UUID":  true,
+    "URI":   true,
+    "URL":   true,
+    "UTF8":  true,
+    "VM":    true,
+    "XML":   true,
+    "XSRF":  true,
+    "XSS":   true,
+}
+```
+
+- 若变量类型为bool类型，则名称应以Has，Is，Can或Allow开头，例如：
+
+```go
+var hasConflict bool
+var isExist bool
+var canManage bool
+var allowGitHook bool
+```
+
+- 局部变量应当尽可能短小，比如使用buf指代buffer，使用i指代index。
+- 代码生成工具自动生成的代码可排除此规则(如`xxx.pb.go`里面的Id)
+
+### 2.7 常量命名
+
+- 常量名必须遵循驼峰式，首字母根据访问控制决定使用大写或小写。
+- 如果是枚举类型的常量，需要先创建相应类型：
+
+```go
+// Code defines an error code type.
+type Code int
+
+// Internal errors.
+const (
+    // ErrUnknown - 0: An unknown error occurred.
+    ErrUnknown Code = iota
+    // ErrFatal - 1: An fatal error occurred.
+    ErrFatal
+)
+```
+
+### 2.8 Error的命名
+
+- Error类型应该写成FooError的形式。
+
+```go
+type ExitError struct {
+	// ....
+}
+```
+
+- Error变量写成ErrFoo的形式。
+
+```go
+var ErrFormat = errors.New("unknown format")
+```
+
+## 3. 注释规范
+
+- 每个可导出的名字都要有注释，该注释对导出的变量、函数、结构体、接口等进行简要介绍。
+- 全部使用单行注释，禁止使用多行注释。
+- 和代码的规范一样，单行注释不要过长，禁止超过 120 字符，超过的请使用换行展示，尽量保持格式优雅。
+- 注释必须是完整的句子，以需要注释的内容作为开头，句点作为结尾，`格式为 // 名称 描述.`。例如：
+
+```go
+// bad
+// logs the flags in the flagset.
+func PrintFlags(flags *pflag.FlagSet) {
+	// normal code
+}
+
+// good
+// PrintFlags logs the flags in the flagset.
+func PrintFlags(flags *pflag.FlagSet) {
+	// normal code
+}
+```
+
+- 所有注释掉的代码在提交code review前都应该被删除，否则应该说明为什么不删除，并给出后续处理建议。
+
+- 在多段注释之间可以使用空行分隔加以区分，如下所示：
+
+```go
+// Package superman implements methods for saving the world.
+//
+// Experience has shown that a small number of procedures can prove
+// helpful when attempting to save the world.
+package superman
+```
+
+### 3.1 包注释
+
+- 每个包都有且仅有一个包级别的注释。
+- 包注释统一用 // 进行注释，格式为 `// Package 包名 包描述`，例如：
+
+```go
+// Package genericclioptions contains flags which can be added to you command, bound, completed, and produce
+// useful helper functions.
+package genericclioptions
+```
+
+### 3.2 变量/常量注释
+
+- 每个可导出的变量/常量都必须有注释说明，`格式为// 变量名 变量描述`，例如：
+
+```go
+// ErrSigningMethod defines invalid signing method error.
+var ErrSigningMethod = errors.New("Invalid signing method")
+```
+- 出现大块常量或变量定义时，可在前面注释一个总的说明，然后在每一行常量的前一行或末尾详细注释该常量的定义，例如：
+```go
+// Code must start with 1xxxxx.
+const (
+    // ErrSuccess - 200: OK.
+    ErrSuccess int = iota + 100001
+
+    // ErrUnknown - 500: Internal server error.
+    ErrUnknown
+
+    // ErrBind - 400: Error occurred while binding the request body to the struct.
+    ErrBind
+
+    // ErrValidation - 400: Validation failed.
+    ErrValidation
+)
+```
+### 3.3 结构体注释
+
+- 每个需要导出的结构体或者接口都必须有注释说明，格式为 `// 结构体名 结构体描述.`。
+- 结构体内的可导出成员变量名，如果意义不明确，必须要给出注释，放在成员变量的前一行或同一行的末尾。例如：
+
+```go
+// User represents a user restful resource. It is also used as gorm model.
+type User struct {
+    // Standard object's metadata.
+    metav1.ObjectMeta `json:"metadata,omitempty"`
+
+    Nickname string `json:"nickname" gorm:"column:nickname"`
+    Password string `json:"password" gorm:"column:password"`
+    Email    string `json:"email" gorm:"column:email"`
+    Phone    string `json:"phone" gorm:"column:phone"`
+    IsAdmin  int    `json:"isAdmin,omitempty" gorm:"column:isAdmin"`
+}
+```
+
+### 3.4 方法注释
+
+每个需要导出的函数或者方法都必须有注释，格式为// 函数名 函数描述.，例如：
+
+```go
+// BeforeUpdate run before update database record.
+func (p *Policy) BeforeUpdate() (err error) {
+	// normal code
+	return nil
+}
+```
+
+### 3.5 类型注释
+
+- 每个需要导出的类型定义和类型别名都必须有注释说明，格式为 `// 类型名 类型描述.`，例如：
+
+```go
+// Code defines an error code type.
+type Code int
+```
+
+## 4. 类型
+
+### 4.1 字符串
+
+- 空字符串判断。
+
+```go
+// bad
+if s == "" {
+    // normal code
+}
+
+// good
+if len(s) == 0 {
+    // normal code
+}
+```
+
+- `[]byte`/`string`相等比较。
+
+```go
+// bad
+var s1 []byte
+var s2 []byte
+...
+bytes.Equal(s1, s2) == 0
+bytes.Equal(s1, s2) != 0
+
+// good
+var s1 []byte
+var s2 []byte
+...
+bytes.Compare(s1, s2) == 0
+bytes.Compare(s1, s2) != 0
+```
+
+- 复杂字符串使用raw字符串避免字符转义。
+
+```go
+// bad
+regexp.MustCompile("\\.")
+
+// good
+regexp.MustCompile(`\.`)
+```
+
+### 4.2 切片
+
+- 空slice判断。
+
+```go
+// bad
+if len(slice) = 0 {
+    // normal code
+}
+
+// good
+if slice != nil && len(slice) == 0 {
+    // normal code
+}
+```
+
+上面判断同样适用于map、channel。
+
+- 声明slice。
+
+```go
+// bad
+s := []string{}
+s := make([]string, 0)
+
+// good
+var s []string
+```
+
+- slice复制。
+
+```go
+// bad
+var b1, b2 []byte
+for i, v := range b1 {
+   b2[i] = v
+}
+for i := range b1 {
+   b2[i] = b1[i]
+}
+
+// good
+copy(b2, b1)
+```
+
+- slice新增。
+
+```go
+// bad
+var a, b []int
+for _, v := range a {
+    b = append(b, v)
+}
+
+// good
+var a, b []int
+b = append(b, a...)
+```
+
+### 4.3 结构体
+
+- struct初始化。
+
+struct以多行格式初始化。
+
+```go
+type user struct {
+	Id   int64
+	Name string
+}
+
+u1 := user{100, "Colin"}
+
+u2 := user{
+    Id:   200,
+    Name: "Lex",
+}
+```
+
+## 5. 控制结构
+
+### 5.1 if
+
+- if 接受初始化语句，约定如下方式建立局部变量。
+
+```go
+if err := loadConfig(); err != nil {
+	// error handling
+	return err
+}
+```
+
+- if 对于bool类型的变量，应直接进行真假判断。
+
+```go
+var isAllow bool
+if isAllow {
+	// normal code
+}
+```
+
+### 5.2 for
+
+- 采用短声明建立局部变量。
+
+```go
+sum := 0
+for i := 0; i < 10; i++ {
+    sum += 1
+}
+```
+
+- 不要在 for 循环里面使用 defer，defer只有在函数退出时才会执行。
+
+```go
+// bad
+for file := range files {
+	fd, err := os.Open(file)
+	if err != nil {
+		return err
+	}
+	defer fd.Close()
+	// normal code
+}
+
+// good
+for file := range files {
+	func() {
+		fd, err := os.Open(file)
+		if err != nil {
+			return err
+		}
+		defer fd.Close()
+		// normal code
+	}()
+}
+```
+
+### 5.3 range
+
+- 如果只需要第一项（key），就丢弃第二个。
+
+```go
+for key := range keys {
+// normal code
+}
+```
+
+- 如果只需要第二项，则把第一项置为下划线。
+
+```go
+sum := 0
+for _, value := range array {
+    sum += value
+}
+```
+
+### 5.4 switch
+
+- 必须要有default。
+
+```go
+switch os := runtime.GOOS; os {
+    case "linux":
+        fmt.Println("Linux.")
+    case "darwin":
+        fmt.Println("OS X.")
+    default:
+        fmt.Printf("%s.\n", os)
+}
+```
+
+### 5.5 goto
+- 业务代码禁止使用 goto 。
+- 框架或其他底层源码尽量不用。
+
+## 6. 函数
+
+- 传入变量和返回变量以小写字母开头。
+- 函数参数个数不能超过5个。
+- 函数分组与顺序
+- 函数应按粗略的调用顺序排序。
+- 同一文件中的函数应按接收者分组。
+- 尽量采用值传递，而非指针传递。
+- 传入参数是 map、slice、chan、interface ，不要传递指针。
+
+### 6.1 函数参数
+
+- 如果函数返回相同类型的两个或三个参数，或者如果从上下文中不清楚结果的含义，使用命名返回，其他情况不建议使用命名返回，例如：
+
+```go
+func coordinate() (x, y float64, err error) {
+	// normal code
+}
+```
+- 传入变量和返回变量都以小写字母开头。
+- 尽量用值传递，非指针传递。
+- 参数数量均不能超过5个。
+- 多返回值最多返回三个，超过三个请使用 struct。
+
+### 6.2 defer
+
+- 当存在资源创建时，应紧跟defer释放资源(可以大胆使用defer，defer在Go1.14版本中，性能大幅提升，defer的性能损耗即使在性能敏感型的业务中，也可以忽略)。
+- 先判断是否错误，再defer释放资源，例如：
+
+```go
+rep, err := http.Get(url)
+if err != nil {
+    return err
+}
+
+defer resp.Body.Close()
+```
+
+### 6.3 方法的接收器
+
+- 推荐以类名第一个英文首字母的小写作为接收器的命名。
+- 接收器的命名在函数超过20行的时候不要用单字符。
+- 接收器的命名不能采用me、this、self这类易混淆名称。
+
+### 6.4 嵌套
+- 嵌套深度不能超过4层。
+
+### 6.5 变量命名
+- 变量声明尽量放在变量第一次使用的前面，遵循就近原则。
+- 如果魔法数字出现超过两次，则禁止使用，改用一个常量代替，例如：
+
+```go
+// PI ...
+const Prise = 3.14
+
+func getAppleCost(n float64) float64 {
+	return Prise * n
+}
+
+func getOrangeCost(n float64) float64 {
+	return Prise * n
+}
+```
+
+## 7. GOPATH 设置规范
+- Go 1.11 之后，弱化了 GOPATH 规则，已有代码（很多库肯定是在1.11之前建立的）肯定符合这个规则，建议保留 GOPATH 规则，便于维护代码。
+- 建议只使用一个 GOPATH，不建议使用多个 GOPATH。如果使用多个GOPATH，编译生效的 bin 目录是在第一个 GOPATH 下。
+
+## 8. 依赖管理
+
+- Go 1.11 以上必须使用 Go Modules。
+- 使用Go Modules作为依赖管理的项目时，不建议提交vendor目录。
+- 使用Go Modules作为依赖管理的项目时，必须提交go.sum文件。
+
+### 9. 最佳实践
+
+- 尽量少用全局变量，而是通过参数传递，使每个函数都是“无状态”的。这样可以减少耦合，也方便分工和单元测试。
+- 在编译时验证接口的符合性，例如：
+
+```go
+type LogHandler struct {
+  h   http.Handler
+  log *zap.Logger
+}
+var _ http.Handler = LogHandler{}
+```
+- 服务器处理请求时，应该创建一个context，保存该请求的相关信息（如requestID），并在函数调用链中传递。
+
+### 9.1 性能
+- string 表示的是不可变的字符串变量，对 string 的修改是比较重的操作，基本上都需要重新申请内存。所以，如果没有特殊需要，需要修改时多使用 []byte。
+- 优先使用 strconv 而不是 fmt。
+
+### 9.2 注意事项
+
+- append 要小心自动分配内存，append 返回的可能是新分配的地址。
+- 如果要直接修改 map 的 value 值，则 value 只能是指针，否则要覆盖原来的值。
+- map 在并发中需要加锁。
+- 编译过程无法检查 interface{} 的转换，只能在运行时检查，小心引起 panic。
+
+## 总结
+
+这里向你介绍了九类常用的编码规范。但今天的最后，我要在这里提醒你一句：规范是人定的，你也可以根据需要，制定符合你项目的规范，但同时我也建议你采纳这些业界沉淀下来的规范，并通过工具来确保规范的执行。