openim-server/config
Monet Lee 80b332cb82
feat: implement log isSimpilfy. (#2436)
* feat: implement log isSimpilfy.

* update go mod.
2024-07-24 11:27:02 +00:00
..
grafana-template Feat metrics (#2429) 2024-07-19 08:08:39 +00: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
alertmanager.yml Feat metrics (#2429) 2024-07-19 08:08:39 +00:00
discovery.yml Etcd naming and discovery (#2300) 2024-05-14 10:21:36 +00:00
email.tmpl Fix search log (#2425) 2024-07-23 02:26:04 +00:00
instance-down-rules.yml Feat metrics (#2429) 2024-07-19 08:08:39 +00:00
kafka.yml update go.mod go.sum (#2210) 2024-04-24 15:42:43 +08:00
local-cache.yml refactor: 3.7.0 code conventions. (#2148) 2024-04-19 22:23:08 +08:00
log.yml feat: implement log isSimpilfy. (#2436) 2024-07-24 11:27:02 +00:00
minio.yml update go.mod go.sum (#2210) 2024-04-24 15:42:43 +08:00
mongodb.yml update go.mod go.sum (#2210) 2024-04-24 15:42:43 +08:00
notification.yml update go.mod go.sum (#2210) 2024-04-24 15:42:43 +08:00
openim-api.yml refactor: 3.7.0 code conventions. (#2148) 2024-04-19 22:23:08 +08:00
openim-crontask.yml feat: new features merged (#2409) 2024-07-16 02:46:21 +00:00
openim-msggateway.yml update go.mod go.sum (#2210) 2024-04-24 15:42:43 +08:00
openim-msgtransfer.yml update go.mod go.sum (#2210) 2024-04-24 15:42:43 +08:00
openim-push.yml Fix group and config (#2341) 2024-06-13 04:13:13 +00:00
openim-rpc-auth.yml update go.mod go.sum (#2210) 2024-04-24 15:42:43 +08:00
openim-rpc-conversation.yml update go.mod go.sum (#2210) 2024-04-24 15:42:43 +08:00
openim-rpc-friend.yml update go.mod go.sum (#2210) 2024-04-24 15:42:43 +08:00
openim-rpc-group.yml update go.mod go.sum (#2210) 2024-04-24 15:42:43 +08:00
openim-rpc-msg.yml update go.mod go.sum (#2210) 2024-04-24 15:42:43 +08:00
openim-rpc-third.yml feature: support for Kodo (#2363) 2024-07-15 03:10:04 +00:00
openim-rpc-user.yml refactor: 3.7.0 code conventions. (#2148) 2024-04-19 22:23:08 +08:00
prometheus.yml Feature domain (#2414) 2024-07-17 02:31:02 +00:00
redis.yml feat: support incremental synchronization (#2379) 2024-07-01 09:38:14 +00:00
share.yml Etcd naming and discovery (#2300) 2024-05-14 10:21:36 +00:00
webhooks.yml feature: add webhook AttentionIds (#2370) 2024-06-27 10:10:06 +00: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