fix: docker release v3.1.1 images optimize

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

.env

@@ -1,5 +1,5 @@
 USER=root
 PASSWORD=openIM123
-MINIO_ENDPOINT=http://116.30.3.80:10005
-API_URL=http://116.30.3.80:10002/object/
-DATA_DIR=./
+MINIO_ENDPOINT=http://116.30.3.14:10005
+API_URL=http://116.30.3.14: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,45 @@
+# 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:

.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

@@ -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: Assign issue to comment author
 on:
   issue_comment:

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

@@ -1,42 +1,41 @@
+# 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
-
-env:
-  GH_TOKEN: ${{ secrets.REDBOT_GITHUB_TOKEN }}
-  ISSUE: ${{ github.event.issue.html_url }}
-  OWNER: ${{ github.repository_owner }}
-  REPO: ${{ github.event.repository.name }}
+  issue_comment:
+    types: [created]
+  pull_request_review_comment:
+    types: [created]
 
 jobs:
   create-pr:
     runs-on: ubuntu-latest
-    if: github.event.pull_request.merged == true && github.event.pull_request.base.ref == 'main'
+    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: Setup GitHub CLI
-          run: |
-            sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-key C99B11DEB97541F0
-            sudo apt-add-repository https://cli.github.com/packages
-            sudo apt-get update
-            sudo apt-get install gh
-          continue-on-error: true
-
-        - name: Configure GitHub CLI
-          run: |
-            git config --global user.email "3293172751ysy@gmail.com"
-            git config --global user.name "kubbot"
-            echo "${{ secrets.BOT_GITHUB_TOKEN }}" | gh auth login --with-token
         - name: Create PR to release branch
           run: |
-            ISSUEID=$(gh pr view 642 --repo $OWNER/$REPO | grep -oP 'Fixes #\K\d+')
+            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"
@@ -46,12 +45,16 @@ jobs:
             MILESTONE=$(echo $ISSUE | jq -r '.milestone | select(.title) | .title')
             TITLE=$(echo $ISSUE | jq -r '.title')
 
-            echo $ISSUE | jq
-
             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"
+            # 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:

.github/workflows/auto-tag.yml

@@ -0,0 +1,38 @@
+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

@@ -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: 'Github Rebot for Cherry Pick when PR is merged'
 on:
   pull_request_target:

.github/workflows/bot-cherry-pick.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 Cherry Pick On Comment
 on:
   issue_comment:

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

@@ -12,38 +12,126 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-name: OpenIM Build Docker Images
+name: Publish Docker image
+
 on:
   push:
+    branches:
+      - main
+      - release-*
     tags:
       - v*
+  workflow_dispatch:
+
+env:
+  # Common versions
+  GO_VERSION: "1.20"
+
 jobs:
-  build:
+  build-dockerhub:
     runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        bin:
-          - openim-server
     steps:
       - name: Checkout
         uses: actions/checkout@v3
-      - name: Setup Docker Buildx
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v2
+      - name: Set up Docker Buildx
         uses: docker/setup-buildx-action@v2
-      - name: Login to GitHub Container Registry
+
+# 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: Docker metadata
-        id: metadata
-        uses: docker/metadata-action@v4
+
+      - name: Build and push Docker image
+        uses: docker/build-push-action@v4
         with:
-          images: ghcr.io/${{ github.repository_owner }}/openim-${{ matrix.bin }}
-      - name: Build and release Docker images
-        uses: docker/build-push-action@v3
-        with:
-          platforms: linux/386,linux/amd64,linux/arm64/v8
-          target: ${{ matrix.bin }}
-          tags: ${{ steps.metadata.outputs.tags }}
-          push: true
+          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,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: Check-Coverage
 
 on:

.github/workflows/cla.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: "OpenIM CLA Assistant"
 on:
   issue_comment:

.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,62 @@
+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

@@ -1,45 +1,73 @@
-name: deploy for dev
+# 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
-        paths:
-            - '.github/workflows/*'
-            # - '__test__/**' # dev No immediate testing is required
-            - 'src/**'
-            - 'Dockerfile'
-            - 'docker-compose.yml'
-            - 'bin/*'
+  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
+  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
 
