fix: kafka environment port

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

.dockerignore

@@ -1,7 +1,8 @@
-# Ignore files and directories starting with a dot
+<!-- # Ignore files and directories starting with a dot
 
 # Ignore specific files
 .dockerignore
+.git
 
 # Ignore build artifacts
 _output/
@@ -28,4 +29,4 @@ assets/
 components/
 
 # Ignore tools and scripts
-.github/
+.github/ -->

.env

@@ -1,5 +1,265 @@
+# ======================================
+# ========= Basic Configuration ========
+# ======================================
+
+# The user for authentication or system operations.
+# Default: USER=root
 USER=root
+
+# Password associated with the specified user for authentication.
+# Default: PASSWORD=openIM123
 PASSWORD=openIM123
-MINIO_ENDPOINT=http://127.0.0.1:10005
-API_URL=http://127.0.0.1:10002/object/
-DATA_DIR=./
+
+# Endpoint for the MinIO object storage service.
+# Default: MINIO_ENDPOINT=http://172.28.0.1:10005
+MINIO_ENDPOINT=http://172.28.0.1:10005
+
+# Base URL for the application programming interface (API).
+# Default: API_URL=http://172.28.0.1:10002
+API_URL=http://172.28.0.1:10002
+
+# Directory path for storing data files or related information.
+# Default: DATA_DIR=./
+DATA_DIR=./
+
+# ======================================
+# ========= 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
+
+# Address or hostname for the MySQL network.
+# Default: MYSQL_NETWORK_ADDRESS=172.28.0.2
+MYSQL_NETWORK_ADDRESS=172.28.0.2
+
+# Address or hostname for the MongoDB network.
+# Default: MONGO_NETWORK_ADDRESS=172.28.0.3
+MONGO_NETWORK_ADDRESS=172.28.0.3
+
+# Address or hostname for the Redis network.
+# Default: REDIS_NETWORK_ADDRESS=172.28.0.4
+REDIS_NETWORK_ADDRESS=172.28.0.4
+
+# Address or hostname for the Kafka network.
+# Default: KAFKA_NETWORK_ADDRESS=172.28.0.5
+KAFKA_NETWORK_ADDRESS=172.28.0.5
+
+# Address or hostname for the ZooKeeper network.
+# Default: ZOOKEEPER_NETWORK_ADDRESS=172.28.0.6
+ZOOKEEPER_NETWORK_ADDRESS=172.28.0.6
+
+# Address or hostname for the MinIO network.
+# Default: MINIO_NETWORK_ADDRESS=172.28.0.7
+MINIO_NETWORK_ADDRESS=172.28.0.7
+
+# Address or hostname for the OpenIM web network.
+# Default: OPENIM_WEB_NETWORK_ADDRESS=172.28.0.8
+OPENIM_WEB_NETWORK_ADDRESS=172.28.0.8
+
+# Address or hostname for the OpenIM server network.
+# Default: OPENIM_SERVER_NETWORK_ADDRESS=172.28.0.9
+OPENIM_SERVER_NETWORK_ADDRESS=172.28.0.9
+
+# Address or hostname for the OpenIM chat network.
+# Default: OPENIM_CHAT_NETWORK_ADDRESS=172.28.0.10
+OPENIM_CHAT_NETWORK_ADDRESS=172.28.0.10
+
+# Address or hostname for the Prometheus network.
+# Default: PROMETHEUS_NETWORK_ADDRESS=172.28.0.11
+PROMETHEUS_NETWORK_ADDRESS=172.28.0.11
+
+# Address or hostname for the Grafana network.
+# Default: GRAFANA_NETWORK_ADDRESS=172.28.0.12
+GRAFANA_NETWORK_ADDRESS=172.28.0.12
+
+
+# ===============================================
+# = 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.6
+
+# Port for ZooKeeper service.
+# Default: ZOOKEEPER_PORT=12181
+ZOOKEEPER_PORT=12181
+
+# ----- MySQL Configuration -----
+
+# Address or hostname for the MySQL service.
+# Default: MYSQL_ADDRESS=172.28.0.1
+MYSQL_ADDRESS=172.28.0.2
+
+# Port on which MySQL database service is running.
+# Default: MYSQL_PORT=13306
+MYSQL_PORT=13306
+
+# Password to authenticate with the MySQL database service.
+# Default: MYSQL_PASSWORD=openIM123
+MYSQL_PASSWORD=openIM123
+
+# ----- MongoDB Configuration -----
+# Address or hostname for the MongoDB service.
+# Default: MONGO_ADDRESS=172.28.0.1
+MONGO_ADDRESS=172.28.0.3
+
+# 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.4
+
+# 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.5
+
+# 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.7
+
+# 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.11
+
+# 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.12
+
+# Port on which Grafana service is running.
+# Default: GRAFANA_PORT=3000
+GRAFANA_PORT=3000
+
+# ======================================
+# ============ 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.8
+
+
+# ======================================
+# ========= OpenIM Server ==============
+# ======================================
+
+# Address or hostname for the OpenIM server.
+# Default: OPENIM_SERVER_ADDRESS=172.28.0.1
+OPENIM_SERVER_ADDRESS=172.28.0.9
+
+# 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_BRANCH=main
+CHAT_BRANCH=main
+
+# Address or hostname for the OpenIM chat service.
+# Default: OPENIM_CHAT_ADDRESS=172.28.0.1
+OPENIM_CHAT_ADDRESS=172.28.0.10
+
+# 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_BRANCH=main
+SERVER_BRANCH=main
+
+# Port for the OpenIM admin API.
+# Default: OPENIM_ADMIN_API_PORT=10009
+OPENIM_ADMIN_API_PORT=10009

.github/release-drafter.yml

@@ -0,0 +1,51 @@
+# Copyright © 2023 OpenIM. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+name-template: 'v$RESOLVED_VERSION 🌈'
+tag-template: 'v$RESOLVED_VERSION'
+categories:
+  - title: '🚀 Features'
+    labels:
+      - 'feature'
+      - 'enhancement'
+  - title: '🐛 Bug Fixes'
+    labels:
+      - 'kind/fix'
+      - 'kind/feature'
+      - 'enhancement'
+      - 'kind/documentation'
+      - 'good first issue'
+  - title: '🧰 Maintenance'
+    label: 'chore'
+change-template: '- $TITLE @$AUTHOR (#$NUMBER)'
+change-title-escapes: '\<*_&' # You can add # and @ to disable mentions, and add ` to disable code blocks.
+version-resolver:
+  major:
+    labels:
+      - 'major'
+  minor:
+    labels:
+      - 'minor'
+  patch:
+    labels:
+      - 'patch'
+  default: patch
+template: |
+  ## Changes $PREVIOUS_TAG
+
+  $CHANGES
+
+  ## Contributors to this $REPOSITORY	release
+
+  $CONTRIBUTORS	

.github/sync-release.yml

@@ -0,0 +1,30 @@
+# 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.
+
+OpenIMSDK/openim-docker:
+  - source: ./config
+    dest: ./openim-server/release/config
+    replace: true
+  - source: ./docs
+    dest: ./openim-server/release/docs
+    replace: true
+  - source: ./scripts
+    dest: ./openim-server/release/scripts
+    replace: true
+  - source: ./scripts
+    dest: ./scripts
+    replace: false
+  - source: ./Makefile
+    dest: ./Makefile
+    replace: false

.github/sync.yml

@@ -75,6 +75,23 @@ OpenIMSDK/OpenKF:
     dest: .github/.codecov.yml
     replace: false
 
+OpenIMSDK/openim-docker:
+  - source: ./config
+    dest: ./openim-server/main/config
+    replace: true
+  - source: ./docs
+    dest: ./openim-server/main/docs
+    replace: true
+  - source: ./scripts
+    dest: ./openim-server/main/scripts
+    replace: true
+  - source: ./scripts
+    dest: ./scripts
+    replace: true
+  - source: ./Makefile
+    dest: ./Makefile
+    replace: true
+
 group:
   # first group：common to all warehouses
   # TODO: add the required warehouse here
@@ -86,7 +103,7 @@ group:
       OpenIMSDK/community
       OpenIMSDK/openim-charts
       OpenIMSDK/openim-sdk-cpp@main
-    files: 
+    files:
       - source: LICENSE
         dest: LICENSE
         replace: false
@@ -116,4 +133,4 @@ group:
         replace: false
       - source: ./scripts/githooks/
         dest: ./scripts/githooks/
-        replace: true
+        replace: true

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

@@ -26,7 +26,8 @@ on:
 jobs:
   create-pr:
     runs-on: ubuntu-latest
-    if: github.event.pull_request.base.ref == 'main' && github.event.pull_request.merged == true
+    if: github.event.pull_request.base.ref == 'main'
+    # && github.event.pull_request.merged == true
     steps:
         - name: Check out code
           uses: actions/checkout@v3

.github/workflows/auto-invite.yml

@@ -34,11 +34,11 @@ jobs:
           body: |
             We value close connections with our users, developers, and contributors here at Open-IM-Server. With a large community and maintainer team, we're always here to help and support you. Whether you're looking to join our community or have any questions or suggestions, we welcome you to get in touch with us.
 
