History

JianBo He a6aae657a9 chore(example): fix gateway.stomp.conf.example		2023-06-20 18:20:33 +08:00
..
alarm.conf.example	chore: update examples to new version and fix errors	2023-06-20 15:38:30 +08:00
cluster-with-dns.conf.example	chore: update examples to new version and fix errors	2023-06-20 15:38:30 +08:00
cluster-with-etcd-ssl.conf.example	chore: update examples to new version and fix errors	2023-06-20 15:38:30 +08:00
cluster-with-etcd.conf.example	chore: update examples to new version and fix errors	2023-06-20 15:38:30 +08:00
cluster-with-k8s.conf.example	chore: update examples to new version and fix errors	2023-06-20 15:38:30 +08:00
cluster-with-manual.conf.example	chore: update examples to new version and fix errors	2023-06-20 15:38:30 +08:00
cluster-with-static.conf.example	chore: update examples to new version and fix errors	2023-06-20 15:38:30 +08:00
conn_congestion.conf.example	chore: add examples of how to configure	2023-06-20 14:53:14 +08:00
dashboard-with-http.conf.example	chore: update examples to new version and fix errors	2023-06-20 15:38:30 +08:00
dashboard-with-https.conf.example	chore: update examples to new version and fix errors	2023-06-20 15:38:30 +08:00
exhook.conf.example	chore: add examples of how to configure	2023-06-20 14:53:14 +08:00
file_transfer-with-local-exporter.conf.example	chore: add examples of how to configure	2023-06-20 14:53:14 +08:00
file_transfer-with-s3-exporter.conf.example	chore: fix errors in the example for the file transfer configuration	2023-06-20 18:13:49 +08:00
flapping_detect.conf.example	chore: fix errors in the example for the file transfer configuration	2023-06-20 18:13:49 +08:00
force_gc.conf.example	chore: add examples of how to configure	2023-06-20 14:53:14 +08:00
force_shutdown.conf.example	chore: add examples of how to configure	2023-06-20 14:53:14 +08:00
gateway.coap.conf.example	chore: update gateway configurations examples	2023-06-20 17:06:37 +08:00
gateway.exproto.conf.example	chore: update gateway configurations examples	2023-06-20 17:06:37 +08:00
gateway.lwm2m.conf.example	chore: update gateway configurations examples	2023-06-20 17:06:37 +08:00
gateway.mqttsn.conf.example	chore: update gateway configurations examples	2023-06-20 17:06:37 +08:00
gateway.stomp.conf.example	chore(example): fix gateway.stomp.conf.example	2023-06-20 18:20:33 +08:00
license.conf.example	chore: add examples of how to configure	2023-06-20 14:53:14 +08:00
listeners.quic.conf.example	chore: update examples to new version and fix errors	2023-06-20 15:38:30 +08:00
listeners.ssl.conf.example	chore: more detail for examples	2023-06-20 17:52:03 +08:00
listeners.tcp.conf.example	chore: update examples to new version and fix errors	2023-06-20 15:38:30 +08:00
listeners.ws.conf.example	chore: more detail for examples	2023-06-20 17:52:03 +08:00
listeners.wss.conf.example	chore: more detail for examples	2023-06-20 17:52:03 +08:00
log.console.conf.example	chore: add examples of how to configure	2023-06-20 14:53:14 +08:00
log.file.conf.example	chore: more detail for examples	2023-06-20 17:52:03 +08:00
mqtt.conf.example	chore: update examples to new version and fix errors	2023-06-20 15:38:30 +08:00
node.conf.example	chore: more detail for examples	2023-06-20 17:52:03 +08:00
plugin.conf.example	chore: fix spell && style error	2023-06-20 14:53:14 +08:00
prometheus.conf.example	chore: fix spell && style error	2023-06-20 14:53:14 +08:00
psk_authentication.conf.example	chore: add examples of how to configure	2023-06-20 14:53:14 +08:00
README.md	chore: add examples of how to configure	2023-06-20 14:53:14 +08:00
retainer.conf.example	chore: add examples of how to configure	2023-06-20 14:53:14 +08:00
sys_topics.conf.example	chore: add examples of how to configure	2023-06-20 14:53:14 +08:00
sysmon.os.conf.example	chore: more detail for examples	2023-06-20 17:52:03 +08:00
sysmon.vm.conf.example	chore: more detail for examples	2023-06-20 17:52:03 +08:00

README.md

Examples

Here are examples of how to configure features In EMQX, most of them can be used directly by copy-paste content into the emqx.conf file, others may need to be slightly modified to use, for example, you should change the listener port or HTTP URL to what you actually used.

Although we have tried to show every configurable field in the example, you do not need to care about each one, since most of them already have default values and can be omitted in the configuration file.

If you are confused about some fields, please refer to our documents, here are just some simple configuration examples with necessary descriptions.

Documentation

The EMQX documentation is available at www.emqx.io/docs/en/latest/.

The EMQX Enterprise documentation is available at docs.emqx.com/en/.