Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
[Minor] Add some docs
  • Loading branch information
vstakhov committed Mar 15, 2020
1 parent 5b795b9 commit 5f19fa6
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 0 deletions.
19 changes: 19 additions & 0 deletions src/plugins/lua/greylist.lua
Expand Up @@ -36,6 +36,25 @@ greylist {
--]]
if confighelp then
rspamd_config:add_example(nil, 'greylist',
"Performs adaptive greylisting using Redis",
[[
greylist {
expire = 1d; # Buckets expire (1 day by default)
timeout = 5m; # Greylisting timeout
key_prefix = 'rg'; # Redis prefix
max_data_len = 10k; # Use boy hash up to this value of bytes for greylisting
message = 'Try again later'; # Default greylisting message
symbol = 'GREYLIST'; # Append symbol
action = 'soft reject'; # Default action change (for Exim use `greylist`)
whitelist_symbols = []; # Skip greylisting if one of the following symbols has been found
ipv4_mask = 19; # Mask bits for ipv4
ipv6_mask = 64; # Mask bits for ipv6
report_time = false; # Tell when greylisting is expired (appended to `message`)
check_local = false; # Greylist local messages
check_authed = false; # Greylist authenticated users
}
]])
return
end

Expand Down
13 changes: 13 additions & 0 deletions src/plugins/lua/history_redis.lua
Expand Up @@ -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

Expand Down

0 comments on commit 5f19fa6

Please sign in to comment.