]>
Commit | Line | Data |
---|---|---|
e3eaa56a DM |
1 | Administration |
2 | ============== | |
3 | ||
70dc6dd1 OB |
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 | |
e3eaa56a DM |
7 | order to verify server health. |
8 | ||
9 | ||
10 | Server Administration | |
11 | --------------------- | |
12 | ||
13 | Server status | |
14 | ~~~~~~~~~~~~~ | |
15 | ||
a695a527 | 16 | [thumbnail="pmg-gui-server-status.png", big=1] |
e3eaa56a DM |
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 | ||
a695a527 | 29 | [thumbnail="pmg-gui-service-status.png", big=1] |
e3eaa56a DM |
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 | ||
a695a527 | 48 | [thumbnail="pmg-gui-updates.png", big=1] |
e3eaa56a DM |
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 | |
70dc6dd1 | 52 | available updates, and administrators can run an upgrade by pressing |
e3eaa56a DM |
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 | ||
a695a527 | 62 | [thumbnail="pmg-gui-syslog.png", big=1] |
e3eaa56a | 63 | |
70dc6dd1 | 64 | The syslog page gives you a quick real-time log view. You can use the |
80034065 | 65 | xref:pmg_tracking_center[Tracking Center] to search the logs. |
e3eaa56a DM |
66 | |
67 | ||
68 | Quarantine | |
69 | ---------- | |
70 | ||
71 | Spam | |
72 | ~~~~ | |
73 | ||
a695a527 | 74 | [thumbnail="pmg-gui-spam-quarantine.png", big=1] |
3f02fc6b DM |
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 | |
70dc6dd1 | 81 | {pmg}. |
3f02fc6b | 82 | |
e3eaa56a DM |
83 | |
84 | Virus | |
85 | ~~~~~ | |
86 | ||
3f02fc6b DM |
87 | Allows administrators to inspect quarantined virus mails. |
88 | ||
e3eaa56a | 89 | |
f7d90c0a DC |
90 | Attachment |
91 | ~~~~~~~~~~ | |
92 | ||
93 | Allows administrators to inspect quarantined mails and download their | |
94 | attachments or deliver/delete them. | |
95 | ||
96 | NOTE: Use the options of the 'Remove attachment' action to control the Attachment Quarantine. | |
97 | ||
98 | ||
4a08dffe | 99 | [[pmg_userblackwhitelist]] |
e3eaa56a DM |
100 | User White- and Blacklist |
101 | ~~~~~~~~~~~~~~~~~~~~~~~~~ | |
102 | ||
3f02fc6b DM |
103 | This is mostly useful to debug or verify white- and blacklist user |
104 | settings. The administrator should not change these values because | |
105 | users can manage this themselves. | |
106 | ||
e3eaa56a | 107 | |
80034065 | 108 | [[pmg_tracking_center]] |
e3eaa56a DM |
109 | Tracking Center |
110 | --------------- | |
111 | ||
a695a527 | 112 | [thumbnail="pmg-gui-tracking-center.png", big=1] |
b0a8e83b | 113 | |
e30d2fb3 DM |
114 | Email processing is a complex task and involves several service |
115 | daemons. Each daemon logs information to the syslog service. The | |
70dc6dd1 | 116 | problem is that a server analyzes many emails in parallel, so it is |
e30d2fb3 DM |
117 | usually very hard to find all logs corresponding to a specific mail. |
118 | ||
70dc6dd1 | 119 | The Tracking Center simplifies the search for |
395d1740 TL |
120 | emails dramatically. We use highly optimized and safe Rust footnote:[A language |
121 | empowering everyone to build reliable and efficient software. | |
122 | https://www.rust-lang.org/] code to search the available syslog data. This is | |
123 | very fast and powerful, and works for sites processing several million emails | |
124 | per day. | |
e30d2fb3 DM |
125 | |
126 | The result is a list of received mails, including the following data: | |
127 | ||
128 | [cols="s,5d"] | |
129 | |==== | |
130 | |Time | Timestamp of first found syslog entry. | |
131 | |From | Envelope 'From' address (the sender). | |
132 | |To | The email receiver address. | |
133 | |Status | Delivery status. | |
134 | |Syslog | The corresponding syslog entries are shown if you double click such | |
135 | entry, or if you press the '+' button on the left. | |
136 | |==== | |
137 | ||
70dc6dd1 | 138 | You can specify filters, and most importantly you can set |
e30d2fb3 | 139 | a 'Start' and 'End' time. By default the start time is set to one hour |
70dc6dd1 OB |
140 | ago. If you still get too many entries, you can try to restrict |
141 | the search to a specific sender or receiver address, or search for a | |
e30d2fb3 | 142 | specific text in the logs ('Filter' entry). |
e3eaa56a | 143 | |
70dc6dd1 | 144 | NOTE: Search is faster if you use a shorter time interval. |
268f309d | 145 | |
70dc6dd1 | 146 | The 'Status' field summarizes what happened with an email. {pmg} is a |
f29824e9 | 147 | mail proxy, meaning that the proxy receives mails from outside, |
70dc6dd1 | 148 | processes them and finally sends the result to the receiver. |
f29824e9 DM |
149 | |
150 | The first phase is receiving the mail. The proxy may reject the mail | |
151 | early, or instead accepts the mail and feeds it into the filter. The filter | |
152 | rules can block or accept the mail. | |
153 | ||
154 | In the second phase, accepted mails need to be delivered to the | |
70dc6dd1 | 155 | receiver. This action may also fail or succeed. 'Status' |
6abb9ee3 ML |
156 | combines the result from the first and second phase. |
157 | ||
158 | When before-queue filtering is enabled, we don't have the same delivery information as | |
159 | with after-queue filtering. In this case, if the mail is accepted by the filter, | |
160 | the status is shown as 'queued/accepted' instead of 'accepted/<status>'. | |
f29824e9 DM |
161 | |
162 | [options="header",cols="2s,1d,5d"] | |
163 | |==== | |
164 | |Status |Phase |Description | |
165 | |rejected |1 | Email rejected (e.g. sender IP is listed on a IP blacklist) | |
166 | |greylisted |1 | Email temporarily rejected by greylisting | |
167 | |queued/deferred |1 | Internal Email was queued, still trying to deliver | |
70dc6dd1 | 168 | |queued/bounced |1 | Internal Email was queued but not accepted by the target email server (for example user unknown) |
6abb9ee3 | 169 | |queued/accepted |1 | Email was accepted, no delivery information available (before-queue only, replaces accepted/<status>) |
70dc6dd1 | 170 | |quarantine |1 | Email was moved to quarantine |
f29824e9 DM |
171 | |blocked |1 | Email was blocked by filter rules |
172 | |accepted/deferred |2 | Email accepted, still trying to deliver | |
70dc6dd1 | 173 | |accepted/bounced |2 | Email accepted but not accepted by the target email server (for example user unknown) |
6abb9ee3 | 174 | |accepted/delivered |2 | Email accepted and delivered |
f29824e9 DM |
175 | |==== |
176 | ||
e3eaa56a DM |
177 | |
178 | Postfix Queue Administration | |
179 | ---------------------------- | |
180 | ||
181 | TODO |