feat: optimize config

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

.devcontainer/README.md

@@ -0,0 +1,140 @@
+# OpenIM - OSS Development Container
+
+[![Open in Dev Containers](https://img.shields.io/static/v1?label=Dev%20Containers&message=Open&color=blue&logo=visualstudiocode)](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/openimsdk/open-im-server)
+
+This repository includes configuration for a development container for working with OpenIM - OSS in a local container or using [GitHub Codespaces](https://github.com/features/codespaces).
+
+> **Tip:** The default VNC password is `openIM123`. The VNC server runs on port `5901` and a web client is available on port `11001`, openim-admin on port `11002`.
+
+## Quick start - local
+
+If you already have VS Code and Docker installed, you can click the badge above or [here](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/openimsdk/open-im-server) to get started. Clicking these links will cause VS Code to automatically install the Dev Containers extension if needed, clone the source code into a container volume, and spin up a dev container for use.
+
+1. Install Docker Desktop or Docker for Linux on your local machine. (See [docs](https://aka.ms/vscode-remote/containers/getting-started) for additional details.)
+
+2. **Important**: Docker needs at least **4 Cores and 8 GB of RAM** to run a full build with **9 GB of RAM** being recommended. If you are on macOS, or are using the old Hyper-V engine for Windows, update these values for Docker Desktop by right-clicking on the Docker status bar item and going to **Preferences/Settings > Resources > Advanced**.
+
+   > **Note:** The [Resource Monitor](https://marketplace.visualstudio.com/items?itemName=mutantdino.resourcemonitor) extension is included in the container so you can keep an eye on CPU/Memory in the status bar.
+
+3. Install [Visual Studio Code Stable](https://code.visualstudio.com/) or [Insiders](https://code.visualstudio.com/insiders/) and the [Dev Containers](https://aka.ms/vscode-remote/download/containers) extension.
+
+   ![Image of Dev Containers extension](https://microsoft.github.io/vscode-remote-release/images/dev-containers-extn.png)
+
+   > **Note:** The Dev Containers extension requires the Visual Studio Code distribution of OpenIM - OSS. See the [FAQ](https://aka.ms/vscode-remote/faq/license) for details.
+
+4. Press <kbd>Ctrl/Cmd</kbd> + <kbd>Shift</kbd> + <kbd>P</kbd> or <kbd>F1</kbd> and select **Dev Containers: Clone Repository in Container Volume...**.
+
+   > **Tip:** While you can use your local source tree instead, operations like `yarn install` can be slow on macOS or when using the Hyper-V engine on Windows. We recommend using the WSL filesystem on Windows or the "clone repository in container" approach on Windows and macOS instead since it uses "named volume" rather than the local filesystem.
+
+5. Type `https://github.com/openimsdk/open-im-server` (or a branch or PR URL) in the input box and press <kbd>Enter</kbd>.
+
+6. After the container is running:
+    1. If you have the `DISPLAY` or `WAYLAND_DISPLAY` environment variables set locally (or in WSL on Windows), desktop apps in the container will be shown in local windows.
+    2. If these are not set, open a web browser and go to [http://localhost:11001](http://localhost:11001), or use a [VNC Viewer][def] to connect to `localhost:11001` and enter `vscode` as the password. Anything you start in VS Code, or the integrated terminal, will appear here.
+
+Next: **[Try it out!](#try-it)**
+
+## Quick start - GitHub Codespaces
+
+1. From the [openimsdk/open-im-server GitHub repository](https://github.com/openimsdk/open-im-server), click on the **Code** dropdown, select **Open with Codespaces**, and then click on **New codespace**. If prompted, select the **Standard** machine size (which is also the default).
+
+   > **Note:** You will not see these options within GitHub if you are not in the Codespaces beta.
+
+2. After the codespace is up and running in your browser, press <kbd>Ctrl/Cmd</kbd> + <kbd>Shift</kbd> + <kbd>P</kbd> or <kbd>F1</kbd> and select **Ports: Focus on Ports View**.
+
+3. You should see **VNC web client (11001)** under in the list of ports. Select the line and click on the globe icon to open it in a browser tab.
+
+    > **Tip:** If you do not see the port, <kbd>Ctrl/Cmd</kbd> + <kbd>Shift</kbd> + <kbd>P</kbd> or <kbd>F1</kbd>, select **Forward a Port** and enter port `11001`.
+
+4. In the new tab, you should see noVNC. Click **Connect** and enter `vscode` as the password.
+
+Anything you start in VS Code, or the integrated terminal, will appear here.
+
+Next: **[Try it out!](#try-it)**
+
+### Using VS Code with GitHub Codespaces
+
+You may see improved VNC responsiveness when accessing a codespace from VS Code client since you can use a [VNC Viewer][def]. Here's how to do it.
+
+1. Install [Visual Studio Code Stable](https://code.visualstudio.com/) or [Insiders](https://code.visualstudio.com/insiders/) and the the [GitHub Codespaces extension](https://marketplace.visualstudio.com/items?itemName=GitHub.codespaces).
+
+    > **Note:** The GitHub Codespaces extension requires the Visual Studio Code distribution of OpenIM - OSS.
+
+2. After the VS Code is up and running, press <kbd>Ctrl/Cmd</kbd> + <kbd>Shift</kbd> + <kbd>P</kbd> or <kbd>F1</kbd>, choose **Codespaces: Create New Codespace**, and use the following settings:
+
+- `openimsdk/open-im-server` for the repository.
+- Select any branch (e.g. **main**) - you can select a different one later.
+- Choose **Standard** (4-core, 8GB) as the size.
+
+3. After you have connected to the codespace, you can use a [VNC Viewer][def] to connect to `localhost:5901` and enter `vscode` as the password.
+
+    > **Tip:** You may also need change your VNC client's **Picture Quality** setting to **High** to get a full color desktop.
+
+4. Anything you start in VS Code, or the integrated terminal, will appear here.
+
+Next: **[Try it out!](#try-it)**
+
+## Try it
+
+This container uses the [Fluxbox](http://fluxbox.org/) window manager to keep things lean. **Right-click on the desktop** to see menu options. It works with GNOME and GTK applications, so other tools can be installed if needed.
+
+   > **Note:** You can also set the resolution from the command line by typing `set-resolution`.
+
+To start working with OpenIM - OSS, follow these steps:
+
+1. In your local VS Code client, open a terminal (<kbd>Ctrl/Cmd</kbd> + <kbd>Shift</kbd> + <kbd>\`</kbd>) and type the following commands:
+
+   ```bash
+   yarn install
+   bash scripts/code.sh
+   ```
+
+2. After the build is complete, open a web browser or a [VNC Viewer][def] to connect to the desktop environment as described in the quick start and enter `vscode` as the password.
+
+3. You should now see OpenIM - OSS!
+
+Next, let's try debugging.
+
+1. Shut down OpenIM - OSS by clicking the box in the upper right corner of the OpenIM - OSS window through your browser or VNC viewer.
+
+2. Go to your local VS Code client, and use the **Run / Debug** view to launch the **VS Code** configuration. (Typically the default, so you can likely just press <kbd>F5</kbd>).
+
+   > **Note:** If launching times out, you can increase the value of `timeout` in the "VS Code", "Attach Main Process", "Attach Extension Host", and "Attach to Shared Process" configurations in [launch.json](../../.vscode/launch.json). However, running `./scripts/code.sh` first will set up Electron which will usually solve timeout issues.
+
+3. After a bit, OpenIM - OSS will appear with the debugger attached!
+
+Enjoy!
+
+
+### Dotfiles
+
+Dotfiles are files and folders on Unix-like systems starting with `.` that control the configuration of applications and shells on your system. You can store and manage your dotfiles in a repository on GitHub. For advice and tutorials about what to include in your dotfiles repository, see [GitHub does dotfiles](https://dotfiles.github.io/).
+
+Your dotfiles repository might include your shell aliases and preferences, any tools you want to install, or any other codespace personalization you want to make.
+
+You can configure GitHub Codespaces to use dotfiles from any repository you own by selecting that repository in your [personal GitHub Codespaces settings](https://github.com/settings/codespaces).
+
+When you create a new codespace, GitHub clones your selected dotfiles repository to the codespace environment, and looks for one of the following files to set up the environment.
+
+- *install.sh*
+- *install*
+- *bootstrap.sh*
+- *bootstrap*
+- *script/bootstrap*
+- *setup.sh*
+- *setup*
+- *script/setup*
+
+If none of these files are found, then any files or folders in your selected dotfiles repository starting with `.` are symlinked to the codespace's `~` or `$HOME` directory.
+
+Any changes to your selected dotfiles repository will apply only to each new codespace, and do not affect any existing codespace.
+
+**Note:** Currently, Codespaces does not support personalizing the User-scoped settings for VS Code with your `dotfiles` repository. You can set default Workspace and Remote [Codespaces] settings for a specific project in the project's repository. For more information, see "[Introduction to dev containers](https://docs.github.com/en/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/introduction-to-dev-containers#creating-a-custom-dev-container-configuration)."
+
+In addition, you can also configure Codespaces secrets on your personal profile page at [github.com/settings/codespaces](https://github.com/settings/codespaces). Development environment secrets are environment variables that are encrypted, and they are accessible to any codespace you create using repositories that have access to these secrets.
+
+### Notes
+
+The container comes with VS Code Insiders installed. To run it from an Integrated Terminal use `VSCODE_IPC_HOOK_CLI= /usr/bin/code-insiders .`.
+
+[def]: https://www.realvnc.com/en/connect/download/viewer/

.devcontainer/devcontainer.json

@@ -0,0 +1,72 @@
+{
+    // Reference Doc: https://code.visualstudio.com/remote/advancedcontainers/overview
+    "name": "OpenIM Dev Environment",
+    // Update the container version when you publish dev-container
+    "build": { "dockerfile": "Dockerfile" },
+    // Replace with uncommented line below to build your own local copy of the image
+    // "dockerFile": "../docker/Dockerfile-dev",
+    "remoteEnv": {
+        "GO111MODULE": "on",
+        "GOPROXY": "https://goproxy.cn",
+        "GOSUMDB": "sum.golang.org",
+        "GONOPROXY": "github.com/openimsdk",
+        "GONOSUMDB": "github.com/openimsdk",
+        "GOPRIVATE": "github.com/openimsdk"
+    },
+    "customizations": {
+        "vscode": {
+            "extensions": [
+                "davidanson.vscode-markdownlint",
+                "golang.go",
+                "ms-azuretools.vscode-dapr",
+                "ms-azuretools.vscode-docker",
+                "ms-kubernetes-tools.vscode-kubernetes-tools"
+            ],
+            "settings": {
+                "go.toolsManagement.checkForUpdates": "local",
+                "go.useLanguageServer": true,
+                "go.gopath": "/go"
+            }
+        }
+    },
+    "mounts": [
+        // Mount docker-in-docker library volume
+        "type=volume,source=dind-var-lib-docker,target=/var/lib/docker",
+
+        // Bind mount docker socket under an alias to support docker-from-docker
+        "type=bind,source=/var/run/docker.sock,target=/var/run/docker-host.sock",
+
+        // Bind mount docker socket under an alias to support docker-from-docker
+        // "type=bind,source=${env:HOME}${env:USERPROFILE}/.minikube/cache,target=/home/openim/.minikube/cache",
+
+        // Uncomment to clone local .kube/config into devcontainer
+        "type=bind,source=${env:HOME}${env:USERPROFILE}/.kube,target=/home/openim/.kube-localhost"
+
+        // Uncomment to additionally clone minikube certs into devcontainer for use with .kube/config
+        // "type=bind,source=${env:HOME}${env:USERPROFILE}/.minikube,target=/home/openim/.minikube-localhost"
+    ],
+    // Always run image-defined default command
+    "overrideCommand": false,
+    // On Linux, this will prevent new files getting created as root, but you
+    // may need to update the USER_UID and USER_GID in docker/Dockerfile-dev
+    // to match your user if not 1000.
+    // "remoteUser": "openimsdk",
+    "runArgs": [
+        // Enable ptrace-based debugging for go
+        "--cap-add=SYS_PTRACE",
+        "--security-opt",
+        "seccomp=unconfined",
+
+        // Uncomment to bind to host network for local devcontainer; this is necessary if using the
+        // bind-mounted /var/run/docker-host.sock directly.
+        "--net=host",
+
+        // Enable docker-in-docker configuration. Comment out if not using for better security.
+        "--privileged",
+
+        // Run the entrypoint defined in container image.
+        "--init"
+    ],
+    "workspaceFolder": "/workspaces/openim",
+    "workspaceMount": "type=bind,source=${localWorkspaceFolder},target=/workspaces/openim"
+}

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

.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,6 +18,7 @@ on:
   push:
     branches:
         - main
+        - release-*
     paths-ignore:
         - "docs/**"
         - "README.md"
@@ -26,6 +27,7 @@ on:
   pull_request:
     branches:
         - main
+        - release-*
     paths-ignore:
         - "README.md"
         - "README_zh-CN.md"
@@ -36,21 +38,19 @@ 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
@@ -83,6 +83,11 @@ 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
 
@@ -109,8 +114,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 +137,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 +207,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 +227,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 +253,27 @@ jobs:
     - name: Build, Start, Check Services and Print Logs for Ubuntu
       if: runner.os == 'Linux'
       run: |
-        sudo make build && \
-        sudo make start && \
-        sudo make check || \
-        (echo "An error occurred, printing logs:" && sudo cat ./_output/logs/* 2>/dev/null)
+        sudo make build
+        sudo make start
+        sudo make check
 
     - 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
-    #   if: runner.os == 'macOS'
-    #   run: |
-    #     make init && \
-    #     make build && \
-    #     make start && \
-    #     make check || \
-    #     (echo "An error occurred, printing logs:" && sudo cat ./_output/logs/* 2>/dev/null)
+    - name: Build, Start, Check Services and Print Logs for macOS
+      if: runner.os == 'macOS' && matrix.arch == 'arm64'
+      run: |
+        make build
 
   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 +295,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

.gitignore

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

CHANGELOG/CHANGELOG-3.4.md

@@ -0,0 +1,32 @@
+# Version logging for OpenIM
+
+<!-- BEGIN MUNGE: GENERATED_TOC -->
+
+<!-- END MUNGE: GENERATED_TOC -->
+
+<a name="unreleased"></a>
+## [Unreleased]
+
+
+<a name="v3.4.2"></a>
+## [v3.4.2] - 2023-12-14
+
+<a name="v3.4.0"></a>
+## [v3.4.0] - 2023-11-10
+
+<a name="v3.4.0-rc.1"></a>
+## [v3.4.0-rc.1] - 2023-11-09
+
+<a name="v3.4.0-rc.0"></a>
+## v3.4.0-rc.0 - 2023-11-09
+### Reverts
+- update etcd to v3.5.2 ([#206](https://github.com/openimsdk/open-im-server/issues/206))
+
+### Pull Requests
+- Merge branch 'tuoyun'
+
+
+[Unreleased]: https://github.com/openimsdk/open-im-server/compare/v3.4.2...HEAD
+[v3.4.2]: https://github.com/openimsdk/open-im-server/compare/v3.4.0...v3.4.2
+[v3.4.0]: https://github.com/openimsdk/open-im-server/compare/v3.4.0-rc.1...v3.4.0
+[v3.4.0-rc.1]: https://github.com/openimsdk/open-im-server/compare/v3.4.0-rc.0...v3.4.0-rc.1

CHANGELOG/CHANGELOG-3.5.md

@@ -0,0 +1,76 @@
+# Version logging for OpenIM
+
+<!-- BEGIN MUNGE: GENERATED_TOC -->
+
+<!-- END MUNGE: GENERATED_TOC -->
+
+<a name="unreleased"></a>
+## [Unreleased]
+
+
+<a name="v3.5.1-alpha.1"></a>
+## [v3.5.1-alpha.1] - 2024-01-09
+
+<a name="v3.5.0"></a>
+## [v3.5.0] - 2024-01-02
+
+<a name="v3.5.1"></a>
+## [v3.5.1] - 2024-01-02
+
+<a name="v3.5.1-bate.1"></a>
+## [v3.5.1-bate.1] - 2024-01-02
+
+<a name="v3.5.1-rc.0"></a>
+## [v3.5.1-rc.0] - 2023-12-30
+
+<a name="v3.5.0-rc.8"></a>
+## [v3.5.0-rc.8] - 2023-12-28
+
+<a name="v3.5.0-rc.7"></a>
+## [v3.5.0-rc.7] - 2023-12-18
+
+<a name="v3.5.0-rc.6"></a>
+## [v3.5.0-rc.6] - 2023-12-15
+
+<a name="v3.5.0-rc.5"></a>
+## [v3.5.0-rc.5] - 2023-12-15
+
+<a name="v3.5.0-rc.4"></a>
+## [v3.5.0-rc.4] - 2023-12-14
+
+<a name="v3.5.0-rc.3"></a>
+## [v3.5.0-rc.3] - 2023-12-14
+
+<a name="v3.5.0-rc.2"></a>
+## [v3.5.0-rc.2] - 2023-12-14
+
+<a name="v3.5.0-rc.1"></a>
+## [v3.5.0-rc.1] - 2023-12-14
+
+<a name="v3.5.0-rc.0"></a>
+## [v3.5.0-rc.0] - 2023-12-14
+
+<a name="v3.5.0-beta.1"></a>
+## v3.5.0-beta.1 - 2023-11-29
+### Reverts
+- update etcd to v3.5.2 ([#206](https://github.com/openimsdk/open-im-server/issues/206))
+
+### Pull Requests
+- Merge branch 'tuoyun'
+
+
+[Unreleased]: https://github.com/openimsdk/open-im-server/compare/v3.5.1-alpha.1...HEAD
+[v3.5.1-alpha.1]: https://github.com/openimsdk/open-im-server/compare/v3.5.0...v3.5.1-alpha.1
+[v3.5.0]: https://github.com/openimsdk/open-im-server/compare/v3.5.1...v3.5.0
+[v3.5.1]: https://github.com/openimsdk/open-im-server/compare/v3.5.1-bate.1...v3.5.1
+[v3.5.1-bate.1]: https://github.com/openimsdk/open-im-server/compare/v3.5.1-rc.0...v3.5.1-bate.1
+[v3.5.1-rc.0]: https://github.com/openimsdk/open-im-server/compare/v3.5.0-rc.8...v3.5.1-rc.0
+[v3.5.0-rc.8]: https://github.com/openimsdk/open-im-server/compare/v3.5.0-rc.7...v3.5.0-rc.8
+[v3.5.0-rc.7]: https://github.com/openimsdk/open-im-server/compare/v3.5.0-rc.6...v3.5.0-rc.7
+[v3.5.0-rc.6]: https://github.com/openimsdk/open-im-server/compare/v3.5.0-rc.5...v3.5.0-rc.6
+[v3.5.0-rc.5]: https://github.com/openimsdk/open-im-server/compare/v3.5.0-rc.4...v3.5.0-rc.5
+[v3.5.0-rc.4]: https://github.com/openimsdk/open-im-server/compare/v3.5.0-rc.3...v3.5.0-rc.4
+[v3.5.0-rc.3]: https://github.com/openimsdk/open-im-server/compare/v3.5.0-rc.2...v3.5.0-rc.3
+[v3.5.0-rc.2]: https://github.com/openimsdk/open-im-server/compare/v3.5.0-rc.1...v3.5.0-rc.2
+[v3.5.0-rc.1]: https://github.com/openimsdk/open-im-server/compare/v3.5.0-rc.0...v3.5.0-rc.1
+[v3.5.0-rc.0]: https://github.com/openimsdk/open-im-server/compare/v3.5.0-beta.1...v3.5.0-rc.0

README-zh_CN.md

@@ -35,52 +35,62 @@
 
 ## Ⓜ️ 关于 OpenIM
 
-OpenIM 不仅仅是一个开源的即时消息组件，它是你的应用程序生态系统的一个不可或缺的部分。查看下面的图表，了解 AppServer、AppClient、OpenIMServer 和 OpenIMSDK 是如何交互的。
+OpenIM 是一个专门设计用于在应用程序中集成聊天、音视频通话、通知以及AI聊天机器人等通信功能的服务平台。它通过提供一系列强大的API和Webhooks，使开发者可以轻松地在他们的应用中加入这些交互特性。OpenIM 本身并不是一个独立运行的聊天应用，而是作为一个平台，为其他应用提供支持，实现丰富的通信功能。下图展示 AppServer、AppClient、OpenIMServer 和 OpenIMSDK 之间的交互关系来具体说明。
+
+
+
+
 
 ![App-OpenIM 关系](./docs/images/oepnim-design.png)
 
 ## 🚀 关于 OpenIMSDK
 
-**OpenIMSDK** 无缝集成到您的应用中，提供丰富、实时的消息体验，无需复杂的 UI 集成。它提供：
+**OpenIMSDK** 是为 **OpenIMServer** 设计的IM SDK，专为嵌入客户端应用而生。其主要功能及模块如下：
 
-+ **本地存储**：用于快速数据检索和消息同步。
-+ **监听器回调**：确保实时消息交互性。
-+ **API 封装**：简化开发流程。
-+ **连接管理**：保证可靠的消息传递。
++ 🌟 主要功能：
 
-它使用 Golang 构建，并支持跨平台部署，确保在所有平台上提供一致的消息体验。
+  - 📦 本地存储
+  - 🔔 监听器回调
+  - 🛡️ API封装
+  - 🌐 连接管理
+
+  ## 📚 主要模块：
+
+  1. 🚀 初始化及登录
+  2. 👤 用户管理
+  3. 👫 好友管理
+  4. 🤖 群组功能
+  5. 💬 会话处理
+
+它使用 Golang 构建，并支持跨平台部署，确保在所有平台上提供一致的接入体验。
 
 👉 **[探索 GO SDK](https://github.com/openimsdk/openim-sdk-core)**
 
 ## 🌐 关于 OpenIMServer
 
-精心用 Golang 开发的 **OpenIMServer** 通过多重方式确保了卓越的即时消息服务器能力：
-
-+ **模块组成**：它由多个模块组成，例如网关和多个 RPC 服务，提供一个多功能的消息环境。
-+ **微服务架构**：支持集群模式，确保出色的性能和可伸缩性，以有效管理各个实例间的通信。
-+ **多样的部署选项**：适应你的操作偏好，通过源代码、Kubernetes 或 Docker 提供部署选项。
++ **OpenIMServer** 具有以下特点：
+  - 🌐 微服务架构：支持集群模式，包括网关(gateway)和多个rpc服务。
+  - 🚀 部署方式多样：支持源代码、kubernetes或docker部署。
+  - 海量用户支持：十万超级大群，千万用户，及百亿消息
 
 ### 增强的业务功能：
 
-+ **REST API**：OpenIMServer 为业务系统提供 REST API，旨在通过后端接口为您的操作提供附加功能，如群组创建和消息推送。
-+ **回调**：为了扩展其在各种业务形式中的实用性，OpenIMServer 提供了回调能力。即，在事件发生之前或之后，它向业务服务器发送请求，比如发送消息，丰富通信过程中的交互和数据交换流。
++ **REST API**：OpenIMServer 提供了REST API供业务系统使用，旨在赋予业务更多功能，例如通过后台接口建立群组、发送推送消息等。
++ **Webhooks**：OpenIMServer提供了回调能力以扩展更多的业务形态，所谓回调，即OpenIMServer会在某一事件发生之前或者之后，向业务服务器发送请求，如发送消息之前或之后的回调。
 
-👉 **[了解更多](https://doc.rentsoft.cn/guides/introduction/product)**
+👉 **[了解更多](https://docs.openim.io/guides/introduction/product)**
 
 ## :rocket: 快速开始
 
-你只需要一个简单的命令，就可以快速学习 OpenIM 的工程解决方案：
+在线体验iOS/Android/H5/PC/Web：
 
-```
-bashCopy code
-$ make demo
-```
+👉 **[OpenIM online demo](https://www.openim.io/zh/commercial)**
 
 🤲 为了方便用户体验，我们提供了多种部署解决方案，您可以根据下面的列表选择自己的部署方法：
 
-+ **[源代码部署指南](https://doc.rentsoft.cn/guides/gettingStarted/imSourceCodeDeployment)**
-+ **[Docker 部署指南](https://doc.rentsoft.cn/guides/gettingStarted/dockerCompose)**
-+ **[Kubernetes 部署指南](https://github.com/openimsdk/open-im-server/tree/main/deployments)**
++ **[源代码部署指南](https://docs.openim.io/guides/gettingStarted/imSourceCodeDeployment)**
++ **[Docker 部署指南](https://docs.openim.io/guides/gettingStarted/dockerCompose)**
++ **[Kubernetes 部署指南](https://docs.openim.io/guides/gettingStarted/k8s-deployment)**
 
 ## :hammer_and_wrench: 开始开发 OpenIM
 

README.md

@@ -25,180 +25,58 @@
 
 </p>
 
-
 ## Ⓜ️ About OpenIM
 
-OpenIM isn't just an open-source instant messaging component, it's an integral part of your application ecosystem. Check out this diagram to understand how AppServer, AppClient, OpenIMServer, and OpenIMSDK interact.
+OpenIM is a service platform specifically designed for integrating chat, audio-video calls, notifications, and AI chatbots into applications. It provides a range of powerful APIs and Webhooks, enabling developers to easily incorporate these interactive features into their applications. OpenIM is not a standalone chat application, but rather serves as a platform to support other applications in achieving rich communication functionalities. The following diagram illustrates the interaction between AppServer, AppClient, OpenIMServer, and OpenIMSDK to explain in detail.
 
 ![App-OpenIM Relationship](./docs/images/oepnim-design.png)
 
 ## 🚀 About OpenIMSDK
 
-**OpenIMSDK** seamlessly integrates into your application, delivering a rich, real-time messaging experience without requiring intricate UI integration. It provides:
+**OpenIMSDK** is an IM SDK designed for **OpenIMServer**, created specifically for embedding in client applications. Its main features and modules are as follows:
 
-+ **Local Storage**: For quick data retrieval and message synchronization.
-+ **Listener Callbacks**: Ensuring real-time message interactivity.
-+ **API Encapsulation**: Streamlining development processes.
-+ **Connection Management**: Guaranteeing reliable message delivery.
++ 🌟 Main Features:
 
-It's crafted in Golang and supports cross-platform deployment, ensuring a coherent messaging experience across all platforms.
+  - 📦 Local storage
+  - 🔔 Listener callbacks
+  - 🛡️ API wrapping
+  - 🌐 Connection management
+
+  ## 📚 Main Modules:
+
+  1. 🚀 Initialization and Login
+  2. 👤 User Management
+  3. 👫 Friend Management
+  4. 🤖 Group Functions
+  5. 💬 Conversation Handling
+
+It is built using Golang and supports cross-platform deployment, ensuring a consistent access experience across all platforms.
 
 👉 **[Explore GO SDK](https://github.com/openimsdk/openim-sdk-core)**
 
 ## 🌐 About OpenIMServer
 
-**OpenIMServer**, meticulously developed in Golang, ensures a stellar instant messaging server capability with a multifold approach:
++ **OpenIMServer** has the following characteristics:
+  - 🌐 Microservice architecture: Supports cluster mode, including a gateway and multiple rpc services.
+  - 🚀 Diverse deployment methods: Supports deployment via source code, Kubernetes, or Docker.
+  - Support for massive user base: Super large groups with hundreds of thousands of users, tens of millions of users, and billions of messages.
 
-+ **Modular Composition**: It's comprised of several modules, such as the gateway and multiple RPC services, offering a versatile messaging environment.
-+ **Microservices Architecture**: Supporting cluster modes, it assures outstanding performance and scalability to manage communication effectively across various instances.
-+ **Diverse Deployment Options**: Adapts to your operational preferences, offering deployment via source code, Kubernetes, or Docker.
+### Enhanced Business Functionality:
 
-### Enhanced Business Functionalities:
-
-+ **REST API**: OpenIMServer provides REST API for business systems, aiming to empower your operations with additional functionalities like group creation and message push via backend interfaces.
-+ **Callbacks**: To expand its utility across varied business forms, OpenIMServer offers callback capabilities. That is, it sends a request to the business server before or after an event occurs, such as sending a message, enriching the interaction and data exchange flow in the communication processes.
-
-👉 **[Learn More](https://docs.openim.io/guides/introduction/product)**
-
-<!--
-
-## :star2: Why OpenIM
-
-**🔍 Function screenshot display**
-
-<div align="center">
-
-|            💻🔄📱 Multi Terminal Synchronization 🔄🖥️             |                  📅⚡ Efficient Meetings 🚀💼      |
-| :----------------------------------------------------------: | :---------------------------------------------------------: |
-| ![multiple-message](./assets/demo/multi-terminal-synchronization.png) | ![efficient-meetings](./assets/demo/efficient-meetings.png) |
-|             📲🔄 **One-to-one and Group Chats** 👥🗣️             |        🎁💻 **Special Features - Custom Messages** ✉️🎨|
-|         ![group-chat](./assets/demo/group-chat.png)          |   ![special-function](./assets/demo/special-function.png)      |
-
-</div>
-
-**OpenIM** offers a powerful and reliable instant messaging platform, ensuring versatile communication across multiple platforms with the following key features:
-
-✅ **Versatile Messaging:** Support for text, images, emojis, voice, video, and more, alongside one-on-one and multi-person audio/video calls.
-
-✅ **Robust Chat Capabilities:** Including roles (application administrator, group owner, etc.) and features like muting, group announcements, and dynamic message loading.
-
-✅ **Unique Interaction Features:** Offering read-and-burn private chats and a message editing function to broaden social scenarios.
-
-✅ **Open Source:** The code of OpenIM is open source and aims to build a leading global IM open source community. [GitHub Repository](https://github.com/OpenIMSDK)
-
-✅ **Extensibility:** Implemented in Golang, OpenIM introduces an "everything is a message" communication model, simplifying custom messages and feature extension.
-
-✅ **High Performance:** Supports a hierarchical governance architecture tested and abstracts the storage model of various message types.
-
-✅ **Full Platform Support:** Native support for iOS, Android, Flutter, uni-app, ReactNative, Electron, and Web.
-
--->
++ **REST API**: OpenIMServer offers REST APIs for business systems, aimed at empowering businesses with more functionalities, such as creating groups and sending push messages through backend interfaces.
++ **Webhooks**: OpenIMServer provides callback capabilities to extend more business forms. A callback means that OpenIMServer sends a request to the business server before or after a certain event, like callbacks before or after sending a message.
 
+👉 **[Learn more](https://docs.openim.io/guides/introduction/product)**
 
 ## :rocket: Quick Start
 
-We support many platforms. Here are the addresses for quick experience on the web side：
-
-👉 **[OpenIM online web demo](https://web-enterprise.rentsoft.cn/)**
-
-You can quickly learn OpenIM engineering solutions, all it takes is one simple command:
-
-```bash
-$ make demo
-```
-
-🤲 In order to facilitate the user experience, we have provided a variety of deployment solutions, you can choose your own deployment method according to the list below:
-
-<!--
-<details> <summary>Deploying with Docker Compose</summary>
-
-It is recommended to use Docker Compose for deployment, which can easily and quickly deploy the entire OpenIM service on a single node
-
-+ [https://github.com/openimsdk/openim-docker](https://github.com/openimsdk/openim-docker)
-
-
-> **Note**
->
-> If you don't know OpenIM's versioning policy, 📚Read our release policy: https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/version.md
-
-
-</details> 
-
-<details>  <summary>Compile from Source</summary>
-
-
-Ur need `Go 1.20` or higher version, and `make`.
-
-
-```bash
-go version && make --version || echo "Error: One of the commands failed."
-```
-
-Version Details: https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/version.md
-
-You can get the version number from the command below or from [github releases](https://github.com/openimsdk/open-im-server/tags).
-
-```bash
-$ curl --silent "https://api.github.com/repos/openimsdk/open-im-server/releases" | jq -r '.[].tag_name'
-```
-
-We have our own version management policy, if you are interested in our version management, I recommend reading [📚 OpenIM Version](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/version.md), We recommend using stable versions such as `v3.3.0` and `v3.2.0` whenever possible. `v3.1.1-alpha.3` as well as `v3.3.0-beta.0` and `v3.2.0-rc.0` are pre-release or beta versions and are not recommended.
-
-Set `OPENIM_VERSION` environment variables for the latest `OPENIM_VERSION` number, or replace the `OPENIM_VERSION` for you to install the OpenIM-Server `OPENIM_VERSION`:
-
-```bash
-$ OPENIM_VERSION=`curl -s https://api.github.com/repos/openimsdk/open-im-server/releases/latest | grep -oE '"tag_name": "[^"]+"' | head -n1 | cut -d'"' -f4`
-# OPENIM_VERSION=v3.3.0
-```
-
-Deploy basic components at the click of a command:
-
-```bash
-# install openim dependency
-$ git clone https://github.com/openimsdk/open-im-server openim/openim-server && export openim=$(pwd)/openim/openim-server && cd $openim/openim-server && git checkout $OPENIM_VERSION
-$ make init && docker compose up -d && make start && make check
-```
-
-> `make help` to help you see the instructions supported by OpenIM.
-
-
-You can use the `make help-all` see OpenIM in action.
-
-</details>
-
-<details>  <summary>Component Configuration Instructions</summary>
-
-Read: Configuration center document：https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/environment.md
-
-</details>
-
-
-<details>  <summary>Deployed with kubernetes</summary>
-
-+ https://github.com/openimsdk/open-im-server/blob/main/deployments/README.md
-
-</details> 
--->
+🤲 To facilitate user experience, we offer various deployment solutions. You can choose your deployment method from the list below:
 
 + **[Source Code Deployment Guide](https://docs.openim.io/guides/gettingStarted/imSourceCodeDeployment)**
-+ **[Production deployment of Linux systems](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/install-openim-linux-system.md)**
 + **[Docker Deployment Guide](https://docs.openim.io/guides/gettingStarted/dockerCompose)**
-+ **[Kubernetes Deployment Guide](https://github.com/openimsdk/open-im-server/tree/main/deployments)**
++ **[Kubernetes Deployment Guide](https://docs.openim.io/guides/gettingStarted/k8s-deployment)**
 
-<!-- 
-## :link: OpenIM and your application
-
-OpenIM isn't just an open-source instant messaging component, it's an integral part of your application ecosystem. Check out this diagram to understand how AppServer, AppClient, OpenIMServer, and OpenIMSDK interact.
-
-![App-OpenIM Relationship](./docs/images/oepnim-design.png)
-
-## :building_construction: Overall Architecture
-
-Delve into the heart of Open-IM-Server's functionality with our architecture diagram.
-
-![Overall Architecture](./docs/images/Architecture.jpg) -->
-
-## :hammer_and_wrench: To start developing OpenIM
+## :hammer_and_wrench: To Start Developing OpenIM
 
 [![Open in Dev Container](https://img.shields.io/static/v1?label=Dev%20Container&message=Open&color=blue&logo=visualstudiocode)](https://vscode.dev/github/openimsdk/open-im-server)
 
@@ -236,6 +114,8 @@ Before you start, please make sure your changes are in demand. The best for that
 - [OpenIM Script Utilities](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/util-scripts.md)
 - [OpenIM Versioning](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/version.md)
 - [Manage backend and monitor deployment](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/prometheus-grafana.md)
+- [Mac Developer Deployment Guide for OpenIM](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/mac-developer-deployment-guide.md)
+
 
 ## :busts_in_silhouette: Community
 
@@ -252,7 +132,7 @@ Our conference is in the [OpenIM Slack](https://join.slack.com/t/openimsdk/share
 
 We take notes of each [biweekly meeting](https://github.com/orgs/OpenIMSDK/discussions/categories/meeting) in [GitHub discussions](https://github.com/openimsdk/open-im-server/discussions/categories/meeting), Our historical meeting notes, as well as replays of the meetings are available at [Google Docs :bookmark_tabs:](https://docs.google.com/document/d/1nx8MDpuG74NASx081JcCpxPgDITNTpIIos0DS6Vr9GU/edit?usp=sharing).
 
-## :eyes: Who are using OpenIM
+## :eyes: Who Are Using OpenIM
 
 Check out our [user case studies](https://github.com/OpenIMSDK/community/blob/main/ADOPTERS.md) page for a list of the project users. Don't hesitate to leave a [📝comment](https://github.com/openimsdk/open-im-server/issues/379) and share your use case.
 

assets/README.md

@@ -25,7 +25,7 @@ assets/
 
 ## Copyright Notice:
 
-The OpenIM logo, including its variations and animated versions, displayed in this repository [OpenIM](https://github.com/OpenIMSDK/openim) under the `/assets/logo` and `/assets/logo-gif` directories, are protected by copyright laws.
+The OpenIM logo, including its variations and animated versions, displayed in this repository [OpenIM](https://github.com/openimsdk/open-im-server) under the `/assets/logo` and `/assets/logo-gif` directories, are protected by copyright laws.
 
 The logo design is credited to @Xx(席欣).
 

assets/colors.md

@@ -0,0 +1,11 @@
+# Official Colors
+
+The openim logo has an official blue color.  When reproducing the logo, please use the official color, when possible.
+
+## Pantone
+
+When possible, the Pantone color is preferred for print material.  The official Pantone color is *285C*.
+
+## RGB
+
+When used digitally, the official RGB color code is *#326CE5*.

cmd/openim-api/main.go

@@ -35,7 +35,7 @@ import (
 	"github.com/openimsdk/open-im-server/v3/pkg/common/config"
 	"github.com/openimsdk/open-im-server/v3/pkg/common/db/cache"
 	kdisc "github.com/openimsdk/open-im-server/v3/pkg/common/discoveryregister"
-	ginProm "github.com/openimsdk/open-im-server/v3/pkg/common/ginprometheus"
+	ginprom "github.com/openimsdk/open-im-server/v3/pkg/common/ginprometheus"
 	"github.com/openimsdk/open-im-server/v3/pkg/common/prommetrics"
 )
 
@@ -88,7 +88,7 @@ func run(port int, proPort int) error {
 	log.ZInfo(context.Background(), "api register public config to discov success")
 	router := api.NewGinRouter(client, rdb)
 	if config.Config.Prometheus.Enable {
-		p := ginProm.NewPrometheus("app", prommetrics.GetGinCusMetrics("Api"))
+		p := ginprom.NewPrometheus("app", prommetrics.GetGinCusMetrics("Api"))
 		p.SetListenAddress(fmt.Sprintf(":%d", proPort))
 		p.Use(router)
 	}

config/templates/alertmanager.yml.template

@@ -1,47 +0,0 @@
-# Copyright © 2023 OpenIM. All rights reserved.
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-###################### AlertManager Configuration ######################
-# AlertManager configuration using environment variables
-#
-# Resolve timeout
-# SMTP configuration for sending alerts
-# Templates for email notifications
-# Routing configurations for alerts
-# Receiver configurations
-global:
-  resolve_timeout: 5m
-  smtp_from: alert@openim.io
-  smtp_smarthost: smtp.163.com:465
-  smtp_auth_username: alert@openim.io
-  smtp_auth_password: YOURAUTHPASSWORD
-  smtp_require_tls: false
-  smtp_hello: xxx监控告警
-
-templates:
-  - /etc/alertmanager/email.tmpl
-
-route:
-  group_by: ['alertname']
-  group_wait: 5s
-  group_interval: 5s
-  repeat_interval: 5m
-  receiver: email
-receivers:
-  - name: email
-    email_configs:
-      - to: 'alert@example.com'
-        html: '{{ template "email.to.html" . }}'
-        headers: { Subject: "[OPENIM-SERVER]Alarm" }
-        send_resolved: true

config/templates/config.yaml.template

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

config/templates/email.tmpl.template

@@ -1,16 +0,0 @@
-{{ define "email.to.html" }}
-{{ range .Alerts }}
-<!-- Begin of OpenIM Alert -->
-<div style="border:1px solid #ccc; padding:10px; margin-bottom:10px;">
-    <h3>OpenIM Alert</h3>
-    <p><strong>Alert Program:</strong> Prometheus Alert</p>
-    <p><strong>Severity Level:</strong> {{ .Labels.severity }}</p>
-    <p><strong>Alert Type:</strong> {{ .Labels.alertname }}</p>
-    <p><strong>Affected Host:</strong> {{ .Labels.instance }}</p>
-    <p><strong>Affected Service:</strong> {{ .Labels.job }}</p>
-    <p><strong>Alert Subject:</strong> {{ .Annotations.summary }}</p>
-    <p><strong>Trigger Time:</strong> {{ .StartsAt.Format "2006-01-02 15:04:05" }}</p>
-</div>
-<!-- End of OpenIM Alert -->
-{{ end }}
-{{ end }}

config/templates/env.template

@@ -1,260 +0,0 @@
-# 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.
-
-# ======================================
-# ========= Basic Configuration ========
-# ======================================
-
-# The user for authentication or system operations.
-# Default: OPENIM_USER=root
-USER=root
-
-# Password associated with the specified user for authentication.
-# Default: PASSWORD=openIM123
-PASSWORD=openIM123
-
-# Base URL for the application programming interface (API).
-# Default: API_URL=http://172.28.0.1:10002
-API_URL=http://14.155.64.202:10002
-
-# Directory path for storing data files or related information.
-# Default: DATA_DIR=./
-DATA_DIR=/data/workspaces/open-im-server
-
-# Choose the appropriate image address, the default is GITHUB image, 
-# you can choose docker hub, for Chinese users can choose Ali Cloud
-# export IMAGE_REGISTRY="ghcr.io/openimsdk"
-# export IMAGE_REGISTRY="openim"
-# export IMAGE_REGISTRY="registry.cn-hangzhou.aliyuncs.com/openimsdk"
-IMAGE_REGISTRY=ghcr.io/openimsdk
-
-# ======================================
-# ========= Network Configuration ======
-# ======================================
-
-# Subnet for the Docker network.
-# Default: DOCKER_BRIDGE_SUBNET=172.28.0.0/16
-DOCKER_BRIDGE_SUBNET=172.28.0.0/16
-
-# Gateway for the Docker network.
-# Default: DOCKER_BRIDGE_GATEWAY=172.28.0.1
-DOCKER_BRIDGE_GATEWAY=172.28.0.1
-
-MONGO_NETWORK_ADDRESS=172.28.0.2
-REDIS_NETWORK_ADDRESS=172.28.0.3
-KAFKA_NETWORK_ADDRESS=172.28.0.4
-ZOOKEEPER_NETWORK_ADDRESS=172.28.0.5
-MINIO_NETWORK_ADDRESS=172.28.0.6
-OPENIM_WEB_NETWORK_ADDRESS=172.28.0.7
-OPENIM_SERVER_NETWORK_ADDRESS=172.28.0.8
-OPENIM_CHAT_NETWORK_ADDRESS=172.28.0.9
-PROMETHEUS_NETWORK_ADDRESS=172.28.0.10
-GRAFANA_NETWORK_ADDRESS=172.28.0.11
-NODE_EXPORTER_NETWORK_ADDRESS=172.28.0.12
-OPENIM_ADMIN_FRONT_NETWORK_ADDRESS=172.28.0.13
-ALERT_MANAGER_NETWORK_ADDRESS=172.28.0.14
-
-# ===============================================
-# = Component Extension Configuration =
-# ===============================================
-
-# ============ Component Extension Configuration ==========
-# ----- ZooKeeper Configuration -----
-# Address or hostname for the ZooKeeper service.
-# Default: ZOOKEEPER_ADDRESS=172.28.0.1
-ZOOKEEPER_ADDRESS=172.28.0.5
-
-# Port for ZooKeeper service.
-# Default: ZOOKEEPER_PORT=12181
-ZOOKEEPER_PORT=12181
-
-# ----- MongoDB Configuration -----
-# Address or hostname for the MongoDB service.
-# Default: MONGO_ADDRESS=172.28.0.1
-MONGO_ADDRESS=172.28.0.2
-
-# Port on which MongoDB service is running.
-# Default: MONGO_PORT=37017
-# MONGO_PORT=37017
-
-# Username to authenticate with the MongoDB service.
-# Default: MONGO_USERNAME=root
-# MONGO_USERNAME=root
-
-# Password to authenticate with the MongoDB service.
-# Default: MONGO_PASSWORD=openIM123
-MONGO_PASSWORD=openIM123
-
-# Name of the database in MongoDB to be used.
-# Default: MONGO_DATABASE=openIM_v3
-MONGO_DATABASE=openIM_v3
-
-# ----- Redis Configuration -----
-# Address or hostname for the Redis service.
-# Default: REDIS_ADDRESS=172.28.0.1
-REDIS_ADDRESS=172.28.0.3
-
-# Port on which Redis in-memory data structure store is running.
-# Default: REDIS_PORT=16379
-REDIS_PORT=16379
-
-# Password to authenticate with the Redis service.
-# Default: REDIS_PASSWORD=openIM123
-REDIS_PASSWORD=openIM123
-
-# ----- Kafka Configuration -----
-# Address or hostname for the Kafka service.
-# Default: KAFKA_ADDRESS=172.28.0.1
-KAFKA_ADDRESS=172.28.0.4
-
-# Kakfa username to authenticate with the Kafka service.
-# KAFKA_USERNAME=''
-
-# Port on which Kafka distributed streaming platform is running.
-# Default: KAFKA_PORT=19092
-KAFKA_PORT=19094
-
-# Topic in Kafka for storing the latest messages in Redis.
-# Default: KAFKA_LATESTMSG_REDIS_TOPIC=latestMsgToRedis
-KAFKA_LATESTMSG_REDIS_TOPIC=latestMsgToRedis
-
-# Topic in Kafka for pushing messages (e.g. notifications or updates).
-# Default: KAFKA_MSG_PUSH_TOPIC=msgToPush
-KAFKA_MSG_PUSH_TOPIC=msgToPush
-
-# Topic in Kafka for storing offline messages in MongoDB.
-# Default: KAFKA_OFFLINEMSG_MONGO_TOPIC=offlineMsgToMongoMysql
-KAFKA_OFFLINEMSG_MONGO_TOPIC=offlineMsgToMongoMysql
-
-# ----- MinIO Configuration ----
-# Address or hostname for the MinIO object storage service.
-# Default: MINIO_ADDRESS=172.28.0.1
-MINIO_ADDRESS=172.28.0.6
-
-# Port on which MinIO object storage service is running.
-# Default: MINIO_PORT=10005
-MINIO_PORT=10005
-
-# Access key to authenticate with the MinIO service.
-# Default: MINIO_ACCESS_KEY=root
-# MINIO_ACCESS_KEY=root
-
-# Secret key corresponding to the access key for MinIO authentication.
-# Default: MINIO_SECRET_KEY=openIM123
-MINIO_SECRET_KEY=openIM123
-
-# ----- Prometheus Configuration -----
-# Address or hostname for the Prometheus service.
-# Default: PROMETHEUS_ADDRESS=172.28.0.1
-PROMETHEUS_ADDRESS=172.28.0.10
-
-# Port on which Prometheus service is running.
-# Default: PROMETHEUS_PORT=19090
-PROMETHEUS_PORT=19090
-
-# ----- Grafana Configuration -----
-# Address or hostname for the Grafana service.
-# Default: GRAFANA_ADDRESS=172.28.0.1
-GRAFANA_ADDRESS=172.28.0.11
-
-# Port on which Grafana service is running.
-# Default: GRAFANA_PORT=13000
-GRAFANA_PORT=13000
-
-# ======================================
-# ============ OpenIM Web ===============
-# ======================================
-
-# Path to the OpenIM web distribution.
-# Default: OPENIM_WEB_DIST_PATH=/app/dist
-OPENIM_WEB_DIST_PATH=/app/dist
-
-# Port on which OpenIM web service is running.
-# Default: OPENIM_WEB_PORT=11001
-OPENIM_WEB_PORT=11001
-
-# Address or hostname for the OpenIM web service.
-# Default: OPENIM_WEB_ADDRESS=172.28.0.1
-OPENIM_WEB_ADDRESS=172.28.0.7
-
-# ======================================
-# ========= OpenIM Server ==============
-# ======================================
-
-# Address or hostname for the OpenIM server.
-# Default: OPENIM_SERVER_ADDRESS=172.28.0.1
-OPENIM_SERVER_ADDRESS=172.28.0.8
-
-# Port for the OpenIM WebSockets.
-# Default: OPENIM_WS_PORT=10001
-OPENIM_WS_PORT=10001
-
-# Port for the OpenIM API.
-# Default: API_OPENIM_PORT=10002
-API_OPENIM_PORT=10002
-
-
-# ======================================
-# ========== OpenIM Chat ===============
-# ======================================
-
-# Branch name for OpenIM chat.
-# Default: CHAT_IMAGE_VERSION=main
-# https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/version.md
-CHAT_IMAGE_VERSION=main
-
-# Address or hostname for the OpenIM chat service.
-# Default: OPENIM_CHAT_ADDRESS=172.28.0.1
-OPENIM_CHAT_ADDRESS=172.28.0.9
-
-# Port for the OpenIM chat API.
-# Default: OPENIM_CHAT_API_PORT=10008
-OPENIM_CHAT_API_PORT=10008
-
-# Directory path for storing data files or related information for OpenIM chat.
-# Default: OPENIM_CHAT_DATA_DIR=./openim-chat/main
-OPENIM_CHAT_DATA_DIR=./openim-chat/main
-
-
-# ======================================
-# ========== OpenIM Admin ==============
-# ======================================
-
-# Branch name for OpenIM server.
-# Default: SERVER_IMAGE_VERSION=main
-SERVER_IMAGE_VERSION=main
-
-# Port for the OpenIM admin API.
-# Default: OPENIM_ADMIN_API_PORT=10009
-OPENIM_ADMIN_API_PORT=10009
-  
-# Port for the node exporter.
-# Default: NODE_EXPORTER_PORT=19100
-NODE_EXPORTER_PORT=19100
-  
-# Port for the prometheus.
-# Default: PROMETHEUS_PORT=19090
-PROMETHEUS_PORT=19090
-  
-# Port for the grafana.
-# Default: GRAFANA_PORT=13000
-GRAFANA_PORT=13000
-  
-# Port for the admin front.
-# Default: OPENIM_ADMIN_FRONT_PORT=11002
-OPENIM_ADMIN_FRONT_PORT=11002
-
-# Port for the alertmanager.
-# Default: ALERT_MANAGER_PORT=19093
-ALERT_MANAGER_PORT=19093

config/templates/instance-down-rules.yml.template

@@ -1,36 +0,0 @@
-# Copyright © 2023 OpenIM. All rights reserved.
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-groups:
-  - name: instance_down
-    rules:
-      - alert: InstanceDown
-        expr: up == 0
-        for: 1m
-        labels:
-          severity: critical
-        annotations:
-          summary: "Instance {{ $labels.instance }} down"
-          description: "{{ $labels.instance }} of job {{ $labels.job }} has been down for more than 1 minutes."
-
-  - name: database_insert_failure_alerts
-    rules:
-      - alert: DatabaseInsertFailed
-        expr: (increase(msg_insert_redis_failed_total[5m]) > 0) or (increase(msg_insert_mongo_failed_total[5m]) > 0)
-        for: 1m
-        labels:
-          severity: critical
-        annotations:
-          summary: "Increase in MsgInsertRedisFailedCounter or MsgInsertMongoFailedCounter detected"
-          description: "Either MsgInsertRedisFailedCounter or MsgInsertMongoFailedCounter has increased in the last 5 minutes, indicating failures in message insert operations to Redis or MongoDB,maybe the redis or mongodb is crash."

config/templates/notification.yaml.template

@@ -1,354 +0,0 @@
-# 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.
-
-# Determines if a message should be sent. If set to false, it triggers a silent sync without a message. If true, it requires triggering a conversation.
-# For rpc notification, send twice: once as a message and once as a notification.
-# The options field 'isNotification' indicates if it's a notification.
-groupCreated:
-  isSendMsg: true
-
-# Reliability level of the message sending.
-# Set to 1 to send only when online, 2 for guaranteed delivery.
-  reliabilityLevel: 1
-
-# This setting is effective only when 'isSendMsg' is true.
-# It controls whether to count unread messages.
-  unreadCount: false
-
-# Configuration for offline push notifications.
-  offlinePush:
-    # Enables or disables offline push notifications.
-    enable: false
-
-    # Title for the notification when a group is created.
-    title: "create group title"
-
-    # Description for the notification.
-    desc: "create group desc"
-
-    # Additional information for the notification.
-    ext: "create group ext"
-
-# Content type is not added here.
-# Content should use a JSON structure conforming to the protobuf format.
-
-groupInfoSet:
-  isSendMsg: false
-  reliabilityLevel: 1
-  unreadCount: false
-  offlinePush:
-    enable: false
-    title: "groupInfoSet title"
-    desc: "groupInfoSet desc"
-    ext: "groupInfoSet ext"
-
-
-joinGroupApplication:
-  isSendMsg: false
-  reliabilityLevel: 1
-  unreadCount: false
-  offlinePush:
-    enable: false
-    title: "joinGroupApplication title"
-    desc: "joinGroupApplication desc"
-    ext: "joinGroupApplication ext"
-
-memberQuit:
-  isSendMsg: true
-  reliabilityLevel: 1
-  unreadCount: false
-  offlinePush:
-    enable: false
-    title: "memberQuit title"
-    desc: "memberQuit desc"
-    ext: "memberQuit ext"
-
-groupApplicationAccepted:
-  isSendMsg: false
-  reliabilityLevel: 1
-  unreadCount: false
-  offlinePush:
-    enable: false
-    title: "groupApplicationAccepted title"
-    desc: "groupApplicationAccepted desc"
-    ext: "groupApplicationAccepted ext"
-
-groupApplicationRejected:
-  isSendMsg: false
-  reliabilityLevel: 1
-  unreadCount: false
-  offlinePush:
-    enable: false
-    title: " title"
-    desc: " desc"
-    ext: " ext"
-
-
-groupOwnerTransferred:
-  isSendMsg: true
-  reliabilityLevel: 1
-  unreadCount: false
-  offlinePush:
-    enable: false
-    title: "groupOwnerTransferred title"
-    desc: "groupOwnerTransferred desc"
-    ext: "groupOwnerTransferred ext"
-
-memberKicked:
-  isSendMsg: true
-  reliabilityLevel: 1
-  unreadCount: false
-  offlinePush:
-    enable: false
-    title: "memberKicked title"
-    desc: "memberKicked desc"
-    ext: "memberKicked ext"
-
-memberInvited:
-  isSendMsg: true
-  reliabilityLevel: 1
-  unreadCount: false
-  offlinePush:
-    enable: false
-    title: "memberInvited title"
-    desc: "memberInvited desc"
-    ext: "memberInvited ext"
-
-memberEnter:
-  isSendMsg: true
-  reliabilityLevel: 1
-  unreadCount: false
-  offlinePush:
-    enable: false
-    title: "memberEnter title"
-    desc: "memberEnter desc"
-    ext: "memberEnter ext"
-
-groupDismissed:
-  isSendMsg: true
-  reliabilityLevel: 1
-  unreadCount: false
-  offlinePush:
-    enable: false
-    title: "groupDismissed title"
-    desc: "groupDismissed desc"
-    ext: "groupDismissed ext"
-
-groupMuted:
-  isSendMsg: true
-  reliabilityLevel: 1
-  unreadCount: false
-  offlinePush:
-    enable: false
-    title: "groupMuted title"
-    desc: "groupMuted desc"
-    ext: "groupMuted ext"
-
-groupCancelMuted:
-  isSendMsg: true
-  reliabilityLevel: 1
-  unreadCount: false
-  offlinePush:
-    enable: false
-    title: "groupCancelMuted title"
-    desc: "groupCancelMuted desc"
-    ext: "groupCancelMuted ext"
-  defaultTips:
-    tips: "group Cancel Muted"
-
-
-groupMemberMuted:
-  isSendMsg: true
-  reliabilityLevel: 1
-  unreadCount: false
-  offlinePush:
-    enable: false
-    title: "groupMemberMuted title"
-    desc: "groupMemberMuted desc"
-    ext: "groupMemberMuted ext"
-
-groupMemberCancelMuted:
-  isSendMsg: true
-  reliabilityLevel: 1
-  unreadCount: false
-  offlinePush:
-    enable: false
-    title: "groupMemberCancelMuted title"
-    desc: "groupMemberCancelMuted desc"
-    ext: "groupMemberCancelMuted ext"
-
-groupMemberInfoSet:
-  isSendMsg: false
-  reliabilityLevel: 1
-  unreadCount: false
-  offlinePush:
-    enable: false
-    title: "groupMemberInfoSet title"
-    desc: "groupMemberInfoSet desc"
-    ext: "groupMemberInfoSet ext"
-
-groupInfoSetAnnouncement:
-  isSendMsg: true
-  reliabilityLevel: 1
-  unreadCount: false
-  offlinePush:
-    enable: false
-    title: "groupInfoSetAnnouncement title"
-    desc: "groupInfoSetAnnouncement desc"
-    ext: "groupInfoSetAnnouncement ext"
-
-
-groupInfoSetName:
-  isSendMsg: true
-  reliabilityLevel: 1
-  unreadCount: false
-  offlinePush:
-    enable: false
-    title: "groupInfoSetName title"
-    desc: "groupInfoSetName desc"
-    ext: "groupInfoSetName ext"
-
-
-#############################friend#################################
-friendApplicationAdded:
-  isSendMsg: false
-  reliabilityLevel: 1
-  unreadCount: false
-  offlinePush:
-    enable: false
-    title: "Somebody applies to add you as a friend"
-    desc: "Somebody applies to add you as a friend"
-    ext: "Somebody applies to add you as a friend"
-
-friendApplicationApproved:
-  isSendMsg: true
-  reliabilityLevel: 1
-  unreadCount: false
-  offlinePush:
-    enable: true
-    title: "Someone applies to add your friend application"
-    desc: "Someone applies to add your friend application"
-    ext: "Someone applies to add your friend application"
-
-friendApplicationRejected:
-  isSendMsg: false
-  reliabilityLevel: 1
-  unreadCount: false
-  offlinePush:
-    enable: true
-    title: "Someone rejected your friend application"
-    desc: "Someone rejected your friend application"
-    ext: "Someone rejected your friend application"
-
-friendAdded:
-  isSendMsg: false
-  reliabilityLevel: 1
-  unreadCount: false
-  offlinePush:
-    enable: true
-    title: "We have become friends"
-    desc: "We have become friends"
-    ext: "We have become friends"
-
-friendDeleted:
-  isSendMsg: false
-  reliabilityLevel: 1
-  unreadCount: false
-  offlinePush:
-    enable: true
-    title: "deleted a friend"
-    desc: "deleted a friend"
-    ext: "deleted a friend"
-
-friendRemarkSet:
-  isSendMsg: false
-  reliabilityLevel: 1
-  unreadCount: false
-  offlinePush:
-    enable: true
-    title: "Your friend's profile has been changed"
-    desc: "Your friend's profile has been changed"
-    ext: "Your friend's profile has been changed"
-
-blackAdded:
-  isSendMsg: false
-  reliabilityLevel: 1
-  unreadCount: false
-  offlinePush:
-    enable: true
-    title: "blocked a user"
-    desc: "blocked a user"
-    ext: "blocked a user"
-
-blackDeleted:
-  isSendMsg: false
-  reliabilityLevel: 1
-  unreadCount: false
-  offlinePush:
-    enable: true
-    title: "Remove a blocked user"
-    desc: "Remove a blocked user"
-    ext: "Remove a blocked user"
-
-friendInfoUpdated:
-  isSendMsg: false
-  reliabilityLevel: 1
-  unreadCount: false
-  offlinePush:
-    enable: true
-    title: "friend info updated"
-    desc: "friend info updated"
-    ext: "friend info updated"
-
-#####################user#########################
-userInfoUpdated:
-  isSendMsg: false
-  reliabilityLevel: 1
-  unreadCount: false
-  offlinePush:
-    enable: true
-    title: "Remove a blocked user"
-    desc: "Remove a blocked user"
-    ext: "Remove a blocked user"
-
-userStatusChanged:
-  isSendMsg: false
-  reliabilityLevel: 1
-  unreadCount: false
-  offlinePush:
-    enable: false
-    title: "user status changed"
-    desc: "user status changed"
-    ext: "user status changed"
-
-#####################conversation#########################
-conversationChanged:
-  isSendMsg: false
-  reliabilityLevel: 1
-  unreadCount: false
-  offlinePush:
-    enable: true
-    title: "conversation changed"
-    desc: "conversation changed"
-    ext: "conversation changed"
-
-conversationSetPrivate:
-  isSendMsg: true
-  reliabilityLevel: 1
-  unreadCount: false
-  offlinePush:
-    enable: true
-    title: "burn after reading"
-    desc: "burn after reading"
-    ext: "burn after reading"

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

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

config/templates/prometheus.yml.template

@@ -1,99 +0,0 @@
-# Copyright © 2023 OpenIM. All rights reserved.
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-# my global config
-global:
-  scrape_interval:     15s # Set the scrape interval to every 15 seconds. Default is every 1 minute.
-  evaluation_interval: 15s # Evaluate rules every 15 seconds. The default is every 1 minute.
-  # scrape_timeout is set to the global default (10s).
-
-# Alertmanager configuration
-alerting:
-  alertmanagers:
-    - static_configs:
-        - targets: ['172.28.0.1:19093']
-
-# Load rules once and periodically evaluate them according to the global 'evaluation_interval'.
-rule_files:
-  - "instance-down-rules.yml"
-# - "first_rules.yml"
-# - "second_rules.yml"
-
-# A scrape configuration containing exactly one endpoint to scrape:
-# Here it's Prometheus itself.
-scrape_configs:
-  # The job name is added as a label "job='job_name'"" to any timeseries scraped from this config.
-  # Monitored information captured by prometheus
-  - job_name: 'node-exporter'
-    static_configs:
-      - targets: [ '172.28.0.1:19100' ]
-        labels:
-          namespace: 'default'
-
-  # prometheus fetches application services
-  - job_name: 'openimserver-openim-api'
-    static_configs:
-      - targets: [ '172.28.0.1:20100' ]
-        labels:
-          namespace: 'default'
-  - job_name: 'openimserver-openim-msggateway'
-    static_configs:
-      - targets: [ '172.28.0.1:20140' ]
-        labels:
-          namespace: 'default'
-  - job_name: 'openimserver-openim-msgtransfer'
-    static_configs:
-      - targets: [ 172.28.0.1:21400, 172.28.0.1:21401, 172.28.0.1:21402, 172.28.0.1:21403 ]
-        labels:
-          namespace: 'default'
-  - job_name: 'openimserver-openim-push'
-    static_configs:
-      - targets: [ '172.28.0.1:20170' ]
-        labels:
-          namespace: 'default'
-  - job_name: 'openimserver-openim-rpc-auth'
-    static_configs:
-      - targets: [ '172.28.0.1:20160' ]
-        labels:
-          namespace: 'default'
-  - job_name: 'openimserver-openim-rpc-conversation'
-    static_configs:
-      - targets: [ '172.28.0.1:20230' ]
-        labels:
-          namespace: 'default'
-  - job_name: 'openimserver-openim-rpc-friend'
-    static_configs:
-      - targets: [ '172.28.0.1:20120' ]
-        labels:
-          namespace: 'default'
-  - job_name: 'openimserver-openim-rpc-group'
-    static_configs:
-      - targets: [ '172.28.0.1:20150' ]
-        labels:
-          namespace: 'default'
-  - job_name: 'openimserver-openim-rpc-msg'
-    static_configs:
-      - targets: [ '172.28.0.1:20130' ]
-        labels:
-          namespace: 'default'
-  - job_name: 'openimserver-openim-rpc-third'
-    static_configs:
-      - targets: [ '172.28.0.1:21301' ]
-        labels:
-          namespace: 'default'
-  - job_name: 'openimserver-openim-rpc-user'
-    static_configs:
-      - targets: [ '172.28.0.1:20110' ]
-        labels:
-          namespace: 'default'

deployments/Readme.md

@@ -165,7 +165,7 @@ export MINIO_ENDPOINT="http://im-minio:9000"
 export MINIO_SIGN_ENDPOINT="https://openim.server.com/im-minio-api"
 
 mkdir ./charts/generated-configs
-../scripts/genconfig.sh ../scripts/install/environment.sh ./templates/openim.yaml > ./charts/generated-configs/config.yaml
+../scripts/genconfig.sh ../scripts/install/environment.sh ./templates/config.yaml > ./charts/generated-configs/config.yaml
 cp ../config/notification.yaml ./charts/generated-configs/notification.yaml
 ../scripts/genconfig.sh ../scripts/install/environment.sh ./templates/helm-image.yaml > ./charts/generated-configs/helm-image.yaml
 ```

deployments/templates/config.yaml

@@ -14,7 +14,7 @@
 
 # -----------------------------------------------------------------
 # TODO: This config file is the template file
-# --| source: deployments/templates/openim.yaml
+# --| source: deployments/templates/config.yaml
 # --| env: scripts/install/environment
 # --| target: config/config.yaml
 # -----------------------------------------------------------------
@@ -315,13 +315,21 @@ iosPush:
 # Timeout in seconds
 # Whether to continue execution if callback fails
 callback:
-  url: ""
+  url: "http://127.0.0.1:10008/callbackExample"
   beforeSendSingleMsg:
     enable: ${CALLBACK_ENABLE}
     timeout: ${CALLBACK_TIMEOUT}
     failedContinue: ${CALLBACK_FAILED_CONTINUE}
+  beforeUpdateUserInfoEx:
+    enable:  ${CALLBACK_ENABLE}
+    timeout: ${CALLBACK_TIMEOUT}
+    failedContinue: ${CALLBACK_FAILED_CONTINUE}
+  afterUpdateUserInfoEx:
+    enable:  ${CALLBACK_ENABLE}
+    timeout: ${CALLBACK_TIMEOUT}
+    failedContinue: ${CALLBACK_FAILED_CONTINUE}
   afterSendSingleMsg:
-    enable: ${CALLBACK_ENABLE}
+    enable: true
     timeout: ${CALLBACK_TIMEOUT}
     failedContinue: ${CALLBACK_FAILED_CONTINUE}
   beforeSendGroupMsg:

deployments/templates/env-template.yaml

@@ -1,3 +1,17 @@
+# Copyright © 2024 OpenIM. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
 # -----------------------------------------------------------------------------
 # General Configuration
 # This section contains general configuration options for the entire environment.
@@ -88,10 +102,6 @@ ZOOKEEPER_PORT=${ZOOKEEPER_PORT}
 # Default: MONGO_PORT=37017
 # MONGO_PORT=${MONGO_PORT}
 
-# Username for MongoDB admin user. Used for service authentication.
-# Default: MONGO_USERNAME=root
-# MONGO_USERNAME=${MONGO_USERNAME}
-
 # Password for MongoDB admin user. Used for service authentication.
 # Default: MONGO_PASSWORD=openIM123
 MONGO_PASSWORD=${MONGO_PASSWORD}
@@ -105,7 +115,7 @@ MONGO_OPENIM_USERNAME=${MONGO_OPENIM_USERNAME}
 MONGO_OPENIM_PASSWORD=${MONGO_OPENIM_PASSWORD}
 
 # Specifies the database name to be used within MongoDB.
-# Default: MONGO_DATABASE=openIM_v3
+# Default: MONGO_DATABASE=openim_v3
 MONGO_DATABASE=${MONGO_DATABASE}
 
 # ----- Redis Configuration -----
@@ -161,10 +171,6 @@ GRAFANA_PORT=${GRAFANA_PORT}
 # ============ OpenIM Web ===============
 # ======================================
 
-# Path to the OpenIM web distribution.
-# Default: OPENIM_WEB_DIST_PATH=/app/dist
-OPENIM_WEB_DIST_PATH=${OPENIM_WEB_DIST_PATH}
-
 # Port on which OpenIM web service is running.
 # Default: OPENIM_WEB_PORT=11001
 OPENIM_WEB_PORT=${OPENIM_WEB_PORT}

docker-compose.yml

@@ -10,15 +10,13 @@ networks:
         - subnet: '${DOCKER_BRIDGE_SUBNET:-172.28.0.0/16}'
           gateway: '${DOCKER_BRIDGE_GATEWAY:-172.28.0.1}'
 
-
-
 services:
   mongodb:
     image: mongo:${MONGODB_IMAGE_VERSION-6.0.2}
     ports:
       - "${MONGO_PORT:-37017}:27017"
     container_name: mongo
-    command: --wiredTigerCacheSizeGB 1 --auth
+    command: ["/bin/bash", "-c", "/docker-entrypoint-initdb.d/mongo-init.sh || true; docker-entrypoint.sh mongod --wiredTigerCacheSizeGB 1 --auth"]
     volumes:
       - "${DATA_DIR:-./}/components/mongodb/data/db:/data/db"
       - "${DATA_DIR:-./}/components/mongodb/data/logs:/data/logs"
@@ -29,7 +27,7 @@ services:
       - wiredTigerCacheSizeGB=1
       - MONGO_INITDB_ROOT_USERNAME=${MONGO_USERNAME:-root}
       - MONGO_INITDB_ROOT_PASSWORD=${MONGO_PASSWORD:-openIM123}
-      - MONGO_INITDB_DATABASE=${MONGO_DATABASE:-openIM_v3}
+      - MONGO_INITDB_DATABASE=${MONGO_DATABASE:-openim_v3}
       - MONGO_OPENIM_USERNAME=${MONGO_OPENIM_USERNAME:-openIM} # Non-root username
       - MONGO_OPENIM_PASSWORD=${MONGO_OPENIM_PASSWORD:-openIM123456} # Non-root password
     restart: always
@@ -89,6 +87,7 @@ services:
        - KAFKA_CFG_CONTROLLER_QUORUM_VOTERS=0@<your_host>:9093
        - KAFKA_CFG_LISTENERS=PLAINTEXT://:9092,CONTROLLER://:9093,EXTERNAL://:9094
        - KAFKA_CFG_ADVERTISED_LISTENERS=PLAINTEXT://kafka:9092,EXTERNAL://${DOCKER_BRIDGE_GATEWAY:-172.28.0.1}:${KAFKA_PORT:-19094}
+      #  - KAFKA_CFG_ADVERTISED_LISTENERS=PLAINTEXT://kafka:9092,EXTERNAL://127.0.0.1:${KAFKA_PORT:-19094} # Mac Deployment
        - KAFKA_CFG_LISTENER_SECURITY_PROTOCOL_MAP=CONTROLLER:PLAINTEXT,EXTERNAL:PLAINTEXT,PLAINTEXT:PLAINTEXT
        - KAFKA_CFG_CONTROLLER_LISTENER_NAMES=CONTROLLER
     networks:
@@ -96,7 +95,7 @@ services:
         ipv4_address: ${KAFKA_NETWORK_ADDRESS:-172.28.0.4}
 
   minio:
-    image: minio/minio:${MINIO_IMAGE_VERSION:-latest}
+    image: minio/minio:${MINIO_IMAGE_VERSION:-RELEASE.2024-01-11T07-46-16Z}
     ports:
       - "${MINIO_PORT:-10005}:9000"
       - "9090:9090"
@@ -114,22 +113,129 @@ services:
         ipv4_address: ${MINIO_NETWORK_ADDRESS:-172.28.0.6}
 
   openim-web:
-    image: ${IMAGE_REGISTRY:-ghcr.io/openimsdk}/openim-web:${OPENIM_WEB_IMAGE_VERSION:-latest}
+    image: ${IMAGE_REGISTRY:-ghcr.io/openimsdk}/openim-web:${OPENIM_WEB_IMAGE_VERSION:-v3.5.0-docker}
     container_name: openim-web
-    environment:
-      - OPENIM_WEB_DIST_PATH=${OPENIM_WEB_DIST_PATH:-/app/dist}
-      - OPENIM_WEB_PORT=${OPENIM_WEB_PORT:-11001}
+    platform: linux/amd64
     restart: always
     ports:
-      - "${OPENIM_WEB_PORT:-11001}:11001"
+      - "${OPENIM_WEB_PORT:-11001}:80"
     networks:
       server:
         ipv4_address: ${OPENIM_WEB_NETWORK_ADDRESS:-172.28.0.7}
 
-  # Uncomment and configure the following services as needed
+### TODO: Uncomment, or deploy using openim docker: https://github.com/openimsdk/openim-docker
+### Uncomment and configure the following services as needed
+
+  # openim-server:
+  #   image: ${IMAGE_REGISTRY:-ghcr.io/openimsdk}/openim-server:${SERVER_IMAGE_VERSION:-main}
+  #   container_name: openim-server
+  #   ports:
+  #     - "${OPENIM_WS_PORT:-10001}:${OPENIM_WS_PORT:-10001}"
+  #     - "${API_OPENIM_PORT:-10002}:${API_OPENIM_PORT:-10002}"
+  #     - "${API_PROM_PORT:-20100}:${API_PROM_PORT:-20100}"
+  #     - "${USER_PROM_PORT:-20110}:${USER_PROM_PORT:-20110}"
+  #     - "${FRIEND_PROM_PORT:-20120}:${FRIEND_PROM_PORT:-20120}"
+  #     - "${MESSAGE_PROM_PORT:-20130}:${MESSAGE_PROM_PORT:-20130}"
+  #     - "${MSG_GATEWAY_PROM_PORT:-20140}:${MSG_GATEWAY_PROM_PORT:-20140}"
+  #     - "${GROUP_PROM_PORT:-20150}:${GROUP_PROM_PORT:-20150}"
+  #     - "${AUTH_PROM_PORT:-20160}:${AUTH_PROM_PORT:-20160}"
+  #     - "${PUSH_PROM_PORT:-20170}:${PUSH_PROM_PORT:-20170}"
+  #     - "${CONVERSATION_PROM_PORT:-20230}:${CONVERSATION_PROM_PORT:-20230}"
+  #     - "${RTC_PROM_PORT:-21300}:${RTC_PROM_PORT:-21300}"
+  #     - "${THIRD_PROM_PORT:-21301}:${THIRD_PROM_PORT:-21301}"
+  #     - "21400-21403:21400-21403"
+  #   healthcheck:
+  #     test: ["CMD", "/openim/openim-server/scripts/check-all.sh"]
+  #     interval: 120s
+  #     timeout: 30s
+  #     retries: 5
+  #   env_file:
+  #     - .env
+  #   environment:
+  #     - OPENIM_IP=${OPENIM_IP:-127.0.0.1}
+  #   volumes:
+  #     - "${DATA_DIR:-./}/openim-server/logs:/openim/openim-server/logs"
+  #     - "${DATA_DIR:-./}/openim-server/_output/logs:/openim/openim-server/_output/logs"
+  #     - "${DATA_DIR:-./}/openim-server/config:/openim/openim-server/config"
+  #   restart: always
+  #   depends_on:
+  #     - kafka
+  #     - mysql
+  #     - mongodb
+  #     - redis
+  #     - minio
+  #   logging:
+  #     driver: json-file
+  #     options:
+  #       max-size: "1g"
+  #       max-file: "2"
+  #   networks:
+  #     server:
+  #       ipv4_address: ${OPENIM_SERVER_NETWORK_ADDRESS:-172.28.0.8}
+
+### TODO: mysql is required to deploy the openim-chat component
+  # mysql:
+  #   image: mysql:${MYSQL_IMAGE_VERSION:-5.7}
+  #   platform: linux/amd64
+  #   ports:
+  #     - "${MYSQL_PORT:-13306}:3306"
+  #   container_name: mysql
+  #   volumes:
+  #     - "${DATA_DIR:-./}/components/mysql/data:/var/lib/mysql"
+  #     - "/etc/localtime:/etc/localtime"
+  #   environment:
+  #     MYSQL_ROOT_PASSWORD: "${MYSQL_PASSWORD:-openIM123}"
+  #   restart: always
+  #   networks:
+  #     server:
+  #       ipv4_address: ${MYSQL_NETWORK_ADDRESS:-172.28.0.15}
+
+  # openim-chat:
+  #   image: ${IMAGE_REGISTRY:-ghcr.io/openimsdk}/openim-chat:${CHAT_IMAGE_VERSION:-main}
+  #   container_name: openim-chat
+  #   healthcheck:
+  #     test: ["CMD", "/openim/openim-chat/scripts/check_all.sh"]
+  #     interval: 60s
+  #     timeout: 30s
+  #     retries: 5
+  #   env_file:
+  #     - .env
+  #   environment:
+  #     - ZOOKEEPER_ADDRESS=${DOCKER_BRIDGE_GATEWAY:-172.28.0.1}
+  #     - ZOOKEEPER_PORT=${ZOOKEEPER_PORT:-12181}
+  #     - OPENIM_SERVER_ADDRESS=http://${OPENIM_SERVER_ADDRESS:-172.28.0.1}
+  #     - API_OPENIM_PORT=${API_OPENIM_PORT:-10002}
+  #     - MYSQL_ADDRESS=${DOCKER_BRIDGE_GATEWAY:-172.28.0.1}
+  #     - MYSQL_PORT=${MYSQL_PORT:-13306}
+  #     - REDIS_ADDRESS=${DOCKER_BRIDGE_GATEWAY:-172.28.0.1}
+  #     - REDIS_PORT=${REDIS_PORT:-16379}
+  #   ports:
+  #     - "${OPENIM_CHAT_API_PORT:-10008}:10008"
+  #     - "${OPENIM_ADMIN_API_PORT:-10009}:10009"
+  #   volumes:
+  #     - "${DATA_DIR:-./}/components/openim-chat/logs:/openim/openim-chat/logs"
+  #     - "${DATA_DIR:-./}/components/openim-chat/config:/openim/openim-chat/config"
+  #   restart: always
+  #   # user: root:root
+  #   depends_on:
+  #     - mysql
+  #     - kafka
+  #     - redis
+  #     - zookeeper
+  #   logging:
+  #     driver: json-file
+  #     options:
+  #       max-size: "1g"
+  #       max-file: "2"
+  #   networks:
+  #     server:
+  #       ipv4_address: ${OPENIM_CHAT_NETWORK_ADDRESS:-172.28.0.9}
+
   # openim-admin:
-  #   image: ${IMAGE_REGISTRY:-ghcr.io/openimsdk}/openim-admin-front:v3.4.0
+  # # https://github.com/openimsdk/open-im-server/issues/1662
+  #   image: ${IMAGE_REGISTRY:-ghcr.io/openimsdk}/openim-admin:${ADMIN_FRONT_VERSION:-toc-base-open-docker.35}
   #   container_name: openim-admin
+  #   platform: linux/amd64
   #   restart: always
   #   ports:
   #     - "${OPENIM_ADMIN_FRONT_PORT:-11002}:80"
@@ -143,8 +249,8 @@ services:
   #   hostname: prometheus
   #   restart: always
   #   volumes:
-  #     - ./config/prometheus.yml:/etc/prometheus/prometheus.yml
-  #     - ./config/instance-down-rules.yml:/etc/prometheus/instance-down-rules.yml
+  #     - "${DATA_DIR:-./}/config/instance-down-rules.yml:/etc/prometheus/instance-down-rules.yml"
+  #     - "${DATA_DIR:-./}/config/prometheus.yml:/etc/prometheus/prometheus.yml"
   #   ports:
   #     - "${PROMETHEUS_PORT:-19090}:9090"
   #   networks:
@@ -157,8 +263,8 @@ services:
   #   hostname: alertmanager
   #   restart: always
   #   volumes:
-  #     - ./config/alertmanager.yml:/etc/alertmanager/alertmanager.yml
-  #     - ./config/email.tmpl:/etc/alertmanager/email.tmpl
+  #     - ${DATA_DIR:-./}/config/alertmanager.yml:/etc/alertmanager/alertmanager.yml
+  #     - ${DATA_DIR:-./}/config/email.tmpl:/etc/alertmanager/email.tmpl
   #   ports:
   #     - "${ALERT_MANAGER_PORT:-19093}:9093"
   #   networks:
@@ -174,7 +280,7 @@ services:
   #   ports:
   #     - "${GRAFANA_PORT:-13000}:3000"
   #   volumes:
-  #     - ${DATA_DIR:-./}/components/grafana:/var/lib/grafana
+  #     - "${DATA_DIR:-./}/components/grafana:/var/lib/grafana"
   #   networks:
   #     server:
   #       ipv4_address: ${GRAFANA_NETWORK_ADDRESS:-172.28.0.11}

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
 
@@ -104,16 +104,19 @@ Docker deployment offers a slightly more intricate template. Within the [openim-
 Configuration file modifications can be made by specifying corresponding environment variables, for instance:
 
 ```bash
-export CHAT_IMAGE_VERSION="main"   
-export SERVER_IMAGE_VERSION="main" 
+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
@@ -304,8 +309,10 @@ This section involves setting up MongoDB, including its port, address, and crede
 | -------------- | -------------- | ----------------------- |
 | MONGO_PORT     | "27017"        | Port used by MongoDB.   |
 | MONGO_ADDRESS  | [Generated IP] | IP address for MongoDB. |
-| MONGO_USERNAME | [User Defined] | Username for MongoDB.   |
-| MONGO_PASSWORD | [User Defined] | Password for MongoDB.   |
+| MONGO_USERNAME | [User Defined] | Admin Username for MongoDB.   |
+| MONGO_PASSWORD | [User Defined] | Admin Password for MongoDB.   |
+| MONGO_OPENIM_PASSWORD | [User Defined] | OpenIM Username for MongoDB.   |
+| MONGO_OPENIM_PASSWORD | [User Defined] | OpenIM Password for MongoDB.   |
 
 ###  2.8. <a name='TencentCloudCOSConfiguration'></a>Tencent Cloud COS Configuration
 
@@ -441,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/config.yaml"]="${OPENIM_OUTPUT_SUBPATH}/bin/config.yaml"
+  ["${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"
 )
 ```
 

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
-- redis:7.0.0
-- mongo:6.0.2
-- mysql:5.7
-- wurstmeister/zookeeper
-- minio/minio
+- [ ] bitnami/kafka:3.5.1
+- [ ] redis:7.0.0
+- [ ] mongo:6.0.2
+- [ ] bitnami/zookeeper:3.8
+- [ ] minio/minio:latest
+
+> [!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:
 
-```
-docker pull wurstmeister/kafka
+```bash
+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 minio/minio
+docker pull bitnami/zookeeper:3.8
+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:
 
-```
-git clone https://github.com/OpenIMSDK/openim-docker.git
+```bash
+docker save -o <tar-file-name>.tar $(docker images -q)
 ```
 
-Or download the code from [Releases](https://github.com/OpenIMSDK/openim-docker/releases/).
-
-1. **Transfer files**: Use `scp` to transfer all images and code to the intranet server.
+3. **Fetch code**: Clone the repository:
 
+```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.
-2. **Deploy using Docker-compose**:
+Import directly with shortcut commands:
 
+```bash
+for i in `ls ./`;do docker load -i $i;done
 ```
-docker-compose up -d
 
-# Verify
-docker-compose ps
+6. **Deploy**: Navigate to the `openim-docker` repository directory and follow the [README guide](https://github.com/openimsdk/openim-docker) for deployment.
+
+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`)**:
-   + **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/).
+**OpenIM Metrics (`prometheus-dashboard.yaml`)**:
 
+- **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

go.mod

@@ -4,8 +4,8 @@ go 1.19
 
 require (
 	firebase.google.com/go v3.13.0+incompatible
-	github.com/OpenIMSDK/protocol v0.0.44
-	github.com/OpenIMSDK/tools v0.0.21
+	github.com/OpenIMSDK/protocol v0.0.48
+	github.com/OpenIMSDK/tools v0.0.23
 	github.com/bwmarrin/snowflake v0.3.0 // indirect
 	github.com/dtm-labs/rockscache v0.1.1
 	github.com/gin-gonic/gin v1.9.1
@@ -131,8 +131,8 @@ require (
 	golang.org/x/arch v0.3.0 // indirect
 	golang.org/x/net v0.17.0 // indirect
 	golang.org/x/oauth2 v0.13.0 // indirect
-	golang.org/x/sys v0.14.0 // indirect
-	golang.org/x/text v0.13.0 // indirect
+	golang.org/x/sys v0.15.0 // indirect
+	golang.org/x/text v0.14.0 // indirect
 	golang.org/x/time v0.5.0 // indirect
 	golang.org/x/xerrors v0.0.0-20220907171357-04be3eba64a2 // indirect
 	google.golang.org/appengine v1.6.7 // indirect
@@ -153,6 +153,8 @@ require (
 	github.com/spf13/cobra v1.7.0
 	github.com/ugorji/go/codec v1.2.11 // indirect
 	go.uber.org/zap v1.24.0 // indirect
-	golang.org/x/crypto v0.14.0 // indirect
+	golang.org/x/crypto v0.17.0 // indirect
 	gopkg.in/ini.v1 v1.67.0 // indirect
 )
+
+replace github.com/OpenIMSDK/protocol v0.0.47 => github.com/AndrewZuo01/protocol v0.0.0-20240112093520-fd9c53e27b94

go.sum

@@ -15,13 +15,13 @@ cloud.google.com/go/storage v1.30.1 h1:uOdMxAs8HExqBlnLtnQyP0YkvbiDpdGShGKtx6U/o
 cloud.google.com/go/storage v1.30.1/go.mod h1:NfxhC0UJE1aXSx7CIIbCf7y9HKT7BiccwkR7+P7gN8E=
 firebase.google.com/go v3.13.0+incompatible h1:3TdYC3DDi6aHn20qoRkxwGqNgdjtblwVAyRLQwGn/+4=
 firebase.google.com/go v3.13.0+incompatible/go.mod h1:xlah6XbEyW6tbfSklcfe5FHJIwjt8toICdV5Wh9ptHs=
+github.com/AndrewZuo01/protocol v0.0.0-20240112093520-fd9c53e27b94 h1:o86vkek41ZrQqoBGqyKvS0z6N0uJj64mpzK72OkDZVM=
+github.com/AndrewZuo01/protocol v0.0.0-20240112093520-fd9c53e27b94/go.mod h1:F25dFrwrIx3lkNoiuf6FkCfxuwf8L4Z8UIsdTHP/r0Y=
 github.com/BurntSushi/toml v0.3.1/go.mod h1:xHWCNGjB5oqiDr8zfno3MHue2Ht5sIBksp03qcyfWMU=
 github.com/IBM/sarama v1.41.3 h1:MWBEJ12vHC8coMjdEXFq/6ftO6DUZnQlFYcxtOJFa7c=
 github.com/IBM/sarama v1.41.3/go.mod h1:Xxho9HkHd4K/MDUo/T/sOqwtX/17D33++E9Wib6hUdQ=
-github.com/OpenIMSDK/protocol v0.0.44 h1:P+9gJ9EW3y+VmzrjPludzn/5r1fjubaC19mKYJ7Oiew=
-github.com/OpenIMSDK/protocol v0.0.44/go.mod h1:F25dFrwrIx3lkNoiuf6FkCfxuwf8L4Z8UIsdTHP/r0Y=
-github.com/OpenIMSDK/tools v0.0.21 h1:iTapc2mIEVH/xl5Nd6jfwPub11Pgp44tVcE1rjB3a48=
-github.com/OpenIMSDK/tools v0.0.21/go.mod h1:eg+q4A34Qmu73xkY0mt37FHGMCMfC6CtmOnm0kFEGFI=
+github.com/OpenIMSDK/tools v0.0.23 h1:xozfrGzhbpNPlDTap5DLVPk+JfgZ/ZyIj4Cuu3/bm9w=
+github.com/OpenIMSDK/tools v0.0.23/go.mod h1:eg+q4A34Qmu73xkY0mt37FHGMCMfC6CtmOnm0kFEGFI=
 github.com/QcloudApi/qcloud_sign_golang v0.0.0-20141224014652-e4130a326409/go.mod h1:1pk82RBxDY/JZnPQrtqHlUFfCctgdorsd9M06fMynOM=
 github.com/alcortesm/tgz v0.0.0-20161220082320-9c5fe88206d7 h1:uSoVVbwJiQipAclBbw+8quDsfcvFjOpI5iCf4p/cqCs=
 github.com/alcortesm/tgz v0.0.0-20161220082320-9c5fe88206d7/go.mod h1:6zEj6s6u/ghQa61ZWa/C2Aw3RkjiTBOix7dkqa1VLIs=
@@ -371,8 +371,8 @@ golang.org/x/crypto v0.0.0-20200622213623-75b288015ac9/go.mod h1:LzIPMQfyMNhhGPh
 golang.org/x/crypto v0.0.0-20210921155107-089bfa567519/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc=
 golang.org/x/crypto v0.0.0-20220622213112-05595931fe9d/go.mod h1:IxCIyHEi3zRg3s0A5j5BB6A9Jmi73HwBIUl50j+osU4=
 golang.org/x/crypto v0.6.0/go.mod h1:OFC/31mSvZgRz0V1QTNCzfAI1aIRzbiufJtkMIlEp58=
-golang.org/x/crypto v0.14.0 h1:wBqGXzWJW6m1XrIKlAH0Hs1JJ7+9KBwnIO8v66Q9cHc=
-golang.org/x/crypto v0.14.0/go.mod h1:MVFd36DqK4CsrnJYDkBA3VC4m2GkXAM0PvzMCn4JQf4=
+golang.org/x/crypto v0.17.0 h1:r8bRNjWL3GshPW3gkd+RpvzWrZAwPS49OmTGZ/uhM4k=
+golang.org/x/crypto v0.17.0/go.mod h1:gCAAfMLgwOJRpTjQ2zCCt2OcSfYMTeZVSRtQlPC7Nq4=
 golang.org/x/exp v0.0.0-20190121172915-509febef88a4/go.mod h1:CJ0aWSM057203Lf6IL+f9T1iT9GByDxfZKAQTCR3kQA=
 golang.org/x/image v0.13.0 h1:3cge/F/QTkNLauhf2QoE9zp+7sr+ZcL4HnoZmdwg9sg=
 golang.org/x/image v0.13.0/go.mod h1:6mmbMOeV28HuMTgA6OSRkdXKYw/t5W9Uwn2Yv1r3Yxk=
@@ -438,12 +438,12 @@ golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8/go.mod h1:oPkhp1MJrh7nUepCBc
 golang.org/x/sys v0.0.0-20220722155257-8c9f86f7a55f/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.5.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
-golang.org/x/sys v0.14.0 h1:Vz7Qs629MkJkGyHxUlRHizWJRG2j8fbQKjELVSNhy7Q=
-golang.org/x/sys v0.14.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
+golang.org/x/sys v0.15.0 h1:h48lPFYpsTvQJZF4EKyI4aLHaev3CxivZmv7yZig9pc=
+golang.org/x/sys v0.15.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
 golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo=
 golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8=
 golang.org/x/term v0.5.0/go.mod h1:jMB1sMXY+tzblOD4FWmEbocvup2/aLOaQEp7JmGp78k=
-golang.org/x/term v0.13.0 h1:bb+I9cTfFazGW51MZqBVmZy7+JEJMouUHTUSKVQLBek=
+golang.org/x/term v0.15.0 h1:y/Oo/a/q3IXu26lQgl04j/gjuBDOBlx7X6Om1j2CPW4=
 golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
 golang.org/x/text v0.3.2/go.mod h1:bEr9sfX3Q8Zfm5fL9x+3itogRgK3+ptLWKqgva+5dAk=
 golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
@@ -451,8 +451,8 @@ golang.org/x/text v0.3.6/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
 golang.org/x/text v0.3.7/go.mod h1:u+2+/6zg+i71rQMx5EYifcz6MCKuco9NR6JIITiCfzQ=
 golang.org/x/text v0.3.8/go.mod h1:E6s5w1FMmriuDzIBO73fBruAKo1PCIq6d2Q6DHfQ8WQ=
 golang.org/x/text v0.7.0/go.mod h1:mrYo+phRRbMaCq/xk9113O4dZlRixOauAjOtrjsXDZ8=
-golang.org/x/text v0.13.0 h1:ablQoSUd0tRdKxZewP80B+BaqeKJuVhuRxj/dkrun3k=
-golang.org/x/text v0.13.0/go.mod h1:TvPlkZtksWOMsz7fbANvkp4WM8x/WCo/om8BMLbz+aE=
+golang.org/x/text v0.14.0 h1:ScX5w1eTa3QqT8oi6+ziP7dTV1S2+ALU0bI+0zXKWiQ=
+golang.org/x/text v0.14.0/go.mod h1:18ZOQIKpY8NJVqYksKHtTdi31H5itFRjB5/qKTNYzSU=
 golang.org/x/time v0.5.0 h1:o7cqy6amK/52YcAKIPlM3a+Fpj35zvRj2TP+e1xFSfk=
 golang.org/x/time v0.5.0/go.mod h1:3BpzKBy/shNhVucY/MWOyx10tF3SFh9QdLuxbVysPQM=
 golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=

go.work

@@ -4,14 +4,15 @@ use (
 	.
 	./test/typecheck
 	./tools/changelog
-	//./tools/imctl
+	./tools/component
+	./tools/data-conversion
+	./tools/formitychecker
+	./tools/imctl
 	./tools/infra
 	./tools/ncpu
 	./tools/openim-web
+	./tools/up35
+	./tools/url2im
 	./tools/versionchecker
 	./tools/yamlfmt
-	./tools/component
-	./tools/url2im
-	./tools/data-conversion
-	./tools/up35
 )

internal/api/conversation.go

@@ -33,8 +33,8 @@ func (o *ConversationApi) GetAllConversations(c *gin.Context) {
 	a2r.Call(conversation.ConversationClient.GetAllConversations, o.Client, c)
 }
 
-func (o *ConversationApi) GetConversationsList(c *gin.Context) {
-	a2r.Call(conversation.ConversationClient.GetConversationList, o.Client, c)
+func (o *ConversationApi) GetSortedConversationList(c *gin.Context) {
+	a2r.Call(conversation.ConversationClient.GetSortedConversationList, o.Client, c)
 }
 
 func (o *ConversationApi) GetConversation(c *gin.Context) {

internal/api/msg.go

@@ -164,6 +164,8 @@ func (m *MessageApi) getSendMsgReq(c *gin.Context, req apistruct.SendMsg) (sendM
 		data = apistruct.VideoElem{}
 	case constant.File:
 		data = apistruct.FileElem{}
+	case constant.AtText:
+		data = apistruct.AtElem{}
 	case constant.Custom:
 		data = apistruct.CustomElem{}
 	case constant.OANotification:
@@ -172,7 +174,6 @@ func (m *MessageApi) getSendMsgReq(c *gin.Context, req apistruct.SendMsg) (sendM
 		if err = m.userRpcClient.GetNotificationByID(c, req.SendID); err != nil {
 			return nil, err
 		}
-
 	default:
 		return nil, errs.ErrArgs.WithDetail("not support err contentType")
 	}

internal/api/route.go

@@ -83,6 +83,7 @@ func NewGinRouter(discov discoveryregistry.SvcDiscoveryRegistry, rdb redis.Unive
 		userRouterGroup.POST("/process_user_command_delete", ParseToken, u.ProcessUserCommandDelete)
 		userRouterGroup.POST("/process_user_command_update", ParseToken, u.ProcessUserCommandUpdate)
 		userRouterGroup.POST("/process_user_command_get", ParseToken, u.ProcessUserCommandGet)
+		userRouterGroup.POST("/process_user_command_get_all", ParseToken, u.ProcessUserCommandGetAll)
 
 		userRouterGroup.POST("/add_notification_account", ParseToken, u.AddNotificationAccount)
 		userRouterGroup.POST("/update_notification_account", ParseToken, u.UpdateNotificationAccountInfo)
@@ -204,7 +205,7 @@ func NewGinRouter(discov discoveryregistry.SvcDiscoveryRegistry, rdb redis.Unive
 	conversationGroup := r.Group("/conversation", ParseToken)
 	{
 		c := NewConversationApi(*conversationRpc)
-		conversationGroup.POST("/get_conversations_list", c.GetConversationsList)
+		conversationGroup.POST("/get_sorted_conversation_list", c.GetSortedConversationList)
 		conversationGroup.POST("/get_all_conversations", c.GetAllConversations)
 		conversationGroup.POST("/get_conversation", c.GetConversation)
 		conversationGroup.POST("/get_conversations", c.GetConversations)

internal/api/user.go

@@ -221,6 +221,11 @@ func (u *UserApi) ProcessUserCommandGet(c *gin.Context) {
 	a2r.Call(user.UserClient.ProcessUserCommandGet, u.Client, c)
 }
 
+// ProcessUserCommandGet user general function get all
+func (u *UserApi) ProcessUserCommandGetAll(c *gin.Context) {
+	a2r.Call(user.UserClient.ProcessUserCommandGetAll, u.Client, c)
+}
+
 func (u *UserApi) AddNotificationAccount(c *gin.Context) {
 	a2r.Call(user.UserClient.AddNotificationAccount, u.Client, c)
 }

internal/push/callback.go

@@ -37,7 +37,7 @@ func callbackOfflinePush(
 	msg *sdkws.MsgData,
 	offlinePushUserIDs *[]string,
 ) error {
-	if !config.Config.Callback.CallbackOfflinePush.Enable {
+	if !config.Config.Callback.CallbackOfflinePush.Enable || msg.ContentType == constant.Typing {
 		return nil
 	}
 	req := &callbackstruct.CallbackBeforePushReq{
@@ -73,7 +73,7 @@ func callbackOfflinePush(
 }
 
 func callbackOnlinePush(ctx context.Context, userIDs []string, msg *sdkws.MsgData) error {
-	if !config.Config.Callback.CallbackOnlinePush.Enable || utils.Contain(msg.SendID, userIDs...) {
+	if !config.Config.Callback.CallbackOnlinePush.Enable || utils.Contain(msg.SendID, userIDs...) || msg.ContentType == constant.Typing {
 		return nil
 	}
 	req := callbackstruct.CallbackBeforePushReq{
@@ -107,7 +107,7 @@ func callbackBeforeSuperGroupOnlinePush(
 	msg *sdkws.MsgData,
 	pushToUserIDs *[]string,
 ) error {
-	if !config.Config.Callback.CallbackBeforeSuperGroupOnlinePush.Enable {
+	if !config.Config.Callback.CallbackBeforeSuperGroupOnlinePush.Enable || msg.ContentType == constant.Typing {
 		return nil
 	}
 	req := callbackstruct.CallbackBeforeSuperGroupOnlinePushReq{

internal/push/push_to_client.go

@@ -101,11 +101,9 @@ func (p *Pusher) DeleteMemberAndSetConversationSeq(ctx context.Context, groupID
 
 func (p *Pusher) Push2User(ctx context.Context, userIDs []string, msg *sdkws.MsgData) error {
 	log.ZDebug(ctx, "Get msg from msg_transfer And push msg", "userIDs", userIDs, "msg", msg.String())
-	// callback
 	if err := callbackOnlinePush(ctx, userIDs, msg); err != nil {
 		return err
 	}
-
 	// push
 	wsResults, err := p.GetConnsAndOnlinePush(ctx, msg, userIDs)
 	if err != nil {
@@ -120,7 +118,7 @@ func (p *Pusher) Push2User(ctx context.Context, userIDs []string, msg *sdkws.Msg
 	}
 
 	for _, v := range wsResults {
-		if msg.SendID != v.UserID && (!v.OnlinePush) {
+		if !v.OnlinePush && msg.SendID == v.UserID {
 			if err = callbackOfflinePush(ctx, userIDs, msg, &[]string{}); err != nil {
 				return err
 			}
@@ -130,6 +128,7 @@ func (p *Pusher) Push2User(ctx context.Context, userIDs []string, msg *sdkws.Msg
 				return err
 			}
 		}
+
 	}
 	return nil
 }

internal/rpc/conversation/conversaion.go

@@ -89,8 +89,8 @@ func (c *conversationServer) GetConversation(ctx context.Context, req *pbconvers
 	return resp, nil
 }
 
-func (m *conversationServer) GetConversationList(ctx context.Context, req *pbconversation.GetConversationListReq) (resp *pbconversation.GetConversationListResp, err error) {
-	log.ZDebug(ctx, "GetConversationList", "seqs", req, "userID", req.UserID)
+func (m *conversationServer) GetSortedConversationList(ctx context.Context, req *pbconversation.GetSortedConversationListReq) (resp *pbconversation.GetSortedConversationListResp, err error) {
+	log.ZDebug(ctx, "GetSortedConversationList", "seqs", req, "userID", req.UserID)
 	var conversationIDs []string
 	if len(req.ConversationIDs) == 0 {
 		conversationIDs, err = m.conversationDatabase.GetConversationIDs(ctx, req.UserID)
@@ -129,30 +129,37 @@ func (m *conversationServer) GetConversationList(ctx context.Context, req *pbcon
 		return nil, err
 	}
 
+	var unreadTotal int64
 	conversation_unreadCount := make(map[string]int64)
 	for conversationID, maxSeq := range maxSeqs {
-		conversation_unreadCount[conversationID] = maxSeq - hasReadSeqs[conversationID]
+		unreadCount := maxSeq - hasReadSeqs[conversationID]
+		conversation_unreadCount[conversationID] = unreadCount
+		unreadTotal += unreadCount
 	}
 
-	conversation_isPinkTime := make(map[int64]string)
-	conversation_notPinkTime := make(map[int64]string)
+	conversation_isPinTime := make(map[int64]string)
+	conversation_notPinTime := make(map[int64]string)
 	for _, v := range conversations {
 		conversationID := v.ConversationID
 		time := conversationMsg[conversationID].MsgInfo.LatestMsgRecvTime
 		conversationMsg[conversationID].RecvMsgOpt = v.RecvMsgOpt
 		if v.IsPinned {
 			conversationMsg[conversationID].IsPinned = v.IsPinned
-			conversation_isPinkTime[time] = conversationID
+			conversation_isPinTime[time] = conversationID
 			continue
 		}
-		conversation_notPinkTime[time] = conversationID
+		conversation_notPinTime[time] = conversationID
 	}
-	resp = &pbconversation.GetConversationListResp{
+	resp = &pbconversation.GetSortedConversationListResp{
+		ConversationTotal: int64(len(chatLogs)),
 		ConversationElems: []*pbconversation.ConversationElem{},
+		UnreadTotal:       unreadTotal,
 	}
 
-	m.conversationSort(conversation_isPinkTime, resp, conversation_unreadCount, conversationMsg)
-	m.conversationSort(conversation_notPinkTime, resp, conversation_unreadCount, conversationMsg)
+	m.conversationSort(conversation_isPinTime, resp, conversation_unreadCount, conversationMsg)
+	m.conversationSort(conversation_notPinTime, resp, conversation_unreadCount, conversationMsg)
+
+	resp.ConversationElems = utils.Paginate(resp.ConversationElems, int(req.Pagination.GetPageNumber()), int(req.Pagination.GetShowNumber()))
 	return resp, nil
 }
 
@@ -425,7 +432,7 @@ func (c *conversationServer) GetConversationOfflinePushUserIDs(
 
 func (c *conversationServer) conversationSort(
 	conversations map[int64]string,
-	resp *pbconversation.GetConversationListResp,
+	resp *pbconversation.GetSortedConversationListResp,
 	conversation_unreadCount map[string]int64,
 	conversationMsg map[string]*pbconversation.ConversationElem,
 ) {

internal/rpc/friend/friend.go

@@ -452,22 +452,19 @@ func (s *friendServer) UpdateFriends(
 		return nil, err
 	}
 
-	for _, friendID := range req.FriendUserIDs {
-		if req.IsPinned != nil {
-			if err = s.friendDatabase.UpdateFriendPinStatus(ctx, req.OwnerUserID, friendID, req.IsPinned.Value); err != nil {
-				return nil, err
-			}
-		}
-		if req.Remark != nil {
-			if err = s.friendDatabase.UpdateFriendRemark(ctx, req.OwnerUserID, friendID, req.Remark.Value); err != nil {
-				return nil, err
-			}
-		}
-		if req.Ex != nil {
-			if err = s.friendDatabase.UpdateFriendEx(ctx, req.OwnerUserID, friendID, req.Ex.Value); err != nil {
-				return nil, err
-			}
-		}
+	val := make(map[string]any)
+
+	if req.IsPinned != nil {
+		val["is_pinned"] = req.IsPinned.Value
+	}
+	if req.Remark != nil {
+		val["remark"] = req.Remark.Value
+	}
+	if req.Ex != nil {
+		val["ex"] = req.Ex.Value
+	}
+	if err = s.friendDatabase.UpdateFriends(ctx, req.OwnerUserID, req.FriendUserIDs, val); err != nil {
+		return nil, err
 	}
 
 	resp := &pbfriend.UpdateFriendsResp{}

internal/rpc/group/callback.go

@@ -279,20 +279,20 @@ func CallbackApplyJoinGroupBefore(ctx context.Context, req *callbackstruct.Callb
 	return nil
 }
 
-func CallbackTransferGroupOwnerAfter(ctx context.Context, req *pbgroup.TransferGroupOwnerReq) (err error) {
-	if !config.Config.Callback.CallbackTransferGroupOwnerAfter.Enable {
+func CallbackAfterTransferGroupOwner(ctx context.Context, req *pbgroup.TransferGroupOwnerReq) (err error) {
+	if !config.Config.Callback.CallbackAfterTransferGroupOwner.Enable {
 		return nil
 	}
 
 	cbReq := &callbackstruct.CallbackTransferGroupOwnerReq{
-		CallbackCommand: callbackstruct.CallbackTransferGroupOwnerAfter,
+		CallbackCommand: callbackstruct.CallbackAfterTransferGroupOwner,
 		GroupID:         req.GroupID,
 		OldOwnerUserID:  req.OldOwnerUserID,
 		NewOwnerUserID:  req.NewOwnerUserID,
 	}
 
 	resp := &callbackstruct.CallbackTransferGroupOwnerResp{}
-	if err = http.CallBackPostReturn(ctx, config.Config.Callback.CallbackUrl, cbReq, resp, config.Config.Callback.CallbackBeforeJoinGroup); err != nil {
+	if err = http.CallBackPostReturn(ctx, config.Config.Callback.CallbackUrl, cbReq, resp, config.Config.Callback.CallbackAfterTransferGroupOwner); err != nil {
 		return err
 	}
 	return nil

internal/rpc/group/group.go

@@ -109,14 +109,11 @@ type groupServer struct {
 }
 
 func (s *groupServer) NotificationUserInfoUpdate(ctx context.Context, req *pbgroup.NotificationUserInfoUpdateReq) (*pbgroup.NotificationUserInfoUpdateResp, error) {
-	defer log.ZDebug(ctx, "return")
+	defer log.ZDebug(ctx, "NotificationUserInfoUpdate return")
 	members, err := s.db.FindGroupMemberUser(ctx, nil, req.UserID)
 	if err != nil {
 		return nil, err
 	}
-	if err := s.PopulateGroupMember(ctx, members...); err != nil {
-		return nil, err
-	}
 	groupIDs := make([]string, 0, len(members))
 	for _, member := range members {
 		if member.Nickname != "" && member.FaceURL != "" {
@@ -1061,7 +1058,7 @@ func (s *groupServer) TransferGroupOwner(ctx context.Context, req *pbgroup.Trans
 		return nil, err
 	}
 
-	if err := CallbackTransferGroupOwnerAfter(ctx, req); err != nil {
+	if err := CallbackAfterTransferGroupOwner(ctx, req); err != nil {
 		return nil, err
 	}
 	s.Notification.GroupOwnerTransferredNotification(ctx, req)

internal/rpc/msg/as_read.go

@@ -124,6 +124,17 @@ func (m *msgServer) MarkMsgsAsRead(
 			return
 		}
 	}
+
+	req_callback := &cbapi.CallbackSingleMsgReadReq{
+		ConversationID: conversation.ConversationID,
+		UserID:         req.UserID,
+		Seqs:           req.Seqs,
+		ContentType:    conversation.ConversationType,
+	}
+	if err = CallbackSingleMsgRead(ctx, req_callback); err != nil {
+		return nil, err
+	}
+
 	if err = m.sendMarkAsReadNotification(ctx, req.ConversationID, conversation.ConversationType, req.UserID,
 		m.conversationAndGetRecvID(conversation, req.UserID), req.Seqs, hasReadSeq); err != nil {
 		return

internal/rpc/msg/callback.go

@@ -70,7 +70,7 @@ func GetContent(msg *sdkws.MsgData) string {
 }
 
 func callbackBeforeSendSingleMsg(ctx context.Context, msg *pbchat.SendMsgReq) error {
-	if !config.Config.Callback.CallbackBeforeSendSingleMsg.Enable {
+	if !config.Config.Callback.CallbackBeforeSendSingleMsg.Enable || msg.MsgData.ContentType == constant.Typing {
 		return nil
 	}
 	req := &cbapi.CallbackBeforeSendSingleMsgReq{
@@ -85,7 +85,7 @@ func callbackBeforeSendSingleMsg(ctx context.Context, msg *pbchat.SendMsgReq) er
 }
 
 func callbackAfterSendSingleMsg(ctx context.Context, msg *pbchat.SendMsgReq) error {
-	if !config.Config.Callback.CallbackAfterSendSingleMsg.Enable {
+	if !config.Config.Callback.CallbackAfterSendSingleMsg.Enable || msg.MsgData.ContentType == constant.Typing {
 		return nil
 	}
 	req := &cbapi.CallbackAfterSendSingleMsgReq{
@@ -100,7 +100,7 @@ func callbackAfterSendSingleMsg(ctx context.Context, msg *pbchat.SendMsgReq) err
 }
 
 func callbackBeforeSendGroupMsg(ctx context.Context, msg *pbchat.SendMsgReq) error {
-	if !config.Config.Callback.CallbackBeforeSendGroupMsg.Enable {
+	if !config.Config.Callback.CallbackBeforeSendGroupMsg.Enable || msg.MsgData.ContentType == constant.Typing {
 		return nil
 	}
 	req := &cbapi.CallbackBeforeSendGroupMsgReq{
@@ -115,7 +115,7 @@ func callbackBeforeSendGroupMsg(ctx context.Context, msg *pbchat.SendMsgReq) err
 }
 
 func callbackAfterSendGroupMsg(ctx context.Context, msg *pbchat.SendMsgReq) error {
-	if !config.Config.Callback.CallbackAfterSendGroupMsg.Enable {
+	if !config.Config.Callback.CallbackAfterSendGroupMsg.Enable || msg.MsgData.ContentType == constant.Typing {
 		return nil
 	}
 	req := &cbapi.CallbackAfterSendGroupMsgReq{

internal/rpc/msg/send.go

@@ -65,6 +65,7 @@ func (m *msgServer) sendMsgSuperGroupChat(
 	if err = callbackBeforeSendGroupMsg(ctx, req); err != nil {
 		return nil, err
 	}
+
 	if err := callbackMsgModify(ctx, req); err != nil {
 		return nil, err
 	}
@@ -167,6 +168,7 @@ func (m *msgServer) sendMsgSingleChat(ctx context.Context, req *pbmsg.SendMsgReq
 		if err = callbackBeforeSendSingleMsg(ctx, req); err != nil {
 			return nil, err
 		}
+
 		if err := callbackMsgModify(ctx, req); err != nil {
 			return nil, err
 		}

internal/rpc/user/user.go

@@ -17,6 +17,7 @@ package user
 import (
 	"context"
 	"errors"
+	"github.com/OpenIMSDK/tools/pagination"
 	"github.com/openimsdk/open-im-server/v3/pkg/common/db/table/relation"
 	"math/rand"
 	"strings"
@@ -228,11 +229,20 @@ func (s *userServer) AccountCheck(ctx context.Context, req *pbuser.AccountCheckR
 }
 
 func (s *userServer) GetPaginationUsers(ctx context.Context, req *pbuser.GetPaginationUsersReq) (resp *pbuser.GetPaginationUsersResp, err error) {
-	total, users, err := s.Page(ctx, req.Pagination)
-	if err != nil {
-		return nil, err
+	if req.UserID == "" && req.NickName == "" {
+		total, users, err := s.PageFindUser(ctx, constant.IMOrdinaryUser, constant.AppOrdinaryUsers, req.Pagination)
+		if err != nil {
+			return nil, err
+		}
+		return &pbuser.GetPaginationUsersResp{Total: int32(total), Users: convert.UsersDB2Pb(users)}, err
+	} else {
+		total, users, err := s.PageFindUserWithKeyword(ctx, constant.IMOrdinaryUser, constant.AppOrdinaryUsers, req.UserID, req.NickName, req.Pagination)
+		if err != nil {
+			return nil, err
+		}
+		return &pbuser.GetPaginationUsersResp{Total: int32(total), Users: convert.UsersDB2Pb(users)}, err
 	}
-	return &pbuser.GetPaginationUsersResp{Total: int32(total), Users: convert.UsersDB2Pb(users)}, err
+
 }
 
 func (s *userServer) UserRegister(ctx context.Context, req *pbuser.UserRegisterReq) (resp *pbuser.UserRegisterResp, err error) {
@@ -379,38 +389,94 @@ func (s *userServer) GetSubscribeUsersStatus(ctx context.Context,
 
 // ProcessUserCommandAdd user general function add
 func (s *userServer) ProcessUserCommandAdd(ctx context.Context, req *pbuser.ProcessUserCommandAddReq) (*pbuser.ProcessUserCommandAddResp, error) {
-	// Assuming you have a method in s.UserDatabase to add a user command
-	err := s.UserDatabase.AddUserCommand(ctx, req.UserID, req.Type, req.Uuid, req.Value)
+	err := authverify.CheckAccessV3(ctx, req.UserID)
 	if err != nil {
 		return nil, err
 	}
 
+	var value string
+	if req.Value != nil {
+		value = req.Value.Value
+	}
+	var ex string
+	if req.Ex != nil {
+		value = req.Ex.Value
+	}
+	// Assuming you have a method in s.UserDatabase to add a user command
+	err = s.UserDatabase.AddUserCommand(ctx, req.UserID, req.Type, req.Uuid, value, ex)
+	if err != nil {
+		return nil, err
+	}
+	tips := &sdkws.UserCommandAddTips{
+		FromUserID: req.UserID,
+		ToUserID:   req.UserID,
+	}
+	err = s.userNotificationSender.UserCommandAddNotification(ctx, tips)
+	if err != nil {
+		return nil, err
+	}
 	return &pbuser.ProcessUserCommandAddResp{}, nil
 }
 
 // ProcessUserCommandDelete user general function delete
 func (s *userServer) ProcessUserCommandDelete(ctx context.Context, req *pbuser.ProcessUserCommandDeleteReq) (*pbuser.ProcessUserCommandDeleteResp, error) {
-	// Assuming you have a method in s.UserDatabase to delete a user command
-	err := s.UserDatabase.DeleteUserCommand(ctx, req.UserID, req.Type, req.Uuid)
+	err := authverify.CheckAccessV3(ctx, req.UserID)
 	if err != nil {
 		return nil, err
 	}
 
+	err = s.UserDatabase.DeleteUserCommand(ctx, req.UserID, req.Type, req.Uuid)
+	if err != nil {
+		return nil, err
+	}
+	tips := &sdkws.UserCommandDeleteTips{
+		FromUserID: req.UserID,
+		ToUserID:   req.UserID,
+	}
+	err = s.userNotificationSender.UserCommandDeleteNotification(ctx, tips)
+	if err != nil {
+		return nil, err
+	}
 	return &pbuser.ProcessUserCommandDeleteResp{}, nil
 }
 
 // ProcessUserCommandUpdate user general function update
 func (s *userServer) ProcessUserCommandUpdate(ctx context.Context, req *pbuser.ProcessUserCommandUpdateReq) (*pbuser.ProcessUserCommandUpdateResp, error) {
-	// Assuming you have a method in s.UserDatabase to update a user command
-	err := s.UserDatabase.UpdateUserCommand(ctx, req.UserID, req.Type, req.Uuid, req.Value)
+	err := authverify.CheckAccessV3(ctx, req.UserID)
 	if err != nil {
 		return nil, err
 	}
+	val := make(map[string]any)
 
+	// Map fields from eax to val
+	if req.Value != nil {
+		val["value"] = req.Value.Value
+	}
+	if req.Ex != nil {
+		val["ex"] = req.Ex.Value
+	}
+
+	// Assuming you have a method in s.UserDatabase to update a user command
+	err = s.UserDatabase.UpdateUserCommand(ctx, req.UserID, req.Type, req.Uuid, val)
+	if err != nil {
+		return nil, err
+	}
+	tips := &sdkws.UserCommandUpdateTips{
+		FromUserID: req.UserID,
+		ToUserID:   req.UserID,
+	}
+	err = s.userNotificationSender.UserCommandUpdateNotification(ctx, tips)
+	if err != nil {
+		return nil, err
+	}
 	return &pbuser.ProcessUserCommandUpdateResp{}, nil
 }
 
 func (s *userServer) ProcessUserCommandGet(ctx context.Context, req *pbuser.ProcessUserCommandGetReq) (*pbuser.ProcessUserCommandGetResp, error) {
+	err := authverify.CheckAccessV3(ctx, req.UserID)
+	if err != nil {
+		return nil, err
+	}
 	// Fetch user commands from the database
 	commands, err := s.UserDatabase.GetUserCommands(ctx, req.UserID, req.Type)
 	if err != nil {
@@ -423,14 +489,45 @@ func (s *userServer) ProcessUserCommandGet(ctx context.Context, req *pbuser.Proc
 	for _, command := range commands {
 		// No need to use index since command is already a pointer
 		commandInfoSlice = append(commandInfoSlice, &pbuser.CommandInfoResp{
+			Type:       command.Type,
 			Uuid:       command.Uuid,
 			Value:      command.Value,
 			CreateTime: command.CreateTime,
+			Ex:         command.Ex,
 		})
 	}
 
 	// Return the response with the slice
-	return &pbuser.ProcessUserCommandGetResp{KVArray: commandInfoSlice}, nil
+	return &pbuser.ProcessUserCommandGetResp{CommandResp: commandInfoSlice}, nil
+}
+
+func (s *userServer) ProcessUserCommandGetAll(ctx context.Context, req *pbuser.ProcessUserCommandGetAllReq) (*pbuser.ProcessUserCommandGetAllResp, error) {
+	err := authverify.CheckAccessV3(ctx, req.UserID)
+	if err != nil {
+		return nil, err
+	}
+	// Fetch user commands from the database
+	commands, err := s.UserDatabase.GetAllUserCommands(ctx, req.UserID)
+	if err != nil {
+		return nil, err
+	}
+
+	// Initialize commandInfoSlice as an empty slice
+	commandInfoSlice := make([]*pbuser.AllCommandInfoResp, 0, len(commands))
+
+	for _, command := range commands {
+		// No need to use index since command is already a pointer
+		commandInfoSlice = append(commandInfoSlice, &pbuser.AllCommandInfoResp{
+			Type:       command.Type,
+			Uuid:       command.Uuid,
+			Value:      command.Value,
+			CreateTime: command.CreateTime,
+			Ex:         command.Ex,
+		})
+	}
+
+	// Return the response with the slice
+	return &pbuser.ProcessUserCommandGetAllResp{CommandResp: commandInfoSlice}, nil
 }
 
 func (s *userServer) AddNotificationAccount(ctx context.Context, req *pbuser.AddNotificationAccountReq) (*pbuser.AddNotificationAccountResp, error) {
@@ -438,22 +535,28 @@ func (s *userServer) AddNotificationAccount(ctx context.Context, req *pbuser.Add
 		return nil, err
 	}
 
-	var userID string
-	for i := 0; i < 20; i++ {
-		userId := s.genUserID()
-		_, err := s.UserDatabase.FindWithError(ctx, []string{userId})
-		if err == nil {
-			continue
+	if req.UserID == "" {
+		for i := 0; i < 20; i++ {
+			userId := s.genUserID()
+			_, err := s.UserDatabase.FindWithError(ctx, []string{userId})
+			if err == nil {
+				continue
+			}
+			req.UserID = userId
+			break
+		}
+		if req.UserID == "" {
+			return nil, errs.ErrInternalServer.Wrap("gen user id failed")
+		}
+	} else {
+		_, err := s.UserDatabase.FindWithError(ctx, []string{req.UserID})
+		if err == nil {
+			return nil, errs.ErrArgs.Wrap("userID is used")
 		}
-		userID = userId
-		break
-	}
-	if userID == "" {
-		return nil, errs.ErrInternalServer.Wrap("gen user id failed")
 	}
 
 	user := &tablerelation.UserModel{
-		UserID:         userID,
+		UserID:         req.UserID,
 		Nickname:       req.NickName,
 		FaceURL:        req.FaceURL,
 		CreateTime:     time.Now(),
@@ -463,7 +566,11 @@ func (s *userServer) AddNotificationAccount(ctx context.Context, req *pbuser.Add
 		return nil, err
 	}
 
-	return &pbuser.AddNotificationAccountResp{}, nil
+	return &pbuser.AddNotificationAccountResp{
+		UserID:   req.UserID,
+		NickName: req.NickName,
+		FaceURL:  req.FaceURL,
+	}, nil
 }
 
 func (s *userServer) UpdateNotificationAccountInfo(ctx context.Context, req *pbuser.UpdateNotificationAccountInfoReq) (*pbuser.UpdateNotificationAccountInfoResp, error) {
@@ -493,34 +600,44 @@ func (s *userServer) UpdateNotificationAccountInfo(ctx context.Context, req *pbu
 }
 
 func (s *userServer) SearchNotificationAccount(ctx context.Context, req *pbuser.SearchNotificationAccountReq) (*pbuser.SearchNotificationAccountResp, error) {
+	// Check if user is an admin
 	if err := authverify.CheckIMAdmin(ctx); err != nil {
 		return nil, err
 	}
 
-	if req.NickName != "" {
-		users, err := s.UserDatabase.FindByNickname(ctx, req.NickName)
+	var users []*relation.UserModel
+	var err error
+
+	// If a keyword is provided in the request
+	if req.Keyword != "" {
+		// Find users by keyword
+		users, err = s.UserDatabase.Find(ctx, []string{req.Keyword})
 		if err != nil {
 			return nil, err
 		}
-		resp := s.userModelToResp(users)
-		return resp, nil
-	}
 
-	if req.UserID != "" {
-		users, err := s.UserDatabase.Find(ctx, []string{req.UserID})
+		// Convert users to response format
+		resp := s.userModelToResp(users, req.Pagination)
+		if resp.Total != 0 {
+			return resp, nil
+		}
+
+		// Find users by nickname if no users found by keyword
+		users, err = s.UserDatabase.FindByNickname(ctx, req.Keyword)
 		if err != nil {
 			return nil, err
 		}
-		resp := s.userModelToResp(users)
+		resp = s.userModelToResp(users, req.Pagination)
 		return resp, nil
 	}
 
-	users, err := s.UserDatabase.FindNotification(ctx, constant.AppNotificationAdmin)
+	// If no keyword, find users with notification settings
+	users, err = s.UserDatabase.FindNotification(ctx, constant.AppNotificationAdmin)
 	if err != nil {
 		return nil, err
 	}
 
-	resp := s.userModelToResp(users)
+	resp := s.userModelToResp(users, req.Pagination)
 	return resp, nil
 }
 
@@ -554,7 +671,7 @@ func (s *userServer) genUserID() string {
 	return string(data)
 }
 
-func (s *userServer) userModelToResp(users []*relation.UserModel) *pbuser.SearchNotificationAccountResp {
+func (s *userServer) userModelToResp(users []*relation.UserModel, pagination pagination.Pagination) *pbuser.SearchNotificationAccountResp {
 	accounts := make([]*pbuser.NotificationAccountInfo, 0)
 	var total int64
 	for _, v := range users {
@@ -568,5 +685,8 @@ func (s *userServer) userModelToResp(users []*relation.UserModel) *pbuser.Search
 			total += 1
 		}
 	}
-	return &pbuser.SearchNotificationAccountResp{Total: total, NotificationAccounts: accounts}
+
+	notificationAccounts := utils.Paginate(accounts, int(pagination.GetPageNumber()), int(pagination.GetShowNumber()))
+
+	return &pbuser.SearchNotificationAccountResp{Total: total, NotificationAccounts: notificationAccounts}
 }

pkg/callbackstruct/constant.go

@@ -41,7 +41,7 @@ const (
 	CallbackBeforeUpdateUserInfoExCommand   = "callbackBeforeUpdateUserInfoExCommand"
 	CallbackBeforeUserRegisterCommand       = "callbackBeforeUserRegisterCommand"
 	CallbackAfterUserRegisterCommand        = "callbackAfterUserRegisterCommand"
-	CallbackTransferGroupOwnerAfter         = "callbackTransferGroupOwnerAfter"
+	CallbackAfterTransferGroupOwner         = "callbackAfterTransferGroupOwner"
 	CallbackBeforeSetFriendRemark           = "callbackBeforeSetFriendRemark"
 	CallbackAfterSetFriendRemark            = "callbackAfterSetFriendRemark"
 	CallbackSingleMsgRead                   = "callbackSingleMsgRead"

pkg/callbackstruct/message.go

@@ -94,9 +94,10 @@ type CallbackGroupMsgReadResp struct {
 
 type CallbackSingleMsgReadReq struct {
 	CallbackCommand `json:"callbackCommand"`
-	SendID          string `json:"sendID"`
-	ReceiveID       string `json:"receiveID"`
-	ContentType     int64  `json:"contentType"`
+	ConversationID  string  `json:"conversationID"`
+	UserID          string  `json:"userID"`
+	Seqs            []int64 `json:"Seqs"`
+	ContentType     int32   `json:"contentType"`
 }
 
 type CallbackSingleMsgReadResp struct {

pkg/common/config/config.go

@@ -296,7 +296,7 @@ type configStruct struct {
 		CallbackKillGroupMember            CallBackConfig `yaml:"killGroupMember"`
 		CallbackDismissGroup               CallBackConfig `yaml:"dismissGroup"`
 		CallbackBeforeJoinGroup            CallBackConfig `yaml:"joinGroup"`
-		CallbackTransferGroupOwnerAfter    CallBackConfig `yaml:"transferGroupOwner"`
+		CallbackAfterTransferGroupOwner    CallBackConfig `yaml:"transferGroupOwner"`
 		CallbackBeforeInviteUserToGroup    CallBackConfig `yaml:"beforeInviteUserToGroup"`
 		CallbackAfterJoinGroup             CallBackConfig `yaml:"joinGroupAfter"`
 		CallbackAfterSetGroupInfo          CallBackConfig `yaml:"setGroupInfoAfter"`

pkg/common/config/parse.go

@@ -24,6 +24,7 @@ import (
 	"gopkg.in/yaml.v3"
 
 	"github.com/openimsdk/open-im-server/v3/pkg/msgprocessor"
+	"github.com/openimsdk/open-im-server/v3/pkg/util/genutil"
 )
 
 //go:embed version
@@ -37,19 +38,30 @@ const (
 
 // return absolude path join ../config/, this is k8s container config path.
 func GetDefaultConfigPath() string {
-	b, err := filepath.Abs(os.Args[0])
+	executablePath, err := os.Executable()
 	if err != nil {
-		fmt.Println("filepath.Abs error,err=", err)
+		fmt.Println("GetDefaultConfigPath error:", err.Error())
 		return ""
 	}
-	return filepath.Join(filepath.Dir(b), "../config/")
+
+	configPath, err := genutil.OutDir(filepath.Join(filepath.Dir(executablePath), "../config/"))
+	if err != nil {
+		fmt.Fprintf(os.Stderr, "failed to get output directory: %v\n", err)
+		os.Exit(1)
+	}
+	return configPath
 }
 
 // getProjectRoot returns the absolute path of the project root directory.
 func GetProjectRoot() string {
-	b, _ := filepath.Abs(os.Args[0])
+	executablePath, _ := os.Executable()
 
-	return filepath.Join(filepath.Dir(b), "../../../../..")
+	projectRoot, err := genutil.OutDir(filepath.Join(filepath.Dir(executablePath), "../../../../.."))
+	if err != nil {
+		fmt.Fprintf(os.Stderr, "failed to get output directory: %v\n", err)
+		os.Exit(1)
+	}
+	return projectRoot
 }
 
 func GetOptionsByNotification(cfg NotificationConf) msgprocessor.Options {

pkg/common/config/version

@@ -1 +1 @@
-v3.3.0
+v3.5.0

pkg/common/db/cache/friend.go

@@ -44,6 +44,8 @@ type FriendCache interface {
 	GetFriend(ctx context.Context, ownerUserID, friendUserID string) (friend *relationtb.FriendModel, err error)
 	// Delete friend when friend info changed
 	DelFriend(ownerUserID, friendUserID string) FriendCache
+	// Delete friends when friends' info changed
+	DelFriends(ownerUserID string, friendUserIDs []string) FriendCache
 }
 
 // FriendCacheRedis is an implementation of the FriendCache interface using Redis.
@@ -152,3 +154,15 @@ func (f *FriendCacheRedis) DelFriend(ownerUserID, friendUserID string) FriendCac
 
 	return newFriendCache
 }
+
+// DelFriends deletes multiple friend infos from the cache.
+func (f *FriendCacheRedis) DelFriends(ownerUserID string, friendUserIDs []string) FriendCache {
+	newFriendCache := f.NewCache()
+
+	for _, friendUserID := range friendUserIDs {
+		key := f.getFriendKey(ownerUserID, friendUserID)
+		newFriendCache.AddKeys(key) // Assuming AddKeys marks the keys for deletion
+	}
+
+	return newFriendCache
+}

pkg/common/db/controller/conversation.go

@@ -279,7 +279,7 @@ func (c *conversationDatabase) CreateGroupChatConversation(ctx context.Context,
 		for _, v := range existConversationUserIDs {
 			cache = cache.DelConversations(v, conversationID)
 		}
-		return c.cache.ExecDel(ctx)
+		return cache.ExecDel(ctx)
 	})
 }
 

pkg/common/db/controller/friend.go

@@ -74,15 +74,8 @@ type FriendDatabase interface {
 	// FindBothFriendRequests finds friend requests sent and received
 	FindBothFriendRequests(ctx context.Context, fromUserID, toUserID string) (friends []*relation.FriendRequestModel, err error)
 
-	// UpdateFriendPinStatus updates the pinned status of a friend
-	UpdateFriendPinStatus(ctx context.Context, ownerUserID string, friendUserID string, isPinned bool) (err error)
-
-	// UpdateFriendRemark updates the remark for a friend
-	UpdateFriendRemark(ctx context.Context, ownerUserID string, friendUserID string, remark string) (err error)
-
-	// UpdateFriendEx updates the 'ex' field for a friend
-	UpdateFriendEx(ctx context.Context, ownerUserID string, friendUserID string, ex string) (err error)
-
+	// UpdateFriends updates fields for friends
+	UpdateFriends(ctx context.Context, ownerUserID string, friendUserIDs []string, val map[string]any) (err error)
 }
 
 type friendDatabase struct {
@@ -323,21 +316,12 @@ func (f *friendDatabase) FindFriendUserIDs(ctx context.Context, ownerUserID stri
 func (f *friendDatabase) FindBothFriendRequests(ctx context.Context, fromUserID, toUserID string) (friends []*relation.FriendRequestModel, err error) {
 	return f.friendRequest.FindBothFriendRequests(ctx, fromUserID, toUserID)
 }
-func (f *friendDatabase) UpdateFriendPinStatus(ctx context.Context, ownerUserID string, friendUserID string, isPinned bool) (err error) {
-	if err := f.friend.UpdatePinStatus(ctx, ownerUserID, friendUserID, isPinned); err != nil {
+func (f *friendDatabase) UpdateFriends(ctx context.Context, ownerUserID string, friendUserIDs []string, val map[string]any) (err error) {
+	if len(val) == 0 {
+		return nil
+	}
+	if err := f.friend.UpdateFriends(ctx, ownerUserID, friendUserIDs, val); err != nil {
 		return err
 	}
-	return f.cache.DelFriend(ownerUserID, friendUserID).ExecDel(ctx)
-}
-func (f *friendDatabase) UpdateFriendRemark(ctx context.Context, ownerUserID string, friendUserID string, remark string) (err error) {
-	if err := f.friend.UpdateFriendRemark(ctx, ownerUserID, friendUserID, remark); err != nil {
-		return err
-	}
-	return f.cache.DelFriend(ownerUserID, friendUserID).ExecDel(ctx)
-}
-func (f *friendDatabase) UpdateFriendEx(ctx context.Context, ownerUserID string, friendUserID string, ex string) (err error) {
-	if err := f.friend.UpdateFriendEx(ctx, ownerUserID, friendUserID, ex); err != nil {
-		return err
-	}
-	return f.cache.DelFriend(ownerUserID, friendUserID).ExecDel(ctx)
+	return f.cache.DelFriends(ownerUserID, friendUserIDs).ExecDel(ctx)
 }

pkg/common/db/controller/msg_test.go

@@ -146,7 +146,7 @@ func Test_BatchInsertChat2DB(t *testing.T) {
 func GetDB() *commonMsgDatabase {
 	config.Config.Mongo.Address = []string{"203.56.175.233:37017"}
 	// config.Config.Mongo.Timeout = 60
-	config.Config.Mongo.Database = "openIM_v3"
+	config.Config.Mongo.Database = "openim_v3"
 	// config.Config.Mongo.Source = "admin"
 	config.Config.Mongo.Username = "root"
 	config.Config.Mongo.Password = "openIM123"

pkg/common/db/controller/user.go

@@ -48,6 +48,10 @@ type UserDatabase interface {
 	//Update(ctx context.Context, user *relation.UserModel) (err error)
 	// UpdateByMap update (zero value) external guarantee userID exists
 	UpdateByMap(ctx context.Context, userID string, args map[string]any) (err error)
+	// FindUser
+	PageFindUser(ctx context.Context, level1 int64, level2 int64, pagination pagination.Pagination) (count int64, users []*relation.UserModel, err error)
+	//FindUser with keyword
+	PageFindUserWithKeyword(ctx context.Context, level1 int64, level2 int64, userID string, nickName string, pagination pagination.Pagination) (count int64, users []*relation.UserModel, err error)
 	// Page If not found, no error is returned
 	Page(ctx context.Context, pagination pagination.Pagination) (count int64, users []*relation.UserModel, err error)
 	// IsExist true as long as one exists
@@ -76,10 +80,11 @@ type UserDatabase interface {
 	SetUserStatus(ctx context.Context, userID string, status, platformID int32) error
 
 	//CRUD user command
-	AddUserCommand(ctx context.Context, userID string, Type int32, UUID string, value string) error
+	AddUserCommand(ctx context.Context, userID string, Type int32, UUID string, value string, ex string) error
 	DeleteUserCommand(ctx context.Context, userID string, Type int32, UUID string) error
-	UpdateUserCommand(ctx context.Context, userID string, Type int32, UUID string, value string) error
+	UpdateUserCommand(ctx context.Context, userID string, Type int32, UUID string, val map[string]any) error
 	GetUserCommands(ctx context.Context, userID string, Type int32) ([]*user.CommandInfoResp, error)
+	GetAllUserCommands(ctx context.Context, userID string) ([]*user.AllCommandInfoResp, error)
 }
 
 type userDatabase struct {
@@ -182,6 +187,13 @@ func (u *userDatabase) Page(ctx context.Context, pagination pagination.Paginatio
 	return u.userDB.Page(ctx, pagination)
 }
 
+func (u *userDatabase) PageFindUser(ctx context.Context, level1 int64, level2 int64, pagination pagination.Pagination) (count int64, users []*relation.UserModel, err error) {
+	return u.userDB.PageFindUser(ctx, level1, level2, pagination)
+}
+func (u *userDatabase) PageFindUserWithKeyword(ctx context.Context, level1 int64, level2 int64, userID, nickName string, pagination pagination.Pagination) (count int64, users []*relation.UserModel, err error) {
+	return u.userDB.PageFindUserWithKeyword(ctx, level1, level2, userID, nickName, pagination)
+}
+
 // IsExist Does userIDs exist? As long as there is one, it will be true.
 func (u *userDatabase) IsExist(ctx context.Context, userIDs []string) (exist bool, err error) {
 	users, err := u.userDB.Find(ctx, userIDs)
@@ -253,16 +265,20 @@ func (u *userDatabase) GetUserStatus(ctx context.Context, userIDs []string) ([]*
 func (u *userDatabase) SetUserStatus(ctx context.Context, userID string, status, platformID int32) error {
 	return u.cache.SetUserStatus(ctx, userID, status, platformID)
 }
-func (u *userDatabase) AddUserCommand(ctx context.Context, userID string, Type int32, UUID string, value string) error {
-	return u.userDB.AddUserCommand(ctx, userID, Type, UUID, value)
+func (u *userDatabase) AddUserCommand(ctx context.Context, userID string, Type int32, UUID string, value string, ex string) error {
+	return u.userDB.AddUserCommand(ctx, userID, Type, UUID, value, ex)
 }
 func (u *userDatabase) DeleteUserCommand(ctx context.Context, userID string, Type int32, UUID string) error {
 	return u.userDB.DeleteUserCommand(ctx, userID, Type, UUID)
 }
-func (u *userDatabase) UpdateUserCommand(ctx context.Context, userID string, Type int32, UUID string, value string) error {
-	return u.userDB.UpdateUserCommand(ctx, userID, Type, UUID, value)
+func (u *userDatabase) UpdateUserCommand(ctx context.Context, userID string, Type int32, UUID string, val map[string]any) error {
+	return u.userDB.UpdateUserCommand(ctx, userID, Type, UUID, val)
 }
 func (u *userDatabase) GetUserCommands(ctx context.Context, userID string, Type int32) ([]*user.CommandInfoResp, error) {
 	commands, err := u.userDB.GetUserCommand(ctx, userID, Type)
 	return commands, err
 }
+func (u *userDatabase) GetAllUserCommands(ctx context.Context, userID string) ([]*user.AllCommandInfoResp, error) {
+	commands, err := u.userDB.GetAllUserCommand(ctx, userID)
+	return commands, err
+}

pkg/common/db/mgo/friend.go

@@ -16,7 +16,6 @@ package mgo
 
 import (
 	"context"
-	"github.com/OpenIMSDK/tools/errs"
 	"github.com/OpenIMSDK/tools/mgoutil"
 	"github.com/OpenIMSDK/tools/pagination"
 	"go.mongodb.org/mongo-driver/mongo/options"
@@ -144,49 +143,22 @@ func (f *FriendMgo) FindFriendUserIDs(ctx context.Context, ownerUserID string) (
 	return mgoutil.Find[string](ctx, f.coll, filter, options.Find().SetProjection(bson.M{"_id": 0, "friend_user_id": 1}))
 }
 
-// UpdatePinStatus update friend's pin status
-func (f *FriendMgo) UpdatePinStatus(ctx context.Context, ownerUserID string, friendUserID string, isPinned bool) (err error) {
-
-	filter := bson.M{"owner_user_id": ownerUserID, "friend_user_id": friendUserID}
-	// Create an update operation to set the "is_pinned" field to isPinned for all documents.
-	update := bson.M{"$set": bson.M{"is_pinned": isPinned}}
-
-	// Perform the update operation for all documents in the collection.
-	_, err = f.coll.UpdateMany(ctx, filter, update)
-
-	if err != nil {
-		return errs.Wrap(err, "update pin error")
+func (f *FriendMgo) UpdateFriends(ctx context.Context, ownerUserID string, friendUserIDs []string, val map[string]any) error {
+	// Ensure there are IDs to update
+	if len(friendUserIDs) == 0 {
+		return nil // Or return an error if you expect there to always be IDs
 	}
 
-	return nil
-}
-func (f *FriendMgo) UpdateFriendRemark(ctx context.Context, ownerUserID string, friendUserID string, remark string) (err error) {
-
-	filter := bson.M{"owner_user_id": ownerUserID, "friend_user_id": friendUserID}
-	// Create an update operation to set the "is_pinned" field to isPinned for all documents.
-	update := bson.M{"$set": bson.M{"remark": remark}}
-
-	// Perform the update operation for all documents in the collection.
-	_, err = f.coll.UpdateMany(ctx, filter, update)
-
-	if err != nil {
-		return errs.Wrap(err, "update remark error")
+	// Create a filter to match documents with the specified ownerUserID and any of the friendUserIDs
+	filter := bson.M{
+		"owner_user_id":  ownerUserID,
+		"friend_user_id": bson.M{"$in": friendUserIDs},
 	}
 
-	return nil
-}
-func (f *FriendMgo) UpdateFriendEx(ctx context.Context, ownerUserID string, friendUserID string, ex string) (err error) {
-
-	filter := bson.M{"owner_user_id": ownerUserID, "friend_user_id": friendUserID}
-	// Create an update operation to set the "is_pinned" field to isPinned for all documents.
-	update := bson.M{"$set": bson.M{"ex": ex}}
-
-	// Perform the update operation for all documents in the collection.
-	_, err = f.coll.UpdateMany(ctx, filter, update)
-
-	if err != nil {
-		return errs.Wrap(err, "update ex error")
-	}
-
-	return nil
+	// Create an update document
+	update := bson.M{"$set": val}
+
+	// Perform the update operation for all matching documents
+	_, err := mgoutil.UpdateMany(ctx, f.coll, filter, update)
+	return err
 }

pkg/common/db/mgo/user.go

@@ -17,6 +17,8 @@ package mgo
 import (
 	"context"
 	"github.com/OpenIMSDK/protocol/user"
+	"github.com/OpenIMSDK/tools/errs"
+	"go.mongodb.org/mongo-driver/bson/primitive"
 	"time"
 
 	"github.com/OpenIMSDK/tools/mgoutil"
@@ -77,8 +79,46 @@ func (u *UserMgo) Page(ctx context.Context, pagination pagination.Pagination) (c
 	return mgoutil.FindPage[*relation.UserModel](ctx, u.coll, bson.M{}, pagination)
 }
 
+func (u *UserMgo) PageFindUser(ctx context.Context, level1 int64, level2 int64, pagination pagination.Pagination) (count int64, users []*relation.UserModel, err error) {
+	query := bson.M{
+		"$or": []bson.M{
+			{"app_manger_level": level1},
+			{"app_manger_level": level2},
+		},
+	}
+
+	return mgoutil.FindPage[*relation.UserModel](ctx, u.coll, query, pagination)
+}
+func (u *UserMgo) PageFindUserWithKeyword(ctx context.Context, level1 int64, level2 int64, userID string, nickName string, pagination pagination.Pagination) (count int64, users []*relation.UserModel, err error) {
+	// Initialize the base query with level conditions
+	query := bson.M{
+		"$and": []bson.M{
+			{"app_manger_level": bson.M{"$in": []int64{level1, level2}}},
+		},
+	}
+
+	// Add userID and userName conditions to the query if they are provided
+	if userID != "" || nickName != "" {
+		userConditions := []bson.M{}
+		if userID != "" {
+			// Use regex for userID
+			regexPattern := primitive.Regex{Pattern: userID, Options: "i"} // 'i' for case-insensitive matching
+			userConditions = append(userConditions, bson.M{"user_id": regexPattern})
+		}
+		if nickName != "" {
+			// Use regex for userName
+			regexPattern := primitive.Regex{Pattern: nickName, Options: "i"} // 'i' for case-insensitive matching
+			userConditions = append(userConditions, bson.M{"nickname": regexPattern})
+		}
+		query["$and"] = append(query["$and"].([]bson.M), bson.M{"$or": userConditions})
+	}
+
+	// Perform the paginated search
+	return mgoutil.FindPage[*relation.UserModel](ctx, u.coll, query, pagination)
+}
+
 func (u *UserMgo) GetAllUserID(ctx context.Context, pagination pagination.Pagination) (int64, []string, error) {
-	return mgoutil.FindPage[string](ctx, u.coll, bson.M{}, pagination, options.Find().SetProjection(bson.M{"user_id": 1}))
+	return mgoutil.FindPage[string](ctx, u.coll, bson.M{}, pagination, options.Find().SetProjection(bson.M{"_id": 0, "user_id": 1}))
 }
 
 func (u *UserMgo) Exist(ctx context.Context, userID string) (exist bool, err error) {
@@ -86,7 +126,7 @@ func (u *UserMgo) Exist(ctx context.Context, userID string) (exist bool, err err
 }
 
 func (u *UserMgo) GetUserGlobalRecvMsgOpt(ctx context.Context, userID string) (opt int, err error) {
-	return mgoutil.FindOne[int](ctx, u.coll, bson.M{"user_id": userID}, options.FindOne().SetProjection(bson.M{"global_recv_msg_opt": 1}))
+	return mgoutil.FindOne[int](ctx, u.coll, bson.M{"user_id": userID}, options.FindOne().SetProjection(bson.M{"_id": 0, "global_recv_msg_opt": 1}))
 }
 
 func (u *UserMgo) CountTotal(ctx context.Context, before *time.Time) (count int64, err error) {
@@ -96,7 +136,7 @@ func (u *UserMgo) CountTotal(ctx context.Context, before *time.Time) (count int6
 	return mgoutil.Count(ctx, u.coll, bson.M{"create_time": bson.M{"$lt": before}})
 }
 
-func (u *UserMgo) AddUserCommand(ctx context.Context, userID string, Type int32, UUID string, value string) error {
+func (u *UserMgo) AddUserCommand(ctx context.Context, userID string, Type int32, UUID string, value string, ex string) error {
 	collection := u.coll.Database().Collection("userCommands")
 
 	// Create a new document instead of updating an existing one
@@ -106,28 +146,48 @@ func (u *UserMgo) AddUserCommand(ctx context.Context, userID string, Type int32,
 		"uuid":       UUID,
 		"createTime": time.Now().Unix(), // assuming you want the creation time in Unix timestamp
 		"value":      value,
+		"ex":         ex,
 	}
 
 	_, err := collection.InsertOne(ctx, doc)
 	return err
 }
+
 func (u *UserMgo) DeleteUserCommand(ctx context.Context, userID string, Type int32, UUID string) error {
 	collection := u.coll.Database().Collection("userCommands")
 
 	filter := bson.M{"userID": userID, "type": Type, "uuid": UUID}
 
-	_, err := collection.DeleteOne(ctx, filter)
+	result, err := collection.DeleteOne(ctx, filter)
+	if result.DeletedCount == 0 {
+		// No records found to update
+		return errs.Wrap(errs.ErrRecordNotFound)
+	}
 	return err
 }
-func (u *UserMgo) UpdateUserCommand(ctx context.Context, userID string, Type int32, UUID string, value string) error {
+func (u *UserMgo) UpdateUserCommand(ctx context.Context, userID string, Type int32, UUID string, val map[string]any) error {
+	if len(val) == 0 {
+		return nil
+	}
+
 	collection := u.coll.Database().Collection("userCommands")
 
 	filter := bson.M{"userID": userID, "type": Type, "uuid": UUID}
-	update := bson.M{"$set": bson.M{"value": value}}
+	update := bson.M{"$set": val}
 
-	_, err := collection.UpdateOne(ctx, filter, update)
-	return err
+	result, err := collection.UpdateOne(ctx, filter, update)
+	if err != nil {
+		return err
+	}
+
+	if result.MatchedCount == 0 {
+		// No records found to update
+		return errs.Wrap(errs.ErrRecordNotFound)
+	}
+
+	return nil
 }
+
 func (u *UserMgo) GetUserCommand(ctx context.Context, userID string, Type int32) ([]*user.CommandInfoResp, error) {
 	collection := u.coll.Database().Collection("userCommands")
 	filter := bson.M{"userID": userID, "type": Type}
@@ -143,19 +203,23 @@ func (u *UserMgo) GetUserCommand(ctx context.Context, userID string, Type int32)
 
 	for cursor.Next(ctx) {
 		var document struct {
+			Type       int32  `bson:"type"`
 			UUID       string `bson:"uuid"`
 			Value      string `bson:"value"`
 			CreateTime int64  `bson:"createTime"`
+			Ex         string `bson:"ex"`
 		}
 
 		if err := cursor.Decode(&document); err != nil {
 			return nil, err
 		}
 
-		commandInfo := &user.CommandInfoResp{ // Change here: use a pointer to the struct
+		commandInfo := &user.CommandInfoResp{
+			Type:       document.Type,
 			Uuid:       document.UUID,
 			Value:      document.Value,
 			CreateTime: document.CreateTime,
+			Ex:         document.Ex,
 		}
 
 		commands = append(commands, commandInfo)
@@ -167,7 +231,48 @@ func (u *UserMgo) GetUserCommand(ctx context.Context, userID string, Type int32)
 
 	return commands, nil
 }
+func (u *UserMgo) GetAllUserCommand(ctx context.Context, userID string) ([]*user.AllCommandInfoResp, error) {
+	collection := u.coll.Database().Collection("userCommands")
+	filter := bson.M{"userID": userID}
 
+	cursor, err := collection.Find(ctx, filter)
+	if err != nil {
+		return nil, err
+	}
+	defer cursor.Close(ctx)
+
+	// Initialize commands as a slice of pointers
+	commands := []*user.AllCommandInfoResp{}
+
+	for cursor.Next(ctx) {
+		var document struct {
+			Type       int32  `bson:"type"`
+			UUID       string `bson:"uuid"`
+			Value      string `bson:"value"`
+			CreateTime int64  `bson:"createTime"`
+			Ex         string `bson:"ex"`
+		}
+
+		if err := cursor.Decode(&document); err != nil {
+			return nil, err
+		}
+
+		commandInfo := &user.AllCommandInfoResp{
+			Type:       document.Type,
+			Uuid:       document.UUID,
+			Value:      document.Value,
+			CreateTime: document.CreateTime,
+			Ex:         document.Ex,
+		}
+
+		commands = append(commands, commandInfo)
+	}
+
+	if err := cursor.Err(); err != nil {
+		return nil, err
+	}
+	return commands, nil
+}
 func (u *UserMgo) CountRangeEverydayTotal(ctx context.Context, start time.Time, end time.Time) (map[string]int64, error) {
 	pipeline := bson.A{
 		bson.M{

pkg/common/db/table/relation/friend.go

@@ -57,10 +57,6 @@ type FriendModelInterface interface {
 	FindInWhoseFriends(ctx context.Context, friendUserID string, pagination pagination.Pagination) (total int64, friends []*FriendModel, err error)
 	// FindFriendUserIDs retrieves a list of friend user IDs for a given owner.
 	FindFriendUserIDs(ctx context.Context, ownerUserID string) (friendUserIDs []string, err error)
-	// UpdatePinStatus update friend's pin status
-	UpdatePinStatus(ctx context.Context, ownerUserID string, friendUserID string, isPinned bool) (err error)
-	// UpdateFriendRemark update friend's remark
-	UpdateFriendRemark(ctx context.Context, ownerUserID string, friendUserID string, remark string) (err error)
-	// UpdateFriendEx update friend's ex
-	UpdateFriendEx(ctx context.Context, ownerUserID string, friendUserID string, ex string) (err error)
+	// UpdateFriends update friends' fields
+	UpdateFriends(ctx context.Context, ownerUserID string, friendUserIDs []string, val map[string]any) (err error)
 }

pkg/common/db/table/relation/user.go

@@ -56,6 +56,8 @@ type UserModelInterface interface {
 	TakeNotification(ctx context.Context, level int64) (user []*UserModel, err error)
 	TakeByNickname(ctx context.Context, nickname string) (user []*UserModel, err error)
 	Page(ctx context.Context, pagination pagination.Pagination) (count int64, users []*UserModel, err error)
+	PageFindUser(ctx context.Context, level1 int64, level2 int64, pagination pagination.Pagination) (count int64, users []*UserModel, err error)
+	PageFindUserWithKeyword(ctx context.Context, level1 int64, level2 int64, userID, nickName string, pagination pagination.Pagination) (count int64, users []*UserModel, err error)
 	Exist(ctx context.Context, userID string) (exist bool, err error)
 	GetAllUserID(ctx context.Context, pagination pagination.Pagination) (count int64, userIDs []string, err error)
 	GetUserGlobalRecvMsgOpt(ctx context.Context, userID string) (opt int, err error)
@@ -64,8 +66,9 @@ type UserModelInterface interface {
 	// 获取范围内用户增量
 	CountRangeEverydayTotal(ctx context.Context, start time.Time, end time.Time) (map[string]int64, error)
 	//CRUD user command
-	AddUserCommand(ctx context.Context, userID string, Type int32, UUID string, value string) error
+	AddUserCommand(ctx context.Context, userID string, Type int32, UUID string, value string, ex string) error
 	DeleteUserCommand(ctx context.Context, userID string, Type int32, UUID string) error
-	UpdateUserCommand(ctx context.Context, userID string, Type int32, UUID string, value string) error
+	UpdateUserCommand(ctx context.Context, userID string, Type int32, UUID string, val map[string]any) error
 	GetUserCommand(ctx context.Context, userID string, Type int32) ([]*user.CommandInfoResp, error)
+	GetAllUserCommand(ctx context.Context, userID string) ([]*user.AllCommandInfoResp, error)
 }

pkg/common/db/unrelation/mongo.go

@@ -78,8 +78,8 @@ func buildMongoURI() string {
 		return config.Config.Mongo.Uri
 	}
 
-	username := os.Getenv("MONGO_USERNAME")
-	password := os.Getenv("MONGO_PASSWORD")
+	username := os.Getenv("MONGO_OPENIM_USERNAME")
+	password := os.Getenv("MONGO_OPENIM_PASSWORD")
 	address := os.Getenv("MONGO_ADDRESS")
 	port := os.Getenv("MONGO_PORT")
 	database := os.Getenv("MONGO_DATABASE")

pkg/common/prommetrics/gin_api.go

@@ -14,14 +14,14 @@
 
 package prommetrics
 
-import ginProm "github.com/openimsdk/open-im-server/v3/pkg/common/ginprometheus"
+import ginprom "github.com/openimsdk/open-im-server/v3/pkg/common/ginprometheus"
 
 /*
 labels := prometheus.Labels{"label_one": "any", "label_two": "value"}
 ApiCustomCnt.MetricCollector.(*prometheus.CounterVec).With(labels).Inc().
 */
 var (
-	ApiCustomCnt = &ginProm.Metric{
+	ApiCustomCnt = &ginprom.Metric{
 		Name:        "custom_total",
 		Description: "Custom counter events.",
 		Type:        "counter_vec",

pkg/common/prommetrics/prommetrics.go

@@ -15,7 +15,7 @@
 package prommetrics
 
 import (
-	grpc_prometheus "github.com/grpc-ecosystem/go-grpc-prometheus"
+	gp "github.com/grpc-ecosystem/go-grpc-prometheus"
 	"github.com/prometheus/client_golang/prometheus"
 	"github.com/prometheus/client_golang/prometheus/collectors"
 
@@ -23,10 +23,10 @@ import (
 	"github.com/openimsdk/open-im-server/v3/pkg/common/ginprometheus"
 )
 
-func NewGrpcPromObj(cusMetrics []prometheus.Collector) (*prometheus.Registry, *grpc_prometheus.ServerMetrics, error) {
+func NewGrpcPromObj(cusMetrics []prometheus.Collector) (*prometheus.Registry, *gp.ServerMetrics, error) {
 	////////////////////////////////////////////////////////
 	reg := prometheus.NewRegistry()
-	grpcMetrics := grpc_prometheus.NewServerMetrics()
+	grpcMetrics := gp.NewServerMetrics()
 	grpcMetrics.EnableHandlingTimeHistogram()
 	cusMetrics = append(cusMetrics, grpcMetrics, collectors.NewGoCollector())
 	reg.MustRegister(cusMetrics...)

pkg/msgprocessor/conversation.go

@@ -52,6 +52,7 @@ func GetChatConversationIDByMsg(msg *sdkws.MsgData) string {
 	case constant.NotificationChatType:
 		return "sn_" + msg.SendID + "_" + msg.RecvID
 	}
+
 	return ""
 }
 

pkg/msgprocessor/options.go

@@ -37,6 +37,7 @@ func NewOptions(opts ...OptionsOpt) Options {
 	for _, opt := range opts {
 		opt(options)
 	}
+
 	return options
 }
 

pkg/rpcclient/notification/friend.go

@@ -197,7 +197,7 @@ func (f *FriendNotificationSender) FriendRemarkSetNotification(ctx context.Conte
 	return f.Notification(ctx, fromUserID, toUserID, constant.FriendRemarkSetNotification, &tips)
 }
 func (f *FriendNotificationSender) FriendsInfoUpdateNotification(ctx context.Context, toUserID string, friendIDs []string) error {
-	tips := sdkws.FriendsInfoUpdateTips{}
+	tips := sdkws.FriendsInfoUpdateTips{FromToUserID: &sdkws.FromToUserID{}}
 	tips.FromToUserID.ToUserID = toUserID
 	tips.FriendIDs = friendIDs
 	return f.Notification(ctx, toUserID, toUserID, constant.FriendsInfoUpdateNotification, &tips)

pkg/rpcclient/notification/group.go

@@ -409,11 +409,16 @@ func (g *GroupNotificationSender) GroupApplicationAcceptedNotification(ctx conte
 	if err != nil {
 		return err
 	}
-	tips := &sdkws.GroupApplicationAcceptedTips{Group: group, HandleMsg: req.HandledMsg, ReceiverAs: 1}
+	tips := &sdkws.GroupApplicationAcceptedTips{Group: group, HandleMsg: req.HandledMsg}
 	if err := g.fillOpUser(ctx, &tips.OpUser, tips.Group.GroupID); err != nil {
 		return err
 	}
-	for _, userID := range append(userIDs, mcontext.GetOpUserID(ctx)) {
+	for _, userID := range append(userIDs, req.FromUserID) {
+		if userID == req.FromUserID {
+			tips.ReceiverAs = 0
+		} else {
+			tips.ReceiverAs = 1
+		}
 		err = g.Notification(ctx, mcontext.GetOpUserID(ctx), userID, constant.GroupApplicationAcceptedNotification, tips)
 		if err != nil {
 			log.ZError(ctx, "failed", err)
@@ -441,7 +446,12 @@ func (g *GroupNotificationSender) GroupApplicationRejectedNotification(ctx conte
 	if err := g.fillOpUser(ctx, &tips.OpUser, tips.Group.GroupID); err != nil {
 		return err
 	}
-	for _, userID := range append(userIDs, mcontext.GetOpUserID(ctx)) {
+	for _, userID := range append(userIDs, req.FromUserID) {
+		if userID == req.FromUserID {
+			tips.ReceiverAs = 0
+		} else {
+			tips.ReceiverAs = 1
+		}
 		err = g.Notification(ctx, mcontext.GetOpUserID(ctx), userID, constant.GroupApplicationRejectedNotification, tips)
 		if err != nil {
 			log.ZError(ctx, "failed", err)

pkg/rpcclient/notification/user.go

@@ -103,3 +103,21 @@ func (u *UserNotificationSender) UserStatusChangeNotification(
 ) error {
 	return u.Notification(ctx, tips.FromUserID, tips.ToUserID, constant.UserStatusChangeNotification, tips)
 }
+func (u *UserNotificationSender) UserCommandUpdateNotification(
+	ctx context.Context,
+	tips *sdkws.UserCommandUpdateTips,
+) error {
+	return u.Notification(ctx, tips.FromUserID, tips.ToUserID, constant.UserCommandUpdateNotification, tips)
+}
+func (u *UserNotificationSender) UserCommandAddNotification(
+	ctx context.Context,
+	tips *sdkws.UserCommandAddTips,
+) error {
+	return u.Notification(ctx, tips.FromUserID, tips.ToUserID, constant.UserCommandAddNotification, tips)
+}
+func (u *UserNotificationSender) UserCommandDeleteNotification(
+	ctx context.Context,
+	tips *sdkws.UserCommandDeleteTips,
+) error {
+	return u.Notification(ctx, tips.FromUserID, tips.ToUserID, constant.UserCommandDeleteNotification, tips)
+}

pkg/util/flag/flag.go

@@ -0,0 +1,40 @@
+package flag
+
+import (
+	goFlag "flag"
+	"log"
+	"strings"
+
+	"github.com/spf13/pflag"
+)
+
+// WordSepNormalizeFunc changes all flags that contain "_" separators.
+func WordSepNormalizeFunc(f *pflag.FlagSet, name string) pflag.NormalizedName {
+	if strings.Contains(name, "_") {
+		return pflag.NormalizedName(strings.ReplaceAll(name, "_", "-"))
+	}
+	return pflag.NormalizedName(name)
+}
+
+// WarnWordSepNormalizeFunc changes and warns for flags that contain "_" separators.
+func WarnWordSepNormalizeFunc(f *pflag.FlagSet, name string) pflag.NormalizedName {
+	if strings.Contains(name, "_") {
+		normalizedName := strings.ReplaceAll(name, "_", "-")
+		log.Printf("WARNING: flag %s has been deprecated and will be removed in a future version. Use %s instead.", name, normalizedName)
+		return pflag.NormalizedName(normalizedName)
+	}
+	return pflag.NormalizedName(name)
+}
+
+// InitFlags normalizes, parses, then logs the command line flags.
+func InitFlags() {
+	pflag.CommandLine.SetNormalizeFunc(WordSepNormalizeFunc)
+	pflag.CommandLine.AddGoFlagSet(goFlag.CommandLine)
+}
+
+// PrintFlags logs the flags in the flagset.
+func PrintFlags(flags *pflag.FlagSet) {
+	flags.VisitAll(func(flag *pflag.Flag) {
+		log.Printf("FLAG: --%s=%q", flag.Name, flag.Value)
+	})
+}

pkg/util/genutil/genutil.go

@@ -0,0 +1,27 @@
+package genutil
+
+import (
+	"fmt"
+	"os"
+	"path/filepath"
+)
+
+// OutDir creates the absolute path name from path and checks path exists.
+// Returns absolute path including trailing '/' or error if path does not exist.
+func OutDir(path string) (string, error) {
+	outDir, err := filepath.Abs(path)
+	if err != nil {
+		return "", err
+	}
+
+	stat, err := os.Stat(outDir)
+	if err != nil {
+		return "", err
+	}
+
+	if !stat.IsDir() {
+		return "", fmt.Errorf("output directory %s is not a directory", outDir)
+	}
+	outDir += "/"
+	return outDir, nil
+}

pkg/util/genutil/genutil_test.go

@@ -0,0 +1,26 @@
+package genutil
+
+import (
+	"testing"
+)
+
+func TestValidDir(t *testing.T) {
+	_, err := OutDir("./")
+	if err != nil {
+		t.Fatal(err)
+	}
+}
+
+func TestInvalidDir(t *testing.T) {
+	_, err := OutDir("./nondir")
+	if err == nil {
+		t.Fatal("expected an error")
+	}
+}
+
+func TestNotDir(t *testing.T) {
+	_, err := OutDir("./genutils_test.go")
+	if err == nil {
+		t.Fatal("expected an error")
+	}
+}

scripts/.spelling_failures

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

scripts/build-all-service.sh

@@ -30,7 +30,7 @@ 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 .)
 popd >/dev/null
 

scripts/check-all.sh

@@ -30,6 +30,7 @@ OPENIM_VERBOSE=4
 
 openim::log::info "\n# Begin to check all openim service"
 
+openim::log::status "Check all dependent service ports"
 # Elegant printing function
 # Elegant printing function
 print_services_and_ports() {
@@ -60,7 +61,7 @@ print_services_and_ports "${OPENIM_DEPENDENCY_TARGETS[@]}" "${OPENIM_DEPENDENCY_
 # OpenIM check
 echo "++ The port being checked: ${OPENIM_SERVER_PORT_LISTARIES[@]}"
 openim::log::info "\n## Check all dependent service ports"
-echo "+++ The port being checked: ${OPENIM_DEPENDENCY_PORT_LISTARIES[@]}"
+echo "++ The port being checked: ${OPENIM_DEPENDENCY_PORT_LISTARIES[@]}"
 
 set +e
 

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_SUBPATH="${LOCAL_OUTPUT_ROOT}/platforms"
-readonly LOCAL_OUTPUT_BINPATH="${LOCAL_OUTPUT_SUBPATH}"
+readonly LOCAL_OUTPUT_ROOT="${OPENIM_ROOT}/${OUT_DIR:-_output}"
+readonly LOCAL_OUTPUT_SUBPATH="${LOCAL_OUTPUT_ROOT}/bin"
+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"
 
@@ -161,7 +162,7 @@ function openim::build::verify_prereqs() {
   #LOCAL_OUTPUT_BUILD_CONTEXT="${LOCAL_OUTPUT_IMAGE_STAGING}/${OPENIM_BUILD_IMAGE}"
 
   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"
 }
 
 # ---------------------------------------------------------------------------
@@ -416,8 +417,8 @@ function openim::build::build_image() {
 
   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/rsyncd.sh" "${LOCAL_OUTPUT_BUILD_CONTEXT}/"
+  cp "${OPENIM_ROOT}/build/build-image/Dockerfile" "${LOCAL_OUTPUT_BUILD_CONTEXT}/Dockerfile"
+  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"
   chmod go= "${LOCAL_OUTPUT_BUILD_CONTEXT}/rsyncd.password"
 

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,9 +14,11 @@
 # 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

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
-result=$?
-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."
+if [ -z "${OPENIM_IP}" ]; then
+    openim::util::require-dig
 fi
 
 source "${env_file}"
@@ -61,4 +53,4 @@ fi
 
 eval "cat << EOF
 $(cat ${template_file})
-EOF"
+EOF"

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/openim.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/openim.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"
 )

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,46 @@ 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
+        return 1
+    fi
+    return 0
+}
+
 # Wait for a short period to allow containers to initialize
 sleep 30
+check_containers
 
-# 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
 
-popd
+popd

scripts/install/dependency.sh

@@ -34,9 +34,9 @@ docker run -d \
     -e wiredTigerCacheSizeGB=1 \
     -e MONGO_INITDB_ROOT_USERNAME=${OPENIM_USER} \
     -e MONGO_INITDB_ROOT_PASSWORD=${PASSWORD} \
-    -e MONGO_INITDB_DATABASE=openIM \
-    -e MONGO_USERNAME=${OPENIM_USER} \
-    -e MONGO_PASSWORD=${PASSWORD} \
+    -e MONGO_INITDB_DATABASE=openim_v3 \
+    -e MONGO_OPENIM_USERNAME=${OPENIM_USER} \
+    -e MONGO_OPENIM_PASSWORD=${PASSWORD} \
     --restart always \
     mongo:6.0.2 --wiredTigerCacheSizeGB 1 --auth
 

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端口
@@ -171,13 +171,13 @@ def "MONGO_URI"                                # MongoDB的URI
 def "MONGO_PORT" "37017"                       # MongoDB的端口
 def "MONGO_ADDRESS" "${DOCKER_BRIDGE_GATEWAY}" # MongoDB的地址
 def "MONGO_DATABASE" "${DATABASE_NAME}"        # MongoDB的数据库名
-def "MONGO_USERNAME" "root"		       # MongoDB的管理员身份用户名
+def "MONGO_USERNAME" "root"		               # MongoDB的管理员身份用户名
 # MongoDB的管理员身份密码
 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,15 +66,20 @@ 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
-        ps -p $PID -o pid,cmd
-      done
+        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."
+        openim::log::error_exit "Expected $OPENIM_MSGGATEWAY_NUM openim msgtransfer processes, but found $NUM_PROCESSES msgtransfer processes."
     fi
 }
 

scripts/install/openim-rpc.sh

@@ -123,12 +123,13 @@ 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.
         OPENIM_RPC_SERVICE_PORTS=( $(openim::util::list-to-string ${OPENIM_RPC_PORT_LISTARIES[$i]}) )
         read -a OPENIM_RPC_SERVICE_PORTS_ARRAY <<< ${OPENIM_RPC_SERVICE_PORTS}
-        
+
         OPENIM_RPC_PROM_PORTS=( $(openim::util::list-to-string ${OPENIM_RPC_PROM_PORT_LISTARIES[$i]}) )
         read -a OPENIM_RPC_PROM_PORTS_ARRAY <<< ${OPENIM_RPC_PROM_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

@@ -103,8 +103,8 @@ function openim::tools::start_service() {
     printf "Specifying prometheus port: %s\n" "${prometheus_port}"
     cmd="${cmd} --prometheus_port ${prometheus_port}"
   fi
-  openim::log::info "Starting ${binary_name}..."
-  ${cmd}
+  openim::log::status "Starting ${binary_name}..."
+  ${cmd} | tee -a "${LOG_FILE}"
 }
 
 function openim::tools::start() {

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=(
-  imctl
+    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_TOOLS=""${OPENIM_ROOT}"/_output/bin/tools"
+export THIS_PLATFORM_BIN="${OPENIM_ROOT}/_output/bin/platforms"
+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)"