pmg-administration.adoc

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