ieQu1 18721d05bc Merge pull request #13526 from ieQu1/replicant-ee 1 år sedan
..
README.md e0d05a02ff refactor: refine examples 2 år sedan
alarm.conf.example e0d05a02ff refactor: refine examples 2 år sedan
cluster-with-dns.conf.example e0d05a02ff refactor: refine examples 2 år sedan
cluster-with-etcd-ssl.conf.example e0d05a02ff refactor: refine examples 2 år sedan
cluster-with-etcd.conf.example e0d05a02ff refactor: refine examples 2 år sedan
cluster-with-k8s.conf.example e0d05a02ff refactor: refine examples 2 år sedan
cluster-with-manual.conf.example e0d05a02ff refactor: refine examples 2 år sedan
cluster-with-static.conf.example e0d05a02ff refactor: refine examples 2 år sedan
conn_congestion.conf.example 43705a54be docs: cosmetic changes in example config files 2 år sedan
dashboard-with-http.conf.example e0d05a02ff refactor: refine examples 2 år sedan
dashboard-with-https.conf.example 3c5c76fcfc refactor: simplify https listener config for dashboard 1 år sedan
delayed.conf.example d7112921a6 docs: remove `enable` from config examples 1 år sedan
exhook.conf.example d7112921a6 docs: remove `enable` from config examples 1 år sedan
flapping_detect.conf.example d7112921a6 docs: remove `enable` from config examples 1 år sedan
force_gc.conf.example d7112921a6 docs: remove `enable` from config examples 1 år sedan
force_shutdown.conf.example d7112921a6 docs: remove `enable` from config examples 1 år sedan
gateway.coap.conf.example 49c4ea9ae9 refactor: mvoe config examples to 'rel/config' 2 år sedan
gateway.exproto.conf.example e0d05a02ff refactor: refine examples 2 år sedan
gateway.lwm2m.conf.example e0d05a02ff refactor: refine examples 2 år sedan
gateway.mqttsn.conf.example e0d05a02ff refactor: refine examples 2 år sedan
gateway.stomp.conf.example e0d05a02ff refactor: refine examples 2 år sedan
listeners.quic.conf.example 254748b54e chore: comment mountpoints to support direct copy-paste used 2 år sedan
listeners.ssl.conf.example d7112921a6 docs: remove `enable` from config examples 1 år sedan
listeners.tcp.conf.example 254748b54e chore: comment mountpoints to support direct copy-paste used 2 år sedan
listeners.ws.conf.example d7112921a6 docs: remove `enable` from config examples 1 år sedan
listeners.wss.conf.example d7112921a6 docs: remove `enable` from config examples 1 år sedan
log.console.conf.example d7112921a6 docs: remove `enable` from config examples 1 år sedan
log.file.conf.example d7112921a6 docs: remove `enable` from config examples 1 år sedan
mqtt.conf.example 12da3c0986 feat: configurable server side message_expiry_interval 2 år sedan
node.conf.example 1beda1cd11 test(mria): Remove role from the example config 1 år sedan
plugins.conf.example b3074144cc chore: temporarily revert `NO_DOC` changes to fields with default value = false 1 år sedan
prometheus-pushgateway.conf.example d7112921a6 docs: remove `enable` from config examples 1 år sedan
prometheus.conf.example d7112921a6 docs: remove `enable` from config examples 1 år sedan
psk_authentication.conf.example d7112921a6 docs: remove `enable` from config examples 1 år sedan
rate_limit.conf.example 2a0f5f8ba5 chore: add rate limit example 2 år sedan
retainer.conf.example d7112921a6 docs: remove `enable` from config examples 1 år sedan
sys_topics.conf.example e0d05a02ff refactor: refine examples 2 år sedan
sysmon.os.conf.example e0d05a02ff refactor: refine examples 2 år sedan
sysmon.vm.conf.example e0d05a02ff refactor: refine examples 2 år sedan

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