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