feat: set openim lint

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

.github/workflows/cla.yml

@@ -33,7 +33,7 @@ env:
   OPEN_IM_SERVER_CLA_DOCUMENT: https://github.com/openim-sigs/cla/blob/main/README.md
   OPEN_IM_SERVER_SIGNATURES_PATH: signatures/${{ github.event.repository.name }}/cla.json
 
-  OPEN_IM_SERVER_ALLOWLIST: kubbot,bot*,bot-*,bot/*,bot-/*,bot,*[bot]
+  OPEN_IM_SERVER_ALLOWLIST: kubbot,openimbot,bot*,dependabot,sweep-ai,*bot,bot-*,bot/*,bot-/*,bot,*[bot]
 
 jobs:
   CLAAssistant:

.github/workflows/docker-buildx.yml

@@ -106,6 +106,16 @@ jobs:
             ghcr.io/openimsdk/openim-api
             openim/openim-api
             registry.cn-hangzhou.aliyuncs.com/openimsdk/openim-api
+          tags: |
+            type=ref,event=tag
+            type=schedule
+            type=ref,event=branch
+            type=ref,event=pr
+            type=semver,pattern={{version}}
+            type=semver,pattern=v{{version}}
+            type=semver,pattern={{major}}.{{minor}}
+            type=semver,pattern={{major}}
+            type=sha
 
       - name: Build and push Docker image for openim-api
         uses: docker/build-push-action@v5
@@ -127,6 +137,16 @@ jobs:
             ghcr.io/openimsdk/openim-cmdutils
             openim/openim-cmdutils
             registry.cn-hangzhou.aliyuncs.com/openimsdk/openim-cmdutils
+          tags: |
+            type=ref,event=tag
+            type=schedule
+            type=ref,event=branch
+            type=ref,event=pr
+            type=semver,pattern={{version}}
+            type=semver,pattern=v{{version}}
+            type=semver,pattern={{major}}.{{minor}}
+            type=semver,pattern={{major}}
+            type=sha
 
       - name: Build and push Docker image for openim-cmdutils
         uses: docker/build-push-action@v5
@@ -148,6 +168,16 @@ jobs:
             ghcr.io/openimsdk/openim-crontask
             openim/openim-crontask
             registry.cn-hangzhou.aliyuncs.com/openimsdk/openim-crontask
+          tags: |
+            type=ref,event=tag
+            type=schedule
+            type=ref,event=branch
+            type=ref,event=pr
+            type=semver,pattern={{version}}
+            type=semver,pattern=v{{version}}
+            type=semver,pattern={{major}}.{{minor}}
+            type=semver,pattern={{major}}
+            type=sha
 
       - name: Build and push Docker image for openim-crontask
         uses: docker/build-push-action@v5
@@ -169,6 +199,16 @@ jobs:
             ghcr.io/openimsdk/openim-msggateway
             openim/openim-msggateway
             registry.cn-hangzhou.aliyuncs.com/openimsdk/openim-msggateway
+          tags: |
+            type=ref,event=tag
+            type=schedule
+            type=ref,event=branch
+            type=ref,event=pr
+            type=semver,pattern={{version}}
+            type=semver,pattern=v{{version}}
+            type=semver,pattern={{major}}.{{minor}}
+            type=semver,pattern={{major}}
+            type=sha
 
       - name: Build and push Docker image for openim-msggateway
         uses: docker/build-push-action@v5
@@ -190,6 +230,16 @@ jobs:
             ghcr.io/openimsdk/openim-msgtransfer
             openim/openim-msgtransfer
             registry.cn-hangzhou.aliyuncs.com/openimsdk/openim-msgtransfer
+          tags: |
+            type=ref,event=tag
+            type=schedule
+            type=ref,event=branch
+            type=ref,event=pr
+            type=semver,pattern={{version}}
+            type=semver,pattern=v{{version}}
+            type=semver,pattern={{major}}.{{minor}}
+            type=semver,pattern={{major}}
+            type=sha
 
       - name: Build and push Docker image for openim-msgtransfer
         uses: docker/build-push-action@v5
@@ -211,6 +261,16 @@ jobs:
             ghcr.io/openimsdk/openim-push
             openim/openim-push
             registry.cn-hangzhou.aliyuncs.com/openimsdk/openim-push
+          tags: |
+            type=ref,event=tag
+            type=schedule
+            type=ref,event=branch
+            type=ref,event=pr
+            type=semver,pattern={{version}}
+            type=semver,pattern=v{{version}}
+            type=semver,pattern={{major}}.{{minor}}
+            type=semver,pattern={{major}}
+            type=sha
 
       - name: Build and push Docker image for openim-push
         uses: docker/build-push-action@v5
@@ -232,6 +292,16 @@ jobs:
             ghcr.io/openimsdk/openim-rpc-auth
             openim/openim-rpc-auth
             registry.cn-hangzhou.aliyuncs.com/openimsdk/openim-rpc-auth
+          tags: |
+            type=ref,event=tag
+            type=schedule
+            type=ref,event=branch
+            type=ref,event=pr
+            type=semver,pattern={{version}}
+            type=semver,pattern=v{{version}}
+            type=semver,pattern={{major}}.{{minor}}
+            type=semver,pattern={{major}}
+            type=sha
 
       - name: Build and push Docker image for openim-rpc-auth
         uses: docker/build-push-action@v5
@@ -253,6 +323,16 @@ jobs:
             ghcr.io/openimsdk/openim-rpc-conversation
             openim/openim-rpc-conversation
             registry.cn-hangzhou.aliyuncs.com/openimsdk/openim-rpc-conversation
+          tags: |
+            type=ref,event=tag
+            type=schedule
+            type=ref,event=branch
+            type=ref,event=pr
+            type=semver,pattern={{version}}
+            type=semver,pattern=v{{version}}
+            type=semver,pattern={{major}}.{{minor}}
+            type=semver,pattern={{major}}
+            type=sha
 
       - name: Build and push Docker image for openim-rpc-conversation
         uses: docker/build-push-action@v5
@@ -274,6 +354,16 @@ jobs:
             ghcr.io/openimsdk/openim-rpc-friend
             openim/openim-rpc-friend
             registry.cn-hangzhou.aliyuncs.com/openimsdk/openim-rpc-friend
+          tags: |
+            type=ref,event=tag
+            type=schedule
+            type=ref,event=branch
+            type=ref,event=pr
+            type=semver,pattern={{version}}
+            type=semver,pattern=v{{version}}
+            type=semver,pattern={{major}}.{{minor}}
+            type=semver,pattern={{major}}
+            type=sha
 
       - name: Build and push Docker image for openim-rpc-friend
         uses: docker/build-push-action@v5
@@ -295,6 +385,16 @@ jobs:
             ghcr.io/openimsdk/openim-rpc-group
             openim/openim-rpc-group
             registry.cn-hangzhou.aliyuncs.com/openimsdk/openim-rpc-group
+          tags: |
+            type=ref,event=tag
+            type=schedule
+            type=ref,event=branch
+            type=ref,event=pr
+            type=semver,pattern={{version}}
+            type=semver,pattern=v{{version}}
+            type=semver,pattern={{major}}.{{minor}}
+            type=semver,pattern={{major}}
+            type=sha
 
       - name: Build and push Docker image for openim-rpc-group
         uses: docker/build-push-action@v5
@@ -316,6 +416,16 @@ jobs:
             ghcr.io/openimsdk/openim-rpc-msg
             openim/openim-rpc-msg
             registry.cn-hangzhou.aliyuncs.com/openimsdk/openim-rpc-msg
+          tags: |
+            type=ref,event=tag
+            type=schedule
+            type=ref,event=branch
+            type=ref,event=pr
+            type=semver,pattern={{version}}
+            type=semver,pattern=v{{version}}
+            type=semver,pattern={{major}}.{{minor}}
+            type=semver,pattern={{major}}
+            type=sha
 
       - name: Build and push Docker image for openim-rpc-msg
         uses: docker/build-push-action@v5
@@ -337,6 +447,16 @@ jobs:
             ghcr.io/openimsdk/openim-rpc-third
             openim/openim-rpc-third
             registry.cn-hangzhou.aliyuncs.com/openimsdk/openim-rpc-third
+          tags: |
+            type=ref,event=tag
+            type=schedule
+            type=ref,event=branch
+            type=ref,event=pr
+            type=semver,pattern={{version}}
+            type=semver,pattern=v{{version}}
+            type=semver,pattern={{major}}.{{minor}}
+            type=semver,pattern={{major}}
+            type=sha
 
       - name: Build and push Docker image for openim-rpc-third
         uses: docker/build-push-action@v5
@@ -358,6 +478,16 @@ jobs:
             ghcr.io/openimsdk/openim-rpc-user
             openim/openim-rpc-user
             registry.cn-hangzhou.aliyuncs.com/openimsdk/openim-rpc-user
+          tags: |
+            type=ref,event=tag
+            type=schedule
+            type=ref,event=branch
+            type=ref,event=pr
+            type=semver,pattern={{version}}
+            type=semver,pattern=v{{version}}
+            type=semver,pattern={{major}}.{{minor}}
+            type=semver,pattern={{major}}
+            type=sha
 
       - name: Build and push Docker image for openim-rpc-user
         uses: docker/build-push-action@v5

.github/workflows/e2e-test.yml

@@ -92,11 +92,41 @@ jobs:
 
     - name: Exec OpenIM API test
       run: |
-        sudo make test-api
+        mkdir -p ./tmp
+        touch ./tmp/test.md
+        echo "# OpenIM Test" >> ./tmp/test.md
+        echo "## OpenIM API Test" >> ./tmp/test.md
+        echo "<details><summary>Command Output for OpenIM API Test</summary>" >> ./tmp/test.md
+        echo "<pre><code>" >> ./tmp/test.md
+        sudo make test-api | tee -a ./tmp/test.md
+        echo "</code></pre>" >> ./tmp/test.md
+        echo "</details>" >> ./tmp/test.md
 
-    - name: Exec OpenIM E2E test
+    - name: Exec OpenIM E2E Test
       run: |
-        sudo make test-e2e
+        echo "" >> ./tmp/test.md
+        echo "## OpenIM E2E Test" >> ./tmp/test.md
+        echo "<details><summary>Command Output for OpenIM E2E Test</summary>" >> ./tmp/test.md
+        echo "<pre><code>" >> ./tmp/test.md
+        sudo make test-e2e | tee -a ./tmp/test.md
+        echo "</code></pre>" >> ./tmp/test.md
+        echo "</details>" >> ./tmp/test.md
+
+    - name: Comment PR with file
+      uses: thollander/actions-comment-pull-request@v2
+      with:
+        filePath: ./tmp/test.md
+        comment_tag: nrt_file
+        reactions: eyes, rocket
+        mode: recreate
+        GITHUB_TOKEN: ${{ secrets.BOT_GITHUB_TOKEN }}
+      continue-on-error: true
+
+    - name: Check outputs
+      run: |
+        echo "id : ${{ steps.nrt_message.outputs.id }}"
+        echo "body : ${{ steps.nrt_message.outputs.body }}"
+        echo "html_url : ${{ steps.nrt_message.outputs.html_url }}"
 
     - name: Exec OpenIM System uninstall
       run: |

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

@@ -17,6 +17,7 @@ on:
   issues:
     types:
       - labeled
+
 jobs:
   add-comment:
     if: github.event.label.name == 'help wanted' || github.event.label.name == 'good first issue'

.github/workflows/openimci.yml

@@ -18,39 +18,42 @@ on:
   push:
     branches:
         - main
+        - release-*
     paths-ignore:
         - "docs/**"
         - "README.md"
         - "README_zh-CN.md"
+        - "**.md"
+        - "docs/**"
         - "CONTRIBUTING.md"
   pull_request:
     branches:
         - main
+        - release-*
     paths-ignore:
         - "README.md"
         - "README_zh-CN.md"
-        - "CONTRIBUTING.md"
+        - "CONTRIBUTING/**"
+        - "**.md"
         - "docs/**"
 
 env:
   GO_VERSION: "1.19"
   GOLANGCI_VERSION: "v1.50.1"
 
-
 jobs:
   openim:
     name: Test with go ${{ matrix.go_version }} on ${{ matrix.os }}
     runs-on: ${{ matrix.os }}
     permissions:
         contents: write
+        pull-requests: write
     environment:
       name: openim
-
     strategy:
       matrix:
         go_version: ["1.19","1.20","1.21"]
         os: [ubuntu-latest]
-
     steps:
     - name: Setup
       uses: actions/checkout@v4
@@ -67,6 +70,9 @@ jobs:
         version: '3.x' # If available, use the latest major version that's compatible
         repo-token: ${{ secrets.GITHUB_TOKEN }}
 
+    - name: OpenIM Scripts Verification(make verify)
+      run: sudo make verify
+
     - name: Module Operations
       run: |
         sudo make tidy
@@ -83,16 +89,14 @@ jobs:
     - name: Build Source
       run: sudo make build
 
+    - name: Build multiarch PLATFORMS
+      if: startsWith(github.ref, 'refs/heads/release-')
+      run: |
+        sudo make multiarch
+
     - name: Cleanup Build
       run: sudo make clean
 
-    - name: Push Changes to Main
-      uses: stefanzweifel/git-auto-commit-action@v5
-      with:
-        commit_message: "cicd: robot automated Change"
-        branch: main
-      continue-on-error: true
-
     - name: Set Current Directory
       id: set_directory
       run: echo "::set-output name=directory::$(pwd)"
@@ -109,8 +113,11 @@ jobs:
       continue-on-error: true
 
   openim-start:
-    name: Test OpenIM install/start on ${{ matrix.os }}
+    name: Test OpenIM install/start on ${{ matrix.os }}-${{ matrix.arch }}
     runs-on: ${{ matrix.os }}
+    permissions:
+        contents: write
+        pull-requests: write
     environment:
       name: openim
     strategy:
@@ -129,15 +136,59 @@ jobs:
       run: |
         sudo make install
 
+    # - name: Check the OpenIM environment and status
+    #   run: |
+    #     sudo docker images
+    #     sudo docker ps
+
+    - name: Check the OpenIM environment and status
+      if: runner.os == 'Linux' && matrix.arch == 'amd64'
+      id: docker_info
+      run: |
+        sleep 30
+        echo "images<<EOF" >> $GITHUB_ENV
+        sudo docker images >> $GITHUB_ENV
+        echo "EOF" >> $GITHUB_ENV
+        echo "containers<<EOF" >> $GITHUB_ENV
+        sudo docker ps >> $GITHUB_ENV
+        echo "EOF" >> $GITHUB_ENV
+
+    - name: Comment PR
+      uses: thollander/actions-comment-pull-request@v2
+      if: runner.os == 'Linux' && matrix.arch == 'amd64'
+      with:
+        message: |
+          > [!TIP]
+          > Run make install to check the status
+
+          ### Docker Images:
+          <details><summary>Click to expand docker images</summary>
+          ```bash
+          ${{ env.images }}
+          ```
+          </details>
+
+          ### Docker Processes:
+          <details><summary>Click to expand docker ps</summary>
+          ```bash
+          ${{ env.containers }}
+          ```
+          </details>
+        GITHUB_TOKEN: ${{ secrets.BOT_GITHUB_TOKEN }}
+
   execute-scripts:
-    name: Execute OpenIM Script On ${{ matrix.os }}
+    name: Execute OpenIM Script On ${{ matrix.os }}-${{ matrix.arch }}
     runs-on: ${{ matrix.os }}
+    permissions:
+        contents: write
+        pull-requests: write
     environment:
       name: openim
     strategy:
       matrix:
-        go_version: ["1.20"]
+        go_version: ["1.21"]
         os: ["ubuntu-latest", "macos-latest"]
+        arch: [arm64, armv7, amd64]
     steps:
     - name: Checkout code
       uses: actions/checkout@v4
@@ -155,7 +206,7 @@ jobs:
         repo-token: ${{ secrets.GITHUB_TOKEN }}
 
     # - name: Install latest Bash (macOS only)
-    #   if: runner.os == 'macOS'
+    #   if: runner.os == 'macOS' && matrix.arch == 'arm64'
     #   run: |
     #     /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
     #     brew update
@@ -175,7 +226,7 @@ jobs:
         sudo sleep 20
 
     # - name: Set up Docker for macOS
-    #   if: runner.os == 'macOS'
+    #   if: runner.os == 'macOS' && matrix.arch == 'arm64'
     #   run: |
     #     brew install --cask docker
     #     open /Applications/Docker.app
@@ -201,29 +252,27 @@ jobs:
     - name: Build, Start, Check Services and Print Logs for Ubuntu
       if: runner.os == 'Linux'
       run: |
-        sudo make build && \
+        sudo make build
-        sudo make start && \
+        sudo make start
-        sudo make check || \
+        sudo make check
-        (echo "An error occurred, printing logs:" && sudo cat ./_output/logs/* 2>/dev/null)
 
     - name: Restart Services and Print Logs for Ubuntu
-      if: runner.os == 'Linux'
+      if: runner.os == 'Linux' && matrix.arch == 'amd64'
       run: |
         sudo make restart
         sudo make check
 
-    # - name: Build, Start, Check Services and Print Logs for macOS
+    - name: Build, Start, Check Services and Print Logs for macOS
-    #   if: runner.os == 'macOS'
+      if: runner.os == 'macOS' && matrix.arch == 'arm64'
-    #   run: |
+      run: |
-    #     make init && \
+        make build
-    #     make build && \
-    #     make start && \
-    #     make check || \
-    #     (echo "An error occurred, printing logs:" && sudo cat ./_output/logs/* 2>/dev/null)
 
   openim-test-build-image:
     name: Build OpenIM Docker Image
     runs-on: ubuntu-latest
+    permissions:
+        contents: write
+        pull-requests: write
     environment:
       name: openim
     steps:
@@ -245,3 +294,9 @@ jobs:
       run: |
         sudo make init
         sudo make image
+
+    - name: Get OpenIM Docker Images Status
+      id: docker_processes
+      run: |
+        sudo docker images
+        sudo docker ps

build/images/openim-rpc-encryption/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 make build BINS=openim-rpc-encryption
+
+RUN cp /openim/openim-server/_output/bin/platforms/$(go env GOOS)/$(go env GOARCH)/openim-rpc-encryption /usr/bin/openim-rpc-encryption
+
+# 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 /usr/bin/openim-rpc-encryption ./bin/openim-rpc-encryption
+
+ENTRYPOINT ["./bin/openim-rpc-encryption"]

build/images/openim-rpc-extend-msg/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 make build BINS=openim-rpc-extend-msg
+
+RUN cp /openim/openim-server/_output/bin/platforms/$(go env GOOS)/$(go env GOARCH)/openim-rpc-extend-msg /usr/bin/openim-rpc-extend-msg
+
+# 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 /usr/bin/openim-rpc-extend-msg ./bin/openim-rpc-extend-msg
+
+ENTRYPOINT ["./bin/openim-rpc-extend-msg"]

docs/.generated_docs

@@ -31,7 +31,7 @@ docs/guide/en-US/cmd/openim/openim-rpc-user_list.md
 docs/guide/en-US/cmd/openim/openim-rpc-user_update.md
 docs/guide/en-US/cmd/openim/openim_validate.md
 docs/guide/en-US/cmd/openim/openim_version.md
-docs/guide/en-US/yaml/openim/openim.yaml
+docs/guide/en-US/yaml/openim/config.yaml
 docs/guide/en-US/yaml/openim/openim_color.yaml
 docs/guide/en-US/yaml/openim/openim_completion.yaml
 docs/guide/en-US/yaml/openim/openim_info.yaml

docs/contrib/environment.md

@@ -89,7 +89,7 @@ While the first two methods will be our main focus, it's worth noting that the t
 
 ###  1.2. <a name='SourceCodeDeployment'></a>Source Code Deployment
 
-In the source code deployment method, the configuration generation process involves executing `make init`, which fundamentally runs the script `./scripts/init-config.sh`. This script utilizes variables defined in the [`environment.sh`](https://github.com/openimsdk/open-im-server/blob/main/scripts/install/environment.sh) script to render the [`openim.yaml`](https://github.com/openimsdk/open-im-server/blob/main/deployments/templates/openim.yaml) template file, subsequently generating the [`config.yaml`](https://github.com/openimsdk/open-im-server/blob/main/config/config.yaml) configuration file.
+In the source code deployment method, the configuration generation process involves executing `make init`, which fundamentally runs the script `./scripts/init-config.sh`. This script utilizes variables defined in the [`environment.sh`](https://github.com/openimsdk/open-im-server/blob/main/scripts/install/environment.sh) script to render the [`config.yaml`](https://github.com/openimsdk/open-im-server/blob/main/deployments/templates/config.yaml) template file, subsequently generating the [`config.yaml`](https://github.com/openimsdk/open-im-server/blob/main/config/config.yaml) configuration file.
 
 ###  1.3. <a name='DockerComposeDeployment'></a>Docker Compose Deployment
 
@@ -108,12 +108,15 @@ export CHAT_IMAGE_VERSION="main"
 export SERVER_IMAGE_VERSION="main"
 ```
 
-These variables are stored within the [`environment.sh`](https://github.com/OpenIMSDK/openim-docker/blob/main/scripts/install/environment.sh) configuration:
+These variables are stored within the [`environment.sh`](https://github.com/OpenIMSDK/open-im-server/blob/main/scripts/install/environment.sh) configuration:
 
 ```bash
 readonly CHAT_IMAGE_VERSION=${CHAT_IMAGE_VERSION:-'main'}
 readonly SERVER_IMAGE_VERSION=${SERVER_IMAGE_VERSION:-'main'}
 ```
+> [!IMPORTANT]
+> Can learn to read our mirror version strategy: https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/images.md
+
 
 Setting a variable, e.g., `export CHAT_IMAGE_VERSION="release-v1.3"`, will prioritize `CHAT_IMAGE_VERSION="release-v1.3"` as the variable value. Ultimately, the chosen image version is determined, and rendering is achieved through `make init` (or `./scripts/init-config.sh`).
 
@@ -127,7 +130,7 @@ For convenience, configuration through modifying environment variables is recomm
 
 + PASSWORD
 
-  + **Description**: Password for mysql, mongodb, redis, and minio.
+  + **Description**: Password for mongodb, redis, and minio.
   + **Default**: `openIM123`
   + Notes:
     + Minimum password length: 8 characters.
@@ -139,20 +142,22 @@ For convenience, configuration through modifying environment variables is recomm
 
 + OPENIM_USER
 
-  + **Description**: Username for mysql, mongodb, redis, and minio.
+  + **Description**: Username for redis, and minio.
   + **Default**: `root`
 
   ```bash
   export OPENIM_USER="root"
   ```
 
-+ API_URL
+> mongo is `openIM`, use `export MONGO_OPENIM_USERNAME="openIM"` to modify
+
++ OPENIM_IP
 
   + **Description**: API address.
   + **Note**: If the server has an external IP, it will be automatically obtained. For internal networks, set this variable to the IP serving internally.
 
   ```bash
-  export API_URL="http://ip:10002"
+  export OPENIM_IP="ip"
   ```
 
 + DATA_DIR
@@ -443,7 +448,7 @@ This section involves configuring the log settings, including storage location,
 
 | Parameter                 | Example Value            | Description                       |
 | ------------------------- | ------------------------ | --------------------------------- |
-| LOG_STORAGE_LOCATION      | ""${OPENIM_ROOT}"/logs/" | Location for storing logs         |
+| LOG_STORAGE_LOCATION      | "${OPENIM_ROOT}/logs/" | Location for storing logs         |
 | LOG_ROTATION_TIME         | "24"                     | Log rotation time (in hours)      |
 | LOG_REMAIN_ROTATION_COUNT | "2"                      | Number of log rotations to retain |
 | LOG_REMAIN_LOG_LEVEL      | "6"                      | Log level to retain               |

docs/contrib/gitcherry-pick.md

@@ -75,7 +75,7 @@ It is critical that our full community is actively engaged on enhancements in th
 
   - Be aware the cherry pick script assumes you have a git remote called `upstream` that points at the openim-server github org.
 
-    Please see our [recommended Git workflow](https://github.com/openimsdk/open-im-server/blob/main/docs/contributors/github-workflow.md#workflow).
+    Please see our [recommended Git workflow](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/github-workflow.md#workflow).
 
   - You will need to run the cherry pick script separately for each patch release you want to cherry pick to. Cherry picks should be applied to all [active](https://github.com/openimsdk/open-im-server/releases) release branches where the fix is applicable.
 

docs/contrib/github-workflow.md

@@ -8,7 +8,6 @@ description: |
   commit hygiene.
 ---
 
-![Git workflow](git_workflow.png)
 
 ## 1. Fork in the cloud
 
@@ -28,10 +27,10 @@ neither `$GOPATH/src/github.com/${your github profile name}/`
 nor any other pattern will work.
 
 ```sh
-export working_dir="$(go env GOPATH)/src/k8s.io"
+export working_dir="$(go env GOPATH)/src/github.com/openimsdk"
 ```
 
-If you already do Go development on github, the `k8s.io` directory
+If you already do Go development on github, the `github.com/openimsdk` directory
 will be a sibling to your existing `github.com` directory.
 
 Set `user` to match your github profile name:

docs/contrib/images.md

@@ -26,6 +26,7 @@ We provide multiple versions of our images to meet different project requirement
 1. `main`: This image corresponds to the latest version of the main branch in OpenIM. It is updated frequently, making it perfect for users who want to stay at the cutting edge of our features.
 2. `release-v3.*`: This is the image that corresponds to the latest version of OpenIM's stable release branch. It's ideal for users who prefer a balance between new features and stability.
 3. `v3.*.*`: These images are specific to each tag in OpenIM. They are preserved in their original state and are never overwritten. These are the go-to images for users who need a specific, unchanging version of OpenIM.
+4. The image versions adhere to Semantic Versioning 2.0.0 strategy. Taking the `openim-server` image as an example, available at [openim-server container package](https://github.com/openimsdk/open-im-server/pkgs/container/openim-server): upon tagging with v3.5.0, the CI automatically releases the following tags - `openim-server:3`, `openim-server:3.5`, `openim-server:3.5.0`, `openim-server:v3.5.0`, `openim-server:latest`, and `sha-e0244d9`. It's important to note that only `sha-e0244d9` is absolutely unique, whereas `openim-server:v3.5.0` and `openim-server:3.5.0` maintain a degree of uniqueness.
 
 ### Multi-Architecture Images
 

docs/contrib/init-config.md

@@ -23,8 +23,8 @@ In the `scripts/init_config.sh` file, we defined some template files. These temp
 ```
 # Defines an associative array where the keys are the template files and the values are the corresponding output files.
 declare -A TEMPLATES=(
-  [""${OPENIM_ROOT}"/scripts/template/config-tmpl/env.template"]="${OPENIM_OUTPUT_SUBPATH}/bin/.env"
+  ["${OPENIM_ROOT}/scripts/template/config-tmpl/env.template"]="${OPENIM_OUTPUT_SUBPATH}/bin/.env"
-  [""${OPENIM_ROOT}"/scripts/template/config-tmpl/config.yaml"]="${OPENIM_OUTPUT_SUBPATH}/bin/config.yaml"
+  ["${OPENIM_ROOT}/scripts/template/config-tmpl/config.yaml"]="${OPENIM_OUTPUT_SUBPATH}/bin/config.yaml"
 )
 ```
 

docs/contrib/mac-developer-deployment-guide.md

@@ -0,0 +1,258 @@
+# Mac Developer Deployment Guide for OpenIM
+
+## Introduction
+
+This guide aims to assist Mac-based developers in contributing effectively to OpenIM. It covers the setup of a development environment tailored for Mac, including the use of GitHub for development workflow and `devcontainer` for a consistent development experience.
+
+Before contributing to OpenIM through issues and pull requests, make sure you are familiar with GitHub and the [pull request workflow](https://docs.github.com/en/get-started/quickstart/github-flow).
+
+## Prerequisites
+
+### System Requirements
+
+- macOS (latest stable version recommended)
+- Internet connection
+- Administrator access
+
+### Knowledge Requirements
+
+- Basic understanding of Git and GitHub
+- Familiarity with Docker and containerization
+- Experience with Go programming language
+
+## Setting up the Development Environment
+
+### Installing Homebrew
+
+Homebrew is an essential package manager for macOS. Install it using:
+
+```sh
+/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
+```
+
+### Installing and Configuring Git
+
+1. Install Git:
+
+   ```sh
+   brew install git
+   ```
+
+2. Configure Git with your user details:
+
+   ```sh
+   git config --global user.name "Your Name"
+   git config --global user.email "your.email@example.com"
+   ```
+
+### Setting Up the Devcontainer
+
+`Devcontainers` provide a Docker-based isolated development environment. 
+
+Read [README.md](https://github.com/openimsdk/open-im-server/tree/main/.devcontainer) in the `.devcontainer` directory of the project to learn more about the devcontainer.
+
+To set it up:
+
+1. Install Docker Desktop for Mac from [Docker Hub](https://docs.docker.com/desktop/install/mac-install/).
+2. Install Visual Studio Code and the Remote - Containers extension.
+3. Open the cloned OpenIM repository in VS Code.
+4. VS Code will prompt to reopen the project in a container. Accept this to set up the environment automatically.
+
+### Installing Go and Dependencies
+
+Use Homebrew to install Go:
+
+```sh
+brew install go
+```
+
+Ensure the version of Go is compatible with the version required by OpenIM (refer to the main documentation for version requirements).
+
+### Additional Tools
+
+Install other required tools like Docker, Vagrant, and necessary GNU utils as described in the main documentation.
+
+## Mac Deployment openim-chat and openim-server
+
+To integrate the Chinese document into an English document for Linux deployment, we will first translate the content and then adapt it to suit the Linux environment. Here's how the translated and adapted content might look:
+
+### Ensure a Clean Environment
+
+- It's recommended to execute in a new directory.
+- Run `ps -ef | grep openim` to ensure no OpenIM processes are running.
+- Run `ps -ef | grep chat` to check for absence of chat-related processes.
+- Execute `docker ps` to verify there are no related containers running.
+
+### Source Code Deployment
+
+#### Deploying openim-server
+
+Source code deployment is slightly more complex because Docker's networking on Linux differs from Mac.
+
+```bash
+git clone https://github.com/openimsdk/open-im-server
+cd open-im-server
+
+export OPENIM_IP="Your IP" # If it's a cloud server, setting might not be needed
+make init # Generates configuration files
+```
+
+Before deploying openim-server, modify the Kafka logic in the docker-compose.yml file. Replace:
+
+```yaml
+- KAFKA_CFG_ADVERTISED_LISTENERS=PLAINTEXT://kafka:9092,EXTERNAL://${DOCKER_BRIDGE_GATEWAY:-172.28.0.1}:${KAFKA_PORT:-19094}
+```
+
+With:
+
+```yaml
+- KAFKA_CFG_ADVERTISED_LISTENERS=PLAINTEXT://kafka:9092,EXTERNAL://127.0.0.1:${KAFKA_PORT:-19094}
+```
+
+Then start the service:
+
+```bash
+docker compose up -d
+```
+
+Before starting the openim-server source, set `config/config.yaml` by replacing all instances of `172.28.0.1` with `127.0.0.1`:
+
+```bash
+vim config/config.yaml -c "%s/172\.28\.0\.1/127.0.0.1/g" -c "wq"
+```
+
+Then start openim-server:
+
+```bash
+make start
+```
+
+To check the startup:
+
+```bash
+make check
+```
+
+<aside>
+🚧 To avoid mishaps, it's best to wait five minutes before running `make check` again.
+
+</aside>
+
+#### Deploying openim-chat
+
+There are several ways to deploy openim-chat, either by source code or using Docker.
+
+Navigate back to the parent directory:
+
+```bash
+cd ..
+```
+
+First, let's look at deploying chat from source:
+
+```bash
+git clone https://github.com/openimsdk/chat
+cd chat
+make init # Generates configuration files
+```
+
+If openim-chat has not deployed MySQL, you will need to deploy it. Note that the official Docker Hub for MySQL does not support architectures like ARM, so you can use the newer version of the open-source edition:
+
+```bash
+docker run -d \
+  --name mysql \
+  -p 13306:3306 \
+  -p 3306:33060 \
+  -v "$(pwd)/components/mysql/data:/var/lib/mysql" \
+  -v "/etc/localtime:/etc/localtime" \
+  -e MYSQL_ROOT_PASSWORD="openIM123" \
+  --restart always \
+  mariadb:10.6
+```
+
+Before starting the source code of openim-chat, set `config/config.yaml` by replacing all instances of `172.28.0.1` with `127.0.0.1`:
+
+```bash
+vim config/config.yaml -c "%s/172\.28\.0\.1/127.0.0.1/g" -c "wq"
+```
+
+Then start openim-chat from source:
+
+```bash
+make start
+```
+
+To check, ensure the following four processes start successfully:
+
+```bash
+make check 
+```
+
+### Docker Deployment
+
+Refer to https://github.com/openimsdk/openim-docker for Docker deployment instructions, which can be followed similarly on Linux.
+
+```bash
+git clone https://github.com/openimsdk/openim-docker
+cd openim-docker
+export OPENIM_IP="Your IP"
+make init
+docker compose up -d 
+docker compose logs -f openim-server
+docker compose logs -f openim-chat
+```
+
+## GitHub Development Workflow
+
+### Creating a New Branch
+
+For new features or fixes, create a new branch:
+
+```sh
+git checkout -b feat/your-feature-name
+```
+
+### Making Changes and Committing
+
+1. Make your changes in the code.
+2. Stage your changes:
+
+   ```sh
+   git add .
+   ```
+
+3. Commit with a meaningful message:
+
+   ```sh
+   git commit -m "Add a brief description of your changes"
+   ```
+
+### Pushing Changes and Creating Pull Requests
+
+1. Push your branch to GitHub:
+
+   ```sh
+   git push origin feat/your-feature-name
+   ```
+
+2. Go to your fork on GitHub and create a pull request to the main OpenIM repository.
+
+### Keeping Your Fork Updated
+
+Regularly sync your fork with the main repository:
+
+```sh
+git fetch upstream
+git checkout main
+git rebase upstream/main
+```
+
+More read: [https://github.com/openimsdk/open-im-server/blob/main/CONTRIBUTING.md](https://github.com/openimsdk/open-im-server/blob/main/CONTRIBUTING.md)
+
+## Testing and Quality Assurance
+
+Run tests as described in the OpenIM documentation to ensure your changes do not break existing functionality.
+
+## Conclusion
+
+This guide provides a comprehensive overview for Mac developers to set up and contribute to OpenIM. By following these steps, you can ensure a smooth and efficient development experience. Happy coding!

docs/contrib/offline-deployment.md

@@ -6,25 +6,57 @@
 
 Below are the base images and their versions you'll need:
 
-- wurstmeister/kafka
+- [ ] bitnami/kafka:3.5.1
-- redis:7.0.0
+- [ ] redis:7.0.0
-- mongo:6.0.2
+- [ ] mongo:6.0.2
-- mysql:5.7
+- [ ] bitnami/zookeeper:3.8
-- wurstmeister/zookeeper
+- [ ] minio/minio:latest
-- minio/minio
+
+> [!IMPORTANT]
+> It is important to note that OpenIM removed mysql components from versions v3.5.0 (release-v3.5) and above, so mysql can be deployed without this requirement or above
+
+**If you need to install more IM components or monitoring products：**
+
+OpenIM:
+
+> [!TIP]
+> If you need to install more IM components or monitoring products [images.md](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/images.md)
+
+- [ ] ghcr.io/openimsdk/openim-web:latest
+- [ ] ghcr.io/openimsdk/openim-admin:latest
+- [ ] ghcr.io/openimsdk/openim-chat:latest
+- [ ] ghcr.io/openimsdk/openim-server:latest
+
+
+Monitoring:
+
+- [ ] prom/prometheus：v2.48.1
+- [ ] prom/alertmanager：v0.23.0
+- [ ] grafana/grafana：10.2.2
+- [ ] bitnami/node-exporter：1.7.0
+
 
 Use the following commands to pull these base images:
 
-```
+```bash
-docker pull wurstmeister/kafka
+docker pull bitnami/kafka:3.5.1
 docker pull redis:7.0.0
 docker pull mongo:6.0.2
 docker pull mysql:5.7
-docker pull wurstmeister/zookeeper
+docker pull bitnami/zookeeper:3.8
-docker pull minio/minio
+docker pull minio/minio:latest
 ```
 
-## 2. OpenIM & Chat Images
+If you need to install more IM components or monitoring products:
+
+```bash
+docker pull prom/prometheus:v2.48.1
+docker pull prom/alertmanager:v0.23.0
+docker pull grafana/grafana:10.2.2
+docker pull bitnami/node-exporter:1.7.0
+```
+
+## 2. OpenIM Images
 
 **For detailed understanding of version management and storage of OpenIM and Chat**: [version.md](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/version.md)
 
@@ -42,9 +74,26 @@ docker pull ghcr.io/openimsdk/openim-server:<version-name>
 - Execute the following command to pull the image:
 
 ```bash
-docker pull ghcr.io/openimsdk/openim-server:<version-name>
+docker pull ghcr.io/openimsdk/openim-chat:<version-name>
 ```
 
+### Web Image
+
+- Execute the following command to pull the image:
+
+```bash
+docker pull ghcr.io/openimsdk/openim-web:<version-name>
+```
+
+### Admin Image
+
+- Execute the following command to pull the image:
+
+```bash
+docker pull ghcr.io/openimsdk/openim-admin:<version-name>
+```
+
+
 ## 3. Image Storage Selection
 
 **Repositories**:
@@ -71,46 +120,61 @@ You can select from the following versions:
 1. **Pull images**: Execute the above `docker pull` commands to pull all required images locally.
 2. **Save images**:
 
-```
+```bash
 docker save -o <tar-file-name>.tar <image-name>
 ```
 
-1. **Fetch code**: Clone the repository:
+If you want to save all the images, use the following command:
 
-```
+```bash
-git clone https://github.com/OpenIMSDK/openim-docker.git
+docker save -o <tar-file-name>.tar $(docker images -q)
 ```
 
-Or download the code from [Releases](https://github.com/OpenIMSDK/openim-docker/releases/).
+3. **Fetch code**: Clone the repository:
-
-1. **Transfer files**: Use `scp` to transfer all images and code to the intranet server.
 
+```bash
+git clone https://github.com/openimsdk/openim-docker.git
 ```
+
+Or download the code from [Releases](https://github.com/openimsdk/openim-docker/releases/).
+
+> Because of the difference between win and linux newlines, please do not clone the repository with win and then synchronize scp to linux.
+
+4. **Transfer files**: Use `scp` to transfer all images and code to the intranet server.
+
+```bash
 scp <tar-file-name>.tar user@remote-ip:/path/on/remote/server
 ```
 
 Or choose other transfer methods such as a hard drive.
 
-1. **Import images**: On the intranet server:
+5. **Import images**: On the intranet server:
 
-```
+```bash
 docker load -i <tar-file-name>.tar
 ```
 
-1. **Deploy**: Navigate to the `openim-docker` repository directory and follow the README guide for deployment.
+Import directly with shortcut commands:
-2. **Deploy using Docker-compose**:
 
+```bash
+for i in `ls ./`;do docker load -i $i;done
 ```
-docker-compose up -d
 
-# Verify
+6. **Deploy**: Navigate to the `openim-docker` repository directory and follow the [README guide](https://github.com/openimsdk/openim-docker) for deployment.
-docker-compose ps
+
+7. **Deploy using docker compose**:
+
+```bash
+export OPENIM_IP="your ip" # Set Ip
+make init # Init config
+docker compose up -d # Deployment
+docker compose ps # Verify
 ```
 
 > **Note**: If you're using a version of Docker prior to 20, make sure you've installed `docker-compose`.
 
 ## 6. Reference Links
 
-- [OpenIMSDK Issue #432](https://github.com/openimsdk/open-im-server/issues/432)
+- [openimsdk Issue #432](https://github.com/openimsdk/open-im-server/issues/432)
 - [Notion Link](https://nsddd.notion.site/435ee747c0bc44048da9300a2d745ad3?pvs=25)
-- [OpenIMSDK Issue #474](https://github.com/openimsdk/open-im-server/issues/474)
+- [openimsdk Issue #474](https://github.com/openimsdk/open-im-server/issues/474)

docs/contrib/prometheus-grafana.md

@@ -111,32 +111,35 @@ Importing Grafana Dashboards is a straightforward process and is applicable to O
 
 To monitor OpenIM in Grafana, you need to focus on three categories of key metrics, each with its specific deployment and configuration steps:
 
-1. **OpenIM Metrics (`prometheus-dashboard.yaml`)**:
+**OpenIM Metrics (`prometheus-dashboard.yaml`)**:
-   + **Configuration File Path**: Located at `config/prometheus-dashboard.yaml`.
-   + **Enabling Monitoring**: Set the environment variable `export PROMETHEUS_ENABLE=true` to enable Prometheus monitoring.
-   + **More Information**: Refer to the [OpenIM Configuration Guide](https://docs.openim.io/configurations/prometheus-integration).
-2. **Node Exporter**:
-   + **Container Deployment**: Deploy the `quay.io/prometheus/node-exporter` container for node monitoring.
-   + **Get Dashboard**: Access the [Node Exporter Full Feature Dashboard](https://grafana.com/grafana/dashboards/1860-node-exporter-full/) and import it using YAML file download or ID import.
-   + **Deployment Guide**: Refer to the [Node Exporter Deployment Documentation](https://prometheus.io/docs/guides/node-exporter/).
-3. **Middleware Metrics**: Each middleware requires specific steps and configurations to enable monitoring. Here is a list of common middleware and links to their respective setup guides:
-   + MySQL:
-     + **Configuration**: Ensure MySQL has performance monitoring enabled.
-     + **Link**: Refer to the [MySQL Monitoring Configuration Guide](https://grafana.com/docs/grafana/latest/datasources/mysql/).
-   + Redis:
-     + **Configuration**: Configure Redis to allow monitoring data export.
-     + **Link**: Refer to the [Redis Monitoring Guide](https://grafana.com/docs/grafana/latest/datasources/redis/).
-   + MongoDB:
-     + **Configuration**: Set up monitoring metrics for MongoDB.
-     + **Link**: Refer to the [MongoDB Monitoring Guide](https://grafana.com/grafana/plugins/grafana-mongodb-datasource/).
-   + Kafka:
-     + **Configuration**: Integrate Kafka with Prometheus monitoring.
-     + **Link**: Refer to the [Kafka Monitoring Guide](https://grafana.com/grafana/plugins/grafana-kafka-datasource/).
-   + Zookeeper:
-     + **Configuration**: Ensure Zookeeper can be monitored by Prometheus.
-     + **Link**: Refer to the [Zookeeper Monitoring Configuration](https://grafana.com/docs/grafana/latest/datasources/zookeeper/).
 
+- **Configuration File Path**: Find this at `config/prometheus-dashboard.yaml`.
+- **Enabling Monitoring**: Activate Prometheus monitoring by setting the environment variable: `export PROMETHEUS_ENABLE=true`.
+- **More Information**: For detailed instructions, see the [OpenIM Configuration Guide](https://docs.openim.io/configurations/prometheus-integration).
 
+**Node Exporter**:
+
+- **Container Deployment**: Use the container `quay.io/prometheus/node-exporter` for effective node monitoring.
+- **Access Dashboard**: Visit the [Node Exporter Full Feature Dashboard](https://grafana.com/grafana/dashboards/1860-node-exporter-full/) for dashboard integration either through YAML file download or ID.
+- **Deployment Guide**: For deployment steps, consult the [Node Exporter Deployment Documentation](https://prometheus.io/docs/guides/node-exporter/).
+
+**Middleware Metrics**: Different middlewares require unique steps and configurations for monitoring:
+
+- MySQL:
+    - **Configuration**: Make sure MySQL is set up for performance monitoring.
+    - **Guide**: See the [MySQL Monitoring Configuration Guide](https://grafana.com/docs/grafana/latest/datasources/mysql/).
+- Redis:
+    - **Configuration**: Adjust Redis settings to enable monitoring data export.
+    - **Guide**: Consult the [Redis Monitoring Guide](https://grafana.com/docs/grafana/latest/datasources/redis/).
+- MongoDB:
+    - **Configuration**: Configure MongoDB for monitoring metrics.
+    - **Guide**: Visit the [MongoDB Monitoring Guide](https://grafana.com/grafana/plugins/grafana-mongodb-datasource/).
+- Kafka:
+    - **Configuration**: Set up Kafka for Prometheus monitoring integration.
+    - **Guide**: Refer to the [Kafka Monitoring Guide](https://grafana.com/grafana/plugins/grafana-kafka-datasource/).
+- Zookeeper:
+    - **Configuration**: Ensure Prometheus can monitor Zookeeper.
+    - **Guide**: Check out the [Zookeeper Monitoring Configuration](https://grafana.com/docs/grafana/latest/datasources/zookeeper/).
 
 **Importing Steps**:
 

docs/contrib/release.md

@@ -0,0 +1,251 @@
+# OpenIM Release Automation Design Document
+
+This document outlines the automation process for releasing OpenIM. You can use the `make release` command for automated publishing. We will discuss how to use the `make release` command and Github Actions CICD separately, while also providing insight into the design principles involved.
+
+## Github Actions Automation
+
+In our CICD pipeline, we have implemented logic for automating the release process using the goreleaser tool. To achieve this, follow these steps on your local machine or server:
+
+```bash
+git clone https://github.com/openimsdk/open-im-server
+cd open-im-server
+git tag -a v3.6.0 -s -m "release: xxx"
+# For pre-release versions: git tag -a v3.6.0-rc.0 -s -m "pre-release: xxx"
+git push origin v3.6.0
+```
+
+The remaining tasks are handled by automated processes:
+
++ Automatically complete the release publication on Github
++ Automatically build the `v3.6.0` version image and push it to aliyun, dockerhub, and github
+
+Through these automated steps, we achieve rapid and efficient OpenIM version releases, simplifying the release process and enhancing productivity.
+
+
+Certainly, here is the continuation of the document in English:
+
+## Local Make Release Design
+
+There are two primary scenarios for local usage:
+
++ Advanced compilation and release, manually executed locally
++ Quick compilation verification and version release, manually executed locally
+
+**These two scenarios can also be combined, for example, by tagging locally and then releasing:**
+
+```bash
+git add .
+git commit -a -s -m "release(v3.6.0): ......"
+git tag v3.6.0
+git release
+git push origin main
+```
+
+In a local environment, you can use the `make release` command to complete the release process. The main implementation logic can be found in the `/data/workspaces/open-im-server/scripts/lib/release.sh` file. First, let's explore its usage through the help information.
+
+### Help Information
+
+To view the help information, execute the following command:
+
+```bash
+$ ./scripts/release.sh --help
+Usage: release.sh [options]
+Options:
+  -h, --help                Display this help message
+  -se, --setup-env          Execute environment setup
+  -vp, --verify-prereqs     Execute prerequisite verification
+  -bc, --build-command      Execute build command
+  -bi, --build-image        Execute build image (default is not executed)
+  -pt, --package-tarballs   Execute tarball packaging
+  -ut, --upload-tarballs    Execute tarball upload
+  -gr, --github-release     Execute GitHub release
+  -gc, --generate-changelog Execute changelog generation
+```
+
+### Default Behavior
+
+If no options are provided, all operations are executed by default:
+
+```bash
+# If no options are provided, enable all operations by default
+if [ "$#" -eq 0 ]; then
+    perform_setup_env=true
+    perform_verify_prereqs=true
+    perform_build_command=true
+    perform_package_tarballs=true
+    perform_upload_tarballs=true
+    perform_github_release=true
+    perform_generate_changelog=true
+    # TODO: Defaultly not enable build_image
+    # perform_build_image=true
+fi
+```
+
+### Environment Variable Setup
+
+Before starting, you need to set environment variables:
+
+```bash
+export TENCENT_SECRET_KEY=OZZ****************************
+export TENCENT_SECRET_ID=AKI****************************
+```
+
+### Modifying COS Account and Password
+
+If you need to change the COS account, password, and bucket information, please modify the following section in the `/data/workspaces/open-im-server/scripts/lib/release.sh` file:
+
+```bash
+readonly BUCKET="openim-1306374445"
+readonly REGION="ap-guangzhou"
+readonly COS_RELEASE_DIR="openim-release"
+```
+
+### GitHub Release Configuration
+
+If you intend to use the GitHub Release feature, you also need to set the environment variable:
+
+```bash
+export GITHUB_TOKEN="your_github_token"
+```
+
+### Modifying GitHub Release Basic Information
+
+If you need to modify the basic information of GitHub Release, please edit the following section in the `/data/workspaces/open-im-server/scripts/lib/release.sh` file:
+
+```bash
+# OpenIM GitHub account information
+readonly OPENIM_GITHUB_ORG=openimsdk
+readonly OPENIM_GITHUB_REPO=open-im-server
+```
+
+This setup allows you to configure and execute the local release process according to your specific needs.
+
+
+### GitHub Release Versioning Rules
+
+Firstly, it's important to note that GitHub Releases should primarily be for pre-release versions. However, goreleaser might provide a `prerelease: auto` option, which automatically marks versions with pre-release indicators like `-rc1`, `-beta`, etc., as pre-releases.
+
+So, if your most recent tag does not have pre-release indicators such as `-rc1` or `-beta`, even if you use `make release` for pre-release versions, goreleaser might still consider them as formal releases.
+
+To avoid this issue, I have added the `--draft` flag to github-release. This way, all releases are created as drafts.
+
+## CICD Release Documentation Design
+
+The release records still require manual composition for GitHub Release. This is different from github-release.
+
+This approach ensures that all releases are initially created as drafts, allowing you to manually review and edit the release documentation on GitHub. This manual step provides more control and allows you to curate release notes and other information before making them public.
+
+
+## Makefile Section
+
+This document aims to elaborate and explain key sections of the OpenIM Release automation design, including the Makefile section and functions within the code. Below, we will provide a detailed explanation of the logic and functions of each section.
+
+In the project's root directory, the Makefile imports a subdirectory:
+
+```makefile
+include scripts/make-rules/release.mk
+```
+
+And defines the `release` target as follows:
+
+```makefile
+## release: release the project ✨
+.PHONY: release release: release.verify release.ensure-tag
+    @scripts/release.sh
+```
+
+### Importing Subdirectory
+
+At the beginning of the Makefile, the `include scripts/make-rules/release.mk` statement imports the `release.mk` file from the subdirectory. This file contains rules and configurations related to releases to be used in subsequent operations.
+
+### The `release` Target
+
+The Makefile defines a target named `release`, which is used to execute the project's release operation. This target is marked as a phony target (`.PHONY`), meaning it doesn't represent an actual file or directory but serves as an identifier for executing a series of actions.
+
+In the `release` target, two dependency targets are executed first: `release.verify` and `release.ensure-tag`. Afterward, the `scripts/release.sh` script is called to perform the actual release operation.
+
+## Logic of `release.verify` and `release.ensure-tag`
+
+```makefile
+## release.verify: Check if a tool is installed and install it
+.PHONY: release.verify
+release.verify: tools.verify.git-chglog tools.verify.github-release tools.verify.coscmd tools.verify.coscli
+
+## release.ensure-tag: ensure tag
+.PHONY: release.ensure-tag
+release.ensure-tag: tools.verify.gsemver
+    @scripts/ensure-tag.sh
+```
+
+### `release.verify` Target
+
+The `release.verify` target is used to check and install tools. It depends on four sub-targets: `tools.verify.git-chglog`, `tools.verify.github-release`, `tools.verify.coscmd`, and `tools.verify.coscli`. These sub-targets aim to check if specific tools are installed and attempt to install them if they are not.
+
+The purpose of this target is to ensure that the necessary tools required for the release process are available so that subsequent operations can be executed smoothly.
+
+### `release.ensure-tag` Target
+
+The `release.ensure-tag` target is used to ensure that the project has a version tag. It depends on the sub-target `tools.verify.gsemver`, indicating that it should check if the `gsemver` tool is installed before executing.
+
+When the `release.ensure-tag` target is executed, it calls the `scripts/ensure-tag.sh` script to ensure that the project has a version tag. Version tags are typically used to identify specific versions of the project for management and release in version control systems.
+
+## Logic of `release.sh` Script
+
+```bash
+openim::golang::setup_env
+openim::build::verify_prereqs
+openim::release::verify_prereqs
+#openim::build::build_image
+openim::build::build_command
+openim::release::package_tarballs
+openim::release::upload_tarballs
+git push origin ${VERSION}
+#openim::release::github_release
+#openim::release::generate_changelog
+```
+
+The `release.sh` script is responsible for executing the actual release operations. Below is the logic of this script:
+
+1. `openim::golang::setup_env`: This function sets up some configurations for the Golang development environment.
+
+2. `openim::build::verify_prereqs`: This function is used to verify whether the prerequisites for building are met. This includes checking dependencies, environment variables, and more.
+
+3. `openim::release::verify_prereqs`: Similar to the previous function, this one is used to verify whether the prerequisites for the release are met. It focuses on conditions relevant to the release.
+
+4. `openim::build::build_command`: This function is responsible for building the project's command, which typically involves compiling the project or performing other build operations.
+
+5. `openim::release::package_tarballs`: This function is used to package tarball files required for the release. These tarballs are usually used for distribution packages during the release.
+
+6. `openim::release::upload_tarballs`: This function is used to upload the packaged tarball files, typically to a distribution platform or repository.
+
+7. `git push origin ${VERSION}`: This line of command pushes the version tag to the remote Git repository's `origin` branch, marking this release in the version control system.
+
+In the comments, you can see that there are some operations that are commented out, such as `openim::build::build_image`, `openim::release::github_release`, and `openim::release::generate_changelog`. These operations are related to building images, releasing to GitHub, and generating changelogs, and they can be enabled in the release process as needed.
+
+Let's take a closer look at the function responsible for packaging the tarball files:
+
+```bash
+function openim::release::package_tarballs() {
+  # Clean out any old releases
+  rm -rf "${RELEASE_STAGE}" "${RELEASE_TARS}" "${RELEASE_IMAGES}"
+  mkdir -p "${RELEASE_TARS}"
+  openim::release::package_src_tarball &
+  openim::release::package_client_tarballs &
+  openim::release::package_openim_manifests_tarball &
+  openim::release::package_server_tarballs &
+  openim::util::wait-for-jobs || { openim::log::error "previous tarball phase failed"; return 1; }
+
+  openim::release::package_final_tarball & # _final depends on some of the previous phases
+  openim::util::wait-for-jobs || { openim::log::error "previous tarball phase failed"; return 1; }
+}
+```
+
+The `openim::release::package_tarballs()` function is responsible for packaging the tarball files required for the release. Here is the specific logic of this function:
+
+1. `rm -rf "${RELEASE_STAGE}" "${RELEASE_TARS}" "${RELEASE_IMAGES}"`: First, the function removes any old release directories and files to ensure a clean starting state.
+
+2. `mkdir -p "${RELEASE_TARS}"`: Next, it creates a directory `${RELEASE_TARS}` to store the packaged tarball files. If the directory doesn't exist, it will be created.
+
+3. `openim::release::package_final_tarball &`: This is an asynchronous operation that depends on some of the previous phases. It is likely used to package the final tarball file, which includes the contents of all previous asynchronous operations.
+
+4. `openim::util::wait-for-jobs`: It waits for all asynchronous operations to complete. If any of the previous asynchronous operations fail, an error will be returned.

docs/contrib/version.md

@@ -1,6 +1,7 @@
 # OpenIM Branch Management and Versioning: A Blueprint for High-Grade Software Development
 
 [📚 **OpenIM TOC**](#openim-branch-management-and-versioning-a-blueprint-for-high-grade-software-development)
+- [OpenIM Branch Management and Versioning: A Blueprint for High-Grade Software Development](#openim-branch-management-and-versioning-a-blueprint-for-high-grade-software-development)
   - [Unfolding the Mechanism of OpenIM Version Maintenance](#unfolding-the-mechanism-of-openim-version-maintenance)
   - [Main Branch: The Heart of OpenIM Development](#main-branch-the-heart-of-openim-development)
   - [Release Branch: The Beacon of Stability](#release-branch-the-beacon-of-stability)
@@ -8,8 +9,21 @@
   - [Release Management: A Guided Tour](#release-management-a-guided-tour)
   - [Milestones, Branching, and Addressing Major Bugs](#milestones-branching-and-addressing-major-bugs)
   - [Version Skew Policy](#version-skew-policy)
+    - [Supported version skew](#supported-version-skew)
+    - [OpenIM Versioning, Branching, and Tag Strategy](#openim-versioning-branching-and-tag-strategy)
+      - [Supported Version Skew](#supported-version-skew-1)
+        - [openim-api](#openim-api)
+        - [openim-rpc-\* Components](#openim-rpc--components)
+        - [Other OpenIM Services](#other-openim-services)
+      - [Supported Component Upgrade Order](#supported-component-upgrade-order)
+        - [openim-api](#openim-api-1)
+        - [openim-rpc-\* Components](#openim-rpc--components-1)
+        - [Other OpenIM Services](#other-openim-services-1)
+      - [Conclusion](#conclusion)
   - [Applying Principles: A Git Workflow Example](#applying-principles-a-git-workflow-example)
+  - [Release Process](#release-process)
   - [Docker Images Version Management](#docker-images-version-management)
+  - [More](#more)
 
 
 At OpenIM, we acknowledge the profound impact of implementing a robust and efficient version management system, hence we abide by the established standards of [Semantic Versioning 2.0.0](https://semver.org/lang/zh-CN/).
@@ -213,3 +227,10 @@ Throughout this process, active communication within the team is pivotal to main
 ## Docker Images Version Management
 
 For more details on managing Docker image versions, visit [OpenIM Docker Images Administration](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/images.md).
+
+## More 
+
+More on multi-branch version management design and version management design at helm charts：
+
++ https://github.com/openimsdk/open-im-server/issues/1695
++ https://github.com/openimsdk/open-im-server/issues/1662

scripts/.spelling_failures

@@ -3,4 +3,6 @@ go.mod
 go.sum
 third_party/
 translations/
-log
+logs
+.git
+.golangci.yml

scripts/bash_beautify.py

@@ -0,0 +1,173 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+#**************************************************************************
+#   Copyright (C) 2011, Paul Lutus                                        *
+#                                                                         *
+#   This program is free software; you can redistribute it and/or modify  *
+#   it under the terms of the GNU General Public License as published by  *
+#   the Free Software Foundation; either version 2 of the License, or     *
+#   (at your option) any later version.                                   *
+#                                                                         *
+#   This program is distributed in the hope that it will be useful,       *
+#   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
+#   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
+#   GNU General Public License for more details.                          *
+#                                                                         *
+#   You should have received a copy of the GNU General Public License     *
+#   along with this program; if not, write to the                         *
+#   Free Software Foundation, Inc.,                                       *
+#   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
+#**************************************************************************
+
+import re
+import sys
+
+PVERSION = '1.0'
+
+
+class BeautifyBash:
+
+    def __init__(self):
+        self.tab_str = ' '
+        self.tab_size = 2
+
+    def read_file(self, fp):
+        with open(fp) as f:
+            return f.read()
+
+    def write_file(self, fp, data):
+        with open(fp, 'w') as f:
+            f.write(data)
+
+    def beautify_string(self, data, path=''):
+        tab = 0
+        case_stack = []
+        in_here_doc = False
+        defer_ext_quote = False
+        in_ext_quote = False
+        ext_quote_string = ''
+        here_string = ''
+        output = []
+        line = 1
+        for record in re.split('\n', data):
+            record = record.rstrip()
+            stripped_record = record.strip()
+
+            # collapse multiple quotes between ' ... '
+            test_record = re.sub(r'\'.*?\'', '', stripped_record)
+            # collapse multiple quotes between " ... "
+            test_record = re.sub(r'".*?"', '', test_record)
+            # collapse multiple quotes between ` ... `
+            test_record = re.sub(r'`.*?`', '', test_record)
+            # collapse multiple quotes between \` ... ' (weird case)
+            test_record = re.sub(r'\\`.*?\'', '', test_record)
+            # strip out any escaped single characters
+            test_record = re.sub(r'\\.', '', test_record)
+            # remove '#' comments
+            test_record = re.sub(r'(\A|\s)(#.*)', '', test_record, 1)
+            if(not in_here_doc):
+                if(re.search('<<-?', test_record)):
+                    here_string = re.sub(
+                        '.*<<-?\s*[\'|"]?([_|\w]+)[\'|"]?.*', '\\1', stripped_record, 1)
+                    in_here_doc = (len(here_string) > 0)
+            if(in_here_doc):  # pass on with no changes
+                output.append(record)
+                # now test for here-doc termination string
+                if(re.search(here_string, test_record) and not re.search('<<', test_record)):
+                    in_here_doc = False
+            else:  # not in here doc
+                if(in_ext_quote):
+                    if(re.search(ext_quote_string, test_record)):
+                        # provide line after quotes
+                        test_record = re.sub(
+                            '.*%s(.*)' % ext_quote_string, '\\1', test_record, 1)
+                        in_ext_quote = False
+                else:  # not in ext quote
+                    if(re.search(r'(\A|\s)(\'|")', test_record)):
+                        # apply only after this line has been processed
+                        defer_ext_quote = True
+                        ext_quote_string = re.sub(
+                            '.*([\'"]).*', '\\1', test_record, 1)
+                        # provide line before quote
+                        test_record = re.sub(
+                            '(.*)%s.*' % ext_quote_string, '\\1', test_record, 1)
+                if(in_ext_quote):
+                    # pass on unchanged
+                    output.append(record)
+                else:  # not in ext quote
+                    inc = len(re.findall(
+                        '(\s|\A|;)(case|then|do)(;|\Z|\s)', test_record))
+                    inc += len(re.findall('(\{|\(|\[)', test_record))
+                    outc = len(re.findall(
+                        '(\s|\A|;)(esac|fi|done|elif)(;|\)|\||\Z|\s)', test_record))
+                    outc += len(re.findall('(\}|\)|\])', test_record))
+                    if(re.search(r'\besac\b', test_record)):
+                        if(len(case_stack) == 0):
+                            sys.stderr.write(
+                                'File %s: error: "esac" before "case" in line %d.\n' % (
+                                    path, line)
+                            )
+                        else:
+                            outc += case_stack.pop()
+                    # sepcial handling for bad syntax within case ... esac
+                    if(len(case_stack) > 0):
+                        if(re.search('\A[^(]*\)', test_record)):
+                            # avoid overcount
+                            outc -= 2
+                            case_stack[-1] += 1
+                        if(re.search(';;', test_record)):
+                            outc += 1
+                            case_stack[-1] -= 1
+                    # an ad-hoc solution for the "else" keyword
+                    else_case = (
+                        0, -1)[re.search('^(else)', test_record) != None]
+                    net = inc - outc
+                    tab += min(net, 0)
+                    extab = tab + else_case
+                    extab = max(0, extab)
+                    output.append(
+                        (self.tab_str * self.tab_size * extab) + stripped_record)
+                    tab += max(net, 0)
+                if(defer_ext_quote):
+                    in_ext_quote = True
+                    defer_ext_quote = False
+                if(re.search(r'\bcase\b', test_record)):
+                    case_stack.append(0)
+            line += 1
+        error = (tab != 0)
+        if(error):
+            sys.stderr.write(
+                'File %s: error: indent/outdent mismatch: %d.\n' % (path, tab))
+        return '\n'.join(output), error
+
+    def beautify_file(self, path):
+        error = False
+        if(path == '-'):
+            data = sys.stdin.read()
+            result, error = self.beautify_string(data, '(stdin)')
+            sys.stdout.write(result)
+        else:  # named file
+            data = self.read_file(path)
+            result, error = self.beautify_string(data, path)
+            if(data != result):
+                # make a backup copy
+                self.write_file(path + '~', data)
+                self.write_file(path, result)
+        return error
+
+    def main(self):
+        error = False
+        sys.argv.pop(0)
+        if(len(sys.argv) < 1):
+            sys.stderr.write(
+                'usage: shell script filenames or \"-\" for stdin.\n')
+        else:
+            for path in sys.argv:
+                error |= self.beautify_file(path)
+        sys.exit((0, 1)[error])
+
+# if not called as a module
+if(__name__ == '__main__'):
+    BeautifyBash().main()
+

scripts/build-all-service.sh

@@ -30,8 +30,8 @@ OPENIM_ROOT=$(dirname "${BASH_SOURCE[0]}")/..
 source "${OPENIM_ROOT}/scripts/lib/init.sh"
 
 # CPU core number
-pushd ""${OPENIM_ROOT}"/tools/ncpu" >/dev/null
+pushd "${OPENIM_ROOT}/tools/ncpu" >/dev/null
-  cpu_count=$(go run .)
+cpu_count=$(go run .)
 popd >/dev/null
 
 openim::color::echo ${GREEN_PREFIX} "======> cpu_count=$cpu_count"

scripts/cherry-pick.sh

@@ -153,7 +153,7 @@ For details on the cherry pick process, see the [cherry pick requests](https://g
 EOF
 )
 
-  gh pr create --title="Automated cherry pick of ${numandtitle}" --body="${prtext}" --head "${GITHUB_USER}:${NEWBRANCH}" --base "${rel}" --repo="${MAIN_REPO_ORG}/${MAIN_REPO_NAME}"
+gh pr create --title="Automated cherry pick of ${numandtitle}" --body="${prtext}" --head "${GITHUB_USER}:${NEWBRANCH}" --base "${rel}" --repo="${MAIN_REPO_ORG}/${MAIN_REPO_NAME}"
 }
 
 git checkout -b "${NEWBRANCHUNIQ}" "${BRANCH}"
@@ -161,14 +161,14 @@ cleanbranch="${NEWBRANCHUNIQ}"
 
 gitamcleanup=true
 for pull in "${PULLS[@]}"; do
-  openim::log::status "Downloading patch to /tmp/${pull}.patch (in case you need to do this again)"
+openim::log::status "Downloading patch to /tmp/${pull}.patch (in case you need to do this again)"
 
-  curl -o "/tmp/${pull}.patch" -sSL "https://github.com/${MAIN_REPO_ORG}/${MAIN_REPO_NAME}/pull/${pull}.patch"
+curl -o "/tmp/${pull}.patch" -sSL "https://github.com/${MAIN_REPO_ORG}/${MAIN_REPO_NAME}/pull/${pull}.patch"
-  echo
+echo
-  openim::log::status "About to attempt cherry pick of PR. To reattempt:"
+openim::log::status "About to attempt cherry pick of PR. To reattempt:"
-  echo "  $ git am -3 /tmp/${pull}.patch"
+echo "  $ git am -3 /tmp/${pull}.patch"
-  echo
+echo
-  git am -3 "/tmp/${pull}.patch" || {
+git am -3 "/tmp/${pull}.patch" || {
   conflicts=false
   while unmerged=$(git status --porcelain | grep ^U) && [[ -n ${unmerged} ]] \
   || [[ -e "${REBASEMAGIC}" ]]; do
@@ -191,54 +191,54 @@ for pull in "${PULLS[@]}"; do
     echo "!!! git am failed, likely because of an in-progress 'git am' or 'git rebase'"
     exit 1
   fi
-  }
+}
 
-  # set the subject
+# set the subject
-  subject=$(grep -m 1 "^Subject" "/tmp/${pull}.patch" | sed -e 's/Subject: \[PATCH//g' | sed 's/.*] //')
+subject=$(grep -m 1 "^Subject" "/tmp/${pull}.patch" | sed -e 's/Subject: \[PATCH//g' | sed 's/.*] //')
-  SUBJECTS+=("#${pull}: ${subject}")
+SUBJECTS+=("#${pull}: ${subject}")
 
-  # remove the patch file from /tmp
+# remove the patch file from /tmp
-  rm -f "/tmp/${pull}.patch"
+rm -f "/tmp/${pull}.patch"
 done
 gitamcleanup=false
 
 # Re-generate docs (if needed)
 if [[ -n "${REGENERATE_DOCS}" ]]; then
-  echo
+echo
-  echo "Regenerating docs..."
+echo "Regenerating docs..."
-  if ! scripts/generate-docs.sh; then
+if ! scripts/generate-docs.sh; then
   echo
   echo "scripts/gendoc.sh FAILED to complete."
   exit 1
-  fi
+fi
 fi
 
 if [[ -n "${DRY_RUN}" ]]; then
-  openim::log::error "!!! Skipping git push and PR creation because you set DRY_RUN."
+openim::log::error "!!! Skipping git push and PR creation because you set DRY_RUN."
-  echo "To return to the branch you were in when you invoked this script:"
+echo "To return to the branch you were in when you invoked this script:"
-  echo
+echo
-  echo "  git checkout ${STARTINGBRANCH}"
+echo "  git checkout ${STARTINGBRANCH}"
-  echo
+echo
-  echo "To delete this branch:"
+echo "To delete this branch:"
-  echo
+echo
-  echo "  git branch -D ${NEWBRANCHUNIQ}"
+echo "  git branch -D ${NEWBRANCHUNIQ}"
-  exit 0
+exit 0
 fi
 
 if git remote -v | grep ^"${FORK_REMOTE}" | grep "${MAIN_REPO_ORG}/${MAIN_REPO_NAME}.git"; then
-  echo "!!! You have ${FORK_REMOTE} configured as your ${MAIN_REPO_ORG}/${MAIN_REPO_NAME}.git"
+echo "!!! You have ${FORK_REMOTE} configured as your ${MAIN_REPO_ORG}/${MAIN_REPO_NAME}.git"
-  echo "This isn't normal. Leaving you with push instructions:"
+echo "This isn't normal. Leaving you with push instructions:"
-  echo
+echo
-  openim::log::status "First manually push the branch this script created:"
+openim::log::status "First manually push the branch this script created:"
-  echo
+echo
-  echo "  git push REMOTE ${NEWBRANCHUNIQ}:${NEWBRANCH}"
+echo "  git push REMOTE ${NEWBRANCHUNIQ}:${NEWBRANCH}"
-  echo
+echo
-  echo "where REMOTE is your personal fork (maybe ${UPSTREAM_REMOTE}? Consider swapping those.)."
+echo "where REMOTE is your personal fork (maybe ${UPSTREAM_REMOTE}? Consider swapping those.)."
-  echo "OR consider setting UPSTREAM_REMOTE and FORK_REMOTE to different values."
+echo "OR consider setting UPSTREAM_REMOTE and FORK_REMOTE to different values."
-  echo
+echo
-  make-a-pr
+make-a-pr
-  cleanbranch=""
+cleanbranch=""
-  exit 0
+exit 0
 fi
 
 echo
@@ -248,8 +248,8 @@ echo "  git push ${FORK_REMOTE} ${NEWBRANCHUNIQ}:${NEWBRANCH}"
 echo
 read -p "+++ Proceed (anything other than 'y' aborts the cherry-pick)? [y/n] " -r
 if ! [[ "${REPLY}" =~ ^[yY]$ ]]; then
-  echo "Aborting." >&2
+echo "Aborting." >&2
-  exit 1
+exit 1
 fi
 
 git push "${FORK_REMOTE}" -f "${NEWBRANCHUNIQ}:${NEWBRANCH}"

scripts/common.sh

@@ -42,7 +42,7 @@ OPENIM_ROOT=$(cd "$(dirname "${BASH_SOURCE[0]}")"/.. && pwd -P)
 
 # Constants
 readonly OPENIM_BUILD_IMAGE_REPO=openim-build
-#readonly OPENIM_BUILD_IMAGE_CROSS_TAG="$(cat ""${OPENIM_ROOT}"/build/build-image/cross/VERSION")"
+#readonly OPENIM_BUILD_IMAGE_CROSS_TAG="$(cat "${OPENIM_ROOT}/build/build-image/cross/VERSION")"
 
 readonly OPENIM_DOCKER_REGISTRY="${OPENIM_DOCKER_REGISTRY:-k8s.gcr.io}"
 readonly OPENIM_BASE_IMAGE_REGISTRY="${OPENIM_BASE_IMAGE_REGISTRY:-us.gcr.io/k8s-artifacts-prod/build-image}"
@@ -53,7 +53,7 @@ readonly OPENIM_BASE_IMAGE_REGISTRY="${OPENIM_BASE_IMAGE_REGISTRY:-us.gcr.io/k8s
 #
 # Increment/change this number if you change the build image (anything under
 # build/build-image) or change the set of volumes in the data container.
-#readonly OPENIM_BUILD_IMAGE_VERSION_BASE="$(cat ""${OPENIM_ROOT}"/build/build-image/VERSION")"
+#readonly OPENIM_BUILD_IMAGE_VERSION_BASE="$(cat "${OPENIM_ROOT}/build/build-image/VERSION")"
 #readonly OPENIM_BUILD_IMAGE_VERSION="${OPENIM_BUILD_IMAGE_VERSION_BASE}-${OPENIM_BUILD_IMAGE_CROSS_TAG}"
 
 # Here we map the output directories across both the local and remote _output
@@ -66,9 +66,10 @@ readonly OPENIM_BASE_IMAGE_REGISTRY="${OPENIM_BASE_IMAGE_REGISTRY:-us.gcr.io/k8s
 #                    is really remote, this is the stuff that has to be copied
 #                    back.
 # OUT_DIR can come in from the Makefile, so honor it.
-readonly LOCAL_OUTPUT_ROOT=""${OPENIM_ROOT}"/${OUT_DIR:-_output}"
+readonly LOCAL_OUTPUT_ROOT="${OPENIM_ROOT}/${OUT_DIR:-_output}"
-readonly LOCAL_OUTPUT_SUBPATH="${LOCAL_OUTPUT_ROOT}/platforms"
+readonly LOCAL_OUTPUT_SUBPATH="${LOCAL_OUTPUT_ROOT}/bin"
-readonly LOCAL_OUTPUT_BINPATH="${LOCAL_OUTPUT_SUBPATH}"
+readonly LOCAL_OUTPUT_BINPATH="${LOCAL_OUTPUT_SUBPATH}/platforms"
+readonly LOCAL_OUTPUT_BINTOOLSPATH="${LOCAL_OUTPUT_SUBPATH}/tools"
 readonly LOCAL_OUTPUT_GOPATH="${LOCAL_OUTPUT_SUBPATH}/go"
 readonly LOCAL_OUTPUT_IMAGE_STAGING="${LOCAL_OUTPUT_ROOT}/images"
 
@@ -86,13 +87,13 @@ readonly OPENIM_CONTAINER_RSYNC_PORT=8730
 #
 # $1 - server architecture
 openim::build::get_docker_wrapped_binaries() {
-  local arch=$1
+local arch=$1
-  local debian_base_version=v2.1.0
+local debian_base_version=v2.1.0
-  local debian_iptables_version=v12.1.0
+local debian_iptables_version=v12.1.0
-  ### If you change any of these lists, please also update DOCKERIZED_BINARIES
+### If you change any of these lists, please also update DOCKERIZED_BINARIES
-  ### in build/BUILD. And openim::golang::server_image_targets
+### in build/BUILD. And openim::golang::server_image_targets
 
-  local targets=(
+local targets=(
   "openim-api,${OPENIM_BASE_IMAGE_REGISTRY}/debian-base-${arch}:${debian_base_version}"
   "openim-cmdutils,${OPENIM_BASE_IMAGE_REGISTRY}/debian-base-${arch}:${debian_base_version}"
   "openim-crontask,${OPENIM_BASE_IMAGE_REGISTRY}/debian-base-${arch}:${debian_base_version}"
@@ -106,8 +107,8 @@ openim::build::get_docker_wrapped_binaries() {
   "openim-rpc-msg,${OPENIM_BASE_IMAGE_REGISTRY}/debian-base-${arch}:${debian_base_version}"
   "openim-rpc-third,${OPENIM_BASE_IMAGE_REGISTRY}/debian-base-${arch}:${debian_base_version}"
   "openim-rpc-user,${OPENIM_BASE_IMAGE_REGISTRY}/debian-base-${arch}:${debian_base_version}"
-  )
+)
-  echo "${targets[@]}"
+echo "${targets[@]}"
 }
 
 # ---------------------------------------------------------------------------
@@ -132,11 +133,11 @@ openim::build::get_docker_wrapped_binaries() {
 #   DOCKER_MOUNT_ARGS
 #   LOCAL_OUTPUT_BUILD_CONTEXT
 function openim::build::verify_prereqs() {
-  local -r require_docker=${1:-true}
+local -r require_docker=${1:-true}
-  openim::log::status "Verifying Prerequisites...."
+openim::log::status "Verifying Prerequisites...."
-  openim::build::ensure_tar || return 1
+openim::build::ensure_tar || return 1
-  openim::build::ensure_rsync || return 1
+openim::build::ensure_rsync || return 1
-  if ${require_docker}; then
+if ${require_docker}; then
   openim::build::ensure_docker_in_path || return 1
   openim::util::ensure_docker_daemon_connectivity || return 1
   
@@ -144,31 +145,31 @@ function openim::build::verify_prereqs() {
     openim::log::status "Docker Version:"
     "${DOCKER[@]}" version | openim::log::info_from_stdin
   fi
-  fi
+fi
 
-  OPENIM_GIT_BRANCH=$(git symbolic-ref --short -q HEAD 2>/dev/null || true)
+OPENIM_GIT_BRANCH=$(git symbolic-ref --short -q HEAD 2>/dev/null || true)
-  OPENIM_ROOT_HASH=$(openim::build::short_hash "${HOSTNAME:-}:"${OPENIM_ROOT}":${OPENIM_GIT_BRANCH}")
+OPENIM_ROOT_HASH=$(openim::build::short_hash "${HOSTNAME:-}:${OPENIM_ROOT}:${OPENIM_GIT_BRANCH}")
-  OPENIM_BUILD_IMAGE_TAG_BASE="build-${OPENIM_ROOT_HASH}"
+OPENIM_BUILD_IMAGE_TAG_BASE="build-${OPENIM_ROOT_HASH}"
-  #OPENIM_BUILD_IMAGE_TAG="${OPENIM_BUILD_IMAGE_TAG_BASE}-${OPENIM_BUILD_IMAGE_VERSION}"
+#OPENIM_BUILD_IMAGE_TAG="${OPENIM_BUILD_IMAGE_TAG_BASE}-${OPENIM_BUILD_IMAGE_VERSION}"
-  #OPENIM_BUILD_IMAGE="${OPENIM_BUILD_IMAGE_REPO}:${OPENIM_BUILD_IMAGE_TAG}"
+#OPENIM_BUILD_IMAGE="${OPENIM_BUILD_IMAGE_REPO}:${OPENIM_BUILD_IMAGE_TAG}"
-  OPENIM_BUILD_CONTAINER_NAME_BASE="openim-build-${OPENIM_ROOT_HASH}"
+OPENIM_BUILD_CONTAINER_NAME_BASE="openim-build-${OPENIM_ROOT_HASH}"
-  #OPENIM_BUILD_CONTAINER_NAME="${OPENIM_BUILD_CONTAINER_NAME_BASE}-${OPENIM_BUILD_IMAGE_VERSION}"
+#OPENIM_BUILD_CONTAINER_NAME="${OPENIM_BUILD_CONTAINER_NAME_BASE}-${OPENIM_BUILD_IMAGE_VERSION}"
-  OPENIM_RSYNC_CONTAINER_NAME_BASE="openim-rsync-${OPENIM_ROOT_HASH}"
+OPENIM_RSYNC_CONTAINER_NAME_BASE="openim-rsync-${OPENIM_ROOT_HASH}"
-  #OPENIM_RSYNC_CONTAINER_NAME="${OPENIM_RSYNC_CONTAINER_NAME_BASE}-${OPENIM_BUILD_IMAGE_VERSION}"
+#OPENIM_RSYNC_CONTAINER_NAME="${OPENIM_RSYNC_CONTAINER_NAME_BASE}-${OPENIM_BUILD_IMAGE_VERSION}"
-  OPENIM_DATA_CONTAINER_NAME_BASE="openim-build-data-${OPENIM_ROOT_HASH}"
+OPENIM_DATA_CONTAINER_NAME_BASE="openim-build-data-${OPENIM_ROOT_HASH}"
-  #OPENIM_DATA_CONTAINER_NAME="${OPENIM_DATA_CONTAINER_NAME_BASE}-${OPENIM_BUILD_IMAGE_VERSION}"
+#OPENIM_DATA_CONTAINER_NAME="${OPENIM_DATA_CONTAINER_NAME_BASE}-${OPENIM_BUILD_IMAGE_VERSION}"
-  #DOCKER_MOUNT_ARGS=(--volumes-from "${OPENIM_DATA_CONTAINER_NAME}")
+#DOCKER_MOUNT_ARGS=(--volumes-from "${OPENIM_DATA_CONTAINER_NAME}")
-  #LOCAL_OUTPUT_BUILD_CONTEXT="${LOCAL_OUTPUT_IMAGE_STAGING}/${OPENIM_BUILD_IMAGE}"
+#LOCAL_OUTPUT_BUILD_CONTEXT="${LOCAL_OUTPUT_IMAGE_STAGING}/${OPENIM_BUILD_IMAGE}"
 
-  openim::version::get_version_vars
+openim::version::get_version_vars
-  #openim::version::save_version_vars ""${OPENIM_ROOT}"/.dockerized-openim-version-defs"
+#openim::version::save_version_vars "${OPENIM_ROOT}/.dockerized-openim-version-defs"
 }
 
 # ---------------------------------------------------------------------------
 # Utility functions
 
 function openim::build::docker_available_on_osx() {
-  if [[ -z "${DOCKER_HOST}" ]]; then
+if [[ -z "${DOCKER_HOST}" ]]; then
   if [[ -S "/var/run/docker.sock" ]]; then
     openim::log::status "Using Docker for MacOS"
     return 0
@@ -182,24 +183,24 @@ function openim::build::docker_available_on_osx() {
     elif [[ -n "$(which docker-machine)" ]]; then
     openim::build::prepare_docker_machine
   fi
-  fi
+fi
 }
 
 function openim::build::prepare_docker_machine() {
-  openim::log::status "docker-machine was found."
+openim::log::status "docker-machine was found."
 
-  local available_memory_bytes
+local available_memory_bytes
-  available_memory_bytes=$(sysctl -n hw.memsize 2>/dev/null)
+available_memory_bytes=$(sysctl -n hw.memsize 2>/dev/null)
 
-  local bytes_in_mb=1048576
+local bytes_in_mb=1048576
 
-  # Give virtualbox 1/2 the system memory. Its necessary to divide by 2, instead
+# Give virtualbox 1/2 the system memory. Its necessary to divide by 2, instead
-  # of multiple by .5, because bash can only multiply by ints.
+# of multiple by .5, because bash can only multiply by ints.
-  local memory_divisor=2
+local memory_divisor=2
 
-  local virtualbox_memory_mb=$(( available_memory_bytes / (bytes_in_mb * memory_divisor) ))
+local virtualbox_memory_mb=$(( available_memory_bytes / (bytes_in_mb * memory_divisor) ))
 
-  docker-machine inspect "${DOCKER_MACHINE_NAME}" &> /dev/null || {
+docker-machine inspect "${DOCKER_MACHINE_NAME}" &> /dev/null || {
   openim::log::status "Creating a machine to build OPENIM"
   docker-machine create --driver "${DOCKER_MACHINE_DRIVER}" \
   --virtualbox-memory "${virtualbox_memory_mb}" \
@@ -212,90 +213,90 @@ function openim::build::prepare_docker_machine() {
     openim::log::error "docker-machine create -d ${DOCKER_MACHINE_DRIVER} --virtualbox-memory ${virtualbox_memory_mb} ${DOCKER_MACHINE_NAME}"
     return 1
   }
-  }
+}
-  docker-machine start "${DOCKER_MACHINE_NAME}" &> /dev/null
+docker-machine start "${DOCKER_MACHINE_NAME}" &> /dev/null
-  # it takes `docker-machine env` a few seconds to work if the machine was just started
+# it takes `docker-machine env` a few seconds to work if the machine was just started
-  local docker_machine_out
+local docker_machine_out
-  while ! docker_machine_out=$(docker-machine env "${DOCKER_MACHINE_NAME}" 2>&1); do
+while ! docker_machine_out=$(docker-machine env "${DOCKER_MACHINE_NAME}" 2>&1); do
   if [[ ${docker_machine_out} =~ "Error checking TLS connection" ]]; then
     echo "${docker_machine_out}"
     docker-machine regenerate-certs "${DOCKER_MACHINE_NAME}"
   else
     sleep 1
   fi
-  done
+done
-  eval "$(docker-machine env "${DOCKER_MACHINE_NAME}")"
+eval "$(docker-machine env "${DOCKER_MACHINE_NAME}")"
-  openim::log::status "A Docker host using docker-machine named '${DOCKER_MACHINE_NAME}' is ready to go!"
+openim::log::status "A Docker host using docker-machine named '${DOCKER_MACHINE_NAME}' is ready to go!"
-  return 0
+return 0
 }
 
 function openim::build::is_gnu_sed() {
-  [[ $(sed --version 2>&1) == *GNU* ]]
+[[ $(sed --version 2>&1) == *GNU* ]]
 }
 
 function openim::build::ensure_rsync() {
-  if [[ -z "$(which rsync)" ]]; then
+if [[ -z "$(which rsync)" ]]; then
   openim::log::error "Can't find 'rsync' in PATH, please fix and retry."
   return 1
-  fi
+fi
 }
 
 function openim::build::update_dockerfile() {
-  if openim::build::is_gnu_sed; then
+if openim::build::is_gnu_sed; then
   sed_opts=(-i)
-  else
+else
   sed_opts=(-i '')
-  fi
+fi
-  sed "${sed_opts[@]}" "s/OPENIM_BUILD_IMAGE_CROSS_TAG/${OPENIM_BUILD_IMAGE_CROSS_TAG}/" "${LOCAL_OUTPUT_BUILD_CONTEXT}/Dockerfile"
+sed "${sed_opts[@]}" "s/OPENIM_BUILD_IMAGE_CROSS_TAG/${OPENIM_BUILD_IMAGE_CROSS_TAG}/" "${LOCAL_OUTPUT_BUILD_CONTEXT}/Dockerfile"
 }
 
 function  openim::build::set_proxy() {
-  if [[ -n "${OPENIMRNETES_HTTPS_PROXY:-}" ]]; then
+if [[ -n "${OPENIMRNETES_HTTPS_PROXY:-}" ]]; then
   echo "ENV https_proxy $OPENIMRNETES_HTTPS_PROXY" >> "${LOCAL_OUTPUT_BUILD_CONTEXT}/Dockerfile"
-  fi
+fi
-  if [[ -n "${OPENIMRNETES_HTTP_PROXY:-}" ]]; then
+if [[ -n "${OPENIMRNETES_HTTP_PROXY:-}" ]]; then
   echo "ENV http_proxy $OPENIMRNETES_HTTP_PROXY" >> "${LOCAL_OUTPUT_BUILD_CONTEXT}/Dockerfile"
-  fi
+fi
-  if [[ -n "${OPENIMRNETES_NO_PROXY:-}" ]]; then
+if [[ -n "${OPENIMRNETES_NO_PROXY:-}" ]]; then
   echo "ENV no_proxy $OPENIMRNETES_NO_PROXY" >> "${LOCAL_OUTPUT_BUILD_CONTEXT}/Dockerfile"
-  fi
+fi
 }
 
 function openim::build::ensure_docker_in_path() {
-  if [[ -z "$(which docker)" ]]; then
+if [[ -z "$(which docker)" ]]; then
   openim::log::error "Can't find 'docker' in PATH, please fix and retry."
   openim::log::error "See https://docs.docker.com/installation/#installation for installation instructions."
   return 1
-  fi
+fi
 }
 
 function openim::build::ensure_tar() {
-  if [[ -n "${TAR:-}" ]]; then
+if [[ -n "${TAR:-}" ]]; then
   return
-  fi
+fi
 
-  # Find gnu tar if it is available, bomb out if not.
+# Find gnu tar if it is available, bomb out if not.
-  TAR=tar
+TAR=tar
-  if which gtar &>/dev/null; then
+if which gtar &>/dev/null; then
   TAR=gtar
-  else
+else
   if which gnutar &>/dev/null; then
     TAR=gnutar
   fi
-  fi
+fi
-  if ! "${TAR}" --version | grep -q GNU; then
+if ! "${TAR}" --version | grep -q GNU; then
   echo "  !!! Cannot find GNU tar. Build on Linux or install GNU tar"
   echo "      on Mac OS X (brew install gnu-tar)."
   return 1
-  fi
+fi
 }
 
 function openim::build::has_docker() {
-  which docker &> /dev/null
+which docker &> /dev/null
 }
 
 function openim::build::has_ip() {
-  which ip &> /dev/null && ip -Version | grep 'iproute2' &> /dev/null
+which ip &> /dev/null && ip -Version | grep 'iproute2' &> /dev/null
 }
 
 # Detect if a specific image exists
@@ -303,12 +304,12 @@ function openim::build::has_ip() {
 # $1 - image repo name
 # $2 - image tag
 function openim::build::docker_image_exists() {
-  [[ -n $1 && -n $2 ]] || {
+[[ -n $1 && -n $2 ]] || {
   openim::log::error "Internal error. Image not specified in docker_image_exists."
   exit 2
-  }
+}
 
-  [[ $("${DOCKER[@]}" images -q "${1}:${2}") ]]
+[[ $("${DOCKER[@]}" images -q "${1}:${2}") ]]
 }
 
 # Delete all images that match a tag prefix except for the "current" version
@@ -317,9 +318,9 @@ function openim::build::docker_image_exists() {
 # $2: The tag base. We consider any image that matches $2*
 # $3: The current image not to delete if provided
 function openim::build::docker_delete_old_images() {
-  # In Docker 1.12, we can replace this with
+# In Docker 1.12, we can replace this with
-  #    docker images "$1" --format "{{.Tag}}"
+#    docker images "$1" --format "{{.Tag}}"
-  for tag in $("${DOCKER[@]}" images "${1}" | tail -n +2 | awk '{print $2}') ; do
+for tag in $("${DOCKER[@]}" images "${1}" | tail -n +2 | awk '{print $2}') ; do
   if [[ "${tag}" != "${2}"* ]] ; then
     V=3 openim::log::status "Keeping image ${1}:${tag}"
     continue
@@ -331,7 +332,7 @@ function openim::build::docker_delete_old_images() {
   else
     V=3 openim::log::status "Keeping image ${1}:${tag}"
   fi
-  done
+done
 }
 
 # Stop and delete all containers that match a pattern
@@ -339,9 +340,9 @@ function openim::build::docker_delete_old_images() {
 # $1: The base container prefix
 # $2: The current container to keep, if provided
 function openim::build::docker_delete_old_containers() {
-  # In Docker 1.12 we can replace this line with
+# In Docker 1.12 we can replace this line with
-  #   docker ps -a --format="{{.Names}}"
+#   docker ps -a --format="{{.Names}}"
-  for container in $("${DOCKER[@]}" ps -a | tail -n +2 | awk '{print $NF}') ; do
+for container in $("${DOCKER[@]}" ps -a | tail -n +2 | awk '{print $NF}') ; do
   if [[ "${container}" != "${1}"* ]] ; then
     V=3 openim::log::status "Keeping container ${container}"
     continue
@@ -352,23 +353,23 @@ function openim::build::docker_delete_old_containers() {
   else
     V=3 openim::log::status "Keeping container ${container}"
   fi
-  done
+done
 }
 
 # Takes $1 and computes a short has for it. Useful for unique tag generation
 function openim::build::short_hash() {
-  [[ $# -eq 1 ]] || {
+[[ $# -eq 1 ]] || {
   openim::log::error "Internal error.  No data based to short_hash."
   exit 2
-  }
+}
 
-  local short_hash
+local short_hash
-  if which md5 >/dev/null 2>&1; then
+if which md5 >/dev/null 2>&1; then
   short_hash=$(md5 -q -s "$1")
-  else
+else
   short_hash=$(echo -n "$1" | md5sum)
-  fi
+fi
-  echo "${short_hash:0:10}"
+echo "${short_hash:0:10}"
 }
 
 # Pedantically kill, wait-on and remove a container. The -f -v options
@@ -376,15 +377,15 @@ function openim::build::short_hash() {
 # container, wait to ensure it's stopped, then try the remove. This is
 # a workaround for bug https://github.com/docker/docker/issues/3968.
 function openim::build::destroy_container() {
-  "${DOCKER[@]}" kill "$1" >/dev/null 2>&1 || true
+"${DOCKER[@]}" kill "$1" >/dev/null 2>&1 || true
-  if [[ $("${DOCKER[@]}" version --format '{{.Server.Version}}') = 17.06.0* ]]; then
+if [[ $("${DOCKER[@]}" version --format '{{.Server.Version}}') = 17.06.0* ]]; then
   # Workaround https://github.com/moby/moby/issues/33948.
   # TODO: remove when 17.06.0 is not relevant anymore
   DOCKER_API_VERSION=v1.29 "${DOCKER[@]}" wait "$1" >/dev/null 2>&1 || true
-  else
+else
   "${DOCKER[@]}" wait "$1" >/dev/null 2>&1 || true
-  fi
+fi
-  "${DOCKER[@]}" rm -f -v "$1" >/dev/null 2>&1 || true
+"${DOCKER[@]}" rm -f -v "$1" >/dev/null 2>&1 || true
 }
 
 # ---------------------------------------------------------------------------
@@ -392,7 +393,7 @@ function openim::build::destroy_container() {
 
 
 function openim::build::clean() {
-  if openim::build::has_docker ; then
+if openim::build::has_docker ; then
   openim::build::docker_delete_old_containers "${OPENIM_BUILD_CONTAINER_NAME_BASE}"
   openim::build::docker_delete_old_containers "${OPENIM_RSYNC_CONTAINER_NAME_BASE}"
   openim::build::docker_delete_old_containers "${OPENIM_DATA_CONTAINER_NAME_BASE}"
@@ -400,39 +401,39 @@ function openim::build::clean() {
   
   V=2 openim::log::status "Cleaning all untagged docker images"
   "${DOCKER[@]}" rmi "$("${DOCKER[@]}" images -q --filter 'dangling=true')" 2> /dev/null || true
-  fi
+fi
 
-  if [[ -d "${LOCAL_OUTPUT_ROOT}" ]]; then
+if [[ -d "${LOCAL_OUTPUT_ROOT}" ]]; then
   openim::log::status "Removing _output directory"
   rm -rf "${LOCAL_OUTPUT_ROOT}"
-  fi
+fi
 }
 
 # Set up the context directory for the openim-build image and build it.
 function openim::build::build_image() {
-  mkdir -p "${LOCAL_OUTPUT_BUILD_CONTEXT}"
+mkdir -p "${LOCAL_OUTPUT_BUILD_CONTEXT}"
-  # Make sure the context directory owned by the right user for syncing sources to container.
+# Make sure the context directory owned by the right user for syncing sources to container.
-  chown -R "${USER_ID}":"${GROUP_ID}" "${LOCAL_OUTPUT_BUILD_CONTEXT}"
+chown -R "${USER_ID}":"${GROUP_ID}" "${LOCAL_OUTPUT_BUILD_CONTEXT}"
 
-  cp /etc/localtime "${LOCAL_OUTPUT_BUILD_CONTEXT}/"
+cp /etc/localtime "${LOCAL_OUTPUT_BUILD_CONTEXT}/"
 
-  cp ""${OPENIM_ROOT}"/build/build-image/Dockerfile" "${LOCAL_OUTPUT_BUILD_CONTEXT}/Dockerfile"
+cp "${OPENIM_ROOT}/build/build-image/Dockerfile" "${LOCAL_OUTPUT_BUILD_CONTEXT}/Dockerfile"
-  cp ""${OPENIM_ROOT}"/build/build-image/rsyncd.sh" "${LOCAL_OUTPUT_BUILD_CONTEXT}/"
+cp "${OPENIM_ROOT}/build/build-image/rsyncd.sh" "${LOCAL_OUTPUT_BUILD_CONTEXT}/"
-  dd if=/dev/urandom bs=512 count=1 2>/dev/null | LC_ALL=C tr -dc 'A-Za-z0-9' | dd bs=32 count=1 2>/dev/null > "${LOCAL_OUTPUT_BUILD_CONTEXT}/rsyncd.password"
+dd if=/dev/urandom bs=512 count=1 2>/dev/null | LC_ALL=C tr -dc 'A-Za-z0-9' | dd bs=32 count=1 2>/dev/null > "${LOCAL_OUTPUT_BUILD_CONTEXT}/rsyncd.password"
-  chmod go= "${LOCAL_OUTPUT_BUILD_CONTEXT}/rsyncd.password"
+chmod go= "${LOCAL_OUTPUT_BUILD_CONTEXT}/rsyncd.password"
 
-  openim::build::update_dockerfile
+openim::build::update_dockerfile
-  openim::build::set_proxy
+openim::build::set_proxy
-  openim::build::docker_build "${OPENIM_BUILD_IMAGE}" "${LOCAL_OUTPUT_BUILD_CONTEXT}" 'false'
+openim::build::docker_build "${OPENIM_BUILD_IMAGE}" "${LOCAL_OUTPUT_BUILD_CONTEXT}" 'false'
 
-  # Clean up old versions of everything
+# Clean up old versions of everything
-  openim::build::docker_delete_old_containers "${OPENIM_BUILD_CONTAINER_NAME_BASE}" "${OPENIM_BUILD_CONTAINER_NAME}"
+openim::build::docker_delete_old_containers "${OPENIM_BUILD_CONTAINER_NAME_BASE}" "${OPENIM_BUILD_CONTAINER_NAME}"
-  openim::build::docker_delete_old_containers "${OPENIM_RSYNC_CONTAINER_NAME_BASE}" "${OPENIM_RSYNC_CONTAINER_NAME}"
+openim::build::docker_delete_old_containers "${OPENIM_RSYNC_CONTAINER_NAME_BASE}" "${OPENIM_RSYNC_CONTAINER_NAME}"
-  openim::build::docker_delete_old_containers "${OPENIM_DATA_CONTAINER_NAME_BASE}" "${OPENIM_DATA_CONTAINER_NAME}"
+openim::build::docker_delete_old_containers "${OPENIM_DATA_CONTAINER_NAME_BASE}" "${OPENIM_DATA_CONTAINER_NAME}"
-  openim::build::docker_delete_old_images "${OPENIM_BUILD_IMAGE_REPO}" "${OPENIM_BUILD_IMAGE_TAG_BASE}" "${OPENIM_BUILD_IMAGE_TAG}"
+openim::build::docker_delete_old_images "${OPENIM_BUILD_IMAGE_REPO}" "${OPENIM_BUILD_IMAGE_TAG_BASE}" "${OPENIM_BUILD_IMAGE_TAG}"
 
-  openim::build::ensure_data_container
+openim::build::ensure_data_container
-  openim::build::sync_to_container
+openim::build::sync_to_container
 }
 
 # Build a docker image from a Dockerfile.
@@ -440,14 +441,14 @@ function openim::build::build_image() {
 # $2 is the location of the "context" directory, with the Dockerfile at the root.
 # $3 is the value to set the --pull flag for docker build; true by default
 function openim::build::docker_build() {
-  local -r image=$1
+local -r image=$1
-  local -r context_dir=$2
+local -r context_dir=$2
-  local -r pull="${3:-true}"
+local -r pull="${3:-true}"
-  local -ra build_cmd=("${DOCKER[@]}" build -t "${image}" "--pull=${pull}" "${context_dir}")
+local -ra build_cmd=("${DOCKER[@]}" build -t "${image}" "--pull=${pull}" "${context_dir}")
 
-  openim::log::status "Building Docker image ${image}"
+openim::log::status "Building Docker image ${image}"
-  local docker_output
+local docker_output
-  docker_output=$("${build_cmd[@]}" 2>&1) || {
+docker_output=$("${build_cmd[@]}" 2>&1) || {
     cat <<EOF >&2
 +++ Docker build command failed for ${image}
 
@@ -459,23 +460,23 @@ ${build_cmd[*]}
 
 EOF
   return 1
-  }
+}
 }
 
 function openim::build::ensure_data_container() {
-  # If the data container exists AND exited successfully, we can use it.
+# If the data container exists AND exited successfully, we can use it.
-  # Otherwise nuke it and start over.
+# Otherwise nuke it and start over.
-  local ret=0
+local ret=0
-  local code=0
+local code=0
 
-  code=$(docker inspect \
+code=$(docker inspect \
   -f '{{.State.ExitCode}}' \
-      "${OPENIM_DATA_CONTAINER_NAME}" 2>/dev/null) || ret=$?
+"${OPENIM_DATA_CONTAINER_NAME}" 2>/dev/null) || ret=$?
-  if [[ "${ret}" == 0 && "${code}" != 0 ]]; then
+if [[ "${ret}" == 0 && "${code}" != 0 ]]; then
   openim::build::destroy_container "${OPENIM_DATA_CONTAINER_NAME}"
   ret=1
-  fi
+fi
-  if [[ "${ret}" != 0 ]]; then
+if [[ "${ret}" != 0 ]]; then
   openim::log::status "Creating data container ${OPENIM_DATA_CONTAINER_NAME}"
   # We have to ensure the directory exists, or else the docker run will
   # create it as root.
@@ -508,11 +509,11 @@ function openim::build::ensure_data_container() {
     /usr/local/go/pkg/
   )
   "${docker_cmd[@]}"
-  fi
+fi
 }
 
 # Build all openim commands.
 function openim::build::build_command() {
-  openim::log::status "Running build command..."
+openim::log::status "Running build command..."
-  make -C "${OPENIM_ROOT}" multiarch
+make -C "${OPENIM_ROOT}" multiarch
 }

scripts/docker-start-all.sh

@@ -28,8 +28,6 @@ openim::log::info "\n# Use Docker to start all openim service"
 
 trap 'openim::util::onCtrlC' INT
 
-"${OPENIM_ROOT}"/scripts/init-config.sh --skip
-
 "${OPENIM_ROOT}"/scripts/start-all.sh
 
 sleep 5

scripts/ensure-tag.sh

@@ -14,11 +14,13 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+OPENIM_ROOT=$(dirname "${BASH_SOURCE[0]}")/..
+
 version="${VERSION}"
 if [ "${version}" == "" ];then
-  version=v`gsemver bump`
+  version=v$(${OPENIM_ROOT}/_output/tools/gsemver bump)
 fi
 
-if [ -z "`git tag -l ${version}`" ];then
+if [ -z "$(git tag -l ${version})" ];then
   git tag -a -m "release version ${version}" ${version}
 fi

scripts/gen-swagger-docs.sh

@@ -67,7 +67,7 @@ echo -e "=== any\nRepresents an untyped JSON map - see the description of the fi
 asciidoctor definitions.adoc
 asciidoctor paths.adoc
 
-cp ${OPENIM_OUTPUT_TMP}/definitions.html ${OPENIM_OUTPUT_TMP}/_output/
+cp "$OPENIM_OUTPUT_TMP/definitions.html" "$OPENIM_OUTPUT_TMP/_output/"
-cp ${OPENIM_OUTPUT_TMP}/paths.html ${OPENIM_OUTPUT_TMP}/_output/operations.html
+cp "$OPENIM_OUTPUT_TMP/paths.html" "$OPENIM_OUTPUT_TMP/_output/operations.html"
 
 success "SUCCESS"

scripts/genconfig.sh

@@ -25,20 +25,12 @@ OPENIM_ROOT=$(dirname "${BASH_SOURCE[0]}")/..
 source "${OPENIM_ROOT}/scripts/lib/init.sh"
 
 if [ $# -ne 2 ];then
-    openim::log::error "Usage: scripts/genconfig.sh scripts/environment.sh configs/openim-api.yaml"
+  openim::log::error "Usage: scripts/genconfig.sh scripts/environment.sh configs/config.yaml"
   exit 1
 fi
 
-openim::util::require-dig
+if [ -z "${OPENIM_IP}" ]; then
-result=$?
+  openim::util::require-dig
-if [ $result -ne 0 ]; then
-    openim::log::info "Please install 'dig' to use this feature."
-    openim::log::info "Installation instructions:"
-    openim::log::info "  For Ubuntu/Debian: sudo apt-get install dnsutils"
-    openim::log::info "  For CentOS/RedHat: sudo yum install bind-utils"
-    openim::log::info "  For macOS: 'dig' should be preinstalled. If missing, try: brew install bind"
-    openim::log::info "  For Windows: Install BIND9 tools from https://www.isc.org/download/"
-    openim::log::error_exit "Error: 'dig' command is required but not installed."
 fi
 
 source "${env_file}"
@@ -55,7 +47,7 @@ do
 done
 
 if [ "${missing}" ];then
-    openim::log::error 'You may run `source scripts/environment.sh` to set these environment'
+  openim::log::error "You may run 'source scripts/environment.sh' to set these environment"
   exit 1
 fi
 

scripts/githooks/commit-msg.sh

@@ -50,9 +50,9 @@ printMessage "Running the OpenIM commit-msg hook."
 # This example catches duplicate Signed-off-by lines.
 
 test "" = "$(grep '^Signed-off-by: ' "$1" |
-	 sort | uniq -c | sed -e '/^[ 	]*1[ 	]/d')" || {
+sort | uniq -c | sed -e '/^[ 	]*1[ 	]/d')" || {
-	echo >&2 Duplicate Signed-off-by lines.
+echo >&2 Duplicate Signed-off-by lines.
-	exit 1
+exit 1
 }
 
 # TODO: go-gitlint dir set
@@ -60,21 +60,21 @@ OPENIM_ROOT=$(dirname "${BASH_SOURCE[0]}")/../..
 GITLINT_DIR="$OPENIM_ROOT/_output/tools/go-gitlint"
 
 $GITLINT_DIR \
-    --msg-file=$1 \
+--msg-file=$1 \
-    --subject-regex="^(build|chore|ci|docs|feat|feature|fix|perf|refactor|revert|style|bot|test)(.*)?:\s?.*" \
+--subject-regex="^(build|chore|ci|docs|feat|feature|fix|perf|refactor|revert|style|bot|test)(.*)?:\s?.*" \
-    --subject-maxlen=150 \
+--subject-maxlen=150 \
-    --subject-minlen=10 \
+--subject-minlen=10 \
-    --body-regex=".*" \
+--body-regex=".*" \
-    --max-parents=1
+--max-parents=1
 
 if [ $? -ne 0 ]
 then
-    if ! command -v $GITLINT_DIR &>/dev/null; then
+if ! command -v $GITLINT_DIR &>/dev/null; then
   printError "$GITLINT_DIR not found. Please run 'make tools' OR 'make tools.verify.go-gitlint' make verto install it."
-    fi
+fi
-    printError "Please fix your commit message to match kubecub coding standards"
+printError "Please fix your commit message to match kubecub coding standards"
-    printError "https://gist.github.com/cubxxw/126b72104ac0b0ca484c9db09c3e5694#file-githook-md"
+printError "https://gist.github.com/cubxxw/126b72104ac0b0ca484c9db09c3e5694#file-githook-md"
-    exit 1
+exit 1
 fi
 
 ### Add Sign-off-by line to the end of the commit message
@@ -88,5 +88,5 @@ SIGNED_OFF_BY_EXISTS=$?
 
 # Add "Signed-off-by" line if it doesn't exist
 if [ $SIGNED_OFF_BY_EXISTS -ne 0 ]; then
-  echo -e "\nSigned-off-by: $NAME <$EMAIL>" >> "$1"
+echo -e "\nSigned-off-by: $NAME <$EMAIL>" >> "$1"
 fi

scripts/githooks/pre-push.sh

@@ -38,7 +38,7 @@ printError() {
 
 printMessage "Running local OpenIM pre-push hook."
 
-if [[ `git status --porcelain` ]]; then
+if [[ $(git status --porcelain) ]]; then
   printError "This scripts needs to run against committed code only. Please commit or stash you changes."
   exit 1
 fi

scripts/init-config.sh

@@ -31,7 +31,7 @@ readonly ENV_FILE=${ENV_FILE:-"${OPENIM_ROOT}/scripts/install/environment.sh"}
 # Templates for configuration files
 declare -A TEMPLATES=(
   ["${OPENIM_ROOT}/deployments/templates/env-template.yaml"]="${OPENIM_ROOT}/.env"
-  ["${OPENIM_ROOT}/deployments/templates/openim.yaml"]="${OPENIM_ROOT}/config/config.yaml"
+  ["${OPENIM_ROOT}/deployments/templates/config.yaml"]="${OPENIM_ROOT}/config/config.yaml"
   ["${OPENIM_ROOT}/deployments/templates/prometheus.yml"]="${OPENIM_ROOT}/config/prometheus.yml"
   ["${OPENIM_ROOT}/deployments/templates/alertmanager.yml"]="${OPENIM_ROOT}/config/alertmanager.yml"
 )
@@ -39,7 +39,7 @@ declare -A TEMPLATES=(
 # Templates for example files
 declare -A EXAMPLES=(
   ["${OPENIM_ROOT}/deployments/templates/env-template.yaml"]="${OPENIM_ROOT}/config/templates/env.template"
-  ["${OPENIM_ROOT}/deployments/templates/openim.yaml"]="${OPENIM_ROOT}/config/templates/config.yaml.template"
+  ["${OPENIM_ROOT}/deployments/templates/config.yaml"]="${OPENIM_ROOT}/config/templates/config.yaml.template"
   ["${OPENIM_ROOT}/deployments/templates/prometheus.yml"]="${OPENIM_ROOT}/config/templates/prometheus.yml.template"
   ["${OPENIM_ROOT}/deployments/templates/alertmanager.yml"]="${OPENIM_ROOT}/config/templates/alertmanager.yml.template"
 )
@@ -95,6 +95,10 @@ generate_config_files() {
 # Function to generate example files
 generate_example_files() {
   env_cmd="env -i"
+  
+  env_vars["OPENIM_IP"]="127.0.0.1"
+  env_vars["LOG_STORAGE_LOCATION"]="../../"
+  
   for var in "${!env_vars[@]}"; do
     env_cmd+=" $var='${env_vars[$var]}'"
   done
@@ -110,7 +114,6 @@ generate_example_files() {
     local example_file="${COPY_EXAMPLES[$template]}"
     process_file "$template" "$example_file" false
   done
-
 }
 
 # Function to process a single file, either by generating or copying
@@ -181,7 +184,6 @@ clean_config_files() {
 
 # Function to clean example files
 clean_example_files() {
-  # 合并 EXAMPLES 和 COPY_EXAMPLES 数组
   local all_examples=("${EXAMPLES[@]}" "${COPY_EXAMPLES[@]}")
   
   for example_file in "${all_examples[@]}"; do

scripts/init-githooks.sh

@@ -50,7 +50,7 @@ help_info() {
 }
 
 delete_hooks() {
-    for file in ${OPENIM_ROOT}/scripts/githooks/*.sh; do
+  for file in "${OPENIM_ROOT}"/scripts/githooks/*.sh; do
     hook_name=$(basename "$file" .sh)  # This removes the .sh extension
     rm -f "$HOOKS_DIR/$hook_name"
   done

scripts/install-im-server.sh

@@ -1,5 +1,5 @@
 #!/usr/bin/env bash
-# Copyright © 2023 OpenIM. All rights reserved.
+# Copyright © 2024 OpenIM. All rights reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -13,8 +13,20 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+#
+# OpenIM Docker Deployment Script
+#
+# This script automates the process of building the OpenIM server image
+# and deploying it using Docker Compose.
+#
+# Variables:
+#   - SERVER_IMAGE_VERSION: Version of the server image (default: test)
+#   - IMAGE_REGISTRY: Docker image registry (default: openim)
+#   - DOCKER_COMPOSE_FILE_URL: URL to the docker-compose.yml file
+#
+# Usage:
+#   SERVER_IMAGE_VERSION=latest IMAGE_REGISTRY=myregistry ./this_script.sh
 
-# Common utilities, variables and checks for all build scripts.
 set -o errexit
 set -o nounset
 set -o pipefail
@@ -28,35 +40,47 @@ chmod +x "${OPENIM_ROOT}"/scripts/*.sh
 
 openim::util::ensure_docker_daemon_connectivity
 
+# Default values for variables
+: ${SERVER_IMAGE_VERSION:=test}
+: ${IMAGE_REGISTRY:=openim}
+: ${DOCKER_COMPOSE_FILE_URL:="https://raw.githubusercontent.com/openimsdk/openim-docker/main/docker-compose.yaml"}
+
 DOCKER_COMPOSE_COMMAND=
 # Check if docker-compose command is available
 openim::util::check_docker_and_compose_versions
-
+if command -v docker compose &> /dev/null; then
-if command -v docker compose &> /dev/null
-then
   openim::log::info "docker compose command is available"
   DOCKER_COMPOSE_COMMAND="docker compose"
 else
   DOCKER_COMPOSE_COMMAND="docker-compose"
 fi
 
+export SERVER_IMAGE_VERSION
+export IMAGE_REGISTRY
 "${OPENIM_ROOT}"/scripts/init-config.sh
+
 pushd "${OPENIM_ROOT}"
+docker build -t "${IMAGE_REGISTRY}/openim-server:${SERVER_IMAGE_VERSION}" .
 ${DOCKER_COMPOSE_COMMAND} stop
-curl https://raw.githubusercontent.com/openimsdk/openim-docker/main/docker-compose.yaml -o docker-compose.yml
+curl "${DOCKER_COMPOSE_FILE_URL}" -o docker-compose.yml
 ${DOCKER_COMPOSE_COMMAND} up -d
 
+# Function to check container status
+check_containers() {
+  if ! ${DOCKER_COMPOSE_COMMAND} ps | grep -q 'Up'; then
+    echo "Error: One or more docker containers failed to start."
+    ${DOCKER_COMPOSE_COMMAND} logs openim-server
+    ${DOCKER_COMPOSE_COMMAND} logs openim-chat
+    return 1
+  fi
+  return 0
+}
+
 # Wait for a short period to allow containers to initialize
 sleep 30
 
-# Check the status of the containers
-if ! ${DOCKER_COMPOSE_COMMAND} ps | grep -q 'Up'; then
-    echo "Error: One or more docker containers failed to start."
-    ${DOCKER_COMPOSE_COMMAND} logs
-fi
-
-sleep 30  # Keep the original 60-second wait, adjusted for the 10-second check above
-${DOCKER_COMPOSE_COMMAND} logs openim-server
 ${DOCKER_COMPOSE_COMMAND} ps
 
+check_containers
+
 popd

scripts/install/dependency.sh

@@ -24,66 +24,66 @@ OPENIM_ROOT=$(cd "$(dirname "${BASH_SOURCE[0]}")"/../.. && pwd -P)
 
 # Start MongoDB service
 docker run -d \
-    --name mongo \
+--name mongo \
-    -p 37017:27017 \
+-p 37017:27017 \
-    -v "${DATA_DIR}/components/mongodb/data/db:/data/db" \
+-v "${DATA_DIR}/components/mongodb/data/db:/data/db" \
-    -v "${DATA_DIR}/components/mongodb/data/logs:/data/logs" \
+-v "${DATA_DIR}/components/mongodb/data/logs:/data/logs" \
-    -v "${DATA_DIR}/components/mongodb/data/conf:/etc/mongo" \
+-v "${DATA_DIR}/components/mongodb/data/conf:/etc/mongo" \
-    -v "./scripts/mongo-init.sh:/docker-entrypoint-initdb.d/mongo-init.sh:ro" \
+-v "./scripts/mongo-init.sh:/docker-entrypoint-initdb.d/mongo-init.sh:ro" \
-    -e TZ=Asia/Shanghai \
+-e TZ=Asia/Shanghai \
-    -e wiredTigerCacheSizeGB=1 \
+-e wiredTigerCacheSizeGB=1 \
-    -e MONGO_INITDB_ROOT_USERNAME=${OPENIM_USER} \
+-e MONGO_INITDB_ROOT_USERNAME=${OPENIM_USER} \
-    -e MONGO_INITDB_ROOT_PASSWORD=${PASSWORD} \
+-e MONGO_INITDB_ROOT_PASSWORD=${PASSWORD} \
-    -e MONGO_INITDB_DATABASE=openIM \
+-e MONGO_INITDB_DATABASE=openim_v3 \
-    -e MONGO_OPENIM_USERNAME=${OPENIM_USER} \
+-e MONGO_OPENIM_USERNAME=${OPENIM_USER} \
-    -e MONGO_OPENIM_PASSWORD=${PASSWORD} \
+-e MONGO_OPENIM_PASSWORD=${PASSWORD} \
-    --restart always \
+--restart always \
-    mongo:6.0.2 --wiredTigerCacheSizeGB 1 --auth
+mongo:6.0.2 --wiredTigerCacheSizeGB 1 --auth
 
 # Start Redis service
 docker run -d \
-    --name redis \
+--name redis \
-    -p 16379:6379 \
+-p 16379:6379 \
-    -v "${DATA_DIR}/components/redis/data:/data" \
+-v "${DATA_DIR}/components/redis/data:/data" \
-    -v "${DATA_DIR}/components/redis/config/redis.conf:/usr/local/redis/config/redis.conf" \
+-v "${DATA_DIR}/components/redis/config/redis.conf:/usr/local/redis/config/redis.conf" \
-    -e TZ=Asia/Shanghai \
+-e TZ=Asia/Shanghai \
-    --sysctl net.core.somaxconn=1024 \
+--sysctl net.core.somaxconn=1024 \
-    --restart always \
+--restart always \
-    redis:7.0.0 redis-server --requirepass ${PASSWORD} --appendonly yes
+redis:7.0.0 redis-server --requirepass ${PASSWORD} --appendonly yes
 
 # Start Zookeeper service
 docker run -d \
-    --name zookeeper \
+--name zookeeper \
-    -p 2181:2181 \
+-p 2181:2181 \
-    -v "/etc/localtime:/etc/localtime" \
+-v "/etc/localtime:/etc/localtime" \
-    -e TZ=Asia/Shanghai \
+-e TZ=Asia/Shanghai \
-    --restart always \
+--restart always \
-    wurstmeister/zookeeper
+wurstmeister/zookeeper
 
 # Start Kafka service
 docker run -d \
-    --name kafka \
+--name kafka \
-    -p 9092:9092 \
+-p 9092:9092 \
-    -e TZ=Asia/Shanghai \
+-e TZ=Asia/Shanghai \
-    -e KAFKA_BROKER_ID=0 \
+-e KAFKA_BROKER_ID=0 \
-    -e KAFKA_ZOOKEEPER_CONNECT=zookeeper:2181 \
+-e KAFKA_ZOOKEEPER_CONNECT=zookeeper:2181 \
-    -e KAFKA_CREATE_TOPICS="latestMsgToRedis:8:1,msgToPush:8:1,offlineMsgToMongoMysql:8:1" \
+-e KAFKA_CREATE_TOPICS="latestMsgToRedis:8:1,msgToPush:8:1,offlineMsgToMongoMysql:8:1" \
-    -e KAFKA_ADVERTISED_LISTENERS="INSIDE://127.0.0.1:9092,OUTSIDE://103.116.45.174:9092" \
+-e KAFKA_ADVERTISED_LISTENERS="INSIDE://127.0.0.1:9092,OUTSIDE://103.116.45.174:9092" \
-    -e KAFKA_LISTENERS="INSIDE://:9092,OUTSIDE://:9093" \
+-e KAFKA_LISTENERS="INSIDE://:9092,OUTSIDE://:9093" \
-    -e KAFKA_LISTENER_SECURITY_PROTOCOL_MAP="INSIDE:PLAINTEXT,OUTSIDE:PLAINTEXT" \
+-e KAFKA_LISTENER_SECURITY_PROTOCOL_MAP="INSIDE:PLAINTEXT,OUTSIDE:PLAINTEXT" \
-    -e KAFKA_INTER_BROKER_LISTENER_NAME=INSIDE \
+-e KAFKA_INTER_BROKER_LISTENER_NAME=INSIDE \
-    --restart always \
+--restart always \
-    --link zookeeper \
+--link zookeeper \
-    wurstmeister/kafka
+wurstmeister/kafka
 
 # Start MinIO service
 docker run -d \
-    --name minio \
+--name minio \
-    -p 10005:9000 \
+-p 10005:9000 \
-    -p 9090:9090 \
+-p 9090:9090 \
-    -v "/mnt/data:/data" \
+-v "/mnt/data:/data" \
-    -v "/mnt/config:/root/.minio" \
+-v "/mnt/config:/root/.minio" \
-    -e MINIO_ROOT_USER=${OPENIM_USER} \
+-e MINIO_ROOT_USER=${OPENIM_USER} \
-    -e MINIO_ROOT_PASSWORD=${PASSWORD} \
+-e MINIO_ROOT_PASSWORD=${PASSWORD} \
-    --restart always \
+--restart always \
-    minio/minio server /data --console-address ':9090'
+minio/minio server /data --console-address ':9090'

scripts/install/environment.sh

@@ -22,7 +22,7 @@
 OPENIM_ROOT="$(cd "$(dirname "${BASH_SOURCE[0]}")/../.." && pwd -P)"
 
 # 生成文件存放目录
-LOCAL_OUTPUT_ROOT=""${OPENIM_ROOT}"/${OUT_DIR:-_output}"
+LOCAL_OUTPUT_ROOT="${OPENIM_ROOT}/${OUT_DIR:-_output}"
 source "${OPENIM_ROOT}/scripts/lib/init.sh"
 
 #TODO: Access to the OPENIM_IP networks outside, or you want to use the OPENIM_IP network
@@ -52,7 +52,7 @@ def "OPENIM_USER" "root"
 readonly PASSWORD=${PASSWORD:-'openIM123'}
 
 # 设置统一的数据库名称，方便管理
-def "DATABASE_NAME" "openIM_v3"
+def "DATABASE_NAME" "openim_v3"
 
 # Linux系统 openim 用户
 def "LINUX_USERNAME" "openim"
@@ -62,7 +62,7 @@ readonly LINUX_PASSWORD=${LINUX_PASSWORD:-"${PASSWORD}"}
 def "INSTALL_DIR" "${LOCAL_OUTPUT_ROOT}/installs"
 mkdir -p ${INSTALL_DIR}
 
-def "ENV_FILE" ""${OPENIM_ROOT}"/scripts/install/environment.sh"
+def "ENV_FILE" "${OPENIM_ROOT}/scripts/install/environment.sh"
 
 ###################### Docker compose ###################
 # OPENIM AND CHAT
@@ -128,7 +128,7 @@ def "OPENIM_CONFIG_DIR" "/etc/openim/config"
 def "OPENIM_LOG_DIR" "/var/log/openim"
 def "CA_FILE" "${OPENIM_CONFIG_DIR}/cert/ca.pem"
 
-def "OPNEIM_CONFIG" ""${OPENIM_ROOT}"/config"
+def "OPNEIM_CONFIG" "${OPENIM_ROOT}/config"
 def "OPENIM_SERVER_ADDRESS" "${DOCKER_BRIDGE_GATEWAY}" # OpenIM服务地址
 
 # OpenIM Websocket端口
@@ -177,7 +177,7 @@ readonly MONGO_PASSWORD=${MONGO_PASSWORD:-"${PASSWORD}"}
 # Mongo OpenIM 身份用户名
 def "MONGO_OPENIM_USERNAME" "openIM"
 # Mongo OpenIM 身份密码
-readonly MONGO_OPENIM_PASSWORD=${MONGO_OPENIM_PASSWORD:-'openIM123456'}
+readonly MONGO_OPENIM_PASSWORD=${MONGO_OPENIM_PASSWORD:-"${PASSWORD}"}
 
 def "MONGO_MAX_POOL_SIZE" "100"                # 最大连接池大小
 
@@ -243,8 +243,6 @@ def "KAFKA_CONSUMERGROUPID_PUSH" "push"                     # `Kafka` 的消费
 
 ###################### openim-web 配置信息 ######################
 def "OPENIM_WEB_PORT" "11001"                       # openim-web的端口
-def "OPENIM_WEB_ADDRESS" "${DOCKER_BRIDGE_GATEWAY}" # openim-web的地址
-def "OPENIM_WEB_DIST_PATH" "/app/dist"              # openim-web的dist路径
 
 ###################### openim-admin-front 配置信息 ######################
 def "OPENIM_ADMIN_FRONT_PORT" "11002"                       # openim-admin-front的端口
@@ -326,7 +324,7 @@ def "OPENIM_CONVERSATION_NAME" "Conversation"       # OpenIM对话服务名称
 def "OPENIM_THIRD_NAME" "Third"                     # OpenIM第三方服务名称
 
 ###################### Log Configuration Variables ######################
-def "LOG_STORAGE_LOCATION" ""${OPENIM_ROOT}"/logs/" # 日志存储位置
+def "LOG_STORAGE_LOCATION" "${OPENIM_ROOT}/logs/" # 日志存储位置
 def "LOG_ROTATION_TIME" "24"                        # 日志轮替时间
 def "LOG_REMAIN_ROTATION_COUNT" "2"                 # 保留的日志轮替数量
 def "LOG_REMAIN_LOG_LEVEL" "6"                      # 保留的日志级别
@@ -414,7 +412,7 @@ readonly MSG_TRANSFER_PROM_ADDRESS_PORT=${MSG_TRANSFER_PROM_ADDRESS_PORT:-"${DOC
 ###################### OpenIM openim-api ######################
 def "OPENIM_API_HOST" "127.0.0.1"
 def "OPENIM_API_BINARY" "${OPENIM_OUTPUT_HOSTBIN}/openim-api" # OpenIM openim-api 二进制文件路径
-def "OPENIM_API_CONFIG" ""${OPENIM_ROOT}"/config/"            # OpenIM openim-api 配置文件路径
+def "OPENIM_API_CONFIG" "${OPENIM_ROOT}/config/"            # OpenIM openim-api 配置文件路径
 def "OPENIM_API_LOG_DIR" "${LOG_STORAGE_LOCATION}/openim-api" # OpenIM openim-api 日志存储路径
 def "OPENIM_API_LOG_LEVEL" "info"                             # OpenIM openim-api 日志级别
 def "OPENIM_API_LOG_MAX_SIZE" "100"                           # OpenIM openim-api 日志最大大小（MB）
@@ -426,7 +424,7 @@ def "OPENIM_API_LOG_WITH_STACK" "${LOG_WITH_STACK}"           # OpenIM openim-ap
 ###################### OpenIM openim-cmdutils ######################
 def "OPENIM_CMDUTILS_HOST" "127.0.0.1"
 def "OPENIM_CMDUTILS_BINARY" "${OPENIM_OUTPUT_HOSTBIN}/openim-cmdutils" # OpenIM openim-cmdutils 二进制文件路径
-def "OPENIM_CMDUTILS_CONFIG" ""${OPENIM_ROOT}"/config/"                 # OpenIM openim-cmdutils 配置文件路径
+def "OPENIM_CMDUTILS_CONFIG" "${OPENIM_ROOT}/config/"                 # OpenIM openim-cmdutils 配置文件路径
 def "OPENIM_CMDUTILS_LOG_DIR" "${LOG_STORAGE_LOCATION}/openim-cmdutils" # OpenIM openim-cmdutils 日志存储路径
 def "OPENIM_CMDUTILS_LOG_LEVEL" "info"                                  # OpenIM openim-cmdutils 日志级别
 def "OPENIM_CMDUTILS_LOG_MAX_SIZE" "100"                                # OpenIM openim-cmdutils 日志最大大小（MB）
@@ -438,7 +436,7 @@ def "OPENIM_CMDUTILS_LOG_WITH_STACK" "${LOG_WITH_STACK}"                # OpenIM
 ###################### OpenIM openim-crontask ######################
 def "OPENIM_CRONTASK_HOST" "127.0.0.1"
 def "OPENIM_CRONTASK_BINARY" "${OPENIM_OUTPUT_HOSTBIN}/openim-crontask" # OpenIM openim-crontask 二进制文件路径
-def "OPENIM_CRONTASK_CONFIG" ""${OPENIM_ROOT}"/config/"                 # OpenIM openim-crontask 配置文件路径
+def "OPENIM_CRONTASK_CONFIG" "${OPENIM_ROOT}/config/"                 # OpenIM openim-crontask 配置文件路径
 def "OPENIM_CRONTASK_LOG_DIR" "${LOG_STORAGE_LOCATION}/openim-crontask" # OpenIM openim-crontask 日志存储路径
 def "OPENIM_CRONTASK_LOG_LEVEL" "info"                                  # OpenIM openim-crontask 日志级别
 def "OPENIM_CRONTASK_LOG_MAX_SIZE" "100"                                # OpenIM openim-crontask 日志最大大小（MB）
@@ -450,7 +448,7 @@ def "OPENIM_CRONTASK_LOG_WITH_STACK" "${LOG_WITH_STACK}"                # OpenIM
 ###################### OpenIM openim-msggateway ######################
 def "OPENIM_MSGGATEWAY_HOST" "127.0.0.1"
 def "OPENIM_MSGGATEWAY_BINARY" "${OPENIM_OUTPUT_HOSTBIN}/openim-msggateway"
-def "OPENIM_MSGGATEWAY_CONFIG" ""${OPENIM_ROOT}"/config/"
+def "OPENIM_MSGGATEWAY_CONFIG" "${OPENIM_ROOT}/config/"
 def "OPENIM_MSGGATEWAY_LOG_DIR" "${LOG_STORAGE_LOCATION}/openim-msggateway"
 def "OPENIM_MSGGATEWAY_LOG_LEVEL" "info"
 def "OPENIM_MSGGATEWAY_LOG_MAX_SIZE" "100"
@@ -465,7 +463,7 @@ readonly OPENIM_MSGGATEWAY_NUM=${OPENIM_MSGGATEWAY_NUM:-'4'}
 ###################### OpenIM openim-msgtransfer ######################
 def "OPENIM_MSGTRANSFER_HOST" "127.0.0.1"
 def "OPENIM_MSGTRANSFER_BINARY" "${OPENIM_OUTPUT_HOSTBIN}/openim-msgtransfer" # OpenIM openim-msgtransfer 二进制文件路径
-def "OPENIM_MSGTRANSFER_CONFIG" ""${OPENIM_ROOT}"/config/"                    # OpenIM openim-msgtransfer 配置文件路径
+def "OPENIM_MSGTRANSFER_CONFIG" "${OPENIM_ROOT}/config/"                    # OpenIM openim-msgtransfer 配置文件路径
 def "OPENIM_MSGTRANSFER_LOG_DIR" "${LOG_STORAGE_LOCATION}/openim-msgtransfer" # OpenIM openim-msgtransfer 日志存储路径
 def "OPENIM_MSGTRANSFER_LOG_LEVEL" "info"                                     # OpenIM openim-msgtransfer 日志级别
 def "OPENIM_MSGTRANSFER_LOG_MAX_SIZE" "100"                                   # OpenIM openim-msgtransfer 日志最大大小（MB）
@@ -477,7 +475,7 @@ def "OPENIM_MSGTRANSFER_LOG_WITH_STACK" "${LOG_WITH_STACK}"                   #
 ###################### OpenIM openim-push ######################
 def "OPENIM_PUSH_HOST" "127.0.0.1"
 def "OPENIM_PUSH_BINARY" "${OPENIM_OUTPUT_HOSTBIN}/openim-push" # OpenIM openim-push 二进制文件路径
-def "OPENIM_PUSH_CONFIG" ""${OPENIM_ROOT}"/config/"             # OpenIM openim-push 配置文件路径
+def "OPENIM_PUSH_CONFIG" "${OPENIM_ROOT}/config/"             # OpenIM openim-push 配置文件路径
 def "OPENIM_PUSH_LOG_DIR" "${LOG_STORAGE_LOCATION}/openim-push" # OpenIM openim-push 日志存储路径
 def "OPENIM_PUSH_LOG_LEVEL" "info"                              # OpenIM openim-push 日志级别
 def "OPENIM_PUSH_LOG_MAX_SIZE" "100"                            # OpenIM openim-push 日志最大大小（MB）
@@ -489,7 +487,7 @@ def "OPENIM_PUSH_LOG_WITH_STACK" "${LOG_WITH_STACK}"            # OpenIM openim-
 ###################### OpenIM openim-rpc-auth ######################
 def "OPENIM_RPC_AUTH_HOST" "127.0.0.1"
 def "OPENIM_RPC_AUTH_BINARY" "${OPENIM_OUTPUT_HOSTBIN}/openim-rpc-auth" # OpenIM openim-rpc-auth 二进制文件路径
-def "OPENIM_RPC_AUTH_CONFIG" ""${OPENIM_ROOT}"/config/"                 # OpenIM openim-rpc-auth 配置文件路径
+def "OPENIM_RPC_AUTH_CONFIG" "${OPENIM_ROOT}/config/"                 # OpenIM openim-rpc-auth 配置文件路径
 def "OPENIM_RPC_AUTH_LOG_DIR" "${LOG_STORAGE_LOCATION}/openim-rpc-auth" # OpenIM openim-rpc-auth 日志存储路径
 def "OPENIM_RPC_AUTH_LOG_LEVEL" "info"                                  # OpenIM openim-rpc-auth 日志级别
 def "OPENIM_RPC_AUTH_LOG_MAX_SIZE" "100"                                # OpenIM openim-rpc-auth 日志最大大小（MB）
@@ -501,7 +499,7 @@ def "OPENIM_RPC_AUTH_LOG_WITH_STACK" "${LOG_WITH_STACK}"                # OpenIM
 ###################### OpenIM openim-rpc-conversation ######################
 def "OPENIM_RPC_CONVERSATION_HOST" "127.0.0.1"
 def "OPENIM_RPC_CONVERSATION_BINARY" "${OPENIM_OUTPUT_HOSTBIN}/openim-rpc-conversation" # OpenIM openim-rpc-conversation 二进制文件路径
-def "OPENIM_RPC_CONVERSATION_CONFIG" ""${OPENIM_ROOT}"/config/"                         # OpenIM openim-rpc-conversation 配置文件路径
+def "OPENIM_RPC_CONVERSATION_CONFIG" "${OPENIM_ROOT}/config/"                         # OpenIM openim-rpc-conversation 配置文件路径
 def "OPENIM_RPC_CONVERSATION_LOG_DIR" "${LOG_STORAGE_LOCATION}/openim-rpc-conversation" # OpenIM openim-rpc-conversation 日志存储路径
 def "OPENIM_RPC_CONVERSATION_LOG_LEVEL" "info"                                          # OpenIM openim-rpc-conversation 日志级别
 def "OPENIM_RPC_CONVERSATION_LOG_MAX_SIZE" "100"                                        # OpenIM openim-rpc-conversation 日志最大大小（MB）
@@ -513,7 +511,7 @@ def "OPENIM_RPC_CONVERSATION_LOG_WITH_STACK" "${LOG_WITH_STACK}"
 ###################### OpenIM openim-rpc-friend ######################
 def "OPENIM_RPC_FRIEND_HOST" "127.0.0.1"
 def "OPENIM_RPC_FRIEND_BINARY" "${OPENIM_OUTPUT_HOSTBIN}/openim-rpc-friend" # OpenIM openim-rpc-friend 二进制文件路径
-def "OPENIM_RPC_FRIEND_CONFIG" ""${OPENIM_ROOT}"/config/"                   # OpenIM openim-rpc-friend 配置文件路径
+def "OPENIM_RPC_FRIEND_CONFIG" "${OPENIM_ROOT}/config/"                   # OpenIM openim-rpc-friend 配置文件路径
 def "OPENIM_RPC_FRIEND_LOG_DIR" "${LOG_STORAGE_LOCATION}/openim-rpc-friend" # OpenIM openim-rpc-friend 日志存储路径
 def "OPENIM_RPC_FRIEND_LOG_LEVEL" "info"                                    # OpenIM openim-rpc-friend 日志级别
 def "OPENIM_RPC_FRIEND_LOG_MAX_SIZE" "100"                                  # OpenIM openim-rpc-friend 日志最大大小（MB）
@@ -525,7 +523,7 @@ def "OPENIM_RPC_FRIEND_LOG_WITH_STACK" "${LOG_WITH_STACK}"                  # Op
 ###################### OpenIM openim-rpc-group ######################
 def "OPENIM_RPC_GROUP_HOST" "127.0.0.1"
 def "OPENIM_RPC_GROUP_BINARY" "${OPENIM_OUTPUT_HOSTBIN}/openim-rpc-group" # OpenIM openim-rpc-group 二进制文件路径
-def "OPENIM_RPC_GROUP_CONFIG" ""${OPENIM_ROOT}"/config/"                  # OpenIM openim-rpc-group 配置文件路径
+def "OPENIM_RPC_GROUP_CONFIG" "${OPENIM_ROOT}/config/"                  # OpenIM openim-rpc-group 配置文件路径
 def "OPENIM_RPC_GROUP_LOG_DIR" "${LOG_STORAGE_LOCATION}/openim-rpc-group" # OpenIM openim-rpc-group 日志存储路径
 def "OPENIM_RPC_GROUP_LOG_LEVEL" "info"                                   # OpenIM openim-rpc-group 日志级别
 def "OPENIM_RPC_GROUP_LOG_MAX_SIZE" "100"                                 # OpenIM openim-rpc-group 日志最大大小（MB）
@@ -537,7 +535,7 @@ def "OPENIM_RPC_GROUP_LOG_WITH_STACK" "${LOG_WITH_STACK}"                 # Open
 ###################### OpenIM openim-rpc-msg ######################
 def "OPENIM_RPC_MSG_HOST" "127.0.0.1"
 def "OPENIM_RPC_MSG_BINARY" "${OPENIM_OUTPUT_HOSTBIN}/openim-rpc-msg" # OpenIM openim-rpc-msg 二进制文件路径
-def "OPENIM_RPC_MSG_CONFIG" ""${OPENIM_ROOT}"/config/"                # OpenIM openim-rpc-msg 配置文件路径
+def "OPENIM_RPC_MSG_CONFIG" "${OPENIM_ROOT}/config/"                # OpenIM openim-rpc-msg 配置文件路径
 def "OPENIM_RPC_MSG_LOG_DIR" "${LOG_STORAGE_LOCATION}/openim-rpc-msg" # OpenIM openim-rpc-msg 日志存储路径
 def "OPENIM_RPC_MSG_LOG_LEVEL" "info"                                 # OpenIM openim-rpc-msg 日志级别
 def "OPENIM_RPC_MSG_LOG_MAX_SIZE" "100"                               # OpenIM openim-rpc-msg 日志最大大小（MB）
@@ -549,7 +547,7 @@ def "OPENIM_RPC_MSG_LOG_WITH_STACK" "${LOG_WITH_STACK}"               # OpenIM o
 ###################### OpenIM openim-rpc-third ######################
 def "OPENIM_RPC_THIRD_HOST" "127.0.0.1"
 def "OPENIM_RPC_THIRD_BINARY" "${OPENIM_OUTPUT_HOSTBIN}/openim-rpc-third" # OpenIM openim-rpc-third 二进制文件路径
-def "OPENIM_RPC_THIRD_CONFIG" ""${OPENIM_ROOT}"/config/"                  # OpenIM openim-rpc-third 配置文件路径
+def "OPENIM_RPC_THIRD_CONFIG" "${OPENIM_ROOT}/config/"                  # OpenIM openim-rpc-third 配置文件路径
 def "OPENIM_RPC_THIRD_LOG_DIR" "${LOG_STORAGE_LOCATION}/openim-rpc-third" # OpenIM openim-rpc-third 日志存储路径
 def "OPENIM_RPC_THIRD_LOG_LEVEL" "info"                                   # OpenIM openim-rpc-third 日志级别
 def "OPENIM_RPC_THIRD_LOG_MAX_SIZE" "100"                                 # OpenIM openim-rpc-third 日志最大大小（MB）
@@ -561,7 +559,7 @@ def "OPENIM_RPC_THIRD_LOG_WITH_STACK" "${LOG_WITH_STACK}"                 # Open
 ###################### OpenIM openim-rpc-user ######################
 def "OPENIM_RPC_USER_HOST" "127.0.0.1"
 def "OPENIM_RPC_USER_BINARY" "${OPENIM_OUTPUT_HOSTBIN}/openim-rpc-user" # OpenIM openim-rpc-user 二进制文件路径
-def "OPENIM_RPC_USER_CONFIG" ""${OPENIM_ROOT}"/config/"                 # OpenIM openim-rpc-user 配置文件路径
+def "OPENIM_RPC_USER_CONFIG" "${OPENIM_ROOT}/config/"                 # OpenIM openim-rpc-user 配置文件路径
 def "OPENIM_RPC_USER_LOG_DIR" "${LOG_STORAGE_LOCATION}/openim-rpc-user" # OpenIM openim-rpc-user 日志存储路径
 def "OPENIM_RPC_USER_LOG_LEVEL" "info"                                  # OpenIM openim-rpc-user 日志级别
 def "OPENIM_RPC_USER_LOG_MAX_SIZE" "100"                                # OpenIM openim-rpc-user 日志最大大小（MB）

scripts/install/install.sh

@@ -76,7 +76,7 @@ function openim::install::install_openim() {
   openim::log::info "check openim dependency"
   openim::common::sudo "cp -r ${OPENIM_ROOT}/config/* ${OPENIM_CONFIG_DIR}/"
   
-    ${OPENIM_ROOT}/scripts/genconfig.sh ${ENV_FILE} ${OPENIM_ROOT}/deployments/templates/openim.yaml > ${OPENIM_CONFIG_DIR}/config.yaml
+  ${OPENIM_ROOT}/scripts/genconfig.sh ${ENV_FILE} ${OPENIM_ROOT}/deployments/templates/config.yaml > ${OPENIM_CONFIG_DIR}/config.yaml
   ${OPENIM_ROOT}/scripts/genconfig.sh ${ENV_FILE} ${OPENIM_ROOT}/deployments/templates/prometheus.yml > ${OPENIM_CONFIG_DIR}/prometheus.yml
   
   openim::util::check_ports ${OPENIM_DEPENDENCY_PORT_LISTARIES[@]}

scripts/install/openim-man.sh

@@ -26,9 +26,9 @@
 #   ./openim-man.sh openim::man::status       - Check installation status
 #
 # Dependencies:
-#   - Assumes there's a common.sh in ""${OPENIM_ROOT}"/scripts/install/" 
+#   - Assumes there's a common.sh in "${OPENIM_ROOT}/scripts/install/"
 #     containing shared functions and variables.
-#   - Relies on the script ""${OPENIM_ROOT}"/scripts/update-generated-docs.sh" 
+#   - Relies on the script "${OPENIM_ROOT}/scripts/update-generated-docs.sh"
 #     to generate the man pages.
 #
 # Notes:
@@ -58,7 +58,7 @@ function openim::man::install() {
   pushd "${OPENIM_ROOT}" > /dev/null
   
   # Generate man pages for each component
-    ""${OPENIM_ROOT}"/scripts/update-generated-docs.sh"
+  "${OPENIM_ROOT}/scripts/update-generated-docs.sh"
   openim::common::sudo "cp docs/man/man1/* /usr/share/man/man1/"
   
   # Verify installation status

scripts/install/openim-msgtransfer.sh

@@ -12,6 +12,8 @@
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.
+# Use:
+# ./scripts/install/openim-msgtransfer.sh openim::msgtransfer::start
 
 # Common utilities, variables and checks for all build scripts.
 set -o errexit
@@ -64,12 +66,17 @@ function openim::msgtransfer::check() {
   PIDS=$(pgrep -f "${OPENIM_OUTPUT_HOSTBIN}/openim-msgtransfer")
   
   NUM_PROCESSES=$(echo "$PIDS" | wc -l)
-    # NUM_PROCESSES=$(($NUM_PROCESSES - 1))
   
   if [ "$NUM_PROCESSES" -eq "$OPENIM_MSGGATEWAY_NUM" ]; then
     openim::log::info "Found $OPENIM_MSGGATEWAY_NUM processes named $OPENIM_OUTPUT_HOSTBIN"
     for PID in $PIDS; do
+      if [[ "$OSTYPE" == "linux-gnu"* ]]; then
         ps -p $PID -o pid,cmd
+        elif [[ "$OSTYPE" == "darwin"* ]]; then
+        ps -p $PID -o pid,comm
+      else
+        openim::log::error "Unsupported OS type: $OSTYPE"
+      fi
     done
   else
     openim::log::error_exit "Expected $OPENIM_MSGGATEWAY_NUM openim msgtransfer processes, but found $NUM_PROCESSES msgtransfer processes."

scripts/install/openim-rpc.sh

@@ -123,6 +123,7 @@ function openim::rpc::start() {
     for ((i = 0; i < ${#OPENIM_RPC_SERVICE_LISTARIES[*]}; i++)); do
         # openim::util::stop_services_with_name ${OPENIM_RPC_SERVICE_LISTARIES
         openim::util::stop_services_on_ports ${OPENIM_RPC_PORT_LISTARIES[$i]}
+
         openim::log::info "OpenIM ${OPENIM_RPC_SERVICE_LISTARIES[$i]} config path: ${OPENIM_RPC_CONFIG}"
 
         # Get the service and Prometheus ports.
@@ -138,7 +139,7 @@ function openim::rpc::start() {
         done
     done
 
-    sleep 1
+    sleep 5
 
     openim::util::check_ports ${OPENIM_RPC_PORT_TARGETS[@]}
     # openim::util::check_ports ${OPENIM_RPC_PROM_PORT_TARGETS[@]}

scripts/install/openim-tools.sh

@@ -104,7 +104,6 @@ function openim::tools::start_service() {
     cmd="${cmd} --prometheus_port ${prometheus_port}"
   fi
   openim::log::status "Starting ${binary_name}..."
-  # Later, after discarding Docker, the Docker keyword is unreliable, and Kubepods is used
   ${cmd} | tee -a "${LOG_FILE}"
 }
 

scripts/install/test.sh

@@ -73,20 +73,22 @@ function openim::test::auth() {
 # Define a function to get a token for a specific user
 openim::test::get_token() {
 	local user_id="${1:-openIM123456}" # Default user ID if not provided
-  token_response=$(${CCURL} "${OperationID}" "${Header}" ${INSECURE_OPENIMAPI}/auth/user_token \
+	token_response=$(
-      -d'{"secret": "'"$SECRET"'","platformID": 1,"userID": "'$user_id'"}')
+		${CCURL} "${OperationID}" "${Header}" ${INSECURE_OPENIMAPI}/auth/user_token \
+		-d'{"secret": "'"$SECRET"'","platformID": 1,"userID": "'$user_id'"}'
+	)
 	token=$(echo $token_response | grep -Po 'token[" :]+\K[^"]+')
 	echo "$token"
 }
 
-
 Header="-HContent-Type: application/json"
 OperationID="-HoperationID: 1646445464564"
 Token="-Htoken: $(openim::test::get_token)"
 
 # Forces a user to log out from the specified platform by user ID.
 openim::test::force_logout() {
-  local request_body=$(cat <<EOF
+	local request_body=$(
+		cat <<EOF
 {
   "platformID": 2,
   "userID": "4950983283"
@@ -100,7 +102,6 @@ EOF
 	openim::test::check_error "$response"
 }
 
-
 #################################### User Module ####################################
 
 # Registers a new user with provided user ID, nickname, and face URL using the API.
@@ -111,7 +112,8 @@ openim::test::user_register() {
 	local face_url="${3:-https://github.com/cubxxw}"
 
 	# Create the request body using the provided or default values
-  local request_body=$(cat <<EOF
+	local request_body=$(
+		cat <<EOF
 {
   "secret": "${SECRET}",
   "users": [
@@ -123,7 +125,7 @@ openim::test::user_register() {
   ]
 }
 EOF
-)
+	)
 
 	echo "Request body for user registration: $request_body"
 
@@ -136,7 +138,8 @@ EOF
 
 # Checks if the provided list of user IDs exist in the system.
 openim::test::check_user_account() {
-  local request_body=$(cat <<EOF
+	local request_body=$(
+		cat <<EOF
 {
   "checkUserIDs": [
     "${1}",
@@ -146,7 +149,7 @@ openim::test::check_user_account() {
   ]
 }
 EOF
-)
+	)
 	echo "$request_body"
 
 	local response=$(${CCURL} "${Token}" "${OperationID}" "${Header}" "${INSECURE_OPENIMAPI}/user/account_check" -d "${request_body}")
@@ -156,7 +159,8 @@ EOF
 
 # Retrieves a list of users with pagination, limited to a specific number per page.
 openim::test::get_users() {
-  local request_body=$(cat <<EOF
+	local request_body=$(
+		cat <<EOF
 {
   "pagination": {
     "pageNumber": 1,
@@ -164,7 +168,7 @@ openim::test::get_users() {
   }
 }
 EOF
-)
+	)
 	echo "$request_body"
 
 	local response=$(${CCURL} "${Token}" "${OperationID}" "${Header}" "${INSECURE_OPENIMAPI}/user/get_users" -d "${request_body}")
@@ -174,7 +178,8 @@ EOF
 
 # Obtains detailed information for a list of user IDs.
 openim::test::get_users_info() {
-  local request_body=$(cat <<EOF
+	local request_body=$(
+		cat <<EOF
 {
   "userIDs": [
     "${1}",
@@ -182,7 +187,7 @@ openim::test::get_users_info() {
   ]
 }
 EOF
-)
+	)
 	echo "$request_body"
 
 	local response=$(${CCURL} "${Token}" "${OperationID}" "${Header}" "${INSECURE_OPENIMAPI}/user/get_users_info" -d "${request_body}")
@@ -192,7 +197,8 @@ EOF
 
 # Retrieves the online status for a list of user IDs.
 openim::test::get_users_online_status() {
-  local request_body=$(cat <<EOF
+	local request_body=$(
+		cat <<EOF
 {
   "userIDs": [
     "${TEST_USER_ID}",
@@ -202,7 +208,7 @@ openim::test::get_users_online_status() {
   ]
 }
 EOF
-)
+	)
 	echo "$request_body"
 
 	local response=$(${CCURL} "${Token}" "${OperationID}" "${Header}" "${INSECURE_OPENIMAPI}/user/get_users_online_status" -d "${request_body}")
@@ -212,7 +218,8 @@ EOF
 
 # Updates the information for a user, such as nickname and face URL.
 openim::test::update_user_info() {
-  local request_body=$(cat <<EOF
+	local request_body=$(
+		cat <<EOF
 {
   "userInfo": {
     "userID": "${TEST_USER_ID}",
@@ -221,7 +228,7 @@ openim::test::update_user_info() {
   }
 }
 EOF
-)
+	)
 	echo "$request_body"
 
 	local response=$(${CCURL} "${Token}" "${OperationID}" "${Header}" "${INSECURE_OPENIMAPI}/user/update_user_info" -d "${request_body}")
@@ -231,12 +238,13 @@ EOF
 
 # Gets the online status for users that a particular user has subscribed to.
 openim::test::get_subscribe_users_status() {
-  local request_body=$(cat <<EOF
+	local request_body=$(
+		cat <<EOF
 {
   "userID": "${TEST_USER_ID}"
 }
 EOF
-)
+	)
 	echo "$request_body"
 
 	local response=$(${CCURL} "${Token}" "${OperationID}" "${Header}" "${INSECURE_OPENIMAPI}/user/get_subscribe_users_status" -d "${request_body}")
@@ -246,7 +254,8 @@ EOF
 
 # Subscribes to the online status of a list of users for a particular user ID.
 openim::test::subscribe_users_status() {
-  local request_body=$(cat <<EOF
+	local request_body=$(
+		cat <<EOF
 {
   "userID": "9168684795",
   "userIDs": [
@@ -257,7 +266,7 @@ openim::test::subscribe_users_status() {
   "genre": 1
 }
 EOF
-)
+	)
 	echo "$request_body"
 
 	local response=$(${CCURL} "${Token}" "${OperationID}" "${Header}" "${INSECURE_OPENIMAPI}/user/subscribe_users_status" -d "${request_body}")
@@ -267,13 +276,14 @@ EOF
 
 # Sets the global message receiving option for a user, determining their messaging preferences.
 openim::test::set_global_msg_recv_opt() {
-  local request_body=$(cat <<EOF
+	local request_body=$(
+		cat <<EOF
 {
   "userID": "${TEST_USER_ID}",
   "globalRecvMsgOpt": 0
 }
 EOF
-)
+	)
 	echo "$request_body"
 
 	local response=$(${CCURL} "${Token}" "${OperationID}" "${Header}" "${INSECURE_OPENIMAPI}/user/set_global_msg_recv_opt" -d "${request_body}")
@@ -322,13 +332,14 @@ function openim::test::user() {
 
 # Checks if two users are friends.
 openim::test::is_friend() {
-  local request_body=$(cat <<EOF
+	local request_body=$(
+		cat <<EOF
 {
   "userID1": "${1}",
   "userID2": "${2}"
 }
 EOF
-)
+	)
 	echo "$request_body"
 
 	local response=$(${CCURL} "${Token}" "${OperationID}" "${Header}" "${INSECURE_OPENIMAPI}/friend/is_friend" -d "${request_body}")
@@ -338,13 +349,14 @@ EOF
 
 # Deletes a friend for a user.
 openim::test::delete_friend() {
-  local request_body=$(cat <<EOF
+	local request_body=$(
+		cat <<EOF
 {
   "ownerUserID":"${1}",
   "friendUserID":"${2}"
 }
 EOF
-)
+	)
 	echo "$request_body"
 
 	local response=$(${CCURL} "${Token}" "${OperationID}" "${Header}" "${INSECURE_OPENIMAPI}/friend/delete_friend" -d "${request_body}")
@@ -354,7 +366,8 @@ EOF
 
 # Gets the friend application list for a user.
 openim::test::get_friend_apply_list() {
-  local request_body=$(cat <<EOF
+	local request_body=$(
+		cat <<EOF
 {
   "userID": "${MANAGER_USERID_1}",
   "pagination": {
@@ -363,7 +376,7 @@ openim::test::get_friend_apply_list() {
   }
 }
 EOF
-)
+	)
 	echo "$request_body"
 
 	local response=$(${CCURL} "${Token}" "${OperationID}" "${Header}" "${INSECURE_OPENIMAPI}/friend/get_friend_apply_list" -d "${request_body}")
@@ -373,7 +386,8 @@ EOF
 
 # Gets the friend list for a user.
 openim::test::get_friend_list() {
-  local request_body=$(cat <<EOF
+	local request_body=$(
+		cat <<EOF
 {
   "userID": "${1}",
   "pagination": {
@@ -382,7 +396,7 @@ openim::test::get_friend_list() {
   }
 }
 EOF
-)
+	)
 	echo "$request_body"
 
 	local response=$(${CCURL} "${Token}" "${OperationID}" "${Header}" "${INSECURE_OPENIMAPI}/friend/get_friend_list" -d "${request_body}")
@@ -392,14 +406,15 @@ EOF
 
 # Sets a remark for a friend.
 openim::test::set_friend_remark() {
-  local request_body=$(cat <<EOF
+	local request_body=$(
+		cat <<EOF
 {
   "ownerUserID": "${1}",
   "friendUserID": "${2}",
   "remark": "remark"
 }
 EOF
-)
+	)
 	echo "$request_body"
 
 	local response=$(${CCURL} "${Token}" "${OperationID}" "${Header}" "${INSECURE_OPENIMAPI}/friend/set_friend_remark" -d "${request_body}")
@@ -409,7 +424,8 @@ EOF
 
 # Adds a friend request.
 openim::test::add_friend() {
-  local request_body=$(cat <<EOF
+	local request_body=$(
+		cat <<EOF
 {
   "fromUserID": "${1}",
   "toUserID": "${2}",
@@ -417,7 +433,7 @@ openim::test::add_friend() {
   "ex": ""
 }
 EOF
-)
+	)
 	echo "$request_body"
 
 	local response=$(${CCURL} "${Token}" "${OperationID}" "${Header}" "${INSECURE_OPENIMAPI}/friend/add_friend" -d "${request_body}")
@@ -429,13 +445,14 @@ EOF
 openim::test::import_friend() {
 	local friend_ids=$(printf ', "%s"' "${@:2}")
 	friend_ids=${friend_ids:2}
-  local request_body=$(cat <<EOF
+	local request_body=$(
+		cat <<EOF
 {
   "ownerUserID": "${1}",
   "friendUserIDs": [${friend_ids}]
 }
 EOF
-)
+	)
 	echo "$request_body"
 
 	local response=$(${CCURL} "${Token}" "${OperationID}" "${Header}" "${INSECURE_OPENIMAPI}/friend/import_friend" -d "${request_body}")
@@ -443,10 +460,10 @@ EOF
 	openim::test::check_error "$response"
 }
 
-
 # Responds to a friend request.
 openim::test::add_friend_response() {
-  local request_body=$(cat <<EOF
+	local request_body=$(
+		cat <<EOF
 {
   "fromUserID": "${1}",
   "toUserID": "${2}",
@@ -454,7 +471,7 @@ openim::test::add_friend_response() {
   "handleMsg": "agree"
 }
 EOF
-)
+	)
 	echo "$request_body"
 
 	local response=$(${CCURL} "${Token}" "${OperationID}" "${Header}" "${INSECURE_OPENIMAPI}/friend/add_friend_response" -d "${request_body}")
@@ -464,7 +481,8 @@ EOF
 
 # Retrieves the friend application list that the user has applied for.
 openim::test::get_self_friend_apply_list() {
-  local request_body=$(cat <<EOF
+	local request_body=$(
+		cat <<EOF
 {
   "userID": "${1}",
   "pagination": {
@@ -473,7 +491,7 @@ openim::test::get_self_friend_apply_list() {
   }
 }
 EOF
-)
+	)
 	echo "$request_body"
 
 	local response=$(${CCURL} "${Token}" "${OperationID}" "${Header}" "${INSECURE_OPENIMAPI}/friend/get_self_friend_apply_list" -d "${request_body}")
@@ -483,13 +501,14 @@ EOF
 
 # Adds a user to the blacklist.
 openim::test::add_black() {
-  local request_body=$(cat <<EOF
+	local request_body=$(
+		cat <<EOF
 {
   "ownerUserID": "${1}",
   "blackUserID": "${2}"
 }
 EOF
-)
+	)
 	echo "$request_body"
 
 	local response=$(${CCURL} "${Token}" "${OperationID}" "${Header}" "${INSECURE_OPENIMAPI}/friend/add_black" -d "${request_body}")
@@ -499,13 +518,14 @@ EOF
 
 # Removes a user from the blacklist.
 openim::test::remove_black() {
-  local request_body=$(cat <<EOF
+	local request_body=$(
+		cat <<EOF
 {
   "ownerUserID": "${1}",
   "blackUserID": "${2}"
 }
 EOF
-)
+	)
 	echo "$request_body"
 
 	local response=$(${CCURL} "${Token}" "${OperationID}" "${Header}" "${INSECURE_OPENIMAPI}/friend/remove_black" -d "${request_body}")
@@ -515,7 +535,8 @@ EOF
 
 # Retrieves the blacklist for a user.
 openim::test::get_black_list() {
-  local request_body=$(cat <<EOF
+	local request_body=$(
+		cat <<EOF
 {
   "userID": "${1}",
   "pagination": {
@@ -524,7 +545,7 @@ openim::test::get_black_list() {
   }
 }
 EOF
-)
+	)
 	echo "$request_body"
 
 	local response=$(${CCURL} "${Token}" "${OperationID}" "${Header}" "${INSECURE_OPENIMAPI}/friend/get_black_list" -d "${request_body}")
@@ -544,16 +565,20 @@ openim::test::update_pin_status() {
 	for friendUserID in "$@"; do
 		friendUserIDsArray+=("\"${friendUserID}\"")
 	done
-  local friendUserIDs=$(IFS=,; echo "${friendUserIDsArray[*]}")
+	local friendUserIDs=$(
+		IFS=,
+		echo "${friendUserIDsArray[*]}"
+	)
 
-  local request_body=$(cat <<EOF
+	local request_body=$(
+		cat <<EOF
 {
   "ownerUserID": "${ownerUserID}",
   "friendUserIDs": [${friendUserIDs}],
   "isPinned": ${isPinned}
 }
 EOF
-)
+	)
 	echo "Requesting to update pin status: $request_body"
 
 	local response=$(${CCURL} "${Token}" "${OperationID}" "${Header}" "${INSECURE_OPENIMAPI}/friend/update_pin_status" -d "${request_body}")
@@ -561,7 +586,6 @@ EOF
 	openim::test::check_error "$response"
 }
 
-
 # [openim::test::friend function description]
 # The `openim::test::friend` function serves as a test suite for friend-related operations.
 # It sequentially invokes all friend-related test functions to ensure the API's friend operations are functioning correctly.
@@ -587,7 +611,7 @@ function openim::test::friend() {
 	local friend_token="-Htoken: $(openim::test::get_token "${FRIEND_USER_ID}")"
 	# 3. Respond to a friend request.
 	# TODO：
-#   openim::test::add_friend_response "${FRIEND_USER_ID}" "${TEST_USER_ID}"
+	#   openim::test::add_friend_response "${FRIEND_USER_ID}" "${TEST_USER_ID}"
 
 	Token=$original_token
 	# 4. Retrieve the friend list of the test user.
@@ -595,7 +619,7 @@ function openim::test::friend() {
 
 	# 5. Set a remark for a friend.
 	# TODO：
-#   openim::test::set_friend_remark "${TEST_USER_ID}" "${FRIEND_USER_ID}"
+	#   openim::test::set_friend_remark "${TEST_USER_ID}" "${FRIEND_USER_ID}"
 
 	# 6. Retrieve the friend application list for the test user.
 	openim::test::get_friend_apply_list "${TEST_USER_ID}" 1 100
@@ -605,7 +629,7 @@ function openim::test::friend() {
 
 	# 8. Delete a friend.
 	# TODO：
-#   openim::test::delete_friend "${TEST_USER_ID}" "${FRIEND_USER_ID}"
+	#   openim::test::delete_friend "${TEST_USER_ID}" "${FRIEND_USER_ID}"
 
 	# 9. Add a user to the blacklist.
 	openim::test::add_black "${TEST_USER_ID}" "${BLACK_USER_ID}"
@@ -618,25 +642,25 @@ function openim::test::friend() {
 
 	# 12. Import friends for the user (Optional).
 	# TODO：
-#   openim::test::import_friend "${TEST_USER_ID}" "11111114" "11111115"
+	#   openim::test::import_friend "${TEST_USER_ID}" "11111114" "11111115"
 
 	# 13. pin Friend
 	# Add this call to your test suite where appropriate
 	# TODO：
-#  openim::test::update_pin_status "${TEST_USER_ID}" true "${FRIEND_USER_ID}"
+	#  openim::test::update_pin_status "${TEST_USER_ID}" true "${FRIEND_USER_ID}"
-#
+	#
-#  openim::test::update_pin_status "${TEST_USER_ID}" false "${FRIEND_USER_ID}"
+	#  openim::test::update_pin_status "${TEST_USER_ID}" false "${FRIEND_USER_ID}"
 
 	# Log the completion of the friend test suite.
 	openim::log::success "Friend test suite completed successfully."
 }
 
-
 #################################### Group Module ####################################
 
 # Creates a new group.
 openim::test::create_group() {
-  local request_body=$(cat <<EOF
+	local request_body=$(
+		cat <<EOF
 {
   "memberUserIDs": [
     "${1}"
@@ -659,7 +683,7 @@ openim::test::create_group() {
   }
 }
 EOF
-)
+	)
 	echo "$request_body"
 
 	local response=$(${CCURL} "${Token}" "${OperationID}" "${Header}" "${INSECURE_OPENIMAPI}/group/create_group" -d "${request_body}")
@@ -669,7 +693,8 @@ EOF
 
 # Invites a user to join a group.
 openim::test::invite_user_to_group() {
-  local request_body=$(cat <<EOF
+	local request_body=$(
+		cat <<EOF
 {
   "groupID": "${1}",
   "invitedUserIDs": [
@@ -679,7 +704,7 @@ openim::test::invite_user_to_group() {
   "reason": "your reason"
 }
 EOF
-)
+	)
 	echo "$request_body"
 
 	local response=$(${CCURL} "${Token}" "${OperationID}" "${Header}" "${INSECURE_OPENIMAPI}/group/invite_user_to_group" -d "${request_body}")
@@ -689,14 +714,15 @@ EOF
 
 # Transfers the ownership of a group to another user.
 openim::test::transfer_group() {
-  local request_body=$(cat <<EOF
+	local request_body=$(
+		cat <<EOF
 {
   "groupID":"${1}",
   "oldOwnerUserID":"${2}",
   "newOwnerUserID": "${3}"
 }
 EOF
-)
+	)
 	echo "$request_body"
 
 	local response=$(${CCURL} "${Token}" "${OperationID}" "${Header}" "${INSECURE_OPENIMAPI}/group/transfer_group" -d "${request_body}")
@@ -706,12 +732,13 @@ EOF
 
 # Retrieves information about multiple groups.
 openim::test::get_groups_info() {
-  local request_body=$(cat <<EOF
+	local request_body=$(
+		cat <<EOF
 {
   "groupIDs": ["${1}", "${2}"]
 }
 EOF
-)
+	)
 	echo "$request_body"
 
 	local response=$(${CCURL} "${Token}" "${OperationID}" "${Header}" "${INSECURE_OPENIMAPI}/group/get_groups_info" -d "${request_body}")
@@ -721,7 +748,8 @@ EOF
 
 # Removes a user from a group.
 openim::test::kick_group() {
-  local request_body=$(cat <<EOF
+	local request_body=$(
+		cat <<EOF
 {
   "groupID": "${1}",
   "kickedUserIDs": [
@@ -730,7 +758,7 @@ openim::test::kick_group() {
   "reason": "Bye!"
 }
 EOF
-)
+	)
 	echo "$request_body"
 
 	local response=$(${CCURL} "${Token}" "${OperationID}" "${Header}" "${INSECURE_OPENIMAPI}/group/kick_group" -d "${request_body}")
@@ -740,13 +768,14 @@ EOF
 
 # Retrieves information about group members.
 openim::test::get_group_members_info() {
-  local request_body=$(cat <<EOF
+	local request_body=$(
+		cat <<EOF
 {
   "groupID": "${1}",
   "userIDs": ["${2}"]
 }
 EOF
-)
+	)
 	echo "$request_body"
 
 	local response=$(${CCURL} "${Token}" "${OperationID}" "${Header}" "${INSECURE_OPENIMAPI}/group/get_group_members_info" -d "${request_body}")
@@ -756,7 +785,8 @@ EOF
 
 # Retrieves a list of group members.
 openim::test::get_group_member_list() {
-  local request_body=$(cat <<EOF
+	local request_body=$(
+		cat <<EOF
 {
   "groupID": "${1}",
   "pagination": {
@@ -765,7 +795,7 @@ openim::test::get_group_member_list() {
   }
 }
 EOF
-)
+	)
 	echo "$request_body"
 
 	local response=$(${CCURL} "${Token}" "${OperationID}" "${Header}" "${INSECURE_OPENIMAPI}/group/get_group_member_list" -d "${request_body}")
@@ -775,7 +805,8 @@ EOF
 
 # Retrieves a list of groups that a user has joined.
 openim::test::get_joined_group_list() {
-  local request_body=$(cat <<EOF
+	local request_body=$(
+		cat <<EOF
 {
   "fromUserID": "${1}",
   "pagination": {
@@ -784,7 +815,7 @@ openim::test::get_joined_group_list() {
   }
 }
 EOF
-)
+	)
 	echo "$request_body"
 
 	local response=$(${CCURL} "${Token}" "${OperationID}" "${Header}" "${INSECURE_OPENIMAPI}/group/get_joined_group_list" -d "${request_body}")
@@ -792,10 +823,10 @@ EOF
 	openim::test::check_error "$response"
 }
 
-
 # Sets group member information.
 openim::test::set_group_member_info() {
-  local request_body=$(cat <<EOF
+	local request_body=$(
+		cat <<EOF
 {
   "members": [
     {
@@ -809,7 +840,7 @@ openim::test::set_group_member_info() {
   ]
 }
 EOF
-)
+	)
 	echo "$request_body"
 
 	local response=$(${CCURL} "${Token}" "${OperationID}" "${Header}" "${INSECURE_OPENIMAPI}/group/set_group_member_info" -d "${request_body}")
@@ -819,12 +850,13 @@ EOF
 
 # Mutes a group.
 openim::test::mute_group() {
-  local request_body=$(cat <<EOF
+	local request_body=$(
+		cat <<EOF
 {
   "groupID": "${1}"
 }
 EOF
-)
+	)
 	echo "$request_body"
 
 	local response=$(${CCURL} "${Token}" "${OperationID}" "${Header}" "${INSECURE_OPENIMAPI}/group/mute_group" -d "${request_body}")
@@ -834,12 +866,13 @@ EOF
 
 # Cancels the muting of a group.
 openim::test::cancel_mute_group() {
-  local request_body=$(cat <<EOF
+	local request_body=$(
+		cat <<EOF
 {
   "groupID": "${1}"
 }
 EOF
-)
+	)
 	echo "$request_body"
 
 	local response=$(${CCURL} "${Token}" "${OperationID}" "${Header}" "${INSECURE_OPENIMAPI}/group/cancel_mute_group" -d "${request_body}")
@@ -849,12 +882,13 @@ EOF
 
 # Dismisses a group.
 openim::test::dismiss_group() {
-  local request_body=$(cat <<EOF
+	local request_body=$(
+		cat <<EOF
 {
   "groupID":"${1}"
 }
 EOF
-)
+	)
 	echo "$request_body"
 
 	local response=$(${CCURL} "${Token}" "${OperationID}" "${Header}" "${INSECURE_OPENIMAPI}/group/dismiss_group" -d "${request_body}")
@@ -864,13 +898,14 @@ EOF
 
 # Cancels muting a group member.
 openim::test::cancel_mute_group_member() {
-  local request_body=$(cat <<EOF
+	local request_body=$(
+		cat <<EOF
 {
   "groupID": "${1}",
   "userID": "${2}"
 }
 EOF
-)
+	)
 	echo "$request_body"
 
 	local response=$(${CCURL} "${Token}" "${OperationID}" "${Header}" "${INSECURE_OPENIMAPI}/group/cancel_mute_group_member" -d "${request_body}")
@@ -880,7 +915,8 @@ EOF
 
 # Allows a user to join a group.
 openim::test::join_group() {
-  local request_body=$(cat <<EOF
+	local request_body=$(
+		cat <<EOF
 {
  "groupID": "${1}",
  "reqMessage": "req msg join group",
@@ -888,7 +924,7 @@ openim::test::join_group() {
  "inviterUserID": "${2}"
 }
 EOF
-)
+	)
 	echo "$request_body"
 
 	local response=$(${CCURL} "${Token}" "${OperationID}" "${Header}" "${INSECURE_OPENIMAPI}/group/join_group" -d "${request_body}")
@@ -898,7 +934,8 @@ EOF
 
 # Sets group information.
 openim::test::set_group_info() {
-  local request_body=$(cat <<EOF
+	local request_body=$(
+		cat <<EOF
 {
   "groupInfoForSet": {
     "groupID": "${1}",
@@ -913,7 +950,7 @@ openim::test::set_group_info() {
   }
 }
 EOF
-)
+	)
 	echo "$request_body"
 
 	local response=$(${CCURL} "${Token}" "${OperationID}" "${Header}" "${INSECURE_OPENIMAPI}/group/set_group_info" -d "${request_body}")
@@ -921,16 +958,16 @@ EOF
 	openim::test::check_error "$response"
 }
 
-
 # Allows a user to quit a group.
 openim::test::quit_group() {
-  local request_body=$(cat <<EOF
+	local request_body=$(
+		cat <<EOF
 {
   "groupID": "${1}",
   "userID": "${2}"
 }
 EOF
-)
+	)
 	echo "$request_body"
 
 	local response=$(${CCURL} "${Token}" "${OperationID}" "${Header}" "${INSECURE_OPENIMAPI}/group/quit_group" -d "${request_body}")
@@ -940,7 +977,8 @@ EOF
 
 # Retrieves the list of group applications received by the user.
 openim::test::get_recv_group_applicationList() {
-  local request_body=$(cat <<EOF
+	local request_body=$(
+		cat <<EOF
 {
   "fromUserID": "${1}",
   "pagination": {
@@ -949,7 +987,7 @@ openim::test::get_recv_group_applicationList() {
   }
 }
 EOF
-)
+	)
 	echo "$request_body"
 
 	local response=$(${CCURL} "${Token}" "${OperationID}" "${Header}" "${INSECURE_OPENIMAPI}/group/get_recv_group_applicationList" -d "${request_body}")
@@ -959,7 +997,8 @@ EOF
 
 # Responds to a group application.
 openim::test::group_application_response() {
-  local request_body=$(cat <<EOF
+	local request_body=$(
+		cat <<EOF
 {
   "groupID": "${1}",
   "fromUserID": "${2}",
@@ -967,7 +1006,7 @@ openim::test::group_application_response() {
   "handleResult": 1
 }
 EOF
-)
+	)
 	echo "$request_body"
 
 	local response=$(${CCURL} "${Token}" "${OperationID}" "${Header}" "${INSECURE_OPENIMAPI}/group/group_application_response" -d "${request_body}")
@@ -977,7 +1016,8 @@ EOF
 
 # Retrieves the list of group applications made by the user.
 openim::test::get_user_req_group_applicationList() {
-  local request_body=$(cat <<EOF
+	local request_body=$(
+		cat <<EOF
 {
   "userID": "${1}",
   "pagination": {
@@ -986,7 +1026,7 @@ openim::test::get_user_req_group_applicationList() {
   }
 }
 EOF
-)
+	)
 	echo "$request_body"
 
 	local response=$(${CCURL} "${Token}" "${OperationID}" "${Header}" "${INSECURE_OPENIMAPI}/group/get_user_req_group_applicationList" -d "${request_body}")
@@ -996,14 +1036,15 @@ EOF
 
 # Mutes a group member for a specified duration.
 openim::test::mute_group_member() {
-  local request_body=$(cat <<EOF
+	local request_body=$(
+		cat <<EOF
 {
   "groupID": "${1}",
   "userID": "${2}",
   "mutedSeconds": ${3}
 }
 EOF
-)
+	)
 	echo "$request_body"
 
 	local response=$(${CCURL} "${Token}" "${OperationID}" "${Header}" "${INSECURE_OPENIMAPI}/group/mute_group_member" -d "${request_body}")
@@ -1013,7 +1054,8 @@ EOF
 
 # Retrieves a list of group applications from specific users.
 openim::test::get_group_users_req_application_list() {
-  local request_body=$(cat <<EOF
+	local request_body=$(
+		cat <<EOF
 {
   "groupID": "${1}",
   "userIDs": [
@@ -1021,7 +1063,7 @@ openim::test::get_group_users_req_application_list() {
   ]
 }
 EOF
-)
+	)
 	echo "$request_body"
 
 	local response=$(${CCURL} "${Token}" "${OperationID}" "${Header}" "${INSECURE_OPENIMAPI}/group/get_group_users_req_application_list" -d "${request_body}")
@@ -1089,7 +1131,7 @@ function openim::test::group() {
 
 	# 13. Join group.
 	# TODO:
-#   openim::test::join_group "$GROUP_ID2" "$OTHER_USER2_ID"
+	#   openim::test::join_group "$GROUP_ID2" "$OTHER_USER2_ID"
 
 	# 14. Set group info.
 	openim::test::set_group_info "$GROUP_ID2"
@@ -1102,7 +1144,7 @@ function openim::test::group() {
 
 	# 17. Group application response.
 	# TODO:
-#   openim::test::group_application_response "$GROUP_ID2" "$OTHER_USER2_ID"
+	#   openim::test::group_application_response "$GROUP_ID2" "$OTHER_USER2_ID"
 
 	# 18. Get user requested group application list.
 	openim::test::get_user_req_group_applicationList "$USER_ID" 1 100
@@ -1121,11 +1163,13 @@ function openim::test::group() {
 
 # Define a function to register a user
 openim::register_user() {
-  user_register_response=$(${CCURL} "${Header}" ${INSECURE_OPENIMAPI}/user/user_register \
+	user_register_response=$(
+		${CCURL} "${Header}" ${INSECURE_OPENIMAPI}/user/user_register \
 		-d'{
-      "secret": "openIM123",
+"secret": "openIM123",
-      "users": [{"userID": "11111112","nickname": "yourNickname","faceURL": "yourFaceURL"}]
+"users": [{"userID": "11111112","nickname": "yourNickname","faceURL": "yourFaceURL"}]
-    }')
+}'
+	)
 
 	echo "$user_register_response"
 }
@@ -1133,10 +1177,12 @@ openim::register_user() {
 # Define a function to check the account
 openim::test::check_account() {
 	local token=$1
-  account_check_response=$(${CCURL} "${Header}" -H"operationID: 1646445464564" -H"token: ${token}" ${INSECURE_OPENIMAPI}/user/account_check \
+	account_check_response=$(
+		${CCURL} "${Header}" -H"operationID: 1646445464564" -H"token: ${token}" ${INSECURE_OPENIMAPI}/user/account_check \
 		-d'{
-          "checkUserIDs": ["11111111","11111112"]
+"checkUserIDs": ["11111111","11111112"]
-        }')
+}'
+	)
 
 	echo "$account_check_response"
 }
@@ -1179,7 +1225,8 @@ openim::test::send_msg() {
 	local recvID="${2}"
 	local groupID="${3}"
 
-  local request_body=$(cat <<EOF
+	local request_body=$(
+		cat <<EOF
 {
   "sendID": "${sendID}",
   "recvID": "${recvID}",
@@ -1204,7 +1251,7 @@ openim::test::send_msg() {
   }
 }
 EOF
-)
+	)
 	echo "$request_body"
 
 	local response=$(${CCURL} "${Token}" "${OperationID}" "${Header}" "${INSECURE_OPENIMAPI}/msg/send_msg" -d "${request_body}")
@@ -1223,7 +1270,8 @@ openim::test::search_msg() {
 	local showNumber="${7}"
 
 	# Construct the request body
-  local request_body=$(cat <<EOF
+	local request_body=$(
+		cat <<EOF
 {
   "sendID": "${sendID}",
   "recvID": "${recvID}",
@@ -1236,7 +1284,7 @@ openim::test::search_msg() {
   }
 }
 EOF
-)
+	)
 	echo "$request_body"
 
 	# Send the request
@@ -1256,7 +1304,8 @@ openim::test::pull_msg_by_seq() {
 	local order="${6}" # Assuming 0 for ascending, 1 for descending
 
 	# Construct the request body
-  local request_body=$(cat <<EOF
+	local request_body=$(
+		cat <<EOF
 {
   "userID": "${userID}",
   "seqRanges": [
@@ -1270,7 +1319,7 @@ openim::test::pull_msg_by_seq() {
   "order": ${order}
 }
 EOF
-)
+	)
 	echo "$request_body"
 
 	# Send the request
@@ -1286,14 +1335,15 @@ openim::test::revoke_msg() {
 	local conversationID="${2}"
 	local seq="${3}"
 
-  local request_body=$(cat <<EOF
+	local request_body=$(
+		cat <<EOF
 {
   "userID": "${userID}",
   "conversationID": "${conversationID}",
   "seq": ${seq}
 }
 EOF
-)
+	)
 	echo "$request_body"
 
 	local response=$(${CCURL} "${Token}" "${OperationID}" "${Header}" "${INSECURE_OPENIMAPI}/msg/revoke_msg" -d "${request_body}")
@@ -1301,17 +1351,17 @@ EOF
 	openim::test::check_error "$response"
 }
 
-
 # Clears all messages for a user.
 openim::test::user_clear_all_msg() {
 	local userID="${1}"
 
-  local request_body=$(cat <<EOF
+	local request_body=$(
+		cat <<EOF
 {
   "userID": "${userID}"
 }
 EOF
-)
+	)
 	echo "$request_body"
 
 	local response=$(${CCURL} "${Token}" "${OperationID}" "${Header}" "${INSECURE_OPENIMAPI}/msg/user_clear_all_msg" -d "${request_body}")
@@ -1322,8 +1372,7 @@ EOF
 # [openim::test::msg function description]
 # The `openim::test::msg` function serves as a test suite for message-related operations.
 # It sequentially invokes all message-related test functions to ensure the API's message operations are functioning correctly.
-function openim::test::msg()
+function openim::test::msg() {
-{
 	local SEND_USER_ID="${MANAGER_USERID_1}" # This should be the sender's userID
 	local GROUP_ID=""                        # GroupID if it's a group message
 	local USER_ID="$RANDOM"
@@ -1352,7 +1401,6 @@ function openim::test::msg()
 	local ORDER=0 # Assuming 0 for ascending order
 	openim::test::pull_msg_by_seq "${RECV_USER_ID}" "${CONVERSATION_ID}" "${BEGIN_SEQ}" "${END_SEQ}" "${NUM}" "${ORDER}"
 
-
 	# Assuming message sending was successful and returned a sequence number.
 	local SEQ_NUMBER=1 # This should be the actual sequence number of the message sent.
 
@@ -1375,7 +1423,6 @@ openim::test::man() {
 	openim::log::info "TODO: openim test man"
 }
 
-
 #################################### Build Module ####################################
 
 # Function: openim::test::smoke
@@ -1416,6 +1463,6 @@ openim::test::test() {
 # Main execution logic: This conditional block checks if the script's arguments match any known
 # test function patterns and, if so, evaluates the function call. This allows for specific test
 # functions to be triggered based on the passed arguments.
-if [[ "$*" =~ openim::test:: ]];then
+if [[ "$*" =~ openim::test:: ]]; then
 	eval $*
 fi

scripts/lib/chat.sh

@@ -27,7 +27,7 @@ openim::chat::validate() {
   # validate if in path
   command -v chat >/dev/null || {
     openim::log::usage "chat must be in your PATH"
-    openim::log::info "You can use 'hack/install-chat.sh' to install a copy in third_party/."
+    openim::log::info "You can use 'scripts/install-chat.sh' to install a copy in third_party/."
     exit 1
   }
   
@@ -61,7 +61,7 @@ openim::chat::validate() {
     version=$(chat --version | grep Version | head -n 1 | cut -d " " -f 3)
     if [[ $(openim::chat::version "${CHAT_VERSION}") -gt $(openim::chat::version "${version}") ]]; then
       openim::log::usage "chat version ${CHAT_VERSION} or greater required."
-    openim::log::info "You can use 'hack/install-chat.sh' to install a copy in third_party/."
+      openim::log::info "You can use 'scripts/install-chat.sh' to install a copy in third_party/."
       exit 1
     fi
   fi
@@ -148,7 +148,7 @@ openim::chat::install() {
     os=$(openim::util::host_os)
     arch=$(openim::util::host_arch)
     
-    cd ""${OPENIM_ROOT}"/third_party" || return 1
+    cd "${OPENIM_ROOT}/third_party" || return 1
     if [[ $(readlink chat) == chat-v${CHAT_VERSION}-${os}-* ]]; then
       openim::log::info "chat v${CHAT_VERSION} already installed. To use:"
       openim::log::info "export PATH=\"$(pwd)/chat:\${PATH}\""

scripts/lib/golang.sh

@@ -89,7 +89,7 @@ readonly OPENIM_SERVER_TARGETS
 readonly OPENIM_SERVER_BINARIES=("${OPENIM_SERVER_TARGETS[@]##*/}")
 
 # TODO: Label
