- # then create pull request, and merge
- # update some new feature, feature2, rebase main branch first.
- ❯ git rebase upstream/main # rebase the current branch to upstream/main branch
- ❯ git add -A
- ❯ git commit -m -s "feat: feature two"
- ```
-
- **Verifying Your Pull Request with `make all` Command**
-
- Before verifying, you may need to complete the basic deployment of OpenIM to get familiar with the deployment status of OpenIM. Please read [this deployment document](https://docs.openim.io/zh-Hans/guides/gettingStarted/imSourceCodeDeployment), which will tell you how to deploy OpenIM middleware and OpenIM services in detail
-
- Before submitting your Pull Request (PR), it's crucial to ensure that it passes all the necessary checks and verifications to maintain the quality and integrity of the OpenIM server project. To facilitate this process, we have encapsulated a series of validation steps into the `make all` command.
-
- - **Purpose of `make all` Command**: The `make all` command serves as a comprehensive pre-PR verification tool. It sequentially executes a variety of tasks designed to scrutinize your changes from multiple angles, ensuring they are ready for submission.
-
- - **Included Commands**:
- - `tidy`: Cleans up the module by removing unused dependencies.
- - `gen`: Generates necessary files from templates or specifications, ensuring that your codebase is up-to-date with its dependencies.
- - `add-copyright`: Checks for and adds copyright notices to files, ensuring compliance with legal requirements.
- - `verify`: Verifies the integrity and consistency of the code, dependencies, and various checks.
- - `test-api`: Runs API tests to ensure that your changes do not break any existing functionality and adhere to the expected behaviors.
- - `lint`: Analyzes the code for potential stylistic or programming errors, enforcing the project's coding standards.
- - `cover`: Measures the code coverage of tests, helping you understand how much of the code is being tested.
- - `restart`: (Optionally) restarts services or applications to ensure that changes are correctly applied and functioning in a live environment.
-
- - **Executing the Command**: To run the `make all` command, simply navigate to the root directory of your cloned repository in your terminal and execute:
- ```bash
- make all
- ```
- This command will sequentially perform all the listed actions, outputting any warnings or errors encountered during the process. It's a vital step to catch any issues early and ensure your contribution meets the quality standards set by the OpenIM community.
-
- - **Benefits**: By using `make all` for pre-PR verification, you significantly increase the likelihood of your PR being accepted on the first review. It not only demonstrates your commitment to quality but also streamlines the review process by minimizing back-and-forth due to common issues that can be caught automatically.
-
-
- **Troubleshooting Git Push Failures**
-
- When working with Git, encountering errors during push operations is not uncommon. Two primary reasons you might face push failures are due to firewall restrictions or authentication issues. Here’s how you can troubleshoot and resolve these problems.
-
- **Firewall Errors**
-
- If you're behind a corporate firewall or your network restricts certain types of traffic, you might encounter issues when trying to push your changes via HTTPS. This is because firewalls can block the ports used by the HTTPS protocol. To resolve this issue, you can configure Git to use a proxy.
-
- If you have a local proxy server set up, you can direct Git to use it by setting the `https_proxy` and `http_proxy` environment variables. Open your terminal or command prompt and run the following commands:
-
- ```bash
- export https_proxy="http://127.0.0.1:7890"
- export http_proxy="http://127.0.0.1:7890"
- ```
-
- Replace `127.0.0.1:7890` with the address and port of your proxy server. These commands set the proxy for the current session. If you want to make these changes permanent, add them to your `.bashrc`, `.bash_profile`, or equivalent shell configuration file.
-
- **Using SSH Instead of HTTPS**
-
- An alternative to using HTTPS is to set up an SSH connection for Git operations. SSH connections are often not blocked by firewalls and do not require proxy settings. Additionally, SSH provides a secure channel and can simplify the authentication process since it relies on SSH keys rather than username and password credentials.
-
- To use SSH with Git, you first need to generate an SSH key pair and add the public key to your GitHub account (or another Git hosting service).
-
- 1. **Generate SSH Key Pair**: Open your terminal and run `ssh-keygen -t rsa -b 4096 -C "your_email@example.com"`, replacing `your_email@example.com` with your email. Press enter to accept the default file location and passphrase prompts.
-
- 2. **Add SSH Key to SSH-Agent**: Ensure the ssh-agent is running with `eval "$(ssh-agent -s)"` and then add your SSH private key to the ssh-agent using `ssh-add ~/.ssh/id_rsa`.
-
- 3. **Add SSH Key to GitHub**: Copy your SSH public key to your clipboard with `cat ~/.ssh/id_rsa.pub | clip` (Windows) or `pbcopy < ~/.ssh/id_rsa.pub` (Mac). Go to GitHub, navigate to Settings > SSH and GPG keys, and add a new SSH key, pasting your key into the field provided.
-
- 4. **Switch to SSH in Your Repository**: Change your repository's remote URL from HTTPS to SSH. You can find the SSH URL in your repository settings on GitHub and use `git remote set-url origin git@github.com:username/repository.git` to switch.
-
- **Authentication Errors**
-
- If you're experiencing authentication errors, it might be due to missing or incorrect credentials. Ensure you have added your SSH key to your Git hosting service. You can test your SSH connection with `ssh -T git@github.com` (replace `github.com` with your Git hosting service's domain). If successful, you'll receive a welcome message.
-
- For HTTPS users, check that your username and password (or personal access token for services like GitHub that no longer accept password authentication for Git operations) are correct.
-
-8. **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.
-
- > [!TIP] There is a [good blog post documenting](https://nsddd.top/posts/participating-in-this-project/) the entire push contribution process.
-
-
-## Style and Specification
-
-We divide the problem into security and general problems:
-
-#### Reporting security issues
-
-Security issues are always treated seriously. As our usual principle, we discourage anyone to spread security issues. If you find a security issue of open-im-server, please do not discuss it in public and even do not open a public issue.
-
-Instead we encourage you to send us a private email to info@openim.io to report this.
-
-#### 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).
-
-Since we collaborate project open-im-server in a distributed way, we appreciate **WELL-WRITTEN**, **DETAILED**, **EXPLICIT** issue reports. To make the communication more efficient, we wish everyone could search if your issue is an existing one in the searching list. If you find it existing, please add your details in comments under the existing issue instead of opening a brand new one.
-
-To make the issue details as standard as possible, we setup an [ISSUE TEMPLATE](https://github.com/OpenIMSDK/.github/tree/main/.github/ISSUE_TEMPLATE) for issue reporters. You can find three kinds of issue templates there: question, bug report and feature request. Please **BE SURE** to follow the instructions to fill fields in template.
-
-**There are a lot of cases when you could open an issue:**
-
-+ bug report
-+ feature request
-+ open-im-server performance issues
-+ feature proposal
-+ feature design
-+ help wanted
-+ doc incomplete
-+ test improvement
-+ any questions on open-im-server project
-+ and so on
-
-Also, we must be reminded when submitting a new question about open-im-server, please remember to remove the sensitive data from your post. Sensitive data could be password, secret key, network locations, private business data and so on.
-
-#### Commit Rules
-
-Actually in open-im-server, we take two rules serious when committing:
-
-**🥇 Commit Message:**
-
-Commit message could help reviewers better understand what the purpose of submitted PR is. It could help accelerate the code review procedure as well. We encourage contributors to use **EXPLICIT** commit message rather than ambiguous message. In general, we advocate the following commit message type:
-
-We use [Semantic Commits](https://www.conventionalcommits.org/en/v1.0.0/) to make it easier to understand what a commit does and to build pretty changelogs. Please use the following prefixes for your commits:
-
-+ `docs: xxxx`. For example, "docs: add docs about storage installation".
-+ `feature: xxxx`.For example, "feature: make result show in sorted order".
-+ `bugfix: xxxx`. For example, "bugfix: fix panic when input nil parameter".
-+ `style: xxxx`. For example, "style: format the code style of Constants.java".
-+ `refactor: xxxx.` For example, "refactor: simplify to make codes more readable".
-+ `test: xxx`. For example, "test: add unit test case for func InsertIntoArray".
-+ `chore: xxx.` For example, "chore: integrate travis-ci". It's the type of mantainance change.
-+ other readable and explicit expression ways.
-
-On the other side, we discourage contributors from committing message like the following ways:
-
-+ ~~fix bug~~
-+ ~~update~~
-+ ~~add doc~~
-
-**🥈 Commit Content:**
-
-Commit content represents all content changes included in one commit. We had better include things in one single commit which could support reviewer's complete review without any other commits' help.
-
-In another word, contents in one single commit can pass the CI to avoid code mess. In brief, there are two minor rules for us to keep in mind:
-
-1. avoid very large change in a commit.
-2. complete and reviewable for each commit.
-3. words are written in lowercase English, not uppercase English or other languages such as Chinese.
-
-No matter what the commit message, or commit content is, we do take more emphasis on code review.
-
-An example for this could be:
+### 1. Fork the Repository
+Go to the `openimsdk/open-im-server` GitHub page, click the "Fork" button in the upper right corner to fork the repository to your GitHub account.
+### 2. Clone the Repository
+Clone the forked repository to your local machine:
```bash
-❯ git commit -a -s -m "docs: add a new section to the README"
+git clone https://github.com/your-username/open-im-server.git
```
-#### PR Description
-
-PR is the only way to make change to open-im-server project files. To help reviewers better get your purpose, PR description could not be too detailed. We encourage contributors to follow the [PR template](https://github.com/OpenIMSDK/.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.
-
-**📖 Opening PRs:**
-
-+ As long as you are working on your PR, please mark it as a draft
-+ Please make sure that your PR is up-to-date with the latest changes in `main`
-+ Mention the issue that your PR is addressing (Fix: #{ID_1}, #{ID_2})
-+ Make sure that your PR passes all checks
-
-**🈴 Reviewing PRs:**
-
-+ Be respectful and constructive
-+ Assign yourself to the PR (comment `/assign`)
-+ Check if all checks are passing
-+ Suggest changes instead of simply commenting on found issues
-+ If you are unsure about something, ask the author
-+ If you are not sure if the changes work, try them out
-+ Reach out to other reviewers if you are unsure about something
-+ If you are happy with the changes, approve the PR
-+ Merge the PR once it has all approvals and the checks are passing
-
-**⚠️ DCO check:**
-
-We have a DCO check that runs on every pull request to ensure code quality and maintainability. This check verifies that the commit has been signed off, indicating that you have read and agreed to the provisions of the Developer Certificate of Origin. If you have not yet signed off on the commit, you can use the following command to sign off on the last commit you made:
-
+### 3. Set Upstream Remote
+Add the original repository as a remote upstream to track updates:
```bash
-❯ git commit --amend --signoff
+git remote add upstream https://github.com/openimsdk/open-im-server.git
```
-Please note that signing off on a commit is a commitment that you have read and agreed to the provisions of the Developer Certificate of Origin. If you have not yet read this document, we strongly recommend that you take some time to read it carefully. If you have any questions about the content of this document, or if you need further assistance, please contact an administrator or relevant personnel.
-
-You can also automate signing off your commits by adding the following to your `.zshrc` or `.bashrc`:
+### 4. Create an Issue
+Create a new issue in the original repository describing the problem you are facing or the new feature you want to add. For significant feature adjustments, propose an RFC issue to facilitate broad discussion and participation from community members.
-```go
-git() {
- if [ $# -gt 0 ] && [[ "$1" == "commit" ]] ; then
- shift
- command git commit --signoff "$@"
- else
- command git "$@"
- fi
-}
+### 5. Create a New Branch
+Create a new branch based on the main branch and name it descriptively, including the Issue ID, for example:
+```bash
+git checkout -b fix-bug-123
```
+### 6. Commit Changes
+After making changes on your local branch, commit them:
+```bash
+git add .
+git commit -m "Describe your changes in detail"
+```
-#### Docs Contribution
-
-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.
-+ [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.
-
-1. Please do not use Chinese punctuations in English docs, and vice versa.
-2. Please use upper case letters where applicable, like the first letter of sentences / headings, etc.
-3. Please specify a language for each Markdown code blocks, unless there's no associated languages.
-4. Please insert a whitespace between Chinese and English words.
-5. Please use the correct case for technical terms, such as using `HTTP` instead of http, `MySQL` rather than mysql, `Kubernetes` instead of kubernetes, etc.
-6. Please check if there's any typos in the docs before submitting PRs.
-
-## Engage to help anything
-
-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;
-+ help solve other user's problems;
-+ help review other's [PR](https://github.com/openimsdk/open-im-server/pulls?q=is%3Apr+is%3Aopen+sort%3Aupdated-desc) design;
-+ discuss about open-im-server to make things clearer;
-+ advocate [open-im-server](https://google.com/search?q=open-im-server) technology beyond GitHub;
-+ write blogs on open-im-server and so on.
-
-In a word, **ANY HELP IS CONTRIBUTION.**
-
-## Release version
-
-Releases of open-im-server are done using [Release Please](https://github.com/googleapis/release-please) and [GoReleaser](https://goreleaser.com/). The workflow looks like this:
-
-🎯 A PR is merged to the `main` branch:
-
-+ Release please is triggered, creates or updates a new release PR
-+ This is done with every merge to main, the current release PR is updated every time
-
-🎯 Merging the 'release please' PR to `main`:
-
-+ Release please is triggered, creates a new release and updates the changelog based on the commit messages
-+ GoReleaser is triggered, builds the binaries and attaches them to the release
-+ Containers are created and pushed to the container registry
-
-With the next relevant merge, a new release PR will be created and the process starts again
-
-**👀 Manually setting the version:**
-
-If you want to manually set the version, you can create a PR with an empty commit message that contains the version number in the commit message. For example:
-
-Such a commit can get produced as follows:
-
-````bash
-❯ git commit --allow-empty -m "chore: release 0.0.3" -m "Release-As: 0.0.3
-````
-
-For the complex release process, in fact, and encapsulation as CICD, you only need to tag locally, and then publish the tag to OpenIM github to complete the entire OpenIM release process.
-
-In addition to CICD, we also do a complex release command locally, which can help you complete the full platform compilation, testing, and release to Minio, just by using the `make release` command.
-Please [read the detailed documents](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/release.md)
-
-
-## Contact Us
-
-We value close connections with our users, developers, and contributors here at open-im-server. With a large community and maintainer team, we're always here to help and support you. Whether you're looking to join our community or have any questions or suggestions, we welcome you to get in touch with us.
+### 7. Push the Branch
+Push your branch back to your GitHub fork:
+```bash
+git push origin fix-bug-123
+```
-Our most recommended way to get in touch is through [Slack](https://join.slack.com/t/openimsdk/shared_invite/zt-22720d66b-o_FvKxMTGXtcnnnHiMqe9Q). Even if you're in China, Slack is usually not blocked by firewalls, making it an easy way to connect with us. Our Slack community is the ideal place to discuss and share ideas and suggestions with other users and developers of open-im-server. You can ask technical questions, seek help, or share your experiences with other users of open-im-server.
+### 8. Create a Pull Request
+Go to your fork on GitHub, click the "Pull Request" button. Make sure the PR description is clear and links to the related Issue.
+#### 🅰 Fixed issue #issueID
-In addition to Slack, we also offer the following ways to get in touch:
+### 9. Sign the CLA
+If this is your first time submitting a PR, you need to reply in the PR comments:
+```
+I have read the CLA Document and I hereby sign the CLA
+```
-+ 
: We also have Slack channels for you to communicate and discuss. To join, visit https://slack.com/ and join our [👀 open-im-server slack](https://join.slack.com/t/openimsdk/shared_invite/zt-22720d66b-o_FvKxMTGXtcnnnHiMqe9Q) team channel.
-+ 
: Get in touch with us on [Gmail](info@openim.io). If you have any questions or issues that need resolving, or any suggestions and feedback for our open source projects, please feel free to contact us via email.
-+ 
: Read our [blog](https://doc.rentsoft.cn/). Our blog is a great place to stay up-to-date with open-im-server projects and trends. On the blog, we share our latest developments, tech trends, and other interesting information.
-+ 
: Add [Wechat](https://github.com/OpenIMSDK/OpenIM-Docs/blob/main/docs/images/WechatIMG20.jpeg) and indicate that you are a user or developer of open-im-server. We will process your request as soon as possible.
+### Additional Notes
+If the same modification needs to be submitted to two different branches (e.g., main and release-v3.7), create two new branches from the corresponding remote branches. First complete the modification in one branch, then use the `cherry-pick` command to apply these changes to the other branch. After that, submit a separate Pull Request for each branch.
-Whether you're looking to join our community or have any questions or suggestions, we welcome you to get in touch with us.
diff --git a/README.md b/README.md
index d0c397a28..7c34664d6 100644
--- a/README.md
+++ b/README.md
@@ -17,7 +17,7 @@
[](https://github.com/openimsdk/open-im-server/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3A%22good+first+issue%22)
[](https://golang.org/)
-
+
Englist ·
中文 ·
@@ -84,7 +84,7 @@ Built with Golang and supports cross-platform deployment to ensure a consistent
👉 **[Explore the GO SDK](https://github.com/openimsdk/openim-sdk-core)**
-## 🌐 Introduction to OpenIMServer
+## 🌐 Introduction to OpenIMServer
+ **OpenIMServer** features include:
- 🌐 Microservices Architecture: Supports cluster mode, including a gateway and multiple rpc services.
@@ -131,7 +131,7 @@ Thank you for contributing to building a powerful instant messaging solution!
## :closed_book: License
-OpenIMSDK is available under the Apache License 2.0. See the [LICENSE file](https://github.com/openimsdk/open-im-server/blob/main/LICENSE) for more information.
+OpenIMSDK is available under the Apache License 2.0. See the [LICENSE file](https://github.com/openimsdk/open-im-server/blob/main/LICENSE) for more information.
diff --git a/config/templates/alertmanager.yml.template b/config/templates/alertmanager.yml.template
deleted file mode 100644
index a0daadfbd..000000000
--- a/config/templates/alertmanager.yml.template
+++ /dev/null
@@ -1,47 +0,0 @@
-# Copyright © 2023 OpenIM. All rights reserved.
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-###################### AlertManager Configuration ######################
-# AlertManager configuration using environment variables
-#
-# Resolve timeout
-# SMTP configuration for sending alerts
-# Templates for email notifications
-# Routing configurations for alerts
-# Receiver configurations
-global:
- resolve_timeout: 5m
- smtp_from: alert@openim.io
- smtp_smarthost: smtp.163.com:465
- smtp_auth_username: alert@openim.io
- smtp_auth_password: YOURAUTHPASSWORD
- smtp_require_tls: false
- smtp_hello: xxx监控告警
-
-templates:
- - /etc/alertmanager/email.tmpl
-
-route:
- group_by: ['alertname']
- group_wait: 5s
- group_interval: 5s
- repeat_interval: 5m
- receiver: email
-receivers:
- - name: email
- email_configs:
- - to: 'alert@example.com'
- html: '{{ template "email.to.html" . }}'
- headers: { Subject: "[OPENIM-SERVER]Alarm" }
- send_resolved: true
diff --git a/config/templates/config.yaml.template b/config/templates/config.yaml.template
deleted file mode 100644
index 5c5cfda78..000000000
--- a/config/templates/config.yaml.template
+++ /dev/null
@@ -1,552 +0,0 @@
-envs:
- discovery: zookeeper
-
-###################### Zookeeper ######################
-# Zookeeper configuration
-# It's not recommended to modify the schema
-#
-# Zookeeper address
-# Zookeeper username
-# Zookeeper password
-zookeeper:
- schema: openim
- address: [ 172.28.0.1:12181 ]
- username: ''
- password: ''
-
-###################### Mongo ######################
-# MongoDB configuration
-
-# If uri is not empty, it will be used directly for the MongoDB connection.
-# This is a complete MongoDB URI string.
-# Example: mongodb://user:password@host1:port1,host2:port2/dbname?options
-mongo:
- uri: ''
-
-# List of MongoDB server addresses.
-# Used for constructing the MongoDB URI if 'uri' above is empty.
-# For a standalone setup, specify the address of the single server.
-# For a sharded cluster, specify the addresses of the Mongos servers.
-# Example: [ '172.28.0.1:37017', '172.28.0.2:37017' ]
-# Default MongoDB database name
-# Maximum connection pool size
- address: [ 172.28.0.1:37017 ]
- database: openim_v3
- username: openIM
- password: openIM123
- maxPoolSize: 100
-
-###################### Redis configuration information ######################
-# Redis configuration
-#
-# Username is required only for Redis version 6.0+
-redis:
- address: [ 172.28.0.1:16379 ]
- username: ''
- password: openIM123
-
-###################### Kafka configuration information ######################
-# Kafka configuration
-#
-# Kafka username
-# Kafka password
-# It's not recommended to modify this topic name
-# Consumer group ID, it's not recommended to modify
-kafka:
- username: ''
- password: ''
- addr: [ 172.28.0.1:19094 ]
- latestMsgToRedis:
- topic: "latestMsgToRedis"
- offlineMsgToMongo:
- topic: "offlineMsgToMongoMysql"
- msgToPush:
- topic: "msgToPush"
- consumerGroupID:
- msgToRedis: redis
- msgToMongo: mongo
- msgToMySql: mysql
- msgToPush: push
-
-###################### RPC configuration information ######################
-# RPC configuration
-#
-# IP address to register with zookeeper when starting RPC, the IP and corresponding rpcPort should be accessible by api/gateway
-# Default listen IP is 0.0.0.0
-rpc:
- registerIP: ''
- listenIP: 0.0.0.0
-
-###################### API configuration information ######################
-# API configuration
-#
-# API service port
-# Default listen IP is 0.0.0.0
-api:
- openImApiPort: [ 10002 ]
- listenIP: 0.0.0.0
-
-###################### Object configuration information ######################
-# Object storage configuration
-#
-# Use minio for object storage
-# API URL should be accessible by the app
-# It's not recommended to modify the bucket name
-# Endpoint should be accessible by the app
-# Session token
-# Configuration for Tencent COS
-# Configuration for Aliyun OSS
-# apiURL is the address of the api, the access address of the app, use s3 must be configured
-# minio.endpoint can be configured as an intranet address,
-# minio.signEndpoint is minio public network address
-object:
- enable: "minio"
- apiURL: "http://127.0.0.1:10002"
- minio:
- bucket: "openim"
- endpoint: "http://172.28.0.1:10005"
- accessKeyID: "root"
- secretAccessKey: "openIM123"
- sessionToken: ''
- signEndpoint: "http://127.0.0.1:10005"
- publicRead: false
- cos:
- bucketURL: https://temp-1252357374.cos.ap-chengdu.myqcloud.com
- secretID: ''
- secretKey: ''
- sessionToken: ''
- publicRead: false
- oss:
- endpoint: "https://oss-cn-chengdu.aliyuncs.com"
- bucket: "demo-9999999"
- bucketURL: "https://demo-9999999.oss-cn-chengdu.aliyuncs.com"
- accessKeyID: ''
- accessKeySecret: ''
- sessionToken: ''
- publicRead: false
- kodo:
- endpoint: "http://s3.cn-east-1.qiniucs.com"
- bucket: "demo-9999999"
- bucketURL: "http://your.domain.com"
- accessKeyID: ''
- accessKeySecret: ''
- sessionToken: ''
- publicRead: false
- aws:
- endpoint: "''" # This might not be necessary unless you're using a custom endpoint
- region: "us-east-1"
- bucket: "demo-9999999"
- accessKeyID: ''
- accessKeySecret: ''
- publicRead: false
-
-###################### RPC Port Configuration ######################
-# RPC service ports
-# These ports are passed into the program by the script and are not recommended to modify
-# For launching multiple programs, just fill in multiple ports separated by commas
-# For example, [10110, 10111]
-rpcPort:
- openImUserPort: [ 10110 ]
- openImFriendPort: [ 10120 ]
- openImMessagePort: [ 10130 ]
- openImGroupPort: [ 10150 ]
- openImAuthPort: [ 10160 ]
- openImPushPort: [ 10170 ]
- openImConversationPort: [ 10180 ]
- openImThirdPort: [ 10190 ]
-
-###################### RPC Register Name Configuration ######################
-# RPC service names for registration, it's not recommended to modify these
-rpcRegisterName:
- openImUserName: User
- openImFriendName: Friend
- openImMsgName: Msg
- openImPushName: Push
- openImMessageGatewayName: MessageGateway
- openImGroupName: Group
- openImAuthName: Auth
- openImConversationName: Conversation
- openImThirdName: Third
-
-###################### Log Configuration ######################
-# Log configuration
-#
-# Storage directory
-# Log rotation time
-# Maximum number of logs to retain
-# Log level, 6 means all levels
-# Whether to output to stdout
-# Whether to output in json format
-# Whether to include stack trace in logs
-log:
- storageLocation: /data/workspaces/open-im-server/_output/logs/
- rotationTime: 24
- remainRotationCount: 2
- remainLogLevel: 6
- isStdout: false
- isJson: false
- withStack: false
-
-###################### Variables definition ######################
-# Long connection server configuration
-#
-# Websocket port for msg_gateway
-# Maximum number of websocket connections
-# Maximum length of websocket request package
-# Websocket connection handshake timeout
-longConnSvr:
- openImWsPort: [ 10001 ]
- websocketMaxConnNum: 100000
- openImMessageGatewayPort: [ 10140 ]
- websocketMaxMsgLen: 4096
- websocketTimeout: 10
-
-# Push notification service configuration
-#
-# Use GeTui for push notifications
-# GeTui offline push configuration
-# FCM offline push configuration
-# Account file, place it in the config directory
-# JPush configuration, modify these after applying in JPush backend
-push:
- enable: getui
- geTui:
- pushUrl: "https://restapi.getui.com/v2/$appId"
- masterSecret: ''
- appKey: ''
- intent: ''
- channelID: ''
- channelName: ''
- fcm:
- serviceAccount: "x.json"
- jpns:
- appKey: ''
- masterSecret: ''
- pushUrl: ''
- pushIntent: ''
-
-# App manager configuration
-#
-# Built-in app manager user IDs
-# Built-in app manager nicknames
-# Attention, this configure is discarded. If you have used him before, configure your own
-manager:
- userID:
- nickname:
-
-# chatAdmin, use for send notification
-#
-# Built-in app system notification account ID
-# Built-in app system notification account nickname
-im-admin:
- userID: [ "imAdmin" ]
- nickname: [ "imAdmin" ]
-
-# Multi-platform login policy
-# For each platform(Android, iOS, Windows, Mac, web), only one can be online at a time
-multiLoginPolicy: 1
-
-# Whether to store messages in MySQL, messages in MySQL are only used for management background
-chatPersistenceMysql: true
-
-# Message cache timeout in seconds, it's not recommended to modify
-msgCacheTimeout: 86400
-
-# Whether to enable read receipts for group chat
-groupMessageHasReadReceiptEnable: true
-
-# Whether to enable read receipts for single chat
-singleMessageHasReadReceiptEnable: true
-
-# MongoDB offline message retention period in days
-retainChatRecords: 365
-
-# Schedule to clear expired messages(older than retainChatRecords days) in MongoDB every Wednesday at 2am
-# This deletion is just for cleaning up disk usage according to previous configuration retainChatRecords, no notification will be sent
-chatRecordsClearTime: "0 2 * * 3"
-
-# Schedule to auto delete messages every day at 2am
-# This deletion is for messages that have been retained for more than msg_destruct_time (seconds) in the conversation field
-msgDestructTime: "0 2 * * *"
-
-# Secret key
-secret: openIM123
-
-# Token policy
-#
-# Token expiration period in days
-tokenPolicy:
- expire: 90
-
-# Message verification policy
-#
-# Whether to verify friendship when sending messages
-messageVerify:
- friendVerify: false
-
-# iOS push notification configuration
-#
-# iOS push notification sound
-# Whether to count badge
-# Whether it's production environment
-iosPush:
- pushSound: "xxx"
- badgeCount: true
- production: false
-
-###################### Third-party service configuration ######################
-# Callback configuration
-#
-# Callback URL
-# Whether to enable this callback event
-# Timeout in seconds
-# Whether to continue execution if callback fails
-callback:
- url: "http://127.0.0.1:10008/callbackExample"
- beforeSendSingleMsg:
- enable: false
- timeout: 5
- failedContinue: true
- beforeUpdateUserInfoEx:
- enable: false
- timeout: 5
- failedContinue: true
- afterUpdateUserInfoEx:
- enable: false
- timeout: 5
- failedContinue: true
- afterSendSingleMsg:
- enable: false
- timeout: 5
- failedContinue: true
- beforeSendGroupMsg:
- enable: false
- timeout: 5
- failedContinue: true
- afterSendGroupMsg:
- enable: false
- timeout: 5
- failedContinue: true
- msgModify:
- enable: false
- timeout: 5
- failedContinue: true
- userOnline:
- enable: false
- timeout: 5
- failedContinue: true
- userOffline:
- enable: false
- timeout: 5
- failedContinue: true
- userKickOff:
- enable: false
- timeout: 5
- failedContinue: true
- offlinePush:
- enable: false
- timeout: 5
- failedContinue: true
- onlinePush:
- enable: false
- timeout: 5
- failedContinue: true
- superGroupOnlinePush:
- enable: false
- timeout: 5
- failedContinue: true
- beforeAddFriend:
- enable: false
- timeout: 5
- failedContinue: true
- beforeUpdateUserInfo:
- enable: false
- timeout: 5
- failedContinue: true
- beforeCreateGroup:
- enable: false
- timeout: 5
- failedContinue: true
- afterCreateGroup:
- enable: false
- timeout: 5
- failedContinue: true
- beforeMemberJoinGroup:
- enable: false
- timeout: 5
- failedContinue: true
- beforeSetGroupMemberInfo:
- enable: false
- timeout: 5
- failedContinue: true
- afterSetGroupMemberInfo:
- enable: false
- timeout: 5
- failedContinue: true
- setMessageReactionExtensions:
- enable: false
- timeout: 5
- failedContinue: true
- quitGroup:
- enable: false
- timeout: 5
- failedContinue: true
- killGroupMember:
- enable: false
- timeout: 5
- failedContinue: true
- dismissGroup:
- enable: false
- timeout: 5
- failedContinue: true
- joinGroup:
- enable: false
- timeout: 5
- failedContinue: true
- groupMsgRead:
- enable: false
- timeout: 5
- failedContinue: true
- singleMsgRead:
- enable: false
- timeout: 5
- failedContinue: true
- updateUserInfo:
- enable: false
- timeout: 5
- failedContinue: true
- beforeUserRegister:
- enable: false
- timeout: 5
- failedContinue: true
- afterUserRegister:
- enable: false
- timeout: 5
- failedContinue: true
- transferGroupOwner:
- enable: false
- timeout: 5
- failedContinue: true
- beforeSetFriendRemark:
- enable: false
- timeout: 5
- failedContinue: true
- afterSetFriendRemark:
- enable: false
- timeout: 5
- failedContinue: true
- afterGroupMsgRead:
- enable: false
- timeout: 5
- failedContinue: true
- afterGroupMsgRevoke:
- enable: false
- timeout: 5
- failedContinue: true
- afterJoinGroup:
- enable: false
- timeout: 5
- failedContinue: true
- beforeInviteUserToGroup:
- enable: false
- timeout: 5
- failedContinue: true
- joinGroupAfter:
- enable: false
- timeout: 5
- failedContinue: true
- setGroupInfoAfter:
- enable: false
- timeout: 5
- failedContinue: true
- setGroupInfoBefore:
- enable: false
- timeout: 5
- failedContinue: true
- revokeMsgAfter:
- enable: false
- timeout: 5
- failedContinue: true
- addBlackBefore:
- enable: false
- timeout: 5
- failedContinue: true
- addFriendAfter:
- enable: false
- timeout: 5
- failedContinue: true
- addFriendAgreeBefore:
- enable: false
- timeout: 5
- failedContinue: true
- deleteFriendAfter:
- enable: false
- timeout: 5
- failedContinue: true
- importFriendsBefore:
- enable: false
- timeout: 5
- failedContinue: true
- importFriendsAfter:
- enable: false
- timeout: 5
- failedContinue: true
- removeBlackAfter:
- enable: false
- timeout: 5
- failedContinue: true
-###################### Prometheus ######################
-# Prometheus configuration for various services
-# The number of Prometheus ports per service needs to correspond to rpcPort
-# The number of ports needs to be consistent with msg_transfer_service_num in script/path_info.sh
-prometheus:
- enable: true
- grafanaUrl: http://127.0.0.1:13000/
- apiPrometheusPort: [20100]
- userPrometheusPort: [ 20110 ]
- friendPrometheusPort: [ 20120 ]
- messagePrometheusPort: [ 20130 ]
- messageGatewayPrometheusPort: [ 20140 ]
- groupPrometheusPort: [ 20150 ]
- authPrometheusPort: [ 20160 ]
- pushPrometheusPort: [ 20170 ]
- conversationPrometheusPort: [ 20230 ]
- rtcPrometheusPort: [ 21300 ]
- thirdPrometheusPort: [ 21301 ]
- messageTransferPrometheusPort: [ 21400, 21401, 21402, 21403 ] # List of ports
-
-###################### LocalCache configuration information ######################
-# topic: redis subscriber channel
-# slotNum: number of slots, multiple slots can prevent too many keys from competing for a lock
-# slotSize: number of slots, the number of cached keys per slot, the overall cache quantity is slotNum * slotSize
-# successExpire: successful cache time seconds
-# failedExpire: failed cache time seconds
-# disable local caching and annotate topic, slotNum, and slotSize
-localCache:
- user:
- topic: DELETE_CACHE_USER
- slotNum: 100
- slotSize: 2000
- successExpire: 300
- failedExpire: 5
-
- group:
- topic: DELETE_CACHE_GROUP
- slotNum: 100
- slotSize: 2000
- successExpire: 300
- failedExpire: 5
-
- friend:
- topic: DELETE_CACHE_FRIEND
- slotNum: 100
- slotSize: 2000
- successExpire: 300
- failedExpire: 5
-
- conversation:
- topic: DELETE_CACHE_CONVERSATION
- slotNum: 100
- slotSize: 2000
- successExpire: 300
- failedExpire: 5
diff --git a/config/templates/email.tmpl.template b/config/templates/email.tmpl.template
deleted file mode 100644
index 0385601d0..000000000
--- a/config/templates/email.tmpl.template
+++ /dev/null
@@ -1,16 +0,0 @@
-{{ define "email.to.html" }}
-{{ range .Alerts }}
-
-
-
OpenIM Alert
-
Alert Program: Prometheus Alert
-
Severity Level: {{ .Labels.severity }}
-
Alert Type: {{ .Labels.alertname }}
-
Affected Host: {{ .Labels.instance }}
-
Affected Service: {{ .Labels.job }}
-
Alert Subject: {{ .Annotations.summary }}
-
Trigger Time: {{ .StartsAt.Format "2006-01-02 15:04:05" }}
-
: Add [Wechat](https://github.com/OpenIMSDK/OpenIM-Docs/blob/main/docs/images/WechatIMG20.jpeg) and indicate that you are a user or developer of open-im-server. We will process your request as soon as possible.
+### Additional Notes
+If the same modification needs to be submitted to two different branches (e.g., main and release-v3.7), create two new branches from the corresponding remote branches. First complete the modification in one branch, then use the `cherry-pick` command to apply these changes to the other branch. After that, submit a separate Pull Request for each branch.
-Whether you're looking to join our community or have any questions or suggestions, we welcome you to get in touch with us.
diff --git a/README.md b/README.md
index d0c397a28..7c34664d6 100644
--- a/README.md
+++ b/README.md
@@ -17,7 +17,7 @@
[](https://github.com/openimsdk/open-im-server/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3A%22good+first+issue%22)
[](https://golang.org/)
-
+