fix: channge smail images

Signed-off-by: Xinwei Xiong(cubxxw-openim) <3293172751nss@gmail.com>
fix: chat scripts path bug
2023-08-09 21:57:19 +08:00 · 2023-08-09 21:12:26 +08:00 · 2023-08-09 20:16:36 +08:00 · 2023-08-09 20:06:06 +08:00 · 2023-08-09 20:05:37 +08:00 · 2023-08-09 18:39:11 +08:00
148 changed files with 4324 additions and 811 deletions
@@ -15,7 +15,7 @@ CHANGELOG/
 # LICENSE

 # Ignore testing and linting configuration
-.golangci.yml
+scripts/golangci.yml

 # Ignore deployment-related files
 docker-compose.yaml
@@ -42,7 +42,7 @@ jobs:
            # 
            # Note: by default the `.golangci.yml` file should be at the root of the repository.
            # The location of the configuration file can be changed by using `--config=`
-            # args: --timeout=30m --config=/my/path/.golangci.yml --issues-exit-code=0
+            args: --timeout=30m --config=/scripts/golangci.yml # --issues-exit-code=0

            # Optional: show only new issues if it's a pull request. The default value is `false`.
            # only-new-issues: true
@@ -43,9 +43,12 @@ jobs:
          # either 'goreleaser' (default) or 'goreleaser-pro':
          distribution: goreleaser
          version: latest
-          args: release --clean
+          workdir: .
+          args: release -f ./build/goreleaser.yaml --rm-dist --clean --release-footer-tmpl=scripts/template/footer.md.tmpl --release-header-tmpl=scripts/template/head.md.tmpl
        env:
+          USERNAME: ${{ github.repository_owner }}
          GITHUB_TOKEN: ${{ secrets.BOT_GITHUB_TOKEN }}
+          FURY_TOKEN: ${{ secrets.FURY_TOKEN }}
          # Your GoReleaser Pro key, if you are using the 'goreleaser-pro'
          # distribution:
          # GORELEASER_KEY: ${{ secrets.GORELEASER_KEY }}
@@ -40,10 +40,13 @@ jobs:
    - name: Checkout code
      uses: actions/checkout@v3

+    - name: Download Docker Compose
+      run: |
+        curl -o docker-compose.yaml https://gist.githubusercontent.com/cubxxw/b1d5cbd2edfa23fee911118aa3e8249e/raw/openim-server.sh
+      shell: bash
+
    - name: Start Docker Compose
      run: |
-        sudo docker compose stop
-        sudo sleep 30
        sudo docker compose up -d
        sudo sleep 60
      continue-on-error: true
@@ -156,7 +156,7 @@ flycheck_*.el
 # vendor/

 # Go workspace file
-go.work
+# go.work

 ### JetBrains ###
 # Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider
@@ -16,8 +16,8 @@ RUN go mod download
 # Copy all files to the container
 ADD . .

-RUN /bin/sh -c "make clean"
-RUN /bin/sh -c "make build"
+RUN make clean
+RUN make build

 FROM ghcr.io/openim-sigs/openim-bash-image:latest

@@ -26,8 +26,6 @@ WORKDIR ${SERVER_WORKDIR}
 # Copy scripts and binary files to the production image
 COPY --from=builder ${OPENIM_SERVER_CMDDIR} /openim/openim-server/scripts
 COPY --from=builder ${SERVER_WORKDIR}/config /openim/openim-server/config
-COPY --from=builder ${SERVER_WORKDIR}/_output/bin/platforms /openim/openim-server/_output/bin/platforms
-
-VOLUME ["/openim/openim-server/logs","/openim/openim-server/config","/openim/openim-server/scripts"]
+COPY --from=builder $OPENIM_SERVER_BINDIR/platforms /openim/openim-server/_output/bin/platforms

 CMD ["bash","-c","${OPENIM_SERVER_CMDDIR}/docker_start_all.sh"]
@@ -12,7 +12,7 @@ all: tidy gen add-copyright format lint cover build
 # Build set

 ROOT_PACKAGE=github.com/OpenIMSDK/Open-IM-Server
-# TODO: This is version control for the future
+# TODO: This is version control for the future https://github.com/OpenIMSDK/Open-IM-Server/issues/574
 VERSION_PACKAGE=github.com/OpenIMSDK/Open-IM-Server/pkg/version

 # ==============================================================================
@@ -191,6 +191,11 @@ advertise:
 release: release.verify release.ensure-tag
 	@scripts/release.sh

+## demo: Run demo ✨
+.PHONY: demo
+demo:
+	@$(MAKE) go.demo
+
 ## help: Show this help info. ✨
 .PHONY: help
 help: Makefile
@@ -22,42 +22,109 @@

 <p align="center">
    <a href="./README.md"><b> English </b></a> •
-    <a href="./README-zh_CN.md"><b> 中文 </b></a>
+    <a href="./README-zh_CN.md"><b> 简体中文 </b></a> •
+    <a href="https://www.openim.online/en"><b> Docs </b></a>
 </p>

+
 </p>

-## What is Open-IM-Server
+## ✨ About OpenIM

-Open-IM-Server is an instant messaging server developed using pure Golang, adopting JSON over WebSocket as the communication protocol. In Open-IM-Server, everything is a message, so you can easily extend custom messages without modifying the server code. With a microservice architecture, Open-IM-Server can be deployed using clusters. By deploying Open-IM-Server on a server, developers can quickly integrate instant messaging and real-time networking features into their applications, ensuring the security and privacy of business data.
+Open-IM-Server, crafted meticulously using pure Golang, stands as a robust instant messaging server. Its unique approach to communication, via JSON over WebSocket, treats every interaction as a message. This simplifies customization and eliminates the need for tinkering with server code. Harnessing the power of microservice architecture, the server can be deployed via clusters, promising impressive performance and scalability.

