chore: update examples to new version and fix errors

examples/alarm.conf.example

@@ -11,7 +11,7 @@ alarm {
     ## Type: Array of the below enum
     ##   - log :: write the alarm to log
     ##   - publish :: publish the alarm as an MQTT message to the system topics
-    actions = [log]
+    actions = [log, publish]
 
     ## Maximum total number of deactivated alarms to keep as history
     ## Type: Range from 1 to 3000

examples/broker.conf.example

@@ -1,30 +0,0 @@
-##--------------------------------------------------------------------
-## Broker
-##
-## Message broker options
-##--------------------------------------------------------------------
-## Note: This is an example of how to configure this feature
-##       you should copy and paste the below data into the emqx.conf for working
-
-## Note: If you and finding how to configure EMQX itself, have a look at the node.conf.example
-
-broker {
-    ## Session locking strategy in a cluster
-    ## Type:
-    ##   - local :: only lock the session on the current node
-    ##   - leader :: select only one remote node to lock the session
-    ##   - quorum :: select some nodes to lock the session
-    ##   - all :: lock the session on all the nodes in the cluster
-    session_locking_strategy = quorum
-
-    ## Dispatch strategy for shared subscription
-    ## Type:
-    ##   - random :: dispatch the message to a random selected subscriber
-    ##   - round_robin :: select the subscribers in a round-robin manner
-    ##   - round_robin_per_group :: select the subscribers in round-robin fashion within each shared subscriber group
-    ##   - local :: select random local subscriber otherwise select random cluster-wide
-    ##   - sticky :: always use the last selected subscriber to dispatch, until the subscriber disconnects.
-    ##   - hash_clientid :: select the subscribers by hashing the `clientIds`
-    ##   - hash_topic :: select the subscribers by hashing the source topic"""
-    shared_subscription_strategy = round_robin
- }

examples/cluster-with-dns.conf.example

@@ -14,7 +14,7 @@ cluster {
     discovery_strategy = dns
 
     ## List of core nodes that the replicant will connect to
-    core_nodes = ['emqx1@192.168.0.1', 'emqx2@192.168.0.2']
+    core_nodes = ["emqx1@192.168.0.1", "emqx2@192.168.0.2"]
 
     ## Remove disconnected nodes from the cluster after this interval
     autoclean = 5m

examples/cluster-with-etcd-ssl.conf.example

@@ -14,7 +14,7 @@ cluster {
     discovery_strategy = etcd
 
     ## List of core nodes that the replicant will connect to
-    core_nodes = ['emqx1@192.168.0.1', 'emqx2@192.168.0.2']
+    core_nodes = ["emqx1@192.168.0.1", "emqx2@192.168.0.2"]
 
     ## Remove disconnected nodes from the cluster after this interval
     autoclean = 5m

examples/cluster-with-etcd.conf.example

@@ -14,7 +14,7 @@ cluster {
     discovery_strategy = etcd
 
     ## List of core nodes that the replicant will connect to
-    core_nodes = ['emqx1@192.168.0.1', 'emqx2@192.168.0.2']
+    core_nodes = ["emqx1@192.168.0.1", "emqx2@192.168.0.2"]
 
     ## Remove disconnected nodes from the cluster after this interval
     autoclean = 5m

examples/cluster-with-k8s.conf.example

@@ -14,7 +14,7 @@ cluster {
     discovery_strategy = k8s
 
     ## List of core nodes that the replicant will connect to
-    core_nodes = ['emqx1@192.168.0.1', 'emqx2@192.168.0.2']
+    core_nodes = ["emqx1@192.168.0.1", "emqx2@192.168.0.2"]
 
     ## Remove disconnected nodes from the cluster after this interval
     autoclean = 5m
@@ -24,7 +24,7 @@ cluster {
 
     k8s {
       ## Kubernetes API endpoint URL
-      apiserver = "http://10.110.111.204:8080"
+      apiserver = "https://kubernetes.default.svc:443"
 
       ## EMQX broker service name
       service_name = emqx

examples/cluster-with-manual.conf.example

@@ -14,7 +14,7 @@ cluster {
     discovery_strategy = manual
 
     ## List of core nodes that the replicant will connect to
-    core_nodes = ['emqx1@192.168.0.1', 'emqx2@192.168.0.2']
+    core_nodes = ["emqx1@192.168.0.1", "emqx2@192.168.0.2"]
 
     ## Remove disconnected nodes from the cluster after this interval
     autoclean = 5m

examples/cluster-with-static.conf.example

@@ -14,7 +14,7 @@ cluster {
     discovery_strategy = static
 
     ## List of core nodes that the replicant will connect to
-    core_nodes = ['emqx1@192.168.0.1', 'emqx2@192.168.0.2']
+    core_nodes = ["emqx1@192.168.0.1", "emqx2@192.168.0.2"]
 
     ## Remove disconnected nodes from the cluster after this interval
     autoclean = 5m
@@ -23,5 +23,5 @@ cluster {
     autoheal = true
 
     ## List EMQX node names in the static cluster
-    static.seeds = ['emqx1@192.168.0.1', 'emqx2@192.168.0.2']
+    static.seeds = ["emqx1@192.168.0.1", "emqx2@192.168.0.2"]
  }

examples/dashboard-with-http.conf.example

@@ -14,10 +14,7 @@ dashboard {
     cors = false
 
     listeners.http {
-        ## Whether to enable the listener
-        enable = true
-
-        ## Port or Address to listen on
+        ## Port or Address to listen on, 0 means disable
         bind = "0.0.0.0:18083" ## or just a port number, e.g. 18083
 
         ## Socket acceptor pool size for TCP protocols

examples/dashboard-with-https.conf.example

@@ -14,10 +14,8 @@ dashboard {
     cors = false
 
     listeners.https {
-        ## Whether to enable the listener
-        enable = true
 
-        ## Port or Address to listen on
+        ## Port or Address to listen on, 0 means disable
         bind = "0.0.0.0:18084" ## or just a port number, e.g. 18084
 
         ## Socket acceptor pool size for TCP protocols

examples/listeners.quic.conf.example

@@ -8,10 +8,7 @@
 
 ## Note: Modifying the 'quicname' to what you need
 listeners.quic.quicname {
-    ## Whether to enable the listener
-    enable = true
-
-    ## Port or Address to listen on
+    ## Port or Address to listen on, 0 means disable
     bind = 14567 ## or with an IP, e.g. "127.0.0.1:14567"
 
     ## When publishing or subscribing, prefix all topics with a mountpoint string
@@ -31,6 +28,10 @@ listeners.quic.quicname {
     ## Type: infinity | Integer
     max_connections = infinity
 
+    ## TLS cipher suite names
+    ciphers = ["TLS_AES_256_GCM_SHA384", "TLS_AES_128_GCM_SHA256", "TLS_CHACHA20_POLY1305_SHA256"]
+
+    ssl_options {
         ## Trusted PEM format CA certificates bundle file
         cacertfile = "data/certs/cacert.pem"
 
@@ -42,7 +43,5 @@ listeners.quic.quicname {
 
         ## Enable or disable peer verification
         verify = verify_none ## to verify_peer to enable
-
-    ## TLS cipher suite names
-    ciphers = ["TLS_AES_256_GCM_SHA384", "TLS_AES_128_GCM_SHA256", "TLS_CHACHA20_POLY1305_SHA256"]
+    }
 }

examples/listeners.ssl.conf.example

@@ -11,12 +11,10 @@
 
 ## Note: Modifying the 'sslname' to what you need
 listeners.ssl.sslname {
-    ## Whether to enable the listener
-    enable = true
-
-    ## Port or Address to listen on
+    ## Port or Address to listen on, 0 means disable
     bind = 8883 ## or with an IP e.g. "127.0.0.1:8883"
 
+    ssl_options {
         ## Trusted PEM format CA certificates bundle file
         cacertfile = "data/certs/cacert.pem"
 
@@ -63,4 +61,5 @@ listeners.ssl.sslname {
 
         ## Maximum time duration allowed for the handshake to complete
         handshake_timeout = 15s
+    }
 }

examples/listeners.tcp.conf.example

@@ -8,10 +8,7 @@
 
 ## Note: Modifying the 'tcpname' to what you need
 listeners.tcp.tcpname {
-    ## false to disable this
-    enable = true
-
-    ## Port or Address to listen on
+    ## Port or Address to listen on, 0 means disable
     bind = 1883 ## or with an IP e.g. "127.0.0.1:1883"
 
     ## Enable the Proxy Protocol V1/2 if the EMQX cluster is deployed behind HAProxy or Nginx
@@ -41,6 +38,7 @@ listeners.tcp.tcpname {
     ## Type: infinity | Integer
     max_connections = infinity
 
+    tcp_options {
         ## TCP backlog defines the maximum length that the queue of pending connections can grow to
         backlog = 1024
 
@@ -75,4 +73,5 @@ listeners.tcp.tcpname {
         ##    - Probes: The maximum number of TCP keep-alive probes to send before giving up and killing the connection if no response is obtained from the other end (Linux default 9).
         ## For example "240,30,5" means: EMQX should start sending TCP keepalive probes after the connection is in idle for 240 seconds, and the probes are sent every 30 seconds until a response is received from the MQTT client, if it misses 5 consecutive responses, EMQX should close the connection
         keepalive = "none"
+    }
 }

examples/listeners.ws.conf.example

@@ -11,12 +11,10 @@
 
 ## Note: Modifying the 'wsname' to what you need
 listeners.ws.wsname {
-    ## for to disable this
-    enable = true
-
-    ## Port or Address to listen on
+    ## Port or Address to listen on, 0 means disable
     bind = "0.0.0.0:8083" # or just a port number, e.g. 8083
 
+    websocket {
         ## WebSocket's MQTT protocol path
         ## Type: String
         ##   For Example:
@@ -41,7 +39,6 @@ listeners.ws.wsname {
         fail_if_no_subprotocol = true
 
         ## Comma-separated list of supported subprotocols
-    ## Type: Comma Separated List
         supported_subprotocols = "mqtt, mqtt-v3, mqtt-v3.1.1, mqtt-v5"
 
         ## If true, origin HTTP header will be validated against the list of allowed origins configured in check_origins parameter
@@ -51,7 +48,6 @@ listeners.ws.wsname {
         allow_origin_absence = true
 
         ## List of allowed origins
-    ## Type: Comma Separated List
         check_origins = "http://localhost:18083, http://127.0.0.1:18083"
 
         ## HTTP header used to pass information about the client IP address
@@ -59,4 +55,5 @@ listeners.ws.wsname {
 
         ## The maximum length of a single MQTT packet
         proxy_port_header = "x-forwarded-port"
+    }
 }

examples/listeners.wss.conf.example

@@ -11,13 +11,13 @@
 
 ## Note: Modifying the 'wssname' to what you need
 listeners.wss.wssname {
-    ## false to disable this
-    enable = true
-
-    ## Port or Address to listen on
-    ## Default: 8084
+    ## Port or Address to listen on, 0 means disable
     bind = 8084 ## or with an IP, e.g. "127.0.0.1:8084"
 
+    ssl_options {
+        ## Trusted PEM format CA certificates bundle file
+        cacertfile = "data/certs/cacert.pem"
+
         ## PEM format certificates chain file
         certfile = "data/certs/cert.pem"
 
@@ -61,4 +61,5 @@ listeners.wss.wssname {
 
         ## Maximum time duration allowed for the handshake to complete
         handshake_timeout = 15s
+    }
 }

examples/mqtt.conf.example

@@ -110,4 +110,15 @@ mqtt {
     ## Use the CN, DN field in the peer certificate or the entire certificate content as Client ID
     ## Type: See the above
     peer_cert_as_clientid = disabled
+
+    ## Dispatch strategy for shared subscription
+    ## Type:
+    ##   - random :: dispatch the message to a random selected subscriber
+    ##   - round_robin :: select the subscribers in a round-robin manner
+    ##   - round_robin_per_group :: select the subscribers in round-robin fashion within each shared subscriber group
+    ##   - local :: select random local subscriber otherwise select random cluster-wide
+    ##   - sticky :: always use the last selected subscriber to dispatch, until the subscriber disconnects.
+    ##   - hash_clientid :: select the subscribers by hashing the `clientIds`
+    ##   - hash_topic :: select the subscribers by hashing the source topic"""
+    shared_subscription_strategy = round_robin
  }

examples/rpc-with-ssl.conf.example

@@ -1,76 +0,0 @@
-##--------------------------------------------------------------------
-## RPC With SSL
-## See rpc-with-tcp.conf.example for RPC with TCP
-## EMQX inter-broker communication
-##--------------------------------------------------------------------
-## Note: This is an example of how to configure this feature
-##       you should copy and paste the below data into the emqx.conf for working
-
-## Note: Most of the time the default config should work
-##   you do not need to modify it unless you know what it is for
-rpc {
-    ## Communication mode
-    ## Type: async | sync
-    mode = async
-
-    ## Transport protocol used for inter-broker communication
-    ## Type: tcp | ssl
-    protocol = ssl
-
-    ## The maximum number of batch messages sent in asynchronous mode
-    ## Type: Integer
-    async_batch_size = 256
-
-    ## Port discovery strategy
-    ## Type:
-    ##   - manual :: discover ports by tcp_server_port
-    ##   - stateless :: discover ports in a stateless manner, using the following algorithm:
-    ##       If node name is emqxN@127.0.0.1, where the N is an integer, then the listening port will be 5370 + N
-    port_discovery = stateless
-
-    ## Listening port used by RPC local service
-    ssl_server_port = 5369
-
-    ## Set the maximum number of RPC communication channels initiated by this node to each remote node
-    ## Type: Range from 1 to 256
-    tcp_client_num = 10
-
-    ## Timeout for establishing an RPC connection
-    connect_timeout = 5s
-
-    ## Path to TLS certificate file used to validate identity of the cluster nodes
-    certfile = "data/cert.pem"
-
-    ## Path to the private key file
-    keyfile = "data/key.pem"
-
-    ## Path to certification authority TLS certificate file
-    cacertfile = "data/cacert.pem"
-
-    ## Timeout for sending the RPC request
-    send_timeout = 5s
-
-    ## Timeout for the remote node authentication
-    authentication_timeout = 5s
-
-    ## Timeout for the reply to a synchronous RPC
-    call_receive_timeout = 15s
-
-    ## How long the connections between the brokers should remain open after the last message is sent
-    socket_keepalive_idle = 15m
-
-    ## The interval between keepalive messages
-    socket_keepalive_interval = 75s
-
-    ## How many times the keepalive probe message can fail to receive a reply until the RPC connection is considered lost
-    socket_keepalive_count = 9
-
-    ## TCP sending buffer size
-    socket_sndbuf = 1MB
-
-    ## TCP receiving buffer size
-    socket_recbuf = 1MB
-
-    ## Socket buffer size in user mode
-    socket_buffer = 1MB
-}

examples/rpc-with-tcp.conf.example

@@ -1,67 +0,0 @@
-##--------------------------------------------------------------------
-## RPC With TCP
-## See rpc-with-ssl.conf.example for RPC with SSL
-## EMQX inter-broker communication
-##--------------------------------------------------------------------
-## Note: This is an example of how to configure this feature
-##       you should copy and paste the below data into the emqx.conf for working
-
-## Note: Most of the time the default config should work
-##   you do not need to modify it unless you know what it is for
-rpc {
-    ## Communication mode
-    ## Type: sync | async
-    mode = async
-
-    ## Transport protocol used for inter-broker communication
-    ## Type: tcp | ssl
-    protocol = tcp
-
-    ## The maximum number of batch messages sent in asynchronous mode
-    ## Type: Integer
-    async_batch_size = 256
-
-    ## Port discovery strategy
-    ## Type:
-    ##   - manual :: discover ports by tcp_server_port
-    ##   - stateless :: discover ports in a stateless manner, using the following algorithm:
-    ##       If node name is emqxN@127.0.0.1, where the N is an integer, then the listening port will be 5370 + N
-    port_discovery = stateless
-
-    ## Listening port used by RPC local service
-    tcp_server_port = 5369
-
-    ## Set the maximum number of RPC communication channels initiated by this node to each remote node
-    ## Type: Range from 1 to 256
-    tcp_client_num = 10
-
-    ## Timeout for establishing an RPC connection
-    connect_timeout = 5s
-
-    ## Timeout for sending the RPC request
-    send_timeout = 5s
-
-    ## Timeout for the remote node authentication
-    authentication_timeout = 5s
-
-    ## Timeout for the reply to a synchronous RPC
-    call_receive_timeout = 15s
-
-    ## How long the connections between the brokers should remain open after the last message is sent
-    socket_keepalive_idle = 15m
-
-    ## The interval between keepalive messages
-    socket_keepalive_interval = 75s
-
-    ## How many times the keepalive probe message can fail to receive a reply until the RPC connection is considered lost
-    socket_keepalive_count = 9
-
-    ## TCP sending buffer size
-    socket_sndbuf = 1MB
-
-    ## TCP receiving buffer size
-    socket_recbuf = 1MB
-
-    ## Socket buffer size in user mode
-    socket_buffer = 1MB
-}

rel/i18n/emqx_prometheus_schema.hocon

@@ -4,7 +4,7 @@ enable.desc:
 """Turn Prometheus data pushing on or off"""
 
 headers.desc:
-"""A HTTP Headers when pushing to Push Gateway.<br/>
+"""An HTTP Headers when pushing to Push Gateway.<br/>
 For example, <code> { Authorization = "some-authz-tokens"}</code>"""
 
 interval.desc: