Add comments to the configuration file

config/openim-msggateway.yml

@@ -1,19 +1,30 @@
 rpc:
+  # The IP address where this RPC service registers itself; if left blank, it defaults to the internal network IP
   registerIP: ''
+  # List of ports that the RPC service listens on; configuring multiple ports will launch multiple instances. These must match the number of configured prometheus ports
   ports: [ 10140 ]
 
 prometheus:
+  # Enable or disable Prometheus monitoring
   enable: true
+  # List of ports that Prometheus listens on; these must match the number of rpc.ports to ensure correct monitoring setup
   ports: [ 20112 ]
 
+# IP address that the RPC/WebSocket service listens on; setting to 0.0.0.0 listens on both internal and external IPs. If left blank, it automatically uses the internal network IP
 listenIP: 0.0.0.0
 
 longConnSvr:
+  # WebSocket listening ports, must match the number of rpc.ports
   ports: [ 10001 ]
+  # Maximum number of WebSocket connections
   websocketMaxConnNum: 100000
+  # Maximum length of the entire WebSocket message packet
   websocketMaxMsgLen: 4096
+  # WebSocket connection handshake timeout in seconds
   websocketTimeout: 10
 
+# 1: For Android, iOS, Windows, Mac, and web platforms, only one instance can be online at a time
 multiLoginPolicy: 1
 
 
+

config/openim-msgtransfer.yml

@@ -1,3 +1,6 @@
 prometheus:
+  # Enable or disable Prometheus monitoring
   enable: true
+  # List of ports that Prometheus listens on; each port corresponds to an instance of monitoring. Ensure these are managed accordingly
+  # Because four instances have been launched, four ports need to be specified
   ports: [ 20108, 20109, 20110, 20111 ]

config/openim-push.yml

@@ -1,10 +1,15 @@
 rpc:
+  # The IP address where this RPC service registers itself; if left blank, it defaults to the internal network IP
   registerIP: ''
+  # IP address that the RPC service listens on; setting to 0.0.0.0 listens on both internal and external IPs. If left blank, it automatically uses the internal network IP
   listenIP: 0.0.0.0
+  # List of ports that the RPC service listens on; configuring multiple ports will launch multiple instances. These must match the number of configured prometheus ports
   ports: [ 10170 ]
 
 prometheus:
+  # Enable or disable Prometheus monitoring
   enable: true
+  # List of ports that Prometheus listens on; these must match the number of rpc.ports to ensure correct monitoring setup
   ports: [ 20107 ]
 
 maxConcurrentWorkers: 3

config/openim-rpc-auth.yml

@@ -1,10 +1,15 @@
 rpc:
+  # The IP address where this RPC service registers itself; if left blank, it defaults to the internal network IP
   registerIP: ''
+  # IP address that the RPC service listens on; setting to 0.0.0.0 listens on both internal and external IPs. If left blank, it automatically uses the internal network IP
   listenIP: 0.0.0.0
+  # List of ports that the RPC service listens on; configuring multiple ports will launch multiple instances. These must match the number of configured prometheus ports
   ports: [ 10160 ]
 
 prometheus:
+  # Enable or disable Prometheus monitoring
   enable: true
+  # List of ports that Prometheus listens on; these must match the number of rpc.ports to ensure correct monitoring setup
   ports: [ 20106 ]
 
 tokenPolicy:

config/openim-rpc-conversation.yml

@@ -1,11 +1,13 @@
 rpc:
+  # The IP address where this RPC service registers itself; if left blank, it defaults to the internal network IP
   registerIP: ''
+  # IP address that the RPC service listens on; setting to 0.0.0.0 listens on both internal and external IPs. If left blank, it automatically uses the internal network IP
   listenIP: 0.0.0.0
+  # List of ports that the RPC service listens on; configuring multiple ports will launch multiple instances. These must match the number of configured prometheus ports
   ports: [ 10180 ]
 
 prometheus:
+  # Enable or disable Prometheus monitoring
   enable: true
+  # List of ports that Prometheus listens on; these must match the number of rpc.ports to ensure correct monitoring setup
   ports: [ 20105 ]
-
-
-

config/openim-rpc-friend.yml

@@ -1,8 +1,13 @@
 rpc:
+  # The IP address where this RPC service registers itself; if left blank, it defaults to the internal network IP
   registerIP: ''
+  # IP address that the RPC service listens on; setting to 0.0.0.0 listens on both internal and external IPs. If left blank, it automatically uses the internal network IP
   listenIP: 0.0.0.0
+  # List of ports that the RPC service listens on; configuring multiple ports will launch multiple instances. These must match the number of configured prometheus ports
   ports: [ 10120 ]
 
 prometheus:
+  # Enable or disable Prometheus monitoring
   enable: true
+  # List of ports that Prometheus listens on; these must match the number of rpc.ports to ensure correct monitoring setup
   ports: [ 20104 ]

config/openim-rpc-group.yml

@@ -1,9 +1,13 @@
 rpc:
+  # The IP address where this RPC service registers itself; if left blank, it defaults to the internal network IP
   registerIP: ''
+  # IP address that the RPC service listens on; setting to 0.0.0.0 listens on both internal and external IPs. If left blank, it automatically uses the internal network IP
   listenIP: 0.0.0.0
+  # List of ports that the RPC service listens on; configuring multiple ports will launch multiple instances. These must match the number of configured prometheus ports
   ports: [ 10150 ]
 
 prometheus:
+  # Enable or disable Prometheus monitoring
   enable: true
+  # List of ports that Prometheus listens on; these must match the number of rpc.ports to ensure correct monitoring setup
   ports: [ 20103 ]
-

config/openim-rpc-msg.yml

@@ -1,12 +1,18 @@
 rpc:
+  # The IP address where this RPC service registers itself; if left blank, it defaults to the internal network IP
   registerIP: ''
+  # IP address that the RPC service listens on; setting to 0.0.0.0 listens on both internal and external IPs. If left blank, it automatically uses the internal network IP
   listenIP: 0.0.0.0
+  # List of ports that the RPC service listens on; configuring multiple ports will launch multiple instances. These must match the number of configured prometheus ports
   ports: [ 10130 ]
 
 prometheus:
+  # Enable or disable Prometheus monitoring
   enable: true
+  # List of ports that Prometheus listens on; these must match the number of rpc.ports to ensure correct monitoring setup
   ports: [ 20102 ]
 
+
 # Does sending messages require friend verification
 friendVerify: false
 

config/openim-rpc-third.yml

@@ -1,12 +1,18 @@
 rpc:
+  # The IP address where this RPC service registers itself; if left blank, it defaults to the internal network IP
   registerIP: ''
+  # IP address that the RPC service listens on; setting to 0.0.0.0 listens on both internal and external IPs. If left blank, it automatically uses the internal network IP
   listenIP: 0.0.0.0
+  # List of ports that the RPC service listens on; configuring multiple ports will launch multiple instances. These must match the number of configured prometheus ports
   ports: [ 10190 ]
 
 prometheus:
+  # Enable or disable Prometheus monitoring
   enable: true
+  # List of ports that Prometheus listens on; these must match the number of rpc.ports to ensure correct monitoring setup
   ports: [ 20101 ]
 
+
 object:
   enable: "minio"
   cos: