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

---
 config/mongodb.yml                         | 9 ++++++++-
 config/notification.yml                    | 9 ---------
 config/openim-push.yml                     | 4 +++-
 config/openim-rpc-third.yml                | 1 +
 internal/push/offlinepush/offlinepusher.go | 2 +-
 5 files changed, 13 insertions(+), 12 deletions(-)

diff --git a/config/mongodb.yml b/config/mongodb.yml
index 12f1f66a55..98f5694e45 100644
--- a/config/mongodb.yml
+++ b/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
\ No newline at end of file
+# Maximum number of retry attempts for a failed database connection
+maxRetry: 10
diff --git a/config/notification.yml b/config/notification.yml
index 1afb44e467..278376c244 100644
--- a/config/notification.yml
+++ b/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
diff --git a/config/openim-push.yml b/config/openim-push.yml
index eabb3256c5..a1abfcf889 100644
--- a/config/openim-push.yml
+++ b/config/openim-push.yml
@@ -13,7 +13,8 @@ prometheus:
   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: ''
@@ -29,6 +30,7 @@ jpns:
   pushURL: ''
   pushIntent: ''
 
+# iOS system push sound and badge count
 iosPush:
       pushSound: "xxx"
       badgeCount: true
diff --git a/config/openim-rpc-third.yml b/config/openim-rpc-third.yml
index 83f8049a63..bb41c93aee 100644
--- a/config/openim-rpc-third.yml
+++ b/config/openim-rpc-third.yml
@@ -14,6 +14,7 @@ prometheus:
 
 
 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
diff --git a/internal/push/offlinepush/offlinepusher.go b/internal/push/offlinepush/offlinepusher.go
index 0706be64a4..d4fcae434a 100644
--- a/internal/push/offlinepush/offlinepusher.go
+++ b/internal/push/offlinepush/offlinepusher.go
@@ -26,7 +26,7 @@ import (
 )
 
 const (
-	geTUI    = "getui"
+	geTUI    = "geTui"
 	firebase = "fcm"
 	jPush    = "jpush"
 )