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

.Section 'admin'

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

Use advanced filters for statistic.

`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`)::

Wether to block encrypted archives. Mark encrypted archives 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).

`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 =' `15`)::

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 =' `99`)::

Maximum number of SMTP daemon processes (in).

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

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.

`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 ClamaAV 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. Usefule 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.

`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
f872534d DM	7	`dailyreport`: `<boolean>` ('default =' `1`)::
	8
	9	Send daily reports.
	10
f872534d DM	11	`demo`: `<boolean>` ('default =' `0`)::
	12
	13	Demo mode - do not start SMTP filter.
	14
eff914dc DM	15	`email`: `<string>` ('default =' `admin@domain.tld`)::
	16
	17	Administrator E-Mail address.
	18
9fda36b0	19	`http_proxy`: `http://.*` ::
f872534d	20
9fda36b0	21	Specify external http proxy which is used for downloads (example: 'http://username:password@host:port/')
f872534d	22
a55e94a6 DM	23	`statlifetime`: `<integer> (1 - N)` ('default =' `7`)::
	24
	25	User Statistics Lifetime (days)
	26
f872534d DM	27	.Section 'clamav'
	28
	29	`archiveblockencrypted`: `<boolean>` ('default =' `0`)::
	30
	31	Wether to block encrypted archives. Mark encrypted archives as viruses.
	32
	33	`archivemaxfiles`: `<integer> (0 - N)` ('default =' `1000`)::
	34
	35	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.
	36
	37	`archivemaxrec`: `<integer> (1 - N)` ('default =' `5`)::
	38
	39	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.
	40
	41	`archivemaxsize`: `<integer> (1000000 - N)` ('default =' `25000000`)::
	42
	43	Files larger than this limit won't be scanned.
	44
	45	`dbmirror`: `<string>` ('default =' `database.clamav.net`)::
	46
	47	ClamAV database mirror server.
	48
f872534d DM	49	`maxcccount`: `<integer> (0 - N)` ('default =' `0`)::
	50
	51	This option sets the lowest number of Credit Card or Social Security numbers found in a file to generate a detect.
	52
	53	`maxscansize`: `<integer> (1000000 - N)` ('default =' `100000000`)::
	54
	55	Sets the maximum amount of data to be scanned for each input file.
	56
f245a28c DM	57	`safebrowsing`: `<boolean>` ('default =' `1`)::
	58
	59	Enables support for Google Safe Browsing.
	60
f872534d DM	61	.Section 'mail'
	62
	63	`banner`: `<string>` ('default =' `ESMTP Proxmox`)::
	64
	65	ESMTP banner.
	66
	67	`conn_count_limit`: `<integer> (0 - N)` ('default =' `50`)::
	68
	69	How many simultaneous connections any client is allowed to make to this service. To disable this feature, specify a limit of 0.
	70
	71	`conn_rate_limit`: `<integer> (0 - N)` ('default =' `0`)::
	72
	73	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.
	74
f872534d DM	75	`dnsbl_sites`: `<string>` ::
	76
	77	Optional list of DNS white/blacklist domains (see postscreen_dnsbl_sites parameter).
	78
	79	`dwarning`: `<integer> (0 - N)` ('default =' `4`)::
	80
	81	SMTP delay warning time (in hours).
	82
4a46ced6	83	`ext_port`: `<integer> (1 - 65535)` ('default =' `25`)::
eff914dc DM	84
	85	SMTP port number for incoming mail (untrusted). This must be a different number than 'int_port'.
	86
f872534d DM	87	`greylist`: `<boolean>` ('default =' `1`)::
	88
	89	Use Greylisting.
	90
	91	`helotests`: `<boolean>` ('default =' `0`)::
	92
	93	Use SMTP HELO tests.
	94
	95	`hide_received`: `<boolean>` ('default =' `0`)::
	96
	97	Hide received header in outgoing mails.
	98
4a46ced6	99	`int_port`: `<integer> (1 - 65535)` ('default =' `26`)::
eff914dc DM	100
	101	SMTP port number for outgoing mail (trusted).
	102