-        steps:
-            - uses: actions/checkout@v2
-            - name: set ssh key # Temporarily set up ssh key
-              run: |
-                  mkdir -p ~/.ssh/
-                  # secrets.WFP_ID_RSA set in GitHub
-                  echo "${{secrets.WFP_ID_RSA}}" > ~/.ssh/id_rsa
-                  chmod 600 ~/.ssh/id_rsa
-                  ssh-keyscan "182.92.xxx.xxx" >> ~/.ssh/known_hosts
-            - 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
+    #   - 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/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

@@ -1,2 +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/gosec.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 Run Gosec
 
 # gosec is a source code security audit tool for the Go language. It performs a static 

.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:

.github/workflows/image.yml

@@ -17,7 +17,7 @@ name: Build Image
 on:
   push:
     branches:
-      - main
+      - release-v*
     paths:
       - "**.go"
       - "!**_test.go"

.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,12 +1,23 @@
+# 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
 on:
   schedule:
     - cron: '30 12 * * 1'
-  push:
-    branches:
-      - main
 
 jobs:
   linkChecker:

.github/workflows/lock-issue.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: 'Lock Threads'
 
 on:

.github/workflows/milestone.yml

@@ -0,0 +1,58 @@
+# 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@d7906e4ad0b1822421a7e6a35d5ca353c962f410 # 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,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 Commit Action'
 
 on:

.github/workflows/openimci.yml

@@ -90,19 +90,11 @@ jobs:
           echo "Run unit test and get test coverage successfully" 
         continue-on-error: true
 
-      - name: Initialize CodeQL
-        uses: github/codeql-action/init@v2
-        with:
-          languages: go
-
       - name: 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
@@ -128,6 +120,14 @@ jobs:
         #   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: |

.github/workflows/project-progress.yml

@@ -33,4 +33,4 @@ jobs:
         with:
           project: OpenIM-V3.1
           column: In Progress
-          repo-token: ${{ secrets.GITHUB_TOKEN }}
+          repo-token: ${{ secrets.BOT_GITHUB_TOKEN }}

.github/workflows/pull-request.yml

@@ -1,11 +1,24 @@
+# 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'
-
+      - 'CONTRIBUTING.md'
       - 'docs/**'
   pull_request:
     branches: [main]
@@ -22,18 +35,80 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - 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@v2
+      - 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:
-          token: ${{ secrets.BOT_GITHUB_TOKEN }}
-          commit-message: 'build: update distribution'
-          title: 'build: update distribution'
+          commit-message: "cicd: bump League Patch to cicd/patch-${{ github.event.number }}"
+          title: Bump League Patch to cicd/patch-${{ github.event.number }}
           body: |
-            - Updates the distribution for changes on `main`
-
-            Auto-generated by [create-pull-request][1]
-
-            [1]: https://github.com/OpenIMSDK/Open-IM-Sever
-          branch: 'bot/update-distribution'
+            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

@@ -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 Server Release
 
 on:

.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: 

.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.

.golangci.yml

@@ -114,7 +114,7 @@ linters-settings:
     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.

.goreleaser.yaml

@@ -36,8 +36,9 @@ builds:
       - ppc64le
       - arm64
     goarm:
-      - 6
-      - 7
+      - "6"
+      - "7"
+
   - binary: openim-cmdutils
     id: openim-cmdutils
     main: ./cmd/openim-cmdutils/main.go
@@ -53,8 +54,9 @@ builds:
       - ppc64le
       - arm64
     goarm:
-      - 6
-      - 7
+      - "6"
+      - "7"
+
   - binary: openim-crontask
     id: openim-crontask
     main: ./cmd/openim-crontask/main.go
@@ -70,8 +72,9 @@ builds:
       - ppc64le
       - arm64
     goarm:
-      - 6
-      - 7
+      - "6"
+      - "7"
+
   - binary: openim-msggateway
     id: openim-msggateway
     main: ./cmd/openim-msggateway/main.go
