diff --git a/.env b/.env index 145d7e917..b2252cc9c 100644 --- a/.env +++ b/.env @@ -1,3 +1,17 @@ +# Copyright © 2023 OpenIM. All rights reserved. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + # ====================================== # ========= Basic Configuration ======== # ====================================== diff --git a/.github/workflows/auto-gh-pr.yml b/.github/workflows/auto-gh-pr.yml index f76a0c70a..98e4d83ff 100644 --- a/.github/workflows/auto-gh-pr.yml +++ b/.github/workflows/auto-gh-pr.yml @@ -51,7 +51,7 @@ jobs: # git checkout -b bot/merge-to-release-$ISSUEID # git push origin bot/merge-to-release-$ISSUEID # gh pr create --base release --head bot/merge-to-release-$ISSUEID --title "Merge main to release" --body "" - # gh pr create --base main --head feat/auto-release-pr-624 --title "The bug is fixed" --body "$x" --repo OpenIMSDK/Open-IM-Server --reviewer "cubxxw" + # gh pr create --base main --head feat/auto-release-pr-624 --title "The bug is fixed" --body "$x" --repo openimsdk/open-im-server --reviewer "cubxxw" continue-on-error: true env: GITHUB_TOKEN: ${{ secrets.BOT_GITHUB_TOKEN }} diff --git a/.github/workflows/pull-request.yml b/.github/workflows/pull-request.yml index 9f3062fb2..d3a35e65d 100644 --- a/.github/workflows/pull-request.yml +++ b/.github/workflows/pull-request.yml @@ -114,7 +114,7 @@ jobs: - [ ] Disenchanter can connect and issue actions This is an automated PR. @ ${{ github.actor }} - [workflow](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/.github/workflows/pull-request.yml). + [workflow](https://github.com/openimsdk/open-im-server/blob/main/.github/workflows/pull-request.yml). base: main labels: | kind/documentation diff --git a/.gitignore b/.gitignore index 92408fa56..2d8f1e002 100644 --- a/.gitignore +++ b/.gitignore @@ -160,6 +160,7 @@ flycheck_*.el # Dependency directories (remove the comment below to include it) vendor/ +tools/imctl # Go workspace file # go.work diff --git a/.golangci.yml b/.golangci.yml index 3d50e109b..d588695dd 100644 --- a/.golangci.yml +++ b/.golangci.yml @@ -176,7 +176,7 @@ linters-settings: # put imports beginning with prefix after 3rd-party packages; # only support one prefix # if not set, use goimports.local-prefixes - prefix: github.com/OpenIMSDK/Open-IM-Server + prefix: github.com/openimsdk/open-im-server gocognit: # minimal code complexity to report, 30 by default (but we recommend 10-20) min-complexity: 30 @@ -333,7 +333,7 @@ linters-settings: goimports: # put imports beginning with prefix after 3rd-party packages; # it's a comma-separated list of prefixes - local-prefixes: github.com/OpenIMSDK/Open-IM-Server + local-prefixes: github.com/openimsdk/open-im-server gomnd: settings: diff --git a/CHANGELOG/.chglog/config.yml b/CHANGELOG/.chglog/config.yml index 296ca2eb7..2a45bc26a 100644 --- a/CHANGELOG/.chglog/config.yml +++ b/CHANGELOG/.chglog/config.yml @@ -3,7 +3,7 @@ style: github template: CHANGELOG.tpl.md info: title: CHANGELOG - repository_url: https://github.com/OpenIMSDK/Open-IM-Server + repository_url: https://github.com/openimsdk/open-im-server options: tag_filter_pattern: '^v' sort: "date" diff --git a/CHANGELOG/CHANGELOG-1.0.md b/CHANGELOG/CHANGELOG-1.0.md index 04980fbd4..bed425943 100644 --- a/CHANGELOG/CHANGELOG-1.0.md +++ b/CHANGELOG/CHANGELOG-1.0.md @@ -47,10 +47,10 @@ - update -[Unreleased]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v1.0.7...HEAD -[v1.0.7]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v1.0.6...v1.0.7 -[v1.0.6]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v1.0.5...v1.0.6 -[v1.0.5]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v1.0.4...v1.0.5 -[v1.0.4]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v1.0.3...v1.0.4 -[v1.0.3]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v1.0.1...v1.0.3 -[v1.0.1]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v1.0.0...v1.0.1 +[Unreleased]: https://github.com/openimsdk/open-im-server/compare/v1.0.7...HEAD +[v1.0.7]: https://github.com/openimsdk/open-im-server/compare/v1.0.6...v1.0.7 +[v1.0.6]: https://github.com/openimsdk/open-im-server/compare/v1.0.5...v1.0.6 +[v1.0.5]: https://github.com/openimsdk/open-im-server/compare/v1.0.4...v1.0.5 +[v1.0.4]: https://github.com/openimsdk/open-im-server/compare/v1.0.3...v1.0.4 +[v1.0.3]: https://github.com/openimsdk/open-im-server/compare/v1.0.1...v1.0.3 +[v1.0.1]: https://github.com/openimsdk/open-im-server/compare/v1.0.0...v1.0.1 diff --git a/CHANGELOG/CHANGELOG-2.0.md b/CHANGELOG/CHANGELOG-2.0.md index b89ddeadc..8902f1814 100644 --- a/CHANGELOG/CHANGELOG-2.0.md +++ b/CHANGELOG/CHANGELOG-2.0.md @@ -14,7 +14,7 @@ ## [v2.0.9] - 2022-04-29 ### Reverts -- update etcd to v3.5.2 ([#206](https://github.com/OpenIMSDK/Open-IM-Server/issues/206)) +- update etcd to v3.5.2 ([#206](https://github.com/openimsdk/open-im-server/issues/206)) ### Pull Requests - Merge branch 'tuoyun' @@ -74,14 +74,14 @@ - update -[Unreleased]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.0.10...HEAD -[v2.0.10]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.0.9...v2.0.10 -[v2.0.9]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.0.8...v2.0.9 -[v2.0.8]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.0.7...v2.0.8 -[v2.0.7]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.0.6...v2.0.7 -[v2.0.6]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.0.5...v2.0.6 -[v2.0.5]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.04...v2.0.5 -[v2.04]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.0.3...v2.04 -[v2.0.3]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.0.2...v2.0.3 -[v2.0.2]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.0.1...v2.0.2 -[v2.0.1]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.0.0...v2.0.1 +[Unreleased]: https://github.com/openimsdk/open-im-server/compare/v2.0.10...HEAD +[v2.0.10]: https://github.com/openimsdk/open-im-server/compare/v2.0.9...v2.0.10 +[v2.0.9]: https://github.com/openimsdk/open-im-server/compare/v2.0.8...v2.0.9 +[v2.0.8]: https://github.com/openimsdk/open-im-server/compare/v2.0.7...v2.0.8 +[v2.0.7]: https://github.com/openimsdk/open-im-server/compare/v2.0.6...v2.0.7 +[v2.0.6]: https://github.com/openimsdk/open-im-server/compare/v2.0.5...v2.0.6 +[v2.0.5]: https://github.com/openimsdk/open-im-server/compare/v2.04...v2.0.5 +[v2.04]: https://github.com/openimsdk/open-im-server/compare/v2.0.3...v2.04 +[v2.0.3]: https://github.com/openimsdk/open-im-server/compare/v2.0.2...v2.0.3 +[v2.0.2]: https://github.com/openimsdk/open-im-server/compare/v2.0.1...v2.0.2 +[v2.0.1]: https://github.com/openimsdk/open-im-server/compare/v2.0.0...v2.0.1 diff --git a/CHANGELOG/CHANGELOG-2.1.md b/CHANGELOG/CHANGELOG-2.1.md index 32effd64d..7eef06f08 100644 --- a/CHANGELOG/CHANGELOG-2.1.md +++ b/CHANGELOG/CHANGELOG-2.1.md @@ -21,7 +21,7 @@ ## v2.1.0 - 2022-06-17 ### Reverts -- update etcd to v3.5.2 ([#206](https://github.com/OpenIMSDK/Open-IM-Server/issues/206)) +- update etcd to v3.5.2 ([#206](https://github.com/openimsdk/open-im-server/issues/206)) - friend modify - update @@ -47,4 +47,4 @@ - Merge branch 'tuoyun' -[Unreleased]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.1.0...HEAD +[Unreleased]: https://github.com/openimsdk/open-im-server/compare/v2.1.0...HEAD diff --git a/CHANGELOG/CHANGELOG-2.2.md b/CHANGELOG/CHANGELOG-2.2.md index e00204316..8afb24b29 100644 --- a/CHANGELOG/CHANGELOG-2.2.md +++ b/CHANGELOG/CHANGELOG-2.2.md @@ -21,7 +21,7 @@ ## v2.2.0 - 2022-07-01 ### Reverts -- update etcd to v3.5.2 ([#206](https://github.com/OpenIMSDK/Open-IM-Server/issues/206)) +- update etcd to v3.5.2 ([#206](https://github.com/openimsdk/open-im-server/issues/206)) - friend modify - update @@ -47,4 +47,4 @@ - Merge branch 'tuoyun' -[Unreleased]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.2.0...HEAD +[Unreleased]: https://github.com/openimsdk/open-im-server/compare/v2.2.0...HEAD diff --git a/CHANGELOG/CHANGELOG-2.3.md b/CHANGELOG/CHANGELOG-2.3.md index c33b81a9a..e14745f30 100644 --- a/CHANGELOG/CHANGELOG-2.3.md +++ b/CHANGELOG/CHANGELOG-2.3.md @@ -37,7 +37,7 @@ ## v2.3.0-rc0 - 2022-07-15 ### Reverts -- update etcd to v3.5.2 ([#206](https://github.com/OpenIMSDK/Open-IM-Server/issues/206)) +- update etcd to v3.5.2 ([#206](https://github.com/openimsdk/open-im-server/issues/206)) - friend modify - update @@ -63,8 +63,8 @@ - Merge branch 'tuoyun' -[Unreleased]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.3.3...HEAD -[v2.3.3]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.3.2...v2.3.3 -[v2.3.2]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.3.0-rc2...v2.3.2 -[v2.3.0-rc2]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.3.0-rc1...v2.3.0-rc2 -[v2.3.0-rc1]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.3.0-rc0...v2.3.0-rc1 +[Unreleased]: https://github.com/openimsdk/open-im-server/compare/v2.3.3...HEAD +[v2.3.3]: https://github.com/openimsdk/open-im-server/compare/v2.3.2...v2.3.3 +[v2.3.2]: https://github.com/openimsdk/open-im-server/compare/v2.3.0-rc2...v2.3.2 +[v2.3.0-rc2]: https://github.com/openimsdk/open-im-server/compare/v2.3.0-rc1...v2.3.0-rc2 +[v2.3.0-rc1]: https://github.com/openimsdk/open-im-server/compare/v2.3.0-rc0...v2.3.0-rc1 diff --git a/CHANGELOG/CHANGELOG-2.9.md b/CHANGELOG/CHANGELOG-2.9.md index b51212ba8..b921eb51b 100644 --- a/CHANGELOG/CHANGELOG-2.9.md +++ b/CHANGELOG/CHANGELOG-2.9.md @@ -38,15 +38,15 @@ ## v2.9.0 - 2023-07-04 ### Reverts -- update etcd to v3.5.2 ([#206](https://github.com/OpenIMSDK/Open-IM-Server/issues/206)) +- update etcd to v3.5.2 ([#206](https://github.com/openimsdk/open-im-server/issues/206)) ### Pull Requests - Merge branch 'tuoyun' -[Unreleased]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.9.0+1.839643f...HEAD -[v2.9.0+1.839643f]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.9.0+2.35f07fe...v2.9.0+1.839643f -[v2.9.0+2.35f07fe]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.9.0+1.b5072b1...v2.9.0+2.35f07fe -[v2.9.0+1.b5072b1]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.9.0+3.2667a3a...v2.9.0+1.b5072b1 -[v2.9.0+3.2667a3a]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.9.0+7.04818ca...v2.9.0+3.2667a3a -[v2.9.0+7.04818ca]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.9.0...v2.9.0+7.04818ca +[Unreleased]: https://github.com/openimsdk/open-im-server/compare/v2.9.0+1.839643f...HEAD +[v2.9.0+1.839643f]: https://github.com/openimsdk/open-im-server/compare/v2.9.0+2.35f07fe...v2.9.0+1.839643f +[v2.9.0+2.35f07fe]: https://github.com/openimsdk/open-im-server/compare/v2.9.0+1.b5072b1...v2.9.0+2.35f07fe +[v2.9.0+1.b5072b1]: https://github.com/openimsdk/open-im-server/compare/v2.9.0+3.2667a3a...v2.9.0+1.b5072b1 +[v2.9.0+3.2667a3a]: https://github.com/openimsdk/open-im-server/compare/v2.9.0+7.04818ca...v2.9.0+3.2667a3a +[v2.9.0+7.04818ca]: https://github.com/openimsdk/open-im-server/compare/v2.9.0...v2.9.0+7.04818ca diff --git a/CHANGELOG/CHANGELOG-3.0.md b/CHANGELOG/CHANGELOG-3.0.md index cf1aa4b62..1b99e7e34 100644 --- a/CHANGELOG/CHANGELOG-3.0.md +++ b/CHANGELOG/CHANGELOG-3.0.md @@ -47,7 +47,7 @@ ## [v2.9.0] - 2023-07-04 ### Reverts -- update etcd to v3.5.2 ([#206](https://github.com/OpenIMSDK/Open-IM-Server/issues/206)) +- update etcd to v3.5.2 ([#206](https://github.com/openimsdk/open-im-server/issues/206)) ### Pull Requests - Merge branch 'tuoyun' @@ -85,7 +85,7 @@ ## [v2.0.9] - 2022-04-29 ### Reverts -- update etcd to v3.5.2 ([#206](https://github.com/OpenIMSDK/Open-IM-Server/issues/206)) +- update etcd to v3.5.2 ([#206](https://github.com/openimsdk/open-im-server/issues/206)) ### Pull Requests - Merge branch 'tuoyun' @@ -161,28 +161,28 @@ - update -[Unreleased]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.9.0...HEAD -[v2.9.0]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.3.3...v2.9.0 -[v2.3.3]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.3.2...v2.3.3 -[v2.3.2]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.3.0-rc2...v2.3.2 -[v2.3.0-rc2]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.3.0-rc1...v2.3.0-rc2 -[v2.3.0-rc1]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.3.0-rc0...v2.3.0-rc1 -[v2.3.0-rc0]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.2.0...v2.3.0-rc0 -[v2.2.0]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.1.0...v2.2.0 -[v2.1.0]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.0.10...v2.1.0 -[v2.0.10]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.0.9...v2.0.10 -[v2.0.9]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.0.7...v2.0.9 -[v2.0.7]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.0.6...v2.0.7 -[v2.0.6]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.0.5...v2.0.6 -[v2.0.5]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.04...v2.0.5 -[v2.04]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.0.3...v2.04 -[v2.0.3]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.0.2...v2.0.3 -[v2.0.2]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.0.1...v2.0.2 -[v2.0.1]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v2.0.0...v2.0.1 -[v2.0.0]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v1.0.7...v2.0.0 -[v1.0.7]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v1.0.6...v1.0.7 -[v1.0.6]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v1.0.5...v1.0.6 -[v1.0.5]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v1.0.4...v1.0.5 -[v1.0.4]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v1.0.3...v1.0.4 -[v1.0.3]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v1.0.1...v1.0.3 -[v1.0.1]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v1.0.0...v1.0.1 +[Unreleased]: https://github.com/openimsdk/open-im-server/compare/v2.9.0...HEAD +[v2.9.0]: https://github.com/openimsdk/open-im-server/compare/v2.3.3...v2.9.0 +[v2.3.3]: https://github.com/openimsdk/open-im-server/compare/v2.3.2...v2.3.3 +[v2.3.2]: https://github.com/openimsdk/open-im-server/compare/v2.3.0-rc2...v2.3.2 +[v2.3.0-rc2]: https://github.com/openimsdk/open-im-server/compare/v2.3.0-rc1...v2.3.0-rc2 +[v2.3.0-rc1]: https://github.com/openimsdk/open-im-server/compare/v2.3.0-rc0...v2.3.0-rc1 +[v2.3.0-rc0]: https://github.com/openimsdk/open-im-server/compare/v2.2.0...v2.3.0-rc0 +[v2.2.0]: https://github.com/openimsdk/open-im-server/compare/v2.1.0...v2.2.0 +[v2.1.0]: https://github.com/openimsdk/open-im-server/compare/v2.0.10...v2.1.0 +[v2.0.10]: https://github.com/openimsdk/open-im-server/compare/v2.0.9...v2.0.10 +[v2.0.9]: https://github.com/openimsdk/open-im-server/compare/v2.0.7...v2.0.9 +[v2.0.7]: https://github.com/openimsdk/open-im-server/compare/v2.0.6...v2.0.7 +[v2.0.6]: https://github.com/openimsdk/open-im-server/compare/v2.0.5...v2.0.6 +[v2.0.5]: https://github.com/openimsdk/open-im-server/compare/v2.04...v2.0.5 +[v2.04]: https://github.com/openimsdk/open-im-server/compare/v2.0.3...v2.04 +[v2.0.3]: https://github.com/openimsdk/open-im-server/compare/v2.0.2...v2.0.3 +[v2.0.2]: https://github.com/openimsdk/open-im-server/compare/v2.0.1...v2.0.2 +[v2.0.1]: https://github.com/openimsdk/open-im-server/compare/v2.0.0...v2.0.1 +[v2.0.0]: https://github.com/openimsdk/open-im-server/compare/v1.0.7...v2.0.0 +[v1.0.7]: https://github.com/openimsdk/open-im-server/compare/v1.0.6...v1.0.7 +[v1.0.6]: https://github.com/openimsdk/open-im-server/compare/v1.0.5...v1.0.6 +[v1.0.5]: https://github.com/openimsdk/open-im-server/compare/v1.0.4...v1.0.5 +[v1.0.4]: https://github.com/openimsdk/open-im-server/compare/v1.0.3...v1.0.4 +[v1.0.3]: https://github.com/openimsdk/open-im-server/compare/v1.0.1...v1.0.3 +[v1.0.1]: https://github.com/openimsdk/open-im-server/compare/v1.0.0...v1.0.1 diff --git a/CHANGELOG/CHANGELOG-3.1.md b/CHANGELOG/CHANGELOG-3.1.md index c51eb2098..8d64c5ef7 100644 --- a/CHANGELOG/CHANGELOG-3.1.md +++ b/CHANGELOG/CHANGELOG-3.1.md @@ -2,31 +2,18 @@ -- [Version logging for OpenIM](#version-logging-for-openim) - - [Unreleased](#unreleased) - - [v3.1.2-beta.3 - 2023-08-09](#v312-beta3---2023-08-09) - - [v3.1.2-beta.2 - 2023-08-09](#v312-beta2---2023-08-09) - - [v3.1.2-beta.1 - 2023-08-09](#v312-beta1---2023-08-09) - - [v3.1.2-beta.0 - 2023-08-08](#v312-beta0---2023-08-08) - - [v3.1.2.beta.0 - 2023-08-08](#v312beta0---2023-08-08) - - [v3.1.1-beta.4 - 2023-08-07](#v311-beta4---2023-08-07) - - [v3.1.1-beta.3 - 2023-08-05](#v311-beta3---2023-08-05) - - [v3.1.1-beta.2 - 2023-08-04](#v311-beta2---2023-08-04) - - [v3.1.1-beta.1 - 2023-08-04](#v311-beta1---2023-08-04) - - [v3.1.1-alpha.3 - 2023-08-03](#v311-alpha3---2023-08-03) - - [v3.1.1-alpha.2 - 2023-08-03](#v311-alpha2---2023-08-03) - - [v3.1.1-alpha.1 - 2023-08-02](#v311-alpha1---2023-08-02) - - [v3.1.0 - 2023-07-28](#v310---2023-07-28) - - [Reverts](#reverts) - - [Pull Requests](#pull-requests) - - ## [Unreleased] + +## [v3.1.3-beta.1] - 2023-08-14 + + +## [v3.1.3] - 2023-08-14 + ## [v3.1.2-beta.3] - 2023-08-09 @@ -39,49 +26,19 @@ ## [v3.1.2-beta.0] - 2023-08-08 - -## [v3.1.2.beta.0] - 2023-08-08 - - -## [v3.1.1-beta.4] - 2023-08-07 - - -## [v3.1.1-beta.3] - 2023-08-05 - - -## [v3.1.1-beta.2] - 2023-08-04 - - -## [v3.1.1-beta.1] - 2023-08-04 - - -## [v3.1.1-alpha.3] - 2023-08-03 - - -## [v3.1.1-alpha.2] - 2023-08-03 - - -## [v3.1.1-alpha.1] - 2023-08-02 - ## v3.1.0 - 2023-07-28 ### Reverts -- update etcd to v3.5.2 ([#206](https://github.com/OpenIMSDK/Open-IM-Server/issues/206)) +- update etcd to v3.5.2 ([#206](https://github.com/openimsdk/open-im-server/issues/206)) ### Pull Requests - Merge branch 'tuoyun' -[Unreleased]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v3.1.2-beta.3...HEAD -[v3.1.2-beta.3]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v3.1.2-beta.2...v3.1.2-beta.3 -[v3.1.2-beta.2]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v3.1.2-beta.1...v3.1.2-beta.2 -[v3.1.2-beta.1]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v3.1.2-beta.0...v3.1.2-beta.1 -[v3.1.2-beta.0]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v3.1.2.beta.0...v3.1.2-beta.0 -[v3.1.2.beta.0]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v3.1.1-beta.4...v3.1.2.beta.0 -[v3.1.1-beta.4]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v3.1.1-beta.3...v3.1.1-beta.4 -[v3.1.1-beta.3]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v3.1.1-beta.2...v3.1.1-beta.3 -[v3.1.1-beta.2]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v3.1.1-beta.1...v3.1.1-beta.2 -[v3.1.1-beta.1]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v3.1.1-alpha.3...v3.1.1-beta.1 -[v3.1.1-alpha.3]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v3.1.1-alpha.2...v3.1.1-alpha.3 -[v3.1.1-alpha.2]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v3.1.1-alpha.1...v3.1.1-alpha.2 -[v3.1.1-alpha.1]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v3.1.0...v3.1.1-alpha.1 +[Unreleased]: https://github.com/openimsdk/open-im-server/compare/v3.1.3-beta.1...HEAD +[v3.1.3-beta.1]: https://github.com/openimsdk/open-im-server/compare/v3.1.3...v3.1.3-beta.1 +[v3.1.3]: https://github.com/openimsdk/open-im-server/compare/v3.1.2-beta.3...v3.1.3 +[v3.1.2-beta.3]: https://github.com/openimsdk/open-im-server/compare/v3.1.2-beta.2...v3.1.2-beta.3 +[v3.1.2-beta.2]: https://github.com/openimsdk/open-im-server/compare/v3.1.2-beta.1...v3.1.2-beta.2 +[v3.1.2-beta.1]: https://github.com/openimsdk/open-im-server/compare/v3.1.2-beta.0...v3.1.2-beta.1 +[v3.1.2-beta.0]: https://github.com/openimsdk/open-im-server/compare/v3.1.0...v3.1.2-beta.0 diff --git a/CHANGELOG/CHANGELOG-3.2.md b/CHANGELOG/CHANGELOG-3.2.md index 0074a7e88..f7823d119 100644 --- a/CHANGELOG/CHANGELOG-3.2.md +++ b/CHANGELOG/CHANGELOG-3.2.md @@ -8,6 +8,21 @@ ## [Unreleased] + +## [v3.2.2] - 2023-09-03 + + +## [v3.2.3] - 2023-09-03 + + +## [v3.2.1] - 2023-09-03 + + +## [v3.2.2-beta.4] - 2023-08-28 + + +## [v3.2.2-alpha.0] - 2023-08-25 + ## [v3.2.2-beta.3] - 2023-08-22 @@ -29,16 +44,21 @@ ## v3.2.0-alpha.0 - 2023-08-16 ### Reverts -- update etcd to v3.5.2 ([#206](https://github.com/OpenIMSDK/Open-IM-Server/issues/206)) +- update etcd to v3.5.2 ([#206](https://github.com/openimsdk/open-im-server/issues/206)) ### Pull Requests - Merge branch 'tuoyun' -[Unreleased]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v3.2.2-beta.3...HEAD -[v3.2.2-beta.3]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v3.2.2-beta.2...v3.2.2-beta.3 -[v3.2.2-beta.2]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v3.2.2-beta.1...v3.2.2-beta.2 -[v3.2.2-beta.1]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v3.2.0...v3.2.2-beta.1 -[v3.2.0]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v3.2.0-rc.0...v3.2.0 -[v3.2.0-rc.0]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v3.2.2-beta.0...v3.2.0-rc.0 -[v3.2.2-beta.0]: https://github.com/OpenIMSDK/Open-IM-Server/compare/v3.2.0-alpha.0...v3.2.2-beta.0 +[Unreleased]: https://github.com/openimsdk/open-im-server/compare/v3.2.2...HEAD +[v3.2.2]: https://github.com/openimsdk/open-im-server/compare/v3.2.3...v3.2.2 +[v3.2.3]: https://github.com/openimsdk/open-im-server/compare/v3.2.1...v3.2.3 +[v3.2.1]: https://github.com/openimsdk/open-im-server/compare/v3.2.2-beta.4...v3.2.1 +[v3.2.2-beta.4]: https://github.com/openimsdk/open-im-server/compare/v3.2.2-alpha.0...v3.2.2-beta.4 +[v3.2.2-alpha.0]: https://github.com/openimsdk/open-im-server/compare/v3.2.2-beta.3...v3.2.2-alpha.0 +[v3.2.2-beta.3]: https://github.com/openimsdk/open-im-server/compare/v3.2.2-beta.2...v3.2.2-beta.3 +[v3.2.2-beta.2]: https://github.com/openimsdk/open-im-server/compare/v3.2.2-beta.1...v3.2.2-beta.2 +[v3.2.2-beta.1]: https://github.com/openimsdk/open-im-server/compare/v3.2.0...v3.2.2-beta.1 +[v3.2.0]: https://github.com/openimsdk/open-im-server/compare/v3.2.0-rc.0...v3.2.0 +[v3.2.0-rc.0]: https://github.com/openimsdk/open-im-server/compare/v3.2.2-beta.0...v3.2.0-rc.0 +[v3.2.2-beta.0]: https://github.com/openimsdk/open-im-server/compare/v3.2.0-alpha.0...v3.2.2-beta.0 diff --git a/CHANGELOG/CHANGELOG.md b/CHANGELOG/CHANGELOG.md index 6ca4d08b2..41df11bba 100644 --- a/CHANGELOG/CHANGELOG.md +++ b/CHANGELOG/CHANGELOG.md @@ -16,7 +16,7 @@ All notable changes to this project will be documented in this file. -+ [https://github.com/OpenIMSDK/Open-IM-Server/releases](https://github.com/OpenIMSDK/Open-IM-Server/releases) ++ [https://github.com/openimsdk/open-im-server/releases](https://github.com/openimsdk/open-im-server/releases) ## OpenIM versioning policy @@ -44,7 +44,7 @@ $ git-chglog --init **Options** -- What is the URL of your repository?: https://github.com/OpenIMSDK/Open-IM-Server +- What is the URL of your repository?: https://github.com/openimsdk/open-im-server - What is your favorite style?: github - Choose the format of your favorite commit message: (): -- feat(core): Add new feature - What is your favorite template style?: standard diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a3ee8b8a6..80cdf66c3 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -46,7 +46,7 @@ The [Makefile](./Makefile) is for every developer, even if you don't know how to #### Code and doc contribution -Every action to make project Open-IM-Server better is encouraged. On GitHub, every improvement for Open-IM-Server could be via a [PR](https://github.com/OpenIMSDK/Open-IM-Server/pulls) (short for pull request). +Every action to make project Open-IM-Server better is encouraged. On GitHub, every improvement for Open-IM-Server could be via a [PR](https://github.com/openimsdk/open-im-server/pulls) (short for pull request). + If you find a typo, try to fix it! + If you find a bug, try to fix it! @@ -61,14 +61,14 @@ Every action to make project Open-IM-Server better is encouraged. On GitHub, eve #### Where should I start? -+ If you are new to the project, don't know how to contribute Open-IM-Server, please check out the [good first issue](https://github.com/OpenIMSDK/Open-IM-Server/issues?q=is%3Aopen+label%3A"good+first+issue"+sort%3Aupdated-desc) label. -+ You should be good at filtering the Open-IM-Server issue tags and finding the ones you like, such as [RFC](https://github.com/OpenIMSDK/Open-IM-Server/issues?q=is%3Aissue+is%3Aopen+RFC+label%3ARFC) for big initiatives, features for [feature](https://github.com/OpenIMSDK/Open-IM-Server/issues?q=is%3Aissue+label%3Afeature) proposals, and [bug](https://github.com/OpenIMSDK/Open-IM-Server/issues?q=is%3Aissue+label%3Abug+) fixes. -+ If you are looking for something to work on, check out our [open issues](https://github.com/OpenIMSDK/Open-IM-Server/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc). -+ If you have an idea for a new feature, please [open an issue](https://github.com/OpenIMSDK/Open-IM-Server/issues/new/choose), and we can discuss it. ++ If you are new to the project, don't know how to contribute Open-IM-Server, please check out the [good first issue](https://github.com/openimsdk/open-im-server/issues?q=is%3Aopen+label%3A"good+first+issue"+sort%3Aupdated-desc) label. ++ You should be good at filtering the Open-IM-Server issue tags and finding the ones you like, such as [RFC](https://github.com/openimsdk/open-im-server/issues?q=is%3Aissue+is%3Aopen+RFC+label%3ARFC) for big initiatives, features for [feature](https://github.com/openimsdk/open-im-server/issues?q=is%3Aissue+label%3Afeature) proposals, and [bug](https://github.com/openimsdk/open-im-server/issues?q=is%3Aissue+label%3Abug+) fixes. ++ If you are looking for something to work on, check out our [open issues](https://github.com/openimsdk/open-im-server/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc). ++ If you have an idea for a new feature, please [open an issue](https://github.com/openimsdk/open-im-server/issues/new/choose), and we can discuss it. #### Design documents -For any substantial design, there should be a well-crafted design document. This document is not just a simple record, but also a detailed description and manifestation, which can help team members better understand the design thinking and grasp the design direction. In the process of writing the design document, we can choose to use tools such as `Google Docs` or `Notion`, and even mark RFC in [issues](https://github.com/OpenIMSDK/Open-IM-Server/issues?q=is%3Aissue+is%3Aopen+RFC+label%3ARFC) or [discussions](https://github.com/OpenIMSDK/Open-IM-Server/discussions) for better collaboration. Of course, after completing the design document, we should also add it to our [Shared Drive](https://drive.google.com/drive/) and notify the appropriate working group to let everyone know of its existence. Only by doing so can we maximize the effectiveness of the design document and provide strong support for the smooth progress of the project. +For any substantial design, there should be a well-crafted design document. This document is not just a simple record, but also a detailed description and manifestation, which can help team members better understand the design thinking and grasp the design direction. In the process of writing the design document, we can choose to use tools such as `Google Docs` or `Notion`, and even mark RFC in [issues](https://github.com/openimsdk/open-im-server/issues?q=is%3Aissue+is%3Aopen+RFC+label%3ARFC) or [discussions](https://github.com/openimsdk/open-im-server/discussions) for better collaboration. Of course, after completing the design document, we should also add it to our [Shared Drive](https://drive.google.com/drive/) and notify the appropriate working group to let everyone know of its existence. Only by doing so can we maximize the effectiveness of the design document and provide strong support for the smooth progress of the project. Anybody can access the shared Drive for reading. To get access to comment. Once you've done that, head to the [shared Drive](https://drive.google.com/) and behold all the docs. @@ -95,10 +95,10 @@ To propose PR for the Open-IM-Server item, we assume you have registered a GitHu 2. **CLONE** your own repository to main locally. Use `git clone https://github.com//Open-IM-Server.git` to clone repository to your local machine. Then you can create new branches to finish the change you wish to make. -3. **Set Remote** upstream to be `https://github.com/OpenIMSDK/Open-IM-Server.git` using the following two commands: +3. **Set Remote** upstream to be `https://github.com/openimsdk/open-im-server.git` using the following two commands: ```bash - ❯ git remote add upstream https://github.com/OpenIMSDK/Open-IM-Server.git + ❯ git remote add upstream https://github.com/openimsdk/open-im-server.git ❯ git remote set-url --push upstream no-pushing ``` @@ -108,7 +108,7 @@ To propose PR for the Open-IM-Server item, we assume you have registered a GitHu ❯ git remote -v origin https://github.com//Open-IM-Server.git (fetch) origin https://github.com//Open-IM-Server.git (push) - upstream https://github.com/OpenIMSDK/Open-IM-Server.git (fetch) + upstream https://github.com/openimsdk/open-im-server.git (fetch) upstream no-pushing (push) ``` @@ -174,7 +174,7 @@ To propose PR for the Open-IM-Server item, we assume you have registered a GitHu # then create pull request, and merge ``` -7. **Open a pull request** to `OpenIMSDK/Open-IM-Server:main` +7. **Open a pull request** to `openimsdk/open-im-server:main` It is recommended to review your changes before filing a pull request. Check if your code doesn't conflict with the main branch and no redundant code is included. @@ -190,7 +190,7 @@ Instead we encourage you to send us a private email to winxu81@gmail.com to repo #### Reporting general issues -To be honest, we regard every user of Open-IM-Serveras a very kind contributor. After experiencing Open-IM-Server, you may have some feedback for the project. Then feel free to open an issue via [NEW ISSUE](https://github.com/OpenIMSDK/Open-IM-Server/issues/new/choose). +To be honest, we regard every user of Open-IM-Serveras a very kind contributor. After experiencing Open-IM-Server, you may have some feedback for the project. Then feel free to open an issue via [NEW ISSUE](https://github.com/openimsdk/open-im-server/issues/new/choose). Since we collaborate project Open-IM-Server in a distributed way, we appreciate **WELL-WRITTEN**, **DETAILED**, **EXPLICIT** issue reports. To make the communication more efficient, we wish everyone could search if your issue is an existing one in the searching list. If you find it existing, please add your details in comments under the existing issue instead of opening a brand new one. @@ -258,7 +258,7 @@ An example for this could be: PR is the only way to make change to Open-IM-Server project files. To help reviewers better get your purpose, PR description could not be too detailed. We encourage contributors to follow the [PR template](https://github.com/OpenIMSDK/.github/tree/main/.github/PULL_REQUEST_TEMPLATE.md) to finish the pull request. -You can find some very formal PR in [RFC](https://github.com/OpenIMSDK/Open-IM-Server/issues?q=is%3Aissue+is%3Aopen+RFC+label%3ARFC) issues and learn about them. +You can find some very formal PR in [RFC](https://github.com/openimsdk/open-im-server/issues?q=is%3Aissue+is%3Aopen+RFC+label%3ARFC) issues and learn about them. **📖 Opening PRs:** @@ -307,8 +307,8 @@ git() { The documentation for Open-IM-Server includes: -+ [README.md](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/README.md): This file includes the basic information and instructions for getting started with Open-IM-Server. -+ [CONTRIBUTING.md](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/CONTRIBUTING.md): This file contains guidelines for contributing to Open-IM-Server's codebase, such as how to submit issues, pull requests, and code reviews. ++ [README.md](https://github.com/openimsdk/open-im-server/blob/main/README.md): This file includes the basic information and instructions for getting started with Open-IM-Server. ++ [CONTRIBUTING.md](https://github.com/openimsdk/open-im-server/blob/main/CONTRIBUTING.md): This file contains guidelines for contributing to Open-IM-Server's codebase, such as how to submit issues, pull requests, and code reviews. + [Official Documentation](https://doc.rentsoft.cn/): This is the official documentation for Open-IM-Server, which includes comprehensive information on all of its features, configuration options, and troubleshooting tips. Please obey the following rules to better format the docs, which would greatly improve the reading experience. @@ -324,9 +324,9 @@ Please obey the following rules to better format the docs, which would greatly i We choose GitHub as the primary place for Open-IM-Server to collaborate. So the latest updates of Open-IM-Server are always here. Although contributions via PR is an explicit way to help, we still call for any other ways. -+ reply to other's [issues](https://github.com/OpenIMSDK/Open-IM-Server/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc) if you could; ++ reply to other's [issues](https://github.com/openimsdk/open-im-server/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc) if you could; + help solve other user's problems; -+ help review other's [PR](https://github.com/OpenIMSDK/Open-IM-Server/pulls?q=is%3Apr+is%3Aopen+sort%3Aupdated-desc) design; ++ help review other's [PR](https://github.com/openimsdk/open-im-server/pulls?q=is%3Apr+is%3Aopen+sort%3Aupdated-desc) design; + discuss about Open-IM-Server to make things clearer; + advocate [Open-IM-Server](https://google.com/search?q=Open-IM-Server) technology beyond GitHub; + write blogs on Open-IM-Server and so on. diff --git a/Makefile b/Makefile index e869ec111..ff7878108 100644 --- a/Makefile +++ b/Makefile @@ -11,9 +11,9 @@ all: tidy gen add-copyright verify lint cover restart # ============================================================================== # Build set -ROOT_PACKAGE=github.com/OpenIMSDK/Open-IM-Server -# TODO: This is version control for the future https://github.com/OpenIMSDK/Open-IM-Server/issues/574 -VERSION_PACKAGE=github.com/OpenIMSDK/Open-IM-Server/pkg/version +ROOT_PACKAGE=github.com/openimsdk/open-im-server +# TODO: This is version control for the future https://github.com/openimsdk/open-im-server/issues/574 +VERSION_PACKAGE=github.com/openimsdk/open-im-server/v3/pkg/version # ============================================================================== # Includes @@ -112,7 +112,7 @@ install: check: @$(MAKE) go.check -## check-component +## check-component: Check OpenIM component deployment ✨ .PHONY: check-component check-component: @$(MAKE) go.check-component diff --git a/README-zh_CN.md b/README-zh_CN.md index 3d9eea319..37a4dd410 100644 --- a/README-zh_CN.md +++ b/README-zh_CN.md @@ -10,11 +10,11 @@

