]>
Commit | Line | Data |
---|---|---|
e62ceaf0 DM |
1 | [[chapter_pmgconfig]] |
2 | ifdef::manvolnum[] | |
3 | pmgconfig(1) | |
4 | ============ | |
5 | :pmg-toplevel: | |
6 | ||
7 | NAME | |
8 | ---- | |
9 | ||
10 | pmgconfig - Proxmox Mail Gateway Configuration Management Toolkit | |
11 | ||
12 | ||
13 | SYNOPSIS | |
14 | -------- | |
15 | ||
16 | include::pmgconfig.1-synopsis.adoc[] | |
17 | ||
18 | ||
19 | DESCRIPTION | |
20 | ----------- | |
21 | endif::manvolnum[] | |
22 | ifndef::manvolnum[] | |
66e9c719 DM |
23 | Configuration Management |
24 | ======================== | |
e62ceaf0 DM |
25 | :pmg-toplevel: |
26 | endif::manvolnum[] | |
27 | ||
685576c2 DM |
28 | {pmg} is usually configured using the web-based Graphical User |
29 | Interface (GUI), but it is also possible to directly edit the | |
30 | configuration files, use the REST API over 'https' | |
66e9c719 | 31 | or the command line tool `pmgsh`. |
685576c2 | 32 | |
66e9c719 | 33 | The command line tool `pmgconfig` is used to simplify some common |
685576c2 DM |
34 | configuration tasks, i.e. to generate cerificates and to rewrite |
35 | service configuration files. | |
36 | ||
66e9c719 DM |
37 | NOTE: We use a Postgres database to store mail filter rules and |
38 | statistic data. See chapter xref:chapter_pmgdb[Database Management] | |
39 | for more information. | |
40 | ||
41 | ||
42 | Configuration files overview | |
43 | ---------------------------- | |
44 | ||
45 | `/etc/network/interfaces`:: | |
46 | ||
47 | Network setup. We never modify this files directly. Instead, we write | |
48 | changes to `/etc/network/interfaces.new`. When you reboot, we rename | |
49 | the file to `/etc/network/interfaces`, so any changes gets activated | |
50 | on the next reboot. | |
51 | ||
9bfe27f3 DM |
52 | `/etc/resolv.conf`:: |
53 | ||
54 | DNS search domain and nameserver setup. | |
55 | ||
56 | `/etc/hostname`:: | |
57 | ||
58 | The system's host name. | |
59 | ||
60 | `/etc/hosts`:: | |
61 | ||
62 | Static table lookup for hostnames. | |
63 | ||
66e9c719 DM |
64 | `/etc/pmg/pmg.conf`:: |
65 | ||
66 | Stores common administration options, i.e. the spam and mail proxy setup. | |
67 | ||
68 | `/etc/pmg/cluster.conf`:: | |
69 | ||
70 | The cluster setup. | |
71 | ||
72 | `/etc/pmg/domains`:: | |
73 | ||
74 | The list of relay domains. | |
75 | ||
76 | `/etc/pmg/fetchmailrc`:: | |
77 | ||
78 | Fetchmail configuration (POP3 and IMAP setup). | |
79 | ||
80 | `/etc/pmg/ldap.conf`:: | |
81 | ||
82 | LDAP configuration. | |
83 | ||
84 | `/etc/pmg/mynetworks`:: | |
85 | ||
86 | List of local (trusted) networks. | |
87 | ||
88 | `/etc/pmg/subscription`:: | |
89 | ||
90 | Stores your subscription key and status. | |
91 | ||
92 | `/etc/pmg/transports`:: | |
93 | ||
94 | Message delivery transport setup. | |
95 | ||
96 | `/etc/pmg/user.conf`:: | |
97 | ||
98 | GUI user configuration. | |
99 | ||
797db11d DM |
100 | `/etc/mail/spamassassin/custom.cf`:: |
101 | ||
102 | Custom {spamassassin} setup. | |
103 | ||
66e9c719 DM |
104 | |
105 | Keys and Certificates | |
106 | --------------------- | |
107 | ||
108 | `/etc/pmg/pmg-api.pem`:: | |
109 | ||
110 | Key and certificate (combined) used be the HTTPs server (API). | |
111 | ||
112 | `/etc/pmg/pmg-authkey.key`:: | |
113 | ||
114 | Privat key use to generate authentication tickets. | |
115 | ||
116 | `/etc/pmg/pmg-authkey.pub`:: | |
117 | ||
118 | Public key use to verify authentication tickets. | |
119 | ||
120 | `/etc/pmg/pmg-csrf.key`:: | |
121 | ||
122 | Internally used to generate CSRF tokens. | |
123 | ||
124 | `/etc/pmg/pmg-tls.pem`:: | |
125 | ||
126 | Key and certificate (combined) to encrypt mail traffic (TLS). | |
127 | ||
128 | ||
129 | Service Configuration Templates | |
130 | ------------------------------- | |
131 | ||
9c85cc80 DM |
132 | {pmg} uses various services to implement mail filtering, for example |
133 | the {postfix} Mail Transport Agent (MTA), the {clamav} antivirus | |
134 | engine and the Apache {spamassassin} project. Those services use | |
135 | separate configuration files, so we need to rewrite those files when | |
136 | configuration is changed. | |
137 | ||
138 | We use a template based approach to generate those files. The {tts} is | |
139 | a well known, fast and flexible template processing system. You can | |
140 | find the default templates in `/var/lib/pmg/templates/`. Please do not | |
141 | modify them directly, because your modification would get lost on the | |
142 | next update. Instead, copy them to `/etc/pmg/templates/`, then apply | |
143 | your changes there. | |
144 | ||
145 | Templates can access any configuration setting, and you can use the | |
146 | `pmgconfig dump` command to get a list of all variable names: | |
147 | ||
148 | ---- | |
149 | # pmgconfig dump | |
150 | ... | |
151 | dns.domain = yourdomain.tld | |
152 | dns.hostname = pmg | |
153 | ipconfig.int_ip = 192.168.2.127 | |
154 | pmg.admin.advfilter = 1 | |
155 | ... | |
156 | ---- | |
157 | ||
158 | The same tool is used to force regeneration of all template based | |
159 | configuration files. You need to run that after modifying a template, | |
160 | or when you directly edit configuration files | |
161 | ||
162 | ---- | |
163 | # pmgconfig sync --restart 1 | |
164 | ---- | |
165 | ||
166 | Above commands also restarts services if underlying configuration | |
167 | files are changed. Please note that this is automatically done when | |
168 | you change the configuration using the GUI or API. | |
169 | ||
170 | NOTE: Modified templates from `/etc/pmg/templates/` are automatically | |
171 | synced from the master node to all cluster members. | |
66e9c719 DM |
172 | |
173 | ||
685576c2 DM |
174 | System Configuration |
175 | -------------------- | |
176 | ||
177 | Network and Time | |
178 | ~~~~~~~~~~~~~~~~ | |
179 | ||
180 | ifndef::manvolnum[] | |
181 | image::images/screenshot/pmg-gui-network-config.png[] | |
182 | endif::manvolnum[] | |
183 | ||
45de5bf5 DM |
184 | Normally the network and time is already configured when you visit the |
185 | GUI. The installer asks for those setting and sets up the correct | |
186 | values. | |
187 | ||
188 | The default setup uses a single Ethernet adapter and static IP | |
189 | assignment. The configuration is stored at '/etc/network/interfaces', | |
190 | and the actual network setup is done the standard Debian way using | |
191 | package 'ifupdown'. | |
192 | ||
193 | .Example network setup '/etc/network/interfaces' | |
194 | ---- | |
195 | source /etc/network/interfaces.d/* | |
196 | ||
197 | auto lo | |
198 | iface lo inet loopback | |
199 | ||
200 | auto ens18 | |
201 | iface ens18 inet static | |
202 | address 192.168.2.127 | |
203 | netmask 255.255.240.0 | |
204 | gateway 192.168.2.1 | |
205 | ---- | |
206 | ||
207 | .DNS recommendations | |
208 | ||
209 | Many tests to detect SPAM mails use DNS queries, so it is important to | |
210 | have a fast and reliable DNS server. We also query some public | |
211 | available DNS Blacklists. Most of them apply rate limits for clients, | |
212 | so they simply will not work if you use a public DNS server (because | |
213 | they are usually blocked). We recommend to use your own DNS server, | |
214 | which need to be configured in 'recursive' mode. | |
685576c2 DM |
215 | |
216 | ||
217 | Options | |
218 | ~~~~~~~ | |
219 | ||
220 | ifndef::manvolnum[] | |
221 | image::images/screenshot/pmg-gui-system-options.png[] | |
222 | endif::manvolnum[] | |
223 | ||
e09057ab DM |
224 | |
225 | Those settings are saved to subsection 'admin' in `/etc/pmg/pmg.conf`, | |
226 | using the following configuration keys: | |
227 | ||
685576c2 DM |
228 | include::pmg.admin-conf-opts.adoc[] |
229 | ||
c331641e DM |
230 | |
231 | Mail Proxy Configuration | |
232 | ------------------------ | |
233 | ||
234 | Relaying | |
235 | ~~~~~~~~ | |
236 | ||
c331641e DM |
237 | ifndef::manvolnum[] |
238 | image::images/screenshot/pmg-gui-mailproxy-relaying.png[] | |
239 | endif::manvolnum[] | |
240 | ||
e09057ab DM |
241 | Those settings are saved to subsection 'mail' in `/etc/pmg/pmg.conf`, |
242 | using the following configuration keys: | |
243 | ||
244 | include::pmg.mail-relaying-conf-opts.adoc[] | |
c331641e DM |
245 | |
246 | Relay Domains | |
247 | ~~~~~~~~~~~~~ | |
248 | ||
c331641e DM |
249 | ifndef::manvolnum[] |
250 | image::images/screenshot/pmg-gui-mailproxy-relaydomains.png[] | |
251 | endif::manvolnum[] | |
252 | ||
6822b369 DM |
253 | List of relayed mail domains, i.e. what destination domains this |
254 | system will relay mail to. The system will reject incoming mails to | |
255 | other domains. | |
c331641e | 256 | |
d9c56b22 | 257 | |
c331641e DM |
258 | Ports |
259 | ~~~~~ | |
260 | ||
c331641e DM |
261 | ifndef::manvolnum[] |
262 | image::images/screenshot/pmg-gui-mailproxy-ports.png[] | |
263 | endif::manvolnum[] | |
264 | ||
d9c56b22 DM |
265 | Those settings are saved to subsection 'mail' in `/etc/pmg/pmg.conf`, |
266 | using the following configuration keys: | |
267 | ||
268 | include::pmg.mail-ports-conf-opts.adoc[] | |
269 | ||
c331641e DM |
270 | |
271 | Options | |
272 | ~~~~~~~ | |
273 | ||
c331641e DM |
274 | ifndef::manvolnum[] |
275 | image::images/screenshot/pmg-gui-mailproxy-options.png[] | |
276 | endif::manvolnum[] | |
277 | ||
e3d778e0 DM |
278 | Those settings are saved to subsection 'mail' in `/etc/pmg/pmg.conf`, |
279 | using the following configuration keys: | |
280 | ||
281 | include::pmg.mail-options-conf-opts.adoc[] | |
c331641e DM |
282 | |
283 | ||
284 | Transports | |
285 | ~~~~~~~~~~ | |
286 | ||
287 | ifndef::manvolnum[] | |
288 | image::images/screenshot/pmg-gui-mailproxy-transports.png[] | |
289 | endif::manvolnum[] | |
290 | ||
b335e06b DM |
291 | You can use {pmg} to send e-mails to different internal |
292 | e-mail servers. For example you can send e-mails addressed to | |
293 | domain.com to your first e-mail server, and e-mails addressed to | |
294 | subdomain.domain.com to a second one. | |
295 | ||
296 | You can add the IP addresses, hostname and SMTP ports and mail domains (or | |
297 | just single email addresses) of your additional e-mail servers. | |
c331641e DM |
298 | |
299 | ||
300 | Networks | |
301 | ~~~~~~~~ | |
302 | ||
303 | ifndef::manvolnum[] | |
304 | image::images/screenshot/pmg-gui-mailproxy-networks.png[] | |
305 | endif::manvolnum[] | |
306 | ||
20e879ad DM |
307 | You can add additional internal (trusted) IP networks or hosts. |
308 | All hosts in this list are allowed to relay. | |
309 | ||
310 | NOTE: Hosts in the same subnet with Proxmox can relay by default and | |
311 | it’s not needed to add them in this list. | |
c331641e DM |
312 | |
313 | ||
314 | TLS | |
315 | ~~~ | |
316 | ||
317 | ifndef::manvolnum[] | |
318 | image::images/screenshot/pmg-gui-mailproxy-tls.png[] | |
319 | endif::manvolnum[] | |
320 | ||
20e879ad DM |
321 | Transport Layer Security (TLS) provides certificate-based |
322 | authentication and encrypted sessions. An encrypted session protects | |
323 | the information that is transmitted with SMTP mail. When you activate | |
324 | TLS, {pmg} automatically generates a new self signed | |
325 | certificate for you (`/etc/pmg/pmg-tls.pem`). | |
326 | ||
327 | {pmg} uses opportunistic TLS encryption. The SMTP transaction is | |
328 | encrypted if the 'STARTTLS' ESMTP feature is supported by the remote | |
329 | server. Otherwise, messages are sent in the clear. | |
330 | ||
331 | Enable TLS logging:: | |
332 | ||
333 | To get additional information about SMTP TLS activity you can enable | |
334 | TLS logging. That way information about TLS sessions and used | |
335 | certificate’s is logged via syslog. | |
336 | ||
337 | Add TLS received header:: | |
338 | ||
339 | Set this option to include information about the protocol and cipher | |
340 | used as well as the client and issuer CommonName into the "Received:" | |
341 | message header. | |
342 | ||
a649b38f DM |
343 | Those settings are saved to subsection 'mail' in `/etc/pmg/pmg.conf`, |
344 | using the following configuration keys: | |
345 | ||
346 | include::pmg.mail-tls-conf-opts.adoc[] | |
347 | ||
c331641e DM |
348 | |
349 | Whitelist | |
350 | ~~~~~~~~~ | |
351 | ||
352 | ifndef::manvolnum[] | |
353 | image::images/screenshot/pmg-gui-mailproxy-whitelist.png[] | |
354 | endif::manvolnum[] | |
355 | ||
6822b369 DM |
356 | All SMTP checks are disabled for those entries (e. g. Greylisting, |
357 | SPF, RBL, ...) | |
358 | ||
359 | NOTE: If you use a backup MX server (e.g. your ISP offers this service | |
360 | for you) you should always add those servers here. | |
c331641e DM |
361 | |
362 | ||
363 | Spam Detector Configuration | |
364 | --------------------------- | |
365 | ||
3371c521 DM |
366 | {pmg} uses a wide variety of local and network tests to identify spam |
367 | signatures. This makes it harder for spammers to identify one aspect | |
368 | which they can craft their messages to work around the spam filter. | |
369 | ||
370 | Every single e-mail will be analyzed and gets a spam score | |
371 | assigned. The system attempts to optimize the efficiency of the rules | |
372 | that are run in terms of minimizing the number of false positives and | |
373 | false negatives. | |
374 | ||
375 | include::pmg.spam-conf-opts.adoc[] | |
376 | ||
377 | ||
378 | Spam Quarantine Configuration | |
379 | ----------------------------- | |
380 | ||
381 | Proxmox analyses all incoming e-mail messages and decides for each | |
382 | e-mail if its ham or spam (or virus). Good e-mails are delivered to | |
383 | the inbox and spam messages can be moved into the spam quarantine. | |
384 | ||
385 | The system can be configured to send daily reports to inform users | |
386 | about the personal spam messages received the last day. That report is | |
387 | only sent if there are new messages in the quarantine. | |
388 | ||
389 | include::pmg.spamquar-conf-opts.adoc[] | |
c331641e DM |
390 | |
391 | ||
392 | Virus Detector Configuration | |
393 | ---------------------------- | |
394 | ||
395 | TODO | |
396 | ||
397 | ||
398 | User Management | |
399 | --------------- | |
400 | ||
401 | TODO | |
402 | ||
403 | ||
e62ceaf0 DM |
404 | ifdef::manvolnum[] |
405 | include::pmg-copyright.adoc[] | |
406 | endif::manvolnum[] | |
407 |