Skip to content

Commit

Permalink
chore: add prettier scripts
Browse files Browse the repository at this point in the history
  • Loading branch information
@msimerson
msimerson committed Aug 22, 2024
1 parent ed23703 commit 4c9760c
Show file tree
Hide file tree
Showing 4 changed files with 102 additions and 111 deletions.
2 changes: 1 addition & 1 deletion Changes.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -202,7 +202,7 @@
- dep(haraka-plugin-redis)!: 1.0 -> 2.0 #3038
- dep(redis)!: 3.1 -> 4.1 #3058
- dep(generic-pool): remove pooling from outbound #3115
- smtp_client: remove smtp_* pooling support in #3113
- smtp_client: remove smtp_\* pooling support in #3113
- dep: bump plugin versions #3063
- dep: bump haraka-plugin-asn from 1.0.9 to 2.0.0 #3062
- dep(redis): 3.1 -> 4.1 #3058
Expand Down
189 changes: 93 additions & 96 deletions Plugins.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@ To create your own plugin, see [Write a Plugin][write-plugin].

## Installing NPM packaged plugins

Plugins can be installed in the directory where Haraka was installed (where depends on your OS platform and whether you specified `-g`) or the Haraka install directory (haraka -i this_path). This example installs _my-great-plugin_ in the Haraka install directory:
Plugins can be installed in the directory where Haraka was installed (where depends on your OS platform and whether you specified `-g`) or the Haraka install directory (haraka -i this\_path). This example installs _my-great-plugin_ in the Haraka install directory:

````
```
cd /etc/haraka
npm install haraka-plugin-my-great-plugin
````
```

NPM then installs the plugin and its dependencies in a `node_modules` directory within the Haraka install directory.

Expand All @@ -19,108 +19,105 @@ A comprehensive list of known plugins. Create a PR to add yours to these lists.

### Auth Plugins

| Name | Description |
| ------------------------- | ------------- |
| [auth-enc-file][url-authencflat] | Auth against user/pass in an encrypted file |
| [flat_file][url-authflat] | Auth against user/pass in a file |
| [auth_bridge][url-authbridge] | Auth against remote MTA |
| [auth-imap][url-auth-imap] | Auth against IMAP server |
| [auth_ldap][url-auth-ldap] | Auth against LDAP |
| [auth_proxy][url-authproxy] | Auth against remote MTA |
| [auth_vpopmaild][url-authvpop] | Auth against vpopmaild |
| [dkim][url-dkim] | DKIM sign & verify |
| [dovecot][url-dovecot] | SMTP AUTH & recipient validation against dovecot |
| [LDAP][url-ldap] | Aliases, Auth, and Recipient validation from LDAP |
| [mailauth][url-mailauth] | Email Auth (SPF, DKIM, DMARC, ARC, & BIMI) |
| [opendkim][url-opendkim] | DKIM sign and verify email messages |
| [spf][url-spf] | Perform SPF checks |
| Name | Description |
| -------------------------------- | ------------------------------------------------- |
| [auth-enc-file][url-authencflat] | Auth against user/pass in an encrypted file |
| [flat_file][url-authflat] | Auth against user/pass in a file |
| [auth_bridge][url-authbridge] | Auth against remote MTA |
| [auth-imap][url-auth-imap] | Auth against IMAP server |
| [auth_ldap][url-auth-ldap] | Auth against LDAP |
| [auth_proxy][url-authproxy] | Auth against remote MTA |
| [auth_vpopmaild][url-authvpop] | Auth against vpopmaild |
| [dkim][url-dkim] | DKIM sign & verify |
| [dovecot][url-dovecot] | SMTP AUTH & recipient validation against dovecot |
| [LDAP][url-ldap] | Aliases, Auth, and Recipient validation from LDAP |
| [mailauth][url-mailauth] | Email Auth (SPF, DKIM, DMARC, ARC, & BIMI) |
| [opendkim][url-opendkim] | DKIM sign and verify email messages |
| [spf][url-spf] | Perform SPF checks |

### Queue Plugins