f872534d DM	103	`max_filters`: `<integer> (3 - 40)` ('default =' `15`)::
	104
	105	Maximum number of pmg-smtp-filter processes.
	106
	107	`max_policy`: `<integer> (2 - 10)` ('default =' `5`)::
	108
	109	Maximum number of pmgpolicy processes.
	110
	111	`max_smtpd_in`: `<integer> (3 - 100)` ('default =' `99`)::
	112
	113	Maximum number of SMTP daemon processes (in).
	114
	115	`max_smtpd_out`: `<integer> (3 - 100)` ('default =' `99`)::
	116
	117	Maximum number of SMTP daemon processes (out).
	118
	119	`maxsize`: `<integer> (1024 - N)` ('default =' `10485760`)::
	120
	121	Maximum email size. Larger mails are rejected.
	122
	123	`message_rate_limit`: `<integer> (0 - N)` ('default =' `0`)::
	124
	125	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.
	126
	127	`rejectunknown`: `<boolean>` ('default =' `0`)::
	128
	129	Reject unknown clients.
	130
	131	`rejectunknownsender`: `<boolean>` ('default =' `0`)::
	132
	133	Reject unknown senders.
	134
	135	`relay`: `<string>` ::
	136
	137	The default mail delivery transport (incoming mails).
	138
	139	`relaynomx`: `<boolean>` ('default =' `0`)::
	140
	141	Disable MX lookups for default relay.
	142
	143	`relayport`: `<integer> (1 - 65535)` ('default =' `25`)::
	144
	145	SMTP port number for relay host.
	146
eff914dc DM	147	`smarthost`: `<string>` ::
	148
	149	When set, all outgoing mails are deliverd to the specified smarthost.
	150
f872534d DM	151	`spf`: `<boolean>` ('default =' `1`)::
	152
	153	Use Sender Policy Framework.
	154
	155	`tls`: `<boolean>` ('default =' `0`)::
	156
eff914dc DM	157	Enable TLS.
	158
	159	`tlsheader`: `<boolean>` ('default =' `0`)::
	160
	161	Add TLS received header.
	162
	163	`tlslog`: `<boolean>` ('default =' `0`)::
	164
	165	Enable TLS Logging.
f872534d	166
eff914dc	167	`verifyreceivers`: `<450 \| 550>` ::
f872534d	168
eff914dc	169	Enable receiver verification. The value spefifies the numerical reply code when the Postfix SMTP server rejects a recipient address.
f872534d DM	170
	171	.Section 'spam'
	172
	173	`bounce_score`: `<integer> (0 - 1000)` ('default =' `0`)::
	174
	175	Additional score for bounce mails.
	176
a18c67c0	177	`clamav_heuristic_score`: `<integer> (0 - 1000)` ('default =' `3`)::
f872534d	178
a18c67c0	179	Score for ClamaAV heuristics (Google Safe Browsing database, PhishingScanURLs, ...).
f872534d DM	180
	181	`languages`: `(all\|([a-z][a-z])+( ([a-z][a-z])+)*)` ('default =' `all`)::
	182
	183	This option is used to specify which languages are considered OK for incoming mail.
	184
a18c67c0	185	`maxspamsize`: `<integer> (64 - N)` ('default =' `262144`)::
f872534d DM	186
	187	Maximum size of spam messages in bytes.
	188
	189	`rbl_checks`: `<boolean>` ('default =' `1`)::
	190
	191	Enable real time blacklists (RBL) checks.
	192
	193	`use_awl`: `<boolean>` ('default =' `1`)::
	194
	195	Use the Auto-Whitelist plugin.
	196
	197	`use_bayes`: `<boolean>` ('default =' `1`)::
	198
	199	Whether to use the naive-Bayesian-style classifier.
	200
f872534d DM	201	`use_razor`: `<boolean>` ('default =' `1`)::
	202
	203	Whether to use Razor2, if it is available.
	204
	205	`wl_bounce_relays`: `<string>` ::
	206
	207	Whitelist legitimate bounce relays.
	208
f245a28c DM	209	.Section 'spamquar'
	210
	211	`allowhrefs`: `<boolean>` ('default =' `1`)::
	212
	213	Allow to view hyperlinks.
	214
	215	`authmode`: `<ldap \| ldapticket \| ticket>` ('default =' `ticket`)::
	216
	217	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.
	218
f245a28c DM	219	`hostname`: `<string>` ::
	220
	221	Quarantine Host. Usefule if you run a Cluster and want users to connect to a specific host.
	222
	223	`lifetime`: `<integer> (1 - N)` ('default =' `7`)::
	224
	225	Quarantine life time (days)
	226
	227	`mailfrom`: `<string>` ::
	228
	229	Text for 'From' header in daily spam report mails.
	230
d7cd791b	231	`reportstyle`: `<custom \| none \| short \| verbose>` ('default =' `verbose`)::
f245a28c DM	232
	233	Spam report style.
	234
	235	`viewimages`: `<boolean>` ('default =' `1`)::
	236
	237	Allow to view images.
	238
	239	.Section 'virusquar'
	240
	241	`allowhrefs`: `<boolean>` ('default =' `1`)::
	242
	243	Allow to view hyperlinks.
	244
f245a28c DM	245	`lifetime`: `<integer> (1 - N)` ('default =' `7`)::
	246
	247	Quarantine life time (days)
	248
	249	`viewimages`: `<boolean>` ('default =' `1`)::
	250
	251	Allow to view images.
	252