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

feature: provide initial Rspamd support #2902

Merged
merged 6 commits into from Jan 5, 2023
Merged

feature: provide initial Rspamd support #2902

merged 6 commits into from Jan 5, 2023

Conversation

georglauterbach
Copy link
Member

Description

This will install the Rspamd (and Redis) package and provide minimal infrastructure to start working with Rspamd. Notably, this is really just bare-minimum infrastructure, but it allows users to use Rspamd as of now. Users will need to adjust Postfix's configuration themselves - a PR that provides ease of use will follow. This is completely backwards compatible.

Type of change

  • New feature (non-breaking change which adds functionality)

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have made corresponding changes to the documentation (README.md or the documentation under docs/)
  • If necessary I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes

This will install the Rspamd (and Redis) package and provide minimal
infrastructure to start working with Rspamd.
@georglauterbach georglauterbach added kind/new feature A new feature is requested in this issue or implemeted with this PR area/features labels Nov 16, 2022
@georglauterbach georglauterbach added this to the v11.3.0 milestone Nov 16, 2022
@georglauterbach georglauterbach self-assigned this Nov 16, 2022
docs/content/config/environment.md Show resolved Hide resolved
target/rspamd/local.d/redis.conf Outdated Show resolved Hide resolved
target/scripts/startup/misc-stack.sh Show resolved Hide resolved
target/scripts/startup/setup-stack.sh Outdated Show resolved Hide resolved
target/supervisor/conf.d/supervisor-app.conf Show resolved Hide resolved
Copy link
Member

@polarathene polarathene left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 👍


Rspamd-support is under active development. Be aware that breaking changes can happen at any time. Moreover, you will _currently_ need to adjust Postfix's configuration _yourself_ if you want to use Rspamd; you may use [`user-patches.sh`][docs-userpatches].

You will need to add Rspamd to the `smtpd_milters` in Postfix's `main.cf`. This can easily be done with `sed`: `sed -i -E 's|^(smtpd_milters = .*)|\1,inet:localhost:11332|g' /etc/postfix/main.cf`. Moreover, have a look at the [integration of Rspamd into Postfx](https://rspamd.com/doc/integration.html). You will need to provide additional configuration files at the moment (to `/etc/rspamd/local.d/`) to make Rspamd run in milter-mode.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is better thanks 👍

Below is just an alternative revision suggested. Optional to apply.

Suggested change
You will need to add Rspamd to the `smtpd_milters` in Postfix's `main.cf`. This can easily be done with `sed`: `sed -i -E 's|^(smtpd_milters = .*)|\1,inet:localhost:11332|g' /etc/postfix/main.cf`. Moreover, have a look at the [integration of Rspamd into Postfx](https://rspamd.com/doc/integration.html). You will need to provide additional configuration files at the moment (to `/etc/rspamd/local.d/`) to make Rspamd run in milter-mode.
Required adjustments ([Integration of Rspamd for Postfix](https://rspamd.com/doc/integration.html)):
- Configure Postfix to include Rspamd as an smtpd milter (`main.cf:smtpd_milters`):
`sed`: `sed -i -E 's|^(smtpd_milters = .*)|\1,inet:localhost:11332|g' /etc/postfix/main.cf`
- You will need to provide additional configuration files at the moment (to `/etc/rspamd/local.d/`) to make Rspamd run in milter-mode.

The 2nd step still seems vague for a user to follow. I'm not going to block on that however as this is temporary docs for a feature not officially supported.

@georglauterbach georglauterbach modified the milestones: v11.3.0, v12.0.0 Dec 11, 2022
@georglauterbach
Copy link
Member Author

This is now ready to be merged (when @casperklein approves as well of course) ;)

@github-actions
Copy link
Contributor

github-actions bot commented Jan 4, 2023

Documentation preview for this PR is ready! 🎉

Built with commit: 8e53d0d

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/features kind/new feature A new feature is requested in this issue or implemeted with this PR service/security/rspamd
Projects
Development

Successfully merging this pull request may close these issues.

None yet

3 participants