Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add store_tokens and signatures descriptions #785

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions doc/configuration/statistic.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,8 @@ Supported parameters for the Redis backend are:
- `min_balance` (Default: `0.9`): Ensures balance between spam and ham learns. If the ratio of spam learns to ham learns (or vice versa) exceeds `1 / min_balance`, learning for the more frequent type is skipped until the other type catches up. For example, with the default value of `0.9`, learning is skipped if one type exceeds the other by a ratio of approximately `1.11` (1/0.9). This helps prevent bias in the learning process.

For further details, see the [Autolearning section](#autolearning).
- `store_tokens` (Default: `false`): This option controls whether to store the actual text tokens of the learned messages in the Redis backend. When set to `true`, the tokens are stored in the database, allowing for future reference or debugging purposes. This may be useful for inspecting what data was learned but can also increase storage usage.
- `signatures` (Default: `false`): This option enables the storage of learning signatures for messages. When set to `true`, Rspamd will store signatures associated with learned messages, which can be used to avoid relearning the same message multiple times.
- `per_user`: For more details, see the Per-user statistics section.
- `cache_prefix`: Prefix used to create keys where to store hashes of already learned IDs, defaults to `"learned_ids"`.
- `cache_max_elt`: Amount of elements to store in one `learned_ids` key.
Expand Down