Merge pull request #462 from cubxxw/feat/cicd-actions

.docker-compose_cfg/config.yaml

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

.docker-compose_cfg/datasource-compose.yaml

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

.docker-compose_cfg/grafana.ini

@@ -633,7 +633,7 @@ active_sync_enabled = true
 #################################### AWS ###########################
 [aws]
 # Enter a comma-separated list of allowed AWS authentication providers.
-# Options are: default (AWS SDK Default), keys (Access && secret key), credentials (Credentials field), ec2_iam_role (EC2 IAM Role)
+# Options are: default (AWS SDK Default), keys (Access && secret key), credentials (Credentials field), ec2_iam_role (EC2 OpenIM Role)
 allowed_auth_providers = default,keys,credentials
 
 # Allow AWS users to assume a role using temporary security credentials.

.docker-compose_cfg/prometheus-compose.yml

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

.github/sync.yml

@@ -28,6 +28,9 @@ OpenIMSDK/openim-sdk-core:
   - source: .github/workflows/stale.yml
     dest: .github/workflows/stale.yml
     replace: false
+  - source: .github/.codecov.yml
+    dest: .github/.codecov.yml
+    replace: false
 
 OpenIMSDK/OpenIM-Docs:
   - source: .github/workflows/
@@ -38,6 +41,9 @@ OpenIMSDK/OpenIM-Docs:
   - source: scripts/githooks/
     dest: scripts/githooks/
     replace: true
+  - source: .github/.codecov.yml
+    dest: .github/.codecov.yml
+    replace: false
 
 OpenIMSDK/OpenKF:
   - source: LICENSE
@@ -51,6 +57,9 @@ OpenIMSDK/OpenKF:
   - source: .github/workflows/stale.yml
     dest: .github/workflows/stale.yml
     replace: false
+  - source: .github/.codecov.yml
+    dest: .github/.codecov.yml
+    replace: false
 
 group:
   # first group：common to all warehouses
@@ -75,6 +84,9 @@ group:
       - source: .github/workflows/help-comment-issue.yml
         dest: .github/workflows/help-comment-issue.yml
         replace: false
+      - source: .github/.codecov.yml
+        dest: .github/.codecov.yml
+        replace: false
       - source: ./scripts/githooks/
         dest: ./scripts/githooks/
         replace: true

.github/weekly-digest.yml

@@ -0,0 +1,7 @@
+# https://github.com/apps/weekly-digest/installations/new
+publishDay: sun
+canPublishIssues: true
+canPublishPullRequests: true
+canPublishContributors: true
+canPublishStargazers: true
+canPublishCommits: true

.github/workflows/codeql-analysis.yml

@@ -1,71 +1,76 @@
-# For most projects, this workflow file will not need changing; you simply need
+# Copyright © 2023 OpenIM open source community. All rights reserved.
-# to commit it to your repository.
 #
-# You may wish to alter this file to override the set of languages analyzed,
+# Licensed under the Apache License, Version 2.0 (the "License");
-# or to provide custom queries or build logic.
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
 #
-# ******** NOTE ********
+#     http://www.apache.org/licenses/LICENSE-2.0
-# We have attempted to detect the languages in your repository. Please check
-# the `language` matrix defined below to confirm you have the correct set of
-# supported CodeQL languages.
 #
-name: "CodeQL"
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+name: "Code Scanning - Action"
 
 on:
   push:
-    branches: [ main ]
+    branches: [main]
   pull_request:
-    # The branches below must be a subset of the branches above
+    branches: [main]
-    branches: "*"
+  schedule:
-#   schedule:
+    #        ┌───────────── minute (0 - 59)
-#     - cron: '23 2 * * 2'
+    #        │  ┌───────────── hour (0 - 23)
+    #        │  │ ┌───────────── day of the month (1 - 31)
+    #        │  │ │ ┌───────────── month (1 - 12 or JAN-DEC)
+    #        │  │ │ │ ┌───────────── day of the week (0 - 6 or SUN-SAT)
+    #        │  │ │ │ │
+    #        │  │ │ │ │
+    #        │  │ │ │ │
+    #        *  * * * *
+    - cron: '30 1 * * 0'
 
 jobs:
-  analyze:
+  CodeQL-Build:
-    name: Analyze
+    # CodeQL runs on ubuntu-latest, windows-latest, and macos-latest
     runs-on: ubuntu-latest
+
     permissions:
-      actions: read
+      # required for all workflows
-      contents: read
       security-events: write
 
-    strategy:
+      # only required for workflows in private repositories
-      fail-fast: false
+      actions: read
-      matrix:
+      contents: read
-        language: [ 'go' ]
-        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python' ]
-        # Learn more:
-        # https://docs.github.com/en/free-pro-team@latest/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#changing-the-languages-that-are-analyzed
 
     steps:
-    - name: Checkout repository
+      - name: Checkout repository
-      uses: actions/checkout@v2
+        uses: actions/checkout@v3
 
-    # Initializes the CodeQL tools for scanning.
+      # Initializes the CodeQL tools for scanning.
-    - name: Initialize CodeQL
+      - name: Initialize CodeQL
-      uses: github/codeql-action/init@v1
+        uses: github/codeql-action/init@v2
-      with:
+        # Override language selection by uncommenting this and choosing your languages
-        languages: ${{ matrix.language }}
+        # with:
-        # If you wish to specify custom queries, you can do so here or in a config file.
+        #   languages: go, javascript, csharp, python, cpp, java, ruby
-        # By default, queries listed here will override any specified in a config file.
-        # Prefix the list here with "+" to use these queries and those in the config file.
-        # queries: ./path/to/local/query, your-org/your-repo/queries@main
 
-    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+      # Autobuild attempts to build any compiled languages (C/C++, C#, Go, or Java).
-    # If this step fails, then you should remove it and run the build manually (see below)
+      # If this step fails, then you should remove it and run the build manually (see below).
-    - name: Autobuild
+      - name: Autobuild
-      uses: github/codeql-action/autobuild@v1
+        uses: github/codeql-action/autobuild@v2
 
-    # ℹ️ Command-line programs to run using the OS shell.
+      # ℹ️ Command-line programs to run using the OS shell.
-    # 📚 https://git.io/JvXDl
+      # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
 
-    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+      # ✏️ If the Autobuild fails above, remove it and uncomment the following
-    #    and modify them (or add more) to build your code if your project
+      #    three lines and modify them (or add more) to build your code if your
-    #    uses a compiled language
+      #    project uses a compiled language
 
-    #- run: |
+      #- run: |
-    #   make bootstrap
+      #     make bootstrap
-    #   make release
+      #     make release
 
-    - name: Perform CodeQL Analysis
+      - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v1
+        uses: github/codeql-action/analyze@v2

.github/workflows/golangci-link.yml

@@ -0,0 +1,51 @@
+# Copyright © 2023 OpenIM open source community. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+name: OpenKF golangci-lint
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+jobs:
+    golangci:
+      name: lint
+      runs-on: ubuntu-latest
+      steps:
+        - uses: actions/checkout@v3
+        - uses: actions/setup-go@v4
+          with:
+            go-version: '1.20'
+            cache: false
+        - name: golangci-lint
+          uses: golangci/golangci-lint-action@v3
+          with:
+            # Require: version of golangci-lint to use in form of v1.2 or v1.2.3 or `latest` to use the latest version
+            version: v1.53
+
+            # Optional: working directory, useful for monorepos
+            working-directory: server
+
+            # Optional: golangci-lint command line arguments.
+            # 
+            # Note: by default the `.golangci.yml` file should be at the root of the repository.
+            # The location of the configuration file can be changed by using `--config=`
+            # args: --timeout=30m --config=/my/path/.golangci.yml --issues-exit-code=0
+
+            # Optional: show only new issues if it's a pull request. The default value is `false`.
+            only-new-issues: true
+
+            # Optional:The mode to install golangci-lint. It can be 'binary' or 'goinstall'.
+            install-mode: "goinstall"

.github/workflows/image.yml

@@ -0,0 +1,81 @@
+name: Build Image
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - "**.go"
+      - "!**_test.go"
+      - "build/**"
+    tags:
+      - v*
+
+jobs:
+  release:
+    strategy:
+      matrix:
+        components: [core, swagger]
+    runs-on: ubuntu-20.04
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 20
+      - uses: dorny/paths-filter@v2
+        if: ${{ !startsWith(github.ref_name, 'v') }}
+        id: changes
+        with:
+          filters: |
+            go:
+              - '**.go'
+              - 'build/core/Dockerfile'
+            api:
+              - 'openapi/**'
+              - 'build/swagger/build.sh'
+              - 'build/swagger/Dockerfile'
+      - name: Docker meta
+        id: meta
+        uses: docker/metadata-action@v4
+        with:
+          flavor: |
+            latest=false
+          images: |
+            ${{ secrets.DOCKERHUB_USERNAME }}/openimsdk-${{ matrix.components }}
+            registry.cn-hangzhou.aliyuncs.com/${{ secrets.ALIREGISTRY_NAMESPACE }}/openimsdk-${{ matrix.components }}
+          tags: |
+            type=ref,event=branch
+            type=sha,prefix={{branch}}-,enable=${{ github.ref_type == 'branch' }}
+            type=ref,event=tag
+      - name: Login to Docker Hub
+        uses: docker/login-action@v2
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+
+      - name: Login to Ali Container Registry
+        uses: docker/login-action@v2
+        with:
+          registry: registry.cn-hangzhou.aliyuncs.com
+          username: ${{ secrets.ALIREGISTRY_USERNAME }}
+          password: ${{ secrets.ALIREGISTRY_TOKEN }}
+
+      - name: Condition
+        id: condition
+        run: |
+          echo "run=${{ startsWith(github.ref_name, 'v') || ((steps.changes.outputs.go == 'true' && (matrix.components == 'core' || matrix.components == 'job')) || (steps.changes.outputs.api == 'true' && matrix.components == 'swagger')) }}" >> $GITHUB_OUTPUT
+
+      - name: Set up QEMU
+        if: ${{ steps.condition.outputs.run == 'true' }}
+        uses: docker/setup-qemu-action@v2
+      - name: Set up Docker Buildx
+        if: ${{ steps.condition.outputs.run == 'true' }}
+        uses: docker/setup-buildx-action@v2
+      - name: Build and push
+        if: ${{ steps.condition.outputs.run == 'true' }}
+        uses: docker/build-push-action@v3
+        with:
+          context: .
+          file: ./build/${{ matrix.components }}/Dockerfile
+          platforms: linux/amd64
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}

.github/workflows/openim-ci.yml

