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

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