@@ -87,8 +90,9 @@ builds:
       - ppc64le
       - arm64
     goarm:
-      - 6
-      - 7
+      - "6"
+      - "7"
+
   - binary: openim-msgtransfer
     id: openim-msgtransfer
     main: ./cmd/openim-msgtransfer/main.go
@@ -104,8 +108,9 @@ builds:
       - ppc64le
       - arm64
     goarm:
-      - 6
-      - 7
+      - "6"
+      - "7"
+
   - binary: openim-push
     id: openim-push
     main: ./cmd/openim-push/main.go
@@ -121,8 +126,9 @@ builds:
       - ppc64le
       - arm64
     goarm:
-      - 6
-      - 7
+      - "6"
+      - "7"
+
   - binary: openim-rpc-auth
     id: openim-rpc-auth
     main: ./cmd/openim-rpc/openim-rpc-auth/main.go
@@ -138,8 +144,9 @@ builds:
       - ppc64le
       - arm64
     goarm:
-      - 6
-      - 7
+      - "6"
+      - "7"
+
   - binary: openim-rpc-conversation
     id: openim-rpc-conversation
     main: ./cmd/openim-rpc/openim-rpc-conversation/main.go
@@ -155,8 +162,9 @@ builds:
       - ppc64le
       - arm64
     goarm:
-      - 6
-      - 7
+      - "6"
+      - "7"
+
   - binary: openim-rpc-friend
     id: openim-rpc-friend
     main: ./cmd/openim-rpc/openim-rpc-friend/main.go
@@ -172,8 +180,9 @@ builds:
       - ppc64le
       - arm64
     goarm:
-      - 6
-      - 7
+      - "6"
+      - "7"
+
   - binary: openim-rpc-group
     id: openim-rpc-group
     main: ./cmd/openim-rpc/openim-rpc-group/main.go
@@ -189,8 +198,9 @@ builds:
       - ppc64le
       - arm64
     goarm:
-      - 6
-      - 7
+      - "6"
+      - "7"
+
   - binary: openim-rpc-msg
     id: openim-rpc-msg
     main: ./cmd/openim-rpc/openim-rpc-msg/main.go
@@ -206,8 +216,9 @@ builds:
       - ppc64le
       - arm64
     goarm:
-      - 6
-      - 7
+      - "6"
+      - "7"
+
   - binary: openim-rpc-third
     id: openim-rpc-third
     main: ./cmd/openim-rpc/openim-rpc-third/main.go
@@ -223,8 +234,9 @@ builds:
       - ppc64le
       - arm64
     goarm:
-      - 6
-      - 7
+      - "6"
+      - "7"
+
   - binary: openim-rpc-user
     id: openim-rpc-user
     main: ./cmd/openim-rpc/openim-rpc-user/main.go
@@ -240,8 +252,8 @@ builds:
       - ppc64le
       - arm64
     goarm:
-      - 6
-      - 7
+      - "6"
+      - "7"
 
 archives:
   - format: tar.gz
@@ -323,6 +335,66 @@ changelog:
     - 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
@@ -375,8 +447,8 @@ milestones:
     # Repository for the milestone
     # Default is extracted from the origin remote URL
     repo:
-      owner: user
-      name: repo
+      owner: OpenIMSDK
+      name: Open-IM-Server
 
     # Whether to close the milestone
     close: true
@@ -407,42 +479,53 @@ checksum:
   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
 
-    This release is only possible thanks to **all** the support of some **awesome people**!
+    + We release logs are recorded on [✨CHANGELOG](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/CHANGELOG/CHANGELOG.md)
 
-    Want to be one of them?
-    Contributions to this project are welcome! Please see [CONTRIBUTING.md](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/CONTRIBUTING.md) for details.
+    + 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/openimbot/openimbot/blob/main/assets/icon/blue%E9%80%8F%E6%98%8E.png" style="float: left; margin-right: 10px;">
+        <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/openimbot/blob/main/assets/icon/red%E9%80%8F%E6%98%8E.png" style="float: right; margin-left: 10px;">
+        <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.
 
