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

(maybe) Fixes a typo in the rspamd docs #682

Merged
merged 1 commit into from
Nov 24, 2024
Merged

Conversation

reind33r
Copy link

Currently, to add rspamd, the docs suggest to

add rspamd check with default configuration into appropriate check block (probably in local_routing):

checks {
   ...
   rspamd
}```

Adding this block in local_routing results in a failure to start, because in this context only check is valid.

(I see that checks exist at top-level, but if we mention local_routing and appropriate check block, it makes more sense to me that the code block is also check)

@codecov-commenter
Copy link

codecov-commenter commented Feb 25, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 52.65%. Comparing base (798c411) to head (bb2c0c9).

Additional details and impacted files
@@            Coverage Diff             @@
##              dev     #682      +/-   ##
==========================================
- Coverage   52.68%   52.65%   -0.03%     
==========================================
  Files         129      129              
  Lines       13369    13369              
==========================================
- Hits         7043     7039       -4     
- Misses       5660     5663       +3     
- Partials      666      667       +1     
Flag Coverage Δ
integration 34.36% <ø> (+0.09%) ⬆️
unit 52.16% <ø> (-0.05%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@foxcpp
Copy link
Owner

foxcpp commented Nov 24, 2024

It is indeed a typo.

checks and modifiers are names of group modules that allow defining reusable configurations for check and modify directives correspondingly:

checks inbound_filters {
        dkim
}

modifiers inbound_mutation {
        replace_rcpt regexp "asd" "asd"
}

smtp tcp://127.0.0.1:2525 {
        check &inbound_filters
        modify &inbound_mutation
        reject
}

@foxcpp foxcpp merged commit b33a1e2 into foxcpp:dev Nov 24, 2024
3 checks passed
@foxcpp
Copy link
Owner

foxcpp commented Nov 24, 2024

Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants