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.

Sign up for GitHub

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

README: additional usage instructions #39

Merged
merged 1 commit into from
May 31, 2024
+10 −4
Merged

README: additional usage instructions #39

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
14 changes: 10 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
# WildDuck plugin for Haraka

This plugin enables recipient checks for Haraka. The plugin normalizes recipient email addresses and validates these against the users table in the WildDuck database. It also checks quota usage, so if the user quota has already been exceeded, the message is rejected.
This plugin:

- enables recipient checks for Haraka. It normalizes recipient email addresses and validates these against the users table in the WildDuck database.
- checks quota usage, so if the user quota has been exceeded, the message is rejected.
- delivers messages to mongodb.

## Install

Expand All @@ -15,7 +19,7 @@ WildDuck plugin should be placed last in the plugins file.

### Configuration

WildDuck plugin expects MongoDB settings to be set. By default, it uses unauthenticated localhost. If you need to use more specific settings then create your own configuration file
This plugin expects MongoDB settings to be set. By default, it uses unauthenticated localhost. If you need to use more specific settings then create your own configuration file:

```sh
cp node_modules/haraka-plugin-wildduck/config/wildduck.ini config/wildduck.ini
Expand All @@ -24,6 +28,8 @@ $EDITOR config/wildduck.ini

### Notes

This is the only delivery plugin you need to use Haraka with WildDuck. Make sure Haraka has no other delivery plugin enabled.
This is the only delivery plugin you need to use Haraka with WildDuck. Make sure Haraka has no other delivery plugin(s) enabled.

For antispam, WildDuck supports [Haraka's Rspamd plugin](https://www.npmjs.com/package/haraka-plugin-rspamd). WildDuck uses Rspamd output to route messages marked as spam to the Junk mailbox.

For antispam, WildDuck supports Haraka Rspamd plugin. WildDuck uses Rspamd output to route messages marked as spam to the Junk mailbox.
This plugin includes SPF and DKIM support. You should not enable Haraka's built-in SPF or dkim_verify plugins.