From 50e82de06f56c91628f61add21cb493330472924 Mon Sep 17 00:00:00 2001
From: skiffer-git <44203734@qq.com>
Date: Wed, 24 Apr 2024 16:15:18 +0800
Subject: [PATCH] Add comments to the configuration file

---
 config/redis.yml     | 9 ++++++++-
 config/share.yml     | 3 ++-
 config/webhooks.yml  | 4 ++++
 config/zookeeper.yml | 6 ++++--
 4 files changed, 18 insertions(+), 4 deletions(-)

diff --git a/config/redis.yml b/config/redis.yml
index 26becd887..27361ba92 100644
--- a/config/redis.yml
+++ b/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
-maxRetry: 10
\ No newline at end of file
+# Maximum number of retry attempts for a failed connection
+maxRetry: 10
diff --git a/config/share.yml b/config/share.yml
index 2abbb77a0..77d16ca49 100644
--- a/config/share.yml
+++ b/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" ]
 
diff --git a/config/webhooks.yml b/config/webhooks.yml
index c7839d4f2..068935b70 100644
--- a/config/webhooks.yml
+++ b/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
diff --git a/config/zookeeper.yml b/config/zookeeper.yml
index 33f52d7ca..7b7557c93 100644
--- a/config/zookeeper.yml
+++ b/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: ''
-