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