Skip to content

Commit

Permalink
docs(plugins/*.md): use to indicate heading levels
Browse files Browse the repository at this point in the history
  • Loading branch information
msimerson committed Jan 10, 2025
1 parent 90ef5e7 commit d0e29fd
Show file tree
Hide file tree
Showing 15 changed files with 34 additions and 69 deletions.
10 changes: 4 additions & 6 deletions docs/plugins/aliases.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
aliases
=======
# aliases

This plugin allows one to configure aliases that may perform an action or
change the RCPT address in a number of ways. All aliases are specified in
Expand All @@ -12,8 +11,7 @@ that run on hook_rcpt

WARNING: DO NOT USE THIS PLUGIN WITH queue/smtp\_proxy.

Configuration
-------------
## Configuration

* aliases

Expand Down Expand Up @@ -135,8 +133,8 @@ Configuration
aliases on a single domain that map to other local parts at the
same domain.

Example Configuration
---------------------
### Example Configuration

{
"test1" : { "action" : "drop" },
"test2" : { "action" : "drop" },
Expand Down
6 changes: 2 additions & 4 deletions docs/plugins/block_me.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
block\_me
========
# block\_me

This plugin allows you to configure an address which mail sent to will be
parsed for a From: address in the body of the message, and will add that
Expand All @@ -10,8 +9,7 @@ particular mailbox to block them in the future.

Note that this is a system-wide block, and not per-user. Be careful with this.

Configuration
-------------
## Configuration

* `config/block_me.recipient` - a file containing the address to email to
get something blocked. For example: **[email protected]**.
Expand Down
6 changes: 2 additions & 4 deletions docs/plugins/data.signatures.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,10 @@
data.signatures
===============
# data.signatures

This plugin allows you to add string signatures to a configuration file and
have this plugin scan the body text of an email for those strings. Mails
matching these signatures will be blocked.

Configuration
-------------
## Configuration

* data.signatures

Expand Down
6 changes: 2 additions & 4 deletions docs/plugins/early_talker.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
early\_talker
============
# early\_talker

Early talkers are violators of the SMTP specification, which require that
clients must wait for certain responses before sending the next command.
Expand All @@ -10,8 +9,7 @@ and after the DATA command for Haraka to detect if it talks early.
If an early talker is detected at connection or DATA, then a DENY is
returned with the message 'You talk too soon'.

Configuration
-------------
## Configuration

The config file early\_talker.ini has two options:

Expand Down
6 changes: 2 additions & 4 deletions docs/plugins/mail_from.is_resolvable.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@
mail\_from.is\_resolvable
=======================
# mail\_from.is\_resolvable

This plugin checks that the domain used in MAIL FROM is resolvable to an MX
record.

Configuration
-------------
## Configuration

This plugin uses the INI-style file format and accepts the following options:

Expand Down
6 changes: 2 additions & 4 deletions docs/plugins/max_unrecognized_commands.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
max\_unrecognized\_commands
=========================
# max\_unrecognized\_commands

This plugin places a maximum limit on the number of unrecognized commands
allowed before recognising that the connection is bad.
Expand All @@ -13,8 +12,7 @@ runs after any plugins that use the unrecognized_command hook to implement
other SMTP verbs and extensions (such as the auth/* plugins), otherwise
commands valid for these plugins will be counted as unknown by this plugin.

Configuration
-------------
## Configuration

* max\_unrecognized\_commands

Expand Down
7 changes: 2 additions & 5 deletions docs/plugins/prevent_credential_leaks.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
prevent\_credential\_leaks
========
# prevent\_credential\_leaks

This plugin prevents an authenticated user (via SMTP AUTH) from sending
their username and password out in a message (e.g. like replying to a
Expand All @@ -16,9 +15,7 @@ Note that if the username is qualified e.g. [email protected] - then the
plugin will search for both `user` and `[email protected]` for maximum
effectiveness.


Configuration
-------------
## Configuration

No configuration is required. Simply add the plugin to your `config/plugins`
file. It should be added before any other plugins that run on hook_data_post
Expand Down
3 changes: 1 addition & 2 deletions docs/plugins/process_title.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
process\_title
=============
# process\_title

This plugin causes the process title seen by the UNIX 'ps' command to
be modified from this:
Expand Down
3 changes: 1 addition & 2 deletions docs/plugins/rcpt_to.in_host_list.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
rcpt\_to.in\_host\_list
=====================
# rcpt\_to.in\_host\_list

This plugin is the mainstay of an inbound Haraka server. It should list the
domains that are local to the host. Mails that have RCPT TO not matching
Expand Down
12 changes: 2 additions & 10 deletions docs/plugins/rcpt_to.max_count.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,3 @@
rcpt\_to.max\_count
=================
# rcpt\_to.max\_count

This plugin sets a maximum limit on RCPT TOs. Violators will be disconnected.

Configuration
-------------

* rcpt\_to.max\_count

The maximum number of recipients. Default: 40.
The functionality of this plugin was integrated in to [haraka-plugin-limit](https://github.com/haraka/haraka-plugin-limit).
9 changes: 3 additions & 6 deletions docs/plugins/record_envelope_addresses.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
record\_envelope\_addresses
=========================
# record\_envelope\_addresses

This plugin adds two new header lines.

Expand All @@ -10,14 +9,12 @@ It is useful if you need to know the exact addresses used to send an email, e.g.
the email was sent to you as BCC or if it is a newsletter. In both cases the recipient
address is normally not recorded in the headers.

Caveats
-------
## Caveats

If you enable this plugin you may introduce a possible information leak, i.e. disclosure
of BCC recipients. So you never want to use this on an outgoing mail server and maybe also
not if this server is used as a relay.

Configuration
-------------
## Configuration

This plugin has no configuration.
3 changes: 1 addition & 2 deletions docs/plugins/reseed_rng.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
reseed\_rng
==========
# reseed\_rng

The V8 that ships with node 0.4.x uses an unsophisticated method of
seeding its random number generator- it simply uses the current time
Expand Down
17 changes: 7 additions & 10 deletions docs/plugins/tarpit.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
tarpit
======
# tarpit

This plugin is designed to introduce deliberate delays on the response
of every hook in order to slow down a connection. It has no
Expand All @@ -10,8 +9,8 @@ that accept recipients or that return OK) but must be loaded *after*
any plugins that wish to use it.


Usage
--------------
## Usage

To use this plugin in another plugin set:

connection.notes.tarpit = <seconds to delay>;
Expand All @@ -21,8 +20,7 @@ or
connection.transaction.notes.tarpit = <seconds to delay>;


Configuration
--------------
## Configuration

The configuration file for tarpit is config/tarpit.ini.

Expand All @@ -34,8 +32,7 @@ The configuration file for tarpit is config/tarpit.ini.
hooks\_to\_delay=connect,helo,ehlo,mail,rcpt,data,data\_post,queue,unrecognized\_command,vrfy,noop,rset,quit


Plugin Timeout
--------------
## Plugin Timeout

config/tarpit.timeout (Default: 0)

Expand All @@ -51,7 +48,7 @@ The solution is to set the contents of config/tarpit.timeout to zero or
**seconds to delay** + 1.


Logging
--------------
## Logging

When tarpitting a command it will log 'tarpitting response for Ns' to
the INFO facility where N is the number of seconds.
6 changes: 2 additions & 4 deletions docs/plugins/toobusy.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
toobusy
=======
# toobusy

This plugin will stop Haraka accepting new connections when the event loop
latency is too high.
Expand All @@ -12,8 +11,7 @@ To use this plugin you have to install the 'toobusy-js' module by running
This plugin should be listed at the top of your config/plugins file so that
it runs before any other plugin that hooks lookup\_rdns.

Configuration
-------------
## Configuration

If you wish to override the default maxLag value of 70ms then add the desired
value to config/toobusy.maxlag. This can be set and changed at runtime and
Expand Down
3 changes: 1 addition & 2 deletions docs/plugins/xclient.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
xclient
=======
# xclient

Implements the [XCLIENT](http://www.postfix.org/XCLIENT_README.html) protocol.

Expand Down

0 comments on commit d0e29fd

Please sign in to comment.