pmg-administration.adoc

   1 Administration
   2 ==============
   3
   4 The Administration GUI allows you to do common administration tasks
   5 like updating software packages, manage quarantine, view service
   6 status and manage 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 image::images/screenshot/pmg-gui-server-status.png[]
  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 image::images/screenshot/pmg-gui-service-status.png[]
  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 image::images/screenshot/pmg-gui-updates.png[]
  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 administrator 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 image::images/screenshot/pmg-gui-syslog.png[]
  63
  64 The syslog page gives you a quick real-time log view. Please use the
  65 xref:pmg_tracking_center[Tracking Center] to search the logs.
  66
  67
  68 Quarantine
  69 ----------
  70
  71 Spam
  72 ~~~~
  73
  74 image::images/screenshot/pmg-gui-spam-quarantine.png[]
  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 Proxmox.
  82
  83
  84 Virus
  85 ~~~~~
  86
  87 Allows administrators to inspect quarantined virus mails.
  88
  89
  90 [[pmg_userblackwhitelist]]
  91 User White- and Blacklist
  92 ~~~~~~~~~~~~~~~~~~~~~~~~~
  93
  94 This is mostly useful to debug or verify white- and blacklist user
  95 settings. The administrator should not change these values because
  96 users can manage this themselves.
  97
  98
  99 [[pmg_tracking_center]]
 100 Tracking Center
 101 ---------------
 102
 103 image::images/screenshot/pmg-gui-tracking-center.png[]
 104
 105 Email processing is a complex task and involves several service
 106 daemons. Each daemon logs information to the syslog service. The
 107 problem is that a servers analyzes many emails in parallel, so it is
 108 usually very hard to find all logs corresponding to a specific mail.
 109
 110 Introduced in {pmg} 2.1, the tracking center simplifies the search for
 111 emails dramatically. We use highly optimized C-code to search the
 112 available syslog data. This is very fast and powerful, and works for
 113 sites processing several million emails per day.
 114
 115 The result is a list of received mails, including the following data:
 116
 117 [cols="s,5d"]
 118 |====
 119 |Time | Timestamp of first found syslog entry.
 120 |From | Envelope 'From' address (the sender).
 121 |To   | The email receiver address.
 122 |Status | Delivery status.
 123 |Syslog | The corresponding syslog entries are shown if you double click such
 124 entry, or if you press the '+' button on the left.
 125 |====
 126
 127 Please notice that you can specify filters, most important you can set
 128 a 'Start' and 'End' time. By default the start time is set to one hour
 129 ago. If you still get to much result entries, you can try to restrict
 130 the search to specific sender or receiver addresses, or search for a
 131 specific text in the logs ('Filter' entry).
 132
 133 NOTE: Search is faster if you use a short time interval.
 134
 135 The 'Status' field summarize what happens with an email. {pmg} is a
 136 mail proxy, meaning that the proxy receives mails from outside,
 137 process it and finally sends the result to the receiver.
 138
 139 The first phase is receiving the mail. The proxy may reject the mail
 140 early, or instead accepts the mail and feeds it into the filter. The filter
 141 rules can block or accept the mail.
 142
 143 In the second phase, accepted mails need to be delivered to the
 144 receiver, and this action may also fail or succeed. The status
 145 combines the result from the first and second phase:
 146
 147 [options="header",cols="2s,1d,5d"]
 148 |====
 149 |Status |Phase |Description
 150 |rejected             |1 | Email rejected (e.g. sender IP is listed on a IP blacklist)
 151 |greylisted           |1 | Email temporarily rejected by greylisting
 152 |queued/deferred      |1 | Internal Email was queued, still trying to deliver
 153 |queued/bounced       |1 | Internal Email was queued but not accepted by the target email server (e. g. user unknown)
 154 |quarantine           |1 | Email was moved to quanantine
 155 |blocked              |1 | Email was blocked by filter rules
 156 |accepted/deferred    |2 | Email accepted, still trying to deliver
 157 |accepted/bounced     |2 | Email accepted but not accepted by the target email server (e. g. user unknown)
 158 |accepted/delivered   |2 | Email accepted and deliverd
 159 |====
 160
 161
 162 Postfix Queue Administration
 163 ----------------------------
 164
 165 TODO