Merge pull request #2129 from cubxxw/automated-cherry-pick-of-#2128-upstream-release-v3.6

releasev3.6: Automated cherry pick of #2128 upstream release v3.6

.env

@@ -1,13 +0,0 @@
-
-MONGO_IMAGE=mongo:6.0.2
-REDIS_IMAGE=redis:7.0.0
-ZOOKEEPER_IMAGE=bitnami/zookeeper:3.8
-KAFKA_IMAGE=bitnami/kafka:3.5.1
-MINIO_IMAGE=minio/minio:RELEASE.2024-01-11T07-46-16Z
-
-
-OPENIM_WEB_FRONT_IMAGE=ghcr.io/openimsdk/openim-web:v3.5.0-docker
-OPENIM_ADMIN_FRONT_IMAGE=ghcr.io/openimsdk/openim-admin:toc-base-open-docker.35
-
-DATA_DIR=./
-

.github/code-language-detector.yml

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

.github/standardizer.yml

@@ -1,50 +0,0 @@
-# https://github.com/marketplace/actions/conformity-checker-for-project
-baseConfig:
-  searchDirectory: "./"
-  ignoreCase: false
-
-directoryNaming:
-  allowHyphens: true
-  allowUnderscores: false
-  mustBeLowercase: true
-
-fileNaming:
-  allowHyphens: true
-  allowUnderscores: true
-  mustBeLowercase: true
-
-ignoreFormats:
-  - "\\.log$"
-  - "\\.env$"
-  - "README\\.md$"
-  - "_test\\.go$"
-  - "\\.md$"
-  - _test\\.txt$
-  - LICENSE
-  - Dockerfile
-  - CODEOWNERS
-  - Makefile
-
-ignoreDirectories:
-  - "vendor"
-  - ".git"
-  - "deployments"
-  - "node_modules"
-  - "logs"
-  - "CHANGELOG"
-  - "components"
-  - "_output"
-  - "tools/openim-web"
-  - "CHANGELOG"
-  - "examples/Test_directory"
-  - test/testdata
-
-fileTypeSpecificNaming:
-  ".yaml":
-    allowHyphens: true
-    allowUnderscores: false
-    mustBeLowercase: true
-  ".go":
-    allowHyphens: false
-    allowUnderscores: true
-    mustBeLowercase: true

.github/workflows/bot-auto-cherry-pick.yml

@@ -25,7 +25,6 @@ jobs:
       - name: Comment cherry-pick command
         uses: actions/github-script@v7
         with:
-          github-token: ${{ secrets.BOT_GITHUB_TOKEN }}
           script: |
             const pr = context.payload.pull_request;
             if (!pr.merged) {
@@ -65,3 +64,4 @@ jobs:
               issue_number: pr.number,
               body: cherryPickCmd
             });
+          github-token: ${{ secrets.BOT_GITHUB_TOKEN }}

.github/workflows/bot-cherry-pick.yml

@@ -12,57 +12,23 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-name: Github Robot for Cherry Pick On Comment
-
+name: Github Rebot for Cherry Pick On Comment
 on:
   issue_comment:
     types: [created]
-
 jobs:
   cherry-pick:
     name: Cherry Pick
+    # && github.event.comment.user.login=='kubbot'
     if: github.event.issue.pull_request != '' && contains(github.event.comment.body, '/cherry-pick')
     runs-on: ubuntu-latest
-
     steps:
       - name: Checkout the latest code
         uses: actions/checkout@v4
         with:
           token: ${{ secrets.BOT_GITHUB_TOKEN }}
-          fetch-depth: 0 # To ensure all history is available for cherry-picking
-
+          fetch-depth: 0 # otherwise, you will fail to push refs to dest repo
       - name: Automatic Cherry Pick
         uses: vendoo/gha-cherry-pick@v1
-        with:
-          # Assuming the cherry-pick commit SHA is passed in the comment like '/cherry-pick sha'
-          commit-sha: ${{ github.event.comment.body }}
-        env:
-          GITHUB_TOKEN: ${{ secrets.BOT_GITHUB_TOKEN }}
-
-      - name: Create a new branch for PR
-        run: |
-          PR_BRANCH="cherry-pick-${GITHUB_SHA}-to-${{ github.base_ref }}"
-          git checkout -b $PR_BRANCH
-          git push origin $PR_BRANCH
-        env:
-          GITHUB_TOKEN: ${{ secrets.BOT_GITHUB_TOKEN }}
-
-      - name: Create Pull Request
-        uses: actions/github-script@v5
-        with:
-          script: |
-            const prTitle = "Cherry-pick to ${{ github.base_ref }}"
-            const prBody = "Automated cherry-pick of ${{ github.event.comment.body }}\n\n/cc @kubbot"
-            const base = "${{ github.base_ref }}"
-            const head = "cherry-pick-${{ github.sha }}-to-${{ github.base_ref }}"
-            const createPr = await github.rest.pulls.create({
-              owner: context.repo.owner,
-              repo: context.repo.repo,
-              title: prTitle,
-              body: prBody,
-              head: head,
-              base: base,
-              maintainer_can_modify: true, // Allows maintainers to edit the PR
-            })
         env:
           GITHUB_TOKEN: ${{ secrets.BOT_GITHUB_TOKEN }}

.github/workflows/code-language-detector.yml

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

.github/workflows/e2e-test.yml

@@ -12,7 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-name: OpenIM E2E And API Test
+name: OpenIM Linux System E2E Test
 
 on:
   workflow_dispatch:
@@ -82,7 +82,7 @@ jobs:
         sudo make tidy
         sudo make tools.verify.go-gitlint
 
-    - name: Build, Start(make build && make start)
+    - name: Build, Start
       run: |
         sudo ./scripts/install/install.sh -i
 
@@ -90,8 +90,9 @@ jobs:
       run: |
         sudo ./scripts/install/install.sh -s
 
-    - name: Exec OpenIM API test (make test-api)
+    - name: Exec OpenIM API test
       run: |
+        sudo make test-api
         mkdir -p ./tmp
         touch ./tmp/test.md
         echo "# OpenIM Test" >> ./tmp/test.md
@@ -102,10 +103,9 @@ jobs:
         echo "</code></pre>" >> ./tmp/test.md
         echo "</details>" >> ./tmp/test.md
 
-        sudo make test-api
-
-    - name: Exec OpenIM E2E Test (make test-e2e)
+    - name: Exec OpenIM E2E Test
       run: |
+        sudo make test-e2e
         echo "" >> ./tmp/test.md
         echo "## OpenIM E2E Test" >> ./tmp/test.md
         echo "<details><summary>Command Output for OpenIM E2E Test</summary>" >> ./tmp/test.md
@@ -114,8 +114,6 @@ jobs:
         echo "</code></pre>" >> ./tmp/test.md
         echo "</details>" >> ./tmp/test.md
 
-        sudo make test-e2e
-
     - name: Comment PR with file
       uses: thollander/actions-comment-pull-request@v2
       with:

.github/workflows/milestone.yml

@@ -41,7 +41,6 @@ jobs:
     steps:
       - uses: actions/github-script@v7 # v6
         with:
-          github-token: ${{ secrets.BOT_GITHUB_TOKEN }}
           script: |
             if (!context.payload.pull_request.merged) {
               console.log('PR was not merged, skipping.');
@@ -57,10 +56,9 @@ jobs:
               owner: context.repo.owner,
               repo: context.repo.repo,
               state: 'open',
-              sort: 'title',
-              direction: 'desc'
+              sort: 'due_on',
+              direction: 'asc'
             })
