feat: save server code

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

.dockerignore

@@ -1,4 +1,4 @@
-# Ignore files and directories starting with a dot
+<!-- # Ignore files and directories starting with a dot
 
 # Ignore specific files
 .dockerignore
@@ -15,7 +15,7 @@ CHANGELOG/
 # LICENSE
 
 # Ignore testing and linting configuration
-.golangci.yml
+scripts/golangci.yml
 
 # Ignore deployment-related files
 docker-compose.yaml
@@ -28,4 +28,4 @@ assets/
 components/
 
 # Ignore tools and scripts
-.github/
+.github/ -->

.github/dependabot.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.
+
 # 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:
@@ -9,3 +23,37 @@ updates:
     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/release-drafter.yml

@@ -0,0 +1,51 @@
+# 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-template: 'v$RESOLVED_VERSION 🌈'
+tag-template: 'v$RESOLVED_VERSION'
+categories:
+  - title: '🚀 Features'
+    labels:
+      - 'feature'
+      - 'enhancement'
+  - title: '🐛 Bug Fixes'
+    labels:
+      - 'kind/fix'
+      - 'kind/feature'
+      - 'enhancement'
+      - 'kind/documentation'
+      - 'good first issue'
+  - title: '🧰 Maintenance'
+    label: 'chore'
+change-template: '- $TITLE @$AUTHOR (#$NUMBER)'
+change-title-escapes: '\<*_&' # You can add # and @ to disable mentions, and add ` to disable code blocks.
+version-resolver:
+  major:
+    labels:
+      - 'major'
+  minor:
+    labels:
+      - 'minor'
+  patch:
+    labels:
+      - 'patch'
+  default: patch
+template: |
+  ## Changes $PREVIOUS_TAG
+
+  $CHANGES
+
+  ## Contributors to this $REPOSITORY	release
+
+  $CONTRIBUTORS	

.github/sync.yml

@@ -75,6 +75,17 @@ OpenIMSDK/OpenKF:
     dest: .github/.codecov.yml
     replace: false
 
+openim-sigs/openim-docker:
+  - source: ./config
+    dest: ./openim-server/config
+    replace: true
+  - source: ./docs
+    dest: ./openim-server/docs
+    replace: true
+  - source: ./scripts
+    dest: ./openim-server/scripts
+    replace: true
+
 group:
   # first group：common to all warehouses
   # TODO: add the required warehouse here

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

@@ -18,30 +18,21 @@ on:
   pull_request:
     # types:
     #   - closed
+  issue_comment:
+    types: [created]
+  pull_request_review_comment:
+    types: [created]
 
 jobs:
   create-pr:
     runs-on: ubuntu-latest
-    if: github.event.pull_request.base.ref == 'main'
+    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 ${{ github.event.pull_request.number }} --repo $OWNER/$REPO | grep -oP 'Fixes #\K\d+')
@@ -56,10 +47,9 @@ jobs:
 
             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 ""
-            
+            # 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:
@@ -67,4 +57,4 @@ jobs:
               GH_TOKEN: ${{ github.token }}
               ISSUE: ${{ github.event.issue.html_url }}
               OWNER: ${{ github.repository_owner }}
-              REPO: ${{ github.event.repository.name }}
+              REPO: ${{ github.event.repository.name }}

.github/workflows/auto-invite.yml

@@ -27,7 +27,7 @@ jobs:
     steps:
 
       - name: Invite user to join our group
-        uses: peter-evans/create-or-update-comment@v1
+        uses: peter-evans/create-or-update-comment@v3
         with:
           token: ${{ secrets.BOT_GITHUB_TOKEN }}
           issue-number: ${{ github.event.issue.number }}

.github/workflows/auto-tag.yml

@@ -0,0 +1,52 @@
+# Copyright © 2023 OpenIM. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+name: Create Tag
+
+on:
+  issue_comment:
+    types: [created]
+  pull_request_review_comment:
+    types: [created]
+
+jobs:
+  create_tag:
+    runs-on: ubuntu-latest
+    if: startsWith(github.event.comment.body, '/create tag')
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Validate version number and get comment
+        id: validate
+        run: |
+          COMMENT="${{ github.event.comment.body }}"
+          VERSION=$(echo $COMMENT | cut -d ' ' -f 3)
+          TAG_COMMENT=$(echo $COMMENT | cut -d '"' -f 2)
+          if [[ $VERSION =~ ^v([0-9]+\.){2}[0-9]+$ ]]; then
+            echo "version=$VERSION" >> $GITHUB_STATE
+            echo "tag_comment=$TAG_COMMENT" >> $GITHUB_STATE
+          else
+            echo "Invalid version number."
+            exit 1
+          fi
+
+      - name: Create a new tag
+        env:
+          GH_TOKEN: ${{ secrets.BOT_GITHUB_TOKEN }}
+        run: |
+          source $GITHUB_STATE
+          git tag -a $VERSION -m "$tag_comment"
+          git push origin $VERSION
+          echo "tag_created=$VERSION" >> $GITHUB_OUTPUT

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

@@ -23,7 +23,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Comment cherry-pick command
-        uses: actions/github-script@v5
+        uses: actions/github-script@v6
         with:
           script: |
             const pr = context.payload.pull_request;

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

@@ -23,7 +23,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout the latest code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
         with:
           token: ${{ secrets.BOT_GITHUB_TOKEN }}
           fetch-depth: 0 # otherwise, you will fail to push refs to dest repo

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

@@ -23,16 +23,20 @@ on:
       - v*
   workflow_dispatch:
 
+env:
+  # Common versions
+  GO_VERSION: "1.20"
+
 jobs:
-  build:
+  build-dockerhub:
     runs-on: ubuntu-latest
     steps:
-      - name: Check out the repo
+      - name: Checkout
         uses: actions/checkout@v3
-
-      - name: Build OpenIM Server
-        run: |
-          sudo make build
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v2
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v2
 
 # docker.io/openim/openim-server:latest
       - name: Extract metadata (tags, labels) for Docker
@@ -40,6 +44,15 @@ jobs:
         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
@@ -51,10 +64,21 @@ jobs:
         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
@@ -73,10 +97,21 @@ jobs:
         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
@@ -88,13 +123,15 @@ jobs:
         uses: docker/login-action@v2
         with:
           registry: ghcr.io
-          username: ${{ github.actor }}
+          username: ${{ github.repository_owner }}
           password: ${{ secrets.GITHUB_TOKEN }}
 
       - name: Build and push Docker image
         uses: docker/build-push-action@v4
         with:
           context: .
+          # linux/ppc64le,linux/s390x
+          platforms: linux/amd64,linux/arm64
           push: ${{ github.event_name != 'pull_request' }}
           tags: ${{ steps.meta3.outputs.tags }}
           labels: ${{ steps.meta3.outputs.labels }}

.github/workflows/check-coverage.yml

@@ -44,7 +44,7 @@ jobs:
         uses: actions/checkout@v3
 
       - name: Setup Golang with cache
-        uses: magnetikonline/action-golang-cache@v3
+        uses: magnetikonline/action-golang-cache@v4
         with:
           go-version: ${{ env.GO_VERSION }}
 

.github/workflows/create_branch_on_tag.yml

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

.github/workflows/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/images/openim-api/Dockerfile
+          platforms: linux/amd64,linux/arm64
+          push: ${{ github.event_name != 'pull_request' }}
+          tags: ${{ steps.meta1.outputs.tags }}
+          labels: ${{ steps.meta1.outputs.labels }}
+          cache-from: type=local,src=/tmp/.buildx-cache
+          cache-to: type=local,dest=/tmp/.buildx-cache
+
+      - name: Extract metadata (tags, labels) for Docker openim-cmdutils
+        id: meta2
+        uses: docker/metadata-action@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/images/openim-cmdutils/Dockerfile
+          platforms: linux/amd64,linux/arm64
+          push: ${{ github.event_name != 'pull_request' }}
+          tags: ${{ steps.meta2.outputs.tags }}
+          labels: ${{ steps.meta2.outputs.labels }}
+          cache-from: type=local,src=/tmp/.buildx-cache
+          cache-to: type=local,dest=/tmp/.buildx-cache
+
+      - name: Extract metadata (tags, labels) for Docker openim-crontask
+        id: meta3
+        uses: docker/metadata-action@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/images/openim-crontask/Dockerfile
+          platforms: linux/amd64,linux/arm64
+          push: ${{ github.event_name != 'pull_request' }}
+          tags: ${{ steps.meta3.outputs.tags }}
+          labels: ${{ steps.meta3.outputs.labels }}
+          cache-from: type=local,src=/tmp/.buildx-cache
+          cache-to: type=local,dest=/tmp/.buildx-cache
+
+      - name: Extract metadata (tags, labels) for Docker openim-msggateway
+        id: meta4
+        uses: docker/metadata-action@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/images/openim-msggateway/Dockerfile
+          platforms: linux/amd64,linux/arm64
+          push: ${{ github.event_name != 'pull_request' }}
+          tags: ${{ steps.meta4.outputs.tags }}
+          labels: ${{ steps.meta4.outputs.labels }}
+          cache-from: type=local,src=/tmp/.buildx-cache
+          cache-to: type=local,dest=/tmp/.buildx-cache
+
+      - name: Extract metadata (tags, labels) for Docker openim-msgtransfer
+        id: meta5
+        uses: docker/metadata-action@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/images/openim-msgtransfer/Dockerfile
+          platforms: linux/amd64,linux/arm64
+          push: ${{ github.event_name != 'pull_request' }}
+          tags: ${{ steps.meta5.outputs.tags }}
+          labels: ${{ steps.meta5.outputs.labels }}
+          cache-from: type=local,src=/tmp/.buildx-cache
+          cache-to: type=local,dest=/tmp/.buildx-cache
+          
+      - name: Extract metadata (tags, labels) for Docker openim-push
+        id: meta6
+        uses: docker/metadata-action@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/images/openim-push/Dockerfile
+          platforms: linux/amd64,linux/arm64
+          push: ${{ github.event_name != 'pull_request' }}
+          tags: ${{ steps.meta6.outputs.tags }}
+          labels: ${{ steps.meta6.outputs.labels }}
+          cache-from: type=local,src=/tmp/.buildx-cache
+          cache-to: type=local,dest=/tmp/.buildx-cache
+
+      - name: Extract metadata (tags, labels) for Docker openim-rpc-auth
+        id: meta7
+        uses: docker/metadata-action@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/images/openim-rpc-auth/Dockerfile
+          platforms: linux/amd64,linux/arm64
+          push: ${{ github.event_name != 'pull_request' }}
+          tags: ${{ steps.meta7.outputs.tags }}
+          labels: ${{ steps.meta7.outputs.labels }}
+          cache-from: type=local,src=/tmp/.buildx-cache
+          cache-to: type=local,dest=/tmp/.buildx-cache
+
+      - name: Extract metadata (tags, labels) for Docker openim-rpc-conversation
+        id: meta8
+        uses: docker/metadata-action@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/images/openim-rpc-conversation/Dockerfile
+          platforms: linux/amd64,linux/arm64
+          push: ${{ github.event_name != 'pull_request' }}
+          tags: ${{ steps.meta8.outputs.tags }}
+          labels: ${{ steps.meta8.outputs.labels }}
+          cache-from: type=local,src=/tmp/.buildx-cache
+          cache-to: type=local,dest=/tmp/.buildx-cache
+
+      - name: Extract metadata (tags, labels) for Docker openim-rpc-friend
+        id: meta9
+        uses: docker/metadata-action@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/images/openim-rpc-friend/Dockerfile
+          platforms: linux/amd64,linux/arm64
+          push: ${{ github.event_name != 'pull_request' }}
+          tags: ${{ steps.meta9.outputs.tags }}
+          labels: ${{ steps.meta9.outputs.labels }}
+          cache-from: type=local,src=/tmp/.buildx-cache
+          cache-to: type=local,dest=/tmp/.buildx-cache
+
+      - name: Extract metadata (tags, labels) for Docker openim-rpc-group
+        id: meta10
+        uses: docker/metadata-action@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/images/openim-rpc-group/Dockerfile
+          platforms: linux/amd64,linux/arm64
+          push: ${{ github.event_name != 'pull_request' }}
+          tags: ${{ steps.meta10.outputs.tags }}
+          labels: ${{ steps.meta10.outputs.labels }}
+          cache-from: type=local,src=/tmp/.buildx-cache
+          cache-to: type=local,dest=/tmp/.buildx-cache
+
+      - name: Extract metadata (tags, labels) for Docker openim-rpc-msg
+        id: meta11
+        uses: docker/metadata-action@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/images/openim-rpc-msg/Dockerfile
+          platforms: linux/amd64,linux/arm64
+          push: ${{ github.event_name != 'pull_request' }}
+          tags: ${{ steps.meta11.outputs.tags }}
+          labels: ${{ steps.meta11.outputs.labels }}
+          cache-from: type=local,src=/tmp/.buildx-cache
+          cache-to: type=local,dest=/tmp/.buildx-cache
+
+      - name: Extract metadata (tags, labels) for Docker openim-rpc-third
+        id: meta12
+        uses: docker/metadata-action@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/images/openim-rpc-third/Dockerfile
+          platforms: linux/amd64,linux/arm64
+          push: ${{ github.event_name != 'pull_request' }}
+          tags: ${{ steps.meta12.outputs.tags }}
+          labels: ${{ steps.meta12.outputs.labels }}
+          cache-from: type=local,src=/tmp/.buildx-cache
+          cache-to: type=local,dest=/tmp/.buildx-cache
+
+      - name: Extract metadata (tags, labels) for Docker openim-rpc-user
+        id: meta13
+        uses: docker/metadata-action@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/images/openim-rpc-user/Dockerfile
+          platforms: linux/amd64,linux/arm64
+          push: ${{ github.event_name != 'pull_request' }}
+          tags: ${{ steps.meta13.outputs.tags }}
+          labels: ${{ steps.meta13.outputs.labels }}
+          cache-from: type=local,src=/tmp/.buildx-cache
+          cache-to: type=local,dest=/tmp/.buildx-cache

