fix: fix openim web port

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

.env

@@ -1,64 +1,279 @@
-# The following is automatically generated
-# Use `make init` OR `./scripts/init-config.sh`
+# Copyright © 2023 OpenIM. All rights reserved.
 #
-# ================= Basic Configuration ===================
-# Endpoint for the MinIO object storage service
-MINIO_ENDPOINT=http://127.0.0.1:10005
+# 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.
 
-# Base URL for the application programming interface (API)
-API_URL=http://127.0.0.1:10002
+# ======================================
+# ========= Basic Configuration ========
+# ======================================
 
-# Directory path for storing data files or related information
+# 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
+
+# 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=./
 
-# ============ Component Extension Configuration ==========
-# Address or hostname for the ZooKeeper service (often used in distributed systems for maintaining configuration information)
-ZOOKEEPER_ADDRESS=127.0.0.1
+# ======================================
+# ========= Network Configuration ======
+# ======================================
 
-# Port on which MySQL database service is running
+# 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
+# Password to authenticate with the MySQL database service.
+# Default: MYSQL_PASSWORD=openIM123
 MYSQL_PASSWORD=openIM123
 
-# Port on which MongoDB service is running
+# ----- 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
+# Username to authenticate with the MongoDB service.
+# Default: MONGO_USERNAME=root
 MONGO_USERNAME=root
 
-# Password to authenticate with the MongoDB service
+# Password to authenticate with the MongoDB service.
+# Default: MONGO_PASSWORD=openIM123
 MONGO_PASSWORD=openIM123
 
-# Name of the database in MongoDB to be used
+# Name of the database in MongoDB to be used.
+# Default: MONGO_DATABASE=openIM_v3
 MONGO_DATABASE=openIM_v3
 
-# Port on which Redis in-memory data structure store is running
+# ----- 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
+# Password to authenticate with the Redis service.
+# Default: REDIS_PASSWORD=openIM123
 REDIS_PASSWORD=openIM123
 
-# Port on which Kafka distributed streaming platform is running
-KAFKA_PORT=9092
+# ----- Kafka Configuration -----
+# Address or hostname for the Kafka service.
+# Default: KAFKA_ADDRESS=172.28.0.1
+KAFKA_ADDRESS=172.28.0.5
 
-# Address or hostname for the Kafka service
-KAFKA_ADDR=127.0.0.1
+# 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
+# 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)
+# 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
+# Topic in Kafka for storing offline messages in MongoDB.
+# Default: KAFKA_OFFLINEMSG_MONGO_TOPIC=offlineMsgToMongoMysql
 KAFKA_OFFLINEMSG_MONGO_TOPIC=offlineMsgToMongoMysql
 
-# Port on which MinIO object storage service is running
+# ----- 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
+# 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
+# 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/workflows/auto-gh-pr.yml

@@ -51,7 +51,7 @@ jobs:
             # git checkout -b bot/merge-to-release-$ISSUEID
             # git push origin bot/merge-to-release-$ISSUEID
             # gh pr create --base release --head bot/merge-to-release-$ISSUEID --title "Merge main to release" --body ""
-            # gh pr create --base main --head feat/auto-release-pr-624  --title "The bug is fixed" --body "$x" --repo OpenIMSDK/Open-IM-Server --reviewer "cubxxw"
+            # gh pr create --base main --head feat/auto-release-pr-624  --title "The bug is fixed" --body "$x" --repo openimsdk/open-im-server --reviewer "cubxxw"
           continue-on-error: true
           env:
               GITHUB_TOKEN: ${{ secrets.BOT_GITHUB_TOKEN }}

.github/workflows/build-openim-web-image.yml

@@ -0,0 +1,274 @@
+# Copyright © 2023 OpenIM open source community. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+name: Build OpenIM Web Docker image
+
+on:
+  push:
+    branches:
+      - main
+      - release-*
+    tags:
+      - v*
+  workflow_dispatch:
+
+env:
+  # Common versions
+  GO_VERSION: "1.20"
+
+jobs:
+  build-dockerhub:
+    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
+
+# docker.io/openim/openim-server:latest
+      - name: Extract metadata (tags, labels) for Docker
+        id: meta
+        uses: docker/metadata-action@v4.6.0
+        with:
+          images: openim/openim-server
+          # generate Docker tags based on the following events/attributes
+          tags: |
+            type=schedule
+            type=ref,event=branch
+            type=ref,event=pr
+            type=semver,pattern={{version}}
+            type=semver,pattern={{major}}.{{minor}}
+            type=semver,pattern={{major}}
+            type=sha
+
+      - name: Log in to Docker Hub
+        uses: docker/login-action@v2
+        with:
+          username: ${{ secrets.DOCKER_USERNAME }}
+          password: ${{ secrets.DOCKER_PASSWORD }}
+
+      - name: Build and push Docker image
+        uses: docker/build-push-action@v4
+        with:
+          context: .
+          # linux/ppc64le,linux/s390x
+          platforms: linux/amd64,linux/arm64
+          push: ${{ github.event_name != 'pull_request' }}
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+
+  build-aliyun:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v2
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v2
+# registry.cn-hangzhou.aliyuncs.com/openimsdk/openim-server:latest
+      - name: Extract metadata (tags, labels) for Docker
+        id: meta2
+        uses: docker/metadata-action@v4.6.0
+        with:
+          images: registry.cn-hangzhou.aliyuncs.com/openimsdk/openim-web
+
+      - name: Log in to AliYun Docker Hub
+        uses: docker/login-action@v2
+        with:
+          registry: registry.cn-hangzhou.aliyuncs.com
+          username: ${{ secrets.ALIREGISTRY_USERNAME }}
+          password: ${{ secrets.ALIREGISTRY_TOKEN }}
+      
+      - name: Build and push Docker image
+        uses: docker/build-push-action@v4
+        with:
+          context: .
+          # linux/ppc64le,linux/s390x
+          platforms: linux/amd64,linux/arm64
+          push: ${{ github.event_name != 'pull_request' }}
+          tags: ${{ steps.meta2.outputs.tags }}
+          labels: ${{ steps.meta2.outputs.labels }}
+
+  build-ghcr:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v2
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v2
+# ghcr.io/openimsdk/openim-server:latest
+      - name: Extract metadata (tags, labels) for Docker
+        id: meta3
+        uses: docker/metadata-action@v4.6.0
+        with:
+          images: ghcr.io/openimsdk/openim-web
+
+      - 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: Build and push Docker image
+        uses: docker/build-push-action@v4
+        with:
+          context: .
+          # linux/ppc64le,linux/s390x
+          platforms: linux/amd64,linux/arm64
+          push: ${{ github.event_name != 'pull_request' }}
+          tags: ${{ steps.meta3.outputs.tags }}
+          labels: ${{ steps.meta3.outputs.labels }}
+
+  build-openim-web-dockerhub:
+    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
+
+# docker.io/openim/openim-server:latest
+      - name: Extract metadata (tags, labels) for Docker
+        id: meta
+        uses: docker/metadata-action@v4.6.0
+        with:
+          images: openim/openim-server
+          # generate Docker tags based on the following events/attributes
+          tags: |
+            type=schedule
+            type=ref,event=branch
+            type=ref,event=pr
+            type=semver,pattern={{version}}
+            type=semver,pattern={{major}}.{{minor}}
+            type=semver,pattern={{major}}
+            type=sha
+
+      - name: Log in to Docker Hub
+        uses: docker/login-action@v2
+        with:
+          username: ${{ secrets.DOCKER_USERNAME }}
+          password: ${{ secrets.DOCKER_PASSWORD }}
+
+      - name: Build and push Docker image
+        uses: docker/build-push-action@v4
+        with:
+          context: .
+          file: ./build/images/openim-tools/openim-web/Dockerfile
+          platforms: linux/amd64,linux/arm64
+          push: ${{ github.event_name != 'pull_request' }}
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+
+  build-openim-web-aliyun:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v2
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v2
+# registry.cn-hangzhou.aliyuncs.com/openimsdk/openim-server:latest
+      - name: Extract metadata (tags, labels) for Docker
+        id: meta2
+        uses: docker/metadata-action@v4.6.0
+        with:
+          images: registry.cn-hangzhou.aliyuncs.com/openimsdk/openim-server
+
+      - name: Log in to AliYun Docker Hub
+        uses: docker/login-action@v2
+        with:
+          registry: registry.cn-hangzhou.aliyuncs.com
+          username: ${{ secrets.ALIREGISTRY_USERNAME }}
+          password: ${{ secrets.ALIREGISTRY_TOKEN }}
+      
+      - name: Build and push Docker image
+        uses: docker/build-push-action@v4
+        with:
+          context: .
+          file: ./build/images/openim-tools/openim-web/Dockerfile
+          platforms: linux/amd64,linux/arm64
+          push: ${{ github.event_name != 'pull_request' }}
+          tags: ${{ steps.meta2.outputs.tags }}
+          labels: ${{ steps.meta2.outputs.labels }}
+
+  build-openim-web-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/docker-buildx.yml

@@ -319,67 +319,3 @@ jobs:
           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/pull-request.yml

@@ -114,7 +114,7 @@ jobs:
             - [ ] Disenchanter can connect and issue actions
             
             This is an automated PR. @ ${{ github.actor }}
-            <sub>[workflow](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/.github/workflows/pull-request.yml).</sub>
+            <sub>[workflow](https://github.com/openimsdk/open-im-server/blob/main/.github/workflows/pull-request.yml).</sub>
           base: main
           labels: |
             kind/documentation

.github/workflows/release.yml

@@ -44,7 +44,7 @@ jobs:
           distribution: goreleaser
           version: latest
           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
+          args: release -f ./build/goreleaser.yaml --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 }}

.gitignore

@@ -160,6 +160,7 @@ flycheck_*.el
 
 # Dependency directories (remove the comment below to include it)
 vendor/
+tools/imctl
 
 # Go workspace file
 # go.work

.golangci.yml

@@ -176,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/Open-IM-Server
+    prefix: github.com/openimsdk/open-im-server
   gocognit:
     # minimal code complexity to report, 30 by default (but we recommend 10-20)
     min-complexity: 30
@@ -333,7 +333,7 @@ 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/Open-IM-Server
+    local-prefixes: github.com/openimsdk/open-im-server
 
   gomnd:
     settings:

CHANGELOG/.chglog/config.yml

@@ -3,7 +3,7 @@ style: github
 template: CHANGELOG.tpl.md
 info:
   title: CHANGELOG
-  repository_url: https://github.com/OpenIMSDK/Open-IM-Server
+  repository_url: https://github.com/openimsdk/open-im-server
 options:
   tag_filter_pattern: '^v'
   sort: "date"

CHANGELOG/CHANGELOG-1.0.md

@@ -47,10 +47,10 @@
 - update
 
 
-[Unreleased]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v1.0.7...HEAD
-[v1.0.7]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v1.0.6...v1.0.7
-[v1.0.6]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v1.0.5...v1.0.6
-[v1.0.5]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v1.0.4...v1.0.5
-[v1.0.4]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v1.0.3...v1.0.4
-[v1.0.3]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v1.0.1...v1.0.3
-[v1.0.1]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v1.0.0...v1.0.1
+[Unreleased]: https://github.com/openimsdk/open-im-server/compare/v1.0.7...HEAD
+[v1.0.7]: https://github.com/openimsdk/open-im-server/compare/v1.0.6...v1.0.7
+[v1.0.6]: https://github.com/openimsdk/open-im-server/compare/v1.0.5...v1.0.6
+[v1.0.5]: https://github.com/openimsdk/open-im-server/compare/v1.0.4...v1.0.5
+[v1.0.4]: https://github.com/openimsdk/open-im-server/compare/v1.0.3...v1.0.4
+[v1.0.3]: https://github.com/openimsdk/open-im-server/compare/v1.0.1...v1.0.3
+[v1.0.1]: https://github.com/openimsdk/open-im-server/compare/v1.0.0...v1.0.1

CHANGELOG/CHANGELOG-2.0.md

@@ -14,7 +14,7 @@
 <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))
