[PATCH pmg-docs] pmgconfig: note pmg-smtp-filter needs restart for custom check script

[PATCH pmg-docs] pmgconfig: note pmg-smtp-filter needs restart for custom check script

[Dominik Csapak]

It's implied by other parts of the docs, but not explicitely stated, so
do that to avoid confusion.

Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>
---
 pmgconfig.adoc | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/pmgconfig.adoc b/pmgconfig.adoc
index 00a988e..34dbecc 100644
--- a/pmgconfig.adoc
+++ b/pmgconfig.adoc
@@ -1011,6 +1011,13 @@ section: admin
 The location of the custom check executable can also be set there with the key
 `custom_check_path` and defaults to `/usr/local/bin/pmg-custom-check`.
 
+To enable the changes to the custom check configuration, `pmg-smtp-filter` has
+to be restarted:
+
+----
+# systemctl restart pmg-smtp-filter.service
+----
+
 NOTE: The custom check executable runs as the unprivileged
 `pmg-smtp-filter` daemon user. It cannot elevate privileges with tools
 like `sudo`, as the service runs with the systemd `NoNewPrivileges`
-- 
2.47.3

Re: [PATCH pmg-docs] pmgconfig: note pmg-smtp-filter needs restart for custom check script

[Thomas Lamprecht]

On 11/06/2026 11:38, Dominik Csapak wrote:
> It's implied by other parts of the docs, but not explicitely stated, so
> do that to avoid confusion.

Should we rather handle that automatically too like Stoiko's 'log-headers'
patch?

> 
> Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>
> ---
>  pmgconfig.adoc | 7 +++++++
>  1 file changed, 7 insertions(+)
> 
> diff --git a/pmgconfig.adoc b/pmgconfig.adoc
> index 00a988e..34dbecc 100644
> --- a/pmgconfig.adoc
> +++ b/pmgconfig.adoc
> @@ -1011,6 +1011,13 @@ section: admin
>  The location of the custom check executable can also be set there with the key
>  `custom_check_path` and defaults to `/usr/local/bin/pmg-custom-check`.
>  
> +To enable the changes to the custom check configuration, `pmg-smtp-filter` has
> +to be restarted:
> +
> +----
> +# systemctl restart pmg-smtp-filter.service
> +----
> +
>  NOTE: The custom check executable runs as the unprivileged
>  `pmg-smtp-filter` daemon user. It cannot elevate privileges with tools
>  like `sudo`, as the service runs with the systemd `NoNewPrivileges`

Re: [PATCH pmg-docs] pmgconfig: note pmg-smtp-filter needs restart for custom check script

[Dominik Csapak]

On 6/11/26 12:40 PM, Thomas Lamprecht wrote:
> On 11/06/2026 11:38, Dominik Csapak wrote:
>> It's implied by other parts of the docs, but not explicitely stated, so
>> do that to avoid confusion.
> 
> Should we rather handle that automatically too like Stoiko's 'log-headers'
> patch?


we could, but makes less sense IMO since the user has to be on the cli 
anyway for putting the script somewhere?

if we'd put it on the gui, i'd say yes definitely, but currently it
won't gain us much. We'd then have to either
* write another note to do 'pmgconfig sync' (maybe with '--restart 1' ?)
* or add a new 'pmgconfig set' command to the cli (which would be
   beneficial in any case i guess) and document that in the docs.

> 
>>
>> Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>
>> ---
>>   pmgconfig.adoc | 7 +++++++
>>   1 file changed, 7 insertions(+)
>>
>> diff --git a/pmgconfig.adoc b/pmgconfig.adoc
>> index 00a988e..34dbecc 100644
>> --- a/pmgconfig.adoc
>> +++ b/pmgconfig.adoc
>> @@ -1011,6 +1011,13 @@ section: admin
>>   The location of the custom check executable can also be set there with the key
>>   `custom_check_path` and defaults to `/usr/local/bin/pmg-custom-check`.
>>   
>> +To enable the changes to the custom check configuration, `pmg-smtp-filter` has
>> +to be restarted:
>> +
>> +----
>> +# systemctl restart pmg-smtp-filter.service
>> +----
>> +
>>   NOTE: The custom check executable runs as the unprivileged
>>   `pmg-smtp-filter` daemon user. It cannot elevate privileges with tools
>>   like `sudo`, as the service runs with the systemd `NoNewPrivileges`
> 

Re: [PATCH pmg-docs] pmgconfig: note pmg-smtp-filter needs restart for custom check script

[Stoiko Ivanov]

On Thu, 11 Jun 2026 12:40:57 +0200
Thomas Lamprecht <t.lamprecht@proxmox.com> wrote:

> On 11/06/2026 11:38, Dominik Csapak wrote:
> > It's implied by other parts of the docs, but not explicitely stated, so
> > do that to avoid confusion.  
> 
> Should we rather handle that automatically too like Stoiko's 'log-headers'
> patch?
Hm - I talked with Dominik off-list about that - and I argued that the
script needs to be put in place by the admin anyways, and that I'd expect
them to edit /etc/pmg/pmg.conf in place directly (which would not get
noticed by pmgdaemon) - but since
* there might be an use-case where admins disable the custom-check in some
  automated fashion (not that I have a good use-case in mind)
* afaict `pmgconfig sync -restart 1` would also trigger the reload if it's
  added to the list.

TBH - not sure if it will make the UX better for many users, but having a
bit of consistency here might cause fewer confused questions why this
particular setting does not trigger the reload compared to many others.. -
so am not opposed to adding it.
(not sure if we did not simply skip it by mistake when the reload
triggering of smtp-filter was added)