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 You can additionally enable user self-service for sending an access link from
  87 the Quarantine Login page.
  88 To enable this on the Quarantine Login page, edit `/etc/pmg/pmg.conf`, see section
  89 xref:pmgconfig_spamdetector_quarantine[Spam Detector Configuration - Quarantine]
  90 for more details about the available settings.
  91
  92
  93 Virus
  94 ~~~~~
  95
  96 Allows administrators to inspect quarantined virus mails.
  97
  98
  99 Attachment
 100 ~~~~~~~~~~
 101
 102 Allows administrators to inspect quarantined mails and download their
 103 attachments or deliver/delete them.
 104
 105 NOTE: Use the options of the 'Remove attachment' action to control the Attachment Quarantine.
 106
 107
 108 [[pmg_userblackwhitelist]]
 109 User White- and Blacklist
 110 ~~~~~~~~~~~~~~~~~~~~~~~~~
 111
 112 This is mostly useful to debug or verify white- and blacklist user
 113 settings. The administrator should not change these values because
 114 users can manage this themselves.
 115
 116
 117 [[pmg_tracking_center]]
 118 Tracking Center
 119 ---------------
 120
 121 [thumbnail="pmg-gui-tracking-center.png", big=1]
 122
 123 Email processing is a complex task and involves several service
 124 daemons. Each daemon logs information to the syslog service. The
 125 problem is that a server analyzes many emails in parallel, so it is
 126 usually very hard to find all logs corresponding to a specific mail.
 127
 128 The Tracking Center simplifies the search for
 129 emails dramatically. We use highly optimized and safe Rust footnote:[A language
 130 empowering everyone to build reliable and efficient software.
 131 https://www.rust-lang.org/] code to search the available syslog data. This is
 132 very fast and powerful, and works for sites processing several million emails
 133 per day.
 134
 135 The result is a list of received mails, including the following data:
 136
 137 [cols="s,5d"]
 138 |====
 139 |Time | Timestamp of first found syslog entry.
 140 |From | Envelope 'From' address (the sender).
 141 |To   | The email receiver address.
 142 |Status | Delivery status.
 143 |Syslog | The corresponding syslog entries are shown if you double click such
 144 entry, or if you press the '+' button on the left.
 145 |====
 146
 147 You can specify filters, and most importantly you can set
 148 a 'Start' and 'End' time. By default the start time is set to one hour
 149 ago. If you still get too many entries, you can try to restrict
 150 the search to a specific sender or receiver address, or search for a
 151 specific text in the logs ('Filter' entry).
 152
 153 NOTE: Search is faster if you use a shorter time interval.
 154
 155 The 'Status' field summarizes what happened with an email. {pmg} is a
 156 mail proxy, meaning that the proxy receives mails from outside,
 157 processes them and finally sends the result to the receiver.
 158
 159 The first phase is receiving the mail. The proxy may reject the mail
 160 early, or instead accepts the mail and feeds it into the filter. The filter
 161 rules can block or accept the mail.
 162
 163 In the second phase, accepted mails need to be delivered to the
 164 receiver. This action may also fail or succeed. 'Status'
 165 combines the result from the first and second phase.
 166
 167 [options="header",cols="2s,1d,5d"]
 168 |====
 169 |Status |Phase |Description
 170 |rejected             |1 | Email rejected (e.g. sender IP is listed on a IP blacklist)
 171 |greylisted           |1 | Email temporarily rejected by greylisting
 172 |queued/deferred      |1 | Internal Email was queued, still trying to deliver
 173 |queued/bounced       |1 | Internal Email was queued but not accepted by the target email server (for example user unknown)
 174 |queued/delivered     |1 | Internal Email was queued and delivered
 175 |quarantine           |1 | Email was moved to quarantine
 176 |blocked              |1 | Email was blocked by filter rules
 177 |accepted/deferred    |2 | Email accepted, still trying to deliver
 178 |accepted/bounced     |2 | Email accepted but not accepted by the target email server (for example user unknown)
 179 |accepted/delivered   |2 | Email accepted and delivered
 180 |====
 181
 182 [[postfix_queue_administration]]
 183 Postfix Queue Administration
 184 ----------------------------
 185
 186 [thumbnail="pmg-gui-queue-admin-summary.png", big=1]
 187
 188 Mail-queues are one of the central concepts of the SMTP protocol. Once a
 189 mailserver accepts a mail for further processing it saves it to a queue.
 190 After the mail is either relayed to another system, stored locally
 191 or discarded, it is deleted from the local mail-queue.
 192
 193 If immediate processing is not possible, for example because a downstream
 194 mailserver is not reachable, the mail remains on the queue for later
 195 processing.
 196
 197 The 'Queue Administration' panel provides a summary about the current state
 198 of the postfix mail-queue, similar to the 'qshape (1)' command-line utility.
 199
 200 It shows domains for which mails were not delivered, and how long they have
 201 been queued.
 202
 203 The three Action Buttons on top provide the most common queue operations:
 204
 205 'Flush Queue'::
 206
 207 Attempt to deliver all currently queued mail, for example if a downstream
 208 server has become available again.
 209
 210 'Delete All Messages'::
 211
 212 Delete all currently queued mail, for example if the queue contains only spam.
 213
 214 'Discard address verification database'::
 215
 216 Clear the recipient verification cache.
 217
 218 A sudden increase of queued mails should be checked out closely. It can
 219 indicate issues connecting to downstream servers.
 220 This can also mean that one of the servers for which you relay emails sends
 221 spam itself.
 222
 223 Deferred Mail
 224 ~~~~~~~~~~~~~
 225 [thumbnail="pmg-gui-queue-admin-deferred.png"]
 226
 227 In the 'Deferred Mail' tab you can examine each deferred email separately.
 228 Besides providing the contact information about sender and receiver you can
 229 also check the reason for an email being still queued.
 230
 231 You can view the complete headers and filter by sender or receiver of queued up
 232 mails.
 233
 234 Here you can also flush or delete each deferred email independently.