dgiot/apps/emqx_retainer/README.md

60 lines
1008 B
Markdown
Raw Normal View History

2021-05-18 14:54:48 +08:00
EMQ X Retainer
==============
The retainer plugin is responsible for storing retained MQTT messages.
Configuration
-------------
etc/emqx_retainer.conf:
```
## Where to store the retained messages.
## Notice that all nodes in a cluster are to have the same storage_type.
##
## Value: ram | disc | disc_only
## - ram: memory only
## - disc: both memory and disc
## - disc_only: disc only
##
## Default: ram
retainer.storage_type = ram
## Maximum number of retained messages allowed.
##
## Value: Number >= 0
retainer.max_retained_messages = 1000000
## Maximum payload size of a retained message.
##
## Value: Bytes
retainer.max_payload_size = 64KB
## Expiration interval of the retained messages. Never expire if the value is 0.
##
## Value: Duration
## - h: hour
## - m: minute
## - s: second
##
## Examples:
## - 2h: 2 hours
## - 30m: 30 minutes
## - 20s: 20 seconds
##
## Defaut: 0
retainer.expiry_interval = 0
```
License
-------
Apache License Version 2.0
Author
------
EMQ X Team