-
             if (milestones.data.length === 0) {
               console.log('There are no milestones, skipping.');
               return;

.github/workflows/openimci.yml

@@ -70,12 +70,6 @@ jobs:
         version: '3.x' # If available, use the latest major version that's compatible
         repo-token: ${{ secrets.GITHUB_TOKEN }}
 
-    - name: Code Typecheck Detector
-      uses: kubecub/typecheck@main
-
-    - name: Conformity Checker for Project
-      uses: kubecub/standardizer@main
-
     - name: Module Operations
       run: |
         sudo make tidy

.github/workflows/pull-request.yml

@@ -56,8 +56,7 @@ jobs:
 
       - name: Generate all necessary files, such as error code files
         run: |
-          make gen.docgo.doc
-          make gen
+          make generate
           echo "Generate all necessary files successfully"
         continue-on-error: true
 
@@ -69,9 +68,9 @@ jobs:
           echo "Generate all necessary files successfully"
         continue-on-error: true
 
-      - name: Generate Versions Including Pre-release Identifiers
+      - name: Generate Vertions
         run: |
-          latest_tag=$(git describe --tags `git rev-list --tags --max-count=1`)
+          latest_tag=$(git describe --tags `git rev-list --tags --max-count=1` | grep -oE '[0-9]+\.[0-9]+\.[0-9]+')
           echo $latest_tag > pkg/common/config/version
         continue-on-error: true
 

.gitignore

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

.golangci.yml

@@ -39,19 +39,19 @@ run:
   # from this option's value (see skip-dirs-use-default).
   # "/" will be replaced by current OS file path separator to properly work
   # on Windows.
-  # skip-dirs:
-  #   - components
-  #   - docs
-  #   - util
-  #   - .*~
-  #   - api/swagger/docs
-  #   - server/docs
-  #   - components/mnt/config/certs
-  #   - logs
+  skip-dirs:
+    - components
+    - docs
+    - util
+    - .*~
+    - api/swagger/docs
+    - server/docs
+    - components/mnt/config/certs
+    - logs
 
   # default is true. Enables skipping of directories:
   #   vendor$, third_party$, testdata$, examples$, Godeps$, builtin$
-  # skip-dirs-use-default: true
+  skip-dirs-use-default: true
 
   # which files to skip: they will be analyzed, but issues from them
   # won't be reported. Default value is empty list, but there is
@@ -59,15 +59,15 @@ run:
   # autogenerated files. If it's not please let us know.
   # "/" will be replaced by current OS file path separator to properly work
   # on Windows.
-  # skip-files:
-  #   - ".*\\.my\\.go$"
-  #   - _test.go
-  #   - ".*_test.go"
-  #   - "mocks/"
-  #   - ".github/"
-  #   - "logs/"
-  #   - "_output/"
-  #   - "components/"
+  skip-files:
+    - ".*\\.my\\.go$"
+    - _test.go
+    - ".*_test.go"
+    - "mocks/"
+    - ".github/"
+    - "logs/"
+    - "_output/"
+    - "components/"
 
   # by default isn't set. If set we pass it to "go list -mod={option}". From "go help modules":
   # If invoked with -mod=readonly, the go command is disallowed from the implicit
@@ -87,7 +87,7 @@ run:
 # output configuration options
 output:
   # colored-line-number|line-number|json|tab|checkstyle|code-climate, default is "colored-line-number"
-  # format: colored-line-number
+  format: colored-line-number
 
   # print lines of code with issue, default is true
   print-issued-lines: true
@@ -118,7 +118,8 @@ linters-settings:
     right-to-left-isolate: true
     first-strong-isolate: true
     pop-directional-isolate: true
-
+    # checks assignments with too many blank identifiers; default is 2
+    max-blank-identifiers: 2
   dupl:
     # tokens count to trigger issue, 150 by default
     threshold: 200
@@ -150,11 +151,6 @@ linters-settings:
     comparison: true
 
   exhaustive:
-    # Program elements to check for exhaustiveness.
-    # Default: [ switch ]
-    check:
-      - switch
-      - map
     # check switch statements in generated files also
     check-generated: false
     # indicates that switch statements are to be considered exhaustive if a
@@ -166,34 +162,33 @@ linters-settings:
     ignore-enum-members: ""
     # consider enums only in package scopes, not in inner scopes
     package-scope-only: false
+  exhaustivestruct:
+    struct-patterns:
+      - '*.Test'
+      - '*.Test2'
+      - '*.Embedded'
+      - '*.External'
 
-
-  forbidigo:
+  # forbidigo:
   #   # Forbid the following identifiers (identifiers are written using regexp):
-    forbid:
-      # - ^print.*$
-      - 'fmt\.Print.*'
-      - fmt.Println.* # too much log noise
-      - ^unsafe\..*$
-      - ^init$
-      - ^os.Exit$
-      - ^fmt.Print.*$
-      - errors.New.*$
-      - ^fmt.Println.*$
-      - ^panic$
-      - painc
+  #   forbid:
+  #     - ^print.*$
+  #     - 'fmt\.Print.*'
+  #     - fmt.Println.* # too much log noise
   #     - ginkgo\\.F.* # these are used just for local development
   #   # Exclude godoc examples from forbidigo checks.  Default is true.
   #   exclude_godoc_examples: false
-
   funlen:
-    lines: 220
+    lines: 150
     statements: 80
-
+  gci:
+    # put imports beginning with prefix after 3rd-party packages;
+    # only support one prefix
+    # if not set, use goimports.local-prefixes
+    prefix: github.com/openimsdk/open-im-server
   gocognit:
     # minimal code complexity to report, 30 by default (but we recommend 10-20)
     min-complexity: 30
-
   goconst:
     # minimal length of string constant, 3 by default
     min-len: 3
@@ -219,6 +214,9 @@ linters-settings:
     # By default list of stable checks is used.
     enabled-checks:
       #- rangeValCopy
+      - nestingreduce
+      - truncatecmp
+      - unnamedresult
       - ruleguard
 
     # Which checks should be disabled; can't be combined with 'enabled-checks'; default is empty
@@ -247,6 +245,9 @@ linters-settings:
       hugeParam:
         # size in bytes that makes the warning trigger (default 80)
         sizeThreshold: 80
+      nestingReduce:
+        # min number of statements inside a branch to trigger a warning (default 5)
+        bodyWidth: 5
       rangeExprCopy:
         # size in bytes that makes the warning trigger (default 512)
         sizeThreshold: 512
@@ -260,10 +261,15 @@ linters-settings:
       ruleguard:
         # path to a gorules file for the ruleguard checker
         rules: ''
+      truncateCmp:
+        # whether to skip int/uint/uintptr types (default true)
+        skipArchDependent: true
       underef:
         # whether to skip (*x).method() calls where x is a pointer receiver (default true)
         skipRecvDeref: true
-
+      unnamedResult:
+        # whether to check exported functions
+        checkExported: true
   gocyclo:
     # minimal code complexity to report, 30 by default (but we recommend 10-20)
     min-complexity: 30
@@ -280,12 +286,9 @@ linters-settings:
     # list of regexps for excluding particular comment lines from check
     exclude:
       # example: exclude comments which contain numbers
-      - '[0-9]+'
-      - 'func\s+\w+'
-      - 'FIXME:'
-      - '.*func.*'
+      # - '[0-9]+'
     # check that each sentence starts with a capital letter
-    capital: true
+    capital: false
   godox:
     # report any comments starting with keywords, this is useful for TODO or FIXME comments that
     # might be left in the code accidentally and should be resolved before merging
@@ -308,15 +311,15 @@ linters-settings:
     # by default
     extra-rules: false
 
-  # goheader:
-    # values:
-      # const:
+  goheader:
+    values:
+      const:
         # define here const type values in format k:v, for example:
         # COMPANY: MY COMPANY
-      # regexp:
+      regexp:
         # define here regexp type values, for example
         # AUTHOR: .*@mycompany\.com
-    # template: # |-
+    template: # |-
       # put here copyright header template for source code files, for example:
       # Note: {{ YEAR }} is a builtin value that returns the year relative to the current machine time.
       #
@@ -334,45 +337,21 @@ linters-settings:
       # 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.
-    # template-path:
+    template-path:
       # also as alternative of directive 'template' you may put the path to file with the template source
-
   goimports:
     # put imports beginning with prefix after 3rd-party packages;
     # it's a comma-separated list of prefixes
     local-prefixes: github.com/openimsdk/open-im-server
 
   gomnd:
-    # List of enabled checks, see https://github.com/tommy-muehle/go-mnd/#checks for description.
-    # Default: ["argument", "case", "condition", "operation", "return", "assign"]
-    checks:
-      - argument
-      - case
-      - condition
-      - operation
-      - return
-      - assign
-    # List of numbers to exclude from analysis.
-    # The numbers should be written as string.
-    # Values always ignored: "1", "1.0", "0" and "0.0"
-    # Default: []
-    ignored-numbers:
-      - '0666'
-      - '0755'
-      - '42'
-    # List of file patterns to exclude from analysis.
-    # Values always ignored: `.+_test.go`
-    # Default: []
-    ignored-files:
-      - 'magic1_.+\.go$'
-    # List of function patterns to exclude from analysis.
-    # Following functions are always ignored: `time.Date`,
-    # `strconv.FormatInt`, `strconv.FormatUint`, `strconv.FormatFloat`,
-    # `strconv.ParseInt`, `strconv.ParseUint`, `strconv.ParseFloat`.
-    # Default: []
-    ignored-functions:
-      - '^math\.'
-      - '^webhook\.StatusText$'
+    settings:
+      mnd:
+        # the list of enabled checks, see https://github.com/tommy-muehle/go-mnd/#checks for description.
+        checks: argument,case,condition,operation,return,assign
+        # ignored-numbers: 1000
+        # ignored-files: magic_.*.go
+        # ignored-functions: math.*
   gomoddirectives:
     # Allow local `replace` directives. Default is false.
     replace-local: true
@@ -384,7 +363,6 @@ linters-settings:
     retract-allow-no-explanation: false
     # Forbid the use of the `exclude` directives. Default is false.
     exclude-forbidden: false
-
   gomodguard:
     allowed:
       modules:    
@@ -448,6 +426,9 @@ linters-settings:
     checks: [ "all" ]
 
   govet:
+    # report about shadowed variables
+    check-shadowing: false
+
     # settings per analyzer
     settings:
       printf: # analyzer name, run `go tool vet help` to see all analyzers
@@ -464,25 +445,15 @@ linters-settings:
     disable:
       - shadow
     disable-all: false
+  # depguard:
+  #   list-type: blacklist
+  #   include-go-root: false
+  #   packages:
+  #     - github.com/Sirupsen/logrus
+  #   packages-with-error-message:
+  #     # specify an error message to output when a blacklisted package is used
+  #     - github.com/Sirupsen/logrus: "logging is allowed only by logutils.Log"
 
-  depguard:
-    rules:
-      prevent_unmaintained_packages:
-        list-mode: lax # allow unless explicitely denied
-        files:
-          - $all
-          - "!$test"
-        allow:
-          - $gostd
-        deny:
-          - pkg: io/ioutil
-            desc: "replaced by io and os packages since Go 1.16: https://tip.golang.org/doc/go1.16#ioutil"
-          - pkg: github.com/OpenIMSDK
-            desc: "The OpenIM organization has been replaced with lowercase, please do not use uppercase organization name, you will use openimsdk"
-          - pkg: log
-            desc: "We have a wrapped log package at openim, we recommend you to use our wrapped log package, https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/logging.md"
-          - pkg: errors
-            desc: "We have a wrapped errors package at openim, we recommend you to use our wrapped errors package, https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/error-code.md"
 
   importas:
     # if set to `true`, force to use alias.
@@ -492,8 +463,6 @@ linters-settings:
       # using `servingv1` alias for `knative.dev/serving/pkg/apis/serving/v1` package
       - pkg: knative.dev/serving/pkg/apis/serving/v1
         alias: servingv1
-      - pkg: gopkg.in/yaml.v2
-        alias: yaml
       # using `autoscalingv1alpha1` alias for `knative.dev/serving/pkg/apis/autoscaling/v1alpha1` package
       - pkg: knative.dev/serving/pkg/apis/autoscaling/v1alpha1
         alias: autoscalingv1alpha1
@@ -502,6 +471,8 @@ linters-settings:
       # see https://github.com/julz/importas#use-regular-expression for details
       - pkg: knative.dev/serving/pkg/apis/(\w+)/(v[\w\d]+)
         alias: $1$2
+    # using `jwt` alias for `github.com/appleboy/gin-jwt/v2` package
+    jwt: github.com/appleboy/gin-jwt/v2
 
   ireturn:
     # ireturn allows using `allow` and `reject` settings at the same time.
@@ -532,6 +503,9 @@ linters-settings:
     line-length: 250
     # tab width in spaces. Default to 1.
     tab-width: 4
+  maligned:
+    # print struct with more effective memory layout or not, false by default
+    suggest-new: true
   misspell:
     # Correct spellings using locale preferences for US or UK.
     # Default is to use a neutral variety of English.
@@ -564,6 +538,8 @@ linters-settings:
   nolintlint:
     # Disable to ensure that all nolint directives actually have an effect. Default is true.
     allow-unused: false
+    # Disable to ensure that nolint directives don't have a leading space. Default is true.
+    allow-leading-space: true
     # Exclude following linters from requiring an explanation.  Default is [].
     allow-no-explanation: [ ]
     # Enable to require an explanation of nonzero length after each nolint directive. Default is false.
@@ -587,13 +563,14 @@ linters-settings:
     strict: false
     # Please refer to https://github.com/yeya24/promlinter#usage for detailed usage.
     disabled-linters:
-     - "Help"
-     - "MetricUnits"
-     - "Counter"
-     - "HistogramSummaryReserved"
-     - "MetricTypeInName"
-     - "ReservedChars"
-     - "CamelCase"
+    #  - "Help"
+    #  - "MetricUnits"
+    #  - "Counter"
+    #  - "HistogramSummaryReserved"
+    #  - "MetricTypeInName"
+    #  - "ReservedChars"
+    #  - "CamelCase"
+    #  - "lintUnitAbbreviations"
     
   predeclared:
     # comma-separated list of predeclared identifiers to not report on
@@ -603,7 +580,6 @@ linters-settings:
   rowserrcheck:
     packages:
       - github.com/jmoiron/sqlx
-
   revive:
     # see https://github.com/mgechev/revive#available-rules for details.
     ignore-generated-header: true
@@ -611,27 +587,15 @@ linters-settings:
     rules:
       - name: indent-error-flow
         severity: warning
-      - name: exported
-        severity: warning
-      - name: var-naming
-        arguments: [ [ "OpenIM"] ]
-        # arguments: [ ["ID", "HTTP", "URL", "URI", "API", "APIKey", "Token", "TokenID", "TokenSecret", "TokenKey", "TokenSecret", "JWT", "JWTToken", "JWTTokenID", "JWTTokenSecret", "JWTTokenKey", "JWTTokenSecret", "OAuth", "OAuthToken", "RPC" ] ]
-      - name: atomic
-      - name: line-length-limit
-        severity: error
-        arguments: [200]
-      - name: unhandled-error
-        arguments : ["fmt.Printf", "myFunction"]
-
   staticcheck:
     # Select the Go version to target. The default is '1.13'.
-    go: "1.20"
+    go: "1.16"
     # https://staticcheck.io/docs/options#checks
     checks: [ "all" ]
 
   stylecheck:
     # Select the Go version to target. The default is '1.13'.
-    go: "1.20"
+    go: "1.16"
 
     # https://staticcheck.io/docs/options#checks
     checks: [ "all", "-ST1000", "-ST1003", "-ST1016", "-ST1020", "-ST1021", "-ST1022" ]
@@ -643,6 +607,7 @@ linters-settings:
     # https://staticcheck.io/docs/options#http_status_code_whitelist
     http-status-code-whitelist: [ "200", "400", "404", "500" ]
 
+
   tagliatelle:
     # check the struck tag name case
     case:
@@ -688,11 +653,12 @@ linters-settings:
     # if it's called for subdir of a project it can't find external interfaces. All text editor integrations
     # with golangci-lint call it on a directory with the changed file.
     check-exported: false
-  # unused:
+  unused:
     # treat code as a program (not a library) and report unused exported identifiers; default is false.
     # XXX: if you enable this setting, unused will report a lot of false-positives in text editors:
     # if it's called for subdir of a project it can't find funcs usages. All text editor integrations
     # with golangci-lint call it on a directory with the changed file.
+    check-exported: false
   whitespace:
     multi-if: false   # Enforces newlines (or comments) after every multi-line if statement
     multi-func: false # Enforces newlines (or comments) after every multi-line function signature
@@ -706,7 +672,6 @@ linters-settings:
       - errors.New(
       - errors.Unwrap(
       - .Wrap(
-      - .WrapMsg(
       - .Wrapf(
       - .WithMessage(
       - .WithMessagef(
@@ -714,8 +679,6 @@ linters-settings:
     ignorePackageGlobs:
         - encoding/*
         - github.com/pkg/*
-        - github.com/openimsdk/*
-        - github.com/OpenIMSDK/*
 
   wsl:
     # If true append is only allowed to be cuddled if appending value is
@@ -742,6 +705,7 @@ linters-settings:
     # Allow only slices initialized with a length of zero. Default is false.
     always: false
 
+
   # The custom section can be used to define linter plugins to be loaded at runtime. See README doc
   #  for more info.
   #custom:
@@ -767,26 +731,21 @@ linters:
     - errcheck
     - decorder
     - ineffassign
-    - forbidigo
     - revive
     - reassign
     - tparallel
     - unconvert
-    - fieldalignment
     - dupl
     - dupword
     - errname
     - gci
-    - exhaustive
-    - gocritic
+    - goheader
     - goprintffuncname
-    - gomnd
-    - goconst
     - gosec
     - misspell      # Spelling mistakes
     - staticcheck   # Static analysis
     - unused        # Checks for unused code
-    # - goimports     # Checks if imports are correctly sorted and formatted
+    - goimports     # Checks if imports are correctly sorted and formatted
     - godot         # Checks for comment punctuation
     - bodyclose     # Ensures HTTP response body is closed
     - stylecheck    # Style checker for Go code
@@ -802,7 +761,6 @@ issues:
   exclude:
     - tools/.*
     - test/.*
-    - components/*
     - third_party/.*
 
   # Excluding configuration per-path, per-linter, per-text and per-source

Dockerfile

@@ -3,6 +3,7 @@ FROM golang:1.20 AS builder
 
 # Set go mod installation source and proxy
 ARG GO111MODULE=on
+ARG GOPROXY=https://goproxy.io,direct
 
 ENV GO111MODULE=$GO111MODULE
 ENV GOPROXY=$GOPROXY
@@ -10,7 +11,6 @@ ENV GOPROXY=$GOPROXY
 # Set up the working directory
 WORKDIR /openim/openim-server
 
-
 # Copy all files to the container
 ADD . .
 

Makefile

@@ -0,0 +1,255 @@
+# ==============================================================================
+# define the default goal
+#
+
+.DEFAULT_GOAL := help
+
+## all: Run tidy, gen, add-copyright, format, lint, cover, build ✨
+.PHONY: all
+all: tidy gen add-copyright verify test-api lint cover restart
+
+# ==============================================================================
+# Build set
+
+ROOT_PACKAGE=github.com/openimsdk/open-im-server
+# TODO: This is version control for the future https://github.com/openimsdk/open-im-server/issues/574
+VERSION_PACKAGE=github.com/openimsdk/open-im-server/v3/pkg/version
+
+# ==============================================================================
+# Includes
+
+include scripts/make-rules/common.mk	# make sure include common.mk at the first include line
+include scripts/make-rules/golang.mk
+include scripts/make-rules/image.mk
+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
+
+define USAGE_OPTIONS
+
+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-cmdutils".
+
+  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.
+endef
+export USAGE_OPTIONS
+
+# ==============================================================================
+# Targets
+
+## init: Initialize openim server project ✨
+.PHONY: init
+init:
+	@$(MAKE) gen.init
+
+## init-githooks: Initialize git hooks ✨
+.PHONY: init-githooks
+init-githooks:
+	@$(MAKE) gen.init-githooks
+
+## gen: Generate all necessary files. ✨
+.PHONY: gen
+gen:
+	@$(MAKE) gen.run
+
+## demo: Run demo get started with Makefiles quickly ✨
+.PHONY: demo
+demo:
+	@$(MAKE) go.demo
+
+## version: Check version of openim. ✨
+.PHONY: version
+version:
+	@$(MAKE) go.versionchecker
+
+## build: Build binaries by default ✨
+.PHONY: build
+build:
+	@$(MAKE) go.build
+
+## start: Start openim ✨
+.PHONY: start
+start:
+	@$(MAKE) go.start
+
+## stop: Stop openim ✨
+.PHONY: stop
+stop:
+	@$(MAKE) go.stop
+
+## restart: Restart openim (make init configuration file is initialized) ✨
+.PHONY: restart
+restart: clean stop build start check
+
+## multiarch: Build binaries for multiple platforms. See option PLATFORMS. ✨
+.PHONY: multiarch
+multiarch:
+	@$(MAKE) go.build.multiarch
+
+## verify: execute all verity scripts. ✨
+.PHONY: verify
+verify:
+	@$(MAKE) go.verify
+
+## install: Install deployment openim ✨
+.PHONY: install
+install:
+	@$(MAKE) go.install
+
+## check: Check OpenIM deployment ✨
+.PHONY: check
+check:
+	@$(MAKE) go.check
+
+## check-component: Check OpenIM component deployment ✨
+.PHONY: check-component
+check-component:
+	@$(MAKE) go.check-component
+
+## tidy: tidy go.mod ✨
+.PHONY: tidy
+tidy:
+	@$(GO) mod tidy
+
+## vendor: vendor go.mod ✨
+.PHONY: vendor
+vendor:
+	@$(GO) mod vendor
+
+## style: code style -> fmt,vet,lint ✨
+.PHONY: style
+style: fmt vet lint
+
+## fmt: Run go fmt against code. ✨
+.PHONY: fmt
+fmt:
+	@$(GO) fmt ./...
+
+## vet: Run go vet against code. ✨
+.PHONY: vet
+vet:
+	@$(GO) vet ./...
+
+## lint: Check syntax and styling of go sources. ✨
+.PHONY: lint
+lint:
+	@$(MAKE) go.lint
+
+## format: Gofmt (reformat) package sources (exclude vendor dir if existed). ✨
+.PHONY: format
+format:
+	@$(MAKE) go.format
+
+## test: Run unit test. ✨
+.PHONY: test
+test:
+	@$(MAKE) go.test
+
+## cover: Run unit test and get test coverage. ✨
+.PHONY: cover
+cover:
+	@$(MAKE) go.test.cover
+
+## test-api: Run api test. ✨
+.PHONY: test-api
+test-api:
+	@$(MAKE) go.test.api
+
+## test-e2e: Run e2e test
+test-e2e:
+	@$(MAKE) go.test.e2e
+
+## 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. ✨
+.PHONY: imports
+imports:
+	@$(MAKE) go.imports
+
+## clean: Delete all files created by the build, as well as all log files. ✨
+.PHONY: clean
+clean:
+	@$(MAKE) go.clean
+
+## image: Build docker images for host arch. ✨
+.PHONY: image
+image:
+	@$(MAKE) image.build
+
+## 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. ✨
+.PHONY: push
+push:
+	@$(MAKE) image.push
+
+## 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. ✨
+.PHONY: tools
+tools:
+	@$(MAKE) tools.install
+
+## 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. ✨
+.PHONY: add-copyright
+add-copyright:
+	@$(MAKE) copyright.add
+
+## advertise: Project introduction, become a contributor ✨
+.PHONY: advertise
+advertise:
+	@$(MAKE) copyright.advertise
+
+## 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. ✨
+.PHONY: help-all
+help-all: go.help copyright.help tools.help image.help dependencies.help gen.help release.help swagger.help help
+	$(call makeallhelp)

README_zh_CN.md

@@ -52,7 +52,7 @@
 </p>
 
 ## 🟢 扫描微信进群交流
-<img src="./docs/images/wechat.jpg" width="300">
+<img src="./docs/images/Wechat.jpg" width="300">
 
 
 ## Ⓜ️ 关于 OpenIM

bootstrap.bat

@@ -1,31 +0,0 @@
-@echo off
-SETLOCAL
-
-mage -version >nul 2>&1
-IF %ERRORLEVEL% EQU 0 (
-    echo Mage is already installed.
-    GOTO DOWNLOAD
-)
-
-go version >nul 2>&1
-IF NOT %ERRORLEVEL% EQU 0 (
-    echo Go is not installed. Please install Go and try again.
-    exit /b 1
-)
-
-echo Installing Mage...
-go install github.com/magefile/mage@latest
-
-mage -version >nul 2>&1
-IF NOT %ERRORLEVEL% EQU 0 (
-    echo Mage installation failed.
-    echo Please ensure that %GOPATH%/bin is in your PATH.
-    exit /b 1
-)
-
-echo Mage installed successfully.
-
-:DOWNLOAD
-go mod download
-
-ENDLOCAL

bootstrap.sh

@@ -1,23 +0,0 @@
-#!/bin/bash
-
-if [[ ":$PATH:" == *":$HOME/.local/bin:"* ]]; then
-    TARGET_DIR="$HOME/.local/bin"
-else
-    TARGET_DIR="/usr/local/bin"
-    echo "Using /usr/local/bin as the installation directory. Might require sudo permissions."
-fi
-
-if ! command -v mage &> /dev/null; then
-    echo "Installing Mage to $TARGET_DIR ..."
-    GOBIN=$TARGET_DIR go install github.com/magefile/mage@latest
-fi
-
-if ! command -v mage &> /dev/null; then
-    echo "Mage installation failed."
-    echo "Please ensure that $TARGET_DIR is in your \$PATH."
-    exit 1
-fi
-
-echo "Mage installed successfully."
-
-go mod download

build/images/openim-api/Dockerfile

@@ -19,6 +19,7 @@
 FROM golang:1.20 AS builder
 
 ARG GO111MODULE=on
+ARG GOPROXY=https://goproxy.io,direct
 
 WORKDIR /openim/openim-server
 

build/images/openim-cmdutils/Dockerfile

@@ -19,6 +19,7 @@
 FROM golang:1.20 AS builder
 
 ARG GO111MODULE=on
+ARG GOPROXY=https://goproxy.io,direct
 
 WORKDIR /openim/openim-server
 

build/images/openim-crontask/Dockerfile

@@ -19,6 +19,7 @@
 FROM golang:1.20 AS builder
 
 ARG GO111MODULE=on
+ARG GOPROXY=https://goproxy.io,direct
 
 WORKDIR /openim/openim-server
 

build/images/openim-msggateway/Dockerfile

@@ -19,6 +19,7 @@
 FROM golang:1.20 AS builder
 
 ARG GO111MODULE=on
+ARG GOPROXY=https://goproxy.io,direct
 
 WORKDIR /openim/openim-server
 

build/images/openim-msgtransfer/Dockerfile

@@ -19,6 +19,7 @@
 FROM golang:1.20 AS builder
 
 ARG GO111MODULE=on
+ARG GOPROXY=https://goproxy.io,direct
 
 WORKDIR /openim/openim-server
 

build/images/openim-push/Dockerfile

@@ -19,6 +19,7 @@
 FROM golang:1.20 AS builder
 
 ARG GO111MODULE=on
+ARG GOPROXY=https://goproxy.io,direct
 
 WORKDIR /openim/openim-server
 

build/images/openim-rpc-auth/Dockerfile

@@ -19,6 +19,7 @@
 FROM golang:1.20 AS builder
 
 ARG GO111MODULE=on
+ARG GOPROXY=https://goproxy.io,direct
 
 WORKDIR /openim/openim-server
 

build/images/openim-rpc-conversation/Dockerfile

@@ -19,6 +19,7 @@
 FROM golang:1.20 AS builder
 
 ARG GO111MODULE=on
+ARG GOPROXY=https://goproxy.io,direct
 
 WORKDIR /openim/openim-server
 

build/images/openim-rpc-friend/Dockerfile

@@ -19,6 +19,7 @@
 FROM golang:1.20 AS builder
 
 ARG GO111MODULE=on
+ARG GOPROXY=https://goproxy.io,direct
 
 WORKDIR /openim/openim-server
 

build/images/openim-rpc-group/Dockerfile

@@ -19,6 +19,7 @@
 FROM golang:1.20 AS builder
 
 ARG GO111MODULE=on
+ARG GOPROXY=https://goproxy.io,direct
 
 WORKDIR /openim/openim-server
 

build/images/openim-rpc-msg/Dockerfile

@@ -19,6 +19,7 @@
 FROM golang:1.20 AS builder
 
 ARG GO111MODULE=on
+ARG GOPROXY=https://goproxy.io,direct
 
 WORKDIR /openim/openim-server
 

build/images/openim-rpc-third/Dockerfile

@@ -19,6 +19,7 @@
 FROM golang:1.20 AS builder
 
 ARG GO111MODULE=on
+ARG GOPROXY=https://goproxy.io,direct
 
 WORKDIR /openim/openim-server
 

build/images/openim-rpc-user/Dockerfile

@@ -19,6 +19,7 @@
 FROM golang:1.20 AS builder
 
 ARG GO111MODULE=on
+ARG GOPROXY=https://goproxy.io,direct
 
 WORKDIR /openim/openim-server
 

build/images/openim-tools/component/Dockerfile

@@ -19,6 +19,7 @@
 FROM golang:1.20 AS builder
 
 ARG GO111MODULE=on
+ARG GOPROXY=https://goproxy.io,direct
 
 WORKDIR /openim/openim-server
 

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

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

cmd/openim-api/main.go

@@ -18,12 +18,14 @@ import (
 	_ "net/http/pprof"
 
 	"github.com/openimsdk/open-im-server/v3/pkg/common/cmd"
-	"github.com/openimsdk/tools/system/program"
+	util "github.com/openimsdk/open-im-server/v3/pkg/util/genutil"
 )
 
 func main() {
-	if err := cmd.NewApiCmd().Exec(); err != nil {
-		program.ExitWithError(err)
+	apiCmd := cmd.NewApiCmd()
+	apiCmd.AddPortFlag()
+	apiCmd.AddPrometheusPortFlag()
+	if err := apiCmd.Execute(); err != nil {
+		util.ExitWithError(err)
 	}
-
 }

cmd/openim-cmdutils/main.go

@@ -16,7 +16,7 @@ package main
 
 import (
 	"github.com/openimsdk/open-im-server/v3/pkg/common/cmd"
-	"github.com/openimsdk/tools/system/program"
+	util "github.com/openimsdk/open-im-server/v3/pkg/util/genutil"
 )
 
 func main() {
@@ -29,8 +29,6 @@ func main() {
 	getCmd.AddCommand(seqCmd.GetSeqCmd(), msgCmd.GetMsgCmd())
 	getCmd.AddSuperGroupIDFlag()
 	getCmd.AddUserIDFlag()
-	getCmd.AddConfigDirFlag()
-	getCmd.AddIndexFlag()
 	getCmd.AddBeginSeqFlag()
 	getCmd.AddLimitFlag()
 	// openIM get seq --userID=xxx
@@ -41,8 +39,6 @@ func main() {
 	fixCmd.AddCommand(seqCmd.FixSeqCmd())
 	fixCmd.AddSuperGroupIDFlag()
 	fixCmd.AddUserIDFlag()
-	fixCmd.AddConfigDirFlag()
-	fixCmd.AddIndexFlag()
 	fixCmd.AddFixAllFlag()
 	// openIM fix seq --userID=xxx
 	// openIM fix seq --superGroupID=xxx
@@ -51,8 +47,6 @@ func main() {
 	clearCmd.AddCommand(msgCmd.ClearMsgCmd())
 	clearCmd.AddSuperGroupIDFlag()
 	clearCmd.AddUserIDFlag()
-	clearCmd.AddConfigDirFlag()
-	clearCmd.AddIndexFlag()
 	clearCmd.AddClearAllFlag()
 	clearCmd.AddBeginSeqFlag()
 	clearCmd.AddLimitFlag()
@@ -61,6 +55,6 @@ func main() {
 	// openIM clear msg --clearAll
 	msgUtilsCmd.AddCommand(&getCmd.Command, &fixCmd.Command, &clearCmd.Command)
 	if err := msgUtilsCmd.Execute(); err != nil {
-		program.ExitWithError(err)
+		util.ExitWithError(err)
 	}
 }

cmd/openim-crontask/main.go

@@ -16,11 +16,12 @@ package main
 
 import (
 	"github.com/openimsdk/open-im-server/v3/pkg/common/cmd"
-	"github.com/openimsdk/tools/system/program"
+	util "github.com/openimsdk/open-im-server/v3/pkg/util/genutil"
 )
 
 func main() {
-	if err := cmd.NewCronTaskCmd().Exec(); err != nil {
-		program.ExitWithError(err)
+	cronTaskCmd := cmd.NewCronTaskCmd()
+	if err := cronTaskCmd.Exec(); err != nil {
+		util.ExitWithError(err)
 	}
 }

cmd/openim-msggateway/main.go

@@ -16,11 +16,15 @@ package main
 
 import (
 	"github.com/openimsdk/open-im-server/v3/pkg/common/cmd"
-	"github.com/openimsdk/tools/system/program"
+	util "github.com/openimsdk/open-im-server/v3/pkg/util/genutil"
 )
 
 func main() {
-	if err := cmd.NewMsgGatewayCmd().Exec(); err != nil {
-		program.ExitWithError(err)
+	msgGatewayCmd := cmd.NewMsgGatewayCmd()
+	msgGatewayCmd.AddWsPortFlag()
+	msgGatewayCmd.AddPortFlag()
+	msgGatewayCmd.AddPrometheusPortFlag()
+	if err := msgGatewayCmd.Exec(); err != nil {
+		util.ExitWithError(err)
 	}
 }

cmd/openim-msgtransfer/main.go

@@ -16,11 +16,14 @@ package main
 
 import (
 	"github.com/openimsdk/open-im-server/v3/pkg/common/cmd"
-	"github.com/openimsdk/tools/system/program"
+	util "github.com/openimsdk/open-im-server/v3/pkg/util/genutil"
 )
 
 func main() {
-	if err := cmd.NewMsgTransferCmd().Exec(); err != nil {
-		program.ExitWithError(err)
+	msgTransferCmd := cmd.NewMsgTransferCmd()
+	msgTransferCmd.AddPrometheusPortFlag()
+	msgTransferCmd.AddTransferProgressFlag()
+	if err := msgTransferCmd.Exec(); err != nil {
+		util.ExitWithError(err)
 	}
 }

cmd/openim-push/main.go

@@ -15,12 +15,16 @@
 package main
 
 import (
+	"github.com/openimsdk/open-im-server/v3/internal/push"
 	"github.com/openimsdk/open-im-server/v3/pkg/common/cmd"
-	"github.com/openimsdk/tools/system/program"
+	util "github.com/openimsdk/open-im-server/v3/pkg/util/genutil"
 )
 
 func main() {
-	if err := cmd.NewPushRpcCmd().Exec(); err != nil {
-		program.ExitWithError(err)
+	pushCmd := cmd.NewRpcCmd(cmd.RpcPushServer, push.Start)
+	pushCmd.AddPortFlag()
+	pushCmd.AddPrometheusPortFlag()
+	if err := pushCmd.Exec(); err != nil {
+		util.ExitWithError(err)
 	}
 }

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

@@ -15,12 +15,16 @@
 package main
 
 import (
+	"github.com/openimsdk/open-im-server/v3/internal/rpc/auth"
 	"github.com/openimsdk/open-im-server/v3/pkg/common/cmd"
-	"github.com/openimsdk/tools/system/program"
+	util "github.com/openimsdk/open-im-server/v3/pkg/util/genutil"
 )
 
 func main() {
-	if err := cmd.NewAuthRpcCmd().Exec(); err != nil {
-		program.ExitWithError(err)
+	authCmd := cmd.NewRpcCmd(cmd.RpcAuthServer, auth.Start)
+	authCmd.AddPortFlag()
+	authCmd.AddPrometheusPortFlag()
+	if err := authCmd.Exec(); err != nil {
+		util.ExitWithError(err)
 	}
 }

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

@@ -15,12 +15,16 @@
 package main
 
 import (
+	"github.com/openimsdk/open-im-server/v3/internal/rpc/conversation"
 	"github.com/openimsdk/open-im-server/v3/pkg/common/cmd"
-	"github.com/openimsdk/tools/system/program"
+	util "github.com/openimsdk/open-im-server/v3/pkg/util/genutil"
 )
 
 func main() {
-	if err := cmd.NewConversationRpcCmd().Exec(); err != nil {
-		program.ExitWithError(err)
+	rpcCmd := cmd.NewRpcCmd(cmd.RpcConversationServer, conversation.Start)
+	rpcCmd.AddPortFlag()
+	rpcCmd.AddPrometheusPortFlag()
+	if err := rpcCmd.Exec(); err != nil {
+		util.ExitWithError(err)
 	}
 }

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

@@ -15,12 +15,16 @@
 package main
 
 import (
+	"github.com/openimsdk/open-im-server/v3/internal/rpc/friend"
 	"github.com/openimsdk/open-im-server/v3/pkg/common/cmd"
-	"github.com/openimsdk/tools/system/program"
+	util "github.com/openimsdk/open-im-server/v3/pkg/util/genutil"
 )
 
 func main() {
-	if err := cmd.NewFriendRpcCmd().Exec(); err != nil {
-		program.ExitWithError(err)
+	rpcCmd := cmd.NewRpcCmd(cmd.RpcFriendServer, friend.Start)
+	rpcCmd.AddPortFlag()
+	rpcCmd.AddPrometheusPortFlag()
+	if err := rpcCmd.Exec(); err != nil {
+		util.ExitWithError(err)
 	}
 }

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

@@ -15,12 +15,16 @@
 package main
 
 import (
+	"github.com/openimsdk/open-im-server/v3/internal/rpc/group"
 	"github.com/openimsdk/open-im-server/v3/pkg/common/cmd"
-	"github.com/openimsdk/tools/system/program"
+	util "github.com/openimsdk/open-im-server/v3/pkg/util/genutil"
 )
 
 func main() {
-	if err := cmd.NewGroupRpcCmd().Exec(); err != nil {
-		program.ExitWithError(err)
+	rpcCmd := cmd.NewRpcCmd(cmd.RpcGroupServer, group.Start)
+	rpcCmd.AddPortFlag()
+	rpcCmd.AddPrometheusPortFlag()
+	if err := rpcCmd.Exec(); err != nil {
+		util.ExitWithError(err)
 	}
 }

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

@@ -15,12 +15,16 @@
 package main
 
 import (
+	"github.com/openimsdk/open-im-server/v3/internal/rpc/msg"
 	"github.com/openimsdk/open-im-server/v3/pkg/common/cmd"
-	"github.com/openimsdk/tools/system/program"
+	util "github.com/openimsdk/open-im-server/v3/pkg/util/genutil"
 )
 
 func main() {
-	if err := cmd.NewMsgRpcCmd().Exec(); err != nil {
-		program.ExitWithError(err)
+	rpcCmd := cmd.NewRpcCmd(cmd.RpcMsgServer, msg.Start)
+	rpcCmd.AddPortFlag()
+	rpcCmd.AddPrometheusPortFlag()
+	if err := rpcCmd.Exec(); err != nil {
+		util.ExitWithError(err)
 	}
 }

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

@@ -15,12 +15,16 @@
 package main
 
 import (
+	"github.com/openimsdk/open-im-server/v3/internal/rpc/third"
 	"github.com/openimsdk/open-im-server/v3/pkg/common/cmd"
-	"github.com/openimsdk/tools/system/program"
+	util "github.com/openimsdk/open-im-server/v3/pkg/util/genutil"
 )
 
 func main() {
-	if err := cmd.NewThirdRpcCmd().Exec(); err != nil {
-		program.ExitWithError(err)
+	rpcCmd := cmd.NewRpcCmd(cmd.RpcThirdServer, third.Start)
+	rpcCmd.AddPortFlag()
+	rpcCmd.AddPrometheusPortFlag()
+	if err := rpcCmd.Exec(); err != nil {
+		util.ExitWithError(err)
 	}
 }

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

@@ -15,12 +15,16 @@
 package main
 
 import (
+	"github.com/openimsdk/open-im-server/v3/internal/rpc/user"
 	"github.com/openimsdk/open-im-server/v3/pkg/common/cmd"
-	"github.com/openimsdk/tools/system/program"
+	util "github.com/openimsdk/open-im-server/v3/pkg/util/genutil"
 )
 
 func main() {
-	if err := cmd.NewUserRpcCmd().Exec(); err != nil {
-		program.ExitWithError(err)
+	rpcCmd := cmd.NewRpcCmd(cmd.RpcUserServer, user.Start)
+	rpcCmd.AddPortFlag()
+	rpcCmd.AddPrometheusPortFlag()
+	if err := rpcCmd.Exec(); err != nil {
+		util.ExitWithError(err)
 	}
 }

config/README_zh_CN.md

@@ -1,65 +0,0 @@
-# 						OpenIM配置文件说明以及常用配置修改说明
-
-## 配置文件说明
-
-| Configuration File              | Description                                                  |
-| ------------------------------- | ------------------------------------------------------------ |
-| **kafka.yml**                   | Kafka用户名、密码、地址等配置                                |
-| **redis.yml**                   | Redis密码、地址等配置                                        |
-| **minio.yml**                   | MinIO用户名、密码、地址及外网IP域名等配置；未修改外网IP或域名可能导致图片文件发送失败 |
-| **zookeeper.yml**               | ZooKeeper用户、密码、地址等配置                              |
-| **mongodb.yml**                 | MongoDB用户名、密码、地址等配置                              |
-| **log.yml**                     | 日志级别及存储目录等配置                                     |
-| **notification.yml**            | 添加好友、创建群组等事件通知配置                             |
-| **share.yml**                   | OpenIM各服务所需的公共配置，如secret等                       |
-| **webhooks.yml**                | Webhook中URL等配置                                           |
-| **local-cache.yml**             | 本地缓存配置                                                 |
-| **openim-rpc-third.yml**        | openim-rpc-third服务的监听IP、端口及图片视频对象存储配置     |
-| **openim-rpc-user.yml**         | openim-rpc-user服务的监听IP、端口配置                        |
-| **openim-api.yml**              | openim-api服务的监听IP、端口等配置项                         |
-| **openim-crontask.yml**         | openim-crontask服务配置                                      |
-| **openim-msggateway.yml**       | openim-msggateway服务的监听IP、端口等配置                    |
-| **openim-msgtransfer.yml**      | openim-msgtransfer服务配置                                   |
-| **openim-push.yml**             | openim-push服务的监听IP、端口及离线推送配置                  |
-| **openim-rpc-auth.yml**         | openim-rpc-auth服务的监听IP、端口及token有效期等配置         |
-| **openim-rpc-conversation.yml** | openim-rpc-conversation服务的监听IP、端口等配置              |
-| **openim-rpc-friend.yml**       | openim-rpc-friend服务的监听IP、端口等配置                    |
-| **openim-rpc-group.yml**        | openim-rpc-group服务的监听IP、端口等配置                     |
-| **openim-rpc-msg.yml**          | openim-rpc-msg服务的监听IP、端口及消息发送是否验证好友关系等配置 |
-
-## 常用配置修改
-
-| 修改配置项                                      | 配置文件                |
-| ----------------------------------------------- | ----------------------- |
-| 使用minio作为图片视频文件对象存储               | `minio.yml`             |
-| 生产环境日志调整                                | `log.yml`               |
-| 发送消息是否验证好友关系                        | `openim-rpc-msg.yml`    |
-| 修改secret                                      | `share.yml`             |
-| 使用oss, cos, aws, kodo作为图片视频文件对象存储 | `openim-rpc-third.yml`  |
-| 设置多端互踢策略                                | `openim-msggateway.yml` |
-| 设置离线推送                                    | `openim-push.yml`       |
-
-## 启动某个OpenIM服务的多个实例
-
-若要启动某个OpenIM的多个实例，只需增加对应的端口数，并修改项目根目录下的`start-config.yml`文件，重启服务即可生效。例如，启动2个`openim-rpc-user`实例的配置如下：
-
-```yaml
-rpc:
-  registerIP: ''
-  listenIP: 0.0.0.0
-  ports: [ 10110, 10111 ]
-
-prometheus:
-  enable: true
-  ports: [ 20100, 20101 ]
-```
-
-修改`start-config.yml`:
-
-```yaml
-serviceBinaries:
-  openim-rpc-user: 2
-```
-
-
-

config/Readme.md

@@ -0,0 +1,243 @@
+# OpenIM Configuration Guide
+
+<!-- vscode-markdown-toc -->
+* 1. [Directory Structure and File Descriptions](#DirectoryStructureandFileDescriptions)
+	* 1.1. [Directory Structure](#DirectoryStructure)
+	* 1.2. [Directory Structure Explanation](#DirectoryStructureExplanation)
+* 2. [File Descriptions](#FileDescriptions)
+	* 2.1. [Files in the Root Directory](#FilesintheRootDirectory)
+	* 2.2. [Files in the `templates/` Directory](#FilesinthetemplatesDirectory)
+* 3. [Configuration File Generation](#ConfigurationFileGeneration)
+	* 3.1. [How to Use `init-config.sh` Script](#HowtoUseinit-config.shScript)
+	* 3.2. [Examples of Operations](#ExamplesofOperations)
+	* 3.3. [Points to Note](#PointstoNote)
+* 4. [Example Directory](#ExampleDirectory)
+	* 4.1. [Overview](#Overview)
+	* 4.2. [Structure](#Structure)
+	* 4.3. [How to Use These Examples](#HowtoUseTheseExamples)
+	* 4.4. [Tips for Using Example Files:](#TipsforUsingExampleFiles:)
+* 5. [Configuration Item Descriptions](#ConfigurationItemDescriptions)
+* 6. [Version Management and Upgrading](#VersionManagementandUpgrading)
+	* 6.1. [Pulling the Latest Code](#PullingtheLatestCode)
+	* 6.2. [Generating the Latest Example Configuration Files](#GeneratingtheLatestExampleConfigurationFiles)
+	* 6.3. [Comparing Configuration File Differences](#ComparingConfigurationFileDifferences)
+	* 6.4. [Updating Configuration Files](#UpdatingConfigurationFiles)
+	* 6.5. [Updating Binary Files and Restarting Services](#UpdatingBinaryFilesandRestartingServices)
+	* 6.6. [Best Practices for Version Management](#BestPracticesforVersionManagement)
+* 7. [How to Contribute](#HowtoContribute)
+	* 7.1. [OpenIM Configuration Item Descriptions](#OpenIMConfigurationItemDescriptions)
+	* 7.2. [Modifying Template Files](#ModifyingTemplateFiles)
+	* 7.3. [Updating Configuration Center Scripts](#UpdatingConfigurationCenterScripts)
+	* 7.4. [Configuration File Generation Process](#ConfigurationFileGenerationProcess)
+	* 7.5. [Contribution Guidelines](#ContributionGuidelines)
+	* 7.6. [Submission and Review](#SubmissionandReview)
+
+<!-- vscode-markdown-toc-config
+	numbering=true
+	autoSave=true
+	/vscode-markdown-toc-config -->
+<!-- /vscode-markdown-toc -->
+
+
+##  1. <a name='DirectoryStructureandFileDescriptions'></a>Directory Structure and File Descriptions
+
+This document details the structure of the `config` directory, aiding users in understanding and managing configuration files.
+
+###  1.1. <a name='DirectoryStructure'></a>Directory Structure
+
+```bash
+$ tree config
+├── alertmanager.yml
+├── config.yaml
+├── email.tmpl
+├── instance-down-rules.yml
+├── notification.yaml
+├── prometheus.yml
+├── Readme.md
+└── templates
+    ├── alertmanager.yml.template
+    ├── config.yaml.template
+    ├── email.tmpl.template
+    ├── env.template
+    ├── instance-down-rules.yml.template
+    ├── notification.yaml.template
+    ├── open-im-ng-example.conf
+    ├── prometheus-dashboard.yaml
+    └── prometheus.yml.template
+```
+
+###  1.2. <a name='DirectoryStructureExplanation'></a>Directory Structure Explanation
+
+- **Root Directory (`config/`)**: Contains actual configuration files and the `templates` subdirectory.
+- **`templates/` Subdirectory**: Stores configuration templates for generating or updating configuration files in the root directory.
+
+##  2. <a name='FileDescriptions'></a>File Descriptions
+
+###  2.1. <a name='FilesintheRootDirectory'></a>Files in the Root Directory
+
+- **`alertmanager.yml`**: Configuration file for AlertManager, managing and setting up the alert system.
+- **`config.yaml`**: The main application configuration file, covering service settings.
+- **`email.tmpl`**: Template file for email notifications, defining email format and content.
+- **`instance-down-rules.yml`**: Instance downtime rules configuration file for the monitoring system.
+- **`notification.yaml`**: Configuration file for notification settings, defining different types of notifications.
+- **`prometheus.yml`**: Configuration file for the Prometheus monitoring system, setting monitoring metrics and rules.
+
+###  2.2. <a name='FilesinthetemplatesDirectory'></a>Files in the `templates/` Directory
+
+- **`alertmanager.yml.template`**: Template for AlertManager configuration.
+- **`config.yaml.template`**: Main configuration template for the application.
+- **`email.tmpl.template`**: Template for email notifications.
+- **`env.template`**: Template for environmental variable configurations, setting environment-related configurations.
+- **`instance-down-rules.yml.template`**: Template for instance downtime rules.
+- **`notification.yaml.template`**: Template for notification settings.
+- **`open-im-ng-example.conf`**: Example configuration file for the application.
+- **`prometheus-dashboard.yaml`**: Prometheus dashboard configuration file, specific to the OpenIM application.
+- **`prometheus.yml.template`**: Template for Prometheus configuration.
+
+##  3. <a name='ConfigurationFileGeneration'></a>Configuration File Generation
+
+Configuration files can be automatically generated using the `make init` command or the `./scripts/init-config.sh` script. These scripts conveniently extract templates from the `templates` directory and generate or update actual configuration files in the root directory.
+
+###  3.1. <a name='HowtoUseinit-config.shScript'></a>How to Use `init-config.sh` Script
+
+```bash
+$ ./scripts/init-config.sh --help
+Usage: init-config.sh [options]
+Options:
+  -h, --help             Show this help message
+  --force                Overwrite existing files without prompt
+  --skip                 Skip generation if file exists
+  --examples             Generate example files
+  --clean-config         Clean all configuration files
+  --clean-examples       Clean all example files
+```
+
+###  3.2. <a name='ExamplesofOperations'></a>Examples of Operations
+
+- Generate all template configuration files:
+
+  ```bash
+  $ ./scripts/init-config.sh --examples
+  ```
+
+- Force overwrite existing configuration files:
+
+  ```bash
+  $ ./scripts/init-config.sh --force
+  ```
+
+###  3.3. <a name='PointstoNote'></a>Points to Note
+
+- **Template files should not be directly modified**: Files in the `template` directory are templates included in source code management. Direct modification may lead to version conflicts or management issues.
+- **Operations for Windows Users**: Windows users can use the `cp` command to copy files from the `template` directory to the `config/` directory and then modify the configuration items as needed.
+
+##  4. <a name='ExampleDirectory'></a>Example Directory
+
+Welcome to our project's `examples` directory! This directory contains a range of example files, showcasing various configurations and settings of our software. These examples are intended to provide you with templates that can serve as a starting point for your own configurations.
+
+###  4.1. <a name='Overview'></a>Overview
+
+In this directory, you'll find examples suitable for a variety of use cases. Each file is a template with default values and configurations, demonstrating best practices and typical scenarios. Whether you're just getting started or looking to implement complex settings, these examples should help you get on the right track.
+
+###  4.2. <a name='Structure'></a>Structure
+
+Here's a quick overview of the contents in this directory:
+
+- `env-example.yaml`: Demonstrates how to set up environmental variables.
+- `openim-example.yaml`: Example configuration file for the OpenIM application.
+- `prometheus-example.yml`: Example configuration for monitoring with Prometheus.
+- `alertmanager-example.yml`: Template for setting up Alertmanager configuration.
+
+###  4.3. <a name='HowtoUseTheseExamples'></a>How to Use These Examples
+
+To use these examples, simply copy the relevant files to your working directory and rename them as needed (for example, removing the `-example` suffix). Then, modify the files according to your needs.
+
+###  4.4. <a name='TipsforUsingExampleFiles:'></a>Tips for Using Example Files:
+
+1. **Read Comments**: Each file contains comments explaining the various sections and settings. Make sure to read these comments for a better understanding of how to customize the file.
+2. **Check Required Changes**: Some examples might require mandatory changes before they can be used effectively (such as setting specific environmental variables).
+3. **Version Compatibility**: Ensure that the example files are compatible with the version of the software you are using.
+
+##  5. <a name='ConfigurationItemDescriptions'></a>Configuration Item Descriptions
+
+##  6. <a name='VersionManagementandUpgrading'></a>Version Management and Upgrading
+
+When managing and upgrading the `config` directory's versions, it is crucial to ensure that the configuration files in both the local `config/` and `config/templates/` directories are kept in sync. This process can ensure that your configuration files are consistent with the latest standard templates, while also maintaining custom settings.
+
+###  6.1. <a name='PullingtheLatestCode'></a>Pulling the Latest Code
+
+First, ensure that your local repository is in sync with the remote repository. This can be achieved by pulling the latest code:
+
+```bash
+$ git pull
+```
+
+###  6.2. <a name='GeneratingtheLatestExampleConfigurationFiles'></a>Generating the Latest Example Configuration Files
+
+Next, generate the latest example configuration files. This can be done by running the `init-config.sh` script, using the `--examples` option to generate example files, and the `--skip` option to avoid overwriting existing configuration files:
+
+```bash
+$ ./scripts/init-config.sh --examples --skip
+```
+
+###  6.3. <a name='ComparingConfigurationFileDifferences'></a>Comparing Configuration File Differences
+
+Once the latest example configuration files are generated, you need to compare the configuration files in the `config/` and `config/templates/` directories to find any potential differences. This step ensures that you can identify and integrate any important updates or changes. Tools like `diff` can be helpful in completing this step:
+
+```bash
+$ diff -ur config/ config/templates/
+```
+
+###  6.4. <a name='UpdatingConfigurationFiles'></a>Updating Configuration Files
+
+Based on the comparison results, manually update the configuration files in the `config/` directory to reflect the latest configurations in `config/templates/`. During this process, ensure to retain any custom configuration settings.
+
+###  6.5. <a name='UpdatingBinaryFilesandRestartingServices'></a>Updating Binary Files and Restarting Services
+
+After updating the configuration files, the next step is to update any related binary files. This typically involves downloading and installing the latest version of the application or service. Depending on the specific application or service, this might involve running specific update scripts or directly downloading the latest version from official sources.
+
+Once the binary files are updated, the services need to be restarted to apply the new configurations. Make sure to conduct necessary checks before restarting to ensure the correctness of the configurations.
+
+###  6.6. <a name='BestPracticesforVersionManagement'></a>Best Practices for Version Management
+
+- **Record Changes**: When committing changes to a version control system, ensure to log detailed change logs.
+- **Stay Synced**: Regularly sync with the remote repository to ensure that your local configurations are in line with the latest developments.
+- **Backup**: Backup your current configurations before making any significant changes, so that you can revert to a previous state if necessary.
+
+By following these steps and best practices, you can ensure effective management and smooth upgrading of your `config` directory.
+
+##  7. <a name='HowtoContribute'></a>How to Contribute
+
+If you have an understanding of the logic behind OpenIM's configuration generation, then you will clearly know where to make modifications to contribute code.
+
+###  7.1. <a name='OpenIMConfigurationItemDescriptions'></a>OpenIM Configuration Item Descriptions
+
+First, it is recommended to read the [OpenIM Configuration Items Document](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/environment.md). This will help you understand the roles of various configuration items and how they affect the operation of OpenIM.
+
+###  7.2. <a name='ModifyingTemplateFiles'></a>Modifying Template Files
+
+To contribute to OpenIM, focus on the `./deployments/templates` directory. This contains various configuration template files, which are the basis for generating the final configuration files.
+
+When making modifications, ensure that your changes align with OpenIM's configuration requirements and logic. This may involve adding new template files or modifying existing files to reflect new configuration options or structural changes.
+
+###  7.3. <a name='UpdatingConfigurationCenterScripts'></a>Updating Configuration Center Scripts
+
+In addition to modifying template files, pay attention to the `./scripts/install/environment.sh` script. In this script, you may need to add or modify environment variables.
+
+This script is responsible for defining environment variables that influence configuration generation. Therefore, any new configuration items or modifications to existing items need to be reflected here.
+
+###  7.4. <a name='ConfigurationFileGenerationProcess'></a>Configuration File Generation Process
+
+The essence of the `make init` command is to use the environment variables defined in `/scripts/install/environment.sh` to render the template files in the `./deployments/templates` directory, thereby generating the final configuration files.
+
+When contributing code, ensure that your changes work smoothly in this process and do not cause errors during configuration file generation.
+
+###  7.5. <a name='ContributionGuidelines'></a>Contribution Guidelines
+
+- **Code Review**: Ensure your changes have passed code review. This typically means that the code should be clear, easy to understand, and adhere to the project's coding style and best practices.
+- **Testing**: Before submitting changes, conduct thorough tests to ensure new or modified configurations work as expected and do not negatively impact existing functionalities.
+- **Documentation**: If you have added a new configuration option or made significant changes to an existing one, update the relevant documentation to assist other users and developers in understanding and utilizing these changes.
+
+###  7.6. <a name='SubmissionandReview'></a>Submission and Review
+
+After completing your changes, submit your code to the OpenIM repository in the form of a Pull Request (PR). The PR will be reviewed by the project maintainers and you may be asked to make further modifications or provide additional information.

config/kafka.yml

@@ -1,18 +0,0 @@
-username: ''
-password: ''
-producerAck: ""
-compressType: "none"
-address: [ localhost:19094 ]
-toRedisTopic: "toRedis"
-toMongoTopic: "toMongo"
-toPushTopic: "toPush"
-toRedisGroupID: redis
-toMongoGroupID: mongo
-toPushGroupID: push
-tls:
-  enableTLS: false
-  caCrt: ""
-  clientCrt: ""
-  clientKey: ""
-  clientKeyPwd: ""
-  insecureSkipVerify: false

config/local-cache.yml

@@ -1,27 +0,0 @@
-user:
-  topic: DELETE_CACHE_USER
-  slotNum: 100
-  slotSize: 2000
-  successExpire: 300
-  failedExpire: 5
-
-group:
-  topic: DELETE_CACHE_GROUP
-  slotNum: 100
-  slotSize: 2000
-  successExpire: 300
-  failedExpire: 5
-
-friend:
-  topic: DELETE_CACHE_FRIEND
-  slotNum: 100
-  slotSize: 2000
-  successExpire: 300
-  failedExpire: 5
-
-conversation:
-  topic: DELETE_CACHE_CONVERSATION
-  slotNum: 100
-  slotSize: 2000
-  successExpire: 300
-  failedExpire: 5

config/log.yml

@@ -1,13 +0,0 @@
-# Log storage path, default is acceptable, change to a full path if modification is needed
-storageLocation: ../../../../logs/
-# Log rotation period (in hours), default is acceptable
-rotationTime: 24
-# Number of log files to retain, default is acceptable
-remainRotationCount: 2
-# Log level settings: 3 for production environment; 6 for more verbose logging in debugging environments
-remainLogLevel: 6
-# Whether to output to standard output, default is acceptable
-isStdout: false
-# Whether to log in JSON format, default is acceptable
-isJson: false
-

config/minio.yml

@@ -1,9 +0,0 @@
-bucket: "openim"
-port: 10005
-accessKeyID: "root"
-secretAccessKey: "openIM123"
-sessionToken: ''
-internalIP: localhost
-externalIP: 150.109.93.151
-url: https://image.rentsoft.cn/
-publicRead: false

config/mongodb.yml

@@ -1,7 +0,0 @@
-uri: ''
-address: [ localhost:37017 ]
-database: openim_v3
-username: openIM
-password: openIM123
-maxPoolSize: 100
-maxRetry: 10

config/notification.yml

@@ -1,354 +0,0 @@
-# Copyright © 2023 OpenIM. All rights reserved.
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-# Determines if a message should be sent. If set to false, it triggers a silent sync without a message. If true, it requires triggering a conversation.
-# For rpc notification, send twice: once as a message and once as a notification.
-# The options field 'isNotification' indicates if it's a notification.
-groupCreated:
-  isSendMsg: true
-
-# Reliability level of the message sending.
-# Set to 1 to send only when online, 2 for guaranteed delivery.
-  reliabilityLevel: 1
-
-# This setting is effective only when 'isSendMsg' is true.
-# It controls whether to count unread messages.
-  unreadCount: false
-
-# Configuration for offline push notifications.
-  offlinePush:
-    # Enables or disables offline push notifications.
-    enable: false
-
-    # Title for the notification when a group is created.
-    title: "create group title"
-
-    # Description for the notification.
-    desc: "create group desc"
-
-    # Additional information for the notification.
-    ext: "create group ext"
-
-# Content type is not added here.
-# Content should use a JSON structure conforming to the protobuf format.
-
-groupInfoSet:
-  isSendMsg: false
-  reliabilityLevel: 1
-  unreadCount: false
-  offlinePush:
-    enable: false
-    title: "groupInfoSet title"
-    desc: "groupInfoSet desc"
-    ext: "groupInfoSet ext"
-
-
-joinGroupApplication:
-  isSendMsg: false
-  reliabilityLevel: 1
-  unreadCount: false
-  offlinePush:
-    enable: false
-    title: "joinGroupApplication title"
-    desc: "joinGroupApplication desc"
-    ext: "joinGroupApplication ext"
-
-memberQuit:
-  isSendMsg: true
-  reliabilityLevel: 1
-  unreadCount: false
-  offlinePush:
-    enable: false
-    title: "memberQuit title"
-    desc: "memberQuit desc"
-    ext: "memberQuit ext"
-
-groupApplicationAccepted:
-  isSendMsg: false
-  reliabilityLevel: 1
-  unreadCount: false
-  offlinePush:
-    enable: false
-    title: "groupApplicationAccepted title"
-    desc: "groupApplicationAccepted desc"
-    ext: "groupApplicationAccepted ext"
-
-groupApplicationRejected:
-  isSendMsg: false
-  reliabilityLevel: 1
-  unreadCount: false
-  offlinePush:
-    enable: false
-    title: "groupApplicationRejected title"
-    desc: "groupApplicationRejected desc"
-    ext: "groupApplicationRejected ext"
-
-
-groupOwnerTransferred:
-  isSendMsg: true
-  reliabilityLevel: 1
-  unreadCount: false
-  offlinePush:
-    enable: false
-    title: "groupOwnerTransferred title"
-    desc: "groupOwnerTransferred desc"
-    ext: "groupOwnerTransferred ext"
-
-memberKicked:
-  isSendMsg: true
-  reliabilityLevel: 1
-  unreadCount: false
-  offlinePush:
-    enable: false
-    title: "memberKicked title"
-    desc: "memberKicked desc"
-    ext: "memberKicked ext"
-
-memberInvited:
-  isSendMsg: true
-  reliabilityLevel: 1
-  unreadCount: false
-  offlinePush:
-    enable: false
-    title: "memberInvited title"
-    desc: "memberInvited desc"
-    ext: "memberInvited ext"
-
-memberEnter:
-  isSendMsg: true
-  reliabilityLevel: 1
-  unreadCount: false
-  offlinePush:
-    enable: false
-    title: "memberEnter title"
-    desc: "memberEnter desc"
-    ext: "memberEnter ext"
-
-groupDismissed:
-  isSendMsg: true
-  reliabilityLevel: 1
-  unreadCount: false
-  offlinePush:
-    enable: false
-    title: "groupDismissed title"
-    desc: "groupDismissed desc"
-    ext: "groupDismissed ext"
-
-groupMuted:
-  isSendMsg: true
-  reliabilityLevel: 1
-  unreadCount: false
-  offlinePush:
-    enable: false
-    title: "groupMuted title"
-    desc: "groupMuted desc"
-    ext: "groupMuted ext"
-
-groupCancelMuted:
-  isSendMsg: true
-  reliabilityLevel: 1
-  unreadCount: false
-  offlinePush:
-    enable: false
-    title: "groupCancelMuted title"
-    desc: "groupCancelMuted desc"
-    ext: "groupCancelMuted ext"
-  defaultTips:
-    tips: "group Cancel Muted"
-
-
-groupMemberMuted:
-  isSendMsg: true
-  reliabilityLevel: 1
-  unreadCount: false
-  offlinePush:
-    enable: false
-    title: "groupMemberMuted title"
-    desc: "groupMemberMuted desc"
-    ext: "groupMemberMuted ext"
-
-groupMemberCancelMuted:
-  isSendMsg: true
-  reliabilityLevel: 1
-  unreadCount: false
-  offlinePush:
-    enable: false
-    title: "groupMemberCancelMuted title"
-    desc: "groupMemberCancelMuted desc"
-    ext: "groupMemberCancelMuted ext"
-
-groupMemberInfoSet:
-  isSendMsg: false
-  reliabilityLevel: 1
-  unreadCount: false
-  offlinePush:
-    enable: false
-    title: "groupMemberInfoSet title"
-    desc: "groupMemberInfoSet desc"
-    ext: "groupMemberInfoSet ext"
-
-groupInfoSetAnnouncement:
-  isSendMsg: true
-  reliabilityLevel: 1
-  unreadCount: false
-  offlinePush:
-    enable: false
-    title: "groupInfoSetAnnouncement title"
-    desc: "groupInfoSetAnnouncement desc"
-    ext: "groupInfoSetAnnouncement ext"
-
-
-groupInfoSetName:
-  isSendMsg: true
-  reliabilityLevel: 1
-  unreadCount: false
-  offlinePush:
-    enable: false
-    title: "groupInfoSetName title"
-    desc: "groupInfoSetName desc"
-    ext: "groupInfoSetName ext"
-
-
-#############################friend#################################
-friendApplicationAdded:
-  isSendMsg: false
-  reliabilityLevel: 1
-  unreadCount: false
-  offlinePush:
-    enable: false
-    title: "Somebody applies to add you as a friend"
-    desc: "Somebody applies to add you as a friend"
-    ext: "Somebody applies to add you as a friend"
-
-friendApplicationApproved:
-  isSendMsg: true
-  reliabilityLevel: 1
-  unreadCount: false
-  offlinePush:
-    enable: true
-    title: "Someone applies to add your friend application"
-    desc: "Someone applies to add your friend application"
-    ext: "Someone applies to add your friend application"
-
-friendApplicationRejected:
-  isSendMsg: false
-  reliabilityLevel: 1
-  unreadCount: false
-  offlinePush:
-    enable: true
-    title: "Someone rejected your friend application"
-    desc: "Someone rejected your friend application"
-    ext: "Someone rejected your friend application"
-
-friendAdded:
-  isSendMsg: false
-  reliabilityLevel: 1
-  unreadCount: false
-  offlinePush:
-    enable: true
-    title: "We have become friends"
-    desc: "We have become friends"
-    ext: "We have become friends"
-
-friendDeleted:
-  isSendMsg: false
-  reliabilityLevel: 1
-  unreadCount: false
-  offlinePush:
-    enable: true
-    title: "deleted a friend"
-    desc: "deleted a friend"
-    ext: "deleted a friend"
-
-friendRemarkSet:
-  isSendMsg: false
-  reliabilityLevel: 1
-  unreadCount: false
-  offlinePush:
-    enable: true
-    title: "Your friend's profile has been changed"
-    desc: "Your friend's profile has been changed"
-    ext: "Your friend's profile has been changed"
-
-blackAdded:
-  isSendMsg: false
-  reliabilityLevel: 1
-  unreadCount: false
-  offlinePush:
-    enable: true
-    title: "blocked a user"
-    desc: "blocked a user"
-    ext: "blocked a user"
-
-blackDeleted:
-  isSendMsg: false
-  reliabilityLevel: 1
-  unreadCount: false
-  offlinePush:
-    enable: true
-    title: "Remove a blocked user"
-    desc: "Remove a blocked user"
-    ext: "Remove a blocked user"
-
-friendInfoUpdated:
-  isSendMsg: false
-  reliabilityLevel: 1
-  unreadCount: false
-  offlinePush:
-    enable: true
-    title: "friend info updated"
-    desc: "friend info updated"
-    ext: "friend info updated"
-
-#####################user#########################
-userInfoUpdated:
-  isSendMsg: false
-  reliabilityLevel: 1
-  unreadCount: false
-  offlinePush:
-    enable: true
-    title: "Remove a blocked user"
-    desc: "Remove a blocked user"
-    ext: "Remove a blocked user"
-
-userStatusChanged:
-  isSendMsg: false
-  reliabilityLevel: 1
-  unreadCount: false
-  offlinePush:
-    enable: false
-    title: "user status changed"
-    desc: "user status changed"
-    ext: "user status changed"
-
-#####################conversation#########################
-conversationChanged:
-  isSendMsg: false
-  reliabilityLevel: 1
-  unreadCount: false
-  offlinePush:
-    enable: true
-    title: "conversation changed"
-    desc: "conversation changed"
-    ext: "conversation changed"
-
-conversationSetPrivate:
-  isSendMsg: true
-  reliabilityLevel: 1
-  unreadCount: false
-  offlinePush:
-    enable: true
-    title: "burn after reading"
-    desc: "burn after reading"
-    ext: "burn after reading"

config/openim-api.yml

@@ -1,13 +0,0 @@
-api:
-  # Listening IP; 0.0.0.0 means both internal and external IPs are listened to, default is recommended
-  listenIP: 0.0.0.0
-  # Listening ports; if multiple are configured, multiple instances will be launched, must be consistent with the number of prometheus.ports
-  ports: [ 10002 ]
-
-prometheus:
-  # Whether to enable prometheus
-  enable: true
-  # Prometheus listening ports, must match the number of api.ports
-  ports: [ 20113 ]
-  # This address can be accessed via a browser
-  grafanaURL: http://127.0.0.1:13000/

config/openim-crontask.yml

@@ -1,4 +0,0 @@
-chatRecordsClearTime: "0 2 * * 3"
-msgDestructTime: "0 2 * * *"
-retainChatRecords: 365
-enableCronLocker: false

config/openim-msggateway.yml

@@ -1,19 +0,0 @@
-rpc:
-  registerIP: ''
-  ports: [ 10140 ]
-
-prometheus:
-  enable: true
-  ports: [ 20112 ]
-
-listenIP: 0.0.0.0
-
-longConnSvr:
-  ports: [ 10001 ]
-  websocketMaxConnNum: 100000
-  websocketMaxMsgLen: 4096
-  websocketTimeout: 10
-
-multiLoginPolicy: 1
-
-

config/openim-msgtransfer.yml

@@ -1,3 +0,0 @@
-prometheus:
-  enable: true
-  ports: [ 20108, 20109, 20110, 20111 ]

config/openim-push.yml

@@ -1,37 +0,0 @@
-rpc:
-  registerIP: ''
-  listenIP: 0.0.0.0
-  ports: [ 10170 ]
-
-prometheus:
-  enable: true
-  ports: [ 20107 ]
-
-maxConcurrentWorkers: 3
-enable: getui
-geTui:
-  pushUrl: "https://restapi.getui.com/v2/$appId"
-  masterSecret: ''
-  appKey: ''
-  intent: ''
-  channelID: ''
-  channelName: ''
-fcm:
-  serviceAccount: "x.json"
-jpns:
-  appKey: ''
-  masterSecret: ''
-  pushURL: ''
-  pushIntent: ''
-
-iosPush:
-      pushSound: "xxx"
-      badgeCount: true
-      production: false
-
-
-
-
-
-
-

config/openim-rpc-auth.yml

@@ -1,13 +0,0 @@
-rpc:
-  registerIP: ''
-  listenIP: 0.0.0.0
-  ports: [ 10160 ]
-
-prometheus:
-  enable: true
-  ports: [ 20106 ]
-
-tokenPolicy:
-  #token有效期，单位（天）
-  expire: 90
-

config/openim-rpc-conversation.yml

@@ -1,11 +0,0 @@
-rpc:
-  registerIP: ''
-  listenIP: 0.0.0.0
-  ports: [ 10180 ]
-
-prometheus:
-  enable: true
-  ports: [ 20105 ]
-
-
-

config/openim-rpc-friend.yml

@@ -1,8 +0,0 @@
-rpc:
-  registerIP: ''
-  listenIP: 0.0.0.0
-  ports: [ 10120 ]
-
-prometheus:
-  enable: true
-  ports: [ 20104 ]

config/openim-rpc-group.yml

@@ -1,9 +0,0 @@
-rpc:
-  registerIP: ''
-  listenIP: 0.0.0.0
-  ports: [ 10150 ]
-
-prometheus:
-  enable: true
-  ports: [ 20103 ]
-

config/openim-rpc-msg.yml

@@ -1,14 +0,0 @@
-rpc:
-  registerIP: ''
-  listenIP: 0.0.0.0
-  ports: [ 10130 ]
-
-prometheus:
-  enable: true
-  ports: [ 20102 ]
-
-#发消息是否需要好友验证
-friendVerify: false
-
-
-

config/openim-rpc-third.yml

@@ -1,40 +0,0 @@
-rpc:
-  registerIP: ''
-  listenIP: 0.0.0.0
-  ports: [ 10190 ]
-
-prometheus:
-  enable: true
-  ports: [ 20101 ]
-
-object:
-  enable: "minio"
-  cos:
-    bucketURL: https://temp-1252357374.cos.ap-chengdu.myqcloud.com
-    secretID: ''
-    secretKey: ''
-    sessionToken: ''
-    publicRead: false
-  oss:
-    endpoint: "https://oss-cn-chengdu.aliyuncs.com"
-    bucket: "demo-9999999"
-    bucketURL: "https://demo-9999999.oss-cn-chengdu.aliyuncs.com"
-    accessKeyID: ''
-    accessKeySecret: ''
-    sessionToken: ''
-    publicRead: false
-  kodo:
-    endpoint: "webhook://s3.cn-east-1.qiniucs.com"
-    bucket: "demo-9999999"
-    bucketURL: "webhook://your.domain.com"
-    accessKeyID: ''
-    accessKeySecret: ''
-    sessionToken: ''
-    publicRead: false
-  aws:
-    endpoint: "''"
-    region: "us-east-1"
-    bucket: "demo-9999999"
-    accessKeyID: ''
-    accessKeySecret: ''
-    publicRead: false

config/openim-rpc-user.yml

@@ -1,17 +0,0 @@
-rpc:
-  # API or other RPCs can access this RPC through this IP; if left blank, the internal network IP is obtained by default
-  registerIP: ''
-  # Listening IP; 0.0.0.0 means both internal and external IPs are listened to, if blank, the internal network IP is automatically obtained by default
-  listenIP: 0.0.0.0
-  # Listening ports; if multiple are configured, multiple instances will be launched, and must be consistent with the number of prometheus.ports
-  ports: [ 10110 ]
-
-prometheus:
-  # Whether to enable prometheus
-  enable: true
-  # Prometheus listening ports, must be consistent with the number of rpc.ports
-  ports: [ 20100 ]
-
-
-
-

config/redis.yml

@@ -1,7 +0,0 @@
-address: [ localhost:16379 ]
-username: ''
-password: openIM123
-enablePipeline: false
-clusterMode: false
-db: 0
-maxRetry: 10

config/share.yml

@@ -1,15 +0,0 @@
-secret: openIM123
-env: zookeeper
-rpcRegisterName:
-  user: user
-  friend: friend
-  msg: msg
-  push: push
-  messageGateway: messageGateway
-  group: group
-  auth: auth
-  conversation: conversation
-  third: third
-
-imAdminUserID: [ "imAdmin" ]
-

config/templates/config.yaml.template

@@ -1,3 +1,24 @@
+# Copyright © 2023 OpenIM. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the License);
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# -----------------------------------------------------------------
+# TODO: This config file is the template file
+# --| source: deployments/templates/config.yaml
+# --| env: scripts/install/environment
+# --| target: config/config.yaml
+# -----------------------------------------------------------------
+
 envs:
   discovery: zookeeper
 
@@ -101,14 +122,14 @@ api:
 # minio.signEndpoint is minio public network address
 object:
   enable: "minio"
-  apiURL: "http://127.0.0.1:10002"
+  apiURL: "http://172.28.0.1:10002"
   minio:
     bucket: "openim"
     endpoint: "http://172.28.0.1:10005"
     accessKeyID: "root"
     secretAccessKey: "openIM123"
     sessionToken: ''
-    signEndpoint: "http://127.0.0.1:10005"
+    signEndpoint: "http://172.28.0.1:10005"
     publicRead: false
   cos:
     bucketURL: https://temp-1252357374.cos.ap-chengdu.myqcloud.com
@@ -133,8 +154,8 @@ object:
     sessionToken: ''
     publicRead: false
   aws:
-    endpoint: "''" # This might not be necessary unless you're using a custom endpoint
-    region: "us-east-1"
+    endpoint: ""
+    region: ""
     bucket: "demo-9999999"
     accessKeyID: ''
     accessKeySecret: ''
@@ -179,7 +200,7 @@ rpcRegisterName:
 # Whether to output in json format
 # Whether to include stack trace in logs
 log:
-  storageLocation: /data/workspaces/open-im-server/_output/logs/
+  storageLocation: /workspaces/open-im-server/logs/
   rotationTime: 24
   remainRotationCount: 2
   remainLogLevel: 6
@@ -229,10 +250,9 @@ push:
 #
 # Built-in app manager user IDs
 # Built-in app manager nicknames
-# Attention, this configure is discarded. If you have used him before, configure your own
 manager:
-  userID:
-  nickname:
+  userID: [ "openIM123456", "openIM654321", "openIMAdmin" ]
+  nickname: [ "system1", "system2", "system3" ]
 
 # chatAdmin, use for send notification
 #
@@ -316,7 +336,7 @@ callback:
     timeout: 5
     failedContinue: true
   afterSendSingleMsg:
-    enable: false
+    enable: true
     timeout: 5
     failedContinue: true
   beforeSendGroupMsg:
@@ -501,7 +521,7 @@ callback:
 # The number of ports needs to be consistent with msg_transfer_service_num in script/path_info.sh
 prometheus:
   enable: true
-  grafanaUrl: http://127.0.0.1:13000/
+  grafanaUrl: http://172.28.0.1:13000/
   apiPrometheusPort: [20100]
   userPrometheusPort: [ 20110 ]
   friendPrometheusPort: [ 20120 ]
@@ -514,39 +534,3 @@ prometheus:
   rtcPrometheusPort: [ 21300 ]
   thirdPrometheusPort: [ 21301 ]
   messageTransferPrometheusPort: [ 21400, 21401, 21402, 21403 ] # List of ports
-
-###################### LocalCache configuration information ######################
-# topic: redis subscriber channel
-# slotNum: number of slots, multiple slots can prevent too many keys from competing for a lock
-# slotSize: number of slots, the number of cached keys per slot, the overall cache quantity is slotNum * slotSize
-# successExpire: successful cache time seconds
-# failedExpire: failed cache time seconds
-# disable local caching and annotate topic, slotNum, and slotSize
-localCache:
-  user:
-    topic: DELETE_CACHE_USER
-    slotNum: 100
-    slotSize: 2000
-    successExpire: 300
-    failedExpire: 5
-
-  group:
-    topic: DELETE_CACHE_GROUP
-    slotNum: 100
-    slotSize: 2000
-    successExpire: 300
-    failedExpire: 5
-
-  friend:
-    topic: DELETE_CACHE_FRIEND
-    slotNum: 100
-    slotSize: 2000
-    successExpire: 300
-    failedExpire: 5
-
-  conversation:
-    topic: DELETE_CACHE_CONVERSATION
-    slotNum: 100
-    slotSize: 2000
-    successExpire: 300
-    failedExpire: 5

config/templates/env.template

@@ -25,7 +25,7 @@
 
 # Data storage directory for persistent data.
 # Example: DATA_DIR=/path/to/data
-DATA_DIR=/data/workspaces/open-im-server
+DATA_DIR=/workspaces/open-im-server
 
 # Docker image registry. Uncomment the preferred one.
 # Options: ghcr.io/openimsdk, openim, registry.cn-hangzhou.aliyuncs.com/openimsdk
@@ -91,7 +91,7 @@ ALERT_MANAGER_NETWORK_ADDRESS=172.28.0.14
 # ==============================================================================
 # Local IP address of the service. Modify if necessary.
 # Example: OPENIM_IP=172.28.0.1，
-OPENIM_IP=127.0.0.1
+OPENIM_IP=172.28.0.1
 
 # ----- ZooKeeper Configuration -----
 # Port for ZooKeeper service.
@@ -100,7 +100,7 @@ ZOOKEEPER_PORT=12181
 
 # MongoDB service port configuration.
 # Default: MONGO_PORT=37017
-MONGO_PORT=37017
+# MONGO_PORT=37017
 
 # Password for MongoDB admin user. Used for service authentication.
 # Default: MONGO_PASSWORD=openIM123
@@ -143,7 +143,7 @@ KAFKA_LATESTMSG_REDIS_TOPIC=latestMsgToRedis
 # MINIO_PORT
 # ----------
 # MINIO_PORT sets the port for the MinIO object storage service.
-# Upon changing this port, the MinIO endpoint URLs in the config/config.yaml file must be updated
+# Upon changing this port, the MinIO endpoint URLs in the  file must be updated
 # to reflect this change. The endpoints include both the 'endpoint' and 'signEndpoint' 
 # under the MinIO configuration.
 #

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

@@ -66,7 +66,6 @@ server {
                 proxy_set_header Connection "Upgrade";
                 proxy_set_header X-real-ip $remote_addr;
                 proxy_set_header X-Forwarded-For $remote_addr;
-                proxy_set_header X-Request-Api $scheme://$host/api;
                 proxy_pass http://im_api/;
                }
         location ^~/grafana/ { #10007  prometheus

config/templates/prometheus-dashboard.yaml

@@ -1213,7 +1213,7 @@
               "editorMode": "code",
               "expr": "sum(rate(app_requests_total{job=~\"^($job)$\"}[$interval])) by (job)",
               "instant": false,
-              "legendFormat": "{{job}}-webhook",
+              "legendFormat": "{{job}}-http",
               "range": true,
               "refId": "A"
             },

config/webhooks.yml

@@ -1,156 +0,0 @@
-url: "webhook://127.0.0.1:10008/callbackExample"
-beforeSendSingleMsg:
-  enable: false
-  timeout: 5
-  failedContinue: true
-beforeUpdateUserInfoEx:
-  enable:  false
-  timeout: 5
-  failedContinue: true
-afterUpdateUserInfoEx:
-  enable:  false
-  timeout: 5
-afterSendSingleMsg:
-  enable: false
-  timeout: 5
-beforeSendGroupMsg:
-  enable: false
-  timeout: 5
-  failedContinue: true
-beforeMsgModify:
-  enable: false
-  timeout: 5
-  failedContinue: true
-afterSendGroupMsg:
-  enable: false
-  timeout: 5
-afterUserOnline:
-  enable: false
-  timeout: 5
-afterUserOffline:
-  enable: false
-  timeout: 5
-afterUserKickOff:
-  enable: false
-  timeout: 5
-beforeOfflinePush:
-  enable: false
-  timeout: 5
-  failedContinue: true
-beforeOnlinePush:
-  enable: false
-  timeout: 5
-  failedContinue: true
-beforeGroupOnlinePush:
-  enable: false
-  timeout: 5
-  failedContinue: true
-beforeAddFriend:
-  enable: false
-  timeout: 5
-  failedContinue: true
-beforeUpdateUserInfo:
-  enable: false
-  timeout: 5
-  failedContinue: true
-afterUpdateUserInfo:
-  enable: false
-  timeout: 5
-beforeCreateGroup:
-  enable: false
-  timeout: 5
-  failedContinue: true
-afterCreateGroup:
-  enable: false
-  timeout: 5
-beforeMemberJoinGroup:
-  enable: false
-  timeout: 5
-  failedContinue: true
-beforeSetGroupMemberInfo:
-  enable: false
-  timeout: 5
-  failedContinue: true
-afterSetGroupMemberInfo:
-  enable: false
-  timeout: 5
-afterQuitGroup:
-  enable: false
-  timeout: 5
-afterKickGroupMember:
-  enable: false
-  timeout: 5
-afterDismissGroup:
-  enable: false
-  timeout: 5
-beforeApplyJoinGroup:
-  enable: false
-  timeout: 5
-  failedContinue: true
-afterGroupMsgRead:
-  enable: false
-  timeout: 5
-afterSingleMsgRead:
-  enable: false
-  timeout: 5
-beforeUserRegister:
-  enable: false
-  timeout: 5
-  failedContinue: true
-afterUserRegister:
-  enable: false
-  timeout: 5
-afterTransferGroupOwner:
-  enable: false
-  timeout: 5
-beforeSetFriendRemark:
-  enable: false
-  timeout: 5
-  failedContinue: true
-afterSetFriendRemark:
-  enable: false
-  timeout: 5
-afterGroupMsgRevoke:
-  enable: false
-  timeout: 5
-afterJoinGroup:
-  enable: false
-  timeout: 5
-beforeInviteUserToGroup:
-  enable: false
-  timeout: 5
-  failedContinue: true
-afterSetGroupInfo:
-  enable: false
-  timeout: 5
-beforeSetGroupInfo:
-  enable: false
-  timeout: 5
-  failedContinue: true
-afterRevokeMsg:
-  enable: false
-  timeout: 5
-beforeAddBlack:
-  enable: false
-  timeout: 5
-  failedContinue:
-afterAddFriend:
-  enable: false
-  timeout: 5
-beforeAddFriendAgree:
-  enable: false
-  timeout: 5
-  failedContinue: true
-afterDeleteFriend:
-  enable: false
-  timeout: 5
-beforeImportFriends:
-  enable: false
-  timeout: 5
-  failedContinue: true
-afterImportFriends:
-  enable: false
-  timeout: 5
-afterRemoveBlack:
-  enable: false
-  timeout: 5

config/zookeeper.yml

@@ -1,6 +0,0 @@
-
-schema: openim
-address: [ localhost:12181 ]
-username: ''
-password: ''
-

deployments/charts/openim-api/templates/deployment.yaml

@@ -48,17 +48,17 @@ spec:
           image: "{{ .Values.image.repository }}:{{ .Values.image.tag | default .Chart.AppVersion }}"
           imagePullPolicy: {{ .Values.image.pullPolicy }}
           ports:
-            - name: webhook
+            - name: http
               containerPort: 80
               protocol: TCP
           #livenessProbe:
           #  httpGet:
           #    path: /
-          #    port: webhook
+          #    port: http
           #readinessProbe:
           #  httpGet:
           #    path: /
-          #    port: webhook
+          #    port: http
           resources:
             {{- toYaml .Values.resources | nindent 12 }}
           volumeMounts:

deployments/charts/openim-api/templates/service.yaml

@@ -22,8 +22,8 @@ spec:
   type: {{ .Values.service.type }}
   ports:
     - port: {{ .Values.service.port }}
-      targetPort: webhook
+      targetPort: http
       protocol: TCP
-      name: webhook
+      name: http
   selector:
     {{- include "openim-api.selectorLabels" . | nindent 4 }}

deployments/charts/openim-msggateway/templates/deployment.yaml

@@ -48,7 +48,7 @@ spec:
           image: "{{ .Values.image.repository }}:{{ .Values.image.tag | default .Chart.AppVersion }}"
           imagePullPolicy: {{ .Values.image.pullPolicy }}
           ports:
-            - name: webhook
+            - name: http
               containerPort: 80
               protocol: TCP
             - name: rpc
@@ -57,11 +57,11 @@ spec:
           #livenessProbe:
           #  httpGet:
           #    path: /
-          #    port: webhook
+          #    port: http
           #readinessProbe:
           #  httpGet:
           #    path: /
-          #    port: webhook
+          #    port: http
           resources:
             {{- toYaml .Values.resources | nindent 12 }}
           volumeMounts:

deployments/charts/openim-msggateway/templates/service.yaml

@@ -22,9 +22,9 @@ spec:
   type: {{ .Values.service.type }}
   ports:
     - port: {{ .Values.service.port }}
-      targetPort: webhook
+      targetPort: http
       protocol: TCP
-      name: webhook
+      name: http
     - port: 88
       targetPort: rpc
       protocol: TCP

deployments/charts/openim-msgtransfer/templates/deployment.yaml

@@ -48,17 +48,17 @@ spec:
           image: "{{ .Values.image.repository }}:{{ .Values.image.tag | default .Chart.AppVersion }}"
           imagePullPolicy: {{ .Values.image.pullPolicy }}
           ports:
-            - name: webhook
+            - name: http
               containerPort: 80
               protocol: TCP
           #livenessProbe:
           #  httpGet:
           #    path: /
-          #    port: webhook
+          #    port: http
           #readinessProbe:
           #  httpGet:
           #    path: /
-          #    port: webhook
+          #    port: http
           resources:
             {{- toYaml .Values.resources | nindent 12 }}
           volumeMounts:

deployments/charts/openim-msgtransfer/templates/service.yaml

@@ -22,8 +22,8 @@ spec:
   type: {{ .Values.service.type }}
   ports:
     - port: {{ .Values.service.port }}
-      targetPort: webhook
+      targetPort: http
       protocol: TCP
-      name: webhook
+      name: http
   selector:
     {{- include "openim-msgtransfer.selectorLabels" . | nindent 4 }}

deployments/charts/openim-push/templates/deployment.yaml

@@ -48,17 +48,17 @@ spec:
           image: "{{ .Values.image.repository }}:{{ .Values.image.tag | default .Chart.AppVersion }}"
           imagePullPolicy: {{ .Values.image.pullPolicy }}
           ports:
-            - name: webhook
+            - name: http
               containerPort: 80
               protocol: TCP
           #livenessProbe:
           #  httpGet:
           #    path: /
-          #    port: webhook
+          #    port: http
           #readinessProbe:
           #  httpGet:
           #    path: /
-          #    port: webhook
+          #    port: http
           resources:
             {{- toYaml .Values.resources | nindent 12 }}
           volumeMounts:

deployments/charts/openim-push/templates/service.yaml

@@ -22,8 +22,8 @@ spec:
   type: {{ .Values.service.type }}
   ports:
     - port: {{ .Values.service.port }}
-      targetPort: webhook
+      targetPort: http
       protocol: TCP
-      name: webhook
+      name: http
   selector:
     {{- include "openim-push.selectorLabels" . | nindent 4 }}

deployments/charts/openim-rpc-auth/templates/deployment.yaml

@@ -48,17 +48,17 @@ spec:
           image: "{{ .Values.image.repository }}:{{ .Values.image.tag | default .Chart.AppVersion }}"
           imagePullPolicy: {{ .Values.image.pullPolicy }}
           ports:
-            - name: webhook
+            - name: http
               containerPort: 80
               protocol: TCP
           #livenessProbe:
           #  httpGet:
           #    path: /
-          #    port: webhook
+          #    port: http
           #readinessProbe:
           #  httpGet:
           #    path: /
-          #    port: webhook
+          #    port: http
           resources:
             {{- toYaml .Values.resources | nindent 12 }}
           volumeMounts:

deployments/charts/openim-rpc-auth/templates/service.yaml

@@ -22,8 +22,8 @@ spec:
   type: {{ .Values.service.type }}
   ports:
     - port: {{ .Values.service.port }}
-      targetPort: webhook
+      targetPort: http
       protocol: TCP
-      name: webhook
+      name: http
   selector:
     {{- include "openim-rpc-auth.selectorLabels" . | nindent 4 }}

deployments/charts/openim-rpc-conversation/templates/deployment.yaml

@@ -48,17 +48,17 @@ spec:
           image: "{{ .Values.image.repository }}:{{ .Values.image.tag | default .Chart.AppVersion }}"
           imagePullPolicy: {{ .Values.image.pullPolicy }}
           ports:
-            - name: webhook
+            - name: http
               containerPort: 80
               protocol: TCP
           #livenessProbe:
           #  httpGet:
           #    path: /
-          #    port: webhook
+          #    port: http
           #readinessProbe:
           #  httpGet:
           #    path: /
-          #    port: webhook
+          #    port: http
           resources:
             {{- toYaml .Values.resources | nindent 12 }}
           volumeMounts:

deployments/charts/openim-rpc-conversation/templates/service.yaml

@@ -22,8 +22,8 @@ spec:
   type: {{ .Values.service.type }}
   ports:
     - port: {{ .Values.service.port }}
-      targetPort: webhook
+      targetPort: http
       protocol: TCP
-      name: webhook
+      name: http
   selector:
     {{- include "openim-rpc-conversation.selectorLabels" . | nindent 4 }}

deployments/charts/openim-rpc-friend/templates/deployment.yaml

@@ -48,17 +48,17 @@ spec:
           image: "{{ .Values.image.repository }}:{{ .Values.image.tag | default .Chart.AppVersion }}"
           imagePullPolicy: {{ .Values.image.pullPolicy }}
           ports:
-            - name: webhook
+            - name: http
               containerPort: 80
               protocol: TCP
           #livenessProbe:
           #  httpGet:
           #    path: /
-          #    port: webhook
+          #    port: http
           #readinessProbe:
           #  httpGet:
           #    path: /
-          #    port: webhook
+          #    port: http
           resources:
             {{- toYaml .Values.resources | nindent 12 }}
           volumeMounts:

deployments/charts/openim-rpc-friend/templates/service.yaml

@@ -22,8 +22,8 @@ spec:
   type: {{ .Values.service.type }}
   ports:
     - port: {{ .Values.service.port }}
-      targetPort: webhook
+      targetPort: http
       protocol: TCP
-      name: webhook
+      name: http
   selector:
     {{- include "openim-rpc-friend.selectorLabels" . | nindent 4 }}

deployments/charts/openim-rpc-group/templates/deployment.yaml

@@ -48,17 +48,17 @@ spec:
           image: "{{ .Values.image.repository }}:{{ .Values.image.tag | default .Chart.AppVersion }}"
           imagePullPolicy: {{ .Values.image.pullPolicy }}
           ports:
-            - name: webhook
+            - name: http
               containerPort: 80
               protocol: TCP
           #livenessProbe:
           #  httpGet:
           #    path: /
-          #    port: webhook
+          #    port: http
           #readinessProbe:
           #  httpGet:
           #    path: /
-          #    port: webhook
+          #    port: http
           resources:
             {{- toYaml .Values.resources | nindent 12 }}
           volumeMounts:

deployments/charts/openim-rpc-group/templates/service.yaml

@@ -22,8 +22,8 @@ spec:
   type: {{ .Values.service.type }}
   ports:
     - port: {{ .Values.service.port }}
-      targetPort: webhook
+      targetPort: http
       protocol: TCP
-      name: webhook
+      name: http
   selector:
     {{- include "openim-rpc-group.selectorLabels" . | nindent 4 }}

deployments/charts/openim-rpc-msg/templates/deployment.yaml

@@ -48,17 +48,17 @@ spec:
           image: "{{ .Values.image.repository }}:{{ .Values.image.tag | default .Chart.AppVersion }}"
           imagePullPolicy: {{ .Values.image.pullPolicy }}
           ports:
-            - name: webhook
+            - name: http
               containerPort: 80
               protocol: TCP
           #livenessProbe:
           #  httpGet:
           #    path: /
-          #    port: webhook
+          #    port: http
           #readinessProbe:
           #  httpGet:
           #    path: /
-          #    port: webhook
+          #    port: http
           resources:
             {{- toYaml .Values.resources | nindent 12 }}
           volumeMounts:

deployments/charts/openim-rpc-msg/templates/service.yaml

@@ -22,8 +22,8 @@ spec:
   type: {{ .Values.service.type }}
   ports:
     - port: {{ .Values.service.port }}
-      targetPort: webhook
+      targetPort: http
       protocol: TCP
-      name: webhook
+      name: http
   selector:
     {{- include "openim-rpc-msg.selectorLabels" . | nindent 4 }}

deployments/charts/openim-rpc-third/templates/deployment.yaml

@@ -48,17 +48,17 @@ spec:
           image: "{{ .Values.image.repository }}:{{ .Values.image.tag | default .Chart.AppVersion }}"
           imagePullPolicy: {{ .Values.image.pullPolicy }}
           ports:
-            - name: webhook
+            - name: http
               containerPort: 80
               protocol: TCP
           #livenessProbe:
           #  httpGet:
           #    path: /
-          #    port: webhook
+          #    port: http
           #readinessProbe:
           #  httpGet:
           #    path: /
-          #    port: webhook
+          #    port: http
           resources:
             {{- toYaml .Values.resources | nindent 12 }}
           volumeMounts:

deployments/charts/openim-rpc-third/templates/service.yaml

@@ -22,8 +22,8 @@ spec:
   type: {{ .Values.service.type }}
   ports:
     - port: {{ .Values.service.port }}
-      targetPort: webhook
+      targetPort: http
       protocol: TCP
-      name: webhook
+      name: http
   selector:
     {{- include "openim-rpc-third.selectorLabels" . | nindent 4 }}

deployments/charts/openim-rpc-user/templates/deployment.yaml

@@ -48,17 +48,17 @@ spec:
           image: "{{ .Values.image.repository }}:{{ .Values.image.tag | default .Chart.AppVersion }}"
           imagePullPolicy: {{ .Values.image.pullPolicy }}
           ports:
-            - name: webhook
+            - name: http
               containerPort: 80
               protocol: TCP
           #livenessProbe:
           #  httpGet:
           #    path: /
-          #    port: webhook
+          #    port: http
           #readinessProbe:
           #  httpGet:
           #    path: /
-          #    port: webhook
+          #    port: http
           resources:
             {{- toYaml .Values.resources | nindent 12 }}
           volumeMounts:

deployments/charts/openim-rpc-user/templates/service.yaml

@@ -22,8 +22,8 @@ spec:
   type: {{ .Values.service.type }}
   ports:
     - port: {{ .Values.service.port }}
-      targetPort: webhook
+      targetPort: http
       protocol: TCP
-      name: webhook
+      name: http
   selector:
     {{- include "openim-rpc-user.selectorLabels" . | nindent 4 }}

deployments/templates/config.yaml

@@ -323,7 +323,7 @@ iosPush:
 # Timeout in seconds
 # Whether to continue execution if callback fails
 callback:
-  url: "webhook://127.0.0.1:10008/callbackExample"
+  url: "http://127.0.0.1:10008/callbackExample"
   beforeSendSingleMsg:
     enable: ${CALLBACK_ENABLE}
     timeout: ${CALLBACK_TIMEOUT}

docker-compose-1.yml

@@ -0,0 +1,298 @@
+#fixme  Clone openIM Server project before using docker-compose,project address：https://github.com/OpenIMSDK/Open-IM-Server.git
+#  The command that triggers this file to pull the image is "docker compose up -f"
+version: '3'
+
+networks:
+  server:
+    driver: bridge
+    ipam:
+      driver: default
+      config:
+        - subnet: '${DOCKER_BRIDGE_SUBNET:-172.28.0.0/16}'
+          gateway: '${DOCKER_BRIDGE_GATEWAY:-172.28.0.1}'
+
+services:
+  mongodb:
+    image: mongo:${MONGODB_IMAGE_VERSION-6.0.2}
+    ports:
+      - "${MONGO_PORT:-37017}:27017"
+    container_name: mongo
+    command: ["/bin/bash", "-c", "/docker-entrypoint-initdb.d/mongo-init.sh || true; docker-entrypoint.sh mongod --wiredTigerCacheSizeGB 1 --auth"]
+    volumes:
+      - "${DATA_DIR:-./}/components/mongodb/data/db:/data/db"
+      - "${DATA_DIR:-./}/components/mongodb/data/logs:/data/logs"
+      - "${DATA_DIR:-./}/components/mongodb/data/conf:/etc/mongo"
+      - "./scripts/mongo-init.sh:/docker-entrypoint-initdb.d/mongo-init.sh:ro"
+    environment:
+      - TZ=Asia/Shanghai
+      - wiredTigerCacheSizeGB=1
+      - MONGO_INITDB_ROOT_USERNAME=${MONGO_USERNAME:-root}
+      - MONGO_INITDB_ROOT_PASSWORD=${MONGO_PASSWORD:-openIM123}
+      - MONGO_INITDB_DATABASE=${MONGO_DATABASE:-openim_v3}
+      - MONGO_OPENIM_USERNAME=${MONGO_OPENIM_USERNAME:-openIM} # Non-root username
+      - MONGO_OPENIM_PASSWORD=${MONGO_OPENIM_PASSWORD:-openIM123456} # Non-root password
+    restart: always
+    networks:
+      server:
+        ipv4_address: ${MONGO_NETWORK_ADDRESS:-172.28.0.2}
+
+  redis:
+    image: redis:${REDIS_IMAGE_VERSION:-7.0.0}
+    container_name: redis
+    ports:
+      - "${REDIS_PORT:-16379}:6379"
+    volumes:
+      - "${DATA_DIR:-./}/components/redis/data:/data"
+      - "${DATA_DIR:-./}/components/redis/config/redis.conf:/usr/local/redis/config/redis.conf"
+    environment:
+      TZ: Asia/Shanghai
+    restart: always
+    sysctls:
+      net.core.somaxconn: 1024
+    command: redis-server --requirepass ${REDIS_PASSWORD:-openIM123} --appendonly yes
+    networks:
+      server:
+        ipv4_address: ${REDIS_NETWORK_ADDRESS:-172.28.0.3}
+
+  zookeeper:
+    image: bitnami/zookeeper:${ZOOKEEPER_IMAGE_VERSION:-3.8}
+    container_name: zookeeper
+    ports:
+     - "${ZOOKEEPER_PORT:-12181}:2181"
+    volumes:
+      - "/etc/localtime:/etc/localtime"
+    environment:
+      - ALLOW_ANONYMOUS_LOGIN=yes
+      - TZ="Asia/Shanghai"
+    restart: always
+    networks:
+      server:
+        ipv4_address: ${ZOOKEEPER_NETWORK_ADDRESS:-172.28.0.5}
+
+  kafka:
+    image: 'bitnami/kafka:${KAFKA_IMAGE_VERSION:-3.5.1}'
+    container_name: kafka
+    restart: always
+    user: ${KAFKA_USER:-root}
+    ports:
+      - "${KAFKA_PORT:-19094}:9094"
+    volumes:
+      - ./scripts/create-topic.sh:/opt/bitnami/kafka/create-topic.sh
+      - "${DATA_DIR:-./}/components/kafka:/bitnami/kafka"
+    command: >
+      bash -c "/opt/bitnami/scripts/kafka/run.sh & sleep 5; /opt/bitnami/kafka/create-topic.sh; wait"
+    environment:
+       - TZ=Asia/Shanghai
+       - KAFKA_CFG_NODE_ID=0
+       - KAFKA_CFG_PROCESS_ROLES=controller,broker
+       - KAFKA_CFG_CONTROLLER_QUORUM_VOTERS=0@<your_host>:9093
+       - KAFKA_CFG_LISTENERS=PLAINTEXT://:9092,CONTROLLER://:9093,EXTERNAL://:9094
+       - KAFKA_CFG_ADVERTISED_LISTENERS=PLAINTEXT://kafka:9092,EXTERNAL://${DOCKER_BRIDGE_GATEWAY:-172.28.0.1}:${KAFKA_PORT:-19094}
+      #  - KAFKA_CFG_ADVERTISED_LISTENERS=PLAINTEXT://kafka:9092,EXTERNAL://127.0.0.1:${KAFKA_PORT:-19094} # Mac Deployment
+       - KAFKA_CFG_LISTENER_SECURITY_PROTOCOL_MAP=CONTROLLER:PLAINTEXT,EXTERNAL:PLAINTEXT,PLAINTEXT:PLAINTEXT
+       - KAFKA_CFG_CONTROLLER_LISTENER_NAMES=CONTROLLER
+    networks:
+      server:
+        ipv4_address: ${KAFKA_NETWORK_ADDRESS:-172.28.0.4}
+
+  minio:
+    image: minio/minio:${MINIO_IMAGE_VERSION:-RELEASE.2024-01-11T07-46-16Z}
+    ports:
+      - "${MINIO_PORT:-10005}:9000"
+      - "9090:9090"
+    container_name: minio
+    volumes:
+      - "${DATA_DIR:-./}/components/mnt/data:/data"
+      - "${DATA_DIR:-./}/components/mnt/config:/root/.minio"
+    environment:
+      MINIO_ROOT_USER: "${MINIO_ACCESS_KEY:-root}"
+      MINIO_ROOT_PASSWORD: "${MINIO_SECRET_KEY:-openIM123}"
+    restart: always
+    command: minio server /data --console-address ':9090'
+    networks:
+      server:
+        ipv4_address: ${MINIO_NETWORK_ADDRESS:-172.28.0.6}
+
+  openim-web:
+    image: ${IMAGE_REGISTRY:-ghcr.io/openimsdk}/openim-web:${OPENIM_WEB_IMAGE_VERSION:-v3.5.0-docker}
+    container_name: openim-web
+    platform: linux/amd64
+    restart: always
+    ports:
+      - "${OPENIM_WEB_PORT:-11001}:80"
+    networks:
+      server:
+        ipv4_address: ${OPENIM_WEB_NETWORK_ADDRESS:-172.28.0.7}
+
+  openim-admin:
+    # https://github.com/openimsdk/open-im-server/issues/1662
+    image: ${IMAGE_REGISTRY:-ghcr.io/openimsdk}/openim-admin:${ADMIN_FRONT_VERSION:-toc-base-open-docker.35}
+    container_name: openim-admin
+    platform: linux/amd64
+    restart: always
+    ports:
+      - "${OPENIM_ADMIN_FRONT_PORT:-11002}:80"
+    networks:
+      server:
+        ipv4_address: ${OPENIM_ADMIN_FRONT_NETWORK_ADDRESS:-172.28.0.13}
+
+  prometheus:
+    image: prom/prometheus
+    container_name: prometheus
+    hostname: prometheus
+    restart: always
+    volumes:
+      - "${DATA_DIR:-./}/config/instance-down-rules.yml:/etc/prometheus/instance-down-rules.yml"
+      - "${DATA_DIR:-./}/config/prometheus.yml:/etc/prometheus/prometheus.yml"
+    ports:
+      - "${PROMETHEUS_PORT:-19090}:9090"
+    networks:
+      server:
+        ipv4_address: ${PROMETHEUS_NETWORK_ADDRESS:-172.28.0.10}
+
+  alertmanager:
+    image: prom/alertmanager
+    container_name: alertmanager
+    hostname: alertmanager
+    restart: always
+    volumes:
+      - ${DATA_DIR:-./}/config/alertmanager.yml:/etc/alertmanager/alertmanager.yml
+      - ${DATA_DIR:-./}/config/email.tmpl:/etc/alertmanager/email.tmpl
+    ports:
+      - "${ALERT_MANAGER_PORT:-19093}:9093"
+    networks:
+      server:
+        ipv4_address: ${ALERT_MANAGER_NETWORK_ADDRESS:-172.28.0.14}
+
+  grafana:
+    image: grafana/grafana
+    container_name: grafana
+    hostname: grafana
+    user: root
+    restart: always
+    ports:
+      - "${GRAFANA_PORT:-13000}:3000"
+    volumes:
+      - "${DATA_DIR:-./}/components/grafana:/var/lib/grafana"
+    networks:
+      server:
+        ipv4_address: ${GRAFANA_NETWORK_ADDRESS:-172.28.0.11}
+
+  node-exporter:
+    image: quay.io/prometheus/node-exporter
+    container_name: node-exporter
+    hostname: node-exporter
+    restart: always
+    ports:
+      - "${NODE_EXPORTER_PORT:-19100}:9100"
+    networks:
+      server:
+        ipv4_address: ${NODE_EXPORTER_NETWORK_ADDRESS:-172.28.0.12}
+
+### Source code deployment does not require pulling the following mirrors
+
+  # openim-server:
+  #   image: ${IMAGE_REGISTRY:-ghcr.io/openimsdk}/openim-server:${SERVER_IMAGE_VERSION:-main}
+  #   container_name: openim-server
+  #   ports:
+  #     - "${OPENIM_WS_PORT:-10001}:${OPENIM_WS_PORT:-10001}"
+  #     - "${API_OPENIM_PORT:-10002}:${API_OPENIM_PORT:-10002}"
+  #     - "${API_PROM_PORT:-20100}:${API_PROM_PORT:-20100}"
+  #     - "${USER_PROM_PORT:-20110}:${USER_PROM_PORT:-20110}"
+  #     - "${FRIEND_PROM_PORT:-20120}:${FRIEND_PROM_PORT:-20120}"
+  #     - "${MESSAGE_PROM_PORT:-20130}:${MESSAGE_PROM_PORT:-20130}"
+  #     - "${MSG_GATEWAY_PROM_PORT:-20140}:${MSG_GATEWAY_PROM_PORT:-20140}"
+  #     - "${GROUP_PROM_PORT:-20150}:${GROUP_PROM_PORT:-20150}"
+  #     - "${AUTH_PROM_PORT:-20160}:${AUTH_PROM_PORT:-20160}"
+  #     - "${PUSH_PROM_PORT:-20170}:${PUSH_PROM_PORT:-20170}"
+  #     - "${CONVERSATION_PROM_PORT:-20230}:${CONVERSATION_PROM_PORT:-20230}"
+  #     - "${RTC_PROM_PORT:-21300}:${RTC_PROM_PORT:-21300}"
+  #     - "${THIRD_PROM_PORT:-21301}:${THIRD_PROM_PORT:-21301}"
+  #     - "21400-21403:21400-21403"
+  #   healthcheck:
+  #     test: ["CMD", "/openim/openim-server/scripts/check-all.sh"]
+  #     interval: 120s
+  #     timeout: 30s
+  #     retries: 5
+  #   env_file:
+  #     - .env
+  #   environment:
+  #     - OPENIM_IP=${OPENIM_IP:-127.0.0.1}
+  #   volumes:
+  #     - "${DATA_DIR:-./}/openim-server/logs:/openim/openim-server/logs"
+  #     - "${DATA_DIR:-./}/openim-server/_output/logs:/openim/openim-server/_output/logs"
+  #     - "${DATA_DIR:-./}/openim-server/config:/openim/openim-server/config"
+  #   restart: always
+  #   depends_on:
+  #     - kafka
+  #     - mysql
+  #     - mongodb
+  #     - redis
+  #     - minio
+  #   logging:
+  #     driver: json-file
+  #     options:
+  #       max-size: "1g"
+  #       max-file: "2"
+  #   networks:
+  #     server:
+  #       ipv4_address: ${OPENIM_SERVER_NETWORK_ADDRESS:-172.28.0.8}
+
+  ### TODO: mysql is required to deploy the openim-chat component
+  # mysql:
+  #   image: mysql:${MYSQL_IMAGE_VERSION:-5.7}
+  #   platform: linux/amd64
+  #   ports:
+  #     - "${MYSQL_PORT:-13306}:3306"
+  #   container_name: mysql
+  #   volumes:
+  #     - "${DATA_DIR:-./}/components/mysql/data:/var/lib/mysql"
+  #     - "/etc/localtime:/etc/localtime"
+  #   environment:
+  #     MYSQL_ROOT_PASSWORD: "${MYSQL_PASSWORD:-openIM123}"
+  #   restart: always
+  #   networks:
+  #     server:
+  #       ipv4_address: ${MYSQL_NETWORK_ADDRESS:-172.28.0.15}
+
+  # openim-chat:
+  #   image: ${IMAGE_REGISTRY:-ghcr.io/openimsdk}/openim-chat:${CHAT_IMAGE_VERSION:-main}
+  #   container_name: openim-chat
+  #   healthcheck:
+  #     test: ["CMD", "/openim/openim-chat/scripts/check_all.sh"]
+  #     interval: 60s
+  #     timeout: 30s
+  #     retries: 5
+  #   env_file:
+  #     - .env
+  #   environment:
+  #     - ZOOKEEPER_ADDRESS=${DOCKER_BRIDGE_GATEWAY:-172.28.0.1}
+  #     - ZOOKEEPER_PORT=${ZOOKEEPER_PORT:-12181}
+  #     - OPENIM_SERVER_ADDRESS=http://${OPENIM_SERVER_ADDRESS:-172.28.0.1}
+  #     - API_OPENIM_PORT=${API_OPENIM_PORT:-10002}
+  #     - MYSQL_ADDRESS=${DOCKER_BRIDGE_GATEWAY:-172.28.0.1}
+  #     - MYSQL_PORT=${MYSQL_PORT:-13306}
+  #     - REDIS_ADDRESS=${DOCKER_BRIDGE_GATEWAY:-172.28.0.1}
+  #     - REDIS_PORT=${REDIS_PORT:-16379}
+  #   ports:
+  #     - "${OPENIM_CHAT_API_PORT:-10008}:10008"
+  #     - "${OPENIM_ADMIN_API_PORT:-10009}:10009"
+  #   volumes:
+  #     - "${DATA_DIR:-./}/components/openim-chat/logs:/openim/openim-chat/logs"
+  #     - "${DATA_DIR:-./}/components/openim-chat/_output/logs:/openim/openim-chat/_output/logs"
+  #     - "${DATA_DIR:-./}/components/openim-chat/config:/openim/openim-chat/config"
+  #   restart: always
+  #   # user: root:root
+  #   depends_on:
+  #     - mysql
+  #     - kafka
+  #     - redis
+  #     - zookeeper
+  #   logging:
+  #     driver: json-file
+  #     options:
+  #       max-size: "1g"
+  #       max-file: "2"
+  #   networks:
+  #     server:
+  #       ipv4_address: ${OPENIM_CHAT_NETWORK_ADDRESS:-172.28.0.9}

docker-compose.yml

@@ -1,121 +1,299 @@
+#fixme  Clone openIM Server project before using docker-compose,project address：https://github.com/OpenIMSDK/Open-IM-Server.git
+#  The command that triggers this file to pull the image is "docker compose up -d".
 version: '3'
 
 networks:
-  openim:
+  server:
     driver: bridge
+    ipam:
+      driver: default
+      config:
+        - subnet: '${DOCKER_BRIDGE_SUBNET:-172.28.0.0/16}'
+          gateway: '${DOCKER_BRIDGE_GATEWAY:-172.28.0.1}'
 
 services:
   mongodb:
-    image: "${MONGO_IMAGE}"
+    image: mongo:${MONGODB_IMAGE_VERSION-6.0.2}
     ports:
-      - "37017:27017"
+      - "${MONGO_PORT:-37017}:27017"
     container_name: mongo
-    command: ["/bin/bash", "-c", "/docker-entrypoint-initdb.d/mongo-init.sh; docker-entrypoint.sh mongod --wiredTigerCacheSizeGB 1 --auth"]
+    command: ["/bin/bash", "-c", "/docker-entrypoint-initdb.d/mongo-init.sh || true; docker-entrypoint.sh mongod --wiredTigerCacheSizeGB 1 --auth"]
     volumes:
-      - "${DATA_DIR}/components/mongodb/data/db:/data/db"
-      - "${DATA_DIR}/components/mongodb/data/logs:/data/logs"
-      - "${DATA_DIR}/components/mongodb/data/conf:/etc/mongo"
+      - "${DATA_DIR:-./}/components/mongodb/data/db:/data/db"
+      - "${DATA_DIR:-./}/components/mongodb/data/logs:/data/logs"
+      - "${DATA_DIR:-./}/components/mongodb/data/conf:/etc/mongo"
       - "./scripts/mongo-init.sh:/docker-entrypoint-initdb.d/mongo-init.sh:ro"
     environment:
       - TZ=Asia/Shanghai
       - wiredTigerCacheSizeGB=1
-      - MONGO_INITDB_ROOT_USERNAME=root
-      - MONGO_INITDB_ROOT_PASSWORD=openIM123
-      - MONGO_INITDB_DATABASE=openim_v3
-      - MONGO_OPENIM_USERNAME=openIM
-      - MONGO_OPENIM_PASSWORD=openIM123
+      - MONGO_INITDB_ROOT_USERNAME=${MONGO_USERNAME:-root}
+      - MONGO_INITDB_ROOT_PASSWORD=${MONGO_PASSWORD:-openIM123}
+      - MONGO_INITDB_DATABASE=${MONGO_DATABASE:-openim_v3}
+      - MONGO_OPENIM_USERNAME=${MONGO_OPENIM_USERNAME:-openIM} # Non-root username
+      - MONGO_OPENIM_PASSWORD=${MONGO_OPENIM_PASSWORD:-openIM123456} # Non-root password
     restart: always
     networks:
-      - openim
+      server:
+        ipv4_address: ${MONGO_NETWORK_ADDRESS:-172.28.0.2}
 
   redis:
-    image: "${REDIS_IMAGE}"
+    image: redis:${REDIS_IMAGE_VERSION:-7.0.0}
     container_name: redis
     ports:
-      - "16379:6379"
+      - "${REDIS_PORT:-16379}:6379"
     volumes:
-      - "${DATA_DIR}/components/redis/data:/data"
-      - "${DATA_DIR}/components/redis/config/redis.conf:/usr/local/redis/config/redis.conf"
+      - "${DATA_DIR:-./}/components/redis/data:/data"
+      - "${DATA_DIR:-./}/components/redis/config/redis.conf:/usr/local/redis/config/redis.conf"
     environment:
       TZ: Asia/Shanghai
     restart: always
     sysctls:
       net.core.somaxconn: 1024
-    command: redis-server /usr/local/redis/config/redis.conf --requirepass openIM123 --appendonly yes
+    command: redis-server --requirepass ${REDIS_PASSWORD:-openIM123} --appendonly yes
     networks:
-      - openim
+      server:
+        ipv4_address: ${REDIS_NETWORK_ADDRESS:-172.28.0.3}
 
   zookeeper:
-    image: "${ZOOKEEPER_IMAGE}"
+    image: bitnami/zookeeper:${ZOOKEEPER_IMAGE_VERSION:-3.8}
     container_name: zookeeper
     ports:
-      - "12181:2181"
+     - "${ZOOKEEPER_PORT:-12181}:2181"
+    volumes:
+      - "/etc/localtime:/etc/localtime"
     environment:
-      TZ: "Asia/Shanghai"
-      ALLOW_ANONYMOUS_LOGIN: "yes"
+      - ALLOW_ANONYMOUS_LOGIN=yes
+      - TZ="Asia/Shanghai"
     restart: always
     networks:
-      - openim
+      server:
+        ipv4_address: ${ZOOKEEPER_NETWORK_ADDRESS:-172.28.0.5}
 
   kafka:
-    image: "${KAFKA_IMAGE}"
+    image: 'bitnami/kafka:${KAFKA_IMAGE_VERSION:-3.5.1}'
     container_name: kafka
-    user: root
     restart: always
+    user: ${KAFKA_USER:-root}
     ports:
-      - "19094:9094"
+      - "${KAFKA_PORT:-19094}:9094"
     volumes:
       - ./scripts/create-topic.sh:/opt/bitnami/kafka/create-topic.sh
-      - "${DATA_DIR}/components/kafka:/bitnami/kafka"
+      - "${DATA_DIR:-./}/components/kafka:/bitnami/kafka"
     command: >
-      bash -c "/opt/bitnami/scripts/kafka/run.sh & /opt/bitnami/kafka/create-topic.sh; wait"
+      bash -c "/opt/bitnami/scripts/kafka/run.sh & sleep 5; /opt/bitnami/kafka/create-topic.sh; wait"
     environment:
-      TZ: Asia/Shanghai
-      KAFKA_CFG_NODE_ID: 0
-      KAFKA_CFG_PROCESS_ROLES: controller,broker
-      KAFKA_CFG_CONTROLLER_QUORUM_VOTERS: 0@kafka:9093
-      KAFKA_CFG_LISTENERS: PLAINTEXT://:9092,CONTROLLER://:9093,EXTERNAL://:9094
-      KAFKA_CFG_ADVERTISED_LISTENERS: PLAINTEXT://kafka:9092,EXTERNAL://localhost:19094
-      KAFKA_CFG_LISTENER_SECURITY_PROTOCOL_MAP: CONTROLLER:PLAINTEXT,EXTERNAL:PLAINTEXT,PLAINTEXT:PLAINTEXT
-      KAFKA_CFG_CONTROLLER_LISTENER_NAMES: CONTROLLER
+       - TZ=Asia/Shanghai
+       - KAFKA_CFG_NODE_ID=0
+       - KAFKA_CFG_PROCESS_ROLES=controller,broker
+       - KAFKA_CFG_CONTROLLER_QUORUM_VOTERS=0@<your_host>:9093
+       - KAFKA_CFG_LISTENERS=PLAINTEXT://:9092,CONTROLLER://:9093,EXTERNAL://:9094
+       - KAFKA_CFG_ADVERTISED_LISTENERS=PLAINTEXT://kafka:9092,EXTERNAL://${DOCKER_BRIDGE_GATEWAY:-172.28.0.1}:${KAFKA_PORT:-19094}
+      #  - KAFKA_CFG_ADVERTISED_LISTENERS=PLAINTEXT://kafka:9092,EXTERNAL://127.0.0.1:${KAFKA_PORT:-19094} # Mac Deployment
+       - KAFKA_CFG_LISTENER_SECURITY_PROTOCOL_MAP=CONTROLLER:PLAINTEXT,EXTERNAL:PLAINTEXT,PLAINTEXT:PLAINTEXT
+       - KAFKA_CFG_CONTROLLER_LISTENER_NAMES=CONTROLLER
     networks:
-      - openim
-
+      server:
+        ipv4_address: ${KAFKA_NETWORK_ADDRESS:-172.28.0.4}
 
   minio:
-    image: "${MINIO_IMAGE}"
+    image: minio/minio:${MINIO_IMAGE_VERSION:-RELEASE.2024-01-11T07-46-16Z}
     ports:
-      - "10005:9000"
-      - "19090:9090"
+      - "${MINIO_PORT:-10005}:9000"
+      - "9090:9090"
     container_name: minio
     volumes:
-      - "${DATA_DIR}/components/mnt/data:/data"
-      - "${DATA_DIR}/components/mnt/config:/root/.minio"
+      - "${DATA_DIR:-./}/components/mnt/data:/data"
+      - "${DATA_DIR:-./}/components/mnt/config:/root/.minio"
     environment:
-      TZ: Asia/Shanghai
-      MINIO_ROOT_USER: root
-      MINIO_ROOT_PASSWORD: openIM123
+      MINIO_ROOT_USER: "${MINIO_ACCESS_KEY:-root}"
+      MINIO_ROOT_PASSWORD: "${MINIO_SECRET_KEY:-openIM123}"
     restart: always
     command: minio server /data --console-address ':9090'
     networks:
-      - openim
+      server:
+        ipv4_address: ${MINIO_NETWORK_ADDRESS:-172.28.0.6}
 
-  openim-web-front:
-    image: ${OPENIM_WEB_FRONT_IMAGE}
-    container_name: openim-web-front
+  openim-web:
+    image: ${IMAGE_REGISTRY:-ghcr.io/openimsdk}/openim-web:${OPENIM_WEB_IMAGE_VERSION:-v3.5.0-docker}
+    container_name: openim-web
+    platform: linux/amd64
     restart: always
     ports:
-      - "11001:80"
+      - "${OPENIM_WEB_PORT:-11001}:80"
     networks:
-      - openim
+      server:
+        ipv4_address: ${OPENIM_WEB_NETWORK_ADDRESS:-172.28.0.7}
 
-  openim-admin-front:
-    image: ${OPENIM_ADMIN_FRONT_IMAGE}
-    container_name: openim-admin-front
+  openim-admin:
+    # https://github.com/openimsdk/open-im-server/issues/1662
+    image: ${IMAGE_REGISTRY:-ghcr.io/openimsdk}/openim-admin:${ADMIN_FRONT_VERSION:-toc-base-open-docker.35}
+    container_name: openim-admin
+    platform: linux/amd64
     restart: always
     ports:
-      - "11002:80"
+      - "${OPENIM_ADMIN_FRONT_PORT:-11002}:80"
     networks:
-      - openim
+      server:
+        ipv4_address: ${OPENIM_ADMIN_FRONT_NETWORK_ADDRESS:-172.28.0.13}
 
+### TODO: Uncomment, or deploy using openim docker: https://github.com/openimsdk/openim-docker
+### Uncomment and configure the following services as needed
 
+  # openim-server:
+  #   image: ${IMAGE_REGISTRY:-ghcr.io/openimsdk}/openim-server:${SERVER_IMAGE_VERSION:-main}
+  #   container_name: openim-server
+  #   ports:
+  #     - "${OPENIM_WS_PORT:-10001}:${OPENIM_WS_PORT:-10001}"
+  #     - "${API_OPENIM_PORT:-10002}:${API_OPENIM_PORT:-10002}"
+  #     - "${API_PROM_PORT:-20100}:${API_PROM_PORT:-20100}"
+  #     - "${USER_PROM_PORT:-20110}:${USER_PROM_PORT:-20110}"
+  #     - "${FRIEND_PROM_PORT:-20120}:${FRIEND_PROM_PORT:-20120}"
+  #     - "${MESSAGE_PROM_PORT:-20130}:${MESSAGE_PROM_PORT:-20130}"
+  #     - "${MSG_GATEWAY_PROM_PORT:-20140}:${MSG_GATEWAY_PROM_PORT:-20140}"
+  #     - "${GROUP_PROM_PORT:-20150}:${GROUP_PROM_PORT:-20150}"
+  #     - "${AUTH_PROM_PORT:-20160}:${AUTH_PROM_PORT:-20160}"
+  #     - "${PUSH_PROM_PORT:-20170}:${PUSH_PROM_PORT:-20170}"
+  #     - "${CONVERSATION_PROM_PORT:-20230}:${CONVERSATION_PROM_PORT:-20230}"
+  #     - "${RTC_PROM_PORT:-21300}:${RTC_PROM_PORT:-21300}"
+  #     - "${THIRD_PROM_PORT:-21301}:${THIRD_PROM_PORT:-21301}"
+  #     - "21400-21403:21400-21403"
+  #   healthcheck:
+  #     test: ["CMD", "/openim/openim-server/scripts/check-all.sh"]
+  #     interval: 120s
+  #     timeout: 30s
+  #     retries: 5
+  #   env_file:
+  #     - .env
+  #   environment:
+  #     - OPENIM_IP=${OPENIM_IP:-127.0.0.1}
+  #   volumes:
+  #     - "${DATA_DIR:-./}/openim-server/logs:/openim/openim-server/logs"
+  #     - "${DATA_DIR:-./}/openim-server/_output/logs:/openim/openim-server/_output/logs"
+  #     - "${DATA_DIR:-./}/openim-server/config:/openim/openim-server/config"
+  #   restart: always
+  #   depends_on:
+  #     - kafka
+  #     - mysql
+  #     - mongodb
+  #     - redis
+  #     - minio
+  #   logging:
+  #     driver: json-file
+  #     options:
+  #       max-size: "1g"
+  #       max-file: "2"
+  #   networks:
+  #     server:
+  #       ipv4_address: ${OPENIM_SERVER_NETWORK_ADDRESS:-172.28.0.8}
+
+### TODO: mysql is required to deploy the openim-chat component
+  # mysql:
+  #   image: mysql:${MYSQL_IMAGE_VERSION:-5.7}
+  #   platform: linux/amd64
+  #   ports:
+  #     - "${MYSQL_PORT:-13306}:3306"
+  #   container_name: mysql
+  #   volumes:
+  #     - "${DATA_DIR:-./}/components/mysql/data:/var/lib/mysql"
+  #     - "/etc/localtime:/etc/localtime"
+  #   environment:
+  #     MYSQL_ROOT_PASSWORD: "${MYSQL_PASSWORD:-openIM123}"
+  #   restart: always
+  #   networks:
+  #     server:
+  #       ipv4_address: ${MYSQL_NETWORK_ADDRESS:-172.28.0.15}
+
+  # openim-chat:
+  #   image: ${IMAGE_REGISTRY:-ghcr.io/openimsdk}/openim-chat:${CHAT_IMAGE_VERSION:-main}
+  #   container_name: openim-chat
+  #   healthcheck:
+  #     test: ["CMD", "/openim/openim-chat/scripts/check_all.sh"]
+  #     interval: 60s
+  #     timeout: 30s
+  #     retries: 5
+  #   env_file:
+  #     - .env
+  #   environment:
+  #     - ZOOKEEPER_ADDRESS=${DOCKER_BRIDGE_GATEWAY:-172.28.0.1}
+  #     - ZOOKEEPER_PORT=${ZOOKEEPER_PORT:-12181}
+  #     - OPENIM_SERVER_ADDRESS=http://${OPENIM_SERVER_ADDRESS:-172.28.0.1}
+  #     - API_OPENIM_PORT=${API_OPENIM_PORT:-10002}
+  #     - MYSQL_ADDRESS=${DOCKER_BRIDGE_GATEWAY:-172.28.0.1}
+  #     - MYSQL_PORT=${MYSQL_PORT:-13306}
+  #     - REDIS_ADDRESS=${DOCKER_BRIDGE_GATEWAY:-172.28.0.1}
+  #     - REDIS_PORT=${REDIS_PORT:-16379}
+  #   ports:
+  #     - "${OPENIM_CHAT_API_PORT:-10008}:10008"
+  #     - "${OPENIM_ADMIN_API_PORT:-10009}:10009"
+  #   volumes:
+  #     - "${DATA_DIR:-./}/components/openim-chat/logs:/openim/openim-chat/logs"
+  #     - "${DATA_DIR:-./}/components/openim-chat/_output/logs:/openim/openim-chat/_output/logs"
+  #     - "${DATA_DIR:-./}/components/openim-chat/config:/openim/openim-chat/config"
+  #   restart: always
+  #   # user: root:root
+  #   depends_on:
+  #     - mysql
+  #     - kafka
+  #     - redis
+  #     - zookeeper
+  #   logging:
+  #     driver: json-file
+  #     options:
+  #       max-size: "1g"
+  #       max-file: "2"
+  #   networks:
+  #     server:
+  #       ipv4_address: ${OPENIM_CHAT_NETWORK_ADDRESS:-172.28.0.9}
+
+  # prometheus:
+  #   image: prom/prometheus
+  #   container_name: prometheus
+  #   hostname: prometheus
+  #   restart: always
+  #   volumes:
+  #     - "${DATA_DIR:-./}/config/instance-down-rules.yml:/etc/prometheus/instance-down-rules.yml"
+  #     - "${DATA_DIR:-./}/config/prometheus.yml:/etc/prometheus/prometheus.yml"
+  #   ports:
+  #     - "${PROMETHEUS_PORT:-19090}:9090"
+  #   networks:
+  #     server:
+  #       ipv4_address: ${PROMETHEUS_NETWORK_ADDRESS:-172.28.0.10}
+
+  # alertmanager:
+  #   image: prom/alertmanager
+  #   container_name: alertmanager
+  #   hostname: alertmanager
+  #   restart: always
+  #   volumes:
+  #     - ${DATA_DIR:-./}/config/alertmanager.yml:/etc/alertmanager/alertmanager.yml
+  #     - ${DATA_DIR:-./}/config/email.tmpl:/etc/alertmanager/email.tmpl
+  #   ports:
+  #     - "${ALERT_MANAGER_PORT:-19093}:9093"
+  #   networks:
+  #     server:
+  #       ipv4_address: ${ALERT_MANAGER_NETWORK_ADDRESS:-172.28.0.14}
+
+  # grafana:
+  #   image: grafana/grafana
+  #   container_name: grafana
+  #   hostname: grafana
+  #   user: root
+  #   restart: always
+  #   ports:
+  #     - "${GRAFANA_PORT:-13000}:3000"
+  #   volumes:
+  #     - "${DATA_DIR:-./}/components/grafana:/var/lib/grafana"
+  #   networks:
+  #     server:
+  #       ipv4_address: ${GRAFANA_NETWORK_ADDRESS:-172.28.0.11}
+
+  # node-exporter:
+  #   image: quay.io/prometheus/node-exporter
+  #   container_name: node-exporter
+  #   hostname: node-exporter
+  #   restart: always
+  #   ports:
+  #     - "${NODE_EXPORTER_PORT:-19100}:9100"
+  #   networks:
+  #     server:
+  #       ipv4_address: ${NODE_EXPORTER_NETWORK_ADDRESS:-172.28.0.12}

docs/contrib/bash-log.md

@@ -2,8 +2,6 @@
 
 **PATH:** `scripts/lib/logging.sh`
 
-
-
 ### Introduction
 
 OpenIM, an intricate project, requires a robust logging mechanism to diagnose issues, maintain system health, and provide insights. A custom-built logging system embedded within OpenIM ensures consistent and structured logs. Let's delve into the design of this logging system and understand its various functions and their usage scenarios.

docs/contrib/go-code.md

@@ -115,83 +115,22 @@ var s = F()
 func F() string { return "A" }
 ```
 
-- This example emphasizes using PascalCase for exported constants and camelCase for unexported ones, avoiding all caps and underscores.
+- Use `_` as a prefix for unexported top-level constants and variables.
 
 ```go
 // bad
 const (
-    MAX_COUNT = 100
-    timeout = 30
+   defaultHost = "127.0.0.1"
+   defaultPort = 8080
 )
 
 // good
 const (
-    MaxCount = 100  // Exported constants should use PascalCase.
-    defaultTimeout = 30  // Unexported constants should use camelCase.
+   _defaultHost = "127.0.0.1"
+   _defaultPort = 8080
 )
 ```
 
-- Grouping related constants enhances organization and readability, especially when there are multiple constants related to a particular feature or configuration.
-
-```go
-// bad
-const apiVersion = "v1"
-const retryInterval = 5
-
-// good
-const (
-    ApiVersion    = "v1"  // Group related constants together for better organization.
-    RetryInterval = 5
-)
-```
-
-- The "good" practice utilizes iota for a clear, concise, and auto-incrementing way to define enumerations, reducing the potential for errors and improving maintainability.
-
-```go
-// bad
-const (
-    StatusActive   = 0
-    StatusInactive = 1
-    StatusUnknown  = 2
-)
-
-// good
-const (
-    StatusActive = iota  // Use iota for simple and efficient constant enumerations.
-    StatusInactive
-    StatusUnknown
-)
-```
-
-- Specifying types explicitly improves clarity, especially when the purpose or type of a constant might not be immediately obvious. Additionally, adding comments to exported constants or those whose purpose isn't clear from the name alone can greatly aid in understanding the code.
-
-```go
-// bad
-const serverAddress = "localhost:8080"
-const debugMode = 1  // Is this supposed to be a boolean or an int?
-
-// good
-const ServerAddress string = "localhost:8080"  // Specify type for clarity.
-// DebugMode indicates if the application should run in debug mode (true for debug mode).
-const DebugMode bool = true
-```
-
-- By defining a contextKey type and making userIDKey of this type, you avoid potential collisions with other context keys. This approach leverages Go's type system to provide compile-time checks against misuse.
-
-```go
-// bad
-const userIDKey = "userID"
-
-// In this example, userIDKey is a string type, which can lead to conflicts or accidental misuse because string keys are prone to typos and collisions in a global namespace.
-
-
-// good
-type contextKey string
-
-const userIDKey contextKey = "userID"
-```
-
-
 - Embedded types (such as mutexes) should be at the top of the field list within the struct, and there must be a blank line separating embedded fields from regular fields.
 
 ```go
@@ -327,59 +266,13 @@ errors.New("redis connection failed")
 - When specifying ranges of numbers, use inclusive ranges whenever possible.
 - Go 1.13 or above is recommended, and the error generation method is `fmt.Errorf("module xxx: %w", err)`.
 
-### 1.4 Panic Processing
-
-The use of `panic` should be carefully controlled in Go applications to ensure program stability and predictable error handling. Following are revised guidelines emphasizing the restriction on using `panic` and promoting alternative strategies for error handling and program termination.
-
-- **Prohibited in Business Logic:** Using `panic` within business logic processing is strictly prohibited. Business logic should handle errors gracefully and use error returns to propagate issues up the call stack.
-
-- **Restricted Use in Main Package:** In the main package, the use of `panic` should be reserved for situations where the program is entirely inoperable, such as failure to open essential files, inability to connect to the database, or other critical startup issues. Even in these scenarios, prefer using structured error handling to terminate the program.
-
-- **Prohibition on Exportable Interfaces:** Exportable interfaces must not invoke `panic`. They should handle errors gracefully and return errors as part of their contract.
-
-- **Prefer Errors Over Panic:** It is recommended to use error returns instead of panic to convey errors within a package. This approach promotes error handling that integrates smoothly with Go's error handling idioms.
-
-#### Alternative to Panic: Structured Program Termination
-
-To enforce these guidelines, consider implementing structured functions to terminate the program gracefully in the face of unrecoverable errors, while providing clear error messages. Here are two recommended functions:
-
-```go
-// ExitWithError logs an error message and exits the program with a non-zero status.
-func ExitWithError(err error) {
-	progName := filepath.Base(os.Args[0])
-	fmt.Fprintf(os.Stderr, "%s exit -1: %+v\n", progName, err)
-	os.Exit(-1)
-}
-
-// SIGTERMExit logs a warning message when the program receives a SIGTERM signal and exits with status 0.
-func SIGTERMExit() {
-	progName := filepath.Base(os.Args[0])
-	fmt.Fprintf(os.Stderr, "Warning %s receive process terminal SIGTERM exit 0\n", progName)
-}
-```
-
-#### Example Usage:
-
-```go
-import (
-	_ "net/webhook/pprof"
-
-	"github.com/openimsdk/open-im-server/v3/pkg/common/cmd"
-	util "github.com/openimsdk/open-im-server/v3/pkg/util/genutil"
-)
-
-func main() {
-	apiCmd := cmd.NewApiCmd()
-	apiCmd.AddPortFlag()
-	apiCmd.AddPrometheusPortFlag()
-	if err := apiCmd.Execute(); err != nil {
-		util.ExitWithError(err)
-	}
-}
-```
-
-In this example, `ExitWithError` is used to terminate the program when an unrecoverable error occurs, providing a clear error message to stderr and exiting with a non-zero status. This approach ensures that critical errors are logged and the program exits in a controlled manner, facilitating troubleshooting and maintaining the stability of the application.
+### 1.4 panic processing
 
+- Panic is prohibited in business logic processing.
+- In the main package, panic is only used when the program is completely inoperable, for example, the file cannot be opened, the database cannot be connected, and the program cannot run normally.
+- In the main package, use `log.Fatal` to record errors, so that the program can be terminated by the log, or the exception thrown by the panic can be recorded in the log file, which is convenient for troubleshooting.
+- An exportable interface must not panic.
+- It is recommended to use error instead of panic to convey errors in the package.
 
 ### 1.5 Unit Tests
 
@@ -416,31 +309,27 @@ The naming convention is a very important part of the code specification. A unif
 - Don't use broad, meaningless package names like common, util, shared or lib.
 - The package name should be simple and clear, such as net, time, log.
 
+### 2.2 Function Naming
 
-### 2.2 Function Naming Conventions
+- The function name is in camel case, and the first letter is uppercase or lowercase according to the access control decision,For example: `MixedCaps` or `mixedCaps`.
+- Code automatically generated by code generation tools (such as `xxxx.pb.go`) and underscores used to group related test cases (such as `TestMyFunction_WhatIsBeingTested`) exclude this rule.
 
-Function names should adhere to the following guidelines, inspired by OpenIM’s standards and Google’s Go Style Guide:
+In accordance with the naming conventions adopted by OpenIM and drawing reference from the Google Naming Conventions as per the guidelines available at https://google.github.io/styleguide/go/, the following expectations for naming practices within the project are set forth:
 
-- Use camel case for function names. Start with an uppercase letter for public functions (`MixedCaps`) and a lowercase letter for private functions (`mixedCaps`).
-- Exceptions to this rule include code automatically generated by tools (e.g., `xxxx.pb.go`) and test functions that use underscores for clarity (e.g., `TestMyFunction_WhatIsBeingTested`).
-
-### 2.3 File and Directory Naming Practices
-
-To maintain consistency and readability across the OpenIM project, observe the following naming practices:
-
-**File Names:**
-- Use underscores (`_`) as the default separator in filenames, keeping them short and descriptive.
-- Both hyphens (`-`) and underscores (`_`) are allowed, but underscores are preferred for general use.
-
-**Script and Markdown Files:**
-- Prefer hyphens (`-`) for shell scripts and Markdown (`.md`) files to enhance searchability and web compatibility.
-
-**Directories:**
-- Name directories with hyphens (`-`) exclusively to separate words, ensuring consistency and readability.
-
-Remember to keep filenames lowercase and use meaningful, concise identifiers to facilitate better organization and navigation within the project.
+1. **File Names:**
+   + Both hyphens (`-`) and underscores (`_`) are permitted when naming files.
+   + A preference is established for the use of underscores (`_`), suggesting it as the best practice in general scenarios.
+2. **Script and Markdown Files:**
+   + For shell scripts (bash files) and Markdown (`.md`) documents, the use of hyphens (`-`) is recommended.
+   + This recommendation is based on the improved searchability and compatibility in web browsers when hyphens are used in names.
+3. **Directories:**
+   + A consistent approach is mandated for naming directories, exclusively using hyphens (`-`) to separate words within directory names.
 
 
+### 2.3 File Naming
+
+- Keep the filename short and meaningful.
+- Filenames should be lowercase and use underscores to separate words.
 
 ### 2.4 Structure Naming
 
@@ -541,24 +430,19 @@ var LintGonicMapper = GonicMapper{
 - If the variable type is bool, the name should start with Has, Is, Can or Allow, for example:
 
 ```go
-var hasConflict bool
+var has Conflict bool
 var isExist bool
-var canManage bool
+var can Manage bool
 var allowGitHook bool
 ```
 
 - Local variables should be as short as possible, for example, use buf to refer to buffer, and use i to refer to index.
 - The code automatically generated by the code generation tool can exclude this rule (such as the Id in `xxx.pb.go`)
 
-### 2.7 Constant Naming
+### 2.7 Constant naming
 
-In Go, constants play a critical role in defining values that do not change throughout the execution of a program. Adhering to best practices in naming constants can significantly improve the readability and maintainability of your code. Here are some guidelines for constant naming:
-
-- **Camel Case Naming:** The name of a constant must follow the camel case notation. The initial letter should be uppercase or lowercase based on the access control requirements. Uppercase indicates that the constant is exported (visible outside the package), while lowercase indicates package-private visibility (visible only within its own package).
-
-- **Enumeration Type Constants:** For constants that represent a set of enumerated values, it's recommended to define a corresponding type first. This approach not only enhances type safety but also improves code readability by clearly indicating the purpose of the enumeration.
-
-**Example:**
+- The constant name must follow the camel case, and the initial letter is uppercase or lowercase according to the access control decision.
+- If it is a constant of enumeration type, you need to create the corresponding type first:
 
 ```go
 // Code defines an error code type.
@@ -568,40 +452,11 @@ type Code int
 const (
      // ErrUnknown - 0: An unknown error occurred.
      ErrUnknown Code = iota
-     // ErrFatal - 1: A fatal error occurred.
+     // ErrFatal - 1: An fatal error occurred.
      ErrFatal
 )
 ```
 
-In the example above, `Code` is defined as a new type based on `int`. The enumerated constants `ErrUnknown` and `ErrFatal` are then defined with explicit comments to indicate their purpose and values. This pattern is particularly useful for grouping related constants and providing additional context.
-
-### Global Variables and Constants Across Packages
-
-- **Use Constants for Global Variables:** When defining variables that are intended to be accessed across packages, prefer using constants to ensure immutability. This practice avoids unintended modifications to the value, which can lead to unpredictable behavior or hard-to-track bugs.
-
-- **Lowercase for Package-Private Usage:** If a global variable or constant is intended for use only within its own package, it should start with a lowercase letter. This clearly signals its limited scope of visibility, adhering to Go's access control mechanism based on naming conventions.
-
-**Guideline:**
-
-- For global constants that need to be accessed across packages, declare them with an uppercase initial letter. This makes them exported, adhering to Go's visibility rules.
-- For constants used within the same package, start their names with a lowercase letter to limit their scope to the package.
-
-**Example:**
-
-```go
-package config
-
-// MaxConnections - the maximum number of allowed connections. Visible across packages.
-const MaxConnections int = 100
-
-// minIdleTime - the minimum idle time before a connection is considered stale. Only visible within the config package.
-const minIdleTime int = 30
-```
-
-In this example, `MaxConnections` is a global constant meant to be accessed across packages, hence it starts with an uppercase letter. On the other hand, `minIdleTime` is intended for use only within the `config` package, so it starts with a lowercase letter.
-
-Following these guidelines ensures that your Go code is more readable, maintainable, and consistent with Go's design philosophy and access control mechanisms.
-
 ### 2.8 Error naming
 
 - The Error type should be written in the form of FooError.
@@ -618,190 +473,6 @@ type ExitError struct {
 var ErrFormat = errors. New("unknown format")
 ```
 
-For non-standard Err naming, CICD will report an error
-
-
-### 2.9 Handling Errors Properly
-
-In Go, proper error handling is crucial for creating reliable and maintainable applications. It's important to ensure that errors are not ignored or discarded, as this can lead to unpredictable behavior and difficult-to-debug issues. Here are the guidelines and examples regarding the proper handling of errors.
-
-#### Guideline: Do Not Discard Errors
-
-- **Mandatory Error Propagation:** When calling a function that returns an error, the calling function must handle or propagate the error, instead of ignoring it. This approach ensures that errors are not silently ignored, allowing higher-level logic to make informed decisions about error handling.
-
-#### Incorrect Example: Discarding an Error
-
-```go
-package main
-
-import (
-	"io/ioutil"
-	"log"
-)
-
-func ReadFileContent(filename string) string {
-	content, _ := ioutil.ReadFile(filename) // Incorrect: Error is ignored
-	return string(content)
-}
-
-func main() {
-	content := ReadFileContent("example.txt")
-	log.Println(content)
-}
-```
-
-In this incorrect example, the error returned by `ioutil.ReadFile` is ignored. This can lead to situations where the program continues execution even if the file doesn't exist or cannot be accessed, potentially causing more cryptic errors downstream.
-
-#### Correct Example: Propagating an Error
-
-```go
-package main
-
-import (
-	"io/ioutil"
-	"log"
-)
-
-// ReadFileContent attempts to read and return the content of the specified file.
-// It returns an error if reading fails.
-func ReadFileContent(filename string) (string, error) {
-	content, err := ioutil.ReadFile(filename)
-	if err != nil {
-		// Correct: Propagate the error
-		return "", err
-	}
-	return string(content), nil
-}
-
-func main() {
-	content, err := ReadFileContent("example.txt")
-	if err != nil {
-		log.Fatalf("Failed to read file: %v", err)
-	}
-	log.Println(content)
-}
-```
-
-In the correct example, the error returned by `ioutil.ReadFile` is propagated back to the caller. The `main` function then checks the error and terminates the program with an appropriate error message if an error occurred. This approach ensures that errors are handled appropriately, and the program does not proceed with invalid state.
-
-### Best Practices for Error Handling
-
-1. **Always check the error returned by a function.** Do not ignore it.
-2. **Propagate errors up the call stack unless they can be handled gracefully at the current level.**
-3. **Provide context for errors when propagating them, making it easier to trace the source of the error.** This can be achieved using `fmt.Errorf` with the `%w` verb or dedicated wrapping functions provided by some error handling packages.
-4. **Log the error at the point where it is handled or makes the program to terminate, to provide insight into the failure.**
-
-By following these guidelines, you ensure that your Go applications handle errors in a consistent and effective manner, improving their reliability and maintainability.
-
-
-### 2.10 Using Context with IO or Inter-Process Communication (IPC)
-
-In Go, `context.Context` is a powerful construct for managing deadlines, cancellation signals, and other request-scoped values across API boundaries and between processes. It is particularly important in I/O operations or inter-process communication (IPC), where operations might need to be cancelled or timed out.
-
-#### Guideline: Use Context for IO and IPC
-
-- **Mandatory Use of Context:** When performing I/O operations or inter-process communication, it's crucial to use `context.Context` to manage the lifecycle of these operations. This includes setting deadlines, handling cancellation signals, and passing request-scoped values.
-
-#### Incorrect Example: Ignoring Context in an HTTP Call
-
-```go
-package main
-
-import (
-	"io/ioutil"
-	"net/http"
-	"log"
-)
-
-// FetchData makes an HTTP GET request to the specified URL and returns the response body.
-// This function does not use context, making it impossible to cancel the request or set a deadline.
-func FetchData(url string) (string, error) {
-	resp, err := http.Get(url) // Incorrect: Ignoring context
-	if err != nil {
-		return "", err
-	}
-	defer resp.Body.Close()
-
-	body, err := ioutil.ReadAll(resp.Body)
-	if err != nil {
-		return "", err
-	}
-
-	return string(body), nil
-}
-
-func main() {
-	data, err := FetchData("http://example.com")
-	if err != nil {
-		log.Fatalf("Failed to fetch data: %v", err)
-	}
-	log.Println(data)
-}
-```
-
-In this incorrect example, the `FetchData` function makes an HTTP GET request without using a `context`. This approach does not allow the request to be cancelled or a timeout to be set, potentially leading to resources being wasted if the server takes too long to respond or if the operation needs to be aborted for any reason.
-
-#### Correct Example: Using Context in an HTTP Call
-
-```go
-package main
-
-import (
-	"context"
-	"io/ioutil"
-	"net/http"
-	"log"
-	"time"
-)
-
-// FetchDataWithContext makes an HTTP GET request to the specified URL using the provided context.
-// This allows the request to be cancelled or timed out according to the context's deadline.
-func FetchDataWithContext(ctx context.Context, url string) (string, error) {
-	req, err := http.NewRequestWithContext(ctx, "GET", url, nil)
-	if err != nil {
-		return "", err
-	}
-
-	resp, err := http.DefaultClient.Do(req)
-	if err != nil {
-		return "", err
-	}
-	defer resp.Body.Close()
-
-	body, err := ioutil.ReadAll(resp.Body)
-	if err != nil {
-		return "", err
-	}
-
-	return string(body), nil
-}
-
-func main() {
-	// Create a context with a 5-second timeout
-	ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
-	defer cancel()
-
-	data, err := FetchDataWithContext(ctx, "http://example.com")
-	if err != nil {
-		log.Fatalf("Failed to fetch data: %v", err)
-	}
-	log.Println(data)
-}
-```
-
-In the correct example, `FetchDataWithContext` uses a context to make the HTTP GET request. This allows the operation to be cancelled or subjected to a timeout, as dictated by the context passed to it. The `context.WithTimeout` function is used in `main` to create a context that cancels the request if it takes longer than 5 seconds, demonstrating a practical use of context to manage operation lifecycle.
-
-### Best Practices for Using Context
-
-1. **Pass context as the first parameter of a function**, following the convention `func(ctx context.Context, ...)`.
-2. **Never ignore the context** provided to you in functions that support it. Always use it in your I/O or IPC operations.
-3. **Avoid storing context in a struct**. Contexts are meant to be passed around within the call stack, not stored.
-4. **Use context's cancellation and deadline features** to control the lifecycle of blocking operations, especially in network I/O and IPC scenarios.
-5. **Propagate context down the call stack** to any function that supports it, ensuring that your application can respond to cancellation signals and deadlines effectively.
-
-By adhering to these guidelines and examples, you can ensure that your Go applications handle I/O and IPC operations more reliably and efficiently, with proper support for cancellation, timeouts, and request-scoped values.
-
-
 ## 3. Comment specification
 
 - Each exportable name must have a comment, which briefly introduces the exported variables, functions, structures, interfaces, etc.