-Open-IM-Server is not a standalone product and does not include account registration and login services. For your convenience, we have open-sourced the [chat repository](https://github.com/OpenIMSDK/chat) which includes login and registration functionality. By deploying the chat business server alongside Open-IM-Server, a chat product can be set up.
+Open-IM-Server is more than an instant messaging server; it's a powerful tool for incorporating real-time networking into your applications, positioning itself as your premier choice for integration! 🚀

-## Features
+Please be aware that Open-IM-Server does not function as a standalone product and does not offer built-in account registration or login services. To ease your implementation process, we've open-sourced the [chat repository](https://github.com/OpenIMSDK/chat), which comprises these features. Deploying this chat business server in conjunction with Open-IM-Server expedites the setup of a comprehensive chat product. 👥

- Open source
- Easy to integrate
- Excellent scalability
- High performance
- Lightweight
- Supports multiple protocols
+Further enhancing your experience, we also provide an SDK client, wherein most complex logics are implemented. The [SDK repository](https://github.com/OpenIMSDK/openim-sdk-core) can be found at [this link](https://github.com/OpenIMSDK/openim-sdk-core). The [chat repository](https://github.com/OpenIMSDK/chat) is our business server while the 'core' represents the high-level encapsulation of the SDK, synergistically working together to deliver superior results. ✨

-## Community
- Visit the official website: [OpenIM  Developer Documentation](https://www.openim.online/)
+## :star2: Why OpenIM

-## Quick Start
+**🔍 Function screenshot display**

-### Deploying with docker-compose
+<div align="center">
+
+|            💻🔄📱 Multi Terminal Synchronization 🔄🖥️             |                  📅⚡ Efficient Meetings 🚀💼      |
+| :----------------------------------------------------------: | :---------------------------------------------------------: |
+| ![multiple-message](./assets/demo/multi-terminal-synchronization.png) | ![efficient-meetings](./assets/demo/efficient-meetings.png) |
+|             📲🔄 **One-to-one and Group Chats** 👥🗣️             |        🎁💻 **Special Features - Custom Messages** ✉️🎨|
+|         ![group-chat](./assets/demo/group-chat.png)          |   ![special-function](./assets/demo/special-function.png)      |
+
+</div>
+
+1. **Comprehensive Message Type Support :speech_balloon:**
+
+   ✅ Supports almost all types of messages, including text, images, emojis, voice, video, geographical location, files, quotes, business cards, system notifications, custom messages and more
+
+   ✅ Supports one-on-one and multi-person audio and video calls
+
+   ✅ Provides terminal support for multiple platforms such as iOS, Android, Flutter, uni-app, ReactNative, Electron, Web, H5 
+
+2. **Efficient Meetings Anytime, Anywhere :earth_americas:**
+
+   ✅ Based on IM (Instant Messaging) with 100% reliable forced signaling capabilities, it paves the way for IM systems, deeply integrated with chat applications 
+
+   ✅ Supports hundreds of people in a single meeting, with subscription numbers reaching thousands, and server-side audio and video recording 
+
+3. **One-on-one and Group Chats for Various Social Scenarios :busts_in_silhouette:**
+
+   ✅ OpenIM has four roles: application administrator, group owner, group administrator, and regular member 
+
+   ✅ Powerful group features such as muting, group announcements, group validation, unlimited group members, and loading group messages as needed 
+
+4. **Unique Features :star2:**
+
+   ✅ Supports read-and-burn private chats, customizable duration
+
+   ✅ Message editing function broadens social scenarios, making instant communication more diverse and interesting
+
+5. **Open Source :open_hands:**
+
+   ✅ The code of OpenIM is open source, self-controlled data, aimed at building a globally leading IM open source community, including client SDK and server 
+
+   ✅ Based on open source Server, many excellent open source projects have been developed, such as [OpenKF](https://github.com/OpenIMSDK/OpenKF) (Open source AI customer service system) 
+
+6. **Easy to Expand :wrench:**
+
+   ✅ The OpenIM server is implemented in Golang, introducing an innovative "everything is a message" communication model, simplifying the implementation of custom messages and extended features 
+
+7. **High Performance :racing_car:**
+
+   ✅ OpenIM supports a hierarchical governance architecture in the cluster, tested by a large number of users, and abstracts the storage model of online messages, offline messages, and historical messages 
+
+8. **Full Platform Support :tv:**
+
+   ✅ Supports native iOS, Android; cross-platform Flutter, uni-app, ReactNative; major web front-end frameworks such as React, Vue; applets; and PC platforms supported by Electron
+
+9. **The ultimate deployment experience 🤖** 
+
+   ✅  Supports [cluster deployment](https://github.com/OpenIMSDK/Open-IM-Server/edit/main/deployments/README.md)
+
+   ✅  Supports multi-architecture mirroring, our Docker images are hosted not only on GitHub but also on Alibaba Cloud and Docker Hub supporting multiple architectures. Visit [our GitHub packages](https://github.com/orgs/OpenIMSDK/packages?repo_name=Open-IM-Server) and read our [version management document](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/version.md) for more information.
+
+11. **A large ecosystem of open source communities 🤲**
+
+    ✅  We have tens of thousands of users and many solutions to problems.
+
+    ✅  We have a large open source community called [OpenIMSDK](https://github.com/OpenIMSDK) that runs the core modules, we have an open source community called [openim-sigs](https://github.com/openim-sigs) to explore more IM-based infrastructure products.
+
+## :rocket: Quick Start
+
+<details>   <summary>Deploying with Docker Compose</summary>

 1. Clone the project

 ```bash
 # choose what you need
-BRANCH=release-v3.0
+BRANCH=release-v3.1
 git clone -b $BRANCH https://github.com/OpenIMSDK/Open-IM-Server openim && export openim=$(pwd)/openim && cd $openim && make build
 ```

-2. Modify .env
+> **Note**
+> Read our release policy: https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/version.md
+
+2. Modify `.env`

 ```bash
 USER=root #no need to modify
@@ -70,9 +137,9 @@ DATA_DIR=./  #designate large disk directory
 3. Deploy and start

 > **Note**
-> This command can only be executed once. It will modify the component passwords in docker-compose based on the PASSWORD variable in .env, and modify the component passwords in config/config.yaml. If the password in .env changes, you need to first execute docker-compose down; rm components -rf and then execute this command.
+> This command can only be executed once. It will modify the component passwords in docker-compose based on the `PASSWORD` variable in `.env`, and modify the component passwords in `config/config.yaml`. If the password in `.env` changes, you need to first execute `docker-compose down`; `rm components -rf` and then execute this command.

-```
+```bash
 make install
 ```

@@ -84,9 +151,9 @@ make check

 ![https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/images/docker_build.png](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/images/docker_build.png)

+</details> 

-
-### Compile from source
+<details>  <summary>Compile from Source</summary>

 Ur need `Go 1.18` or higher version, and `make`.

@@ -97,6 +164,7 @@ Version Details: https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conv
 BRANCH=release-v3.1
 git clone -b $BRANCH https://github.com/OpenIMSDK/Open-IM-Server openim && export openim=$(pwd)/openim && cd $openim && make build
 ```
+
 Read about the [OpenIM Version Policy](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/version.md)

 `make help` to help you see the instructions supported by OpenIM.
@@ -105,7 +173,9 @@ All services have been successfully built as shown in the figure

 ![Successful Compilation](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/images/build.png)

-### Component Configuration Instructions
+</details>
+
+<details>  <summary>Component Configuration Instructions</summary>

 The config/config.yaml file has detailed configuration instructions for the storage components.

@@ -113,7 +183,7 @@ The config/config.yaml file has detailed configuration instructions for the stor

  - Used for RPC service discovery and registration, cluster support.

-    ```
+    ```bash
    zookeeper:
      schema: openim                          #Not recommended to modify
      address: [ 127.0.0.1:2181 ]             #address
@@ -125,7 +195,7 @@ The config/config.yaml file has detailed configuration instructions for the stor

  - Used for storing users, relationships, and groups, supports master-slave database.

-    ```
+    ```bash
    mysql:
      address: [ 127.0.0.1:13306 ]            #address
      username: root                          #username
@@ -142,7 +212,7 @@ The config/config.yaml file has detailed configuration instructions for the stor

  - Used for storing offline messages, supports mongo sharded clusters.

-    ```
+    ```bash
    mongo:
      uri:                                    #Use this value directly if not empty
      address: [ 127.0.0.1:37017 ]            #address
@@ -156,7 +226,7 @@ The config/config.yaml file has detailed configuration instructions for the stor

  - Used for storing message sequence numbers, latest messages, user tokens, and mysql cache, supports cluster deployment.

-    ```
+    ```bash
    redis:
      address: [ 127.0.0.1:16379 ]            #address
      username:                               #username
@@ -167,7 +237,7 @@ The config/config.yaml file has detailed configuration instructions for the stor

  - Used for message queues, for message decoupling, supports cluster deployment.

-    ```
+    ```bash
    kafka:
      username:                               #username
      password:                               #password
@@ -188,27 +258,31 @@ The config/config.yaml file has detailed configuration instructions for the stor
        msgToModify: modify
    ```

-### Start and Stop Services
+</details>
+
+<details>  <summary>Start and Stop Services</summary>

 Start services

 ```
-./start_all.sh;
+./scripts/start_all.sh;
 ```

 Check services

 ```
-./check_all.sh
+./scripts/check_all.sh
 ```

 Stop services

 ```
-./stop_all.sh
+./scripts/stop_all.sh
 ```

-### Open IM Ports
+</details> 
+
+<details>  <summary>Open IM Ports</summary>

 | TCP Port  | Description                                                  | Operation                                             |
 | --------- | ------------------------------------------------------------ | ----------------------------------------------------- |
@@ -216,42 +290,75 @@ Stop services
 | TCP:10002 | api port, such as user, friend, group, message interfaces.   | Port release or nginx reverse proxy, and firewall off |
 | TCP:10005 | Required when choosing minio storage (openIM uses minio storage by default) | Port release or nginx reverse proxy, and firewall off |

-### Open Chat Ports
+</details> 
+
+<details>  <summary>Open Chat Ports</summary>
+
+ chat warehouse: https://github.com/OpenIMSDK/chat 

 | TCP Port  | Description                                         | Operation                                             |
 | --------- | --------------------------------------------------- | ----------------------------------------------------- |
 | TCP:10008 | Business system, such as registration, login etc    | Port release or nginx reverse proxy, and firewall off |
 | TCP:10009 | Management backend, such as statistics, banning etc | Port release or nginx reverse proxy, and firewall off |

-## Relationship Between APP and OpenIM
+</details>

-OpenIM is an open source instant messaging component, it is not an independent product. This image shows the relationship between AppServer, AppClient, Open-IM-Server and Open-IM-SDK.
+## :link: Relationship Between APP and OpenIM

-![https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/open-im-server.png](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/images/open-im-server.png)
+OpenIM isn't just an open-source instant messaging component, it's an integral part of your application ecosystem. Check out this diagram to understand how AppServer, AppClient, Open-IM-Server, and Open-IM-SDK interact.

-## Overall Architecture
+![App-OpenIM Relationship](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/images/open-im-server.png)

-![https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/Architecture.jpg](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/images/Architecture.jpg)
+## :building_construction: Overall Architecture

-## To start developing OpenIM
-The [community repository](https://github.com/OpenIMSDK/community) hosts all information about building Kubernetes from source, how to contribute code and documentation, who to contact about what, etc.
+Delve into the heart of Open-IM-Server's functionality with our architecture diagram.

+![Overall Architecture](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/images/Architecture.jpg)

-## Contributing
+## :hammer_and_wrench: To start developing OpenIM

-Contributions to this project are welcome! Please see [CONTRIBUTING.md](./CONTRIBUTING.md) for details.
+OpenIM Our goal is to build a top-level open source community. We have a set of standards, in the [Community repository](https://github.com/OpenIMSDK/community).

-## Community Meetings
-We want anyone to get involved in our community, we offer gifts and rewards, and we welcome you to join us every Thursday night.
+If you'd like to contribute to this Open-IM-Server repository, please read our [contributor documentation](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/CONTRIBUTING.md).

-We take notes of each [biweekly meeting](https://github.com/OpenIMSDK/Open-IM-Server/issues/381) in [GitHub discussions](https://github.com/OpenIMSDK/Open-IM-Server/discussions/categories/meeting), and our minutes are written in [Google Docs](https://docs.google.com/document/d/1nx8MDpuG74NASx081JcCpxPgDITNTpIIos0DS6Vr9GU/edit?usp=sharing).
+Before you start, please make sure your changes are in demand. The best for that is to create a [new discussion](https://github.com/OpenIMSDK/Open-IM-Server/discussions/new/choose) OR [Slack Communication](https://join.slack.com/t/openimsdk/shared_invite/zt-1tmoj26uf-_FDy3dowVHBiGvLk9e5Xkg), or if you find an issue, [report it](https://github.com/OpenIMSDK/Open-IM-Server/issues/new/choose) first.

+- [Code Standards](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/go_code.md)
+- [Docker Images Standards](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/images.md)
+- [Directory Standards](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/directory.md)
+- [Commit Standards](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/commit.md)
+- [Versioning Standards](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/version.md)
+- [Interface Standards](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/api.md)
+- [Log Standards](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/log.md)
+- [Error Code Standards](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/error_code.md)

-## Who are using Open-IM-Server
-The [user case studies](https://github.com/OpenIMSDK/community/blob/main/ADOPTERS.md) page includes the user list of the project. You can leave a [📝comment](https://github.com/OpenIMSDK/Open-IM-Server/issues/379) to let us know your use case.
+## :busts_in_silhouette: Community

-![avatar](https://openim-1253691595.cos.ap-nanjing.myqcloud.com/WechatIMG20.jpeg)
+ 📚 [OpenIM Community](https://github.com/OpenIMSDK/community)
+ 💕 [OpenIM Interest Group](https://github.com/Openim-sigs)
+ 🚀 [Join our Slack community](https://join.slack.com/t/openimsdk/shared_invite/zt-1tmoj26uf-_FDy3dowVHBiGvLk9e5Xkg)
+ :eyes: [Join our wechat (微信群)](https://openim-1253691595.cos.ap-nanjing.myqcloud.com/WechatIMG20.jpeg)

-## License
+## :calendar: Community Meetings

-Open-IM-Server is under the Apache 2.0 license. See the [LICENSE](./LICENSE) file for details
+We want anyone to get involved in our community and contributing code, we offer gifts and rewards, and we welcome you to join us every Thursday night.
+
+Our conference is in the [OpenIM Slack](https://join.slack.com/t/openimsdk/shared_invite/zt-1tmoj26uf-_FDy3dowVHBiGvLk9e5Xkg) 🎯, then you can search the Open-IM-Server pipeline to join
+
+We take notes of each [biweekly meeting](https://github.com/orgs/OpenIMSDK/discussions/categories/meeting) in [GitHub discussions](https://github.com/OpenIMSDK/Open-IM-Server/discussions/categories/meeting), Our historical meeting notes, as well as replays of the meetings are available at [Google Docs :bookmark_tabs:](https://docs.google.com/document/d/1nx8MDpuG74NASx081JcCpxPgDITNTpIIos0DS6Vr9GU/edit?usp=sharing).
+
+## :eyes: Who are using OpenIM
+
+Check out our [user case studies](https://github.com/OpenIMSDK/community/blob/main/ADOPTERS.md) page for a list of the project users. Don't hesitate to leave a [📝comment](https://github.com/OpenIMSDK/Open-IM-Server/issues/379) and share your use case.
+
+## :page_facing_up: License
+
+OpenIM is licensed under the Apache 2.0 license. See [LICENSE](https://github.com/OpenIMSDK/Open-IM-Server/tree/main/LICENSE) for the full license text.
+
+The OpenIM logo, including its variations and animated versions, displayed in this repository [OpenIM](https://github.com/OpenIMSDK/Open-IM-Server) under the [assets/logo](./assets/logo) and [assets/logo-gif](assets/logo-gif) directories, are protected by copyright laws.
+
+## 🔮 Thanks to our contributors!
+
+<a href="https://github.com/OpenIMSDK/Open-IM-Server/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=OpenIMSDK/Open-IM-Server" />
+</a>
@@ -0,0 +1,14 @@
+## :star2: Why OpenIM
+
+**🔍 Function screenshot display**
+
+<div align="center">
+
+
+|             multiple message              |               Efficient meetings                |
+| :---------------------------------------: | :---------------------------------------------: |
+| ![multiple-message](./multiple-message.png) | ![efficient-meetings](./efficient-meetings.png) |
+|      **One-to-one and group chats**       |     **Special features - Custom messages**      |
+|      ![group-chat](./group-chat.png)      |   ![special-function](./special-function.png)    |
+
+</div>
@@ -34,13 +34,16 @@ COPY . .
 RUN make clean
 RUN make build BINS=openim-api

-FROM ghcr.io/openim-sigs/openim-bash-image:latest
+# FROM ghcr.io/openim-sigs/openim-bash-image:latest
+FROM test:v1

 WORKDIR /openim/openim-server

 COPY --from=builder /openim/openim-server/_output/bin/platforms /openim/openim-server/_output/bin/platforms
 COPY --from=builder /openim/openim-server/config /openim/openim-server/config

-EXPOSE ${10002}
+ENV PORT 10002

-CMD ["sh","-c","${OPENIM_SERVER_BINDIR}/platforms/${OS}/${ARCH}/openim-api --port 10002 -c ${SERVER_WORKDIR}/config"]
+EXPOSE ${PORT}
+
+CMD ["bash", "-c","${OPENIM_SERVER_BINDIR}/platforms/$(get_os)/$(get_arch)/openim-api --port ${PORT} -c ${SERVER_WORKDIR}/config"]
@@ -39,7 +39,7 @@ FROM ghcr.io/openim-sigs/openim-bash-image:latest

 WORKDIR /openim/openim-server

-COPY --from=builder ${SERVER_WORKDIR}/_output/bin/platforms /openim/openim-server/_output/bin/platforms
+COPY --from=builder $OPENIM_SERVER_BINDIR/platforms /openim/openim-server/_output/bin/platforms
 COPY --from=builder ${SERVER_WORKDIR}/config /openim/openim-server/config

-CMD ["sh","-c","${OPENIM_SERVER_BINDIR}/platforms/${OS}/${ARCH}/openim-cmdutils"]
+CMD ["bash", "-c","${OPENIM_SERVER_BINDIR}/platforms/$(get_os)/$(get_arch)/openim-cmdutils"]
@@ -41,4 +41,4 @@ WORKDIR /openim/openim-server
 COPY --from=builder /openim/openim-server/_output/bin/platforms /openim/openim-server/_output/bin/platforms
 COPY --from=builder /openim/openim-server/config /openim/openim-server/config

-CMD ["sh","-c","${OPENIM_SERVER_BINDIR}/platforms/${OS}/${ARCH}/openim-crontask"]
+CMD ["bash", "-c","${OPENIM_SERVER_BINDIR}/platforms/$(get_os)/$(get_arch)/openim-crontask"]
@@ -47,4 +47,4 @@ ENV ARCH ${ARCH}
 EXPOSE 10140
 EXPOSE 10001

-CMD ${OPENIM_SERVER_BINDIR}/platforms/${OS}/${ARCH}/openim-msggateway --port 10140 --ws_port 10001
+CMD ${OPENIM_SERVER_BINDIR}/platforms/$(get_os)/$(get_arch)/openim-msggateway --port 10140 --ws_port 10001
@@ -44,4 +44,4 @@ WORKDIR /openim/openim-server
 COPY --from=builder /openim/openim-server/_output/bin/platforms /openim/openim-server/_output/bin/platforms
 COPY --from=builder /openim/openim-server/config /openim/openim-server/config

-CMD ${OPENIM_SERVER_BINDIR}/platforms/${OS}/${ARCH}/openim-msgtransfer
+CMD ${OPENIM_SERVER_BINDIR}/platforms/$(get_os)/$(get_arch)/openim-msgtransfer
@@ -46,4 +46,4 @@ COPY --from=builder /openim/openim-server/config /openim/openim-server/config

 EXPOSE 10170

-CMD ${OPENIM_SERVER_BINDIR}/platforms/${OS}/${ARCH}/openim-push --port 10170
+CMD ${OPENIM_SERVER_BINDIR}/platforms/$(get_os)/$(get_arch)/openim-push --port 10170
@@ -49,4 +49,4 @@ COPY --from=builder /openim/openim-server/config /openim/openim-server/config

 EXPOSE 10160

-CMD ["sh","-c","${OPENIM_SERVER_BINDIR}/platforms/${OS}/${ARCH}/openim-rpc-auth --port 10160 -c ${SERVER_WORKDIR}/config"]
+CMD ["bash", "-c","${OPENIM_SERVER_BINDIR}/platforms/$(get_os)/$(get_arch)/openim-rpc-auth --port 10160 -c ${SERVER_WORKDIR}/config"]
@@ -56,4 +56,4 @@ COPY --from=builder /openim/openim-server/config /openim/openim-server/config
 EXPOSE 10230
 EXPOSE 20230

-CMD ["sh","-c","${OPENIM_SERVER_BINDIR}/platforms/${OS}/${ARCH}/openim-rpc-conversation --port 10230 --prometheus_port 20230 -c ${SERVER_WORKDIR}/config"]
+CMD ["bash", "-c","${OPENIM_SERVER_BINDIR}/platforms/$(get_os)/$(get_arch)/openim-rpc-conversation --port 10230 --prometheus_port 20230 -c ${SERVER_WORKDIR}/config"]
@@ -56,4 +56,4 @@ COPY --from=builder /openim/openim-server/config /openim/openim-server/config
 EXPOSE 10120
 EXPOSE 20120

-CMD ["sh","-c","${OPENIM_SERVER_BINDIR}/platforms/${OS}/${ARCH}/openim-rpc-friend --port 10120 --prometheus_port 20120 -c ${SERVER_WORKDIR}/config"]
+CMD ["bash", "-c","${OPENIM_SERVER_BINDIR}/platforms/$(get_os)/$(get_arch)/openim-rpc-friend --port 10120 --prometheus_port 20120 -c ${SERVER_WORKDIR}/config"]
@@ -56,4 +56,4 @@ COPY --from=builder /openim/openim-server/config /openim/openim-server/config
 EXPOSE 10150
 EXPOSE 20150

-CMD ["sh","-c","${OPENIM_SERVER_BINDIR}/platforms/${OS}/${ARCH}/openim-rpc-group --port 10150 --prometheus_port 20150 -c ${SERVER_WORKDIR}/config"]
+CMD ["bash", "-c","${OPENIM_SERVER_BINDIR}/platforms/$(get_os)/$(get_arch)/openim-rpc-group --port 10150 --prometheus_port 20150 -c ${SERVER_WORKDIR}/config"]
@@ -56,4 +56,4 @@ COPY --from=builder /openim/openim-server/config /openim/openim-server/config
 EXPOSE 10130
 EXPOSE 20130

-CMD ["sh","-c","${OPENIM_SERVER_BINDIR}/platforms/${OS}/${ARCH}/openim-rpc-msg --port 10130 --prometheus_port 20130 -c ${SERVER_WORKDIR}/config"]
+CMD ["bash", "-c","${OPENIM_SERVER_BINDIR}/platforms/$(get_os)/$(get_arch)/openim-rpc-msg --port 10130 --prometheus_port 20130 -c ${SERVER_WORKDIR}/config"]
@@ -55,4 +55,4 @@ COPY --from=builder /openim/openim-server/config /openim/openim-server/config

 EXPOSE 10200

-CMD ["sh","-c","${OPENIM_SERVER_BINDIR}/platforms/${OS}/${ARCH}/openim-rpc-third --port 10200 -c ${SERVER_WORKDIR}/config"]
+CMD ["bash", "-c","${OPENIM_SERVER_BINDIR}/platforms/$(get_os)/$(get_arch)/openim-rpc-third --port 10200 -c ${SERVER_WORKDIR}/config"]
@@ -55,4 +55,4 @@ COPY --from=builder /openim/openim-server/config /openim/openim-server/config

 EXPOSE 10110

-CMD ["sh","-c","${OPENIM_SERVER_BINDIR}/platforms/${OS}/${ARCH}/openim-rpc-user --port 10110 -c ${SERVER_WORKDIR}/config"]
+CMD ["bash", "-c","${OPENIM_SERVER_BINDIR}/platforms/$(get_os)/$(get_arch)/openim-rpc-user --port 10110 -c ${SERVER_WORKDIR}/config"]
@@ -479,53 +479,4 @@ checksum:
  algorithm: sha256

 release:
-
  prerelease: auto
-  
-  footer: |
-  
-    ## Welcome to the {{ .Tag }} release of [chat](https://github.com/OpenIMSDK/chat)!🎉🎉!
-
-    **Full Changelog**: https://github.com/OpenIMSDK/Open-IM-Server/compare/{{ .PreviousTag }}...{{ .Tag }}
-
-    ## Helping out
-
-    + We release logs are recorded on [✨CHANGELOG](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/CHANGELOG/CHANGELOG.md)
-
-    + For information on versions of OpenIM and how to maintain branches, read [📚this article](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/version.md)
-
-    + If you wish to use mirroring, read OpenIM's [image management policy](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/images.md)
-
-    **Want to be one of them 😘?**
-
-    <p align="center">
-        <a href="https://github.com/kubbot" style="float: left; margin-right: 10px;">
-            <img src="https://github.com/openimbot/openimbot/blob/main/assets/icon/blue%E9%80%8F%E6%98%8E.png" width="50" height="50" />
-        </a>
-        <a href="https://www.openim.online">
-            <img src="https://github.com/OpenIMSDK/Open-IM-Server/blob/main/assets/logo/openim-logo.png" />
-        </a>
-        <a href="https://github.com/openimbot" style="float: right; margin-left: 10px;">
-            <img src="https://github.com/openimbot/openimbot/blob/main/assets/icon/red%E9%80%8F%E6%98%8E.png" width="50" height="50" />
-        </a>
-    </p>
-
-    > **Note**
-    > @openimbot and @kubbot have made great contributions to the community as community 🤖robots(@openimsdk/bot), respectively.
-    > Thanks to the @openimsdk/openim team for all their hard work on this release.
-    > Thank you to all the [💕developers and contributors](https://github.com/OpenIMSDK/Open-IM-Server/graphs/contributors), people from all over the world, OpenIM brings us together
-    > Contributions to this project are welcome! Please see [CONTRIBUTING.md](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/CONTRIBUTING.md) for details.
-
-    ## Get Involved with OpenIM!
-
-    **Here are some ways to get involved with the OpenIM community:**
-
-    📢 **Slack Channel**: Join our Slack channels for discussions, communication, and support. Click [here](https://join.slack.com/t/openimsdk/shared_invite/zt-1tmoj26uf-_FDy3dowVHBiGvLk9e5Xkg) to join the Open-IM-Server Slack team channel.
-
-    📧 **Gmail Contact**: If you have any questions, suggestions, or feedback for our open-source projects, please feel free to [contact us via email](https://mail.google.com/mail/?view=cm&fs=1&tf=1&to=winxu81@gmail.com).
-
-    📖 **Blog**: Stay up-to-date with OpenIM-Server projects and trends by reading our [blog](https://doc.rentsoft.cn/). We share the latest developments, tech trends, and other interesting information related to OpenIM.
-
-    📱 **WeChat**: Add us on WeChat (QR Code) and indicate that you are a user or developer of Open-IM-Server. We'll process your request as soon as possible.
-
-    Remember, your contributions play a vital role in making OpenIM successful, and we look forward to your active participation in our community! 🙌
@@ -2,6 +2,17 @@

 OpenIM 支持很多种集群化部署方式，包括但不限于 helm, sealos, kubeam, kubesphere, kubeflow, kuboard, kubespray, k3s, k3d, k3c, k3sup, k3v, k3x

+**目前还在开发这个模块，预计 v3.2.0 之前会有一个集群方案。**
+
+目前各个贡献者，以及之前的官方有出过一些可以参考的方案：
+
+- https://github.com/OpenIMSDK/k8s-jenkins
+- https://github.com/OpenIMSDK/Open-IM-Server-k8s-deploy
+- https://github.com/OpenIMSDK/openim-charts
+- https://github.com/showurl/deploy-openim
+
+
+
 ### 依赖检查

 ```bash
@@ -52,7 +52,6 @@ services:
      net.core.somaxconn: 1024
    command: redis-server --requirepass ${PASSWORD} --appendonly yes

-
  zookeeper:
    image: wurstmeister/zookeeper
    ports:
@@ -64,7 +63,6 @@ services:
      TZ: Asia/Shanghai
    restart: always

-
  kafka:
    image: wurstmeister/kafka
    container_name: kafka
@@ -98,9 +96,8 @@ services:
    restart: always
    command: minio server /data --console-address ':9090'

-
-  openim_server:
-    image: ghcr.io/openim-sigs/openim-server:v1.0.0-debug.11 #ghcr.io/openimsdk/openim-server:main
+  openim-server:
+    image: ghcr.io/openimsdk/openim-server:latest
    container_name: openim-server
    volumes:
      - ./logs:/openim/openim-server/logs
@@ -122,7 +119,7 @@ services:
        max-file: "2"

  openim-chat:
-    image: ghcr.io/openim-sigs/openim-chat:v1.0.0-debug.11 # ghcr.io/openimsdk/openim-chat:main
+    image: ghcr.io/openimsdk/openim-chat:latest
    container_name: openim-chat
    volumes:
      - ./_output/openim/openim-chat/logs:/openim/openim-chat/logs
@@ -134,7 +131,7 @@ services:
      - mongodb
      - redis
      - minio
-      - openim_server
+      - openim-server
    network_mode: "host"
    logging:
      driver: json-file
@@ -150,7 +147,7 @@ services:
    #    ports:
    #    - 9091:9091
    depends_on:
-    - openim_server
+    - openim-server
    command: --web.listen-address=:9091 --config.file="/etc/prometheus/prometheus.yml"
    network_mode: "host"

@@ -1,8 +1,5 @@
 docs/.generated_docs
-docs/guide/en-US/cmd/iam-apiserver.md
-docs/guide/en-US/cmd/iam-authz-server.md
-docs/guide/en-US/cmd/iam-pump.md
-docs/guide/en-US/cmd/iam-watcher.md
+
 docs/guide/en-US/cmd/openim/openim.md
 docs/guide/en-US/cmd/openim/openim_color.md
 docs/guide/en-US/cmd/openim/openim_completion.md
@@ -77,7 +77,7 @@ logs/*  @skiffer-git @FGadvancer
 pkg/a2r  @openimsdk/openim @skiffer-git @cubxxw @openimsdk/bot

 # scripts directory
-scripts/LICENSE/*   @openimsdk/openim @cubxxw @skiffer-git @FGadvancer
+scripts/template/*   @openimsdk/openim @cubxxw @skiffer-git @FGadvancer
 scripts/enterprise/*  @openimsdk/openim @FGadvancer @cubxxw @skiffer-git @openimsdk/bot
 scripts/githooks/*   @openimsdk/openim @cubxxw @skiffer-git @FGadvancer
 scripts/lib/*   @openimsdk/openim @FGadvancer @cubxxw @skiffer-git @openimsdk/bot
@@ -1,23 +1,19 @@
-## Go 代码开发规范
-在Go 项目开发中，一个好的编码规范可以极大的提高代码质量。为了帮你节省时间和精力，这里我整理了一份清晰、可直接套用的 Go 编码规范，供你参考。
+## OpenIM development specification
+We have very high standards for code style and specification, and we want our products to be polished and perfect

-这份规范，是我参考了 Go 官方提供的编码规范，以及 Go 社区沉淀的一些比较合理的规范之后，加入自己的理解总结出的，它比很多公司内部的规范更全面，你掌握了，以后在面试大厂的时候，或者在大厂里写代码的时候，都会让人高看你一眼，觉得你code很专业。
+## 1. Code style

-这份编码规范中包含代码风格、命名规范、注释规范、类型、控制结构、函数、GOPATH 设置规范、依赖管理和最佳实践九类规范。如果你觉得这些规范内容太多了，看完一遍也记不住，这完全没关系。你可以多看几遍，也可以在用到时把它翻出来，在实际应用中掌握。这篇特别放送的内容，更多是作为写代码时候的一个参考手册。
+### 1.1 Code format

-## 1. 代码风格
-
-### 1.1 代码格式
-
- 代码都必须用 `gofmt` 进行格式化。
- 运算符和操作数之间要留空格。
- 建议一行代码不超过120个字符，超过部分，请采用合适的换行方式换行。但也有些例外场景，例如import行、工具自动生成的代码、带tag的struct字段。
- 文件长度不能超过800行。
- 函数长度不能超过80行。
- import规范
-	- 代码都必须用`goimports`进行格式化（建议将代码Go代码编辑器设置为：保存时运行 `goimports`）。
-	- 不要使用相对路径引入包，例如 `import ../util/net` 。
-	- 包名称与导入路径的最后一个目录名不匹配时，或者多个相同包名冲突时，则必须使用导入别名。
+- Code must be formatted with `gofmt`.
+- Leave spaces between operators and operands.
+- It is recommended that a line of code does not exceed 120 characters. If the part exceeds, please use an appropriate line break method. But there are also some exception scenarios, such as import lines, code automatically generated by tools, and struct fields with tags.
+- The file length cannot exceed 800 lines.
+- Function length cannot exceed 80 lines.
+- import specification
+- All code must be formatted with `goimports` (it is recommended to set the code Go code editor to: run `goimports` on save).
+- Do not use relative paths to import packages, such as `import ../util/net`.
+- Import aliases must be used when the package name does not match the last directory name of the import path, or when multiple identical package names conflict.

 ```go
 // bad
@@ -26,32 +22,32 @@
 //good
 jwt "github.com/dgrijalva/jwt-go/v4"
 ```
-	- 导入的包建议进行分组，匿名包的引用使用一个新的分组，并对匿名包引用进行说明。
+- Imported packages are suggested to be grouped, and anonymous package references use a new group, and anonymous package references are explained.

 ```go
 import (
-		// go 标准包
+// go standard package
 "fmt"

-		// 第三方包
+// third party package
 "github.com/jinzhu/gorm"
 "github.com/spf13/cobra"
 "github.com/spf13/viper"

-		// 匿名包单独分组，并对匿名包引用进行说明
+// Anonymous packages are grouped separately, and anonymous package references are explained
 // import mysql driver
 _ "github.com/jinzhu/gorm/dialects/mysql"

-		// 内部包
+// inner package
 v1 "github.com/marmotedu/api/apiserver/v1"
 metav1 "github.com/marmotedu/apimachinery/pkg/meta/v1"
 "github.com/marmotedu/iam/pkg/cli/genericclioptions"
 )
 ```

-### 1.2 声明、初始化和定义
+### 1.2 Declaration, initialization and definition

-当函数中需要使用到多个变量时，可以在函数开始处使用`var`声明。在函数外部声明必须使用 `var` ，不要采用 `:=` ，容易踩到变量的作用域的问题。
+When multiple variables need to be used in a function, the `var` declaration can be used at the beginning of the function. Declaration outside the function must use `var`, do not use `:=`, it is easy to step on the scope of the variable.

 ```go
 var (
@@ -60,7 +56,7 @@ var (
 )
 ```

- 在初始化结构引用时，请使用`&T{}`代替`new(T)`，以使其与结构体初始化一致。
+- When initializing a structure reference, please use `&T{}` instead of `new(T)` to make it consistent with structure initialization.

 ```go
 // bad
@@ -71,7 +67,7 @@ sptr.Name = "bar"
 sptr := &T{Name: "bar"}
 ```

- struct 声明和初始化格式采用多行，定义如下。
+- The struct declaration and initialization format takes multiple lines and is defined as follows.

 ```go
 type User struct{
@@ -85,7 +81,7 @@ user := User{
 }
 ```

- 相似的声明放在一组，同样适用于常量、变量和类型声明。
+- Similar declarations are grouped together, and the same applies to constant, variable, and type declarations.

 ```go
 // bad
@@ -99,14 +95,14 @@ import (
 )
 ```

- 尽可能指定容器容量，以便为容器预先分配内存，例如：
+- Specify container capacity where possible to pre-allocate memory for the container, for example:

 ```go
 v := make(map[int]string, 4)
 v := make([]string, 0, 4)
 ```

- 在顶层，使用标准var关键字。请勿指定类型，除非它与表达式的类型不同。
+- At the top level, use the standard var keyword. Do not specify a type unless it is different from the type of the expression.

 ```go
 // bad
@@ -116,13 +112,13 @@ func F() string { return "A" }

 // good
 var_s = F()
-// 由于 F 已经明确了返回一个字符串类型，因此我们没有必要显式指定_s 的类型
-// 还是那种类型
+// Since F already explicitly returns a string type, we don't need to explicitly specify the type of _s
+// still of that type

 func F() string { return "A" }
 ```

- 对于未导出的顶层常量和变量，使用`_`作为前缀。
+- Use `_` as a prefix for unexported top-level constants and variables.

 ```go
 // bad
@@ -138,7 +134,7 @@ const (
 )
 ```

- 嵌入式类型（例如 mutex）应位于结构体内的字段列表的顶部，并且必须有一个空行将嵌入式字段与常规字段分隔开。
+- Embedded types (such as mutexes) should be at the top of the field list within the struct, and there must be a blank line separating embedded fields from regular fields.

 ```go
 // bad
@@ -155,9 +151,9 @@ type Client struct {
 }
 ```

-### 1.3 错误处理
+### 1.3 Error Handling

- `error`作为函数的值返回，必须对`error`进行处理，或将返回值赋值给明确忽略。对于`defer xx.Close()`可以不用显式处理。
+- `error` is returned as the value of the function, `error` must be handled, or the return value assigned to explicitly ignore. For `defer xx.Close()`, there is no need to explicitly handle it.

 ```go
 func load() error {
@@ -171,7 +167,7 @@ load()
  _ = load()
 ```

- `error`作为函数的值返回且有多个返回值的时候，`error`必须是最后一个参数。
+- When `error` is returned as the value of a function and there are multiple return values, `error` must be the last parameter.

 ```go
 // bad
@@ -185,7 +181,7 @@ func load() (int, error) {
 }
 ```

- 尽早进行错误处理，并尽早返回，减少嵌套。
+- Perform error handling as early as possible and return as early as possible to reduce nesting.

 ```go
 // bad
@@ -203,7 +199,7 @@ if err != nil {
 // normal code
 ```

- 如果需要在 if 之外使用函数调用的结果，则应采用下面的方式。
+- If you need to use the result of the function call outside if, you should use the following method.

 ```go
 // bad
@@ -218,7 +214,7 @@ if err != nil {
 }
 ```

- 错误要单独判断，不与其他逻辑组合判断。
+- Errors should be judged independently, not combined with other logic.

 ```go
 // bad
@@ -241,7 +237,7 @@ if v == nil {
 }
 ```

- 如果返回值需要初始化，则采用下面的方式。
+- If the return value needs to be initialized, use the following method.

 ```go
 v, err := f()
@@ -251,8 +247,8 @@ if err != nil {
 }
 ```

- 错误描述建议
-	- 错误描述用小写字母开头，结尾不要加标点符号，例如：
+- Bug description suggestions
+- Error descriptions start with a lowercase letter and do not end with punctuation, for example:
 ```go
 // bad
 errors.New("Redis connection failed")
@@ -261,34 +257,34 @@ if err != nil {
 // good
 errors.New("redis connection failed")
 ```
-	- 告诉用户他们可以做什么，而不是告诉他们不能做什么。
-	- 当声明一个需求时，用must 而不是should。例如，`must be greater than 0、must match regex '[a-z]+'`。
-	- 当声明一个格式不对时，用must not。例如，`must not contain`。
-	- 当声明一个动作时用may not。例如，`may not be specified when otherField is empty、only name may be specified`。
-	- 引用文字字符串值时，请在单引号中指示文字。例如，`ust not contain '..'`。
-	- 当引用另一个字段名称时，请在反引号中指定该名称。例如，must be greater than `request`。
-	- 指定不等时，请使用单词而不是符号。例如，`must be less than 256、must be greater than or equal to 0 (不要用 larger than、bigger than、more than、higher than)`。
-	- 指定数字范围时，请尽可能使用包含范围。
-	- 建议 Go 1.13 以上，error 生成方式为 `fmt.Errorf("module xxx: %w", err)`。
+- Tell users what they can do, not what they can't.
+- When declaring a requirement, use must instead of should. For example, `must be greater than 0, must match regex '[a-z]+'`.
+- When declaring that a format is incorrect, use must not. For example, `must not contain`.
+- Use may not when declaring an action. For example, `may not be specified when otherField is empty, only name may be specified`.
+- When quoting a literal string value, indicate the literal in single quotes. For example, `ust not contain '..'`.
+- When referencing another field name, specify that name in backticks. For example, must be greater than `request`.
+- When specifying unequal, use words instead of symbols. For example, `must be less than 256, must be greater than or equal to 0 (do not use larger than, bigger than, more than, higher than)`.
+- When specifying ranges of numbers, use inclusive ranges whenever possible.
+- Go 1.13 or above is recommended, and the error generation method is `fmt.Errorf("module xxx: %w", err)`.

-### 1.4 panic处理
+### 1.4 panic processing

- 在业务逻辑处理中禁止使用panic。
- 在main包中，只有当程序完全不可运行时使用panic，例如无法打开文件、无法连接数据库导致程序无法正常运行。
- 在main包中，使用 `log.Fatal` 来记录错误，这样就可以由log来结束程序，或者将panic抛出的异常记录到日志文件中，方便排查问题。
- 可导出的接口一定不能有panic。
- 包内建议采用error而不是panic来传递错误。
+- Panic is prohibited in business logic processing.
+- In the main package, panic is only used when the program is completely inoperable, for example, the file cannot be opened, the database cannot be connected, and the program cannot run normally.
+- In the main package, use `log.Fatal` to record errors, so that the program can be terminated by the log, or the exception thrown by the panic can be recorded in the log file, which is convenient for troubleshooting.
+- An exportable interface must not panic.
+- It is recommended to use error instead of panic to convey errors in the package.

-### 1.5 单元测试
+### 1.5 Unit Tests

- 单元测试文件名命名规范为 `example_test.go`。
- 每个重要的可导出函数都要编写测试用例。
- 因为单元测试文件内的函数都是不对外的，所以可导出的结构体、函数等可以不带注释。
- 如果存在 `func (b *Bar) Foo` ，单测函数可以为 `func TestBar_Foo`。
+- The unit test filename naming convention is `example_test.go`.
+- Write a test case for every important exportable function.
+- Because the functions in the unit test file are not external, the exportable structures, functions, etc. can be uncommented.
+- If `func (b *Bar) Foo` exists, the single test function can be `func TestBar_Foo`.

-### 1.6 类型断言失败处理
+### 1.6 Type assertion failure handling

- type assertion 的单个返回值针对不正确的类型将产生 panic。请始终使用 “comma ok”的惯用法。
+- A single return value from a type assertion will panic for an incorrect type. Always use the "comma ok" idiom.

 ```go
 // bad
@@ -301,85 +297,85 @@ if !ok {
 }
 ```

-## 2. 命名规范
+## 2. Naming convention

-命名规范是代码规范中非常重要的一部分，一个统一的、短小的、精确的命名规范可以大大提高代码的可读性，也可以借此规避一些不必要的Bug。
+The naming convention is a very important part of the code specification. A uniform, short, and precise naming convention can greatly improve the readability of the code and avoid unnecessary bugs.

-### 2.1 包命名
+### 2.1 Package Naming

- 包名必须和目录名一致，尽量采取有意义、简短的包名，不要和标准库冲突。
- 包名全部小写，没有大写或下划线，使用多级目录来划分层级。
- 项目名可以通过中划线来连接多个单词。
- 包名以及包所在的目录名，不要使用复数，例如，是`net/url`，而不是`net/urls`。
- 不要用 common、util、shared 或者 lib 这类宽泛的、无意义的包名。
- 包名要简单明了，例如 net、time、log。
+- The package name must be consistent with the directory name, try to use a meaningful and short package name, and do not conflict with the standard library.
+- Package names are all lowercase, without uppercase or underscores, and use multi-level directories to divide the hierarchy.
+- Item names can connect multiple words with dashes.
+- Do not use plurals for the package name and the directory name where the package is located, for example, `net/url` instead of `net/urls`.
+- Don't use broad, meaningless package names like common, util, shared or lib.
+- The package name should be simple and clear, such as net, time, log.

-### 2.2 函数命名
+### 2.2 Function Naming

- 函数名采用驼峰式，首字母根据访问控制决定使用大写或小写，例如：`MixedCaps`或者`mixedCaps`。
- 代码生成工具自动生成的代码(如`xxxx.pb.go`)和为了对相关测试用例进行分组，而采用的下划线(如`TestMyFunction_WhatIsBeingTested`)排除此规则。
+- The function name is in camel case, and the first letter is uppercase or lowercase according to the access control decision,For example: `MixedCaps` or `mixedCaps`.
+- Code automatically generated by code generation tools (such as `xxxx.pb.go`) and underscores used to group related test cases (such as `TestMyFunction_WhatIsBeingTested`) exclude this rule.

-### 2.3 文件命名
+### 2.3 File Naming

- 文件名要简短有意义。
- 文件名应小写，并使用下划线分割单词。
+- Keep the filename short and meaningful.
+- Filenames should be lowercase and use underscores to separate words.

-### 2.4 结构体命名
+### 2.4 Structure Naming

- 采用驼峰命名方式，首字母根据访问控制决定使用大写或小写，例如`MixedCaps`或者`mixedCaps`。
- 结构体名不应该是动词，应该是名词，比如 `Node`、`NodeSpec`。
- 避免使用Data、Info这类无意义的结构体名。
- 结构体的声明和初始化应采用多行，例如：
+- The camel case is adopted, and the first letter is uppercase or lowercase according to the access control, such as `MixedCaps` or `mixedCaps`.
+- Struct names should not be verbs, but should be nouns, such as `Node`, `NodeSpec`.
+- Avoid using meaningless structure names such as Data and Info.
+- The declaration and initialization of the structure should take multiple lines, for example:

 ```go
-// User 多行声明
+// User multi-line declaration
 type User struct {
-    Name  string
+     name string
     Email string
 }

-// 多行初始化
+// multi-line initialization
 u := User{
     UserName: "belm",
     Email: "nosbelm@qq.com",
 }
 ```

-### 2.5 接口命名
+### 2.5 Interface Naming

- 接口命名的规则，基本和结构体命名规则保持一致：
-	- 单个函数的接口名以 “er"”作为后缀（例如Reader，Writer），有时候可能导致蹩脚的英文，但是没关系。
-	- 两个函数的接口名以两个函数名命名，例如ReadWriter。
-	- 三个以上函数的接口名，类似于结构体名。
+- The interface naming rules are basically consistent with the structure naming rules:
+- Interface names of individual functions suffixed with "er"" (e.g. Reader, Writer) can sometimes lead to broken English, but that's okay.
+- The interface name of the two functions is named after the two function names, eg ReadWriter.
+- An interface name for more than three functions, similar to a structure name.

-例如：
+For example:

 ```
 // Seeking to an offset before the start of the file is an error.
 // Seeking to any positive offset is legal, but the behavior of subsequent
-	// I/O operations on the underlying object is implementation-dependent.
+// I/O operations on the underlying object are implementation-dependent.
 type Seeker interface {
 Seek(offset int64, whence int) (int64, error)
 }

 // ReadWriter is the interface that groups the basic Read and Write methods.
 type ReadWriter interface {
-	    Reader
+reader
 Writer
 }
 ```

-### 2.6 变量命名
+### 2.6 Variable Naming

- 变量名必须遵循驼峰式，首字母根据访问控制决定使用大写或小写。
- 在相对简单（对象数量少、针对性强）的环境中，可以将一些名称由完整单词简写为单个字母，例如：
-	- user 可以简写为 u；
-	- userID 可以简写 uid。
- 特有名词时，需要遵循以下规则：
-	- 如果变量为私有，且特有名词为首个单词，则使用小写，如 apiClient。
-	- 其他情况都应当使用该名词原有的写法，如 APIClient、repoID、UserID。
+- Variable names must follow camel case, and the initial letter is uppercase or lowercase according to the access control decision.
+- In relatively simple (few objects, highly targeted) environments, some names can be abbreviated from full words to single letters, for example:
+- user can be abbreviated as u;
+- userID can be abbreviated as uid.
+- When using proper nouns, the following rules need to be followed:
+- If the variable is private and the proper noun is the first word, use lowercase, such as apiClient.
+- In other cases, the original wording of the noun should be used, such as APIClient, repoID, UserID.

-下面列举了一些常见的特有名词。
+Some common nouns are listed below.

 ```
 // A GonicMapper that contains a list of common initialisms taken from golang/lint
@@ -420,7 +416,7 @@ var LintGonicMapper = GonicMapper{
 }
 ```

- 若变量类型为bool类型，则名称应以Has，Is，Can或Allow开头，例如：
+- If the variable type is bool, the name should start with Has, Is, Can or Allow, for example:

 ```go
 var has Conflict bool
@@ -429,13 +425,13 @@ var canManage bool
 var allowGitHook bool
 ```

- 局部变量应当尽可能短小，比如使用buf指代buffer，使用i指代index。
- 代码生成工具自动生成的代码可排除此规则(如`xxx.pb.go`里面的Id)
+- Local variables should be as short as possible, for example, use buf to refer to buffer, and use i to refer to index.
+- The code automatically generated by the code generation tool can exclude this rule (such as the Id in `xxx.pb.go`)

-### 2.7 常量命名
+### 2.7 Constant naming

- 常量名必须遵循驼峰式，首字母根据访问控制决定使用大写或小写。
- 如果是枚举类型的常量，需要先创建相应类型：
+- The constant name must follow the camel case, and the initial letter is uppercase or lowercase according to the access control decision.
+- If it is a constant of enumeration type, you need to create the corresponding type first:

 ```go
 // Code defines an error code type.
@@ -450,9 +446,9 @@ const (
 )
 ```

-### 2.8 Error的命名
+### 2.8 Error naming

- Error类型应该写成FooError的形式。
+- The Error type should be written in the form of FooError.

 ```go
 type ExitError struct {
@@ -460,18 +456,18 @@ type ExitError struct {
 }
 ```

- Error变量写成ErrFoo的形式。
+- The Error variable is written in the form of ErrFoo.

 ```go
 var ErrFormat = errors. New("unknown format")
 ```

-## 3. 注释规范
+## 3. Comment specification

- 每个可导出的名字都要有注释，该注释对导出的变量、函数、结构体、接口等进行简要介绍。
- 全部使用单行注释，禁止使用多行注释。
- 和代码的规范一样，单行注释不要过长，禁止超过 120 字符，超过的请使用换行展示，尽量保持格式优雅。
- 注释必须是完整的句子，以需要注释的内容作为开头，句点作为结尾，`格式为 // 名称 描述.`。例如：
+- Each exportable name must have a comment, which briefly introduces the exported variables, functions, structures, interfaces, etc.
+- All single-line comments are used, and multi-line comments are prohibited.
+- Same as the code specification, single-line comments should not be too long, and no more than 120 characters are allowed. If it exceeds, please use a new line to display, and try to keep the format elegant.
+- A comment must be a complete sentence, starting with the content to be commented and ending with a period, `the format is // name description.`. For example:

 ```go
 // bad
@@ -487,9 +483,9 @@ func PrintFlags(flags *pflag.FlagSet) {
 }
 ```

- 所有注释掉的代码在提交code review前都应该被删除，否则应该说明为什么不删除，并给出后续处理建议。
+- All commented out code should be deleted before submitting code review, otherwise, it should explain why it is not deleted, and give follow-up processing suggestions.

- 在多段注释之间可以使用空行分隔加以区分，如下所示：
+- Multiple comments can be separated by blank lines, as follows:

 ```go
 // Package superman implements methods for saving the world.
@@ -499,10 +495,10 @@ func PrintFlags(flags *pflag.FlagSet) {
 package superman
 ```

-### 3.1 包注释
+### 3.1 Package Notes

- 每个包都有且仅有一个包级别的注释。
- 包注释统一用 // 进行注释，格式为 `// Package 包名 包描述`，例如：
+- 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:

 ```go
 // Package genericclioptions contains flags which can be added to you command, bound, completed, and produce
@@ -510,15 +506,15 @@ package superman
 package genericclioptions
 ```

-### 3.2 变量/常量注释
+### 3.2 Variable/Constant Comments

- 每个可导出的变量/常量都必须有注释说明，`格式为// 变量名 变量描述`，例如：
+- Each variable/constant that can be exported must have a comment description, `the format is // variable name variable description`, for example:

 ```go
 // ErrSigningMethod defines invalid signing method error.
 var ErrSigningMethod = errors. New("Invalid signing method")
 ```
- 出现大块常量或变量定义时，可在前面注释一个总的说明，然后在每一行常量的前一行或末尾详细注释该常量的定义，例如：
+- When there is a large block of constant or variable definition, you can comment a general description in front, and then comment the definition of the constant in detail before or at the end of each line of constant, for example:
 ```go
 // Code must start with 1xxxxx.
 const (
@@ -535,10 +531,10 @@ const (
     ErrValidation
 )
 ```
-### 3.3 结构体注释
+### 3.3 Structure Annotation

- 每个需要导出的结构体或者接口都必须有注释说明，格式为 `// 结构体名 结构体描述.`。
- 结构体内的可导出成员变量名，如果意义不明确，必须要给出注释，放在成员变量的前一行或同一行的末尾。例如：
+- Each structure or interface that needs to be exported must have a comment description, the format is `// structure name structure description.`.
+- The name of the exportable member variable in the structure, if the meaning is not clear, a comment must be given and placed before the member variable or at the end of the same line. For example:

 ```go
 // User represents a user restful resource. It is also used as gorm model.
@@ -554,9 +550,9 @@ type User struct {
 }
 ```

-### 3.4 方法注释
+### 3.4 Method Notes

-每个需要导出的函数或者方法都必须有注释，格式为// 函数名 函数描述.，例如：
+Each function or method that needs to be exported must have a comment, the format is // function name function description., for examplelike:

 ```go
 // BeforeUpdate run before update database record.
@@ -566,20 +562,20 @@ func (p *Policy) BeforeUpdate() (err error) {
 }
 ```

-### 3.5 类型注释
+### 3.5 Type annotations

- 每个需要导出的类型定义和类型别名都必须有注释说明，格式为 `// 类型名 类型描述.`，例如：
+- Each type definition and type alias that needs to be exported must have a comment description, the format is `// type name type description.`, for example:

 ```go
 // Code defines an error code type.
 type Code int
 ```

-## 4. 类型
+## 4. Type

-### 4.1 字符串
+### 4.1 Strings

- 空字符串判断。
+- Empty string judgment.

 ```go
 // bad
@@ -593,7 +589,7 @@ if len(s) == 0 {
 }
 ```

- `[]byte`/`string`相等比较。
+- `[]byte`/`string` equality comparison.

 ```go
 // bad
@@ -611,7 +607,7 @@ bytes.Compare(s1, s2) == 0
 bytes. Compare(s1, s2) != 0
 ```

- 复杂字符串使用raw字符串避免字符转义。
+- Complex strings use raw strings to avoid character escaping.

 ```go
 // bad
@@ -621,9 +617,9 @@ regexp.MustCompile("\\.")
 regexp.MustCompile(`\.`)
 ```

-### 4.2 切片
+### 4.2 Slicing

- 空slice判断。
+- Empty slice judgment.

 ```go
 // bad
@@ -637,9 +633,9 @@ if slice != nil && len(slice) == 0 {
 }
 ```

-上面判断同样适用于map、channel。
+The above judgment also applies to map and channel.

- 声明slice。
+- Declare a slice.

 ```go
 // bad
@@ -650,7 +646,7 @@ s := make([]string, 0)
 var s[]string
 ```

- slice复制。
+- slice copy.

 ```go
 // bad
@@ -666,7 +662,7 @@ for i := range b1 {
 copy(b2, b1)
 ```

- slice新增。
+- slice added.

 ```go
 // bad
@@ -680,16 +676,16 @@ var a, b []int
 b = append(b, a...)
 ```

-### 4.3 结构体
+### 4.3 Structure

- struct初始化。
+- struct initialization.

-struct以多行格式初始化。
+The struct is initialized in multi-line format.

 ```go
 type user struct {
 Id int64
-	Name string
+name string
 }

 u1 := user{100, "Colin"}
@@ -700,11 +696,11 @@ u2 := user{
 }
 ```

-## 5. 控制结构
+## 5. Control Structure

 ### 5.1 if

- if 接受初始化语句，约定如下方式建立局部变量。
+- if accepts the initialization statement, the convention is to create local variables in the following way.

 ```go
 if err := loadConfig(); err != nil {
@@ -713,7 +709,7 @@ if err := loadConfig(); err != nil {
 }
 ```

- if 对于bool类型的变量，应直接进行真假判断。
+- if For variables of bool type, true and false judgments should be made directly.

 ```go
 var isAllow bool
@@ -724,7 +720,7 @@ if isAllow {

 ### 5.2 for

- 采用短声明建立局部变量。
+- Create local variables using short declarations.

 ```go
 sum := 0
@@ -733,7 +729,7 @@ for i := 0; i < 10; i++ {
 }
 ```

- 不要在 for 循环里面使用 defer，defer只有在函数退出时才会执行。
+- Don't use defer in for loop, defer will only be executed when the function exits.

 ```go
 // bad
@@ -761,7 +757,7 @@ for file := range files {

 ### 5.3 range

- 如果只需要第一项（key），就丢弃第二个。
+- If only the first item (key) is needed, discard the second.

 ```go
 for key := range keys {
@@ -769,7 +765,7 @@ for key := range keys {
 }
 ```

- 如果只需要第二项，则把第一项置为下划线。
+- If only the second item is required, underline the first item.

 ```go
 sum := 0
@@ -780,7 +776,7 @@ for _, value := range array {

 ### 5.4 switch

- 必须要有default。
+- must have default.

 ```go
 switch os := runtime.GOOS; os {
@@ -794,37 +790,37 @@ switch os := runtime.GOOS; os {
 ```

 ### 5.5 goto
- 业务代码禁止使用 goto 。
- 框架或其他底层源码尽量不用。
+- Business code prohibits the use of goto.
+- Try not to use frameworks or other low-level source code.

-## 6. 函数
+## 6. Functions

- 传入变量和返回变量以小写字母开头。
- 函数参数个数不能超过5个。
- 函数分组与顺序
- 函数应按粗略的调用顺序排序。
- 同一文件中的函数应按接收者分组。
- 尽量采用值传递，而非指针传递。
- 传入参数是 map、slice、chan、interface ，不要传递指针。
+- Incoming variables and return variables start with a lowercase letter.
+- The number of function parameters cannot exceed 5.
+- Function grouping and ordering
+- Functions should be sorted in rough calling order.
+- Functions in the same file should be grouped by receiver.
+- Try to use value transfer instead of pointer transfer.
+- The incoming parameters are map, slice, chan, interface, do not pass pointers.

-### 6.1 函数参数
+### 6.1 Function parameters

- 如果函数返回相同类型的两个或三个参数，或者如果从上下文中不清楚结果的含义，使用命名返回，其他情况不建议使用命名返回，例如：
+- If the function returns two or three arguments of the same type, or if the meaning of the result is not clear from the context, use named returns, otherwise it is not recommended to use named returns, for example:

 ```go
 func coordinate() (x, y float64, err error) {
 // normal code
 }
 ```
- 传入变量和返回变量都以小写字母开头。
- 尽量用值传递，非指针传递。
- 参数数量均不能超过5个。
- 多返回值最多返回三个，超过三个请使用 struct。
+- Both incoming and returned variables start with a lowercase letter.
+- Try to pass by value instead of pointer.
+- The number of parameters cannot exceed 5.
+- Multiple return values can return up to three, and if there are more than three, please use struct.

 ### 6.2 defer

- 当存在资源创建时，应紧跟defer释放资源(可以大胆使用defer，defer在Go1.14版本中，性能大幅提升，defer的性能损耗即使在性能敏感型的业务中，也可以忽略)。
- 先判断是否错误，再defer释放资源，例如：
+- When resources are created, resources should be released immediately after defer (defer can be used boldly, the performance of defer is greatly improved in Go1.14 version, and the performance loss of defer can be ignored even in performance-sensitive businesses).
+- First judge whether there is an error, and then defer to release resources, for example:

 ```go
 rep, err := http. Get(url)
@@ -835,46 +831,46 @@ if err != nil {
 defer resp.Body.Close()
 ```

-### 6.3 方法的接收器
+### 6.3 Method Receiver

- 推荐以类名第一个英文首字母的小写作为接收器的命名。
- 接收器的命名在函数超过20行的时候不要用单字符。
- 接收器的命名不能采用me、this、self这类易混淆名称。
+- It is recommended to use the lowercase of the first English letter of the class name as the name of the receiver.
+- Don't use a single character in the name of the receiver when the function exceeds 20 lines.
+- The name of the receiver cannot use confusing names such as me, this, and self.

-### 6.4 嵌套
- 嵌套深度不能超过4层。
+### 6.4 Nesting
+- The nesting depth cannot exceed 4 levels.

-### 6.5 变量命名
- 变量声明尽量放在变量第一次使用的前面，遵循就近原则。
- 如果魔法数字出现超过两次，则禁止使用，改用一个常量代替，例如：
+### 6.5 Variable Naming
+- The variable declaration should be placed before the first use of the variable as far as possible, following the principle of proximity.
+- If the magic number appears more than twice, it is forbidden to use it and use a constant instead, for example:

 ```go
 // PI...
-const Prise = 3.14
+const Price = 3.14

 func getAppleCost(n float64) float64 {
-	return Prise * n
+return Price * n
 }

 func getOrangeCost(n float64) float64 {
-	return Prise * n
+return Price * n
 }
 ```

-## 7. GOPATH 设置规范
- Go 1.11 之后，弱化了 GOPATH 规则，已有代码（很多库肯定是在1.11之前建立的）肯定符合这个规则，建议保留 GOPATH 规则，便于维护代码。
- 建议只使用一个 GOPATH，不建议使用多个 GOPATH。如果使用多个GOPATH，编译生效的 bin 目录是在第一个 GOPATH 下。
+## 7. GOPATH setting specification
+- After Go 1.11, the GOPATH rule has been weakened. Existing code (many libraries must have been created before 1.11) must conform to this rule. It is recommended to keep the GOPATH rule to facilitate code maintenance.
+- Only one GOPATH is recommended, multiple GOPATHs are not recommended. If multiple GOPATHs are used, the bin directory where compilation takes effect is under the first GOPATH.

-## 8. 依赖管理
+## 8. Dependency Management

- Go 1.11 以上必须使用 Go Modules。
- 使用Go Modules作为依赖管理的项目时，不建议提交vendor目录。
- 使用Go Modules作为依赖管理的项目时，必须提交go.sum文件。
+- Go 1.11 and above must use Go Modules.
+- When using Go Modules as a dependency management project, it is not recommended to submit the vendor directory.
+- When using Go Modules as a dependency management project, the go.sum file must be submitted.

-### 9. 最佳实践
+### 9. Best Practices

- 尽量少用全局变量，而是通过参数传递，使每个函数都是“无状态”的。这样可以减少耦合，也方便分工和单元测试。
- 在编译时验证接口的符合性，例如：
+- Minimize the use of global variables, but pass parameters, so that each function is "stateless". This reduces coupling and facilitates division of labor and unit testing.
+- Verify interface compliance at compile time, for example:

 ```go
 type LogHandler struct {
@@ -883,19 +879,15 @@ type LogHandler struct {
 }
 var_http.Handler = LogHandler{}
 ```
- 服务器处理请求时，应该创建一个context，保存该请求的相关信息（如requestID），并在函数调用链中传递。
+- When the server processes a request, it should create a context, save the relevant information of the request (such as requestID), and pass it in the function call chain.

-### 9.1 性能
- string 表示的是不可变的字符串变量，对 string 的修改是比较重的操作，基本上都需要重新申请内存。所以，如果没有特殊需要，需要修改时多使用 []byte。
- 优先使用 strconv 而不是 fmt。
+### 9.1 Performance
+- string represents an immutable string variable, modifying string is a relatively heavy operation, and basically needs to re-apply for memory. Therefore, if there is no special need, use []byte more when you need to modify.
+- Prefer strconv over fmt.

-### 9.2 注意事项
+### 9.2 Precautions

- append 要小心自动分配内存，append 返回的可能是新分配的地址。
- 如果要直接修改 map 的 value 值，则 value 只能是指针，否则要覆盖原来的值。
- map 在并发中需要加锁。
- 编译过程无法检查 interface{} 的转换，只能在运行时检查，小心引起 panic。
-
-## 总结
-
-这里向你介绍了九类常用的编码规范。但今天的最后，我要在这里提醒你一句：规范是人定的，你也可以根据需要，制定符合你项目的规范，但同时我也建议你采纳这些业界沉淀下来的规范，并通过工具来确保规范的执行。
+- append Be careful about automatically allocating memory, append may return a newly allocated address.
+- If you want to directly modify the value of the map, the value can only be a pointer, otherwise the original value must be overwritten.
+- map needs to be locked during concurrency.
+- The conversion of interface{} cannot be checked during compilation, it can only be checked at runtime, be careful to cause panic.
@@ -8,7 +8,7 @@ require (
 	github.com/bwmarrin/snowflake v0.3.0 // indirect
 	github.com/dtm-labs/rockscache v0.1.1
 	github.com/gin-gonic/gin v1.9.1
-	github.com/go-playground/validator/v10 v10.14.1
+	github.com/go-playground/validator/v10 v10.15.0
 	github.com/gogo/protobuf v1.3.2
 	github.com/golang-jwt/jwt/v4 v4.5.0
 	github.com/golang/protobuf v1.5.3
@@ -26,7 +26,7 @@ require (
 	github.com/stretchr/testify v1.8.4
 	go.mongodb.org/mongo-driver v1.12.1
 	golang.org/x/image v0.9.0 // indirect
-	google.golang.org/api v0.134.0
+	google.golang.org/api v0.135.0
 	google.golang.org/grpc v1.57.0
 	google.golang.org/protobuf v1.31.0
 	gopkg.in/yaml.v3 v3.0.1
@@ -37,7 +37,7 @@ require (
 require github.com/google/uuid v1.3.0

 require (
-	github.com/OpenIMSDK/protocol v0.0.4
+	github.com/OpenIMSDK/protocol v0.0.6
 	github.com/OpenIMSDK/tools v0.0.13
 	github.com/aliyun/aliyun-oss-go-sdk v2.2.8+incompatible
 	github.com/go-redis/redis v6.15.9+incompatible
@@ -125,8 +125,9 @@ require (
 	golang.org/x/time v0.3.0 // indirect
 	golang.org/x/xerrors v0.0.0-20220907171357-04be3eba64a2 // indirect
 	google.golang.org/appengine v1.6.7 // indirect
+	google.golang.org/genproto v0.0.0-20230706204954-ccb25ca9f130 // indirect
 	google.golang.org/genproto/googleapis/api v0.0.0-20230706204954-ccb25ca9f130 // indirect
-	google.golang.org/genproto/googleapis/rpc v0.0.0-20230720185612-659f7aaaa771 // indirect
+	google.golang.org/genproto/googleapis/rpc v0.0.0-20230726155614-23370e0ffb3e // indirect
 )

 require (
@@ -138,6 +139,5 @@ require (
 	github.com/ugorji/go/codec v1.2.11 // indirect
 	go.uber.org/zap v1.24.0 // indirect
 	golang.org/x/crypto v0.11.0 // indirect
-	google.golang.org/genproto v0.0.0-20230706204954-ccb25ca9f130 // indirect
 	gopkg.in/ini.v1 v1.67.0 // indirect
 )
@@ -17,8 +17,8 @@ cloud.google.com/go/storage v1.30.1/go.mod h1:NfxhC0UJE1aXSx7CIIbCf7y9HKT7Biccwk
 firebase.google.com/go v3.13.0+incompatible h1:3TdYC3DDi6aHn20qoRkxwGqNgdjtblwVAyRLQwGn/+4=
 firebase.google.com/go v3.13.0+incompatible/go.mod h1:xlah6XbEyW6tbfSklcfe5FHJIwjt8toICdV5Wh9ptHs=
 github.com/BurntSushi/toml v0.3.1/go.mod h1:xHWCNGjB5oqiDr8zfno3MHue2Ht5sIBksp03qcyfWMU=
-github.com/OpenIMSDK/protocol v0.0.4 h1:zEEAi677nog+k4u3e5h36nvYeb1XAwcKQ3Uc2tzxHYs=
-github.com/OpenIMSDK/protocol v0.0.4/go.mod h1:F25dFrwrIx3lkNoiuf6FkCfxuwf8L4Z8UIsdTHP/r0Y=
+github.com/OpenIMSDK/protocol v0.0.6 h1:KjaItOEww7vjrhwyxHnVzhw80pnjcNukpskadqW6gnA=
+github.com/OpenIMSDK/protocol v0.0.6/go.mod h1:F25dFrwrIx3lkNoiuf6FkCfxuwf8L4Z8UIsdTHP/r0Y=
 github.com/OpenIMSDK/tools v0.0.13 h1:rcw4HS8S2DPZR9UOBxD8/ol9UBMzXBypzOVEytDRIMo=
 github.com/OpenIMSDK/tools v0.0.13/go.mod h1:eg+q4A34Qmu73xkY0mt37FHGMCMfC6CtmOnm0kFEGFI=
 github.com/QcloudApi/qcloud_sign_golang v0.0.0-20141224014652-e4130a326409/go.mod h1:1pk82RBxDY/JZnPQrtqHlUFfCctgdorsd9M06fMynOM=
@@ -100,8 +100,8 @@ github.com/go-playground/locales v0.14.1 h1:EWaQ/wswjilfKLTECiXz7Rh+3BjFhfDFKv/o
 github.com/go-playground/locales v0.14.1/go.mod h1:hxrqLVvrK65+Rwrd5Fc6F2O76J/NuW9t0sjnWqG1slY=
 github.com/go-playground/universal-translator v0.18.1 h1:Bcnm0ZwsGyWbCzImXv+pAJnYK9S473LQFuzCbDbfSFY=
 github.com/go-playground/universal-translator v0.18.1/go.mod h1:xekY+UJKNuX9WP91TpwSH2VMlDf28Uj24BCp08ZFTUY=
-github.com/go-playground/validator/v10 v10.14.1 h1:9c50NUPC30zyuKprjL3vNZ0m5oG+jU0zvx4AqHGnv4k=
-github.com/go-playground/validator/v10 v10.14.1/go.mod h1:9iXMNT7sEkjXb0I+enO7QXmzG6QCsPWY4zveKFVRSyU=
+github.com/go-playground/validator/v10 v10.15.0 h1:nDU5XeOKtB3GEa+uB7GNYwhVKsgjAR7VgKoNB6ryXfw=
+github.com/go-playground/validator/v10 v10.15.0/go.mod h1:9iXMNT7sEkjXb0I+enO7QXmzG6QCsPWY4zveKFVRSyU=
 github.com/go-redis/redis v6.15.9+incompatible h1:K0pv1D7EQUjfyoMql+r/jZqCLizCGKFlFgcHWWmHQjg=
 github.com/go-redis/redis v6.15.9+incompatible/go.mod h1:NAIEuMOZ/fxfXJIrKDQDz8wamY7mA7PouImQ2Jvg6kA=
 github.com/go-sql-driver/mysql v1.7.0/go.mod h1:OXbVy3sEdcQ2Doequ6Z5BW6fXNQTmx+9S1MCJN5yJMI=
@@ -463,8 +463,8 @@ golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8T
 golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
 golang.org/x/xerrors v0.0.0-20220907171357-04be3eba64a2 h1:H2TDz8ibqkAF6YGhCdN3jS9O0/s90v0rJh3X/OLHEUk=
 golang.org/x/xerrors v0.0.0-20220907171357-04be3eba64a2/go.mod h1:K8+ghG5WaK9qNqU5K3HdILfMLy1f3aNYFI/wnl100a8=
-google.golang.org/api v0.134.0 h1:ktL4Goua+UBgoP1eL1/60LwZJqa1sIzkLmvoR3hR6Gw=
-google.golang.org/api v0.134.0/go.mod h1:sjRL3UnjTx5UqNQS9EWr9N8p7xbHpy1k0XGRLCf3Spk=
+google.golang.org/api v0.135.0 h1:6Vgfj6uPMXcyy66waYWBwmkeNB+9GmUlJDOzkukPQYQ=
+google.golang.org/api v0.135.0/go.mod h1:Bp77uRFgwsSKI0BWH573F5Q6wSlznwI2NFayLOp/7mQ=
 google.golang.org/appengine v1.1.0/go.mod h1:EbEs0AVv82hx2wNQdGPgUI5lhzA/G0D9YwlJXL52JkM=
 google.golang.org/appengine v1.4.0/go.mod h1:xpcJRLb0r/rnEns0DIKYYv+WjYCduHsrkT7/EB5XEv4=
 google.golang.org/appengine v1.6.7 h1:FZR1q0exgwxzPzp/aF+VccGrSfxfPpkBqjIIEq3ru6c=
@@ -477,8 +477,8 @@ google.golang.org/genproto v0.0.0-20230706204954-ccb25ca9f130 h1:Au6te5hbKUV8pIY
 google.golang.org/genproto v0.0.0-20230706204954-ccb25ca9f130/go.mod h1:O9kGHb51iE/nOGvQaDUuadVYqovW56s5emA88lQnj6Y=
 google.golang.org/genproto/googleapis/api v0.0.0-20230706204954-ccb25ca9f130 h1:XVeBY8d/FaK4848myy41HBqnDwvxeV3zMZhwN1TvAMU=
 google.golang.org/genproto/googleapis/api v0.0.0-20230706204954-ccb25ca9f130/go.mod h1:mPBs5jNgx2GuQGvFwUvVKqtn6HsUw9nP64BedgvqEsQ=
-google.golang.org/genproto/googleapis/rpc v0.0.0-20230720185612-659f7aaaa771 h1:Z8qdAF9GFsmcUuWQ5KVYIpP3PCKydn/YKORnghIalu4=
-google.golang.org/genproto/googleapis/rpc v0.0.0-20230720185612-659f7aaaa771/go.mod h1:TUfxEVdsvPg18p6AslUXFoLdpED4oBnGwyqk3dV1XzM=
+google.golang.org/genproto/googleapis/rpc v0.0.0-20230726155614-23370e0ffb3e h1:S83+ibolgyZ0bqz7KEsUOPErxcv4VzlszxY+31OfB/E=
+google.golang.org/genproto/googleapis/rpc v0.0.0-20230726155614-23370e0ffb3e/go.mod h1:TUfxEVdsvPg18p6AslUXFoLdpED4oBnGwyqk3dV1XzM=
 google.golang.org/grpc v1.19.0/go.mod h1:mqu4LbDTu4XGKhr4mRzUsmM4RtVoemTSY81AxZiDr8c=
 google.golang.org/grpc v1.23.0/go.mod h1:Y5yQAOtifL1yxbo5wqy6BxZv8vAUGQwXBOALyacEbxg=
 google.golang.org/grpc v1.25.1/go.mod h1:c3i+UQWmh7LiEpx4sFZnkU36qjEYZ0imhYfXVyQciAY=
@@ -0,0 +1,9 @@
+go 1.20
+
+use (
+	.
+	./tools/changelog
+	./tools/infra
+	./tools/ncpu
+	./tools/yamlfmt
+)
@@ -0,0 +1,9 @@
+github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/kr/pretty v0.1.0 h1:L/CwN0zerZDmRFUapSPitk6f+Q3+0za1rQkzVuMiMFI=
+github.com/kr/pretty v0.1.0/go.mod h1:dAy3ld7l9f0ibDNOQOHHMYYIIbhfbHSm3C4ZsoJORNo=
+github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
+github.com/prashantv/gostub v1.1.0/go.mod h1:A5zLQHz7ieHGG7is6LLXLz7I8+3LZzsrV0P1IAHhP5U=
+github.com/stretchr/testify v1.7.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
+gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127 h1:qIbj1fsPNlZgppZ+VLlY7N33q108Sa+fhmuc+sWQYwY=
+gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
@@ -1,4 +1,5 @@
 #!/usr/bin/env bash
+
 # Copyright © 2023 OpenIM. All rights reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -88,7 +88,6 @@ func (u *UserApi) GetUsersOnlineStatus(c *gin.Context) {
 			log.ZWarn(c, "GetUsersOnlineStatus rpc err", err)

 			parseError := apiresp.ParseError(err)
-			log.ZDebug(c, "errcode bantanger", "errcode", parseError.ErrCode)
 			if parseError.ErrCode == errs.NoPermissionError {
 				apiresp.GinError(c, err)
 				return
@@ -0,0 +1,15 @@
+// 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.
+
+package apistruct // import "github.com/OpenIMSDK/Open-IM-Server/pkg/apistruct"
@@ -0,0 +1,15 @@
+// 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.
+
+package authverify // import "github.com/OpenIMSDK/Open-IM-Server/pkg/authverify"
@@ -0,0 +1,15 @@
+// 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.
+
+package callbackstruct // import "github.com/OpenIMSDK/Open-IM-Server/pkg/callbackstruct"
@@ -0,0 +1,15 @@
+// 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.
+
+package cmd // import "github.com/OpenIMSDK/Open-IM-Server/pkg/common/cmd"
@@ -0,0 +1,15 @@
+// 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.
+
+package config // import "github.com/OpenIMSDK/Open-IM-Server/pkg/common/config"
@@ -0,0 +1,15 @@
+// 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.
+
+package convert // import "github.com/OpenIMSDK/Open-IM-Server/pkg/common/convert"
@@ -0,0 +1,15 @@
+// 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.
+
+package cache // import "github.com/OpenIMSDK/Open-IM-Server/pkg/common/db/cache"
@@ -0,0 +1,15 @@
+// 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.
+
+package controller // import "github.com/OpenIMSDK/Open-IM-Server/pkg/common/db/controller"
@@ -16,10 +16,10 @@ package controller

 import (
 	"context"
-	unRelationTb "github.com/OpenIMSDK/Open-IM-Server/pkg/common/db/table/unrelation"
-	"github.com/OpenIMSDK/protocol/user"
+	"time"

 	unRelationTb "github.com/OpenIMSDK/Open-IM-Server/pkg/common/db/table/unrelation"
+	"github.com/OpenIMSDK/protocol/user"

 	"github.com/OpenIMSDK/tools/errs"
 	"github.com/OpenIMSDK/tools/tx"
@@ -179,13 +179,13 @@ func (u *userDatabase) CountRangeEverydayTotal(ctx context.Context, start time.T
 	return u.userDB.CountRangeEverydayTotal(ctx, start, end)
 }

-// SubscribeUsersStatus Subscribe or unsubscribe a user's presence status
+// SubscribeUsersStatus Subscribe or unsubscribe a user's presence status.
 func (u *userDatabase) SubscribeUsersStatus(ctx context.Context, userID string, userIDs []string) error {
 	err := u.mongoDB.AddSubscriptionList(ctx, userID, userIDs)
 	return err
 }

-// UnsubscribeUsersStatus unsubscribe a user's presence status
+// UnsubscribeUsersStatus unsubscribe a user's presence status.
 func (u *userDatabase) UnsubscribeUsersStatus(ctx context.Context, userID string, userIDs []string) error {
 	err := u.mongoDB.UnsubscriptionList(ctx, userID, userIDs)
 	return err
@@ -0,0 +1,15 @@
+// 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.
+
+package localcache // import "github.com/OpenIMSDK/Open-IM-Server/pkg/common/db/localcache"
@@ -0,0 +1,15 @@
+// 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.
+
+package relation // import "github.com/OpenIMSDK/Open-IM-Server/pkg/common/db/relation"
@@ -0,0 +1,15 @@
+// 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.
+
+package cont // import "github.com/OpenIMSDK/Open-IM-Server/pkg/common/db/s3/cont"
@@ -0,0 +1,15 @@
+// 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.
+
+package cos // import "github.com/OpenIMSDK/Open-IM-Server/pkg/common/db/s3/cos"
@@ -0,0 +1,15 @@
+// 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.
+
+package s3 // import "github.com/OpenIMSDK/Open-IM-Server/pkg/common/db/s3"
@@ -0,0 +1,15 @@
+// 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.
+
+package minio // import "github.com/OpenIMSDK/Open-IM-Server/pkg/common/db/s3/minio"
@@ -0,0 +1,15 @@
+// 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.
+
+package oss // import "github.com/OpenIMSDK/Open-IM-Server/pkg/common/db/s3/oss"
@@ -0,0 +1,15 @@
+// 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.
+
+package relation // import "github.com/OpenIMSDK/Open-IM-Server/pkg/common/db/table/relation"
@@ -0,0 +1,15 @@
+// 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.
+
+package unrelation // import "github.com/OpenIMSDK/Open-IM-Server/pkg/common/db/table/unrelation"
@@ -0,0 +1,15 @@
+// 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.
+
+package unrelation // import "github.com/OpenIMSDK/Open-IM-Server/pkg/common/db/unrelation"
@@ -16,6 +16,7 @@ package unrelation

 import (
 	"context"
+
 	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/db/table/unrelation"
 	"github.com/OpenIMSDK/tools/errs"
 	"github.com/OpenIMSDK/tools/utils"
@@ -153,7 +154,7 @@ func (u *UserMongoDriver) RemoveSubscribedListFromUser(ctx context.Context, user
 	return errs.Wrap(err)
 }

-// GetAllSubscribeList Get all users subscribed by this user
+// GetAllSubscribeList Get all users subscribed by this user.
 func (u *UserMongoDriver) GetAllSubscribeList(ctx context.Context, userID string) (userIDList []string, err error) {
 	var user unrelation.UserModel
 	cursor := u.userCollection.FindOne(
@@ -166,7 +167,7 @@ func (u *UserMongoDriver) GetAllSubscribeList(ctx context.Context, userID string
 	return user.UserIDList, nil
 }

-// GetSubscribedList Get the user subscribed by those users
+// GetSubscribedList Get the user subscribed by those users.
 func (u *UserMongoDriver) GetSubscribedList(ctx context.Context, userID string) (userIDList []string, err error) {
 	var user unrelation.UserModel
 	cursor := u.userCollection.FindOne(
@@ -0,0 +1,15 @@
+// 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.
+
+package http // import "github.com/OpenIMSDK/Open-IM-Server/pkg/common/http"
@@ -0,0 +1,15 @@
+// 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.
+
+package kafka // import "github.com/OpenIMSDK/Open-IM-Server/pkg/common/kafka"
@@ -0,0 +1,15 @@
+// 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.
+
+package locker // import "github.com/OpenIMSDK/Open-IM-Server/pkg/common/locker"
@@ -0,0 +1,15 @@
+// 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.
+
+package prome // import "github.com/OpenIMSDK/Open-IM-Server/pkg/common/prome"
@@ -0,0 +1,15 @@
+// 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.
+
+package startrpc // import "github.com/OpenIMSDK/Open-IM-Server/pkg/common/startrpc"
@@ -0,0 +1,15 @@
+// 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.
+
+package msgprocessor // import "github.com/OpenIMSDK/Open-IM-Server/pkg/msgprocessor"
@@ -0,0 +1,15 @@
+// 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.
+
+package rpcclient // import "github.com/OpenIMSDK/Open-IM-Server/pkg/rpcclient"
@@ -0,0 +1,15 @@
+// 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.
+
+package notification // import "github.com/OpenIMSDK/Open-IM-Server/pkg/rpcclient/notification"
@@ -0,0 +1,15 @@
+// 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.
+
+package statistics // import "github.com/OpenIMSDK/Open-IM-Server/pkg/statistics"
@@ -84,6 +84,36 @@ Each directory and script in the structure should be understood as a part of a l

 - Linux MIPS64LE (linux_mips64le) : Suitable for 64-bit Linux systems with little endian MIPS architecture.

+## Get started quickly - demo.sh
+
+Is the `demo.sh` script teaching you how to quickly get started with OpenIM development and use
+
+
+Steps to run demo:
+
+```sh
+make demo
+```
+
+Instructions for producing the demo movie:
+
+```bash
+# Create temporary directory
+mkdir /tmp/kb-demo
+cd /tmp/kb-demo
+
+asciinema rec
+<path-to-KB-repo>/scripts/demo/run.sh
+
+<CTRL-C> to terminate the script
+<CTRL-D> to terminate the asciinema recording
+<CTRL-C> to save the recording locally
+
+# Edit the recorded file by editing the controller-gen path
+# Once you are happy with the recording, use svg-term program to generate the svg
+
+svg-term --cast=<movie-id> --out _output/demo.svg --window
+```


 ## examples
@@ -17,6 +17,8 @@
 set -e
 set -o pipefail

+. $(dirname ${BASH_SOURCE})/lib/init.sh
+
 trap 'echo "Script interrupted."; exit 1' INT

 # Function for colored echo
@@ -26,24 +28,6 @@ function color_echo() {
    echo -e "${COLOR}===> $* ${COLOR_SUFFIX}"
 }

-# Color definitions
-function openim_color() {
-    COLOR_SUFFIX="\033[0m"      # End all colors and special effects
-
-    BLACK_PREFIX="\033[30m"     # Black prefix
-    RED_PREFIX="\033[31m"       # Red prefix
-    GREEN_PREFIX="\033[32m"     # Green prefix
-    YELLOW_PREFIX="\033[33m"    # Yellow prefix
-    BLUE_PREFIX="\033[34m"      # Blue prefix
-    SKY_BLUE_PREFIX="\033[36m"  # Sky blue prefix
-    WHITE_PREFIX="\033[37m"     # White prefix
-    BOLD_PREFIX="\033[1m"       # Bold prefix
-    UNDERLINE_PREFIX="\033[4m"  # Underline prefix
-    ITALIC_PREFIX="\033[3m"     # Italic prefix
-
-    CYAN_PREFIX="\033[0;36m"     # Cyan prefix
-}
-
 function print_with_delay() {
  text="$1"
  delay="$2"
@@ -68,6 +52,7 @@ function print_progress() {
  done
  printf "]${COLOR_SUFFIX}\n"
 }
+
 function openim_logo() {
    # Set text color to cyan for header and URL
    echo -e "\033[0;36m"
@@ -21,9 +21,8 @@ SCRIPTS_ROOT=$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)
 OPENIM_ROOT=$(dirname "${BASH_SOURCE[0]}")/..

 #Include shell font styles and some basic information
-source $SCRIPTS_ROOT/style_info.sh
+source $SCRIPTS_ROOT/lib/init.sh
 source $SCRIPTS_ROOT/path_info.sh
-source $SCRIPTS_ROOT/function.sh

 cd $SCRIPTS_ROOT

@@ -1,4 +1,5 @@
 #!/usr/bin/env bash
+
 # Copyright © 2023 OpenIM. All rights reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -18,21 +19,8 @@ SCRIPTS_ROOT=$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)
 OPENIM_ROOT=$(dirname "${BASH_SOURCE[0]}")/..

 #Include shell font styles and some basic information
-source $SCRIPTS_ROOT/style_info.sh
 source $SCRIPTS_ROOT/path_info.sh
-source $SCRIPTS_ROOT/function.sh
-
-echo -e "${YELLOW_PREFIX}=======>SCRIPTS_ROOT=$SCRIPTS_ROOT${COLOR_SUFFIX}"
-echo -e "${YELLOW_PREFIX}=======>OPENIM_ROOT=$OPENIM_ROOT${COLOR_SUFFIX}"
-echo -e "${YELLOW_PREFIX}=======>pwd=$PWD${COLOR_SUFFIX}"
-
-echo -e  ""
-
-echo -e "${BACKGROUND_BLUE}===============> Building all using make build binary files ${COLOR_SUFFIX}" 
-
-echo -e  ""
-echo -e "${BOLD_PREFIX}____________________________________________________________ ${COLOR_SUFFIX}"
-
+source $SCRIPTS_ROOT/lib/init.sh

 bin_dir="$BIN_DIR"
 logs_dir="$OPENIM_ROOT/logs"
@@ -67,43 +55,7 @@ if [ $? -ne 0 ]; then
  exit 1
 fi

-# Get the current operating system and architecture
-OS=$(uname -s | tr '[:upper:]' '[:lower:]')
-ARCH=$(uname -m)
-
-# Select the repository home directory based on the operating system and architecture
-if [[ "$OS" == "darwin" ]]; then
-    if [[ "$ARCH" == "x86_64" ]]; then
-        REPO_DIR="darwin/amd64"
-    else
-        REPO_DIR="darwin/386"
-    fi
-elif [[ "$OS" == "linux" ]]; then
-    if [[ "$ARCH" == "x86_64" ]]; then
-        REPO_DIR="linux/amd64"
-    elif [[ "$ARCH" == "arm64" ]]; then
-        REPO_DIR="linux/arm64"
-    elif [[ "$ARCH" == "mips64" ]]; then
-        REPO_DIR="linux/mips64"
-    elif [[ "$ARCH" == "mips64le" ]]; then
-        REPO_DIR="linux/mips64le"
-    elif [[ "$ARCH" == "ppc64le" ]]; then
-        REPO_DIR="linux/ppc64le"
-    elif [[ "$ARCH" == "s390x" ]]; then
-        REPO_DIR="linux/s390x"
-    else
-        REPO_DIR="linux/386"
-    fi
-elif [[ "$OS" == "windows" ]]; then
-    if [[ "$ARCH" == "x86_64" ]]; then
-        REPO_DIR="windows/amd64"
-    else
-        REPO_DIR="windows/386"
-    fi
-else
-    echo -e "${RED_PREFIX}Unsupported OS: $OS${COLOR_SUFFIX}"
-    exit 1
-fi
+openim::util::gen_os_arch

 # Determine if all scripts were successfully built
 BUILD_SUCCESS=true
@@ -18,9 +18,8 @@ SCRIPTS_ROOT=$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)
 OPENIM_ROOT=$(dirname "${BASH_SOURCE[0]}")/..

 #Include shell font styles and some basic information
-source $SCRIPTS_ROOT/style_info.sh
+source $SCRIPTS_ROOT/lib/init.sh
 source $SCRIPTS_ROOT/path_info.sh
-source $SCRIPTS_ROOT/function.sh

 cd $SCRIPTS_ROOT

@@ -43,7 +42,7 @@ service_port_name=(
 )
 for i in ${service_port_name[*]}; do
  list=$(cat $config_path | grep -w ${i} | awk -F '[:]' '{print $NF}')
-  list_to_string $list
+  openim::util::list-to-string $list
  for j in ${ports_array}; do
    port=$(ss -tunlp| grep openim | awk '{print $5}' | grep -w ${j} | awk -F '[:]' '{print $NF}')
    if [[ ${port} -ne ${j} ]]; then
@@ -1,4 +1,5 @@
 #!/usr/bin/env bash
+
 # Copyright © 2023 OpenIM. All rights reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -18,7 +19,7 @@

 # Common utilities, variables and checks for all build scripts.
 set -o errexit
-set -o nounset
+set +o nounset
 set -o pipefail

 # Unset CDPATH, having it set messes up with script import paths
@@ -1,4 +1,5 @@
 #!/usr/bin/env bash
+
 # Copyright © 2023 OpenIM. All rights reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -0,0 +1,83 @@
+#!/usr/bin/env bash
+# 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.
+
+clear
+. $(dirname ${BASH_SOURCE})/lib/util.sh
+
+openim::util::desc "========> Welcome to the OpenIM Demo"
+openim::util::desc "========> We'll help you get started with OpenIM quickly"
+openim::util::desc "========> Press Enter to continue...."
+openim::util::run "make advertise"
+clear
+
+openim::util::desc "You can learn a lot about automation using make help"
+openim::util::run "make help"
+clear
+
+openim::util::desc "You can learn a lot about automation using make help-all"
+openim::util::run "make help-all"
+clear
+
+openim::util::desc "How did we teach you how to build OpenIM"
+openim::util::desc "A full build startup check"
+openim::util::run "make all"
+
+openim::util::desc "Build one OpenIM binary"
+openim::util::desc "BINS: openim-api openim-cmdutils openim-crontask openim-msggateway openim-msgtransfer openim-push openim-rpc changelog infra ncpu yamlfmt"
+openim::util::run "make build BINS=openim-api"
+
+openim::util::desc "Build binaries for all platforms"
+openim::util::run "make multiarch -j BINS=openim-api PLATFORMS='linux_arm64 linux_amd64' "
+
+openim::util::desc "If you wish to use dlv for debugging, either binary or process"
+openim::util::desc "You need to enable debug mode"
+openim::util::run "make build BINS=openim-api DEBUG=1"
+clear
+
+openim::util::desc "Run tidy to format and fix imports"
+openim::util::run "make tidy"
+clear
+
+openim::util::desc "Vendor go.mod dependencies"
+openim::util::run "make vendor"
+clear
+
+openim::util::desc "Run unit tests"
+openim::util::run "make test"
+clear
+
+openim::util::desc "Run unit tests and get test coverage"
+openim::util::run "make cover"
+clear
+
+openim::util::desc "Check for updates to go.mod dependencies"
+openim::util::run "make updates"
+clear
+
+openim::util::desc "Clean all generated files"
+openim::util::run "make clean"
+clear
+
+openim::util::desc "Generate all necessary files"
+openim::util::run "make gen"
+clear
+
+openim::util::desc "Verify the license headers for all files"
+openim::util::run "make verify-copyright"
+clear
+
+openim::util::desc "Add copyright"
+openim::util::run "make add-copyright"
+clear
@@ -1,4 +1,5 @@
 #!/usr/bin/env bash
+
 # Copyright © 2023 OpenIM. All rights reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -1,4 +1,5 @@
 #!/usr/bin/env bash
+
 # Copyright © 2023 OpenIM. All rights reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -18,9 +18,8 @@ SCRIPTS_ROOT=$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)
 OPENIM_ROOT=$(dirname "${BASH_SOURCE[0]}")/..

 #Include shell font styles and some basic information
-source $SCRIPTS_ROOT/style_info.sh
+source $SCRIPTS_ROOT/lib/init.sh
 source $SCRIPTS_ROOT/path_info.sh
-source $SCRIPTS_ROOT/function.sh

 cd $SCRIPTS_ROOT

@@ -38,7 +37,7 @@ service_port_name=(

 for i in ${service_port_name[*]}; do
  list=$(cat $config_path | grep -w ${i} | awk -F '[:]' '{print $NF}')
-  list_to_string $list
+  openim::util::list-to-string $list
  for j in ${ports_array}; do
    port=$(ss -tunlp| grep openim | awk '{print $5}' | grep -w ${j} | awk -F '[:]' '{print $NF}')
    if [[ ${port} -ne ${j} ]]; then
@@ -15,7 +15,7 @@

 #input:[10023,2323,3434]
 #output:10023 2323 3434
-list_to_string(){
+openim::util::list-to-string(){
    ports_list=$*
    sub_s1=`echo $ports_list | sed 's/ //g'`
    sub_s2=${sub_s1//,/ }
@@ -23,7 +23,7 @@ list_to_string(){
    sub_s4=${sub_s3%]*}
    ports_array=$sub_s4
 }
-remove_space(){
+openim::util::remove_space(){
  value=$*
  result=`echo $value | sed 's/ //g'`
 }
@@ -1,4 +1,5 @@
 #!/usr/bin/env bash
+
 # Copyright © 2023 OpenIM. All rights reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -18,9 +19,8 @@ SCRIPTS_ROOT=$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)
 OPENIM_ROOT=$(dirname "${SCRIPTS_ROOT}")/..

 #Include shell font styles and some basic information
-source $SCRIPTS_ROOT/style_info.sh
 source $SCRIPTS_ROOT/path_info.sh
-source $SCRIPTS_ROOT/function.sh
+source $SCRIPTS_ROOT/lib/init.sh

 cd $SCRIPTS_ROOT

@@ -0,0 +1,91 @@
+#!/usr/bin/env bash
+
+# Copyright 2020 Lingfei Kong <colin404@foxmail.com>. All rights reserved.
+# Use of this source code is governed by a MIT style
+# license that can be found in the LICENSE file.
+
+# OPENIM 项目源码根目录
+IAM_ROOT=$(dirname "${BASH_SOURCE[0]}")/..
+
+# 生成文件存放目录
+LOCAL_OUTPUT_ROOT="${IAM_ROOT}/${OUT_DIR:-_output}"
+
+# 设置统一的密码，方便记忆
+readonly PASSWORD=${PASSWORD:-'iam59!z$'}
+
+# Linux系统 going 用户
+readonly LINUX_USERNAME=${LINUX_USERNAME:-going}
+# Linux root & going 用户密码
+readonly LINUX_PASSWORD=${LINUX_PASSWORD:-${PASSWORD}}
+
+# 设置安装目录
+readonly INSTALL_DIR=${INSTALL_DIR:-/tmp/installation}
+mkdir -p ${INSTALL_DIR}
+readonly ENV_FILE=${IAM_ROOT}/scripts/install/environment.sh
+
+# MariaDB 配置信息
+readonly MARIADB_ADMIN_USERNAME=${MARIADB_ADMIN_USERNAME:-root} # MariaDB root 用户
+readonly MARIADB_ADMIN_PASSWORD=${MARIADB_ADMIN_PASSWORD:-${PASSWORD}} # MariaDB root 用户密码
+readonly MARIADB_HOST=${MARIADB_HOST:-127.0.0.1:3306} # MariaDB 主机地址
+readonly MARIADB_DATABASE=${MARIADB_DATABASE:-openim} # MariaDB openim 应用使用的数据库名
+readonly MARIADB_USERNAME=${MARIADB_USERNAME:-openim} # openim 数据库用户名
+readonly MARIADB_PASSWORD=${MARIADB_PASSWORD:-${PASSWORD}} # openim 数据库密码
+
+# Redis 配置信息
+readonly REDIS_HOST=${REDIS_HOST:-127.0.0.1} # Redis 主机地址
+readonly REDIS_PORT=${REDIS_PORT:-6379} # Redis 监听端口
+readonly REDIS_USERNAME=${REDIS_USERNAME:-''} # Redis 用户名
+readonly REDIS_PASSWORD=${REDIS_PASSWORD:-${PASSWORD}} # Redis 密码
+
+# MongoDB 配置
+readonly MONGO_ADMIN_USERNAME=${MONGO_ADMIN_USERNAME:-root} # MongoDB root 用户
+readonly MONGO_ADMIN_PASSWORD=${MONGO_ADMIN_PASSWORD:-${PASSWORD}} # MongoDB root 用户密码
+readonly MONGO_HOST=${MONGO_HOST:-127.0.0.1} # MongoDB 地址
+readonly MONGO_PORT=${MONGO_PORT:-27017} # MongoDB 端口
+readonly MONGO_USERNAME=${MONGO_USERNAME:-openim} # MongoDB 用户名
+readonly MONGO_PASSWORD=${MONGO_PASSWORD:-${PASSWORD}} # MongoDB 密码
+
+# openim 配置
+readonly IAM_DATA_DIR=${IAM_DATA_DIR:-/data/openim} # openim 各组件数据目录
+readonly IAM_INSTALL_DIR=${IAM_INSTALL_DIR:-/opt/openim} # openim 安装文件存放目录
+readonly IAM_CONFIG_DIR=${IAM_CONFIG_DIR:-/etc/openim} # openim 配置文件存放目录
+readonly IAM_LOG_DIR=${IAM_LOG_DIR:-/var/log/openim} # openim 日志文件存放目录
+readonly CA_FILE=${CA_FILE:-${IAM_CONFIG_DIR}/cert/ca.pem} # CA
+
+# openim-apiserver 配置
+readonly IAM_APISERVER_HOST=${IAM_APISERVER_HOST:-127.0.0.1} # openim-apiserver 部署机器 IP 地址
+readonly IAM_APISERVER_GRPC_BIND_ADDRESS=${IAM_APISERVER_GRPC_BIND_ADDRESS:-0.0.0.0}
+readonly IAM_APISERVER_GRPC_BIND_PORT=${IAM_APISERVER_GRPC_BIND_PORT:-8081}
+readonly IAM_APISERVER_INSECURE_BIND_ADDRESS=${IAM_APISERVER_INSECURE_BIND_ADDRESS:-127.0.0.1}
+readonly IAM_APISERVER_INSECURE_BIND_PORT=${IAM_APISERVER_INSECURE_BIND_PORT:-8080}
+readonly IAM_APISERVER_SECURE_BIND_ADDRESS=${IAM_APISERVER_SECURE_BIND_ADDRESS:-0.0.0.0}
+readonly IAM_APISERVER_SECURE_BIND_PORT=${IAM_APISERVER_SECURE_BIND_PORT:-8443}
+readonly IAM_APISERVER_SECURE_TLS_CERT_KEY_CERT_FILE=${IAM_APISERVER_SECURE_TLS_CERT_KEY_CERT_FILE:-${IAM_CONFIG_DIR}/cert/openim-apiserver.pem}
+readonly IAM_APISERVER_SECURE_TLS_CERT_KEY_PRIVATE_KEY_FILE=${IAM_APISERVER_SECURE_TLS_CERT_KEY_PRIVATE_KEY_FILE:-${IAM_CONFIG_DIR}/cert/openim-apiserver-key.pem}
+
+# openim-authz-server 配置
+readonly IAM_AUTHZ_SERVER_HOST=${IAM_AUTHZ_SERVER_HOST:-127.0.0.1} # openim-authz-server 部署机器 IP 地址
+readonly IAM_AUTHZ_SERVER_INSECURE_BIND_ADDRESS=${IAM_AUTHZ_SERVER_INSECURE_BIND_ADDRESS:-127.0.0.1}
+readonly IAM_AUTHZ_SERVER_INSECURE_BIND_PORT=${IAM_AUTHZ_SERVER_INSECURE_BIND_PORT:-9090}
+readonly IAM_AUTHZ_SERVER_SECURE_BIND_ADDRESS=${IAM_AUTHZ_SERVER_SECURE_BIND_ADDRESS:-0.0.0.0}
+readonly IAM_AUTHZ_SERVER_SECURE_BIND_PORT=${IAM_AUTHZ_SERVER_SECURE_BIND_PORT:-9443}
+readonly IAM_AUTHZ_SERVER_SECURE_TLS_CERT_KEY_CERT_FILE=${IAM_AUTHZ_SERVER_SECURE_TLS_CERT_KEY_CERT_FILE:-${IAM_CONFIG_DIR}/cert/openim-authz-server.pem}
+readonly IAM_AUTHZ_SERVER_SECURE_TLS_CERT_KEY_PRIVATE_KEY_FILE=${IAM_AUTHZ_SERVER_SECURE_TLS_CERT_KEY_PRIVATE_KEY_FILE:-${IAM_CONFIG_DIR}/cert/openim-authz-server-key.pem}
+readonly IAM_AUTHZ_SERVER_CLIENT_CA_FILE=${IAM_AUTHZ_SERVER_CLIENT_CA_FILE:-${CA_FILE}}
+readonly IAM_AUTHZ_SERVER_RPCSERVER=${IAM_AUTHZ_SERVER_RPCSERVER:-${IAM_APISERVER_HOST}:${IAM_APISERVER_GRPC_BIND_PORT}}
+
+# openim-pump 配置
+readonly IAM_PUMP_HOST=${IAM_PUMP_HOST:-127.0.0.1} # openim-pump 部署机器 IP 地址
+readonly IAM_PUMP_COLLECTION_NAME=${IAM_PUMP_COLLECTION_NAME:-iam_analytics}
+readonly IAM_PUMP_MONGO_URL=${IAM_PUMP_MONGO_URL:-mongodb://${MONGO_USERNAME}:${MONGO_PASSWORD}@${MONGO_HOST}:${MONGO_PORT}/${IAM_PUMP_COLLECTION_NAME}?authSource=${IAM_PUMP_COLLECTION_NAME}}
+
+# openim-watcher配置
+readonly IAM_WATCHER_HOST=${IAM_WATCHER_HOST:-127.0.0.1} # openim-watcher 部署机器 IP 地址
+
+# iamctl 配置
+readonly CONFIG_USER_USERNAME=${CONFIG_USER_USERNAME:-admin}
+readonly CONFIG_USER_PASSWORD=${CONFIG_USER_PASSWORD:-Admin@2021}
+readonly CONFIG_USER_CLIENT_CERTIFICATE=${CONFIG_USER_CLIENT_CERTIFICATE:-${HOME}/.openim/cert/admin.pem}
+readonly CONFIG_USER_CLIENT_KEY=${CONFIG_USER_CLIENT_KEY:-${HOME}/.openim/cert/admin-key.pem}
+readonly CONFIG_SERVER_ADDRESS=${CONFIG_SERVER_ADDRESS:-${IAM_APISERVER_HOST}:${IAM_APISERVER_SECURE_BIND_PORT}}
+readonly CONFIG_SERVER_CERTIFICATE_AUTHORITY=${CONFIG_SERVER_CERTIFICATE_AUTHORITY:-${CA_FILE}}
@@ -1,33 +0,0 @@
-#!/usr/bin/env bash
-# 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.
-
-# input: [10023, 2323, 3434]
-# output: 10023 2323 3434
-
-# 函数功能：将列表转换为字符串，去除空格和括号
-list_to_string() {
-    ports_list=$*  # 获取传入的参数列表
-    sub_s1=$(echo $ports_list | sed 's/ //g')  # 去除空格
-    sub_s2=${sub_s1//,/ }  # 将逗号替换为空格
-    sub_s3=${sub_s2#*[}  # 去除左括号及其之前的内容
-    sub_s4=${sub_s3%]*}  # 去除右括号及其之后的内容
-    ports_array=$sub_s4  # 将处理后的字符串赋值给变量 ports_array
-}
-
-# 函数功能：去除字符串中的空格
-remove_space() {
-    value=$*  # 获取传入的参数
-    result=$(echo $value | sed 's/ //g')  # 去除空格
-}
@@ -0,0 +1,73 @@
+#!/usr/bin/env bash
+# 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.
+
+# Script to generate docs from the latest swagger spec.
+
+set -o errexit
+set -o nounset
+set -o pipefail
+
+# The root of the build/dist directory
+OPENIM_ROOT="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd -P)"
+source ${OPENIM_ROOT}/scripts/lib/util.sh
+
+mkdir -p ${OPENIM_OUTPUT_TMP}
+cd ${OPENIM_OUTPUT_TMP}
+
+# gendocs takes "input.json" as the input swagger spec.
+# $1 is expected to be <group>_<version>
+cp ${OPENIM_OUTPUT_TMP}/swagger-source/"$1".json ${OPENIM_OUTPUT_TMP}/input.json
+
+./gradle-2.5/bin/gradle gendocs --info
+
+#insert a TOC for top level API objects
+buf="== Top Level API Objects\n\n"
+top_level_models=$(grep '&[A-Za-z]*{},' /register.go | sed 's/.*&//;s/{},//')
+
+# check if the top level models exist in the definitions.adoc. If they exist,
+# their name will be <version>.<model_name>
+VERSION="${1#*_}"
+for m in ${top_level_models}
+do
+  if grep -xq "=== ${VERSION}.${m}" ./definitions.adoc
+  then
+    buf+="* <<${VERSION}.${m}>>\n"
+  fi
+done
+sed -i "1i ${buf}" ./definitions.adoc
+
+# fix the links in .adoc, replace <<x.y>> with link:definitions.html#_x_y[x.y], and lowercase the _x_y part
+sed -i -e 's|<<\(.*\)\.\(.*\)>>|link:#_\L\1_\2\E[\1.\2]|g' ./definitions.adoc
+sed -i -e 's|<<\(.*\)\.\(.*\)>>|link:../definitions#_\L\1_\2\E[\1.\2]|g' ./paths.adoc
+
+# fix the link to <<any>>
+sed -i -e 's|<<any>>|link:#_any[any]|g' ./definitions.adoc
+sed -i -e 's|<<any>>|link:../definitions#_any[any]|g' ./paths.adoc
+
+# change the title of paths.adoc from "paths" to "operations"
+sed -i 's|== Paths|== Operations|g' ./paths.adoc
+
+# $$ has special meaning in asciidoc, we need to escape it
+sed -i 's|\$\$|+++$$+++|g' ./definitions.adoc
+
+echo -e "=== any\nRepresents an untyped JSON map - see the description of the field for more info about the structure of this object." >> ./definitions.adoc
+
+asciidoctor definitions.adoc
+asciidoctor paths.adoc
+
+cp ${OPENIM_OUTPUT_TMP}/definitions.html ${OPENIM_OUTPUT_TMP}/_output/
+cp ${OPENIM_OUTPUT_TMP}/paths.html ${OPENIM_OUTPUT_TMP}/_output/operations.html
+
+success "SUCCESS"
@@ -0,0 +1,42 @@
+#!/usr/bin/env bash
+
+# Copyright 2020 Lingfei Kong <colin404@foxmail.com>. All rights reserved.
+# Use of this source code is governed by a MIT style
+# license that can be found in the LICENSE file.
+
+# 本脚本功能：根据 scripts/environment.sh 配置，生成 OPENIM 组件 YAML 配置文件。
+# 示例：genconfig.sh scripts/environment.sh configs/openim-api.yaml
+
+# Path to the original script file
+env_file="$1"
+# Path to the generated config file
+template_file="$2"
+
+. $(dirname ${BASH_SOURCE})/lib/init.sh
+
+if [ $# -ne 2 ];then
+    openim::log::error "Usage: genconfig.sh scripts/environment.sh configs/openim-api.yaml"
+    exit 1
+fi
+
+source "${env_file}"
+
+declare -A envs
+
+set +u
+for env in $(sed -n 's/^[^#].*${\(.*\)}.*/\1/p' ${template_file})
+do
+    if [ -z "$(eval echo \$${env})" ];then
+        openim::log::error "environment variable '${env}' not set"
+        missing=true
+    fi
+done
+
+if [ "${missing}" ];then
+    openim::log::error 'You may run `source scripts/environment.sh` to set these environment'
+    exit 1
+fi
+
+eval "cat << EOF
+$(cat ${template_file})
+EOF"
@@ -0,0 +1,37 @@
+#!/usr/bin/env bash
+# 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.
+
+# Iterates over two directories: 'pkg' and 'internal/pkg'.
+for top in pkg internal/pkg tools
+do
+    # Finds all subdirectories (including nested ones) under the current directory in the iteration ('pkg' or 'internal/pkg').
+    for d in $(find $top -type d)
+    do
+        # Checks if 'doc.go' doesn't exist in the current subdirectory.
+        if [ ! -f $d/doc.go ]; then
+            # Checks if there are any '.go' files in the current subdirectory.
+            if ls $d/*.go > /dev/null 2>&1; then
+                # Echoes the path of the 'doc.go' file to the terminal. 
+                # This is likely for debugging or information purposes.
+                echo $d/doc.go
+
+                # Writes the package declaration and import comment to the 'doc.go' file in the current subdirectory.
+                # 'basename $d' retrieves the name of the current directory (last part of the path).
+                # The import comment is constructed based on a static base URL and the directory path.
+                echo "package $(basename $d) // import \"github.com/OpenIMSDK/Open-IM-Server/$d\"" > $d/doc.go
+            fi
+        fi
+    done
+done
@@ -26,7 +26,7 @@
 LC_ALL=C

 local_branch="$(git rev-parse --abbrev-ref HEAD)"
-valid_branch_regex="^(main|master|develop|release(-[a-zA-Z0-9._-]+)?)$|(feature|feat|openim|hotfix|test|bug|bot|ci|cicd|style|)\/[a-z0-9._-]+$|^HEAD$"
+valid_branch_regex="^(main|master|develop|release(-[a-zA-Z0-9._-]+)?)$|(feature|feat|openim|hotfix|test|bug|bot|refactor|revert|ci|cicd|style|)\/[a-z0-9._-]+$|^HEAD$"

 YELLOW="\e[93m"
 GREEN="\e[32m"
@@ -19,9 +19,8 @@ SCRIPTS_ROOT=$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)
 OPENIM_ROOT=$(dirname "${SCRIPTS_ROOT}")/..

 #Include shell font styles and some basic information
-source $SCRIPTS_ROOT/style_info.sh
+source $SCRIPTS_ROOT/lib/init.sh
 source $SCRIPTS_ROOT/path_info.sh
-source $SCRIPTS_ROOT/function.sh

 cd $SCRIPTS_ROOT

@@ -0,0 +1,178 @@
+# 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.
+
+# A set of helpers for starting/running chat for tests
+
+CHAT_VERSION=${CHAT_VERSION:-1.1.0}
+CHAT_HOST=${CHAT_HOST:-127.0.0.1}
+CHAT_PORT=${CHAT_PORT:-2379}
+# This is intentionally not called CHAT_LOG_LEVEL:
+# chat checks that and compains when it is set in addition
+# to the command line argument, even when both have the same value.
+CHAT_LOGLEVEL=${CHAT_LOGLEVEL:-warn}
+export OPENIM_INTEGRATION_CHAT_URL="http://${CHAT_HOST}:${CHAT_PORT}"
+
+openim::chat::validate() {
+  # validate if in path
+  command -v chat >/dev/null || {
+    openim::log::usage "chat must be in your PATH"
+    openim::log::info "You can use 'hack/install-chat.sh' to install a copy in third_party/."
+    exit 1
+  }
+
+  # validate chat port is free
+  local port_check_command
+  if command -v ss &> /dev/null && ss -Version | grep 'iproute2' &> /dev/null; then
+    port_check_command="ss"
+  elif command -v netstat &>/dev/null; then
+    port_check_command="netstat"
+  else
+    openim::log::usage "unable to identify if chat is bound to port ${CHAT_PORT}. unable to find ss or netstat utilities."
+    exit 1
+  fi
+  if ${port_check_command} -nat | grep "LISTEN" | grep "[\.:]${CHAT_PORT:?}" >/dev/null 2>&1; then
+    openim::log::usage "unable to start chat as port ${CHAT_PORT} is in use. please stop the process listening on this port and retry."
+    openim::log::usage "$(${port_check_command} -nat | grep "LISTEN" | grep "[\.:]${CHAT_PORT:?}")"
+    exit 1
+  fi
+
+  # need set the env of "CHAT_UNSUPPORTED_ARCH" on unstable arch.
+  arch=$(uname -m)
+  if [[ $arch =~ arm* ]]; then
+	  export CHAT_UNSUPPORTED_ARCH=arm
+  fi
+  # validate installed version is at least equal to minimum
+  version=$(chat --version | grep Version | head -n 1 | cut -d " " -f 3)
+  if [[ $(openim::chat::version "${CHAT_VERSION}") -gt $(openim::chat::version "${version}") ]]; then
+   export PATH=${OPENIM_ROOT}/third_party/chat:${PATH}
+   hash chat
+   echo "${PATH}"
+   version=$(chat --version | grep Version | head -n 1 | cut -d " " -f 3)
+   if [[ $(openim::chat::version "${CHAT_VERSION}") -gt $(openim::chat::version "${version}") ]]; then
+    openim::log::usage "chat version ${CHAT_VERSION} or greater required."
+    openim::log::info "You can use 'hack/install-chat.sh' to install a copy in third_party/."
+    exit 1
+   fi
+  fi
+}
+
+openim::chat::version() {
+  printf '%s\n' "${@}" | awk -F . '{ printf("%d%03d%03d\n", $1, $2, $3) }'
+}
+
+openim::chat::start() {
+  # validate before running
+  openim::chat::validate
+
+  # Start chat
+  CHAT_DIR=${CHAT_DIR:-$(mktemp -d 2>/dev/null || mktemp -d -t test-chat.XXXXXX)}
+  if [[ -d "${ARTIFACTS:-}" ]]; then
+    CHAT_LOGFILE="${ARTIFACTS}/chat.$(uname -n).$(id -un).log.DEBUG.$(date +%Y%m%d-%H%M%S).$$"
+  else
+    CHAT_LOGFILE=${CHAT_LOGFILE:-"/dev/null"}
+  fi
+  openim::log::info "chat --advertise-client-urls ${OPENIM_INTEGRATION_CHAT_URL} --data-dir ${CHAT_DIR} --listen-client-urls http://${CHAT_HOST}:${CHAT_PORT} --log-level=${CHAT_LOGLEVEL} 2> \"${CHAT_LOGFILE}\" >/dev/null"
+  chat --advertise-client-urls "${OPENIM_INTEGRATION_CHAT_URL}" --data-dir "${CHAT_DIR}" --listen-client-urls "${OPENIM_INTEGRATION_CHAT_URL}" --log-level="${CHAT_LOGLEVEL}" 2> "${CHAT_LOGFILE}" >/dev/null &
+  CHAT_PID=$!
+
+  echo "Waiting for chat to come up."
+  openim::util::wait_for_url "${OPENIM_INTEGRATION_CHAT_URL}/health" "chat: " 0.25 80
+  curl -fs -X POST "${OPENIM_INTEGRATION_CHAT_URL}/v3/kv/put" -d '{"key": "X3Rlc3Q=", "value": ""}'
+}
+
+openim::chat::start_scraping() {
+  if [[ -d "${ARTIFACTS:-}" ]]; then
+    CHAT_SCRAPE_DIR="${ARTIFACTS}/chat-scrapes"
+  else
+    CHAT_SCRAPE_DIR=$(mktemp -d -t test.XXXXXX)/chat-scrapes
+  fi
+  openim::log::info "Periodically scraping chat to ${CHAT_SCRAPE_DIR} ."
+  mkdir -p "${CHAT_SCRAPE_DIR}"
+  (
+    while sleep 30; do
+      openim::chat::scrape
+    done
+  ) &
+  CHAT_SCRAPE_PID=$!
+}
+
+openim::chat::scrape() {
+    curl -s -S "${OPENIM_INTEGRATION_CHAT_URL}/metrics" > "${CHAT_SCRAPE_DIR}/next" && mv "${CHAT_SCRAPE_DIR}/next" "${CHAT_SCRAPE_DIR}/$(date +%s).scrape"
+}
+
+openim::chat::stop() {
+  if [[ -n "${CHAT_SCRAPE_PID:-}" ]] && [[ -n "${CHAT_SCRAPE_DIR:-}" ]] ; then
+    kill "${CHAT_SCRAPE_PID}" &>/dev/null || :
+    wait "${CHAT_SCRAPE_PID}" &>/dev/null || :
+    openim::chat::scrape || :
+    (
+      # shellcheck disable=SC2015
+      cd "${CHAT_SCRAPE_DIR}"/.. && \
+      tar czf chat-scrapes.tgz chat-scrapes && \
+      rm -rf chat-scrapes || :
+    )
+  fi
+  if [[ -n "${CHAT_PID-}" ]]; then
+    kill "${CHAT_PID}" &>/dev/null || :
+    wait "${CHAT_PID}" &>/dev/null || :
+  fi
+}
+
+openim::chat::clean_chat_dir() {
+  if [[ -n "${CHAT_DIR-}" ]]; then
+    rm -rf "${CHAT_DIR}"
+  fi
+}
+
+openim::chat::cleanup() {
+  openim::chat::stop
+  openim::chat::clean_chat_dir
+}
+
+openim::chat::install() {
+  (
+    local os
+    local arch
+
+    os=$(openim::util::host_os)
+    arch=$(openim::util::host_arch)
+
+    cd "${OPENIM_ROOT}/third_party" || return 1
+    if [[ $(readlink chat) == chat-v${CHAT_VERSION}-${os}-* ]]; then
+      openim::log::info "chat v${CHAT_VERSION} already installed. To use:"
+      openim::log::info "export PATH=\"$(pwd)/chat:\${PATH}\""
+      return  #already installed
+    fi
+
+    if [[ ${os} == "darwin" ]]; then
+      download_file="chat-v${CHAT_VERSION}-${os}-${arch}.zip"
+      url="https://github.com/chat-io/chat/releases/download/v${CHAT_VERSION}/${download_file}"
+      openim::util::download_file "${url}" "${download_file}"
+      unzip -o "${download_file}"
+      ln -fns "chat-v${CHAT_VERSION}-${os}-${arch}" chat
+      rm "${download_file}"
+    elif [[ ${os} == "linux" ]]; then
+      url="https://github.com/coreos/chat/releases/download/v${CHAT_VERSION}/chat-v${CHAT_VERSION}-${os}-${arch}.tar.gz"
+      download_file="chat-v${CHAT_VERSION}-${os}-${arch}.tar.gz"
+      openim::util::download_file "${url}" "${download_file}"
+      tar xzf "${download_file}"
+      ln -fns "chat-v${CHAT_VERSION}-${os}-${arch}" chat
+      rm "${download_file}"
+    else
+      openim::log::info "${os} is NOT supported."
+    fi
+    openim::log::info "chat v${CHAT_VERSION} installed. To use:"
+    openim::log::info "export PATH=\"$(pwd)/chat:\${PATH}\""
+  )
+}
@@ -1,4 +1,5 @@
 #!/usr/bin/env bash
+
 # Copyright © 2023 OpenIM. All rights reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -13,24 +14,84 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.

+# this script is used to install the dependencies of the project
+#
+# Usage: `scripts/color.sh`.
+################################################################################

 # Define color variables
-# Feature
+# --- Feature --- 
 COLOR_NORMAL='\033[0m';COLOR_BOLD='\033[1m';COLOR_DIM='\033[2m';COLOR_UNDER='\033[4m';
 COLOR_ITALIC='\033[3m';COLOR_NOITALIC='\033[23m';COLOR_BLINK='\033[5m';
 COLOR_REVERSE='\033[7m';COLOR_CONCEAL='\033[8m';COLOR_NOBOLD='\033[22m';
 COLOR_NOUNDER='\033[24m';COLOR_NOBLINK='\033[25m';

-# Front color
+# --- Front color --- 
 COLOR_BLACK='\033[30m';COLOR_RED='\033[31m';COLOR_GREEN='\033[32m';COLOR_YELLOW='\033[33m';
 COLOR_BLUE='\033[34m';COLOR_MAGENTA='\033[35m';COLOR_CYAN='\033[36m';COLOR_WHITE='\033[37m';

-# background color
+# --- background color --- 
 COLOR_BBLACK='\033[40m';COLOR_BRED='\033[41m';
 COLOR_BGREEN='\033[42m';COLOR_BYELLOW='\033[43m';
 COLOR_BBLUE='\033[44m';COLOR_BMAGENTA='\033[45m';
 COLOR_BCYAN='\033[46m';COLOR_BWHITE='\033[47m';

+# --- make demo (run demo) ---
+reset=$(tput sgr0)
+bold=$(tput bold)
+black=$(tput setaf 0)
+red=$(tput setaf 1)
+green=$(tput bold; tput setaf 2)
+yellow=$(tput bold; tput setaf 3)
+blue=$(tput bold; tput setaf 6)
+timeout=$(if [ "$(uname)" == "Darwin" ]; then echo "1"; else echo "0.1"; fi)
+
+# --- Color definitions --- 
+# Color definitions
+function openim_color() {
+    COLOR_SUFFIX="\033[0m"      # End all colors and special effects
+
+    BLACK_PREFIX="\033[30m"     # Black prefix
+    RED_PREFIX="\033[31m"       # Red prefix
+    GREEN_PREFIX="\033[32m"     # Green prefix
+    YELLOW_PREFIX="\033[33m"    # Yellow prefix
+    BLUE_PREFIX="\033[34m"      # Blue prefix
+    SKY_BLUE_PREFIX="\033[36m"  # Sky blue prefix
+    WHITE_PREFIX="\033[37m"     # White prefix
+    BOLD_PREFIX="\033[1m"       # Bold prefix
+    UNDERLINE_PREFIX="\033[4m"  # Underline prefix
+    ITALIC_PREFIX="\033[3m"     # Italic prefix
+
+    CYAN_PREFIX="\033[0;36m"     # Cyan prefix
+}
+
+# --- helper functions for logs ---
+function info()
+{
+    echo -e "[${GREEN_PREFIX}INFO${COLOR_SUFFIX}] " "$@"
+}
+
+function warn()
+{
+    echo -e "[${YELLOW_PREFIX}WARN${COLOR_SUFFIX}] " "$@" >&2
+}
+
+function fatal()
+{
+    echo -e "[${RED_PREFIX}ERROR${COLOR_SUFFIX}] " "$@" >&2
+    exit 1
+}
+
+function debug()
+{
+    echo -e "[${BLUE_PREFIX}DEBUG${COLOR_SUFFIX}]===> " "$@"
+}
+
+function success()
+{
+    echo -e "${BRIGHT_GREEN_PREFIX}===> [SUCCESS] <===${COLOR_SUFFIX}\n=> " "$@"
+}
+
 # Print colors you can use
 openim::color::print_color()
 {
@@ -13,25 +13,189 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.

-
 set -o errexit
 set +o nounset
 set -o pipefail

+# Short-circuit if init.sh has already been sourced
+[[ $(type -t openim::init::loaded) == function ]] && return 0
+
 # Unset CDPATH so that path interpolation can work correctly
 unset CDPATH

-# Default use go modules
+# Until all GOPATH references are removed from all build scripts as well,
+# explicitly disable module mode to avoid picking up user-set GO111MODULE preferences.
+# As individual scripts (like hack/update-vendor.sh) make use of go modules,
+# they can explicitly set GO111MODULE=on
 export GO111MODULE=on

 # The root of the build/dist directory
 OPENIM_ROOT="$(cd "$(dirname "${BASH_SOURCE[0]}")/../.." && pwd -P)"

-source "${OPENIM_ROOT}/scripts/lib/util.sh"
-source "${OPENIM_ROOT}/scripts/lib/logging.sh"
-source "${OPENIM_ROOT}/scripts/lib/color.sh"
+OPENIM_OUTPUT_SUBPATH="${OPENIM_OUTPUT_SUBPATH:-_output}"
+OPENIM_OUTPUT="${OPENIM_ROOT}/${OPENIM_OUTPUT_SUBPATH}"
+OPENIM_OUTPUT_BINPATH="${OPENIM_OUTPUT}/bin/platforms"
+OPENIM_OUTPUT_BINTOOLPATH="${OPENIM_OUTPUT}/bin-tools"
+OPENIM_OUTPUT_TOOLS="${OPENIM_OUTPUT}/tools"
+OPENIM_OUTPUT_TMP="${OPENIM_OUTPUT}/tmp"
+
+# This controls rsync compression. Set to a value > 0 to enable rsync
+# compression for build container
+OPENIM_RSYNC_COMPRESS="${KUBE_RSYNC_COMPRESS:-0}"
+
+# Set no_proxy for localhost if behind a proxy, otherwise,
+# the connections to localhost in scripts will time out
+export no_proxy="127.0.0.1,localhost${no_proxy:+,${no_proxy}}"
+
+# This is a symlink to binaries for "this platform", e.g. build tools.
+export THIS_PLATFORM_BIN="${OPENIM_ROOT}/_output/bin/platforms"
+
+. $(dirname ${BASH_SOURCE})/color.sh
+. $(dirname ${BASH_SOURCE})/util.sh
+. $(dirname ${BASH_SOURCE})/logging.sh

 openim::log::install_errexit
+openim::util::ensure-bash-version

-source "${OPENIM_ROOT}/scripts/lib/version.sh"
-source "${OPENIM_ROOT}/scripts/lib/golang.sh"
+. $(dirname ${BASH_SOURCE})/version.sh
+. $(dirname ${BASH_SOURCE})/golang.sh
+. $(dirname ${BASH_SOURCE})/test.sh
+. $(dirname ${BASH_SOURCE})/release.sh
+. $(dirname ${BASH_SOURCE})/chat.sh
+
+OPENIM_OUTPUT_HOSTBIN="${OPENIM_OUTPUT_BINPATH}/$(openim::util::host_platform)"
+export OPENIM_OUTPUT_HOSTBIN
+
+export OPENIM_NONSERVER_GROUP_VERSIONS
+
+# This emulates "readlink -f" which is not available on MacOS X.
+# Test:
+# T=/tmp/$$.$RANDOM
+# mkdir $T
+# touch $T/file
+# mkdir $T/dir
+# ln -s $T/file $T/linkfile
+# ln -s $T/dir $T/linkdir
+# function testone() {
+#   X=$(readlink -f $1 2>&1)
+#   Y=$(kube::readlinkdashf $1 2>&1)
+#   if [ "$X" != "$Y" ]; then
+#     echo readlinkdashf $1: expected "$X", got "$Y"
+#   fi
+# }
+# testone /
+# testone /tmp
+# testone $T
+# testone $T/file
+# testone $T/dir
+# testone $T/linkfile
+# testone $T/linkdir
+# testone $T/nonexistant
+# testone $T/linkdir/file
+# testone $T/linkdir/dir
+# testone $T/linkdir/linkfile
+# testone $T/linkdir/linkdir
+function openim::readlinkdashf {
+  # run in a subshell for simpler 'cd'
+  (
+    if [[ -d "${1}" ]]; then # This also catch symlinks to dirs.
+      cd "${1}"
+      pwd -P
+    else
+      cd "$(dirname "${1}")"
+      local f
+      f=$(basename "${1}")
+      if [[ -L "${f}" ]]; then
+        readlink "${f}"
+      else
+        echo "$(pwd -P)/${f}"
+      fi
+    fi
+  )
+}
+
+# This emulates "readlink -f" which is not available on MacOS X.
+# Test:
+# T=/tmp/$$.$RANDOM
+# mkdir $T
+# touch $T/file
+# mkdir $T/dir
+# ln -s $T/file $T/linkfile
+# ln -s $T/dir $T/linkdir
+# function testone() {
+#   X=$(readlink -f $1 2>&1)
+#   Y=$(kube::readlinkdashf $1 2>&1)
+#   if [ "$X" != "$Y" ]; then
+#     echo readlinkdashf $1: expected "$X", got "$Y"
+#   fi
+# }
+# testone /
+# testone /tmp
+# testone $T
+# testone $T/file
+# testone $T/dir
+# testone $T/linkfile
+# testone $T/linkdir
+# testone $T/nonexistant
+# testone $T/linkdir/file
+# testone $T/linkdir/dir
+# testone $T/linkdir/linkfile
+# testone $T/linkdir/linkdir
+function openim::readlinkdashf {
+  # run in a subshell for simpler 'cd'
+  (
+    if [[ -d "${1}" ]]; then # This also catch symlinks to dirs.
+      cd "${1}"
+      pwd -P
+    else
+      cd "$(dirname "${1}")"
+      local f
+      f=$(basename "${1}")
+      if [[ -L "${f}" ]]; then
+        readlink "${f}"
+      else
+        echo "$(pwd -P)/${f}"
+      fi
+    fi
+  )
+}
+
+# This emulates "realpath" which is not available on MacOS X
+# Test:
+# T=/tmp/$$.$RANDOM
+# mkdir $T
+# touch $T/file
+# mkdir $T/dir
+# ln -s $T/file $T/linkfile
+# ln -s $T/dir $T/linkdir
+# function testone() {
+#   X=$(realpath $1 2>&1)
+#   Y=$(kube::realpath $1 2>&1)
+#   if [ "$X" != "$Y" ]; then
+#     echo realpath $1: expected "$X", got "$Y"
+#   fi
+# }
+# testone /
+# testone /tmp
+# testone $T
+# testone $T/file
+# testone $T/dir
+# testone $T/linkfile
+# testone $T/linkdir
+# testone $T/nonexistant
+# testone $T/linkdir/file
+# testone $T/linkdir/dir
+# testone $T/linkdir/linkfile
+# testone $T/linkdir/linkdir
+openim::realpath() {
+  if [[ ! -e "${1}" ]]; then
+    echo "${1}: No such file or directory" >&2
+    return 1
+  fi
+  openim::readlinkdashf "${1}"
+}
+
+# Marker function to indicate init.sh has been fully sourced
+openim::init::loaded() {
+  return 0
+}
@@ -38,6 +38,7 @@ readonly RELEASE_IMAGES="${LOCAL_OUTPUT_ROOT}/release-images"
 # OpenIM github account info
 readonly OPENIM_GITHUB_ORG=OpenIMSDK
 readonly OPENIM_GITHUB_REPO=Open-IM-Server
+readonly CHAT_GITHUB_REPO=chat

 readonly ARTIFACT=openim.tar.gz
 readonly CHECKSUM=${ARTIFACT}.sha1sum
@@ -143,8 +144,8 @@ function openim::release::package_src_tarball() {
      -path "${OPENIM_ROOT}"/.config\* -o \
      -path "${OPENIM_ROOT}"/.chglog\* -o \
      -path "${OPENIM_ROOT}"/.gitlint -o \
-      -path "${OPENIM_ROOT}"/.golangci.yml -o \
-      -path "${OPENIM_ROOT}"/.goreleaser.yml -o \
+      -path "${OPENIM_ROOT}"/scripts/golangci.yml -o \
+      -path "${OPENIM_ROOT}"/build/goreleaser.yaml -o \
      -path "${OPENIM_ROOT}"/.note.md -o \
      -path "${OPENIM_ROOT}"/.todo.md \
      \) -prune \
@@ -0,0 +1,561 @@
+#!/usr/bin/env bash
+# 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.
+
+# A set of helpers for tests
+
+openim::test::clear_all() {
+  if openim::test::if_supports_resource "rc" ; then
+    # shellcheck disable=SC2154
+    # Disabling because "kube_flags" is set in a parent script
+    kubectl delete "${kube_flags[@]}" rc --all --grace-period=0 --force
+  fi
+  if openim::test::if_supports_resource "pods" ; then
+    kubectl delete "${kube_flags[@]}" pods --all --grace-period=0 --force
+  fi
+}
+
+# Prints the calling file and line number $1 levels deep
+# Defaults to 2 levels so you can call this to find your own caller
+openim::test::get_caller() {
+  local levels=${1:-2}
+  local caller_file="${BASH_SOURCE[${levels}]}"
+  local caller_line="${BASH_LINENO[${levels}-1]}"
+  echo "$(basename "${caller_file}"):${caller_line}"
+}
+
+# Force exact match of a returned result for a object query.  Wrap this with || to support multiple
+# valid return types.
+# This runs `kubectl get` once and asserts that the result is as expected.
+# $1: Object on which get should be run
+# $2: The go-template to run on the result
+# $3: The expected output
+# $4: Additional args to be passed to kubectl
+openim::test::get_object_assert() {
+  openim::test::object_assert 1 "$@"
+}
+
+# Asserts that the output of a given get query is as expected.
+# Runs the query multiple times before failing it.
+# $1: Object on which get should be run
+# $2: The go-template to run on the result
+# $3: The expected output
+# $4: Additional args to be passed to kubectl
+openim::test::wait_object_assert() {
+  openim::test::object_assert 10 "$@"
+}
+
+# Asserts that the output of a given get query is as expected.
+# Can run the query multiple times before failing it.
+# $1: Number of times the query should be run before failing it.
+# $2: Object on which get should be run
+# $3: The go-template to run on the result
+# $4: The expected output
+# $5: Additional args to be passed to kubectl
+openim::test::object_assert() {
+  local tries=$1
+  local object=$2
+  local request=$3
+  local expected=$4
+  local args=${5:-}
+
+  for j in $(seq 1 "${tries}"); do
+    # shellcheck disable=SC2086
+    # Disabling because to allow for expansion here
+    res=$(kubectl get "${kube_flags[@]}" ${args} ${object} -o go-template="${request}")
+    if [[ "${res}" =~ ^$expected$ ]]; then
+        echo -n "${green}"
+        echo "$(openim::test::get_caller 3): Successful get ${object} ${request}: ${res}"
+        echo -n "${reset}"
+        return 0
+    fi
+    echo "Waiting for Get ${object} ${request} ${args}: expected: ${expected}, got: ${res}"
+    sleep $((j-1))
+  done
+
+  echo "${bold}${red}"
+  echo "$(openim::test::get_caller 3): FAIL!"
+  echo "Get ${object} ${request}"
+  echo "  Expected: ${expected}"
+  echo "  Got:      ${res}"
+  echo "${reset}${red}"
+  caller
+  echo "${reset}"
+  return 1
+}
+
+openim::test::get_object_jsonpath_assert() {
+  local object=$1
+  local request=$2
+  local expected=$3
+
+  # shellcheck disable=SC2086
+  # Disabling to allow for expansion here
+  res=$(kubectl get "${kube_flags[@]}" ${object} -o jsonpath=${request})
+
+  if [[ "${res}" =~ ^$expected$ ]]; then
+      echo -n "${green}"
+      echo "$(openim::test::get_caller): Successful get ${object} ${request}: ${res}"
+      echo -n "${reset}"
+      return 0
+  else
+      echo "${bold}${red}"
+      echo "$(openim::test::get_caller): FAIL!"
+      echo "Get ${object} ${request}"
+      echo "  Expected: ${expected}"
+      echo "  Got:      ${res}"
+      echo "${reset}${red}"
+      caller
+      echo "${reset}"
+      return 1
+  fi
+}
+
+openim::test::describe_object_assert() {
+  local resource=$1
+  local object=$2
+  local matches=( "${@:3}" )
+
+  # shellcheck disable=SC2086
+  # Disabling to allow for expansion here
+  result=$(kubectl describe "${kube_flags[@]}" ${resource} ${object})
+
+  for match in "${matches[@]}"; do
+    if grep -q "${match}" <<< "${result}"; then
+      echo "matched ${match}"
+    else
+      echo "${bold}${red}"
+      echo "$(openim::test::get_caller): FAIL!"
+      echo "Describe ${resource} ${object}"
+      echo "  Expected Match: ${match}"
+      echo "  Not found in:"
+      echo "${result}"
+      echo "${reset}${red}"
+      caller
+      echo "${reset}"
+      return 1
+    fi
+  done
+
+  echo -n "${green}"
+  echo "$(openim::test::get_caller): Successful describe ${resource} ${object}:"
+  echo "${result}"
+  echo -n "${reset}"
+  return 0
+}
+
+openim::test::describe_object_events_assert() {
+    local resource=$1
+    local object=$2
+    local showevents=${3:-"true"}
+
+  # shellcheck disable=SC2086
+  # Disabling to allow for expansion here
+    if [[ -z "${3:-}" ]]; then
+        result=$(kubectl describe "${kube_flags[@]}" ${resource} ${object})
+    else
+        result=$(kubectl describe "${kube_flags[@]}" "--show-events=${showevents}" ${resource} ${object})
+    fi
+
+    if grep -q "No events.\|Events:" <<< "${result}"; then
+        local has_events="true"
+    else
+        local has_events="false"
+    fi
+    if [[ "${showevents}" == "${has_events}" ]]; then
+        echo -n "${green}"
+        echo "$(openim::test::get_caller): Successful describe"
+        echo "${result}"
+        echo "${reset}"
+        return 0
+    else
+        echo "${bold}${red}"
+        echo "$(openim::test::get_caller): FAIL"
+        if [[ "${showevents}" == "false" ]]; then
+            echo "  Events information should not be described in:"
+        else
+            echo "  Events information not found in:"
+        fi
+        echo "${result}"
+        echo "${reset}${red}"
+        caller
+        echo "${reset}"
+        return 1
+    fi
+}
+
+openim::test::describe_resource_assert() {
+  local resource=$1
+  local matches=( "${@:2}" )
+
+  # shellcheck disable=SC2086
+  # Disabling to allow for expansion here
+  result=$(kubectl describe "${kube_flags[@]}" ${resource})
+
+  for match in "${matches[@]}"; do
+    if grep -q "${match}" <<< "${result}"; then
+      echo "matched ${match}"
+    else
+      echo "${bold}${red}"
+      echo "FAIL!"
+      echo "Describe ${resource}"
+      echo "  Expected Match: ${match}"
+      echo "  Not found in:"
+      echo "${result}"
+      echo "${reset}${red}"
+      caller
+      echo "${reset}"
+      return 1
+    fi
+  done
+
+  echo -n "${green}"
+  echo "Successful describe ${resource}:"
+  echo "${result}"
+  echo -n "${reset}"
+  return 0
+}
+
+openim::test::describe_resource_events_assert() {
+    local resource=$1
+    local showevents=${2:-"true"}
+
+    # shellcheck disable=SC2086
+    # Disabling to allow for expansion here
+    result=$(kubectl describe "${kube_flags[@]}" "--show-events=${showevents}" ${resource})
+
+    if grep -q "No events.\|Events:" <<< "${result}"; then
+        local has_events="true"
+    else
+        local has_events="false"
+    fi
+    if [[ "${showevents}" == "${has_events}" ]]; then
+        echo -n "${green}"
+        echo "Successful describe"
+        echo "${result}"
+        echo -n "${reset}"
+        return 0
+    else
+        echo "${bold}${red}"
+        echo "FAIL"
+        if [[ "${showevents}" == "false" ]]; then
+            echo "  Events information should not be described in:"
+        else
+            echo "  Events information not found in:"
+        fi
+        echo "${result}"
+        caller
+        echo "${reset}"
+        return 1
+    fi
+}
+
+openim::test::describe_resource_chunk_size_assert() {
+  # $1: the target resource
+  local resource=$1
+  # $2: comma-separated list of additional resources that will be listed
+  local additionalResources=${2:-}
+  # Remaining args are flags to pass to kubectl
+  local args=${3:-}
+
+  # Expect list requests for the target resource and the additional resources
+  local expectLists
+  IFS="," read -r -a expectLists <<< "${resource},${additionalResources}"
+
+  # shellcheck disable=SC2086
+  # Disabling to allow for expansion here
+  defaultResult=$(kubectl describe ${resource} --show-events=true -v=6 ${args} "${kube_flags[@]}" 2>&1 >/dev/null)
+  for r in "${expectLists[@]}"; do
+    if grep -q "${r}?.*limit=500" <<< "${defaultResult}"; then
+      echo "query for ${r} had limit param"
+    else
+      echo "${bold}${red}"
+      echo "FAIL!"
+      echo "Describe ${resource}"
+      echo "  Expected limit param on request for: ${r}"
+      echo "  Not found in:"
+      echo "${defaultResult}"
+      echo "${reset}${red}"
+      caller
+      echo "${reset}"
+      return 1
+    fi
+  done
+
+  # shellcheck disable=SC2086
+  # Disabling to allow for expansion here
+  # Try a non-default chunk size
+  customResult=$(kubectl describe ${resource} --show-events=false --chunk-size=10 -v=6 ${args} "${kube_flags[@]}" 2>&1 >/dev/null)
+  if grep -q "${resource}?limit=10" <<< "${customResult}"; then
+    echo "query for ${resource} had user-specified limit param"
+  else
+    echo "${bold}${red}"
+    echo "FAIL!"
+    echo "Describe ${resource}"
+    echo "  Expected limit param on request for: ${r}"
+    echo "  Not found in:"
+    echo "${customResult}"
+    echo "${reset}${red}"
+    caller
+    echo "${reset}"
+    return 1
+  fi
+
+  echo -n "${green}"
+  echo "Successful describe ${resource} verbose logs:"
+  echo "${defaultResult}"
+  echo -n "${reset}"
+
+  return 0
+}
+
+# Compare sort-by resource name output (first column, skipping first line) with expected order specify in the last parameter
+openim::test::if_sort_by_has_correct_order() {
+  local var
+  var="$(echo "$1" | awk '{if(NR!=1) print $1}' | tr '\n' ':')"
+  openim::test::if_has_string "${var}" "${@:$#}"
+}
+
+openim::test::if_has_string() {
+  local message=$1
+  local match=$2
+
+  if grep -q "${match}" <<< "${message}"; then
+    echo -n "${green}"
+    echo "Successful"
+    echo -n "${reset}"
+    echo "message:${message}"
+    echo "has:${match}"
+    return 0
+  else
+    echo -n "${bold}${red}"
+    echo "FAIL!"
+    echo -n "${reset}"
+    echo "message:${message}"
+    echo "has not:${match}"
+    caller
+    return 1
+  fi
+}
+
+openim::test::if_has_not_string() {
+  local message=$1
+  local match=$2
+
+  if grep -q "${match}" <<< "${message}"; then
+    echo -n "${bold}${red}"
+    echo "FAIL!"
+    echo -n "${reset}"
+    echo "message:${message}"
+    echo "has:${match}"
+    caller
+    return 1
+  else
+    echo -n "${green}"
+    echo "Successful"
+    echo -n "${reset}"
+    echo "message:${message}"
+    echo "has not:${match}"
+    return 0
+  fi
+}
+
+openim::test::if_empty_string() {
+  local match=$1
+  if [ -n "${match}" ]; then
+    echo -n "${bold}${red}"
+    echo "FAIL!"
+    echo "${match} is not empty"
+    echo -n "${reset}"
+    caller
+    return 1
+  else
+    echo -n "${green}"
+    echo "Successful"
+    echo -n "${reset}"
+    return 0
+  fi
+}
+
+# Returns true if the required resource is part of supported resources.
+# Expects env vars:
+#   SUPPORTED_RESOURCES: Array of all resources supported by the apiserver. "*"
+#   means it supports all resources. For ex: ("*") or ("rc" "*") both mean that
+#   all resources are supported.
+#   $1: Name of the resource to be tested.
+openim::test::if_supports_resource() {
+  SUPPORTED_RESOURCES=${SUPPORTED_RESOURCES:-""}
+  REQUIRED_RESOURCE=${1:-""}
+
+  for r in "${SUPPORTED_RESOURCES[@]}"; do
+    if [[ "${r}" == "*" || "${r}" == "${REQUIRED_RESOURCE}" ]]; then
+      return 0
+    fi
+  done
+  return 1
+}
+
+openim::test::version::object_to_file() {
+  name=$1
+  flags=${2:-""}
+  file=$3
+  # shellcheck disable=SC2086
+  # Disabling because "flags" needs to allow for expansion here
+  kubectl version ${flags} | grep "${name} Version:" | sed -e s/"${name} Version: "/""/g > "${file}"
+}
+
+openim::test::version::json_object_to_file() {
+  flags=$1
+  file=$2
+  # shellcheck disable=SC2086
+  # Disabling because "flags" needs to allow for expansion here
+  kubectl version ${flags} --output json | sed -e s/' '/''/g -e s/'\"'/''/g -e s/'}'/''/g -e s/'{'/''/g -e s/'clientVersion:'/'clientVersion:,'/ -e s/'serverVersion:'/'serverVersion:,'/ | tr , '\n' > "${file}"
+}
+
+openim::test::version::json_client_server_object_to_file() {
+  flags=$1
+  name=$2
+  file=$3
+  # shellcheck disable=SC2086
+  # Disabling because "flags" needs to allow for expansion here
+  kubectl version ${flags} --output json | jq -r ".${name}" | sed -e s/'\"'/''/g -e s/'}'/''/g -e s/'{'/''/g -e /^$/d -e s/','/''/g  -e s/':'/'='/g > "${file}"
+}
+
+openim::test::version::yaml_object_to_file() {
+  flags=$1
+  file=$2
+  # shellcheck disable=SC2086
+  # Disabling because "flags" needs to allow for expansion here
+  kubectl version ${flags} --output yaml | sed -e s/' '/''/g -e s/'\"'/''/g -e /^$/d > "${file}"
+}
+
+openim::test::version::diff_assert() {
+  local original=$1
+  local comparator=${2:-"eq"}
+  local latest=$3
+  local diff_msg=${4:-""}
+  local res=""
+
+  if [ ! -f "${original}" ]; then
+        echo "${bold}${red}"
+        echo "FAIL! ${diff_msg}"
+        echo "the file '${original}' does not exit"
+        echo "${reset}${red}"
+        caller
+        echo "${reset}"
+        return 1
+  fi
+
+  if [ ! -f "${latest}" ]; then
+        echo "${bold}${red}"
+        echo "FAIL! ${diff_msg}"
+        echo "the file '${latest}' does not exit"
+        echo "${reset}${red}"
+        caller
+        echo "${reset}"
+        return 1
+  fi
+
+  if [ "${comparator}" == "exact" ]; then
+      # Skip sorting of file content for exact comparison.
+      cp "${original}" "${original}.sorted"
+      cp "${latest}" "${latest}.sorted"
+  else
+      sort "${original}" > "${original}.sorted"
+      sort "${latest}" > "${latest}.sorted"
+  fi
+
+  if [ "${comparator}" == "eq" ] || [ "${comparator}" == "exact" ]; then
+    if [ "$(diff -iwB "${original}".sorted "${latest}".sorted)" == "" ] ; then
+        echo -n "${green}"
+        echo "Successful: ${diff_msg}"
+        echo -n "${reset}"
+        return 0
+    else
+        echo "${bold}${red}"
+        echo "FAIL! ${diff_msg}"
+        echo "  Expected: "
+        cat "${original}"
+        echo "  Got: "
+        cat "${latest}"
+        echo "${reset}${red}"
+        caller
+        echo "${reset}"
+        return 1
+    fi
+  else
+    if [ -n "$(diff -iwB "${original}".sorted "${latest}".sorted)" ] ; then
+        echo -n "${green}"
+        echo "Successful: ${diff_msg}"
+        echo -n "${reset}"
+        return 0
+    else
+        echo "${bold}${red}"
+        echo "FAIL! ${diff_msg}"
+        echo "  Expected: "
+        cat "${original}"
+        echo "  Got: "
+        cat "${latest}"
+        echo "${reset}${red}"
+        caller
+        echo "${reset}"
+        return 1
+      fi
+  fi
+}
+
+# Force exact match of kubectl stdout, stderr, and return code.
+# $1: file with actual stdout
+# $2: file with actual stderr
+# $3: the actual return code
+# $4: file with expected stdout
+# $5: file with expected stderr
+# $6: expected return code
+# $7: additional message describing the invocation
+openim::test::results::diff() {
+  local actualstdout=$1
+  local actualstderr=$2
+  local actualcode=$3
+  local expectedstdout=$4
+  local expectedstderr=$5
+  local expectedcode=$6
+  local message=$7
+  local result=0
+
+  if ! openim::test::version::diff_assert "${expectedstdout}" "exact" "${actualstdout}" "stdout for ${message}"; then
+      result=1
+  fi
+  if ! openim::test::version::diff_assert "${expectedstderr}" "exact" "${actualstderr}" "stderr for ${message}"; then
+      result=1
+  fi
+  if [ "${actualcode}" -ne "${expectedcode}" ]; then
+      echo "${bold}${red}"
+      echo "$(openim::test::get_caller): FAIL!"
+      echo "Return code for ${message}"
+      echo "  Expected: ${expectedcode}"
+      echo "  Got:      ${actualcode}"
+      echo "${reset}${red}"
+      caller
+      echo "${reset}"
+      result=1
+  fi
+
+  if [ "${result}" -eq 0 ]; then
+     echo -n "${green}"
+     echo "$(openim::test::get_caller): Successful: ${message}"
+     echo -n "${reset}"
+  fi
+
+  return "$result"
+}
@@ -13,6 +13,70 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.

+# this script is used to check whether the code is formatted by gofmt or not
+#
+# Usage: source scripts/lib/util.sh
+################################################################################
+
+#1、将IP写在一个文件里，比如文件名为hosts_file，一行一个IP地址。
+#2、修改ssh-mutual-trust.sh里面的用户名及密码，默认为root用户及密码123。
+# hosts_file_path="path/to/your/hosts/file"
+# openim:util::setup_ssh_key_copy "$hosts_file_path" "root" "123"
+function openim:util::setup_ssh_key_copy() {
+  local hosts_file="$1"
+  local username="${2:-root}"
+  local password="${3:-123}"
+
+  local sshkey_file=~/.ssh/id_rsa.pub
+
+  # check sshkey file 
+  if [[ ! -e $sshkey_file ]]; then
+    expect -c "
+    spawn ssh-keygen -t rsa
+    expect \"Enter*\" { send \"\n\"; exp_continue; }
+    "
+  fi
+
+  # get hosts list
+  local hosts=$(awk '/^[^#]/ {print $1}' "${hosts_file}")
+
+  ssh_key_copy() {
+    local target=$1
+
+    # delete history
+    sed -i "/$target/d" ~/.ssh/known_hosts
+
+    # copy key 
+    expect -c "
+    set timeout 100
+    spawn ssh-copy-id $username@$target
+    expect {
+      \"yes/no\" { send \"yes\n\"; exp_continue; }
+      \"*assword\" { send \"$password\n\"; }
+      \"already exist on the remote system\" { exit 1; }
+    }
+    expect eof
+    "
+  }
+
+  # auto sshkey pair
+  for host in $hosts; do
+    if ! ping -i 0.2 -c 3 -W 1 "$host" > /dev/null 2>&1; then
+      echo "[ERROR]: Can't connect $host"
+      continue
+    fi
+
+    local host_entry=$(awk "/$host/"'{print $1, $2}' /etc/hosts)
+    if [[ $host_entry ]]; then
+      local hostaddr=$(echo "$host_entry" | awk '{print $1}')
+      local hostname=$(echo "$host_entry" | awk '{print $2}')
+      ssh_key_copy "$hostaddr"
+      ssh_key_copy "$hostname"
+    else
+      ssh_key_copy "$host"
+    fi
+  done
+}

 function openim::util::sourced_variable {
  # Call this function to tell shellcheck that a variable is supposed to
@@ -616,6 +680,50 @@ function openim::util::ensure-cfssl {
  popd > /dev/null || return 1
 }

+# openim::util::ensure-docker-buildx
+# Check if we have "docker buildx" commands available
+#
+function openim::util::ensure-docker-buildx {
+  # podman returns 0 on `docker buildx version`, docker on `docker buildx`. One of them must succeed.
+  if docker buildx version >/dev/null 2>&1 || docker buildx >/dev/null 2>&1; then
+    return 0
+  else
+    echo "ERROR: docker buildx not available. Docker 19.03 or higher is required with experimental features enabled"
+    exit 1
+  fi
+}
+
+# openim::util::ensure-bash-version
+# Check if we are using a supported bash version
+#
+function openim::util::ensure-bash-version {
+  # shellcheck disable=SC2004
+  if ((${BASH_VERSINFO[0]}<4)) || ( ((${BASH_VERSINFO[0]}==4)) && ((${BASH_VERSINFO[1]}<2)) ); then
+    echo "ERROR: This script requires a minimum bash version of 4.2, but got version of ${BASH_VERSINFO[0]}.${BASH_VERSINFO[1]}"
+    if [ "$(uname)" = 'Darwin' ]; then
+      echo "On macOS with homebrew 'brew install bash' is sufficient."
+    fi
+    exit 1
+  fi
+}
+
+# openim::util::ensure-install-nginx
+# Check if nginx is installed
+#
+function openim::util::ensure-install-nginx {
+  if ! command -v nginx &>/dev/null; then
+    echo "ERROR: nginx not found. Please install nginx."
+    exit 1
+  fi
+
+  for port in 80
+  do
+    if echo |telnet 127.0.0.1 $port 2>&1|grep refused &>/dev/null;then
+      exit 1
+    fi
+  done
+}
+
 # openim::util::ensure-gnu-sed
 # Determines which sed binary is gnu-sed on linux/darwin
 #
@@ -637,6 +745,26 @@ function openim::util::ensure-gnu-sed {
  openim::util::sourced_variable "${SED}"
 }

+# openim::util::ensure-gnu-date
+# Determines which date binary is gnu-date on linux/darwin
+#
+# Sets:
+#  DATE: The name of the gnu-date binary
+#
+function openim::util::ensure-gnu-date {
+  # NOTE: the echo below is a workaround to ensure date is executed before the grep.
+  date_help="$(LANG=C date --help 2>&1 || true)"
+  if echo "${date_help}" | grep -q "GNU\|BusyBox"; then
+    DATE="date"
+  elif command -v gdate &>/dev/null; then
+    DATE="gdate"
+  else
+    openim::log::error "Failed to find GNU date as date or gdate. If you are on Mac: brew install coreutils." >&2
+    return 1
+  fi
+  openim::util::sourced_variable "${DATE}"
+}
+
 # openim::util::check-file-in-alphabetical-order <file>
 # Check that the file is in alphabetical order
 #
@@ -709,3 +837,120 @@ if [[ -z "${color_start-}" ]]; then
 fi

 # ex: ts=2 sw=2 et filetype=sh
+
+function openim::util::desc() {
+    openim::util:run::maybe_first_prompt
+    rate=25
+    if [ -n "$DEMO_RUN_FAST" ]; then
+      rate=1000
+    fi
+    echo "$blue# $@$reset" | pv -qL $rate
+    openim::util:run::prompt
+}
+
+function openim::util:run::prompt() {
+    echo -n "$yellow\$ $reset"
+}
+
+started=""
+function openim::util:run::maybe_first_prompt() {
+    if [ -z "$started" ]; then
+        openim::util:run::prompt
+        started=true
+    fi
+}
+
+# After a `run` this variable will hold the stdout of the command that was run.
+# If the command was interactive, this will likely be garbage.
+DEMO_RUN_STDOUT=""
+
+function openim::util::run() {
+    openim::util:run::maybe_first_prompt
+    rate=25
+    if [ -n "$DEMO_RUN_FAST" ]; then
+      rate=1000
+    fi
+    echo "$green$1$reset" | pv -qL $rate
+    if [ -n "$DEMO_RUN_FAST" ]; then
+      sleep 0.5
+    fi
+    OFILE="$(mktemp -t $(basename $0).XXXXXX)"
+    if [ "$(uname)" == "Darwin" ]; then
+       script -q "$OFILE" $1
+    else
+       script -eq -c "$1" -f "$OFILE"
+    fi
+    r=$?
+    read -d '' -t "${timeout}" -n 10000 # clear stdin
+    openim::util:run::prompt
+    if [ -z "$DEMO_AUTO_RUN" ]; then
+      read -s
+    fi
+    DEMO_RUN_STDOUT="$(tail -n +2 $OFILE | sed 's/\r//g')"
+    return $r
+}
+
+function openim::util::run::relative() {
+    for arg; do
+        echo "$(realpath $(dirname $(which $0)))/$arg" | sed "s|$(realpath $(pwd))|.|"
+    done
+}
+
+
+# input: [10023, 2323, 3434]
+# output: 10023 2323 3434
+# Function function: Converts a list to a string, removing Spaces and parentheses
+function openim::util::list-to-string() {
+    ports_list=$*  # 获取传入的参数列表
+    sub_s1=$(echo $ports_list | sed 's/ //g')  # 去除空格
+    sub_s2=${sub_s1//,/ }  # 将逗号替换为空格
+    sub_s3=${sub_s2#*[}  # 去除左括号及其之前的内容
+    sub_s4=${sub_s3%]*}  # 去除右括号及其之后的内容
+    ports_array=$sub_s4  # 将处理后的字符串赋值给变量 ports_array
+}
+
+# Function Function: Remove Spaces in the string
+function openim::util::remove_space() {
+    value=$*  # 获取传入的参数
+    result=$(echo $value | sed 's/ //g')  # 去除空格
+}
+
+function openim::util::gen_os_arch() {
+    # Get the current operating system and architecture
+    OS=$(uname -s | tr '[:upper:]' '[:lower:]')
+    ARCH=$(uname -m)
+
+    # Select the repository home directory based on the operating system and architecture
+    if [[ "$OS" == "darwin" ]]; then
+        if [[ "$ARCH" == "x86_64" ]]; then
+            REPO_DIR="darwin/amd64"
+        else
+            REPO_DIR="darwin/386"
+        fi
+    elif [[ "$OS" == "linux" ]]; then
+        if [[ "$ARCH" == "x86_64" ]]; then
+            REPO_DIR="linux/amd64"
+        elif [[ "$ARCH" == "arm64" ]]; then
+            REPO_DIR="linux/arm64"
+        elif [[ "$ARCH" == "mips64" ]]; then
+            REPO_DIR="linux/mips64"
+        elif [[ "$ARCH" == "mips64le" ]]; then
+            REPO_DIR="linux/mips64le"
+        elif [[ "$ARCH" == "ppc64le" ]]; then
+            REPO_DIR="linux/ppc64le"
+        elif [[ "$ARCH" == "s390x" ]]; then
+            REPO_DIR="linux/s390x"
+        else
+            REPO_DIR="linux/386"
+        fi
+    elif [[ "$OS" == "windows" ]]; then
+        if [[ "$ARCH" == "x86_64" ]]; then
+            REPO_DIR="windows/amd64"
+        else
+            REPO_DIR="windows/386"
+        fi
+    else
+        echo -e "${RED_PREFIX}Unsupported OS: $OS${COLOR_SUFFIX}"
+        exit 1
+    fi
+}
@@ -13,7 +13,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
- 
 # -----------------------------------------------------------------------------
 # Version management helpers.  These functions help to set, save and load the
 # following variables:
@@ -46,6 +46,12 @@ BIN_DIR := $(OUTPUT_DIR)/bin
 $(shell mkdir -p $(BIN_DIR))
 endif

+# BIN_TOOLS_DIR: Directory where executable files are stored.
+ifeq ($(origin BIN_TOOLS_DIR),undefined)
+BIN_TOOLS_DIR := $(OUTPUT_DIR)/bin-tools
+$(shell mkdir -p $(BIN_TOOLS_DIR))
+endif
+
 # TOOLS_DIR: The directory where tools are stored for build and testing.
 ifeq ($(origin TOOLS_DIR),undefined)
 TOOLS_DIR := $(OUTPUT_DIR)/tools
@@ -120,7 +126,7 @@ FIND := find . ! -path './utils/*' ! -path './vendor/*' ! -path './third_party/*
 XARGS := xargs -r --no-run-if-empty

 # Linux command settings-CODE DIRS Copyright
-CODE_DIRS := $(ROOT_DIR)/pkg $(ROOT_DIR)/cmd $(ROOT_DIR)/config $(ROOT_DIR)/db $(ROOT_DIR)/.docker-compose_cfg $(ROOT_DIR)/internal $(ROOT_DIR)/scripts $(ROOT_DIR)/test $(ROOT_DIR)/.github $(ROOT_DIR)/build $(ROOT_DIR)/build $(ROOT_DIR)/deployments
+CODE_DIRS := $(ROOT_DIR)/pkg $(ROOT_DIR)/cmd $(ROOT_DIR)/config $(ROOT_DIR)/db $(ROOT_DIR)/.docker-compose_cfg $(ROOT_DIR)/internal $(ROOT_DIR)/scripts $(ROOT_DIR)/test $(ROOT_DIR)/.github $(ROOT_DIR)/build $(ROOT_DIR)/tools $(ROOT_DIR)/deployments
 FINDS := find $(CODE_DIRS)

 # Makefile settings: Select different behaviors by determining whether V option is set
@@ -17,7 +17,7 @@
 # Makefile helper functions for copyright
 #

-LICENSE_TEMPLATE ?= $(ROOT_DIR)/scripts/LICENSE/LICENSE_TEMPLATES
+LICENSE_TEMPLATE ?= $(ROOT_DIR)/scripts/template/LICENSE_TEMPLATES

 ## copyright.verify: Validate boilerplate headers for assign files
 .PHONY: copyright.verify
@@ -17,7 +17,7 @@
 #

 GO := go
-GO_SUPPORTED_VERSIONS ?= 1.18|1.19|1.20
+GO_SUPPORTED_VERSIONS ?= 1.18|1.19|1.20|1.21

 GO_LDFLAGS += -X $(VERSION_PACKAGE).gitVersion=$(GIT_TAG) \
 	-X $(VERSION_PACKAGE).gitCommit=$(GIT_COMMIT) \
@@ -44,8 +44,8 @@ ifeq ($(origin GOBIN), undefined)
 	GOBIN := $(GOPATH)/bin
 endif

-# COMMANDS is Specify all files under ${ROOT_DIR}/cmd/ except those ending in.md
-COMMANDS ?= $(filter-out %.md, $(wildcard ${ROOT_DIR}/cmd/*))
+# COMMANDS is Specify all files under ${ROOT_DIR}/cmd/ and ${ROOT_DIR}/tools/ except those ending in.md
+COMMANDS ?= $(filter-out %.md, $(wildcard ${ROOT_DIR}/cmd/* ${ROOT_DIR}/tools/*))
 ifeq (${COMMANDS},)
  $(error Could not determine COMMANDS, set ROOT_DIR or run in source dir)
 endif
@@ -127,8 +127,14 @@ go.build.%:
 			$(BIN_DIR)/platforms/$(OS)/$(ARCH)/$$(basename $${d})$(GO_OUT_EXT) $${d}/main.go; \
 		done; \
 	else \
+		if [ -f $(ROOT_DIR)/cmd/$(COMMAND)/main.go ]; then \
 			CGO_ENABLED=0 GOOS=$(OS) GOARCH=$(ARCH) $(GO) build $(GO_BUILD_FLAGS) -o \
 			$(BIN_DIR)/platforms/$(OS)/$(ARCH)/$(COMMAND)$(GO_OUT_EXT) $(ROOT_DIR)/cmd/$(COMMAND)/main.go; \
+		elif [ -f $(ROOT_DIR)/tools/$(COMMAND)/$(COMMAND).go ]; then \
+			CGO_ENABLED=0 GOOS=$(OS) GOARCH=$(ARCH) $(GO) build $(GO_BUILD_FLAGS) -o \
+			$(BIN_TOOLS_DIR)/platforms/$(OS)/$(ARCH)/$(COMMAND)$(GO_OUT_EXT) $(ROOT_DIR)/tools/$(COMMAND)/$(COMMAND).go; \
+			chmod +x $(BIN_TOOLS_DIR)/platforms/$(OS)/$(ARCH)/$(COMMAND)$(GO_OUT_EXT); \
+		fi \
 	fi

 ## go.install: Install deployment openim
@@ -151,13 +157,19 @@ go.build.multiarch: go.build.verify $(foreach p,$(PLATFORMS),$(addprefix go.buil
 .PHONY: go.lint
 go.lint: tools.verify.golangci-lint
 	@echo "===========> Run golangci to lint source codes"
-	@$(TOOLS_DIR)/golangci-lint run --color always -c $(ROOT_DIR)/.golangci.yml $(ROOT_DIR)/... 
+	@$(TOOLS_DIR)/golangci-lint run --color always -c $(ROOT_DIR)/scripts/golangci.yml $(ROOT_DIR)/... 

 ## go.test: Run unit test
 .PHONY: go.test
 go.test:
 	@$(GO) test ./...

+## go.demo: Run demo
+.PHONY: go.demo
+go.demo:
+	@echo "===========> Run demo"
+	@$(ROOT_DIR)/scripts/demo.sh
+
 ## go.test.junit-report: Run unit test
 .PHONY: go.test.junit-report
 go.test.junit-report: tools.verify.go-junit-report
@@ -197,8 +209,8 @@ go.updates: tools.verify.go-mod-outdated
 ## go.clean: Clean all builds directories and files
 .PHONY: go.clean
 go.clean:
-	@echo "===========> Cleaning all builds TMP_DIR($(TMP_DIR)) AND BIN_DIR($(BIN_DIR))"
-	@-rm -vrf $(TMP_DIR) $(BIN_DIR)
+	@echo "===========> Cleaning all builds TMP_DIR($(TMP_DIR)) AND BIN_DIR($(BIN_DIR)) AND BIN_TOOLS_DIR($(BIN_TOOLS_DIR))"
+	@-rm -vrf $(TMP_DIR) $(BIN_DIR) $(BIN_TOOLS_DIR)
 	@echo "===========> End clean..."

 ## copyright.help: Show copyright help
@@ -18,9 +18,8 @@ SCRIPTS_ROOT=$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)
 OPENIM_ROOT=$(dirname "${BASH_SOURCE[0]}")/..

 #Include shell font styles and some basic information
-source $SCRIPTS_ROOT/style_info.sh
+source $SCRIPTS_ROOT/lib/init.sh
 source $SCRIPTS_ROOT/path_info.sh
-source $SCRIPTS_ROOT/function.sh

 cd $SCRIPTS_ROOT

@@ -30,18 +29,17 @@ echo -e "${YELLOW_PREFIX}=======>pwd=$PWD${COLOR_SUFFIX}"

 bin_dir="$BIN_DIR"
 logs_dir="$OPENIM_ROOT/logs"
-sdk_db_dir="$OPENIM_ROOT/sdk/db/"

 ulimit -n 200000

 list1=$(cat $config_path | grep openImMessageGatewayPort | awk -F '[:]' '{print $NF}')
 list2=$(cat $config_path | grep openImWsPort | awk -F '[:]' '{print $NF}')
 list3=$(cat $config_path | grep messageGatewayPrometheusPort | awk -F '[:]' '{print $NF}')
-list_to_string $list1
+openim::util::list-to-string $list1
 rpc_ports=($ports_array)
-list_to_string $list2
+openim::util::list-to-string $list2
 ws_ports=($ports_array)
-list_to_string $list3
+openim::util::list-to-string $list3
 prome_ports=($ports_array)
 if [ ${#rpc_ports[@]} -ne ${#ws_ports[@]} ]; then

--- a/Show More
+++ b/Show More
Author	SHA1	Message	Date
Xinwei Xiong(cubxxw-openim)	e33ce70d66	fix: channge smail images Signed-off-by: Xinwei Xiong(cubxxw-openim) <3293172751nss@gmail.com>	2023-08-09 21:57:19 +08:00
Xinwei Xiong(cubxxw-openim)	94ec6cd212	fix: chat scripts path bug Signed-off-by: Xinwei Xiong(cubxxw-openim) <3293172751nss@gmail.com>	2023-08-09 21:12:26 +08:00
Xinwei Xiong(cubxxw-openim)	062aa5766e	style: Formatting code make lint path Signed-off-by: Xinwei Xiong(cubxxw-openim) <3293172751nss@gmail.com>	2023-08-09 20:16:36 +08:00
Xinwei Xiong(cubxxw-openim)	9cf3fcb1fc	style: Formatting code make lint path Signed-off-by: Xinwei Xiong(cubxxw-openim) <3293172751nss@gmail.com>	2023-08-09 20:06:06 +08:00
Xinwei Xiong(cubxxw-openim)	2e08746f3f	style: Formatting code make lint path Signed-off-by: Xinwei Xiong(cubxxw-openim) <3293172751nss@gmail.com>	2023-08-09 20:05:37 +08:00
Xinwei Xiong(cubxxw-openim)	08ccf7c318	style: Formatting code make lint path Signed-off-by: Xinwei Xiong(cubxxw-openim) <3293172751nss@gmail.com>	2023-08-09 18:39:11 +08:00
Xinwei Xiong(cubxxw-openim)	ca4bfde2aa	feat: add scripts cross ower Signed-off-by: Xinwei Xiong(cubxxw-openim) <3293172751nss@gmail.com>	2023-08-09 15:40:16 +08:00
Xinwei Xiong(cubxxw-openim)	bc8702749f	ci: add go-docs file and copyright scripts Signed-off-by: Xinwei Xiong(cubxxw-openim) <3293172751nss@gmail.com>	2023-08-09 15:12:21 +08:00
Xinwei Xiong(cubxxw-openim)	9e14c92933	ci: add copyright scripts Signed-off-by: Xinwei Xiong(cubxxw-openim) <3293172751nss@gmail.com>	2023-08-09 15:07:23 +08:00
Xinwei Xiong(cubxxw-openim)	0a6f10a7cc	feat: add lib and start scripts Signed-off-by: Xinwei Xiong(cubxxw-openim) <3293172751nss@gmail.com>	2023-08-09 14:53:36 +08:00
Xinwei Xiong(cubxxw-openim)	bce5cdf746	feat: sync script code Signed-off-by: Xinwei Xiong(cubxxw-openim) <3293172751nss@gmail.com>	2023-08-09 12:17:24 +08:00
Xinwei Xiong(cubxxw-openim)	18728fc993	fix: fix scripts path module Signed-off-by: Xinwei Xiong(cubxxw-openim) <3293172751nss@gmail.com>	2023-08-09 11:40:06 +08:00
Xinwei Xiong(cubxxw-openim)	be6f189365	fix: fix scripts and optimize Signed-off-by: Xinwei Xiong(cubxxw-openim) <3293172751nss@gmail.com>	2023-08-08 22:44:15 +08:00
Xinwei Xiong(cubxxw-openim)	da1316af2a	fix: fix golang release file path Signed-off-by: Xinwei Xiong(cubxxw-openim) <3293172751nss@gmail.com>	2023-08-08 18:00:23 +08:00
Xinwei Xiong(cubxxw-openim)	b759f8b5cc	fix: fix golang release file path Signed-off-by: Xinwei Xiong(cubxxw-openim) <3293172751nss@gmail.com>	2023-08-08 17:59:45 +08:00
Xinwei Xiong(cubxxw-openim)	c1f6fc4e63	fix: fix bin tools path Signed-off-by: Xinwei Xiong(cubxxw-openim) <3293172751nss@gmail.com>	2023-08-08 17:34:06 +08:00
Xinwei Xiong	73effdf644	fix: fix bin tools path (#814 ) Signed-off-by: Xinwei Xiong(cubxxw-openim) <3293172751nss@gmail.com>	2023-08-08 03:42:36 +00:00
dependabot[bot]	c8971de833	feat(deps): bump the gomod-deps group with 1 update (#813 ) Bumps the gomod-deps group with 1 update: [google.golang.org/api](https://github.com/googleapis/google-api-go-client). - [Release notes](https://github.com/googleapis/google-api-go-client/releases) - [Changelog](https://github.com/googleapis/google-api-go-client/blob/main/CHANGES.md) - [Commits](https://github.com/googleapis/google-api-go-client/compare/v0.134.0...v0.135.0) --- updated-dependencies: - dependency-name: google.golang.org/api dependency-type: direct:production update-type: version-update:semver-minor dependency-group: gomod-deps ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>	2023-08-08 03:33:03 +00:00
Xinwei Xiong	b26a979378	feat: add scripts format (#811 ) * feat: add scripts format Signed-off-by: Xinwei Xiong(cubxxw-openim) <3293172751nss@gmail.com> * feat: add go work Signed-off-by: Xinwei Xiong(cubxxw-openim) <3293172751nss@gmail.com> --------- Signed-off-by: Xinwei Xiong(cubxxw-openim) <3293172751nss@gmail.com>	2023-08-08 03:24:15 +00:00
Xinwei Xiong	3836bf19d6	Update docker-compose.yaml (#810 )	2023-08-07 10:04:34 +00:00
dependabot[bot]	f2f2448fe2	feat(deps): bump the gomod-deps group with 3 updates (#808 ) Bumps the gomod-deps group with 3 updates: [github.com/go-playground/validator/v10](https://github.com/go-playground/validator), [google.golang.org/api](https://github.com/googleapis/google-api-go-client) and [google.golang.org/grpc](https://github.com/grpc/grpc-go). Updates `github.com/go-playground/validator/v10` from 10.14.1 to 10.15.0 - [Release notes](https://github.com/go-playground/validator/releases) - [Commits](https://github.com/go-playground/validator/compare/v10.14.1...v10.15.0) Updates `google.golang.org/api` from 0.114.0 to 0.134.0 - [Release notes](https://github.com/googleapis/google-api-go-client/releases) - [Changelog](https://github.com/googleapis/google-api-go-client/blob/main/CHANGES.md) - [Commits](https://github.com/googleapis/google-api-go-client/compare/v0.114.0...v0.134.0) Updates `google.golang.org/grpc` from 1.56.2 to 1.57.0 - [Release notes](https://github.com/grpc/grpc-go/releases) - [Commits](https://github.com/grpc/grpc-go/compare/v1.56.2...v1.57.0) --- updated-dependencies: - dependency-name: github.com/go-playground/validator/v10 dependency-type: direct:production update-type: version-update:semver-minor dependency-group: gomod-deps - dependency-name: google.golang.org/api dependency-type: direct:production update-type: version-update:semver-minor dependency-group: gomod-deps - dependency-name: google.golang.org/grpc dependency-type: direct:production update-type: version-update:semver-minor dependency-group: gomod-deps ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>	2023-08-07 09:42:49 +00:00
Xinwei Xiong	969a9d8782	Update README.md (#807 )	2023-08-07 07:36:18 +00:00
Xinwei Xiong	6f64b0a236	Update README.md (#806 )	2023-08-07 07:32:42 +00:00
Xinwei Xiong	4d04c76cd7	docs: add png multi-terminal-synchronization (#805 )	2023-08-07 07:26:23 +00:00
Xinwei Xiong	7a448b35d4	feat: fix scripts and build speed (#790 ) * feat: fix scripts and build speed Signed-off-by: Xinwei Xiong(cubxxw-openim) <3293172751nss@gmail.com> * feat: add docker compose file Signed-off-by: Xinwei Xiong(cubxxw-openim) <3293172751nss@gmail.com> * fix: fix image Signed-off-by: Xinwei Xiong(cubxxw-openim) <3293172751nss@gmail.com> * feat: add chat scripts design Signed-off-by: Xinwei Xiong(cubxxw-openim) <3293172751nss@gmail.com> --------- Signed-off-by: Xinwei Xiong(cubxxw-openim) <3293172751nss@gmail.com>	2023-08-07 06:21:31 +00:00
Xinwei Xiong	594b16374b	Update README.md (#803 )	2023-08-07 02:22:48 +00:00
Xinwei Xiong	39275c0110	Update README.md (#802 )	2023-08-07 02:07:33 +00:00
Xinwei Xiong	4ad81c363c	Update README.md (#801 )	2023-08-07 02:07:22 +00:00
Xinwei Xiong	10b56142d5	Update README.md (#800 )	2023-08-07 02:05:22 +00:00
Xinwei Xiong	5ee54c9c2a	docs: add png file (#799 )	2023-08-07 02:04:27 +00:00
Xinwei Xiong	0b75c52a6e	Create README.md (#798 )	2023-08-07 02:01:55 +00:00
Xinwei Xiong	375105997f	Update README.md (#797 )	2023-08-06 07:39:06 +00:00
Xinwei Xiong	4e9179f309	Update README.md (#796 )	2023-08-06 07:33:48 +00:00
Xinwei Xiong	863e925b30	Update README.md (#795 )	2023-08-06 07:33:42 +00:00
Xinwei Xiong	8cb05d50c9	Update go_code.md (#794 )	2023-08-06 07:13:13 +00:00
Xinwei Xiong	5d34e3f081	Update README.md (#793 )	2023-08-06 07:08:11 +00:00
Xinwei Xiong	d8fd4bfcf1	Update README.md (#792 )	2023-08-06 05:37:16 +00:00