Просмотр исходного кода

refactor: hide 'enable' config from doc when it's 'true' by default

zmstone 1 год назад
Родитель
Сommit
b457c2a49c

+ 4 - 7
rel/config/ee-examples/file_transfer-with-local-exporter.conf.example

@@ -11,8 +11,6 @@ file_transfer {
         ## Local file system backend setting
         ## Currently, it's the only available storage backend.
         local {
-            ## Enable the backend
-            enable = true
 
             ## Segments and temporary files storage settings
             segments {
@@ -30,12 +28,11 @@ file_transfer {
             }
 
             ## Local filesystem exporter
+            ## Enable the backend
+            ## Note: Can only configure one backend at a time
+            ## One can set 'exporter.local.enable=false' to disable it
+            ## while keeping the configuration context
             exporter.local {
-
-                ## Enable the backend
-                ## Note: Only one backend may be enabled at a time
-                enable = true
-
                 ## Directory in the local file system where to store transferred files
                 root = "/var/lib/emqx/transfers/exports"
             }

+ 4 - 6
rel/config/ee-examples/file_transfer-with-s3-exporter.conf.example

@@ -12,8 +12,6 @@ file_transfer {
         ## Local file system backend setting
         ## Currently, it's the only available storage backend.
         local {
-            ## Enable the backend
-            enable = true
 
             ## Segments and temporary files storage settings
             segments {
@@ -31,12 +29,12 @@ file_transfer {
             }
 
             ## S3-compatible object storage exporter
+            ## Enable the backend
+            ## Note: Can only configure one backend at a time
+            ## One can set 'exporter.s3.enable=false' to disable it
+            ## while keeping the configuration context
             exporter.s3 {
 
-                ## Disable the backend
-                ## Note: Only one backend may be enabled at a time.
-                enable = true
-
                 ## Endpoint of S3 API of the object storage service of your choice
                 host = "s3.us-east-1.amazonaws.com"
                 port = 443