| Name | Description |
| -------------------------- | ------------- |
| [discard][url-qdisc] | queues messages to /dev/null |
| [kafka][url-kafka] | Queue inbound mail to a Kafka topic |
| [lmtp][url-qlmtp] | deliver queued messages via LMTP |
| [mongodb][mongo-url] | Queue emails to MongoDB |
| [qmail-queue][url-qmail] | queue to qmail |
| [quarantine][url-qquart] | queue to a quarantine directory |
| [rabbitmq][url-qrabbit] | queue to RabbitMQ |
| [rabbitmq_amqplib][url-qrabbita] | queue to RabbitMQ using amqplib |
| [rails][url-qrails] | queue messages to a Rails app using [Action Mailbox][url-action-mailbox] |
| [smtp_bridge][url-qbridge] | Bridge SMTP sessions to another MTA |
| [smtp_forward][url-qforward] | Forward emails to another MTA |
| [smtp_proxy][url-qproxy] | Proxy SMTP connections to another MTA |
| [wildduck][url-wildduck] | queue messages to Wild Duck |
| Name | Description |
| -------------------------------- | ------------------------------------------------------------------------ |
| [discard][url-qdisc] | queues messages to /dev/null |
| [kafka][url-kafka] | Queue inbound mail to a Kafka topic |
| [lmtp][url-qlmtp] | deliver queued messages via LMTP |
| [mongodb][mongo-url] | Queue emails to MongoDB |
| [qmail-queue][url-qmail] | queue to qmail |
| [quarantine][url-qquart] | queue to a quarantine directory |
| [rabbitmq][url-qrabbit] | queue to RabbitMQ |
| [rabbitmq_amqplib][url-qrabbita] | queue to RabbitMQ using amqplib |
| [rails][url-qrails] | queue messages to a Rails app using [Action Mailbox][url-action-mailbox] |
| [smtp_bridge][url-qbridge] | Bridge SMTP sessions to another MTA |
| [smtp_forward][url-qforward] | Forward emails to another MTA |
| [smtp_proxy][url-qproxy] | Proxy SMTP connections to another MTA |
| [wildduck][url-wildduck] | queue messages to Wild Duck |

### Filtering Plugins

| Name | Description |
| ------------------------- | ------------- |
| [attachment][url-attach] | Restrict attachment types |
| [avg][url-avg] | AVG antivirus scanner |
| [clamd][url-clamd] | Anti-Virus scanning with ClamAV |
| [data.signatures][url-sigs] | Block emails whose bodies match signatures |
| [dcc][url-dcc] | Distributed Checksum Clearinghouse |
| [esets][url-esets] | Virus scanning with ESET Mail Security |
| [messagesniffer][url-msgsniff] | Anti-spam via [MessageSniffer][url-ms] |
| [milter][url-milter] | milter support |
| [rspamd][url-rspamd] | Scan emails with rspamd |
| [spamassassin][url-spamass] | Scan emails with SpamAssassin |
| [uribl][url-uribl] | Block based on URI blacklists |

| Name | Description |
| ------------------------------ | ------------------------------------------ |
| [attachment][url-attach] | Restrict attachment types |
| [avg][url-avg] | AVG antivirus scanner |
| [clamd][url-clamd] | Anti-Virus scanning with ClamAV |
| [data.signatures][url-sigs] | Block emails whose bodies match signatures |
| [dcc][url-dcc] | Distributed Checksum Clearinghouse |
| [esets][url-esets] | Virus scanning with ESET Mail Security |
| [messagesniffer][url-msgsniff] | Anti-spam via [MessageSniffer][url-ms] |
| [milter][url-milter] | milter support |
| [rspamd][url-rspamd] | Scan emails with rspamd |
| [spamassassin][url-spamass] | Scan emails with SpamAssassin |
| [uribl][url-uribl] | Block based on URI blacklists |

### Every other Plugin

| Name | Description |
| ------------------------- | ------------- |
| [access][url-access] | ACLs based on IPs, domains, email addrs, etc. |
| [accounting_files][url-acc-files] | Retrieve, Store and Archive custom information of outbound traffic |
| [aliases][url-aliases] | Email aliases |
| [ASN][url-asn] | Get ASN info for remote senders |
| [block_me][url-blockme] | Populate block list via forwarded emails |
| [bounce][url-bounce] | Many options for bounce processing |
| [delay_deny][url-delay] | Delays all pre-DATA 'deny' results |
| [dns-list][url-dns-list] | Check remote MTAs against DNS black, white, and karma lists |
| [dovecot][url-dovecot] | Recipient validation & SMTP AUTH against dovecot |
| [early_talker][url-early] | Reject remotes that talk early |
| [fcrdns][url-fcrdns] | Forward Confirmed reverse DNS |
| [geoip][url-geoip] | get geographic information about mail senders |
| [greylist][url-greylist] | Greylisting |
| [headers][url-headers] | Inspect and verify various email headers |
| [helo.checks][url-helo] | Validity checks of the HELO string |
| [karma][url-karma] | Dynamic scoring of incoming connections |
| [known-senders][url-known-senders] | Reward emails from those you send mail to |
| [LDAP][url-ldap] | Aliases, Auth, and Recipient validation from LDAP |
| [Limit][url-limit] | Apply many types of limits to SMTP connections |
| [log.elasticsearch][url-elastic] | Store message metadata in Elasticsearch |
| [log reader][url-logreader] | extract log entries from the haraka log file |
| [syslog][url-syslog] | Log to syslog |
| [mail_from.is_resolvable][url-mfres] | Verifies the MAIL FROM domain resolves to a MX |
| [outbound-logger][url-outbound-logger] | JSON logging of outbound email traffic. Logs useful metadata about delivered/bounced emails |
| [p0f][url-p0f] | TCP Fingerprinting |
| [prevent_credential_leaks][url-creds] | Prevent users from emailing their credentials |
| [process_title][url-proctitle] | Populate `ps` output with activity counters |
| [recipient-routes][url-rroutes] | Route emails based on their recipient(s) |
| [redis][url-redis] | multi-purpose Redis db connection(s) |
| [rcpt_to.in_host_list][url-rhost] | Define local email domains in a file |
| [rcpt_to.ldap][url-rcpt-ldap] | Validate recipients against LDAP |
| [rcpt-postgresql][url-postgres] | validate recipients against PostgreSQL
| [qmail-deliverable][url-rqmd] | Validate recipients against Qmail-Deliverable |
| [record_envelope_addresses][url-recordenv] | Adds message headers with ENV recips |
| [relay][url-relay] | Manage relay permissions |
| [reseed_rng][url-rng] | Reseed the RNG |
| [batv-srs][url-batv] | BATV & SRS |
| [srs][url-srs] | Sender Rewriting Scheme |
| [tarpit][url-tarpit] | Slow down connections |
| [tls][url-tls] | Implements TLS |
| [toobusy][url-toobusy] | Defers connections when too busy |
| [vmta][url-vmta] | Virtual MTA management |
| [watch][url-watch] | Watch live SMTP traffic in a web interface |
| [wildduck][url-wildduck] | provides recipient checks against Wild Duck |
| [xclient][url-xclient] | Implements XCLIENT |


