Merge remote-tracking branch 'refs/remotes/origin/main' into corn37

# Conflicts:
#	go.mod

config/kafka.yml

@@ -1,18 +1,36 @@
+# Username for authentication
 username: ''
+# Password for authentication
 password: ''
+# Producer acknowledgment settings
 producerAck: ""
+# Compression type to use (e.g., none, gzip, snappy)
 compressType: "none"
+# List of Kafka broker addresses
 address: [ localhost:19094 ]
+# Kafka topic for Redis integration
 toRedisTopic: "toRedis"
+# Kafka topic for MongoDB integration
 toMongoTopic: "toMongo"
+# Kafka topic for push notifications
 toPushTopic: "toPush"
+# Consumer group ID for Redis topic
 toRedisGroupID: redis
+# Consumer group ID for MongoDB topic
 toMongoGroupID: mongo
+# Consumer group ID for push notifications topic
 toPushGroupID: push
+# TLS (Transport Layer Security) configuration
 tls:
+  # Enable or disable TLS
   enableTLS: false
+  # CA certificate file path
   caCrt: ""
+  # Client certificate file path
   clientCrt: ""
+  # Client key file path
   clientKey: ""
+  # Client key password
   clientKeyPwd: ""
+  # Whether to skip TLS verification (not recommended for production)
   insecureSkipVerify: false

config/minio.yml

@@ -1,7 +1,16 @@
+# Name of the bucket in MinIO
 bucket: "openim"
+# Access key ID for MinIO authentication
 accessKeyID: "root"
+# Secret access key for MinIO authentication
 secretAccessKey: "openIM123"
+# Session token for MinIO authentication (optional)
 sessionToken: ''
-internalAddress: "minio:9000"
+# Internal address of the MinIO server
+internalAddress: "localhost:10005"
+# External address of the MinIO server, accessible from outside. Supports both HTTP and HTTPS using a domain name
 externalAddress: "http://external_ip:10005"
-publicRead: false
+# Flag to enable or disable public read access to the bucket
+publicRead: false
+
+

config/mongodb.yml

@@ -1,7 +1,14 @@
+# URI for database connection, leave empty if using address and credential settings directly
 uri: ''
+# List of MongoDB server addresses
 address: [ localhost:37017 ]
+# Name of the database
 database: openim_v3
+# Username for database authentication
 username: openIM
+# Password for database authentication
 password: openIM123
+# Maximum number of connections in the connection pool
 maxPoolSize: 100
-maxRetry: 10
+# Maximum number of retry attempts for a failed database connection
+maxRetry: 10

config/notification.yml

@@ -17,32 +17,23 @@
 # The options field 'isNotification' indicates if it's a notification.
 groupCreated:
   isSendMsg: true
-
 # Reliability level of the message sending.
 # Set to 1 to send only when online, 2 for guaranteed delivery.
   reliabilityLevel: 1
-
 # This setting is effective only when 'isSendMsg' is true.
 # It controls whether to count unread messages.
   unreadCount: false
-
 # Configuration for offline push notifications.
   offlinePush:
     # Enables or disables offline push notifications.
     enable: false
-
     # Title for the notification when a group is created.
     title: "create group title"
-
     # Description for the notification.
     desc: "create group desc"
-
     # Additional information for the notification.
     ext: "create group ext"
 
-# Content type is not added here.
-# Content should use a JSON structure conforming to the protobuf format.
-
 groupInfoSet:
   isSendMsg: false
   reliabilityLevel: 1

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,14 +1,20 @@
 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
-enable: getui
+#"Use geTui for offline push notifications, or choose fcm or jpns; corresponding configuration settings must be specified."
+enable: "geTui"
 geTui:
   pushUrl: "https://restapi.getui.com/v2/$appId"
   masterSecret: ''
@@ -24,6 +30,7 @@ jpns:
   pushURL: ''
   pushIntent: ''
 
+# iOS system push sound and badge count
 iosPush:
       pushSound: "xxx"
       badgeCount: true

config/openim-rpc-auth.yml

@@ -1,13 +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: [ 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:
-  #token有效期，单位（天）
+  # Token validity period, in days
   expire: 90
 

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,13 +1,19 @@
 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,13 +1,20 @@
 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:
+  # Use MinIO as object storage, or set to "cos", "oss", "kodo", "aws", while also configuring the corresponding settings
   enable: "minio"
   cos:
     bucketURL: https://temp-1252357374.cos.ap-chengdu.myqcloud.com