[pmg-docs.git] / pmg.conf.5-opts.adoc

.Section 'admin'

`advfilter`: `<boolean>` ('default =' `1`)::

Use advanced filters for statistic.

`avast`: `<boolean>` ('default =' `0`)::

Use Avast Virus Scanner (/usr/bin/scan). You need to buy and install 'Avast Core Security' before you can enable this feature.

`clamav`: `<boolean>` ('default =' `1`)::

Use ClamAV Virus Scanner. This is the default virus scanner and is enabled by default.

`custom_check`: `<boolean>` ('default =' `0`)::

Use Custom Check Script. The script has to take the defined arguments and can return Virus findings or a Spamscore.

`custom_check_path`: `^/([^/\0]+\/)+[^/\0]+$` ('default =' `/usr/local/bin/pmg-custom-check`)::

Absolute Path to the Custom Check Script

`dailyreport`: `<boolean>` ('default =' `1`)::

Send daily reports.

`demo`: `<boolean>` ('default =' `0`)::

Demo mode - do not start SMTP filter.

`email`: `<string>` ('default =' `admin@domain.tld`)::

Administrator E-Mail address.

`http_proxy`: `http://.*` ::

Specify external http proxy which is used for downloads (example: 'http://username:password@host:port/')

`statlifetime`: `<integer> (1 - N)` ('default =' `7`)::

User Statistics Lifetime (days)

.Section 'clamav'

`archiveblockencrypted`: `<boolean>` ('default =' `0`)::

Whether to block encrypted archives and documents. Mark encrypted archives and documents as viruses.

`archivemaxfiles`: `<integer> (0 - N)` ('default =' `1000`)::

Number of files to be scanned within an archive, a document, or any other kind of container. Warning: disabling this limit or setting it too high may result in severe damage to the system.

`archivemaxrec`: `<integer> (1 - N)` ('default =' `5`)::

Nested archives are scanned recursively, e.g. if a ZIP archive contains a TAR  file,  all files within it will also be scanned. This options specifies how deeply the process should be continued. Warning: setting this limit too high may result in severe damage to the system.

`archivemaxsize`: `<integer> (1000000 - N)` ('default =' `25000000`)::

Files larger than this limit won't be scanned.

`dbmirror`: `<string>` ('default =' `database.clamav.net`)::

ClamAV database mirror server.

`maxcccount`: `<integer> (0 - N)` ('default =' `0`)::

This option sets the lowest number of Credit Card or Social Security numbers found in a file to generate a detect.

`maxscansize`: `<integer> (1000000 - N)` ('default =' `100000000`)::

Sets the maximum amount of data to be scanned for each input file.

`safebrowsing`: `<boolean>` ('default =' `1`)::

Enables support for Google Safe Browsing.

.Section 'mail'

`banner`: `<string>` ('default =' `ESMTP Proxmox`)::

ESMTP banner.

`conn_count_limit`: `<integer> (0 - N)` ('default =' `50`)::

How many simultaneous connections any client is allowed to make to this service. To disable this feature, specify a limit of 0.

`conn_rate_limit`: `<integer> (0 - N)` ('default =' `0`)::

The maximal number of connection attempts any client is allowed to make to this service per minute. To disable this feature, specify a limit of 0.

`dnsbl_sites`: `<string>` ::

Optional list of DNS white/blacklist domains (see postscreen_dnsbl_sites parameter).

`dnsbl_threshold`: `<integer> (0 - N)` ('default =' `1`)::

The inclusive lower bound for blocking a remote SMTP client, based on its combined DNSBL score (see postscreen_dnsbl_threshold parameter).

`dwarning`: `<integer> (0 - N)` ('default =' `4`)::

SMTP delay warning time (in hours).

`ext_port`: `<integer> (1 - 65535)` ('default =' `25`)::

SMTP port number for incoming mail (untrusted). This must be a different number than 'int_port'.

`greylist`: `<boolean>` ('default =' `1`)::

Use Greylisting.

`helotests`: `<boolean>` ('default =' `0`)::

Use SMTP HELO tests.

`hide_received`: `<boolean>` ('default =' `0`)::

Hide received header in outgoing mails.

`int_port`: `<integer> (1 - 65535)` ('default =' `26`)::

SMTP port number for outgoing mail (trusted).