.github/workflows/golangci-lint.yml

@@ -42,7 +42,7 @@ jobs:
             # 
             # Note: by default the `.golangci.yml` file should be at the root of the repository.
             # The location of the configuration file can be changed by using `--config=`
-            # args: --timeout=30m --config=/my/path/.golangci.yml --issues-exit-code=0
+            args: --timeout=30m --config=/scripts/golangci.yml # --issues-exit-code=0
 
             # Optional: show only new issues if it's a pull request. The default value is `false`.
             # only-new-issues: true

.github/workflows/greetings.yml

@@ -0,0 +1,45 @@
+# Copyright © 2023 OpenIM. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+name: first-interaction
+
+on:
+  issues:
+    types: [opened]
+  pull_request:
+    branches: [main]
+    types: [opened]
+
+jobs:
+  check_for_first_interaction:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/first-interaction@main
+        with:
+          repo-token: ${{ secrets.BOT_GITHUB_TOKEN }}
+          issue-message: |
+            Hello! Thank you for filing an issue.
+
+            If this is a bug report, please include relevant logs to help us debug the problem.
+            
+            [Join slack 🤖](https://join.slack.com/t/openimsdk/shared_invite/zt-1tmoj26uf-_FDy3dowVHBiGvLk9e5Xkg) to connect and communicate with our developers.
+          pr-message: |
+            Hello! Thank you for your contribution.
+            
+            If you are fixing a bug, please reference the issue number in the description.
+
+            If you are implementing a feature request, please check with the maintainers that the feature will be accepted first.
+
+            [Join slack 🤖](https://join.slack.com/t/openimsdk/shared_invite/zt-1tmoj26uf-_FDy3dowVHBiGvLk9e5Xkg) to connect and communicate with our developers.

.github/workflows/image.yml

@@ -1,95 +0,0 @@
-# Copyright © 2023 OpenIM open source community. All rights reserved.
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-name: Build Image
-
-on:
-  push:
-    branches:
-      - main
-    paths:
-      - "**.go"
-      - "!**_test.go"
-      - "build/**"
-    tags:
-      - v*
-
-jobs:
-  release:
-    strategy:
-      matrix:
-        components: [core, swagger]
-    runs-on: ubuntu-20.04
-    steps:
-      - uses: actions/checkout@v3
-        with:
-          fetch-depth: 20
-      - uses: dorny/paths-filter@v2
-        if: ${{ !startsWith(github.ref_name, 'v') }}
-        id: changes
-        with:
-          filters: |
-            go:
-              - '**.go'
-              - 'build/core/Dockerfile'
-            api:
-              - 'openapi/**'
-              - 'build/swagger/build.sh'
-              - 'build/swagger/Dockerfile'
-      - name: Docker meta
-        id: meta
-        uses: docker/metadata-action@v4
-        with:
-          flavor: |
-            latest=false
-          images: |
-            ${{ secrets.DOCKERHUB_USERNAME }}/openimsdk-${{ matrix.components }}
-            registry.cn-hangzhou.aliyuncs.com/${{ secrets.ALIREGISTRY_NAMESPACE }}/openimsdk-${{ matrix.components }}
-          tags: |
-            type=ref,event=branch
-            type=sha,prefix={{branch}}-,enable=${{ github.ref_type == 'branch' }}
-            type=ref,event=tag
-      - name: Login to Docker Hub
-        uses: docker/login-action@v2
-        with:
-          username: ${{ secrets.DOCKERHUB_USERNAME }}
-          password: ${{ secrets.DOCKERHUB_TOKEN }}
-
-      - name: Login to Ali Container Registry
-        uses: docker/login-action@v2
-        with:
-          registry: registry.cn-hangzhou.aliyuncs.com
-          username: ${{ secrets.ALIREGISTRY_USERNAME }}
-          password: ${{ secrets.ALIREGISTRY_TOKEN }}
-
-      - name: Condition
-        id: condition
-        run: |
-          echo "run=${{ startsWith(github.ref_name, 'v') || ((steps.changes.outputs.go == 'true' && (matrix.components == 'core' || matrix.components == 'job')) || (steps.changes.outputs.api == 'true' && matrix.components == 'swagger')) }}" >> $GITHUB_OUTPUT
-
-      - name: Set up QEMU
-        if: ${{ steps.condition.outputs.run == 'true' }}
-        uses: docker/setup-qemu-action@v2
-      - name: Set up Docker Buildx
-        if: ${{ steps.condition.outputs.run == 'true' }}
-        uses: docker/setup-buildx-action@v2
-      - name: Build and push
-        if: ${{ steps.condition.outputs.run == 'true' }}
-        uses: docker/build-push-action@v3
-        with:
-          context: .
-          file: ./build/${{ matrix.components }}/Dockerfile
-          platforms: linux/amd64
-          push: true
-          tags: ${{ steps.meta.outputs.tags }}

.github/workflows/link-pr.yml

@@ -27,7 +27,7 @@ jobs:
 
       - name: Link Checker
         id: lychee
-        uses: lycheeverse/lychee-action@v1.7.0
+        uses: lycheeverse/lychee-action@v1.8.0
         with:
             # For parameter description, see https://github.com/lycheeverse/lychee#commandline-parameters
             # Actions Link address -> https://github.com/lycheeverse/lychee-action

.github/workflows/milestone.yml

@@ -0,0 +1,72 @@
+# Copyright © 2023 OpenIM. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# shamelessly copied from https://github.com/sigstore/cosign/blob/main/.github/workflows/milestone.yaml
+
+name: milestone
+
+on:
+  pull_request_target:
+    types: [closed]
+    branches:
+      - main
+
+jobs:
+  milestone:
+    runs-on: ubuntu-latest
+
+    permissions:
+      actions: none
+      checks: none
+      contents: read
+      deployments: none
+      issues: write
+      packages: none
+      pull-requests: write
+      repository-projects: none
+      security-events: none
+      statuses: none
+
+    steps:
+      - uses: actions/github-script@v6 # v6
+        with:
+          script: |
+            if (!context.payload.pull_request.merged) {
+              console.log('PR was not merged, skipping.');
+              return;
+            }
+
+            if (!!context.payload.pull_request.milestone) {
+              console.log('PR has existing milestone, skipping.');
+              return;
+            }
+
+            milestones = await github.rest.issues.listMilestones({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              state: 'open',
+              sort: 'due_on',
+              direction: 'asc'
+            })
+            if (milestones.data.length === 0) {
+              console.log('There are no milestones, skipping.');
+              return;
+            }
+
+            await github.rest.issues.update({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              issue_number: context.payload.pull_request.number,
+              milestone: milestones.data[0].number
+            });

.github/workflows/opencommit.yml

@@ -27,7 +27,7 @@ jobs:
     permissions: write-all
     steps:
       - name: Setup Node.js Environment
-        uses: actions/setup-node@v2
+        uses: actions/setup-node@v3
         with:
           node-version: '16'
       - uses: actions/checkout@v3

.github/workflows/openimci.yml

@@ -48,12 +48,12 @@ jobs:
 
     strategy:
       matrix:
-        go_version: ["1.18","1.19","1.20"]
+        go_version: ["1.18","1.19","1.20","1.21"]
         os: [ubuntu-latest]
 
     steps:
       - name: Set up Go ${{ matrix.go_version }}
-        uses: actions/setup-go@v2
+        uses: actions/setup-go@v4
         with:
           go-version: ${{ matrix.go_version }}
         id: go
@@ -80,29 +80,15 @@ jobs:
 
       - name: Generate all necessary files, such as error code files
         run: |
-          make generate
+          make gen
           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
@@ -113,7 +99,7 @@ jobs:
       - name: Clean all build
         run: |
           sudo make clean
-          echo "Clean all build successfully" 
+          echo "Clean all build successfully"
 
       - name: push OpenIM 
         uses: stefanzweifel/git-auto-commit-action@v4
@@ -157,7 +143,7 @@ jobs:
         continue-on-error: true
 
       - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v1
+        uses: docker/setup-buildx-action@v2
         continue-on-error: true
 
   openim-start:
@@ -167,17 +153,17 @@ jobs:
       name: openim
     strategy:
       matrix:
-        go_version: ["1.20"]
+        go_version: ["1.21"]
         os: ["ubuntu-latest"]
     steps:
       - name: Set up Go ${{ matrix.go_version }}
-        uses: actions/setup-go@v2
+        uses: actions/setup-go@v4
         with:
           go-version: ${{ matrix.go_version }}
         id: go
 
       - name: Check out code into the Go module directory
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
 
       - name: Run OpenIM make install start
         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

@@ -47,7 +47,7 @@ jobs:
           git checkout -b cicd/patch-${{ github.event.number }}
       - uses: actions/setup-node@v3
       - name: Setup Go
-        uses: actions/setup-go@v2
+        uses: actions/setup-go@v4
       - name: Run go modules tidy
         run: |
           sudo make tidy

.github/workflows/release-drafter.yml

@@ -0,0 +1,55 @@
+# 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: Release Drafter
+
+on:
+  push:
+    # branches to consider in the event; optional, defaults to all
+    branches:
+      - master
+  # pull_request event is required only for autolabeler
+  pull_request:
+    # Only following types are handled by the action, but one can default to all as well
+    types: [opened, reopened, synchronize]
+  # pull_request_target event is required for autolabeler to support PRs from forks
+  # pull_request_target:
+  #   types: [opened, reopened, synchronize]
+
+permissions:
+  contents: read
+
+jobs:
+  update_release_draft:
+    permissions:
+      # write permission is required to create a github release
+      contents: write
+      # write permission is required for autolabeler
+      # otherwise, read permission is required at least
+      pull-requests: write
+    runs-on: ubuntu-latest
+    steps:
+      # (Optional) GitHub Enterprise requires GHE_HOST variable set
+      #- name: Set GHE_HOST
+      #  run: |
+      #    echo "GHE_HOST=${GITHUB_SERVER_URL##https:\/\/}" >> $GITHUB_ENV
+
+      # Drafts your next Release notes as Pull Requests are merged into "master"
+      - uses: release-drafter/release-drafter@v5
+        # (Optional) specify config name to use, relative to .github/. Default: release-drafter.yml
+        # with:
+        #   config-name: my-config.yml
+        #   disable-autolabeler: true
+        env:
+          GITHUB_TOKEN: ${{ secrets.REDBOT_GITHUB_TOKEN }}

.github/workflows/release.yml

@@ -12,7 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-name: OpenIM Server Release
+name: OpenIM Server Release Workflow
 
 on:
   push:
@@ -43,9 +43,12 @@ jobs:
           # either 'goreleaser' (default) or 'goreleaser-pro':
           distribution: goreleaser
           version: latest
-          args: release --clean
+          workdir: .
+          args: release -f ./build/goreleaser.yaml --rm-dist --clean --release-footer-tmpl=scripts/template/footer.md.tmpl --release-header-tmpl=scripts/template/head.md.tmpl
         env:
+          USERNAME: ${{ github.repository_owner }}
           GITHUB_TOKEN: ${{ secrets.BOT_GITHUB_TOKEN }}
+          FURY_TOKEN: ${{ secrets.FURY_TOKEN }}
           # Your GoReleaser Pro key, if you are using the 'goreleaser-pro'
           # distribution:
           # GORELEASER_KEY: ${{ secrets.GORELEASER_KEY }}
@@ -60,7 +63,7 @@ jobs:
       matrix:
         format: [ deb, rpm, apk ]
     steps:
-      - uses: actions/checkout@c85c95e3d7251135ab7dc9ce3241c5835cc595a9 # v3
+      - uses: actions/checkout@v3 # v3
         with:
           fetch-depth: 0
       - uses: arduino/setup-task@e26d8975574116b0097a1161e0fe16ba75d84c1c # v1

.github/workflows/scriptsci.yml

@@ -12,7 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-name: OpenIM Start Execute Scripts
+name: OpenIM Scripts Execute CI
 
 on: 
     push:
@@ -38,43 +38,46 @@ jobs:
 
     steps:
     - name: Checkout code
-      uses: actions/checkout@v2
+      uses: actions/checkout@v3
+
+    - name: Download Docker Compose
+      run: |
+        curl -o docker-compose.yaml https://gist.githubusercontent.com/cubxxw/b1d5cbd2edfa23fee911118aa3e8249e/raw/openim-server.sh
+      shell: bash
 
     - name: Start Docker Compose
       run: |
-        sudo docker compose stop
-        sudo sleep 30
         sudo docker compose up -d
         sudo sleep 60
       continue-on-error: true
 
     - name: Stop all services
       run: |
-        sudo chmod +x ./scripts/stop_all.sh
-        sudo ./scripts/stop_all.sh
+        sudo chmod +x ./scripts/stop-all.sh
+        sudo ./scripts/stop-all.sh
         sudo cat logs/openIM.log 2>/dev/null
       shell: bash
       continue-on-error: true
 
     - name: Build all services
       run: |
-        sudo chmod +x ./scripts/build_all_service.sh
-        sudo ./scripts/build_all_service.sh
+        sudo chmod +x ./scripts/build-all-service.sh
+        sudo ./scripts/build-all-service.sh
         sudo cat logs/openIM.log 2>/dev/null
       shell: bash
 
     - name: Start all services
       run: |
-        sudo chmod +x ./scripts/start_all.sh
-        sudo ./scripts/start_all.sh
+        sudo chmod +x ./scripts/start-all.sh
+        sudo ./scripts/start-all.sh
         sudo cat logs/openIM.log 2>/dev/null
       continue-on-error: true
       shell: bash
 
     - name: Check all services
       run: |
-        sudo chmod +x ./scripts/check_all.sh
-        sudo ./scripts/check_all.sh
+        sudo chmod +x ./scripts/check-all.sh
+        sudo ./scripts/check-all.sh
         sudo cat logs/openIM.log 2>/dev/null
       shell: bash
 

.github/workflows/stale.yml

@@ -32,7 +32,7 @@ jobs:
       pull-requests: write
 
     steps:
-    - uses: actions/stale@v5
+    - uses: actions/stale@v8
       with:
         repo-token: ${{ secrets.BOT_GITHUB_TOKEN }}
         days-before-stale: 60

.gitignore

@@ -153,10 +153,10 @@ flycheck_*.el
 *.out
 
 # Dependency directories (remove the comment below to include it)
-# vendor/
+vendor/
 
 # Go workspace file
-go.work
+# go.work
 
 ### JetBrains ###
 # Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider

CHANGELOG/CHANGELOG-3.1.md

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

CHANGELOG/CHANGELOG.md

@@ -3,6 +3,8 @@
 - [Changelog](#changelog)
   - [OpenIM versioning policy](#openim-versioning-policy)
   - [command](#command)
+    - [install](#install)
+  - [User](#user)
   - [create next tag](#create-next-tag)
   - [Release version logs](#release-version-logs)
   - [Introduction](#introduction)
@@ -22,10 +24,68 @@ All notable changes to this project will be documented in this file.
 
 ## command
 
+To use git-chglog you need to configure:
+
+1. CHANGELOG templates
+2. git-chglog configuration
+
+### install 
+
+```bash
+$ go get github.com/git-chglog/git-chglog/cmd/git-chglog
+```
+
+
+## User
+
+```bash
+$ git-chglog --init
+```
+
+**Options**
+
+- What is the URL of your repository?: https://github.com/OpenIMSDK/Open-IM-Server
+- What is your favorite style?: github
+- Choose the format of your favorite commit message: <type>(<scope>): <subject> -- feat(core): Add new feature
+- What is your favorite template style?: standard
+- Do you include Merge Commit in CHANGELOG?: n
+- Do you include Revert Commit in CHANGELOG?: y
+- In which directory do you output configuration files and templates?: .chglog
+
 ```bash
 git-chglog --tag-filter-pattern 'v2.0.*'  -o CHANGELOG-2.0.md
 ```
 
+**Other uses:**
+
+```bash
+$ git-chglog
+
+  If <tag query> is not specified, it corresponds to all tags.
+  This is the simplest example.
+
+$ git-chglog 1.0.0..2.0.0
+
+  The above is a command to generate CHANGELOG including commit of 1.0.0 to 2.0.0.
+
+$ git-chglog 1.0.0
+
+  The above is a command to generate CHANGELOG including commit of only 1.0.0.
+
+$ git-chglog $(git describe --tags $(git rev-list --tags --max-count=1))
+
+  The above is a command to generate CHANGELOG with the commit included in the latest tag.
+
+$ git-chglog --output CHANGELOG.md
+
+  The above is a command to output to CHANGELOG.md instead of standard output.
+
+$ git-chglog --config custom/dir/config.yml
+
+  The above is a command that uses a configuration file placed other than ".chglog/config.yml".
+```
+
+
 ## create next tag
 
 ```bash
@@ -51,6 +111,7 @@ git tag 2.0.0
 + [OpenIM CHANGELOG-V2.3](CHANGELOG-2.3.md)
 + [OpenIM CHANGELOG-V2.9](CHANGELOG-2.9.md)
 + [OpenIM CHANGELOG-V3.0](CHANGELOG-3.0.md)
++ [OpenIM CHANGELOG-V3.1](CHANGELOG-3.1.md)
 
 ## Introduction
 

CONTRIBUTING.md

@@ -4,6 +4,10 @@ So, you want to hack on Open-IM-Server? Yay!
 
 First of all, thank you for considering contributing to our project! We appreciate your time and effort, and we value any contribution, whether it's reporting a bug, suggesting a new feature, or submitting a pull request.
 
+![Hello OpenIM Image](assets/demo/hello-openim.png)
+
+> Use `make demo` start contributing fast.
+
 This document provides guidelines and best practices to help you contribute effectively.
 
 ## 📇Topics

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,26 +8,22 @@ ENV GO111MODULE=$GO111MODULE
 ENV GOPROXY=$GOPROXY
 
 # Set up the working directory
-WORKDIR /Open-IM-Server
+WORKDIR /openim/openim-server
+
+COPY go.mod go.sum go.work go.work.sum ./
+#RUN go mod download
 
 # Copy all files to the container
 ADD . .
 
-RUN /bin/sh -c "make build"
+RUN make clean
+RUN make build
 
-# Production Stage
-FROM alpine
+FROM ghcr.io/openim-sigs/openim-bash-image:latest
 
-RUN echo "https://mirrors.aliyun.com/alpine/v3.4/main" > /etc/apk/repositories && \
-    apk --no-cache add tzdata ca-certificates bash
-
-# 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_BINDIR} /openim/openim-server/_output/bin
 
-WORKDIR /Open-IM-Server/scripts
-
-CMD ["./docker_start_all.sh"]
+CMD ["bash","-c","${OPENIM_SERVER_CMDDIR}/docker-start-all.sh"]

Makefile

@@ -6,13 +6,13 @@
 
 ## all: Run tidy, gen, add-copyright, format, lint, cover, build ✨
 .PHONY: all
-all: tidy gen add-copyright format lint cover build
+all: tidy gen add-copyright lint cover restart
 
 # ==============================================================================
 # Build set
 
 ROOT_PACKAGE=github.com/OpenIMSDK/Open-IM-Server
-# TODO: This is version control for the future
+# TODO: This is version control for the future https://github.com/OpenIMSDK/Open-IM-Server/issues/574
 VERSION_PACKAGE=github.com/OpenIMSDK/Open-IM-Server/pkg/version
 
 # ==============================================================================
@@ -53,16 +53,45 @@ export USAGE_OPTIONS
 # ==============================================================================
 # Targets
 
+## init: Initialize openim server project ✨
+.PHONY: init
+init:
+	@$(MAKE) gen.init
+
+## demo: Run demo get started with Makefiles quickly ✨
+.PHONY: demo
+demo:
+	@$(MAKE) go.demo
+
 ## build: Build binaries by default ✨
 .PHONY: build
 build:
 	@$(MAKE) go.build
 
+## start: Start openim ✨
+.PHONY: start
+start:
+	@$(MAKE) go.start
+
+## stop: Stop openim ✨
+.PHONY: stop
+stop:
+	@$(MAKE) go.stop
+
+## restart: Restart openim ✨
+.PHONY: restart
+restart: clean stop build start
+
 ## multiarch: Build binaries for multiple platforms. See option PLATFORMS. ✨
 .PHONY: multiarch
 multiarch:
 	@$(MAKE) go.build.multiarch
 
+## verify: execute all verity scripts. ✨
+.PHONY: verify
+verify:
+	@$(MAKE) go.verify
+
 ## install: Install deployment openim ✨
 .PHONY: install
 install:

README-zh_CN.md

@@ -1,16 +1,19 @@
-<h1 align="center" style="border-bottom: none">
-    <b>
-        <a href="https://doc.rentsoft.cn/">Open IM Server</a><br>
-    </b>
-    ⭐️  Open source Instant Messaging Server  ⭐️ <br>
-</h1>
+<p align="center">
+    <a href="https://www.openim.online">
+        <img src="./assets/logo-gif/openim-logo.gif" width="60%" height="30%"/>
+    </a>
+</p>
+
+<h3 align="center" style="border-bottom: none">
+    ⭐️  Open source Instant Messaging Server ⭐️ <br>
+<h3>
 
 
 <p align=center>
 <a href="https://goreportcard.com/report/github.com/OpenIMSDK/Open-IM-Server"><img src="https://goreportcard.com/badge/github.com/OpenIMSDK/Open-IM-Server" alt="A+"></a>
 <a href="https://github.com/OpenIMSDK/Open-IM-Server/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3A%22good+first+issue%22"><img src="https://img.shields.io/github/issues/OpenIMSDK/Open-IM-Server/good%20first%20issue?logo=%22github%22" alt="good first"></a>
 <a href="https://github.com/OpenIMSDK/Open-IM-Server"><img src="https://img.shields.io/github/stars/OpenIMSDK/Open-IM-Server.svg?style=flat&logo=github&colorB=deeppink&label=stars"></a>
-<a href="https://join.slack.com/t/openimsdk/shared_invite/zt-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>
@@ -18,164 +21,220 @@
 </p>
 
 <p align="center">
-    <a href="./README.md"><b>English</b></a> •
-    <a href="./README_zh-CN.md"><b>中文</b></a>
+    <a href="./README.md"><b> English </b></a> •
+    <a href="./README-zh_CN.md"><b> 简体中文 </b></a> •
+    <a href="https://www.openim.online/en"><b> Docs </b></a>
 </p>
 
+
 </p>
 
-## Open-IM-Server 是什么
+## ✨ 关于 OpenIM
 
-Open-IM-Server 是一款即时通讯服务器，使用纯 Golang 开发，采用 JSON over WebSocket 传输协议。在 Open-IM-Server 中，所有东西都是消息，因此您可以轻松扩展自定义消息，而无需修改服务器代码。使用微服务架构，Open-IM-Server 可以使用集群进行部署。通过在服务器上部署 Open-IM-Server，开发人员可以快速地将即时通讯和实时网络功能集成到自己的应用程序中，并确保业务数据的安全性和隐私性。
+Open-IM-Server 是使用纯 Golang 精心制作的强大的即时消息服务器。其通过 JSON over WebSocket 进行通信的独特方法将每次交互都视为消息。这简化了定制并消除了修改服务器代码的需求。通过利用微服务架构，服务器可以通过集群部署，保证出色的性能和可伸缩性。
 
-Open-IM-Server并不是一个独立的产品，本身不包含账号的注册和登录服务。
-为方便大家测试，我们开源了包括登录注册功能的 [chat 仓库](https://github.com/OpenIMSDK/chat)，chat 业务服务端和 Open-IM-Server 一起部署，即可搭建一个聊天产品。
+Open-IM-Server 不仅仅是一个即时消息服务器；它是将实时网络集成到您的应用程序中的强大工具，定位为您集成的首选选择！🚀
 
-## 特点
+请注意，Open-IM-Server 不作为独立产品运行，也不提供内置的帐户注册或登录服务。为了简化您的实施过程，我们已开源了 [chat repository](https://github.com/OpenIMSDK/chat)，其中包括这些功能。与 Open-IM-Server 一起部署此聊天业务服务器可加快全面的聊天产品的设置。👥
 
-+ 开源
-+ 易于集成
-+ 良好的可扩展性
-+ 高性能
-+ 轻量级
-+ 支持多种协议
+为了进一步增强您的体验，我们还提供了 SDK 客户端，在其中实现了大多数复杂逻辑。可以在 [此链接](https://github.com/OpenIMSDK/openim-sdk-core) 找到 [SDK repository](https://github.com/OpenIMSDK/openim-sdk-core)。[chat repository](https://github.com/OpenIMSDK/chat) 是我们的业务服务器，而 'core' 代表 SDK 的高级封装，它们协同工作以提供卓越的结果。✨
 
-## 社区
+## :star2: 为什么选择 OpenIM
 
-+ 访问中文官方网站：[OpenIM中文开发文档](https://doc.rentsoft.cn/)
+**🔍 功能截图显示**
 
-## 快速开始
+<div align="center">
 
-### 使用 docker-compose 部署
+|                      💻🔄📱 多终端同步 🔄🖥️                       |                        📅⚡ 高效会议 🚀💼                        |
+| :----------------------------------------------------------: | :----------------------------------------------------------: |
+| ![multiple-message](./assets/demo/multi-terminal-synchronization.png) | ![efficient-meetings](./assets/demo/efficient-meetings.png) |
+|                    📲🔄 **一对一和群聊** 👥🗣️                    |               🎁💻 **特殊功能 - 自定义消息** ✉️🎨                |
+| ![group-chat](./assets/demo/group-chat.png) | ![special-function](./assets/demo/special-function.png) |
+
+</div>
+
+1. **全面的消息类型支持 :speech_balloon:**
+
+   ✅ 支持几乎所有类型的消息，包括文本、图片、表情符号、语音、视频、地理位置、文件、报价、名片、系统通知、自定义消息等
+
+   ✅ 支持一对一和多人音视频通话
+
+   ✅ 为 iOS、Android、Flutter、uni-app、ReactNative、Electron、Web、H5 等多个平台提供终端支持
+
+2. **随时随地的高效会议 :earth_americas:**
+
+   ✅ 基于具有 100% 可靠强制信令功能的 IM (Instant Messaging)，为与聊天应用程序深度集成的 IM 系统铺平了道路
+
+   ✅ 支持单次会议中的数百人，订阅人数达到数千，以及服务器端音视频录制
+
+3. **适用于各种社交场景的一对一和群聊 :busts_in_silhouette:**
+
+   ✅ OpenIM 有四种角色：应用程序管理员、群主、群管理员和普通成员
+
+   ✅ 强大的群特性，如静音、群公告、群验证、无限群成员和根据需要加载群消息
+
+4. **独特的功能 :star2:**
+
+   ✅ 支持读取并烧毁私人聊天，可自定义时长
+
+   ✅ 消息编辑功能扩大了社交场景，使即时通讯变得更加多样化和有趣
+
+5. **开源 :open_hands:**
+
+   ✅ OpenIM 的代码是开源的，数据自控，旨在构建一个全球领先的 IM 开源社区，包括客户端 SDK 和服务器
+
+   ✅ 基于开源服务器，已经开发了许多出色的开源项目，例如 [OpenKF](https://github.com/OpenIMSDK/OpenKF) (开源 AI 客户服务系统)
+
+6. **易于扩展 :wrench:**
+
+   ✅ OpenIM 服务器是用 Golang 实现的，引入了创新的 "一切都是消息" 通信模型，简化了自定义消息和扩展功能的实现
+
+7. **高性能 :racing_car:**
+
+   ✅ OpenIM 支持集群中的分层治理架构，经过大量用户的测试，并抽象了在线消息、离线消息和历史消息的存储模型
+
+8. **全平台支持 :tv:**
+
+   ✅ 支持原生 iOS、Android；跨平台 Flutter、uni-app、ReactNative；主要的 Web 前端框架如 React、Vue；小程序和 Electron 支持的 PC 平台
+
+9. **终极部署体验 🤖**
+
+   ✅ 支持 [集群部署](https://github.com/OpenIMSDK/Open-IM-Server/edit/main/deployments/README.md)
+
+   ✅ 支持多架构镜像，我们的 Docker 镜像不仅托管在 GitHub 上，而且还在阿里云和 Docker Hub 上支持多个架构。请访问 [我们的 GitHub packages](https://github.com/orgs/OpenIMSDK/packages?repo_name=Open-IM-Server) 并阅读我们的 [版本管理文档](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/version.md) 以获取更多信息。
+
+10. **开源社区的大生态系统 🤲**
+
+    ✅ 我们有数万用户和许多解决方案来解决问题。 
+
+    ✅  我们有一个大型的开源社区叫 [OpenIMSDK](https://github.com/OpenIMSDK)，它运行核心模块，我们还有一个开源社区叫 [openim-sigs](https://github.com/openim-sigs) 以探索更多基于 IM 的基础设施产品。
+
+## :rocket: 快速开始
+
+<details>   <summary>使用 Docker Compose 部署</summary>
 
 1. 克隆项目
 
 ```
-git clone https://github.com/OpenIMSDK/Open-IM-Server 
-cd Open-IM-Server
-git checkout release-v3.0 #or other release branch
+bashCopy code# 选择您需要的
+BRANCH=release-v3.1
+git clone -b $BRANCH https://github.com/OpenIMSDK/Open-IM-Server openim && export openim=$(pwd)/openim && cd $openim && make build
 ```
 
-2. 修改 .env
+> **注意** 阅读我们的发布策略：https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/version.md
+
+1. 修改 `.env`
 
 ```
-此处主要修改相关组件密码
-USER=root #不用修改
-PASSWORD=openIM123  #8位以上的数字和字母组合密码，密码对redis mysql mongo生效，以及config/config.yaml中的accessSecret
-ENDPOINT=http://127.0.0.1:10005 #minio对外服务的ip和端口，或用域名storage.xx.xx，app要能访问到此ip和端口或域名，
-API_URL=http://127.0.0.1:10002/object/ #app要能访问到此ip和端口或域名，
+bashCopy codeUSER=root #无需修改
+PASSWORD=openIM123  #8位或更多数字和字母的组合，此密码适用于redis、mysql、mongo，以及config/config.yaml中的accessSecret
+ENDPOINT=http://127.0.0.1:10005 #minio的外部服务IP和端口，或使用域名storage.xx.xx，应用程序必须能够访问此IP和端口或域名，
+API_URL=http://127.0.0.1:10002/object/ #应用程序必须能够访问此IP和端口或域名，
 DATA_DIR=./  #指定大磁盘目录
 ```
 
-3. 部署和启动
+1. 部署并启动
 
-注意：此命令只能执行一次，它会根据.env 中的 PASSWORD 变量修改 docker-compose 中组件密码，并修改 config/config.yaml 中的组件密码
-如果.env 中的密码变了，需要先 docker-compose down ; rm components -rf 后再执行此命令。
+> **注意** 此命令只能执行一次。它会基于 `.env` 中的 `PASSWORD` 变量修改 docker-compose 中的组件密码，并修改 `config/config.yaml` 中的组件密码。如果 `.env` 中的密码发生变化，您需要首先执行 `docker-compose down`；`rm components -rf` 然后执行此命令。
 
 ```
-chmod +x install_im_server.sh;
-./install_im_server.sh;
+bashCopy code
+make install
 ```
 
-4. 检查服务
+1. 检查服务
 
 ```
-cd scripts;
-./docker_check_service.sh
+bashCopy code
+make check
 ```
 
 ![https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/images/docker_build.png](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/images/docker_build.png)
 
-### 使用源码编译
+</details>  <details>  <summary>从源码编译</summary>
 
-1. Go 1.18或更高版本。
+您需要 `Go 1.18` 或更高版本，以及 `make`。
 
-2. 克隆
+版本详情：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
-   ```
+```
+bashCopy code# 选择您需要的
+BRANCH=release-v3.1
+git clone -b $BRANCH https://github.com/OpenIMSDK/Open-IM-Server openim && export openim=$(pwd)/openim && cd $openim && make build
+```
 
-3. 编译
+阅读关于 [OpenIM 版本策略](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/version.md)
 
-   ```
-   cd Open-IM-server/scripts
-   chmod +x *.sh
-   ./build_all_service.sh
-   ```
+使用 `make help` 来查看 OpenIM 支持的指令。
 
-所有服务已成功构建如图所示
+如图所示，所有服务已成功构建
 
-![编译成功](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/images/build.png)
+![成功编译](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/images/build.png)
 
-### 组件配置说明
+</details> <details>  <summary>组件配置说明</summary>
 
-config/config.yaml中针对存储组件有详细的配置说明
+config/config.yaml 文件为存储组件提供了详细的配置说明。
+
+- Zookeeper
+
+  - 用于 RPC 服务发现和注册，支持集群。
 
-+ Zookeeper
-  + 用于RPC 服务发现和注册，支持集群。
-  
-    ````
     ```
-    zookeeper:
+    bashCopy codezookeeper:
       schema: openim                          #不建议修改
       address: [ 127.0.0.1:2181 ]             #地址
       username:                               #用户名
       password:                               #密码
     ```
-    ````
-  
-    
-  
-+ MySQL
-  
-  + 用于存储用户、关系链、群组，支持数据库主备。
-  
+
+- MySQL
+
+  - 用于存储用户、关系和群组，支持主从数据库。
+
     ```
-    mysql:
+    bashCopy codemysql:
       address: [ 127.0.0.1:13306 ]            #地址
       username: root                          #用户名
       password: openIM123                     #密码
       database: openIM_v2                     #不建议修改
-      maxOpenConn: 1000                       #最大连接数
-      maxIdleConn: 100                        #最大空闲连接数
-      maxLifeTime: 60                         #连接可以重复使用的最长时间（秒）
-      logLevel: 4                             #日志级别 1=slient 2=error 3=warn 4=info
-      slowThreshold: 500                      #慢语句阈值 （毫秒）
+      maxOpenConn: 1000                       #最大连接
+      maxIdleConn: 100                        #最大空闲连接
+      maxLifeTime: 60                         #连接可重用的最大时间(秒)
+      logLevel: 4                             #日志级别 1=静音 2=错误 3=警告 4=信息
+      slowThreshold: 500                      #慢语句阈值(毫秒)
     ```
-  
-    
-  
-+ Mongo
-  + 用于存储离线消息，支持mongo分片集群。
-  
+
+- Mongo
+
+  - 用于存储离线消息，支持 mongo 分片集群。
+
     ```
-    mongo:
-      uri:                                    #不为空则直接使用该值
+    bashCopy codemongo:
+      uri:                                    #如果不为空，则直接使用此值
       address: [ 127.0.0.1:37017 ]            #地址
-      database: openIM                        #mongo db 默认即可
+      database: openIM                        #默认 mongo 数据库
       username: root                          #用户名
       password: openIM123                     #密码
       maxPoolSize: 100                        #最大连接数
     ```
-  
-+ Redis
-  + 用于存储消息序列号、最新消息、用户token及mysql缓存，支持集群部署。
-  
+
+- Redis
+
+  - 用于存储消息序列号、最新消息、用户令牌和 mysql 缓存，支持集群部署。
+
     ```
-    redis:
+    bashCopy coderedis:
       address: [ 127.0.0.1:16379 ]            #地址
       username:                               #用户名
       password: openIM123                     #密码
     ```
-  
-+ Kafka
-  + 用于消息队列，用于消息解耦，支持集群部署。
-  
+
+- Kafka
+
+  - 用于消息队列，用于消息解耦，支持集群部署。
+
     ```
-    kafka:
+    bashCopy codekafka:
       username:                               #用户名
       password:                               #密码
       addr: [ 127.0.0.1:9092 ]                #地址
@@ -195,71 +254,104 @@ config/config.yaml中针对存储组件有详细的配置说明
         msgToModify: modify
     ```
 
-### 启停服务
+</details> <details>  <summary>启动和停止服务</summary>
 
 启动服务
 
 ```
-./start_all.sh;
+bashCopy code
+./scripts/start-all.sh;
 ```
 
 检查服务
 
 ```
-./check_all.sh
+bashCopy code
+./scripts/check-all.sh
 ```
 
 停止服务
 
 ```
-./stop_all.sh
+bashCopy code
+./scripts/stop-all.sh
 ```
 
-### 开放 IM 端口
+</details>
 
-| TCP 端口  | 说明                                                  | 操作                                    |
-| --------- | ----------------------------------------------------- | --------------------------------------- |
-| TCP:10001 | ws 协议，消息端口，如消息发送、推送等，用于客户端 SDK | 端口放行或 nginx 反向代理，并关闭防火墙 |
-| TCP:10002 | api 端口，如用户、好友、群组、消息等接口。            | 端口放行或 nginx 反向代理，并关闭防火墙 |
-| TCP:10005 | 选择 minio 存储时需要(openIM 默认使用 minio 存储)     | 端口放行或 nginx 反向代理，并关闭防火墙 |
+<details>  <summary>开放 IM 端口</summary>
 
-### 开放 Chat 端口
+| TCP 端口  | 描述                                                | 操作                                    |
+| --------- | --------------------------------------------------- | --------------------------------------- |
+| TCP:10001 | ws 协议，消息端口如消息发送、推送等，用于客户端 SDK | 端口释放或 nginx 反向代理，并关闭防火墙 |
+| TCP:10002 | api 端口，如用户、朋友、组、消息接口。              | 端口释放或 nginx 反向代理，并关闭防火墙 |
+| TCP:10005 | 选择 minio 存储时所需 (openIM 默认使用 minio 存储)  | 端口释放或 nginx 反向代理，并关闭防火墙 |
 
-| TCP 端口  | 说明                     | 操作                                    |
+</details>  <details>  <summary>开放聊天端口</summary>
+
+- 聊天仓库: https://github.com/OpenIMSDK/chat
+
+| TCP 端口  | 描述                     | 操作                                    |
 | --------- | ------------------------ | --------------------------------------- |
-| TCP:10008 | 业务系统，如注册、登录等 | 端口放行或 nginx 反向代理，并关闭防火墙 |
-| TCP:10009 | 管理后台，如统计、封号等 | 端口放行或 nginx 反向代理，并关闭防火墙 |
+| TCP:10008 | 业务系统，如注册、登录等 | 端口释放或 nginx 反向代理，并关闭防火墙 |
+| TCP:10009 | 管理后台，如统计、封禁等 | 端口释放或 nginx 反向代理，并关闭防火墙 |
 
-## APP和OpenIM关系
+</details>
 
-OpenIM 是开源的即时通讯组件，它并不是一个独立的产品，此图展示了AppServer、AppClient、Open-IM-Server以及Open-IM-SDK之间的关系
+## :link: APP 和 OpenIM 之间的关系
 
-![https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/open-im-server.png](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/images/open-im-server.png)
+OpenIM 不仅仅是一个开源的即时消息组件，它是您的应用程序生态系统的一个不可分割的部分。查看此图表以了解 AppServer、AppClient、Open-IM-Server 和 Open-IM-SDK 如何互动。
 
-## 整体架构
+![App-OpenIM 关系](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/images/open-im-server.png)
 
-![https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/Architecture.jpg](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/images/Architecture.jpg)
+## :building_construction: 总体架构
 
-## 开始开发 OpenIM
+深入了解 Open-IM-Server 的功能与我们的架构图。
 
-[社区存储库](https://github.com/OpenIMSDK/community)包含有关从源代码构建 Kubernetes、如何贡献代码和文档。
+![总体架构](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/images/Architecture.jpg)
 
-## 贡献
+## :hammer_and_wrench: 开始开发 OpenIM
 
-欢迎对该项目进行贡献！请参见 [CONTRIBUTING.md](http://CONTRIBUTING.md) 了解详细信息。
+OpenIM 我们的目标是建立一个顶级的开源社区。我们有一套标准，在 [Community repository](https://github.com/OpenIMSDK/community) 中。
 
-## 社区会议
+如果您想为这个 Open-IM-Server 仓库做贡献，请阅读我们的 [贡献者文档](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/CONTRIBUTING.md)。
 
-我们希望任何人都能参与我们的社区，我们提供礼品和奖励，并欢迎您每周四晚上加入我们。
+在您开始之前，请确保您的更改是需要的。最好的方法是创建一个 [新的讨论](https://github.com/OpenIMSDK/Open-IM-Server/discussions/new/choose) 或 [Slack 通讯](https://join.slack.com/t/openimsdk/shared_invite/zt-1tmoj26uf-_FDy3dowVHBiGvLk9e5Xkg)，或者如果您发现一个问题，首先 [报告它](https://github.com/OpenIMSDK/Open-IM-Server/issues/new/choose)。
 
-我们在 [GitHub 讨论](https://github.com/OpenIMSDK/Open-IM-Server/discussions/categories/meeting) 中记录每个 [两周会议](https://github.com/OpenIMSDK/Open-IM-Server/issues/381)，我们的记录写在 [Google 文档](https://docs.google.com/document/d/1nx8MDpuG74NASx081JcCpxPgDITNTpIIos0DS6Vr9GU/edit?usp=sharing) 中。
+- [代码标准](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/go_code.md)
+- [Docker 图像标准](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/images.md)
+- [目录标准](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/directory.md)
+- [提交标准](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/commit.md)
+- [版本控制标准](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/version.md)
+- [接口标准](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/api.md)
+- [日志标准](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/log.md)
+- [错误代码标准](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/error_code.md)
 
-## 谁在使用 Open-IM-Server
+## :busts_in_silhouette: 社区
 
-[用户案例研究](https://github.com/OpenIMSDK/community/blob/main/ADOPTERS.md) 页面包括该项目的用户列表。您可以留下 [📝评论](https://github.com/OpenIMSDK/Open-IM-Server/issues/379) 让我们知道您的用例。
+- 📚 [OpenIM 社区](https://github.com/OpenIMSDK/community)
+- 💕 [OpenIM 兴趣小组](https://github.com/Openim-sigs)
+- 🚀 [加入我们的 Slack 社区](https://join.slack.com/t/openimsdk/shared_invite/zt-1tmoj26uf-_FDy3dowVHBiGvLk9e5Xkg)
+- :eyes: [加入我们的微信群 (微信群)](https://openim-1253691595.cos.ap-nanjing.myqcloud.com/WechatIMG20.jpeg)
 
-![https://github.com/OpenIMSDK/OpenIM-Docs/blob/main/docs/images/WechatIMG20.jpeg](https://github.com/OpenIMSDK/OpenIM-Docs/blob/main/docs/images/WechatIMG20.jpeg)
+## :calendar: 社区会议
 
-## 许可证
+我们希望任何人都可以参与我们的社区并贡献代码，我们提供礼物和奖励，欢迎您每周四晚上加入我们。
 
-Open-IM-Server 使用 Apache 2.0 许可证。有关详情，请参阅 LICENSE 文件。
+我们的会议在 [OpenIM Slack](https://join.slack.com/t/openimsdk/shared_invite/zt-1tmoj26uf-_FDy3dowVHBiGvLk9e5Xkg) 🎯，然后您可以搜索 Open-IM-Server 管道加入。
+
+我们在 [GitHub 讨论](https://github.com/OpenIMSDK/Open-IM-Server/discussions/categories/meeting) 中记下每次 [双周会议](https://github.com/orgs/OpenIMSDK/discussions/categories/meeting) 的笔记，我们的历史会议记录以及会议回放都可在 [Google Docs :bookmark_tabs:](https://docs.google.com/document/d/1nx8MDpuG74NASx081JcCpxPgDITNTpIIos0DS6Vr9GU/edit?usp=sharing) 中找到。
+
+## :eyes: 谁在使用 OpenIM
+
+查看我们的 [用户案例研究](https://github.com/OpenIMSDK/community/blob/main/ADOPTERS.md) 页面以获取项目用户列表。不要犹豫，留下一个 [📝评论](https://github.com/OpenIMSDK/Open-IM-Server/issues/379) 并分享您的使用案例。
+
+## :page_facing_up: 许可证
+
+OpenIM 根据 Apache 2.0 许可证授权。请查看 [LICENSE](https://github.com/OpenIMSDK/Open-IM-Server/tree/main/LICENSE) 以获取完整的许可证文本。
+
+OpenIM logo，包括其变体和动画版本，在此存储库 [OpenIM](https://github.com/OpenIMSDK/Open-IM-Server) 下的 [assets/logo](./assets/logo) 和 [assets/logo-gif](./assets/logo-gif) 目录中显示，受版权法保护。
+
+## 🔮 感谢我们的贡献者！
+
+<a href="https://github.com/OpenIMSDK/Open-IM-Server/graphs/contributors">   <img src="https://contrib.rocks/image?repo=OpenIMSDK/Open-IM-Server" /> </a>

README.md

@@ -22,81 +22,179 @@
 
 <p align="center">
     <a href="./README.md"><b> English </b></a> •
-    <a href="./README-zh_CN.md"><b> 中文 </b></a>
+    <a href="./README-zh_CN.md"><b> 简体中文 </b></a> •
+    <a href="https://www.openim.online/en"><b> Docs </b></a>
 </p>
 
+
 </p>
 
-## What is Open-IM-Server
+## ✨ About OpenIM
 
-Open-IM-Server is an instant messaging server developed using pure Golang, adopting JSON over WebSocket as the communication protocol. In Open-IM-Server, everything is a message, so you can easily extend custom messages without modifying the server code. With a microservice architecture, Open-IM-Server can be deployed using clusters. By deploying Open-IM-Server on a server, developers can quickly integrate instant messaging and real-time networking features into their applications, ensuring the security and privacy of business data.
+Open-IM-Server, meticulously developed in pure Golang, is a powerful instant messaging server. Its distinct communication method, employing pb+websocket, views every interaction as a message, streamlining customization without altering server code. Built on a microservice architecture, it offers deployment through clusters for outstanding performance and scalability.
 
-Open-IM-Server is not a standalone product and does not include account registration and login services. For your convenience, we have open-sourced the [chat repository](https://github.com/OpenIMSDK/chat) which includes login and registration functionality. By deploying the chat business server alongside Open-IM-Server, a chat product can be set up.
+Open-IM-Server is more than an instant messaging server; it's a powerful tool for incorporating real-time networking into your applications, positioning itself as your premier choice for integration! 🚀
 
-## Features
+Please be aware that Open-IM-Server does not function as a standalone product and does not offer built-in account registration or login services. To ease your implementation process, we've open-sourced the [chat repository](https://github.com/OpenIMSDK/chat), which comprises these features. Deploying this chat business server in conjunction with Open-IM-Server expedites the setup of a comprehensive chat product. 👥
 
-- Open source
-- Easy to integrate
-- Excellent scalability
-- High performance
-- Lightweight
-- Supports multiple protocols
+Further enhancing your experience, we also provide an SDK client, wherein most complex logics are implemented. The [SDK repository](https://github.com/OpenIMSDK/openim-sdk-core) can be found at [this link](https://github.com/OpenIMSDK/openim-sdk-core). The [chat repository](https://github.com/OpenIMSDK/chat) is our business server while the 'core' represents the high-level encapsulation of the SDK, synergistically working together to deliver superior results. ✨
 
-## Community
-- Visit the official website: [OpenIM  Developer Documentation](https://www.openim.online/)
+## :star2: Why OpenIM
 
-## Quick Start
+**🔍 Function screenshot display**
 
-### Deploying with docker-compose
+<div align="center">
 
-1. Clone the project
+|            💻🔄📱 Multi Terminal Synchronization 🔄🖥️             |                  📅⚡ Efficient Meetings 🚀💼      |
+| :----------------------------------------------------------: | :---------------------------------------------------------: |
+| ![multiple-message](./assets/demo/multi-terminal-synchronization.png) | ![efficient-meetings](./assets/demo/efficient-meetings.png) |
+|             📲🔄 **One-to-one and Group Chats** 👥🗣️             |        🎁💻 **Special Features - Custom Messages** ✉️🎨|
+|         ![group-chat](./assets/demo/group-chat.png)          |   ![special-function](./assets/demo/special-function.png)      |
+
+</div>
+
+1. **Comprehensive Message Type Support :speech_balloon:**
+
+   ✅ Supports almost all types of messages, including text, images, emojis, voice, video, geographical location, files, quotes, business cards, system notifications, custom messages and more
+
+   ✅ Supports one-on-one and multi-person audio and video calls
+
+   ✅ Provides terminal support for multiple platforms such as iOS, Android, Flutter, uni-app, ReactNative, Electron, Web, H5 
+
+2. **Efficient Meetings Anytime, Anywhere :earth_americas:**
+
+   ✅ Based on IM (Instant Messaging) with 100% reliable forced signaling capabilities, it paves the way for IM systems, deeply integrated with chat applications 
+
+   ✅ Supports hundreds of people in a single meeting, with subscription numbers reaching thousands, and server-side audio and video recording 
+
+3. **One-on-one and Group Chats for Various Social Scenarios :busts_in_silhouette:**
+
+   ✅ OpenIM has four roles: application administrator, group owner, group administrator, and regular member 
+
+   ✅ Powerful group features such as muting, group announcements, group validation, unlimited group members, and loading group messages as needed 
+
+4. **Unique Features :star2:**
+
+   ✅ Supports read-and-burn private chats, customizable duration
+
+   ✅ Message editing function broadens social scenarios, making instant communication more diverse and interesting
+
+5. **Open Source :open_hands:**
+
+   ✅ The code of OpenIM is open source, self-controlled data, aimed at building a globally leading IM open source community, including client SDK and server 
+
+   ✅ Based on open source Server, many excellent open source projects have been developed, such as [OpenKF](https://github.com/OpenIMSDK/OpenKF) (Open source AI customer service system) 
+
+6. **Easy to Expand :wrench:**
+
+   ✅ The OpenIM server is implemented in Golang, introducing an innovative "everything is a message" communication model, simplifying the implementation of custom messages and extended features 
+
+7. **High Performance :racing_car:**
+
+   ✅ OpenIM supports a hierarchical governance architecture in the cluster, tested by a large number of users, and abstracts the storage model of online messages, offline messages, and historical messages 
+
+8. **Full Platform Support :tv:**
+
+   ✅ Supports native iOS, Android; cross-platform Flutter, uni-app, ReactNative; major web front-end frameworks such as React, Vue; applets; and PC platforms supported by Electron
+
+9. **The ultimate deployment experience 🤖** 
+
+   ✅  Supports [cluster deployment](https://github.com/OpenIMSDK/Open-IM-Server/edit/main/deployments/README.md)
+
+   ✅  Supports multi-architecture mirroring, our Docker images are hosted not only on GitHub but also on Alibaba Cloud and Docker Hub supporting multiple architectures. Visit [our GitHub packages](https://github.com/orgs/OpenIMSDK/packages?repo_name=Open-IM-Server) and read our [version management document](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/version.md) for more information.
+
+11. **A large ecosystem of open source communities 🤲**
+
+    ✅  We have tens of thousands of users and many solutions to problems.
+
+    ✅  We have a large open source community called [OpenIMSDK](https://github.com/OpenIMSDK) that runs the core modules, we have an open source community called [openim-sigs](https://github.com/openim-sigs) to explore more IM-based infrastructure products.
+
+## :rocket: Quick Start
+
+You can quickly learn OpenIM engineering solutions,  all it takes is one simple command:
 
 ```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
+$ make demo
 ```
 
-2. Modify .env
+🤲 In order to facilitate the user experience, we have provided a variety of deployment solutions, you can choose your own deployment method according to the list below:
+
+<details>   <summary>Deploying with Docker Compose</summary>
+
+**1. Clone the project**
 
 ```bash
-USER=root #no need to modify
-PASSWORD=openIM123  #A combination of 8 or more numbers and letters, this password applies to redis, mysql, mongo, as well as accessSecret in config/config.yaml
-ENDPOINT=http://127.0.0.1:10005 #minio's external service IP and port, or use the domain name storage.xx.xx, the app must be able to access this IP and port or domain,
-API_URL=http://127.0.0.1:10002/object/ #the app must be able to access this IP and port or domain,
-DATA_DIR=./  #designate large disk directory
+# choose what you need, We take branch 3.2 as an example
+$ BRANCH=release-v3.2
+$ git clone -b $BRANCH https://github.com/OpenIMSDK/Open-IM-Server openim && export openim=$(pwd)/openim && cd $openim
 ```
 
-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.
+> If you don't know OpenIM's versioning policy, 📚Read our release policy: https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/version.md
 
+
+
+**2. Configure the config file**
+
+If you tried to get started quickly with `make demo`, then you know that our config file is generated by automation.
+
+You can use `make init` to quickly initialize a configuration file
+
+```bash
+$ make init
+$ git diff
 ```
-make install
+
+Then feel free to modify your current config file,  you can also modify `/scripts/install/environment.sh` document template, `make init` is essentially rendering `environment.sh` template, and then through the `make init` to automatically generate a new configuration.
+
+If you only need to change the config file for a short time, or if you don't want to make any major changes in the future, you can modify the `.env file directly
+
+```bash
+USER=root 								#no need to modify
+PASSWORD=openIM123  					#A combination of 8 or more numbers and letters, this password applies to redis, mysql, mongo, as well as accessSecret in config/config.yaml
+ENDPOINT=http://127.0.0.1:10005 		#minio's external service IP and port, or use the domain name storage.xx.xx, the app must be able to access this IP and port or domain,
+API_URL=http://127.0.0.1:10002/object/ 	#the app must be able to access this IP and port or domain,
+DATA_DIR=./  							#designate large disk directory
+```
+
+3. **Deploy and start**
+
+> **Note**
+>
+> You can deploy either directly with `make install` or with `docker compose up`, the logic is the same
+
+```bash
+$ make install
+# OR
+$ docker-compose up
 ```
 
 4. Check the service
 
 ```bash
-make check
+$ 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)
+Looking at the command line at this point, there are two items in the output, checking for the start of the component port that OpenIM depends on, and the start of the OpenIM core component
 
+</details> 
 
-
-### Compile from source
+<details>  <summary>Compile from Source</summary>
 
 Ur need `Go 1.18` or higher version, and `make`.
 
+```bash
+$ go version; make --version
+```
+
 Version Details: https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/version.md
 
 ```bash
 # choose what you need
-BRANCH=release-v3.1
-git clone -b $BRANCH https://github.com/OpenIMSDK/Open-IM-Server openim && export openim=$(pwd)/openim && cd $openim && make build
+$ BRANCH=release-v3.1
+$ git clone -b $BRANCH https://github.com/OpenIMSDK/Open-IM-Server openim && export openim=$(pwd)/openim && cd $openim && make build
 ```
+
 Read about the [OpenIM Version Policy](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/version.md)
 
 `make help` to help you see the instructions supported by OpenIM.
@@ -105,7 +203,10 @@ All services have been successfully built as shown in the figure
 
 ![Successful Compilation](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/images/build.png)
 
-### Component Configuration Instructions
+</details>
+
+<details>  <summary>Component Configuration Instructions</summary>
+
 
 The config/config.yaml file has detailed configuration instructions for the storage components.
 
@@ -113,7 +214,7 @@ The config/config.yaml file has detailed configuration instructions for the stor
 
   - Used for RPC service discovery and registration, cluster support.
 
-    ```
+    ```bash
     zookeeper:
       schema: openim                          #Not recommended to modify
       address: [ 127.0.0.1:2181 ]             #address
@@ -125,7 +226,7 @@ The config/config.yaml file has detailed configuration instructions for the stor
 
   - Used for storing users, relationships, and groups, supports master-slave database.
 
-    ```
+    ```bash
     mysql:
       address: [ 127.0.0.1:13306 ]            #address
       username: root                          #username
@@ -142,7 +243,7 @@ The config/config.yaml file has detailed configuration instructions for the stor
 
   - Used for storing offline messages, supports mongo sharded clusters.
 
-    ```
+    ```bash
     mongo:
       uri:                                    #Use this value directly if not empty
       address: [ 127.0.0.1:37017 ]            #address
@@ -156,7 +257,7 @@ The config/config.yaml file has detailed configuration instructions for the stor
 
   - Used for storing message sequence numbers, latest messages, user tokens, and mysql cache, supports cluster deployment.
 
-    ```
+    ```bash
     redis:
       address: [ 127.0.0.1:16379 ]            #address
       username:                               #username
@@ -167,7 +268,7 @@ The config/config.yaml file has detailed configuration instructions for the stor
 
   - Used for message queues, for message decoupling, supports cluster deployment.
 
-    ```
+    ```bash
     kafka:
       username:                               #username
       password:                               #password
@@ -188,27 +289,33 @@ The config/config.yaml file has detailed configuration instructions for the stor
         msgToModify: modify
     ```
 
-### Start and Stop Services
+</details>
+
+<details>  <summary>Start and Stop Services</summary>
+
 
 Start services
 
 ```
-./start_all.sh;
+./scripts/start-all.sh;
 ```
 
 Check services
 
 ```
-./check_all.sh
+./scripts/check-all.sh
 ```
 
 Stop services
 
 ```
-./stop_all.sh
+./scripts/stop-all.sh
 ```
 
-### Open IM Ports
+</details> 
+
+<details>  <summary>Open IM Ports</summary>
+
 
 | TCP Port  | Description                                                  | Operation                                             |
 | --------- | ------------------------------------------------------------ | ----------------------------------------------------- |
@@ -216,42 +323,76 @@ Stop services
 | TCP:10002 | api port, such as user, friend, group, message interfaces.   | Port release or nginx reverse proxy, and firewall off |
 | TCP:10005 | Required when choosing minio storage (openIM uses minio storage by default) | Port release or nginx reverse proxy, and firewall off |
 
-### Open Chat Ports
+</details> 
+
+<details>  <summary>Open Chat Ports</summary>
+
+
++ chat warehouse: https://github.com/OpenIMSDK/chat 
 
 | TCP Port  | Description                                         | Operation                                             |
 | --------- | --------------------------------------------------- | ----------------------------------------------------- |
 | TCP:10008 | Business system, such as registration, login etc    | Port release or nginx reverse proxy, and firewall off |
 | TCP:10009 | Management backend, such as statistics, banning etc | Port release or nginx reverse proxy, and firewall off |
 
-## Relationship Between APP and OpenIM
+</details>
 
-OpenIM is an open source instant messaging component, it is not an independent product. This image shows the relationship between AppServer, AppClient, Open-IM-Server and Open-IM-SDK.
+## :link: Relationship Between APP and OpenIM
 
-![https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/open-im-server.png](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/images/open-im-server.png)
+OpenIM isn't just an open-source instant messaging component, it's an integral part of your application ecosystem. Check out this diagram to understand how AppServer, AppClient, Open-IM-Server, and Open-IM-SDK interact.
 
-## Overall Architecture
+![App-OpenIM Relationship](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/images/open-im-server.png)
 
-![https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/Architecture.jpg](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/images/Architecture.jpg)
+## :building_construction: Overall Architecture
 
-## To start developing OpenIM
-The [community repository](https://github.com/OpenIMSDK/community) hosts all information about building Kubernetes from source, how to contribute code and documentation, who to contact about what, etc.
+Delve into the heart of Open-IM-Server's functionality with our architecture diagram.
 
+![Overall Architecture](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/images/Architecture.jpg)
 
-## Contributing
+## :hammer_and_wrench: To start developing OpenIM
 
-Contributions to this project are welcome! Please see [CONTRIBUTING.md](./CONTRIBUTING.md) for details.
+OpenIM Our goal is to build a top-level open source community. We have a set of standards, in the [Community repository](https://github.com/OpenIMSDK/community).
 
-## Community Meetings
-We want anyone to get involved in our community, we offer gifts and rewards, and we welcome you to join us every Thursday night.
+If you'd like to contribute to this Open-IM-Server repository, please read our [contributor documentation](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/CONTRIBUTING.md).
 
-We take notes of each [biweekly meeting](https://github.com/OpenIMSDK/Open-IM-Server/issues/381) in [GitHub discussions](https://github.com/OpenIMSDK/Open-IM-Server/discussions/categories/meeting), and our minutes are written in [Google Docs](https://docs.google.com/document/d/1nx8MDpuG74NASx081JcCpxPgDITNTpIIos0DS6Vr9GU/edit?usp=sharing).
+Before you start, please make sure your changes are in demand. The best for that is to create a [new discussion](https://github.com/OpenIMSDK/Open-IM-Server/discussions/new/choose) OR [Slack Communication](https://join.slack.com/t/openimsdk/shared_invite/zt-1tmoj26uf-_FDy3dowVHBiGvLk9e5Xkg), or if you find an issue, [report it](https://github.com/OpenIMSDK/Open-IM-Server/issues/new/choose) first.
 
+- [Code Standards](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/go_code.md)
+- [Docker Images Standards](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/images.md)
+- [Directory Standards](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/directory.md)
+- [Commit Standards](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/commit.md)
+- [Versioning Standards](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/version.md)
+- [Interface Standards](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/api.md)
+- [Log Standards](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/log.md)
+- [Error Code Standards](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/error_code.md)
 
-## Who are using Open-IM-Server
-The [user case studies](https://github.com/OpenIMSDK/community/blob/main/ADOPTERS.md) page includes the user list of the project. You can leave a [📝comment](https://github.com/OpenIMSDK/Open-IM-Server/issues/379) to let us know your use case.
+## :busts_in_silhouette: Community
 
-![avatar](https://openim-1253691595.cos.ap-nanjing.myqcloud.com/WechatIMG20.jpeg)
++ 📚 [OpenIM Community](https://github.com/OpenIMSDK/community)
++ 💕 [OpenIM Interest Group](https://github.com/Openim-sigs)
++ 🚀 [Join our Slack community](https://join.slack.com/t/openimsdk/shared_invite/zt-1tmoj26uf-_FDy3dowVHBiGvLk9e5Xkg)
++ :eyes: [Join our wechat (微信群)](https://openim-1253691595.cos.ap-nanjing.myqcloud.com/WechatIMG20.jpeg)
 
-## License
+## :calendar: Community Meetings
 
-Open-IM-Server is under the Apache 2.0 license. See the [LICENSE](./LICENSE) file for details
+We want anyone to get involved in our community and contributing code, we offer gifts and rewards, and we welcome you to join us every Thursday night.
+
+Our conference is in the [OpenIM Slack](https://join.slack.com/t/openimsdk/shared_invite/zt-1tmoj26uf-_FDy3dowVHBiGvLk9e5Xkg) 🎯, then you can search the Open-IM-Server pipeline to join
+
+We take notes of each [biweekly meeting](https://github.com/orgs/OpenIMSDK/discussions/categories/meeting) in [GitHub discussions](https://github.com/OpenIMSDK/Open-IM-Server/discussions/categories/meeting), Our historical meeting notes, as well as replays of the meetings are available at [Google Docs :bookmark_tabs:](https://docs.google.com/document/d/1nx8MDpuG74NASx081JcCpxPgDITNTpIIos0DS6Vr9GU/edit?usp=sharing).
+
+## :eyes: Who are using OpenIM
+
+Check out our [user case studies](https://github.com/OpenIMSDK/community/blob/main/ADOPTERS.md) page for a list of the project users. Don't hesitate to leave a [📝comment](https://github.com/OpenIMSDK/Open-IM-Server/issues/379) and share your use case.
+
+## :page_facing_up: License
+
+OpenIM is licensed under the Apache 2.0 license. See [LICENSE](https://github.com/OpenIMSDK/Open-IM-Server/tree/main/LICENSE) for the full license text.
+
+The OpenIM logo, including its variations and animated versions, displayed in this repository [OpenIM](https://github.com/OpenIMSDK/Open-IM-Server) under the [assets/logo](./assets/logo) and [assets/logo-gif](assets/logo-gif) directories, are protected by copyright laws.
+
+## 🔮 Thanks to our contributors!
+
+<a href="https://github.com/OpenIMSDK/Open-IM-Server/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=OpenIMSDK/Open-IM-Server" />
+</a>

assets/demo/README.md

@@ -0,0 +1,14 @@
+## :star2: Why OpenIM
+
+**🔍 Function screenshot display**
+
+<div align="center">
+
+
+|             multiple message              |               Efficient meetings                |
+| :---------------------------------------: | :---------------------------------------------: |
+| ![multiple-message](./multiple-message.png) | ![efficient-meetings](./efficient-meetings.png) |
+|      **One-to-one and group chats**       |     **Special features - Custom messages**      |
+|      ![group-chat](./group-chat.png)      |   ![special-function](./special-function.png)    |
+
+</div>

build/docker/openim-api/Dockerfile

@@ -1,12 +0,0 @@
-FROM golang:1.20.0 as build
-
-WORKDIR /openim
-
-RUN ln -sf /usr/share/zoneinfo/Asia/Shanghai /etc/localtime && \
-      echo "Asia/Shanghai" > /etc/timezone && \
-      mkdir -p /var/log/miniblog
-
-COPY miniblog /openim
-
-EXPOSE 10002
-CMD ["./bin/openim-api","--port", "10002"]

build/goreleaser.yaml

@@ -447,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
@@ -479,49 +479,4 @@ checksum:
   algorithm: sha256
 
 release:
-  footer: |
-  
-    ## Welcome to the {{ .Tag }} release of [chat](https://github.com/OpenIMSDK/chat)!🎉🎉!
-
-    **Full Changelog**: https://github.com/OpenIMSDK/Open-IM-Server/compare/{{ .PreviousTag }}...{{ .Tag }}
-
-    ## Helping out
-
-    We release logs are recorded on [✨ CHANGELOG](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/CHANGELOG/CHANGELOG.md)--config_folder_path
-
-    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)
-
-    This release is only possible thanks to **all** the support of some **awesome people**!
-
-    https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/version.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.
-
-    <p align="center">
-        <a href="https://github.com/kubbot" style="float: left; margin-right: 10px;">
-            <img src="https://github.com/openimbot/openimbot/blob/main/assets/icon/blue%E9%80%8F%E6%98%8E.png" width="50" height="50" />
-        </a>
-        <a href="https://www.openim.online">
-            <img src="https://github.com/OpenIMSDK/Open-IM-Server/blob/main/assets/logo/openim-logo.png" />
-        </a>
-        <a href="https://github.com/openimbot" style="float: right; margin-left: 10px;">
-            <img src="https://github.com/openimbot/openimbot/blob/main/assets/icon/red%E9%80%8F%E6%98%8E.png" width="50" height="50" />
-        </a>
-    </p>
-
-
-    ## Get Involved with OpenIM!
-
-    **Here are some ways to get involved with the OpenIM community:**
-
-    📢 **Slack Channel**: Join our Slack channels for discussions, communication, and support. Click [here](https://join.slack.com/t/openimsdk/shared_invite/zt-1tmoj26uf-_FDy3dowVHBiGvLk9e5Xkg) to join the Open-IM-Server Slack team channel.
-
-    📧 **Gmail Contact**: If you have any questions, suggestions, or feedback for our open-source projects, please feel free to [contact us via email](https://mail.google.com/mail/?view=cm&fs=1&tf=1&to=winxu81@gmail.com).
-
-    📖 **Blog**: Stay up-to-date with OpenIM-Server projects and trends by reading our [blog](https://doc.rentsoft.cn/). We share the latest developments, tech trends, and other interesting information related to OpenIM.
-
-    📱 **WeChat**: Add us on WeChat (QR Code) and indicate that you are a user or developer of Open-IM-Server. We'll process your request as soon as possible.
-
-    Remember, your contributions play a vital role in making OpenIM successful, and we look forward to your active participation in our community! 🙌
+  prerelease: auto

build/images/openim-api/Dockerfile

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

build/images/openim-cmdutils/Dockerfile

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

build/images/openim-crontask/Dockerfile

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

build/images/openim-msggateway/Dockerfile

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

build/images/openim-msgtransfer/Dockerfile

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

build/images/openim-push/Dockerfile

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

build/images/openim-rpc-auth/Dockerfile

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

build/images/openim-rpc-conversation/Dockerfile

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

build/images/openim-rpc-friend/Dockerfile

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

build/images/openim-rpc-group/Dockerfile

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

build/images/openim-rpc-msg/Dockerfile

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

build/images/openim-rpc-third/Dockerfile

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

build/images/openim-rpc-user/Dockerfile

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

@@ -26,14 +26,15 @@ import (
 
 	_ "net/http/pprof"
 
-	"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/protocol/constant"
 	"github.com/OpenIMSDK/tools/discoveryregistry"
 	openKeeper "github.com/OpenIMSDK/tools/discoveryregistry/zookeeper"
 	"github.com/OpenIMSDK/tools/log"
+
+	"github.com/OpenIMSDK/Open-IM-Server/internal/api"
+	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/cmd"
+	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/config"
+	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/db/cache"
 )
 
 func main() {

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

@@ -21,7 +21,7 @@ import (
 
 func main() {
 	cronTaskCmd := cmd.NewCronTaskCmd()
-	if err := cronTaskCmd.Exec(tools.StartCronTask); err != nil {
+	if err := cronTaskCmd.Exec(tools.StartTask); err != nil {
 		panic(err.Error())
 	}
 }

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-rpc/openim-rpc-auth/Makefile

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

config/config.yaml

@@ -24,10 +24,10 @@
 # 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
@@ -42,12 +42,12 @@ mysql:
   address: [ 127.0.0.1:13306 ]
   username: root
   password: openIM123
-  database: openIM_v3                     
-  maxOpenConn: 1000                       
-  maxIdleConn: 100                        
-  maxLifeTime: 60                         
-  logLevel: 4                             
-  slowThreshold: 500    
+  database: openIM_v3
+  maxOpenConn: 1000
+  maxIdleConn: 100
+  maxLifeTime: 60
+  logLevel: 4
+  slowThreshold: 500
 
 ###################### Mongo ######################
 # MongoDB configuration
@@ -62,7 +62,7 @@ mongo:
   database: openIM_v3
   username: root
   password: openIM123
-  maxPoolSize: 100  
+  maxPoolSize: 100
 
 ###################### Redis ######################
 # Redis configuration
@@ -70,7 +70,7 @@ mongo:
 # Username is required only for Redis version 6.0+
 redis:
   address: [ 127.0.0.1:16379 ]
-  username:                               
+  username:
   password: openIM123
 
 ###################### Kafka ######################
@@ -81,13 +81,13 @@ redis:
 # It's not recommended to modify this topic name
 # Consumer group ID, it's not recommended to modify
 kafka:
-  username:                               
-  password:                               
+  username:
+  password:
   addr: [ 127.0.0.1:9092 ]
   latestMsgToRedis:
-    topic: "latestMsgToRedis"             
+    topic: "latestMsgToRedis"
   offlineMsgToMongo:
-    topic: "offlineMsgToMongoMysql"       
+    topic: "offlineMsgToMongoMysql"
   msgToPush:
     topic: "msgToPush"
   consumerGroupID:
@@ -111,8 +111,8 @@ rpc:
 # API service port
 # Default listen IP is 0.0.0.0
 api:
-  openImApiPort: [ 10002 ]                
-  listenIP: 0.0.0.0    
+  openImApiPort: [ 10002 ]
+  listenIP: 0.0.0.0
 
 ###################### Gateway ######################
 # Object storage configuration
@@ -124,25 +124,29 @@ api:
 # Session token
 # Configuration for Tencent COS
 # Configuration for Aliyun OSS
+# apiURL is the address of the api, the access address of the app, use s3 must be configured
+# minio.endpoint can be configured as an intranet address,
+# minio.signEndpoint is minio public network address
 object:
-  enable: "minio"                         
-  apiURL: http://127.0.0.1:10002/object/
+  enable: "minio"
+  apiURL: "http://127.0.0.1:10002"
   minio:
-    bucket: "openim"                      
-    endpoint: http://127.0.0.1:10005
-    accessKeyID: root
-    secretAccessKey: openIM123
-    sessionToken: ""                      
-  cos:                                    
+    bucket: "openim"
+    endpoint: "http://127.0.0.1:10005"
+    accessKeyID: "root"
+    secretAccessKey: "openIM123"
+    sessionToken: ""
+    signEndpoint: "http://127.0.0.1:10005"
+  cos:
     bucketURL: "https://temp-1252357374.cos.ap-chengdu.myqcloud.com"
     secretID: ""
     secretKey: ""
     sessionToken: ""
-  oss:                                    
+  oss:
     endpoint: "https://oss-cn-chengdu.aliyuncs.com"
     bucket: "demo-9999999"
     bucketURL: "https://demo-9999999.oss-cn-chengdu.aliyuncs.com"
-    accessKeyID: root
+    accessKeyID: ""
     accessKeySecret: ""
     sessionToken: ""
 
@@ -150,7 +154,7 @@ object:
 # These ports are passed into the program by the script and are not recommended to modify
 # For launching multiple programs, just fill in multiple ports separated by commas
 # For example, [10110, 10111]
-rpcPort: 
+rpcPort:
   openImUserPort: [ 10110 ]
   openImFriendPort: [ 10120 ]
   openImMessagePort: [ 10130 ]
@@ -183,12 +187,12 @@ rpcRegisterName:
 # Whether to output in json format
 # Whether to include stack trace in logs
 log:
-  storageLocation: ../../../../../logs/  
-  rotationTime: 24                        
-  remainRotationCount: 2                  
-  remainLogLevel: 6                       
-  isStdout: false                         
-  isJson: false                           
+  storageLocation: ../../../../../logs/
+  rotationTime: 24
+  remainRotationCount: 2
+  remainLogLevel: 6
+  isStdout: false
+  isJson: false
   withStack: false
 
 # Long connection server configuration
@@ -198,10 +202,10 @@ log:
 # Maximum length of websocket request package
 # Websocket connection handshake timeout
 longConnSvr:
-  openImWsPort: [ 10001 ]                 
-  websocketMaxConnNum: 100000             
-  websocketMaxMsgLen: 4096                
-  websocketTimeout: 10  
+  openImWsPort: [ 10001 ]
+  websocketMaxConnNum: 100000
+  websocketMaxMsgLen: 4096
+  websocketTimeout: 10
 
 # Push notification service configuration
 #
@@ -371,4 +375,4 @@ prometheus:
   conversationPrometheusPort: [ 20230 ]
   rtcPrometheusPort: [ 21300 ]
   thirdPrometheusPort: [ 21301 ]
-  messageTransferPrometheusPort: [ 21400, 21401, 21402, 21403 ]
+  messageTransferPrometheusPort: [ 21400, 21401, 21402, 21403 ]

config/notification.yaml

@@ -304,6 +304,16 @@ userInfoUpdated:
     desc: "Remove a blocked user"
     ext: "Remove a blocked user"
 
+userStatusChanged:
+  isSendMsg: false
+  reliabilityLevel: 1
+  unreadCount: false
+  offlinePush:
+    enable: false
+    title: "user status changed"
+    desc: "user status changed"
+    ext: "user status changed"
+
 #####################conversation#########################
 conversationChanged:
   isSendMsg: false

deployments/README.md

@@ -2,6 +2,16 @@
 
 OpenIM 支持很多种集群化部署方式，包括但不限于 helm, sealos, kubeam, kubesphere, kubeflow, kuboard, kubespray, k3s, k3d, k3c, k3sup, k3v, k3x
 
+**目前还在开发这个模块，预计 v3.2.0 之前会有一个集群方案。**
+
+目前各个贡献者，以及之前的官方有出过一些可以参考的方案：
+
+- https://github.com/OpenIMSDK/k8s-jenkins
+- https://github.com/OpenIMSDK/Open-IM-Server-k8s-deploy
+- https://github.com/OpenIMSDK/openim-charts
+- https://github.com/showurl/deploy-openim
+
+
 ### 依赖检查
 
 ```bash
@@ -23,4 +33,4 @@ $ cd ${OpenIM_ROOT}
 
 
 
-### Helm安装
+### Helm安装

deployments/templates/env_template.yaml

@@ -0,0 +1,19 @@
+# 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.
+
+USER=${USER}
+PASSWORD=${PASSWORD}
+MINIO_ENDPOINT=${MINIO_ENDPOINT}
+API_URL=${API_URL}
+DATA_DIR=${DATA_DIR}

deployments/templates/init/README.md

@@ -0,0 +1,220 @@
+# Systemd Configuration, Installation, and Startup
+
+- [Systemd Configuration, Installation, and Startup](#systemd-configuration-installation-and-startup)
+  - [1. Introduction](#1-introduction)
+  - [2. Prerequisites (Requires root permissions)](#2-prerequisites-requires-root-permissions)
+  - [3. Create `openim-api` systemd unit template file](#3-create-openim-api-systemd-unit-template-file)
+  - [4. Copy systemd unit template file to systemd config directory (Requires root permissions)](#4-copy-systemd-unit-template-file-to-systemd-config-directory-requires-root-permissions)
+  - [5. Start systemd service](#5-start-systemd-service)
+
+## 1. Introduction
+
+Systemd is the default service management form for the latest Linux distributions, replacing the original init.
+
+Format introduction:
+
+```bash
+[Unit] : Unit of the service
+
+Description: Brief description of the service
+
+[Service]: Configuration of the service's runtime behavior
+
+ExecStart: Complete path of the program
+
+Restart: Restart configurations like no, always, on-success, on-failure, on-abnormal, on-abort, on-watchdog
+
+[Install]: Installation configuration
+
+WantedBy: Multi-user, etc.
+```
+
+For more details, refer to: [Systemd Service Manual](https://www.freedesktop.org/software/systemd/man/systemd.service.html)
+
+Starting command:
+
+```bash
+systemctl daemon-reload && systemctl enable openim-api && systemctl restart openim-api
+```
+
+Service status:
+
+```bash
+systemctl status openim-api
+```
+
+Stop command:
+
+```bash
+systemctl stop openim-api
+```
+
+More command:
+```bash
+# 列出正在运行的Unit,可以直接使用systemctl
+systemctl list-units
+
+# 列出所有Unit，包括没有找到配置文件的或者启动失败的
+systemctl list-units --all
+
+# 列出所有没有运行的 Unit
+systemctl list-units --all --state=inactive
+
+# 列出所有加载失败的 Unit
+systemctl list-units --failed
+
+# 列出所有正在运行的、类型为service的Unit
+systemctl list-units --type=service
+
+# 显示某个 Unit 是否正在运行
+systemctl is-active application.service
+
+# 显示某个 Unit 是否处于启动失败状态
+systemctl is-failed application.service
+
+# 显示某个 Unit 服务是否建立了启动链接
+systemctl is-enabled application.service
+
+# 立即启动一个服务
+sudo systemctl start apache.service
+
+# 立即停止一个服务
+sudo systemctl stop apache.service
+
+# 重启一个服务
+sudo systemctl restart apache.service
+
+# 重新加载一个服务的配置文件
+sudo systemctl reload apache.service
+
+# 重载所有修改过的配置文件
+sudo systemctl daemon-reload
+```
+
+**Why choose systemd?**
+
+**Advanced requirements:**
+
+- Convenient service runtime log recording for problem analysis
+- Service management logs
+- Option to restart upon abnormal exit
+
+The daemon does not meet these advanced requirements.
+
+`nohup` only logs the service's runtime outputs and errors.
+
+Only systemd can fulfill all of the above requirements.
+
+> The default logs are enhanced with timestamps, usernames, service names, PIDs, etc., making them user-friendly. You can view logs of abnormal service exits. Advanced customization is possible through the configuration files in `/lib/systemd/system/`.
+
+In short, systemd is the current mainstream way to manage backend services on Linux, so I've abandoned `nohup` in my new versions of bash scripts, opting instead for systemd.
+
+## 2. Prerequisites (Requires root permissions)
+
+1. Configure `environment.sh` based on the comments.
+2. Create a data directory:
+
+```bash
+mkdir -p ${OPENIM_DATA_DIR}/{openim-api,openim-crontask}
+```
+
+3. Create a bin directory and copy `openim-api` and `openim-crontask` executable files:
+
+```bash
+source ./environment.sh
+mkdir -p ${OPENIM_INSTALL_DIR}/bin
+cp openim-api openim-crontask ${OPENIM_INSTALL_DIR}/bin
+```
+
+4. Copy the configuration files of `openim-api` and `openim-crontask` to the `${OPENIM_CONFIG_DIR}` directory:
+
+```bash
+mkdir -p ${OPENIM_CONFIG_DIR}
+cp openim-api.yaml openim-crontask.yaml ${OPENIM_CONFIG_DIR}
+```
+
+## 3. Create `openim-api` systemd unit template file
+
+For each OpenIM service, we will create a systemd unit template. Follow the steps below for each service:
+
+Run the following shell script to generate the `openim-api.service.template`:
+
+```bash
+source ./environment.sh
+cat > openim-api.service.template <<EOF
+[Unit]
+Description=OpenIM Server API
+Documentation=https://github.com/marmotedu/iam/blob/master/init/README.md
+
+[Service]
+WorkingDirectory=${OPENIM_DATA_DIR}/openim-api
+ExecStart=${OPENIM_INSTALL_DIR}/bin/openim-api --config=${OPENIM_CONFIG_DIR}/openim-api.yaml
+Restart=always
+RestartSec=5
+StartLimitInterval=0
+
+[Install]
+WantedBy=multi-user.target
+EOF
+```
+
+Following the above style, create the respective template files or generate them in bulk:
+
+First, make sure you've sourced the environment variables:
+
+```bash
+source ./environment.sh
+```
+
+Use the shell script to generate the systemd unit template for each service:
+
+```bash
+declare -a services=(
+"openim-api"
+... [other services]
+)
+
+for service in "${services[@]}"
+do
+   cat > $service.service.template <<EOF
+[Unit]
+Description=OpenIM Server - $service
+Documentation=https://github.com/marmotedu/iam/blob/master/init/README.md
+
+[Service]
+WorkingDirectory=${OPENIM_DATA_DIR}/$service
+ExecStart=${OPENIM_INSTALL_DIR}/bin/$service --config=${OPENIM_CONFIG_DIR}/$service.yaml
+Restart=always
+RestartSec=5
+StartLimitInterval=0
+
+[Install]
+WantedBy=multi-user.target
+EOF
+done
+```
+
+## 4. Copy systemd unit template file to systemd config directory (Requires root permissions)
+
+Ensure you have root permissions to perform this operation:
+
+```bash
+for service in "${services[@]}"
+do
+   sudo cp $service.service.template /etc/systemd/system/$service.service
+done
+...
+```
+
+## 5. Start systemd service
+
+To start the OpenIM services:
+
+```bash
+for service in "${services[@]}"
+do
+   sudo systemctl daemon-reload 
+   sudo systemctl enable $service 
+   sudo systemctl restart $service
+done
+```

deployments/templates/init/openim-api.service

@@ -0,0 +1,16 @@
+[Unit]
+Description=OPENIM OPENIM API
+Documentation=Control interface for the OpenIM API service.
+Documentation=https://github.com/OpenIMSDK/Open-IM-Server/blob/main/deployment/init/README.md
+
+[Service]
+WorkingDirectory=${OPENIM_DATA_DIR}/openim-api
+ExecStartPre=/usr/bin/mkdir -p ${OPENIM_DATA_DIR}/openim-api
+ExecStartPre=/usr/bin/mkdir -p ${OPENIM_LOG_DIR}
+ExecStart=${OPENIM_INSTALL_DIR}/bin/openim-api --config=${OPENIM_CONFIG_DIR}/openim-api.yaml
+Restart=always
+RestartSec=5
+StartLimitInterval=0
+
+[Install]
+WantedBy=multi-user.target

deployments/templates/init/openim-cmdutils.service

@@ -0,0 +1,16 @@
+[Unit]
+Description=OPENIM OPENIM CMDUTILS
+Documentation=Utility toolkit for common OpenIM command-line operations.
+Documentation=https://github.com/OpenIMSDK/Open-IM-Server/blob/main/deployment/init/README.md
+
+[Service]
+WorkingDirectory=${OPENIM_DATA_DIR}/openim-cmdutils
+ExecStartPre=/usr/bin/mkdir -p ${OPENIM_DATA_DIR}/openim-cmdutils
+ExecStartPre=/usr/bin/mkdir -p ${OPENIM_LOG_DIR}
+ExecStart=${OPENIM_INSTALL_DIR}/bin/openim-cmdutils --config=${OPENIM_CONFIG_DIR}/openim-cmdutils.yaml
+Restart=always
+RestartSec=5
+StartLimitInterval=0
+
+[Install]
+WantedBy=multi-user.target

deployments/templates/init/openim-crontask.service

@@ -0,0 +1,16 @@
+[Unit]
+Description=OPENIM OPENIM CRONTASK
+Documentation=Manages the OpenIM CronTask service, with both direct and systemctl installation methods.
+Documentation=https://github.com/OpenIMSDK/Open-IM-Server/blob/main/deployment/init/README.md
+
+[Service]
+WorkingDirectory=${OPENIM_DATA_DIR}/openim-crontask
+ExecStartPre=/usr/bin/mkdir -p ${OPENIM_DATA_DIR}/openim-crontask
+ExecStartPre=/usr/bin/mkdir -p ${OPENIM_LOG_DIR}
+ExecStart=${OPENIM_INSTALL_DIR}/bin/openim-crontask -c=${OPENIM_CONFIG_DIR}
+Restart=always
+RestartSec=5
+StartLimitInterval=0
+
+[Install]
+WantedBy=multi-user.target

deployments/templates/init/openim-msggateway.service

@@ -0,0 +1,15 @@
+[Unit]
+Description=OPENIM OPENIM MSGGATEWAY
+Documentation=https://github.com/OpenIMSDK/Open-IM-Server/blob/main/deployment/init/README.md
+
+[Service]
+WorkingDirectory=${OPENIM_DATA_DIR}/openim-msggateway
+ExecStartPre=/usr/bin/mkdir -p ${OPENIM_DATA_DIR}/openim-msggateway
+ExecStartPre=/usr/bin/mkdir -p ${OPENIM_LOG_DIR}
+ExecStart=${OPENIM_INSTALL_DIR}/bin/openim-msggateway --config=${OPENIM_CONFIG_DIR}/openim-msggateway.yaml
+Restart=always
+RestartSec=5
+StartLimitInterval=0
+
+[Install]
+WantedBy=multi-user.target

deployments/templates/init/openim-msgtransfer.service

@@ -0,0 +1,15 @@
+[Unit]
+Description=OPENIM OPENIM MSGTRANSFER
+Documentation=https://github.com/OpenIMSDK/Open-IM-Server/blob/main/deployment/init/README.md
+
+[Service]
+WorkingDirectory=${OPENIM_DATA_DIR}/openim-msgtransfer
+ExecStartPre=/usr/bin/mkdir -p ${OPENIM_DATA_DIR}/openim-msgtransfer
+ExecStartPre=/usr/bin/mkdir -p ${OPENIM_LOG_DIR}
+ExecStart=${OPENIM_INSTALL_DIR}/bin/openim-msgtransfer --config=${OPENIM_CONFIG_DIR}/openim-msgtransfer.yaml
+Restart=always
+RestartSec=5
+StartLimitInterval=0
+
+[Install]
+WantedBy=multi-user.target

deployments/templates/init/openim-push.service

@@ -0,0 +1,16 @@
+[Unit]
+Description=OPENIM OPENIM PUSH
+Documentation=Interface for controlling the OpenIM Push Notification service.
+Documentation=https://github.com/OpenIMSDK/Open-IM-Server/blob/main/deployment/init/README.md
+
+[Service]
+WorkingDirectory=${OPENIM_DATA_DIR}/openim-push
+ExecStartPre=/usr/bin/mkdir -p ${OPENIM_DATA_DIR}/openim-push
+ExecStartPre=/usr/bin/mkdir -p ${OPENIM_LOG_DIR}
+ExecStart=${OPENIM_INSTALL_DIR}/bin/openim-push --port ${OPENIM_PUSH_PORT} --prometheus_port ${PUSH_PROM_PORT}
+Restart=always
+RestartSec=5
+StartLimitInterval=0
+
+[Install]
+WantedBy=multi-user.target

deployments/templates/init/openim-rpc-auth.service

@@ -0,0 +1,15 @@
+[Unit]
+Description=OPENIM OPENIM RPC AUTH
+Documentation=https://github.com/OpenIMSDK/Open-IM-Server/blob/main/deployment/init/README.md
+
+[Service]
+WorkingDirectory=${OPENIM_DATA_DIR}/openim-rpc-auth
+ExecStartPre=/usr/bin/mkdir -p ${OPENIM_DATA_DIR}/openim-rpc-auth
+ExecStartPre=/usr/bin/mkdir -p ${OPENIM_LOG_DIR}
+ExecStart=${OPENIM_INSTALL_DIR}/bin/openim-rpc-auth --config=${OPENIM_CONFIG_DIR}/openim-rpc-auth.yaml
+Restart=always
+RestartSec=5
+StartLimitInterval=0
+
+[Install]
+WantedBy=multi-user.target

deployments/templates/init/openim-rpc-conversation.service

@@ -0,0 +1,15 @@
+[Unit]
+Description=OPENIM OPENIM RPC CONVERSATION
+Documentation=https://github.com/OpenIMSDK/Open-IM-Server/blob/main/deployment/init/README.md
+
+[Service]
+WorkingDirectory=${OPENIM_DATA_DIR}/openim-rpc-conversation
+ExecStartPre=/usr/bin/mkdir -p ${OPENIM_DATA_DIR}/openim-rpc-conversation
+ExecStartPre=/usr/bin/mkdir -p ${OPENIM_LOG_DIR}
+ExecStart=${OPENIM_INSTALL_DIR}/bin/openim-rpc-conversation --config=${OPENIM_CONFIG_DIR}/openim-rpc-conversation.yaml
+Restart=always
+RestartSec=5
+StartLimitInterval=0
+
+[Install]
+WantedBy=multi-user.target