diff --git a/website/docs/settings/store-and-forward-plugin.md b/website/docs/settings/store-and-forward-plugin.md index 19d7b6f0..6e726711 100644 --- a/website/docs/settings/store-and-forward-plugin.md +++ b/website/docs/settings/store-and-forward-plugin.md @@ -6,13 +6,27 @@ sidebar_label: Store and Forward ## Overview +:::caution +This is a work in progress and is not yet available. +::: +The Store Forward Plugin is an implementation of a Store and Forward system to enable resilient messaging in the event that a client device is disconnected from the main network. + +Because of the increased network traffic for this overhead, it's not adviced to use this if you are duty cycle limited for your airtime usage nor is it adviced to use this for SF12 (Long range but Slow). ## Settings -| Setting | Acceptable Values | Default | Description | -| :-----: | :---------------: | :-----: | :---------: | -| store_forward_plugin_enabled | `true`, `false` | `false` | Enables the plugin. | -| store_forward_plugin_records | integer | `0` | TODO | +| Setting | Acceptable Values | Default | +| :-----: | :---------------: | :-----: | +| store_forward_plugin_enabled | `true`, `false` | `false` | +| store_forward_plugin_records | integer | `0` | + +### store_forward_plugin_enabled + +Enables the plugin. + +### store_forward_plugin_records + + ## Details