[pmg-devel] [PATCH] dkim: document dkim_use_domain

[pmg-devel] [PATCH] dkim: document dkim_use_domain

[Maximiliano Sandoval]

Signed-off-by: Maximiliano Sandoval <m.sandoval@proxmox.com>
---
Continuation of https://lists.proxmox.com/pipermail/pmg-devel/2024-February/002714.html.

 pmgconfig.adoc | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/pmgconfig.adoc b/pmgconfig.adoc
index bf3887e..0acb8e9 100644
--- a/pmgconfig.adoc
+++ b/pmgconfig.adoc
@@ -585,6 +585,13 @@ Controls whether all outbound mail should get signed or only mails from domains
 listed in `/etc/pmg/dkim/domains`, if it exists and `/etc/pmg/domains`
 otherwise.
 
+Select Signing Domain::
+
+Determines whether to DKIM sign emails using the domain found in the envelope
+from or the from header in the body of the email. Some emails do not set a
+return path and it is desirable to sign them using the domain found in the from
+header.
+
 These settings are saved to the 'admin' subsection in `/etc/pmg/pmg.conf`,
 using the following configuration keys:
 
-- 
2.39.2

Re: [pmg-devel] [PATCH] dkim: document dkim_use_domain

[Stoiko Ivanov]

Thanks for addressing this!

comment inline:
On Mon, 19 Feb 2024 14:00:36 +0100
Maximiliano Sandoval <m.sandoval@proxmox.com> wrote:

> Signed-off-by: Maximiliano Sandoval <m.sandoval@proxmox.com>
> ---
> Continuation of https://lists.proxmox.com/pipermail/pmg-devel/2024-February/002714.html.
> 
>  pmgconfig.adoc | 7 +++++++
>  1 file changed, 7 insertions(+)
> 
> diff --git a/pmgconfig.adoc b/pmgconfig.adoc
> index bf3887e..0acb8e9 100644
> --- a/pmgconfig.adoc
> +++ b/pmgconfig.adoc
> @@ -585,6 +585,13 @@ Controls whether all outbound mail should get signed or only mails from domains
>  listed in `/etc/pmg/dkim/domains`, if it exists and `/etc/pmg/domains`
>  otherwise.
>  
> +Select Signing Domain::
> +
> +Determines whether to DKIM sign emails using the domain found in the envelope
> +from or the from header in the body of the email. Some emails do not set a
here I'd probably add a reference to RFC5321 and RFC5322 respectively 
> +return path and it is desirable to sign them using the domain found in the from
I personally would rather phrase that as:
`Some emails are sent with an empty envelope sender` instead of not
setting a return path (the Return-Path header is usually set by some MTA
on the transport-path of the mail.
> +header.
> +
Additionally - I'd mention that DMARC (with reference to the RFC+section)
needs the header-from as domain in certain situations.


>  These settings are saved to the 'admin' subsection in `/etc/pmg/pmg.conf`,
>  using the following configuration keys:
>