firest 6fedd0328f fix(retainer): Fix missing changes in configuration %!s(int64=2) %!d(string=hai) anos
..
README.md e0d05a02ff refactor: refine examples %!s(int64=2) %!d(string=hai) anos
alarm.conf.example e0d05a02ff refactor: refine examples %!s(int64=2) %!d(string=hai) anos
cluster-with-dns.conf.example e0d05a02ff refactor: refine examples %!s(int64=2) %!d(string=hai) anos
cluster-with-etcd-ssl.conf.example e0d05a02ff refactor: refine examples %!s(int64=2) %!d(string=hai) anos
cluster-with-etcd.conf.example e0d05a02ff refactor: refine examples %!s(int64=2) %!d(string=hai) anos
cluster-with-k8s.conf.example e0d05a02ff refactor: refine examples %!s(int64=2) %!d(string=hai) anos
cluster-with-manual.conf.example e0d05a02ff refactor: refine examples %!s(int64=2) %!d(string=hai) anos
cluster-with-static.conf.example e0d05a02ff refactor: refine examples %!s(int64=2) %!d(string=hai) anos
conn_congestion.conf.example 43705a54be docs: cosmetic changes in example config files %!s(int64=2) %!d(string=hai) anos
dashboard-with-http.conf.example e0d05a02ff refactor: refine examples %!s(int64=2) %!d(string=hai) anos
dashboard-with-https.conf.example e0d05a02ff refactor: refine examples %!s(int64=2) %!d(string=hai) anos
delayed.conf.example 49c4ea9ae9 refactor: mvoe config examples to 'rel/config' %!s(int64=2) %!d(string=hai) anos
exhook.conf.example e0d05a02ff refactor: refine examples %!s(int64=2) %!d(string=hai) anos
flapping_detect.conf.example e0d05a02ff refactor: refine examples %!s(int64=2) %!d(string=hai) anos
force_gc.conf.example e0d05a02ff refactor: refine examples %!s(int64=2) %!d(string=hai) anos
force_shutdown.conf.example e0d05a02ff refactor: refine examples %!s(int64=2) %!d(string=hai) anos
gateway.coap.conf.example 49c4ea9ae9 refactor: mvoe config examples to 'rel/config' %!s(int64=2) %!d(string=hai) anos
gateway.exproto.conf.example e0d05a02ff refactor: refine examples %!s(int64=2) %!d(string=hai) anos
gateway.lwm2m.conf.example e0d05a02ff refactor: refine examples %!s(int64=2) %!d(string=hai) anos
gateway.mqttsn.conf.example e0d05a02ff refactor: refine examples %!s(int64=2) %!d(string=hai) anos
gateway.stomp.conf.example e0d05a02ff refactor: refine examples %!s(int64=2) %!d(string=hai) anos
listeners.quic.conf.example e0d05a02ff refactor: refine examples %!s(int64=2) %!d(string=hai) anos
listeners.ssl.conf.example 0428d91aa4 fix(config-examples): fix bad configs %!s(int64=2) %!d(string=hai) anos
listeners.tcp.conf.example e0d05a02ff refactor: refine examples %!s(int64=2) %!d(string=hai) anos
listeners.ws.conf.example e0d05a02ff refactor: refine examples %!s(int64=2) %!d(string=hai) anos
listeners.wss.conf.example e0d05a02ff refactor: refine examples %!s(int64=2) %!d(string=hai) anos
log.console.conf.example e0d05a02ff refactor: refine examples %!s(int64=2) %!d(string=hai) anos
log.file.conf.example e0d05a02ff refactor: refine examples %!s(int64=2) %!d(string=hai) anos
mqtt.conf.example e0d05a02ff refactor: refine examples %!s(int64=2) %!d(string=hai) anos
node.conf.example 0428d91aa4 fix(config-examples): fix bad configs %!s(int64=2) %!d(string=hai) anos
plugins.conf.example 0428d91aa4 fix(config-examples): fix bad configs %!s(int64=2) %!d(string=hai) anos
prometheus-pushgateway.conf.example e0d05a02ff refactor: refine examples %!s(int64=2) %!d(string=hai) anos
prometheus.conf.example 43705a54be docs: cosmetic changes in example config files %!s(int64=2) %!d(string=hai) anos
psk_authentication.conf.example e0d05a02ff refactor: refine examples %!s(int64=2) %!d(string=hai) anos
retainer.conf.example 6fedd0328f fix(retainer): Fix missing changes in configuration %!s(int64=2) %!d(string=hai) anos
sys_topics.conf.example e0d05a02ff refactor: refine examples %!s(int64=2) %!d(string=hai) anos
sysmon.os.conf.example e0d05a02ff refactor: refine examples %!s(int64=2) %!d(string=hai) anos
sysmon.vm.conf.example e0d05a02ff refactor: refine examples %!s(int64=2) %!d(string=hai) anos

README.md

Examples

Here are examples of how to configure EMQX. The main purpose of the examples are to serve as a reference for configuration layout and syntax, but not a guide to how to configure EMQX. For more information about EMQX configuration, please refer to EMQX documentation (links below).

There are two ways to extend the configuration of EMQX:

  • By adding the configs to emqx.conf file.
  • By adding the configs to a new file and include it in emqx.conf file. For example, add include "mylisteners.conf" to emqx.conf file and add the listeners to mylisteners.conf.

EMQX configuration consists of two parts: static configs and dynamic configs.

  • Configs loaded from emqx.conf (and included files) are static configs.
  • Configs added or updated from the dashboard or CLI are dynamic configs which are synced to all nodes in the cluster and stored in the data directory on each node.

It is important to note that static configs are loaded when EMQX starts and overlays on top of the dynamic configs, to avoid confusion, it is highly recommended NOT to use the same config name for both static and dynamic configs.

Documentation

The EMQX documentation is available at www.emqx.io/docs/en/latest/.

The EMQX Enterprise documentation is available at docs.emqx.com/en/.