`max_filters`: `<integer> (3 - 40)` ('default =' `35`)::

Maximum number of pmg-smtp-filter processes.

`max_policy`: `<integer> (2 - 10)` ('default =' `5`)::

Maximum number of pmgpolicy processes.

`max_smtpd_in`: `<integer> (3 - 100)` ('default =' `100`)::

Maximum number of SMTP daemon processes (in).

`max_smtpd_out`: `<integer> (3 - 100)` ('default =' `100`)::

Maximum number of SMTP daemon processes (out).

`maxsize`: `<integer> (1024 - N)` ('default =' `10485760`)::

Maximum email size. Larger mails are rejected.

`message_rate_limit`: `<integer> (0 - N)` ('default =' `0`)::

The maximal number of message delivery requests that any client is allowed to make to this service per minute.To disable this feature, specify a limit of 0.

`rejectunknown`: `<boolean>` ('default =' `0`)::

Reject unknown clients.

`rejectunknownsender`: `<boolean>` ('default =' `0`)::

Reject unknown senders.

`relay`: `<string>` ::

The default mail delivery transport (incoming mails).

`relaynomx`: `<boolean>` ('default =' `0`)::

Disable MX lookups for default relay.

`relayport`: `<integer> (1 - 65535)` ('default =' `25`)::

SMTP port number for relay host.

`smarthost`: `<string>` ::

When set, all outgoing mails are deliverd to the specified smarthost.

`smarthostport`: `<integer> (1 - 65535)` ('default =' `25`)::

SMTP port number for smarthost.

`spf`: `<boolean>` ('default =' `1`)::

Use Sender Policy Framework.

`tls`: `<boolean>` ('default =' `0`)::

Enable TLS.

`tlsheader`: `<boolean>` ('default =' `0`)::

Add TLS received header.

`tlslog`: `<boolean>` ('default =' `0`)::

Enable TLS Logging.

`verifyreceivers`: `<450 | 550>` ::

Enable receiver verification. The value spefifies the numerical reply code when the Postfix SMTP server rejects a recipient address.

.Section 'spam'

`bounce_score`: `<integer> (0 - 1000)` ('default =' `0`)::

Additional score for bounce mails.

`clamav_heuristic_score`: `<integer> (0 - 1000)` ('default =' `3`)::

Score for ClamAV heuristics (Google Safe Browsing database, PhishingScanURLs, ...).

`languages`: `(all|([a-z][a-z])+( ([a-z][a-z])+)*)` ('default =' `all`)::

This option is used to specify which languages are considered OK for incoming mail.

`maxspamsize`: `<integer> (64 - N)` ('default =' `262144`)::

Maximum size of spam messages in bytes.

`rbl_checks`: `<boolean>` ('default =' `1`)::

Enable real time blacklists (RBL) checks.

`use_awl`: `<boolean>` ('default =' `1`)::

Use the Auto-Whitelist plugin.

`use_bayes`: `<boolean>` ('default =' `1`)::

Whether to use the naive-Bayesian-style classifier.

`use_razor`: `<boolean>` ('default =' `1`)::

Whether to use Razor2, if it is available.

`wl_bounce_relays`: `<string>` ::

Whitelist legitimate bounce relays.

.Section 'spamquar'

`allowhrefs`: `<boolean>` ('default =' `1`)::

Allow to view hyperlinks.

`authmode`: `<ldap | ldapticket | ticket>` ('default =' `ticket`)::

Authentication mode to access the quarantine interface. Mode 'ticket' allows login using tickets sent with the daily spam report. Mode 'ldap' requires to login using an LDAP account. Finally, mode 'ldapticket' allows both ways.

`hostname`: `<string>` ::

Quarantine Host. Useful if you run a Cluster and want users to connect to a specific host.

`lifetime`: `<integer> (1 - N)` ('default =' `7`)::

Quarantine life time (days)

`mailfrom`: `<string>` ::

Text for 'From' header in daily spam report mails.

`port`: `<integer> (1 - 65535)` ('default =' `8006`)::

Quarantine Port. Useful if you have a reverse proxy or port forwarding for the webinterface. Only used for the generated Spam report.

`protocol`: `<http | https>` ('default =' `https`)::

