aboutsummaryrefslogtreecommitdiffstats
path: root/src/plugins/lua/history_redis.lua
diff options
context:
space:
mode:
authorVsevolod Stakhov <vsevolod@highsecure.ru>2020-03-15 20:57:07 +0000
committerVsevolod Stakhov <vsevolod@highsecure.ru>2020-03-15 20:57:07 +0000
commit5f19fa64711cd73f6ce5defc3eb23ddf94983ed2 (patch)
tree903c42ff09132ac316dd88631c935c886836fcd4 /src/plugins/lua/history_redis.lua
parent5b795b9a65e53c45f26394439e9c6e0ad4653dec (diff)
downloadrspamd-5f19fa64711cd73f6ce5defc3eb23ddf94983ed2.tar.gz
rspamd-5f19fa64711cd73f6ce5defc3eb23ddf94983ed2.zip
[Minor] Add some docs
Diffstat (limited to 'src/plugins/lua/history_redis.lua')
-rw-r--r--src/plugins/lua/history_redis.lua13
1 files changed, 13 insertions, 0 deletions
diff --git a/src/plugins/lua/history_redis.lua b/src/plugins/lua/history_redis.lua
index cc26a281e..b05df4e5d 100644
--- a/src/plugins/lua/history_redis.lua
+++ b/src/plugins/lua/history_redis.lua
@@ -15,6 +15,19 @@ limitations under the License.
]]--
if confighelp then
+ rspamd_config:add_example(nil, 'history_redis',
+ "Store history of checks for WebUI using Redis",
+ [[
+redis_history {
+ key_prefix = 'rs_history', # default key name
+ nrows = 200; # default rows limit
+ compress = true; # use zstd compression when storing data in redis
+ subject_privacy = false; # subject privacy is off
+ subject_privacy_alg = 'blake2'; # default hash-algorithm to obfuscate subject
+ subject_privacy_prefix = 'obf'; # prefix to show it's obfuscated
+ subject_privacy_length = 16; # cut the length of the hash
+}
+ ]])
return
end