History

Zaiming (Stone) Shi 0cde9e6ecf Merge pull request #6878 from zmstone/slog-ftw refactor: delete deprecated logging macros		2022-01-27 16:15:47 +01:00
..
etc	chore(retainer): change root name emqx_retainer > retainer	2022-01-11 15:30:42 +08:00
include	chore: update copyright	2022-01-05 20:55:00 +01:00
src	Merge pull request #6878 from zmstone/slog-ftw	2022-01-27 16:15:47 +01:00
test	test: call ct helpers to load config	2022-01-25 11:50:18 +01:00
.gitignore	style: ensure newline at EOF for all files	2021-11-04 14:40:14 +01:00
README.md	docs: fix typos	2022-01-27 12:29:38 +01:00
TODO	refactor(proj): Add apps	2020-12-04 22:11:53 +01:00
rebar.config	chore: major mode file variable for Emacs	2022-01-13 15:53:47 +08: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
##
## Default: 0
retainer.expiry_interval = 0

License

Apache License Version 2.0

Author

EMQ X Team