Quarantine Webinterface Protocol. Useful if you have a reverse proxy for the webinterface. Only used for the generated Spam report.

`reportstyle`: `<custom | none | short | verbose>` ('default =' `verbose`)::

Spam report style.

`viewimages`: `<boolean>` ('default =' `1`)::

Allow to view images.

.Section 'virusquar'

`allowhrefs`: `<boolean>` ('default =' `1`)::

Allow to view hyperlinks.

`lifetime`: `<integer> (1 - N)` ('default =' `7`)::

Quarantine life time (days)

`viewimages`: `<boolean>` ('default =' `1`)::

Allow to view images.
Commit	Line	Data
f872534d DM	1	.Section 'admin'
f872534d DM	2
9fda36b0 DM	3	`advfilter`: `<boolean>` ('default =' `1`)::
	4
	5	Use advanced filters for statistic.
	6
f225b3b4 DM	7	`avast`: `<boolean>` ('default =' `0`)::
f225b3b4 DM	8
241ac83c	9	Use Avast Virus Scanner (/usr/bin/scan). You need to buy and install 'Avast Core Security' before you can enable this feature.
f225b3b4 DM	10
	11	`clamav`: `<boolean>` ('default =' `1`)::
	12
	13	Use ClamAV Virus Scanner. This is the default virus scanner and is enabled by default.
	14
241ac83c TL	15	`custom_check`: `<boolean>` ('default =' `0`)::
	16
	17	Use Custom Check Script. The script has to take the defined arguments and can return Virus findings or a Spamscore.
	18
	19	`custom_check_path`: `^/([^/\0]+\/)+[^/\0]+$` ('default =' `/usr/local/bin/pmg-custom-check`)::
	20
	21	Absolute Path to the Custom Check Script
	22
f872534d DM	23	`dailyreport`: `<boolean>` ('default =' `1`)::
	24
	25	Send daily reports.
	26
f872534d DM	27	`demo`: `<boolean>` ('default =' `0`)::
	28
	29	Demo mode - do not start SMTP filter.
	30
eff914dc DM	31	`email`: `<string>` ('default =' `admin@domain.tld`)::
	32
	33	Administrator E-Mail address.
	34
9fda36b0	35	`http_proxy`: `http://.*` ::
f872534d	36
9fda36b0	37	Specify external http proxy which is used for downloads (example: 'http://username:password@host:port/')
f872534d	38
a55e94a6 DM	39	`statlifetime`: `<integer> (1 - N)` ('default =' `7`)::
	40
	41	User Statistics Lifetime (days)
	42
f872534d DM	43	.Section 'clamav'
	44
	45	`archiveblockencrypted`: `<boolean>` ('default =' `0`)::
	46
241ac83c	47	Whether to block encrypted archives and documents. Mark encrypted archives and documents as viruses.
f872534d DM	48
	49	`archivemaxfiles`: `<integer> (0 - N)` ('default =' `1000`)::
	50
	51	Number of files to be scanned within an archive, a document, or any other kind of container. Warning: disabling this limit or setting it too high may result in severe damage to the system.
	52
	53	`archivemaxrec`: `<integer> (1 - N)` ('default =' `5`)::
	54
	55	Nested archives are scanned recursively, e.g. if a ZIP archive contains a TAR file, all files within it will also be scanned. This options specifies how deeply the process should be continued. Warning: setting this limit too high may result in severe damage to the system.
	56
	57	`archivemaxsize`: `<integer> (1000000 - N)` ('default =' `25000000`)::
	58
	59	Files larger than this limit won't be scanned.
	60
	61	`dbmirror`: `<string>` ('default =' `database.clamav.net`)::
	62
	63	ClamAV database mirror server.
	64
f872534d DM	65	`maxcccount`: `<integer> (0 - N)` ('default =' `0`)::
	66
	67	This option sets the lowest number of Credit Card or Social Security numbers found in a file to generate a detect.
	68
	69	`maxscansize`: `<integer> (1000000 - N)` ('default =' `100000000`)::
	70
	71	Sets the maximum amount of data to be scanned for each input file.
	72
f245a28c DM	73	`safebrowsing`: `<boolean>` ('default =' `1`)::
	74
	75	Enables support for Google Safe Browsing.
	76
