diff --git a/Makefile b/Makefile index 3d94ab1..f46f091 100644 --- a/Makefile +++ b/Makefile @@ -37,7 +37,8 @@ GEN_DEB_SOURCES= \ ${MANUAL_SOURCES} \ docinfo.xml -GEN_SCRIPTS= +GEN_SCRIPTS= \ + gen-pmg.conf.5-opts.pl API_VIEWER_SOURCES= \ api-viewer/index.html \ @@ -151,7 +152,7 @@ $(GEN_DEB): $(GEN_DEB_SOURCES) asciidoc-pmg install -dm755 build-$(GEN_PACKAGE)/usr/bin # install files install -m 0644 ${GEN_DEB_SOURCES} build-$(GEN_PACKAGE)/usr/share/${GEN_PACKAGE} - #install -m 0755 ${GEN_SCRIPTS} build-$(GEN_PACKAGE)/usr/share/${GEN_PACKAGE} + install -m 0755 ${GEN_SCRIPTS} build-$(GEN_PACKAGE)/usr/share/${GEN_PACKAGE} # install asciidoc-pmg install -m 0755 asciidoc-pmg build-$(GEN_PACKAGE)/usr/bin/ install -dm755 build-$(GEN_PACKAGE)/usr/share/${GEN_PACKAGE}/asciidoc/ diff --git a/gen-pmg.conf.5-opts.pl b/gen-pmg.conf.5-opts.pl new file mode 100755 index 0000000..601d14f --- /dev/null +++ b/gen-pmg.conf.5-opts.pl @@ -0,0 +1,24 @@ +#!/usr/bin/perl + +use lib '.'; +use strict; +use warnings; +use PVE::RESTHandler; + +use Data::Dumper; + +use PMG::Config; + +my $types = PMG::Config::Base->lookup_types; + +foreach my $section (@$types) { + my $plugin = PMG::Config::Base->lookup($section); + my $schema = $plugin->updateSchema(1); + my $properties = $schema->{properties}; + + print ".Section '$section'\n\n"; + + print PVE::RESTHandler::dump_properties($properties); +} + +exit(0); diff --git a/pmg-admin-guide.adoc b/pmg-admin-guide.adoc index 44b3d2f..129f98d 100644 --- a/pmg-admin-guide.adoc +++ b/pmg-admin-guide.adoc @@ -80,10 +80,9 @@ TODO Configuration Files ------------------- -TODO - :leveloffset: 2 -//include::datacenter.cfg.adoc[] + +include::pmg.conf.adoc[] :leveloffset: 0 diff --git a/pmg.conf.5-opts.adoc b/pmg.conf.5-opts.adoc new file mode 100644 index 0000000..ee6ecce --- /dev/null +++ b/pmg.conf.5-opts.adoc @@ -0,0 +1,220 @@ +.Section 'admin' + +`dailyreport`: `` ('default =' `1`):: + +Send daily reports. + +`delete`: `` :: + +A list of settings you want to delete. + +`demo`: `` ('default =' `0`):: + +Demo mode - do not start SMTP filter. + +`digest`: `` :: + +Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. + +`proxypassword`: `` :: + +HTTP proxy password. + +`proxyport`: ` (1 - N)` ('default =' `8080`):: + +HTTP proxy port. + +`proxyserver`: `` :: + +HTTP proxy server address. + +`proxyuser`: `` :: + +HTTP proxy user name. + +.Section 'clamav' + +`archiveblockencrypted`: `` ('default =' `0`):: + +Wether to block encrypted archives. Mark encrypted archives as viruses. + +`archivemaxfiles`: ` (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`: ` (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`: ` (1000000 - N)` ('default =' `25000000`):: + +Files larger than this limit won't be scanned. + +`dbmirror`: `` ('default =' `database.clamav.net`):: + +ClamAV database mirror server. + +`delete`: `` :: + +A list of settings you want to delete. + +`digest`: `` :: + +Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. + +`maxcccount`: ` (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`: ` (1000000 - N)` ('default =' `100000000`):: + +Sets the maximum amount of data to be scanned for each input file. + +.Section 'mail' + +`banner`: `` ('default =' `ESMTP Proxmox`):: + +ESMTP banner. + +`conn_count_limit`: ` (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`: ` (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. + +`delete`: `` :: + +A list of settings you want to delete. + +`digest`: `` :: + +Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. + +`dnsbl_sites`: `` :: + +Optional list of DNS white/blacklist domains (see postscreen_dnsbl_sites parameter). + +`dwarning`: ` (0 - N)` ('default =' `4`):: + +SMTP delay warning time (in hours). + +`greylist`: `` ('default =' `1`):: + +Use Greylisting. + +`helotests`: `` ('default =' `0`):: + +Use SMTP HELO tests. + +`hide_received`: `` ('default =' `0`):: + +Hide received header in outgoing mails. + +`max_filters`: ` (3 - 40)` ('default =' `15`):: + +Maximum number of pmg-smtp-filter processes. + +`max_policy`: ` (2 - 10)` ('default =' `5`):: + +Maximum number of pmgpolicy processes. + +`max_smtpd_in`: ` (3 - 100)` ('default =' `99`):: + +Maximum number of SMTP daemon processes (in). + +`max_smtpd_out`: ` (3 - 100)` ('default =' `99`):: + +Maximum number of SMTP daemon processes (out). + +`maxsize`: ` (1024 - N)` ('default =' `10485760`):: + +Maximum email size. Larger mails are rejected. + +`message_rate_limit`: ` (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`: `` ('default =' `0`):: + +Reject unknown clients. + +`rejectunknownsender`: `` ('default =' `0`):: + +Reject unknown senders. + +`relay`: `` :: + +The default mail delivery transport (incoming mails). + +`relaynomx`: `` ('default =' `0`):: + +Disable MX lookups for default relay. + +`relayport`: ` (1 - 65535)` ('default =' `25`):: + +SMTP port number for relay host. + +`spf`: `` ('default =' `1`):: + +Use Sender Policy Framework. + +`tls`: `` ('default =' `0`):: + +Use TLS. + +`use_rbl`: `` ('default =' `1`):: + +Use Realtime Blacklists. + +`verifyreceivers`: ` (0 - 599)` ('default =' `0`):: + +Enable receiver verification. The value (if greater than 0) spefifies the numerical reply code when the Postfix SMTP server rejects a recipient address (450 or 550). + +.Section 'spam' + +`bounce_score`: ` (0 - 1000)` ('default =' `0`):: + +Additional score for bounce mails. + +`delete`: `` :: + +A list of settings you want to delete. + +`digest`: `` :: + +Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. + +`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`: ` (64 - N)` ('default =' `204800`):: + +Maximum size of spam messages in bytes. + +`rbl_checks`: `` ('default =' `1`):: + +Enable real time blacklists (RBL) checks. + +`use_awl`: `` ('default =' `1`):: + +Use the Auto-Whitelist plugin. + +`use_bayes`: `` ('default =' `1`):: + +Whether to use the naive-Bayesian-style classifier. + +`use_ocr`: `` ('default =' `0`):: + +Enable OCR to scan pictures. + +`use_razor`: `` ('default =' `1`):: + +Whether to use Razor2, if it is available. + +`wl_bounce_relays`: `` :: + +Whitelist legitimate bounce relays. + diff --git a/pmg.conf.adoc b/pmg.conf.adoc new file mode 100644 index 0000000..2b011f6 --- /dev/null +++ b/pmg.conf.adoc @@ -0,0 +1,58 @@ +[[pmg_configuration_file]] +ifdef::manvolnum[] +pmg.conf(5) +=========== +:pmg-toplevel: + +NAME +---- + +pmg.conf - Proxmox Mail Gateway Main Configuration + + +SYNOPSIS +-------- + +`/etc/pmg/pmg.conf` + + +DESCRIPTION +----------- +endif::manvolnum[] +ifndef::manvolnum[] +Proxmox Mail Gateway Main Configuration +======================================= +endif::manvolnum[] +ifdef::wiki[] +:title: Manual: pmg.conf +:pmg-toplevel: +endif::wiki[] + +The file `/etc/pmg/pmg.conf` is the main configuration. + + +File Format +----------- + +The file is divided into several section. Each section has +the following format: + +---- +section: NAME + OPTION value + ... +---- + +Blank lines in the file separates sections, and lines starting with a `#` +character are treated as comments and are also ignored. + + +Options +------- + +include::pmg.conf.5-opts.adoc[] + + +ifdef::manvolnum[] +include::pmg-copyright.adoc[] +endif::manvolnum[]