-A+ -good first - +A+ +good first + - +

@@ -99,9 +99,9 @@ Open-IM-Server 不仅仅是一个即时消息服务器;它是将实时网络 9. **终极部署体验 🤖** - ✅ 支持 [集群部署](https://github.com/OpenIMSDK/Open-IM-Server/edit/main/deployments/README.md) + ✅ 支持 [集群部署](https://github.com/openimsdk/open-im-server/edit/main/deployments/README.md) - ✅ 支持多架构镜像,我们的 Docker 镜像不仅托管在 GitHub 上,而且还在阿里云和 Docker Hub 上支持多个架构。请访问 [我们的 GitHub packages](https://github.com/orgs/OpenIMSDK/packages?repo_name=Open-IM-Server) 并阅读我们的 [版本管理文档](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/version.md) 以获取更多信息。 + ✅ 支持多架构镜像,我们的 Docker 镜像不仅托管在 GitHub 上,而且还在阿里云和 Docker Hub 上支持多个架构。请访问 [我们的 GitHub packages](https://github.com/orgs/OpenIMSDK/packages?repo_name=Open-IM-Server) 并阅读我们的 [版本管理文档](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/version.md) 以获取更多信息。 10. **开源社区的大生态系统 🤲** @@ -118,10 +118,10 @@ Open-IM-Server 不仅仅是一个即时消息服务器;它是将实时网络 ``` # 选择您需要的 BRANCH=release-v3.1 -git clone -b $BRANCH https://github.com/OpenIMSDK/Open-IM-Server openim && export openim=$(pwd)/openim && cd $openim && make build +git clone -b $BRANCH https://github.com/openimsdk/open-im-server openim && export openim=$(pwd)/openim && cd $openim && make build ``` -> **注意** 阅读我们的发布策略:https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/version.md +> **注意** 阅读我们的发布策略:https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/version.md 1. 修改 `.env` @@ -149,27 +149,27 @@ make install make check ``` -![https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/images/docker_build.png](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/images/docker_build.png) +![https://github.com/openimsdk/open-im-server/blob/main/docs/images/docker_build.png](https://github.com/openimsdk/open-im-server/blob/main/docs/images/docker_build.png)
从源码编译 您需要 `Go 1.18` 或更高版本,以及 `make`。 -版本详情:https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/version.md +版本详情:https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/version.md ``` # 选择您需要的 BRANCH=release-v3.1 -git clone -b $BRANCH https://github.com/OpenIMSDK/Open-IM-Server openim && export openim=$(pwd)/openim && cd $openim && make build +git clone -b $BRANCH https://github.com/openimsdk/open-im-server openim && export openim=$(pwd)/openim && cd $openim && make build ``` -阅读关于 [OpenIM 版本策略](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/version.md) +阅读关于 [OpenIM 版本策略](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/version.md) 使用 `make help` 来查看 OpenIM 支持的指令。 如图所示,所有服务已成功构建 -![成功编译](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/images/build.png) +![成功编译](https://github.com/openimsdk/open-im-server/blob/main/docs/images/build.png)
组件配置说明 @@ -302,30 +302,30 @@ config/config.yaml 文件为存储组件提供了详细的配置说明。 OpenIM 不仅仅是一个开源的即时消息组件,它是您的应用程序生态系统的一个不可分割的部分。查看此图表以了解 AppServer、AppClient、Open-IM-Server 和 Open-IM-SDK 如何互动。 -![App-OpenIM 关系](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/images/open-im-server.png) +![App-OpenIM 关系](https://github.com/openimsdk/open-im-server/blob/main/docs/images/open-im-server.png) ## :building_construction: 总体架构 深入了解 Open-IM-Server 的功能与我们的架构图。 -![总体架构](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/images/Architecture.jpg) +![总体架构](https://github.com/openimsdk/open-im-server/blob/main/docs/images/Architecture.jpg) ## :hammer_and_wrench: 开始开发 OpenIM OpenIM 我们的目标是建立一个顶级的开源社区。我们有一套标准,在 [Community repository](https://github.com/OpenIMSDK/community) 中。 -如果您想为这个 Open-IM-Server 仓库做贡献,请阅读我们的 [贡献者文档](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/CONTRIBUTING.md)。 +如果您想为这个 Open-IM-Server 仓库做贡献,请阅读我们的 [贡献者文档](https://github.com/openimsdk/open-im-server/blob/main/CONTRIBUTING.md)。 -在您开始之前,请确保您的更改是需要的。最好的方法是创建一个 [新的讨论](https://github.com/OpenIMSDK/Open-IM-Server/discussions/new/choose) 或 [Slack 通讯](https://join.slack.com/t/openimsdk/shared_invite/zt-22720d66b-o_FvKxMTGXtcnnnHiMqe9Q),或者如果您发现一个问题,首先 [报告它](https://github.com/OpenIMSDK/Open-IM-Server/issues/new/choose)。 +在您开始之前,请确保您的更改是需要的。最好的方法是创建一个 [新的讨论](https://github.com/openimsdk/open-im-server/discussions/new/choose) 或 [Slack 通讯](https://join.slack.com/t/openimsdk/shared_invite/zt-22720d66b-o_FvKxMTGXtcnnnHiMqe9Q),或者如果您发现一个问题,首先 [报告它](https://github.com/openimsdk/open-im-server/issues/new/choose)。 -- [代码标准](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/go_code.md) -- [Docker 图像标准](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/images.md) -- [目录标准](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/directory.md) -- [提交标准](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/commit.md) -- [版本控制标准](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/version.md) -- [接口标准](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/api.md) -- [日志标准](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/) -- [错误代码标准](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/error_code.md) +- [代码标准](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/go_code.md) +- [Docker 图像标准](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/images.md) +- [目录标准](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/directory.md) +- [提交标准](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/commit.md) +- [版本控制标准](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/version.md) +- [接口标准](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/api.md) +- [日志标准](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/) +- [错误代码标准](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/error_code.md) ## :busts_in_silhouette: 社区 @@ -340,18 +340,18 @@ OpenIM 我们的目标是建立一个顶级的开源社区。我们有一套标 我们的会议在 [OpenIM Slack](https://join.slack.com/t/openimsdk/shared_invite/zt-22720d66b-o_FvKxMTGXtcnnnHiMqe9Q) 🎯,然后您可以搜索 Open-IM-Server 管道加入。 -我们在 [GitHub 讨论](https://github.com/OpenIMSDK/Open-IM-Server/discussions/categories/meeting) 中记下每次 [双周会议](https://github.com/orgs/OpenIMSDK/discussions/categories/meeting) 的笔记,我们的历史会议记录以及会议回放都可在 [Google Docs :bookmark_tabs:](https://docs.google.com/document/d/1nx8MDpuG74NASx081JcCpxPgDITNTpIIos0DS6Vr9GU/edit?usp=sharing) 中找到。 +我们在 [GitHub 讨论](https://github.com/openimsdk/open-im-server/discussions/categories/meeting) 中记下每次 [双周会议](https://github.com/orgs/OpenIMSDK/discussions/categories/meeting) 的笔记,我们的历史会议记录以及会议回放都可在 [Google Docs :bookmark_tabs:](https://docs.google.com/document/d/1nx8MDpuG74NASx081JcCpxPgDITNTpIIos0DS6Vr9GU/edit?usp=sharing) 中找到。 ## :eyes: 谁在使用 OpenIM -查看我们的 [用户案例研究](https://github.com/OpenIMSDK/community/blob/main/ADOPTERS.md) 页面以获取项目用户列表。不要犹豫,留下一个 [📝评论](https://github.com/OpenIMSDK/Open-IM-Server/issues/379) 并分享您的使用案例。 +查看我们的 [用户案例研究](https://github.com/OpenIMSDK/community/blob/main/ADOPTERS.md) 页面以获取项目用户列表。不要犹豫,留下一个 [📝评论](https://github.com/openimsdk/open-im-server/issues/379) 并分享您的使用案例。 ## :page_facing_up: 许可证 -OpenIM 根据 Apache 2.0 许可证授权。请查看 [LICENSE](https://github.com/OpenIMSDK/Open-IM-Server/tree/main/LICENSE) 以获取完整的许可证文本。 +OpenIM 根据 Apache 2.0 许可证授权。请查看 [LICENSE](https://github.com/openimsdk/open-im-server/tree/main/LICENSE) 以获取完整的许可证文本。 -OpenIM logo,包括其变体和动画版本,在此存储库 [OpenIM](https://github.com/OpenIMSDK/Open-IM-Server) 下的 [assets/logo](./assets/logo) 和 [assets/logo-gif](./assets/logo-gif) 目录中显示,受版权法保护。 +OpenIM logo,包括其变体和动画版本,在此存储库 [OpenIM](https://github.com/openimsdk/open-im-server) 下的 [assets/logo](./assets/logo) 和 [assets/logo-gif](./assets/logo-gif) 目录中显示,受版权法保护。 ## 🔮 感谢我们的贡献者! - \ No newline at end of file + \ No newline at end of file diff --git a/README.md b/README.md index 8e02b1a5d..504dcd012 100644 --- a/README.md +++ b/README.md @@ -10,11 +10,11 @@

-A+ -good first - +A+ +good first + - +

@@ -99,9 +99,9 @@ Further enhancing your experience, we also provide an SDK client, wherein most c 9. **The ultimate deployment experience 🤖** - ✅ Supports [cluster deployment](https://github.com/OpenIMSDK/Open-IM-Server/edit/main/deployments/README.md) + ✅ Supports [cluster deployment](https://github.com/openimsdk/open-im-server/edit/main/deployments/README.md) - ✅ Supports multi-architecture mirroring, our Docker images are hosted not only on GitHub but also on Alibaba Cloud and Docker Hub supporting multiple architectures. Visit [our GitHub packages](https://github.com/orgs/OpenIMSDK/packages?repo_name=Open-IM-Server) and read our [version management document](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/version.md) for more information. + ✅ Supports multi-architecture mirroring, our Docker images are hosted not only on GitHub but also on Alibaba Cloud and Docker Hub supporting multiple architectures. Visit [our GitHub packages](https://github.com/orgs/OpenIMSDK/packages?repo_name=Open-IM-Server) and read our [version management document](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/version.md) for more information. 11. **A large ecosystem of open source communities 🤲** @@ -132,7 +132,7 @@ git clone -b main https://github.com/openim-sigs/openim-docker openim/openim-doc ``` > **Note** -> If you don't know OpenIM's versioning policy, 📚Read our release policy: https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/version.md +> If you don't know OpenIM's versioning policy, 📚Read our release policy: https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/version.md **2. Configure the config file** @@ -152,7 +152,7 @@ cat scripts/install/environment.sh ```bash export PASSWORD="openIM123" # Set password export USER="root" # Set username -# Choose chat version and server version https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/images.md, eg: main, release-v*.* +# Choose chat version and server version https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/images.md, eg: main, release-v*.* export CHAT_BRANCH="main" export SERVER_BRANCH="main" #... Other environment variables @@ -166,7 +166,7 @@ export DOCKER_BRIDGE_SUBNET="172.28.0.0/16" export API_URL="http://127.0.0.1:10002" ``` -If you wish to use more custom features, read our [config documentation](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/contrib/environment.md). +If you wish to use more custom features, read our [config documentation](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/environment.md). Next, update the configuration using make init: @@ -189,20 +189,20 @@ Ur need `Go 1.18` or higher version, and `make`. go version && make --version || echo "Error: One of the commands failed." ``` -Version Details: https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/version.md +Version Details: https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/version.md -You can get the version number from the command below or from [github releases](https://github.com/OpenIMSDK/Open-IM-Server/tags). +You can get the version number from the command below or from [github releases](https://github.com/openimsdk/open-im-server/tags). ```bash -$ curl --silent "https://api.github.com/repos/OpenIMSDK/Open-IM-Server/releases" | jq -r '.[].tag_name' +$ curl --silent "https://api.github.com/repos/openimsdk/open-im-server/releases" | jq -r '.[].tag_name' ``` -We have our own version management policy, if you are interested in our version management, I recommend reading [📚 OpenIM Version](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/version.md), We recommend using stable versions such as `v3.3.0` and `v3.2.0` whenever possible. `v3.1.1-alpha.3` as well as `v3.3.0-beta.0` and `v3.2.0-rc.0` are pre-release or beta versions and are not recommended. +We have our own version management policy, if you are interested in our version management, I recommend reading [📚 OpenIM Version](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/version.md), We recommend using stable versions such as `v3.3.0` and `v3.2.0` whenever possible. `v3.1.1-alpha.3` as well as `v3.3.0-beta.0` and `v3.2.0-rc.0` are pre-release or beta versions and are not recommended. Set `OPENIM_VERSION` environment variables for the latest `OPENIM_VERSION` number, or replace the `OPENIM_VERSION` for you to install the OpenIM-Server `OPENIM_VERSION`: ```bash -$ OPENIM_VERSION=`curl -s https://api.github.com/repos/OpenIMSDK/Open-IM-Server/releases/latest | grep -oE '"tag_name": "[^"]+"' | head -n1 | cut -d'"' -f4` +$ OPENIM_VERSION=`curl -s https://api.github.com/repos/openimsdk/open-im-server/releases/latest | grep -oE '"tag_name": "[^"]+"' | head -n1 | cut -d'"' -f4` # OPENIM_VERSION=v3.3.0 ``` @@ -210,7 +210,7 @@ Deploy basic components at the click of a command: ```bash # install openim dependency -$ git clone https://github.com/OpenIMSDK/Open-IM-Server openim/openim-server && export openim=$(pwd)/openim/openim-server && cd $openim/openim-server && git checkout $OPENIM_VERSION +$ git clone https://github.com/openimsdk/open-im-server openim/openim-server && export openim=$(pwd)/openim/openim-server && cd $openim/openim-server && git checkout $OPENIM_VERSION $ curl https://raw.githubusercontent.com/OpenIMSDK/openim-docker/main/example/basic-openim-server-dependency.yml -o basic-openim-server-dependency.yml && make init && docker compose -f basic-openim-server-dependency.yml up -d && make start ``` @@ -228,7 +228,7 @@ You can use the `make help-all` see OpenIM in action.
Component Configuration Instructions -Read: Configuration center document:https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/contrib/environment.md +Read: Configuration center document:https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/environment.md
@@ -236,7 +236,7 @@ Read: Configuration center document:https://github.com/OpenIMSDK/Open-IM-Serve
Deployed with kubernetes -Read: https://github.com/OpenIMSDK/Open-IM-Server/blob/main/deployments/README.md +Read: https://github.com/openimsdk/open-im-server/blob/main/deployments/README.md
@@ -268,30 +268,30 @@ Read: https://github.com/OpenIMSDK/Open-IM-Server/blob/main/deployments/README.m OpenIM isn't just an open-source instant messaging component, it's an integral part of your application ecosystem. Check out this diagram to understand how AppServer, AppClient, Open-IM-Server, and Open-IM-SDK interact. -![App-OpenIM Relationship](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/images/open-im-server.png) +![App-OpenIM Relationship](https://github.com/openimsdk/open-im-server/blob/main/docs/images/open-im-server.png) ## :building_construction: Overall Architecture Delve into the heart of Open-IM-Server's functionality with our architecture diagram. -![Overall Architecture](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/images/Architecture.jpg) +![Overall Architecture](https://github.com/openimsdk/open-im-server/blob/main/docs/images/Architecture.jpg) ## :hammer_and_wrench: To start developing OpenIM OpenIM Our goal is to build a top-level open source community. We have a set of standards, in the [Community repository](https://github.com/OpenIMSDK/community). -If you'd like to contribute to this Open-IM-Server repository, please read our [contributor documentation](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/CONTRIBUTING.md). +If you'd like to contribute to this Open-IM-Server repository, please read our [contributor documentation](https://github.com/openimsdk/open-im-server/blob/main/CONTRIBUTING.md). -Before you start, please make sure your changes are in demand. The best for that is to create a [new discussion](https://github.com/OpenIMSDK/Open-IM-Server/discussions/new/choose) OR [Slack Communication](https://join.slack.com/t/openimsdk/shared_invite/zt-22720d66b-o_FvKxMTGXtcnnnHiMqe9Q), or if you find an issue, [report it](https://github.com/OpenIMSDK/Open-IM-Server/issues/new/choose) first. +Before you start, please make sure your changes are in demand. The best for that is to create a [new discussion](https://github.com/openimsdk/open-im-server/discussions/new/choose) OR [Slack Communication](https://join.slack.com/t/openimsdk/shared_invite/zt-22720d66b-o_FvKxMTGXtcnnnHiMqe9Q), or if you find an issue, [report it](https://github.com/openimsdk/open-im-server/issues/new/choose) first. -- [Code Standards](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/go_code.md) -- [Docker Images Standards](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/images.md) -- [Directory Standards](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/directory.md) -- [Commit Standards](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/commit.md) -- [Versioning Standards](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/version.md) -- [Interface Standards](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/api.md) -- [Log Standards](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/logging.md) -- [Error Code Standards](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/error_code.md) +- [Code Standards](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/go_code.md) +- [Docker Images Standards](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/images.md) +- [Directory Standards](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/directory.md) +- [Commit Standards](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/commit.md) +- [Versioning Standards](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/version.md) +- [Interface Standards](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/api.md) +- [Log Standards](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/logging.md) +- [Error Code Standards](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/error_code.md) ## :busts_in_silhouette: Community @@ -306,20 +306,20 @@ We want anyone to get involved in our community and contributing code, we offer Our conference is in the [OpenIM Slack](https://join.slack.com/t/openimsdk/shared_invite/zt-22720d66b-o_FvKxMTGXtcnnnHiMqe9Q) 🎯, then you can search the Open-IM-Server pipeline to join -We take notes of each [biweekly meeting](https://github.com/orgs/OpenIMSDK/discussions/categories/meeting) in [GitHub discussions](https://github.com/OpenIMSDK/Open-IM-Server/discussions/categories/meeting), Our historical meeting notes, as well as replays of the meetings are available at [Google Docs :bookmark_tabs:](https://docs.google.com/document/d/1nx8MDpuG74NASx081JcCpxPgDITNTpIIos0DS6Vr9GU/edit?usp=sharing). +We take notes of each [biweekly meeting](https://github.com/orgs/OpenIMSDK/discussions/categories/meeting) in [GitHub discussions](https://github.com/openimsdk/open-im-server/discussions/categories/meeting), Our historical meeting notes, as well as replays of the meetings are available at [Google Docs :bookmark_tabs:](https://docs.google.com/document/d/1nx8MDpuG74NASx081JcCpxPgDITNTpIIos0DS6Vr9GU/edit?usp=sharing). ## :eyes: Who are using OpenIM -Check out our [user case studies](https://github.com/OpenIMSDK/community/blob/main/ADOPTERS.md) page for a list of the project users. Don't hesitate to leave a [📝comment](https://github.com/OpenIMSDK/Open-IM-Server/issues/379) and share your use case. +Check out our [user case studies](https://github.com/OpenIMSDK/community/blob/main/ADOPTERS.md) page for a list of the project users. Don't hesitate to leave a [📝comment](https://github.com/openimsdk/open-im-server/issues/379) and share your use case. ## :page_facing_up: License -OpenIM is licensed under the Apache 2.0 license. See [LICENSE](https://github.com/OpenIMSDK/Open-IM-Server/tree/main/LICENSE) for the full license text. +OpenIM is licensed under the Apache 2.0 license. See [LICENSE](https://github.com/openimsdk/open-im-server/tree/main/LICENSE) for the full license text. -The OpenIM logo, including its variations and animated versions, displayed in this repository [OpenIM](https://github.com/OpenIMSDK/Open-IM-Server) under the [assets/logo](./assets/logo) and [assets/logo-gif](assets/logo-gif) directories, are protected by copyright laws. +The OpenIM logo, including its variations and animated versions, displayed in this repository [OpenIM](https://github.com/openimsdk/open-im-server) under the [assets/logo](./assets/logo) and [assets/logo-gif](assets/logo-gif) directories, are protected by copyright laws. ## 🔮 Thanks to our contributors! - - + + diff --git a/build/goreleaser.yaml b/build/goreleaser.yaml index ecd031921..d4e28fc2a 100644 --- a/build/goreleaser.yaml +++ b/build/goreleaser.yaml @@ -484,8 +484,8 @@ changelog: # use: buildx # build_flag_templates: # - "--pull" -# - "--label=io.artifacthub.package.readme-url=https://raw.githubusercontent.com/OpenIMSDK/Open-IM-Server/main/README.md" -# - "--label=io.artifacthub.package.logo-url=hhttps://github.com/OpenIMSDK/Open-IM-Server/blob/main/assets/logo/openim-logo-green.png" +# - "--label=io.artifacthub.package.readme-url=https://raw.githubusercontent.com/openimsdk/open-im-server/main/README.md" +# - "--label=io.artifacthub.package.logo-url=hhttps://github.com/openimsdk/open-im-server/blob/main/assets/logo/openim-logo-green.png" # - '--label=io.artifacthub.package.maintainers=[{"name":"Xinwei Xiong","email":"3293172751nss@gmail.com"}]' # - "--label=io.artifacthub.package.license=Apace-2.0" # - "--label=org.opencontainers.image.description=OpenIM Open source top instant messaging system" @@ -504,8 +504,8 @@ changelog: # use: buildx # build_flag_templates: # - "--pull" -# - "--label=io.artifacthub.package.readme-url=https://raw.githubusercontent.com/OpenIMSDK/Open-IM-Server/main/README.md" -# - "--label=io.artifacthub.package.logo-url=hhttps://github.com/OpenIMSDK/Open-IM-Server/blob/main/assets/logo/openim-logo-green.png" +# - "--label=io.artifacthub.package.readme-url=https://raw.githubusercontent.com/openimsdk/open-im-server/main/README.md" +# - "--label=io.artifacthub.package.logo-url=hhttps://github.com/openimsdk/open-im-server/blob/main/assets/logo/openim-logo-green.png" # - '--label=io.artifacthub.package.maintainers=[{"name":"Xinwei Xiong","email":"3293172751nss@gmail.com"}]' # - "--label=io.artifacthub.package.license=Apace-2.0" # - "--label=org.opencontainers.image.description=OpenIM Open source top instant messaging system" @@ -555,7 +555,7 @@ nfpms: - openim-rpc-user # Your app's vendor. vendor: OpenIMSDK - homepage: https://github.com/OpenIMSDK/Open-IM-Server + homepage: https://github.com/openimsdk/open-im-server maintainer: kubbot description: |- Auto sync github labels diff --git a/config/config.yaml b/config/config.yaml index c8c994c36..c1059581b 100644 --- a/config/config.yaml +++ b/config/config.yaml @@ -132,14 +132,14 @@ api: # minio.signEndpoint is minio public network address object: enable: "minio" - apiURL: "http://14.153.6.114: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://14.153.6.114:10005" + signEndpoint: "http://172.28.0.1:10005" cos: bucketURL: https://temp-1252357374.cos.ap-chengdu.myqcloud.com secretID: '' @@ -194,7 +194,7 @@ rpcRegisterName: # Whether to output in json format # Whether to include stack trace in logs log: - storageLocation: ../logs + storageLocation: /root/workspaces/openim/openim-server/logs/ rotationTime: 24 remainRotationCount: 2 remainLogLevel: 6 diff --git a/deployments/README.md b/deployments/README.md index 7e3d47854..1dfb87217 100644 --- a/deployments/README.md +++ b/deployments/README.md @@ -7,7 +7,7 @@ OpenIM 支持很多种集群化部署方式,包括但不限于 helm, sealos, k 目前各个贡献者,以及之前的官方有出过一些可以参考的方案: - https://github.com/OpenIMSDK/k8s-jenkins -- https://github.com/OpenIMSDK/Open-IM-Server-k8s-deploy +- https://github.com/openimsdk/open-im-server-k8s-deploy - https://github.com/OpenIMSDK/openim-charts - https://github.com/showurl/deploy-openim diff --git a/deployments/templates/init/openim-api.service b/deployments/templates/init/openim-api.service index dba018b89..aed0e9b2d 100644 --- a/deployments/templates/init/openim-api.service +++ b/deployments/templates/init/openim-api.service @@ -1,7 +1,7 @@ [Unit] Description=OPENIM OPENIM API Documentation=Control interface for the OpenIM API service. -Documentation=https://github.com/OpenIMSDK/Open-IM-Server/blob/main/deployment/init/README.md +Documentation=https://github.com/openimsdk/open-im-server/blob/main/deployment/init/README.md [Service] WorkingDirectory=${OPENIM_DATA_DIR}/openim-api diff --git a/deployments/templates/init/openim-cmdutils.service b/deployments/templates/init/openim-cmdutils.service index f96976a89..0e1058483 100644 --- a/deployments/templates/init/openim-cmdutils.service +++ b/deployments/templates/init/openim-cmdutils.service @@ -1,7 +1,7 @@ [Unit] Description=OPENIM OPENIM CMDUTILS Documentation=Utility toolkit for common OpenIM command-line operations. -Documentation=https://github.com/OpenIMSDK/Open-IM-Server/blob/main/deployment/init/README.md +Documentation=https://github.com/openimsdk/open-im-server/blob/main/deployment/init/README.md [Service] WorkingDirectory=${OPENIM_DATA_DIR}/openim-cmdutils diff --git a/deployments/templates/init/openim-crontask.service b/deployments/templates/init/openim-crontask.service index 9f1a60898..30ebe997e 100644 --- a/deployments/templates/init/openim-crontask.service +++ b/deployments/templates/init/openim-crontask.service @@ -1,7 +1,7 @@ [Unit] Description=OPENIM OPENIM CRONTASK Documentation=Manages the OpenIM CronTask service, with both direct and systemctl installation methods. -Documentation=https://github.com/OpenIMSDK/Open-IM-Server/blob/main/deployment/init/README.md +Documentation=https://github.com/openimsdk/open-im-server/blob/main/deployment/init/README.md [Service] WorkingDirectory=${OPENIM_DATA_DIR}/openim-crontask diff --git a/deployments/templates/init/openim-msggateway.service b/deployments/templates/init/openim-msggateway.service index 4e280dd86..e0a322492 100644 --- a/deployments/templates/init/openim-msggateway.service +++ b/deployments/templates/init/openim-msggateway.service @@ -1,6 +1,6 @@ [Unit] Description=OPENIM OPENIM MSGGATEWAY -Documentation=https://github.com/OpenIMSDK/Open-IM-Server/blob/main/deployment/init/README.md +Documentation=https://github.com/openimsdk/open-im-server/blob/main/deployment/init/README.md [Service] WorkingDirectory=${OPENIM_DATA_DIR}/openim-msggateway diff --git a/deployments/templates/init/openim-msgtransfer.service b/deployments/templates/init/openim-msgtransfer.service index bd805a0ba..7e20c4c92 100644 --- a/deployments/templates/init/openim-msgtransfer.service +++ b/deployments/templates/init/openim-msgtransfer.service @@ -1,6 +1,6 @@ [Unit] Description=OPENIM OPENIM MSGTRANSFER -Documentation=https://github.com/OpenIMSDK/Open-IM-Server/blob/main/deployment/init/README.md +Documentation=https://github.com/openimsdk/open-im-server/blob/main/deployment/init/README.md [Service] WorkingDirectory=${OPENIM_DATA_DIR}/openim-msgtransfer diff --git a/deployments/templates/init/openim-push.service b/deployments/templates/init/openim-push.service index b2fdc237c..efcc88e89 100644 --- a/deployments/templates/init/openim-push.service +++ b/deployments/templates/init/openim-push.service @@ -1,7 +1,7 @@ [Unit] Description=OPENIM OPENIM PUSH Documentation=Interface for controlling the OpenIM Push Notification service. -Documentation=https://github.com/OpenIMSDK/Open-IM-Server/blob/main/deployment/init/README.md +Documentation=https://github.com/openimsdk/open-im-server/blob/main/deployment/init/README.md [Service] WorkingDirectory=${OPENIM_DATA_DIR}/openim-push diff --git a/deployments/templates/init/openim-rpc.service b/deployments/templates/init/openim-rpc.service index 15671602a..026e3ebe2 100644 --- a/deployments/templates/init/openim-rpc.service +++ b/deployments/templates/init/openim-rpc.service @@ -1,6 +1,6 @@ [Unit] Description=OPENIM OPENIM RPC AUTH -Documentation=https://github.com/OpenIMSDK/Open-IM-Server/blob/main/deployment/init/README.md +Documentation=https://github.com/openimsdk/open-im-server/blob/main/deployment/init/README.md [Service] WorkingDirectory=${OPENIM_DATA_DIR}/openim-rpc-auth diff --git a/docker-compose.yml b/docker-compose.yml index b08c12097..126409d3d 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -1,4 +1,4 @@ -#fixme Clone openIM Server project before using docker-compose,project address:https://github.com/OpenIMSDK/Open-IM-Server.git +#fixme Clone openIM Server project before using docker-compose,project address:https://github.com/openimsdk/open-im-server.git version: '3' networks: @@ -140,7 +140,7 @@ services: - "9090:9090" container_name: minio volumes: - - minio_data:/data + - minio_data:/data - minio_config:/root/.minio environment: MINIO_ROOT_USER: "${MINIO_ACCESS_KEY}" diff --git a/docs/README.md b/docs/README.md index e1d8c5d58..f9d045c49 100644 --- a/docs/README.md +++ b/docs/README.md @@ -4,8 +4,8 @@ Welcome to the OpenIM Documentation hub! This center provides a comprehensive ra ## Table of Contents -1. [Contrib](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/contrib) - Guidance on contributing and configurations for developers -2. [Conversions](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions) - Coding conventions, logging policies, and other transformation tools +1. [Contrib](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib) - Guidance on contributing and configurations for developers +2. [Conversions](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions) - Coding conventions, logging policies, and other transformation tools ------ @@ -13,34 +13,34 @@ Welcome to the OpenIM Documentation hub! This center provides a comprehensive ra This section offers developers a detailed guide on how to contribute code, set up their environment, and follow the associated processes. -- [Code Conventions](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/contrib/code_conventions.md) - Rules and conventions for writing code in OpenIM. -- [Development Guide](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/contrib/development.md) - A guide on how to carry out development within OpenIM. -- [Git Cherry Pick](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/contrib/git_cherry-pick.md) - Guidelines on cherry-picking operations. -- [Git Workflow](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/contrib/git_workflow.md) - The git workflow in OpenIM. -- [Initialization Configurations](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/contrib/init_config.md) - Guidance on setting up and initializing OpenIM. -- [Docker Installation](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/contrib/install_docker.md) - How to install Docker on your machine. -- [Linux Development Environment](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/contrib/linux_development.md) - Guide to set up the development environment on Linux. -- [Local Actions](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/contrib/local_actions.md) - Guidelines on how to carry out certain common actions locally. -- [Offline Deployment](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/contrib/offline-deployment.md) - Methods of deploying OpenIM offline. -- [Protoc Tools](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/contrib/protoc_tools.md) - Guide on using protoc tools. -- [Go Tools](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/contrib/util_go.md) - Tools and libraries in OpenIM for Go. -- [Makefile Tools](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/contrib/util_makefile.md) - Best practices and tools for Makefile. -- [Script Tools](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/contrib/util_scripts.md) - Best practices and tools for scripts. +- [Code Conventions](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/code_conventions.md) - Rules and conventions for writing code in OpenIM. +- [Development Guide](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/development.md) - A guide on how to carry out development within OpenIM. +- [Git Cherry Pick](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/git_cherry-pick.md) - Guidelines on cherry-picking operations. +- [Git Workflow](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/git_workflow.md) - The git workflow in OpenIM. +- [Initialization Configurations](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/init_config.md) - Guidance on setting up and initializing OpenIM. +- [Docker Installation](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/install_docker.md) - How to install Docker on your machine. +- [Linux Development Environment](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/linux_development.md) - Guide to set up the development environment on Linux. +- [Local Actions](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/local_actions.md) - Guidelines on how to carry out certain common actions locally. +- [Offline Deployment](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/offline-deployment.md) - Methods of deploying OpenIM offline. +- [Protoc Tools](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/protoc_tools.md) - Guide on using protoc tools. +- [Go Tools](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/util_go.md) - Tools and libraries in OpenIM for Go. +- [Makefile Tools](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/util_makefile.md) - Best practices and tools for Makefile. +- [Script Tools](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/util_scripts.md) - Best practices and tools for scripts. ## Conversions This section introduces various conventions and policies within OpenIM, encompassing code, logs, versions, and more. -- [API Conversions](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/api.md) - Guidelines and methods for API conversions. -- [Logging Policy](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/bash_log.md) - Logging policies and conventions in OpenIM. -- [CI/CD Actions](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/cicd_actions.md) - Procedures and conventions for CI/CD. -- [Commit Conventions](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/commit.md) - Conventions for code commits in OpenIM. -- [Directory Conventions](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/directory.md) - Directory structure and conventions within OpenIM. -- [Error Codes](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/error_code.md) - List and descriptions of error codes. -- [Go Code Conversions](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/go_code.md) - Conventions and conversions for Go code. -- [Docker Image Strategy](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/images.md) - Management strategies for OpenIM Docker images, spanning multiple architectures and image repositories. -- [Logging Conventions](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/logging.md) - Further detailed conventions on logging. -- [Version Conventions](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/version.md) - Naming and management strategies for OpenIM versions. +- [API Conversions](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/api.md) - Guidelines and methods for API conversions. +- [Logging Policy](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/bash_log.md) - Logging policies and conventions in OpenIM. +- [CI/CD Actions](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/cicd_actions.md) - Procedures and conventions for CI/CD. +- [Commit Conventions](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/commit.md) - Conventions for code commits in OpenIM. +- [Directory Conventions](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/directory.md) - Directory structure and conventions within OpenIM. +- [Error Codes](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/error_code.md) - List and descriptions of error codes. +- [Go Code Conversions](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/go_code.md) - Conventions and conversions for Go code. +- [Docker Image Strategy](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/images.md) - Management strategies for OpenIM Docker images, spanning multiple architectures and image repositories. +- [Logging Conventions](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/logging.md) - Further detailed conventions on logging. +- [Version Conventions](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/version.md) - Naming and management strategies for OpenIM versions. ## For Developers, Contributors, and Community Maintainers @@ -49,19 +49,19 @@ This section introduces various conventions and policies within OpenIM, encompas If you're a developer or someone keen on contributing: -- Familiarize yourself with our [Code Conventions](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/contrib/code_conventions.md) and [Git Workflow](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/contrib/git_workflow.md) to ensure smooth contributions. -- Dive into the [Development Guide](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/contrib/development.md) to get a hang of the development practices in OpenIM. +- Familiarize yourself with our [Code Conventions](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/code_conventions.md) and [Git Workflow](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/git_workflow.md) to ensure smooth contributions. +- Dive into the [Development Guide](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/development.md) to get a hang of the development practices in OpenIM. ### Community Maintainers As a community maintainer: - Ensure that contributions align with the standards outlined in our documentation. -- Regularly review the [Logging Policy](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/bash_log.md) and [Error Codes](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/error_code.md) to stay updated. +- Regularly review the [Logging Policy](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/bash_log.md) and [Error Codes](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/error_code.md) to stay updated. ## For Users Users should pay particular attention to: -- [Docker Installation](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/contrib/install_docker.md) - Necessary if you're planning to use Docker images of OpenIM. -- [Docker Image Strategy](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/images.md) - To understand the different images available and how to choose the right one for your architecture. \ No newline at end of file +- [Docker Installation](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/install_docker.md) - Necessary if you're planning to use Docker images of OpenIM. +- [Docker Image Strategy](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/images.md) - To understand the different images available and how to choose the right one for your architecture. \ No newline at end of file diff --git a/docs/contrib/code_conventions.md b/docs/contrib/code_conventions.md index 94478e6ff..39bec1114 100644 --- a/docs/contrib/code_conventions.md +++ b/docs/contrib/code_conventions.md @@ -35,4 +35,4 @@ ## Testing conventions -Please refer to [TESTING.md](https://github.com/OpenIMSDK/Open-IM-Server/tree/main/test/readme) document. +Please refer to [TESTING.md](https://github.com/openimsdk/open-im-server/tree/main/test/readme) document. diff --git a/docs/contrib/development.md b/docs/contrib/development.md index a8c640570..45039304a 100644 --- a/docs/contrib/development.md +++ b/docs/contrib/development.md @@ -61,7 +61,7 @@ OpenIM build and test processes development require Docker to run certain steps. ### Vagrant -As described in the [Testing documentation](https://github.com/OpenIMSDK/Open-IM-Server/tree/main/test/readme), all the smoke tests are run in virtual machines managed by Vagrant. To install Vagrant in the development environment, [follow the instructions from the Hashicorp website](https://www.vagrantup.com/downloads), alongside any of the following hypervisors: +As described in the [Testing documentation](https://github.com/openimsdk/open-im-server/tree/main/test/readme), all the smoke tests are run in virtual machines managed by Vagrant. To install Vagrant in the development environment, [follow the instructions from the Hashicorp website](https://www.vagrantup.com/downloads), alongside any of the following hypervisors: - [VirtualBox](https://www.virtualbox.org/) - [libvirt](https://libvirt.org/) and the [vagrant-libvirt plugin](https://github.com/vagrant-libvirt/vagrant-libvirt#installation) diff --git a/docs/contrib/environment.md b/docs/contrib/environment.md index 51baa5ae0..d539b961b 100644 --- a/docs/contrib/environment.md +++ b/docs/contrib/environment.md @@ -13,7 +13,7 @@ Three ways to modify the configuration: ```bash export PASSWORD="openIM123" # Set password export USER="root" # Set username -# Choose chat version and server version https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/images.md, eg: main, release-v*.* +# Choose chat version and server version https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/images.md, eg: main, release-v*.* export CHAT_BRANCH="main" export SERVER_BRANCH="main" #... Other environment variables @@ -48,9 +48,76 @@ make init The `config/config.yaml` file has detailed configuration instructions for the storage components. -The config file is available via [environment.sh](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/scripts/install/environment.sh) configuration [openim.yaml](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/deployments/templates/openim.yaml) template, and then through the `make init` to automatically generate a new configuration. +The config file is available via [environment.sh](https://github.com/openimsdk/open-im-server/blob/main/scripts/install/environment.sh) configuration [openim.yaml](https://github.com/openimsdk/open-im-server/blob/main/deployments/templates/openim.yaml) template, and then through the `make init` to automatically generate a new configuration. +## Environment variable + +By setting the environment variable below, You can then refresh the configuration using `make init` or `./scripts/init-config.sh` + +##### MINIO + ++ [MINIO DOCS](https://min.io/docs/minio/kubernetes/upstream/index.html) + +apiURL is the address of the api, the access address of the app, use s3 must be configured + +#### Overview + +MinIO is an object storage server that is API compatible with Amazon S3. It's best suited for storing unstructured data such as photos, videos, log files, backups, and container/VM images. In this guide, we'll walk through the process of configuring MinIO with custom settings. + +#### Default Configuration + +Configuration can be achieved by modifying the default variables in the `./scripts/install/environment.sh` file. However, for more flexibility and dynamic adjustments, setting environment variables is recommended. + +#### Setting Up the Environment Variables + +##### IP Configuration + +By default, the system generates the public IP of the machine. To manually set a public or local IP address, use: + +```bash +export IP=127.0.0.1 +``` + +##### API URL + +This is the address your application uses to communicate with MinIO. By default, it uses the public IP. However, you can adjust it to a public domain or another IP. + +```bash +export API_URL=127.0.0.1:10002 +``` + +##### MinIO Endpoint Configuration + +This is the primary address MinIO uses for communications: + +```bash +export MINIO_ENDPOINT="127.0.0.1" +``` + +##### MinIO Sign Endpoint + +For direct external access to stored content: + +```bash +export MINIO_SIGN_ENDPOINT=127.0.0.1:10005 +``` + +##### Modifying MinIO's Port + +If you need to adjust MinIO's port from the default: + +```bash +export MINIO_PORT="10005" +``` + +#### Applying the Configuration + +After setting your desired environment variables, restart the MinIO server to apply the changes. + +#### Verification + +It's crucial to verify the configurations by checking the connectivity between your application and MinIO using the set API URL and ensuring that the data can be directly accessed using the `signEndpoint`. ## Configuration Details @@ -133,6 +200,16 @@ The config file is available via [environment.sh](https://github.com/OpenIMSDK/O + + ## Config options -... \ No newline at end of file +... + +## Use the default values + +A method to revert to the default value: + +```bash +export IP=127.0.0.1 +``` diff --git a/docs/contrib/git_cherry-pick.md b/docs/contrib/git_cherry-pick.md index 9afb9c232..010685d65 100644 --- a/docs/contrib/git_cherry-pick.md +++ b/docs/contrib/git_cherry-pick.md @@ -27,8 +27,8 @@ Ensuring this strategy's success extends beyond just documentation; it hinges on - [Contributor License Agreement](https://github.com/openim-sigs/cla) is considered implicit for all code within cherry pick pull requests, **unless there is a large conflict**. - A pull request merged against the `main` branch. -- The release branch exists (example: [`release-1.18`](https://github.com/OpenIMSDK/Open-IM-Server/tree/release-v3.1)) -- The normal git and GitHub configured shell environment for pushing to your openim-server `origin` fork on GitHub and making a pull request against a configured remote `upstream` that tracks `https://github.com/OpenIMSDK/Open-IM-Server.git`, including `GITHUB_USER`. +- The release branch exists (example: [`release-1.18`](https://github.com/openimsdk/open-im-server/tree/release-v3.1)) +- The normal git and GitHub configured shell environment for pushing to your openim-server `origin` fork on GitHub and making a pull request against a configured remote `upstream` that tracks `https://github.com/openimsdk/open-im-server.git`, including `GITHUB_USER`. - Have GitHub CLI (`gh`) installed following [installation instructions](https://github.com/cli/cli#installation). - A github personal access token which has permissions "repo" and "read:org". Permissions are required for [gh auth login](https://cli.github.com/manual/gh_auth_login) and not used for anything unrelated to cherry-pick creation process (creating a branch and initiating PR). @@ -65,7 +65,7 @@ It is critical that our full community is actively engaged on enhancements in th ### Steps -- Run the [cherry pick script](https://github.com/OpenIMSDK/Open-IM-Server/tree/main/scripts/cherry-pick.sh) +- Run the [cherry pick script](https://github.com/openimsdk/open-im-server/tree/main/scripts/cherry-pick.sh) This example applies a main branch PR #98765 to the remote branch `upstream/release-v3.1`: @@ -75,9 +75,9 @@ It is critical that our full community is actively engaged on enhancements in th - Be aware the cherry pick script assumes you have a git remote called `upstream` that points at the openim-server github org. - Please see our [recommended Git workflow](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/contributors/github-workflow.md#workflow). + Please see our [recommended Git workflow](https://github.com/openimsdk/open-im-server/blob/main/docs/contributors/github-workflow.md#workflow). - - You will need to run the cherry pick script separately for each patch release you want to cherry pick to. Cherry picks should be applied to all [active](https://github.com/OpenIMSDK/Open-IM-Server/releases) release branches where the fix is applicable. + - You will need to run the cherry pick script separately for each patch release you want to cherry pick to. Cherry picks should be applied to all [active](https://github.com/openimsdk/open-im-server/releases) release branches where the fix is applicable. - If `GITHUB_TOKEN` is not set you will be asked for your github password: provide the github [personal access token](https://github.com/settings/tokens) rather than your actual github password. If you can securely set the environment variable `GITHUB_TOKEN` to your personal access token then you can avoid an interactive prompt. Refer [mislav/hub#2655 (comment)](https://github.com/mislav/hub/issues/2655#issuecomment-735836048) diff --git a/docs/contrib/git_workflow.md b/docs/contrib/git_workflow.md index 1d21f9cdd..32257e941 100644 --- a/docs/contrib/git_workflow.md +++ b/docs/contrib/git_workflow.md @@ -18,7 +18,7 @@ OpenIM project uses the [GitHub flow](https://docs.github.com/en/get-started/qui ### Branch naming conventions -Every forked repository works independently, meaning that any contributor can create branches with the name they see fit. However, it is worth noting that OpenIM mirrors [OpenIM version skew policy](https://github.com/OpenIMSDK/Open-IM-Server/releases) by maintaining release branches for the most recent three minor releases. The only exception is that the main branch mirrors the latest OpenIM release (3.10) instead of using a `release-` prefixed one. +Every forked repository works independently, meaning that any contributor can create branches with the name they see fit. However, it is worth noting that OpenIM mirrors [OpenIM version skew policy](https://github.com/openimsdk/open-im-server/releases) by maintaining release branches for the most recent three minor releases. The only exception is that the main branch mirrors the latest OpenIM release (3.10) instead of using a `release-` prefixed one. ```text main -------------------------------------------. (OpenIM 3.10) @@ -39,7 +39,7 @@ There are everyday tasks related to git that every contributor needs to perform, Creating a OpenIM fork, cloning it, and setting its upstream remote can be summarized on: -1. Visit +1. Visit 2. Click the `Fork` button (top right) to establish a cloud-based fork 3. Clone fork to local storage 4. Add to your fork OpenIM remote as upstream @@ -54,8 +54,8 @@ git clone https://github.com/$user/OpenIM.git ## Add OpenIM as upstream to your fork cd OpenIM -git remote add upstream https://github.com/OpenIMSDK/Open-IM-Server.git -# or: git remote add upstream git@github.com:OpenIMSDK/Open-IM-Server.git +git remote add upstream https://github.com/openimsdk/open-im-server.git +# or: git remote add upstream git@github.com:openimsdk/open-im-server.git ## Ensure to never push to upstream directly git remote set-url --push upstream no_push diff --git a/docs/contrib/offline-deployment.md b/docs/contrib/offline-deployment.md index 6272c7499..f5083ad12 100644 --- a/docs/contrib/offline-deployment.md +++ b/docs/contrib/offline-deployment.md @@ -26,11 +26,11 @@ docker pull minio/minio ## 2. OpenIM & Chat Images -**For detailed understanding of version management and storage of OpenIM and Chat**: [version.md](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/version.md) +**For detailed understanding of version management and storage of OpenIM and Chat**: [version.md](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/version.md) ### OpenIM Image -- Get image version info: [images.md](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/images.md) +- Get image version info: [images.md](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/images.md) - Depending on the required version, execute the following command: ```bash @@ -111,6 +111,6 @@ docker-compose ps ## 6. Reference Links -- [OpenIMSDK Issue #432](https://github.com/OpenIMSDK/Open-IM-Server/issues/432) +- [OpenIMSDK Issue #432](https://github.com/openimsdk/open-im-server/issues/432) - [Notion Link](https://nsddd.notion.site/435ee747c0bc44048da9300a2d745ad3?pvs=25) -- [OpenIMSDK Issue #474](https://github.com/OpenIMSDK/Open-IM-Server/issues/474) \ No newline at end of file +- [OpenIMSDK Issue #474](https://github.com/openimsdk/open-im-server/issues/474) \ No newline at end of file diff --git a/docs/contrib/util_go.md b/docs/contrib/util_go.md index 4126aa97c..ca7b26ad1 100644 --- a/docs/contrib/util_go.md +++ b/docs/contrib/util_go.md @@ -1,6 +1,6 @@ # utils go -+ [toold readme](https://github.com/OpenIMSDK/Open-IM-Server/tree/main/tools) ++ [toold readme](https://github.com/openimsdk/open-im-server/tree/main/tools) about scripts fix: ``` diff --git a/docs/conversions/github-workflow.md b/docs/conversions/github-workflow.md index 013495e5e..64b530740 100644 --- a/docs/conversions/github-workflow.md +++ b/docs/conversions/github-workflow.md @@ -83,7 +83,7 @@ You may now edit files on the `myfeature` branch. ### Building open-im-server -This workflow is process-specific. For quick-start build instructions for [openimsdk/open-im-server](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/contrib/util_makefile.md) +This workflow is process-specific. For quick-start build instructions for [openimsdk/open-im-server](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/util_makefile.md) ## 4. Keep your branch in sync diff --git a/docs/conversions/logging.md b/docs/conversions/logging.md index 82f74c9aa..fd9e883ef 100644 --- a/docs/conversions/logging.md +++ b/docs/conversions/logging.md @@ -2,7 +2,7 @@ ### Log Standards -- The unified log package `github.com/OpenIMSDK/Open-IM-Server/internal/pkg/log` should be used for all logging; +- The unified log package `github.com/openimsdk/open-im-server/internal/pkg/log` should be used for all logging; - Use structured logging formats: `log.Infow`, `log.Warnw`, `log.Errorw`, etc. For example: `log.Infow("Update post function called")`; - All logs should start with an uppercase letter and should not end with a `.`. For example: `log.Infow("Update post function called")`; - Use past tense. For example, use `Could not delete B` instead of `Cannot delete B`; diff --git a/docs/conversions/version.md b/docs/conversions/version.md index 0e6a26988..0980eaa27 100644 --- a/docs/conversions/version.md +++ b/docs/conversions/version.md @@ -27,15 +27,15 @@ In the OpenIM repository, version identification strictly complies with the `MAJ ## Main Branch: The Heart of OpenIM Development -The `main` branch is the operational heart of our development process. Housing the most recent and advanced features, this branch serves as the nerve center for all enhancements and updates. It encapsulates the freshest, though possibly unstable, facets of the software. Visit our `main` branch [here](https://github.com/OpenIMSDK/Open-IM-Server/tree/main). +The `main` branch is the operational heart of our development process. Housing the most recent and advanced features, this branch serves as the nerve center for all enhancements and updates. It encapsulates the freshest, though possibly unstable, facets of the software. Visit our `main` branch [here](https://github.com/openimsdk/open-im-server/tree/main). ## Release Branch: The Beacon of Stability -For every major release, we curate a corresponding `release` branch, e.g., `release-v3.1`. This branch symbolizes an embodiment of stability and ensures an updated version of the software, providing a dependable option for users favoring stability over nascent, yet possibly unstable, features. Visit the `release-v3.1` branch [here](https://github.com/OpenIMSDK/Open-IM-Server/tree/release-v3.1). +For every major release, we curate a corresponding `release` branch, e.g., `release-v3.1`. This branch symbolizes an embodiment of stability and ensures an updated version of the software, providing a dependable option for users favoring stability over nascent, yet possibly unstable, features. Visit the `release-v3.1` branch [here](https://github.com/openimsdk/open-im-server/tree/release-v3.1). ## Tag Management: The Cornerstone of Version Control -In OpenIM's version control system, the role of `tags` stands paramount. Owing to their immutable nature, tags can be effectively utilized to retrieve a specific version of the software. Explore our library of tags [here](https://github.com/OpenIMSDK/Open-IM-Server/tags). +In OpenIM's version control system, the role of `tags` stands paramount. Owing to their immutable nature, tags can be effectively utilized to retrieve a specific version of the software. Explore our library of tags [here](https://github.com/openimsdk/open-im-server/tags). Our Docker image versions are intimately entwined with these tripartite components. For instance, a Docker image tag may correspond to `ghcr.io/openimsdk/openim-server:v3.1.0`, a release to `ghcr.io/openimsdk/openim-server:release-v3.0`, and the main branch to `ghcr.io/openimsdk/openim-server:main` or `ghcr.io/openimsdk/openim-server:latest`. @@ -55,7 +55,7 @@ Whenever a project undergoes a partial functional addition, the minor version nu ## Release Management: A Guided Tour -Our GitHub repository at https://github.com/OpenIMSDK/Open-IM-Server/releases associates a release with each tag, with a distinction between Pre-release and Latest, determined by the branch source. Every significant feature launch prompts the issue of a `release` branch, such as `release-v3.2`, as a beacon of stability and Latest release. +Our GitHub repository at https://github.com/openimsdk/open-im-server/releases associates a release with each tag, with a distinction between Pre-release and Latest, determined by the branch source. Every significant feature launch prompts the issue of a `release` branch, such as `release-v3.2`, as a beacon of stability and Latest release. Pre-releases correspond to releases from the `main` branch, denoting tags with Version modifiers such as `v3.2.1-beta.0`, `v3.2.1-rc.1`, etc. If you are seeking the most recent, albeit possibly unstable, release with new features, these tags, originating from the latest `main` branch code, are your go-to. @@ -65,9 +65,9 @@ Conversely, if stability is your primary concern, you should opt for the release **About:** -+ [OpenIM Milestones](https://github.com/OpenIMSDK/Open-IM-Server/milestones) -+ [OpenIM Tags](https://github.com/OpenIMSDK/Open-IM-Server/tags) -+ [OpenIM Branches](https://github.com/OpenIMSDK/Open-IM-Server/branches) ++ [OpenIM Milestones](https://github.com/openimsdk/open-im-server/milestones) ++ [OpenIM Tags](https://github.com/openimsdk/open-im-server/tags) ++ [OpenIM Branches](https://github.com/openimsdk/open-im-server/branches) We create a new branch, such as `release-v3.1`, for each significant milestone (e.g., v3.1.0), housing all relevant code for that release. All enhancements and bug fixes targeting the subsequent version (e.g., v3.2.0) are integrated into this branch. @@ -120,4 +120,4 @@ Throughout this process, active communication within the team is pivotal to main ## Docker Images Version Management -For more details on managing Docker image versions, visit [OpenIM Docker Images Administration](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/images.md). +For more details on managing Docker image versions, visit [OpenIM Docker Images Administration](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/images.md). diff --git a/install.sh b/install.sh index 7dba0a39e..d43767362 100755 --- a/install.sh +++ b/install.sh @@ -103,9 +103,9 @@ function check_git_repo() { # Inside a git repository for remote in $(git remote); do repo_url=$(git remote get-url $remote) - if [[ $repo_url == "https://github.com/OpenIMSDK/Open-IM-Server.git" || \ - $repo_url == "https://github.com/OpenIMSDK/Open-IM-Server" || \ - $repo_url == "git@github.com:OpenIMSDK/Open-IM-Server.git" ]]; then + if [[ $repo_url == "https://github.com/openimsdk/open-im-server.git" || \ + $repo_url == "https://github.com/openimsdk/open-im-server" || \ + $repo_url == "git@github.com:openimsdk/open-im-server.git" ]]; then # If it's OpenIMSDK repository info "Current directory is OpenIMSDK git repository." info "Executing installation directly." @@ -515,7 +515,7 @@ O:::::::OOO:::::::O p:::::ppppp:::::::pe::::::::e n::::n n::::nII: ' 0.0001 # Display product URL - print_with_delay "Discover more and contribute at: https://github.com/OpenIMSDK/Open-IM-Server" 0.01 + print_with_delay "Discover more and contribute at: https://github.com/openimsdk/open-im-server" 0.01 # Reset text color back to normal echo -e "\033[0m" diff --git a/install_guide.sh b/install_guide.sh index c6532feb8..f42e65b9d 100755 --- a/install_guide.sh +++ b/install_guide.sh @@ -91,7 +91,7 @@ install_docker_compose() { fi rm -rf ./Open-IM-Server set -e - git clone https://github.com/OpenIMSDK/Open-IM-Server.git --recursive; + git clone https://github.com/openimsdk/open-im-server.git --recursive; set +e cd ./Open-IM-Server git checkout errcode diff --git a/pkg/apistruct/doc.go b/pkg/apistruct/doc.go index d99eab7b6..2f1404584 100644 --- a/pkg/apistruct/doc.go +++ b/pkg/apistruct/doc.go @@ -12,4 +12,4 @@ // See the License for the specific language governing permissions and // limitations under the License. -package apistruct // import "github.com/OpenIMSDK/Open-IM-Server/pkg/apistruct" +package apistruct // import "github.com/openimsdk/open-im-server/v3/pkg/apistruct" diff --git a/pkg/authverify/doc.go b/pkg/authverify/doc.go index e07d69614..f9173a708 100644 --- a/pkg/authverify/doc.go +++ b/pkg/authverify/doc.go @@ -12,4 +12,4 @@ // See the License for the specific language governing permissions and // limitations under the License. -package authverify // import "github.com/OpenIMSDK/Open-IM-Server/pkg/authverify" +package authverify // import "github.com/openimsdk/open-im-server/v3/pkg/authverify" diff --git a/pkg/callbackstruct/doc.go b/pkg/callbackstruct/doc.go index d9d9cd8d0..c3445c60e 100644 --- a/pkg/callbackstruct/doc.go +++ b/pkg/callbackstruct/doc.go @@ -12,4 +12,4 @@ // See the License for the specific language governing permissions and // limitations under the License. -package callbackstruct // import "github.com/OpenIMSDK/Open-IM-Server/pkg/callbackstruct" +package callbackstruct // import "github.com/openimsdk/open-im-server/v3/pkg/callbackstruct" diff --git a/pkg/common/cmd/doc.go b/pkg/common/cmd/doc.go index 75da58c57..991a85eb9 100644 --- a/pkg/common/cmd/doc.go +++ b/pkg/common/cmd/doc.go @@ -12,4 +12,4 @@ // See the License for the specific language governing permissions and // limitations under the License. -package cmd // import "github.com/OpenIMSDK/Open-IM-Server/pkg/common/cmd" +package cmd // import "github.com/openimsdk/open-im-server/v3/pkg/common/cmd" diff --git a/pkg/common/cmd/msg_gateway.go b/pkg/common/cmd/msg_gateway.go index dc02c1f16..34a9f3b4e 100644 --- a/pkg/common/cmd/msg_gateway.go +++ b/pkg/common/cmd/msg_gateway.go @@ -16,7 +16,7 @@ package cmd import ( "github.com/openimsdk/open-im-server/v3/internal/msggateway" - //"github.com/OpenIMSDK/Open-IM-Server/internal/msggateway". + //"github.com/openimsdk/open-im-server/internal/msggateway". "github.com/spf13/cobra" "github.com/OpenIMSDK/protocol/constant" diff --git a/pkg/common/config/doc.go b/pkg/common/config/doc.go index a58dd1b8f..4b76cb9fa 100644 --- a/pkg/common/config/doc.go +++ b/pkg/common/config/doc.go @@ -12,4 +12,4 @@ // See the License for the specific language governing permissions and // limitations under the License. -package config // import "github.com/OpenIMSDK/Open-IM-Server/pkg/common/config" +package config // import "github.com/openimsdk/open-im-server/v3/pkg/common/config" diff --git a/pkg/common/convert/doc.go b/pkg/common/convert/doc.go index 0789adc3f..29c1144c1 100644 --- a/pkg/common/convert/doc.go +++ b/pkg/common/convert/doc.go @@ -12,4 +12,4 @@ // See the License for the specific language governing permissions and // limitations under the License. -package convert // import "github.com/OpenIMSDK/Open-IM-Server/pkg/common/convert" +package convert // import "github.com/openimsdk/open-im-server/v3/pkg/common/convert" diff --git a/pkg/common/db/cache/doc.go b/pkg/common/db/cache/doc.go index e02c5b9ba..77651e3de 100644 --- a/pkg/common/db/cache/doc.go +++ b/pkg/common/db/cache/doc.go @@ -12,4 +12,4 @@ // See the License for the specific language governing permissions and // limitations under the License. -package cache // import "github.com/OpenIMSDK/Open-IM-Server/pkg/common/db/cache" +package cache // import "github.com/openimsdk/open-im-server/v3/pkg/common/db/cache" diff --git a/pkg/common/db/controller/doc.go b/pkg/common/db/controller/doc.go index d54b689a6..72316f128 100644 --- a/pkg/common/db/controller/doc.go +++ b/pkg/common/db/controller/doc.go @@ -12,4 +12,4 @@ // See the License for the specific language governing permissions and // limitations under the License. -package controller // import "github.com/OpenIMSDK/Open-IM-Server/pkg/common/db/controller" +package controller // import "github.com/openimsdk/open-im-server/v3/pkg/common/db/controller" diff --git a/pkg/common/db/localcache/doc.go b/pkg/common/db/localcache/doc.go index 40afac0ba..d349373ee 100644 --- a/pkg/common/db/localcache/doc.go +++ b/pkg/common/db/localcache/doc.go @@ -12,4 +12,4 @@ // See the License for the specific language governing permissions and // limitations under the License. -package localcache // import "github.com/OpenIMSDK/Open-IM-Server/pkg/common/db/localcache" +package localcache // import "github.com/openimsdk/open-im-server/v3/pkg/common/db/localcache" diff --git a/pkg/common/db/relation/doc.go b/pkg/common/db/relation/doc.go index a3ac7243f..41135ac97 100644 --- a/pkg/common/db/relation/doc.go +++ b/pkg/common/db/relation/doc.go @@ -12,4 +12,4 @@ // See the License for the specific language governing permissions and // limitations under the License. -package relation // import "github.com/OpenIMSDK/Open-IM-Server/pkg/common/db/relation" +package relation // import "github.com/openimsdk/open-im-server/v3/pkg/common/db/relation" diff --git a/pkg/common/db/s3/cont/doc.go b/pkg/common/db/s3/cont/doc.go index bdba8501b..45737bc7c 100644 --- a/pkg/common/db/s3/cont/doc.go +++ b/pkg/common/db/s3/cont/doc.go @@ -12,4 +12,4 @@ // See the License for the specific language governing permissions and // limitations under the License. -package cont // import "github.com/OpenIMSDK/Open-IM-Server/pkg/common/db/s3/cont" +package cont // import "github.com/openimsdk/open-im-server/v3/pkg/common/db/s3/cont" diff --git a/pkg/common/db/s3/cos/doc.go b/pkg/common/db/s3/cos/doc.go index bf405d0fc..592f90ee2 100644 --- a/pkg/common/db/s3/cos/doc.go +++ b/pkg/common/db/s3/cos/doc.go @@ -12,4 +12,4 @@ // See the License for the specific language governing permissions and // limitations under the License. -package cos // import "github.com/OpenIMSDK/Open-IM-Server/pkg/common/db/s3/cos" +package cos // import "github.com/openimsdk/open-im-server/v3/pkg/common/db/s3/cos" diff --git a/pkg/common/db/s3/doc.go b/pkg/common/db/s3/doc.go index 0a3cfe521..a43710676 100644 --- a/pkg/common/db/s3/doc.go +++ b/pkg/common/db/s3/doc.go @@ -12,4 +12,4 @@ // See the License for the specific language governing permissions and // limitations under the License. -package s3 // import "github.com/OpenIMSDK/Open-IM-Server/pkg/common/db/s3" +package s3 // import "github.com/openimsdk/open-im-server/v3/pkg/common/db/s3" diff --git a/pkg/common/db/s3/minio/doc.go b/pkg/common/db/s3/minio/doc.go index 704e12202..42e898c15 100644 --- a/pkg/common/db/s3/minio/doc.go +++ b/pkg/common/db/s3/minio/doc.go @@ -12,4 +12,4 @@ // See the License for the specific language governing permissions and // limitations under the License. -package minio // import "github.com/OpenIMSDK/Open-IM-Server/pkg/common/db/s3/minio" +package minio // import "github.com/openimsdk/open-im-server/v3/pkg/common/db/s3/minio" diff --git a/pkg/common/db/s3/oss/doc.go b/pkg/common/db/s3/oss/doc.go index 9520a7ed8..d2e2c91af 100644 --- a/pkg/common/db/s3/oss/doc.go +++ b/pkg/common/db/s3/oss/doc.go @@ -12,4 +12,4 @@ // See the License for the specific language governing permissions and // limitations under the License. -package oss // import "github.com/OpenIMSDK/Open-IM-Server/pkg/common/db/s3/oss" +package oss // import "github.com/openimsdk/open-im-server/v3/pkg/common/db/s3/oss" diff --git a/pkg/common/db/table/relation/doc.go b/pkg/common/db/table/relation/doc.go index fe78a700d..32185c8c7 100644 --- a/pkg/common/db/table/relation/doc.go +++ b/pkg/common/db/table/relation/doc.go @@ -12,4 +12,4 @@ // See the License for the specific language governing permissions and // limitations under the License. -package relation // import "github.com/OpenIMSDK/Open-IM-Server/pkg/common/db/table/relation" +package relation // import "github.com/openimsdk/open-im-server/v3/pkg/common/db/table/relation" diff --git a/pkg/common/db/table/unrelation/doc.go b/pkg/common/db/table/unrelation/doc.go index 1c0eab222..7596206a0 100644 --- a/pkg/common/db/table/unrelation/doc.go +++ b/pkg/common/db/table/unrelation/doc.go @@ -12,4 +12,4 @@ // See the License for the specific language governing permissions and // limitations under the License. -package unrelation // import "github.com/OpenIMSDK/Open-IM-Server/pkg/common/db/table/unrelation" +package unrelation // import "github.com/openimsdk/open-im-server/v3/pkg/common/db/table/unrelation" diff --git a/pkg/common/db/unrelation/doc.go b/pkg/common/db/unrelation/doc.go index b36a2406f..1a15e42c4 100644 --- a/pkg/common/db/unrelation/doc.go +++ b/pkg/common/db/unrelation/doc.go @@ -12,4 +12,4 @@ // See the License for the specific language governing permissions and // limitations under the License. -package unrelation // import "github.com/OpenIMSDK/Open-IM-Server/pkg/common/db/unrelation" +package unrelation // import "github.com/openimsdk/open-im-server/v3/pkg/common/db/unrelation" diff --git a/pkg/common/http/doc.go b/pkg/common/http/doc.go index 33a0d5e5d..e6fd3ec1e 100644 --- a/pkg/common/http/doc.go +++ b/pkg/common/http/doc.go @@ -12,4 +12,4 @@ // See the License for the specific language governing permissions and // limitations under the License. -package http // import "github.com/OpenIMSDK/Open-IM-Server/pkg/common/http" +package http // import "github.com/openimsdk/open-im-server/v3/pkg/common/http" diff --git a/pkg/common/kafka/doc.go b/pkg/common/kafka/doc.go index c796db138..0f0c69a76 100644 --- a/pkg/common/kafka/doc.go +++ b/pkg/common/kafka/doc.go @@ -12,4 +12,4 @@ // See the License for the specific language governing permissions and // limitations under the License. -package kafka // import "github.com/OpenIMSDK/Open-IM-Server/pkg/common/kafka" +package kafka // import "github.com/openimsdk/open-im-server/v3/pkg/common/kafka" diff --git a/pkg/common/locker/doc.go b/pkg/common/locker/doc.go index c94581aa9..8b9378f90 100644 --- a/pkg/common/locker/doc.go +++ b/pkg/common/locker/doc.go @@ -12,4 +12,4 @@ // See the License for the specific language governing permissions and // limitations under the License. -package locker // import "github.com/OpenIMSDK/Open-IM-Server/pkg/common/locker" +package locker // import "github.com/openimsdk/open-im-server/v3/pkg/common/locker" diff --git a/pkg/common/prome/doc.go b/pkg/common/prome/doc.go index 0b82aa7bf..7058c711c 100644 --- a/pkg/common/prome/doc.go +++ b/pkg/common/prome/doc.go @@ -12,4 +12,4 @@ // See the License for the specific language governing permissions and // limitations under the License. -package prome // import "github.com/OpenIMSDK/Open-IM-Server/pkg/common/prome" +package prome // import "github.com/openimsdk/open-im-server/v3/pkg/common/prome" diff --git a/pkg/common/startrpc/doc.go b/pkg/common/startrpc/doc.go index 571fd971a..1d5fd6787 100644 --- a/pkg/common/startrpc/doc.go +++ b/pkg/common/startrpc/doc.go @@ -12,4 +12,4 @@ // See the License for the specific language governing permissions and // limitations under the License. -package startrpc // import "github.com/OpenIMSDK/Open-IM-Server/pkg/common/startrpc" +package startrpc // import "github.com/openimsdk/open-im-server/v3/pkg/common/startrpc" diff --git a/pkg/msgprocessor/doc.go b/pkg/msgprocessor/doc.go index 2f1d0cb44..d1e24ce30 100644 --- a/pkg/msgprocessor/doc.go +++ b/pkg/msgprocessor/doc.go @@ -12,4 +12,4 @@ // See the License for the specific language governing permissions and // limitations under the License. -package msgprocessor // import "github.com/OpenIMSDK/Open-IM-Server/pkg/msgprocessor" +package msgprocessor // import "github.com/openimsdk/open-im-server/v3/pkg/msgprocessor" diff --git a/pkg/rpcclient/doc.go b/pkg/rpcclient/doc.go index f32f4f322..0fdfacc60 100644 --- a/pkg/rpcclient/doc.go +++ b/pkg/rpcclient/doc.go @@ -12,4 +12,4 @@ // See the License for the specific language governing permissions and // limitations under the License. -package rpcclient // import "github.com/OpenIMSDK/Open-IM-Server/pkg/rpcclient" +package rpcclient // import "github.com/openimsdk/open-im-server/v3/pkg/rpcclient" diff --git a/pkg/rpcclient/notification/doc.go b/pkg/rpcclient/notification/doc.go index eea54e59c..2d409bdc9 100644 --- a/pkg/rpcclient/notification/doc.go +++ b/pkg/rpcclient/notification/doc.go @@ -12,4 +12,4 @@ // See the License for the specific language governing permissions and // limitations under the License. -package notification // import "github.com/OpenIMSDK/Open-IM-Server/pkg/rpcclient/notification" +package notification // import "github.com/openimsdk/open-im-server/v3/pkg/rpcclient/notification" diff --git a/pkg/statistics/doc.go b/pkg/statistics/doc.go index 4dabe2058..8051c4c71 100644 --- a/pkg/statistics/doc.go +++ b/pkg/statistics/doc.go @@ -12,4 +12,4 @@ // See the License for the specific language governing permissions and // limitations under the License. -package statistics // import "github.com/OpenIMSDK/Open-IM-Server/pkg/statistics" +package statistics // import "github.com/openimsdk/open-im-server/v3/pkg/statistics" diff --git a/scripts/advertise.sh b/scripts/advertise.sh index fbb68b4cc..9c8c284ad 100755 --- a/scripts/advertise.sh +++ b/scripts/advertise.sh @@ -78,7 +78,7 @@ O:::::::OOO:::::::O p:::::ppppp:::::::pe::::::::e n::::n n::::nII: ' 0.0001 # Display product URL - print_with_delay "Discover more and contribute at: https://github.com/OpenIMSDK/Open-IM-Server" 0.01 + print_with_delay "Discover more and contribute at: https://github.com/openimsdk/open-im-server" 0.01 # Reset text color back to normal echo -e "\033[0m" diff --git a/scripts/check-all.sh b/scripts/check-all.sh index d40e5a479..defc030f8 100755 --- a/scripts/check-all.sh +++ b/scripts/check-all.sh @@ -17,7 +17,7 @@ # # Usage: `scripts/check-all.sh`. # Encapsulated as: `make check`. -# READ: https://github.com/OpenIMSDK/Open-IM-Server/tree/main/scripts/install/environment.sh +# READ: https://github.com/openimsdk/open-im-server/tree/main/scripts/install/environment.sh set -o errexit set -o nounset @@ -71,7 +71,7 @@ fi if [[ $? -ne 0 ]]; then openim::log::error_exit "The service does not start properly, please check the port, query variable definition!" - echo "+++ https://github.com/OpenIMSDK/Open-IM-Server/tree/main/scripts/install/environment.sh +++" + echo "+++ https://github.com/openimsdk/open-im-server/tree/main/scripts/install/environment.sh +++" else echo "++++ Check all dependent service ports successfully !" fi diff --git a/scripts/cherry-pick.sh b/scripts/cherry-pick.sh index 8b81b3401..200ee8ed8 100755 --- a/scripts/cherry-pick.sh +++ b/scripts/cherry-pick.sh @@ -14,7 +14,7 @@ # limitations under the License. -# Usage Instructions: https://github.com/OpenIMSDK/Open-IM-Server/tree/main/docs/contrib/git_cherry-pick.md +# Usage Instructions: https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/git_cherry-pick.md # Checkout a PR from GitHub. (Yes, this is sitting in a Git tree. How # meta.) Assumes you care about pulls from remote "upstream" and @@ -68,7 +68,7 @@ if [[ "$#" -lt 2 ]]; then echo " Set UPSTREAM_REMOTE (default: upstream) and FORK_REMOTE (default: origin)" echo " to override the default remote names to what you have locally." echo - echo " For merge process info, see https://github.com/OpenIMSDK/Open-IM-Server/tree/main/docs/contrib/git_cherry-pick.md" + echo " For merge process info, see https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/git_cherry-pick.md" exit 2 fi @@ -145,7 +145,7 @@ Cherry pick of ${PULLSUBJ} on ${rel}. ${numandtitle} -For details on the cherry pick process, see the [cherry pick requests](https://github.com/OpenIMSDK/Open-IM-Server/tree/main/docs/contrib/git_cherry-pick.md) page. +For details on the cherry pick process, see the [cherry pick requests](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/git_cherry-pick.md) page. \`\`\`release-note diff --git a/scripts/genconfig.sh b/scripts/genconfig.sh index fef411446..030c31faf 100755 --- a/scripts/genconfig.sh +++ b/scripts/genconfig.sh @@ -15,7 +15,7 @@ # 本脚本功能:根据 scripts/environment.sh 配置,生成 OPENIM 组件 YAML 配置文件。 # 示例:./scripts/genconfig.sh scripts/install/environment.sh scripts/template/config.yaml -# Read: https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/contrib/init_config.md +# Read: https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/init_config.md env_file="$1" template_file="$2" diff --git a/scripts/gendoc.sh b/scripts/gendoc.sh index 1d381483f..c948fcdf9 100755 --- a/scripts/gendoc.sh +++ b/scripts/gendoc.sh @@ -17,7 +17,7 @@ DEFAULT_DIRS=( "pkg" "internal/pkg" ) -BASE_URL="github.com/OpenIMSDK/Open-IM-Server" +BASE_URL="github.com/openimsdk/open-im-server" usage() { echo "Usage: $0 [OPTIONS]" diff --git a/scripts/init-config.sh b/scripts/init-config.sh index db77e7e76..6d8bef806 100755 --- a/scripts/init-config.sh +++ b/scripts/init-config.sh @@ -14,7 +14,7 @@ # limitations under the License. # This script automatically initializes the various configuration files -# Read: https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/contrib/init_config.md +# Read: https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/init_config.md set -o errexit set -o nounset diff --git a/scripts/install/environment.sh b/scripts/install/environment.sh index 57a8d0400..080e95042 100755 --- a/scripts/install/environment.sh +++ b/scripts/install/environment.sh @@ -15,9 +15,9 @@ # This is a file that initializes variables for the automation script that initializes the config file # You need to supplement the script according to the specification. -# Read: https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/contrib/init_config.md +# Read: https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/init_config.md # 格式化 bash 注释:https://tool.lu/shell/ -# 配置中心文档:https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/contrib/environment.md +# 配置中心文档:https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/environment.md OPENIM_ROOT="$(cd "$(dirname "${BASH_SOURCE[0]}")/../.." && pwd -P)" @@ -26,7 +26,7 @@ LOCAL_OUTPUT_ROOT=""${OPENIM_ROOT}"/${OUT_DIR:-_output}" source "${OPENIM_ROOT}/scripts/lib/init.sh" #TODO: Access to the IP networks outside, or you want to use the IP network -# IP=http://127.0.0.1 +# IP=127.0.0.1 if [ -z "${IP}" ]; then IP=$(openim::util::get_server_ip) fi @@ -42,9 +42,6 @@ function def() { eval "readonly $var_name=\"\${$var_name:-$(printf '%q' "$default_value")}\"" } -# app要能访问到此ip和端口或域名 -readonly API_URL=${API_URL:-"http://${IP}:10002"} - # OpenIM Docker Compose 数据存储的默认路径 def "DATA_DIR" "${OPENIM_ROOT}" @@ -109,7 +106,7 @@ LAST_OCTET=$((LAST_OCTET + 1)) GRAFANA_NETWORK_ADDRESS=$(generate_ip) ###################### openim 配置 ###################### -# read: https://github.com/OpenIMSDK/Open-IM-Server/blob/main/deployment/init/README.md +# read: https://github.com/openimsdk/open-im-server/blob/main/deployment/init/README.md def "OPENIM_DATA_DIR" "/data/openim" def "OPENIM_INSTALL_DIR" "/opt/openim" def "OPENIM_CONFIG_DIR" "/etc/openim" @@ -174,9 +171,12 @@ def "MONGO_PASSWORD" "${PASSWORD}" # MongoDB的密码 def "MONGO_MAX_POOL_SIZE" "100" # 最大连接池大小 ###################### Object 配置信息 ###################### +# app要能访问到此ip和端口或域名 +readonly API_URL=${API_URL:-"http://${IP}:${API_OPENIM_PORT}"} + def "OBJECT_ENABLE" "minio" # 对象是否启用 # 对象的API地址 -readonly OBJECT_APIURL=${OBJECT_APIURL:-"http://${IP}:10002"} +readonly OBJECT_APIURL=${OBJECT_APIURL:-"http://${API_URL}"} def "MINIO_BUCKET" "openim" # MinIO的存储桶名称 def "MINIO_PORT" "10005" # MinIO的端口 # MinIO的端点URL @@ -185,7 +185,7 @@ readonly MINIO_ENDPOINT=${MINIO_ENDPOINT:-"http://${MINIO_ADDRESS}:${MINIO_PORT} def "MINIO_ACCESS_KEY" "${USER}" # MinIO的访问密钥ID def "MINIO_SECRET_KEY" "${PASSWORD}" # MinIO的密钥 def "MINIO_SESSION_TOKEN" # MinIO的会话令牌 -readonly MINIO_SIGN_ENDPOINT=${MINIO_SIGN_ENDPOINT:-"http://${IP}:${MINIO_PORT}"} # signEndpoint为minio公网地址 # MinIO的会话令牌 +readonly MINIO_SIGN_ENDPOINT=${MINIO_SIGN_ENDPOINT:-"http://${IP}:${MINIO_PORT}"} # signEndpoint为minio公网地址 # 腾讯云COS的存储桶URL def "COS_BUCKET_URL" "https://temp-1252357374.cos.ap-chengdu.myqcloud.com" def "COS_SECRET_ID" # 腾讯云COS的密钥ID diff --git a/scripts/install/openim-msggateway.sh b/scripts/install/openim-msggateway.sh index 1010fbbec..c51c20646 100755 --- a/scripts/install/openim-msggateway.sh +++ b/scripts/install/openim-msggateway.sh @@ -30,12 +30,12 @@ function openim::msggateway::start() openim::log::info "Start OpenIM Msggateway, binary root: ${SERVER_NAME}" openim::log::status "Start OpenIM Msggateway, path: ${OPENIM_MSGGATEWAY_BINARY}" - openim::util::stop_services_with_name ${SERVER_NAME} + openim::util::stop_services_with_name ${OPENIM_MSGGATEWAY_BINARY} # OpenIM message gateway service port OPENIM_MESSAGE_GATEWAY_PORTS=$(openim::util::list-to-string ${OPENIM_MESSAGE_GATEWAY_PORT} ) read -a OPENIM_MSGGATEWAY_PORTS_ARRAY <<< ${OPENIM_MESSAGE_GATEWAY_PORTS} - + openim::util::stop_services_on_ports ${OPENIM_MSGGATEWAY_PORTS_ARRAY[*]} # OpenIM WS port OPENIM_WS_PORTS=$(openim::util::list-to-string ${OPENIM_WS_PORT} ) read -a OPENIM_WS_PORTS_ARRAY <<< ${OPENIM_WS_PORTS} diff --git a/scripts/install/openim-msgtransfer.sh b/scripts/install/openim-msgtransfer.sh index 612acd738..428f6b64e 100755 --- a/scripts/install/openim-msgtransfer.sh +++ b/scripts/install/openim-msgtransfer.sh @@ -30,7 +30,7 @@ function openim::msgtransfer::start() openim::log::info "Start OpenIM Msggateway, binary root: ${SERVER_NAME}" openim::log::status "Start OpenIM Msggateway, path: ${OPENIM_MSGTRANSFER_BINARY}" - openim::util::stop_services_with_name ${SERVER_NAME} + openim::util::stop_services_with_name ${OPENIM_MSGTRANSFER_BINARY} # Message Transfer Prometheus port list MSG_TRANSFER_PROM_PORTS=(openim::util::list-to-string ${MSG_TRANSFER_PROM_PORT} ) diff --git a/scripts/lib/util.sh b/scripts/lib/util.sh index 6825797e1..2455f91dc 100755 --- a/scripts/lib/util.sh +++ b/scripts/lib/util.sh @@ -635,7 +635,7 @@ openim::util::remove-gen-docs() { # repo, e.g. "upstream" or "origin". openim::util::git_upstream_remote_name() { git remote -v | grep fetch |\ - grep -E 'github.com[/:]OpenIMSDK/Open-IM-Server|openim.cc/server' |\ + grep -E 'github.com[/:]openimsdk/open-im-server|openim.cc/server' |\ head -n 1 | awk '{print $1}' } diff --git a/scripts/make-rules/golang.mk b/scripts/make-rules/golang.mk index 26fe721cc..0614bdf6f 100644 --- a/scripts/make-rules/golang.mk +++ b/scripts/make-rules/golang.mk @@ -73,7 +73,7 @@ ifeq ($(strip $(BINS)),) endif # TODO: EXCLUDE_TESTS variable, which contains the name of the package to be excluded from the test -EXCLUDE_TESTS=github.com/OpenIMSDK/Open-IM-Server/test github.com/OpenIMSDK/Open-IM-Server/pkg/log github.com/OpenIMSDK/Open-IM-Server/db github.com/OpenIMSDK/Open-IM-Server/scripts github.com/OpenIMSDK/Open-IM-Server/config +EXCLUDE_TESTS=github.com/openimsdk/open-im-server/test github.com/openimsdk/open-im-server/v3/pkg/log github.com/openimsdk/open-im-server/db github.com/openimsdk/open-im-server/scripts github.com/openimsdk/open-im-server/config # ============================================================================== # ❯ tree -L 1 cmd diff --git a/scripts/make-rules/image.mk b/scripts/make-rules/image.mk index 8320bc023..bb353034f 100644 --- a/scripts/make-rules/image.mk +++ b/scripts/make-rules/image.mk @@ -23,7 +23,7 @@ DOCKER := docker DOCKER_SUPPORTED_API_VERSION ?= 1.32|1.40|1.41 -# read: https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/images.md +# read: https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/images.md REGISTRY_PREFIX ?= ghcr.io/openimsdk BASE_IMAGE ?= ghcr.io/openim-sigs/openim-bash-image diff --git a/scripts/verify-typecheck.sh b/scripts/verify-typecheck.sh index 0aa79482a..a0b818135 100755 --- a/scripts/verify-typecheck.sh +++ b/scripts/verify-typecheck.sh @@ -36,6 +36,6 @@ scripts/run-in-gopath.sh \ go run test/typecheck/typecheck.go "$@" "--serial=$TYPECHECK_SERIAL" || ret=$? if [[ $ret -ne 0 ]]; then openim::log::error "Type Check has failed. This may cause cross platform build failures." >&2 - openim::log::error "Please see https://github.com/OpenIMSDK/Open-IM-Server/tree/main/test/typecheck for more information." >&2 + openim::log::error "Please see https://github.com/openimsdk/open-im-server/tree/main/test/typecheck for more information." >&2 exit 1 fi diff --git a/test/typecheck/go.mod b/test/typecheck/go.mod index 253c4641e..f644c5b25 100644 --- a/test/typecheck/go.mod +++ b/test/typecheck/go.mod @@ -1,4 +1,4 @@ -module github.com/OpenIMSDK/Open-IM-Server/test/typecheck +module github.com/openimsdk/open-im-server/test/typecheck go 1.18 diff --git a/tools/README.md b/tools/README.md index 45c66564d..bd16a84d1 100644 --- a/tools/README.md +++ b/tools/README.md @@ -18,7 +18,7 @@ export OPENIM_TOOLS_NAME= # copy and paste to create a new CRD and Controller mkdir tools/${OPENIM_TOOLS_NAME} cd tools/${OPENIM_TOOLS_NAME} -go mod init github.com/OpenIMSDK/Open-IM-Server/tools/${OPENIM_TOOLS_NAME} +go mod init github.com/openimsdk/open-im-server/tools/${OPENIM_TOOLS_NAME} go mod tidy go work use -r . cd ../.. diff --git a/tools/changelog/changelog.go b/tools/changelog/changelog.go index 9a25826b1..17a9e5404 100644 --- a/tools/changelog/changelog.go +++ b/tools/changelog/changelog.go @@ -299,7 +299,7 @@ func sortAndUniq(lines []string) []string { func upstreamLinkify(line string) string { if m := upstreamKube.FindStringSubmatch(line); len(m) > 0 { - return fmt.Sprintf("UPSTREAM: [#%s](https://github.com/OpenIMSDK/Open-IM-Server/pull/%s):%s", m[1], m[1], m[2]) + return fmt.Sprintf("UPSTREAM: [#%s](https://github.com/openimsdk/open-im-server/pull/%s):%s", m[1], m[1], m[2]) } if m := upstreamRepo.FindStringSubmatch(line); len(m) > 0 { return fmt.Sprintf("UPSTREAM: [%s#%s](https://github.com/%s/pull/%s):%s", m[1], m[2], m[1], m[2], m[3]) diff --git a/tools/component/component.go b/tools/component/component.go index 692e7b6e2..04c6ba9a5 100644 --- a/tools/component/component.go +++ b/tools/component/component.go @@ -206,7 +206,7 @@ func checkMinio() error { } } if exactIP(config.Config.Object.ApiURL) == "127.0.0.1" || exactIP(config.Config.Object.Minio.SignEndpoint) == "127.0.0.1" { - return ErrConfig.Wrap("apiURL or Minio SignEndpoint endpoint contain 127.0.0.1.") + return ErrConfig.Wrap("apiURL or Minio SignEndpoint endpoint contain 127.0.0.1") } } return nil diff --git a/tools/imctl/README.md b/tools/imctl/README.md index 520df6421..28df87e26 100644 --- a/tools/imctl/README.md +++ b/tools/imctl/README.md @@ -8,7 +8,7 @@ - Status: Draft - RFC Pull Request: (leave blank) - OpenIMSDK Pull Request: (leave blank) -- OpenIMSDK Issue: https://github.com/OpenIMSDK/Open-IM-Server/issues/924 +- OpenIMSDK Issue: https://github.com/openimsdk/open-im-server/issues/924 - Supersedes: N/A ## 📇Topics diff --git a/tools/imctl/cmd/imctl/imctl.go b/tools/imctl/cmd/imctl/imctl.go index d72fee927..04032c64c 100644 --- a/tools/imctl/cmd/imctl/imctl.go +++ b/tools/imctl/cmd/imctl/imctl.go @@ -18,7 +18,7 @@ package main import ( "os" - "github.com/OpenIMSDK/Open-IM-Server/tools/imctl/internal/imctl/cmd" + "github.com/openimsdk/open-im-server/v3/tools/imctl/internal/imctl/cmd" ) func main() { diff --git a/tools/imctl/internal/imctl/cmd/cmd.go b/tools/imctl/internal/imctl/cmd/cmd.go index 24b8a2c8e..ced641fd6 100644 --- a/tools/imctl/internal/imctl/cmd/cmd.go +++ b/tools/imctl/internal/imctl/cmd/cmd.go @@ -23,24 +23,24 @@ import ( "github.com/spf13/cobra" "github.com/spf13/viper" - "github.com/OpenIMSDK/Open-IM-Server/tools/imctl/pkg/cli/genericclioptions" - - cmdutil "github.com/OpenIMSDK/Open-IM-Server/tools/imctl/inernal/iamctl/cmd/util" - "github.com/OpenIMSDK/Open-IM-Server/tools/imctl/internal/imctl/cmd/color" - "github.com/OpenIMSDK/Open-IM-Server/tools/imctl/internal/imctl/cmd/completion" - "github.com/OpenIMSDK/Open-IM-Server/tools/imctl/internal/imctl/cmd/info" - "github.com/OpenIMSDK/Open-IM-Server/tools/imctl/internal/imctl/cmd/jwt" - "github.com/OpenIMSDK/Open-IM-Server/tools/imctl/internal/imctl/cmd/new" - "github.com/OpenIMSDK/Open-IM-Server/tools/imctl/internal/imctl/cmd/options" - "github.com/OpenIMSDK/Open-IM-Server/tools/imctl/internal/imctl/cmd/policy" - "github.com/OpenIMSDK/Open-IM-Server/tools/imctl/internal/imctl/cmd/secret" - "github.com/OpenIMSDK/Open-IM-Server/tools/imctl/internal/imctl/cmd/set" - "github.com/OpenIMSDK/Open-IM-Server/tools/imctl/internal/imctl/cmd/user" - "github.com/OpenIMSDK/Open-IM-Server/tools/imctl/internal/imctl/cmd/validate" - "github.com/OpenIMSDK/Open-IM-Server/tools/imctl/internal/imctl/cmd/version" - "github.com/OpenIMSDK/Open-IM-Server/tools/imctl/internal/imctl/util/templates" - genericapiserver "github.com/OpenIMSDK/Open-IM-Server/tools/imctl/internal/pkg/server" - "github.com/OpenIMSDK/Open-IM-Server/tools/imctl/pkg/cli/genericclioptions" + "github.com/openimsdk/open-im-server/tools/imctl/pkg/cli/genericclioptions" + + cmdutil "github.com/openimsdk/open-im-server/tools/imctl/inernal/iamctl/cmd/util" + "github.com/openimsdk/open-im-server/tools/imctl/internal/imctl/cmd/color" + "github.com/openimsdk/open-im-server/tools/imctl/internal/imctl/cmd/completion" + "github.com/openimsdk/open-im-server/tools/imctl/internal/imctl/cmd/info" + "github.com/openimsdk/open-im-server/tools/imctl/internal/imctl/cmd/jwt" + "github.com/openimsdk/open-im-server/tools/imctl/internal/imctl/cmd/new" + "github.com/openimsdk/open-im-server/tools/imctl/internal/imctl/cmd/options" + "github.com/openimsdk/open-im-server/tools/imctl/internal/imctl/cmd/policy" + "github.com/openimsdk/open-im-server/tools/imctl/internal/imctl/cmd/secret" + "github.com/openimsdk/open-im-server/tools/imctl/internal/imctl/cmd/set" + "github.com/openimsdk/open-im-server/tools/imctl/internal/imctl/cmd/user" + "github.com/openimsdk/open-im-server/tools/imctl/internal/imctl/cmd/validate" + "github.com/openimsdk/open-im-server/tools/imctl/internal/imctl/cmd/version" + "github.com/openimsdk/open-im-server/tools/imctl/internal/imctl/util/templates" + genericapiserver "github.com/openimsdk/open-im-server/tools/imctl/internal/pkg/server" + "github.com/openimsdk/open-im-server/tools/imctl/pkg/cli/genericclioptions" ) // NewDefaultIAMCtlCommand creates the `imctl` command with default arguments. @@ -59,7 +59,7 @@ func NewIMCtlCommand(in io.Reader, out, err io.Writer) *cobra.Command { Find more information at: // TODO: add link to docs, from auto scripts and gendocs - https://github.com/OpenIMSDK/Open-IM-Server/tree/main/docs`), + https://github.com/openimsdk/open-im-server/tree/main/docs`), Run: runHelp, // Hook before and after Run initialize and write profiles to disk, // respectively. diff --git a/tools/imctl/internal/imctl/cmd/color/color.go b/tools/imctl/internal/imctl/cmd/color/color.go index bc54403e8..551ec379c 100644 --- a/tools/imctl/internal/imctl/cmd/color/color.go +++ b/tools/imctl/internal/imctl/cmd/color/color.go @@ -24,9 +24,9 @@ import ( "github.com/openim-sigs/component-base/util/stringutil" "github.com/spf13/cobra" - cmdutil "github.com/OpenIMSDK/Open-IM-Server/tools/imctl/internal/imctl/cmd/util" - "github.com/OpenIMSDK/Open-IM-Server/tools/imctl/pkg/cli/genericclioptions" - "github.com/OpenIMSDK/Open-IM-Server/tools/imctl/pkg/util/templates" + cmdutil "github.com/openimsdk/open-im-server/tools/imctl/internal/imctl/cmd/util" + "github.com/openimsdk/open-im-server/tools/imctl/pkg/cli/genericclioptions" + "github.com/openimsdk/open-im-server/tools/imctl/pkg/util/templates" ) // ColorOptions is an options struct to support color subcommands. diff --git a/tools/imctl/internal/imctl/cmd/completion/completion.go b/tools/imctl/internal/imctl/cmd/completion/completion.go index 6e7d81afe..6242dbd45 100644 --- a/tools/imctl/internal/imctl/cmd/completion/completion.go +++ b/tools/imctl/internal/imctl/cmd/completion/completion.go @@ -21,8 +21,8 @@ import ( "github.com/spf13/cobra" - cmdutil "github.com/OpenIMSDK/Open-IM-Server/tools/imctl/internal/imctl/cmd/util" - "github.com/OpenIMSDK/Open-IM-Server/tools/imctl/pkg/util/templates" + cmdutil "github.com/openimsdk/open-im-server/tools/imctl/internal/imctl/cmd/util" + "github.com/openimsdk/open-im-server/tools/imctl/pkg/util/templates" ) const defaultBoilerPlate = ` diff --git a/tools/imctl/internal/imctl/cmd/info/info.go b/tools/imctl/internal/imctl/cmd/info/info.go index 95bdbe3e3..a51c2f4de 100644 --- a/tools/imctl/internal/imctl/cmd/info/info.go +++ b/tools/imctl/internal/imctl/cmd/info/info.go @@ -24,9 +24,9 @@ import ( "github.com/openim-sigs/component-base/util/iputil" "github.com/spf13/cobra" - cmdutil "github.com/OpenIMSDK/Open-IM-Server/tools/imctl/internal/imctl/cmd/util" - "github.com/OpenIMSDK/Open-IM-Server/tools/imctl/pkg/cli/genericclioptions" - "github.com/OpenIMSDK/Open-IM-Server/tools/imctl/pkg/util/templates" + cmdutil "github.com/openimsdk/open-im-server/tools/imctl/internal/imctl/cmd/util" + "github.com/openimsdk/open-im-server/tools/imctl/pkg/cli/genericclioptions" + "github.com/openimsdk/open-im-server/tools/imctl/pkg/util/templates" ) // Info defines the host information struct. diff --git a/tools/imctl/internal/imctl/cmd/new/new.go b/tools/imctl/internal/imctl/cmd/new/new.go index 6ac0667fc..95ec853b1 100644 --- a/tools/imctl/internal/imctl/cmd/new/new.go +++ b/tools/imctl/internal/imctl/cmd/new/new.go @@ -28,9 +28,9 @@ import ( "golang.org/x/text/cases" "golang.org/x/text/language" - "github.com/OpenIMSDK/Open-IM-Server/tools/imctl/internal/imctl/util/templates" - "github.com/OpenIMSDK/Open-IM-Server/tools/imctl/pkg/cli/genericclioptions" - cmdutil "github.com/OpenIMSDK/Open-IM-Server/tools/imctl/pkg/util" + "github.com/openimsdk/open-im-server/tools/imctl/internal/imctl/util/templates" + "github.com/openimsdk/open-im-server/tools/imctl/pkg/cli/genericclioptions" + cmdutil "github.com/openimsdk/open-im-server/tools/imctl/pkg/util" ) const ( @@ -68,9 +68,9 @@ import ( "github.com/spf13/cobra" - cmdutil "github.com/OpenIMSDK/Open-IM-Server/tools/imctl/pkg/util" - "github.com/OpenIMSDK/Open-IM-Server/tools/imctl/internal/imctl/util/templates" - "github.com/OpenIMSDK/Open-IM-Server/tools/imctl/pkg/cli/genericclioptions" + cmdutil "github.com/openimsdk/open-im-server/tools/imctl/pkg/util" + "github.com/openimsdk/open-im-server/tools/imctl/internal/imctl/util/templates" + "github.com/openimsdk/open-im-server/tools/imctl/pkg/cli/genericclioptions" ) const ( @@ -205,9 +205,9 @@ import ( "github.com/spf13/cobra" "github.com/spf13/viper" - cmdutil "github.com/OpenIMSDK/Open-IM-Server/tools/imctl/pkg/util" - "github.com/OpenIMSDK/Open-IM-Server/tools/imctl/internal/imctl/util/templates" - "github.com/OpenIMSDK/Open-IM-Server/tools/imctl/pkg/cli/genericclioptions" + cmdutil "github.com/openimsdk/open-im-server/tools/imctl/pkg/util" + "github.com/openimsdk/open-im-server/tools/imctl/internal/imctl/util/templates" + "github.com/openimsdk/open-im-server/tools/imctl/pkg/cli/genericclioptions" ) const maxStringLength = 17 @@ -253,9 +253,9 @@ import ( "github.com/spf13/cobra" "github.com/spf13/viper" - cmdutil "github.com/OpenIMSDK/Open-IM-Server/tools/imctl/pkg/util" - "github.com/OpenIMSDK/Open-IM-Server/tools/imctl/internal/imctl/util/templates" - "github.com/OpenIMSDK/Open-IM-Server/tools/imctl/pkg/cli/genericclioptions" + cmdutil "github.com/openimsdk/open-im-server/tools/imctl/pkg/util" + "github.com/openimsdk/open-im-server/tools/imctl/internal/imctl/util/templates" + "github.com/openimsdk/open-im-server/tools/imctl/pkg/cli/genericclioptions" ) const ( @@ -386,9 +386,9 @@ import ( "github.com/spf13/cobra" - cmdutil "github.com/OpenIMSDK/Open-IM-Server/tools/imctl/pkg/util" - "github.com/OpenIMSDK/Open-IM-Server/tools/imctl/internal/imctl/util/templates" - "github.com/OpenIMSDK/Open-IM-Server/tools/imctl/pkg/cli/genericclioptions" + cmdutil "github.com/openimsdk/open-im-server/tools/imctl/pkg/util" + "github.com/openimsdk/open-im-server/tools/imctl/internal/imctl/util/templates" + "github.com/openimsdk/open-im-server/tools/imctl/pkg/cli/genericclioptions" ) // SubCmd2Options is an options struct to support subcmd2 subcommands. diff --git a/tools/imctl/internal/imctl/cmd/options/options.go b/tools/imctl/internal/imctl/cmd/options/options.go index 9dfee06c9..52e236d13 100644 --- a/tools/imctl/internal/imctl/cmd/options/options.go +++ b/tools/imctl/internal/imctl/cmd/options/options.go @@ -20,7 +20,7 @@ import ( "github.com/spf13/cobra" - "github.com/OpenIMSDK/Open-IM-Server/tools/imctl/pkg/util/templates" + "github.com/openimsdk/open-im-server/tools/imctl/pkg/util/templates" ) var optionsExample = templates.Examples(` diff --git a/tools/imctl/internal/imctl/cmd/version/version.go b/tools/imctl/internal/imctl/cmd/version/version.go index 851f9b28d..c2636bfd2 100644 --- a/tools/imctl/internal/imctl/cmd/version/version.go +++ b/tools/imctl/internal/imctl/cmd/version/version.go @@ -25,9 +25,9 @@ import ( "github.com/openim-sigs/component-base/pkg/version" "github.com/spf13/cobra" - "github.com/OpenIMSDK/Open-IM-Server/tools/imctl/internal/imctl/util/templates" - "github.com/OpenIMSDK/Open-IM-Server/tools/imctl/pkg/cli/genericclioptions" - cmdutil "github.com/OpenIMSDK/Open-IM-Server/tools/imctl/pkg/util" + "github.com/openimsdk/open-im-server/tools/imctl/internal/imctl/util/templates" + "github.com/openimsdk/open-im-server/tools/imctl/pkg/cli/genericclioptions" + cmdutil "github.com/openimsdk/open-im-server/tools/imctl/pkg/util" ) // Version is a struct for version information.