f872534d DM	77	.Section 'mail'
	78
	79	`banner`: `<string>` ('default =' `ESMTP Proxmox`)::
	80
	81	ESMTP banner.
	82
	83	`conn_count_limit`: `<integer> (0 - N)` ('default =' `50`)::
	84
	85	How many simultaneous connections any client is allowed to make to this service. To disable this feature, specify a limit of 0.
	86
	87	`conn_rate_limit`: `<integer> (0 - N)` ('default =' `0`)::
	88
	89	The maximal number of connection attempts any client is allowed to make to this service per minute. To disable this feature, specify a limit of 0.
	90
f872534d DM	91	`dnsbl_sites`: `<string>` ::
	92
	93	Optional list of DNS white/blacklist domains (see postscreen_dnsbl_sites parameter).
	94
1ed9e770 DM	95	`dnsbl_threshold`: `<integer> (0 - N)` ('default =' `1`)::
	96
	97	The inclusive lower bound for blocking a remote SMTP client, based on its combined DNSBL score (see postscreen_dnsbl_threshold parameter).
	98
f872534d DM	99	`dwarning`: `<integer> (0 - N)` ('default =' `4`)::
	100
	101	SMTP delay warning time (in hours).
	102
4a46ced6	103	`ext_port`: `<integer> (1 - 65535)` ('default =' `25`)::
eff914dc DM	104
	105	SMTP port number for incoming mail (untrusted). This must be a different number than 'int_port'.
	106
f872534d DM	107	`greylist`: `<boolean>` ('default =' `1`)::
	108
	109	Use Greylisting.
	110
	111	`helotests`: `<boolean>` ('default =' `0`)::
	112
	113	Use SMTP HELO tests.
	114
	115	`hide_received`: `<boolean>` ('default =' `0`)::
	116
	117	Hide received header in outgoing mails.
	118
4a46ced6	119	`int_port`: `<integer> (1 - 65535)` ('default =' `26`)::
eff914dc DM	120
	121	SMTP port number for outgoing mail (trusted).
	122
241ac83c	123	`max_filters`: `<integer> (3 - 40)` ('default =' `35`)::
f872534d DM	124
	125	Maximum number of pmg-smtp-filter processes.
	126
	127	`max_policy`: `<integer> (2 - 10)` ('default =' `5`)::
	128
	129	Maximum number of pmgpolicy processes.
	130
241ac83c	131	`max_smtpd_in`: `<integer> (3 - 100)` ('default =' `100`)::
f872534d DM	132
	133	Maximum number of SMTP daemon processes (in).
	134
241ac83c	135	`max_smtpd_out`: `<integer> (3 - 100)` ('default =' `100`)::
f872534d DM	136
	137	Maximum number of SMTP daemon processes (out).
	138
	139	`maxsize`: `<integer> (1024 - N)` ('default =' `10485760`)::
	140
	141	Maximum email size. Larger mails are rejected.
	142
	143	`message_rate_limit`: `<integer> (0 - N)` ('default =' `0`)::
	144
	145	The maximal number of message delivery requests that any client is allowed to make to this service per minute.To disable this feature, specify a limit of 0.
	146
	147	`rejectunknown`: `<boolean>` ('default =' `0`)::
	148
	149	Reject unknown clients.
	150
	151	`rejectunknownsender`: `<boolean>` ('default =' `0`)::
	152
	153	Reject unknown senders.
	154
	155	`relay`: `<string>` ::
	156
	157	The default mail delivery transport (incoming mails).
	158
	159	`relaynomx`: `<boolean>` ('default =' `0`)::
	160
	161	Disable MX lookups for default relay.
	162
	163	`relayport`: `<integer> (1 - 65535)` ('default =' `25`)::
	164
	165	SMTP port number for relay host.
	166
eff914dc DM	167	`smarthost`: `<string>` ::
	168
	169	When set, all outgoing mails are deliverd to the specified smarthost.
	170
851283b1 DM	171	`smarthostport`: `<integer> (1 - 65535)` ('default =' `25`)::
	172
	173	SMTP port number for smarthost.
	174
f872534d DM	175	`spf`: `<boolean>` ('default =' `1`)::
	176
	177	Use Sender Policy Framework.
	178
	179	`tls`: `<boolean>` ('default =' `0`)::
	180