-START_SCRIPTS_PATH=""${OPENIM_ROOT}"/scripts/install/"
+START_SCRIPTS_PATH="${OPENIM_ROOT}/scripts/install/"
 openim::golang::start_script_list() {
   local targets=(
       openim-api.sh
@@ -261,7 +261,18 @@ openim::golang::setup_platforms
 # The set of client targets that we are building for all platforms
 # If you update this list, please also update build/BUILD.
 readonly OPENIM_CLIENT_TARGETS=(
+    changelog
+    component
+    conversion-msg
+    conversion-mysql
+    formitychecker
     imctl
+    infra
+    ncpu
+    openim-web
+    up35
+    versionchecker
+    yamlfmt
 )
 readonly OPENIM_CLIENT_BINARIES=("${OPENIM_CLIENT_TARGETS[@]##*/}")
 

scripts/lib/init.sh

@@ -25,7 +25,7 @@ unset CDPATH
 
 # Until all GOPATH references are removed from all build scripts as well,
 # explicitly disable module mode to avoid picking up user-set GO111MODULE preferences.
-# As individual scripts (like hack/update-vendor.sh) make use of go modules,
+# As individual scripts (like scripts/update-vendor.sh) make use of go modules,
 # they can explicitly set GO111MODULE=on
 export GO111MODULE=on
 
@@ -33,7 +33,7 @@ export GO111MODULE=on
 OPENIM_ROOT="$(cd "$(dirname "${BASH_SOURCE[0]}")/../.." && pwd -P)"
 
 OPENIM_OUTPUT_SUBPATH="${OPENIM_OUTPUT_SUBPATH:-_output}"
-OPENIM_OUTPUT=""${OPENIM_ROOT}"/${OPENIM_OUTPUT_SUBPATH}"
+OPENIM_OUTPUT="${OPENIM_ROOT}/${OPENIM_OUTPUT_SUBPATH}"
 
 OPENIM_OUTPUT_BINPATH="${OPENIM_OUTPUT}/bin/platforms"
 OPENIM_OUTPUT_BINTOOLPATH="${OPENIM_OUTPUT}/bin/tools"
@@ -50,8 +50,8 @@ OPENIM_RSYNC_COMPRESS="${KUBE_RSYNC_COMPRESS:-0}"
 export no_proxy="127.0.0.1,localhost${no_proxy:+,${no_proxy}}"
 
 # This is a symlink to binaries for "this platform", e.g. build tools.
-export THIS_PLATFORM_BIN=""${OPENIM_ROOT}"/_output/bin/platforms"
+export THIS_PLATFORM_BIN="${OPENIM_ROOT}/_output/bin/platforms"
-export THIS_PLATFORM_BIN_TOOLS=""${OPENIM_ROOT}"/_output/bin/tools"
+export THIS_PLATFORM_BIN_TOOLS="${OPENIM_ROOT}/_output/bin/tools"
 
 . $(dirname ${BASH_SOURCE})/color.sh
 . $(dirname ${BASH_SOURCE})/util.sh
@@ -62,7 +62,6 @@ openim::util::ensure-bash-version
 
 . $(dirname ${BASH_SOURCE})/version.sh
 . $(dirname ${BASH_SOURCE})/golang.sh
-. $(dirname ${BASH_SOURCE})/release.sh
 . $(dirname ${BASH_SOURCE})/chat.sh
 
 OPENIM_OUTPUT_HOSTBIN="${OPENIM_OUTPUT_BINPATH}/$(openim::util::host_platform)"

scripts/lib/release.sh

@@ -25,6 +25,7 @@
 readonly BUCKET="openim-1306374445"
 readonly REGION="ap-guangzhou"
 readonly COS_RELEASE_DIR="openim-release"
+# readonly COS_RELEASE_DIR="openim-advanced-release" # !pro 
 
 # default cos command tool coscli or coscmd
 readonly COSTOOL="coscli"
@@ -37,9 +38,11 @@ readonly RELEASE_IMAGES="${LOCAL_OUTPUT_ROOT}/release-images"
 # OpenIM github account info
 readonly OPENIM_GITHUB_ORG=openimsdk
 readonly OPENIM_GITHUB_REPO=open-im-server
-readonly CHAT_GITHUB_REPO=chat
+# readonly OPENIM_GITHUB_REPO=open-im-server-enterprise # !pro 
 
 readonly ARTIFACT=openim.tar.gz
+# readonly ARTIFACT=openim-enterprise.tar.gz # !pro
+
 readonly CHECKSUM=${ARTIFACT}.sha1sum
 
 OPENIM_BUILD_CONFORMANCE=${OPENIM_BUILD_CONFORMANCE:-y}

scripts/lib/util.sh

@@ -1086,7 +1086,7 @@ function openim::util::ensure-install-nginx {
     exit 1
   fi
 
-  for port in 80
+  for port in "80"
   do
     if echo |telnet 127.0.0.1 $port 2>&1|grep refused &>/dev/null;then
       exit 1
@@ -2320,7 +2320,7 @@ function openim::util::ensure-install-nginx {
     exit 1
   fi
 
-  for port in 80
+  for port in "80"
   do
     if echo |telnet 127.0.0.1 $port 2>&1|grep refused &>/dev/null;then
       exit 1
@@ -2467,7 +2467,7 @@ function openim::util::desc() {
 }
 
 function openim::util:run::prompt() {
-    echo -n "$yellow\$ $reset"
+    echo -n "${yellow}\$ ${reset}"
 }
 
 started=""
@@ -2488,7 +2488,7 @@ function openim::util::run() {
     if [ -n "$DEMO_RUN_FAST" ]; then
       rate=1000
     fi
-    echo "$green$1$reset" | pv -qL $rate
+    echo "${green}$1${reset}" | pv -qL "$rate"
     if [ -n "$DEMO_RUN_FAST" ]; then
       sleep 0.5
     fi

scripts/make-rules/common.mk

@@ -73,7 +73,8 @@ endif
 ifeq ($(origin VERSION), undefined)
 # VERSION := $(shell git describe --tags --always --match='v*')
 # git describe --tags --always --match="v*" --dirty
-VERSION := $(shell git describe --tags --always --match="v*" --dirty | sed 's/-/./g')	#v2.3.3.631.g00abdc9b.dirty
+# VERSION := $(shell git describe --tags --always --match="v*" --dirty | sed 's/-/./g')	#v2.3.3.631.g00abdc9b.dirty
+VERSION := $(shell git describe --tags --always --match='v*')
 # v2.3.3: git tag
 endif
 
@@ -100,7 +101,7 @@ endif
 # The OS must be linux when building docker images
 # PLATFORMS ?= linux_amd64 linux_arm64
 # The OS can be linux/windows/darwin when building binaries
-PLATFORMS ?= linux_s390x linux_mips64 linux_mips64le darwin_amd64 windows_amd64 linux_amd64 linux_arm64 linux_ppc64le # wasip1_wasm
+PLATFORMS ?= linux_s390x linux_mips64 linux_mips64le darwin_amd64 darwin_arm64 windows_amd64 linux_amd64 linux_arm64 linux_ppc64le # wasip1_wasm
 
 # set a specific PLATFORM, defaults to the host platform
 ifeq ($(origin PLATFORM), undefined)
@@ -125,11 +126,11 @@ APIROOT=$(ROOT_DIR)/pkg/proto
 
 # Linux command settings
 # TODO: Whether you need to join utils?
-FIND := find . ! -path './utils/*' ! -path './vendor/*' ! -path './third_party/*'
+FIND := find . ! -path './utils/*' ! -path './vendor/*' ! -path './third_party/*' ! -path './components/*' ! -path './logs/*'
 XARGS := xargs -r --no-run-if-empty
 
 # Linux command settings-CODE DIRS Copyright
-CODE_DIRS := $(ROOT_DIR)/pkg $(ROOT_DIR)/cmd $(ROOT_DIR)/config $(ROOT_DIR)/.docker-compose_cfg $(ROOT_DIR)/internal $(ROOT_DIR)/scripts $(ROOT_DIR)/test $(ROOT_DIR)/.github $(ROOT_DIR)/build $(ROOT_DIR)/tools $(ROOT_DIR)/deployments
+CODE_DIRS := $(ROOT_DIR)/pkg $(ROOT_DIR)/cmd $(ROOT_DIR)/config $(ROOT_DIR)/internal $(ROOT_DIR)/scripts $(ROOT_DIR)/test $(ROOT_DIR)/.github $(ROOT_DIR)/build $(ROOT_DIR)/tools $(ROOT_DIR)/deployments
 FINDS := find $(CODE_DIRS)
 
 # Makefile settings: Select different behaviors by determining whether V option is set

scripts/make-rules/golang.mk

@@ -244,7 +244,7 @@ go.imports: tools.verify.goimports
 
 ## go.verify: execute all verity scripts.
 .PHONY: go.verify
-go.verify:
+go.verify: tools.verify.misspell
 	@echo "Starting verification..."
 	@scripts_list=$$(find $(ROOT_DIR)/scripts -type f -name 'verify-*' | sort); \
 	for script in $$scripts_list; do \

scripts/make-rules/image.mk

@@ -45,7 +45,8 @@ endif
 IMAGES_DIR ?= $(wildcard ${ROOT_DIR}/build/images/*)
 # Determine images names by stripping out the dir names, and filter out the undesired directories
 # IMAGES ?= $(filter-out Dockerfile,$(foreach image,${IMAGES_DIR},$(notdir ${image})))
-IMAGES ?= $(filter-out Dockerfile openim-tools openim-cmdutils,$(foreach image,${IMAGES_DIR},$(notdir ${image})))
+IMAGES ?= $(filter-out Dockerfile openim-tools openim-rpc-extend-msg openim-rpc-encryption openim-cmdutils,$(foreach image,${IMAGES_DIR},$(notdir ${image})))
+# IMAGES ?= $(filter-out Dockerfile openim-tools openim-cmdutils,$(foreach image,${IMAGES_DIR},$(notdir ${image}))) # !pro
 
 ifeq (${IMAGES},)
   $(error Could not determine IMAGES, set ROOT_DIR or run in source dir)

scripts/make-rules/tools.mk

@@ -146,7 +146,7 @@ install.github-release:
 # amd64
 .PHONY: install.coscli
 install.coscli:
-	@wget -q https://ghproxy.com/https://github.com/tencentyun/coscli/releases/download/v0.13.0-beta/coscli-linux -O ${TOOLS_DIR}/coscli
+	@wget -q https://github.com/tencentyun/coscli/releases/download/v0.19.0-beta/coscli-linux -O ${TOOLS_DIR}/coscli
 	@chmod +x ${TOOLS_DIR}/coscli
 
 ## install.coscmd: Install coscmd, used to upload files to cos
@@ -217,6 +217,11 @@ install.depth:
 install.go-callvis:
 	@$(GO) install github.com/ofabry/go-callvis@latest
 
+## install.misspell
+.PHONY: install.misspell
+install.misspell:
+	@$(GO) install github.com/client9/misspell/cmd/misspell@latest
+
 ## install.gothanks: Install gothanks, used to thank go dependencies
 .PHONY: install.gothanks
 install.gothanks:

scripts/mongo-init.sh

@@ -18,7 +18,6 @@ mongosh <<EOF
 use admin
 db.auth('$MONGO_INITDB_ROOT_USERNAME', '$MONGO_INITDB_ROOT_PASSWORD')
 
-
 db = db.getSiblingDB('$MONGO_INITDB_DATABASE')
 db.createUser({
   user: "$MONGO_OPENIM_USERNAME",
@@ -29,4 +28,3 @@ db.createUser({
   ]
 });
 EOF
-

scripts/release.sh

@@ -130,7 +130,7 @@ perform_action() {
   
   if [ "$flag" == true ]; then
     openim::log::info "## $message..."
-        if ! $command; then
+    if ! eval "$command"; then
       openim::log::errexit "Error in $message"
     fi
   fi

scripts/start-all.sh

@@ -32,6 +32,8 @@ if [[ $? -ne 0 ]]; then
 fi
 set -o errexit
 
+"${OPENIM_ROOT}"/scripts/init-config.sh --skip
+
 echo "You need to start the following scripts in order: ${OPENIM_SERVER_SCRIPTARIES[@]}"
 openim::log::install_errexit
 

scripts/stop-all.sh

@@ -35,3 +35,12 @@ openim::util::stop_services_on_ports ${OPENIM_SERVER_PORT_LISTARIES[@]}
 echo -e "\n++ Stop all processes in the path ${OPENIM_OUTPUT_HOSTBIN}"
 
 openim::util::stop_services_with_name "${OPENIM_OUTPUT_HOSTBIN}"
+
+echo -n "Stopping services 15 seconds."
+for i in {1..15}; do
+  echo -n "."
+  sleep 1
+done
+echo -e "\nServices stopped."
+
+openim::log::success "✨  Wait 15 seconds for all processes to be killed"

scripts/update-generated-docs.sh

@@ -23,7 +23,7 @@ set -o nounset
 set -o pipefail
 
 OPENIM_ROOT=$(dirname "${BASH_SOURCE[0]}")/..
-source "${OPENIM_ROOT}/hack/lib/init.sh"
+source "${OPENIM_ROOT}/scripts/lib/init.sh"
 
 openim::golang::setup_env
 

scripts/update-yamlfmt.sh

@@ -19,9 +19,9 @@ set -o nounset
 set -o pipefail
 
 OPENIM_ROOT=$(dirname "${BASH_SOURCE[0]}")/..
-source "${OPENIM_ROOT}/hack/lib/init.sh"
+source "${OPENIM_ROOT}/scripts/lib/init.sh"
 
-kube::golang::setup_env
+openim::golang::setup_env
 
 cd "${OPENIM_ROOT}"
 
@@ -40,4 +40,4 @@ find_files() {
 }
 
 export GO111MODULE=on
-find_files | xargs go run tools/yamlfmt/main.go
+find_files | xargs go run tools/yamlfmt/yamlfmt.go

scripts/verify-shellcheck.sh

@@ -43,6 +43,54 @@ disabled=(
   1091
   # this lint prefers command -v to which, they are not the same
   2230
+  # Error SC2155 indicates that you should separate variable declaration and assignment to avoid masking the return value of the command.
+  # In Bash scripts, when you declare and assign a local variable at the same time a command is executed, you only get the output of the command, but not the exit status (return value) of the command.  #
+  2155
+  # ShellCheck issues SC2086 warnings when you refer to a variable in a script but don't put it in double quotes.This can lead to unexpected behavior when scripts encounter Spaces, 
+  # newlines, and wildcards in file names or other data.
+  2086
+  2206
+
+  # TODO: 需要修复，然后开启
+  2034
+  2048
+  2148
+  2059
+  2214
+  2145
+  2128
+  2550
+  2046
+  2181
+  1102
+  2045
+  2068
+  2145
+  2207
+  2231
+  2013
+  2154
+  2120
+  1083
+  2001
+  2012
+  2016
+  2164
+  2223
+  2166
+  2119
+  2162
+  2295
+  2002
+  2004
+  2202
+  2178
+  2064
+  2260
+  2043
+  2178
+  2044
+  2153
 )
 # comma separate for passing to shellcheck
 join_by() {
@@ -65,14 +113,18 @@ cd "${OPENIM_ROOT}"
 #    forked should be linted and fixed.
 all_shell_scripts=()
 while IFS=$'\n' read -r script;
-  do git check-ignore -q "$script" || all_shell_scripts+=("$script");
+do git check-ignore -q "$script" || all_shell_scripts+=("$script");
-done < <(find . -name "*.sh" \
+  done < <(find . -name "*.sh" \
   -not \( \
   -path ./_\*      -o \
   -path ./.git\*   -o \
+  -path ./Godeps\* -o \
+  -path ./_output\* -o \
+  -path ./components\* -o \
+  -path ./logs\* -o \
   -path ./vendor\* -o \
   \( -path ./third_party\* -a -not -path ./third_party/forked\* \) \
-  \))
+\) -print 2>/dev/null)
 
 # detect if the host machine has the required shellcheck version installed
 # if so, we will use that instead.
@@ -113,7 +165,7 @@ if ${HAVE_SHELLCHECK}; then
 else
   openim::log::info "Using shellcheck ${SHELLCHECK_VERSION} docker image."
   "${DOCKER}" run \
-    --rm -v ""${OPENIM_ROOT}":"${OPENIM_ROOT}"" -w "${OPENIM_ROOT}" \
+  --rm -v "${OPENIM_ROOT}:${OPENIM_ROOT}" -w "${OPENIM_ROOT}" \
   "${SHELLCHECK_IMAGE}" \
   shellcheck "${SHELLCHECK_OPTIONS[@]}" "${all_shell_scripts[@]}" >&2 || res=$?
 fi

scripts/verify-spelling.sh

@@ -25,17 +25,8 @@ OPENIM_ROOT=$(dirname "${BASH_SOURCE[0]}")/..
 export OPENIM_ROOT
 source "${OPENIM_ROOT}/scripts/lib/init.sh"
 
-# Ensure that we find the binaries we build before anything else.
-export GOBIN="${KUBE_OUTPUT_BINPATH}"
-PATH="${GOBIN}:${PATH}"
-
-# Install tools we need
-pushd ""${OPENIM_ROOT}"/tools" >/dev/null
-  GO111MODULE=on go install github.com/client9/misspell/cmd/misspell
-popd >/dev/null
-
 # Spell checking
 # All the skipping files are defined in scripts/.spelling_failures
-skipping_file=""${OPENIM_ROOT}"/scripts/.spelling_failures"
+skipping_file="${OPENIM_ROOT}/scripts/.spelling_failures"
 failing_packages=$(sed "s| | -e |g" "${skipping_file}")
-git ls-files | grep -v -e "${failing_packages}" | xargs misspell -i "Creater,creater,ect" -error -o stderr
+git ls-files | grep -v -e "${failing_packages}" | xargs "$OPENIM_ROOT/_output/tools/misspell" -i "Creater,creater,ect" -error -o stderr

scripts/verify-typecheck.sh

@@ -33,7 +33,7 @@ cd "${OPENIM_ROOT}"
 ret=0
 TYPECHECK_SERIAL="${TYPECHECK_SERIAL:-false}"
 scripts/run-in-gopath.sh \
-    go run test/typecheck/typecheck.go "$@" "--serial=$TYPECHECK_SERIAL" || ret=$?
+go run test/typecheck/typecheck.go "$@" "--serial=$TYPECHECK_SERIAL" || ret=$?
 if [[ $ret -ne 0 ]]; then
   openim::log::error "Type Check has failed. This may cause cross platform build failures." >&2
   openim::log::error "Please see https://github.com/openimsdk/open-im-server/tree/main/test/typecheck for more information." >&2

scripts/verify-yamlfmt.sh

@@ -36,13 +36,13 @@ openim::util::trap_add "git worktree remove -f ${_tmpdir}" EXIT
 cd "${_tmpdir}"
 
 # Format YAML files
-hack/update-yamlfmt.sh
+scripts/update-yamlfmt.sh
 
 # Test for diffs
 diffs=$(git status --porcelain | wc -l)
 if [[ ${diffs} -gt 0 ]]; then
   echo "YAML files need to be formatted" >&2
   git diff
-  echo "Please run 'hack/update-yamlfmt.sh'" >&2
+  echo "Please run 'scripts/update-yamlfmt.sh'" >&2
   exit 1
 fi

tools/data-conversion/README.md

@@ -31,7 +31,7 @@ var (
     usernameV3 = "root"
     passwordV3 = "openIM123"
     addrV3     = "127.0.0.1:13306"
-    databaseV3 = "openIM_v3"
+    databaseV3 = "openim_v3"
 )
 ```
 

tools/formitychecker/README.md

@@ -0,0 +1,102 @@
+# Development of a Go-Based Conformity Checker for Project File and Directory Naming Standards
+
+### 1. Project Overview
+
+#### Project Name
+
+- `GoConformityChecker`
+
+#### Functionality Description
+
+- Checks if the file and subdirectory names in a specified directory adhere to specific naming conventions.
+- Supports specific file types (e.g., `.go`, `.yml`, `.yaml`, `.md`, `.sh`, etc.).
+- Allows users to specify directories to be checked and directories to be ignored.
+- More read https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/code-conventions.md
+
+#### Naming Conventions
+
+- Go files: Only underscores are allowed.
+- YAML, YML, and Markdown files: Only hyphens are allowed.
+- Directories: Only underscores are allowed.
+
+### 2. File Structure
+
+- `main.go`: Entry point of the program, handles command-line arguments.
+- `checker/checker.go`: Contains the core logic.
+- `config/config.go`: Parses and stores configuration information.
+
+### 3. Core Code Design
+
+#### main.go
+
+- Parses command-line arguments, including the directory to be checked and directories to be ignored.
+- Calls the `checker` module for checking.
+
+#### config.go
+
+- Defines a configuration structure, such as directories to check and ignore.
+
+#### checker.go
+
+- Iterates through the specified directory.
+- Applies different naming rules based on file types and directory names.
+- Records files or directories that do not conform to the standards.
+
+### 4. Pseudocode Example
+
+#### main.go
+
+```go
+package main
+
+import (
+    "flag"
+    "fmt"
+    "GoConformityChecker/checker"
+)
+
+func main() {
+    // Parse command-line arguments
+    var targetDir string
+    var ignoreDirs string
+    flag.StringVar(&targetDir, "target", ".", "Directory to check")
+    flag.StringVar(&ignoreDirs, "ignore", "", "Directories to ignore")
+    flag.Parse()
+
+    // Call the checker
+    err := checker.CheckDirectory(targetDir, ignoreDirs)
+    if err != nil {
+        fmt.Println("Error:", err)
+    }
+}
+```
+
+#### checker.go
+
+```go
+package checker
+
+import (
+    // Import necessary packages
+)
+
+func CheckDirectory(targetDir, ignoreDirs string) error {
+    // Iterate through the directory, applying rules to check file and directory names
+    // Return any found errors or non-conformities
+    return nil
+}
+```
+
+### 5. Implementation Details
+
+- **File and Directory Traversal**: Use Go's `path/filepath` package to traverse directories and subdirectories.
+- **Naming Rules Checking**: Apply different regex expressions for naming checks based on file extensions.
+- **Error Handling and Reporting**: Record files or directories that do not conform and report to the user.
+
+### 6. Future Development and Extensions
+
+- Support more file types and naming rules.
+- Provide more detailed error reports, such as showing line numbers and specific naming mistakes.
+- Add a graphical or web interface for non-command-line users.
+
+The above is an overview of the entire project's design. Following this design, specific coding implementation can begin. Note that the actual implementation may need adjustments based on real-world conditions.

tools/imctl/.gitignore

@@ -36,20 +36,6 @@ config/config.yaml
 .env
 ./.env
 
-### OpenIM deploy ###
-deploy/openim_demo
-deploy/openim-api
-deploy/openim-rpc-msg_gateway
-deploy/openim-msgtransfer
-deploy/openim-push
-deploy/openim_timer_task
-deploy/openim-rpc-user
-deploy/openim-rpc-friend
-deploy/openim-rpc-group
-deploy/openim-rpc-msg
-deploy/openim-rpc-auth
-deploy/Open-IM-SDK-Core
-
 # files used by the developer
 .idea.md
 .todo.md

tools/openim-web/README.md

@@ -37,7 +37,6 @@ Variables can be set as above, Environment variables can also be set
 example:
 
 ```bash
-$ export OPENIM_WEB_DIST_PATH="/app/dist"
 $ export OPENIM_WEB_PPRT="11001"
 ```
 

tools/yamlfmt/OWNERS

@@ -1,10 +0,0 @@
-# See the OWNERS docs at https://go.k8s.io/owners
-
-reviewers:
-  - cubxxw
-  - kubbot
-approvers:
-  - cubxxw
-labels:
-  - sig/testing
-  - sig/contributor-experience