History

Zaiming (Stone) Shi 211b8e1b06 Merge remote-tracking branch 'origin/release-5.0-beta.3' into merge-5.0-beta.3-to-master		2022-01-04 22:48:25 +01:00
..
etc	fix(emqx_retainer): remove disc_only option	2022-01-04 14:40:11 +08:00
include	feat(eqmx_retainer): let emqx_retainer can support other types of databases	2021-07-17 13:18:03 +08:00
src	Merge remote-tracking branch 'origin/release-5.0-beta.3' into merge-5.0-beta.3-to-master	2022-01-04 22:48:25 +01:00
test	fix(emqx_retainer): fix config update error	2021-12-31 09:56:25 +08:00
.gitignore	style: ensure newline at EOF for all files	2021-11-04 14:40:14 +01:00
README.md	fix(emqx_retainer): remove disc_only option	2022-01-04 14:40:11 +08:00
TODO	refactor(proj): Add apps	2020-12-04 22:11:53 +01:00
rebar.config	ci(mix): add elixir deps check	2021-12-24 14:44:49 -03: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
##  - ram: memory only
##  - disc: both memory and disc
##
## 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