eff914dc DM	181	Enable TLS.
	182
	183	`tlsheader`: `<boolean>` ('default =' `0`)::
	184
	185	Add TLS received header.
	186
	187	`tlslog`: `<boolean>` ('default =' `0`)::
	188
	189	Enable TLS Logging.
f872534d	190
eff914dc	191	`verifyreceivers`: `<450 \| 550>` ::
f872534d	192
eff914dc	193	Enable receiver verification. The value spefifies the numerical reply code when the Postfix SMTP server rejects a recipient address.
f872534d DM	194
	195	.Section 'spam'
	196
	197	`bounce_score`: `<integer> (0 - 1000)` ('default =' `0`)::
	198
	199	Additional score for bounce mails.
	200
a18c67c0	201	`clamav_heuristic_score`: `<integer> (0 - 1000)` ('default =' `3`)::
f872534d	202
241ac83c	203	Score for ClamAV heuristics (Google Safe Browsing database, PhishingScanURLs, ...).
f872534d DM	204
	205	`languages`: `(all\|([a-z][a-z])+( ([a-z][a-z])+)*)` ('default =' `all`)::
	206
	207	This option is used to specify which languages are considered OK for incoming mail.
	208
a18c67c0	209	`maxspamsize`: `<integer> (64 - N)` ('default =' `262144`)::
f872534d DM	210
	211	Maximum size of spam messages in bytes.
	212
	213	`rbl_checks`: `<boolean>` ('default =' `1`)::
	214
	215	Enable real time blacklists (RBL) checks.
	216
	217	`use_awl`: `<boolean>` ('default =' `1`)::
	218
	219	Use the Auto-Whitelist plugin.
	220
	221	`use_bayes`: `<boolean>` ('default =' `1`)::
	222
	223	Whether to use the naive-Bayesian-style classifier.
	224
f872534d DM	225	`use_razor`: `<boolean>` ('default =' `1`)::
	226
	227	Whether to use Razor2, if it is available.
	228
	229	`wl_bounce_relays`: `<string>` ::
	230
	231	Whitelist legitimate bounce relays.
	232
f245a28c DM	233	.Section 'spamquar'
	234
	235	`allowhrefs`: `<boolean>` ('default =' `1`)::
	236
	237	Allow to view hyperlinks.
	238
	239	`authmode`: `<ldap \| ldapticket \| ticket>` ('default =' `ticket`)::
	240
	241	Authentication mode to access the quarantine interface. Mode 'ticket' allows login using tickets sent with the daily spam report. Mode 'ldap' requires to login using an LDAP account. Finally, mode 'ldapticket' allows both ways.
	242
f245a28c DM	243	`hostname`: `<string>` ::
f245a28c DM	244
b81b1f95	245	Quarantine Host. Useful if you run a Cluster and want users to connect to a specific host.
f245a28c DM	246
	247	`lifetime`: `<integer> (1 - N)` ('default =' `7`)::
	248
	249	Quarantine life time (days)
	250
	251	`mailfrom`: `<string>` ::
	252
	253	Text for 'From' header in daily spam report mails.
	254
b81b1f95 DM	255	`port`: `<integer> (1 - 65535)` ('default =' `8006`)::
	256
	257	Quarantine Port. Useful if you have a reverse proxy or port forwarding for the webinterface. Only used for the generated Spam report.
	258
	259	`protocol`: `<http \| https>` ('default =' `https`)::
	260
	261	Quarantine Webinterface Protocol. Useful if you have a reverse proxy for the webinterface. Only used for the generated Spam report.
	262
d7cd791b	263	`reportstyle`: `<custom \| none \| short \| verbose>` ('default =' `verbose`)::
f245a28c DM	264
	265	Spam report style.
	266
	267	`viewimages`: `<boolean>` ('default =' `1`)::
	268
	269	Allow to view images.
	270
	271	.Section 'virusquar'
	272
	273	`allowhrefs`: `<boolean>` ('default =' `1`)::
	274
	275	Allow to view hyperlinks.
	276
f245a28c DM	277	`lifetime`: `<integer> (1 - N)` ('default =' `7`)::
	278
	279	Quarantine life time (days)
	280
	281	`viewimages`: `<boolean>` ('default =' `1`)::
	282
	283	Allow to view images.
	284