zmstone fc041c064e docs: remove 0 means disalbe comment from example configs 1 anno fa
..
README.md e0d05a02ff refactor: refine examples 2 anni fa
alarm.conf.example e0d05a02ff refactor: refine examples 2 anni fa
cluster-with-dns.conf.example e0d05a02ff refactor: refine examples 2 anni fa
cluster-with-etcd-ssl.conf.example e0d05a02ff refactor: refine examples 2 anni fa
cluster-with-etcd.conf.example e0d05a02ff refactor: refine examples 2 anni fa
cluster-with-k8s.conf.example e0d05a02ff refactor: refine examples 2 anni fa
cluster-with-manual.conf.example e0d05a02ff refactor: refine examples 2 anni fa
cluster-with-static.conf.example e0d05a02ff refactor: refine examples 2 anni fa
conn_congestion.conf.example 43705a54be docs: cosmetic changes in example config files 2 anni fa
dashboard-with-http.conf.example fc041c064e docs: remove 0 means disalbe comment from example configs 1 anno fa
dashboard-with-https.conf.example fc041c064e docs: remove 0 means disalbe comment from example configs 1 anno fa
delayed.conf.example d7112921a6 docs: remove `enable` from config examples 1 anno fa
exhook.conf.example d7112921a6 docs: remove `enable` from config examples 1 anno fa
flapping_detect.conf.example d7112921a6 docs: remove `enable` from config examples 1 anno fa
force_gc.conf.example d7112921a6 docs: remove `enable` from config examples 1 anno fa
force_shutdown.conf.example d7112921a6 docs: remove `enable` from config examples 1 anno fa
gateway.coap.conf.example 49c4ea9ae9 refactor: mvoe config examples to 'rel/config' 2 anni fa
gateway.exproto.conf.example e0d05a02ff refactor: refine examples 2 anni fa
gateway.lwm2m.conf.example e0d05a02ff refactor: refine examples 2 anni fa
gateway.mqttsn.conf.example e0d05a02ff refactor: refine examples 2 anni fa
gateway.stomp.conf.example e0d05a02ff refactor: refine examples 2 anni fa
listeners.quic.conf.example fc041c064e docs: remove 0 means disalbe comment from example configs 1 anno fa
listeners.ssl.conf.example fc041c064e docs: remove 0 means disalbe comment from example configs 1 anno fa
listeners.tcp.conf.example fc041c064e docs: remove 0 means disalbe comment from example configs 1 anno fa
listeners.ws.conf.example fc041c064e docs: remove 0 means disalbe comment from example configs 1 anno fa
listeners.wss.conf.example fc041c064e docs: remove 0 means disalbe comment from example configs 1 anno fa
log.console.conf.example d7112921a6 docs: remove `enable` from config examples 1 anno fa
log.file.conf.example d7112921a6 docs: remove `enable` from config examples 1 anno fa
mqtt.conf.example 12da3c0986 feat: configurable server side message_expiry_interval 2 anni fa
node.conf.example 1beda1cd11 test(mria): Remove role from the example config 1 anno fa
plugins.conf.example b3074144cc chore: temporarily revert `NO_DOC` changes to fields with default value = false 1 anno fa
prometheus-pushgateway.conf.example d7112921a6 docs: remove `enable` from config examples 1 anno fa
prometheus.conf.example d7112921a6 docs: remove `enable` from config examples 1 anno fa
psk_authentication.conf.example d7112921a6 docs: remove `enable` from config examples 1 anno fa
rate_limit.conf.example 2a0f5f8ba5 chore: add rate limit example 2 anni fa
retainer.conf.example d7112921a6 docs: remove `enable` from config examples 1 anno fa
sys_topics.conf.example e0d05a02ff refactor: refine examples 2 anni fa
sysmon.os.conf.example e0d05a02ff refactor: refine examples 2 anni fa
sysmon.vm.conf.example e0d05a02ff refactor: refine examples 2 anni fa

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/.