]>
Commit | Line | Data |
---|---|---|
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[] | |
23 | Configuration Management | |
24 | ======================== | |
25 | :pmg-toplevel: | |
26 | endif::manvolnum[] | |
27 | ||
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' | |
31 | or the command line tool `pmgsh`. | |
32 | ||
33 | The command line tool `pmgconfig` is used to simplify some common | |
34 | configuration tasks, i.e. to generate cerificates and to rewrite | |
35 | service configuration files. | |
36 | ||
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 | ||
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 | ||
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/tls_policy`:: | |
93 | ||
94 | TLS policy for outbound connections. | |
95 | ||
96 | `/etc/pmg/transports`:: | |
97 | ||
98 | Message delivery transport setup. | |
99 | ||
100 | `/etc/pmg/user.conf`:: | |
101 | ||
102 | GUI user configuration. | |
103 | ||
104 | `/etc/mail/spamassassin/custom.cf`:: | |
105 | ||
106 | Custom {spamassassin} setup. | |
107 | ||
108 | ||
109 | Keys and Certificates | |
110 | --------------------- | |
111 | ||
112 | `/etc/pmg/pmg-api.pem`:: | |
113 | ||
114 | Key and certificate (combined) used be the HTTPs server (API). | |
115 | ||
116 | `/etc/pmg/pmg-authkey.key`:: | |
117 | ||
118 | Privat key use to generate authentication tickets. | |
119 | ||
120 | `/etc/pmg/pmg-authkey.pub`:: | |
121 | ||
122 | Public key use to verify authentication tickets. | |
123 | ||
124 | `/etc/pmg/pmg-csrf.key`:: | |
125 | ||
126 | Internally used to generate CSRF tokens. | |
127 | ||
128 | `/etc/pmg/pmg-tls.pem`:: | |
129 | ||
130 | Key and certificate (combined) to encrypt mail traffic (TLS). | |
131 | ||
132 | ||
133 | Service Configuration Templates | |
134 | ------------------------------- | |
135 | ||
136 | {pmg} uses various services to implement mail filtering, for example | |
137 | the {postfix} Mail Transport Agent (MTA), the {clamav} antivirus | |
138 | engine and the Apache {spamassassin} project. Those services use | |
139 | separate configuration files, so we need to rewrite those files when | |
140 | configuration is changed. | |
141 | ||
142 | We use a template based approach to generate those files. The {tts} is | |
143 | a well known, fast and flexible template processing system. You can | |
144 | find the default templates in `/var/lib/pmg/templates/`. Please do not | |
145 | modify them directly, because your modification would get lost on the | |
146 | next update. Instead, copy them to `/etc/pmg/templates/`, then apply | |
147 | your changes there. | |
148 | ||
149 | Templates can access any configuration setting, and you can use the | |
150 | `pmgconfig dump` command to get a list of all variable names: | |
151 | ||
152 | ---- | |
153 | # pmgconfig dump | |
154 | ... | |
155 | dns.domain = yourdomain.tld | |
156 | dns.hostname = pmg | |
157 | ipconfig.int_ip = 192.168.2.127 | |
158 | pmg.admin.advfilter = 1 | |
159 | ... | |
160 | ---- | |
161 | ||
162 | The same tool is used to force regeneration of all template based | |
163 | configuration files. You need to run that after modifying a template, | |
164 | or when you directly edit configuration files | |
165 | ||
166 | ---- | |
167 | # pmgconfig sync --restart 1 | |
168 | ---- | |
169 | ||
170 | Above commands also restarts services if underlying configuration | |
171 | files are changed. Please note that this is automatically done when | |
172 | you change the configuration using the GUI or API. | |
173 | ||
174 | NOTE: Modified templates from `/etc/pmg/templates/` are automatically | |
175 | synced from the master node to all cluster members. | |
176 | ||
177 | ||
178 | [[pmgconfig_systemconfig]] | |
179 | System Configuration | |
180 | -------------------- | |
181 | ||
182 | Network and Time | |
183 | ~~~~~~~~~~~~~~~~ | |
184 | ||
185 | ifndef::manvolnum[] | |
186 | image::images/screenshot/pmg-gui-network-config.png[] | |
187 | endif::manvolnum[] | |
188 | ||
189 | Normally the network and time is already configured when you visit the | |
190 | GUI. The installer asks for those setting and sets up the correct | |
191 | values. | |
192 | ||
193 | The default setup uses a single Ethernet adapter and static IP | |
194 | assignment. The configuration is stored at '/etc/network/interfaces', | |
195 | and the actual network setup is done the standard Debian way using | |
196 | package 'ifupdown'. | |
197 | ||
198 | .Example network setup '/etc/network/interfaces' | |
199 | ---- | |
200 | source /etc/network/interfaces.d/* | |
201 | ||
202 | auto lo | |
203 | iface lo inet loopback | |
204 | ||
205 | auto ens18 | |
206 | iface ens18 inet static | |
207 | address 192.168.2.127 | |
208 | netmask 255.255.240.0 | |
209 | gateway 192.168.2.1 | |
210 | ---- | |
211 | ||
212 | .DNS recommendations | |
213 | ||
214 | Many tests to detect SPAM mails use DNS queries, so it is important to | |
215 | have a fast and reliable DNS server. We also query some public | |
216 | available DNS Blacklists. Most of them apply rate limits for clients, | |
217 | so they simply will not work if you use a public DNS server (because | |
218 | they are usually blocked). We recommend to use your own DNS server, | |
219 | which need to be configured in 'recursive' mode. | |
220 | ||
221 | ||
222 | Options | |
223 | ~~~~~~~ | |
224 | ||
225 | ifndef::manvolnum[] | |
226 | image::images/screenshot/pmg-gui-system-options.png[] | |
227 | endif::manvolnum[] | |
228 | ||
229 | ||
230 | Those settings are saved to subsection 'admin' in `/etc/pmg/pmg.conf`, | |
231 | using the following configuration keys: | |
232 | ||
233 | include::pmg.admin-conf-opts.adoc[] | |
234 | ||
235 | ||
236 | Mail Proxy Configuration | |
237 | ------------------------ | |
238 | ||
239 | [[pmgconfig_mailproxy_relaying]] | |
240 | Relaying | |
241 | ~~~~~~~~ | |
242 | ||
243 | ifndef::manvolnum[] | |
244 | image::images/screenshot/pmg-gui-mailproxy-relaying.png[] | |
245 | endif::manvolnum[] | |
246 | ||
247 | Those settings are saved to subsection 'mail' in `/etc/pmg/pmg.conf`, | |
248 | using the following configuration keys: | |
249 | ||
250 | include::pmg.mail-relaying-conf-opts.adoc[] | |
251 | ||
252 | [[pmgconfig_mailproxy_relay_domains]] | |
253 | Relay Domains | |
254 | ~~~~~~~~~~~~~ | |
255 | ||
256 | ifndef::manvolnum[] | |
257 | image::images/screenshot/pmg-gui-mailproxy-relaydomains.png[] | |
258 | endif::manvolnum[] | |
259 | ||
260 | List of relayed mail domains, i.e. what destination domains this | |
261 | system will relay mail to. The system will reject incoming mails to | |
262 | other domains. | |
263 | ||
264 | ||
265 | [[pmgconfig_mailproxy_ports]] | |
266 | Ports | |
267 | ~~~~~ | |
268 | ||
269 | ifndef::manvolnum[] | |
270 | image::images/screenshot/pmg-gui-mailproxy-ports.png[] | |
271 | endif::manvolnum[] | |
272 | ||
273 | Those settings are saved to subsection 'mail' in `/etc/pmg/pmg.conf`, | |
274 | using the following configuration keys: | |
275 | ||
276 | include::pmg.mail-ports-conf-opts.adoc[] | |
277 | ||
278 | ||
279 | [[pmgconfig_mailproxy_options]] | |
280 | Options | |
281 | ~~~~~~~ | |
282 | ||
283 | ifndef::manvolnum[] | |
284 | image::images/screenshot/pmg-gui-mailproxy-options.png[] | |
285 | endif::manvolnum[] | |
286 | ||
287 | Those settings are saved to subsection 'mail' in `/etc/pmg/pmg.conf`, | |
288 | using the following configuration keys: | |
289 | ||
290 | include::pmg.mail-options-conf-opts.adoc[] | |
291 | ||
292 | ||
293 | [[pmgconfig_mailproxy_transports]] | |
294 | Transports | |
295 | ~~~~~~~~~~ | |
296 | ||
297 | ifndef::manvolnum[] | |
298 | image::images/screenshot/pmg-gui-mailproxy-transports.png[] | |
299 | endif::manvolnum[] | |
300 | ||
301 | You can use {pmg} to send e-mails to different internal | |
302 | e-mail servers. For example you can send e-mails addressed to | |
303 | domain.com to your first e-mail server, and e-mails addressed to | |
304 | subdomain.domain.com to a second one. | |
305 | ||
306 | You can add the IP addresses, hostname and SMTP ports and mail domains (or | |
307 | just single email addresses) of your additional e-mail servers. | |
308 | ||
309 | ||
310 | [[pmgconfig_mailproxy_networks]] | |
311 | Networks | |
312 | ~~~~~~~~ | |
313 | ||
314 | ifndef::manvolnum[] | |
315 | image::images/screenshot/pmg-gui-mailproxy-networks.png[] | |
316 | endif::manvolnum[] | |
317 | ||
318 | You can add additional internal (trusted) IP networks or hosts. | |
319 | All hosts in this list are allowed to relay. | |
320 | ||
321 | NOTE: Hosts in the same subnet with Proxmox can relay by default and | |
322 | it’s not needed to add them in this list. | |
323 | ||
324 | ||
325 | [[pmgconfig_mailproxy_tls]] | |
326 | TLS | |
327 | ~~~ | |
328 | ||
329 | ifndef::manvolnum[] | |
330 | image::images/screenshot/pmg-gui-mailproxy-tls.png[] | |
331 | endif::manvolnum[] | |
332 | ||
333 | Transport Layer Security (TLS) provides certificate-based | |
334 | authentication and encrypted sessions. An encrypted session protects | |
335 | the information that is transmitted with SMTP mail. When you activate | |
336 | TLS, {pmg} automatically generates a new self signed | |
337 | certificate for you (`/etc/pmg/pmg-tls.pem`). | |
338 | ||
339 | {pmg} uses opportunistic TLS encryption by default. The SMTP transaction is | |
340 | encrypted if the 'STARTTLS' ESMTP feature is supported by the remote | |
341 | server. Otherwise, messages are sent in the clear. | |
342 | You can set a different TLS policy per desitination domain, should you for | |
343 | example need to prevent e-mail delivery without encryption, or to work around | |
344 | a broken 'STARTTLS' ESMTP implementation. See {postfix_tls_readme} for details | |
345 | on the supported policies. | |
346 | ||
347 | Enable TLS logging:: | |
348 | ||
349 | To get additional information about SMTP TLS activity you can enable | |
350 | TLS logging. That way information about TLS sessions and used | |
351 | certificate’s is logged via syslog. | |
352 | ||
353 | Add TLS received header:: | |
354 | ||
355 | Set this option to include information about the protocol and cipher | |
356 | used as well as the client and issuer CommonName into the "Received:" | |
357 | message header. | |
358 | ||
359 | Those settings are saved to subsection 'mail' in `/etc/pmg/pmg.conf`, | |
360 | using the following configuration keys: | |
361 | ||
362 | include::pmg.mail-tls-conf-opts.adoc[] | |
363 | ||
364 | ||
365 | Whitelist | |
366 | ~~~~~~~~~ | |
367 | ||
368 | ifndef::manvolnum[] | |
369 | image::images/screenshot/pmg-gui-mailproxy-whitelist.png[] | |
370 | endif::manvolnum[] | |
371 | ||
372 | All SMTP checks are disabled for those entries (e. g. Greylisting, | |
373 | SPF, RBL, ...) | |
374 | ||
375 | NOTE: If you use a backup MX server (e.g. your ISP offers this service | |
376 | for you) you should always add those servers here. | |
377 | ||
378 | ||
379 | [[pmgconfig_spamdetector]] | |
380 | Spam Detector Configuration | |
381 | --------------------------- | |
382 | ||
383 | Options | |
384 | ~~~~~~~ | |
385 | ||
386 | ifndef::manvolnum[] | |
387 | image::images/screenshot/pmg-gui-spam-options.png[] | |
388 | endif::manvolnum[] | |
389 | ||
390 | {pmg} uses a wide variety of local and network tests to identify spam | |
391 | signatures. This makes it harder for spammers to identify one aspect | |
392 | which they can craft their messages to work around the spam filter. | |
393 | ||
394 | Every single e-mail will be analyzed and gets a spam score | |
395 | assigned. The system attempts to optimize the efficiency of the rules | |
396 | that are run in terms of minimizing the number of false positives and | |
397 | false negatives. | |
398 | ||
399 | include::pmg.spam-conf-opts.adoc[] | |
400 | ||
401 | ||
402 | [[pmgconfig_spamdetector_quarantine]] | |
403 | Quarantine | |
404 | ~~~~~~~~~~ | |
405 | ||
406 | ifndef::manvolnum[] | |
407 | image::images/screenshot/pmg-gui-spamquar-options.png[] | |
408 | endif::manvolnum[] | |
409 | ||
410 | Proxmox analyses all incoming e-mail messages and decides for each | |
411 | e-mail if its ham or spam (or virus). Good e-mails are delivered to | |
412 | the inbox and spam messages can be moved into the spam quarantine. | |
413 | ||
414 | The system can be configured to send daily reports to inform users | |
415 | about the personal spam messages received the last day. That report is | |
416 | only sent if there are new messages in the quarantine. | |
417 | ||
418 | Some options are only available in the config file `/etc/pmg/pmg.conf`, | |
419 | and not in the webinterface. | |
420 | ||
421 | include::pmg.spamquar-conf-opts.adoc[] | |
422 | ||
423 | ||
424 | [[pmgconfig_clamav]] | |
425 | Virus Detector Configuration | |
426 | ---------------------------- | |
427 | ||
428 | [[pmgconfig_clamav_options]] | |
429 | Options | |
430 | ~~~~~~~ | |
431 | ||
432 | ifndef::manvolnum[] | |
433 | image::images/screenshot/pmg-gui-virus-options.png[] | |
434 | endif::manvolnum[] | |
435 | ||
436 | All mails are automatically passed to the included virus detector | |
437 | ({clamav}). The default setting are considered safe, so it is usually | |
438 | not required to change them. | |
439 | ||
440 | {clamav} related settings are saved to subsection 'clamav' in `/etc/pmg/pmg.conf`, | |
441 | using the following configuration keys: | |
442 | ||
443 | include::pmg.clamav-conf-opts.adoc[] | |
444 | ||
445 | ifndef::manvolnum[] | |
446 | image::images/screenshot/pmg-gui-clamav-database.png[] | |
447 | endif::manvolnum[] | |
448 | ||
449 | Please note that the virus signature database it automatically | |
450 | updated. But you can see the database status on the GUI, and you can | |
451 | trigger manual updates there. | |
452 | ||
453 | ||
454 | [[pmgconfig_clamav_quarantine]] | |
455 | Quarantine | |
456 | ~~~~~~~~~~ | |
457 | ||
458 | ifndef::manvolnum[] | |
459 | image::images/screenshot/pmg-gui-virusquar-options.png[] | |
460 | endif::manvolnum[] | |
461 | ||
462 | Indentified virus mails are automatically moved to the virus | |
463 | quarantine. The administartor can view those mails using the GUI, or | |
464 | deliver them in case of false positives. {pmg} does not notify | |
465 | individual users about received virus mails. | |
466 | ||
467 | Virus quarantine related settings are saved to subsection 'virusquar' | |
468 | in `/etc/pmg/pmg.conf`, using the following configuration keys: | |
469 | ||
470 | include::pmg.virusquar-conf-opts.adoc[] | |
471 | ||
472 | ||
473 | Custom SpamAssassin configuration | |
474 | --------------------------------- | |
475 | ||
476 | This is only for advanced users. To add or change the Proxmox | |
477 | {spamassassin} configuration please login to the console via SSH. Go | |
478 | to directory `/etc/mail/spamassasin/`. In this directory there are several | |
479 | files (`init.pre`, `local.cf`, ...) – do not change them. | |
480 | ||
481 | To add your special configuration, you have to create a new file and | |
482 | name it `custom.cf` (in this directory), then add your | |
483 | configuration there. Be aware to use the {spamassassin} | |
484 | syntax, and test with | |
485 | ||
486 | ---- | |
487 | # spamassassin -D --lint | |
488 | ---- | |
489 | ||
490 | If you run a cluster, the `custom.cf` file is synchronized from the | |
491 | master node to all cluster members. | |
492 | ||
493 | ||
494 | User Management | |
495 | --------------- | |
496 | ||
497 | User management in {pmg} consists of three types of users/accounts: | |
498 | ||
499 | ||
500 | [[pmgconfig_localuser]] | |
501 | Local Users | |
502 | ~~~~~~~~~~~ | |
503 | ||
504 | image::images/screenshot/pmg-gui-local-user-config.png[] | |
505 | ||
506 | Local users are used to manage and audit {pmg}. Those users can login on the | |
507 | management web interface. | |
508 | ||
509 | There are three roles: | |
510 | ||
511 | * Administrator | |
512 | + | |
513 | Is allowed to manage settings of {pmg}, except some tasks like | |
514 | network configuration and upgrading. | |
515 | ||
516 | * Quarantine manager | |
517 | + | |
518 | Is allowed to manage quarantines, blacklists and whitelists, but not other | |
519 | settings. Has no right to view any other data. | |
520 | ||
521 | * Auditor | |
522 | + | |
523 | With this role, the user is only allowed to view data and configuration, but | |
524 | not to edit it. | |
525 | ||
526 | In addition there is always the 'root' user, which is used to perform special | |
527 | system administrator tasks, such as updgrading a host or changing the | |
528 | network configuration. | |
529 | ||
530 | NOTE: Only pam users are able to login via the webconsole and ssh, which the | |
531 | users created with the web interface are not. Those users are created for | |
532 | {pmg} administration only. | |
533 | ||
534 | Local user related settings are saved in `/etc/pmg/user.conf`. | |
535 | ||
536 | For details of the fields see xref:pmg_user_configuration_file[user.conf] | |
537 | ||
538 | [[pmgconfig_ldap]] | |
539 | LDAP/Active Directory | |
540 | ~~~~~~~~~~~~~~~~~~~~~ | |
541 | ||
542 | image::images/screenshot/pmg-gui-ldap-user-config.png[] | |
543 | ||
544 | You can specify multiple LDAP/Active Directory profiles, so that you can | |
545 | create rules matching those users and groups. | |
546 | ||
547 | Creating a profile requires (at least) the following: | |
548 | ||
549 | * profile name | |
550 | * protocol (LDAP or LDAPS; LDAPS is recommended) | |
551 | * at least one server | |
552 | * a user and password (if your server does not support anonymous binds) | |
553 | ||
554 | All other fields should work with the defaults for most setups, but can be | |
555 | used to customize the queries. | |
556 | ||
557 | The settings are saved to `/etc/pmg/ldap.conf`. Details for the options | |
558 | can be found here: xref:pmg_ldap_configuration_file[ldap.conf] | |
559 | ||
560 | Bind user | |
561 | ^^^^^^^^^ | |
562 | ||
563 | It is highly recommended that the user which you use for connecting to the | |
564 | LDAP server only has the permission to query the server. For LDAP servers | |
565 | (for example OpenLDAP or FreeIPA), the username has to be of a format like | |
566 | 'uid=username,cn=users,cn=accounts,dc=domain' , where the specific fields are | |
567 | depending on your setup. For Active Directory servers, the format should be | |
568 | like 'username@domain' or 'domain\username'. | |
569 | ||
570 | Sync | |
571 | ^^^^ | |
572 | ||
573 | {pmg} synchronizes the relevant user and group info periodically, so that | |
574 | that information is available in a fast manner, even when the LDAP/AD server | |
575 | is temporarily not accessible. | |
576 | ||
577 | After a successfull sync, the groups and users should be visible on the web | |
578 | interface. After that, you can create rules targeting LDAP users and groups. | |
579 | ||
580 | ||
581 | [[pmgconfig_fetchmail]] | |
582 | Fetchmail | |
583 | ~~~~~~~~~ | |
584 | ||
585 | image::images/screenshot/pmg-gui-fetchmail-config.png[] | |
586 | ||
587 | Fetchmail is utility for polling and forwarding e-mails. You can define | |
588 | e-mail accounts, which will then be fetched and forwarded to the e-mail | |
589 | address you defined. | |
590 | ||
591 | You have to add an entry for each account/target combination you want to | |
592 | fetch and forward. Those will then be regularly polled and forwarded, | |
593 | according to your configuration. | |
594 | ||
595 | The API and web interface offer following configuration options: | |
596 | ||
597 | include::fetchmail.conf.5-opts.adoc[] | |
598 | ||
599 | ||
600 | ifdef::manvolnum[] | |
601 | include::pmg-copyright.adoc[] | |
602 | endif::manvolnum[] | |
603 |