History

lafirest 860aea50db chore(emqx_retainer): change config of emqx_retainer to use hocon		2021-06-30 21:42:34 +08:00
..
etc	chore(emqx_retainer): change config of emqx_retainer to use hocon	2021-06-30 21:42:34 +08:00
include	chore(retainer): Add RLOG shard	2021-06-28 20:22:06 +02:00
src	chore(emqx_retainer): change config of emqx_retainer to use hocon	2021-06-30 21:42:34 +08:00
test	chore(emqx_retainer): change config of emqx_retainer to use hocon	2021-06-30 21:42:34 +08:00
.gitignore	refactor(proj): Add apps	2020-12-04 22:11:53 +01:00
README.md	refactor(proj): Add apps	2020-12-04 22:11:53 +01:00
TODO	refactor(proj): Add apps	2020-12-04 22:11:53 +01:00
rebar.config	feat(cuttlefish): use hocon as a parsing function (#4008 )	2021-01-19 19:52:17 +09:00

README.md

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