-            Our most recommended way to get in touch is through [Slack](https://join.slack.com/t/openimsdk/shared_invite/zt-1tmoj26uf-_FDy3dowVHBiGvLk9e5Xkg). Even if you're in China, Slack is usually not blocked by firewalls, making it an easy way to connect with us. Our Slack community is the ideal place to discuss and share ideas and suggestions with other users and developers of Open-IM-Server. You can ask technical questions, seek help, or share your experiences with other users of Open-IM-Server.
+            Our most recommended way to get in touch is through [Slack](https://join.slack.com/t/openimsdk/shared_invite/zt-22720d66b-o_FvKxMTGXtcnnnHiMqe9Q). Even if you're in China, Slack is usually not blocked by firewalls, making it an easy way to connect with us. Our Slack community is the ideal place to discuss and share ideas and suggestions with other users and developers of Open-IM-Server. You can ask technical questions, seek help, or share your experiences with other users of Open-IM-Server.
             
             In addition to Slack, we also offer the following ways to get in touch:
             
-            + <a href="https://join.slack.com/t/openimsdk/shared_invite/zt-1tmoj26uf-_FDy3dowVHBiGvLk9e5Xkg" target="_blank"><img src="https://img.shields.io/badge/Slack-OpenIM%2B-blueviolet?logo=slack&amp;logoColor=white"></a> We also have Slack channels for you to communicate and discuss. To join, visit https://slack.com/ and join our [👀 Open-IM-Server slack](https://join.slack.com/t/openimsdk/shared_invite/zt-1tmoj26uf-_FDy3dowVHBiGvLk9e5Xkg) team channel.
+            + <a href="https://join.slack.com/t/openimsdk/shared_invite/zt-22720d66b-o_FvKxMTGXtcnnnHiMqe9Q" target="_blank"><img src="https://img.shields.io/badge/Slack-OpenIM%2B-blueviolet?logo=slack&amp;logoColor=white"></a> We also have Slack channels for you to communicate and discuss. To join, visit https://slack.com/ and join our [👀 Open-IM-Server slack](https://join.slack.com/t/openimsdk/shared_invite/zt-22720d66b-o_FvKxMTGXtcnnnHiMqe9Q) team channel.
             + <a href="https://mail.google.com/mail/u/0/?fs=1&tf=cm&to=winxu81@gmail.com" target="_blank"><img src="https://img.shields.io/badge/gmail-%40OOpenIMSDKCore?style=social&logo=gmail"></a> Get in touch with us on [Gmail](https://mail.google.com/mail/u/0/?fs=1&tf=cm&to=winxu81@gmail.com). If you have any questions or issues that need resolving, or any suggestions and feedback for our open source projects, please feel free to contact us via email.
             + <a href="https://doc.rentsoft.cn/" target="_blank"><img src="https://img.shields.io/badge/%E5%8D%9A%E5%AE%A2-%40OpenIMSDKCore-blue?style=social&logo=Octopus%20Deploy"></a> Read our [blog](https://doc.rentsoft.cn/). Our blog is a great place to stay up-to-date with Open-IM-Server projects and trends. On the blog, we share our latest developments, tech trends, and other interesting information.
             + <a href="https://github.com/OpenIMSDK/OpenIM-Docs/blob/main/docs/images/WechatIMG20.jpeg" target="_blank"><img src="https://img.shields.io/badge/%E5%BE%AE%E4%BF%A1-OpenIMSDKCore-brightgreen?logo=wechat&style=flat-square"></a> Add [Wechat](https://github.com/OpenIMSDK/OpenIM-Docs/blob/main/docs/images/WechatIMG20.jpeg) and indicate that you are a user or developer of Open-IM-Server. We will process your request as soon as possible.

.github/workflows/deploy.yml

@@ -52,22 +52,4 @@ jobs:
             echo "REPO: $REPO"
             git clone -b develop https://github.com/${OWNER}/${REPO}.git; cd ${REPO}
             docker compose up -d
-
-
-    #   - name: deploy # Deployment
-    #     run: |
-    #       ssh work@182.92.xxx.xxx "
-    #         # 【Attention】Log in with the 'work' account, manually create /home/work/imooc-lego directory
-    #         # Then git clone https://username:password@github.com/imooc-lego/biz-editor-server.git -b dev (private repository, use GitHub username and password)
-    #         # Remember to delete origin to avoid exposing GitHub password
-    #         cd /home/work/imooc-lego/biz-editor-server;
-    #         git remote add origin https://openimbot:${{secrets.WFP_PASSWORD}}@github.com/OpenIMSDK/open-im-server.git;
-    #         git checkout dev;
-    #         git pull origin dev; # Download the latest code again
-    #         git remote remove origin; # Remove origin to avoid exposing GitHub password
-    #         # Start docker
-    #         docker-compose build editor-server; # Same as the service name in docker-compose.yml
-    #         docker-compose up -d;
-    #       "
-    #   - name: delete ssh key # Delete ssh key
-    #     run: rm -rf ~/.ssh/id_rsa
+        continue-on-error: true

.github/workflows/docker-buildx.yml

@@ -95,7 +95,7 @@ jobs:
         uses: docker/build-push-action@v4
         with:
           context: .
-          file: ./build/docker/openim-api/Dockerfile
+          file: ./build/images/openim-api/Dockerfile
           platforms: linux/amd64,linux/arm64
           push: ${{ github.event_name != 'pull_request' }}
           tags: ${{ steps.meta1.outputs.tags }}
@@ -113,7 +113,7 @@ jobs:
         uses: docker/build-push-action@v4
         with:
           context: .
-          file: ./build/docker/openim-cmdutils/Dockerfile
+          file: ./build/images/openim-cmdutils/Dockerfile
           platforms: linux/amd64,linux/arm64
           push: ${{ github.event_name != 'pull_request' }}
           tags: ${{ steps.meta2.outputs.tags }}
@@ -131,7 +131,7 @@ jobs:
         uses: docker/build-push-action@v4
         with:
           context: .
-          file: ./build/docker/openim-crontask/Dockerfile
+          file: ./build/images/openim-crontask/Dockerfile
           platforms: linux/amd64,linux/arm64
           push: ${{ github.event_name != 'pull_request' }}
           tags: ${{ steps.meta3.outputs.tags }}
@@ -149,7 +149,7 @@ jobs:
         uses: docker/build-push-action@v4
         with:
           context: .
-          file: ./build/docker/openim-msggateway/Dockerfile
+          file: ./build/images/openim-msggateway/Dockerfile
           platforms: linux/amd64,linux/arm64
           push: ${{ github.event_name != 'pull_request' }}
           tags: ${{ steps.meta4.outputs.tags }}
@@ -167,7 +167,7 @@ jobs:
         uses: docker/build-push-action@v4
         with:
           context: .
-          file: ./build/docker/openim-msgtransfer/Dockerfile
+          file: ./build/images/openim-msgtransfer/Dockerfile
           platforms: linux/amd64,linux/arm64
           push: ${{ github.event_name != 'pull_request' }}
           tags: ${{ steps.meta5.outputs.tags }}
@@ -185,7 +185,7 @@ jobs:
         uses: docker/build-push-action@v4
         with:
           context: .
-          file: ./build/docker/openim-push/Dockerfile
+          file: ./build/images/openim-push/Dockerfile
           platforms: linux/amd64,linux/arm64
           push: ${{ github.event_name != 'pull_request' }}
           tags: ${{ steps.meta6.outputs.tags }}
@@ -203,7 +203,7 @@ jobs:
         uses: docker/build-push-action@v4
         with:
           context: .
-          file: ./build/docker/openim-rpc-auth/Dockerfile
+          file: ./build/images/openim-rpc-auth/Dockerfile
           platforms: linux/amd64,linux/arm64
           push: ${{ github.event_name != 'pull_request' }}
           tags: ${{ steps.meta7.outputs.tags }}
@@ -221,7 +221,7 @@ jobs:
         uses: docker/build-push-action@v4
         with:
           context: .
-          file: ./build/docker/openim-rpc-conversation/Dockerfile
+          file: ./build/images/openim-rpc-conversation/Dockerfile
           platforms: linux/amd64,linux/arm64
           push: ${{ github.event_name != 'pull_request' }}
           tags: ${{ steps.meta8.outputs.tags }}
@@ -239,7 +239,7 @@ jobs:
         uses: docker/build-push-action@v4
         with:
           context: .
-          file: ./build/docker/openim-rpc-friend/Dockerfile
+          file: ./build/images/openim-rpc-friend/Dockerfile
           platforms: linux/amd64,linux/arm64
           push: ${{ github.event_name != 'pull_request' }}
           tags: ${{ steps.meta9.outputs.tags }}
@@ -257,7 +257,7 @@ jobs:
         uses: docker/build-push-action@v4
         with:
           context: .
-          file: ./build/docker/openim-rpc-group/Dockerfile
+          file: ./build/images/openim-rpc-group/Dockerfile
           platforms: linux/amd64,linux/arm64
           push: ${{ github.event_name != 'pull_request' }}
           tags: ${{ steps.meta10.outputs.tags }}
@@ -275,7 +275,7 @@ jobs:
         uses: docker/build-push-action@v4
         with:
           context: .
-          file: ./build/docker/openim-rpc-msg/Dockerfile
+          file: ./build/images/openim-rpc-msg/Dockerfile
           platforms: linux/amd64,linux/arm64
           push: ${{ github.event_name != 'pull_request' }}
           tags: ${{ steps.meta11.outputs.tags }}
@@ -293,7 +293,7 @@ jobs:
         uses: docker/build-push-action@v4
         with:
           context: .
-          file: ./build/docker/openim-rpc-third/Dockerfile
+          file: ./build/images/openim-rpc-third/Dockerfile
           platforms: linux/amd64,linux/arm64
           push: ${{ github.event_name != 'pull_request' }}
           tags: ${{ steps.meta12.outputs.tags }}
@@ -311,10 +311,75 @@ jobs:
         uses: docker/build-push-action@v4
         with:
           context: .
-          file: ./build/docker/openim-rpc-user/Dockerfile
+          file: ./build/images/openim-rpc-user/Dockerfile
           platforms: linux/amd64,linux/arm64
           push: ${{ github.event_name != 'pull_request' }}
           tags: ${{ steps.meta13.outputs.tags }}
           labels: ${{ steps.meta13.outputs.labels }}
           cache-from: type=local,src=/tmp/.buildx-cache
+          cache-to: type=local,dest=/tmp/.buildx-cache
+
+  build-tools-ghcr:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v2
+        
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v2
+        with:
+          install: true
+
+      - name: Cache Docker layers
+        uses: actions/cache@v3
+        with:
+          path: /tmp/.buildx-cache
+          key: ${{ runner.os }}-buildx-${{ github.sha }}
+          restore-keys: |
+            ${{ runner.os }}-buildx-
+
+      - name: Log in to GitHub Container Registry
+        uses: docker/login-action@v2
+        with:
+          registry: ghcr.io
+          username: ${{ github.repository_owner }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Extract metadata (tags, labels) for Docker openim-web
+        id: meta1
+        uses: docker/metadata-action@v4.6.0
+        with:
+          images: ghcr.io/openimsdk/openim-web
+
+      - name: Build and push Docker image for openim-web
+        uses: docker/build-push-action@v4
+        with:
+          context: .
+          file: ./build/images/openim-tools/openim-web/Dockerfile
+          platforms: linux/amd64,linux/arm64
+          push: ${{ github.event_name != 'pull_request' }}
+          tags: ${{ steps.meta1.outputs.tags }}
+          labels: ${{ steps.meta1.outputs.labels }}
+          cache-from: type=local,src=/tmp/.buildx-cache
+          cache-to: type=local,dest=/tmp/.buildx-cache
+
+      - name: Extract metadata (tags, labels) for Docker openim-web
+        id: meta2
+        uses: docker/metadata-action@v4.6.0
+        with:
+          images: ghcr.io/openimsdk/component
+
+      - name: Build and push Docker image for component
+        uses: docker/build-push-action@v4
+        with:
+          context: .
+          file: ./build/images/openim-tools/component/Dockerfile
+          platforms: linux/amd64,linux/arm64
+          push: ${{ github.event_name != 'pull_request' }}
+          tags: ${{ steps.meta2.outputs.tags }}
+          labels: ${{ steps.meta2.outputs.labels }}
+          cache-from: type=local,src=/tmp/.buildx-cache
           cache-to: type=local,dest=/tmp/.buildx-cache

.github/workflows/e2e-test.yml

@@ -12,5 +12,33 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-# name: OpenIM e2e Test
+name: e2e
 
+on:
+  workflow_dispatch:
+  pull_request:
+  push:
+  schedule:
+    # run e2e test every 4 hours
+    - cron: 0 */4 * * *
+
+jobs:
+  build:
+    name: Test
+    runs-on: ubuntu-latest
+    env:
+      GO111MODULE: on
+    steps:
+
+      - name: Set up Go 1.21
+        uses: actions/setup-go@v2
+        with:
+          go-version: 1.21
+        id: go
+
+      - name: Check out code into the Go module directory
+        uses: actions/checkout@v2
+
+      - name: Create e2e test
+        run: |
+          echo "...test e2e"

.github/workflows/golangci-lint.yml

@@ -18,7 +18,6 @@ on:
   push:
     branches: [main]
   pull_request:
-    branches: [main]
 jobs:
     golangci:
       name: lint
@@ -27,25 +26,25 @@ jobs:
         - uses: actions/checkout@v3
         - uses: actions/setup-go@v4
           with:
-            go-version: '1.20'
+            go-version: '1.21'
             cache: false
         - name: golangci-lint
-          uses: golangci/golangci-lint-action@v3
+          uses: golangci/golangci-lint-action@v3.7.0
           with:
             # Require: version of golangci-lint to use in form of v1.2 or v1.2.3 or `latest` to use the latest version
-            version: v1.53
+            version: v1.54
 
             # Optional: working directory, useful for monorepos
-            working-directory: server
+            # working-directory: server
 
             # Optional: golangci-lint command line arguments.
             # 
             # Note: by default the `.golangci.yml` file should be at the root of the repository.
             # The location of the configuration file can be changed by using `--config=`
-            # args: --timeout=30m --config=/my/path/.golangci.yml --issues-exit-code=0
+            # args: --timeout=30m --config=/scripts/.golangci.yml --issues-exit-code=0
 
             # Optional: show only new issues if it's a pull request. The default value is `false`.
-            # only-new-issues: true
+            only-new-issues: true
 
             # Optional:The mode to install golangci-lint. It can be 'binary' or 'goinstall'.
-            install-mode: "goinstall"
+            # install-mode: "goinstall"

.github/workflows/greetings.yml

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

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

@@ -31,5 +31,5 @@ jobs:
           token: ${{ secrets.BOT_GITHUB_TOKEN }}
           body: |
             This issue is available for anyone to work on. **Make sure to reference this issue in your pull request.** :sparkles: Thank you for your contribution! :sparkles:
-            [Join slack 🤖](https://join.slack.com/t/openimsdk/shared_invite/zt-1tmoj26uf-_FDy3dowVHBiGvLk9e5Xkg) to connect and communicate with our developers.
-            If you wish to accept this assignment, please leave a comment in the comments section: `/accept`.🎯
+            [Join slack 🤖](https://join.slack.com/t/openimsdk/shared_invite/zt-22720d66b-o_FvKxMTGXtcnnnHiMqe9Q) to connect and communicate with our developers.
+            If you wish to accept this assignment, please leave a comment in the comments section: `/accept`.🎯

.github/workflows/openimci.yml

@@ -36,124 +36,99 @@ env:
   GO_VERSION: "1.19"
   GOLANGCI_VERSION: "v1.50.1"
 
+
 jobs:
   openim:
     name: Test with go ${{ matrix.go_version }} on ${{ matrix.os }}
     runs-on: ${{ matrix.os }}
     permissions:
-        # Give the default GITHUB_TOKEN write permission to commit and push the changed files back to the repository.
         contents: write
     environment:
       name: openim
 
     strategy:
       matrix:
-        go_version: ["1.18","1.19","1.20"]
+        go_version: ["1.18","1.19","1.20","1.21"]
         os: [ubuntu-latest]
 
     steps:
-      - name: Set up Go ${{ matrix.go_version }}
-        uses: actions/setup-go@v4
-        with:
-          go-version: ${{ matrix.go_version }}
-        id: go
+    - name: Setup
+      uses: actions/checkout@v3
+      
+    - name: Set up Go ${{ matrix.go_version }}
+      uses: actions/setup-go@v4
+      with:
+        go-version: ${{ matrix.go_version }}
+      id: go
 
-      - name: Check out code into the Go module directory
-        uses: actions/checkout@v3
+    - name: Install Task
+      uses: arduino/setup-task@v1
+      with:
+        version: 2.x
 
-      - name: Install Task
-        uses: arduino/setup-task@v1
-        with:
-          version: 2.x
+    - name: Module Operations
+      run: |
+        sudo make tidy
+        sudo make tools.verify.go-gitlint
 
-      - name: Run go modules tidy
-        run: |
-          sudo make tidy
-          sudo make tools.verify.go-gitlint
-          echo "Run go modules tidy successfully" 
+    - name: Format Code
+      run: sudo make format
+      continue-on-error: true
 
-      - name: Run go format
-        run: |
-          sudo make format
-          echo "Run go format successfully" 
-        continue-on-error: true
+    - name: Generate Files
+      run: make gen
+      continue-on-error: true
 
-      - name: Generate all necessary files, such as error code files
-        run: |
-          make generate
-          echo "Generate all necessary files successfully" 
-        continue-on-error: true
+    - name: Build Source
+      run: sudo make build
 
-      - name: Run unit test and get test coverage
-        run: |
-          make cover
-          echo "Run unit test and get test coverage successfully" 
-        continue-on-error: true
+    - name: Cleanup Build
+      run: sudo make clean
 
-      - name: Build source code for host platform
-        run: |
-          sudo make build
-          echo "Build source code for host platform successfully" 
+    - name: Push Changes to Main
+      uses: stefanzweifel/git-auto-commit-action@v4
+      with:
+        commit_message: "cicd: robot automated Change"
+        branch: main
+      continue-on-error: true
 
-      - name: OpenIM verify copyright
-        run: |
-          sudo make verify-copyright
-          sudo make add-copyright
-          echo "OpenIM verify successfully" 
-        continue-on-error: true
+    - name: Set Current Directory
+      id: set_directory
+      run: echo "::set-output name=directory::$(pwd)"
+      continue-on-error: true
 
-      - name: Clean all build
-        run: |
-          sudo make clean
-          echo "Clean all build successfully" 
-
-      - name: push OpenIM 
-        uses: stefanzweifel/git-auto-commit-action@v4
-        with:
-          commit_message: "cicd: robot automated Change"
-        #   commit_options: '--no-verify --signoff'
-          branch: main
-        #   create_branch: true
-        #   # Optional commit user and author settings
-        #   commit_user_name: kubbot # defaults to "github-actions[bot]"
-        #   commit_user_email: 3293172751ysy@gmail.com # defaults to "41898282+github-actions[bot]@users.noreply.github.com"
-        #   commit_author: Kubbot # defaults to author of the commit that triggered the run
-        continue-on-error: true
-
-      - name: Commit Changes
-        uses: stefanzweifel/git-auto-commit-action@v4
-        with:
-          commit_message: "chore(fmt): robot automated format and lint Change"
-          commit_options: '--no-verify --signoff'
-          branch: main
-        continue-on-error: true
-
-      - name: Set Current Directory
-        id: set_directory
-        run: |
-          echo "::set-output name=directory::$(pwd)"
-        continue-on-error: true
-
-      - name: Collect Test Coverage File
-        id: collect_coverage
-        run: |
-          cd ${{ steps.set_directory.outputs.directory }}
-          make cover
-          echo "::set-output name=coverage_file::./_output/tmp/coverage.out"
-        continue-on-error: true
-
-      - name: Display Test Coverage
-        run: |
-          echo "Test Coverage:"
-          cat ${{ steps.collect_coverage.outputs.coverage_file }}
-        continue-on-error: true
-
-      - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v2
-        continue-on-error: true
+    - name: Collect and Display Test Coverage
+      id: collect_coverage
+      run: |
+        cd ${{ steps.set_directory.outputs.directory }}
+        make cover
+        echo "::set-output name=coverage_file::./_output/tmp/coverage.out"
+        echo "Test Coverage:"
+        cat ${{ steps.collect_coverage.outputs.coverage_file }}
+      continue-on-error: true
 
   openim-start:
-    name: Teat OpenIM make install start on ${{ matrix.os }}
+    name: Test OpenIM install/start on ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    environment:
+      name: openim
+    strategy:
+      matrix:
+        go_version: ["1.21"]
+        os: ["ubuntu-latest"]
+    steps:
+    - name: Checkout and Install OpenIM
+      uses: actions/checkout@v3
+    - name: Install Task
+      uses: arduino/setup-task@v1
+      with:
+        version: 2.x
+    - name: Run OpenIM make install start
+      run: |
+        sudo make install
+
+  execute-scripts:
+    name: Execute OpenIM script on ${{ matrix.os }}
     runs-on: ${{ matrix.os }}
     environment:
       name: openim
@@ -162,15 +137,36 @@ jobs:
         go_version: ["1.20"]
         os: ["ubuntu-latest"]
     steps:
-      - name: Set up Go ${{ matrix.go_version }}
-        uses: actions/setup-go@v4
-        with:
-          go-version: ${{ matrix.go_version }}
-        id: go
+    - name: Checkout code
+      uses: actions/checkout@v3
 
-      - name: Check out code into the Go module directory
-        uses: actions/checkout@v3
+    - name: Set up Go ${{ matrix.go_version }}
+      uses: actions/setup-go@v4
+      with:
+        go-version: ${{ matrix.go_version }}
+      id: go
+    - name: Install Task
+      uses: arduino/setup-task@v1
+      with:
+        version: 2.x
+    - name: Docker Operations
+      run: |
+        curl -o docker-compose.yaml https://raw.githubusercontent.com/OpenIMSDK/openim-docker/main/example/basic-openim-server-dependency.yml
+        sudo docker compose up -d
+        sudo sleep 60
 
-      - name: Run OpenIM make install start
-        run: |
-          sudo make install
+    - name: Module Operations
+      run: |
+        sudo make tidy
+        sudo make tools.verify.go-gitlint
+
+    - name: Build, Start and Check Services
+      run: |
+        sudo make init
+        sudo make build
+        sudo make start
+        sudo make check
+
+    - name: Print OpenIM Logs
+      run: sudo cat ./_output/logs/* 2>/dev/null
+      continue-on-error: true

.github/workflows/project-progress.yml

@@ -31,6 +31,6 @@ jobs:
     steps:
       - uses: alex-page/github-project-automation-plus@v0.8.3
         with:
-          project: OpenIM-V3.1
+          project: openim-powerful
           column: In Progress
           repo-token: ${{ secrets.BOT_GITHUB_TOKEN }}

.github/workflows/pull-request.yml

@@ -20,16 +20,13 @@ on:
       - 'README.md'
       - 'CONTRIBUTING.md'
       - 'docs/**'
-  pull_request:
-    branches: [main]
-    paths-ignore:
-      - 'README.md'
-      - 'CONTRIBUTING.md'
-      - 'docs/**'
+  workflow_dispatch:
+  schedule:
+    - cron: '0 2 * * *'
 
 permissions:
-  pull-requests: write
   contents: write
+  pull-requests: write
 
 jobs:
   build:
@@ -60,6 +57,12 @@ jobs:
           echo "Run go format successfully" 
         continue-on-error: true
 
+      - name: Run go lint
+        run: |
+          sudo make lint
+          echo "Run go lint successfully" 
+        continue-on-error: true
+
       - name: Generate all necessary files, such as error code files
         run: |
           make generate
@@ -72,18 +75,13 @@ jobs:
           echo "Run unit test and get test coverage successfully" 
         continue-on-error: true
 
-      - name: Initialize CodeQL
-        uses: github/codeql-action/init@v2
-        with:
-          languages: go
+    #   - name: Initialize CodeQL
+    #     uses: github/codeql-action/init@v2
+    #     with:
+    #       languages: go
 
-      - name: Build source code for host platform
-        run: |
-          sudo make build
-          echo "Build source code for host platform successfully" 
-
-      - name: Perform CodeQL Analysis
-        uses: github/codeql-action/analyze@v2
+    #   - name: Perform CodeQL Analysis
+        # uses: github/codeql-action/analyze@v2
 
       - name: OpenIM verify copyright
         run: |
@@ -92,23 +90,33 @@ jobs:
           echo "OpenIM verify successfully" 
         continue-on-error: true
       
-      - name: Commit code
-        run: |
-            git add .
+    #   - name: Commit code
+    #     run: |
+    #         git add .
+    #         git commit -m "cicd: bump League Patch to cicd/patch-${{ github.event.number }}"
     
       - name: Create Pull Request
         uses: peter-evans/create-pull-request@v5
         with:
+          token: ${{ secrets.BOT_GITHUB_TOKEN }}
           commit-message: "cicd: bump League Patch to cicd/patch-${{ github.event.number }}"
           title: Bump League Patch to cicd/patch-${{ github.event.number }}
+          author: kubbot <kubbot@3293172751ysy@gmail.com>
+          signoff: false
+          draft: false
+          branch: "cicd/patch-${{ github.event.number }}"
+          assignees: cubxxw
+          reviewers: cubxxw
+          delete-branch: true
           body: |
             Review criteria:
-            
+
             - [ ] Disenchanter can connect and issue actions
             
-            This is an automated PR.
+            This is an automated PR. @ ${{ github.actor }}
             <sub>[workflow](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/.github/workflows/pull-request.yml).</sub>
           base: main
-          branch: cicd/patch-${{ github.event.number }}
-          labels: kind/documentation, area/test, ok-to-test
-          token: ${{ secrets.REDBOT_GITHUB_TOKEN }}
+          labels: |
+            kind/documentation
+            enhancement
+            report

.github/workflows/release-drafter.yml

@@ -0,0 +1,55 @@
+# Copyright © 2023 OpenIM. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+name: Release Drafter
+
+on:
+  push:
+    # branches to consider in the event; optional, defaults to all
+    branches:
+      - main
+  # pull_request event is required only for autolabeler
+  pull_request:
+    # Only following types are handled by the action, but one can default to all as well
+    # types: [opened, reopened, synchronize]
+  # pull_request_target event is required for autolabeler to support PRs from forks
+  # pull_request_target:
+  #   types: [opened, reopened, synchronize]
+
+permissions:
+  contents: read
+
+jobs:
+  update_release_draft:
+    permissions:
+      # write permission is required to create a github release
+      contents: write
+      # write permission is required for autolabeler
+      # otherwise, read permission is required at least
+      pull-requests: write
+    runs-on: ubuntu-latest
+    steps:
+      # (Optional) GitHub Enterprise requires GHE_HOST variable set
+      #- name: Set GHE_HOST
+      #  run: |
+      #    echo "GHE_HOST=${GITHUB_SERVER_URL##https:\/\/}" >> $GITHUB_ENV
+
+      # Drafts your next Release notes as Pull Requests are merged into "master"
+      - uses: release-drafter/release-drafter@v5
+        # (Optional) specify config name to use, relative to .github/. Default: release-drafter.yml
+        # with:
+        #   config-name: my-config.yml
+        #   disable-autolabeler: true
+        env:
+          GITHUB_TOKEN: ${{ secrets.REDBOT_GITHUB_TOKEN }}

.github/workflows/release.yml

@@ -12,7 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-name: OpenIM Server Release
+name: OpenIM Server Release Workflow
 
 on:
   push:
@@ -43,9 +43,12 @@ jobs:
           # either 'goreleaser' (default) or 'goreleaser-pro':
           distribution: goreleaser
           version: latest
-          args: release --clean
+          workdir: .
+          args: release -f ./build/goreleaser.yaml --rm-dist --clean --release-footer-tmpl=scripts/template/footer.md.tmpl --release-header-tmpl=scripts/template/head.md.tmpl
         env:
+          USERNAME: ${{ github.repository_owner }}
           GITHUB_TOKEN: ${{ secrets.BOT_GITHUB_TOKEN }}
+          FURY_TOKEN: ${{ secrets.FURY_TOKEN }}
           # Your GoReleaser Pro key, if you are using the 'goreleaser-pro'
           # distribution:
           # GORELEASER_KEY: ${{ secrets.GORELEASER_KEY }}

.github/workflows/scripts-test.yml

@@ -1,89 +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.
-
-name: OpenIM Start Execute Scripts
-
-on: 
-    push:
-      branches:
-          - main
-      paths-ignore:
-          - "docs/**"
-          - "README.md"
-          - "README_zh-CN.md"
-          - "CONTRIBUTING.md"
-    pull_request:
-      branches:
-          - main
-      paths-ignore:
-          - "README.md"
-          - "README_zh-CN.md"
-          - "CONTRIBUTING.md"
-          - "docs/**"
-
-jobs:
-  execute-scripts:
-    runs-on: ubuntu-latest
-
-    steps:
-    - name: Checkout code
-      uses: actions/checkout@v3
-
-    - name: Download Docker Compose
-      run: |
-        curl -o docker-compose.yaml https://gist.githubusercontent.com/cubxxw/b1d5cbd2edfa23fee911118aa3e8249e/raw/openim-server.sh
-      shell: bash
-
-    - name: Start Docker Compose
-      run: |
-        sudo docker compose up -d
-        sudo sleep 60
-      continue-on-error: true
-
-    - name: Stop all services
-      run: |
-        sudo chmod +x ./scripts/stop_all.sh
-        sudo ./scripts/stop_all.sh
-        sudo cat logs/openIM.log 2>/dev/null
-      shell: bash
-      continue-on-error: true
-
-    - name: Build all services
-      run: |
-        sudo chmod +x ./scripts/build_all_service.sh
-        sudo ./scripts/build_all_service.sh
-        sudo cat logs/openIM.log 2>/dev/null
-      shell: bash
-
-    - name: Start all services
-      run: |
-        sudo chmod +x ./scripts/start_all.sh
-        sudo ./scripts/start_all.sh
-        sudo cat logs/openIM.log 2>/dev/null
-      continue-on-error: true
-      shell: bash
-
-    - name: Check all services
-      run: |
-        sudo chmod +x ./scripts/check_all.sh
-        sudo ./scripts/check_all.sh
-        sudo cat logs/openIM.log 2>/dev/null
-      shell: bash
-
-    - name: Print openIM.log
-      run: |
-        sudo cat logs/* 2>/dev/null
-        sudo cat logs/* 2>/dev/null >> "$GITHUB_OUTPUT"
-      shell: bash
-      continue-on-error: true

.github/workflows/scripts-verify.yml

@@ -0,0 +1,76 @@
+# Copyright © 2023 OpenIM. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+name: OpenIM executes the script validation code
+
+on: 
+  push:
+    branches:
+        - main
+    paths-ignore:
+        - "docs/**"
+        - "README.md"
+        - "README_zh-CN.md"
+        - "CONTRIBUTING.md"
+  pull_request:
+    branches:
+        - main
+    paths-ignore:
+        - "README.md"
+        - "README_zh-CN.md"
+        - "CONTRIBUTING.md"
+        - "docs/**"
+
+env:
+  GO_VERSION: "1.19"
+  GOLANGCI_VERSION: "v1.50.1"
+
+jobs:
+  openim:
+    name: Test with go ${{ matrix.go_version }} on ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    permissions:
+        contents: write
+    environment:
+      name: openim
+
+    strategy:
+      matrix:
+        go_version: ["1.21"]
+        os: [ubuntu-latest]
+
+    steps:
+    - name: Setup
+      uses: actions/checkout@v3
+      
+    - name: In ${{ matrix.os }} Execute the script validation code
+      uses: actions/setup-go@v4
+      with:
+        go-version: ${{ matrix.go_version }}
+      id: go
+
+    - name: scripts validation
+      run: |
+        sudo make verify
+      continue-on-error: true
+
+    - name: verify format
+      run: |
+        sudo make format
+      continue-on-error: true
+
+    - name: verify license
+      run: |
+        sudo make verify-copyright
+      continue-on-error: true

.github/workflows/sync-release.yml

@@ -0,0 +1,43 @@
+# Copyright © 2023 KubeCub open source community. All rights reserved.
+# Licensed under the MIT License (the "License");
+# you may not use this file except in compliance with the License.
+
+# https://github.com/BetaHuhn/repo-file-sync-action
+name: Synchronize kubecub public code to other repositories
+on:
+    push:
+        paths:
+            - scripts/*
+            - docs/*
+            - config/*
+        branches:
+          - release-v*.*
+    workflow_dispatch:
+
+jobs:
+  sync:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Run GitHub File Sync
+        uses: BetaHuhn/repo-file-sync-action@latest
+        with:
+          GH_INSTALLATION_TOKEN: "${{ secrets.BOT_GITHUB_TOKEN }}"
+          CONFIG_PATH: .github/sync-release.yml
+          ORIGINAL_MESSAGE: true
+          SKIP_PR: true
+          COMMIT_EACH_FILE: false
+          COMMIT_BODY: "🤖 kubbot to synchronize the warehouse"
+          GIT_EMAIL: "3293172751ysy@gmail.com"
+          GIT_USERNAME: "kubbot"
+          PR_BODY: 👌 kubecub provides automated community services
+          REVIEWERS: |
+            kubbot
+            cubxxw
+          PR_LABELS: |
+            file-sync
+            automerge
+          ASSIGNEES: |
+            kubbot

.gitignore

@@ -30,6 +30,12 @@ bin/
 output/
 _output/
 
+### OpenIM Config ###
+config/config.yaml
+./config/config.yaml
+.env
+./.env
+
 ### OpenIM deploy ###
 deploy/openim_demo
 deploy/openim-api
@@ -153,10 +159,11 @@ flycheck_*.el
 *.out
 
 # Dependency directories (remove the comment below to include it)
-# vendor/
+vendor/
 
 # Go workspace file
 # go.work
+go.work.sum
 
 ### JetBrains ###
 # Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider
@@ -392,3 +399,5 @@ Sessionx.vim
 # End of https://www.toptal.com/developers/gitignore/api/go,git,vim,tags,test,emacs,backup,jetbrains
 .idea
 dist/
+.env
+config/config.yaml

.golangci.yml

@@ -58,7 +58,6 @@ run:
   skip-files:
     - ".*\\.my\\.go$"
     - _test.go
-    - ".*\\.pb\\.go"
 
   # by default isn't set. If set we pass it to "go list -mod={option}". From "go help modules":
   # If invoked with -mod=readonly, the go command is disallowed from the implicit
@@ -177,7 +176,7 @@ linters-settings:
     # put imports beginning with prefix after 3rd-party packages;
     # only support one prefix
     # if not set, use goimports.local-prefixes
-    prefix: github.com/OpenIMSDK/OpenKF
+    prefix: github.com/OpenIMSDK/Open-IM-Server
   gocognit:
     # minimal code complexity to report, 30 by default (but we recommend 10-20)
     min-complexity: 30
@@ -334,10 +333,8 @@ linters-settings:
   goimports:
     # put imports beginning with prefix after 3rd-party packages;
     # it's a comma-separated list of prefixes
-    local-prefixes: github.com/OpenIMSDK/OpenKF
-  golint:
-    # minimal confidence for issues, default is 0.8
-    min-confidence: 0.9
+    local-prefixes: github.com/OpenIMSDK/Open-IM-Server
+
   gomnd:
     settings:
       mnd:
@@ -443,12 +440,7 @@ linters-settings:
   #   packages-with-error-message:
   #     # specify an error message to output when a blacklisted package is used
   #     - github.com/Sirupsen/logrus: "logging is allowed only by logutils.Log"
-  ifshort:
-    # Maximum length of variable declaration measured in number of lines, after which linter won't suggest using short syntax.
-    # Has higher priority than max-decl-chars.
-    max-decl-lines: 1
-    # Maximum length of variable declaration measured in number of characters, after which linter won't suggest using short syntax.
-    max-decl-chars: 30
+
 
   importas:
     # if set to `true`, force to use alias.
@@ -723,7 +715,6 @@ linters:
     - asciicheck
     - bodyclose
     - cyclop
-    - deadcode
     # - depguard
     - dogsled
     - dupl
@@ -751,7 +742,6 @@ linters:
     - gosec
     - gosimple
     - govet
-    - ifshort
     - importas
     - ineffassign
     - lll
@@ -771,19 +761,16 @@ linters:
     - rowserrcheck
     - sqlclosecheck
     - staticcheck
-    - structcheck
     - stylecheck
     - thelper
     - tparallel
     - unconvert
     - unparam
     - unused
-    - varcheck
     - wastedassign
     - whitespace
     - bidichk
     - wastedassign
-    - golint
     - execinquery
     - nosprintfhostport
     - grouper
@@ -814,10 +801,6 @@ issues:
 
   # Excluding configuration per-path, per-linter, per-text and per-source
   exclude-rules:
-    - linters:
-      - golint
-      path: (internal/api/.*)\.go # exclude golint for internal/api/... files
-
     - linters:
       - revive
       path: (log/.*)\.go
@@ -857,9 +840,7 @@ issues:
 
     - path: (pkg/app/.*)\.go
       linters:
-        - deadcode
         - unused
-        - varcheck
         - forbidigo
 
     # Exclude some staticcheck messages

CHANGELOG/CHANGELOG-2.0.md

@@ -1,53 +1,22 @@
-# Version logging for OpenIM:v2.0
-
-> **Note**:
-> Deprecated version logging for OpenIM, please refer to [CHANGELOG.md](../CHANGELOG.md)
+# Version logging for OpenIM
 
 <!-- BEGIN MUNGE: GENERATED_TOC -->
 
-- [Version logging for OpenIM:v2.0](#version-logging-for-openimv20)
-  - [\[Unreleased\]](#unreleased)
-  - [\[v2.0.10\] - 2022-05-13](#v2010---2022-05-13)
-  - [\[v2.0.9\] - 2022-04-29](#v209---2022-04-29)
-    - [Reverts](#reverts)
-    - [Pull Requests](#pull-requests)
-  - [\[v2.0.8\] - 2022-04-24](#v208---2022-04-24)
-    - [Pull Requests](#pull-requests-1)
-  - [\[v2.0.7\] - 2022-04-08](#v207---2022-04-08)
-    - [Pull Requests](#pull-requests-2)
-  - [\[v2.0.6\] - 2022-04-01](#v206---2022-04-01)
-    - [Pull Requests](#pull-requests-3)
-  - [\[v2.0.5\] - 2022-03-24](#v205---2022-03-24)
-  - [\[v2.04\] - 2022-03-18](#v204---2022-03-18)
-  - [\[v2.0.3\] - 2022-03-11](#v203---2022-03-11)
-  - [\[v2.0.2\] - 2022-03-04](#v202---2022-03-04)
-    - [Pull Requests](#pull-requests-4)
-  - [\[v2.0.1\] - 2022-02-25](#v201---2022-02-25)
-  - [v2.0.0 - 2022-02-23](#v200---2022-02-23)
-    - [Reverts](#reverts-1)
-
 <!-- END MUNGE: GENERATED_TOC -->
 
-
 <a name="unreleased"></a>
-
 ## [Unreleased]
 
 
 <a name="v2.0.10"></a>
-
 ## [v2.0.10] - 2022-05-13
 
 <a name="v2.0.9"></a>
-
 ## [v2.0.9] - 2022-04-29
-
 ### Reverts
-
 - update etcd to v3.5.2 ([#206](https://github.com/OpenIMSDK/Open-IM-Server/issues/206))
 
 ### Pull Requests
-
 - Merge branch 'tuoyun'
 - Merge branch 'tuoyun'
 - Merge branch 'tuoyun'
@@ -57,53 +26,38 @@
 
 
 <a name="v2.0.8"></a>
-
 ## [v2.0.8] - 2022-04-24
-
 ### Pull Requests
-
 - Merge branch 'tuoyun'
 - Merge branch 'tuoyun'
 
 
 <a name="v2.0.7"></a>
-
 ## [v2.0.7] - 2022-04-08
-
 ### Pull Requests
-
 - Merge branch 'tuoyun'
 - Merge branch 'tuoyun'
 - Merge branch 'tuoyun'
 
 
 <a name="v2.0.6"></a>
-
 ## [v2.0.6] - 2022-04-01
-
 ### Pull Requests
-
 - Merge branch 'tuoyun'
 
 
 <a name="v2.0.5"></a>
-
 ## [v2.0.5] - 2022-03-24
 
 <a name="v2.04"></a>
-
 ## [v2.04] - 2022-03-18
 
 <a name="v2.0.3"></a>
-
 ## [v2.0.3] - 2022-03-11
 
 <a name="v2.0.2"></a>
-
 ## [v2.0.2] - 2022-03-04
-
 ### Pull Requests
-
 - Merge branch 'tuoyun'
 - Merge branch 'tuoyun'
 - Merge branch 'tuoyun'
@@ -111,11 +65,23 @@
 
 
 <a name="v2.0.1"></a>
-
 ## [v2.0.1] - 2022-02-25
 
 <a name="v2.0.0"></a>
-
 ## v2.0.0 - 2022-02-23
-
 ### Reverts
+- friend modify
+- update
+
+
+[Unreleased]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.0.10...HEAD
+[v2.0.10]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.0.9...v2.0.10
+[v2.0.9]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.0.8...v2.0.9
+[v2.0.8]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.0.7...v2.0.8
+[v2.0.7]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.0.6...v2.0.7
+[v2.0.6]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.0.5...v2.0.6
+[v2.0.5]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.04...v2.0.5
+[v2.04]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.0.3...v2.04
+[v2.0.3]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.0.2...v2.0.3
+[v2.0.2]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.0.1...v2.0.2
+[v2.0.1]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.0.0...v2.0.1

CHANGELOG/CHANGELOG-3.1.md

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

CHANGELOG/CHANGELOG-3.2.md

@@ -0,0 +1,44 @@
+# Version logging for OpenIM
+
+<!-- BEGIN MUNGE: GENERATED_TOC -->
+
+<!-- END MUNGE: GENERATED_TOC -->
+
+<a name="unreleased"></a>
+## [Unreleased]
+
+
+<a name="v3.2.2-beta.3"></a>
+## [v3.2.2-beta.3] - 2023-08-22
+
+<a name="v3.2.2-beta.2"></a>
+## [v3.2.2-beta.2] - 2023-08-21
+
+<a name="v3.2.2-beta.1"></a>
+## [v3.2.2-beta.1] - 2023-08-19
+
+<a name="v3.2.0"></a>
+## [v3.2.0] - 2023-08-18
+
+<a name="v3.2.0-rc.0"></a>
+## [v3.2.0-rc.0] - 2023-08-17
+
+<a name="v3.2.2-beta.0"></a>
+## [v3.2.2-beta.0] - 2023-08-17
+
+<a name="v3.2.0-alpha.0"></a>
+## v3.2.0-alpha.0 - 2023-08-16
+### 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.2.2-beta.3...HEAD
+[v3.2.2-beta.3]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v3.2.2-beta.2...v3.2.2-beta.3
+[v3.2.2-beta.2]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v3.2.2-beta.1...v3.2.2-beta.2
+[v3.2.2-beta.1]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v3.2.0...v3.2.2-beta.1
+[v3.2.0]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v3.2.0-rc.0...v3.2.0
+[v3.2.0-rc.0]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v3.2.2-beta.0...v3.2.0-rc.0
+[v3.2.2-beta.0]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v3.2.0-alpha.0...v3.2.2-beta.0

CHANGELOG/CHANGELOG.md

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

CONTRIBUTING.md

@@ -4,6 +4,10 @@ So, you want to hack on Open-IM-Server? Yay!
 
 First of all, thank you for considering contributing to our project! We appreciate your time and effort, and we value any contribution, whether it's reporting a bug, suggesting a new feature, or submitting a pull request.
 
+![Hello OpenIM Image](assets/demo/hello-openim.png)
+
+> Use `make demo` start contributing fast.
+
 This document provides guidelines and best practices to help you contribute effectively.
 
 ## 📇Topics
@@ -68,7 +72,7 @@ For any substantial design, there should be a well-crafted design document. This
 
 Anybody can access the shared Drive for reading. To get access to comment. Once you've done that, head to the [shared Drive](https://drive.google.com/) and behold all the docs.
 
-In addition to that, we'd love to invite you to [join our Slack](https://join.slack.com/t/openimsdk/shared_invite/zt-1tmoj26uf-_FDy3dowVHBiGvLk9e5Xkg) where you can play with your imagination, tell us what you're working on, and get a quick response.
+In addition to that, we'd love to invite you to [join our Slack](https://join.slack.com/t/openimsdk/shared_invite/zt-22720d66b-o_FvKxMTGXtcnnnHiMqe9Q) where you can play with your imagination, tell us what you're working on, and get a quick response.
 
 When documenting a new design, we recommend a 2-step approach:
 
@@ -77,7 +81,7 @@ When documenting a new design, we recommend a 2-step approach:
 
 In order to contribute a feature to Open-IM-Server you'll need to go through the following steps:
 
-+ Discuss your idea with the appropriate [working groups](https://join.slack.com/t/openimsdk/shared_invite/zt-1tmoj26uf-_FDy3dowVHBiGvLk9e5Xkg) on the working group's Slack channel.
++ Discuss your idea with the appropriate [working groups](https://join.slack.com/t/openimsdk/shared_invite/zt-22720d66b-o_FvKxMTGXtcnnnHiMqe9Q) on the working group's Slack channel.
 + Once there is general agreement that the feature is useful, create a GitHub issue to track the discussion. The issue should include information about the requirements and use cases that it is trying to address.
 + Include a discussion of the proposed design and technical details of the implementation in the issue.
 
@@ -360,11 +364,11 @@ Such a commit can get produced as follows:
 
 We value close connections with our users, developers, and contributors here at Open-IM-Server. With a large community and maintainer team, we're always here to help and support you. Whether you're looking to join our community or have any questions or suggestions, we welcome you to get in touch with us.
 
-Our most recommended way to get in touch is through [Slack](https://join.slack.com/t/openimsdk/shared_invite/zt-1tmoj26uf-_FDy3dowVHBiGvLk9e5Xkg). Even if you're in China, Slack is usually not blocked by firewalls, making it an easy way to connect with us. Our Slack community is the ideal place to discuss and share ideas and suggestions with other users and developers of Open-IM-Server. You can ask technical questions, seek help, or share your experiences with other users of Open-IM-Server.
+Our most recommended way to get in touch is through [Slack](https://join.slack.com/t/openimsdk/shared_invite/zt-22720d66b-o_FvKxMTGXtcnnnHiMqe9Q). Even if you're in China, Slack is usually not blocked by firewalls, making it an easy way to connect with us. Our Slack community is the ideal place to discuss and share ideas and suggestions with other users and developers of Open-IM-Server. You can ask technical questions, seek help, or share your experiences with other users of Open-IM-Server.
 
 In addition to Slack, we also offer the following ways to get in touch:
 
-+ <a href="https://join.slack.com/t/openimsdk/shared_invite/zt-1tmoj26uf-_FDy3dowVHBiGvLk9e5Xkg" target="_blank"><img src="https://img.shields.io/badge/slack-%40OpenIMSDKCore-informational?logo=slack&style=flat-square"></a>:  We also have Slack channels for you to communicate and discuss. To join, visit https://slack.com/ and join our [👀 Open-IM-Server slack](https://join.slack.com/t/openimsdk/shared_invite/zt-1tmoj26uf-_FDy3dowVHBiGvLk9e5Xkg) team channel.
++ <a href="https://join.slack.com/t/openimsdk/shared_invite/zt-22720d66b-o_FvKxMTGXtcnnnHiMqe9Q" target="_blank"><img src="https://img.shields.io/badge/slack-%40OpenIMSDKCore-informational?logo=slack&style=flat-square"></a>:  We also have Slack channels for you to communicate and discuss. To join, visit https://slack.com/ and join our [👀 Open-IM-Server slack](https://join.slack.com/t/openimsdk/shared_invite/zt-22720d66b-o_FvKxMTGXtcnnnHiMqe9Q) team channel.
 + <a href="https://mail.google.com/mail/u/0/?fs=1&tf=cm&to=4closetool3@gmail.com" target="_blank"><img src="https://img.shields.io/badge/gmail-%40OOpenIMSDKCore?style=social&logo=gmail"></a>: Get in touch with us on [Gmail](winxu81@gmail.com). If you have any questions or issues that need resolving, or any suggestions and feedback for our open source projects, please feel free to contact us via email.
 + <a href="https://doc.rentsoft.cn/" target="_blank"><img src="https://img.shields.io/badge/%E5%8D%9A%E5%AE%A2-%40OpenIMSDKCore-blue?style=social&logo=Octopus%20Deploy"></a>: Read our [blog](https://doc.rentsoft.cn/). Our blog is a great place to stay up-to-date with Open-IM-Server projects and trends. On the blog, we share our latest developments, tech trends, and other interesting information.
 + <a href="https://github.com/OpenIMSDK/OpenIM-Docs/blob/main/docs/images/WechatIMG20.jpeg" target="_blank"><img src="https://img.shields.io/badge/%E5%BE%AE%E4%BF%A1-OpenIMSDKCore-brightgreen?logo=wechat&style=flat-square"></a>: Add [Wechat](https://github.com/OpenIMSDK/OpenIM-Docs/blob/main/docs/images/WechatIMG20.jpeg) and indicate that you are a user or developer of Open-IM-Server. We will process your request as soon as possible.

Dockerfile

@@ -19,13 +19,13 @@ ADD . .
 RUN make clean
 RUN make build
 
-FROM ghcr.io/openim-sigs/openim-bash-image:latest
+FROM ghcr.io/openim-sigs/openim-ubuntu-image:latest
 
 WORKDIR ${SERVER_WORKDIR}
 
 # Copy scripts and binary files to the production image
+COPY --from=builder ${OPENIM_SERVER_BINDIR} /openim/openim-server/_output/bin
 COPY --from=builder ${OPENIM_SERVER_CMDDIR} /openim/openim-server/scripts
 COPY --from=builder ${SERVER_WORKDIR}/config /openim/openim-server/config
-COPY --from=builder ${SERVER_WORKDIR}/_output/bin/platforms /openim/openim-server/_output/bin/platforms
 
-CMD ["bash","-c","${OPENIM_SERVER_CMDDIR}/docker_start_all.sh"]
+CMD ["/openim/openim-server/scripts/docker-start-all.sh"]

Makefile

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

README-zh_CN.md

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

README.md

@@ -13,7 +13,7 @@
 <a href="https://goreportcard.com/report/github.com/OpenIMSDK/Open-IM-Server"><img src="https://goreportcard.com/badge/github.com/OpenIMSDK/Open-IM-Server" alt="A+"></a>
 <a href="https://github.com/OpenIMSDK/Open-IM-Server/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3A%22good+first+issue%22"><img src="https://img.shields.io/github/issues/OpenIMSDK/Open-IM-Server/good%20first%20issue?logo=%22github%22" alt="good first"></a>
 <a href="https://github.com/OpenIMSDK/Open-IM-Server"><img src="https://img.shields.io/github/stars/OpenIMSDK/Open-IM-Server.svg?style=flat&logo=github&colorB=deeppink&label=stars"></a>
-<a href="https://join.slack.com/t/openimsdk/shared_invite/zt-1tmoj26uf-_FDy3dowVHBiGvLk9e5Xkg"><img src="https://img.shields.io/badge/Slack-300%2B-blueviolet?logo=slack&amp;logoColor=white"></a>
+<a href="https://join.slack.com/t/openimsdk/shared_invite/zt-22720d66b-o_FvKxMTGXtcnnnHiMqe9Q"><img src="https://img.shields.io/badge/Slack-300%2B-blueviolet?logo=slack&amp;logoColor=white"></a>
 <a href="https://github.com/OpenIMSDK/Open-IM-Server/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-Apache--2.0-green"></a>
 <a href="https://golang.org/"><img src="https://img.shields.io/badge/Language-Go-blue.svg"></a>
 </p>
@@ -31,7 +31,7 @@
 
 ## ✨ About OpenIM
 
-Open-IM-Server, crafted meticulously using pure Golang, stands as a robust instant messaging server. Its unique approach to communication, via JSON over WebSocket, treats every interaction as a message. This simplifies customization and eliminates the need for tinkering with server code. Harnessing the power of microservice architecture, the server can be deployed via clusters, promising impressive performance and scalability.
+Open-IM-Server, meticulously developed in pure Golang, is a powerful instant messaging server. Its distinct communication method, employing pb+websocket, views every interaction as a message, streamlining customization without altering server code. Built on a microservice architecture, it offers deployment through clusters for outstanding performance and scalability.
 
 Open-IM-Server is more than an instant messaging server; it's a powerful tool for incorporating real-time networking into your applications, positioning itself as your premier choice for integration! 🚀
 
@@ -111,73 +111,105 @@ Further enhancing your experience, we also provide an SDK client, wherein most c
 
 ## :rocket: Quick Start
 
+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>
 
-1. Clone the project
+
+> docker compose will not be maintained in future versions, but it is still the easiest and most convenient way to organize docker compose deployments into a separate project https://github.com/openim-sigs/openim-docker to maintain.
+
+**1. Clone the project**
+
 
 ```bash
-# choose what you need
-BRANCH=release-v3.1
-git clone -b $BRANCH https://github.com/OpenIMSDK/Open-IM-Server openim && export openim=$(pwd)/openim && cd $openim && make build
+git clone -b feat/test https://github.com/openim-sigs/openim-docker openim/openim-docker && export openim=$(pwd)/openim && cd $openim/openim-docker  && ./scripts/init-config.sh && docker-compose up -d
 ```
 
 > **Note**
-> Read our release policy: https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/version.md
+> If you don't know OpenIM's versioning policy, 📚Read our release policy: https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/version.md
 
-2. Modify `.env`
+
+
+**2. Configure the config file**
+
+If you tried to get started quickly with `make demo`, then you know that our config file is generated by automation.
+
+You can use `make init` to quickly initialize a configuration file
+
+Modify the automation script:
 
 ```bash
-USER=root #no need to modify
-PASSWORD=openIM123  #A combination of 8 or more numbers and letters, this password applies to redis, mysql, mongo, as well as accessSecret in config/config.yaml
-ENDPOINT=http://127.0.0.1:10005 #minio's external service IP and port, or use the domain name storage.xx.xx, the app must be able to access this IP and port or domain,
-API_URL=http://127.0.0.1:10002/object/ #the app must be able to access this IP and port or domain,
-DATA_DIR=./  #designate large disk directory
+cat scripts/install/environment.sh
 ```
 
-3. Deploy and start
-
-> **Note**
-> This command can only be executed once. It will modify the component passwords in docker-compose based on the `PASSWORD` variable in `.env`, and modify the component passwords in `config/config.yaml`. If the password in `.env` changes, you need to first execute `docker-compose down`; `rm components -rf` and then execute this command.
+1. Recommended using environment variables:
 
 ```bash
-make install
+export PASSWORD="openIM123" # Set password
+export USER="root" # Set username
+# Choose chat version and server version https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/images.md, eg: main, release-v*.*
+export CHAT_BRANCH="main"
+export SERVER_BRANCH="main"
+#... Other environment variables
+# MONGO_USERNAME: This sets the MongoDB username
+# MONGO_PASSWORD: Set the MongoDB password
+# MONGO_DATABASE: Sets the MongoDB database name
+# MINIO_ENDPOINT: set the MinIO service address
+# API_URL: under network environment, set OpenIM Server API address
+export API_URL="http://127.0.0.1:10002"
 ```
 
-4. Check the service
+Next, update the configuration using make init:
 
 ```bash
-make check
+$ make init
+$ git diff
 ```
 
-![https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/images/docker_build.png](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/images/docker_build.png)
 
 </details> 
 
 <details>  <summary>Compile from Source</summary>
 
+
 Ur need `Go 1.18` 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/conversions/version.md
 
 ```bash
 # choose what you need
-BRANCH=release-v3.1
-git clone -b $BRANCH https://github.com/OpenIMSDK/Open-IM-Server openim && export openim=$(pwd)/openim && cd $openim && make build
+$ BRANCH=release-v3.1
+$ git clone -b $BRANCH https://github.com/OpenIMSDK/Open-IM-Server openim && export openim=$(pwd)/openim && cd $openim && make start
 ```
 
-Read about the [OpenIM Version Policy](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/version.md)
+> `make help` to help you see the instructions supported by OpenIM.
 
-`make help` to help you see the instructions supported by OpenIM.
+Use `make check` to check all component starts
 
-All services have been successfully built as shown in the figure
+```bash
+$ make check
+```
 
-![Successful Compilation](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/images/build.png)
+You can use the `make help-all` see OpenIM in action.
 
 </details>
 
 <details>  <summary>Component Configuration Instructions</summary>
+The `config/config.yaml` file has detailed configuration instructions for the storage components.
 
-The config/config.yaml file has detailed configuration instructions for the storage components.
+
+The config file is available via [environment.sh](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/scripts/install/environment.sh) configuration [openim.yaml](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/deployments/templates/openim.yaml) template, and then through the `make init` to automatically generate a new configuration.
 
 - Zookeeper
 
@@ -260,30 +292,16 @@ The config/config.yaml file has detailed configuration instructions for the stor
 
 </details>
 
-<details>  <summary>Start and Stop Services</summary>
+<details>  <summary>Deployed with kubernetes</summary>
 
-Start services
 
-```
-./scripts/start_all.sh;
-```
-
-Check services
-
-```
-./scripts/check_all.sh
-```
-
-Stop services
-
-```
-./scripts/stop_all.sh
-```
+read: https://github.com/OpenIMSDK/Open-IM-Server/blob/main/deployments/README.md
 
 </details> 
 
 <details>  <summary>Open IM Ports</summary>
 
+
 | TCP Port  | Description                                                  | Operation                                             |
 | --------- | ------------------------------------------------------------ | ----------------------------------------------------- |
 | TCP:10001 | ws protocol, message port such as message sending, pushing etc, used for client SDK | Port release or nginx reverse proxy, and firewall off |
@@ -294,6 +312,7 @@ Stop services
 
 <details>  <summary>Open Chat Ports</summary>
 
+
 + chat warehouse: https://github.com/OpenIMSDK/chat 
 
 | TCP Port  | Description                                         | Operation                                             |
@@ -303,6 +322,7 @@ Stop services
 
 </details>
 
+
 ## :link: Relationship Between APP and 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, Open-IM-Server, and Open-IM-SDK interact.
@@ -321,7 +341,7 @@ OpenIM Our goal is to build a top-level open source community. We have a set of
 
 If you'd like to contribute to this Open-IM-Server repository, please read our [contributor documentation](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/CONTRIBUTING.md).
 
-Before you start, please make sure your changes are in demand. The best for that is to create a [new discussion](https://github.com/OpenIMSDK/Open-IM-Server/discussions/new/choose) OR [Slack Communication](https://join.slack.com/t/openimsdk/shared_invite/zt-1tmoj26uf-_FDy3dowVHBiGvLk9e5Xkg), or if you find an issue, [report it](https://github.com/OpenIMSDK/Open-IM-Server/issues/new/choose) first.
+Before you start, please make sure your changes are in demand. The best for that is to create a [new discussion](https://github.com/OpenIMSDK/Open-IM-Server/discussions/new/choose) OR [Slack Communication](https://join.slack.com/t/openimsdk/shared_invite/zt-22720d66b-o_FvKxMTGXtcnnnHiMqe9Q), or if you find an issue, [report it](https://github.com/OpenIMSDK/Open-IM-Server/issues/new/choose) first.
 
 - [Code Standards](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/go_code.md)
 - [Docker Images Standards](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/images.md)
@@ -336,14 +356,14 @@ Before you start, please make sure your changes are in demand. The best for that
 
 + 📚 [OpenIM Community](https://github.com/OpenIMSDK/community)
 + 💕 [OpenIM Interest Group](https://github.com/Openim-sigs)
-+ 🚀 [Join our Slack community](https://join.slack.com/t/openimsdk/shared_invite/zt-1tmoj26uf-_FDy3dowVHBiGvLk9e5Xkg)
++ 🚀 [Join our Slack community](https://join.slack.com/t/openimsdk/shared_invite/zt-22720d66b-o_FvKxMTGXtcnnnHiMqe9Q)
 + :eyes: [Join our wechat (微信群)](https://openim-1253691595.cos.ap-nanjing.myqcloud.com/WechatIMG20.jpeg)
 
 ## :calendar: Community Meetings
 
 We want anyone to get involved in our community and contributing code, we offer gifts and rewards, and we welcome you to join us every Thursday night.
 
-Our conference is in the [OpenIM Slack](https://join.slack.com/t/openimsdk/shared_invite/zt-1tmoj26uf-_FDy3dowVHBiGvLk9e5Xkg) 🎯, then you can search the Open-IM-Server pipeline to join
+Our conference is in the [OpenIM Slack](https://join.slack.com/t/openimsdk/shared_invite/zt-22720d66b-o_FvKxMTGXtcnnnHiMqe9Q) 🎯, then you can search the Open-IM-Server pipeline to join
 
 We take notes of each [biweekly meeting](https://github.com/orgs/OpenIMSDK/discussions/categories/meeting) in [GitHub discussions](https://github.com/OpenIMSDK/Open-IM-Server/discussions/categories/meeting), Our historical meeting notes, as well as replays of the meetings are available at [Google Docs :bookmark_tabs:](https://docs.google.com/document/d/1nx8MDpuG74NASx081JcCpxPgDITNTpIIos0DS6Vr9GU/edit?usp=sharing).
 

build/README.md

@@ -0,0 +1,65 @@
+# Building OpenIM
+
+Building OpenIM is easy if you take advantage of the containerized build environment. This document will help guide you through understanding this build process.
+
+## Requirements
+
+1. Docker, using one of the following configurations:
+  * **macOS** Install Docker for Mac. See installation instructions [here](https://docs.docker.com/docker-for-mac/).
+     **Note**: You will want to set the Docker VM to have at least 4GB of initial memory or building will likely fail.
+  * **Linux with local Docker**  Install Docker according to the [instructions](https://docs.docker.com/installation/#installation) for your OS.
+  * **Windows with Docker Desktop WSL2 backend**  Install Docker according to the [instructions](https://docs.docker.com/docker-for-windows/wsl-tech-preview/). Be sure to store your sources in the local Linux file system, not the Windows remote mount at `/mnt/c`.
+  
+  **Note**: You will need to check if Docker CLI plugin buildx is properly installed (`docker-buildx` file should be present in `~/.docker/cli-plugins`). You can install buildx according to the [instructions](https://github.com/docker/buildx/blob/master/README.md#installing).
+
+2. **Optional** [Google Cloud SDK](https://developers.google.com/cloud/sdk/)
+
+You must install and configure Google Cloud SDK if you want to upload your release to Google Cloud Storage and may safely omit this otherwise.
+
+## Actions
+
+About [Images packages](https://github.com/orgs/OpenIMSDK/packages?repo_name=Open-IM-Server)
+
+All files in the `build/images` directory are not templated and are instead rendered by Github Actions, which is an automated process.
+
+Trigger condition:
+1. create a new tag with the format `vX.Y.Z` (e.g. `v1.0.0`)
+2. push the tag to the remote repository
+3. wait for the build to finish
+4. download the artifacts from the release page
+
+## Make images
+
+**help info:**
+
+```bash
+$ make image.help
+```
+
+**build images:**
+
+```bash
+$ make image
+```
+
+## Overview
+
+While it is possible to build OpenIM using a local golang installation, we have a build process that runs in a Docker container.  This simplifies initial set up and provides for a very consistent build and test environment.
+
+
+## Basic Flow
+
+The scripts directly under [`build/`](.) are used to build and test.  They will ensure that the `kube-build` Docker image is built (based on [`build/build-image/Dockerfile`](build-image/Dockerfile) and after base image's `KUBE_BUILD_IMAGE_CROSS_TAG` from Dockerfile is replaced with one of those actual tags of the base image, like `v1.13.9-2`) and then execute the appropriate command in that container.  These scripts will both ensure that the right data is cached from run to run for incremental builds and will copy the results back out of the container. You can specify a different registry/name and version for `kube-cross` by setting `KUBE_CROSS_IMAGE` and `KUBE_CROSS_VERSION`, see [`common.sh`](common.sh) for more details.
+
+The `kube-build` container image is built by first creating a "context" directory in `_output/images/build-image`.  It is done there instead of at the root of the OpenIM repo to minimize the amount of data we need to package up when building the image.
+
+There are 3 different containers instances that are run from this image.  The first is a "data" container to store all data that needs to persist across to support incremental builds. Next there is an "rsync" container that is used to transfer data in and out to the data container.  Lastly there is a "build" container that is used for actually doing build actions.  The data container persists across runs while the rsync and build containers are deleted after each use.
+
+`rsync` is used transparently behind the scenes to efficiently move data in and out of the container.  This will use an ephemeral port picked by Docker.  You can modify this by setting the `KUBE_RSYNC_PORT` env variable.
+
+All Docker names are suffixed with a hash derived from the file path (to allow concurrent usage on things like CI machines) and a version number.  When the version number changes all state is cleared and clean build is started.  This allows the build infrastructure to be changed and signal to CI systems that old artifacts need to be deleted.
+
+## Build artifacts
+The build system output all its products to a top level directory in the source repository named `_output`.
+These include the binary compiled packages (e.g. kubectl, kube-scheduler etc.) and archived Docker images.
+If you intend to run a component with a docker image you will need to import it from this directory with

build/docker/openim-rpc-conversation/Dockerfile

@@ -1,59 +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.
-
-# OpenIM base image: https://github.com/openim-sigs/openim-base-image
-
-# Set go mod installation source and proxy
-
-FROM golang:1.20 AS builder
-
-ARG GO111MODULE=on
-ARG GOPROXY=https://goproxy.cn,direct
-
-WORKDIR /openim/openim-server
-
-ENV GO111MODULE=$GO111MODULE
-ENV GOPROXY=$GOPROXY
-
-COPY go.mod go.sum ./
-RUN go mod download
-
-COPY . .
-
-RUN make clean
-
-RUN make build BINS=openim-rpc
-# RUN CGO_ENABLED=0 go build -ldflags="-w -s" -o ./_output/bin/platforms/$(go env GOOS)/$(go env GOARCH)/openim-rpc-conversation ./cmd/openim-rpc/openim-rpc-conversation
-
-RUN rm -rf ./_output/bin/platforms/$(go env GOOS)/$(go env GOARCH)/openim-rpc-friend && \
-    rm -rf ./_output/bin/platforms/$(go env GOOS)/$(go env GOARCH)/openim-rpc-group && \
-    rm -rf ./_output/bin/platforms/$(go env GOOS)/$(go env GOARCH)/openim-rpc-msg && \
-    rm -rf ./_output/bin/platforms/$(go env GOOS)/$(go env GOARCH)/openim-rpc-third && \
-    rm -rf ./_output/bin/platforms/$(go env GOOS)/$(go env GOARCH)/openim-rpc-user && \
-    rm -rf ./_output/bin/platforms/$(go env GOOS)/$(go env GOARCH)/openim-rpc-auth
-
-FROM ghcr.io/openim-sigs/openim-bash-image:latest
-
-WORKDIR /openim/openim-server
-
-ENV OS ${OS}
-ENV ARCH ${ARCH}
-
-COPY --from=builder /openim/openim-server/_output/bin/platforms /openim/openim-server/_output/bin/platforms/
-COPY --from=builder /openim/openim-server/config /openim/openim-server/config
-
-EXPOSE 10230
-EXPOSE 20230
-
-CMD ["bash", "-c","${OPENIM_SERVER_BINDIR}/platforms/${OS}/${ARCH}/openim-rpc-conversation --port 10230 --prometheus_port 20230 -c ${SERVER_WORKDIR}/config"]

build/docker/openim-rpc-friend/Dockerfile

@@ -1,59 +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.
-
-# OpenIM base image: https://github.com/openim-sigs/openim-base-image
-
-# Set go mod installation source and proxy
-
-FROM golang:1.20 AS builder
-
-ARG GO111MODULE=on
-ARG GOPROXY=https://goproxy.cn,direct
-
-WORKDIR /openim/openim-server
-
-ENV GO111MODULE=$GO111MODULE
-ENV GOPROXY=$GOPROXY
-
-COPY go.mod go.sum ./
-RUN go mod download
-
-COPY . .
-
-RUN make clean
-
-RUN make build BINS=openim-rpc
-# RUN CGO_ENABLED=0 go build -ldflags="-w -s" -o ./_output/bin/platforms/$(go env GOOS)/$(go env GOARCH)/openim-rpc-friend ./cmd/openim-rpc/openim-rpc-friend
-
-RUN rm -rf ./_output/bin/platforms/$(go env GOOS)/$(go env GOARCH)/openim-rpc-group && \
-    rm -rf ./_output/bin/platforms/$(go env GOOS)/$(go env GOARCH)/openim-rpc-msg && \
-    rm -rf ./_output/bin/platforms/$(go env GOOS)/$(go env GOARCH)/openim-rpc-third && \
-    rm -rf ./_output/bin/platforms/$(go env GOOS)/$(go env GOARCH)/openim-rpc-user && \
-    rm -rf ./_output/bin/platforms/$(go env GOOS)/$(go env GOARCH)/openim-rpc-conversation && \
-    rm -rf ./_output/bin/platforms/$(go env GOOS)/$(go env GOARCH)/openim-rpc-auth
-
-FROM ghcr.io/openim-sigs/openim-bash-image:latest
-
-WORKDIR /openim/openim-server
-
-ENV OS ${OS}
-ENV ARCH ${ARCH}
-
-COPY --from=builder /openim/openim-server/_output/bin/platforms /openim/openim-server/_output/bin/platforms/
-COPY --from=builder /openim/openim-server/config /openim/openim-server/config
-
-EXPOSE 10120
-EXPOSE 20120
-
-CMD ["bash", "-c","${OPENIM_SERVER_BINDIR}/platforms/${OS}/${ARCH}/openim-rpc-friend --port 10120 --prometheus_port 20120 -c ${SERVER_WORKDIR}/config"]

build/docker/openim-rpc-group/Dockerfile

@@ -1,59 +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.
-
-# OpenIM base image: https://github.com/openim-sigs/openim-base-image
-
-# Set go mod installation source and proxy
-
-FROM golang:1.20 AS builder
-
-ARG GO111MODULE=on
-ARG GOPROXY=https://goproxy.cn,direct
-
-WORKDIR /openim/openim-server
-
-ENV GO111MODULE=$GO111MODULE
-ENV GOPROXY=$GOPROXY
-
-COPY go.mod go.sum ./
-RUN go mod download
-
-COPY . .
-
-RUN make clean
-
-RUN make build BINS=openim-rpc
-# RUN CGO_ENABLED=0 go build -ldflags="-w -s" -o ./_output/bin/platforms/$(go env GOOS)/$(go env GOARCH)/openim-rpc-group ./cmd/openim-rpc/openim-rpc-group
-
-RUN rm -rf ./_output/bin/platforms/$(go env GOOS)/$(go env GOARCH)/openim-rpc-friend && \
-    rm -rf ./_output/bin/platforms/$(go env GOOS)/$(go env GOARCH)/openim-rpc-msg && \
-    rm -rf ./_output/bin/platforms/$(go env GOOS)/$(go env GOARCH)/openim-rpc-third && \
-    rm -rf ./_output/bin/platforms/$(go env GOOS)/$(go env GOARCH)/openim-rpc-user && \
-    rm -rf ./_output/bin/platforms/$(go env GOOS)/$(go env GOARCH)/openim-rpc-conversation && \
-    rm -rf ./_output/bin/platforms/$(go env GOOS)/$(go env GOARCH)/openim-rpc-auth
-
-FROM ghcr.io/openim-sigs/openim-bash-image:latest
-
-WORKDIR /openim/openim-server
-
-ENV OS ${OS}
-ENV ARCH ${ARCH}
-
-COPY --from=builder /openim/openim-server/_output/bin/platforms /openim/openim-server/_output/bin/platforms/
-COPY --from=builder /openim/openim-server/config /openim/openim-server/config
-
-EXPOSE 10150
-EXPOSE 20150
-
-CMD ["bash", "-c","${OPENIM_SERVER_BINDIR}/platforms/${OS}/${ARCH}/openim-rpc-group --port 10150 --prometheus_port 20150 -c ${SERVER_WORKDIR}/config"]

build/docker/openim-rpc-msg/Dockerfile

@@ -1,59 +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.
-
-# OpenIM base image: https://github.com/openim-sigs/openim-base-image
-
-# Set go mod installation source and proxy
-
-FROM golang:1.20 AS builder
-
-ARG GO111MODULE=on
-ARG GOPROXY=https://goproxy.cn,direct
-
-WORKDIR /openim/openim-server
-
-ENV GO111MODULE=$GO111MODULE
-ENV GOPROXY=$GOPROXY
-
-COPY go.mod go.sum ./
-RUN go mod download
-
-COPY . .
-
-RUN make clean
-
-RUN make build BINS=openim-rpc
-# RUN CGO_ENABLED=0 go build -ldflags="-w -s" -o ./_output/bin/platforms/$(go env GOOS)/$(go env GOARCH)/openim-rpc-msg ./cmd/openim-rpc/openim-rpc-msg
-
-RUN rm -rf ./_output/bin/platforms/$(go env GOOS)/$(go env GOARCH)/openim-rpc-friend && \
-    rm -rf ./_output/bin/platforms/$(go env GOOS)/$(go env GOARCH)/openim-rpc-group && \
-    rm -rf ./_output/bin/platforms/$(go env GOOS)/$(go env GOARCH)/openim-rpc-third && \
-    rm -rf ./_output/bin/platforms/$(go env GOOS)/$(go env GOARCH)/openim-rpc-user && \
-    rm -rf ./_output/bin/platforms/$(go env GOOS)/$(go env GOARCH)/openim-rpc-conversation && \
-    rm -rf ./_output/bin/platforms/$(go env GOOS)/$(go env GOARCH)/openim-rpc-auth
-
-FROM ghcr.io/openim-sigs/openim-bash-image:latest
-
-WORKDIR /openim/openim-server
-
-ENV OS ${OS}
-ENV ARCH ${ARCH}
-
-COPY --from=builder /openim/openim-server/_output/bin/platforms /openim/openim-server/_output/bin/platforms/
-COPY --from=builder /openim/openim-server/config /openim/openim-server/config
-
-EXPOSE 10130
-EXPOSE 20130
-
-CMD ["bash", "-c","${OPENIM_SERVER_BINDIR}/platforms/${OS}/${ARCH}/openim-rpc-msg --port 10130 --prometheus_port 20130 -c ${SERVER_WORKDIR}/config"]

build/docker/openim-rpc-third/Dockerfile

@@ -1,58 +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.
-
-# OpenIM base image: https://github.com/openim-sigs/openim-base-image
-
-# Set go mod installation source and proxy
-
-FROM golang:1.20 AS builder
-
-ARG GO111MODULE=on
-ARG GOPROXY=https://goproxy.cn,direct
-
-WORKDIR /openim/openim-server
-
-ENV GO111MODULE=$GO111MODULE
-ENV GOPROXY=$GOPROXY
-
-COPY go.mod go.sum ./
-RUN go mod download
-
-COPY . .
-
-RUN make clean
-
-RUN make build BINS=openim-rpc
-# RUN CGO_ENABLED=0 go build -ldflags="-w -s" -o ./_output/bin/platforms/$(go env GOOS)/$(go env GOARCH)/openim-rpc-third ./cmd/openim-rpc/openim-rpc-third
-
-RUN rm -rf ./_output/bin/platforms/$(go env GOOS)/$(go env GOARCH)/openim-rpc-friend && \
-    rm -rf ./_output/bin/platforms/$(go env GOOS)/$(go env GOARCH)/openim-rpc-group && \
-    rm -rf ./_output/bin/platforms/$(go env GOOS)/$(go env GOARCH)/openim-rpc-msg && \
-    rm -rf ./_output/bin/platforms/$(go env GOOS)/$(go env GOARCH)/openim-rpc-user && \
-    rm -rf ./_output/bin/platforms/$(go env GOOS)/$(go env GOARCH)/openim-rpc-conversation && \
-    rm -rf ./_output/bin/platforms/$(go env GOOS)/$(go env GOARCH)/openim-rpc-auth
-
-FROM ghcr.io/openim-sigs/openim-bash-image:latest
-
-WORKDIR /openim/openim-server
-
-ENV OS ${OS}
-ENV ARCH ${ARCH}
-
-COPY --from=builder /openim/openim-server/_output/bin/platforms /openim/openim-server/_output/bin/platforms/
-COPY --from=builder /openim/openim-server/config /openim/openim-server/config
-
-EXPOSE 10200
-
-CMD ["bash", "-c","${OPENIM_SERVER_BINDIR}/platforms/${OS}/${ARCH}/openim-rpc-third --port 10200 -c ${SERVER_WORKDIR}/config"]

build/docker/openim-rpc-user/Dockerfile

@@ -1,58 +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.
-
-# OpenIM base image: https://github.com/openim-sigs/openim-base-image
-
-# Set go mod installation source and proxy
-
-FROM golang:1.20 AS builder
-
-ARG GO111MODULE=on
-ARG GOPROXY=https://goproxy.cn,direct
-
-WORKDIR /openim/openim-server
-
-ENV GO111MODULE=$GO111MODULE
-ENV GOPROXY=$GOPROXY
-
-COPY go.mod go.sum ./
-RUN go mod download
-
-COPY . .
-
-RUN make clean
-
-RUN make build BINS=openim-rpc
-# RUN CGO_ENABLED=0 go build -ldflags="-w -s" -o ./_output/bin/platforms/$(go env GOOS)/$(go env GOARCH)/openim-rpc-user ./cmd/openim-rpc/openim-rpc-user
-
-RUN rm -rf ./_output/bin/platforms/$(go env GOOS)/$(go env GOARCH)/openim-rpc-friend && \
-    rm -rf ./_output/bin/platforms/$(go env GOOS)/$(go env GOARCH)/openim-rpc-group && \
-    rm -rf ./_output/bin/platforms/$(go env GOOS)/$(go env GOARCH)/openim-rpc-msg && \
-    rm -rf ./_output/bin/platforms/$(go env GOOS)/$(go env GOARCH)/openim-rpc-third && \
-    rm -rf ./_output/bin/platforms/$(go env GOOS)/$(go env GOARCH)/openim-rpc-conversation && \
-    rm -rf ./_output/bin/platforms/$(go env GOOS)/$(go env GOARCH)/openim-rpc-auth
-
-FROM ghcr.io/openim-sigs/openim-bash-image:latest
-
-WORKDIR /openim/openim-server
-
-ENV OS ${OS}
-ENV ARCH ${ARCH}
-
-COPY --from=builder /openim/openim-server/_output/bin/platforms /openim/openim-server/_output/bin/platforms/
-COPY --from=builder /openim/openim-server/config /openim/openim-server/config
-
-EXPOSE 10110
-
-CMD ["bash", "-c","${OPENIM_SERVER_BINDIR}/platforms/${OS}/${ARCH}/openim-rpc-user --port 10110 -c ${SERVER_WORKDIR}/config"]

build/goreleaser.yaml

@@ -255,6 +255,134 @@ builds:
       - "6"
       - "7"
 
+  - binary: infra
+    id: infra
+    main: ./tools/infra/infra.go
+    goos:
+      - darwin
+      - windows
+      - linux
+    goarch:
+      - s390x
+      - mips64
+      - mips64le
+      - amd64
+      - ppc64le
+      - arm64
+    goarm:
+      - "6"
+      - "7"
+
+  - binary: ncpu
+    id: ncpu
+    main: ./tools/ncpu/ncpu.go
+    goos:
+      - darwin
+      - windows
+      - linux
+    goarch:
+      - s390x
+      - mips64
+      - mips64le
+      - amd64
+      - ppc64le
+      - arm64
+    goarm:
+      - "6"
+      - "7"
+
+  - binary: openim-web
+    id: openim-web
+    main: ./tools/openim-web/openim-web.go
+    goos:
+      - darwin
+      - windows
+      - linux
+    goarch:
+      - s390x
+      - mips64
+      - mips64le
+      - amd64
+      - ppc64le
+      - arm64
+    goarm:
+      - "6"
+      - "7"
+
+  - binary: component
+    id: component
+    main: ./tools/component/component.go
+    goos:
+      - darwin
+      - windows
+      - linux
+    goarch:
+      - s390x
+      - mips64
+      - mips64le
+      - amd64
+      - ppc64le
+      - arm64
+    goarm:
+      - "6"
+      - "7"
+    
+  - binary: versionchecker
+    id: versionchecker
+    main: ./tools/versionchecker/versionchecker.go
+    goos:
+      - darwin
+      - windows
+      - linux
+    goarch:
+      - s390x
+      - mips64
+      - mips64le
+      - amd64
+      - ppc64le
+      - arm64
+    goarm:
+      - "6"
+      - "7"
+
+  - binary: changelog
+    id: changelog
+    main: ./tools/changelog/changelog.go
+    goos:
+      - darwin
+      - windows
+      - linux
+    goarch:
+      - s390x
+      - mips64
+      - mips64le
+      - amd64
+      - ppc64le
+      - arm64
+    goarm:
+      - "6"
+      - "7"
+
+  - binary: yamlfmt
+    id: yamlfmt
+    main: ./tools/yamlfmt/yamlfmt.go
+    goos:
+      - darwin
+      - windows
+      - linux
+    goarch:
+      - s390x
+      - mips64
+      - mips64le
+      - amd64
+      - ppc64le
+      - arm64
+    goarm:
+      - "6"
+      - "7"
+
+# TODO：Need a script, such as the init - release to help binary to find the right directory
+# ,which can be compiled binary
 archives:
   - format: tar.gz
     # this name template makes the OS and Arch compatible with the results of uname.
@@ -265,12 +393,23 @@ archives:
       {{- else if eq .Arch "386" }}i386
       {{- else }}{{ .Arch }}{{ end }}
       {{- if .Arm }}v{{ .Arm }}{{ end }}
+
+    # Set this to true if you want all files in the archive to be in a single directory.
+    # If set to true and you extract the archive 'goreleaser_Linux_arm64.tar.gz',
+    # you'll get a folder 'goreleaser_Linux_arm64'.
+    # If set to false, all files are extracted separately.
+    # You can also set it to a custom folder name (templating is supported).
+    wrap_in_directory: true
+
     # use zip for windows archives
     files:
-      - LICENSE
-      - README.md
       - CHANGELOG/*
-      - CONTRIBUTING.md
+      - deployment/*
+      - config/*
+      - build/*
+      - scripts/*
+      - Makefile
+      - install.sh
       - docs/*
       - src: "*.md"
         dst: docs
@@ -339,7 +478,9 @@ changelog:
 #   - image_templates:
 #       - "openimsdk/open-im-server:{{ .Tag }}-amd64"
 #       - "ghcr.io/goreleaser/goreleaser:{{ .Tag }}-amd64"
-#     dockerfile: Dockerfile
+#     dockerfile: build/images/openim-api/Dockerfile.release
+#     ids: 
+#       - openim-api
 #     use: buildx
 #     build_flag_templates:
 #       - "--pull"
@@ -359,7 +500,7 @@ changelog:
 #   - image_templates:
 #       - "goreleaser/goreleaser:{{ .Tag }}-arm64"
 #       - "ghcr.io/goreleaser/goreleaser:{{ .Tag }}-arm64"
-#     dockerfile: Dockerfile
+#     dockerfile: build/images/openim-api/Dockerfile.release
 #     use: buildx
 #     build_flag_templates:
 #       - "--pull"
@@ -479,53 +620,4 @@ checksum:
   algorithm: sha256
 
 release:
-
-  prerelease: auto
-  
-  footer: |
-  
-    ## Welcome to the {{ .Tag }} release of [chat](https://github.com/OpenIMSDK/chat)!🎉🎉!
-
-    **Full Changelog**: https://github.com/OpenIMSDK/Open-IM-Server/compare/{{ .PreviousTag }}...{{ .Tag }}
-
-    ## Helping out
-
-    + We release logs are recorded on [✨CHANGELOG](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/CHANGELOG/CHANGELOG.md)
-
-    + For information on versions of OpenIM and how to maintain branches, read [📚this article](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/version.md)
-
-    + If you wish to use mirroring, read OpenIM's [image management policy](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/images.md)
-
-    **Want to be one of them 😘?**
-
-    <p align="center">
-        <a href="https://github.com/kubbot" style="float: left; margin-right: 10px;">
-            <img src="https://github.com/openimbot/openimbot/blob/main/assets/icon/blue%E9%80%8F%E6%98%8E.png" width="50" height="50" />
-        </a>
-        <a href="https://www.openim.online">
-            <img src="https://github.com/OpenIMSDK/Open-IM-Server/blob/main/assets/logo/openim-logo.png" />
-        </a>
-        <a href="https://github.com/openimbot" style="float: right; margin-left: 10px;">
-            <img src="https://github.com/openimbot/openimbot/blob/main/assets/icon/red%E9%80%8F%E6%98%8E.png" width="50" height="50" />
-        </a>
-    </p>
-
-    > **Note**
-    > @openimbot and @kubbot have made great contributions to the community as community 🤖robots(@openimsdk/bot), respectively.
-    > Thanks to the @openimsdk/openim team for all their hard work on this release.
-    > Thank you to all the [💕developers and contributors](https://github.com/OpenIMSDK/Open-IM-Server/graphs/contributors), people from all over the world, OpenIM brings us together
-    > Contributions to this project are welcome! Please see [CONTRIBUTING.md](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/CONTRIBUTING.md) for details.
-
-    ## Get Involved with OpenIM!
-
-    **Here are some ways to get involved with the OpenIM community:**
-
-    📢 **Slack Channel**: Join our Slack channels for discussions, communication, and support. Click [here](https://join.slack.com/t/openimsdk/shared_invite/zt-1tmoj26uf-_FDy3dowVHBiGvLk9e5Xkg) to join the Open-IM-Server Slack team channel.
-
-    📧 **Gmail Contact**: If you have any questions, suggestions, or feedback for our open-source projects, please feel free to [contact us via email](https://mail.google.com/mail/?view=cm&fs=1&tf=1&to=winxu81@gmail.com).
-
-    📖 **Blog**: Stay up-to-date with OpenIM-Server projects and trends by reading our [blog](https://doc.rentsoft.cn/). We share the latest developments, tech trends, and other interesting information related to OpenIM.
-
-    📱 **WeChat**: Add us on WeChat (QR Code) and indicate that you are a user or developer of Open-IM-Server. We'll process your request as soon as possible.
-
-    Remember, your contributions play a vital role in making OpenIM successful, and we look forward to your active participation in our community! 🙌
+  prerelease: auto

build/images/openim-api/Dockerfile

@@ -34,6 +34,7 @@ COPY . .
 RUN make clean
 RUN make build BINS=openim-api
 
+# FROM ghcr.io/openim-sigs/openim-bash-image:latest
 FROM ghcr.io/openim-sigs/openim-bash-image:latest
 
 WORKDIR /openim/openim-server
@@ -41,6 +42,9 @@ WORKDIR /openim/openim-server
 COPY --from=builder /openim/openim-server/_output/bin/platforms /openim/openim-server/_output/bin/platforms
 COPY --from=builder /openim/openim-server/config /openim/openim-server/config
 
-EXPOSE ${10002}
+ENV PORT 10002
+EXPOSE 10002
 
-CMD ["bash", "-c","${OPENIM_SERVER_BINDIR}/platforms/${OS}/${ARCH}/openim-api --port 10002 -c ${SERVER_WORKDIR}/config"]
+RUN mv ${OPENIM_SERVER_BINDIR}/platforms/$(get_os)/$(get_arch)/openim-api /usr/bin/openim-api
+
+ENTRYPOINT ["bash", "-c", "openim-api -c $OPENIM_SERVER_CONFIG_NAME --port $PORT"]

build/images/openim-api/Dockerfile.release

@@ -0,0 +1,8 @@
+FROM ghcr.io/openim-sigs/openim-bash-image:latest
+
+COPY openim-api /usr/bin/
+
+# nosemgrep: dockerfile.security.missing-user.missing-user
+ENTRYPOINT ["/usr/bin/openim-api"]
+# nosemgrep: dockerfile.security.missing-user.missing-user
+CMD ["--help"]

build/images/openim-cmdutils/Dockerfile

@@ -39,7 +39,11 @@ FROM ghcr.io/openim-sigs/openim-bash-image:latest
 
 WORKDIR /openim/openim-server
 
-COPY --from=builder ${SERVER_WORKDIR}/_output/bin/platforms /openim/openim-server/_output/bin/platforms
+COPY --from=builder $OPENIM_SERVER_BINDIR/platforms /openim/openim-server/_output/bin/platforms
 COPY --from=builder ${SERVER_WORKDIR}/config /openim/openim-server/config
 
-CMD ["bash", "-c","${OPENIM_SERVER_BINDIR}/platforms/${OS}/${ARCH}/openim-cmdutils"]
+RUN mv ${OPENIM_SERVER_BINDIR}/platforms/$(get_os)/$(get_arch)/openim-cmdutils /usr/bin/openim-cmdutils
+
+ENTRYPOINT ["openim-cmdutils"]
+
+CMD ["--help"]

build/images/openim-crontask/Dockerfile

@@ -41,4 +41,8 @@ WORKDIR /openim/openim-server
 COPY --from=builder /openim/openim-server/_output/bin/platforms /openim/openim-server/_output/bin/platforms
 COPY --from=builder /openim/openim-server/config /openim/openim-server/config
 
-CMD ["bash", "-c","${OPENIM_SERVER_BINDIR}/platforms/${OS}/${ARCH}/openim-crontask"]
+ENV OPENIM_SERVER_CONFIG_NAME=/openim/openim-server/config
+
+RUN mv ${OPENIM_SERVER_BINDIR}/platforms/$(get_os)/$(get_arch)/openim-crontask /usr/bin/openim-crontask
+
+CMD ["bash", "-c", "openim-crontask -c $OPENIM_SERVER_CONFIG_NAME"]

build/images/openim-msggateway/Dockerfile

@@ -41,10 +41,12 @@ WORKDIR /openim/openim-server
 COPY --from=builder /openim/openim-server/_output/bin/platforms /openim/openim-server/_output/bin/platforms
 COPY --from=builder /openim/openim-server/config /openim/openim-server/config
 
-ENV OS ${OS}
-ENV ARCH ${ARCH}
+ENV PORT 10140 \
+    WS_PORT 10001
 
 EXPOSE 10140
 EXPOSE 10001
 
-CMD ${OPENIM_SERVER_BINDIR}/platforms/${OS}/${ARCH}/openim-msggateway --port 10140 --ws_port 10001
+RUN mv ${OPENIM_SERVER_BINDIR}/platforms/$(get_os)/$(get_arch)/openim-msggateway /usr/bin/openim-msggateway
+
+CMD ["bash", "-c", "openim-msggateway -c $OPENIM_SERVER_CONFIG_NAME --port $PORT --ws_port $WS_PORT"]

build/images/openim-msgtransfer/Dockerfile

@@ -36,12 +36,11 @@ RUN make build BINS=openim-msgtransfer
 
 FROM ghcr.io/openim-sigs/openim-bash-image:latest
 
-ENV OS ${OS}
-ENV ARCH ${ARCH}
-
 WORKDIR /openim/openim-server
 
 COPY --from=builder /openim/openim-server/_output/bin/platforms /openim/openim-server/_output/bin/platforms
 COPY --from=builder /openim/openim-server/config /openim/openim-server/config
 
-CMD ${OPENIM_SERVER_BINDIR}/platforms/${OS}/${ARCH}/openim-msgtransfer
+RUN mv ${OPENIM_SERVER_BINDIR}/platforms/$(get_os)/$(get_arch)/openim-msgtransfer /usr/bin/openim-msgtransfer
+
+ENTRYPOINT ["bash", "-c", "if [[ -n $PROMETHEUS_PORT ]]; then openim-msgtransfer -c $OPENIM_SERVER_CONFIG_NAME --prometheus_port $PROMETHEUS_PORT; else openim-msgtransfer -c $OPENIM_SERVER_CONFIG_NAME; fi"]

build/images/openim-push/Dockerfile

@@ -15,6 +15,7 @@
 # OpenIM base image: https://github.com/openim-sigs/openim-base-image
 
 # Set go mod installation source and proxy
+# docker run -e "PORT=10003" -e "PROMETHEUSORT=4321"  --network host  -it 67ef891ad1ff
 
 FROM golang:1.20 AS builder
 
@@ -38,12 +39,14 @@ FROM ghcr.io/openim-sigs/openim-bash-image:latest
 
 WORKDIR /openim/openim-server
 
-ENV OS ${OS}
-ENV ARCH ${ARCH}
-
 COPY --from=builder /openim/openim-server/_output/bin/platforms /openim/openim-server/_output/bin/platforms
 COPY --from=builder /openim/openim-server/config /openim/openim-server/config
 
+ENV PORT 10170 \
+    PROMETHEUS_PORT 20170
+
 EXPOSE 10170
 
-CMD ${OPENIM_SERVER_BINDIR}/platforms/${OS}/${ARCH}/openim-push --port 10170
+RUN mv ${OPENIM_SERVER_BINDIR}/platforms/$(get_os)/$(get_arch)/openim-push /usr/bin/openim-push
+
+ENTRYPOINT ["bash", "-c", "if [[ -n $PROMETHEUS_PORT ]]; then openim-push -c $OPENIM_SERVER_CONFIG_NAME --port $PORT --prometheus_port $PROMETHEUS_PORT; else openim-push -c $OPENIM_SERVER_CONFIG_NAME --port $PORT; fi"]

build/images/openim-rpc-auth/Dockerfile

@@ -33,20 +33,20 @@ COPY . .
 
 RUN make clean
 
-# RUN make build BINS=openim-rpc
-
-RUN CGO_ENABLED=0 go build -ldflags="-w -s" -o ./_output/bin/platforms/$(go env GOOS)/$(go env GOARCH)/openim-rpc-auth ./cmd/openim-rpc/openim-rpc-auth
+RUN make build BINS=openim-rpc-auth
 
 FROM ghcr.io/openim-sigs/openim-bash-image:latest
 
 WORKDIR /openim/openim-server
 
-ENV OS ${OS}
-ENV ARCH ${ARCH}
-
 COPY --from=builder /openim/openim-server/_output/bin/platforms /openim/openim-server/_output/bin/platforms/
 COPY --from=builder /openim/openim-server/config /openim/openim-server/config
 
+ENV PORT 10160 \
+    PROMETHEUS_PORT 20160
+
 EXPOSE 10160
 
-CMD ["bash", "-c","${OPENIM_SERVER_BINDIR}/platforms/${OS}/${ARCH}/openim-rpc-auth --port 10160 -c ${SERVER_WORKDIR}/config"]
+RUN mv ${OPENIM_SERVER_BINDIR}/platforms/$(get_os)/$(get_arch)/openim-rpc-auth /usr/bin/openim-rpc-auth
+
+ENTRYPOINT ["bash", "-c", "if [[ -n $PROMETHEUS_PORT ]]; then "openim-rpc-auth --port $PORT -c $OPENIM_SERVER_CONFIG_NAME" --prometheus_port $PROMETHEUS_PORT; else "openim-rpc-auth --port $PORT -c $OPENIM_SERVER_CONFIG_NAME"; fi"]

build/images/openim-rpc-conversation/Dockerfile

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

build/images/openim-rpc-friend/Dockerfile

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

build/images/openim-rpc-group/Dockerfile

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

build/images/openim-rpc-msg/Dockerfile

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

build/images/openim-rpc-third/Dockerfile

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

build/images/openim-rpc-user/Dockerfile

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

build/images/openim-tools/component/Dockerfile

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

build/images/openim-tools/openim-web/Dockerfile

@@ -0,0 +1,57 @@
+# Copyright © 2023 OpenIM. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# OpenIM base image: https://github.com/openim-sigs/openim-base-image
+
+# Set go mod installation source and proxy
+
+FROM golang:1.20 AS builder
+
+ARG GO111MODULE=on
+ARG GOPROXY=https://goproxy.cn,direct
+
+WORKDIR /openim/openim-server
+
+ENV GO111MODULE=$GO111MODULE
+ENV GOPROXY=$GOPROXY
+
+RUN apt-get update && apt-get install -y curl unzip
+
+RUN curl -LO https://app-1302656840.cos.ap-nanjing.myqcloud.com/dist.zip \
+   && unzip dist.zip -d ./ \
+   && rm dist.zip
+
+COPY go.mod go.sum ./
+RUN go mod download
+
+COPY . .
+
+RUN make clean
+RUN make build BINS=openim-web
+
+FROM ghcr.io/openim-sigs/openim-ubuntu-image:latest
+
+WORKDIR /openim/openim-server
+
+COPY --from=builder /openim/openim-server/_output/bin/tools /openim/openim-server/_output/bin/tools/
+COPY --from=builder /openim/openim-server/dist /openim/openim-server/dist
+
+ENV PORT 11001
+ENV DISTPATH /openim/openim-server/dist
+
+EXPOSE 11001
+
+RUN mv ${OPENIM_SERVER_BINDIR}/tools/$(get_os)/$(get_arch)/openim-web /usr/bin/openim-web
+
+ENTRYPOINT ["bash", "-c", "openim-web -port $PORT -distPath $DISTPATH"]

cmd/openim-api/deploy.Dockerfile

@@ -1,32 +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.
-
-FROM ubuntu
-
-WORKDIR /openim/openim-server/bin
-
-RUN apt-get update && apt-get install apt-transport-https && apt-get install procps\
-&&apt-get install net-tools
-#Non-interactive operation
-ENV DEBIAN_FRONTEND=noninteractive
-RUN apt-get install -y vim curl tzdata gawk
-#Time zone adjusted to East eighth District
-RUN ln -fs /usr/share/zoneinfo/Asia/Shanghai /etc/localtime && dpkg-reconfigure -f noninteractive tzdata
-RUN apt-get -qq update \
-    && apt-get -qq install -y --no-install-recommends ca-certificates curl
-COPY ./openim-api ./
-
-VOLUME ["/openim/openim-server/logs","/openim/openim-server/config"]
-
-CMD ["./openim-api","--port", "10002"]

cmd/openim-api/main.go

@@ -28,7 +28,7 @@ import (
 
 	"github.com/OpenIMSDK/protocol/constant"
 	"github.com/OpenIMSDK/tools/discoveryregistry"
-	openKeeper "github.com/OpenIMSDK/tools/discoveryregistry/zookeeper"
+	openkeeper "github.com/OpenIMSDK/tools/discoveryregistry/zookeeper"
 	"github.com/OpenIMSDK/tools/log"
 
 	"github.com/OpenIMSDK/Open-IM-Server/internal/api"
@@ -66,11 +66,11 @@ func run(port int) error {
 	}
 	fmt.Println("api start init discov client")
 	var client discoveryregistry.SvcDiscoveryRegistry
-	client, err = openKeeper.NewClient(config.Config.Zookeeper.ZkAddr, config.Config.Zookeeper.Schema,
-		openKeeper.WithFreq(time.Hour), openKeeper.WithUserNameAndPassword(
+	client, err = openkeeper.NewClient(config.Config.Zookeeper.ZkAddr, config.Config.Zookeeper.Schema,
+		openkeeper.WithFreq(time.Hour), openkeeper.WithUserNameAndPassword(
 			config.Config.Zookeeper.Username,
 			config.Config.Zookeeper.Password,
-		), openKeeper.WithRoundRobin(), openKeeper.WithTimeout(10), openKeeper.WithLogger(log.NewZkLogger()))
+		), openkeeper.WithRoundRobin(), openkeeper.WithTimeout(10), openkeeper.WithLogger(log.NewZkLogger()))
 	if err != nil {
 		return err
 	}

cmd/openim-crontask/deploy.Dockerfile

@@ -1,32 +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.
-
-FROM ubuntu
-
-WORKDIR /openim/openim-server/bin
-
-RUN apt-get update && apt-get install apt-transport-https && apt-get install procps\
-&&apt-get install net-tools
-#Non-interactive operation
-ENV DEBIAN_FRONTEND=noninteractive
-RUN apt-get install -y vim curl tzdata gawk
-#Time zone adjusted to East eighth District
-RUN ln -fs /usr/share/zoneinfo/Asia/Shanghai /etc/localtime && dpkg-reconfigure -f noninteractive tzdata
-RUN apt-get -qq update \
-    && apt-get -qq install -y --no-install-recommends ca-certificates curl
-COPY ./openim-crontask ./
-
-VOLUME ["/openim/openim-server/logs","/openim/openim-server/config"]
-
-CMD ["./openim-crontask"]

cmd/openim-crontask/main.go

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

cmd/openim-msggateway/deploy.Dockerfile

@@ -1,32 +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.
-
-FROM ubuntu
-
-WORKDIR /openim/openim-server/bin
-
-RUN apt-get update && apt-get install apt-transport-https && apt-get install procps\
-&&apt-get install net-tools
-#Non-interactive operation
-ENV DEBIAN_FRONTEND=noninteractive
-RUN apt-get install -y vim curl tzdata gawk
-#Time zone adjusted to East eighth District
-RUN ln -fs /usr/share/zoneinfo/Asia/Shanghai /etc/localtime && dpkg-reconfigure -f noninteractive tzdata
-RUN apt-get -qq update \
-    && apt-get -qq install -y --no-install-recommends ca-certificates curl
-COPY ./openim-rpc-msg_gateway ./
-
-VOLUME ["/openim/openim-server/logs","/openim/openim-server/config"]
-
-CMD ["./openim-rpc-msg_gateway","--port", "10140" "--ws_port", "10001", "--prometheus_port", "20240"]

cmd/openim-msgtransfer/deploy.Dockerfile

@@ -1,32 +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.
-
-FROM ubuntu
-
-WORKDIR /openim/openim-server/bin
-
-RUN apt-get update && apt-get install apt-transport-https && apt-get install procps\
-&&apt-get install net-tools
-#Non-interactive operation
-ENV DEBIAN_FRONTEND=noninteractive
-RUN apt-get install -y vim curl tzdata gawk
-#Time zone adjusted to East eighth District
-RUN ln -fs /usr/share/zoneinfo/Asia/Shanghai /etc/localtime && dpkg-reconfigure -f noninteractive tzdata
-RUN apt-get -qq update \
-    && apt-get -qq install -y --no-install-recommends ca-certificates curl
-COPY ./openim-msgtransfer ./
-
-VOLUME ["/openim/openim-server/logs","/openim/openim-server/config"]
-
-CMD ["./openim-msgtransfer","--prometheus_port", "21400"]

cmd/openim-push/deploy.Dockerfile

@@ -1,32 +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.
-
-FROM ubuntu
-
-WORKDIR /openim/openim-server/bin
-
-RUN apt-get update && apt-get install apt-transport-https && apt-get install procps\
-&&apt-get install net-tools
-#Non-interactive operation
-ENV DEBIAN_FRONTEND=noninteractive
-RUN apt-get install -y vim curl tzdata gawk
-#Time zone adjusted to East eighth District
-RUN ln -fs /usr/share/zoneinfo/Asia/Shanghai /etc/localtime && dpkg-reconfigure -f noninteractive tzdata
-RUN apt-get -qq update \
-    && apt-get -qq install -y --no-install-recommends ca-certificates curl
-COPY ./openim-push ./
-
-VOLUME ["/openim/openim-server/logs","/openim/openim-server/config"]
-
-CMD ["./openim-push", "--port", "10170", "--prometheus_port", "20170"]

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

@@ -1,32 +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.
-
-FROM ubuntu
-
-WORKDIR /openim/openim-server/bin
-
-RUN apt-get update && apt-get install apt-transport-https && apt-get install procps\
-&&apt-get install net-tools
-#Non-interactive operation
-ENV DEBIAN_FRONTEND=noninteractive
-RUN apt-get install -y vim curl tzdata gawk
-#Time zone adjusted to East eighth District
-RUN ln -fs /usr/share/zoneinfo/Asia/Shanghai /etc/localtime && dpkg-reconfigure -f noninteractive tzdata
-RUN apt-get -qq update \
-    && apt-get -qq install -y --no-install-recommends ca-certificates curl
-COPY ./openim-rpc-auth ./
-
-VOLUME ["/openim/openim-server/logs","/openim/openim-server/config"]
-
-CMD ["./openim-rpc-auth", "--port", "10160"]

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

@@ -1,32 +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.
-
-FROM ubuntu
-
-WORKDIR /openim/openim-server/bin
-
-RUN apt-get update && apt-get install apt-transport-https && apt-get install procps\
-&&apt-get install net-tools
-#Non-interactive operation
-ENV DEBIAN_FRONTEND=noninteractive
-RUN apt-get install -y vim curl tzdata gawk
-#Time zone adjusted to East eighth District
-RUN ln -fs /usr/share/zoneinfo/Asia/Shanghai /etc/localtime && dpkg-reconfigure -f noninteractive tzdata
-RUN apt-get -qq update \
-    && apt-get -qq install -y --no-install-recommends ca-certificates curl
-COPY ./openim-rpc-conversation ./
-
-VOLUME ["/openim/openim-server/logs","/openim/openim-server/config"]
-
-CMD ["./openim-rpc-conversation", "--port", "10230", "--prometheus_port","20230"]

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

@@ -1,32 +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.
-
-FROM ubuntu
-
-WORKDIR /openim/openim-server/bin
-
-RUN apt-get update && apt-get install apt-transport-https && apt-get install procps\
-&&apt-get install net-tools
-#Non-interactive operation
-ENV DEBIAN_FRONTEND=noninteractive
-RUN apt-get install -y vim curl tzdata gawk
-#Time zone adjusted to East eighth District
-RUN ln -fs /usr/share/zoneinfo/Asia/Shanghai /etc/localtime && dpkg-reconfigure -f noninteractive tzdata
-RUN apt-get -qq update \
-    && apt-get -qq install -y --no-install-recommends ca-certificates curl
-COPY ./openim-rpc-friend ./
-
-VOLUME ["/openim/openim-server/logs","/openim/openim-server/config"]
-
-CMD ["./openim-rpc-friend", "--port", "10120", "--prometheus_port","20120"]

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

@@ -1,32 +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.
-
-FROM ubuntu
-
-WORKDIR /openim/openim-server/bin
-
-RUN apt-get update && apt-get install apt-transport-https && apt-get install procps\
-&&apt-get install net-tools
-#Non-interactive operation
-ENV DEBIAN_FRONTEND=noninteractive
-RUN apt-get install -y vim curl tzdata gawk
-#Time zone adjusted to East eighth District
-RUN ln -fs /usr/share/zoneinfo/Asia/Shanghai /etc/localtime && dpkg-reconfigure -f noninteractive tzdata
-RUN apt-get -qq update \
-    && apt-get -qq install -y --no-install-recommends ca-certificates curl
-COPY ./openim-rpc-group ./
-
-VOLUME ["/openim/openim-server/logs","/openim/openim-server/config"]
-
-CMD ["./openim-rpc-group", "--port", "10150", "--prometheus_port","20150"]

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

@@ -1,32 +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.
-
-FROM ubuntu
-
-WORKDIR /openim/openim-server/bin
-
-RUN apt-get update && apt-get install apt-transport-https && apt-get install procps\
-&&apt-get install net-tools
-#Non-interactive operation
-ENV DEBIAN_FRONTEND=noninteractive
-RUN apt-get install -y vim curl tzdata gawk
-#Time zone adjusted to East eighth District
-RUN ln -fs /usr/share/zoneinfo/Asia/Shanghai /etc/localtime && dpkg-reconfigure -f noninteractive tzdata
-RUN apt-get -qq update \
-    && apt-get -qq install -y --no-install-recommends ca-certificates curl
-COPY ./openim-rpc-msg ./
-
-VOLUME ["/openim/openim-server/logs","/openim/openim-server/config"]
-
-CMD ["./openim-rpc-msg", "--port", "10130", "--prometheus_port","20130"]

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

@@ -1,32 +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.
-
-FROM ubuntu
-
-WORKDIR /openim/openim-server/bin
-
-RUN apt-get update && apt-get install apt-transport-https && apt-get install procps\
-&&apt-get install net-tools
-#Non-interactive operation
-ENV DEBIAN_FRONTEND=noninteractive
-RUN apt-get install -y vim curl tzdata gawk
-#Time zone adjusted to East eighth District
-RUN ln -fs /usr/share/zoneinfo/Asia/Shanghai /etc/localtime && dpkg-reconfigure -f noninteractive tzdata
-RUN apt-get -qq update \
-    && apt-get -qq install -y --no-install-recommends ca-certificates curl
-COPY ./openim-rpc-third ./
-
-VOLUME ["/openim/openim-server/logs","/openim/openim-server/config"]
-
-CMD ["./openim-rpc-third", "--port", "10200"]

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

@@ -1,32 +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.
-
-FROM ubuntu
-
-WORKDIR /openim/openim-server/bin
-
-RUN apt-get update && apt-get install apt-transport-https && apt-get install procps\
-&&apt-get install net-tools
-#Non-interactive operation
-ENV DEBIAN_FRONTEND=noninteractive
-RUN apt-get install -y vim curl tzdata gawk
-#Time zone adjusted to East eighth District
-RUN ln -fs /usr/share/zoneinfo/Asia/Shanghai /etc/localtime && dpkg-reconfigure -f noninteractive tzdata
-RUN apt-get -qq update \
-    && apt-get -qq install -y --no-install-recommends ca-certificates curl
-COPY ./openim-rpc-user ./
-
-VOLUME ["/openim/openim-server/logs","/openim/openim-server/config"]
-
-CMD ["./openim-rpc-user", "--port", "10110"]

config/config.yaml

@@ -1,6 +1,6 @@
 # Copyright © 2023 OpenIM. All rights reserved.
 #
-# Licensed under the Apache License, Version 2.0 (the "License");
+# 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
 #
@@ -13,7 +13,10 @@
 # limitations under the License.
 
 # -----------------------------------------------------------------
-# Infrastructural configurations, please modify based on your setup
+# TODO: This config file is the template file
+# --| source: deployments/templates/openim.yaml
+# --| env: scripts/install/environment
+# --| target: config/config.yaml
 # -----------------------------------------------------------------
 
 ###################### Zookeeper ######################
@@ -24,10 +27,10 @@
 # Zookeeper username
 # Zookeeper password
 zookeeper:
-  schema: openim                          
-  address: [ 127.0.0.1:2181 ]            
-  username:                               
-  password:   
+  schema: openim
+  address: [ 172.28.0.1:12181 ]
+  username: ''
+  password: ''
 
 ###################### Mysql ######################
 # MySQL configuration
@@ -39,15 +42,15 @@ zookeeper:
 # Log level: 1=slient, 2=error, 3=warn, 4=info
 # Slow query threshold in milliseconds
 mysql:
-  address: [ 127.0.0.1:13306 ]
+  address: [ 172.28.0.1:13306 ]
   username: root
   password: openIM123
-  database: openIM_v3                     
-  maxOpenConn: 1000                       
-  maxIdleConn: 100                        
-  maxLifeTime: 60                         
-  logLevel: 4                             
-  slowThreshold: 500    
+  database: openIM_v3
+  maxOpenConn: 1000
+  maxIdleConn: 100
+  maxLifeTime: 60
+  logLevel: 4
+  slowThreshold: 500
 
 ###################### Mongo ######################
 # MongoDB configuration
@@ -57,23 +60,23 @@ mysql:
 # Default MongoDB database name
 # Maximum connection pool size
 mongo:
-  uri:
-  address: [ 127.0.0.1:37017 ]
+  uri: ''
+  address: [ 172.28.0.1:37017 ]
   database: openIM_v3
   username: root
   password: openIM123
-  maxPoolSize: 100  
+  maxPoolSize: 100
 
-###################### Redis ######################
+###################### Redis configuration information ######################
 # Redis configuration
 #
 # Username is required only for Redis version 6.0+
 redis:
-  address: [ 127.0.0.1:16379 ]
-  username:                               
+  address: [ 172.28.0.1:16379 ]
+  username: ''
   password: openIM123
 
-###################### Kafka ######################
+###################### Kafka configuration information ######################
 # Kafka configuration
 #
 # Kafka username
@@ -81,13 +84,13 @@ redis:
 # It's not recommended to modify this topic name
 # Consumer group ID, it's not recommended to modify
 kafka:
-  username:                               
-  password:                               
-  addr: [ 127.0.0.1:9092 ]
+  username: ''
+  password: ''
+  addr: [ 172.28.0.1:19094 ]
   latestMsgToRedis:
-    topic: "latestMsgToRedis"             
+    topic: "latestMsgToRedis"
   offlineMsgToMongo:
-    topic: "offlineMsgToMongoMysql"       
+    topic: "offlineMsgToMongoMysql"
   msgToPush:
     topic: "msgToPush"
   consumerGroupID:
@@ -96,25 +99,25 @@ kafka:
     msgToMySql: mysql
     msgToPush: push
 
-###################### RPC ######################
+###################### 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:
+  registerIP: ''
   listenIP: 0.0.0.0
 
-###################### API ######################
+###################### API configuration information ######################
 # API configuration
 #
 # API service port
 # Default listen IP is 0.0.0.0
 api:
-  openImApiPort: [ 10002 ]                
-  listenIP: 0.0.0.0    
+  openImApiPort: [ 10002 ]
+  listenIP: 0.0.0.0
 
-###################### Gateway ######################
+###################### Object configuration information ######################
 # Object storage configuration
 #
 # Use minio for object storage
@@ -124,28 +127,34 @@ api:
 # Session token
 # Configuration for Tencent COS
 # Configuration for Aliyun OSS
+# apiURL is the address of the api, the access address of the app, use s3 must be configured
+# minio.endpoint can be configured as an intranet address,
+# minio.signEndpoint is minio public network address
 object:
-  enable: "minio"                         
-  apiURL: http://127.0.0.1:10002/object/
+  enable: "minio"
+  apiURL: "http://14.153.6.114:10002"
   minio:
-    bucket: "openim"                      
-    endpoint: http://127.0.0.1:10005
-    accessKeyID: root
-    secretAccessKey: openIM123
-    sessionToken: ""                      
-  cos:                                    
-    bucketURL: "https://temp-1252357374.cos.ap-chengdu.myqcloud.com"
-    secretID: ""
-    secretKey: ""
-    sessionToken: ""
-  oss:                                    
+    bucket: "openim"
+    endpoint: "http://172.28.0.1:10005"
+    accessKeyID: "root"
+    secretAccessKey: "openIM123"
+    sessionToken: ''
+    signEndpoint: "http://14.153.6.114:10005"
+  cos:
+    bucketURL: https://temp-1252357374.cos.ap-chengdu.myqcloud.com
+    secretID: ''
+    secretKey: ''
+    sessionToken: ''
+  oss:
     endpoint: "https://oss-cn-chengdu.aliyuncs.com"
     bucket: "demo-9999999"
     bucketURL: "https://demo-9999999.oss-cn-chengdu.aliyuncs.com"
-    accessKeyID: root
-    accessKeySecret: ""
-    sessionToken: ""
+    accessKeyID: ''
+    accessKeySecret: ''
+    sessionToken: ''
 
+
+###################### 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
@@ -161,6 +170,7 @@ rpcPort:
   openImConversationPort: [ 10180 ]
   openImThirdPort: [ 10190 ]
 
+###################### RPC Register Name Configuration ######################
 # RPC service names for registration, it's not recommended to modify these
 rpcRegisterName:
   openImUserName: User
@@ -173,6 +183,7 @@ rpcRegisterName:
   openImConversationName: Conversation
   openImThirdName: Third
 
+###################### Log Configuration ######################
 # Log configuration
 #
 # Storage directory
@@ -183,14 +194,15 @@ rpcRegisterName:
 # Whether to output in json format
 # Whether to include stack trace in logs
 log:
-  storageLocation: ../../../../../logs/  
-  rotationTime: 24                        
-  remainRotationCount: 2                  
-  remainLogLevel: 6                       
-  isStdout: false                         
-  isJson: false                           
+  storageLocation: ../logs
+  rotationTime: 24
+  remainRotationCount: 2
+  remainLogLevel: 6
+  isStdout: false
+  isJson: false
   withStack: false
 
+###################### Variables definition ######################
 # Long connection server configuration
 #
 # Websocket port for msg_gateway
@@ -198,10 +210,10 @@ log:
 # Maximum length of websocket request package
 # Websocket connection handshake timeout
 longConnSvr:
-  openImWsPort: [ 10001 ]                 
-  websocketMaxConnNum: 100000             
-  websocketMaxMsgLen: 4096                
-  websocketTimeout: 10  
+  openImWsPort: [ 10001 ]
+  websocketMaxConnNum: 100000
+  websocketMaxMsgLen: 4096
+  websocketTimeout: 10
 
 # Push notification service configuration
 #
@@ -232,8 +244,8 @@ push:
 # Built-in app manager user IDs
 # Built-in app manager nicknames
 manager:
-  userID: [ "openIM123456","openIM654321","openIMAdmin" ]
-  nickname: [ "system1","system2", "system3" ]
+  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
@@ -287,6 +299,7 @@ iosPush:
   badgeCount: true
   production: false
 
+###################### Third-party service configuration ######################
 # Callback configuration
 #
 # Callback URL
@@ -356,7 +369,7 @@ callback:
     failedContinue: true
 
 ###################### Prometheus ######################
-# Prometheus configuration
+# 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:
@@ -371,4 +384,4 @@ prometheus:
   conversationPrometheusPort: [ 20230 ]
   rtcPrometheusPort: [ 21300 ]
   thirdPrometheusPort: [ 21301 ]
-  messageTransferPrometheusPort: [ 21400, 21401, 21402, 21403 ]
+  messageTransferPrometheusPort: [ 21400, 21401, 21402, 21403 ] # List of ports

config/notification.yaml

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

deployments/README.md

@@ -12,7 +12,6 @@ OpenIM 支持很多种集群化部署方式，包括但不限于 helm, sealos, k
 - https://github.com/showurl/deploy-openim
 
 
-
 ### 依赖检查
 
 ```bash

deployments/templates/chat.yaml

@@ -0,0 +1,110 @@
+# Configuration for OpenIMServer
+
+# -----------------------------------------------------------------
+# TODO: This config file is the template file
+# --| source: deployments/templates/chat.yaml
+# --| env: scripts/install/environment
+# --| target: config/config.yaml
+# -----------------------------------------------------------------
+
+###################### Zookeeper ######################
+# Zookeeper configuration
+# It's not recommended to modify the schema
+zookeeper:
+  schema: ${ZOOKEEPER_SCHEMA}
+  zkAddr:
+    - ${ZOOKEEPER_ADDRESS}:${ZOOKEEPER_PORT}
+  username: ${ZOOKEEPER_USERNAME}
+  password: ${ZOOKEEPER_PASSWORD}
+
+###################### Chat API ######################
+chatApi:
+  openImChatApiPort: [ ${OPENIM_CHAT_API_PORT} ]
+  listenIP: ${CHAT_API_LISTEN_IP}
+
+###################### Admin API ######################
+adminApi:
+  openImAdminApiPort: [ ${OPENIM_ADMIN_API_PORT} ]
+  listenIP: ${ADMIN_API_LISTEN_IP}
+
+###################### RPC ######################
+rpc:
+  registerIP:                             #作为rpc启动时，注册到zookeeper的IP，api/gateway能访问到此ip和对应的rpcPort中的端口
+  listenIP:                               #默认为0.0.0.0
+
+rpcPort:
+  openImAdminPort: [ ${OPENIM_ADMIN_PORT} ]
+  openImChatPort: [ ${OPENIM_CHAT_PORT} ]
+rpcRegisterName:
+  openImAdminName: ${OPENIM_ADMIN_NAME}
+  openImChatName: ${OPENIM_CHAT_NAME}
+
+###################### MySQL ######################
+mysql:
+  #  address: [ 127.0.0.1:13306 ]            #目前仅支持单机
+  #  username: root                          #用户名
+  #  password: openIM123                     #密码
+  #  database: openIM_v2                     #不建议修改
+  #  maxOpenConn: 1000                       #最大连接数
+  #  maxIdleConn: 100                        #最大空闲连接数
+  #  maxLifeTime: 60                         #连接可以重复使用的最长时间（秒）
+  #  logLevel: 4                             #日志级别 1=slient 2=error 3=warn 4=info
+  #  slowThreshold: 500                      #慢语句阈值 （毫秒）
+  database: openim_enterprise
+
+###################### Log ######################
+log:
+  storageLocation: ../logs/           #存放目录
+#  rotationTime: 24                    #日志旋转时间
+#  remainRotationCount: 2              #日志数量
+#  remainLogLevel: 6                   #日志级别 6表示全都打印，
+#  isStdout: false
+#  isJson: false
+#  withStack: false
+
+###################### Secret & Token Policy ######################
+# secret: openIM123
+#tokenPolicy:
+#  expire: 86400
+
+###################### Verify Code ######################
+verifyCode:
+  validTime: 300 # 验证码有效时间
+  validCount: 5 # 验证码有效次数
+  uintTime: 86400 # 单位时间间隔
+  maxCount: 10 # 单位时间内最大获取次数
+  superCode: "666666" # 超级验证码(只有use为空时使用)
+  len: 6 # 验证码长度
+  use: "" # 使用的验证码服务(use: "ali")
+  ali:
+    endpoint: "dysmsapi.aliyuncs.com"
+    accessKeyId: ""
+    accessKeySecret: ""
+    signName: ""
+    verificationCodeTemplateCode: ""
+
+
+###################### Proxy Header ######################
+# 获取ip的header,没有配置直接获取远程地址
+#proxyHeader: "X-Forwarded-For"
+
+###################### Admin List ######################
+adminList:
+  - adminID: admin1
+    nickname: chat1
+    imAdmin: openIM123456
+  - adminID: admin2
+    nickname: chat2
+    imAdmin: openIM654321
+  - adminID: admin3
+    nickname: chat3
+    imAdmin: openIMAdmin
+
+###################### OpenIM URL ######################
+openIMUrl: ${OPENIM_SERVER_ADDRESS}:${API_OPENIM_PORT}
+
+###################### Redis ######################
+redis:
+  # address: [ 127.0.0.1:16379 ]
+  # username:
+  # password: openIM123

deployments/templates/env_template.yaml

@@ -0,0 +1,265 @@
+# ======================================
+# ========= Basic Configuration ========
+# ======================================
+
+# The user for authentication or system operations.
+# Default: USER=root
+USER=${USER}
+
+# Password associated with the specified user for authentication.
+# Default: PASSWORD=openIM123
+PASSWORD=${PASSWORD}
+
+# Endpoint for the MinIO object storage service.
+# Default: MINIO_ENDPOINT=http://172.28.0.1:10005
+MINIO_ENDPOINT=${MINIO_ENDPOINT}
+
+# Base URL for the application programming interface (API).
+# Default: API_URL=http://172.28.0.1:10002
+API_URL=${API_URL}
+
+# Directory path for storing data files or related information.
+# Default: DATA_DIR=./
+DATA_DIR=${DATA_DIR}
+
+# ======================================
+# ========= Network Configuration ======
+# ======================================
+
+# Subnet for the Docker network.
+# Default: DOCKER_BRIDGE_SUBNET=172.28.0.0/16
+DOCKER_BRIDGE_SUBNET=${DOCKER_BRIDGE_SUBNET}
+
+# Gateway for the Docker network.
+# Default: DOCKER_BRIDGE_GATEWAY=172.28.0.1
+DOCKER_BRIDGE_GATEWAY=${DOCKER_BRIDGE_GATEWAY}
+
+# Address or hostname for the MySQL network.
+# Default: MYSQL_NETWORK_ADDRESS=172.28.0.2
+MYSQL_NETWORK_ADDRESS=${MYSQL_NETWORK_ADDRESS}
+
+# Address or hostname for the MongoDB network.
+# Default: MONGO_NETWORK_ADDRESS=172.28.0.3
+MONGO_NETWORK_ADDRESS=${MONGO_NETWORK_ADDRESS}
+
+# Address or hostname for the Redis network.
+# Default: REDIS_NETWORK_ADDRESS=172.28.0.4
+REDIS_NETWORK_ADDRESS=${REDIS_NETWORK_ADDRESS}
+
+# Address or hostname for the Kafka network.
+# Default: KAFKA_NETWORK_ADDRESS=172.28.0.5
+KAFKA_NETWORK_ADDRESS=${KAFKA_NETWORK_ADDRESS}
+
+# Address or hostname for the ZooKeeper network.
+# Default: ZOOKEEPER_NETWORK_ADDRESS=172.28.0.6
+ZOOKEEPER_NETWORK_ADDRESS=${ZOOKEEPER_NETWORK_ADDRESS}
+
+# Address or hostname for the MinIO network.
+# Default: MINIO_NETWORK_ADDRESS=172.28.0.7
+MINIO_NETWORK_ADDRESS=${MINIO_NETWORK_ADDRESS}
+
+# Address or hostname for the OpenIM web network.
+# Default: OPENIM_WEB_NETWORK_ADDRESS=172.28.0.8
+OPENIM_WEB_NETWORK_ADDRESS=${OPENIM_WEB_NETWORK_ADDRESS}
+
+# Address or hostname for the OpenIM server network.
+# Default: OPENIM_SERVER_NETWORK_ADDRESS=172.28.0.9
+OPENIM_SERVER_NETWORK_ADDRESS=${OPENIM_SERVER_NETWORK_ADDRESS}
+
+# Address or hostname for the OpenIM chat network.
+# Default: OPENIM_CHAT_NETWORK_ADDRESS=172.28.0.10
+OPENIM_CHAT_NETWORK_ADDRESS=${OPENIM_CHAT_NETWORK_ADDRESS}
+
+# Address or hostname for the Prometheus network.
+# Default: PROMETHEUS_NETWORK_ADDRESS=172.28.0.11
+PROMETHEUS_NETWORK_ADDRESS=${PROMETHEUS_NETWORK_ADDRESS}
+
+# Address or hostname for the Grafana network.
+# Default: GRAFANA_NETWORK_ADDRESS=172.28.0.12
+GRAFANA_NETWORK_ADDRESS=${GRAFANA_NETWORK_ADDRESS}
+
+
+# ===============================================
+# = Component Extension Configuration =
+# ===============================================
+
+# ============ Component Extension Configuration ==========
+# ----- ZooKeeper Configuration -----
+# Address or hostname for the ZooKeeper service.
+# Default: ZOOKEEPER_ADDRESS=172.28.0.1
+ZOOKEEPER_ADDRESS=${ZOOKEEPER_NETWORK_ADDRESS}
+
+# Port for ZooKeeper service.
+# Default: ZOOKEEPER_PORT=12181
+ZOOKEEPER_PORT=${ZOOKEEPER_PORT}
+
+# ----- MySQL Configuration -----
+
+# Address or hostname for the MySQL service.
+# Default: MYSQL_ADDRESS=172.28.0.1
+MYSQL_ADDRESS=${MYSQL_NETWORK_ADDRESS}
+
+# Port on which MySQL database service is running.
+# Default: MYSQL_PORT=13306
+MYSQL_PORT=${MYSQL_PORT}
+
+# Password to authenticate with the MySQL database service.
+# Default: MYSQL_PASSWORD=openIM123
+MYSQL_PASSWORD=${MYSQL_PASSWORD}
+
+# ----- MongoDB Configuration -----
+# Address or hostname for the MongoDB service.
+# Default: MONGO_ADDRESS=172.28.0.1
+MONGO_ADDRESS=${MONGO_NETWORK_ADDRESS}
+
+# Port on which MongoDB service is running.
+# Default: MONGO_PORT=37017
+MONGO_PORT=${MONGO_PORT}
+
+# Username to authenticate with the MongoDB service.
+# Default: MONGO_USERNAME=root
+MONGO_USERNAME=${MONGO_USERNAME}
+
+# Password to authenticate with the MongoDB service.
+# Default: MONGO_PASSWORD=openIM123
+MONGO_PASSWORD=${MONGO_PASSWORD}
+
+# Name of the database in MongoDB to be used.
+# Default: MONGO_DATABASE=openIM_v3
+MONGO_DATABASE=${MONGO_DATABASE}
+
+# ----- Redis Configuration -----
+# Address or hostname for the Redis service.
+# Default: REDIS_ADDRESS=172.28.0.1
+REDIS_ADDRESS=${REDIS_NETWORK_ADDRESS}
+
+# Port on which Redis in-memory data structure store is running.
+# Default: REDIS_PORT=16379
+REDIS_PORT=${REDIS_PORT}
+
+# Password to authenticate with the Redis service.
+# Default: REDIS_PASSWORD=openIM123
+REDIS_PASSWORD=${REDIS_PASSWORD}
+
+# ----- Kafka Configuration -----
+# Address or hostname for the Kafka service.
+# Default: KAFKA_ADDRESS=172.28.0.1
+KAFKA_ADDRESS=${KAFKA_NETWORK_ADDRESS}
+
+# Port on which Kafka distributed streaming platform is running.
+# Default: KAFKA_PORT=19092
+KAFKA_PORT=${KAFKA_PORT}
+
+# Topic in Kafka for storing the latest messages in Redis.
+# Default: KAFKA_LATESTMSG_REDIS_TOPIC=latestMsgToRedis
+KAFKA_LATESTMSG_REDIS_TOPIC=${KAFKA_LATESTMSG_REDIS_TOPIC}
+
+# Topic in Kafka for pushing messages (e.g. notifications or updates).
+# Default: KAFKA_MSG_PUSH_TOPIC=msgToPush
+KAFKA_MSG_PUSH_TOPIC=${KAFKA_MSG_PUSH_TOPIC}
+
+# Topic in Kafka for storing offline messages in MongoDB.
+# Default: KAFKA_OFFLINEMSG_MONGO_TOPIC=offlineMsgToMongoMysql
+KAFKA_OFFLINEMSG_MONGO_TOPIC=${KAFKA_OFFLINEMSG_MONGO_TOPIC}
+
+# ----- MinIO Configuration ----
+# Address or hostname for the MinIO object storage service.
+# Default: MINIO_ADDRESS=172.28.0.1
+MINIO_ADDRESS=${MINIO_NETWORK_ADDRESS}
+
+# Port on which MinIO object storage service is running.
+# Default: MINIO_PORT=10005
+MINIO_PORT=${MINIO_PORT}
+
+# Access key to authenticate with the MinIO service.
+# Default: MINIO_ACCESS_KEY=root
+MINIO_ACCESS_KEY=${MINIO_ACCESS_KEY}
+
+# Secret key corresponding to the access key for MinIO authentication.
+# Default: MINIO_SECRET_KEY=openIM123
+MINIO_SECRET_KEY=${MINIO_SECRET_KEY}
+
+# ----- Prometheus Configuration -----
+# Address or hostname for the Prometheus service.
+# Default: PROMETHEUS_ADDRESS=172.28.0.1
+PROMETHEUS_ADDRESS=${PROMETHEUS_NETWORK_ADDRESS}
+
+# Port on which Prometheus service is running.
+# Default: PROMETHEUS_PORT=19090
+PROMETHEUS_PORT=${PROMETHEUS_PORT}
+
+# ----- Grafana Configuration -----
+# Address or hostname for the Grafana service.
+# Default: GRAFANA_ADDRESS=172.28.0.1
+GRAFANA_ADDRESS=${GRAFANA_NETWORK_ADDRESS}
+
+# Port on which Grafana service is running.
+# Default: GRAFANA_PORT=3000
+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}
+
+# Address or hostname for the OpenIM web service.
+# Default: OPENIM_WEB_ADDRESS=172.28.0.1
+OPENIM_WEB_ADDRESS=${OPENIM_WEB_NETWORK_ADDRESS}
+
+
+# ======================================
+# ========= OpenIM Server ==============
+# ======================================
+
+# Address or hostname for the OpenIM server.
+# Default: OPENIM_SERVER_ADDRESS=172.28.0.1
+OPENIM_SERVER_ADDRESS=${OPENIM_SERVER_NETWORK_ADDRESS}
+
+# Port for the OpenIM WebSockets.
+# Default: OPENIM_WS_PORT=10001
+OPENIM_WS_PORT=${OPENIM_WS_PORT}
+
+# Port for the OpenIM API.
+# Default: API_OPENIM_PORT=10002
+API_OPENIM_PORT=${API_OPENIM_PORT}
+
+
+# ======================================
+# ========== OpenIM Chat ===============
+# ======================================
+
+# Branch name for OpenIM chat.
+# Default: CHAT_BRANCH=main
+CHAT_BRANCH=${CHAT_BRANCH}
+
+# Address or hostname for the OpenIM chat service.
+# Default: OPENIM_CHAT_ADDRESS=172.28.0.1
+OPENIM_CHAT_ADDRESS=${OPENIM_CHAT_NETWORK_ADDRESS}
+
+# Port for the OpenIM chat API.
+# Default: OPENIM_CHAT_API_PORT=10008
+OPENIM_CHAT_API_PORT=${OPENIM_CHAT_API_PORT}
+
+# 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_DATA_DIR}
+
+
+# ======================================
+# ========== OpenIM Admin ==============
+# ======================================
+
+# Branch name for OpenIM server.
+# Default: SERVER_BRANCH=main
+SERVER_BRANCH=${SERVER_BRANCH}
+
+# Port for the OpenIM admin API.
+# Default: OPENIM_ADMIN_API_PORT=10009
+OPENIM_ADMIN_API_PORT=${OPENIM_ADMIN_API_PORT}

deployments/templates/init/README.md

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

deployments/templates/init/openim-api.service

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

deployments/templates/init/openim-cmdutils.service

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

deployments/templates/init/openim-crontask.service

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

deployments/templates/init/openim-msggateway.service

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

deployments/templates/init/openim-msgtransfer.service

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

deployments/templates/init/openim-push.service

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

deployments/templates/init/openim-rpc.service

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

deployments/templates/openim-api.yaml

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

deployments/templates/openim.yaml

@@ -0,0 +1,387 @@
+# 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
+# -----------------------------------------------------------------
+
+###################### Zookeeper ######################
+# Zookeeper configuration
+# It's not recommended to modify the schema
+# 
+# Zookeeper address
+# Zookeeper username
+# Zookeeper password
+zookeeper:
+  schema: ${ZOOKEEPER_SCHEMA}
+  address: [ ${ZOOKEEPER_ADDRESS}:${ZOOKEEPER_PORT} ]
+  username: ${ZOOKEEPER_USERNAME}
+  password: ${ZOOKEEPER_PASSWORD}
+
+###################### Mysql ######################
+# MySQL configuration
+# Currently, only single machine setup is supported
+#
+# Maximum number of open connections
+# Maximum number of idle connections
+# Maximum lifetime in seconds a connection can be reused
+# Log level: 1=slient, 2=error, 3=warn, 4=info
+# Slow query threshold in milliseconds
+mysql:
+  address: [ ${MYSQL_ADDRESS}:${MYSQL_PORT} ]
+  username: ${MYSQL_USERNAME}
+  password: ${MYSQL_PASSWORD}
+  database: ${MYSQL_DATABASE}
+  maxOpenConn: ${MYSQL_MAX_OPEN_CONN}
+  maxIdleConn: ${MYSQL_MAX_IDLE_CONN}
+  maxLifeTime: ${MYSQL_MAX_LIFETIME}
+  logLevel: ${MYSQL_LOG_LEVEL}
+  slowThreshold: ${MYSQL_SLOW_THRESHOLD}
+
+###################### Mongo ######################
+# MongoDB configuration
+# If uri is not empty, it will be used directly
+#
+# MongoDB address for standalone setup, Mongos address for sharded cluster setup
+# Default MongoDB database name
+# Maximum connection pool size
+mongo:
+  uri: ${MONGO_URI}
+  address: [ ${MONGO_ADDRESS}:${MONGO_PORT} ]
+  database: ${MONGO_DATABASE}
+  username: ${MONGO_USERNAME}
+  password: ${MONGO_PASSWORD}
+  maxPoolSize: ${MONGO_MAX_POOL_SIZE}
+
+###################### Redis configuration information ######################
+# Redis configuration
+#
+# Username is required only for Redis version 6.0+
+redis:
+  address: [ ${REDIS_ADDRESS}:${REDIS_PORT} ]
+  username: ${REDIS_USERNAME}
+  password: ${REDIS_PASSWORD}
+
+###################### 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: ${KAFKA_USERNAME}
+  password: ${KAFKA_PASSWORD}
+  addr: [ ${KAFKA_ADDRESS}:${KAFKA_PORT} ]
+  latestMsgToRedis:
+    topic: "${KAFKA_LATESTMSG_REDIS_TOPIC}"
+  offlineMsgToMongo:
+    topic: "${KAFKA_OFFLINEMSG_MONGO_TOPIC}"
+  msgToPush:
+    topic: "${KAFKA_MSG_PUSH_TOPIC}"
+  consumerGroupID:
+    msgToRedis: ${KAFKA_CONSUMERGROUPID_REDIS}
+    msgToMongo: ${KAFKA_CONSUMERGROUPID_MONGO}
+    msgToMySql: ${KAFKA_CONSUMERGROUPID_MYSQL}
+    msgToPush: ${KAFKA_CONSUMERGROUPID_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: ${RPC_REGISTER_IP}
+  listenIP: ${RPC_LISTEN_IP}
+
+###################### API configuration information ######################
+# API configuration
+#
+# API service port
+# Default listen IP is 0.0.0.0
+api:
+  openImApiPort: [ ${API_OPENIM_PORT} ]
+  listenIP: ${API_LISTEN_IP}
+
+###################### 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: "${OBJECT_ENABLE}"
+  apiURL: "${OBJECT_APIURL}"
+  minio:
+    bucket: "${MINIO_BUCKET}"
+    endpoint: "${MINIO_ENDPOINT}"
+    accessKeyID: "${MINIO_ACCESS_KEY}"
+    secretAccessKey: "${MINIO_SECRET_KEY}"
+    sessionToken: ${MINIO_SESSION_TOKEN}
+    signEndpoint: "${MINIO_SIGN_ENDPOINT}"
+  cos:
+    bucketURL: ${COS_BUCKET_URL}
+    secretID: ${COS_SECRET_ID}
+    secretKey: ${COS_SECRET_KEY}
+    sessionToken: ${COS_SESSION_TOKEN}
+  oss:
+    endpoint: "${OSS_ENDPOINT}"
+    bucket: "${OSS_BUCKET}"
+    bucketURL: "${OSS_BUCKET_URL}"
+    accessKeyID: ${OSS_ACCESS_KEY_ID}
+    accessKeySecret: ${OSS_ACCESS_KEY_SECRET}
+    sessionToken: ${OSS_SESSION_TOKEN}
+
+
+###################### 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: [ ${OPENIM_USER_PORT} ]
+  openImFriendPort: [ ${OPENIM_FRIEND_PORT} ]
+  openImMessagePort: [ ${OPENIM_MESSAGE_PORT} ]
+  openImMessageGatewayPort: [ ${OPENIM_MESSAGE_GATEWAY_PORT} ]
+  openImGroupPort: [ ${OPENIM_GROUP_PORT} ]
+  openImAuthPort: [ ${OPENIM_AUTH_PORT} ]
+  openImPushPort: [ ${OPENIM_PUSH_PORT} ]
+  openImConversationPort: [ ${OPENIM_CONVERSATION_PORT} ]
+  openImThirdPort: [ ${OPENIM_THIRD_PORT} ]
+
+###################### RPC Register Name Configuration ######################
+# RPC service names for registration, it's not recommended to modify these
+rpcRegisterName:
+  openImUserName: ${OPENIM_USER_NAME}
+  openImFriendName: ${OPENIM_FRIEND_NAME}
+  openImMsgName: ${OPENIM_MSG_NAME}
+  openImPushName: ${OPENIM_PUSH_NAME}
+  openImMessageGatewayName: ${OPENIM_MESSAGE_GATEWAY_NAME}
+  openImGroupName: ${OPENIM_GROUP_NAME}
+  openImAuthName: ${OPENIM_AUTH_NAME}
+  openImConversationName: ${OPENIM_CONVERSATION_NAME}
+  openImThirdName: ${OPENIM_THIRD_NAME}
+
+###################### 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: ${LOG_STORAGE_LOCATION}
+  rotationTime: ${LOG_ROTATION_TIME}
+  remainRotationCount: ${LOG_REMAIN_ROTATION_COUNT}
+  remainLogLevel: ${LOG_REMAIN_LOG_LEVEL}
+  isStdout: ${LOG_IS_STDOUT}
+  isJson: ${LOG_IS_JSON}
+  withStack: ${LOG_WITH_STACK}
+
+###################### 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: [ ${OPENIM_WS_PORT} ]
+  websocketMaxConnNum: ${WEBSOCKET_MAX_CONN_NUM}
+  websocketMaxMsgLen: ${WEBSOCKET_MAX_MSG_LEN}
+  websocketTimeout: ${WEBSOCKET_TIMEOUT}
+
+# 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: ${PUSH_ENABLE}
+  geTui:
+    pushUrl: "${GETUI_PUSH_URL}"
+    masterSecret: ""
+    appKey: ""
+    intent: ""
+    channelID: ""
+    channelName: ""
+  fcm:
+    serviceAccount: "${FCM_SERVICE_ACCOUNT}"
+  jpns:
+    appKey:
+    masterSecret:
+    pushUrl:
+    pushIntent:
+
+# App manager configuration
+#
+# Built-in app manager user IDs
+# Built-in app manager nicknames
+manager:
+  userID: [ "${MANAGER_USERID_1}", "${MANAGER_USERID_2}", "${MANAGER_USERID_3}" ]
+  nickname: [ "${NICKNAME_1}", "${NICKNAME_2}", "${NICKNAME_3}" ]
+
+# Multi-platform login policy
+# For each platform(Android, iOS, Windows, Mac, web), only one can be online at a time
+multiLoginPolicy: ${MULTILOGIN_POLICY}
+
+# Whether to store messages in MySQL, messages in MySQL are only used for management background
+chatPersistenceMysql: ${CHAT_PERSISTENCE_MYSQL}
+
+# Message cache timeout in seconds, it's not recommended to modify
+msgCacheTimeout: ${MSG_CACHE_TIMEOUT}
+
+# Whether to enable read receipts for group chat
+groupMessageHasReadReceiptEnable: ${GROUP_MSG_READ_RECEIPT}
+
+# Whether to enable read receipts for single chat
+singleMessageHasReadReceiptEnable: ${SINGLE_MSG_READ_RECEIPT}
+
+# MongoDB offline message retention period in days
+retainChatRecords: ${RETAIN_CHAT_RECORDS}
+
+# 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: "${CHAT_RECORDS_CLEAR_TIME}"
+
+# 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: "${MSG_DESTRUCT_TIME}"
+
+# Secret key
+secret: ${SECRET}
+
+# Token policy
+#
+# Token expiration period in days
+tokenPolicy:
+  expire: ${TOKEN_EXPIRE}
+
+# 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
+  afterSendSingleMsg:
+    enable: false
+    timeout: 5
+  beforeSendGroupMsg:
+    enable: false
+    timeout: 5
+    failedContinue: true
+  afterSendGroupMsg:
+    enable: false
+    timeout: 5
+  msgModify:
+    enable: false
+    timeout: 5
+    failedContinue: true
+  userOnline:
+    enable: false
+    timeout: 5
+  userOffline:
+    enable: false
+    timeout: 5
+  userKickOff:
+    enable: false
+    timeout: 5
+  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
+  beforeCreateGroup:
+    enable: false
+    timeout: 5
+    failedContinue: true
+  beforeMemberJoinGroup:
+    enable: false
+    timeout: 5
+    failedContinue: true
+  beforeSetGroupMemberInfo:
+    enable: false
+    timeout: 5
+    failedContinue: true
+  setMessageReactionExtensions:
+    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: ${PROMETHEUS_ENABLE}
+  userPrometheusPort: [ ${USER_PROM_PORT} ]
+  friendPrometheusPort: [ ${FRIEND_PROM_PORT} ]
+  messagePrometheusPort: [ ${MESSAGE_PROM_PORT} ]
+  messageGatewayPrometheusPort: [ ${MSG_GATEWAY_PROM_PORT} ]
+  groupPrometheusPort: [ ${GROUP_PROM_PORT} ]
+  authPrometheusPort: [ ${AUTH_PROM_PORT} ]
+  pushPrometheusPort: [ ${PUSH_PROM_PORT} ]
+  conversationPrometheusPort: [ ${CONVERSATION_PROM_PORT} ]
+  rtcPrometheusPort: [ ${RTC_PROM_PORT} ]
+  thirdPrometheusPort: [ ${THIRD_PROM_PORT} ]
+  messageTransferPrometheusPort: [ ${MSG_TRANSFER_PROM_PORT} ] # List of ports

docker-compose.yaml

@@ -1,170 +0,0 @@
-#fixme  Clone openIM Server project before using docker-compose,project address：https://github.com/OpenIMSDK/Open-IM-Server.git
-version: "3"
-services:
-  mysql:
-    image: mysql:5.7
-    ports:
-      - 13306:3306
-      - 23306:33060
-    container_name: mysql
-    volumes:
-      - ${DATA_DIR}/components/mysql/data:/var/lib/mysql
-      - /etc/localtime:/etc/localtime
-    environment:
-      MYSQL_ROOT_PASSWORD: ${PASSWORD}
-    restart: always
-
-  mongodb:
-    image: mongo:6.0.2
-    ports:
-      - 37017:27017
-    container_name: mongo
-    command: --wiredTigerCacheSizeGB 1 --auth
-    volumes:
-      - ${DATA_DIR}/components/mongodb/data/db:/data/db
-      - ${DATA_DIR}/components/mongodb/data/logs:/data/logs
-      - ${DATA_DIR}/components/mongodb/data/conf:/etc/mongo
-      - ./scripts/mongo-init.sh:/docker-entrypoint-initdb.d/mongo-init.sh:ro
-    environment:
-      - TZ=Asia/Shanghai
-      # cache
-      - wiredTigerCacheSizeGB=1
-      - MONGO_INITDB_ROOT_USERNAME=${USER}
-      - MONGO_INITDB_ROOT_PASSWORD=${PASSWORD}
-      - MONGO_INITDB_DATABASE=openIM
-      - MONGO_USERNAME=${USER}
-      - MONGO_PASSWORD=${PASSWORD}
-    restart: always
-
-  redis:
-    image: redis:7.0.0
-    ports:
-      - 16379:6379
-    container_name: redis
-    volumes:
-      - ${DATA_DIR}/components/redis/data:/data
-      #redis config file
-      - ${DATA_DIR}/components/redis/config/redis.conf:/usr/local/redis/config/redis.conf
-    environment:
-      TZ: Asia/Shanghai
-    restart: always
-    sysctls:
-      net.core.somaxconn: 1024
-    command: redis-server --requirepass ${PASSWORD} --appendonly yes
-
-  zookeeper:
-    image: wurstmeister/zookeeper
-    ports:
-      - 2181:2181
-    container_name: zookeeper
-    volumes:
-      - /etc/localtime:/etc/localtime
-    environment:
-      TZ: Asia/Shanghai
-    restart: always
-
-  kafka:
-    image: wurstmeister/kafka
-    container_name: kafka
-    restart: always
-    ports:
-      - 9092:9092
-    environment:
-      TZ: Asia/Shanghai
-      KAFKA_BROKER_ID: 0
-      KAFKA_ZOOKEEPER_CONNECT: zookeeper:2181
-      KAFKA_CREATE_TOPICS: "latestMsgToRedis:8:1,msgToPush:8:1,offlineMsgToMongoMysql:8:1"
-      KAFKA_ADVERTISED_LISTENERS: INSIDE://127.0.0.1:9092,OUTSIDE://103.116.45.174:9092
-      KAFKA_LISTENERS: INSIDE://:9092,OUTSIDE://:9093
-      KAFKA_LISTENER_SECURITY_PROTOCOL_MAP: "INSIDE:PLAINTEXT,OUTSIDE:PLAINTEXT"
-      KAFKA_INTER_BROKER_LISTENER_NAME: INSIDE
-    depends_on:
-      - zookeeper
-
-  minio:
-    image: minio/minio
-    ports:
-      - 10005:9000
-      - 9090:9090
-    container_name: minio
-    volumes:
-      - /mnt/data:/data
-      - /mnt/config:/root/.minio
-    environment:
-      MINIO_ROOT_USER: ${USER}
-      MINIO_ROOT_PASSWORD: ${PASSWORD}
-    restart: always
-    command: minio server /data --console-address ':9090'
-
-  openim-server:
-    image: ghcr.io/openimsdk/openim-server:latest
-    container_name: openim-server
-    volumes:
-      - ./logs:/openim/openim-server/logs
-      - ./config:/openim/openim-server/config
-      - ./scripts:/openim/openim-server/scripts
-    restart: always
-    depends_on:
-      - zookeeper
-      - kafka
-      - mysql
-      - mongodb
-      - redis
-      - minio
-    network_mode: "host"
-    logging:
-      driver: json-file
-      options:
-        max-size: "1g"
-        max-file: "2"
-
-  openim-chat:
-    image: ghcr.io/openimsdk/openim-chat:latest
-    container_name: openim-chat
-    volumes:
-      - ./_output/openim/openim-chat/logs:/openim/openim-chat/logs
-      - ./_output/openim/openim-chat/config:/openim/openim-chat/config
-      - ./_output/openim/openim-chat/scripts:/openim/openim-chat/scripts
-    restart: always
-    depends_on:
-      - mysql
-      - mongodb
-      - redis
-      - minio
-      - openim-server
-    network_mode: "host"
-    logging:
-      driver: json-file
-      options:
-        max-size: "1g"
-        max-file: "2"
-
-  prometheus:
-    image: prom/prometheus
-    volumes:
-      - ./.docker-compose_cfg/prometheus-compose.yml:/etc/prometheus/prometheus.yml
-    container_name: prometheus
-    #    ports:
-    #    - 9091:9091
-    depends_on:
-    - openim-server
-    command: --web.listen-address=:9091 --config.file="/etc/prometheus/prometheus.yml"
-    network_mode: "host"
-
-  grafana:
-    image: grafana/grafana
-    volumes:
-      - ./.docker-compose_cfg/datasource-compose.yaml:/etc/grafana/provisioning/datasources/datasource.yaml
-      - ./.docker-compose_cfg/grafana.ini:/etc/grafana/grafana.ini
-      - ./.docker-compose_cfg/node-exporter-full_rev1.json:/var/lib/grafana/dashboards/node-exporter-full_rev1.json
-    container_name: grafana
-    depends_on:
-      - prometheus
-    network_mode: "host"
-
-  # node-exporter:
-  #   image: quay.io/prometheus/node-exporter
-  #   container_name: node-exporter
-  #   restart: always
-  #   ports:
-  #     - "9100:9100"

docker-compose.yml

@@ -0,0 +1,267 @@
+#fixme  Clone openIM Server project before using docker-compose,project address：https://github.com/OpenIMSDK/Open-IM-Server.git
+version: '3'
+
+networks:
+  server:
+    driver: bridge
+    ipam:
+      driver: default
+      config:
+        - subnet: '${DOCKER_BRIDGE_SUBNET}'
+          gateway: '${DOCKER_BRIDGE_GATEWAY}'
+
+volumes:
+  mysql_data:
+  mongodb_data:
+  mongodb_logs:
+  mongodb_config:
+  redis_data:
+  redis_config:
+  kafka_data:
+  minio_data:
+  minio_config:
+  openim_server_logs:
+  openim_server_output:
+  openim_server_config:
+  openim_server_scripts:
+  openim_chat_logs:
+  openim_chat_output:
+  openim_chat_config:
+  openim_chat_scripts:
+  openim_server_prometheus_config:
+  openim_server_grafana_datasource:
+  openim_server_grafana_config:
+  openim_server_grafana_dashboard:
+
+services:
+  mysql:
+    image: mysql:5.7
+    ports:
+      - "${MYSQL_PORT}:3306"
+    container_name: mysql
+    volumes:
+      - mysql_data:/var/lib/mysql
+      - "/etc/localtime:/etc/localtime"
+    environment:
+      MYSQL_ROOT_PASSWORD: "${MYSQL_PASSWORD}"
+    restart: always
+    networks:
+      server:
+        ipv4_address: ${MYSQL_NETWORK_ADDRESS}
+
+  mongodb:
+    image: mongo:6.0.2
+    ports:
+      - "${MONGO_PORT}:27017"
+    container_name: mongo
+    command: --wiredTigerCacheSizeGB 1 --auth
+    volumes:
+      - mongodb_data:/data/db
+      - mongodb_logs:/data/logs
+      - mongodb_config:/etc/mongo
+      - "./scripts/mongo-init.sh:/docker-entrypoint-initdb.d/mongo-init.sh:ro"
+    environment:
+      - TZ=Asia/Shanghai
+      - wiredTigerCacheSizeGB=1
+      - MONGO_INITDB_ROOT_USERNAME=${MONGO_USERNAME}
+      - MONGO_INITDB_ROOT_PASSWORD=${MONGO_PASSWORD}
+      - MONGO_INITDB_DATABASE=${MONGO_DATABASE}
+    restart: always
+    networks:
+      server:
+        ipv4_address: ${MONGO_NETWORK_ADDRESS}
+
+  redis:
+    image: redis:7.0.0
+    container_name: redis
+    ports:
+      - "${REDIS_PORT}:6379"
+    volumes:
+      - redis_data:/data
+      - redis_config:/usr/local/redis/config/redis.conf
+    environment:
+      TZ: Asia/Shanghai
+    restart: always
+    sysctls:
+      net.core.somaxconn: 1024
+    command: redis-server --requirepass ${REDIS_PASSWORD} --appendonly yes
+    networks:
+      server:
+        ipv4_address: ${REDIS_NETWORK_ADDRESS}
+
+  zookeeper:
+   image: bitnami/zookeeper:3.8
+   container_name: zookeeper
+   ports:
+    - "${ZOOKEEPER_PORT}:2181"
+   volumes:
+     - "/etc/localtime:/etc/localtime"
+   environment:
+     - ALLOW_ANONYMOUS_LOGIN=yes
+     - TZ="Asia/Shanghai"
+   restart: always
+   networks:
+      server:
+        ipv4_address: ${ZOOKEEPER_NETWORK_ADDRESS}
+
+  kafka:
+    image: 'bitnami/kafka:3.5.1'
+    container_name: kafka
+    user: root
+    restart: always
+    ports:
+    - "${KAFKA_PORT}:9094"
+    volumes:
+      - ./scripts/create_topic.sh:/opt/bitnami/kafka/create_topic.sh
+      - ${DATA_DIR}/components/kafka:/bitnami/kafka
+    command: >
+      bash -c "
+      /opt/bitnami/scripts/kafka/run.sh & sleep 5; /opt/bitnami/kafka/create_topic.sh; wait
+      "
+    extra_hosts:
+      - "host.docker.internal:host-gateway"
+    environment:
+       - TZ=Asia/Shanghai
+       - KAFKA_CFG_NODE_ID=0
+       - KAFKA_CFG_PROCESS_ROLES=controller,broker
+       - 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}:${KAFKA_PORT}
+       - KAFKA_CFG_LISTENER_SECURITY_PROTOCOL_MAP=CONTROLLER:PLAINTEXT,EXTERNAL:PLAINTEXT,PLAINTEXT:PLAINTEXT
+       - KAFKA_CFG_CONTROLLER_LISTENER_NAMES=CONTROLLER
+    networks:
+      server:
+        ipv4_address: ${KAFKA_NETWORK_ADDRESS}
+
+  minio:
+    image: minio/minio
+    ports:
+      - "${MINIO_PORT}:9000"
+      - "9090:9090"
+    container_name: minio
+    volumes:
+      - minio_data:/data
+      - minio_config:/root/.minio
+    environment:
+      MINIO_ROOT_USER: "${MINIO_ACCESS_KEY}"
+      MINIO_ROOT_PASSWORD: "${MINIO_SECRET_KEY}"
+    restart: always
+    command: minio server /data --console-address ':9090'
+    networks:
+      server:
+        ipv4_address: ${MINIO_NETWORK_ADDRESS}
+
+  openim-web:
+    image: ghcr.io/openimsdk/openim-web:latest
+    container_name: openim-web
+    environment:
+      - OPENIM_WEB_DIST_PATH=${OPENIM_WEB_DIST_PATH}
+      - OPENIM_WEB_PORT=${OPENIM_WEB_PORT}
+    restart: always
+    ports:
+      - "${OPENIM_WEB_PORT}:11001"
+    networks:
+      server:
+        ipv4_address: ${OPENIM_WEB_NETWORK_ADDRESS}
+
+  openim-server:
+    # image: ghcr.io/openimsdk/openim-server:main
+    image: registry.cn-hangzhou.aliyuncs.com/openimsdk/openim-server:main
+    # image: openim/openim-server:main
+#    build: .
+    container_name: openim-server
+    ports:
+      - ${OPENIM_WS_PORT}:10001
+      - ${API_OPENIM_PORT}:10002
+    healthcheck:
+      test: ["CMD", "/openim/openim-server/scripts/check-all.sh"]
+      interval: 300s
+      timeout: 10s
+      retries: 5
+    volumes:
+      - ./logs:/openim/openim-server/logs
+      - ./_output:/openim/openim-server/_output
+      - ./config:/openim/openim-server/config
+      - ./scripts:/openim/openim-server/scripts
+    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}
+
+  # openim-chat:
+  #   # image: ghcr.io/openimsdk/openim-chat:main
+  #   image: registry.cn-hangzhou.aliyuncs.com/openimsdk/openim-chat:main
+  #   # image: ghcr.io/openimsdk/openim-chat:main
+  #   container_name: openim-chat
+  #   healthcheck:
+  #     test: ["CMD", "/openim/openim-chat/scripts/check_all.sh"]
+  #     interval: 300s
+  #     timeout: 10s
+  #     retries: 5
+  #   ports:
+  #     - ${OPENIM_CHAT_API_PORT}:10008
+  #     - ${OPENIM_ADMIN_API_PORT}:10009
+  #   volumes:
+  #     - openim_chat_logs:/openim/openim-chat/logs
+  #     - openim_chat_output:/openim/openim-chat/_output
+  #     - openim_chat_config:/openim/openim-chat/config
+  #     - openim_chat_scripts:/openim/openim-chat/scripts
+  #   restart: always
+  #   user: root:root
+  #   depends_on:
+  #     - mysql
+  #     - mongodb
+  #     - redis
+  #     - minio
+  #     - server
+  #   logging:
+  #     driver: json-file
+  #     options:
+  #       max-size: "1g"
+  #       max-file: "2"
+  #   networks:
+  #     server:
+  #       ipv4_address: ${OPENIM_CHAT_NETWORK_ADDRESS}
+
+  # prometheus:
+  #   image: prom/prometheus
+  #   volumes:
+  #     - openim_server_prometheus_config:/etc/prometheus
+  #   container_name: prometheus
+  #   ports:
+  #     - ${PROMETHEUS_PORT}:9091
+  #   command: --web.listen-address=:9091 --config.file="/etc/prometheus"
+  #   networks:
+  #     server:
+  #       ipv4_address: ${PROMETHEUS_NETWORK_ADDRESS}
+
+  # grafana:
+  #   image: grafana/grafana
+  #   volumes:
+  #     - openim_server_grafana_datasource:/etc/grafana/provisioning/datasources
+  #     - openim_server_grafana_config:/etc/grafana
+  #     - openim_server_grafana_dashboard:/var/lib/grafana/dashboards
+  #   container_name: grafana
+  #   ports:
+  #     - ${GRAFANA_PORT}:3000
+  #   networks:
+  #     server:
+  #       ipv4_address: ${GRAFANA_NETWORK_ADDRESS}
+
+  # node-exporter:
+  #   image: quay.io/prometheus/node-exporter
+  #   container_name: node-exporter
+  #   restart: always
+  #   ports:
+  #     - "9100:9100"

docs/.generated_docs

@@ -44,10 +44,6 @@ docs/guide/en-US/yaml/openim/openim_set.yaml
 docs/guide/en-US/yaml/openim/openim-rpc-user.yaml
 docs/guide/en-US/yaml/openim/openim_validate.yaml
 docs/guide/en-US/yaml/openim/openim_version.yaml
-docs/man/man1/iam-apiserver.1
-docs/man/man1/iam-authz-server.1
-docs/man/man1/iam-pump.1
-docs/man/man1/iam-watcher.1
 docs/man/man1/openim-color.1
 docs/man/man1/openim-completion.1
 docs/man/man1/openim-info.1

docs/CODEOWNERS

@@ -64,12 +64,11 @@ cmd/*
 # config directory
 config/*    @skiffer-git
 
-# db directory
-db/sdk  @cubxxw @FGadvancer  
-
 # internal directory
 internal/ @openimsdk/openim @skiffer-git @FGadvancer
 
+tools @openimsdk/openim @openimsdk/bot @cubxxw @skiffer-git @FGadvancer
+
 # logs directory
 logs/*  @skiffer-git @FGadvancer
 
@@ -77,7 +76,7 @@ logs/*  @skiffer-git @FGadvancer
 pkg/a2r  @openimsdk/openim @skiffer-git @cubxxw @openimsdk/bot
 
 # scripts directory
-scripts/LICENSE/*   @openimsdk/openim @cubxxw @skiffer-git @FGadvancer
+scripts/template/*   @openimsdk/openim @cubxxw @skiffer-git @FGadvancer
 scripts/enterprise/*  @openimsdk/openim @FGadvancer @cubxxw @skiffer-git @openimsdk/bot
 scripts/githooks/*   @openimsdk/openim @cubxxw @skiffer-git @FGadvancer
 scripts/lib/*   @openimsdk/openim @FGadvancer @cubxxw @skiffer-git @openimsdk/bot

docs/contrib/git_cherry-pick.md

@@ -0,0 +1,177 @@
+# Git Cherry-Pick Guide
+
+- Git Cherry-Pick Guide
+  - [Introduction](#introduction)
+  - [What is git cherry-pick?](#what-is-git-cherry-pick)
+  - [Using git cherry-pick](#using-git-cherry-pick)
+  - [Applying Multiple Commits](#applying-multiple-commits)
+  - [Configurations](#configurations)
+  - [Handling Conflicts](#handling-conflicts)
+  - [Applying Commits from Another Repository](#applying-commits-from-another-repository)
+
+## Introduction
+
+Author: @cubxxw
+
+As OpenIM has progressively embarked on a standardized path, I've had the honor of initiating a significant project, `git cherry-pick`. While some may see it as merely a naming convention in the Go language, it represents more. It's a thoughtful design within the OpenIM project, my very first conscious design, and a first in laying out an extensive collaboration process and copyright management with goals of establishing a top-tier community standard.
+
+## What is git cherry-pick?
+
+In multi-branch repositories, transferring commits from one branch to another is common. You can either merge all changes from one branch (using `git merge`) or selectively apply certain commits. This selective application of commits is where `git cherry-pick` comes into play.
+
+Our collaboration strategy with GitHub necessitates maintenance of multiple `release-v*` branches alongside the `main` branch. To manage this, we mainly develop on the `main` branch and selectively merge into `release-v*` branches. This ensures the `main` branch stays current while the `release-v*` branches remain stable.
+
+Ensuring this strategy's success extends beyond just documentation; it hinges on well-engineered solutions and automation tools, like Makefile, powerful CI/CD processes, and even Prow.
+
+## Prerequisites
+
+- [Contributor License Agreement](https://github.com/openim-sigs/cla) is considered implicit for all code within cherry pick pull requests, **unless there is a large conflict**.
+- A pull request merged against the `main` branch.
+- The release branch exists (example: [`release-1.18`](https://github.com/OpenIMSDK/Open-IM-Server/tree/release-v3.1))
+- The normal git and GitHub configured shell environment for pushing to your openim-server `origin` fork on GitHub and making a pull request against a configured remote `upstream` that tracks `https://github.com/OpenIMSDK/Open-IM-Server.git`, including `GITHUB_USER`.
+- Have GitHub CLI (`gh`) installed following [installation instructions](https://github.com/cli/cli#installation).
+- A github personal access token which has permissions "repo" and "read:org". Permissions are required for [gh auth login](https://cli.github.com/manual/gh_auth_login) and not used for anything unrelated to cherry-pick creation process (creating a branch and initiating PR).
+
+## What Kind of PRs are Good for Cherry Picks
+
+Compared to the normal main branch's merge volume across time, the release branches see one or two orders of magnitude less PRs. This is because there is an order or two of magnitude higher scrutiny. Again, the emphasis is on critical bug fixes, e.g.,
+
+- Loss of data
+- Memory corruption
+- Panic, crash, hang
+- Security
+
+A bugfix for a functional issue (not a data loss or security issue) that only affects an alpha feature does not qualify as a critical bug fix.
+
+If you are proposing a cherry pick and it is not a clear and obvious critical bug fix, please reconsider. If upon reflection you wish to continue, bolster your case by supplementing your PR with e.g.,
+
+- A GitHub issue detailing the problem
+- Scope of the change
+- Risks of adding a change
+- Risks of associated regression
+- Testing performed, test cases added
+- Key stakeholder SIG reviewers/approvers attesting to their confidence in the change being a required backport
+
+If the change is in cloud provider-specific platform code (which is in the process of being moved out of core openim-server), describe the customer impact, how the issue escaped initial testing, remediation taken to prevent similar future escapes, and why the change cannot be carried in your downstream fork of the openim-server project branches.
+
+It is critical that our full community is actively engaged on enhancements in the project. If a released feature was not enabled on a particular provider's platform, this is a community miss that needs to be resolved in the `main` branch for subsequent releases. Such enabling will not be backported to the patch release branches.
+
+## Initiate a Cherry Pick
+
+### Before you begin
+
+- Plan to initiate a cherry-pick against *every* supported release branch. If you decide to skip some release branch, explain your decision in a comment to the PR being cherry-picked.
+- Initiate cherry-picks in order, from newest to oldest supported release branches. For example, if 3.1 is the newest supported release branch, then, before cherry-picking to 2.25, make sure the cherry-pick PR already exists for in 2.26 and 3.1. This helps to prevent regressions as a result of an upgrade to the next release.
+
+### Steps
+
+- Run the [cherry pick script](https://github.com/OpenIMSDK/Open-IM-Server/tree/main/scripts/cherry-pick.sh)
+
+  This example applies a main branch PR #98765 to the remote branch `upstream/release-v3.1`:
+
+  ```
+  scripts/cherry-pick.sh upstream/release-v3.1 98765
+  ```
+
+  - 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/openim-server/community/blob/main/contributors/guide/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/openim-server/website/blob/main/content/en/releases/patch-releases.md#detailed-release-history-for-active-branches) release branches where the fix is applicable.
+
+  - If `GITHUB_TOKEN` is not set you will be asked for your github password: provide the github [personal access token](https://github.com/settings/tokens) rather than your actual github password. If you can securely set the environment variable `GITHUB_TOKEN` to your personal access token then you can avoid an interactive prompt. Refer [mislav/hub#2655 (comment)](https://github.com/mislav/hub/issues/2655#issuecomment-735836048)
+
+- Your cherry pick PR will immediately get the `do-not-merge/cherry-pick-not-approved` label.
+
+  [Normal rules apply for code merge](https://github.com/openim-server/community/blob/main/contributors/devel/sig-release/release.md#tldr), with some additional caveats outlined in the next section of this document.
+
+## Cherry Pick Review
+
+As with any other PR, code OWNERS review (`/lgtm`) and approve (`/approve`) on cherry pick PRs as they deem appropriate.
+
+The same release note requirements apply as normal pull requests, except the release note stanza will auto-populate from the main branch pull request from which the cherry pick originated.
+
+
+## Using git cherry-pick
+
+`git cherry-pick` applies specified commits from one branch to another.
+
+```bash
+$ git cherry-pick <commitHash>
+```
+
+As an example, consider a repository with `main` and `release-v3.1` branches. To apply commit `f` from the `release-v3.1` branch to the `main` branch:
+
+```
+# Switch to main branch
+$ git checkout main
+
+# Perform cherry-pick
+$ git cherry-pick f
+```
+
+You can also use a branch name instead of a commit hash to cherry-pick the latest commit from that branch.
+
+```bash
+$ git cherry-pick release-v3.1
+```
+
+## Applying Multiple Commits
+
+To apply multiple commits simultaneously:
+
+```bash
+$ git cherry-pick <HashA> <HashB>
+```
+
+To apply a range of consecutive commits:
+
+```bash
+$ git cherry-pick <HashA>..<HashB>
+```
+
+## Configurations
+
+Here are some commonly used configurations for `git cherry-pick`:
+
+- **`-e`, `--edit`**: Open an external editor to modify the commit message.
+- **`-n`, `--no-commit`**: Update the working directory and staging area without creating a new commit.
+- **`-x`**: Append a reference in the commit message for tracking the source of the cherry-picked commit.
+- **`-s`, `--signoff`**: Add a sign-off message at the end of the commit indicating who performed the cherry-pick.
+- **`-m parent-number`, `--mainline parent-number`**: When the original commit is a merge of two branches, specify which parent branch's changes should be used.
+
+## Handling Conflicts
+
+If conflicts arise during the cherry-pick:
+
+- **`--continue`**: After resolving conflicts, stage the changes with `git add .` and then continue the cherry-pick process.
+- **`--abort`**: Abandon the cherry-pick and revert to the previous state.
+- **`--quit`**: Exit the cherry-pick without reverting to the previous state.
+
+## Applying Commits from Another Repository
+
+You can also cherry-pick commits from another repository:
+
+1. Add the external repository as a remote:
+
+   ```
+   $ git remote add target git://gitUrl
+   ```
+
+2. Fetch the commits from the remote:
+
+   ```
+   $ git fetch target
+   ```
+
+3. Identify the commit hash you wish to cherry-pick:
+
+   ```
+   $ git log target/main
+   ```
+
+4. Perform the cherry-pick:
+
+   ```
+   $ git cherry-pick <commitHash>
+   ```

docs/contrib/init_config.md

@@ -0,0 +1,74 @@
+# Init OpenIM Config
+
+- [Init OpenIM Config](#init-openim-config)
+  - [Start](#start)
+  - [Define Automated Configuration](#define-automated-configuration)
+  - [Define Configuration Variables](#define-configuration-variables)
+    - [Bash Parsing Features](#bash-parsing-features)
+  - [Reasons and Advantages of the Design](#reasons-and-advantages-of-the-design)
+
+
+##  Start
+
+With the increasing complexity of software engineering, effective configuration management has become more and more important. Yaml and other configuration files provide the necessary parameters and guidance for systems, but they also impose additional management overhead for developers. This article explores how to automate and optimize configuration management, thereby improving efficiency and reducing the chances of errors.
+
+First, obtain the OpenIM code through the contributor documentation and initialize it following the steps below.
+
+## Define Automated Configuration
+
+We no longer strongly recommend modifying the same configuration file. If you have a new configuration file related to your business, we suggest generating and managing it through automation.
+
+In the `scripts/init_config.sh` file, we defined some template files. These templates will be automatically generated to the corresponding directories when executing `make init`.
+
+```
+# 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"
+)
+```
+
+If you have your new mapping files, you can implement them by appending them to the array.
+
+Lastly, run:
+
+```
+./scripts/init_config.sh
+```
+
+## Define Configuration Variables
+
+In the `scripts/install/environment.sh` file, we defined many reusable variables for automation convenience.
+
+In the provided example, the def function is a core element. This function not only provides a concise way to define variables but also offers default value options for each variable. This way, even if a specific variable is not explicitly set in an environment or scenario, it can still have an expected value.
+
+```
+function def() {
+    local var_name="$1"
+    local default_value="$2"
+    eval "readonly $var_name=\${$var_name:-$default_value}"
+}
+```
+
+### Bash Parsing Features
+
+Since bash is a parsing script language, it executes commands in the order they appear in the script. This characteristic means we can define commonly used or core variables at the beginning of the script and then reuse or modify them later on.
+
+For instance, we can initially set a universal password and reuse this password in subsequent variable definitions.
+
+```
+# Set a consistent password for easy memory
+def "PASSWORD" "openIM123"
+
+# Linux system user for openim
+def "LINUX_USERNAME" "openim"
+def "LINUX_PASSWORD" "${PASSWORD}"
+```
+
+## Reasons and Advantages of the Design
+
+1. **Simplify Configuration Management**: Through automation scripts, we can avoid manual operations and configurations, thus reducing tedious repetitive tasks.
+2. **Reduce Errors**: Manually editing yaml or other configuration files can lead to formatting mistakes or typographical errors. Automating with scripts can lower the risk of such errors.
+3. **Enhanced Readability**: Using the `def` function and other bash scripting techniques, we can establish a clear, easy-to-read, and maintainable configuration system.
+4. **Improved Reusability**: As demonstrated above, we can reuse variables and functions in different parts of the script, reducing redundant code and increasing overall consistency.
+5. **Flexible Default Value Mechanism**: By providing default values for variables, we can ensure configurations are complete and consistent across various scenarios, while also offering customization options for advanced users.

docs/contrib/install_docker.md

@@ -0,0 +1,45 @@
+# Install Docker
+
+The installation command is as follows:
+
+```bash
+$ curl -fsSL https://get.docker.com | bash -s docker --mirror aliyun
+``
+
+## 2.2 Start Docker
+
+```bash
+$ systemctl start docker
+```
+
+## 2.3 Test Docker
+
+```bash
+$ docker run hello-world
+```
+
+## 2.4 Configure Docker Acceleration
+
+```bash
+$ mkdir -p /etc/docker
+$ tee /etc/docker/daemon.json <<-'EOF'
+{
+  "registry-mirrors": ["https://registry.docker-cn.com"]
+}
+EOF
+$ systemctl daemon-reload
+$ systemctl restart docker
+```
+
+## 2.5 Install Docker Compose
+
+```bash
+$ sudo curl -L "https://github.com/docker/compose/releases/download/latest/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
+$ sudo chmod +x /usr/local/bin/docker-compose
+```
+
+## 2.6 Test Docker Compose
+
+```bash
+$ docker-compose --version
+```

docs/contrib/linux_development.md

@@ -0,0 +1,137 @@
+# Ubuntu 22.04 OpenIM Project Development Guide
+
+## TOC
+- [Ubuntu 22.04 OpenIM Project Development Guide](#ubuntu-2204-openim-project-development-guide)
+  - [TOC](#toc)
+  - [1. Setting Up Ubuntu Server](#1-setting-up-ubuntu-server)
+  - [1.1 Create `openim` Standard User](#11-create-openim-standard-user)
+  - [1.2 Setting up the `openim` User's Shell Environment](#12-setting-up-the-openim-users-shell-environment)
+  - [1.3 Installing Dependencies](#13-installing-dependencies)
+
+## 1. Setting Up Ubuntu Server
+
+You can use tools like PuTTY or other SSH clients to log in to your Ubuntu server. Once logged in, a few fundamental configurations are required, such as creating a standard user, adding to sudoers, and setting up the `$HOME/.bashrc` file. The steps are as follows:
+
+## 1.1 Create `openim` Standard User
+
+1. Log in to the Ubuntu system as the `root` user and create a standard user.
+
+Generally, a project will involve multiple developers. Instead of provisioning a server for every developer, many organizations share a single development machine among developers. To simulate this real-world scenario, we'll use a standard user for development. To create the `openim` user:
+
+```
+bashCopy code# adduser openim # Create the openim user, which developers will use for login and development.
+# passwd openim # Set the login password for openim.
+```
+
+Working with a non-root user ensures the system's safety and is a good practice. It's recommended to avoid using the root user as much as possible during everyday development.
+
+1. Add to sudoers.
+
+Often, even standard users need root privileges. Instead of frequently asking the system administrator for the root password, you can add the standard user to the sudoers. This allows them to temporarily gain root access using the sudo command. To add the `openim` user to sudoers:
+
+```
+bashCopy code
+# sed -i '/^root.*ALL=(ALL:ALL).*ALL/a\openim\tALL=(ALL) \tALL' /etc/sudoers
+```
+
+## 1.2 Setting up the `openim` User's Shell Environment
+
+1. Log into the Ubuntu system.
+
+Assuming we're using the **openim** user, log in using PuTTY or other SSH clients.
+
+1. Configure the `$HOME/.bashrc` file.
+
+The first step after logging into a new server is to configure the `$HOME/.bashrc` file. It makes the Linux shell more user-friendly by setting environment variables like `LANG` and `PS1`. Here's how the configuration would look:
+
+```
+bashCopy code# .bashrc
+
+# User specific aliases and functions
+
+alias rm='rm -i'
+alias cp='cp -i'
+alias mv='mv -i'
+
+# Source global definitions
+if [ -f /etc/bashrc ]; then
+    . /etc/bashrc
+fi
+
+if [ ! -d $HOME/workspace ]; then
+    mkdir -p $HOME/workspace
+fi
+
+# User specific environment
+export LANG="en_US.UTF-8" 
+export PS1='[\u@dev \W]\$ '
+export WORKSPACE="$HOME/workspace"
+export PATH=$HOME/bin:$PATH
+
+cd $WORKSPACE
+```
+
+After updating `$HOME/.bashrc`, run the `bash` command to reload the configurations into the current shell.
+
+## 1.3 Installing Dependencies
+
+The OpenIM project on Ubuntu may have various dependencies. Some are direct, and others are indirect. Installing these in advance prevents issues like missing packages or compile-time errors later on.
+
+1. Install dependencies.
+
+You can use the `apt` command to install the required tools on Ubuntu:
+
+```
+bashCopy code$ sudo apt-get update 
+$ sudo apt-get install build-essential autoconf automake cmake perl libcurl4-gnutls-dev libtool gcc g++ glibc-doc-reference zlib1g-dev git-lfs telnet lrzsz jq libexpat1-dev libssl-dev
+$ sudo apt install libcurl4-openssl-dev
+```
+
+1. Install Git.
+
+A higher version of Git ensures compatibility with certain commands like `git fetch --unshallow`. To install a recent version:
+
+```
+bashCopy code$ cd /tmp
+$ wget --no-check-certificate https://mirrors.edge.kernel.org/pub/software/scm/git/git-2.36.1.tar.gz
+$ tar -xvzf git-2.36.1.tar.gz
+$ cd git-2.36.1/
+$ ./configure
+$ make
+$ sudo make install
+$ git --version          
+```
+
+Then, add Git's binary directory to the `PATH`:
+
+```
+bashCopy code
+$ echo 'export PATH=/usr/local/libexec/git-core:$PATH' >> $HOME/.bashrc
+```
+
+1. Configure Git.
+
+To set up Git:
+
+```
+bashCopy code$ git config --global user.name "Your Name"
+$ git config --global user.email "your_email@example.com"
+$ git config --global credential.helper store
+$ git config --global core.longpaths true
+```
+
+Other Git configurations include:
+
+```
+bashCopy code
+$ git config --global core.quotepath off
+```
+
+And for handling larger files:
+
+```
+bashCopy code
+$ git lfs install --skip-repo
+```
+
+By following the steps in this guide, your Ubuntu 22.04 server should now be set up and ready for OpenIM project development.

docs/contrib/local_actions.md

@@ -0,0 +1,14 @@
+# act
+
+Run your [GitHub Actions](https://developer.github.com/actions/) locally! Why would you want to do this? Two reasons:
+
+- **Fast Feedback** - Rather than having to commit/push every time you want to test out the changes you are making to your `.github/workflows/` files (or for any changes to embedded GitHub actions), you can use `act` to run the actions locally. The [environment variables](https://help.github.com/en/actions/configuring-and-managing-workflows/using-environment-variables#default-environment-variables) and [filesystem](https://help.github.com/en/actions/reference/virtual-environments-for-github-hosted-runners#filesystems-on-github-hosted-runners) are all configured to match what GitHub provides.
+- **Local Task Runner** - I love [make](https://en.wikipedia.org/wiki/Make_(software)). However, I also hate repeating myself. With `act`, you can use the GitHub Actions defined in your `.github/workflows/` to replace your `Makefile`!
+
+## install act
+
++ [https://github.com/nektos/act](https://github.com/nektos/act)
+
+```bash
+curl -s https://raw.githubusercontent.com/nektos/act/master/install.sh | sudo bash
+···

docs/contrib/offline-deployment.md

@@ -0,0 +1,116 @@
+
+
+# OpenIM Offline Deployment Design
+
+## 1. Base Images
+
+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
+
+Use the following commands to pull these base images:
+
+```
+docker pull wurstmeister/kafka
+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
+```
+
+## 2. OpenIM & Chat 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/conversions/version.md)
+
+### OpenIM Image
+
+- Get image version info: [images.md](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/images.md)
+- Depending on the required version, execute the following command:
+
+```bash
+docker pull ghcr.io/openimsdk/openim-server:<version-name>
+```
+
+### Chat Image
+
+- Execute the following command to pull the image:
+
+```bash
+docker pull ghcr.io/openimsdk/openim-server:<version-name>
+```
+
+## 3. Image Storage Selection
+
+**Repositories**:
+
+- Alibaba Cloud: `registry.cn-hangzhou.aliyuncs.com/openimsdk/openim-server`
+- Docker Hub: `openim/openim-server`
+
+**Version Selection**:
+
+- Stable: e.g. release-v3.2 (or 3.1, 3.3)
+- Latest: latest
+- Latest of main: main
+
+## 4. Version Selection
+
+You can select from the following versions:
+
+- Stable: e.g. release-v3.2
+- Latest: latest
+- Latest from main branch: main
+
+## 5. Offline Deployment Steps
+
+1. **Pull images**: Execute the above `docker pull` commands to pull all required images locally.
+2. **Save images**:
+
+```
+docker save -o <tar-file-name>.tar <image-name>
+```
+
+1. **Fetch code**: Clone the repository:
+
+```
+git clone https://github.com/OpenIMSDK/openim-docker.git
+```
+
+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.
+
+```
+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:
+
+```
+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**:
+
+```
+docker-compose up -d
+
+# Verify
+docker-compose ps
+```
+
+> **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)
+- [Notion Link](https://nsddd.notion.site/435ee747c0bc44048da9300a2d745ad3?pvs=25)
+- [OpenIMSDK Issue #474](https://github.com/OpenIMSDK/Open-IM-Server/issues/474)

docs/contrib/protoc_tools.md

@@ -0,0 +1,60 @@
+# OpenIM Protoc Tool
+
+## Introduction
+
+OpenIM is passionate about ensuring that its suite of tools is custom-tailored to cater to the unique needs of its users. That commitment led us to develop and release our custom Protoc tool, version v1.0.0.
+
+### Why a Custom Version?
+
+There are several reasons to choose our custom Protoc tool over generic open-source versions:
+
+- **Specialized Features**: OpenIM's Protoc tool has been enriched with features and plugins that are optimized for the OpenIM ecosystem. This makes it more aligned with the needs of OpenIM users.
+- **Optimized Performance**: Built from the ground up with OpenIM's infrastructure in mind, our tool guarantees faster and more efficient operations.
+- **Enhanced Compatibility**: Our Protoc tool ensures full compatibility with OpenIM's offerings, minimizing potential conflicts and integration challenges.
+- **Rich Output Support**: Unlike generic tools, our custom tool provides a wide array of output options including C++, C#, Java, Kotlin, Objective-C, PHP, Python, Ruby, and more. This allows developers to generate code for their preferred platform with ease.
+
+## Download
+
++ https://github.com/OpenIMSDK/Open-IM-Protoc
+
+Access the official release of the Protoc tool on the OpenIM repository here: [OpenIM Protoc Tool v1.0.0 Release](https://github.com/OpenIMSDK/Open-IM-Protoc/releases/tag/v1.0.0)
+
+### Direct Download Links:
+
+- **Windows**: [Download for Windows](https://github.com/OpenIMSDK/Open-IM-Protoc/releases/download/v1.0.0/windows.zip)
+- **Linux**: [Download for Linux](https://github.com/OpenIMSDK/Open-IM-Protoc/releases/download/v1.0.0/linux.zip)
+
+## Installation
+
+For Windows:
+
+1. Navigate to the Windows download link provided above and download the version suitable for your system.
+2. Extract the contents of the zip file.
+3. Add the path of the extracted tool to your `PATH` environment variable to run the Protoc tool directly from the command line.
+
+For Linux:
+
+1. Navigate to the Linux download link provided above and download the version suitable for your system.
+2. Extract the contents of the zip file.
+3. Use `chmod +x ./*` to make the extracted files executable.
+4. Add the path of the extracted tool to your `PATH` environment variable to run the Protoc tool directly from the command line.
+
+## Usage
+
+The OpenIM Protoc tool provides a multitude of options for parsing `.proto` files and generating output:
+
+```
+bashCopy code
+./protoc [OPTION] PROTO_FILES
+```
+
+Some of the key options include:
+
+- `--proto_path=PATH`: Specify the directory to search for imports.
+- `--version`: Show version info.
+- `--encode=MESSAGE_TYPE`: Convert a text-format message of a given type from standard input to binary on standard output.
+- `--decode=MESSAGE_TYPE`: Convert a binary message of a given type from standard input to text format on standard output.
+- `--cpp_out=OUT_DIR`: Generate C++ header and source.
+- `--java_out=OUT_DIR`: Generate Java source file.
+
+... and many more. For a full list of options, run `./protoc --help` or refer to the official documentation.

docs/contrib/util_go.md

@@ -0,0 +1,8 @@
+# utils go 
+
++ [toold readme](https://github.com/OpenIMSDK/Open-IM-Server/tree/main/tools)
+
+about scripts fix:
+```
+"${OPENIM-ROOT}/_output/bin/tools/${platform}/${lookfor}"
+```

docs/contrib/util_makefile.md

@@ -0,0 +1,90 @@
+# Open-IM-Server Development Tools Guide
+
+- [Open-IM-Server Development Tools Guide](#open-im-server-development-tools-guide)
+  - [Introduction](#introduction)
+  - [Getting Started](#getting-started)
+  - [Toolset Categories](#toolset-categories)
+  - [Installation Commands](#installation-commands)
+    - [Basic Installation](#basic-installation)
+    - [Individual Tool Installation](#individual-tool-installation)
+    - [Tool Verification](#tool-verification)
+  - [Detailed Tool Descriptions](#detailed-tool-descriptions)
+  - [Best Practices](#best-practices)
+  - [Conclusion](#conclusion)
+
+
+## Introduction
+
+Open-IM-Server boasts a robust set of tools encapsulated within its Makefile system, designed to ease development, code formatting, and tool management. This guide aims to familiarize developers with the features and usage of the Makefile toolset provided within the Open-IM-Server project.
+
+## Getting Started
+
+Executing `make tools` ensures verification and installation of the default tools:
+
+- golangci-lint
+- goimports
+- addlicense
+- deepcopy-gen
+- conversion-gen
+- ginkgo
+- go-junit-report
+- go-gitlint
+
+The installation path is situated at `/root/workspaces/openim/Open-IM-Server/_output/tools/`.
+
+## Toolset Categories
+
+The Makefile logically groups tools into different categories for better management:
+
+- **Development Tools**: `BUILD_TOOLS`
+- **Code Analysis Tools**: `ANALYSIS_TOOLS`
+- **Code Generation Tools**: `GENERATION_TOOLS`
+- **Testing Tools**: `TEST_TOOLS`
+- **Version Control Tools**: `VERSION_CONTROL_TOOLS`
+- **Utility Tools**: `UTILITY_TOOLS`
+- **Tencent Cloud Object Storage Tools**: `COS_TOOLS`
+
+## Installation Commands
+
+1. **golangci-lint**: high performance Go code linter with integration of multiple inspection tools.
+2. **goimports**: Used to format Go source files and automatically add or remove imports.
+3. **addlicense**: Adds a license header to the source file.
+4. **deepcopy-gen and conversions-gen **: Generate deepcopy and conversion functionality.
+5. **ginkgo**: Testing framework for Go.
+6. **go-junit-report**: Converts Go test output to junit xml format.
+7. **go-gitlint**: For checking git commit information. ... (And so on, list all the tools according to the `make tools.help` output above)...
+
+ 
+
+### Basic Installation
+
+- `tools.install`: Installs tools mentioned in the `BUILD_TOOLS` list.
+- `tools.install-all`: Installs all tools from the `ALL_TOOLS` list.
+
+### Individual Tool Installation
+
+- `tools.install.%`: Installs a single tool in the `$GOBIN/` directory.
+- `tools.install-all.%`: Parallelly installs an individual tool located in `./tools/*`.
+
+### Tool Verification
+
+- `tools.verify.%`: Checks if a specific tool is installed, and if not, installs it.
+
+## Detailed Tool Descriptions
+
+The following commands serve the purpose of installing particular development tools:
+
+- `install.golangci-lint`: Installs `golangci-lint`.
+- `install.addlicense`: Installs `addlicense`. ... (and so on for every tool as mentioned in the provided Makefile source)...
+
+The commands primarily leverage Go's `install` operation, fetching and installing tools from their respective repositories. This method is especially convenient as it auto-handles dependencies and installation paths. For tools not written directly with Go (like `install.coscli`), other installation methods like wget or pip are employed.
+
+## Best Practices
+
+1. **Regular Updates**: To ensure tools are up-to-date, periodically run the `make tools` command.
+2. **Individual Tools**: If only specific tools are required, employ the `make install.<tool-name>` command for individual installations.
+3. **Verification**: Before code submissions, use the `make tools.verify.%` command to guarantee that all necessary tools are present and up-to-date.
+
+## Conclusion
+
+The Makefile provided by Open-IM-Server presents a centralized approach to manage and install all necessary tools during the development process. It ensures that all developers employ consistent tool versions, reducing potential issues due to version disparities. Whether you're a maintainer or a contributor to the Open-IM-Server project, understanding the workings of this Makefile will significantly enhance your developmental efficiency.

docs/contrib/util_scripts.md

@@ -0,0 +1,248 @@
+# OpenIM Bash Utility Script
+
+This script offers a variety of utilities and helpers to enhance and simplify operations related to the OpenIM project.
+
+## Table of Contents
+
+- [OpenIM Bash Utility Script](#openim-bash-utility-script)
+  - [Table of Contents](#table-of-contents)
+  - [brief descriptions of each function](#brief-descriptions-of-each-function)
+  - [Introduction](#introduction)
+  - [Usage](#usage)
+    - [SSH Key Setup](#ssh-key-setup)
+  - [openim::util::ensure-gnu-sed](#openimutilensure-gnu-sed)
+  - [openim::util::ensure-gnu-date](#openimutilensure-gnu-date)
+  - [openim::util::check-file-in-alphabetical-order](#openimutilcheck-file-in-alphabetical-order)
+  - [openim::util::require-jq](#openimutilrequire-jq)
+  - [openim::util::md5](#openimutilmd5)
+  - [openim::util::read-array](#openimutilread-array)
+  - [Color Definitions](#color-definitions)
+  - [openim::util::desc and related functions](#openimutildesc-and-related-functions)
+  - [openim::util::onCtrlC](#openimutilonctrlc)
+  - [openim::util::list-to-string](#openimutillist-to-string)
+  - [openim::util::remove-space](#openimutilremove-space)
+  - [openim::util::gencpu](#openimutilgencpu)
+  - [openim::util::gen-os-arch](#openimutilgen-os-arch)
+  - [openim::util::download-file](#openimutildownload-file)
+  - [openim::util::get-public-ip](#openimutilget-public-ip)
+  - [openim::util::extract-tarball](#openimutilextract-tarball)
+  - [openim::util::check-port-open](#openimutilcheck-port-open)
+  - [openim::util::file-lines-count](#openimutilfile-lines-count)
+
+
+##  brief descriptions of each function 
+
+**Englist:**
+1. `openim::util::ensure-gnu-sed` - Determines if GNU version of `sed` exists on the system and sets its name.
+2. `openim::util::ensure-gnu-date` - Determines if GNU version of `date` exists on the system and sets its name.
+3. `openim::util::check-file-in-alphabetical-order` - Checks if a file is sorted in alphabetical order.
+4. `openim::util::require-jq` - Checks if `jq` is installed.
+5. `openim::util::md5` - Outputs the MD5 hash of a file.
+6. `openim::util::read-array` - Reads content from standard input into an array.
+7. `openim::util::desc` - Displays descriptive information.
+8. `openim::util::run::prompt` - Displays a prompt.
+9. `openim::util::run::maybe-first-prompt` - Possibly displays the first prompt based on whether it's started or not.
+10. `openim::util::run` - Executes a command and captures its output.
+11. `openim::util::run::relative` - Returns paths relative to the current script.
+12. `openim::util::onCtrlC` - Performs an action when Ctrl+C is pressed.
+13. `openim::util::list-to-string` - Converts a list into a string.
+14. `openim::util::remove-space` - Removes spaces from a string.
+15. `openim::util::gencpu` - Retrieves CPU information.
+16. `openim::util::gen-os-arch` - Generates a repository directory based on the operating system and architecture.
+17. `openim::util::download-file` - Downloads a file from a URL.
+18. `openim::util::get-public-ip` - Retrieves the public IP address of the machine.
+19. `openim::util::extract-tarball` - Extracts a tarball to a specified directory.
+20. `openim::util::check-port-open` - Checks if a given port is open on the machine.
+21. `openim::util::file-lines-count` - Counts the number of lines in a file.
+
+
+
+## Introduction
+
+This script is mainly used to validate whether the code is correctly formatted by `gofmt`. Apart from that, it offers utilities like setting up SSH keys, various wait conditions, host and platform detection, documentation generation, etc. 
+
+## Usage
+
+### SSH Key Setup
+
+To set up an SSH key:
+
+```bash
+#1. Write IPs in a file, one IP per line. Let's name it hosts-file.
+#2. Modify the default username and password in the script.
+hosts-file-path="path/to/your/hosts/file"
+openim:util::setup_ssh_key_copy "$hosts-file-path" "root" "123"
+```
+
+## openim::util::ensure-gnu-sed
+
+Ensures the presence of the GNU version of the `sed` command. Different operating systems may have variations of the `sed` command, and this utility function is used to make sure the script uses the GNU version. If it finds the GNU `sed`, it sets the `SED` variable accordingly. If not found, it checks for `gsed`, which is usually the name of GNU `sed` on macOS. If neither is found, an error message is displayed.
+
+
+
+## openim::util::ensure-gnu-date
+
+Similar to the function for `sed`, this function ensures the script uses the GNU version of the `date` command. If it identifies the GNU `date`, it sets the `DATE` variable. On macOS, it looks for `gdate` as an alternative. In the absence of both, an error message is recommended.
+
+
+
+## openim::util::check-file-in-alphabetical-order
+
+This function checks if the contents of a given file are sorted in alphabetical order. If not, it provides a command suggestion for the user to sort the file correctly.
+
+
+
+## openim::util::require-jq
+
+Verifies the installation of `jq`, a popular command-line JSON parser. If it's not present, a prompt to install it is displayed.
+
+
+
+## openim::util::md5
+
+A cross-platform function that computes the MD5 hash of its input. This function takes into account the differences in the `md5` command between macOS and Linux.
+
+
+
+## openim::util::read-array
+
+A function designed to read from stdin and populate an array, line by line. It's provided as an alternative to `mapfile -t` and is compatible with bash 3.
+
+
+
+## Color Definitions
+
+The script also defines a set of colors to enhance its console output. These include colors like red, yellow, green, blue, cyan, etc., which can be used for better user experience and clear logs.
+
+
+
+## openim::util::desc and related functions
+
+These functions seem to aid in building interactive demonstrations or tutorials in the terminal. They use the `pv` utility to control the display rate of the output, emulating typing. There's also functionality to handle user prompts and execute commands while capturing their output.
+
+
+
+## openim::util::onCtrlC
+
+Handles the `CTRL+C` command. It terminates background processes of the script when the user interrupts it using `CTRL+C`.
+
+
+
+## openim::util::list-to-string
+
+Transforms a list format (like `[10023, 2323, 3434]`) to a space-separated string (`10023 2323 3434`). Also removes unnecessary spaces and characters.
+
+
+
+## openim::util::remove-space
+
+Removes spaces from a given string.
+
+
+
+## openim::util::gencpu
+
+Fetches the number of CPUs using the `lscpu` command.
+
+
+
+## openim::util::gen-os-arch
+
+Identifies the operating system and architecture of the system running the script. This is useful to determine directories or binaries specific to that OS and architecture.
+
+
+
+## openim::util::download-file
+
+This function can be used to download a file from a URL. If `curl` is available, it uses `curl`. If not, it falls back to `wget`.
+
+```bash
+function openim::util::download-file() {
+  local url="$1"
+  local dest="$2"
+
+  if command -v curl &>/dev/null; then
+    curl -L "${url}" -o "${dest}"
+  elif command -v wget &>/dev/null; then
+    wget "${url}" -O "${dest}"
+  else
+    openim::log::error "Neither curl nor wget available. Cannot download file."
+    return 1
+  fi
+}
+```
+
+
+
+## openim::util::get-public-ip
+
+Fetches the public IP address of the machine.
+
+```bash
+function openim::util::get-public-ip() {
+  if command -v curl &>/dev/null; then
+    curl -s https://ipinfo.io/ip
+  elif command -v wget &>/dev/null; then
+    wget -qO- https://ipinfo.io/ip
+  else
+    openim::log::error "Neither curl nor wget available. Cannot fetch public IP."
+    return 1
+  fi
+}
+```
+
+
+
+## openim::util::extract-tarball
+
+This function extracts a tarball to a specified directory.
+
+```bash
+function openim::util::extract-tarball() {
+  local tarball="$1"
+  local dest="$2"
+
+  mkdir -p "${dest}"
+  tar -xzf "${tarball}" -C "${dest}"
+}
+```
+
+
+
+## openim::util::check-port-open
+
+Checks if a given port is open on the local machine.
+
+```bash
+function openim::util::check-port-open() {
+  local port="$1"
+  if command -v nc &>/dev/null; then
+    echo -n > /dev/tcp/127.0.0.1/"${port}" 2>&1
+    return $?
+  elif command -v telnet &>/dev/null; then
+    telnet 127.0.0.1 "${port}" 2>&1 | grep -q "Connected"
+    return $?
+  else
+    openim::log::error "Neither nc nor telnet available. Cannot check port."
+    return 1
+  fi
+}
+```
+
+
+
+## openim::util::file-lines-count
+
+Counts the number of lines in a file.
+
+```bash
+function openim::util::file-lines-count() {
+  local file="$1"
+  if [[ -f "${file}" ]]; then
+    wc -l < "${file}"
+  else
+    openim::log::error "File does not exist: ${file}"
+    return 1
+  fi
+}
+```