From d7112921a6a177d9f7056d74e26f2b1ed76bd84f Mon Sep 17 00:00:00 2001 From: Thales Macedo Garitezi Date: Fri, 19 Jul 2024 12:26:23 -0300 Subject: [PATCH] docs: remove `enable` from config examples Fixes https://emqx.atlassian.net/browse/EMQX-12730 --- .../file_transfer-with-local-exporter.conf.example | 3 --- .../ee-examples/file_transfer-with-s3-exporter.conf.example | 5 ----- rel/config/examples/delayed.conf.example | 2 -- rel/config/examples/exhook.conf.example | 3 --- rel/config/examples/flapping_detect.conf.example | 3 --- rel/config/examples/force_gc.conf.example | 3 --- rel/config/examples/force_shutdown.conf.example | 3 --- rel/config/examples/gateway.exproto.conf.example | 1 - rel/config/examples/listeners.ssl.conf.example | 1 - rel/config/examples/listeners.ws.conf.example | 1 - rel/config/examples/listeners.wss.conf.example | 1 - rel/config/examples/log.console.conf.example | 3 --- rel/config/examples/log.file.conf.example | 3 --- rel/config/examples/plugins.conf.example | 4 +--- rel/config/examples/prometheus-pushgateway.conf.example | 3 --- rel/config/examples/prometheus.conf.example | 1 - rel/config/examples/psk_authentication.conf.example | 3 --- rel/config/examples/retainer.conf.example | 3 --- 18 files changed, 1 insertion(+), 45 deletions(-) diff --git a/rel/config/ee-examples/file_transfer-with-local-exporter.conf.example b/rel/config/ee-examples/file_transfer-with-local-exporter.conf.example index dcb1e88d1..4eeef33c7 100644 --- a/rel/config/ee-examples/file_transfer-with-local-exporter.conf.example +++ b/rel/config/ee-examples/file_transfer-with-local-exporter.conf.example @@ -3,9 +3,6 @@ ## NOTE: This configuration is only applicable in EMQX Enterprise edition 5.1 or later. file_transfer { - ## Enable the File Transfer feature - enable = true - ## Storage backend settings storage { ## Local file system backend setting diff --git a/rel/config/ee-examples/file_transfer-with-s3-exporter.conf.example b/rel/config/ee-examples/file_transfer-with-s3-exporter.conf.example index 94061223e..7a738c097 100644 --- a/rel/config/ee-examples/file_transfer-with-s3-exporter.conf.example +++ b/rel/config/ee-examples/file_transfer-with-s3-exporter.conf.example @@ -4,9 +4,6 @@ ## Note: This configuration is only applicable for EMQX Enterprise edition 5.1 or later. file_transfer { - ## Enable the File Transfer feature - enable = true - ## Storage backend settings storage { ## Local file system backend setting @@ -51,8 +48,6 @@ file_transfer { ## Enable the HTTPS transport_options { - ssl.enable = true - ## Timeout for connection attempts connect_timeout = 15s } diff --git a/rel/config/examples/delayed.conf.example b/rel/config/examples/delayed.conf.example index 7b0d243c2..b5b2c2c08 100644 --- a/rel/config/examples/delayed.conf.example +++ b/rel/config/examples/delayed.conf.example @@ -7,8 +7,6 @@ ## you should copy and paste the below data into the emqx.conf for working delayed { - enable = true ## false for disabled - ## Maximum number of delayed messages ## Default: 0 (0 is no limit) max_delayed_messages = 0 diff --git a/rel/config/examples/exhook.conf.example b/rel/config/examples/exhook.conf.example index cf9fffc71..45a186586 100644 --- a/rel/config/examples/exhook.conf.example +++ b/rel/config/examples/exhook.conf.example @@ -7,9 +7,6 @@ exhook.servers = [ ## Name of the exhook server name = "server_1" - ## Feature switch - enable = false - ## URL of gRPC server url = "http://127.0.0.1:9090" diff --git a/rel/config/examples/flapping_detect.conf.example b/rel/config/examples/flapping_detect.conf.example index fe4522b1e..6878d1f41 100644 --- a/rel/config/examples/flapping_detect.conf.example +++ b/rel/config/examples/flapping_detect.conf.example @@ -3,9 +3,6 @@ ## Ban the client when the times of connections exceed the limit in the configured time window flapping_detect { - ## use 'true' to enable this feature - enable = false - ## Time window for flapping detection window_time = 1m diff --git a/rel/config/examples/force_gc.conf.example b/rel/config/examples/force_gc.conf.example index ee07ee4d2..08543b533 100644 --- a/rel/config/examples/force_gc.conf.example +++ b/rel/config/examples/force_gc.conf.example @@ -1,9 +1,6 @@ ## Force Elrang VM garbage collection force_gc { - ## set 'false' to disable this feature - enable = true - ## GC the process after this many received messages count = 16000 diff --git a/rel/config/examples/force_shutdown.conf.example b/rel/config/examples/force_shutdown.conf.example index d0a466aa0..1dd6747a8 100644 --- a/rel/config/examples/force_shutdown.conf.example +++ b/rel/config/examples/force_shutdown.conf.example @@ -3,9 +3,6 @@ ## Forced shutdown MQTT clients for overload protection force_shutdown { - ## set 'false' to disable force shutdown feature - enable = true - ## Maximum mailbox size for each Erlang process ## Note: Do not modify this unless you know what this is for max_mailbox_size = 1000 diff --git a/rel/config/examples/gateway.exproto.conf.example b/rel/config/examples/gateway.exproto.conf.example index fcedb944b..303bd2872 100644 --- a/rel/config/examples/gateway.exproto.conf.example +++ b/rel/config/examples/gateway.exproto.conf.example @@ -16,7 +16,6 @@ gateway.exproto { ## Configurations for request to ConnectionHandler service handler { address = "http://127.0.0.1:9001" - ssl_options {enable = false} } listeners.tcp.default { diff --git a/rel/config/examples/listeners.ssl.conf.example b/rel/config/examples/listeners.ssl.conf.example index 4a74f1a27..ffc79db54 100644 --- a/rel/config/examples/listeners.ssl.conf.example +++ b/rel/config/examples/listeners.ssl.conf.example @@ -3,7 +3,6 @@ listeners.ssl.my_ssl_listener_name { ## Port or Address to listen on, 0 means disable bind = 8883 ## or with an IP e.g. "127.0.0.1:8883" - enabled = true acceptors = 16 enable_authn = true max_connections = infinity diff --git a/rel/config/examples/listeners.ws.conf.example b/rel/config/examples/listeners.ws.conf.example index f6a6adae8..f8c07e84a 100644 --- a/rel/config/examples/listeners.ws.conf.example +++ b/rel/config/examples/listeners.ws.conf.example @@ -3,7 +3,6 @@ listeners.ws.my_ws_listener_name { ## Port or Address to listen on, 0 means disable bind = "0.0.0.0:8083" # or just a port number, e.g. 8083 - enabled = true enable_authn = true max_connections = infinity proxy_protocol = false diff --git a/rel/config/examples/listeners.wss.conf.example b/rel/config/examples/listeners.wss.conf.example index cbc632e30..d0a03b777 100644 --- a/rel/config/examples/listeners.wss.conf.example +++ b/rel/config/examples/listeners.wss.conf.example @@ -3,7 +3,6 @@ listeners.wss.my_wss_listener_name = { ## Port or Address to listen on, 0 means disable bind = 8084 ## or with an IP, e.g. "127.0.0.1:8084" - enabled = true enable_authn = true max_connections = infinity proxy_protocol = false diff --git a/rel/config/examples/log.console.conf.example b/rel/config/examples/log.console.conf.example index 9bb01b0d9..3b8a0436e 100644 --- a/rel/config/examples/log.console.conf.example +++ b/rel/config/examples/log.console.conf.example @@ -1,9 +1,6 @@ ## Log to console log.console { - ## set true to enable this - enable = false - ## Log level ## Type: debug | info | notice | warning | error | critical | alert | emergency level = warning diff --git a/rel/config/examples/log.file.conf.example b/rel/config/examples/log.file.conf.example index e6f408f61..f6dce6eaf 100644 --- a/rel/config/examples/log.file.conf.example +++ b/rel/config/examples/log.file.conf.example @@ -1,9 +1,6 @@ ## Log to file log.file { - ## Enable file log handler - enable = true - ## Log level ## Type: debug | info | notice | warning | error | critical | alert | emergency level = warning diff --git a/rel/config/examples/plugins.conf.example b/rel/config/examples/plugins.conf.example index 6fcc09cbb..9388f4f24 100644 --- a/rel/config/examples/plugins.conf.example +++ b/rel/config/examples/plugins.conf.example @@ -9,10 +9,8 @@ plugins { ## Format: {name}-{version} ## Note: name and version should be what it is in the plugin application name_vsn = "my_acl-0.1.0", - - enable = true ## enable this plugin }, - {name_vsn = "my_rule-0.1.1", enable = false} + {name_vsn = "my_rule-0.1.1"} ] ## The installation directory for the external plugins diff --git a/rel/config/examples/prometheus-pushgateway.conf.example b/rel/config/examples/prometheus-pushgateway.conf.example index 70b74794a..f463056e3 100644 --- a/rel/config/examples/prometheus-pushgateway.conf.example +++ b/rel/config/examples/prometheus-pushgateway.conf.example @@ -5,9 +5,6 @@ ## If you want to use push-gateway prometheus { - ## Set to true to make EMQX send metrics to push-gateway - enable = false - ## URL of push-gateway server push_gateway_server = "http://127.0.0.1:9091" diff --git a/rel/config/examples/prometheus.conf.example b/rel/config/examples/prometheus.conf.example index 049b11ee3..e31d0fe1d 100644 --- a/rel/config/examples/prometheus.conf.example +++ b/rel/config/examples/prometheus.conf.example @@ -7,7 +7,6 @@ prometheus { enable_basic_auth = false push_gateway { - enable = false url = "http://127.0.0.1:9091" headers {Authorization = "Basic YWRtaW46Y2JraG55eWd5QDE="} interval = 15s diff --git a/rel/config/examples/psk_authentication.conf.example b/rel/config/examples/psk_authentication.conf.example index 6c3482638..cea6f21c2 100644 --- a/rel/config/examples/psk_authentication.conf.example +++ b/rel/config/examples/psk_authentication.conf.example @@ -1,9 +1,6 @@ ## Pre-Shared Keys authentication psk_authentication { - ## Set to false to disable - enable = true - ## If init_file is specified, EMQX will import PSKs from the file into the built-in database at startup for use by the runtime init_file = "psk" diff --git a/rel/config/examples/retainer.conf.example b/rel/config/examples/retainer.conf.example index d78119ec2..b698020d4 100644 --- a/rel/config/examples/retainer.conf.example +++ b/rel/config/examples/retainer.conf.example @@ -5,9 +5,6 @@ ##-------------------------------------------------------------------- retainer { - ## set to false to disable retainer - enable = true - ## Message retention time, default is 0 means the message will never expire msg_expiry_interval = 5s