firest 254748b54e chore: comment mountpoints to support direct copy-paste used 2 rokov pred
..
README.md e0d05a02ff refactor: refine examples 2 rokov pred
alarm.conf.example e0d05a02ff refactor: refine examples 2 rokov pred
cluster-with-dns.conf.example e0d05a02ff refactor: refine examples 2 rokov pred
cluster-with-etcd-ssl.conf.example e0d05a02ff refactor: refine examples 2 rokov pred
cluster-with-etcd.conf.example e0d05a02ff refactor: refine examples 2 rokov pred
cluster-with-k8s.conf.example e0d05a02ff refactor: refine examples 2 rokov pred
cluster-with-manual.conf.example e0d05a02ff refactor: refine examples 2 rokov pred
cluster-with-static.conf.example e0d05a02ff refactor: refine examples 2 rokov pred
conn_congestion.conf.example 43705a54be docs: cosmetic changes in example config files 2 rokov pred
dashboard-with-http.conf.example e0d05a02ff refactor: refine examples 2 rokov pred
dashboard-with-https.conf.example e0d05a02ff refactor: refine examples 2 rokov pred
delayed.conf.example 49c4ea9ae9 refactor: mvoe config examples to 'rel/config' 2 rokov pred
exhook.conf.example e0d05a02ff refactor: refine examples 2 rokov pred
flapping_detect.conf.example e0d05a02ff refactor: refine examples 2 rokov pred
force_gc.conf.example e0d05a02ff refactor: refine examples 2 rokov pred
force_shutdown.conf.example e0d05a02ff refactor: refine examples 2 rokov pred
gateway.coap.conf.example 49c4ea9ae9 refactor: mvoe config examples to 'rel/config' 2 rokov pred
gateway.exproto.conf.example e0d05a02ff refactor: refine examples 2 rokov pred
gateway.lwm2m.conf.example e0d05a02ff refactor: refine examples 2 rokov pred
gateway.mqttsn.conf.example e0d05a02ff refactor: refine examples 2 rokov pred
gateway.stomp.conf.example e0d05a02ff refactor: refine examples 2 rokov pred
listeners.quic.conf.example 254748b54e chore: comment mountpoints to support direct copy-paste used 2 rokov pred
listeners.ssl.conf.example 0428d91aa4 fix(config-examples): fix bad configs 2 rokov pred
listeners.tcp.conf.example 254748b54e chore: comment mountpoints to support direct copy-paste used 2 rokov pred
listeners.ws.conf.example e0d05a02ff refactor: refine examples 2 rokov pred
listeners.wss.conf.example e0d05a02ff refactor: refine examples 2 rokov pred
log.console.conf.example e0d05a02ff refactor: refine examples 2 rokov pred
log.file.conf.example e0d05a02ff refactor: refine examples 2 rokov pred
mqtt.conf.example e0d05a02ff refactor: refine examples 2 rokov pred
node.conf.example 0428d91aa4 fix(config-examples): fix bad configs 2 rokov pred
plugins.conf.example 0428d91aa4 fix(config-examples): fix bad configs 2 rokov pred
prometheus-pushgateway.conf.example e0d05a02ff refactor: refine examples 2 rokov pred
prometheus.conf.example 43705a54be docs: cosmetic changes in example config files 2 rokov pred
psk_authentication.conf.example e0d05a02ff refactor: refine examples 2 rokov pred
rate_limit.conf.example 2a0f5f8ba5 chore: add rate limit example 2 rokov pred
retainer.conf.example 816297049e chore(example): add `msg_expiry_interval` into `retainer` example 2 rokov pred
sys_topics.conf.example e0d05a02ff refactor: refine examples 2 rokov pred
sysmon.os.conf.example e0d05a02ff refactor: refine examples 2 rokov pred
sysmon.vm.conf.example e0d05a02ff refactor: refine examples 2 rokov pred

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