Add comments to the configuration file

config/redis.yml

@@ -1,7 +1,14 @@
+# List of Redis server addresses
 address: [ localhost:16379 ]
+# Username for Redis authentication (leave blank if not used)
 username: ''
+# Password for Redis authentication
 password: openIM123
+# Enable or disable pipeline processing
 enablePipeline: false
+# Enable or disable cluster mode
 clusterMode: false
+# Database index to be used
 db: 0
+# Maximum number of retry attempts for a failed connection
 maxRetry: 10

config/share.yml

@@ -1,3 +1,4 @@
+# Secret key used for verifying administrator identity, and for generating and validating tokens
 secret: openIM123
 env: zookeeper
 rpcRegisterName:
@@ -10,6 +11,6 @@ rpcRegisterName:
   auth: auth
   conversation: conversation
   third: third
-
+# Built-in administrator userID
 imAdminUserID: [ "imAdmin" ]
 

config/webhooks.yml

@@ -1,7 +1,11 @@
 url: "webhook://127.0.0.1:10008/callbackExample"
+# Webhook before sending a message
 beforeSendSingleMsg:
+  # Whether to enable
   enable: false
+  # Timeout duration in seconds
   timeout: 5
+  # Whether to continue on error
   failedContinue: true
 beforeUpdateUserInfoEx:
   enable:  false

config/zookeeper.yml

@@ -1,6 +1,8 @@
-
+# Database schema name
 schema: openim
+# List of server addresses
 address: [ localhost:12181 ]
+# Username for authentication (leave blank if not used)
 username: ''
+# Password for authentication (leave blank if not used)
 password: ''
-