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

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

README.md

Examples

Documentation