]> git.proxmox.com Git - pmg-docs.git/blobdiff - pmg-administration.adoc
add documentation for RAR support
[pmg-docs.git] / pmg-administration.adoc
index 1018db4941a8fc39905950906668ce741a9188f2..28e51c385acf98266243ab0c02a7b44860488250 100644 (file)
@@ -1,9 +1,9 @@
 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.
 
 
@@ -13,7 +13,7 @@ Server Administration
 Server status
 ~~~~~~~~~~~~~
 
-image::images/screenshot/pmg-gui-server-status.png[]
+[thumbnail="pmg-gui-server-status.png", big=1]
 
 This page shows server statistics about CPU, memory, disk and network
 usage. You can select the displayed time span on the upper right.
@@ -26,7 +26,7 @@ button. It is also possible to trigger a server 'Restart' or
 Services
 ~~~~~~~~
 
-image::images/screenshot/pmg-gui-service-status.png[]
+[thumbnail="pmg-gui-service-status.png", big=1]
 
 This panel lists all major services used for mail processing and
 cluster synchronization. If necessary, you can start, stop or restart
@@ -45,11 +45,11 @@ systemctl status postfix
 Updates
 ~~~~~~~
 
-image::images/screenshot/pmg-gui-updates.png[]
+[thumbnail="pmg-gui-updates.png", big=1]
 
 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
@@ -59,9 +59,9 @@ details abaout available package repositories.
 Syslog and Tasks
 ~~~~~~~~~~~~~~~~
 
-image::images/screenshot/pmg-gui-syslog.png[]
+[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.
 
 
@@ -71,14 +71,14 @@ Quarantine
 Spam
 ~~~~
 
-image::images/screenshot/pmg-gui-spam-quarantine.png[]
+[thumbnail="pmg-gui-spam-quarantine.png", big=1]
 
 This panel lets you inspect the mail quarantine. Emails can be safely
 previewed and if desired, delivered to the original user.
 
 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}.
 
 
 Virus
@@ -87,6 +87,15 @@ Virus
 Allows administrators to inspect quarantined virus mails.
 
 
+Attachment
+~~~~~~~~~~
+
+Allows administrators to inspect quarantined mails and download their
+attachments or deliver/delete them.
+
+NOTE: Use the options of the 'Remove attachment' action to control the Attachment Quarantine.
+
+
 [[pmg_userblackwhitelist]]
 User White- and Blacklist
 ~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -100,17 +109,19 @@ users can manage this themselves.
 Tracking Center
 ---------------
 
-image::images/screenshot/pmg-gui-tracking-center.png[]
+[thumbnail="pmg-gui-tracking-center.png", big=1]
 
 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:
 
@@ -124,25 +135,25 @@ 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
-combines the result from the first and second phase:
+receiver. This action may also fail or succeed. 'Status'
+combines the result from the first and second phase.
 
 [options="header",cols="2s,1d,5d"]
 |====
@@ -150,16 +161,65 @@ combines the result from the first and second phase:
 |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)
-|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/delivered   |2 | Email accepted and deliverd
+|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.