emqx/apps/emqx_retainer
Zaiming Shi 0cf8380822 chore(apps): Sync plugins to apps dir
emqx_telemetry from tag v4.2.7
all other apps are from e4.2.4
see sync-apps.sh
2021-02-06 11:42:40 +01:00
..
.github/workflows chore(apps): Sync plugins to apps dir 2021-02-06 11:42:40 +01:00
etc chore(apps): Sync plugins to apps dir 2021-02-06 11:42:40 +01:00
include chore(apps): Sync plugins to apps dir 2021-02-06 11:42:40 +01:00
priv chore(apps): Sync plugins to apps dir 2021-02-06 11:42:40 +01:00
src chore(apps): Sync plugins to apps dir 2021-02-06 11:42:40 +01:00
test chore(apps): Sync plugins to apps dir 2021-02-06 11:42:40 +01:00
.gitignore chore(apps): Sync plugins to apps dir 2021-02-06 11:42:40 +01:00
LICENSE chore(apps): Sync plugins to apps dir 2021-02-06 11:42:40 +01:00
Makefile chore(apps): Sync plugins to apps dir 2021-02-06 11:42:40 +01:00
README.md chore(apps): Sync plugins to apps dir 2021-02-06 11:42:40 +01:00
TODO chore(apps): Sync plugins to apps dir 2021-02-06 11:42:40 +01:00
rebar.config chore(apps): Sync plugins to apps dir 2021-02-06 11:42:40 +01:00
rebar.config.script chore(apps): Sync plugins to apps dir 2021-02-06 11:42:40 +01: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