openim-server/config
OpenIM-Gordon 653b48479d
3.6.1 code conventions (#2202)
* refactor: webhooks update.

* Adjust configuration settings

* Adjust configuration settings

* Adjust configuration settings

* feat: s3 api addr

* refactor: webhooks update.

* Adjust configuration settings

* Adjust configuration settings

* Adjust configuration settings

* Adjust configuration settings

* Adjust configuration settings

* Adjust configuration settings

* Adjust configuration settings

* refactor: webhooks update.

* refactor: kafka update.

* Simplify the Docker Compose configuration, remove unnecessary environment variables, and eliminate the gateway service.

* refactor: kafka update.

* refactor: kafka update.

* Simplify the Docker Compose configuration, remove unnecessary environment variables, and eliminate the gateway service.

* Simplify the Docker Compose configuration, remove unnecessary environment variables, and eliminate the gateway service.

* Windows can compile and run.

* Windows can compile and run.

* refactor: kafka update.

* feat: msg cache split

* refactor: webhooks update

* refactor: webhooks update

* refactor: friends update

* refactor: group update

* refactor: third update

* refactor: api update

* refactor: crontab update

* refactor: msggateway update

* mage

* mage

* refactor: all module update.

* check

* refactor: all module update.

* load config

* load config

* load config

* load config

* refactor: all module update.

* refactor: all module update.

* refactor: all module update.

* refactor: all module update.

* refactor: all module update.

* Optimize Docker configuration and script.

* refactor: all module update.

* Optimize Docker configuration and script.

* Optimize Docker configuration and script.

* Optimize Docker configuration and script.

* refactor: all module update.

* Optimize Docker configuration and script.

* refactor: all module update.

* refactor: all module update.

* Optimize Docker configuration and script.

* Optimize Docker configuration and script.

* Optimize Docker configuration and script.

* Optimize Docker configuration and script.

* Optimize Docker configuration and script.

* Optimize Docker configuration and script.

* update tools

* update tools

* Optimize Docker configuration and script.

* Optimize Docker configuration and script.

* Optimize Docker configuration and script.

* Optimize Docker configuration and script.

* Optimize Docker configuration and script.

* Optimize Docker configuration and script.

* Optimize Docker configuration and script.

* Optimize Docker configuration and script.

* Optimize Docker configuration and script.

* Optimize Docker configuration and script.

* Optimize Docker configuration and script.

* update protocol

* Optimize Docker configuration and script.

* Optimize Docker configuration and script.

* refactor: all module update.

* Optimize Docker configuration and script.

* Optimize Docker configuration and script.

* Optimize Docker configuration and script.

* Optimize Docker configuration and script.

* refactor: api remove token auth by redis directly.

* Code Refactoring

* refactor: websocket auth change to call rpc of auth.

* refactor: kick online user and remove token change to call auth rpc.

* refactor: kick online user and remove token change to call auth rpc.

* refactor: remove msggateway redis.

* refactor: cmd update.

* refactor: cmd update.

* refactor: cmd update.

* refactor: cmd update.

* refactor: cmd update.

* refactor: cmd update.

* refactor: cmd update.

* refactor: cmd update.

* refactor: cmd update.

* refactor: cmd update.

* refactor: cmd update.

* refactor: cmd update.

* refactor: cmd update.

* refactor: cmd update.

* refactor: cmd update.

* refactor: cmd update.

* refactor: cmd update.

* refactor: cmd update.

* refactor: cmd update.

* refactor: cmd update.

* refactor: cmd update.

* refactor: cmd update.

* refactor: cmd update.

* refactor: cmd update.

* refactor: cmd update.

* refactor: cmd update.

* refactor webhook

* refactor: cmd update.

* refactor: cmd update.

* refactor: cmd update.

* refactor: cmd update.

* refactor webhook

* refactor: cmd update.

* refactor: cmd update.

* fix: runtime: goroutine stack exceeds

* refactor: cmd update.

* refactor notification

* refactor notification

* refactor

* refactor: cmd update.

* refactor: cmd update.

* refactor

* refactor

* refactor

* protojson

* protojson

* protojson

* go mod

* wrapperspb

* refactor: cmd update.

* refactor: cmd update.

* refactor: cmd update.

* refactor: context update.

* refactor: websocket update info.

* refactor: websocket update info.

* refactor: websocket update info.

* refactor: websocket update info.

* refactor: api name change.

* refactor: debug info.

* refactor: debug info.

* refactor: debug info.

* fix: update file

* refactor

* refactor

* refactor: debug info.

* refactor: debug info.

* refactor: debug info.

* refactor: debug info.

* refactor: debug info.

* refactor: debug info.

* fix: callback update.

* fix: callback update.

* refactor

* fix: update message.

* fix: msg cache timeout.

* refactor

* refactor

* fix: push update.

* fix: push update.

* fix: push update.

* fix: push update.

* fix: push update.

* fix: push update.

* refactor

* refactor

* fix: push update.

* fix: websocket handle error remove when upgrade error.

* fix: priority url

* fix: minio config

* refactor: add zk logger.

* refactor

* fix: minio config

* refactor

* refactor

* refactor

* refactor

* refactor: remove zk logger.

* refactor: update tools version.

* refactor

* refactor: update server version to 3.7.0.

* refactor

* refactor

* refactor

* refactor

* refactor

* refactor

* refactor

* refactor

* refactor

* refactor

* refactor

* refactor

* refactor

* refactor: zk log debug.

* refactor: zk log debug.

* refactor: zk log debug.

* refactor: zk log debug.

* refactor: zk log debug.

* refactor

* refactor

* refactor

* refactor: log level change.

* refactor: 3.7.0 code conventions.

---------

Co-authored-by: skiffer-git <44203734@qq.com>
Co-authored-by: withchao <993506633@qq.com>
2024-04-24 12:11:24 +08:00
..
templates refactor: 3.7.0 code conventions. (#2148) 2024-04-19 22:23:08 +08:00
README.md 3.6.1 code conventions (#2202) 2024-04-24 12:11:24 +08:00
README_zh_CN.md refactor: 3.7.0 code conventions. (#2148) 2024-04-19 22:23:08 +08:00
kafka.yml refactor: 3.7.0 code conventions. (#2148) 2024-04-19 22:23:08 +08:00
local-cache.yml refactor: 3.7.0 code conventions. (#2148) 2024-04-19 22:23:08 +08:00
log.yml refactor: 3.7.0 code conventions. (#2148) 2024-04-19 22:23:08 +08:00
minio.yml 3.6.1 code conventions (#2202) 2024-04-24 12:11:24 +08:00
mongodb.yml refactor: 3.7.0 code conventions. (#2148) 2024-04-19 22:23:08 +08:00
notification.yml refactor: 3.7.0 code conventions. (#2148) 2024-04-19 22:23:08 +08:00
openim-api.yml refactor: 3.7.0 code conventions. (#2148) 2024-04-19 22:23:08 +08:00
openim-crontask.yml refactor: 3.7.0 code conventions. (#2148) 2024-04-19 22:23:08 +08:00
openim-msggateway.yml refactor: 3.7.0 code conventions. (#2148) 2024-04-19 22:23:08 +08:00
openim-msgtransfer.yml refactor: 3.7.0 code conventions. (#2148) 2024-04-19 22:23:08 +08:00
openim-push.yml refactor: 3.7.0 code conventions. (#2148) 2024-04-19 22:23:08 +08:00
openim-rpc-auth.yml refactor: 3.7.0 code conventions. (#2148) 2024-04-19 22:23:08 +08:00
openim-rpc-conversation.yml refactor: 3.7.0 code conventions. (#2148) 2024-04-19 22:23:08 +08:00
openim-rpc-friend.yml refactor: 3.7.0 code conventions. (#2148) 2024-04-19 22:23:08 +08:00
openim-rpc-group.yml refactor: 3.7.0 code conventions. (#2148) 2024-04-19 22:23:08 +08:00
openim-rpc-msg.yml refactor: 3.7.0 code conventions. (#2148) 2024-04-19 22:23:08 +08:00
openim-rpc-third.yml refactor: 3.7.0 code conventions. (#2148) 2024-04-19 22:23:08 +08:00
openim-rpc-user.yml refactor: 3.7.0 code conventions. (#2148) 2024-04-19 22:23:08 +08:00
redis.yml refactor: 3.7.0 code conventions. (#2148) 2024-04-19 22:23:08 +08:00
share.yml refactor: 3.7.0 code conventions. (#2148) 2024-04-19 22:23:08 +08:00
webhooks.yml refactor: 3.7.0 code conventions. (#2148) 2024-04-19 22:23:08 +08:00
zookeeper.yml refactor: 3.7.0 code conventions. (#2148) 2024-04-19 22:23:08 +08:00

README.md

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