Administration
==============
-The Administration GUI allows you to do common administration tasks
-like updating software packages, manage quarantine, view service
-status and manage mail queues. It also provides server statistics in
+The Administration GUI allows you to do common tasks
+such as updating software packages, managing quarantine, viewing service
+status, and managing mail queues. It also provides server statistics in
order to verify server health.
We release software updates on a regular basis, and it is recommended
to always run the latest available version. This page shows the
-available updates, and administrator can run an upgrade by pressing
+available updates, and administrators can run an upgrade by pressing
the 'Upgrade' button.
See section xref:pmg_package_repositories[Package Repositories] for
[thumbnail="pmg-gui-syslog.png", big=1]
-The syslog page gives you a quick real-time log view. Please use the
+The syslog page gives you a quick real-time log view. You can use the
xref:pmg_tracking_center[Tracking Center] to search the logs.
The email preview on the web interface is very secure as malicious
code (attacking your operating system or email client) is removed by
-Proxmox.
+{pmg}.
+
+Users can get access to their personalized quarantine via the daily
+spam report, or by logging in with their LDAP credentials.
+
+You can additionally enable user self-service for sending an access link from
+the Quarantine Login page.
+To enable this on the Quarantine Login page, edit `/etc/pmg/pmg.conf`, see section
+xref:pmgconfig_spamdetector_quarantine[Spam Detector Configuration - Quarantine]
+for more details about the available settings.
Virus
Email processing is a complex task and involves several service
daemons. Each daemon logs information to the syslog service. The
-problem is that a servers analyzes many emails in parallel, so it is
+problem is that a server analyzes many emails in parallel, so it is
usually very hard to find all logs corresponding to a specific mail.
-Introduced in {pmg} 2.1, the tracking center simplifies the search for
-emails dramatically. We use highly optimized C-code to search the
-available syslog data. This is very fast and powerful, and works for
-sites processing several million emails per day.
+The Tracking Center simplifies the search for
+emails dramatically. We use highly optimized and safe Rust footnote:[A language
+empowering everyone to build reliable and efficient software.
+https://www.rust-lang.org/] code to search the available syslog data. This is
+very fast and powerful, and works for sites processing several million emails
+per day.
The result is a list of received mails, including the following data:
entry, or if you press the '+' button on the left.
|====
-Please notice that you can specify filters, most important you can set
+You can specify filters, and most importantly you can set
a 'Start' and 'End' time. By default the start time is set to one hour
-ago. If you still get to much result entries, you can try to restrict
-the search to specific sender or receiver addresses, or search for a
+ago. If you still get too many entries, you can try to restrict
+the search to a specific sender or receiver address, or search for a
specific text in the logs ('Filter' entry).
-NOTE: Search is faster if you use a short time interval.
+NOTE: Search is faster if you use a shorter time interval.
-The 'Status' field summarize what happens with an email. {pmg} is a
+The 'Status' field summarizes what happened with an email. {pmg} is a
mail proxy, meaning that the proxy receives mails from outside,
-process it and finally sends the result to the receiver.
+processes them and finally sends the result to the receiver.
The first phase is receiving the mail. The proxy may reject the mail
early, or instead accepts the mail and feeds it into the filter. The filter
rules can block or accept the mail.
In the second phase, accepted mails need to be delivered to the
-receiver, and this action may also fail or succeed. The status
+receiver. This action may also fail or succeed. 'Status'
combines the result from the first and second phase.
-When before-queue filtering is enabled, we don't have the same delivery information as
-with after-queue filtering. In this case, if the mail is accepted by the filter,
-the status is shown as 'queued/accepted' instead of 'accepted/<status>'.
-
[options="header",cols="2s,1d,5d"]
|====
|Status |Phase |Description
|rejected |1 | Email rejected (e.g. sender IP is listed on a IP blacklist)
|greylisted |1 | Email temporarily rejected by greylisting
|queued/deferred |1 | Internal Email was queued, still trying to deliver
-|queued/bounced |1 | Internal Email was queued but not accepted by the target email server (e. g. user unknown)
-|queued/accepted |1 | Email was accepted, no delivery information available (before-queue only, replaces accepted/<status>)
-|quarantine |1 | Email was moved to quanantine
+|queued/bounced |1 | Internal Email was queued but not accepted by the target email server (for example user unknown)
+|queued/delivered |1 | Internal Email was queued and delivered
+|quarantine |1 | Email was moved to quarantine
|blocked |1 | Email was blocked by filter rules
|accepted/deferred |2 | Email accepted, still trying to deliver
-|accepted/bounced |2 | Email accepted but not accepted by the target email server (e. g. user unknown)
+|accepted/bounced |2 | Email accepted but not accepted by the target email server (for example user unknown)
|accepted/delivered |2 | Email accepted and delivered
|====
-
+[[postfix_queue_administration]]
Postfix Queue Administration
----------------------------
-TODO
+[thumbnail="pmg-gui-queue-admin-summary.png", big=1]
+
+Mail-queues are one of the central concepts of the SMTP protocol. Once a
+mailserver accepts a mail for further processing it saves it to a queue.
+After the mail is either relayed to another system, stored locally
+or discarded, it is deleted from the local mail-queue.
+
+If immediate processing is not possible, for example because a downstream
+mailserver is not reachable, the mail remains on the queue for later
+processing.
+
+The 'Queue Administration' panel provides a summary about the current state
+of the postfix mail-queue, similar to the 'qshape (1)' command-line utility.
+
+It shows domains for which mails were not delivered, and how long they have
+been queued.
+
+The three Action Buttons on top provide the most common queue operations:
+
+'Flush Queue'::
+
+Attempt to deliver all currently queued mail, for example if a downstream
+server has become available again.
+
+'Delete All Messages'::
+
+Delete all currently queued mail, for example if the queue contains only spam.
+
+'Discard address verification database'::
+
+Clear the recipient verification cache.
+
+A sudden increase of queued mails should be checked out closely. It can
+indicate issues connecting to downstream servers.
+This can also mean that one of the servers for which you relay emails sends
+spam itself.
+
+Deferred Mail
+~~~~~~~~~~~~~
+[thumbnail="pmg-gui-queue-admin-deferred.png"]
+
+In the 'Deferred Mail' tab you can examine each deferred email separately.
+Besides providing the contact information about sender and receiver you can
+also check the reason for an email being still queued.
+
+You can view the complete headers and filter by sender or receiver of queued up
+mails.
+
+Here you can also flush or delete each deferred email independently.
projects / pmg-docs.git / blobdiff