system: gromox-cleaner.service and timer unit

References: GXH-111, GXH-117

Author: jengelh

Makefile.am

@@ -30,7 +30,8 @@ phplib_LTLIBRARIES = mapi.la
 endif
 dist_sysusers_DATA = system/sysusers-gromox.conf
 dist_tmpfiles_DATA = system/tmpfiles-gromox.conf
-dist_unit_DATA = system/gromox-delivery.service \
+dist_unit_DATA = system/gromox-cleaner.service system/gromox-cleaner.timer \
+	system/gromox-delivery.service \
 	system/gromox-delivery-queue.service system/gromox-event.service \
 	system/gromox-http.service system/gromox-imap.service \
 	system/gromox-midb.service system/gromox-pop3.service \
@@ -312,7 +313,8 @@ dist_man_MANS = \
 	doc/exchange_nsp.4gx doc/exchange_rfr.4gx \
 	doc/exmdb_local.4gx doc/exmdb_provider.4gx \
 	doc/gromox.7 doc/gromox.cfg.5 doc/gromox-abktconv.8 \
-	doc/gromox-abktpull.8 doc/gromox-dbop.8 doc/gromox-dscli.8 \
+	doc/gromox-abktpull.8 doc/gromox-cleaner.service.8 \
+	doc/gromox-dbop.8 doc/gromox-dscli.8 \
 	doc/gromox-e2ghelper.8 \
 	doc/gromox-eml2mbox.8 doc/gromox-eml2mt.8 doc/gromox-exm2eml.8 \
 	doc/gromox-exm2ical.8 doc/gromox-exm2mt.8 doc/gromox-exm2tnef.8 \

doc/gromox-cleaner.service.8

@@ -0,0 +1,23 @@
+.\" SPDX-License-Identifier: CC-BY-SA-4.0 or-later
+.\" SPDX-FileCopyrightText: 2020-2022 grommunio GmbH
+.TH gromox\-cleaner.service 8 "" "Gromox" "Gromox admin reference"
+.SH Name
+gromox\-cleaner.service, gromox\-cleaner.timer \(em Soft-deleted
+message/attachment removal
+.SH Description
+gromox\-cleaner.service is a systemd unit that invokes gromox\-mbop(8) to clear
+out soft-deleted messages from stores, as well as reclaim space by deleting
+orphaned on-disk attachment files which are no longer referenced by any
+message. Usually, the service is invoked periodically from
+gromox\-cleaner.timer.
+.SH Configuration
+/etc/gromox/gromox.cfg is read for the following directives:
+.TP
+\fBsoftpurge_purgetime\fP
+Controls the lifetime of soft-deleted messages. Messages which have the
+soft-delete flag (a.k.a. "hidden flag" in Exchange) and which have their
+PR_LAST_MODIFICATION_TIME older than this interval are hard-deleted.
+.br
+Default: \fI30days\fP
+.SH See also
+\fBgromox\fP(7), \fBgromox\-mbop\fP(8)

doc/gromox.7

@@ -87,6 +87,8 @@ delivery-queue(8gx) \(em LMTP/SMTP frontend for local delivery
 user_filter(4gx) \(em Service plugin for application of user login limits
 .SS Auxiliary services
 .IP \(bu 4
+gromox\-cleaner.service(8) \(em Soft-deleted message/attachment removal
+.IP \(bu 4
 pam_gromox(4gx) \(em a PAM plugin to authenticate with Gromox
 .IP \(bu 4
 event(8gx) \(em Folder change notification daemon

doc/gromox.cfg.5

@@ -9,6 +9,9 @@ service had separate configuration files, but the number of directives that
 needed explicit configuration were reduced over time to the point that there
 were too many distinct files for little value, and so, gromox.cfg came to be.
 .SH Configuration directives
+.PP
+This manpage does not describe all possible directives. Please also consult the
+manpages of gromox daemons and command-line utilities for more.
 .TP
 \fBautoreply_silence_window\fP
 If an autoreply message (other than a bounce report, e.g. out-of-office) is to

system/gromox-cleaner.service

@@ -0,0 +1,19 @@
+[Unit]
+Description=Gromox mailbox cleaner
+Requisite=gromox-http.service
+After=gromox-http.service
+
+[Service]
+# Fallback if EnvironmentFile hasn't got any value
+Environment=softdelete_purgetime=30d
+EnvironmentFile=/etc/gromox/gromox.cfg
+ExecStart=/usr/sbin/gromox-mbop foreach.here.mb ( purge-softdelete -d ${PURGETIME} -r / ) ( purge-datafiles )
+MemoryDenyWriteExecute=yes
+PrivateDevices=yes
+PrivateNetwork=yes
+PrivateUsers=no
+ProtectControlGroups=yes
+ProtectKernelModules=yes
+ProtectKernelTunables=yes
+SystemCallFilter=@default @file-system @basic-io @system-service
+Type=oneshot

system/gromox-cleaner.timer

@@ -0,0 +1,10 @@
+[Unit]
+Description=Periodic purge of softdeleted items in Gromox mailboxes
+
+[Timer]
+OnCalendar=daily
+Persistent=true
+WakeSystem=no
+
+[Install]
+WantedBy=timers.target