@@ -0,0 +1,72 @@
+name: OpenIM CI
+
+on:
+# main branch
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+
+  openimci:
+    name: Test with go ${{ matrix.go_version }} on ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    environment:
+      name: openimci
+
+    strategy:
+      matrix:
+        go_version: ['1.18', '1.19', '1.20']
+        os: [ubuntu-latest, macOS-latest]
+
+    steps:
+      - name: Set up Go ${{ matrix.go_version }}
+        uses: actions/setup-go@v2
+        with:
+          go-version: ${{ matrix.go_version }}
+        id: go
+
+      - name: Check out code into the Go module directory
+        uses: actions/checkout@v2
+
+      - name: Run go modules Tidy
+        run: |
+          make tidy
+
+      - name: Generate all necessary files, such as error code files
+        run: |
+          make gen
+
+      - name: Check syntax and styling of go sources
+        run: |
+          make lint
+
+      - name: Run unit test and get test coverage
+        run: |
+          make cover
+
+      - name: Build source code for host platform
+        run: |
+          make build
+
+      - name: Collect Test Coverage File
+        uses: actions/upload-artifact@v1.0.0
+        with:
+          name: main-output
+          path: _output/coverage.out
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v1
+
+      - name: Login to DockerHub
+        uses: docker/login-action@v1
+        with:
+          username: ${{ env.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+
+      - name: Build docker images for host arch and push images to registry
+        run: |
+          make push

.gitignore

@@ -30,17 +30,17 @@ output/
 _output/
 
 ### OpenIM deploy ###
-deploy/open_im_demo
+deploy/openim_demo
-deploy/open_im_api
+deploy/openim-api
-deploy/open_im_msg_gateway
+deploy/openim-rpc-msg_gateway
-deploy/open_im_msg_transfer
+deploy/openim-msgtransfer
-deploy/open_im_push
+deploy/openim-push
-deploy/open_im_timer_task
+deploy/openim_timer_task
-deploy/open_im_rpc_user
+deploy/openim-rpc-user
-deploy/open_im_rpc_friend
+deploy/openim-rpc-friend
-deploy/open_im_rpc_group
+deploy/openim-rpc-group
-deploy/open_im_rpc_msg
+deploy/openim-rpc-msg
-deploy/open_im_rpc_auth
+deploy/openim-rpc-auth
 deploy/Open-IM-SDK-Core
 
 # files used by the developer

.gitmodules

@@ -1,4 +0,0 @@
-
-[submodule "cmd/Open-IM-SDK-Core"]
-	path = cmd/Open-IM-SDK-Core
-	url = https://github.com/OpenIMSDK/Open-IM-SDK-Core.git

CHANGELOG.md

@@ -0,0 +1 @@
+CHANGELOG/CHANGELOG.md

CHANGELOG/.chglog/CHANGELOG.tpl.md

@@ -1,40 +1,62 @@
-{{ range .Versions }}
+# Version logging for OpenIM
-<a name="{{ .Tag.Name }}"></a>
-## {{ if .Tag.Previous }}[{{ .Tag.Name }}]({{ $.Info.RepositoryURL }}/compare/{{ .Tag.Previous.Name }}...{{ .Tag.Name }}){{ else }}{{ .Tag.Name }}{{ end }}
 
-> {{ datetime "2006-01-02" .Tag.Date }}
+<!-- BEGIN MUNGE: GENERATED_TOC -->
 
-{{ range .CommitGroups -}}
+<!-- END MUNGE: GENERATED_TOC -->
+
+{{ if .Versions -}}
+<a name="unreleased"></a>
+## [Unreleased]
+
+{{ if .Unreleased.CommitGroups -}}
+{{ range .Unreleased.CommitGroups -}}
 ### {{ .Title }}
+{{ range .Commits -}}
+- {{ if .Scope }}**{{ .Scope }}:** {{ end }}{{ .Subject }}
+{{ end }}
+{{ end -}}
+{{ end -}}
+{{ end -}}
 
+{{ range .Versions }}
+<a name="{{ .Tag.Name }}"></a>
+## {{ if .Tag.Previous }}[{{ .Tag.Name }}]{{ else }}{{ .Tag.Name }}{{ end }} - {{ datetime "2006-01-02" .Tag.Date }}
+{{ range .CommitGroups -}}
+### {{ .Title }}
 {{ range .Commits -}}
-* {{ if .Scope }}**{{ .Scope }}:** {{ end }}{{ .Subject }}
+- {{ if .Scope }}**{{ .Scope }}:** {{ end }}{{ .Subject }}
 {{ end }}
 {{ end -}}
 
 {{- if .RevertCommits -}}
 ### Reverts
-
 {{ range .RevertCommits -}}
-* {{ .Revert.Header }}
+- {{ .Revert.Header }}
 {{ end }}
 {{ end -}}
 
 {{- if .MergeCommits -}}
 ### Pull Requests
-
 {{ range .MergeCommits -}}
-* {{ .Header }}
+- {{ .Header }}
 {{ end }}
 {{ end -}}
 
 {{- if .NoteGroups -}}
 {{ range .NoteGroups -}}
 ### {{ .Title }}
-
 {{ range .Notes }}
 {{ .Body }}
 {{ end }}
 {{ end -}}
 {{ end -}}
+{{ end -}}
+
+{{- if .Versions }}
+[Unreleased]: {{ .Info.RepositoryURL }}/compare/{{ $latest := index .Versions 0 }}{{ $latest.Tag.Name }}...HEAD
+{{ range .Versions -}}
+{{ if .Tag.Previous -}}
+[{{ .Tag.Name }}]: {{ $.Info.RepositoryURL }}/compare/{{ .Tag.Previous.Name }}...{{ .Tag.Name }}
+{{ end -}}
+{{ end -}}
 {{ end -}}

CHANGELOG/.chglog/config.yml

@@ -1,28 +1,67 @@
+bin: git
 style: github
 template: CHANGELOG.tpl.md
 info:
   title: CHANGELOG
   repository_url: https://github.com/OpenIMSDK/Open-IM-Server
 options:
+  tag_filter_pattern: '^v'
+  sort: "date"
+
   commits:
-    # filters:
+    filters:
-    #   Type:
+      Type:
-    #     - feat
+        - feat
-    #     - fix
+        - fix
-    #     - perf
+        - perf
-    #     - refactor
+        - refactor
+        - docs
+        - test
+        - chore
+        - ci
+        - build
+    sort_by: Scope
+
   commit_groups:
-    # title_maps:
+    group_by: Type
-    #   feat: Features
+    sort_by: Title
-    #   fix: Bug Fixes
+    title_order:
-    #   perf: Performance Improvements
+      - feat
-    #   refactor: Code Refactoring
+      - fix
+      - perf
+      - refactor
+      - docs
+      - test
+      - chore
+      - ci
+      - build
+    title_maps:
+      feat: Features
+
   header:
-    pattern: "^(\\w*)(?:\\(([\\w\\$\\.\\-\\*\\s]*)\\))?\\:\\s(.*)$"
+    pattern: "<regexp>"
     pattern_maps:
-      - Type
+      - PropName
-      - Scope
+
-      - Subject
+  issues:
+    prefix:
+      - #
+
+  refs:
+    actions:
+      - Closes
+      - Fixes
+
+  merges:
+    pattern: "^Merge branch '(\\w+)'$"
+    pattern_maps:
+      - Source
+
+  reverts:
+    pattern: "^Revert \"([\\s\\S]*)\"$"
+    pattern_maps:
+      - Header
+
   notes:
     keywords:
       - BREAKING CHANGE

CHANGELOG/CHANGELOG-0.0.0.md

@@ -1,228 +0,0 @@
-
-<a name="v2.3.3"></a>
-## [v2.3.3](https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.3.2...v2.3.3)
-
-> 2022-09-18
-
-
-<a name="v2.3.2"></a>
-## [v2.3.2](https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.3.0-rc2...v2.3.2)
-
-> 2022-09-09
-
-### GetSelfUserInfo
-
-* Handle the case where the user does not exist
-
-### Pull Requests
-
-* Merge pull request [#267](https://github.com/OpenIMSDK/Open-IM-Server/issues/267) from ouyangshi/del
-* Merge pull request [#265](https://github.com/OpenIMSDK/Open-IM-Server/issues/265) from ouyangshi/del
-* Merge pull request [#252](https://github.com/OpenIMSDK/Open-IM-Server/issues/252) from x-shadow-man/config-perf
-* Merge pull request [#263](https://github.com/OpenIMSDK/Open-IM-Server/issues/263) from ouyangshi/main
-* Merge pull request [#258](https://github.com/OpenIMSDK/Open-IM-Server/issues/258) from ouyangshi/main
-* Merge pull request [#261](https://github.com/OpenIMSDK/Open-IM-Server/issues/261) from ouyangshi/v2.3.0release
-
-
-<a name="v2.3.0-rc2"></a>
-## [v2.3.0-rc2](https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.3.0-rc1...v2.3.0-rc2)
-
-> 2022-07-29
-
-
-<a name="v2.3.0-rc1"></a>
-## [v2.3.0-rc1](https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.3.0-rc0...v2.3.0-rc1)
-
-> 2022-07-25
-
-
-<a name="v2.3.0-rc0"></a>
-## [v2.3.0-rc0](https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.2.0...v2.3.0-rc0)
-
-> 2022-07-15
-
-
-<a name="v2.2.0"></a>
-## [v2.2.0](https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.1.0...v2.2.0)
-
-> 2022-07-01
-
-
-<a name="v2.1.0"></a>
-## [v2.1.0](https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.0.10...v2.1.0)
-
-> 2022-06-17
-
-
-<a name="v2.0.10"></a>
-## [v2.0.10](https://github.com/OpenIMSDK/Open-IM-Server/compare/list...v2.0.10)
-
-> 2022-05-13
-
-
-<a name="list"></a>
-## [list](https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.0.9...list)
-
-> 2022-04-29
-
-
-<a name="v2.0.9"></a>
-## [v2.0.9](https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.0.7...v2.0.9)
-
-> 2022-04-29
-
-### Reverts
-
-* update etcd to v3.5.2 ([#206](https://github.com/OpenIMSDK/Open-IM-Server/issues/206))
-
-
-<a name="v2.0.7"></a>
-## [v2.0.7](https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.0.6...v2.0.7)
-
-> 2022-04-08
-
-
-<a name="v2.0.6"></a>
-## [v2.0.6](https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.0.5...v2.0.6)
-
-> 2022-04-01
-
-### Fix
-
-* json tag value of UserIDResult.UserID ([#178](https://github.com/OpenIMSDK/Open-IM-Server/issues/178))
-
-### Pull Requests
-
-* Merge pull request [#173](https://github.com/OpenIMSDK/Open-IM-Server/issues/173) from OpenIMSDK/tuoyun
-
-
-<a name="v2.0.5"></a>
-## [v2.0.5](https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.04...v2.0.5)
-
-> 2022-03-24
-
-
-<a name="v2.04"></a>
-## [v2.04](https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.0.3...v2.04)
-
-> 2022-03-18
-
-
-<a name="v2.0.3"></a>
-## [v2.0.3](https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.0.2...v2.0.3)
-
-> 2022-03-11
-
-
-<a name="v2.0.2"></a>
-## [v2.0.2](https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.0.1...v2.0.2)
-
-> 2022-03-04
-
-### Version
-
-* "3"
-* "2"
-
-
-<a name="v2.0.1"></a>
-## [v2.0.1](https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.0.0...v2.0.1)
-
-> 2022-02-25
-
-### DbMysqlDatabaseName
-
-* openIM_v2
-
-
-<a name="v2.0.0"></a>
-## [v2.0.0](https://github.com/OpenIMSDK/Open-IM-Server/compare/v1.0.7...v2.0.0)
-
-> 2022-02-23
-
-### Pb
-
-* open_im_sdk.OfflinePushInfo
-
-### Pull Requests
-
-* Merge pull request [#131](https://github.com/OpenIMSDK/Open-IM-Server/issues/131) from OpenIMSDK/cms-dev
-
-
-<a name="v1.0.7"></a>
-## [v1.0.7](https://github.com/OpenIMSDK/Open-IM-Server/compare/v1.0.6...v1.0.7)
-
-> 2021-12-17
-
-
-<a name="v1.0.6"></a>
-## [v1.0.6](https://github.com/OpenIMSDK/Open-IM-Server/compare/v1.0.5...v1.0.6)
-
-> 2021-12-10
-
-### Pb
-
-* open_im_sdk.OfflinePushInfo
-
-
-<a name="v1.0.5"></a>
-## [v1.0.5](https://github.com/OpenIMSDK/Open-IM-Server/compare/v1.0.4...v1.0.5)
-
-> 2021-12-03
-
-
-<a name="v1.0.4"></a>
-## [v1.0.4](https://github.com/OpenIMSDK/Open-IM-Server/compare/v1.0.3...v1.0.4)
-
-> 2021-11-25
-
-
-<a name="v1.0.3"></a>
-## [v1.0.3](https://github.com/OpenIMSDK/Open-IM-Server/compare/v1.0.1...v1.0.3)
-
-> 2021-11-12
-
-### Feat
-
-* test utils ([#26](https://github.com/OpenIMSDK/Open-IM-Server/issues/26))
-
-### Fix
-
-* Startup error ([#11](https://github.com/OpenIMSDK/Open-IM-Server/issues/11))
-
-### Pull Requests
-
-* Merge pull request [#12](https://github.com/OpenIMSDK/Open-IM-Server/issues/12) from njulk/main
-* Merge pull request [#9](https://github.com/OpenIMSDK/Open-IM-Server/issues/9) from xmcy0011/dev
-* Merge pull request [#6](https://github.com/OpenIMSDK/Open-IM-Server/issues/6) from Bloomingg/int
-
-
-<a name="v1.0.1"></a>
-## [v1.0.1](https://github.com/OpenIMSDK/Open-IM-Server/compare/v1.0.0...v1.0.1)
-
-> 2021-11-04
-
-
-<a name="v1.0.0"></a>
-## v1.0.0
-
-> 2021-10-28
-
-### Ci
-
-* ignore files created by docker-compose ([#19](https://github.com/OpenIMSDK/Open-IM-Server/issues/19))
-
-### Feat
-
-* optimise get server ip ([#20](https://github.com/OpenIMSDK/Open-IM-Server/issues/20))
-
-### Reverts
-
-* friend modify
-* update
-
-### Pull Requests
-
-* Merge pull request [#7](https://github.com/OpenIMSDK/Open-IM-Server/issues/7) from memory-qianxiao/docker-compose_update
-* Merge pull request [#4](https://github.com/OpenIMSDK/Open-IM-Server/issues/4) from wujingke/patch-1
-

CHANGELOG/CHANGELOG-1.0.md

@@ -0,0 +1,56 @@
+# Version logging for OpenIM
+
+> **Note**:
+> Deprecated version logging for OpenIM, please refer to [CHANGELOG.md](../CHANGELOG.md)
+
+<!-- BEGIN MUNGE: GENERATED_TOC -->
+
+- [Version logging for OpenIM](#version-logging-for-openim)
+  - [Unreleased](#unreleased)
+  - [v1.0.7 - 2021-12-17](#v107---2021-12-17)
+  - [v1.0.6 - 2021-12-10](#v106---2021-12-10)
+  - [v1.0.5 - 2021-12-03](#v105---2021-12-03)
+  - [v1.0.4 - 2021-11-25](#v104---2021-11-25)
+  - [v1.0.3 - 2021-11-12](#v103---2021-11-12)
+  - [v1.0.1 - 2021-11-04](#v101---2021-11-04)
+  - [v1.0.0 - 2021-10-28](#v100---2021-10-28)
+    - [Reverts](#reverts)
+
+<!-- END MUNGE: GENERATED_TOC -->
+
+<a name="unreleased"></a>
+## [Unreleased]
+
+
+<a name="v1.0.7"></a>
+## [v1.0.7] - 2021-12-17
+
+<a name="v1.0.6"></a>
+## [v1.0.6] - 2021-12-10
+
+<a name="v1.0.5"></a>
+## [v1.0.5] - 2021-12-03
+
+<a name="v1.0.4"></a>
+## [v1.0.4] - 2021-11-25
+
+<a name="v1.0.3"></a>
+## [v1.0.3] - 2021-11-12
+
+<a name="v1.0.1"></a>
+## [v1.0.1] - 2021-11-04
+
+<a name="v1.0.0"></a>
+## v1.0.0 - 2021-10-28
+### Reverts
+- friend modify
+- update
+
+
+[Unreleased]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v1.0.7...HEAD
+[v1.0.7]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v1.0.6...v1.0.7
+[v1.0.6]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v1.0.5...v1.0.6
+[v1.0.5]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v1.0.4...v1.0.5
+[v1.0.4]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v1.0.3...v1.0.4
+[v1.0.3]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v1.0.1...v1.0.3
+[v1.0.1]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v1.0.0...v1.0.1

CHANGELOG/CHANGELOG-2.0.md

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

CHANGELOG/CHANGELOG-2.1.md

@@ -0,0 +1,50 @@
+# Version logging for OpenIM:v2.1
+
+> **Note**:
+> Deprecated version logging for OpenIM, please refer to [CHANGELOG.md](../CHANGELOG.md)
+
+<!-- BEGIN MUNGE: GENERATED_TOC -->
+
+- [Version logging for OpenIM:v2.1](#version-logging-for-openimv21)
+  - [Unreleased](#unreleased)
+  - [v2.1.0 - 2022-06-17](#v210---2022-06-17)
+    - [Reverts](#reverts)
+    - [Pull Requests](#pull-requests)
+
+
+<!-- END MUNGE: GENERATED_TOC -->
+
+<a name="unreleased"></a>
+## [Unreleased]
+
+
+<a name="v2.1.0"></a>
+## v2.1.0 - 2022-06-17
+### Reverts
+- update etcd to v3.5.2 ([#206](https://github.com/OpenIMSDK/Open-IM-Server/issues/206))
+- friend modify
+- update
+
+### Pull Requests
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+
+
+[Unreleased]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.1.0...HEAD

CHANGELOG/CHANGELOG-2.2.md

@@ -0,0 +1,50 @@
+# Version logging for OpenIM:v2.2
+
+> **Note**:
+> Deprecated version logging for OpenIM, please refer to [CHANGELOG.md](../CHANGELOG.md)
+
+<!-- BEGIN MUNGE: GENERATED_TOC -->
+
+- [Version logging for OpenIM:v2.2](#version-logging-for-openimv22)
+  - [Unreleased](#unreleased)
+  - [v2.2.0 - 2022-07-01](#v220---2022-07-01)
+    - [Reverts](#reverts)
+    - [Pull Requests](#pull-requests)
+
+
+<!-- END MUNGE: GENERATED_TOC -->
+
+<a name="unreleased"></a>
+## [Unreleased]
+
+
+<a name="v2.2.0"></a>
+## v2.2.0 - 2022-07-01
+### Reverts
+- update etcd to v3.5.2 ([#206](https://github.com/OpenIMSDK/Open-IM-Server/issues/206))
+- friend modify
+- update
+
+### Pull Requests
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+
+
+[Unreleased]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.2.0...HEAD

CHANGELOG/CHANGELOG-2.3.md

@@ -0,0 +1,70 @@
+# Version logging for OpenIM:v2.3
+
+> **Note**:
+> Deprecated version logging for OpenIM, please refer to [CHANGELOG.md](../CHANGELOG.md)
+
+<!-- BEGIN MUNGE: GENERATED_TOC -->
+
+- [Version logging for OpenIM:v2.3](#version-logging-for-openimv23)
+  - [Unreleased](#unreleased)
+  - [v2.3.3 - 2022-09-18](#v233---2022-09-18)
+  - [v2.3.2 - 2022-09-09](#v232---2022-09-09)
+  - [v2.3.0-rc2 - 2022-07-29](#v230-rc2---2022-07-29)
+  - [v2.3.0-rc1 - 2022-07-25](#v230-rc1---2022-07-25)
+  - [v2.3.0-rc0 - 2022-07-15](#v230-rc0---2022-07-15)
+    - [Reverts](#reverts)
+    - [Pull Requests](#pull-requests)
+
+
+<!-- END MUNGE: GENERATED_TOC -->
+
+<a name="unreleased"></a>
+## [Unreleased]
+
+
+<a name="v2.3.3"></a>
+## [v2.3.3] - 2022-09-18
+
+<a name="v2.3.2"></a>
+## [v2.3.2] - 2022-09-09
+
+<a name="v2.3.0-rc2"></a>
+## [v2.3.0-rc2] - 2022-07-29
+
+<a name="v2.3.0-rc1"></a>
+## [v2.3.0-rc1] - 2022-07-25
+
+<a name="v2.3.0-rc0"></a>
+## v2.3.0-rc0 - 2022-07-15
+### Reverts
+- update etcd to v3.5.2 ([#206](https://github.com/OpenIMSDK/Open-IM-Server/issues/206))
+- friend modify
+- update
+
+### Pull Requests
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+
+
+[Unreleased]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.3.3...HEAD
+[v2.3.3]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.3.2...v2.3.3
+[v2.3.2]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.3.0-rc2...v2.3.2
+[v2.3.0-rc2]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.3.0-rc1...v2.3.0-rc2
+[v2.3.0-rc1]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.3.0-rc0...v2.3.0-rc1

CHANGELOG/CHANGELOG-2.9.md

@@ -0,0 +1,52 @@
+# Version logging for OpenIM
+
+<!-- BEGIN MUNGE: GENERATED_TOC -->
+
+- [Version logging for OpenIM](#version-logging-for-openim)
+  - [Unreleased](#unreleased)
+  - [v2.9.0+1.839643f - 2023-07-07](#v2901839643f---2023-07-07)
+  - [v2.9.0+2.35f07fe - 2023-07-06](#v290235f07fe---2023-07-06)
+  - [v2.9.0+1.b5072b1 - 2023-07-05](#v2901b5072b1---2023-07-05)
+  - [v2.9.0+3.2667a3a - 2023-07-05](#v29032667a3a---2023-07-05)
+  - [v2.9.0+7.04818ca - 2023-07-05](#v290704818ca---2023-07-05)
+  - [v2.9.0 - 2023-07-04](#v290---2023-07-04)
+    - [Reverts](#reverts)
+    - [Pull Requests](#pull-requests)
+
+
+<!-- END MUNGE: GENERATED_TOC -->
+
+<a name="unreleased"></a>
+## [Unreleased]
+
+
+<a name="v2.9.0+1.839643f"></a>
+## [v2.9.0+1.839643f] - 2023-07-07
+
+<a name="v2.9.0+2.35f07fe"></a>
+## [v2.9.0+2.35f07fe] - 2023-07-06
+
+<a name="v2.9.0+1.b5072b1"></a>
+## [v2.9.0+1.b5072b1] - 2023-07-05
+
+<a name="v2.9.0+3.2667a3a"></a>
+## [v2.9.0+3.2667a3a] - 2023-07-05
+
+<a name="v2.9.0+7.04818ca"></a>
+## [v2.9.0+7.04818ca] - 2023-07-05
+
+<a name="v2.9.0"></a>
+## v2.9.0 - 2023-07-04
+### Reverts
+- update etcd to v3.5.2 ([#206](https://github.com/OpenIMSDK/Open-IM-Server/issues/206))
+
+### Pull Requests
+- Merge branch 'tuoyun'
+
+
+[Unreleased]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.9.0+1.839643f...HEAD
+[v2.9.0+1.839643f]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.9.0+2.35f07fe...v2.9.0+1.839643f
+[v2.9.0+2.35f07fe]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.9.0+1.b5072b1...v2.9.0+2.35f07fe
+[v2.9.0+1.b5072b1]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.9.0+3.2667a3a...v2.9.0+1.b5072b1
+[v2.9.0+3.2667a3a]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.9.0+7.04818ca...v2.9.0+3.2667a3a
+[v2.9.0+7.04818ca]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.9.0...v2.9.0+7.04818ca

CHANGELOG/CHANGELOG-3.0.md

@@ -0,0 +1,255 @@
+# Version logging for OpenIM
+
+**3.0 Major refactoring**
+
+<!-- BEGIN MUNGE: GENERATED_TOC -->
+
+- [Version logging for OpenIM](#version-logging-for-openim)
+  - [\[v3.0\]](#v30)
+  - [v3.0.0 - 2023-07-10](#v300---2023-07-10)
+  - [v2.9.0+1.839643f - 2023-07-07](#v2901839643f---2023-07-07)
+  - [v2.9.0+2.35f07fe - 2023-07-06](#v290235f07fe---2023-07-06)
+  - [v2.9.0+1.b5072b1 - 2023-07-05](#v2901b5072b1---2023-07-05)
+  - [v2.9.0+3.2667a3a - 2023-07-05](#v29032667a3a---2023-07-05)
+  - [v2.9.0+7.04818ca - 2023-07-05](#v290704818ca---2023-07-05)
+  - [v2.9.0 - 2023-07-04](#v290---2023-07-04)
+  - [v0.0.0+1.3714b4f - 2023-07-04](#v00013714b4f---2023-07-04)
+  - [v0.0.0+635.8b92c90 - 2023-07-04](#v0006358b92c90---2023-07-04)
+  - [v0.0.0+1.78a6d03 - 2023-07-04](#v000178a6d03---2023-07-04)
+  - [v0.0.0+2.e057c18 - 2023-07-04](#v0002e057c18---2023-07-04)
+  - [v0.0.0+630.b55ac4a - 2023-07-04](#v000630b55ac4a---2023-07-04)
+    - [Reverts](#reverts)
+    - [Pull Requests](#pull-requests)
+  - [v2.3.3 - 2022-09-18](#v233---2022-09-18)
+  - [v2.3.2 - 2022-09-09](#v232---2022-09-09)
+  - [v2.3.0-rc2 - 2022-07-29](#v230-rc2---2022-07-29)
+  - [v2.3.0-rc1 - 2022-07-25](#v230-rc1---2022-07-25)
+  - [v2.3.0-rc0 - 2022-07-15](#v230-rc0---2022-07-15)
+  - [v2.2.0 - 2022-07-01](#v220---2022-07-01)
+  - [v2.1.0 - 2022-06-17](#v210---2022-06-17)
+    - [Pull Requests](#pull-requests-1)
+  - [v2.0.10 - 2022-05-13](#v2010---2022-05-13)
+  - [v2.0.9 - 2022-04-29](#v209---2022-04-29)
+    - [Reverts](#reverts-1)
+    - [Pull Requests](#pull-requests-2)
+  - [v2.0.8 - 2022-04-24](#v208---2022-04-24)
+    - [Pull Requests](#pull-requests-3)
+  - [v2.0.7 - 2022-04-08](#v207---2022-04-08)
+    - [Pull Requests](#pull-requests-4)
+  - [v2.0.6 - 2022-04-01](#v206---2022-04-01)
+    - [Pull Requests](#pull-requests-5)
+  - [v2.0.5 - 2022-03-24](#v205---2022-03-24)
+  - [v2.04 - 2022-03-18](#v204---2022-03-18)
+  - [v2.0.3 - 2022-03-11](#v203---2022-03-11)
+  - [v2.0.2 - 2022-03-04](#v202---2022-03-04)
+    - [Pull Requests](#pull-requests-6)
+  - [v2.0.1 - 2022-02-25](#v201---2022-02-25)
+  - [v2.0.0 - 2022-02-23](#v200---2022-02-23)
+  - [v1.0.7 - 2021-12-17](#v107---2021-12-17)
+  - [v1.0.6 - 2021-12-10](#v106---2021-12-10)
+  - [v1.0.5 - 2021-12-03](#v105---2021-12-03)
+  - [v1.0.4 - 2021-11-25](#v104---2021-11-25)
+  - [v1.0.3 - 2021-11-12](#v103---2021-11-12)
+  - [v1.0.1 - 2021-11-04](#v101---2021-11-04)
+  - [v1.0.0 - 2021-10-28](#v100---2021-10-28)
+    - [Reverts](#reverts-2)
+
+
+<!-- END MUNGE: GENERATED_TOC -->
+
+<a name="unreleased"></a>
+## [v3.0]
+
+
+<a name="v3.0.0"></a>
+## [v3.0.0] - 2023-07-10
+
+<a name="v2.9.0+1.839643f"></a>
+## [v2.9.0+1.839643f] - 2023-07-07
+
+<a name="v2.9.0+2.35f07fe"></a>
+## [v2.9.0+2.35f07fe] - 2023-07-06
+
+<a name="v2.9.0+1.b5072b1"></a>
+## [v2.9.0+1.b5072b1] - 2023-07-05
+
+<a name="v2.9.0+3.2667a3a"></a>
+## [v2.9.0+3.2667a3a] - 2023-07-05
+
+<a name="v2.9.0+7.04818ca"></a>
+## [v2.9.0+7.04818ca] - 2023-07-05
+
+<a name="v2.9.0"></a>
+## [v2.9.0] - 2023-07-04
+
+<a name="v0.0.0+1.3714b4f"></a>
+## [v0.0.0+1.3714b4f] - 2023-07-04
+
+<a name="v0.0.0+635.8b92c90"></a>
+## [v0.0.0+635.8b92c90] - 2023-07-04
+
+<a name="v0.0.0+1.78a6d03"></a>
+## [v0.0.0+1.78a6d03] - 2023-07-04
+
+<a name="v0.0.0+2.e057c18"></a>
+## [v0.0.0+2.e057c18] - 2023-07-04
+
+<a name="v0.0.0+630.b55ac4a"></a>
+## [v0.0.0+630.b55ac4a] - 2023-07-04
+### Reverts
+- update etcd to v3.5.2 ([#206](https://github.com/OpenIMSDK/Open-IM-Server/issues/206))
+
+### Pull Requests
+- Merge branch 'tuoyun'
+
+
+<a name="v2.3.3"></a>
+## [v2.3.3] - 2022-09-18
+
+<a name="v2.3.2"></a>
+## [v2.3.2] - 2022-09-09
+
+<a name="v2.3.0-rc2"></a>
+## [v2.3.0-rc2] - 2022-07-29
+
+<a name="v2.3.0-rc1"></a>
+## [v2.3.0-rc1] - 2022-07-25
+
+<a name="v2.3.0-rc0"></a>
+## [v2.3.0-rc0] - 2022-07-15
+
+<a name="v2.2.0"></a>
+## [v2.2.0] - 2022-07-01
+
+<a name="v2.1.0"></a>
+## [v2.1.0] - 2022-06-17
+### Pull Requests
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+
+
+<a name="v2.0.10"></a>
+## [v2.0.10] - 2022-05-13
+
+<a name="v2.0.9"></a>
+## [v2.0.9] - 2022-04-29
+### Reverts
+- update etcd to v3.5.2 ([#206](https://github.com/OpenIMSDK/Open-IM-Server/issues/206))
+
+### Pull Requests
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+
+
+<a name="v2.0.8"></a>
+## [v2.0.8] - 2022-04-24
+### Pull Requests
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+
+
+<a name="v2.0.7"></a>
+## [v2.0.7] - 2022-04-08
+### Pull Requests
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+
+
+<a name="v2.0.6"></a>
+## [v2.0.6] - 2022-04-01
+### Pull Requests
+- Merge branch 'tuoyun'
+
+
+<a name="v2.0.5"></a>
+## [v2.0.5] - 2022-03-24
+
+<a name="v2.04"></a>
+## [v2.04] - 2022-03-18
+
+<a name="v2.0.3"></a>
+## [v2.0.3] - 2022-03-11
+
+<a name="v2.0.2"></a>
+## [v2.0.2] - 2022-03-04
+### Pull Requests
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+- Merge branch 'tuoyun'
+
+
+<a name="v2.0.1"></a>
+## [v2.0.1] - 2022-02-25
+
+<a name="v2.0.0"></a>
+## [v2.0.0] - 2022-02-23
+
+<a name="v1.0.7"></a>
+## [v1.0.7] - 2021-12-17
+
+<a name="v1.0.6"></a>
+## [v1.0.6] - 2021-12-10
+
+<a name="v1.0.5"></a>
+## [v1.0.5] - 2021-12-03
+
+<a name="v1.0.4"></a>
+## [v1.0.4] - 2021-11-25
+
+<a name="v1.0.3"></a>
+## [v1.0.3] - 2021-11-12
+
+<a name="v1.0.1"></a>
+## [v1.0.1] - 2021-11-04
+
+<a name="v1.0.0"></a>
+## v1.0.0 - 2021-10-28
+### Reverts
+- friend modify
+- update
+
+
+[Unreleased]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v3.0.0...HEAD
+[v3.0.0]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.9.0+1.839643f...v3.0.0
+[v2.9.0+1.839643f]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.9.0+2.35f07fe...v2.9.0+1.839643f
+[v2.9.0+2.35f07fe]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.9.0+1.b5072b1...v2.9.0+2.35f07fe
+[v2.9.0+1.b5072b1]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.9.0+3.2667a3a...v2.9.0+1.b5072b1
+[v2.9.0+3.2667a3a]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.9.0+7.04818ca...v2.9.0+3.2667a3a
+[v2.9.0+7.04818ca]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.9.0...v2.9.0+7.04818ca
+[v2.9.0]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v0.0.0+1.3714b4f...v2.9.0
+[v0.0.0+1.3714b4f]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v0.0.0+635.8b92c90...v0.0.0+1.3714b4f
+[v0.0.0+635.8b92c90]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v0.0.0+1.78a6d03...v0.0.0+635.8b92c90
+[v0.0.0+1.78a6d03]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v0.0.0+2.e057c18...v0.0.0+1.78a6d03
+[v0.0.0+2.e057c18]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v0.0.0+630.b55ac4a...v0.0.0+2.e057c18
+[v0.0.0+630.b55ac4a]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.3.3...v0.0.0+630.b55ac4a
+[v2.3.3]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.3.2...v2.3.3
+[v2.3.2]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.3.0-rc2...v2.3.2
+[v2.3.0-rc2]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.3.0-rc1...v2.3.0-rc2
+[v2.3.0-rc1]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.3.0-rc0...v2.3.0-rc1
+[v2.3.0-rc0]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.2.0...v2.3.0-rc0
+[v2.2.0]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.1.0...v2.2.0
+[v2.1.0]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.0.10...v2.1.0
+[v2.0.10]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.0.9...v2.0.10
+[v2.0.9]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.0.8...v2.0.9
+[v2.0.8]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.0.7...v2.0.8
+[v2.0.7]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.0.6...v2.0.7
+[v2.0.6]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.0.5...v2.0.6
+[v2.0.5]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.04...v2.0.5
+[v2.04]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.0.3...v2.04
+[v2.0.3]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.0.2...v2.0.3
+[v2.0.2]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.0.1...v2.0.2
+[v2.0.1]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.0.0...v2.0.1
+[v2.0.0]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v1.0.7...v2.0.0
+[v1.0.7]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v1.0.6...v1.0.7
+[v1.0.6]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v1.0.5...v1.0.6
+[v1.0.5]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v1.0.4...v1.0.5
+[v1.0.4]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v1.0.3...v1.0.4
+[v1.0.3]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v1.0.1...v1.0.3
+[v1.0.1]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v1.0.0...v1.0.1

CHANGELOG/CHANGELOG.md

@@ -1,3 +1,29 @@
 # Changelog
 
-All notable changes to this project will be documented in this file.
+All notable changes to this project will be documented in this file.
+
++ [https://github.com/OpenIMSDK/Open-IM-Server/releases](https://github.com/OpenIMSDK/Open-IM-Server/releases)
+
+## command
+
+```bash
+git-chglog --tag-filter-pattern 'v2.0.*'  -o CHANGELOG-2.0.md
+```
+
+## create next tag
+
+```bash
+git-chglog --next-tag 2.0.0 -o CHANGELOG.md
+git commit -am "release 2.0.0"
+git tag 2.0.0
+```
+
+## Release version logs
+
++ [OpenIM CHANGELOG-V1.0](CHANGELOG-1.0.md)
++ [OpenIM CHANGELOG-V2.0](CHANGELOG-2.0.md)
++ [OpenIM CHANGELOG-V2.1](CHANGELOG-2.1.md)
++ [OpenIM CHANGELOG-V2.2](CHANGELOG-2.2.md)
++ [OpenIM CHANGELOG-V2.3](CHANGELOG-2.3.md)
++ [OpenIM CHANGELOG-V2.9](CHANGELOG-2.9.md)
++ [OpenIM CHANGELOG-V3.0](CHANGELOG-3.0.md)

CONTRIBUTING.md

@@ -8,13 +8,23 @@ This document provides guidelines and best practices to help you contribute effe
 
 ## 📇Topics
 
-- [What we expect of you](#What-we-expect-of-you)
+- [Contributing to Open-IM-Server](#contributing-to-open-im-server)
-- [Code of Conduct](#Code-of-Conduct)
+  - [📇Topics](#topics)
-- [Getting Started](#Getting-Started)
+  - [What we expect of you](#what-we-expect-of-you)
-- [Style and Specification](#Style-and-Specification)
+  - [Code of ConductCode of Conduct](#code-of-conductcode-of-conduct)
-- [Engage to help anything](#Engage-to-help-anything)
+      - [Code and doc contribution](#code-and-doc-contribution)
-- [Release version](#Release-version)
+      - [Where should I start?](#where-should-i-start)
-- [Contact Us](#Contact-Us)
+      - [Design documents](#design-documents)
+  - [Getting Started](#getting-started)
+  - [Style and Specification](#style-and-specification)
+      - [Reporting security issues](#reporting-security-issues)
+      - [Reporting general issues](#reporting-general-issues)
+      - [Commit Rules](#commit-rules)
+      - [PR Description](#pr-description)
+      - [Docs Contribution](#docs-contribution)
+  - [Engage to help anything](#engage-to-help-anything)
+  - [Release version](#release-version)
+  - [Contact Us](#contact-us)
 
 ## What we expect of you
 
@@ -32,7 +42,7 @@ The [Makefile](./Makefile) is for every developer, even if you don't know how to
 
 #### Code and doc contribution
 
-Every action to make project Open-IM-Server better is encouraged. On GitHub, every improvement for Open-IM-Server could be via a [PR](https://github.com/Open-IM-Server/pulls) (short for pull request).
+Every action to make project Open-IM-Server better is encouraged. On GitHub, every improvement for Open-IM-Server could be via a [PR](https://github.com/OpenIMSDK/Open-IM-Server/pulls) (short for pull request).
 
 + If you find a typo, try to fix it!
 + If you find a bug, try to fix it!
@@ -48,7 +58,7 @@ Every action to make project Open-IM-Server better is encouraged. On GitHub, eve
 #### Where should I start?
 
 + If you are new to the project, don't know how to contribute Open-IM-Server, please check out the [good first issue](https://github.com/OpenIMSDK/Open-IM-Server/issues?q=is%3Aopen+label%3A"good+first+issue"+sort%3Aupdated-desc) label.
-+ You should be good at filtering the Open-IM-Server issue tags and finding the ones you like, such as [RFC](https://github.com/OpenIMSDK/Open-IM-Server/issues?q=is%3Aissue+is%3Aopen+RFC+label%3ARFC) for big initiatives, features for [feature](https://github.com/OpenIMSDK/Open-IM-Server/issues?q=is%3Aissue+label%3Afeature) proposals, and [bug](https://github.com/{github/issues?q=is%3Aissue+label%3Abug+) fixes.
++ You should be good at filtering the Open-IM-Server issue tags and finding the ones you like, such as [RFC](https://github.com/OpenIMSDK/Open-IM-Server/issues?q=is%3Aissue+is%3Aopen+RFC+label%3ARFC) for big initiatives, features for [feature](https://github.com/OpenIMSDK/Open-IM-Server/issues?q=is%3Aissue+label%3Afeature) proposals, and [bug](https://github.com/OpenIMSDK/Open-IM-Server/issues?q=is%3Aissue+label%3Abug+) fixes.
 + If you are looking for something to work on, check out our [open issues](https://github.com/OpenIMSDK/Open-IM-Server/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc).
 + If you have an idea for a new feature, please [open an issue](https://github.com/OpenIMSDK/Open-IM-Server/issues/new/choose), and we can discuss it.
 
@@ -79,7 +89,7 @@ To propose PR for the Open-IM-Server item, we assume you have registered a GitHu
 
 1. Fork the repository(Open-IM-Server)
 
-2. **CLONE** your own repository to master locally. Use `git clone https://github.com/<your-username>/Open-IM-Server.git` to clone repository to your local machine. Then you can create new branches to finish the change you wish to make.
+2. **CLONE** your own repository to main locally. Use `git clone https://github.com/<your-username>/Open-IM-Server.git` to clone repository to your local machine. Then you can create new branches to finish the change you wish to make.
 
 3. **Set Remote** upstream to be `https://github.com/OpenIMSDK/Open-IM-Server.git` using the following two commands:
 
@@ -180,7 +190,7 @@ To be honest, we regard every user of Open-IM-Serveras a very kind contributor.
 
 Since we collaborate project Open-IM-Server in a distributed way, we appreciate **WELL-WRITTEN**, **DETAILED**, **EXPLICIT** issue reports. To make the communication more efficient, we wish everyone could search if your issue is an existing one in the searching list. If you find it existing, please add your details in comments under the existing issue instead of opening a brand new one.
 
-To make the issue details as standard as possible, we setup an [ISSUE TEMPLATE](https://github.com/OpenIMSDK/Open-IM-Server/tree/main/.github/ISSUE_TEMPLATE) for issue reporters. You can find three kinds of issue templates there: question, bug report and feature request. Please **BE SURE** to follow the instructions to fill fields in template.
+To make the issue details as standard as possible, we setup an [ISSUE TEMPLATE](https://github.com/OpenIMSDK/.github/tree/main/.github/ISSUE_TEMPLATE) for issue reporters. You can find three kinds of issue templates there: question, bug report and feature request. Please **BE SURE** to follow the instructions to fill fields in template.
 
 **There are a lot of cases when you could open an issue:**
 
@@ -242,7 +252,7 @@ An example for this could be:
 
 #### PR Description
 
-PR is the only way to make change to Open-IM-Server project files. To help reviewers better get your purpose, PR description could not be too detailed. We encourage contributors to follow the [PR template](https://github.com/OpenIMSDK/Open-IM-Server/tree/main/.github/PULL_REQUEST_TEMPLATE.md) to finish the pull request.
+PR is the only way to make change to Open-IM-Server project files. To help reviewers better get your purpose, PR description could not be too detailed. We encourage contributors to follow the [PR template](https://github.com/OpenIMSDK/.github/tree/main/.github/PULL_REQUEST_TEMPLATE.md) to finish the pull request.
 
 You can find some very formal PR in [RFC](https://github.com/OpenIMSDK/Open-IM-Server/issues?q=is%3Aissue+is%3Aopen+RFC+label%3ARFC) issues and learn about them.
 
@@ -295,7 +305,6 @@ The documentation for Open-IM-Server includes:
 
 + [README.md](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/README.md): This file includes the basic information and instructions for getting started with Open-IM-Server.
 + [CONTRIBUTING.md](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/CONTRIBUTING.md): This file contains guidelines for contributing to Open-IM-Server's codebase, such as how to submit issues, pull requests, and code reviews.
-+ [DEVELOPGUIDE.md](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/DEVELOPGUIDE.md): This file provides a more in-depth guide to developing Open-IM-Server, including information on the project's architecture, coding conventions, and testing practices.
 + [Official Documentation](https://doc.rentsoft.cn/): This is the official documentation for Open-IM-Server, which includes comprehensive information on all of its features, configuration options, and troubleshooting tips.
 
 Please obey the following rules to better format the docs, which would greatly improve the reading experience.
@@ -315,7 +324,7 @@ We choose GitHub as the primary place for Open-IM-Server to collaborate. So the
 + help solve other user's problems;
 + help review other's [PR](https://github.com/OpenIMSDK/Open-IM-Server/pulls?q=is%3Apr+is%3Aopen+sort%3Aupdated-desc) design; 
 + discuss about Open-IM-Server to make things clearer;
-+ advocate [Open-IM-Server](google.com/search?q=Open-IM-Server) technology beyond GitHub;
++ advocate [Open-IM-Server](https://google.com/search?q=Open-IM-Server) technology beyond GitHub;
 + write blogs on Open-IM-Server and so on.
 
 In a word, **ANY HELP IS CONTRIBUTION.**

Makefile

@@ -4,6 +4,7 @@
 
 .DEFAULT_GOAL := help
 
+## all: Run tidy, gen, add-copyright, format, lint, cover, build ✨
 .PHONY: all
 all: tidy gen add-copyright format lint cover build
 
@@ -24,6 +25,8 @@ include scripts/make-rules/copyright.mk
 include scripts/make-rules/gen.mk
 include scripts/make-rules/dependencies.mk
 include scripts/make-rules/tools.mk
+include scripts/make-rules/release.mk
+include scripts/make-rules/swagger.mk
 
 # ==============================================================================
 # Usage
@@ -36,11 +39,12 @@ Options:
 
   BINS             Binaries to build. Default is all binaries under cmd.
                    This option is available when using: make {build}(.multiarch)
-                   Example: make build BINS="open_im_api open_im_cms_api".
+                   Example: make build BINS="openim-api openim-cmdutils".
 
   PLATFORMS        Platform to build for. Default is linux_arm64 and linux_amd64.
                    This option is available when using: make {build}.multiarch
-                   Example: make build.multiarch PLATFORMS="linux_arm64 linux_amd64".
+                   Example: make multiarch PLATFORMS="linux_s390x linux_mips64
+                   linux_mips64le darwin_amd64 windows_amd64 linux_amd64 linux_arm64".
 
   V                Set to 1 enable verbose build. Default is 0.
 endef
@@ -49,120 +53,135 @@ export USAGE_OPTIONS
 # ==============================================================================
 # Targets
 
-## build: Build binaries by default
+## build: Build binaries by default ✨
 .PHONY: build
 build:
 	@$(MAKE) go.build
 
-## build-multiarch: Build binaries for multiple platforms. See option PLATFORMS.
+## multiarch: Build binaries for multiple platforms. See option PLATFORMS. ✨
-.PHONY: build-multiarch
+.PHONY: multiarch
-build-multiarch:
+multiarch:
 	@$(MAKE) go.build.multiarch
 
-## tidy: tidy go.mod
+## tidy: tidy go.mod ✨
 .PHONY: tidy
 tidy:
 	@$(GO) mod tidy
 
-## vendor: vendor go.mod
+## vendor: vendor go.mod ✨
 .PHONY: vendor
 vendor:
 	@$(GO) mod vendor
 
-## style: code style -> fmt,vet,lint
+## style: code style -> fmt,vet,lint ✨
 .PHONY: style
 style: fmt vet lint
 
-## fmt: Run go fmt against code.
+## fmt: Run go fmt against code. ✨
 .PHONY: fmt
 fmt:
 	@$(GO) fmt ./...
 
-## vet: Run go vet against code.
+## vet: Run go vet against code. ✨
 .PHONY: vet
 vet:
 	@$(GO) vet ./...
 
-## lint: Check syntax and styling of go sources.
+lint: Check syntax and styling of go sources. ✨
 .PHONY: lint
 lint:
 	@$(MAKE) go.lint
 
-## format: Gofmt (reformat) package sources (exclude vendor dir if existed).
+## format: Gofmt (reformat) package sources (exclude vendor dir if existed). ✨
 .PHONY: format
 format:
 	@$(MAKE) go.format
 
-## test: Run unit test.
+## test: Run unit test. ✨
 .PHONY: test
 test:
 	@$(MAKE) go.test
 
-## cover: Run unit test and get test coverage.
+## cover: Run unit test and get test coverage. ✨
-.PHONY: cover 
+.PHONY: cover
 cover:
 	@$(MAKE) go.test.cover
 
-## updates: Check for updates to go.mod dependencies
+## updates: Check for updates to go.mod dependencies. ✨
 .PHONY: updates
 	@$(MAKE) go.updates
 
-## imports: task to automatically handle import packages in Go files using goimports tool
+## imports: task to automatically handle import packages in Go files using goimports tool. ✨
 .PHONY: imports
 imports:
 	@$(MAKE) go.imports
 
-## clean: Remove all files that are created by building. 
+## clean: Remove all files that are created by building. ✨
 .PHONY: clean
 clean:
 	@$(MAKE) go.clean
 
-## image: Build docker images for host arch.
+## image: Build docker images for host arch. ✨
 .PHONY: image
 image:
 	@$(MAKE) image.build
 
-## image.multiarch: Build docker images for multiple platforms. See option PLATFORMS.
+## image.multiarch: Build docker images for multiple platforms. See option PLATFORMS. ✨
 .PHONY: image.multiarch
 image.multiarch:
 	@$(MAKE) image.build.multiarch
 
-## push: Build docker images for host arch and push images to registry.
+## push: Build docker images for host arch and push images to registry. ✨
 .PHONY: push
 push:
 	@$(MAKE) image.push
 
-## push.multiarch: Build docker images for multiple platforms and push images to registry.
+## push.multiarch: Build docker images for multiple platforms and push images to registry. ✨
 .PHONY: push.multiarch
 push.multiarch:
 	@$(MAKE) image.push.multiarch
 
-## tools: Install dependent tools.
+## tools: Install dependent tools. ✨
 .PHONY: tools
 tools:
 	@$(MAKE) tools.install
 
-## gen: Generate all necessary files.
+## gen: Generate all necessary files. ✨
 .PHONY: gen
 gen:
 	@$(MAKE) gen.run
 
-## verify-copyright: Verify the license headers for all files.
+## swagger: Generate swagger document. ✨
+.PHONY: swagger
+swagger:
+	@$(MAKE) swagger.run
+
+## serve-swagger: Serve swagger spec and docs. ✨
+.PHONY: swagger.serve
+serve-swagger:
+	@$(MAKE) swagger.serve
+
+## verify-copyright: Verify the license headers for all files. ✨
 .PHONY: verify-copyright
 verify-copyright:
 	@$(MAKE) copyright.verify
 
-## add-copyright: Add copyright ensure source code files have license headers.
+## add-copyright: Add copyright ensure source code files have license headers. ✨
 .PHONY: add-copyright
 add-copyright:
 	@$(MAKE) copyright.add
 
-## help: Show this help info.
+## release: release the project ✨
+.PHONY: release
+release: release.verify release.ensure-tag
+	@scripts/release.sh
+
+## help: Show this help info. ✨
 .PHONY: help
 help: Makefile
 	$(call makehelp)
 
-## help-all: Show all help details info.
+## help-all: Show all help details info. ✨
 .PHONY: help-all
-help-all: go.help copyright.help tools.help image.help help
+help-all: go.help copyright.help tools.help image.help dependencies.help gen.help release.help swagger.help help
-	$(call makeallhelp)
+	$(call makeallhelp)

README-zh_CN.md

@@ -19,7 +19,7 @@
 
 <p align="center">
     <a href="./README.md"><b>English</b></a> •
-    <a href="./README_zh.md"><b>中文</b></a>
+    <a href="./README_zh-CN.md"><b>中文</b></a>
 </p>
 
 </p>
@@ -142,7 +142,7 @@ Open-IM-Server 是一款即时通讯服务器，使用纯 Golang 开发，采用
 
 > Open-IM 脚本提供服务编译、启动和停止脚本。有四个 Open-IM 脚本启动模块，一个是 http+rpc 服务启动模块，第二个是 WebSocket 服务启动模块，然后是 msg_transfer 模块，最后是 push 模块。
 
-+ path_info.cfg&&style_info.cfg&&
++ path_info.sh&&style_info.sh&&
 
   functions.sh
 

README.md

@@ -86,7 +86,7 @@ By deployment of the Open-IM-Server on the customer's server, developers can int
        ./docker_check_service.sh./check_all.sh
        ```
        
-       ![OpenIMServersonSystempng](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/Open-IM-Servers-on-System.png)
+       ![OpenIMServersonSystempng](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/images/Open-IM-Servers-on-System.png)
 
 #### Deploy using source code
 
@@ -146,7 +146,7 @@ all services build success
 
 > Open-IM scripts provides service compilation, start, and stop scripts. There are four Open-IM scripts start modules, one is the http+rpc service start module, the second is the websocket service start module, then the msg_transfer module, and the last is the push module
 
-- path_info.cfg&&style_info.cfg&&functions.sh
+- path_info.sh&&style_info.sh&&functions.sh
     - Contains the path information of each module, including the path where the source code is located, the name of the service startup, the shell print font style, and some functions for processing shell strings
 - build_all_service.sh
     - Compile the module, compile all the source code of Open-IM into a binary file and put it into the bin directory
@@ -157,11 +157,11 @@ all services build success
 
 ## Authentication Clow Chart 
 
-![avatar](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/open-im-server.png)
+![avatar](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/images/open-im-server.png)
 
 ## Architecture
 
-![avatar](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/Architecture.jpg)
+![avatar](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/images/Architecture.jpg)
 
 ## 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.

cmd/api/deploy.Dockerfile

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

cmd/crontask/deploy.Dockerfile

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

cmd/crontask/main.go

@@ -1,13 +0,0 @@
-package main
-
-import (
-	"github.com/OpenIMSDK/Open-IM-Server/internal/tools"
-	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/cmd"
-)
-
-func main() {
-	cronTaskCmd := cmd.NewCronTaskCmd()
-	if err := cronTaskCmd.Exec(tools.StartCronTask); err != nil {
-		panic(err.Error())
-	}
-}

cmd/msggateway/deploy.Dockerfile

@@ -1,18 +0,0 @@
-FROM ubuntu
-
-WORKDIR /Open-IM-Server/bin
-
-RUN apt-get update && apt-get install apt-transport-https && apt-get install procps\
-&&apt-get install net-tools
-#Non-interactive operation
-ENV DEBIAN_FRONTEND=noninteractive
-RUN apt-get install -y vim curl tzdata gawk
-#Time zone adjusted to East eighth District
-RUN ln -fs /usr/share/zoneinfo/Asia/Shanghai /etc/localtime && dpkg-reconfigure -f noninteractive tzdata
-RUN apt-get -qq update \
-    && apt-get -qq install -y --no-install-recommends ca-certificates curl
-COPY ./open_im_msg_gateway ./
-
-VOLUME ["/Open-IM-Server/logs","/Open-IM-Server/config"]
-
-CMD ["./open_im_msg_gateway","--port", "10140" "--ws_port", "10001"， "--prometheus_port", "20240"]

cmd/msggateway/main.go

@@ -1,15 +0,0 @@
-package main
-
-import (
-	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/cmd"
-)
-
-func main() {
-	msgGatewayCmd := cmd.NewMsgGatewayCmd()
-	msgGatewayCmd.AddWsPortFlag()
-	msgGatewayCmd.AddPortFlag()
-	msgGatewayCmd.AddPrometheusPortFlag()
-	if err := msgGatewayCmd.Exec(); err != nil {
-		panic(err.Error())
-	}
-}

cmd/msgtransfer/Makefile

@@ -1,34 +0,0 @@
-.PHONY: all build run gotool install clean help
-
-NAME=open_im_msg_transfer
-BIN_DIR=../../bin/
-
-OS:= $(or $(os),linux)
-ARCH:=$(or $(arch),amd64)
-all: gotool build
-
-ifeq ($(OS),windows)
-
-BINARY_NAME=${NAME}.exe
-
-else
-
-BINARY_NAME=${NAME}
-
-endif
-
-build:
-	CGO_ENABLED=0 GOOS=${OS} GOARCH=${ARCH}; go build -ldflags="-w -s" -o ${BINARY_NAME}
-
-run:
-	@go run ./
-
-gotool:
-	go fmt ./
-	go vet ./
-
-install:build
-	mv ${BINARY_NAME} ${BIN_DIR}
-
-clean:
-	@if [ -f ${BINARY_NAME} ] ; then rm ${BINARY_NAME} ; fi

cmd/msgtransfer/deploy.Dockerfile

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

cmd/msgtransfer/main.go

@@ -1,13 +0,0 @@
-package main
-
-import (
-	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/cmd"
-)
-
-func main() {
-	msgTransferCmd := cmd.NewMsgTransferCmd()
-	msgTransferCmd.AddPrometheusPortFlag()
-	if err := msgTransferCmd.Exec(); err != nil {
-		panic(err.Error())
-	}
-}

cmd/openim-api/Makefile

@@ -1,6 +1,6 @@
 .PHONY: all build run gotool install clean help
 
-NAME=open_im_api
+NAME=openim-api
 BIN_DIR=../../bin/
 
 OS:= $(or $(os),linux)

cmd/openim-api/deploy.Dockerfile

@@ -0,0 +1,32 @@
+# Copyright © 2023 OpenIM. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+FROM ubuntu
+
+WORKDIR /Open-IM-Server/bin
+
+RUN apt-get update && apt-get install apt-transport-https && apt-get install procps\
+&&apt-get install net-tools
+#Non-interactive operation
+ENV DEBIAN_FRONTEND=noninteractive
+RUN apt-get install -y vim curl tzdata gawk
+#Time zone adjusted to East eighth District
+RUN ln -fs /usr/share/zoneinfo/Asia/Shanghai /etc/localtime && dpkg-reconfigure -f noninteractive tzdata
+RUN apt-get -qq update \
+    && apt-get -qq install -y --no-install-recommends ca-certificates curl
+COPY ./openim-api ./
+
+VOLUME ["/Open-IM-Server/logs","/Open-IM-Server/config"]
+
+CMD ["./openim-api","--port", "10002"]

cmd/openim-api/main.go

@@ -1,3 +1,17 @@
+// Copyright © 2023 OpenIM. All rights reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
 package main
 
 import (
@@ -52,8 +66,10 @@ func run(port int) error {
 	fmt.Println("api start init discov client")
 	var client discoveryregistry.SvcDiscoveryRegistry
 	client, err = openKeeper.NewClient(config.Config.Zookeeper.ZkAddr, config.Config.Zookeeper.Schema,
-		openKeeper.WithFreq(time.Hour), openKeeper.WithUserNameAndPassword(config.Config.Zookeeper.Username,
+		openKeeper.WithFreq(time.Hour), openKeeper.WithUserNameAndPassword(
-			config.Config.Zookeeper.Password), openKeeper.WithRoundRobin(), openKeeper.WithTimeout(10), openKeeper.WithLogger(log.NewZkLogger()))
+			config.Config.Zookeeper.Username,
+			config.Config.Zookeeper.Password,
+		), openKeeper.WithRoundRobin(), openKeeper.WithTimeout(10), openKeeper.WithLogger(log.NewZkLogger()))
 	if err != nil {
 		return err
 	}

cmd/openim-cmdutils/Makefile

@@ -1,6 +1,6 @@
 .PHONY: all build run gotool install clean help
 
-NAME=open_im_cmd_utils
+NAME=openim-cmdutils
 BIN_DIR=../../bin/
 
 OS:= $(or $(os),linux)

cmd/openim-cmdutils/main.go

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

cmd/openim-crontask/Makefile

@@ -1,6 +1,6 @@
 .PHONY: all build run gotool install clean help
 
-NAME=open_im_cron_task
+NAME=openim-crontask
 BIN_DIR=../../bin/
 
 OS:= $(or $(os),linux)

cmd/openim-crontask/deploy.Dockerfile

@@ -0,0 +1,32 @@
+# Copyright © 2023 OpenIM. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+FROM ubuntu
+
+WORKDIR /Open-IM-Server/bin
+
+RUN apt-get update && apt-get install apt-transport-https && apt-get install procps\
+&&apt-get install net-tools
+#Non-interactive operation
+ENV DEBIAN_FRONTEND=noninteractive
+RUN apt-get install -y vim curl tzdata gawk
+#Time zone adjusted to East eighth District
+RUN ln -fs /usr/share/zoneinfo/Asia/Shanghai /etc/localtime && dpkg-reconfigure -f noninteractive tzdata
+RUN apt-get -qq update \
+    && apt-get -qq install -y --no-install-recommends ca-certificates curl
+COPY ./openim-crontask ./
+
+VOLUME ["/Open-IM-Server/logs","/Open-IM-Server/config"]
+
+CMD ["./openim-crontask"]

cmd/openim-crontask/main.go

@@ -0,0 +1,27 @@
+// 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 main
+
+import (
+	"github.com/OpenIMSDK/Open-IM-Server/internal/tools"
+	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/cmd"
+)
+
+func main() {
+	cronTaskCmd := cmd.NewCronTaskCmd()
+	if err := cronTaskCmd.Exec(tools.StartCronTask); err != nil {
+		panic(err.Error())
+	}
+}

cmd/openim-msggateway/Makefile

@@ -1,6 +1,6 @@
 .PHONY: all build run gotool install clean help
 
-NAME=open_im_msg_gateway
+NAME=openim-rpc-msg_gateway
 BIN_DIR=../../bin/
 
 OS:= $(or $(os),linux)
@@ -32,4 +32,3 @@ install:build
 
 clean:
 	@if [ -f ${BINARY_NAME} ] ; then rm ${BINARY_NAME} ; fi
-

cmd/openim-msggateway/deploy.Dockerfile

@@ -0,0 +1,32 @@
+# Copyright © 2023 OpenIM. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+FROM ubuntu
+
+WORKDIR /Open-IM-Server/bin
+
+RUN apt-get update && apt-get install apt-transport-https && apt-get install procps\
+&&apt-get install net-tools
+#Non-interactive operation
+ENV DEBIAN_FRONTEND=noninteractive
+RUN apt-get install -y vim curl tzdata gawk
+#Time zone adjusted to East eighth District
+RUN ln -fs /usr/share/zoneinfo/Asia/Shanghai /etc/localtime && dpkg-reconfigure -f noninteractive tzdata
+RUN apt-get -qq update \
+    && apt-get -qq install -y --no-install-recommends ca-certificates curl
+COPY ./openim-rpc-msg_gateway ./
+
+VOLUME ["/Open-IM-Server/logs","/Open-IM-Server/config"]
+
+CMD ["./openim-rpc-msg_gateway","--port", "10140" "--ws_port", "10001", "--prometheus_port", "20240"]

cmd/openim-msggateway/main.go

@@ -0,0 +1,29 @@
+// Copyright © 2023 OpenIM. All rights reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package main
+
+import (
+	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/cmd"
+)
+
+func main() {
+	msgGatewayCmd := cmd.NewMsgGatewayCmd()
+	msgGatewayCmd.AddWsPortFlag()
+	msgGatewayCmd.AddPortFlag()
+	msgGatewayCmd.AddPrometheusPortFlag()
+	if err := msgGatewayCmd.Exec(); err != nil {
+		panic(err.Error())
+	}
+}

cmd/openim-msgtransfer/Makefile

@@ -0,0 +1,34 @@
+.PHONY: all build run gotool install clean help
+
+NAME=openim-msgtransfer
+BIN_DIR=../../bin/
+
+OS:= $(or $(os),linux)
+ARCH:=$(or $(arch),amd64)
+all: gotool build
+
+ifeq ($(OS),windows)
+
+BINARY_NAME=${NAME}.exe
+
+else
+
+BINARY_NAME=${NAME}
+
+endif
+
+build:
+	CGO_ENABLED=0 GOOS=${OS} GOARCH=${ARCH}; go build -ldflags="-w -s" -o ${BINARY_NAME}
+
+run:
+	@go run ./
+
+gotool:
+	go fmt ./
+	go vet ./
+
+install:build
+	mv ${BINARY_NAME} ${BIN_DIR}
+
+clean:
+	@if [ -f ${BINARY_NAME} ] ; then rm ${BINARY_NAME} ; fi

cmd/openim-msgtransfer/deploy.Dockerfile

@@ -0,0 +1,32 @@
+# Copyright © 2023 OpenIM. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+FROM ubuntu
+
+WORKDIR /Open-IM-Server/bin
+
+RUN apt-get update && apt-get install apt-transport-https && apt-get install procps\
+&&apt-get install net-tools
+#Non-interactive operation
+ENV DEBIAN_FRONTEND=noninteractive
+RUN apt-get install -y vim curl tzdata gawk
+#Time zone adjusted to East eighth District
+RUN ln -fs /usr/share/zoneinfo/Asia/Shanghai /etc/localtime && dpkg-reconfigure -f noninteractive tzdata
+RUN apt-get -qq update \
+    && apt-get -qq install -y --no-install-recommends ca-certificates curl
+COPY ./openim-msgtransfer ./
+
+VOLUME ["/Open-IM-Server/logs","/Open-IM-Server/config"]
+
+CMD ["./openim-msgtransfer","--prometheus_port", "21400"]

cmd/openim-msgtransfer/main.go

@@ -15,9 +15,13 @@
 package main
 
 import (
-	"Open_IM/test/mysql"
+	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/cmd"
 )
 
 func main() {
-	mysql.ImportUserToSuperGroup()
+	msgTransferCmd := cmd.NewMsgTransferCmd()
+	msgTransferCmd.AddPrometheusPortFlag()
+	if err := msgTransferCmd.Exec(); err != nil {
+		panic(err.Error())
+	}
 }

cmd/openim-push/Makefile

@@ -1,6 +1,6 @@
 .PHONY: all build run gotool install clean help
 
-NAME=open_im_push
+NAME=openim-push
 BIN_DIR=../../bin/
 
 OS:= $(or $(os),linux)

cmd/openim-push/deploy.Dockerfile

@@ -0,0 +1,32 @@
+# Copyright © 2023 OpenIM. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+FROM ubuntu
+
+WORKDIR /Open-IM-Server/bin
+
+RUN apt-get update && apt-get install apt-transport-https && apt-get install procps\
+&&apt-get install net-tools
+#Non-interactive operation
+ENV DEBIAN_FRONTEND=noninteractive
+RUN apt-get install -y vim curl tzdata gawk
+#Time zone adjusted to East eighth District
+RUN ln -fs /usr/share/zoneinfo/Asia/Shanghai /etc/localtime && dpkg-reconfigure -f noninteractive tzdata
+RUN apt-get -qq update \
+    && apt-get -qq install -y --no-install-recommends ca-certificates curl
+COPY ./openim-push ./
+
+VOLUME ["/Open-IM-Server/logs","/Open-IM-Server/config"]
+
+CMD ["./openim-push", "--port", "10170", "--prometheus_port", "20170"]

cmd/openim-push/main.go

@@ -0,0 +1,33 @@
+// 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 main
+
+import (
+	"github.com/OpenIMSDK/Open-IM-Server/internal/push"
+	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/cmd"
+	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/config"
+)
+
+func main() {
+	pushCmd := cmd.NewRpcCmd("push")
+	pushCmd.AddPortFlag()
+	pushCmd.AddPrometheusPortFlag()
+	if err := pushCmd.Exec(); err != nil {
+		panic(err.Error())
+	}
+	if err := pushCmd.StartSvr(config.Config.RpcRegisterName.OpenImPushName, push.Start); err != nil {
+		panic(err.Error())
+	}
+}

cmd/openim-rpc/openim-rpc-auth/Makefile

@@ -1,6 +1,6 @@
 .PHONY: all build run gotool install clean help
 
-NAME=open_im_msg
+NAME=openim-rpc-auth
 BIN_DIR=../../../bin/
 
 OS:= $(or $(os),linux)
@@ -32,5 +32,3 @@ install:build
 
 clean:
 	@if [ -f ${BINARY_NAME} ] ; then rm ${BINARY_NAME} ; fi
-
-

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

@@ -0,0 +1,32 @@
+# Copyright © 2023 OpenIM. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+FROM ubuntu
+
+WORKDIR /Open-IM-Server/bin
+
+RUN apt-get update && apt-get install apt-transport-https && apt-get install procps\
+&&apt-get install net-tools
+#Non-interactive operation
+ENV DEBIAN_FRONTEND=noninteractive
+RUN apt-get install -y vim curl tzdata gawk
+#Time zone adjusted to East eighth District
+RUN ln -fs /usr/share/zoneinfo/Asia/Shanghai /etc/localtime && dpkg-reconfigure -f noninteractive tzdata
+RUN apt-get -qq update \
+    && apt-get -qq install -y --no-install-recommends ca-certificates curl
+COPY ./openim-rpc-auth ./
+
+VOLUME ["/Open-IM-Server/logs","/Open-IM-Server/config"]
+
+CMD ["./openim-rpc-auth", "--port", "10160"]

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

@@ -0,0 +1,33 @@
+// 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 main
+
+import (
+	"github.com/OpenIMSDK/Open-IM-Server/internal/rpc/auth"
+	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/cmd"
+	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/config"
+)
+
+func main() {
+	authCmd := cmd.NewRpcCmd("auth")
+	authCmd.AddPortFlag()
+	authCmd.AddPrometheusPortFlag()
+	if err := authCmd.Exec(); err != nil {
+		panic(err.Error())
+	}
+	if err := authCmd.StartSvr(config.Config.RpcRegisterName.OpenImAuthName, auth.Start); err != nil {
+		panic(err.Error())
+	}
+}

cmd/openim-rpc/openim-rpc-conversation/Makefile

@@ -1,6 +1,6 @@
 .PHONY: all build run gotool install clean help
 
-NAME=open_im_conversation
+NAME=openim-rpc-conversation
 BIN_DIR=../../../bin/
 
 OS:= $(or $(os),linux)

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

@@ -0,0 +1,32 @@
+# Copyright © 2023 OpenIM. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+FROM ubuntu
+
+WORKDIR /Open-IM-Server/bin
+
+RUN apt-get update && apt-get install apt-transport-https && apt-get install procps\
+&&apt-get install net-tools
+#Non-interactive operation
+ENV DEBIAN_FRONTEND=noninteractive
+RUN apt-get install -y vim curl tzdata gawk
+#Time zone adjusted to East eighth District
+RUN ln -fs /usr/share/zoneinfo/Asia/Shanghai /etc/localtime && dpkg-reconfigure -f noninteractive tzdata
+RUN apt-get -qq update \
+    && apt-get -qq install -y --no-install-recommends ca-certificates curl
+COPY ./openim-rpc-conversation ./
+
+VOLUME ["/Open-IM-Server/logs","/Open-IM-Server/config"]
+
+CMD ["./openim-rpc-conversation", "--port", "10230", "--prometheus_port","20230"]

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

@@ -0,0 +1,33 @@
+// 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 main
+
+import (
+	"github.com/OpenIMSDK/Open-IM-Server/internal/rpc/conversation"
+	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/cmd"
+	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/config"
+)
+
+func main() {
+	rpcCmd := cmd.NewRpcCmd("conversation")
+	rpcCmd.AddPortFlag()
+	rpcCmd.AddPrometheusPortFlag()
+	if err := rpcCmd.Exec(); err != nil {
+		panic(err.Error())
+	}
+	if err := rpcCmd.StartSvr(config.Config.RpcRegisterName.OpenImConversationName, conversation.Start); err != nil {
+		panic(err.Error())
+	}
+}

cmd/openim-rpc/openim-rpc-friend/Makefile

@@ -1,6 +1,6 @@
 .PHONY: all build run gotool install clean help
 
-NAME=open_im_user
+NAME=openim-rpc-friend
 BIN_DIR=../../../bin/
 
 OS:= $(or $(os),linux)
@@ -32,8 +32,3 @@ install:build
 
 clean:
 	@if [ -f ${BINARY_NAME} ] ; then rm ${BINARY_NAME} ; fi
-
-
-
-
-

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

@@ -0,0 +1,32 @@
+# Copyright © 2023 OpenIM. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+FROM ubuntu
+
+WORKDIR /Open-IM-Server/bin
+
+RUN apt-get update && apt-get install apt-transport-https && apt-get install procps\
+&&apt-get install net-tools
+#Non-interactive operation
+ENV DEBIAN_FRONTEND=noninteractive
+RUN apt-get install -y vim curl tzdata gawk
+#Time zone adjusted to East eighth District
+RUN ln -fs /usr/share/zoneinfo/Asia/Shanghai /etc/localtime && dpkg-reconfigure -f noninteractive tzdata
+RUN apt-get -qq update \
+    && apt-get -qq install -y --no-install-recommends ca-certificates curl
+COPY ./openim-rpc-friend ./
+
+VOLUME ["/Open-IM-Server/logs","/Open-IM-Server/config"]
+
+CMD ["./openim-rpc-friend", "--port", "10120", "--prometheus_port","20120"]

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

@@ -0,0 +1,33 @@
+// 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 main
+
+import (
+	"github.com/OpenIMSDK/Open-IM-Server/internal/rpc/friend"
+	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/cmd"
+	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/config"
+)
+
+func main() {
+	rpcCmd := cmd.NewRpcCmd("friend")
+	rpcCmd.AddPortFlag()
+	rpcCmd.AddPrometheusPortFlag()
+	if err := rpcCmd.Exec(); err != nil {
+		panic(err.Error())
+	}
+	if err := rpcCmd.StartSvr(config.Config.RpcRegisterName.OpenImFriendName, friend.Start); err != nil {
+		panic(err.Error())
+	}
+}

cmd/openim-rpc/openim-rpc-group/Makefile

@@ -1,6 +1,6 @@
 .PHONY: all build run gotool install clean help
 
-NAME=open_im_friend
+NAME=openim-rpc-group
 BIN_DIR=../../../bin/
 
 OS:= $(or $(os),linux)
@@ -32,5 +32,3 @@ install:build
 
 clean:
 	@if [ -f ${BINARY_NAME} ] ; then rm ${BINARY_NAME} ; fi
-
-

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

@@ -0,0 +1,32 @@
+# Copyright © 2023 OpenIM. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+FROM ubuntu
+
+WORKDIR /Open-IM-Server/bin
+
+RUN apt-get update && apt-get install apt-transport-https && apt-get install procps\
+&&apt-get install net-tools
+#Non-interactive operation
+ENV DEBIAN_FRONTEND=noninteractive
+RUN apt-get install -y vim curl tzdata gawk
+#Time zone adjusted to East eighth District
+RUN ln -fs /usr/share/zoneinfo/Asia/Shanghai /etc/localtime && dpkg-reconfigure -f noninteractive tzdata
+RUN apt-get -qq update \
+    && apt-get -qq install -y --no-install-recommends ca-certificates curl
+COPY ./openim-rpc-group ./
+
+VOLUME ["/Open-IM-Server/logs","/Open-IM-Server/config"]
+
+CMD ["./openim-rpc-group", "--port", "10150", "--prometheus_port","20150"]

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

@@ -0,0 +1,33 @@
+// 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 main
+
+import (
+	"github.com/OpenIMSDK/Open-IM-Server/internal/rpc/group"
+	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/cmd"
+	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/config"
+)
+
+func main() {
+	rpcCmd := cmd.NewRpcCmd("group")
+	rpcCmd.AddPortFlag()
+	rpcCmd.AddPrometheusPortFlag()
+	if err := rpcCmd.Exec(); err != nil {
+		panic(err.Error())
+	}
+	if err := rpcCmd.StartSvr(config.Config.RpcRegisterName.OpenImGroupName, group.Start); err != nil {
+		panic(err.Error())
+	}
+}

cmd/openim-rpc/openim-rpc-msg/Makefile

@@ -1,6 +1,6 @@
 .PHONY: all build run gotool install clean help
 
-NAME=open_im_auth
+NAME=openim-rpc-msg
 BIN_DIR=../../../bin/
 
 OS:= $(or $(os),linux)

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

@@ -0,0 +1,32 @@
+# Copyright © 2023 OpenIM. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+FROM ubuntu
+
+WORKDIR /Open-IM-Server/bin
+
+RUN apt-get update && apt-get install apt-transport-https && apt-get install procps\
+&&apt-get install net-tools
+#Non-interactive operation
+ENV DEBIAN_FRONTEND=noninteractive
+RUN apt-get install -y vim curl tzdata gawk
+#Time zone adjusted to East eighth District
+RUN ln -fs /usr/share/zoneinfo/Asia/Shanghai /etc/localtime && dpkg-reconfigure -f noninteractive tzdata
+RUN apt-get -qq update \
+    && apt-get -qq install -y --no-install-recommends ca-certificates curl
+COPY ./openim-rpc-msg ./
+
+VOLUME ["/Open-IM-Server/logs","/Open-IM-Server/config"]
+
+CMD ["./openim-rpc-msg", "--port", "10130", "--prometheus_port","20130"]

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

@@ -0,0 +1,33 @@
+// 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 main
+
+import (
+	"github.com/OpenIMSDK/Open-IM-Server/internal/rpc/msg"
+	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/cmd"
+	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/config"
+)
+
+func main() {
+	rpcCmd := cmd.NewRpcCmd("msg")
+	rpcCmd.AddPortFlag()
+	rpcCmd.AddPrometheusPortFlag()
+	if err := rpcCmd.Exec(); err != nil {
+		panic(err.Error())
+	}
+	if err := rpcCmd.StartSvr(config.Config.RpcRegisterName.OpenImMsgName, msg.Start); err != nil {
+		panic(err.Error())
+	}
+}

cmd/openim-rpc/openim-rpc-third/Makefile

@@ -0,0 +1,34 @@
+.PHONY: all build run gotool install clean help
+
+NAME=openim-rpc-third
+BIN_DIR=../../../bin/
+
+OS:= $(or $(os),linux)
+ARCH:=$(or $(arch),amd64)
+all: gotool build
+
+ifeq ($(OS),windows)
+
+BINARY_NAME=${NAME}.exe
+
+else
+
+BINARY_NAME=${NAME}
+
+endif
+
+build:
+	CGO_ENABLED=0 GOOS=${OS} GOARCH=${ARCH}; go build -ldflags="-w -s" -o ${BINARY_NAME}
+
+run:
+	@go run ./
+
+gotool:
+	go fmt ./
+	go vet ./
+
+install:build
+	mv ${BINARY_NAME} ${BIN_DIR}
+
+clean:
+	@if [ -f ${BINARY_NAME} ] ; then rm ${BINARY_NAME} ; fi

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

@@ -0,0 +1,32 @@
+# Copyright © 2023 OpenIM. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+FROM ubuntu
+
+WORKDIR /Open-IM-Server/bin
+
+RUN apt-get update && apt-get install apt-transport-https && apt-get install procps\
+&&apt-get install net-tools
+#Non-interactive operation
+ENV DEBIAN_FRONTEND=noninteractive
+RUN apt-get install -y vim curl tzdata gawk
+#Time zone adjusted to East eighth District
+RUN ln -fs /usr/share/zoneinfo/Asia/Shanghai /etc/localtime && dpkg-reconfigure -f noninteractive tzdata
+RUN apt-get -qq update \
+    && apt-get -qq install -y --no-install-recommends ca-certificates curl
+COPY ./openim-rpc-third ./
+
+VOLUME ["/Open-IM-Server/logs","/Open-IM-Server/config"]
+
+CMD ["./openim-rpc-third", "--port", "10200"]

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

@@ -0,0 +1,33 @@
+// 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 main
+
+import (
+	"github.com/OpenIMSDK/Open-IM-Server/internal/rpc/third"
+	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/cmd"
+	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/config"
+)
+
+func main() {
+	rpcCmd := cmd.NewRpcCmd("third")
+	rpcCmd.AddPortFlag()
+	rpcCmd.AddPrometheusPortFlag()
+	if err := rpcCmd.Exec(); err != nil {
+		panic(err.Error())
+	}
+	if err := rpcCmd.StartSvr(config.Config.RpcRegisterName.OpenImThirdName, third.Start); err != nil {
+		panic(err.Error())
+	}
+}

cmd/openim-rpc/openim-rpc-user/Makefile

@@ -0,0 +1,34 @@
+.PHONY: all build run gotool install clean help
+
+NAME=openim-rpc-user
+BIN_DIR=../../../bin/
+
+OS:= $(or $(os),linux)
+ARCH:=$(or $(arch),amd64)
+all: gotool build
+
+ifeq ($(OS),windows)
+
+BINARY_NAME=${NAME}.exe
+
+else
+
+BINARY_NAME=${NAME}
+
+endif
+
+build:
+	CGO_ENABLED=0 GOOS=${OS} GOARCH=${ARCH}; go build -ldflags="-w -s" -o ${BINARY_NAME}
+
+run:
+	@go run ./
+
+gotool:
+	go fmt ./
+	go vet ./
+
+install:build
+	mv ${BINARY_NAME} ${BIN_DIR}
+
+clean:
+	@if [ -f ${BINARY_NAME} ] ; then rm ${BINARY_NAME} ; fi

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

@@ -0,0 +1,32 @@
+# Copyright © 2023 OpenIM. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+FROM ubuntu
+
+WORKDIR /Open-IM-Server/bin
+
+RUN apt-get update && apt-get install apt-transport-https && apt-get install procps\
+&&apt-get install net-tools
+#Non-interactive operation
+ENV DEBIAN_FRONTEND=noninteractive
+RUN apt-get install -y vim curl tzdata gawk
+#Time zone adjusted to East eighth District
+RUN ln -fs /usr/share/zoneinfo/Asia/Shanghai /etc/localtime && dpkg-reconfigure -f noninteractive tzdata
+RUN apt-get -qq update \
+    && apt-get -qq install -y --no-install-recommends ca-certificates curl
+COPY ./openim-rpc-user ./
+
+VOLUME ["/Open-IM-Server/logs","/Open-IM-Server/config"]
+
+CMD ["./openim-rpc-user", "--port", "10110"]

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

@@ -0,0 +1,33 @@
+// 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 main
+
+import (
+	"github.com/OpenIMSDK/Open-IM-Server/internal/rpc/user"
+	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/cmd"
+	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/config"
+)
+
+func main() {
+	rpcCmd := cmd.NewRpcCmd("user")
+	rpcCmd.AddPortFlag()
+	rpcCmd.AddPrometheusPortFlag()
+	if err := rpcCmd.Exec(); err != nil {
+		panic(err.Error())
+	}
+	if err := rpcCmd.StartSvr(config.Config.RpcRegisterName.OpenImUserName, user.Start); err != nil {
+		panic(err.Error())
+	}
+}

cmd/push/deploy.Dockerfile

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

cmd/push/main.go

@@ -1,19 +0,0 @@
-package main
-
-import (
-	"github.com/OpenIMSDK/Open-IM-Server/internal/push"
-	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/cmd"
-	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/config"
-)
-
-func main() {
-	pushCmd := cmd.NewRpcCmd("push")
-	pushCmd.AddPortFlag()
-	pushCmd.AddPrometheusPortFlag()
-	if err := pushCmd.Exec(); err != nil {
-		panic(err.Error())
-	}
-	if err := pushCmd.StartSvr(config.Config.RpcRegisterName.OpenImPushName, push.Start); err != nil {
-		panic(err.Error())
-	}
-}

cmd/rpc/auth/deploy.Dockerfile

@@ -1,18 +0,0 @@
-FROM ubuntu
-
-WORKDIR /Open-IM-Server/bin
-
-RUN apt-get update && apt-get install apt-transport-https && apt-get install procps\
-&&apt-get install net-tools
-#Non-interactive operation
-ENV DEBIAN_FRONTEND=noninteractive
-RUN apt-get install -y vim curl tzdata gawk
-#Time zone adjusted to East eighth District
-RUN ln -fs /usr/share/zoneinfo/Asia/Shanghai /etc/localtime && dpkg-reconfigure -f noninteractive tzdata
-RUN apt-get -qq update \
-    && apt-get -qq install -y --no-install-recommends ca-certificates curl
-COPY ./open_im_auth ./
-
-VOLUME ["/Open-IM-Server/logs","/Open-IM-Server/config"]
-
-CMD ["./open_im_auth", "--port", "10160"]

cmd/rpc/auth/main.go

@@ -1,19 +0,0 @@
-package main
-
-import (
-	"github.com/OpenIMSDK/Open-IM-Server/internal/rpc/auth"
-	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/cmd"
-	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/config"
-)
-
-func main() {
-	authCmd := cmd.NewRpcCmd("auth")
-	authCmd.AddPortFlag()
-	authCmd.AddPrometheusPortFlag()
-	if err := authCmd.Exec(); err != nil {
-		panic(err.Error())
-	}
-	if err := authCmd.StartSvr(config.Config.RpcRegisterName.OpenImAuthName, auth.Start); err != nil {
-		panic(err.Error())
-	}
-}

cmd/rpc/conversation/deploy.Dockerfile

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

cmd/rpc/conversation/main.go

@@ -1,19 +0,0 @@
-package main
-
-import (
-	"github.com/OpenIMSDK/Open-IM-Server/internal/rpc/conversation"
-	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/cmd"
-	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/config"
-)
-
-func main() {
-	rpcCmd := cmd.NewRpcCmd("conversation")
-	rpcCmd.AddPortFlag()
-	rpcCmd.AddPrometheusPortFlag()
-	if err := rpcCmd.Exec(); err != nil {
-		panic(err.Error())
-	}
-	if err := rpcCmd.StartSvr(config.Config.RpcRegisterName.OpenImConversationName, conversation.Start); err != nil {
-		panic(err.Error())
-	}
-}

cmd/rpc/friend/deploy.Dockerfile

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

cmd/rpc/friend/main.go

@@ -1,19 +0,0 @@
-package main
-
-import (
-	"github.com/OpenIMSDK/Open-IM-Server/internal/rpc/friend"
-	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/cmd"
-	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/config"
-)
-
-func main() {
-	rpcCmd := cmd.NewRpcCmd("friend")
-	rpcCmd.AddPortFlag()
-	rpcCmd.AddPrometheusPortFlag()
-	if err := rpcCmd.Exec(); err != nil {
-		panic(err.Error())
-	}
-	if err := rpcCmd.StartSvr(config.Config.RpcRegisterName.OpenImFriendName, friend.Start); err != nil {
-		panic(err.Error())
-	}
-}

cmd/rpc/group/Makefile

@@ -1,39 +0,0 @@
-.PHONY: all build run gotool install clean help
-
-NAME=open_im_group
-BIN_DIR=../../../bin/
-
-OS:= $(or $(os),linux)
-ARCH:=$(or $(arch),amd64)
-all: gotool build
-
-ifeq ($(OS),windows)
-
-BINARY_NAME=${NAME}.exe
-
-else
-
-BINARY_NAME=${NAME}
-
-endif
-
-build:
-	CGO_ENABLED=0 GOOS=${OS} GOARCH=${ARCH}; go build -ldflags="-w -s" -o ${BINARY_NAME}
-
-run:
-	@go run ./
-
-gotool:
-	go fmt ./
-	go vet ./
-
-install:build
-	mv ${BINARY_NAME} ${BIN_DIR}
-
-clean:
-	@if [ -f ${BINARY_NAME} ] ; then rm ${BINARY_NAME} ; fi
-
-
-
-
-

cmd/rpc/group/deploy.Dockerfile

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

cmd/rpc/group/main.go

@@ -1,19 +0,0 @@
-package main
-
-import (
-	"github.com/OpenIMSDK/Open-IM-Server/internal/rpc/group"
-	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/cmd"
-	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/config"
-)
-
-func main() {
-	rpcCmd := cmd.NewRpcCmd("group")
-	rpcCmd.AddPortFlag()
-	rpcCmd.AddPrometheusPortFlag()
-	if err := rpcCmd.Exec(); err != nil {
-		panic(err.Error())
-	}
-	if err := rpcCmd.StartSvr(config.Config.RpcRegisterName.OpenImGroupName, group.Start); err != nil {
-		panic(err.Error())
-	}
-}

cmd/rpc/msg/deploy.Dockerfile

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

cmd/rpc/msg/main.go

@@ -1,19 +0,0 @@
-package main
-
-import (
-	"github.com/OpenIMSDK/Open-IM-Server/internal/rpc/msg"
-	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/cmd"
-	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/config"
-)
-
-func main() {
-	rpcCmd := cmd.NewRpcCmd("msg")
-	rpcCmd.AddPortFlag()
-	rpcCmd.AddPrometheusPortFlag()
-	if err := rpcCmd.Exec(); err != nil {
-		panic(err.Error())
-	}
-	if err := rpcCmd.StartSvr(config.Config.RpcRegisterName.OpenImMsgName, msg.Start); err != nil {
-		panic(err.Error())
-	}
-}

cmd/rpc/third/Makefile

@@ -1,39 +0,0 @@
-.PHONY: all build run gotool install clean help
-
-NAME=open_im_third
-BIN_DIR=../../../bin/
-
-OS:= $(or $(os),linux)
-ARCH:=$(or $(arch),amd64)
-all: gotool build
-
-ifeq ($(OS),windows)
-
-BINARY_NAME=${NAME}.exe
-
-else
-
-BINARY_NAME=${NAME}
-
-endif
-
-build:
-	CGO_ENABLED=0 GOOS=${OS} GOARCH=${ARCH}; go build -ldflags="-w -s" -o ${BINARY_NAME}
-
-run:
-	@go run ./
-
-gotool:
-	go fmt ./
-	go vet ./
-
-install:build
-	mv ${BINARY_NAME} ${BIN_DIR}
-
-clean:
-	@if [ -f ${BINARY_NAME} ] ; then rm ${BINARY_NAME} ; fi
-
-
-
-
-

cmd/rpc/third/deploy.Dockerfile

@@ -1,18 +0,0 @@
-FROM ubuntu
-
-WORKDIR /Open-IM-Server/bin
-
-RUN apt-get update && apt-get install apt-transport-https && apt-get install procps\
-&&apt-get install net-tools
-#Non-interactive operation
-ENV DEBIAN_FRONTEND=noninteractive
-RUN apt-get install -y vim curl tzdata gawk
-#Time zone adjusted to East eighth District
-RUN ln -fs /usr/share/zoneinfo/Asia/Shanghai /etc/localtime && dpkg-reconfigure -f noninteractive tzdata
-RUN apt-get -qq update \
-    && apt-get -qq install -y --no-install-recommends ca-certificates curl
-COPY ./open_im_third ./
-
-VOLUME ["/Open-IM-Server/logs","/Open-IM-Server/config"]
-
-CMD ["./open_im_third", "--port", "10200"]

cmd/rpc/third/main.go

@@ -1,19 +0,0 @@
-package main
-
-import (
-	"github.com/OpenIMSDK/Open-IM-Server/internal/rpc/third"
-	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/cmd"
-	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/config"
-)
-
-func main() {
-	rpcCmd := cmd.NewRpcCmd("third")
-	rpcCmd.AddPortFlag()
-	rpcCmd.AddPrometheusPortFlag()
-	if err := rpcCmd.Exec(); err != nil {
-		panic(err.Error())
-	}
-	if err := rpcCmd.StartSvr(config.Config.RpcRegisterName.OpenImThirdName, third.Start); err != nil {
-		panic(err.Error())
-	}
-}

cmd/rpc/user/deploy.Dockerfile

@@ -1,18 +0,0 @@
-FROM ubuntu
-
-WORKDIR /Open-IM-Server/bin
-
-RUN apt-get update && apt-get install apt-transport-https && apt-get install procps\
-&&apt-get install net-tools
-#Non-interactive operation
-ENV DEBIAN_FRONTEND=noninteractive
-RUN apt-get install -y vim curl tzdata gawk
-#Time zone adjusted to East eighth District
-RUN ln -fs /usr/share/zoneinfo/Asia/Shanghai /etc/localtime && dpkg-reconfigure -f noninteractive tzdata
-RUN apt-get -qq update \
-    && apt-get -qq install -y --no-install-recommends ca-certificates curl
-COPY ./open_im_user ./
-
-VOLUME ["/Open-IM-Server/logs","/Open-IM-Server/config"]
-
-CMD ["./open_im_user", "--port", "10110"]

cmd/rpc/user/main.go

@@ -1,19 +0,0 @@
-package main
-
-import (
-	"github.com/OpenIMSDK/Open-IM-Server/internal/rpc/user"
-	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/cmd"
-	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/config"
-)
-
-func main() {
-	rpcCmd := cmd.NewRpcCmd("user")
-	rpcCmd.AddPortFlag()
-	rpcCmd.AddPrometheusPortFlag()
-	if err := rpcCmd.Exec(); err != nil {
-		panic(err.Error())
-	}
-	if err := rpcCmd.StartSvr(config.Config.RpcRegisterName.OpenImUserName, user.Start); err != nil {
-		panic(err.Error())
-	}
-}

config/config.yaml

@@ -1,3 +1,17 @@
+# Copyright © 2023 OpenIM. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
 #OpenIM config
 
 
@@ -260,5 +274,4 @@ prometheus: #prometheus每个服务的端口数量需要和rpcPort保持对应
   conversationPrometheusPort: [ 20230 ]
   rtcPrometheusPort: [ 21300 ]
   thirdPrometheusPort: [ 21301 ]
-  messageTransferPrometheusPort: [ 21400, 21401, 21402, 21403 ] #端口数量需要和script/path_info.cfg中的msg_transfer_service_num保持一致
+  messageTransferPrometheusPort: [ 21400, 21401, 21402, 21403 ] #端口数量需要和script/path_info.sh中的msg_transfer_service_num保持一致
-

config/notification.yaml

@@ -1,3 +1,17 @@
+# Copyright © 2023 OpenIM. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
 groupCreated:
   isSendMsg: true #是否发送消息，false不发消息为无声的触发同步。true发消息需要触发会话，rpc notification直接发两次，一次消息一次通知, options字段isNotification是否为通知
   reliabilityLevel: 1 # 1为online才发送 2为必达

deployments/README.md

@@ -0,0 +1,26 @@
+# OpenIM 应用容器化部署指南
+
+OpenIM 支持很多种集群化部署方式，包括但不限于 helm, sealos, kubeam, kubesphere, kubeflow, kuboard, kubespray, k3s, k3d, k3c, k3sup, k3v, k3x
+
+### 依赖检查
+
+```bash
+Kubernetes: >= 1.16.0-0
+Helm: >= 3.0
+```
+
+假设 OpenIM 项目根目录路径为 `OpenIM_ROOT`
+
+进入 OpenIM 项目根目录
+
+$ cd ${OpenIM_ROOT}
+
+
+
+### 容器化安装
+
+具体安装步骤如下：
+
+
+
+### Helm安装

docker-compose.yaml

@@ -99,9 +99,9 @@ services:
     command: minio server /data --console-address ':9090'
 
 
-  open_im_server:
+  openim_server:
-    image: openim/open_im_server:v3.0.1
+    image: openim/openim_server:v3.0.1
-    container_name: open_im_server
+    container_name: openim_server
     volumes:
       - ./logs:/Open-IM-Server/logs
       - ./config/config.yaml:/Open-IM-Server/config/config.yaml
@@ -131,7 +131,7 @@ services:
       - mongodb
       - redis
       - minio
-      - open_im_server
+      - openim_server
     network_mode: "host"
     logging:
       driver: json-file
@@ -147,7 +147,7 @@ services:
     #    ports:
     #    - 9091:9091
     depends_on:
-      - open_im_server
+    - openim_server
     command: --web.listen-address=:9091 --config.file="/etc/prometheus/prometheus.yml"
     network_mode: "host"
 

docs/.generated_docs

@@ -0,0 +1,84 @@
+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
+docs/guide/en-US/cmd/openim/openim_info.md
+docs/guide/en-US/cmd/openim/openim_jwt.md
+docs/guide/en-US/cmd/openim/openim_jwt_show.md
+docs/guide/en-US/cmd/openim/openim_jwt_sign.md
+docs/guide/en-US/cmd/openim/openim_jwt_verify.md
+docs/guide/en-US/cmd/openim/openim_new.md
+docs/guide/en-US/cmd/openim/openim_options.md
+docs/guide/en-US/cmd/openim/openim_policy.md
+docs/guide/en-US/cmd/openim/openim_policy_create.md
+docs/guide/en-US/cmd/openim/openim_policy_delete.md
+docs/guide/en-US/cmd/openim/openim_policy_get.md
+docs/guide/en-US/cmd/openim/openim_policy_list.md
+docs/guide/en-US/cmd/openim/openim_policy_update.md
+docs/guide/en-US/cmd/openim/openim_secret.md
+docs/guide/en-US/cmd/openim/openim_secret_create.md
+docs/guide/en-US/cmd/openim/openim_secret_delete.md
+docs/guide/en-US/cmd/openim/openim_secret_get.md
+docs/guide/en-US/cmd/openim/openim_secret_list.md
+docs/guide/en-US/cmd/openim/openim_secret_update.md
+docs/guide/en-US/cmd/openim/openim_set.md
+docs/guide/en-US/cmd/openim/openim-rpc-user.md
+docs/guide/en-US/cmd/openim/openim-rpc-user_create.md
+docs/guide/en-US/cmd/openim/openim-rpc-user_delete.md
+docs/guide/en-US/cmd/openim/openim-rpc-user_get.md
+docs/guide/en-US/cmd/openim/openim-rpc-user_list.md
+docs/guide/en-US/cmd/openim/openim-rpc-user_update.md
+docs/guide/en-US/cmd/openim/openim_validate.md
+docs/guide/en-US/cmd/openim/openim_version.md
+docs/guide/en-US/yaml/openim/openim.yaml
+docs/guide/en-US/yaml/openim/openim_color.yaml
+docs/guide/en-US/yaml/openim/openim_completion.yaml
+docs/guide/en-US/yaml/openim/openim_info.yaml
+docs/guide/en-US/yaml/openim/openim_jwt.yaml
+docs/guide/en-US/yaml/openim/openim_new.yaml
+docs/guide/en-US/yaml/openim/openim_options.yaml
+docs/guide/en-US/yaml/openim/openim_policy.yaml
+docs/guide/en-US/yaml/openim/openim_secret.yaml
+docs/guide/en-US/yaml/openim/openim_set.yaml
+docs/guide/en-US/yaml/openim/openim-rpc-user.yaml
+docs/guide/en-US/yaml/openim/openim_validate.yaml
+docs/guide/en-US/yaml/openim/openim_version.yaml
+docs/man/man1/iam-apiserver.1
+docs/man/man1/iam-authz-server.1
+docs/man/man1/iam-pump.1
+docs/man/man1/iam-watcher.1
+docs/man/man1/openim-color.1
+docs/man/man1/openim-completion.1
+docs/man/man1/openim-info.1
+docs/man/man1/openim-jwt-show.1
+docs/man/man1/openim-jwt-sign.1
+docs/man/man1/openim-jwt-verify.1
+docs/man/man1/openim-jwt.1
+docs/man/man1/openim-new.1
+docs/man/man1/openim-options.1
+docs/man/man1/openim-policy-create.1
+docs/man/man1/openim-policy-delete.1
+docs/man/man1/openim-policy-get.1
+docs/man/man1/openim-policy-list.1
+docs/man/man1/openim-policy-update.1
+docs/man/man1/openim-policy.1
+docs/man/man1/openim-secret-create.1
+docs/man/man1/openim-secret-delete.1
+docs/man/man1/openim-secret-get.1
+docs/man/man1/openim-secret-list.1
+docs/man/man1/openim-secret-update.1
+docs/man/man1/openim-secret.1
+docs/man/man1/openim-set.1
+docs/man/man1/openim-user-create.1
+docs/man/man1/openim-user-delete.1
+docs/man/man1/openim-user-get.1
+docs/man/man1/openim-user-list.1
+docs/man/man1/openim-user-update.1
+docs/man/man1/openim-user.1
+docs/man/man1/openim-validate.1
+docs/man/man1/openim-version.1
+docs/man/man1/openim.1

docs/CODEOWNERS

@@ -0,0 +1,88 @@
+# This is a comment.
+# Each line is a file pattern followed by one or more owners.
+
+# README files
+README.md @cubxxw @kubbot @Bloomingg @FGadvancer @hrxiang @Oliver-WJ @skiffer-git @std-s @wangchuxiao-dev @withchao
+
+# Contributing guidelines
+CONTRIBUTING.md @cubxxw @kubbot @Bloomingg @FGadvancer @hrxiang @Oliver-WJ @skiffer-git @std-s @wangchuxiao-dev @withchao
+
+# License files
+LICENSE    @cubxxw @kubbot @Bloomingg @FGadvancer @hrxiang @Oliver-WJ @skiffer-git @std-s @wangchuxiao-dev @withchao
+
+# Makefile
+Makefile    @cubxxw @kubbot @Bloomingg @FGadvancer @hrxiang @Oliver-WJ @skiffer-git @std-s @wangchuxiao-dev @withchao
+
+# These owners will be the default owners for everything in
+# the repo. Unless a later match takes precedence,
+# @cubxxw and @kubbot will be requested for
+# review when someone opens a pull request.
+* @cubxxw @kubbot @Bloomingg @FGadvancer @hrxiang @Oliver-WJ @skiffer-git @std-s @wangchuxiao-dev @withchao
+
+# Order is important; the last matching pattern takes the most
+# precedence. When someone opens a pull request that only
+# modifies JS files, only @js-owner and not the global
+# owner(s) will be requested for a review.
+*.js   @cubxxw @kubbot @Bloomingg @FGadvancer @hrxiang @Oliver-WJ @skiffer-git @std-s @wangchuxiao-dev @withchao
+
+# You can also use email addresses if you prefer. They'll be
+# used to look up users just like we do for commit author
+# emails.
+*.go 3293172751nss@gmail.com 
+*.py 3293172751nss@gmail.com 
+
+# Teams can be specified as code owners as well. Teams should
+# be identified in the format @org/team-name. Teams must have
+# explicit write access to the repository. In this example,
+# the OpenIMSDK team in the github organization owns all .txt files.
+*.txt @cubxxw @kubbot @Bloomingg @FGadvancer @hrxiang @Oliver-WJ @skiffer-git @std-s @wangchuxiao-dev @withchao
+
+# The `docs/*` pattern will match files like
+# `docs/getting-started.md` but not further nested files like
+# `docs/build-app/troubleshooting.md`.
+docs/*  3293172751nss@gmail.com @kubbot @skiffer-git
+
+# In this example, @octocat owns any file in an apps directory
+# anywhere in your repository.
+api/ @cubxxw @IRONICBo @skiffer-git
+
+# This is a comment.
+# Each line is a file pattern followed by one or more owners.
+
+# CHANGELOG file
+CHANGELOG/*    @cubxxw @skiffer-git
+
+# _output directory
+_output/*    @skiffer-git
+
+# bin directory
+bin/*    @skiffer-git @FGadvancer
+
+# cmd directory
+cmd/* 
+
+# config directory
+config/*    @skiffer-git
+
+# db directory
+db/sdk    @77caleb @BanTanger @cubxxw @Gordon  
+
+# internal directory
+internal/ @skiffer-git @FGadvancer
+
+# logs directory
+logs/*    @skiffer-git @FGadvancer
+
+# pkg directory
+pkg/a2r    @skiffer-git
+
+# scripts directory
+scripts/LICENSE/*   @cubxxw @skiffer-git @FGadvancer
+scripts/enterprise/*  @FGadvancer @cubxxw @skiffer-git @kubbot
+scripts/githooks/*    @cubxxw @skiffer-git @FGadvancer
+scripts/lib/*    @FGadvancer @cubxxw @skiffer-git @kubbot
+scripts/make-rules/* @FGadvancer @cubxxw @skiffer-git @kubbot
+
+# test directory
+test/mongo    @FGadvancer @cubxxw @skiffer-git @kubbot
+test/mysql    @FGadvancer @cubxxw @skiffer-git @kubbot

docs/contrib/cicd-actions.md

@@ -0,0 +1,129 @@
+# Continuous Integration and Automation
+
+Every change on the OpenIM repository, either made through a pull request or direct push, triggers the continuous integration pipelines defined within the same repository. Needless to say, all the OpenIM contributions can be merged until all the checks pass (AKA having green builds).
+
+- [Continuous Integration and Automation](#continuous-integration-and-automation)
+  - [CI Platforms](#ci-platforms)
+    - [GitHub Actions](#github-actions)
+  - [Running locally](#running-locally)
+
+## CI Platforms
+
+Currently, there are two different platforms involved in running the CI processes:
+
+- GitHub actions
+- Drone pipelines on CNCF infrastructure
+
+### GitHub Actions
+
+All the existing GitHub Actions are defined as YAML files under the `.github/workflows` directory. These can be grouped into:
+
+- **PR Checks**. These actions run all the required validations upon PR creation and update. Covering the DCO compliance check, `x86_64` test batteries (unit, integration, smoke), and code coverage.
+- **Repository automation**. Currently, it only covers issues and epic grooming.
+
+Everything runs on GitHub's provided runners; thus, the tests are limited to run in `x86_64` architectures.
+
+
+## Running locally
+
+A contributor should verify their changes locally to speed up the pull request process. Fortunately, all the CI steps can be on local environments, except for the publishing ones, through either of the following methods:
+
+**User Makefile:**
+```bash
+root@PS2023EVRHNCXG:~/workspaces/openim/Open-IM-Server# make help 😊
+
+Usage: make <TARGETS> <OPTIONS> ...
+
+Targets:
+
+all                          Run tidy, gen, add-copyright, format, lint, cover, build 🚀
+build                        Build binaries by default 🛠️
+multiarch                    Build binaries for multiple platforms. See option PLATFORMS. 🌍
+tidy                         tidy go.mod ✨
+vendor                       vendor go.mod 📦
+style                        code style -> fmt,vet,lint 💅
+fmt                          Run go fmt against code. ✨
+vet                          Run go vet against code. ✅
+lint                         Check syntax and styling of go sources. ✔️
+format                       Gofmt (reformat) package sources (exclude vendor dir if existed). 🔄
+test                         Run unit test. 🧪
+cover                        Run unit test and get test coverage. 📊
+updates                      Check for updates to go.mod dependencies 🆕
+imports                      task to automatically handle import packages in Go files using goimports tool 📥
+clean                        Remove all files that are created by building. 🗑️
+image                        Build docker images for host arch. 🐳
+image.multiarch              Build docker images for multiple platforms. See option PLATFORMS. 🌍🐳
+push                         Build docker images for host arch and push images to registry. 📤🐳
+push.multiarch               Build docker images for multiple platforms and push images to registry. 🌍📤🐳
+tools                        Install dependent tools. 🧰
+gen                          Generate all necessary files. 🧩
+swagger                      Generate swagger document. 📖
+serve-swagger                Serve swagger spec and docs. 🚀📚
+verify-copyright             Verify the license headers for all files. ✅
+add-copyright                Add copyright ensure source code files have license headers. 📄
+release                      release the project 🎉
+help                         Show this help info. ℹ️
+help-all                     Show all help details info. ℹ️📚
+
+Options:
+
+DEBUG            Whether or not to generate debug symbols. Default is 0. ❓
+
+BINS             Binaries to build. Default is all binaries under cmd. 🛠️
+This option is available when using: make {build}(.multiarch) 🧰
+Example: make build BINS="openim-api openim_cms_api".
+
+PLATFORMS        Platform to build for. Default is linux_arm64 and linux_amd64. 🌍
+This option is available when using: make {build}.multiarch 🌍
+Example: make multiarch PLATFORMS="linux_s390x linux_mips64
+linux_mips64le darwin_amd64 windows_amd64 linux_amd64 linux_arm64".
+
+V                Set to 1 enable verbose build. Default is 0. 📝
+```
+
+
+How to Use Makefile to Help Contributors Build Projects Quickly 😊
+
+The `make help` command is a handy tool that provides useful information on how to utilize the Makefile effectively. By running this command, contributors will gain insights into various targets and options available for building projects swiftly.
+
+Here's a breakdown of the targets and options provided by the Makefile:
+
+**Targets 😃**
+
+1. `all`: This target runs multiple tasks like `tidy`, `gen`, `add-copyright`, `format`, `lint`, `cover`, and `build`. It ensures comprehensive project building.
+2. `build`: The primary target that compiles binaries by default. It is particularly useful for creating the necessary executable files.
+3. `multiarch`: A target that builds binaries for multiple platforms. Contributors can specify the desired platforms using the `PLATFORMS` option.
+4. `tidy`: This target cleans up the `go.mod` file, ensuring its consistency.
+5. `vendor`: A target that updates the project dependencies based on the `go.mod` file.
+6. `style`: Checks the code style using tools like `fmt`, `vet`, and `lint`. It ensures a consistent coding style throughout the project.
+7. `fmt`: Formats the code using the `go fmt` command, ensuring proper indentation and formatting.
+8. `vet`: Runs the `go vet` command to identify common errors in the code.
+9. `lint`: Validates the syntax and styling of Go source files using a linter.
+10. `format`: Reformats the package sources using `gofmt`. It excludes the vendor directory if it exists.
+11. `test`: Executes unit tests to ensure the functionality and stability of the code.
+12. `cover`: Performs unit tests and calculates the test coverage of the code.
+13. `updates`: Checks for updates to the project's dependencies specified in the `go.mod` file.
+14. `imports`: Automatically handles import packages in Go files using the `goimports` tool.
+15. `clean`: Removes all files generated during the build process, effectively cleaning up the project directory.
+16. `image`: Builds Docker images for the host architecture.
+17. `image.multiarch`: Similar to the `image` target, but it builds Docker images for multiple platforms. Contributors can specify the desired platforms using the `PLATFORMS` option.
+18. `push`: Builds Docker images for the host architecture and pushes them to a registry.
+19. `push.multiarch`: Builds Docker images for multiple platforms and pushes them to a registry. Contributors can specify the desired platforms using the `PLATFORMS` option.
+20. `tools`: Installs the necessary tools or dependencies required by the project.
+21. `gen`: Generates all the required files automatically.
+22. `swagger`: Generates the swagger document for the project.
+23. `serve-swagger`: Serves the swagger specification and documentation.
+24. `verify-copyright`: Verifies the license headers for all project files.
+25. `add-copyright`: Adds copyright headers to the source code files.
+26. `release`: Releases the project, presumably for distribution.
+27. `help`: Displays information about available targets and options.
+28. `help-all`: Shows detailed information about all available targets and options.
+
+**Options 😄**
+
+1. `DEBUG`: A boolean option that determines whether or not to generate debug symbols. The default value is 0 (false).
+2. `BINS`: Specifies the binaries to build. By default, it builds all binaries under the `cmd` directory. Contributors can provide a list of specific binaries using this option.
+3. `PLATFORMS`: Specifies the platforms to build for. The default platforms are `linux_arm64` and `linux_amd64`. Contributors can specify multiple platforms by providing a space-separated list of platform names.
+4. `V`: A boolean option that enables verbose build output when set to 1 (true). The default value is 0 (false).
+
+With these targets and options in place, contributors can efficiently build projects using the Makefile. Happy coding! 🚀😊

docs/contrib/code_conventions.md

@@ -0,0 +1,38 @@
+# Code conventions
+
+- [Code conventions](#code-conventions)
+  - [POSIX shell](#posix-shell)
+  - [Go](#go)
+  - [Directory and file conventions](#directory-and-file-conventions)
+  - [Testing conventions](#testing-conventions)
+
+## POSIX shell
+
+- [Style guide](https://google.github.io/styleguide/shell.xml)
+
+## Go
+
+- [Go Code Review Comments](https://github.com/golang/go/wiki/CodeReviewComments)
+- [Effective Go](https://golang.org/doc/effective_go.html)
+- Know and avoid [Go landmines](https://gist.github.com/lavalamp/4bd23295a9f32706a48f)
+- Comment your code.
+  - [Go's commenting conventions](http://blog.golang.org/godoc-documenting-go-code)
+  - If reviewers ask questions about why the code is the way it is, that's a sign that comments might be helpful.
+- Command-line flags should use dashes, not underscores
+- Naming
+  - Please consider package name when selecting an interface name, and avoid redundancy. For example, `storage.Interface` is better than `storage.StorageInterface`.
+  - Do not use uppercase characters, underscores, or dashes in package names.
+  - Please consider parent directory name when choosing a package name. For example, `pkg/controllers/autoscaler/foo.go` should say `package autoscaler` not `package autoscalercontroller`.
+    - Unless there's a good reason, the `package foo` line should match the name of the directory in which the `.go` file exists.
+    - Importers can use a different name if they need to disambiguate.
+
+## Directory and file conventions
+
+- Avoid general utility packages. Packages called "util" are suspect. Instead, derive a name that describes your desired function. For example, the utility functions dealing with waiting for operations are in the `wait` package and include functionality like `Poll`. The full name is `wait.Poll`.
+- All filenames should be lowercase.
+- All source files and directories should use underscores, not dashes.
+  - Package directories should generally avoid using separators as much as possible. When package names are multiple words, they usually should be in nested subdirectories.
+
+## Testing conventions
+
+Please refer to [TESTING.md](../../tests/TESTING.md) document.