yuanbiao
/
emqx
1
0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

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

This commit is contained in:
zmstone 2024-05-29 15:35:33 +02:00
parent b232784df2
commit b457c2a49c
2 changed files with 8 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
rel/config/ee-examples/file_transfer-with-local-exporter.conf.example
View File

@ -11,8 +11,6 @@ file_transfer {
## Local file system backend setting ## Local file system backend setting
## Currently, it's the only available storage backend. ## Currently, it's the only available storage backend.
local { local {
## Enable the backend
enable = true
## Segments and temporary files storage settings ## Segments and temporary files storage settings
segments { segments {
@ -30,12 +28,11 @@ file_transfer {
} }
## Local filesystem exporter ## 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 { 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 ## Directory in the local file system where to store transferred files
root = "/var/lib/emqx/transfers/exports" root = "/var/lib/emqx/transfers/exports"
} }

10
rel/config/ee-examples/file_transfer-with-s3-exporter.conf.example
View File

@ -12,8 +12,6 @@ file_transfer {
## Local file system backend setting ## Local file system backend setting
## Currently, it's the only available storage backend. ## Currently, it's the only available storage backend.
local { local {
## Enable the backend
enable = true
## Segments and temporary files storage settings ## Segments and temporary files storage settings
segments { segments {
@ -31,12 +29,12 @@ file_transfer {
} }
## S3-compatible object storage exporter ## 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 { 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 ## Endpoint of S3 API of the object storage service of your choice
host = "s3.us-east-1.amazonaws.com" host = "s3.us-east-1.amazonaws.com"
port = 443 port = 443