pmg-administration.adoc

   1 Administration
   2 ==============
   3
   4 The Administration GUI allows you to do common tasks
   5 such as updating software packages, managing quarantine, viewing service
   6 status, and managing mail queues. It also provides server statistics in
   7 order to verify server health.
   8
   9
  10 Server Administration
  11 ---------------------
  12
  13 Server status
  14 ~~~~~~~~~~~~~
  15
  16 [thumbnail="pmg-gui-server-status.png", big=1]
  17
  18 This page shows server statistics about CPU, memory, disk and network
  19 usage. You can select the displayed time span on the upper right.
  20
  21 Administrators can open a terminal window using the 'Console'
  22 button. It is also possible to trigger a server 'Restart' or
  23 'Shutdown'.
  24
  25
  26 Services
  27 ~~~~~~~~
  28
  29 [thumbnail="pmg-gui-service-status.png", big=1]
  30
  31 This panel lists all major services used for mail processing and
  32 cluster synchronization. If necessary, you can start, stop or restart
  33 them. The 'Syslog' button shows the system log filtered for the
  34 selected service.
  35
  36 Please note that {pmg} uses {systemd} to manage services, so you can
  37 also use the standard `systemctl` command line tool to manage or view
  38 service status, for example:
  39
  40 -----
  41 systemctl status postfix
  42 -----
  43
  44
  45 Updates
  46 ~~~~~~~
  47
  48 [thumbnail="pmg-gui-updates.png", big=1]
  49
  50 We release software updates on a regular basis, and it is recommended
  51 to always run the latest available version. This page shows the
  52 available updates, and administrators can run an upgrade by pressing
  53 the 'Upgrade' button.
  54
  55 See section xref:pmg_package_repositories[Package Repositories] for
  56 details abaout available package repositories.
  57
  58
  59 Syslog and Tasks
  60 ~~~~~~~~~~~~~~~~
  61
  62 [thumbnail="pmg-gui-syslog.png", big=1]
  63
  64 The syslog page gives you a quick real-time log view. You can use the
  65 xref:pmg_tracking_center[Tracking Center] to search the logs.
  66
  67
  68 Quarantine
  69 ----------
  70
  71 Spam
  72 ~~~~
  73
  74 [thumbnail="pmg-gui-spam-quarantine.png", big=1]
  75
  76 This panel lets you inspect the mail quarantine. Emails can be safely
  77 previewed and if desired, delivered to the original user.
  78
  79 The email preview on the web interface is very secure as malicious
  80 code (attacking your operating system or email client) is removed by
  81 {pmg}.
  82
  83 Users can get access to their personalized quarantine via the daily
  84 spam report, or by logging in with their LDAP credentials.
  85
  86 Alternatively you can enable the link on Quarantine Login page. There users will get
  87 a link to their personalized quarantine.
  88 To enable this on the Quarantine Login page, edit `/etc/pmg/pmg.conf`  (see section xref:pmgconfig_spamdetector_quarantine[Spam Detector Configuration - Quarantine])
  89
  90
  91 Virus
  92 ~~~~~
  93
  94 Allows administrators to inspect quarantined virus mails.
  95
  96
  97 Attachment
  98 ~~~~~~~~~~
  99
 100 Allows administrators to inspect quarantined mails and download their
 101 attachments or deliver/delete them.
 102
 103 NOTE: Use the options of the 'Remove attachment' action to control the Attachment Quarantine.
 104
 105
 106 [[pmg_userblackwhitelist]]
 107 User White- and Blacklist
 108 ~~~~~~~~~~~~~~~~~~~~~~~~~
 109
 110 This is mostly useful to debug or verify white- and blacklist user
 111 settings. The administrator should not change these values because
 112 users can manage this themselves.
 113
 114
 115 [[pmg_tracking_center]]
 116 Tracking Center
 117 ---------------
 118
 119 [thumbnail="pmg-gui-tracking-center.png", big=1]
 120
 121 Email processing is a complex task and involves several service
 122 daemons. Each daemon logs information to the syslog service. The
 123 problem is that a server analyzes many emails in parallel, so it is
 124 usually very hard to find all logs corresponding to a specific mail.
 125
 126 The Tracking Center simplifies the search for
 127 emails dramatically. We use highly optimized and safe Rust footnote:[A language
 128 empowering everyone to build reliable and efficient software.
 129 https://www.rust-lang.org/] code to search the available syslog data. This is
 130 very fast and powerful, and works for sites processing several million emails
 131 per day.
 132
 133 The result is a list of received mails, including the following data:
 134
 135 [cols="s,5d"]
 136 |====
 137 |Time | Timestamp of first found syslog entry.
 138 |From | Envelope 'From' address (the sender).
 139 |To   | The email receiver address.
 140 |Status | Delivery status.
 141 |Syslog | The corresponding syslog entries are shown if you double click such
 142 entry, or if you press the '+' button on the left.
 143 |====
 144
 145 You can specify filters, and most importantly you can set
 146 a 'Start' and 'End' time. By default the start time is set to one hour
 147 ago. If you still get too many entries, you can try to restrict
 148 the search to a specific sender or receiver address, or search for a
 149 specific text in the logs ('Filter' entry).
 150
 151 NOTE: Search is faster if you use a shorter time interval.
 152
 153 The 'Status' field summarizes what happened with an email. {pmg} is a
 154 mail proxy, meaning that the proxy receives mails from outside,
 155 processes them and finally sends the result to the receiver.
 156
 157 The first phase is receiving the mail. The proxy may reject the mail
 158 early, or instead accepts the mail and feeds it into the filter. The filter
 159 rules can block or accept the mail.
 160
 161 In the second phase, accepted mails need to be delivered to the
 162 receiver. This action may also fail or succeed. 'Status'
 163 combines the result from the first and second phase.
 164
 165 [options="header",cols="2s,1d,5d"]
 166 |====
 167 |Status |Phase |Description
 168 |rejected             |1 | Email rejected (e.g. sender IP is listed on a IP blacklist)
 169 |greylisted           |1 | Email temporarily rejected by greylisting
 170 |queued/deferred      |1 | Internal Email was queued, still trying to deliver
 171 |queued/bounced       |1 | Internal Email was queued but not accepted by the target email server (for example user unknown)
 172 |queued/delivered     |1 | Internal Email was queued and delivered
 173 |quarantine           |1 | Email was moved to quarantine
 174 |blocked              |1 | Email was blocked by filter rules
 175 |accepted/deferred    |2 | Email accepted, still trying to deliver
 176 |accepted/bounced     |2 | Email accepted but not accepted by the target email server (for example user unknown)
 177 |accepted/delivered   |2 | Email accepted and delivered
 178 |====
 179
 180 [[postfix_queue_administration]]
 181 Postfix Queue Administration
 182 ----------------------------
 183
 184 [thumbnail="pmg-gui-queue-admin-summary.png", big=1]
 185
 186 Mail-queues are one of the central concepts of the SMTP protocol. Once a
 187 mailserver accepts a mail for further processing it saves it to a queue.
 188 After the mail is either relayed to another system, stored locally
 189 or discarded, it is deleted from the local mail-queue.
 190
 191 If immediate processing is not possible, for example because a downstream
 192 mailserver is not reachable, the mail remains on the queue for later
 193 processing.
 194
 195 The 'Queue Administration' panel provides a summary about the current state
 196 of the postfix mail-queue, similar to the 'qshape (1)' command-line utility.
 197
 198 It shows domains for which mails were not delivered, and how long they have
 199 been queued.
 200
 201 The three Action Buttons on top provide the most common queue operations:
 202
 203 'Flush Queue'::
 204
 205 Attempt to deliver all currently queued mail, for example if a downstream
 206 server has become available again.
 207
 208 'Delete All Messages'::
 209
 210 Delete all currently queued mail, for example if the queue contains only spam.
 211
 212 'Discard address verification database'::
 213
 214 Clear the recipient verification cache.
 215
 216 A sudden increase of queued mails should be checked out closely. It can
 217 indicate issues connecting to downstream servers.
 218 This can also mean that one of the servers for which you relay emails sends
 219 spam itself.
 220
 221 Deferred Mail
 222 ~~~~~~~~~~~~~
 223 [thumbnail="pmg-gui-queue-admin-deferred.png"]
 224
 225 In the 'Deferred Mail' tab you can examine each deferred email separately.
 226 Besides providing the contact information about sender and receiver you can
 227 also check the reason for an email being still queued.
 228
 229 You can view the complete headers and filter by sender or receiver of queued up
 230 mails.
 231
 232 Here you can also flush or delete each deferred email independently.