-    ## Contact Us
+    ## Get Involved with OpenIM!
 
-    We value close connections with our users, developers, and contributors here at OpenIMSDK. With a large community and maintainer team, we're always here to help and support you. Whether you're looking to join our community or have any questions or suggestions, we welcome you to get in touch with us.
+    **Here are some ways to get involved with the OpenIM community:**
 
-    Our most recommended way to get in touch is through [Slack](https://join.slack.com/t/openimsdk/shared_invite/zt-1tmoj26uf-_FDy3dowVHBiGvLk9e5Xkg). Even if you're in China, Slack is usually not blocked by firewalls, making it an easy way to connect with us. Our Slack community is the ideal place to discuss and share ideas and suggestions with other users and developers of OpenIMSDK. You can ask technical questions, seek help, or share your experiences with other users of OpenIMSDK.
+    📢 **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.
 
-    In [OpenIM community is recruiting new members! discussion](https://github.com/orgs/OpenIMSDK/discussions/426) please leave your information, convenient we will better developers around the small gift to send to your hands.
+    📧 **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).
 
-    In addition to Slack, we also offer the following ways to get in touch:
+    📖 **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.
 
-    + <a href="https://join.slack.com/t/openimsdk/shared_invite/zt-1tmoj26uf-_FDy3dowVHBiGvLk9e5Xkg" target="_blank"><img src="https://img.shields.io/badge/slack-%40OpenIMSDKCore-informational?logo=slack&style=flat-square"></a>:  We also have Slack channels for you to communicate and discuss. To join, visit https://slack.com/ and join our [👀 Open-IM-Server slack](https://join.slack.com/t/openimsdk/shared_invite/zt-1tmoj26uf-_FDy3dowVHBiGvLk9e5Xkg) team channel.
-    + <a href="https://mail.google.com/mail/u/0/?fs=1&tf=cm&to=4closetool3@gmail.com" target="_blank"><img src="https://img.shields.io/badge/gmail-%40OOpenIMSDKCore?style=social&logo=gmail"></a>: Get in touch with us on [Gmail](winxu81@gmail.com). If you have any questions or issues that need resolving, or any suggestions and feedback for our open source projects, please feel free to contact us via email.
-    + <a href="https://doc.rentsoft.cn/" target="_blank"><img src="https://img.shields.io/badge/%E5%8D%9A%E5%AE%A2-%40OpenIMSDKCore-blue?style=social&logo=Octopus%20Deploy"></a>: Read our [blog](https://doc.rentsoft.cn/). Our blog is a great place to stay up-to-date with Open-IM-Server projects and trends. On the blog, we share our latest developments, tech trends, and other interesting information.
-    + <a href="https://github.com/OpenIMSDK/OpenIM-Docs/blob/main/docs/images/WechatIMG20.jpeg" target="_blank"><img src="https://img.shields.io/badge/%E5%BE%AE%E4%BF%A1-OpenIMSDKCore-brightgreen?logo=wechat&style=flat-square"></a>: Add [Wechat](https://github.com/OpenIMSDK/OpenIM-Docs/blob/main/docs/images/WechatIMG20.jpeg) and indicate that you are a user or developer of Open-IM-Server. We will process your request as soon as possible.
+    📱 **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.
 
-    Whether you're looking to join our community or have any questions or suggestions, we welcome you to get in touch with us.
+    Remember, your contributions play a vital role in making OpenIM successful, and we look forward to your active participation in our community! 🙌

CHANGELOG/CHANGELOG.md

@@ -1,6 +1,7 @@
 # Changelog
 
 - [Changelog](#changelog)
+  - [OpenIM versioning policy](#openim-versioning-policy)
   - [command](#command)
   - [create next tag](#create-next-tag)
   - [Release version logs](#release-version-logs)
@@ -15,6 +16,10 @@ 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

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.

Dockerfile

@@ -1,10 +1,6 @@
 # Build Stage
 FROM golang:1.20 AS builder
 
-LABEL org.opencontainers.image.source=https://github.com/OpenIMSDK/Open-IM-Server
-LABEL org.opencontainers.image.description="OpenIM Server image"
-LABEL org.opencontainers.image.licenses="Apache 2.0"
-
 # Set go mod installation source and proxy
 ARG GO111MODULE=on
 ARG GOPROXY=https://goproxy.cn,direct
@@ -12,25 +8,26 @@ ENV GO111MODULE=$GO111MODULE
 ENV GOPROXY=$GOPROXY
 
 # Set up the working directory
-WORKDIR /Open-IM-Server
+WORKDIR /openim/openim-server
+
+COPY go.mod go.sum ./
+RUN go mod download
 
 # Copy all files to the container
 ADD . .
 
+RUN /bin/sh -c "make clean"
 RUN /bin/sh -c "make build"
 
-# Production Stage
-FROM alpine
+FROM ghcr.io/openim-sigs/openim-bash-image:v1.3.0
 
-RUN apk --no-cache add tzdata
-
-# Set directory to map logs, config files, scripts, and SDK
-VOLUME ["/Open-IM-Server/logs", "/Open-IM-Server/config", "/Open-IM-Server/scripts", "/Open-IM-Server/db/sdk"]
+WORKDIR ${SERVER_WORKDIR}
 
 # Copy scripts and binary files to the production image
-COPY --from=builder /Open-IM-Server/scripts /Open-IM-Server/scripts
-COPY --from=builder /Open-IM-Server/_output/bin/platforms/linux/amd64 /Open-IM-Server/_output/bin/platforms/linux/amd64
+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
 
-WORKDIR /Open-IM-Server/scripts
+VOLUME ["/openim/openim-server/logs","/openim/openim-server/config","/openim/openim-server/scripts"]
 
-CMD ["docker_start_all.sh"]
+CMD ["bash","-c","${OPENIM_SERVER_CMDDIR}/docker_start_all.sh"]

Makefile

@@ -68,6 +68,11 @@ multiarch:
 install:
 	@$(MAKE) go.install
 
+## check: Check OpenIM deployment ✨
+.PHONY: check
+check:
+	@$(MAKE) go.check
+
 ## tidy: tidy go.mod ✨
 .PHONY: tidy
 tidy:
@@ -176,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.md

@@ -13,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>
@@ -51,15 +51,15 @@ Open-IM-Server is not a standalone product and does not include account registra
 
 1. Clone the project
 
-```
-clone https://github.com/OpenIMSDK/Open-IM-Server 
-cd Open-IM-Server
-git checkout release-v3.0 #or other release branch
+```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. Modify .env
+2. Modify .env
 
-```
+```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,
@@ -67,20 +67,19 @@ API_URL=http://127.0.0.1:10002/object/ #the app must be able to access this IP a
 DATA_DIR=./  #designate large disk directory
 ```
 
-1. Deploy and start
+3. Deploy and start
 
-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.
+> **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.
 
 ```
-chmod +x install_im_server.sh;
-./install_im_server.sh;
+make install
 ```
 
-1. Check the service
+4. Check the service
 
-```
-cd scripts;
-./docker_check_service.sh
+```bash
+make check
 ```
 
 ![https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/images/docker_build.png](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/images/docker_build.png)
@@ -89,23 +88,18 @@ cd scripts;
 
 ### Compile from source
 
-1. Go 1.18 or higher version.
+Ur need `Go 1.18` or higher version, and `make`.
 
-2. Clone
+Version Details: https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/version.md
 
-   ```
-   git clone https://github.com/OpenIMSDK/Open-IM-Server 
-   cd Open-IM-Server
-   git checkout release-v3.0 #or other release branch
-   ```
+```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)
 
-3. Compile
-
-   ```
-   cd Open-IM-server/scripts
-   chmod +x *.sh
-   ./build_all_service.sh
-   ```
+`make help` to help you see the instructions supported by OpenIM.
 
 All services have been successfully built as shown in the figure
 

build/docker/openim-api/Dockerfile

@@ -0,0 +1,32 @@
+# 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:v1.3.0
+
+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,31 @@
+# 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:v1.3.0
+
+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,30 @@
+# 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:v1.3.0
+
+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,36 @@
+# 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:v1.3.0
+
+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,33 @@
+# 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:v1.3.0
+
+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,35 @@
+# 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:v1.3.0
+
+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,38 @@
+# 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:v1.3.0
+
+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,45 @@
+# 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:v1.3.0
+
+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,45 @@
+# 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:v1.3.0
+
+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,45 @@
+# 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:v1.3.0
+
+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,45 @@
+# 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:v1.3.0
+
+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,44 @@
+# 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:v1.3.0
+
+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,44 @@
+# 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:v1.3.0
+
+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

@@ -28,9 +28,9 @@ import (
 
 	"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/db/cache"
-	"github.com/OpenIMSDK/tools/config"
-	"github.com/OpenIMSDK/tools/constant"
+	"github.com/OpenIMSDK/protocol/constant"
 	"github.com/OpenIMSDK/tools/discoveryregistry"
 	openKeeper "github.com/OpenIMSDK/tools/discoveryregistry/zookeeper"
 	"github.com/OpenIMSDK/tools/log"

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-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-push/main.go

@@ -17,7 +17,7 @@ package main
 import (
 	"github.com/OpenIMSDK/Open-IM-Server/internal/push"
 	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/cmd"
-	"github.com/OpenIMSDK/tools/config"
+	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/config"
 )
 
 func main() {

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-auth/main.go

@@ -17,7 +17,7 @@ package main
 import (
 	"github.com/OpenIMSDK/Open-IM-Server/internal/rpc/auth"
 	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/cmd"
-	"github.com/OpenIMSDK/tools/config"
+	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/config"
 )
 
 func main() {

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-conversation/main.go

@@ -17,7 +17,7 @@ package main
 import (
 	"github.com/OpenIMSDK/Open-IM-Server/internal/rpc/conversation"
 	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/cmd"
-	"github.com/OpenIMSDK/tools/config"
+	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/config"
 )
 
 func main() {

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-friend/main.go

@@ -17,7 +17,7 @@ package main
 import (
 	"github.com/OpenIMSDK/Open-IM-Server/internal/rpc/friend"
 	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/cmd"
-	"github.com/OpenIMSDK/tools/config"
+	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/config"
 )
 
 func main() {

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-group/main.go

@@ -17,7 +17,7 @@ package main
 import (
 	"github.com/OpenIMSDK/Open-IM-Server/internal/rpc/group"
 	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/cmd"
-	"github.com/OpenIMSDK/tools/config"
+	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/config"
 )
 
 func main() {

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-msg/main.go

@@ -17,7 +17,7 @@ package main
 import (
 	"github.com/OpenIMSDK/Open-IM-Server/internal/rpc/msg"
 	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/cmd"
-	"github.com/OpenIMSDK/tools/config"
+	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/config"
 )
 
 func main() {

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-third/main.go

@@ -17,7 +17,7 @@ package main
 import (
 	"github.com/OpenIMSDK/Open-IM-Server/internal/rpc/third"
 	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/cmd"
-	"github.com/OpenIMSDK/tools/config"
+	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/config"
 )
 
 func main() {

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"]

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

@@ -17,7 +17,7 @@ package main
 import (
 	"github.com/OpenIMSDK/Open-IM-Server/internal/rpc/user"
 	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/cmd"
-	"github.com/OpenIMSDK/tools/config"
+	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/config"
 )
 
 func main() {

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 ]            #目前仅支持单机
+  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                      #慢语句阈值 （毫秒）
+  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 默认即可
+  uri:
+  address: [ 127.0.0.1:37017 ]
+  database: openIM_v3
   username: root
   password: openIM123
-  maxPoolSize: 100
+  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
+  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/"  #地址需要app能访问到
+  enable: "minio"                         
+  apiURL: http://127.0.0.1:10002/object/
   minio:
-    bucket: "openim"                      #不建议修改
-    endpoint: http://127.0.0.1:10005      #地址需要app能够访问
+    bucket: "openim"                      
+    endpoint: http://127.0.0.1:10005
     accessKeyID: root
     secretAccessKey: openIM123
-    sessionToken: ""            #token
-  cos: #tencent cos
+    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"
 
+# 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

@@ -100,16 +100,15 @@ services:
 
 
   openim_server:
-    image: ghcr.io/openimsdk/openim-server:v3.0
+    image: ghcr.io/openim-sigs/openim-server:v1.0.0-debug.0 #ghcr.io/openimsdk/openim-server:latels
     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
@@ -123,8 +122,12 @@ services:
         max-file: "2"
 
   openim_chat:
-    image: ghcr.io/openimsdk/openim-chat:v1.0.0
+    image: ghcr.io/openim-sigs/openim-chat:v1.0.0-debug.0 #ghcr.io/openimsdk/openim-chat:latels
     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

@@ -65,7 +65,7 @@ cmd/*
 config/*    @skiffer-git
 
 # db directory
-db/sdk  @BanTanger @cubxxw @Gordon  
+db/sdk  @cubxxw @FGadvancer  
 
 # internal directory
 internal/ @openimsdk/openim @skiffer-git @FGadvancer

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。
+
+## 总结
+
+这里向你介绍了九类常用的编码规范。但今天的最后，我要在这里提醒你一句：规范是人定的，你也可以根据需要，制定符合你项目的规范，但同时我也建议你采纳这些业界沉淀下来的规范，并通过工具来确保规范的执行。

docs/conversions/images.md

@@ -0,0 +1,95 @@
+# OpenIM Image Management Strategy and Pulling Guide
+
+OpenIM is an efficient, stable, and scalable instant messaging framework that provides convenient deployment methods through Docker images. OpenIM manages multiple image sources, hosted respectively on GitHub (ghcr), Alibaba Cloud, and Docker Hub. This document is aimed at detailing the image management strategy of OpenIM and providing the steps for pulling these images.
+
+
+## Image Management Strategy
+
+OpenIM's versions correspond to GitHub's tag versions. Each time we release a new version and tag it on GitHub, an automated process is triggered that pushes the new Docker image version to the following three platforms:
+
+1. **GitHub (ghcr.io):** We use GitHub Container Registry (ghcr.io) to host OpenIM's Docker images. This allows us to better integrate with the GitHub source code repository, providing better version control and continuous integration/deployment (CI/CD) features. You can view all GitHub images [here](https://github.com/orgs/OpenIMSDK/packages).
+2. **Alibaba Cloud (registry.cn-hangzhou.aliyuncs.com):** For users in Mainland China, we also host OpenIM's Docker images on Alibaba Cloud to provide faster pull speeds. You can view all Alibaba Cloud images on this [page](https://cr.console.aliyun.com/cn-hangzhou/instances/repositories) of Alibaba Cloud Image Service (note that you need to log in to your Alibaba Cloud account first).
+3. **Docker Hub (docker.io):** Docker Hub is the most commonly used Docker image hosting platform, and we also host OpenIM's images there to facilitate developers worldwide. You can view all Docker Hub images on the [OpenIM's Docker Hub page](https://hub.docker.com/r/openim).
+
+
+## OpenIM Image Design and Usage Guide
+
+OpenIM offers a comprehensive and flexible system of Docker images, available across multiple repositories. We actively maintain these images across different platforms, namely GitHub's ghcr.io, Alibaba Cloud, and Docker Hub. However, we highly recommend ghcr.io for deployment.
+
+### Available Versions
+
+We provide multiple versions of our images to meet different project requirements. Here's a quick overview of what you can expect:
+
+1. `main`: This image corresponds to the latest version of the main branch in OpenIM. It is updated frequently, making it perfect for users who want to stay at the cutting edge of our features.
+2. `release-v3.*`: This is the image that corresponds to the latest version of OpenIM's stable release branch. It's ideal for users who prefer a balance between new features and stability.
+3. `v3.*.*`: These images are specific to each tag in OpenIM. They are preserved in their original state and are never overwritten. These are the go-to images for users who need a specific, unchanging version of OpenIM.
+
+### Multi-Architecture Images
+
+In order to cater to a wider range of needs, some of our images are provided with multiple architectures under `OS / Arch`. These images offer greater compatibility across different operating systems and hardware architectures, ensuring that OpenIM can be deployed virtually anywhere.
+
+**Example:**
+
++ [https://github.com/OpenIMSDK/chat/pkgs/container/openim-chat/113925695?tag=v1.1.0](https://github.com/OpenIMSDK/chat/pkgs/container/openim-chat/113925695?tag=v1.1.0)
+
+
+## Methods and Steps for Pulling Images
+
+When pulling OpenIM's Docker images, you can choose the most suitable source based on your geographic location and network conditions. Here are the steps to pull OpenIM images from each source:
+
+### Select image
+
+1. Choose the image repository platform you prefer. As previously mentioned, we recommend [OpenIM ghcr.io](https://github.com/orgs/OpenIMSDK/packages).
+
+2. Choose the image name and image version that suits your needs. Refer to the description above for more details.
+
+
+### Install image
+
+1. First, make sure Docker is installed on your machine. If not, you can refer to the [Docker official documentation](https://docs.docker.com/get-docker/) for installation.
+
+2. Open the terminal and run the following commands to pull the images:
+
+   For OpenIM Server:
+
+   - Pull from GitHub:
+
+     ```bash
+     docker pull ghcr.io/openimsdk/openim-server:latest
+     ```
+
+   - Pull from Alibaba Cloud:
+
+     ```bash
+     docker pull registry.cn-hangzhou.aliyuncs.com/openimsdk/openim-server:latest
+     ```
+
+   - Pull from Docker Hub:
+
+     ```bash
+     docker pull docker.io/openim/openim-server:latest
+     ```
+
+   For OpenIM Chat:
+
+   - Pull from GitHub:
+
+     ```bash
+     docker pull ghcr.io/openimsdk/openim-chat:latest
+     ```
+
+   - Pull from Alibaba Cloud:
+
+     ```bash
+     docker pull registry.cn-hangzhou.aliyuncs.com/openimsdk/openim-chat:latest
+     ```
+
+   - Pull from Docker Hub:
+
+     ```bash
+     docker pull docker.io/openim/openim-chat:latest
+     ```
+
+3. Run the `docker images` command to confirm that the image has been successfully pulled.
+
+This concludes OpenIM's image management strategy and the steps for pulling images. If you have any questions, please feel free to ask.

docs/conversions/logging.md

@@ -0,0 +1,20 @@
+##  Log Standards
+
+### Log Standards
+
+- The unified log package `github.com/OpenIMSDK/Open-IM-Server/internal/pkg/log` should be used for all logging;
+- Use structured logging formats: `log.Infow`, `log.Warnw`, `log.Errorw`, etc. For example: `log.Infow("Update post function called")`;
+- All logs should start with an uppercase letter and should not end with a `.`. For example: `log.Infow("Update post function called")`;
+- Use past tense. For example, use `Could not delete B` instead of `Cannot delete B`;
+- Adhere to log level standards:
+  - Debug level logs use `log.Debugw`;
+  - Info level logs use `log.Infow`;
+  - Warning level logs use `log.Warnw`;
+  - Error level logs use `log.Errorw`;
+  - Panic level logs use `log.Panicw`;
+  - Fatal level logs use `log.Fatalw`.
+- Log settings:
+  - Development and test environments: The log level is set to `debug`, the log format can be set to `console` / `json` as needed, and caller is enabled;
+  - Production environment: The log level is set to `info`, the log format is set to `json`, and caller is enabled. (**Note**: In the early stages of going online, to facilitate troubleshooting, the log level can be set to `debug`)
+- When logging, avoid outputting sensitive information, such as passwords, keys, etc.
+- If you are calling a logging function in a function/method with a `context.Context` parameter, it is recommended to use `log.L(ctx).Infow()` for logging.