[pmg-devel] [PATCH pmg-docs] pmgconfig: Link to SA rule writing documentation

[pmg-devel] [PATCH pmg-docs] pmgconfig: Link to SA rule writing documentation

[Dylan Whyte]

Adds a link to SpamAssassin's rule syntax documentation to the section
"Custom SpamAssassin Configuration".

Also clarifies that the name of a custom spam score should be the name
of the corresponding SpamAssassin rule.
---
 asciidoc/asciidoc-pmg.conf | 1 +
 pmgconfig.adoc             | 8 ++++----
 2 files changed, 5 insertions(+), 4 deletions(-)

diff --git a/asciidoc/asciidoc-pmg.conf b/asciidoc/asciidoc-pmg.conf
index 2789e16..a0b998f 100644
--- a/asciidoc/asciidoc-pmg.conf
+++ b/asciidoc/asciidoc-pmg.conf
@@ -11,6 +11,7 @@ manmanual=Proxmox Mail Gateway Documentation
 max-width=55em
 spamassassin=https://spamassassin.apache.org[SpamAssassin(TM)]
 spamassassin_dnsbl=https://cwiki.apache.org/confluence/display/SPAMASSASSIN/DnsBlocklists[SpamAssassin DNSBL documentation]
+spamassassin_rule_syntax=https://cwiki.apache.org/confluence/display/SPAMASSASSIN/writingrules[SpamAssassin rule syntax]
 postfix=http://www.postfix.org[Postfix]
 postfix_tls_readme=http://www.postfix.org/TLS_README.html[Postfix TLS Readme]
 postfix_afterqueue=http://www.postfix.org/FILTER_README.html[Postfix After-Queue Content Filter]
diff --git a/pmgconfig.adoc b/pmgconfig.adoc
index 8f0826b..b19cbb5 100644
--- a/pmgconfig.adoc
+++ b/pmgconfig.adoc
@@ -666,7 +666,7 @@ The system logs all the rules which a particular mail hits. Analyzing the logs c
 lead to finding such a pattern in your environment.
 
 You can adjust the score of a rule by creating a new 'Custom Rule Score' entry
-in the GUI.
+in the GUI and entering a {spamassassin} rule as the name.
 
 NOTE: In general, it is strongly recommended not to make large changes to the
 default scores.
@@ -739,9 +739,9 @@ them, as `init.pre`, `v310.pre`, `v320.pre`, `local.cf` will be overwritten by
 the xref:pmgconfig_template_engine[template engine], while the others can
 get updated by any {spamassassin} package upgrade.
 
-To add your custom configuration, you have to create a new file and name it
-`custom.cf` (in this directory), then add your configuration there. Make sure
-to use the correct {spamassassin} syntax, and test it with:
+To add your custom configuration, you have to create a new file named
+`custom.cf` (in `/etc/mail/spamassassin/`), then add your configuration there.
+Make sure to use the correct {spamassassin_rule_syntax} and test it with:
 
 ----
 # spamassassin -D --lint
-- 
2.30.2

[pmg-devel] applied: [PATCH pmg-docs] pmgconfig: Link to SA rule writing documentation

[Stoiko Ivanov]

huge thanks for addressing this so quickly - applied
with Signed-off-by you added (I hope this is alright with you)



On Tue, 11 Jan 2022 16:30:35 +0100
Dylan Whyte <d.whyte@proxmox.com> wrote:

> Adds a link to SpamAssassin's rule syntax documentation to the section
> "Custom SpamAssassin Configuration".
> 
> Also clarifies that the name of a custom spam score should be the name
> of the corresponding SpamAssassin rule.
> ---
>  asciidoc/asciidoc-pmg.conf | 1 +
>  pmgconfig.adoc             | 8 ++++----
>  2 files changed, 5 insertions(+), 4 deletions(-)
> 
> diff --git a/asciidoc/asciidoc-pmg.conf b/asciidoc/asciidoc-pmg.conf
> index 2789e16..a0b998f 100644
> --- a/asciidoc/asciidoc-pmg.conf
> +++ b/asciidoc/asciidoc-pmg.conf
> @@ -11,6 +11,7 @@ manmanual=Proxmox Mail Gateway Documentation
>  max-width=55em
>  spamassassin=https://spamassassin.apache.org[SpamAssassin(TM)]
>  spamassassin_dnsbl=https://cwiki.apache.org/confluence/display/SPAMASSASSIN/DnsBlocklists[SpamAssassin DNSBL documentation]
> +spamassassin_rule_syntax=https://cwiki.apache.org/confluence/display/SPAMASSASSIN/writingrules[SpamAssassin rule syntax]
>  postfix=http://www.postfix.org[Postfix]
>  postfix_tls_readme=http://www.postfix.org/TLS_README.html[Postfix TLS Readme]
>  postfix_afterqueue=http://www.postfix.org/FILTER_README.html[Postfix After-Queue Content Filter]
> diff --git a/pmgconfig.adoc b/pmgconfig.adoc
> index 8f0826b..b19cbb5 100644
> --- a/pmgconfig.adoc
> +++ b/pmgconfig.adoc
> @@ -666,7 +666,7 @@ The system logs all the rules which a particular mail hits. Analyzing the logs c
>  lead to finding such a pattern in your environment.
>  
>  You can adjust the score of a rule by creating a new 'Custom Rule Score' entry
> -in the GUI.
> +in the GUI and entering a {spamassassin} rule as the name.
>  
>  NOTE: In general, it is strongly recommended not to make large changes to the
>  default scores.
> @@ -739,9 +739,9 @@ them, as `init.pre`, `v310.pre`, `v320.pre`, `local.cf` will be overwritten by
>  the xref:pmgconfig_template_engine[template engine], while the others can
>  get updated by any {spamassassin} package upgrade.
>  
> -To add your custom configuration, you have to create a new file and name it
> -`custom.cf` (in this directory), then add your configuration there. Make sure
> -to use the correct {spamassassin} syntax, and test it with:
> +To add your custom configuration, you have to create a new file named
> +`custom.cf` (in `/etc/mail/spamassassin/`), then add your configuration there.
> +Make sure to use the correct {spamassassin_rule_syntax} and test it with:
>  
>  ----
>  # spamassassin -D --lint