mirror of
https://github.com/openimsdk/open-im-server.git
synced 2025-04-06 04:15:46 +08:00
0276c7df60
* refactor: refactor workflows contents. * add tool workflows. * update field. * fix: remove chat error. * Fix err. * fix error. * remove cn comment. * update workflows files. * update infra config. * move workflows. * feat: update bot. * fix: solve uncorrect outdated msg get. * update get docIDs logic. * update * update skip logic. * fix * update. * fix: delay deleteObject func. * remove unused content. * update log type. * feat: implement request batch count limit. * update * update * feat: add rocksTimeout * feat: wrap logs * feat: add logs * feat: listen config * feat: enable listen TIME_WAIT port * feat: add logs * feat: cache batch * chore: enable fullUserCache * feat: push rpc num * feat: push err * feat: with operationID * feat: sleep * feat: change 1s * feat: change log * feat: implement Getbatch in rpcCache. * feat: print getOnline cost * feat: change log * feat: change kafka and push config * feat: del interface * feat: fix err * feat: change config * feat: go mod * feat: change config * feat: change config * feat: add sleep in push * feat: warn logs * feat: logs * feat: logs * feat: change port * feat: start config * feat: remove port reuse * feat: prometheus config * feat: prometheus config * feat: prometheus config * feat: add long time send msg to grafana * feat: init * feat: init * feat: implement offline push. * feat: batch get user online * feat: implement batch Push spilt * update go mod * Revert "feat: change port" This reverts commit 06d5e944 * feat: change port * feat: change config * feat: implement kafka producer and consumer. * update format, * add PushMQ log. * feat: get all online users and init push * feat: lock in online cache * feat: config * fix: init online status * fix: add logs * fix: userIDs * fix: add logs * feat: update Handler logic. * update MQ logic. * update * update * fix: method name * fix: update OfflinePushConsumerHandler. * fix: prommetrics * fix: add logs * fix: ctx * fix: log * fix: config * feat: change port * fix: atomic online cache status --------- Co-authored-by: Monet Lee <monet_lee@163.com>
title: 'OpenIM Configuration Files and Common Configuration Item Modifications Guide'
## Configuration Files Explanation
| Configuration File | Description |
| ------------------------------- | ------------------------------------------------------------ |
| kafka.yml | Configurations for Kafka username, password, address, etc. |
| redis.yml | Configurations for Redis password, address, etc. |
| minio.yml | Configurations for MinIO username, password, address, and external IP/domain; failing to modify external IP or domain may cause image file sending failures |
| zookeeper.yml | Configurations for ZooKeeper user, password, address, etc. |
| mongodb.yml | Configurations for MongoDB username, password, address, etc. |
| log.yml | Configurations for log level and storage directory. |
| notification.yml | Configurations for events like adding friends, creating groups, etc. |
| share.yml | Common configurations needed by various OpenIM services, such as secret. |
| webhooks.yml | Configurations for URLs in Webhook. |
| local-cache.yml | Local cache configurations. |
| openim-rpc-third.yml | Configurations for listening IP, port, and storage settings for images and videos in openim-rpc-third service. |
| openim-rpc-user.yml | Configurations for listening IP and port in openim-rpc-user service. |
| openim-api.yml | Configurations for listening IP, port, etc., in openim-api service. |
| openim-crontask.yml | Configurations for openim-crontask service. |
| openim-msggateway.yml | Configurations for listening IP, port, etc., in openim-msggateway service. |
| openim-msgtransfer.yml | Configurations for openim-msgtransfer service. |
| openim-push.yml | Configurations for listening IP, port, and offline push settings in openim-push service. |
| openim-rpc-auth.yml | Configurations for listening IP, port, and token expiration settings in openim-rpc-auth service. |
| openim-rpc-conversation.yml | Configurations for listening IP, port, etc., in openim-rpc-conversation service. |
| openim-rpc-friend.yml | Configurations for listening IP, port, etc., in openim-rpc-friend service. |
| openim-rpc-group.yml | Configurations for listening IP, port, etc., in openim-rpc-group service. |
| openim-rpc-msg.yml | Configurations for listening IP, port, and whether to verify friendship before sending messages in openim-rpc-msg service. |
## Common Configuration Item Modifications
| Configuration Item Modification | Configuration File |
| ----------------------------------------------------- | ----------------------- |
| Using MinIO for image and video file object storage |
minio.yml |
| Adjusting production environment logs | log.yml |
| Verifying friendship before sending messages | openim-rpc-msg.yml |
| Modifying secret | share.yml |
| Using OSS, COS, AWS, Kodo for image and video storage | openim-rpc-third.yml |
| Setting multiple login policy | openim-msggateway.yml |
| Setting up offline push | openim-push.yml |
## Starting Multiple Instances of an OpenIM Service
To start multiple instances of an OpenIM service, simply increase the corresponding port numbers and modify the start-config.yml file in the project root directory. Restart the service to take effect. For example, the configuration to start 2 instances of openim-rpc-user is as follows:
yaml rpc: registerIP: '' listenIP: 0.0.0.0 ports: [ 10110, 10111 ] prometheus: enable: true ports: [ 20100, 20101 ]
Modify start-config.yml:
yaml serviceBinaries: openim-rpc-user: 2