| Name | Description |
| ------------------------------------------ | ------------------------------------------------------------------------------------------- |
| [access][url-access] | ACLs based on IPs, domains, email addrs, etc. |
| [accounting_files][url-acc-files] | Retrieve, Store and Archive custom information of outbound traffic |
| [aliases][url-aliases] | Email aliases |
| [ASN][url-asn] | Get ASN info for remote senders |
| [block_me][url-blockme] | Populate block list via forwarded emails |
| [bounce][url-bounce] | Many options for bounce processing |
| [delay_deny][url-delay] | Delays all pre-DATA 'deny' results |
| [dns-list][url-dns-list] | Check remote MTAs against DNS black, white, and karma lists |
| [dovecot][url-dovecot] | Recipient validation & SMTP AUTH against dovecot |
| [early_talker][url-early] | Reject remotes that talk early |
| [fcrdns][url-fcrdns] | Forward Confirmed reverse DNS |
| [geoip][url-geoip] | get geographic information about mail senders |
| [greylist][url-greylist] | Greylisting |
| [headers][url-headers] | Inspect and verify various email headers |
| [helo.checks][url-helo] | Validity checks of the HELO string |
| [karma][url-karma] | Dynamic scoring of incoming connections |
| [known-senders][url-known-senders] | Reward emails from those you send mail to |
| [LDAP][url-ldap] | Aliases, Auth, and Recipient validation from LDAP |
| [Limit][url-limit] | Apply many types of limits to SMTP connections |
| [log.elasticsearch][url-elastic] | Store message metadata in Elasticsearch |
| [log reader][url-logreader] | extract log entries from the haraka log file |
| [syslog][url-syslog] | Log to syslog |
| [mail_from.is_resolvable][url-mfres] | Verifies the MAIL FROM domain resolves to a MX |
| [outbound-logger][url-outbound-logger] | JSON logging of outbound email traffic. Logs useful metadata about delivered/bounced emails |
| [p0f][url-p0f] | TCP Fingerprinting |
| [prevent_credential_leaks][url-creds] | Prevent users from emailing their credentials |
| [process_title][url-proctitle] | Populate `ps` output with activity counters |
| [recipient-routes][url-rroutes] | Route emails based on their recipient(s) |
| [redis][url-redis] | multi-purpose Redis db connection(s) |
| [rcpt_to.in_host_list][url-rhost] | Define local email domains in a file |
| [rcpt_to.ldap][url-rcpt-ldap] | Validate recipients against LDAP |
| [rcpt-postgresql][url-postgres] | validate recipients against PostgreSQL |
| [qmail-deliverable][url-rqmd] | Validate recipients against Qmail-Deliverable |
| [record_envelope_addresses][url-recordenv] | Adds message headers with ENV recips |
| [relay][url-relay] | Manage relay permissions |
| [reseed_rng][url-rng] | Reseed the RNG |
| [batv-srs][url-batv] | BATV & SRS |
| [srs][url-srs] | Sender Rewriting Scheme |
| [tarpit][url-tarpit] | Slow down connections |
| [tls][url-tls] | Implements TLS |
| [toobusy][url-toobusy] | Defers connections when too busy |
| [vmta][url-vmta] | Virtual MTA management |
| [watch][url-watch] | Watch live SMTP traffic in a web interface |
| [wildduck][url-wildduck] | provides recipient checks against Wild Duck |
| [xclient][url-xclient] | Implements XCLIENT |

<!-- URLs tucked safely out of the way -->

Expand Down
Loading

0 comments on commit 4c9760c

Please sign in to comment.