+- update etcd to v3.5.2 ([#206](https://github.com/openimsdk/open-im-server/issues/206))
 
 ### Pull Requests
 - Merge branch 'tuoyun'
@@ -74,14 +74,14 @@
 - 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
+[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-2.1.md

@@ -21,7 +21,7 @@
 <a name="v2.1.0"></a>
 ## v2.1.0 - 2022-06-17
 ### Reverts
-- update etcd to v3.5.2 ([#206](https://github.com/OpenIMSDK/Open-IM-Server/issues/206))
+- update etcd to v3.5.2 ([#206](https://github.com/openimsdk/open-im-server/issues/206))
 - friend modify
 - update
 
@@ -47,4 +47,4 @@
 - Merge branch 'tuoyun'
 
 
-[Unreleased]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.1.0...HEAD
+[Unreleased]: https://github.com/openimsdk/open-im-server/compare/v2.1.0...HEAD

CHANGELOG/CHANGELOG-2.2.md

@@ -21,7 +21,7 @@
 <a name="v2.2.0"></a>
 ## v2.2.0 - 2022-07-01
 ### Reverts
-- update etcd to v3.5.2 ([#206](https://github.com/OpenIMSDK/Open-IM-Server/issues/206))
+- update etcd to v3.5.2 ([#206](https://github.com/openimsdk/open-im-server/issues/206))
 - friend modify
 - update
 
@@ -47,4 +47,4 @@
 - Merge branch 'tuoyun'
 
 
-[Unreleased]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.2.0...HEAD
+[Unreleased]: https://github.com/openimsdk/open-im-server/compare/v2.2.0...HEAD

CHANGELOG/CHANGELOG-2.3.md

@@ -37,7 +37,7 @@
 <a name="v2.3.0-rc0"></a>
 ## v2.3.0-rc0 - 2022-07-15
 ### Reverts
-- update etcd to v3.5.2 ([#206](https://github.com/OpenIMSDK/Open-IM-Server/issues/206))
+- update etcd to v3.5.2 ([#206](https://github.com/openimsdk/open-im-server/issues/206))
 - friend modify
 - update
 
@@ -63,8 +63,8 @@
 - Merge branch 'tuoyun'
 
 
-[Unreleased]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.3.3...HEAD
-[v2.3.3]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.3.2...v2.3.3
-[v2.3.2]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.3.0-rc2...v2.3.2
-[v2.3.0-rc2]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.3.0-rc1...v2.3.0-rc2
-[v2.3.0-rc1]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.3.0-rc0...v2.3.0-rc1
+[Unreleased]: https://github.com/openimsdk/open-im-server/compare/v2.3.3...HEAD
+[v2.3.3]: https://github.com/openimsdk/open-im-server/compare/v2.3.2...v2.3.3
+[v2.3.2]: https://github.com/openimsdk/open-im-server/compare/v2.3.0-rc2...v2.3.2
+[v2.3.0-rc2]: https://github.com/openimsdk/open-im-server/compare/v2.3.0-rc1...v2.3.0-rc2
+[v2.3.0-rc1]: https://github.com/openimsdk/open-im-server/compare/v2.3.0-rc0...v2.3.0-rc1

CHANGELOG/CHANGELOG-2.9.md

@@ -38,15 +38,15 @@
 <a name="v2.9.0"></a>
 ## v2.9.0 - 2023-07-04
 ### Reverts
-- update etcd to v3.5.2 ([#206](https://github.com/OpenIMSDK/Open-IM-Server/issues/206))
+- 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/v2.9.0+1.839643f...HEAD
-[v2.9.0+1.839643f]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.9.0+2.35f07fe...v2.9.0+1.839643f
-[v2.9.0+2.35f07fe]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.9.0+1.b5072b1...v2.9.0+2.35f07fe
-[v2.9.0+1.b5072b1]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.9.0+3.2667a3a...v2.9.0+1.b5072b1
-[v2.9.0+3.2667a3a]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.9.0+7.04818ca...v2.9.0+3.2667a3a
-[v2.9.0+7.04818ca]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.9.0...v2.9.0+7.04818ca
+[Unreleased]: https://github.com/openimsdk/open-im-server/compare/v2.9.0+1.839643f...HEAD
+[v2.9.0+1.839643f]: https://github.com/openimsdk/open-im-server/compare/v2.9.0+2.35f07fe...v2.9.0+1.839643f
+[v2.9.0+2.35f07fe]: https://github.com/openimsdk/open-im-server/compare/v2.9.0+1.b5072b1...v2.9.0+2.35f07fe
+[v2.9.0+1.b5072b1]: https://github.com/openimsdk/open-im-server/compare/v2.9.0+3.2667a3a...v2.9.0+1.b5072b1
+[v2.9.0+3.2667a3a]: https://github.com/openimsdk/open-im-server/compare/v2.9.0+7.04818ca...v2.9.0+3.2667a3a
+[v2.9.0+7.04818ca]: https://github.com/openimsdk/open-im-server/compare/v2.9.0...v2.9.0+7.04818ca

CHANGELOG/CHANGELOG-3.0.md

@@ -47,7 +47,7 @@
 <a name="v2.9.0"></a>
 ## [v2.9.0] - 2023-07-04
 ### Reverts
-- update etcd to v3.5.2 ([#206](https://github.com/OpenIMSDK/Open-IM-Server/issues/206))
+- update etcd to v3.5.2 ([#206](https://github.com/openimsdk/open-im-server/issues/206))
 
 ### Pull Requests
 - Merge branch 'tuoyun'
@@ -85,7 +85,7 @@
 <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))
+- update etcd to v3.5.2 ([#206](https://github.com/openimsdk/open-im-server/issues/206))
 
 ### Pull Requests
 - Merge branch 'tuoyun'
@@ -161,28 +161,28 @@
 - update
 
 
-[Unreleased]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.9.0...HEAD
-[v2.9.0]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.3.3...v2.9.0
-[v2.3.3]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.3.2...v2.3.3
-[v2.3.2]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.3.0-rc2...v2.3.2
-[v2.3.0-rc2]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.3.0-rc1...v2.3.0-rc2
-[v2.3.0-rc1]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.3.0-rc0...v2.3.0-rc1
-[v2.3.0-rc0]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.2.0...v2.3.0-rc0
-[v2.2.0]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.1.0...v2.2.0
-[v2.1.0]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.0.10...v2.1.0
-[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.7...v2.0.9
-[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
-[v2.0.0]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v1.0.7...v2.0.0
-[v1.0.7]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v1.0.6...v1.0.7
-[v1.0.6]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v1.0.5...v1.0.6
-[v1.0.5]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v1.0.4...v1.0.5
-[v1.0.4]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v1.0.3...v1.0.4
-[v1.0.3]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v1.0.1...v1.0.3
-[v1.0.1]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v1.0.0...v1.0.1
+[Unreleased]: https://github.com/openimsdk/open-im-server/compare/v2.9.0...HEAD
+[v2.9.0]: https://github.com/openimsdk/open-im-server/compare/v2.3.3...v2.9.0
+[v2.3.3]: https://github.com/openimsdk/open-im-server/compare/v2.3.2...v2.3.3
+[v2.3.2]: https://github.com/openimsdk/open-im-server/compare/v2.3.0-rc2...v2.3.2
+[v2.3.0-rc2]: https://github.com/openimsdk/open-im-server/compare/v2.3.0-rc1...v2.3.0-rc2
+[v2.3.0-rc1]: https://github.com/openimsdk/open-im-server/compare/v2.3.0-rc0...v2.3.0-rc1
+[v2.3.0-rc0]: https://github.com/openimsdk/open-im-server/compare/v2.2.0...v2.3.0-rc0
+[v2.2.0]: https://github.com/openimsdk/open-im-server/compare/v2.1.0...v2.2.0
+[v2.1.0]: https://github.com/openimsdk/open-im-server/compare/v2.0.10...v2.1.0
+[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.7...v2.0.9
+[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
+[v2.0.0]: https://github.com/openimsdk/open-im-server/compare/v1.0.7...v2.0.0
+[v1.0.7]: https://github.com/openimsdk/open-im-server/compare/v1.0.6...v1.0.7
+[v1.0.6]: https://github.com/openimsdk/open-im-server/compare/v1.0.5...v1.0.6
+[v1.0.5]: https://github.com/openimsdk/open-im-server/compare/v1.0.4...v1.0.5
+[v1.0.4]: https://github.com/openimsdk/open-im-server/compare/v1.0.3...v1.0.4
+[v1.0.3]: https://github.com/openimsdk/open-im-server/compare/v1.0.1...v1.0.3
+[v1.0.1]: https://github.com/openimsdk/open-im-server/compare/v1.0.0...v1.0.1

CHANGELOG/CHANGELOG-3.1.md

@@ -2,31 +2,18 @@
 
 <!-- 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.3-beta.1"></a>
+## [v3.1.3-beta.1] - 2023-08-14
+
+<a name="v3.1.3"></a>
+## [v3.1.3] - 2023-08-14
+
 <a name="v3.1.2-beta.3"></a>
 ## [v3.1.2-beta.3] - 2023-08-09
 
@@ -39,49 +26,19 @@
 <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))
+- 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
+[Unreleased]: https://github.com/openimsdk/open-im-server/compare/v3.1.3-beta.1...HEAD
+[v3.1.3-beta.1]: https://github.com/openimsdk/open-im-server/compare/v3.1.3...v3.1.3-beta.1
+[v3.1.3]: https://github.com/openimsdk/open-im-server/compare/v3.1.2-beta.3...v3.1.3
+[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.0...v3.1.2-beta.0

CHANGELOG/CHANGELOG-3.2.md

@@ -8,6 +8,21 @@
 ## [Unreleased]
 
 
+<a name="v3.2.2"></a>
+## [v3.2.2] - 2023-09-03
+
+<a name="v3.2.3"></a>
+## [v3.2.3] - 2023-09-03
+
+<a name="v3.2.1"></a>
+## [v3.2.1] - 2023-09-03
+
+<a name="v3.2.2-beta.4"></a>
+## [v3.2.2-beta.4] - 2023-08-28
+
+<a name="v3.2.2-alpha.0"></a>
+## [v3.2.2-alpha.0] - 2023-08-25
+
 <a name="v3.2.2-beta.3"></a>
 ## [v3.2.2-beta.3] - 2023-08-22
 
@@ -29,16 +44,21 @@
 <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))
+- 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
+[Unreleased]: https://github.com/openimsdk/open-im-server/compare/v3.2.2...HEAD
+[v3.2.2]: https://github.com/openimsdk/open-im-server/compare/v3.2.3...v3.2.2
+[v3.2.3]: https://github.com/openimsdk/open-im-server/compare/v3.2.1...v3.2.3
+[v3.2.1]: https://github.com/openimsdk/open-im-server/compare/v3.2.2-beta.4...v3.2.1
+[v3.2.2-beta.4]: https://github.com/openimsdk/open-im-server/compare/v3.2.2-alpha.0...v3.2.2-beta.4
+[v3.2.2-alpha.0]: https://github.com/openimsdk/open-im-server/compare/v3.2.2-beta.3...v3.2.2-alpha.0
+[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

@@ -16,7 +16,7 @@
 
 All notable changes to this project will be documented in this file.
 
-+ [https://github.com/OpenIMSDK/Open-IM-Server/releases](https://github.com/OpenIMSDK/Open-IM-Server/releases)
++ [https://github.com/openimsdk/open-im-server/releases](https://github.com/openimsdk/open-im-server/releases)
 
 ## OpenIM versioning policy
 
@@ -44,7 +44,7 @@ $ git-chglog --init
 
 **Options**
 
-- What is the URL of your repository?: https://github.com/OpenIMSDK/Open-IM-Server
+- 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
@@ -89,9 +89,9 @@ $ git-chglog --config custom/dir/config.yml
 ## create next tag
 
 ```bash
-git-chglog --next-tag 2.0.0 -o CHANGELOG.md
-git commit -am "release 2.0.0"
-git tag 2.0.0
+$ git-chglog --next-tag 2.0.0 -o CHANGELOG.md
+$ git commit -am "release 2.0.0"
+$ git tag 2.0.0
 ```
 
 | Query          | Description                                    | Example                     |
@@ -112,6 +112,9 @@ git tag 2.0.0
 + [OpenIM CHANGELOG-V2.9](CHANGELOG-2.9.md)
 + [OpenIM CHANGELOG-V3.0](CHANGELOG-3.0.md)
 + [OpenIM CHANGELOG-V3.1](CHANGELOG-3.1.md)
++ [OpenIM CHANGELOG-V3.2](CHANGELOG-3.2.md)
++ [OpenIM CHANGELOG-V3.3](CHANGELOG-3.3.md)
+
 
 ## Introduction
 
@@ -121,7 +124,7 @@ In both the open-source and closed-source software development communities, it i
 
 The most common format for version numbers is as follows:
 
-```
+```bash
 major.minor[.patch[.build]]
 ```
 

CONTRIBUTING.md

@@ -46,7 +46,7 @@ The [Makefile](./Makefile) is for every developer, even if you don't know how to
 
 #### Code and doc contribution
 
-Every action to make project Open-IM-Server better is encouraged. On GitHub, every improvement for Open-IM-Server could be via a [PR](https://github.com/OpenIMSDK/Open-IM-Server/pulls) (short for pull request).
+Every action to make project Open-IM-Server better is encouraged. On GitHub, every improvement for Open-IM-Server could be via a [PR](https://github.com/openimsdk/open-im-server/pulls) (short for pull request).
 
 + If you find a typo, try to fix it!
 + If you find a bug, try to fix it!
@@ -61,14 +61,14 @@ Every action to make project Open-IM-Server better is encouraged. On GitHub, eve
 
 #### Where should I start?
 
-+ If you are new to the project, don't know how to contribute Open-IM-Server, please check out the [good first issue](https://github.com/OpenIMSDK/Open-IM-Server/issues?q=is%3Aopen+label%3A"good+first+issue"+sort%3Aupdated-desc) label.
-+ You should be good at filtering the Open-IM-Server issue tags and finding the ones you like, such as [RFC](https://github.com/OpenIMSDK/Open-IM-Server/issues?q=is%3Aissue+is%3Aopen+RFC+label%3ARFC) for big initiatives, features for [feature](https://github.com/OpenIMSDK/Open-IM-Server/issues?q=is%3Aissue+label%3Afeature) proposals, and [bug](https://github.com/OpenIMSDK/Open-IM-Server/issues?q=is%3Aissue+label%3Abug+) fixes.
-+ If you are looking for something to work on, check out our [open issues](https://github.com/OpenIMSDK/Open-IM-Server/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc).
-+ If you have an idea for a new feature, please [open an issue](https://github.com/OpenIMSDK/Open-IM-Server/issues/new/choose), and we can discuss it.
++ If you are new to the project, don't know how to contribute Open-IM-Server, please check out the [good first issue](https://github.com/openimsdk/open-im-server/issues?q=is%3Aopen+label%3A"good+first+issue"+sort%3Aupdated-desc) label.
++ You should be good at filtering the Open-IM-Server issue tags and finding the ones you like, such as [RFC](https://github.com/openimsdk/open-im-server/issues?q=is%3Aissue+is%3Aopen+RFC+label%3ARFC) for big initiatives, features for [feature](https://github.com/openimsdk/open-im-server/issues?q=is%3Aissue+label%3Afeature) proposals, and [bug](https://github.com/openimsdk/open-im-server/issues?q=is%3Aissue+label%3Abug+) fixes.
++ If you are looking for something to work on, check out our [open issues](https://github.com/openimsdk/open-im-server/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc).
++ If you have an idea for a new feature, please [open an issue](https://github.com/openimsdk/open-im-server/issues/new/choose), and we can discuss it.
 
 #### Design documents
 
-For any substantial design, there should be a well-crafted design document. This document is not just a simple record, but also a detailed description and manifestation, which can help team members better understand the design thinking and grasp the design direction. In the process of writing the design document, we can choose to use tools such as `Google Docs` or `Notion`, and even mark RFC in [issues](https://github.com/OpenIMSDK/Open-IM-Server/issues?q=is%3Aissue+is%3Aopen+RFC+label%3ARFC) or [discussions](https://github.com/OpenIMSDK/Open-IM-Server/discussions) for better collaboration. Of course, after completing the design document, we should also add it to our [Shared Drive](https://drive.google.com/drive/) and notify the appropriate working group to let everyone know of its existence. Only by doing so can we maximize the effectiveness of the design document and provide strong support for the smooth progress of the project.
+For any substantial design, there should be a well-crafted design document. This document is not just a simple record, but also a detailed description and manifestation, which can help team members better understand the design thinking and grasp the design direction. In the process of writing the design document, we can choose to use tools such as `Google Docs` or `Notion`, and even mark RFC in [issues](https://github.com/openimsdk/open-im-server/issues?q=is%3Aissue+is%3Aopen+RFC+label%3ARFC) or [discussions](https://github.com/openimsdk/open-im-server/discussions) for better collaboration. Of course, after completing the design document, we should also add it to our [Shared Drive](https://drive.google.com/drive/) and notify the appropriate working group to let everyone know of its existence. Only by doing so can we maximize the effectiveness of the design document and provide strong support for the smooth progress of the project.
 
 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.
 
@@ -95,10 +95,10 @@ To propose PR for the Open-IM-Server item, we assume you have registered a GitHu
 
 2. **CLONE** your own repository to main locally. Use `git clone https://github.com/<your-username>/Open-IM-Server.git` to clone repository to your local machine. Then you can create new branches to finish the change you wish to make.
 
-3. **Set Remote** upstream to be `https://github.com/OpenIMSDK/Open-IM-Server.git` using the following two commands:
+3. **Set Remote** upstream to be `https://github.com/openimsdk/open-im-server.git` using the following two commands:
 
    ```bash
-   ❯ git remote add upstream https://github.com/OpenIMSDK/Open-IM-Server.git
+   ❯ git remote add upstream https://github.com/openimsdk/open-im-server.git
    ❯ git remote set-url --push upstream no-pushing
    ```
 
@@ -108,7 +108,7 @@ To propose PR for the Open-IM-Server item, we assume you have registered a GitHu
    ❯ git remote -v
    origin     https://github.com/<your-username>/Open-IM-Server.git (fetch)
    origin     https://github.com/<your-username>/Open-IM-Server.git (push)
-   upstream   https://github.com/OpenIMSDK/Open-IM-Server.git (fetch)
+   upstream   https://github.com/openimsdk/open-im-server.git (fetch)
    upstream   no-pushing (push)
    ```
 
@@ -174,7 +174,7 @@ To propose PR for the Open-IM-Server item, we assume you have registered a GitHu
    # then create pull request, and merge
    ```
 
-7. **Open a pull request** to `OpenIMSDK/Open-IM-Server:main`
+7. **Open a pull request** to `openimsdk/open-im-server:main`
 
    It is recommended to review your changes before filing a pull request. Check if your code doesn't conflict with the main branch and no redundant code is included.
 
@@ -190,7 +190,7 @@ Instead we encourage you to send us a private email to winxu81@gmail.com to repo
 
 #### Reporting general issues
 
-To be honest, we regard every user of Open-IM-Serveras a very kind contributor. After experiencing Open-IM-Server, you may have some feedback for the project. Then feel free to open an issue via [NEW ISSUE](https://github.com/OpenIMSDK/Open-IM-Server/issues/new/choose).
+To be honest, we regard every user of Open-IM-Serveras a very kind contributor. After experiencing Open-IM-Server, you may have some feedback for the project. Then feel free to open an issue via [NEW ISSUE](https://github.com/openimsdk/open-im-server/issues/new/choose).
 
 Since we collaborate project Open-IM-Server in a distributed way, we appreciate **WELL-WRITTEN**, **DETAILED**, **EXPLICIT** issue reports. To make the communication more efficient, we wish everyone could search if your issue is an existing one in the searching list. If you find it existing, please add your details in comments under the existing issue instead of opening a brand new one.
 
@@ -258,7 +258,7 @@ An example for this could be:
 
 PR is the only way to make change to Open-IM-Server project files. To help reviewers better get your purpose, PR description could not be too detailed. We encourage contributors to follow the [PR template](https://github.com/OpenIMSDK/.github/tree/main/.github/PULL_REQUEST_TEMPLATE.md) to finish the pull request.
 
-You can find some very formal PR in [RFC](https://github.com/OpenIMSDK/Open-IM-Server/issues?q=is%3Aissue+is%3Aopen+RFC+label%3ARFC) issues and learn about them.
+You can find some very formal PR in [RFC](https://github.com/openimsdk/open-im-server/issues?q=is%3Aissue+is%3Aopen+RFC+label%3ARFC) issues and learn about them.
 
 **📖 Opening PRs:**
 
@@ -307,8 +307,8 @@ git() {
 
 The documentation for Open-IM-Server includes:
 
-+ [README.md](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/README.md): This file includes the basic information and instructions for getting started with Open-IM-Server.
-+ [CONTRIBUTING.md](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/CONTRIBUTING.md): This file contains guidelines for contributing to Open-IM-Server's codebase, such as how to submit issues, pull requests, and code reviews.
++ [README.md](https://github.com/openimsdk/open-im-server/blob/main/README.md): This file includes the basic information and instructions for getting started with Open-IM-Server.
++ [CONTRIBUTING.md](https://github.com/openimsdk/open-im-server/blob/main/CONTRIBUTING.md): This file contains guidelines for contributing to Open-IM-Server's codebase, such as how to submit issues, pull requests, and code reviews.
 + [Official Documentation](https://doc.rentsoft.cn/): This is the official documentation for Open-IM-Server, which includes comprehensive information on all of its features, configuration options, and troubleshooting tips.
 
 Please obey the following rules to better format the docs, which would greatly improve the reading experience.
@@ -324,9 +324,9 @@ Please obey the following rules to better format the docs, which would greatly i
 
 We choose GitHub as the primary place for Open-IM-Server to collaborate. So the latest updates of Open-IM-Server are always here. Although contributions via PR is an explicit way to help, we still call for any other ways.
 
-+ reply to other's [issues](https://github.com/OpenIMSDK/Open-IM-Server/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc) if you could;
++ reply to other's [issues](https://github.com/openimsdk/open-im-server/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc) if you could;
 + help solve other user's problems;
-+ help review other's [PR](https://github.com/OpenIMSDK/Open-IM-Server/pulls?q=is%3Apr+is%3Aopen+sort%3Aupdated-desc) design; 
++ help review other's [PR](https://github.com/openimsdk/open-im-server/pulls?q=is%3Apr+is%3Aopen+sort%3Aupdated-desc) design; 
 + discuss about Open-IM-Server to make things clearer;
 + advocate [Open-IM-Server](https://google.com/search?q=Open-IM-Server) technology beyond GitHub;
 + write blogs on Open-IM-Server and so on.

Dockerfile

@@ -25,7 +25,7 @@ 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 ${OPENIM_SERVER_CMDDIR} /openim/openim-server/scripts
+# COPY --from=builder ${SERVER_WORKDIR}/config /openim/openim-server/config
 
 CMD ["/openim/openim-server/scripts/docker-start-all.sh"]

Makefile

@@ -11,9 +11,9 @@ 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 https://github.com/OpenIMSDK/Open-IM-Server/issues/574
-VERSION_PACKAGE=github.com/OpenIMSDK/Open-IM-Server/pkg/version
+ROOT_PACKAGE=github.com/openimsdk/open-im-server
+# 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/v3/pkg/version
 
 # ==============================================================================
 # Includes
@@ -112,7 +112,7 @@ install:
 check:
 	@$(MAKE) go.check
 
-## check-component
+## check-component: Check OpenIM component deployment ✨
 .PHONY: check-component
 check-component:
 	@$(MAKE) go.check-component

README-zh_CN.md

@@ -10,11 +10,11 @@
 
 
 <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://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-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://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>
 
@@ -99,9 +99,9 @@ Open-IM-Server 不仅仅是一个即时消息服务器；它是将实时网络
 
 9. **终极部署体验 🤖**
 
-   ✅ 支持 [集群部署](https://github.com/OpenIMSDK/Open-IM-Server/edit/main/deployments/README.md)
+   ✅ 支持 [集群部署](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) 以获取更多信息。
+   ✅ 支持多架构镜像，我们的 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. **开源社区的大生态系统 🤲**
 
@@ -116,17 +116,17 @@ Open-IM-Server 不仅仅是一个即时消息服务器；它是将实时网络
 1. 克隆项目
 
 ```
-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
+git clone -b $BRANCH https://github.com/openimsdk/open-im-server openim && export openim=$(pwd)/openim && cd $openim && make build
 ```
 
-> **注意** 阅读我们的发布策略：https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/version.md
+> **注意** 阅读我们的发布策略：https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/version.md
 
 1. 修改 `.env`
 
 ```
-bashCopy codeUSER=root #无需修改
+USER=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和端口或域名，
@@ -138,38 +138,38 @@ DATA_DIR=./  #指定大磁盘目录
 > **注意** 此命令只能执行一次。它会基于 `.env` 中的 `PASSWORD` 变量修改 docker-compose 中的组件密码，并修改 `config/config.yaml` 中的组件密码。如果 `.env` 中的密码发生变化，您需要首先执行 `docker-compose down`；`rm components -rf` 然后执行此命令。
 
 ```
-bashCopy code
+
 make install
 ```
 
 1. 检查服务
 
 ```
-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)
+![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>
 
 您需要 `Go 1.18` 或更高版本，以及 `make`。
 
-版本详情：https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/version.md
+版本详情：https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/version.md
 
 ```
-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
+git clone -b $BRANCH https://github.com/openimsdk/open-im-server openim && export openim=$(pwd)/openim && cd $openim && make build
 ```
 
-阅读关于 [OpenIM 版本策略](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/version.md)
+阅读关于 [OpenIM 版本策略](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/version.md)
 
 使用 `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>
 
@@ -180,7 +180,7 @@ config/config.yaml 文件为存储组件提供了详细的配置说明。
   - 用于 RPC 服务发现和注册，支持集群。
 
     ```
-    bashCopy codezookeeper:
+    zookeeper:
       schema: openim                          #不建议修改
       address: [ 127.0.0.1:2181 ]             #地址
       username:                               #用户名
@@ -192,7 +192,7 @@ config/config.yaml 文件为存储组件提供了详细的配置说明。
   - 用于存储用户、关系和群组，支持主从数据库。
 
     ```
-    bashCopy codemysql:
+    mysql:
       address: [ 127.0.0.1:13306 ]            #地址
       username: root                          #用户名
       password: openIM123                     #密码
@@ -209,7 +209,7 @@ config/config.yaml 文件为存储组件提供了详细的配置说明。
   - 用于存储离线消息，支持 mongo 分片集群。
 
     ```
-    bashCopy codemongo:
+    mongo:
       uri:                                    #如果不为空，则直接使用此值
       address: [ 127.0.0.1:37017 ]            #地址
       database: openIM                        #默认 mongo 数据库
@@ -223,7 +223,7 @@ config/config.yaml 文件为存储组件提供了详细的配置说明。
   - 用于存储消息序列号、最新消息、用户令牌和 mysql 缓存，支持集群部署。
 
     ```
-    bashCopy coderedis:
+    redis:
       address: [ 127.0.0.1:16379 ]            #地址
       username:                               #用户名
       password: openIM123                     #密码
@@ -234,7 +234,7 @@ config/config.yaml 文件为存储组件提供了详细的配置说明。
   - 用于消息队列，用于消息解耦，支持集群部署。
 
     ```
-    bashCopy codekafka:
+    kafka:
       username:                               #用户名
       password:                               #密码
       addr: [ 127.0.0.1:9092 ]                #地址
@@ -259,21 +259,21 @@ config/config.yaml 文件为存储组件提供了详细的配置说明。
 启动服务
 
 ```
-bashCopy code
+
 ./scripts/start-all.sh;
 ```
 
 检查服务
 
 ```
-bashCopy code
+
 ./scripts/check-all.sh
 ```
 
 停止服务
 
 ```
-bashCopy code
+
 ./scripts/stop-all.sh
 ```
 
@@ -302,30 +302,30 @@ bashCopy code
 
 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)
+![App-OpenIM 关系](https://github.com/openimsdk/open-im-server/blob/main/docs/images/open-im-server.png)
 
 ## :building_construction: 总体架构
 
 深入了解 Open-IM-Server 的功能与我们的架构图。
 
-![总体架构](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/images/Architecture.jpg)
+![总体架构](https://github.com/openimsdk/open-im-server/blob/main/docs/images/Architecture.jpg)
 
 ## :hammer_and_wrench: 开始开发 OpenIM
 
 OpenIM 我们的目标是建立一个顶级的开源社区。我们有一套标准，在 [Community repository](https://github.com/OpenIMSDK/community) 中。
 
-如果您想为这个 Open-IM-Server 仓库做贡献，请阅读我们的 [贡献者文档](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/CONTRIBUTING.md)。
+如果您想为这个 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)。
+在您开始之前，请确保您的更改是需要的。最好的方法是创建一个 [新的讨论](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)。
 
-- [代码标准](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)
+- [代码标准](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/)
+- [错误代码标准](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/error_code.md)
 
 ## :busts_in_silhouette: 社区
 
@@ -340,18 +340,18 @@ OpenIM 我们的目标是建立一个顶级的开源社区。我们有一套标
 
 我们的会议在 [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) 中找到。
+我们在 [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) 并分享您的使用案例。
+查看我们的 [用户案例研究](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 根据 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) 目录中显示，受版权法保护。
+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>
+<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

@@ -10,11 +10,11 @@
 
 
 <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://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-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://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>
 
@@ -99,9 +99,9 @@ Further enhancing your experience, we also provide an SDK client, wherein most c
 
 9. **The ultimate deployment experience 🤖** 
 
-   ✅  Supports [cluster deployment](https://github.com/OpenIMSDK/Open-IM-Server/edit/main/deployments/README.md)
+   ✅  Supports [cluster deployment](https://github.com/openimsdk/open-im-server/edit/main/deployments/README.md)
 
-   ✅  Supports multi-architecture mirroring, our Docker images are hosted not only on GitHub but also on Alibaba Cloud and Docker Hub supporting multiple architectures. Visit [our GitHub packages](https://github.com/orgs/OpenIMSDK/packages?repo_name=Open-IM-Server) and read our [version management document](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/version.md) for more information.
+   ✅  Supports multi-architecture mirroring, our Docker images are hosted not only on GitHub but also on Alibaba Cloud and Docker Hub supporting multiple architectures. Visit [our GitHub packages](https://github.com/orgs/OpenIMSDK/packages?repo_name=Open-IM-Server) and read our [version management document](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/version.md) for more information.
 
 11. **A large ecosystem of open source communities 🤲**
 
@@ -128,14 +128,11 @@ $ make demo
 
 
 ```bash
-# choose what you need, We take branch 3.2 as an example
-$ BRANCH=release-v3.2
-$ git clone -b $BRANCH https://github.com/OpenIMSDK/Open-IM-Server openim/openim-server && export openim_dir=$(pwd)/openim && cd ${openim_dir}/openim-server
+git clone -b main 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**
-> 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
-
+> If you don't know OpenIM's versioning policy, 📚Read our release policy: https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/version.md
 
 
 **2. Configure the config file**
@@ -144,42 +141,41 @@ If you tried to get started quickly with `make demo`, then you know that our con
 
 You can use `make init` to quickly initialize a configuration file
 
+Modify the automation script:
+
+```bash
+cat scripts/install/environment.sh
+```
+
+1. Recommended using environment variables:
+
+```bash
+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
+# DOCKER_BRIDGE_SUBNET: set the docker bridge network address
+export DOCKER_BRIDGE_SUBNET="172.28.0.0/16"
+# API_URL: under network environment, set OpenIM Server API address
+export API_URL="http://127.0.0.1:10002"
+```
+
+If you wish to use more custom features, read our [config documentation](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/environment.md).
+
+
+Next, update the configuration using make init:
+
 ```bash
 $ make init
 $ git diff
 ```
 
-Then feel free to modify your current config file,  you can also modify `/scripts/install/environment.sh` document template, `make init` is essentially rendering `environment.sh` template, and then through the `make init` to automatically generate a new configuration.
-
-If you only need to change the config file for a short time, or if you don't want to make any major changes in the future, you can modify the `.env file directly
-
-```bash
-USER=root 								#no need to modify
-PASSWORD=openIM123  					#A combination of 8 or more numbers and letters, this password applies to redis, mysql, mongo, as well as accessSecret in config/config.yaml
-ENDPOINT=http://127.0.0.1:10005 		#minio's external service IP and port, or use the domain name storage.xx.xx, the app must be able to access this IP and port or domain,
-API_URL=http://127.0.0.1:10002/object/ 	#the app must be able to access this IP and port or domain,
-DATA_DIR=./  							#designate large disk directory
-```
-
-**3. Deploy and start**
-
-> **Note**
->
-> You can deploy either directly with `make install` or with `docker compose up`, the logic is the same
-
-```bash
-$ make install
-# OR
-$ docker-compose up
-```
-
-4. Check the service
-
-```bash
-$ make check
-```
-
-Looking at the command line at this point, there are two items in the output, checking for the start of the component port that OpenIM depends on, and the start of the OpenIM core component
 
 </details> 
 
@@ -193,12 +189,29 @@ Ur need `Go 1.18` or higher version, and `make`.
 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
+Version Details: https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/version.md
+
+You can get the version number from the command below or from [github releases](https://github.com/openimsdk/open-im-server/tags).
 
 ```bash
-# 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 start
+$ curl --silent "https://api.github.com/repos/openimsdk/open-im-server/releases" | jq -r '.[].tag_name'
+```
+
+We have our own version management policy, if you are interested in our version management, I recommend reading [📚 OpenIM Version](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/version.md), We recommend using stable versions such as `v3.3.0` and `v3.2.0` whenever possible. `v3.1.1-alpha.3` as well as `v3.3.0-beta.0` and `v3.2.0-rc.0` are pre-release or beta versions and are not recommended.
+
+Set `OPENIM_VERSION` environment variables for the latest `OPENIM_VERSION` number, or replace the `OPENIM_VERSION` for you to install the OpenIM-Server `OPENIM_VERSION`:
+
+```bash
+$ OPENIM_VERSION=`curl -s https://api.github.com/repos/openimsdk/open-im-server/releases/latest | grep -oE '"tag_name": "[^"]+"' | head -n1 | cut -d'"' -f4`
+# OPENIM_VERSION=v3.3.0
+```
+
+Deploy basic components at the click of a command:
+
+```bash
+# install openim dependency
+$ git clone https://github.com/openimsdk/open-im-server openim/openim-server && export openim=$(pwd)/openim/openim-server && cd $openim/openim-server && git checkout $OPENIM_VERSION
+$ curl https://raw.githubusercontent.com/OpenIMSDK/openim-docker/main/example/basic-openim-server-dependency.yml -o basic-openim-server-dependency.yml && make init && docker compose -f basic-openim-server-dependency.yml up -d && make start
 ```
 
 > `make help` to help you see the instructions supported by OpenIM.
@@ -214,96 +227,16 @@ 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 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
-
-  - Used for RPC service discovery and registration, cluster support.
-
-    ```bash
-    zookeeper:
-      schema: openim                          #Not recommended to modify
-      address: [ 127.0.0.1:2181 ]             #address
-      username:                               #username
-      password:                               #password
-    ```
-
-- MySQL
-
-  - Used for storing users, relationships, and groups, supports master-slave database.
-
-    ```bash
-    mysql:
-      address: [ 127.0.0.1:13306 ]            #address
-      username: root                          #username
-      password: openIM123                     #password
-      database: openIM_v2                     #Not recommended to modify
-      maxOpenConn: 1000                       #maximum connection
-      maxIdleConn: 100                        #maximum idle connection
-      maxLifeTime: 60                         #maximum time a connection can be reused (seconds)
-      logLevel: 4                             #log level 1=slient 2=error 3=warn 4=info
-      slowThreshold: 500                      #slow statement threshold (milliseconds)
-    ```
-
-- Mongo
-
-  - Used for storing offline messages, supports mongo sharded clusters.
-
-    ```bash
-    mongo:
-      uri:                                    #Use this value directly if not empty
-      address: [ 127.0.0.1:37017 ]            #address
-      database: openIM                        #default mongo db
-      username: root                          #username
-      password: openIM123                     #password
-      maxPoolSize: 100                        #maximum connections
-    ```
-
-- Redis
-
-  - Used for storing message sequence numbers, latest messages, user tokens, and mysql cache, supports cluster deployment.
-
-    ```bash
-    redis:
-      address: [ 127.0.0.1:16379 ]            #address
-      username:                               #username
-      password: openIM123                     #password
-    ```
-
-- Kafka
-
-  - Used for message queues, for message decoupling, supports cluster deployment.
-
-    ```bash
-    kafka:
-      username:                               #username
-      password:                               #password
-      addr: [ 127.0.0.1:9092 ]                #address
-      latestMsgToRedis:
-        topic: "latestMsgToRedis"
-      offlineMsgToMongo:
-        topic: "offlineMsgToMongoMysql"
-      msgToPush:
-        topic: "msqToPush"
-      msgToModify:
-        topic: "msgToModify"
-      consumerGroupID:
-        msgToRedis: redis
-        msgToMongo: mongo
-        msgToMySql: mysql
-        msgToPush: push
-        msgToModify: modify
-    ```
+Read: Configuration center document：https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/environment.md
 
 </details>
 
+
 <details>  <summary>Deployed with kubernetes</summary>
 
 
-read: https://github.com/OpenIMSDK/Open-IM-Server/blob/main/deployments/README.md
+Read: https://github.com/openimsdk/open-im-server/blob/main/deployments/README.md
 
 </details> 
 
@@ -335,30 +268,30 @@ read: https://github.com/OpenIMSDK/Open-IM-Server/blob/main/deployments/README.m
 
 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.
 
-![App-OpenIM Relationship](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/images/open-im-server.png)
+![App-OpenIM Relationship](https://github.com/openimsdk/open-im-server/blob/main/docs/images/open-im-server.png)
 
 ## :building_construction: Overall Architecture
 
 Delve into the heart of Open-IM-Server's functionality with our architecture diagram.
 
-![Overall Architecture](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/images/Architecture.jpg)
+![Overall Architecture](https://github.com/openimsdk/open-im-server/blob/main/docs/images/Architecture.jpg)
 
 ## :hammer_and_wrench: To start developing OpenIM
 
 OpenIM Our goal is to build a top-level open source community. We have a set of standards, in the [Community repository](https://github.com/OpenIMSDK/community).
 
-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).
+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-22720d66b-o_FvKxMTGXtcnnnHiMqe9Q), 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)
-- [Directory Standards](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/directory.md)
-- [Commit Standards](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/commit.md)
-- [Versioning Standards](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/version.md)
-- [Interface Standards](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/api.md)
-- [Log Standards](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/log.md)
-- [Error Code Standards](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/error_code.md)
+- [Code Standards](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/go_code.md)
+- [Docker Images Standards](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/images.md)
+- [Directory Standards](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/directory.md)
+- [Commit Standards](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/commit.md)
+- [Versioning Standards](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/version.md)
+- [Interface Standards](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/api.md)
+- [Log Standards](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/logging.md)
+- [Error Code Standards](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/error_code.md)
 
 ## :busts_in_silhouette: Community
 
@@ -373,20 +306,20 @@ We want anyone to get involved in our community and contributing code, we offer
 
 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).
+We take notes of each [biweekly meeting](https://github.com/orgs/OpenIMSDK/discussions/categories/meeting) in [GitHub discussions](https://github.com/openimsdk/open-im-server/discussions/categories/meeting), Our historical meeting notes, as well as replays of the meetings are available at [Google Docs :bookmark_tabs:](https://docs.google.com/document/d/1nx8MDpuG74NASx081JcCpxPgDITNTpIIos0DS6Vr9GU/edit?usp=sharing).
 
 ## :eyes: Who are using OpenIM
 
-Check out our [user case studies](https://github.com/OpenIMSDK/community/blob/main/ADOPTERS.md) page for a list of the project users. Don't hesitate to leave a [📝comment](https://github.com/OpenIMSDK/Open-IM-Server/issues/379) and share your use case.
+Check out our [user case studies](https://github.com/OpenIMSDK/community/blob/main/ADOPTERS.md) page for a list of the project users. Don't hesitate to leave a [📝comment](https://github.com/openimsdk/open-im-server/issues/379) and share your use case.
 
 ## :page_facing_up: License
 
-OpenIM is licensed under the Apache 2.0 license. See [LICENSE](https://github.com/OpenIMSDK/Open-IM-Server/tree/main/LICENSE) for the full license text.
+OpenIM is licensed under the Apache 2.0 license. See [LICENSE](https://github.com/openimsdk/open-im-server/tree/main/LICENSE) for the full license text.
 
-The OpenIM logo, including its variations and animated versions, displayed in this repository [OpenIM](https://github.com/OpenIMSDK/Open-IM-Server) under the [assets/logo](./assets/logo) and [assets/logo-gif](assets/logo-gif) directories, are protected by copyright laws.
+The OpenIM logo, including its variations and animated versions, displayed in this repository [OpenIM](https://github.com/openimsdk/open-im-server) under the [assets/logo](./assets/logo) and [assets/logo-gif](assets/logo-gif) directories, are protected by copyright laws.
 
 ## 🔮 Thanks to our contributors!
 
-<a href="https://github.com/OpenIMSDK/Open-IM-Server/graphs/contributors">
-  <img src="https://contrib.rocks/image?repo=OpenIMSDK/Open-IM-Server" />
+<a href="https://github.com/openimsdk/open-im-server/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=openimsdk/open-im-server" />
 </a>

build/goreleaser.yaml

@@ -484,8 +484,8 @@ changelog:
 #     use: buildx
 #     build_flag_templates:
 #       - "--pull"
-#       - "--label=io.artifacthub.package.readme-url=https://raw.githubusercontent.com/OpenIMSDK/Open-IM-Server/main/README.md"
-#       - "--label=io.artifacthub.package.logo-url=hhttps://github.com/OpenIMSDK/Open-IM-Server/blob/main/assets/logo/openim-logo-green.png"
+#       - "--label=io.artifacthub.package.readme-url=https://raw.githubusercontent.com/openimsdk/open-im-server/main/README.md"
+#       - "--label=io.artifacthub.package.logo-url=hhttps://github.com/openimsdk/open-im-server/blob/main/assets/logo/openim-logo-green.png"
 #       - '--label=io.artifacthub.package.maintainers=[{"name":"Xinwei Xiong","email":"3293172751nss@gmail.com"}]'
 #       - "--label=io.artifacthub.package.license=Apace-2.0"
 #       - "--label=org.opencontainers.image.description=OpenIM Open source top instant messaging system"
@@ -504,8 +504,8 @@ changelog:
 #     use: buildx
 #     build_flag_templates:
 #       - "--pull"
-#       - "--label=io.artifacthub.package.readme-url=https://raw.githubusercontent.com/OpenIMSDK/Open-IM-Server/main/README.md"
-#       - "--label=io.artifacthub.package.logo-url=hhttps://github.com/OpenIMSDK/Open-IM-Server/blob/main/assets/logo/openim-logo-green.png"
+#       - "--label=io.artifacthub.package.readme-url=https://raw.githubusercontent.com/openimsdk/open-im-server/main/README.md"
+#       - "--label=io.artifacthub.package.logo-url=hhttps://github.com/openimsdk/open-im-server/blob/main/assets/logo/openim-logo-green.png"
 #       - '--label=io.artifacthub.package.maintainers=[{"name":"Xinwei Xiong","email":"3293172751nss@gmail.com"}]'
 #       - "--label=io.artifacthub.package.license=Apace-2.0"
 #       - "--label=org.opencontainers.image.description=OpenIM Open source top instant messaging system"
@@ -555,7 +555,7 @@ nfpms:
       - openim-rpc-user
     # Your app's vendor.
     vendor: OpenIMSDK
-    homepage: https://github.com/OpenIMSDK/Open-IM-Server
+    homepage: https://github.com/openimsdk/open-im-server
     maintainer: kubbot <https://github.com/kubbot>
     description: |-
       Auto sync github labels

build/images/openim-api/Dockerfile

@@ -43,10 +43,8 @@ COPY --from=builder /openim/openim-server/_output/bin/platforms /openim/openim-s
 COPY --from=builder /openim/openim-server/config /openim/openim-server/config
 
 ENV PORT 10002
-ENV CONFIG=/openim/openim-server/config
-
-EXPOSE $PORT
+EXPOSE 10002
 
 RUN mv ${OPENIM_SERVER_BINDIR}/platforms/$(get_os)/$(get_arch)/openim-api /usr/bin/openim-api
 
-ENTRYPOINT ["bash", "-c", "openim-api -c $CONFIG --port $PORT"]
+ENTRYPOINT ["bash", "-c", "openim-api -c $OPENIM_SERVER_CONFIG_NAME --port $PORT"]

build/images/openim-crontask/Dockerfile

@@ -41,8 +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
 
-ENV CONFIG=/openim/openim-server/config
+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 $CONFIG"]
+CMD ["bash", "-c", "openim-crontask -c $OPENIM_SERVER_CONFIG_NAME"]

build/images/openim-msggateway/Dockerfile

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

build/images/openim-msgtransfer/Dockerfile

@@ -43,4 +43,4 @@ COPY --from=builder /openim/openim-server/config /openim/openim-server/config
 
 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 $CONFIG --prometheus_port $PROMETHEUS_PORT; else openim-msgtransfer -c $CONFIG; fi"]
+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

@@ -43,11 +43,10 @@ COPY --from=builder /openim/openim-server/_output/bin/platforms /openim/openim-s
 COPY --from=builder /openim/openim-server/config /openim/openim-server/config
 
 ENV PORT 10170 \
-    PROMETHEUS_PORT 20170 \
-    CONFIG=/openim/openim-server/config
+    PROMETHEUS_PORT 20170
 
-EXPOSE $PORT
+EXPOSE 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 $CONFIG --port $PORT --prometheus_port $PROMETHEUS_PORT; else openim-push -c $CONFIG --port $PORT; fi"]
+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

@@ -42,11 +42,11 @@ 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 10160
-ENV CONFIG=/openim/openim-server/config
+ENV PORT 10160 \
+    PROMETHEUS_PORT 20160
 
-EXPOSE $PORT
+EXPOSE 10160
 
 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 $CONFIG" --prometheus_port $PROMETHEUS_PORT; else "openim-rpc-auth --port $PORT -c $CONFIG"; fi"]
+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

@@ -43,12 +43,10 @@ COPY --from=builder /openim/openim-server/_output/bin/platforms /openim/openim-s
 COPY --from=builder /openim/openim-server/config /openim/openim-server/config
 
 ENV PORT 10230 \
-    PROMETHEUS_PORT 20230 \
-    CONFIG=/openim/openim-server/config
+    PROMETHEUS_PORT 20230
 
-EXPOSE $PORT
-EXPOSE $PROMETHEUS_PORT
+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 $CONFIG" --prometheus_port $PROMETHEUS_PORT; else "openim-rpc-conversation --port $PORT -c $CONFIG"; fi"]
+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

@@ -43,12 +43,10 @@ COPY --from=builder /openim/openim-server/_output/bin/platforms /openim/openim-s
 COPY --from=builder /openim/openim-server/config /openim/openim-server/config
 
 ENV PORT 10120 \
-    PROMETHEUS_PORT 20120 \
-    CONFIG=/openim/openim-server/config
+    PROMETHEUS_PORT 20120
 
-EXPOSE $PORT
-EXPOSE $PROMETHEUS_PORT
+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 $CONFIG" --prometheus_port $PROMETHEUS_PORT; else "openim-rpc-friend --port $PORT -c $CONFIG"; fi"]
+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

@@ -43,12 +43,10 @@ COPY --from=builder /openim/openim-server/_output/bin/platforms /openim/openim-s
 COPY --from=builder /openim/openim-server/config /openim/openim-server/config
 
 ENV PORT 10150 \
-    PROMETHEUS_PORT 20150 \
-    CONFIG=/openim/openim-server/config
+    PROMETHEUS_PORT 20150
 
-EXPOSE $PORT
-EXPOSE $PROMETHEUS_PORT
+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 $CONFIG" --prometheus_port $PROMETHEUS_PORT; else "openim-rpc-group --port $PORT -c $CONFIG"; fi"]
+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

@@ -43,12 +43,10 @@ COPY --from=builder /openim/openim-server/_output/bin/platforms /openim/openim-s
 COPY --from=builder /openim/openim-server/config /openim/openim-server/config
 
 ENV PORT 10130 \
-    PROMETHEUS_PORT 20130 \
-    CONFIG=/openim/openim-server/config
+    PROMETHEUS_PORT 20130
 
-EXPOSE $PORT
-EXPOSE $PROMETHEUS_PORT
+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 $CONFIG" --prometheus_port $PROMETHEUS_PORT; else "openim-rpc-msg --port $PORT -c $CONFIG"; fi"]
+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

@@ -43,11 +43,11 @@ 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 10200 \
-    CONFIG=/openim/openim-server/config
+ENV PORT 10190 \
+    PROMETHEUS_PORT 21301
 
-EXPOSE $PORT
+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 $CONFIG" --prometheus_port $PROMETHEUS_PORT; else "openim-rpc-third --port $PORT -c $CONFIG"; fi"]
+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

@@ -43,10 +43,10 @@ COPY --from=builder /openim/openim-server/_output/bin/platforms /openim/openim-s
 COPY --from=builder /openim/openim-server/config /openim/openim-server/config
 
 ENV PORT 10110 \
-    CONFIG=/openim/openim-server/config
+    PROMETHEUS_PORT 20110
 
-EXPOSE $PORT
+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 $CONFIG" --prometheus_port $PROMETHEUS_PORT; else "openim-rpc-user --port $PORT -c $CONFIG"; fi"]
+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

@@ -42,8 +42,8 @@ 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 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 $CONFIG"]
+ENTRYPOINT ["bash", "-c", "component -c $OPENIM_SERVER_CONFIG_NAME"]

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

@@ -50,7 +50,7 @@ COPY --from=builder /openim/openim-server/dist /openim/openim-server/dist
 ENV PORT 11001
 ENV DISTPATH /openim/openim-server/dist
 
-EXPOSE $PORT
+EXPOSE 11001
 
 RUN mv ${OPENIM_SERVER_BINDIR}/tools/$(get_os)/$(get_arch)/openim-web /usr/bin/openim-web
 

cmd/openim-api/main.go

@@ -18,9 +18,6 @@ import (
 	"context"
 	"fmt"
 	"net"
-	"net/http"
-	"os"
-	"runtime"
 	"strconv"
 	"time"
 
@@ -31,10 +28,10 @@ import (
 	openkeeper "github.com/OpenIMSDK/tools/discoveryregistry/zookeeper"
 	"github.com/OpenIMSDK/tools/log"
 
-	"github.com/OpenIMSDK/Open-IM-Server/internal/api"
-	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/cmd"
-	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/config"
-	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/db/cache"
+	"github.com/openimsdk/open-im-server/v3/internal/api"
+	"github.com/openimsdk/open-im-server/v3/pkg/common/cmd"
+	"github.com/openimsdk/open-im-server/v3/pkg/common/config"
+	"github.com/openimsdk/open-im-server/v3/pkg/common/db/cache"
 )
 
 func main() {
@@ -46,16 +43,6 @@ func main() {
 	}
 }
 
-func startPprof() {
-	runtime.GOMAXPROCS(1)
-	runtime.SetMutexProfileFraction(1)
-	runtime.SetBlockProfileRate(1)
-	if err := http.ListenAndServe(":6060", nil); err != nil {
-		panic(err)
-	}
-	os.Exit(0)
-}
-
 func run(port int) error {
 	if port == 0 {
 		return fmt.Errorf("port is empty")
@@ -92,7 +79,6 @@ func run(port int) error {
 	}
 	fmt.Println("start api server, address: ", address, ", OpenIM version: ", config.Version)
 	log.ZInfo(context.Background(), "start server success", "address", address, "version", config.Version)
-	go startPprof()
 	err = router.Run(address)
 	if err != nil {
 		log.ZError(context.Background(), "api run failed ", err, "address", address)

cmd/openim-cmdutils/main.go

@@ -15,7 +15,7 @@
 package main
 
 import (
-	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/cmd"
+	"github.com/openimsdk/open-im-server/v3/pkg/common/cmd"
 )
 
 func main() {

cmd/openim-crontask/main.go

@@ -15,8 +15,8 @@
 package main
 
 import (
-	"github.com/OpenIMSDK/Open-IM-Server/internal/tools"
-	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/cmd"
+	"github.com/openimsdk/open-im-server/v3/internal/tools"
+	"github.com/openimsdk/open-im-server/v3/pkg/common/cmd"
 )
 
 func main() {

cmd/openim-msggateway/main.go

@@ -15,7 +15,7 @@
 package main
 
 import (
-	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/cmd"
+	"github.com/openimsdk/open-im-server/v3/pkg/common/cmd"
 )
 
 func main() {

cmd/openim-msgtransfer/main.go

@@ -15,7 +15,7 @@
 package main
 
 import (
-	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/cmd"
+	"github.com/openimsdk/open-im-server/v3/pkg/common/cmd"
 )
 
 func main() {

cmd/openim-push/main.go

@@ -15,9 +15,9 @@
 package main
 
 import (
-	"github.com/OpenIMSDK/Open-IM-Server/internal/push"
-	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/cmd"
-	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/config"
+	"github.com/openimsdk/open-im-server/v3/internal/push"
+	"github.com/openimsdk/open-im-server/v3/pkg/common/cmd"
+	"github.com/openimsdk/open-im-server/v3/pkg/common/config"
 )
 
 func main() {

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

@@ -15,9 +15,9 @@
 package main
 
 import (
-	"github.com/OpenIMSDK/Open-IM-Server/internal/rpc/auth"
-	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/cmd"
-	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/config"
+	"github.com/openimsdk/open-im-server/v3/internal/rpc/auth"
+	"github.com/openimsdk/open-im-server/v3/pkg/common/cmd"
+	"github.com/openimsdk/open-im-server/v3/pkg/common/config"
 )
 
 func main() {

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

@@ -15,9 +15,9 @@
 package main
 
 import (
-	"github.com/OpenIMSDK/Open-IM-Server/internal/rpc/conversation"
-	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/cmd"
-	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/config"
+	"github.com/openimsdk/open-im-server/v3/internal/rpc/conversation"
+	"github.com/openimsdk/open-im-server/v3/pkg/common/cmd"
+	"github.com/openimsdk/open-im-server/v3/pkg/common/config"
 )
 
 func main() {

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

@@ -15,9 +15,9 @@
 package main
 
 import (
-	"github.com/OpenIMSDK/Open-IM-Server/internal/rpc/friend"
-	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/cmd"
-	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/config"
+	"github.com/openimsdk/open-im-server/v3/internal/rpc/friend"
+	"github.com/openimsdk/open-im-server/v3/pkg/common/cmd"
+	"github.com/openimsdk/open-im-server/v3/pkg/common/config"
 )
 
 func main() {

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

@@ -15,9 +15,9 @@
 package main
 
 import (
-	"github.com/OpenIMSDK/Open-IM-Server/internal/rpc/group"
-	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/cmd"
-	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/config"
+	"github.com/openimsdk/open-im-server/v3/internal/rpc/group"
+	"github.com/openimsdk/open-im-server/v3/pkg/common/cmd"
+	"github.com/openimsdk/open-im-server/v3/pkg/common/config"
 )
 
 func main() {

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

@@ -15,9 +15,9 @@
 package main
 
 import (
-	"github.com/OpenIMSDK/Open-IM-Server/internal/rpc/msg"
-	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/cmd"
-	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/config"
+	"github.com/openimsdk/open-im-server/v3/internal/rpc/msg"
+	"github.com/openimsdk/open-im-server/v3/pkg/common/cmd"
+	"github.com/openimsdk/open-im-server/v3/pkg/common/config"
 )
 
 func main() {

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

@@ -15,9 +15,9 @@
 package main
 
 import (
-	"github.com/OpenIMSDK/Open-IM-Server/internal/rpc/third"
-	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/cmd"
-	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/config"
+	"github.com/openimsdk/open-im-server/v3/internal/rpc/third"
+	"github.com/openimsdk/open-im-server/v3/pkg/common/cmd"
+	"github.com/openimsdk/open-im-server/v3/pkg/common/config"
 )
 
 func main() {

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

@@ -15,9 +15,9 @@
 package main
 
 import (
-	"github.com/OpenIMSDK/Open-IM-Server/internal/rpc/user"
-	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/cmd"
-	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/config"
+	"github.com/openimsdk/open-im-server/v3/internal/rpc/user"
+	"github.com/openimsdk/open-im-server/v3/pkg/common/cmd"
+	"github.com/openimsdk/open-im-server/v3/pkg/common/config"
 )
 
 func main() {

config/config.yaml

@@ -28,9 +28,9 @@
 # Zookeeper password
 zookeeper:
   schema: openim
-  address: [ 127.0.0.1:2181 ]
-  username:
-  password:
+  address: [ 172.28.0.1:12181 ]
+  username: ''
+  password: ''
 
 ###################### Mysql ######################
 # MySQL configuration
@@ -42,7 +42,7 @@ 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
@@ -60,8 +60,8 @@ 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
@@ -72,8 +72,8 @@ mongo:
 #
 # 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 configuration information ######################
@@ -84,9 +84,9 @@ 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"
   offlineMsgToMongo:
@@ -105,7 +105,7 @@ kafka:
 # 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 configuration information ######################
@@ -132,26 +132,27 @@ api:
 # minio.signEndpoint is minio public network address
 object:
   enable: "minio"
-  apiURL: "http://127.0.0.1:10002"
+  apiURL: "http://172.28.0.1:10002"
   minio:
     bucket: "openim"
-    endpoint: "http://127.0.0.1:10005"
+    endpoint: "http://172.28.0.1:10005"
     accessKeyID: "root"
     secretAccessKey: "openIM123"
-    sessionToken: ""
-    signEndpoint: "http://127.0.0.1:10005"
+    sessionToken: ''
+    signEndpoint: "http://172.28.0.1:10005"
   cos:
-    bucketURL: "https://temp-1252357374.cos.ap-chengdu.myqcloud.com"
-    secretID: ""
-    secretKey: ""
-    sessionToken: ""
+    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: ""
-    accessKeySecret: ""
-    sessionToken: ""
+    accessKeyID: ''
+    accessKeySecret: ''
+    sessionToken: ''
+
 
 ###################### RPC Port Configuration ######################
 # RPC service ports
@@ -193,11 +194,11 @@ rpcRegisterName:
 # Whether to output in json format
 # Whether to include stack trace in logs
 log:
-  storageLocation: ../../../../../logs/
+  storageLocation: /root/workspaces/openim/openim-server/logs/
   rotationTime: 24
   remainRotationCount: 2
   remainLogLevel: 6
-  isStdout: false 
+  isStdout: false
   isJson: false
   withStack: false
 

deployments/README.md

@@ -7,7 +7,7 @@ OpenIM 支持很多种集群化部署方式，包括但不限于 helm, sealos, k
 目前各个贡献者，以及之前的官方有出过一些可以参考的方案：
 
 - https://github.com/OpenIMSDK/k8s-jenkins
-- https://github.com/OpenIMSDK/Open-IM-Server-k8s-deploy
+- https://github.com/openimsdk/open-im-server-k8s-deploy
 - https://github.com/OpenIMSDK/openim-charts
 - https://github.com/showurl/deploy-openim
 
@@ -19,12 +19,83 @@ Kubernetes: >= 1.16.0-0
 Helm: >= 3.0
 ```
 
-假设 OpenIM 项目根目录路径为 `OpenIM_ROOT`
 
-进入 OpenIM 项目根目录
+### 最低配置
 
-$ cd ${OpenIM_ROOT}
+建议生产环境的最低配置如下：
 
+```bash
+CPU: 4
+Memory: 8G
+Disk: 100G
+```
+
+## 生成配置文件
+
+我们将自动文件全部自动化处理了，所以生成配置文件对于 openim 来说是可选的，但是如果你想要自定义配置，可以参考下面的步骤：
+
+```bash
+$ make init
+# 或者是使用脚本:
+# ./scripts/init-config.sh
+```
+此时会帮你在 `deployments/openim/config` 目录下生成配置文件，你可以根据自己的需求进行修改。
+
+
+## 集群搭建
+
+如果你已经有了一个 `kubernetes` 集群，或者是你希望自己从头开始搭建一个 `kubernetes` 那么你可以直接跳过这一步。
+
+为了快速开始，我使用 [sealos](https://github.com/labring/sealos) 来快速搭建集群，sealos 底层也是对 kubeadm 的封装:
+
+```bash
+$ SEALOS_VERSION=`curl -s https://api.github.com/repos/labring/sealos/releases/latest | grep -oE '"tag_name": "[^"]+"' | head -n1 | cut -d'"' -f4` && \
+  curl -sfL https://raw.githubusercontent.com/labring/sealos/${SEALOS_VERSION}/scripts/install.sh |
+  sh -s ${SEALOS_VERSION} labring/sealos
+```
+
+**支持的版本：**
+
++ docker: `labring/kubernetes-docker`:(v1.24.0~v1.27.0)
++ containerd: `labring/kubernetes`:(v1.24.0~v1.27.0)
+
+
+#### 安装集群：
+
+集群的信息如下：
+
+| 机器名   | IP地址          | 系统信息                                                                                                    |
+|---------|-----------------|------------------------------------------------------------------------------------------------------------|
+| master01| 10.0.0.9   | Linux VM-0-9-ubuntu 5.15.0-76-generic #83-Ubuntu SMP Thu Jun 15 19:16:32 UTC 2023 x86_64 x86_64 x86_64 GNU/Linux |
+| node01  | 10.0.0.4   | Linux VM-0-9-ubuntu 5.15.0-76-generic #83-Ubuntu SMP Thu Jun 15 19:16:32 UTC 2023 x86_64 x86_64 x86_64 GNU/Linux |
+| node02  | 10.0.0.10  | Linux VM-0-9-ubuntu 5.15.0-76-generic #83-Ubuntu SMP Thu Jun 15 19:16:32 UTC 2023 x86_64 x86_64 x86_64 GNU/Linux |
+
+```bash
+$ export CLUSTER_USERNAME=ubuntu
+$ export CLUSTER_PASSWORD=123456
+$ sealos run labring/kubernetes:v1.25.0 labring/helm:v3.8.2 labring/calico:v3.24.1 \
+    --masters 10.0.0.9 \
+    --nodes 10.0.0.4,10.0.0.10 \
+    -u "$CLUSTER_USERNAME" \
+    -p "$CLUSTER_PASSWORD"
+```
+
+### 安装 helm
+
+helm通过打包的方式，支持发布的版本管理和控制，很大程度上简化了Kubernetes应用的部署和管理。
+
+
+**使用脚本：**
+
+```bash
+$ curl https://raw.githubusercontent.com/helm/helm/main/scripts/get-helm-3 | bash
+```
+
+**添加仓库：**
+
+```bash
+$ helm repo add brigade https://openimsdk.github.io/openim-charts
+```
 
 
 ### 容器化安装

deployments/openim-chat/.helmignore

@@ -0,0 +1,23 @@
+# Patterns to ignore when building packages.
+# This supports shell glob matching, relative path matching, and
+# negation (prefixed with !). Only one pattern per line.
+.DS_Store
+# Common VCS dirs
+.git/
+.gitignore
+.bzr/
+.bzrignore
+.hg/
+.hgignore
+.svn/
+# Common backup files
+*.swp
+*.bak
+*.tmp
+*.orig
+*~
+# Various IDEs
+.project
+.idea/
+*.tmproj
+.vscode/

deployments/openim-chat/Chart.yaml

@@ -0,0 +1,38 @@
+# 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.
+
+apiVersion: v2
+name: openim-chat
+description: A Helm chart for Kubernetes
+
+# A chart can be either an 'application' or a 'library' chart.
+#
+# Application charts are a collection of templates that can be packaged into versioned archives
+# to be deployed.
+#
+# Library charts provide useful utilities or functions for the chart developer. They're included as
+# a dependency of application charts to inject those utilities and functions into the rendering
+# pipeline. Library charts do not define any templates and therefore cannot be deployed.
+type: application
+
+# This is the chart version. This version number should be incremented each time you make changes
+# to the chart and its templates, including the app version.
+# Versions are expected to follow Semantic Versioning (https://semver.org/)
+version: 0.1.0
+
+# This is the version number of the application being deployed. This version number should be
+# incremented each time you make changes to the application. Versions are not expected to
+# follow Semantic Versioning. They should reflect the version the application is using.
+# It is recommended to use it with quotes.
+appVersion: "1.16.0"

deployments/openim-chat/templates/NOTES.txt

@@ -0,0 +1,22 @@
+1. Get the application URL by running these commands:
+{{- if .Values.ingress.enabled }}
+{{- range $host := .Values.ingress.hosts }}
+  {{- range .paths }}
+  http{{ if $.Values.ingress.tls }}s{{ end }}://{{ $host.host }}{{ .path }}
+  {{- end }}
+{{- end }}
+{{- else if contains "NodePort" .Values.service.type }}
+  export NODE_PORT=$(kubectl get --namespace {{ .Release.Namespace }} -o jsonpath="{.spec.ports[0].nodePort}" services {{ include "openim-chat.fullname" . }})
+  export NODE_IP=$(kubectl get nodes --namespace {{ .Release.Namespace }} -o jsonpath="{.items[0].status.addresses[0].address}")
+  echo http://$NODE_IP:$NODE_PORT
+{{- else if contains "LoadBalancer" .Values.service.type }}
+     NOTE: It may take a few minutes for the LoadBalancer IP to be available.
+           You can watch the status of by running 'kubectl get --namespace {{ .Release.Namespace }} svc -w {{ include "openim-chat.fullname" . }}'
+  export SERVICE_IP=$(kubectl get svc --namespace {{ .Release.Namespace }} {{ include "openim-chat.fullname" . }} --template "{{"{{ range (index .status.loadBalancer.ingress 0) }}{{.}}{{ end }}"}}")
+  echo http://$SERVICE_IP:{{ .Values.service.port }}
+{{- else if contains "ClusterIP" .Values.service.type }}
+  export POD_NAME=$(kubectl get pods --namespace {{ .Release.Namespace }} -l "app.kubernetes.io/name={{ include "openim-chat.name" . }},app.kubernetes.io/instance={{ .Release.Name }}" -o jsonpath="{.items[0].metadata.name}")
+  export CONTAINER_PORT=$(kubectl get pod --namespace {{ .Release.Namespace }} $POD_NAME -o jsonpath="{.spec.containers[0].ports[0].containerPort}")
+  echo "Visit http://127.0.0.1:8080 to use your application"
+  kubectl --namespace {{ .Release.Namespace }} port-forward $POD_NAME 8080:$CONTAINER_PORT
+{{- end }}

deployments/openim-chat/templates/_helpers.tpl

@@ -0,0 +1,62 @@
+{{/*
+Expand the name of the chart.
+*/}}
+{{- define "openim-chat.name" -}}
+{{- default .Chart.Name .Values.nameOverride | trunc 63 | trimSuffix "-" }}
+{{- end }}
+
+{{/*
+Create a default fully qualified app name.
+We truncate at 63 chars because some Kubernetes name fields are limited to this (by the DNS naming spec).
+If release name contains chart name it will be used as a full name.
+*/}}
+{{- define "openim-chat.fullname" -}}
+{{- if .Values.fullnameOverride }}
+{{- .Values.fullnameOverride | trunc 63 | trimSuffix "-" }}
+{{- else }}
+{{- $name := default .Chart.Name .Values.nameOverride }}
+{{- if contains $name .Release.Name }}
+{{- .Release.Name | trunc 63 | trimSuffix "-" }}
+{{- else }}
+{{- printf "%s-%s" .Release.Name $name | trunc 63 | trimSuffix "-" }}
+{{- end }}
+{{- end }}
+{{- end }}
+
+{{/*
+Create chart name and version as used by the chart label.
+*/}}
+{{- define "openim-chat.chart" -}}
+{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" }}
+{{- end }}
+
+{{/*
+Common labels
+*/}}
+{{- define "openim-chat.labels" -}}
+helm.sh/chart: {{ include "openim-chat.chart" . }}
+{{ include "openim-chat.selectorLabels" . }}
+{{- if .Chart.AppVersion }}
+app.kubernetes.io/version: {{ .Chart.AppVersion | quote }}
+{{- end }}
+app.kubernetes.io/managed-by: {{ .Release.Service }}
+{{- end }}
+
+{{/*
+Selector labels
+*/}}
+{{- define "openim-chat.selectorLabels" -}}
+app.kubernetes.io/name: {{ include "openim-chat.name" . }}
+app.kubernetes.io/instance: {{ .Release.Name }}
+{{- end }}
+
+{{/*
+Create the name of the service account to use
+*/}}
+{{- define "openim-chat.serviceAccountName" -}}
+{{- if .Values.serviceAccount.create }}
+{{- default (include "openim-chat.fullname" .) .Values.serviceAccount.name }}
+{{- else }}
+{{- default "default" .Values.serviceAccount.name }}
+{{- end }}
+{{- end }}

deployments/openim-chat/templates/deployment.yaml

@@ -0,0 +1,75 @@
+# 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.
+
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: {{ include "openim-chat.fullname" . }}
+  labels:
+    {{- include "openim-chat.labels" . | nindent 4 }}
+spec:
+  {{- if not .Values.autoscaling.enabled }}
+  replicas: {{ .Values.replicaCount }}
+  {{- end }}
+  selector:
+    matchLabels:
+      {{- include "openim-chat.selectorLabels" . | nindent 6 }}
+  template:
+    metadata:
+      {{- with .Values.podAnnotations }}
+      annotations:
+        {{- toYaml . | nindent 8 }}
+      {{- end }}
+      labels:
+        {{- include "openim-chat.selectorLabels" . | nindent 8 }}
+    spec:
+      {{- with .Values.imagePullSecrets }}
+      imagePullSecrets:
+        {{- toYaml . | nindent 8 }}
+      {{- end }}
+      serviceAccountName: {{ include "openim-chat.serviceAccountName" . }}
+      securityContext:
+        {{- toYaml .Values.podSecurityContext | nindent 8 }}
+      containers:
+        - name: {{ .Chart.Name }}
+          securityContext:
+            {{- toYaml .Values.securityContext | nindent 12 }}
+          image: "{{ .Values.image.repository }}:{{ .Values.image.tag | default .Chart.AppVersion }}"
+          imagePullPolicy: {{ .Values.image.pullPolicy }}
+          ports:
+            - name: http
+              containerPort: 80
+              protocol: TCP
+          livenessProbe:
+            httpGet:
+              path: /
+              port: http
+          readinessProbe:
+            httpGet:
+              path: /
+              port: http
+          resources:
+            {{- toYaml .Values.resources | nindent 12 }}
+      {{- with .Values.nodeSelector }}
+      nodeSelector:
+        {{- toYaml . | nindent 8 }}
+      {{- end }}
+      {{- with .Values.affinity }}
+      affinity:
+        {{- toYaml . | nindent 8 }}
+      {{- end }}
+      {{- with .Values.tolerations }}
+      tolerations:
+        {{- toYaml . | nindent 8 }}
+      {{- end }}

deployments/openim-chat/templates/hpa.yaml

@@ -0,0 +1,42 @@
+# 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.
+
+{{- if .Values.autoscaling.enabled }}
+apiVersion: autoscaling/v2beta1
+kind: HorizontalPodAutoscaler
+metadata:
+  name: {{ include "openim-chat.fullname" . }}
+  labels:
+    {{- include "openim-chat.labels" . | nindent 4 }}
+spec:
+  scaleTargetRef:
+    apiVersion: apps/v1
+    kind: Deployment
+    name: {{ include "openim-chat.fullname" . }}
+  minReplicas: {{ .Values.autoscaling.minReplicas }}
+  maxReplicas: {{ .Values.autoscaling.maxReplicas }}
+  metrics:
+    {{- if .Values.autoscaling.targetCPUUtilizationPercentage }}
+    - type: Resource
+      resource:
+        name: cpu
+        targetAverageUtilization: {{ .Values.autoscaling.targetCPUUtilizationPercentage }}
+    {{- end }}
+    {{- if .Values.autoscaling.targetMemoryUtilizationPercentage }}
+    - type: Resource
+      resource:
+        name: memory
+        targetAverageUtilization: {{ .Values.autoscaling.targetMemoryUtilizationPercentage }}
+    {{- end }}
+{{- end }}

deployments/openim-chat/templates/ingress.yaml

@@ -0,0 +1,75 @@
+# 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.
+
+{{- if .Values.ingress.enabled -}}
+{{- $fullName := include "openim-chat.fullname" . -}}
+{{- $svcPort := .Values.service.port -}}
+{{- if and .Values.ingress.className (not (semverCompare ">=1.18-0" .Capabilities.KubeVersion.GitVersion)) }}
+  {{- if not (hasKey .Values.ingress.annotations "kubernetes.io/ingress.class") }}
+  {{- $_ := set .Values.ingress.annotations "kubernetes.io/ingress.class" .Values.ingress.className}}
+  {{- end }}
+{{- end }}
+{{- if semverCompare ">=1.19-0" .Capabilities.KubeVersion.GitVersion -}}
+apiVersion: networking.k8s.io/v1
+{{- else if semverCompare ">=1.14-0" .Capabilities.KubeVersion.GitVersion -}}
+apiVersion: networking.k8s.io/v1beta1
+{{- else -}}
+apiVersion: extensions/v1beta1
+{{- end }}
+kind: Ingress
+metadata:
+  name: {{ $fullName }}
+  labels:
+    {{- include "openim-chat.labels" . | nindent 4 }}
+  {{- with .Values.ingress.annotations }}
+  annotations:
+    {{- toYaml . | nindent 4 }}
+  {{- end }}
+spec:
+  {{- if and .Values.ingress.className (semverCompare ">=1.18-0" .Capabilities.KubeVersion.GitVersion) }}
+  ingressClassName: {{ .Values.ingress.className }}
+  {{- end }}
+  {{- if .Values.ingress.tls }}
+  tls:
+    {{- range .Values.ingress.tls }}
+    - hosts:
+        {{- range .hosts }}
+        - {{ . | quote }}
+        {{- end }}
+      secretName: {{ .secretName }}
+    {{- end }}
+  {{- end }}
+  rules:
+    {{- range .Values.ingress.hosts }}
+    - host: {{ .host | quote }}
+      http:
+        paths:
+          {{- range .paths }}
+          - path: {{ .path }}
+            {{- if and .pathType (semverCompare ">=1.18-0" $.Capabilities.KubeVersion.GitVersion) }}
+            pathType: {{ .pathType }}
+            {{- end }}
+            backend:
+              {{- if semverCompare ">=1.19-0" $.Capabilities.KubeVersion.GitVersion }}
+              service:
+                name: {{ $fullName }}
+                port:
+                  number: {{ $svcPort }}
+              {{- else }}
+              serviceName: {{ $fullName }}
+              servicePort: {{ $svcPort }}
+              {{- end }}
+          {{- end }}
+    {{- end }}
+{{- end }}

deployments/openim-chat/templates/service.yaml

@@ -0,0 +1,29 @@
+# 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.
+
+apiVersion: v1
+kind: Service
+metadata:
+  name: {{ include "openim-chat.fullname" . }}
+  labels:
+    {{- include "openim-chat.labels" . | nindent 4 }}
+spec:
+  type: {{ .Values.service.type }}
+  ports:
+    - port: {{ .Values.service.port }}
+      targetPort: http
+      protocol: TCP
+      name: http
+  selector:
+    {{- include "openim-chat.selectorLabels" . | nindent 4 }}

deployments/openim-chat/templates/serviceaccount.yaml

@@ -0,0 +1,26 @@
+# 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.
+
+{{- if .Values.serviceAccount.create -}}
+apiVersion: v1
+kind: ServiceAccount
+metadata:
+  name: {{ include "openim-chat.serviceAccountName" . }}
+  labels:
+    {{- include "openim-chat.labels" . | nindent 4 }}
+  {{- with .Values.serviceAccount.annotations }}
+  annotations:
+    {{- toYaml . | nindent 4 }}
+  {{- end }}
+{{- end }}

deployments/openim-chat/values.yaml

@@ -0,0 +1,96 @@
+# 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.
+
+# Default values for openim-chat.
+# This is a YAML-formatted file.
+# Declare variables to be passed into your templates.
+
+replicaCount: 1
+
+image:
+  repository: nginx
+  pullPolicy: IfNotPresent
+  # Overrides the image tag whose default is the chart appVersion.
+  tag: ""
+
+imagePullSecrets: []
+nameOverride: ""
+fullnameOverride: ""
+
+serviceAccount:
+  # Specifies whether a service account should be created
+  create: true
+  # Annotations to add to the service account
+  annotations: {}
+  # The name of the service account to use.
+  # If not set and create is true, a name is generated using the fullname template
+  name: ""
+
+podAnnotations: {}
+
+podSecurityContext: {}
+  # fsGroup: 2000
+
+securityContext: {}
+  # capabilities:
+  #   drop:
+  #   - ALL
+  # readOnlyRootFilesystem: true
+  # runAsNonRoot: true
+  # runAsUser: 1000
+
+service:
+  type: ClusterIP
+  port: 80
+
+ingress:
+  enabled: false
+  className: ""
+  annotations: {}
+    # kubernetes.io/ingress.class: nginx
+    # kubernetes.io/tls-acme: "true"
+  hosts:
+    - host: chart-example.local
+      paths:
+        - path: /
+          pathType: ImplementationSpecific
+  tls: []
+  #  - secretName: chart-example-tls
+  #    hosts:
+  #      - chart-example.local
+
+resources: {}
+  # We usually recommend not to specify default resources and to leave this as a conscious
+  # choice for the user. This also increases chances charts run on environments with little
+  # resources, such as Minikube. If you do want to specify resources, uncomment the following
+  # lines, adjust them as necessary, and remove the curly braces after 'resources:'.
+  # limits:
+  #   cpu: 100m
+  #   memory: 128Mi
+  # requests:
+  #   cpu: 100m
+  #   memory: 128Mi
+
+autoscaling:
+  enabled: false
+  minReplicas: 1
+  maxReplicas: 100
+  targetCPUUtilizationPercentage: 80
+  # targetMemoryUtilizationPercentage: 80
+
+nodeSelector: {}
+
+tolerations: []
+
+affinity: {}

deployments/openim-server/.helmignore

@@ -0,0 +1,23 @@
+# Patterns to ignore when building packages.
+# This supports shell glob matching, relative path matching, and
+# negation (prefixed with !). Only one pattern per line.
+.DS_Store
+# Common VCS dirs
+.git/
+.gitignore
+.bzr/
+.bzrignore
+.hg/
+.hgignore
+.svn/
+# Common backup files
+*.swp
+*.bak
+*.tmp
+*.orig
+*~
+# Various IDEs
+.project
+.idea/
+*.tmproj
+.vscode/

deployments/openim-server/Chart.yaml

@@ -0,0 +1,38 @@
+# 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.
+
+apiVersion: v2
+name: openim-server
+description: A Helm chart for Kubernetes
+
+# A chart can be either an 'application' or a 'library' chart.
+#
+# Application charts are a collection of templates that can be packaged into versioned archives
+# to be deployed.
+#
+# Library charts provide useful utilities or functions for the chart developer. They're included as
+# a dependency of application charts to inject those utilities and functions into the rendering
+# pipeline. Library charts do not define any templates and therefore cannot be deployed.
+type: application
+
+# This is the chart version. This version number should be incremented each time you make changes
+# to the chart and its templates, including the app version.
+# Versions are expected to follow Semantic Versioning (https://semver.org/)
+version: 0.1.0
+
+# This is the version number of the application being deployed. This version number should be
+# incremented each time you make changes to the application. Versions are not expected to
+# follow Semantic Versioning. They should reflect the version the application is using.
+# It is recommended to use it with quotes.
+appVersion: "1.16.0"

deployments/openim-server/templates/NOTES.txt

@@ -0,0 +1,22 @@
+1. Get the application URL by running these commands:
+{{- if .Values.ingress.enabled }}
+{{- range $host := .Values.ingress.hosts }}
+  {{- range .paths }}
+  http{{ if $.Values.ingress.tls }}s{{ end }}://{{ $host.host }}{{ .path }}
+  {{- end }}
+{{- end }}
+{{- else if contains "NodePort" .Values.service.type }}
+  export NODE_PORT=$(kubectl get --namespace {{ .Release.Namespace }} -o jsonpath="{.spec.ports[0].nodePort}" services {{ include "openim-server.fullname" . }})
+  export NODE_IP=$(kubectl get nodes --namespace {{ .Release.Namespace }} -o jsonpath="{.items[0].status.addresses[0].address}")
+  echo http://$NODE_IP:$NODE_PORT
+{{- else if contains "LoadBalancer" .Values.service.type }}
+     NOTE: It may take a few minutes for the LoadBalancer IP to be available.
+           You can watch the status of by running 'kubectl get --namespace {{ .Release.Namespace }} svc -w {{ include "openim-server.fullname" . }}'
+  export SERVICE_IP=$(kubectl get svc --namespace {{ .Release.Namespace }} {{ include "openim-server.fullname" . }} --template "{{"{{ range (index .status.loadBalancer.ingress 0) }}{{.}}{{ end }}"}}")
+  echo http://$SERVICE_IP:{{ .Values.service.port }}
+{{- else if contains "ClusterIP" .Values.service.type }}
+  export POD_NAME=$(kubectl get pods --namespace {{ .Release.Namespace }} -l "app.kubernetes.io/name={{ include "openim-server.name" . }},app.kubernetes.io/instance={{ .Release.Name }}" -o jsonpath="{.items[0].metadata.name}")
+  export CONTAINER_PORT=$(kubectl get pod --namespace {{ .Release.Namespace }} $POD_NAME -o jsonpath="{.spec.containers[0].ports[0].containerPort}")
+  echo "Visit http://127.0.0.1:8080 to use your application"
+  kubectl --namespace {{ .Release.Namespace }} port-forward $POD_NAME 8080:$CONTAINER_PORT
+{{- end }}

deployments/openim-server/templates/_helpers.tpl

@@ -0,0 +1,62 @@
+{{/*
+Expand the name of the chart.
+*/}}
+{{- define "openim-server.name" -}}
+{{- default .Chart.Name .Values.nameOverride | trunc 63 | trimSuffix "-" }}
+{{- end }}
+
+{{/*
+Create a default fully qualified app name.
+We truncate at 63 chars because some Kubernetes name fields are limited to this (by the DNS naming spec).
+If release name contains chart name it will be used as a full name.
+*/}}
+{{- define "openim-server.fullname" -}}
+{{- if .Values.fullnameOverride }}
+{{- .Values.fullnameOverride | trunc 63 | trimSuffix "-" }}
+{{- else }}
+{{- $name := default .Chart.Name .Values.nameOverride }}
+{{- if contains $name .Release.Name }}
+{{- .Release.Name | trunc 63 | trimSuffix "-" }}
+{{- else }}
+{{- printf "%s-%s" .Release.Name $name | trunc 63 | trimSuffix "-" }}
+{{- end }}
+{{- end }}
+{{- end }}
+
+{{/*
+Create chart name and version as used by the chart label.
+*/}}
+{{- define "openim-server.chart" -}}
+{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" }}
+{{- end }}
+
+{{/*
+Common labels
+*/}}
+{{- define "openim-server.labels" -}}
+helm.sh/chart: {{ include "openim-server.chart" . }}
+{{ include "openim-server.selectorLabels" . }}
+{{- if .Chart.AppVersion }}
+app.kubernetes.io/version: {{ .Chart.AppVersion | quote }}
+{{- end }}
+app.kubernetes.io/managed-by: {{ .Release.Service }}
+{{- end }}
+
+{{/*
+Selector labels
+*/}}
+{{- define "openim-server.selectorLabels" -}}
+app.kubernetes.io/name: {{ include "openim-server.name" . }}
+app.kubernetes.io/instance: {{ .Release.Name }}
+{{- end }}
+
+{{/*
+Create the name of the service account to use
+*/}}
+{{- define "openim-server.serviceAccountName" -}}
+{{- if .Values.serviceAccount.create }}
+{{- default (include "openim-server.fullname" .) .Values.serviceAccount.name }}
+{{- else }}
+{{- default "default" .Values.serviceAccount.name }}
+{{- end }}
+{{- end }}

deployments/openim-server/templates/deployment.yaml

@@ -0,0 +1,75 @@
+# 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.
+
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: {{ include "openim-server.fullname" . }}
+  labels:
+    {{- include "openim-server.labels" . | nindent 4 }}
+spec:
+  {{- if not .Values.autoscaling.enabled }}
+  replicas: {{ .Values.replicaCount }}
+  {{- end }}
+  selector:
+    matchLabels:
+      {{- include "openim-server.selectorLabels" . | nindent 6 }}
+  template:
+    metadata:
+      {{- with .Values.podAnnotations }}
+      annotations:
+        {{- toYaml . | nindent 8 }}
+      {{- end }}
+      labels:
+        {{- include "openim-server.selectorLabels" . | nindent 8 }}
+    spec:
+      {{- with .Values.imagePullSecrets }}
+      imagePullSecrets:
+        {{- toYaml . | nindent 8 }}
+      {{- end }}
+      serviceAccountName: {{ include "openim-server.serviceAccountName" . }}
+      securityContext:
+        {{- toYaml .Values.podSecurityContext | nindent 8 }}
+      containers:
+        - name: {{ .Chart.Name }}
+          securityContext:
+            {{- toYaml .Values.securityContext | nindent 12 }}
+          image: "{{ .Values.image.repository }}:{{ .Values.image.tag | default .Chart.AppVersion }}"
+          imagePullPolicy: {{ .Values.image.pullPolicy }}
+          ports:
+            - name: http
+              containerPort: 80
+              protocol: TCP
+          livenessProbe:
+            httpGet:
+              path: /
+              port: http
+          readinessProbe:
+            httpGet:
+              path: /
+              port: http
+          resources:
+            {{- toYaml .Values.resources | nindent 12 }}
+      {{- with .Values.nodeSelector }}
+      nodeSelector:
+        {{- toYaml . | nindent 8 }}
+      {{- end }}
+      {{- with .Values.affinity }}
+      affinity:
+        {{- toYaml . | nindent 8 }}
+      {{- end }}
+      {{- with .Values.tolerations }}
+      tolerations:
+        {{- toYaml . | nindent 8 }}
+      {{- end }}

deployments/openim-server/templates/hpa.yaml

@@ -0,0 +1,42 @@
+# 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.
+
+{{- if .Values.autoscaling.enabled }}
+apiVersion: autoscaling/v2beta1
+kind: HorizontalPodAutoscaler
+metadata:
+  name: {{ include "openim-server.fullname" . }}
+  labels:
+    {{- include "openim-server.labels" . | nindent 4 }}
+spec:
+  scaleTargetRef:
+    apiVersion: apps/v1
+    kind: Deployment
+    name: {{ include "openim-server.fullname" . }}
+  minReplicas: {{ .Values.autoscaling.minReplicas }}
+  maxReplicas: {{ .Values.autoscaling.maxReplicas }}
+  metrics:
+    {{- if .Values.autoscaling.targetCPUUtilizationPercentage }}
+    - type: Resource
+      resource:
+        name: cpu
+        targetAverageUtilization: {{ .Values.autoscaling.targetCPUUtilizationPercentage }}
+    {{- end }}
+    {{- if .Values.autoscaling.targetMemoryUtilizationPercentage }}
+    - type: Resource
+      resource:
+        name: memory
+        targetAverageUtilization: {{ .Values.autoscaling.targetMemoryUtilizationPercentage }}
+    {{- end }}
+{{- end }}

deployments/openim-server/templates/ingress.yaml

@@ -0,0 +1,75 @@
+# 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.
+
+{{- if .Values.ingress.enabled -}}
+{{- $fullName := include "openim-server.fullname" . -}}
+{{- $svcPort := .Values.service.port -}}
+{{- if and .Values.ingress.className (not (semverCompare ">=1.18-0" .Capabilities.KubeVersion.GitVersion)) }}
+  {{- if not (hasKey .Values.ingress.annotations "kubernetes.io/ingress.class") }}
+  {{- $_ := set .Values.ingress.annotations "kubernetes.io/ingress.class" .Values.ingress.className}}
+  {{- end }}
+{{- end }}
+{{- if semverCompare ">=1.19-0" .Capabilities.KubeVersion.GitVersion -}}
+apiVersion: networking.k8s.io/v1
+{{- else if semverCompare ">=1.14-0" .Capabilities.KubeVersion.GitVersion -}}
+apiVersion: networking.k8s.io/v1beta1
+{{- else -}}
+apiVersion: extensions/v1beta1
+{{- end }}
+kind: Ingress
+metadata:
+  name: {{ $fullName }}
+  labels:
+    {{- include "openim-server.labels" . | nindent 4 }}
+  {{- with .Values.ingress.annotations }}
+  annotations:
+    {{- toYaml . | nindent 4 }}
+  {{- end }}
+spec:
+  {{- if and .Values.ingress.className (semverCompare ">=1.18-0" .Capabilities.KubeVersion.GitVersion) }}
+  ingressClassName: {{ .Values.ingress.className }}
+  {{- end }}
+  {{- if .Values.ingress.tls }}
+  tls:
+    {{- range .Values.ingress.tls }}
+    - hosts:
+        {{- range .hosts }}
+        - {{ . | quote }}
+        {{- end }}
+      secretName: {{ .secretName }}
+    {{- end }}
+  {{- end }}
+  rules:
+    {{- range .Values.ingress.hosts }}
+    - host: {{ .host | quote }}
+      http:
+        paths:
+          {{- range .paths }}
+          - path: {{ .path }}
+            {{- if and .pathType (semverCompare ">=1.18-0" $.Capabilities.KubeVersion.GitVersion) }}
+            pathType: {{ .pathType }}
+            {{- end }}
+            backend:
+              {{- if semverCompare ">=1.19-0" $.Capabilities.KubeVersion.GitVersion }}
+              service:
+                name: {{ $fullName }}
+                port:
+                  number: {{ $svcPort }}
+              {{- else }}
+              serviceName: {{ $fullName }}
+              servicePort: {{ $svcPort }}
+              {{- end }}
+          {{- end }}
+    {{- end }}
+{{- end }}

deployments/openim-server/templates/service.yaml

@@ -0,0 +1,29 @@
+# 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.
+
+apiVersion: v1
+kind: Service
+metadata:
+  name: {{ include "openim-server.fullname" . }}
+  labels:
+    {{- include "openim-server.labels" . | nindent 4 }}
+spec:
+  type: {{ .Values.service.type }}
+  ports:
+    - port: {{ .Values.service.port }}
+      targetPort: http
+      protocol: TCP
+      name: http
+  selector:
+    {{- include "openim-server.selectorLabels" . | nindent 4 }}

deployments/openim-server/templates/serviceaccount.yaml

@@ -0,0 +1,26 @@
+# 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.
+
+{{- if .Values.serviceAccount.create -}}
+apiVersion: v1
+kind: ServiceAccount
+metadata:
+  name: {{ include "openim-server.serviceAccountName" . }}
+  labels:
+    {{- include "openim-server.labels" . | nindent 4 }}
+  {{- with .Values.serviceAccount.annotations }}
+  annotations:
+    {{- toYaml . | nindent 4 }}
+  {{- end }}
+{{- end }}

deployments/openim-server/values.yaml

@@ -0,0 +1,96 @@
+# 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.
+
+# Default values for openim-server.
+# This is a YAML-formatted file.
+# Declare variables to be passed into your templates.
+
+replicaCount: 1
+
+image:
+  repository: nginx
+  pullPolicy: IfNotPresent
+  # Overrides the image tag whose default is the chart appVersion.
+  tag: ""
+
+imagePullSecrets: []
+nameOverride: ""
+fullnameOverride: ""
+
+serviceAccount:
+  # Specifies whether a service account should be created
+  create: true
+  # Annotations to add to the service account
+  annotations: {}
+  # The name of the service account to use.
+  # If not set and create is true, a name is generated using the fullname template
+  name: ""
+
+podAnnotations: {}
+
+podSecurityContext: {}
+  # fsGroup: 2000
+
+securityContext: {}
+  # capabilities:
+  #   drop:
+  #   - ALL
+  # readOnlyRootFilesystem: true
+  # runAsNonRoot: true
+  # runAsUser: 1000
+
+service:
+  type: ClusterIP
+  port: 80
+
+ingress:
+  enabled: false
+  className: ""
+  annotations: {}
+    # kubernetes.io/ingress.class: nginx
+    # kubernetes.io/tls-acme: "true"
+  hosts:
+    - host: chart-example.local
+      paths:
+        - path: /
+          pathType: ImplementationSpecific
+  tls: []
+  #  - secretName: chart-example-tls
+  #    hosts:
+  #      - chart-example.local
+
+resources: {}
+  # We usually recommend not to specify default resources and to leave this as a conscious
+  # choice for the user. This also increases chances charts run on environments with little
+  # resources, such as Minikube. If you do want to specify resources, uncomment the following
+  # lines, adjust them as necessary, and remove the curly braces after 'resources:'.
+  # limits:
+  #   cpu: 100m
+  #   memory: 128Mi
+  # requests:
+  #   cpu: 100m
+  #   memory: 128Mi
+
+autoscaling:
+  enabled: false
+  minReplicas: 1
+  maxReplicas: 100
+  targetCPUUtilizationPercentage: 80
+  # targetMemoryUtilizationPercentage: 80
+
+nodeSelector: {}
+
+tolerations: []
+
+affinity: {}

deployments/templates/chat.yaml

@@ -0,0 +1,124 @@
+# 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.
+
+# 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

@@ -12,81 +12,268 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-# ================= Basic Configuration ===================
-# User for authentication or system operations
+# ======================================
+# ========= Basic Configuration ========
+# ======================================
+
+# The user for authentication or system operations.
+# Default: USER=root
 USER=${USER}
 
-# Password associated with the specified user for authentication
+# Password associated with the specified user for authentication.
+# Default: PASSWORD=openIM123
 PASSWORD=${PASSWORD}
 
-# Endpoint for the MinIO object storage service
+# 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)
+# 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
+# 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 ==========
-# Address or hostname for the ZooKeeper service (often used in distributed systems for maintaining configuration information)
-ZOOKEEPER_ADDRESS=${ZOOKEEPER_ADDRESS}
+# ----- 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}
 
-# Port on which MySQL database service is running
+# ----- 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
+# Password to authenticate with the MySQL database service.
+# Default: MYSQL_PASSWORD=openIM123
 MYSQL_PASSWORD=${MYSQL_PASSWORD}
 
-# Port on which MongoDB service is running
+# ----- 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
+# Username to authenticate with the MongoDB service.
+# Default: MONGO_USERNAME=root
 MONGO_USERNAME=${MONGO_USERNAME}
 
-# Password to authenticate with the MongoDB service
+# Password to authenticate with the MongoDB service.
+# Default: MONGO_PASSWORD=openIM123
 MONGO_PASSWORD=${MONGO_PASSWORD}
 
-# Name of the database in MongoDB to be used
+# Name of the database in MongoDB to be used.
+# Default: MONGO_DATABASE=openIM_v3
 MONGO_DATABASE=${MONGO_DATABASE}
 
-# Port on which Redis in-memory data structure store is running
+# ----- 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
+# Password to authenticate with the Redis service.
+# Default: REDIS_PASSWORD=openIM123
 REDIS_PASSWORD=${REDIS_PASSWORD}
 
-# Port on which Kafka distributed streaming platform is running
+# ----- 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}
 
-# Address or hostname for the Kafka service
-KAFKA_ADDR=${KAFKA_ADDR}
-
-# Topic in Kafka for storing the latest messages in Redis
+# 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)
+# 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
+# Topic in Kafka for storing offline messages in MongoDB.
+# Default: KAFKA_OFFLINEMSG_MONGO_TOPIC=offlineMsgToMongoMysql
 KAFKA_OFFLINEMSG_MONGO_TOPIC=${KAFKA_OFFLINEMSG_MONGO_TOPIC}
 
-# Port on which MinIO object storage service is running
+# ----- 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
+# 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
+# Secret key corresponding to the access key for MinIO authentication.
+# Default: MINIO_SECRET_KEY=openIM123
 MINIO_SECRET_KEY=${MINIO_SECRET_KEY}
 
-# ================== OpenIM Web ===========================
+# ----- 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}
-OPENIM_WEB_PPRT=${OPENIM_WEB_PPRT}
+
+# 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}
 
 
-# =================== BRANCH NAME =========================
+# ======================================
+# ========= 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}
-SERVER_BRANCH=${SERVER_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

@@ -144,7 +144,7 @@ source ./environment.sh
 cat > openim-api.service.template <<EOF
 [Unit]
 Description=OpenIM Server API
-Documentation=https://github.com/marmotedu/iam/blob/master/init/README.md
+Documentation=https://github.com/oepnimsdk/open-im-server/blob/master/init/README.md
 
 [Service]
 WorkingDirectory=${OPENIM_DATA_DIR}/openim-api
@@ -179,7 +179,7 @@ do
    cat > $service.service.template <<EOF
 [Unit]
 Description=OpenIM Server - $service
-Documentation=https://github.com/marmotedu/iam/blob/master/init/README.md
+Documentation=https://github.com/oepnimsdk/open-im-server/blob/master/init/README.md
 
 [Service]
 WorkingDirectory=${OPENIM_DATA_DIR}/$service

deployments/templates/init/openim-api.service

@@ -1,7 +1,7 @@
 [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
+Documentation=https://github.com/openimsdk/open-im-server/blob/main/deployment/init/README.md
 
 [Service]
 WorkingDirectory=${OPENIM_DATA_DIR}/openim-api

deployments/templates/init/openim-cmdutils.service

@@ -1,7 +1,7 @@
 [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
+Documentation=https://github.com/openimsdk/open-im-server/blob/main/deployment/init/README.md
 
 [Service]
 WorkingDirectory=${OPENIM_DATA_DIR}/openim-cmdutils

deployments/templates/init/openim-crontask.service

@@ -1,7 +1,7 @@
 [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
+Documentation=https://github.com/openimsdk/open-im-server/blob/main/deployment/init/README.md
 
 [Service]
 WorkingDirectory=${OPENIM_DATA_DIR}/openim-crontask

deployments/templates/init/openim-msggateway.service

@@ -1,6 +1,6 @@
 [Unit]
 Description=OPENIM OPENIM MSGGATEWAY
-Documentation=https://github.com/OpenIMSDK/Open-IM-Server/blob/main/deployment/init/README.md
+Documentation=https://github.com/openimsdk/open-im-server/blob/main/deployment/init/README.md
 
 [Service]
 WorkingDirectory=${OPENIM_DATA_DIR}/openim-msggateway

deployments/templates/init/openim-msgtransfer.service

@@ -1,6 +1,6 @@
 [Unit]
 Description=OPENIM OPENIM MSGTRANSFER
-Documentation=https://github.com/OpenIMSDK/Open-IM-Server/blob/main/deployment/init/README.md
+Documentation=https://github.com/openimsdk/open-im-server/blob/main/deployment/init/README.md
 
 [Service]
 WorkingDirectory=${OPENIM_DATA_DIR}/openim-msgtransfer

deployments/templates/init/openim-push.service

@@ -1,7 +1,7 @@
 [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
+Documentation=https://github.com/openimsdk/open-im-server/blob/main/deployment/init/README.md
 
 [Service]
 WorkingDirectory=${OPENIM_DATA_DIR}/openim-push

deployments/templates/init/openim-rpc.service

@@ -1,6 +1,6 @@
 [Unit]
 Description=OPENIM OPENIM RPC AUTH
-Documentation=https://github.com/OpenIMSDK/Open-IM-Server/blob/main/deployment/init/README.md
+Documentation=https://github.com/openimsdk/open-im-server/blob/main/deployment/init/README.md
 
 [Service]
 WorkingDirectory=${OPENIM_DATA_DIR}/openim-rpc-auth

deployments/templates/openim.yaml

@@ -86,7 +86,7 @@ redis:
 kafka:
   username: ${KAFKA_USERNAME}
   password: ${KAFKA_PASSWORD}
-  addr: [ ${KAFKA_ADDR}:${KAFKA_PORT} ]
+  addr: [ ${KAFKA_ADDRESS}:${KAFKA_PORT} ]
   latestMsgToRedis:
     topic: "${KAFKA_LATESTMSG_REDIS_TOPIC}"
   offlineMsgToMongo:

docker-compose.yml

@@ -1,6 +1,38 @@
-#fixme  Clone openIM Server project before using docker-compose,project address：https://github.com/OpenIMSDK/Open-IM-Server.git
+#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
@@ -8,11 +40,14 @@ services:
       - "${MYSQL_PORT}:3306"
     container_name: mysql
     volumes:
-      - "${DATA_DIR}/components/mysql/data:/var/lib/mysql"
+      - 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
@@ -21,9 +56,9 @@ services:
     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"
+      - 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
@@ -32,52 +67,71 @@ services:
       - 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"
-    container_name: redis
     volumes:
-      - "${DATA_DIR}/components/redis/data:/data"
-      - "${DATA_DIR}/components/redis/config/redis.conf:/usr/local/redis/config/redis.conf"
+      - 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: wurstmeister/zookeeper
-    ports:
-      - "${ZOOKEEPER_PORT}:2181"
-    container_name: zookeeper
-    volumes:
-      - "/etc/localtime:/etc/localtime"
-    environment:
-      TZ: Asia/Shanghai
-    restart: always
-    network_mode: "host"
+   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: wurstmeister/kafka
+    image: 'bitnami/kafka:3.5.1'
     container_name: kafka
+    user: root
     restart: always
     ports:
-      - "${KAFKA_PORT}:9092"
+    - "${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_BROKER_ID: 0
-      KAFKA_ZOOKEEPER_CONNECT: "${ZOOKEEPER_ADDRESS}:${ZOOKEEPER_PORT}"
-      KAFKA_CREATE_TOPICS: "${KAFKA_LATESTMSG_REDIS_TOPIC}:8:1,${KAFKA_MSG_PUSH_TOPIC}:8:1,${KAFKA_OFFLINEMSG_MONGO_TOPIC}:8:1"
-      KAFKA_ADVERTISED_LISTENERS: INSIDE://${KAFKA_ADDR}:${KAFKA_PORT},OUTSIDE://CHANGE_TO_YOUR_EXTERNAL_IP:${KAFKA_PORT}
-      KAFKA_LISTENERS: INSIDE://:9092,OUTSIDE://:9093
-      KAFKA_LISTENER_SECURITY_PROTOCOL_MAP: "INSIDE:PLAINTEXT,OUTSIDE:PLAINTEXT"
-      KAFKA_INTER_BROKER_LISTENER_NAME: INSIDE
-    depends_on:
-      - zookeeper
-    network_mode: "host"
+       - 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
@@ -86,80 +140,130 @@ services:
       - "9090:9090"
     container_name: minio
     volumes:
-      - "${DATA_DIR}/components/mnt/data:/data"
-      - "${DATA_DIR}/components/mnt/config:/root/.minio"
+      - 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:main
-  #   container_name: openim-web
-  #   environment:
-  #     - OPENIM_WEB_DIST_PATH=${OPENIM_WEB_DIST_PATH}
-  #     - OPENIM_WEB_PPRT=${OPENIM_WEB_PPRT}
-  #   restart: always
-  #   ports:
-  #     - "${OPENIM_WEB_PPRT}:11001"
-
-  openim-server:
-    image: ghcr.io/openimsdk/openim-server:main
-    # image: registry.cn-hangzhou.aliyuncs.com/openimsdk/openim-server:main
-    # image: openim/openim-server:main
-    container_name: openim-server
-    healthcheck:
-      test: ["CMD", "./scripts/check-all.sh"]
-      interval: 30s
-      timeout: 10s
-      retries: 5
-    volumes:
-      - ./logs:/openim/openim-server/logs
-      - ./config:/openim/openim-server/config
-      - ./scripts:/openim/openim-server/scripts
+  openim-web:
+    image: ghcr.io/openimsdk/openim-web:latest
+    # image: registry.cn-hangzhou.aliyuncs.com/openimsdk/openim-web:latest
+    # image: openim/openim-web:latest
+    container_name: openim-web
+    environment:
+      - OPENIM_WEB_DIST_PATH=${OPENIM_WEB_DIST_PATH}
+      - OPENIM_WEB_PORT=${OPENIM_WEB_PORT}
     restart: always
-    depends_on:
-      - zookeeper
-      - kafka
-      - mysql
-      - mongodb
-      - redis
-      - minio
-    network_mode: "host"
-    logging:
-      driver: json-file
-      options:
-        max-size: "1g"
-        max-file: "2"
+    ports:
+      - "${OPENIM_WEB_PORT}:11001"
+    networks:
+      server:
+        ipv4_address: ${OPENIM_WEB_NETWORK_ADDRESS}
 
-  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"
+#   openim-server:
+#     image: ghcr.io/openimsdk/openim-server:main
+#     # image: registry.cn-hangzhou.aliyuncs.com/openimsdk/openim-server:release-v3.3
+#     # 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/logs:/openim/openim-server/_output/logs
+#       - ./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}
 
-  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"
+  # 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"
+  #     - "9100:9100"

docs/README.md

@@ -0,0 +1,67 @@
+# OpenIM Server Docs
+
+Welcome to the OpenIM Documentation hub! This center provides a comprehensive range of guides and manuals designed to help you get the most out of your OpenIM experience.
+
+## Table of Contents
+
+1. [Contrib](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib) - Guidance on contributing and configurations for developers
+2. [Conversions](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions) - Coding conventions, logging policies, and other transformation tools
+
+------
+
+## Contrib
+
+This section offers developers a detailed guide on how to contribute code, set up their environment, and follow the associated processes.
+
+- [Code Conventions](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/code_conventions.md) - Rules and conventions for writing code in OpenIM.
+- [Development Guide](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/development.md) - A guide on how to carry out development within OpenIM.
+- [Git Cherry Pick](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/git_cherry-pick.md) - Guidelines on cherry-picking operations.
+- [Git Workflow](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/git_workflow.md) - The git workflow in OpenIM.
+- [Initialization Configurations](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/init_config.md) - Guidance on setting up and initializing OpenIM.
+- [Docker Installation](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/install_docker.md) - How to install Docker on your machine.
+- [Linux Development Environment](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/linux_development.md) - Guide to set up the development environment on Linux.
+- [Local Actions](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/local_actions.md) - Guidelines on how to carry out certain common actions locally.
+- [Offline Deployment](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/offline-deployment.md) - Methods of deploying OpenIM offline.
+- [Protoc Tools](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/protoc_tools.md) - Guide on using protoc tools.
+- [Go Tools](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/util_go.md) - Tools and libraries in OpenIM for Go.
+- [Makefile Tools](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/util_makefile.md) - Best practices and tools for Makefile.
+- [Script Tools](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/util_scripts.md) - Best practices and tools for scripts.
+
+## Conversions
+
+This section introduces various conventions and policies within OpenIM, encompassing code, logs, versions, and more.
+
+- [API Conversions](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/api.md) - Guidelines and methods for API conversions.
+- [Logging Policy](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/bash_log.md) - Logging policies and conventions in OpenIM.
+- [CI/CD Actions](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/cicd_actions.md) - Procedures and conventions for CI/CD.
+- [Commit Conventions](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/commit.md) - Conventions for code commits in OpenIM.
+- [Directory Conventions](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/directory.md) - Directory structure and conventions within OpenIM.
+- [Error Codes](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/error_code.md) - List and descriptions of error codes.
+- [Go Code Conversions](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/go_code.md) - Conventions and conversions for Go code.
+- [Docker Image Strategy](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/images.md) - Management strategies for OpenIM Docker images, spanning multiple architectures and image repositories.
+- [Logging Conventions](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/logging.md) - Further detailed conventions on logging.
+- [Version Conventions](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/version.md) - Naming and management strategies for OpenIM versions.
+
+
+## For Developers, Contributors, and Community Maintainers
+
+### Developers & Contributors
+
+If you're a developer or someone keen on contributing:
+
+- Familiarize yourself with our [Code Conventions](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/code_conventions.md) and [Git Workflow](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/git_workflow.md) to ensure smooth contributions.
+- Dive into the [Development Guide](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/development.md) to get a hang of the development practices in OpenIM.
+
+### Community Maintainers
+
+As a community maintainer:
+
+- Ensure that contributions align with the standards outlined in our documentation.
+- Regularly review the [Logging Policy](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/bash_log.md) and [Error Codes](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/error_code.md) to stay updated.
+
+## For Users
+
+Users should pay particular attention to:
+
+- [Docker Installation](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/install_docker.md) - Necessary if you're planning to use Docker images of OpenIM.
+- [Docker Image Strategy](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/images.md) - To understand the different images available and how to choose the right one for your architecture.

docs/contrib/code_conventions.md

@@ -35,4 +35,4 @@
 
 ## Testing conventions
 
-Please refer to [TESTING.md](../../tests/TESTING.md) document.
+Please refer to [TESTING.md](https://github.com/openimsdk/open-im-server/tree/main/test/readme) document.

docs/contrib/development.md

@@ -10,12 +10,11 @@ Since OpenIM is written in Go, it is fair to assume that the Go tools are all on
     - [Go](#go)
     - [Docker](#docker)
     - [Vagrant](#vagrant)
-  - [Cloning, Building and Testing OpenIM](#cloning-building-and-testing-openim)
   - [Dependency management](#dependency-management)
 
 ## Non-Linux environment prerequisites
 
-All the test and build scripts within this repository were created to be run on GNU Linux development environments. Due to this, it is suggested to use the virtual machine defined on this repository's [Vagrantfile](../../Vagrantfile) to use them.
+All the test and build scripts within this repository were created to be run on GNU Linux development environments. Due to this, it is suggested to use the virtual machine defined on this repository's [Vagrantfile](https://developer.hashicorp.com/vagrant/docs/vagrantfile) to use them.
 
 Either way, if one still wants to build and test OpenIM on non-Linux environments, specific setups are to be followed.
 
@@ -62,18 +61,11 @@ OpenIM build and test processes development require Docker to run certain steps.
 
 ### Vagrant
 
-As described in the [Testing documentation](../../tests/TESTING.md), all the smoke tests are run in virtual machines managed by Vagrant.  To install Vagrant in the development environment, [follow the instructions from the Hashicorp website](https://www.vagrantup.com/downloads), alongside any of the following hypervisors:
+As described in the [Testing documentation](https://github.com/openimsdk/open-im-server/tree/main/test/readme), all the smoke tests are run in virtual machines managed by Vagrant.  To install Vagrant in the development environment, [follow the instructions from the Hashicorp website](https://www.vagrantup.com/downloads), alongside any of the following hypervisors:
 
 - [VirtualBox](https://www.virtualbox.org/)
 - [libvirt](https://libvirt.org/) and the [vagrant-libvirt plugin](https://github.com/vagrant-libvirt/vagrant-libvirt#installation)
 
-## Cloning, Building and Testing OpenIM
-
-These topics already have been addressed on their respective documents:
-
-- [Git Workflow](./git-workflow.md)
-- [Building](../../BUILDING.md)
-- [Testing](../../tests/TESTING.md)
 
 ## Dependency management
 

docs/contrib/environment.md

@@ -0,0 +1,215 @@
+# OpenIM enviroment
+
+
+## How to change the configuration
+
+
+**Modify the configuration files:**
+
+Three ways to modify the configuration:
+
+#### **1. Recommended using environment variables:**
+
+```bash
+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"
+```
+
+Next, update the configuration using `make init`:
+
+```bash
+make init
+```
+
+#### **2. Modify the automation script:**
+
+```bash
+scripts/install/environment.sh
+```
+
+Next, update the configuration using `make init`:
+
+```bash
+make init
+```
+
+#### 3. Modify `config.yaml` and `.env` files (but will be overwritten when using `make init` again).
+
+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.
+
+
+## Environment variable
+
+By setting the environment variable below, You can then refresh the configuration using `make init` or `./scripts/init-config.sh`
+
+##### MINIO
+
++ [MINIO DOCS](https://min.io/docs/minio/kubernetes/upstream/index.html)
+
+apiURL is the address of the api, the access address of the app, use s3 must be configured
+
+#### Overview
+
+MinIO is an object storage server that is API compatible with Amazon S3. It's best suited for storing unstructured data such as photos, videos, log files, backups, and container/VM images. In this guide, we'll walk through the process of configuring MinIO with custom settings.
+
+#### Default Configuration
+
+Configuration can be achieved by modifying the default variables in the `./scripts/install/environment.sh` file. However, for more flexibility and dynamic adjustments, setting environment variables is recommended.
+
+#### Setting Up the Environment Variables
+
+##### IP Configuration
+
+By default, the system generates the public IP of the machine. To manually set a public or local IP address, use:
+
+```bash
+export IP=127.0.0.1
+```
+
+##### API URL
+
+This is the address your application uses to communicate with MinIO. By default, it uses the public IP. However, you can adjust it to a public domain or another IP.
+
+```bash
+export API_URL=127.0.0.1:10002
+```
+
+##### MinIO Endpoint Configuration
+
+This is the primary address MinIO uses for communications:
+
+```bash
+export MINIO_ENDPOINT="127.0.0.1"
+```
+
+##### MinIO Sign Endpoint
+
+For direct external access to stored content:
+
+```bash
+export MINIO_SIGN_ENDPOINT=127.0.0.1:10005
+```
+
+##### Modifying MinIO's Port
+
+If you need to adjust MinIO's port from the default:
+
+```bash
+export MINIO_PORT="10005"
+```
+
+#### Applying the Configuration
+
+After setting your desired environment variables, restart the MinIO server to apply the changes.
+
+#### Verification
+
+It's crucial to verify the configurations by checking the connectivity between your application and MinIO using the set API URL and ensuring that the data can be directly accessed using the `signEndpoint`.
+
+
+## Configuration Details
+
+###### Zookeeper
+
+- **Purpose**: Used for RPC service discovery and registration, cluster support.
+  
+    ```bash
+    zookeeper:
+      schema: openim                          # Not recommended to modify
+      address: [ 127.0.0.1:2181 ]            # Address
+      username:                               # Username
+      password:                               # Password
+    ```
+
+###### MySQL
+
+- **Purpose**: Used for storing users, relationships, and groups. Supports master-slave database.
+
+    ```bash
+    mysql:
+      address: [ 127.0.0.1:13306 ]            # Address
+      username: root                          # Username
+      password: openIM123                     # Password
+      database: openIM_v2                     # Not recommended to modify
+      maxOpenConn: 1000                       # Maximum connection
+      maxIdleConn: 100                        # Maximum idle connection
+      maxLifeTime: 60                         # Max time a connection can be reused (seconds)
+      logLevel: 4                             # Log level (1=silent, 2=error, 3=warn, 4=info)
+      slowThreshold: 500                      # Slow statement threshold (milliseconds)
+    ```
+
+###### Mongo
+
+- **Purpose**: Used for storing offline messages. Supports mongo sharded clusters.
+
+    ```bash
+    mongo:
+      uri:                                    # Use this value directly if not empty
+      address: [ 127.0.0.1:37017 ]            # Address
+      database: openIM                        # Default mongo db
+      username: root                          # Username
+      password: openIM123                     # Password
+      maxPoolSize: 100                        # Maximum connections
+    ```
+
+###### Redis
+
+- **Purpose**: Used for storing message sequence numbers, latest messages, user tokens, and MySQL cache. Supports cluster deployment.
+
+    ```bash
+    redis:
+      address: [ 127.0.0.1:16379 ]            # Address
+      username:                               # Username
+      password: openIM123                     # Password
+    ```
+
+###### Kafka
+
+- **Purpose**: Used for message queues for decoupling. Supports cluster deployment.
+
+    ```bash
+    kafka:
+      username:                               # Username
+      password:                               # Password
+      addr: [ 127.0.0.1:9092 ]                # Address
+      topics:
+        latestMsgToRedis: "latestMsgToRedis"
+        offlineMsgToMongo: "offlineMsgToMongoMysql"
+        msgToPush: "msgToPush"
+        msgToModify: "msgToModify"
+      consumerGroupID:
+        msgToRedis: redis
+        msgToMongo: mongo
+        msgToMySql: mysql
+        msgToPush: push
+        msgToModify: modify
+    ```
+
+
+
+
+
+## Config options
+
+...
+
+## Use the default values
+
+A method to revert to the default value:
+
+```bash
+export IP=127.0.0.1
+```

docs/contrib/git_cherry-pick.md

@@ -27,8 +27,8 @@ Ensuring this strategy's success extends beyond just documentation; it hinges on
 
 - [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`.
+- 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).
 
@@ -65,7 +65,7 @@ It is critical that our full community is actively engaged on enhancements in th
 
 ### Steps
 
-- Run the [cherry pick script](https://github.com/OpenIMSDK/Open-IM-Server/tree/main/scripts/cherry-pick.sh)
+- 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`:
 
@@ -75,15 +75,14 @@ It is critical that our full community is actively engaged on enhancements in th
 
   - Be aware the cherry pick script assumes you have a git remote called `upstream` that points at the openim-server github org.
 
-    Please see our [recommended Git workflow](https://github.com/openim-server/community/blob/main/contributors/guide/github-workflow.md#workflow).
+    Please see our [recommended Git workflow](https://github.com/openimsdk/open-im-server/blob/main/docs/contributors/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.
+  - You will need to run the cherry pick script separately for each patch release you want to cherry pick to. Cherry picks should be applied to all [active](https://github.com/openimsdk/open-im-server/releases) release branches where the fix is applicable.
 
   - 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
 

docs/contrib/git_workflow.md

@@ -18,7 +18,7 @@ OpenIM project uses the [GitHub flow](https://docs.github.com/en/get-started/qui
 
 ### Branch naming conventions
 
-Every forked repository works independently, meaning that any contributor can create branches with the name they see fit. However, it is worth noting that OpenIM mirrors [OpenIM version skew policy](https://github.com/OpenIMSDK/Open-IM-Server/releases) by maintaining release branches for the most recent three minor releases. The only exception is that the main branch mirrors the latest OpenIM release (3.10) instead of using a `release-` prefixed one.
+Every forked repository works independently, meaning that any contributor can create branches with the name they see fit. However, it is worth noting that OpenIM mirrors [OpenIM version skew policy](https://github.com/openimsdk/open-im-server/releases) by maintaining release branches for the most recent three minor releases. The only exception is that the main branch mirrors the latest OpenIM release (3.10) instead of using a `release-` prefixed one.
 
 ```text
 main          -------------------------------------------. (OpenIM 3.10)
@@ -39,7 +39,7 @@ There are everyday tasks related to git that every contributor needs to perform,
 
 Creating a OpenIM fork, cloning it, and setting its upstream remote can be summarized on:
 
-1. Visit <https://github.com/OpenIMSDK/Open-IM-Server>
+1. Visit <https://github.com/openimsdk/open-im-server>
 2. Click the `Fork` button (top right) to establish a cloud-based fork
 3. Clone fork to local storage
 4. Add to your fork OpenIM remote as upstream
@@ -54,8 +54,8 @@ git clone https://github.com/$user/OpenIM.git
 
 ## Add OpenIM as upstream to your fork
 cd OpenIM 
-git remote add upstream https://github.com/OpenIMSDK/Open-IM-Server.git
-# or: git remote add upstream git@github.com:OpenIMSDK/Open-IM-Server.git
+git remote add upstream https://github.com/openimsdk/open-im-server.git
+# or: git remote add upstream git@github.com:openimsdk/open-im-server.git
 
 ## Ensure to never push to upstream directly
 git remote set-url --push upstream no_push

docs/contrib/linux_development.md

@@ -19,7 +19,7 @@ You can use tools like PuTTY or other SSH clients to log in to your Ubuntu serve
 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.
+# adduser openim # Create the openim user, which developers will use for login and development.
 # passwd openim # Set the login password for openim.
 ```
 
@@ -30,7 +30,7 @@ Working with a non-root user ensures the system's safety and is a good practice.
 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
 ```
 
@@ -45,7 +45,7 @@ Assuming we're using the **openim** user, log in using PuTTY or other SSH client
 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
+# .bashrc
 
 # User specific aliases and functions
 
@@ -82,7 +82,7 @@ The OpenIM project on Ubuntu may have various dependencies. Some are direct, and
 You can use the `apt` command to install the required tools on Ubuntu:
 
 ```
-bashCopy code$ sudo apt-get update 
+$ 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
 ```
@@ -92,7 +92,7 @@ $ sudo apt install libcurl4-openssl-dev
 A higher version of Git ensures compatibility with certain commands like `git fetch --unshallow`. To install a recent version:
 
 ```
-bashCopy code$ cd /tmp
+$ 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/
@@ -105,7 +105,7 @@ $ git --version
 Then, add Git's binary directory to the `PATH`:
 
 ```
-bashCopy code
+
 $ echo 'export PATH=/usr/local/libexec/git-core:$PATH' >> $HOME/.bashrc
 ```
 
@@ -114,7 +114,7 @@ $ echo 'export PATH=/usr/local/libexec/git-core:$PATH' >> $HOME/.bashrc
 To set up Git:
 
 ```
-bashCopy code$ git config --global user.name "Your Name"
+$ 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
@@ -123,14 +123,14 @@ $ 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
 ```
 

docs/contrib/offline-deployment.md

@@ -26,11 +26,11 @@ 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)
+**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)
+- 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
@@ -111,6 +111,6 @@ docker-compose ps
 
 ## 6. Reference Links
 
-- [OpenIMSDK Issue #432](https://github.com/OpenIMSDK/Open-IM-Server/issues/432)
+- [OpenIMSDK Issue #432](https://github.com/openimsdk/open-im-server/issues/432)
 - [Notion Link](https://nsddd.notion.site/435ee747c0bc44048da9300a2d745ad3?pvs=25)
-- [OpenIMSDK Issue #474](https://github.com/OpenIMSDK/Open-IM-Server/issues/474)
+- [OpenIMSDK Issue #474](https://github.com/openimsdk/open-im-server/issues/474)

docs/contrib/protoc_tools.md

@@ -44,7 +44,7 @@ For Linux:
 The OpenIM Protoc tool provides a multitude of options for parsing `.proto` files and generating output:
 
 ```
-bashCopy code
+
 ./protoc [OPTION] PROTO_FILES
 ```
 

docs/contrib/util_go.md

@@ -1,6 +1,6 @@
 # utils go 
 
-+ [toold readme](https://github.com/OpenIMSDK/Open-IM-Server/tree/main/tools)
++ [toold readme](https://github.com/openimsdk/open-im-server/tree/main/tools)
 
 about scripts fix:
 ```

docs/conversions/github-workflow.md

@@ -0,0 +1,284 @@
+---
+title: "GitHub Workflow"
+weight: 6
+description: |
+  This document is an overview of the GitHub workflow used by the
+  open-im-server project. It includes tips and suggestions on keeping your
+  local environment in sync with upstream and how to maintain good
+  commit hygiene.
+---
+
+![Git workflow](git_workflow.png)
+
+## 1. Fork in the cloud
+
+1. Visit https://github.com/openimsdk/open-im-server
+2. Click `Fork` button (top right) to establish a cloud-based fork.
+
+## 2. Clone fork to local storage
+
+Per Go's [workspace instructions][go-workspace], place open-im-server' code on your
+`GOPATH` using the following cloning procedure.
+
+[go-workspace]: https://golang.org/doc/code.html#Workspaces
+
+In your shell, define a local working directory as `working_dir`. If your `GOPATH` has multiple paths, pick
+just one and use it instead of `$GOPATH`. You must follow exactly this pattern,
+neither `$GOPATH/src/github.com/${your github profile name}/`
+nor any other pattern will work.
+
+```sh
+export working_dir="$(go env GOPATH)/src/k8s.io"
+```
+
+If you already do Go development on github, the `k8s.io` directory
+will be a sibling to your existing `github.com` directory.
+
+Set `user` to match your github profile name:
+
+```sh
+export user=<your github profile name>
+```
+
+Both `$working_dir` and `$user` are mentioned in the figure above.
+
+Create your clone:
+
+```sh
+mkdir -p $working_dir
+cd $working_dir
+git clone https://github.com/$user/open-im-server.git
+# or: git clone git@github.com:$user/open-im-server.git
+
+cd $working_dir/open-im-server
+git remote add upstream https://github.com/openimsdk/open-im-server.git
+# or: git remote add upstream git@github.com:openimsdk/open-im-server.git
+
+# Never push to upstream master
+git remote set-url --push upstream no_push
+
+# Confirm that your remotes make sense:
+git remote -v
+```
+
+## 3. Create a Working Branch
+
+Get your local master up to date. Note that depending on which repository you are working from,
+the default branch may be called "main" instead of "master".
+
+```sh
+cd $working_dir/open-im-server
+git fetch upstream
+git checkout master
+git rebase upstream/master
+```
+
+Create your new branch.
+
+```sh
+git checkout -b myfeature
+```
+
+You may now edit files on the `myfeature` branch.
+
+### Building open-im-server
+
+This workflow is process-specific. For quick-start build instructions for [openimsdk/open-im-server](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/util_makefile.md)
+
+## 4. Keep your branch in sync
+
+You will need to periodically fetch changes from the `upstream`
+repository to keep your working branch in sync. Note that depending on which repository you are working from,
+the default branch may be called 'main' instead of 'master'.
+
+Make sure your local repository is on your working branch and run the
+following commands to keep it in sync:
+
+```sh
+git fetch upstream
+git rebase upstream/master
+```
+
+Please don't use `git pull` instead of the above `fetch` and
+`rebase`. Since `git pull` executes a merge, it creates merge commits. These make the commit history messy
+and violate the principle that commits ought to be individually understandable
+and useful (see below). 
+
+You might also consider changing your `.git/config` file via
+`git config branch.autoSetupRebase always` to change the behavior of `git pull`, or another non-merge option such as `git pull --rebase`.
+
+## 5. Commit Your Changes
+
+You will probably want to regularly commit your changes. It is likely that you will go back and edit,
+build, and test multiple times. After a few cycles of this, you might
+[amend your previous commit](https://www.w3schools.com/git/git_amend.asp).
+
+```sh
+git commit
+```
+
+## 6. Push to GitHub
+
+When your changes are ready for review, push your working branch to
+your fork on GitHub.
+
+```sh
+git push -f <your_remote_name> myfeature
+```
+
+## 7. Create a Pull Request
+
+1. Visit your fork at `https://github.com/<user>/open-im-server`
+2. Click the **Compare & Pull Request** button next to your `myfeature` branch.
+3. Check out the pull request process for more details and
+   advice.
+
+_If you have upstream write access_, please refrain from using the GitHub UI for
+creating PRs, because GitHub will create the PR branch inside the main
+repository rather than inside your fork.
+
+### Get a code review
+
+Once your pull request has been opened it will be assigned to one or more
+reviewers.  Those reviewers will do a thorough code review, looking for
+correctness, bugs, opportunities for improvement, documentation and comments,
+and style.
+
+Commit changes made in response to review comments to the same branch on your
+fork.
+
+Very small PRs are easy to review.  Very large PRs are very difficult to review.
+
+### Squash commits
+
+After a review, prepare your PR for merging by squashing your commits.
+
+All commits left on your branch after a review should represent meaningful milestones or units of work. Use commits to add clarity to the development and review process.
+
+Before merging a PR, squash the following kinds of commits:
+
+- Fixes/review feedback
+- Typos
+- Merges and rebases
+- Work in progress
+
+Aim to have every commit in a PR compile and pass tests independently if you can, but it's not a requirement. In particular, `merge` commits must be removed, as they will not pass tests.
+
+To squash your commits, perform an [interactive rebase](https://git-scm.com/book/en/v2/Git-Tools-Rewriting-History):
+
+1. Check your git branch:
+
+  ```
+  git status
+  ```
+
+  The output should be similar to this:
+
+  ```
+  On branch your-contribution
+  Your branch is up to date with 'origin/your-contribution'.
+  ```
+
+2. Start an interactive rebase using a specific commit hash, or count backwards from your last commit using `HEAD~<n>`, where `<n>` represents the number of commits to include in the rebase.
+
+  ```
+  git rebase -i HEAD~3
+  ```
+
+  The output should be similar to this:
+
+  ```
+  pick 2ebe926 Original commit
+  pick 31f33e9 Address feedback
+  pick b0315fe Second unit of work
+
+  # Rebase 7c34fc9..b0315ff onto 7c34fc9 (3 commands)
+  #
+  # Commands:
+  # p, pick <commit> = use commit
+  # r, reword <commit> = use commit, but edit the commit message
+  # e, edit <commit> = use commit, but stop for amending
+  # s, squash <commit> = use commit, but meld into previous commit
+  # f, fixup <commit> = like "squash", but discard this commit's log message
+
+  ...
+
+  ```
+
+3. Use a command line text editor to change the word `pick` to `squash` for the commits you want to squash, then save your changes and continue the rebase:
+
+  ```
+  pick 2ebe926 Original commit
+  squash 31f33e9 Address feedback
+  pick b0315fe Second unit of work
+
+  ...
+
+  ```
+
+  The output after saving changes should look similar to this:
+
+  ```
+  [detached HEAD 61fdded] Second unit of work
+   Date: Thu Mar 5 19:01:32 2020 +0100
+   2 files changed, 15 insertions(+), 1 deletion(-)
+
+   ...
+
+  Successfully rebased and updated refs/heads/master.
+  ```
+4. Force push your changes to your remote branch:
+
+  ```
+  git push --force
+  ```
+
+For mass automated fixups such as automated doc formatting, use one or more
+commits for the changes to tooling and a final commit to apply the fixup en
+masse. This makes reviews easier.
+
+An alternative to this manual squashing process is to use the Prow and Tide based automation that is configured in GitHub: adding a comment to your PR with `/label tide/merge-method-squash` will trigger the automation so that GitHub squash your commits onto the target branch once the PR is approved. Using this approach simplifies things for those less familiar with Git, but there are situations in where it's better to squash locally; reviewers will have this in mind and can ask for manual squashing to be done.
+
+By squashing locally, you control the commit message(s) for your work, and can separate a large PR into logically separate changes.
+For example: you have a pull request that is code complete and has 24 commits. You rebase this against the same merge base, simplifying the change to two commits. Each of those two commits represents a single logical change and each commit message summarizes what changes. Reviewers see that the set of changes are now understandable, and approve your PR.
+
+## Merging a commit
+
+Once you've received review and approval, your commits are squashed, your PR is ready for merging.
+
+Merging happens automatically after both a Reviewer and Approver have approved the PR. If you haven't squashed your commits, they may ask you to do so before approving a PR.
+
+## Reverting a commit
+
+In case you wish to revert a commit, use the following instructions.
+
+_If you have upstream write access_, please refrain from using the
+`Revert` button in the GitHub UI for creating the PR, because GitHub
+will create the PR branch inside the main repository rather than inside your fork.
+
+- Create a branch and sync it with upstream. Note that depending on which repository you are working from, the default branch may be called 'main' instead of 'master'.
+  ```sh
+  # create a branch
+  git checkout -b myrevert
+
+  # sync the branch with upstream
+  git fetch upstream
+  git rebase upstream/master
+  ```
+- If the commit you wish to revert is a *merge commit*, use this command:
+  ```sh
+  # SHA is the hash of the merge commit you wish to revert
+  git revert -m 1 <SHA>
+  ```
+  If it is a *single commit*, use this command:
+  ```sh
+  # SHA is the hash of the single commit you wish to revert
+  git revert <SHA>
+  ```
+
+- This will create a new commit reverting the changes. Push this new commit to your remote.
+  ```sh
+  git push <your_remote_name> myrevert
+  ```
+
+- Finally, [create a Pull Request](#7-create-a-pull-request) using this branch.

docs/conversions/go_code.md

@@ -103,12 +103,12 @@ v := make([]string, 0, 4)
 
 ```go
 // bad
-var_s string = F()
+var s string = F()
 
 func F() string { return "A" }
 
 // good
-var_s = F()
+var s = F()
 // Since F already explicitly returns a string type, we don't need to explicitly specify the type of _s
 // still of that type
 
@@ -439,7 +439,7 @@ const (
      // ErrUnknown - 0: An unknown error occurred.
      ErrUnknown Code = iota
      // ErrFatal - 1: An fatal error occurred.
-     Err Fatal
+     ErrFatal
 )
 ```
 
@@ -495,7 +495,7 @@ package superman
 ### 3.1 Package Notes
 
 - Each package has one and only one package-level annotation.
-- Package comments are uniformly commented with // in the format of `// Package package name package description`, for example:
+- Package comments are uniformly commented with // in the format of `// Package <package name> package description`, for example:
 
 ```go
 // Package genericclioptions contains flags which can be added to you command, bound, completed, and produce
@@ -757,7 +757,7 @@ defer fd. Close()
 - If only the first item (key) is needed, discard the second.
 
 ```go
-for key := range keys {
+for keyIndex := range keys {
 // normal code
 }
 ```

docs/conversions/logging.md

@@ -2,7 +2,7 @@
 
 ### Log Standards
 
-- The unified log package `github.com/OpenIMSDK/Open-IM-Server/internal/pkg/log` should be used for all logging;
+- The unified log package `github.com/openimsdk/open-im-server/internal/pkg/log` should be used for all logging;
 - Use structured logging formats: `log.Infow`, `log.Warnw`, `log.Errorw`, etc. For example: `log.Infow("Update post function called")`;
 - All logs should start with an uppercase letter and should not end with a `.`. For example: `log.Infow("Update post function called")`;
 - Use past tense. For example, use `Could not delete B` instead of `Cannot delete B`;

docs/conversions/version.md

@@ -27,15 +27,15 @@ In the OpenIM repository, version identification strictly complies with the `MAJ
 
 ## Main Branch: The Heart of OpenIM Development
 
-The `main` branch is the operational heart of our development process. Housing the most recent and advanced features, this branch serves as the nerve center for all enhancements and updates. It encapsulates the freshest, though possibly unstable, facets of the software. Visit our `main` branch [here](https://github.com/OpenIMSDK/Open-IM-Server/tree/main).
+The `main` branch is the operational heart of our development process. Housing the most recent and advanced features, this branch serves as the nerve center for all enhancements and updates. It encapsulates the freshest, though possibly unstable, facets of the software. Visit our `main` branch [here](https://github.com/openimsdk/open-im-server/tree/main).
 
 ## Release Branch: The Beacon of Stability
 
-For every major release, we curate a corresponding `release` branch, e.g., `release-v3.1`. This branch symbolizes an embodiment of stability and ensures an updated version of the software, providing a dependable option for users favoring stability over nascent, yet possibly unstable, features. Visit the `release-v3.1` branch [here](https://github.com/OpenIMSDK/Open-IM-Server/tree/release-v3.1).
+For every major release, we curate a corresponding `release` branch, e.g., `release-v3.1`. This branch symbolizes an embodiment of stability and ensures an updated version of the software, providing a dependable option for users favoring stability over nascent, yet possibly unstable, features. Visit the `release-v3.1` branch [here](https://github.com/openimsdk/open-im-server/tree/release-v3.1).
 
 ## Tag Management: The Cornerstone of Version Control
 
-In OpenIM's version control system, the role of `tags` stands paramount. Owing to their immutable nature, tags can be effectively utilized to retrieve a specific version of the software. Explore our library of tags [here](https://github.com/OpenIMSDK/Open-IM-Server/tags).
+In OpenIM's version control system, the role of `tags` stands paramount. Owing to their immutable nature, tags can be effectively utilized to retrieve a specific version of the software. Explore our library of tags [here](https://github.com/openimsdk/open-im-server/tags).
 
 Our Docker image versions are intimately entwined with these tripartite components. For instance, a Docker image tag may correspond to `ghcr.io/openimsdk/openim-server:v3.1.0`, a release to `ghcr.io/openimsdk/openim-server:release-v3.0`, and the main branch to `ghcr.io/openimsdk/openim-server:main` or `ghcr.io/openimsdk/openim-server:latest`.
 
@@ -55,7 +55,7 @@ Whenever a project undergoes a partial functional addition, the minor version nu
 
 ## Release Management: A Guided Tour
 
-Our GitHub repository at https://github.com/OpenIMSDK/Open-IM-Server/releases associates a release with each tag, with a distinction between Pre-release and Latest, determined by the branch source. Every significant feature launch prompts the issue of a `release` branch, such as `release-v3.2`, as a beacon of stability and Latest release.
+Our GitHub repository at https://github.com/openimsdk/open-im-server/releases associates a release with each tag, with a distinction between Pre-release and Latest, determined by the branch source. Every significant feature launch prompts the issue of a `release` branch, such as `release-v3.2`, as a beacon of stability and Latest release.
 
 Pre-releases correspond to releases from the `main` branch, denoting tags with Version modifiers such as `v3.2.1-beta.0`, `v3.2.1-rc.1`, etc. If you are seeking the most recent, albeit possibly unstable, release with new features, these tags, originating from the latest `main` branch code, are your go-to.
 
@@ -65,9 +65,9 @@ Conversely, if stability is your primary concern, you should opt for the release
 
 **About:**
 
-+ [OpenIM Milestones](https://github.com/OpenIMSDK/Open-IM-Server/milestones)
-+ [OpenIM Tags](https://github.com/OpenIMSDK/Open-IM-Server/tags)
-+ [OpenIM Branches](https://github.com/OpenIMSDK/Open-IM-Server/branches)
++ [OpenIM Milestones](https://github.com/openimsdk/open-im-server/milestones)
++ [OpenIM Tags](https://github.com/openimsdk/open-im-server/tags)
++ [OpenIM Branches](https://github.com/openimsdk/open-im-server/branches)
 
 We create a new branch, such as `release-v3.1`, for each significant milestone (e.g., v3.1.0), housing all relevant code for that release. All enhancements and bug fixes targeting the subsequent version (e.g., v3.2.0) are integrated into this branch.
 
@@ -82,7 +82,7 @@ We reinforce our approach to branch management and versioning with stringent tes
 The workflow to address a bug fix might follow these steps:
 
 ```bash
-bashCopy codebashCopy code# Checkout the branch for the version that needs the bug fix
+# Checkout the branch for the version that needs the bug fix
 git checkout release-v3.1
 
 # Create a new branch for the bug fix
@@ -120,5 +120,4 @@ Throughout this process, active communication within the team is pivotal to main
 
 ## Docker Images Version Management
 
-For more details on managing Docker image versions, visit [OpenIM Docker Images Administration](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/images.md).
-
+For more details on managing Docker image versions, visit [OpenIM Docker Images Administration](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/images.md).