diff --git a/api-viewer/apidata.js b/api-viewer/apidata.js index b3820ea..25d6526 100644 --- a/api-viewer/apidata.js +++ b/api-viewer/apidata.js @@ -8021,7 +8021,7 @@ var pmgapi = [ "typetext" : "" }, "hostname" : { - "description" : "Quarantine Host. Usefule if you run a Cluster and want users to connect to a specific host.", + "description" : "Quarantine Host. Useful if you run a Cluster and want users to connect to a specific host.", "format" : "address", "optional" : 1, "type" : "string", @@ -8041,6 +8041,25 @@ var pmgapi = [ "type" : "string", "typetext" : "" }, + "port" : { + "default" : 8006, + "description" : "Quarantine Port. Useful if you have a reverse proxy or port forwarding for the webinterface. Only used for the generated Spam report.", + "maximum" : 65535, + "minimum" : 1, + "optional" : 1, + "type" : "integer", + "typetext" : " (1 - 65535)" + }, + "protocol" : { + "default" : "https", + "description" : "Quarantine Webinterface Protocol. Useful if you have a reverse proxy for the webinterface. Only used for the generated Spam report.", + "enum" : [ + "http", + "https" + ], + "optional" : 1, + "type" : "string" + }, "reportstyle" : { "default" : "verbose", "description" : "Spam report style.", diff --git a/pmg.conf.5-opts.adoc b/pmg.conf.5-opts.adoc index aad109f..0e2ea3a 100644 --- a/pmg.conf.5-opts.adoc +++ b/pmg.conf.5-opts.adoc @@ -218,7 +218,7 @@ Authentication mode to access the quarantine interface. Mode 'ticket' allows log `hostname`: `` :: -Quarantine Host. Usefule if you run a Cluster and want users to connect to a specific host. +Quarantine Host. Useful if you run a Cluster and want users to connect to a specific host. `lifetime`: ` (1 - N)` ('default =' `7`):: @@ -228,6 +228,14 @@ Quarantine life time (days) Text for 'From' header in daily spam report mails. +`port`: ` (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`: `` ('default =' `https`):: + +Quarantine Webinterface Protocol. Useful if you have a reverse proxy for the webinterface. Only used for the generated Spam report. + `reportstyle`: `` ('default =' `verbose`):: Spam report style. diff --git a/pmg.spamquar-conf-opts.adoc b/pmg.spamquar-conf-opts.adoc index 9cb41c8..52b7d64 100644 --- a/pmg.spamquar-conf-opts.adoc +++ b/pmg.spamquar-conf-opts.adoc @@ -8,7 +8,7 @@ Authentication mode to access the quarantine interface. Mode 'ticket' allows log `hostname`: `` :: -Quarantine Host. Usefule if you run a Cluster and want users to connect to a specific host. +Quarantine Host. Useful if you run a Cluster and want users to connect to a specific host. `lifetime`: ` (1 - N)` ('default =' `7`):: @@ -18,6 +18,14 @@ Quarantine life time (days) Text for 'From' header in daily spam report mails. +`port`: ` (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`: `` ('default =' `https`):: + +Quarantine Webinterface Protocol. Useful if you have a reverse proxy for the webinterface. Only used for the generated Spam report. + `reportstyle`: `` ('default =' `verbose`):: Spam report style. diff --git a/pmgbackup.1-synopsis.adoc b/pmgbackup.1-synopsis.adoc index ca89d25..e435f71 100644 --- a/pmgbackup.1-synopsis.adoc +++ b/pmgbackup.1-synopsis.adoc @@ -8,30 +8,22 @@ Backup the system configuration. Backup statistic databases. - - - -*pmgbackup help* `[]` `[OPTIONS]` +*pmgbackup help* `[OPTIONS]` Get help about specified command. -``: `` :: +`--extra-args` `` :: -Command name +Shows help for a specific command `--verbose` `` :: Verbose output format. - - - *pmgbackup list* List all stored backups (files named proxmox-backup_{DATE}.tgz). - - *pmgbackup restore* `--filename ` `[OPTIONS]` Restore the system configuration. @@ -53,5 +45,3 @@ The backup file name. Restore statistic databases. Only considered when you restore the 'database'. - - diff --git a/pmgcm.1-synopsis.adoc b/pmgcm.1-synopsis.adoc index 3e748a0..54410b8 100644 --- a/pmgcm.1-synopsis.adoc +++ b/pmgcm.1-synopsis.adoc @@ -4,9 +4,6 @@ Create initial cluster config with current node as master. - - - *pmgcm delete* `` Remove a node from the cluster. @@ -15,24 +12,18 @@ Remove a node from the cluster. Cluster Node ID. - - - -*pmgcm help* `[]` `[OPTIONS]` +*pmgcm help* `[OPTIONS]` Get help about specified command. -``: `` :: +`--extra-args` `` :: -Command name +Shows help for a specific command `--verbose` `` :: Verbose output format. - - - *pmgcm join* `` `[OPTIONS]` Join a new node to an existing cluster. @@ -45,22 +36,15 @@ IP address. SSL certificate fingerprint. - - *pmgcm join_cmd* Prints the command for joining an new node to the cluster. You need to execute the command on the new node. - - *pmgcm promote* Promote current node to become the new master. - - - *pmgcm status* `[OPTIONS]` Cluster node status. @@ -69,9 +53,6 @@ Cluster node status. List local node if there is no cluster defined. Please note that RSA keys and fingerprint are not valid in that case. - - - *pmgcm sync* `[OPTIONS]` Synchronize cluster configuration. @@ -81,5 +62,3 @@ Synchronize cluster configuration. Optional IP address for master node. - - diff --git a/pmgconfig.1-synopsis.adoc b/pmgconfig.1-synopsis.adoc index 085138f..9675694 100644 --- a/pmgconfig.1-synopsis.adoc +++ b/pmgconfig.1-synopsis.adoc @@ -9,42 +9,30 @@ API). Overwrite existing certificate. - - *pmgconfig dump* Print configuration setting which can be used in templates. - - - -*pmgconfig help* `[]` `[OPTIONS]` +*pmgconfig help* `[OPTIONS]` Get help about specified command. -``: `` :: +`--extra-args` `` :: -Command name +Shows help for a specific command `--verbose` `` :: Verbose output format. - - - *pmgconfig init* Generate required files in /etc/pmg/ - - *pmgconfig ldapsync* Syncronize the LDAP database. - - *pmgconfig sync* `[OPTIONS]` Syncronize Proxmox Mail Gateway configurations with system configuration. @@ -53,8 +41,6 @@ Syncronize Proxmox Mail Gateway configurations with system configuration. Restart services if necessary. - - *pmgconfig tlscert* `[OPTIONS]` Generate /etc/pmg/pmg-tls.pem (self signed certificate for encrypted SMTP @@ -65,5 +51,3 @@ traffic). Overwrite existing certificate. - - diff --git a/pmgdaemon.8-synopsis.adoc b/pmgdaemon.8-synopsis.adoc index e8e6ea4..99d08e3 100644 --- a/pmgdaemon.8-synopsis.adoc +++ b/pmgdaemon.8-synopsis.adoc @@ -1,26 +1,21 @@ *pmgdaemon* ` [ARGS] [OPTIONS]` -*pmgdaemon help* `[]` `[OPTIONS]` +*pmgdaemon help* `[OPTIONS]` Get help about specified command. -``: `` :: +`--extra-args` `` :: -Command name +Shows help for a specific command `--verbose` `` :: Verbose output format. - - - *pmgdaemon restart* Restart the daemon (or start if not running). - - *pmgdaemon start* `[OPTIONS]` Start the daemon. @@ -29,18 +24,12 @@ Start the daemon. Debug mode - stay in foreground - - *pmgdaemon status* Get daemon status. - - *pmgdaemon stop* Stop the daemon. - - diff --git a/pmgdb.1-synopsis.adoc b/pmgdb.1-synopsis.adoc index aba2a6c..0a81aed 100644 --- a/pmgdb.1-synopsis.adoc +++ b/pmgdb.1-synopsis.adoc @@ -4,30 +4,22 @@ Delete PMG rule database. - - *pmgdb dump* Print the PMG rule database. - - - -*pmgdb help* `[]` `[OPTIONS]` +*pmgdb help* `[OPTIONS]` Get help about specified command. -``: `` :: +`--extra-args` `` :: -Command name +Shows help for a specific command `--verbose` `` :: Verbose output format. - - - *pmgdb init* `[OPTIONS]` Initialize/Upgrade the PMG rule database. @@ -40,20 +32,12 @@ Delete existing database. Reset and update statistic database. - - - *pmgdb reset* Reset PMG rule database back to factory defaults. - - - *pmgdb update* Update the PMG statistic database. - - diff --git a/pmgmirror.8-synopsis.adoc b/pmgmirror.8-synopsis.adoc index 04ba3e0..d559e05 100644 --- a/pmgmirror.8-synopsis.adoc +++ b/pmgmirror.8-synopsis.adoc @@ -1,26 +1,21 @@ *pmgmirror* ` [ARGS] [OPTIONS]` -*pmgmirror help* `[]` `[OPTIONS]` +*pmgmirror help* `[OPTIONS]` Get help about specified command. -``: `` :: +`--extra-args` `` :: -Command name +Shows help for a specific command `--verbose` `` :: Verbose output format. - - - *pmgmirror restart* Restart the Database Mirror Daemon - - *pmgmirror start* `[OPTIONS]` Start the Database Mirror Daemon @@ -29,12 +24,8 @@ Start the Database Mirror Daemon Debug mode - stay in foreground - - *pmgmirror stop* Stop the Database Mirror Daemon - - diff --git a/pmgproxy.8-synopsis.adoc b/pmgproxy.8-synopsis.adoc index a422ebf..8515291 100644 --- a/pmgproxy.8-synopsis.adoc +++ b/pmgproxy.8-synopsis.adoc @@ -1,26 +1,21 @@ *pmgproxy* ` [ARGS] [OPTIONS]` -*pmgproxy help* `[]` `[OPTIONS]` +*pmgproxy help* `[OPTIONS]` Get help about specified command. -``: `` :: +`--extra-args` `` :: -Command name +Shows help for a specific command `--verbose` `` :: Verbose output format. - - - *pmgproxy restart* Restart the daemon (or start if not running). - - *pmgproxy start* `[OPTIONS]` Start the daemon. @@ -29,18 +24,12 @@ Start the daemon. Debug mode - stay in foreground - - *pmgproxy status* Get daemon status. - - *pmgproxy stop* Stop the daemon. - - diff --git a/pmgqm.1-synopsis.adoc b/pmgqm.1-synopsis.adoc index ec8a78d..9400f94 100644 --- a/pmgqm.1-synopsis.adoc +++ b/pmgqm.1-synopsis.adoc @@ -1,20 +1,17 @@ *pmgqm* ` [ARGS] [OPTIONS]` -*pmgqm help* `[]` `[OPTIONS]` +*pmgqm help* `[OPTIONS]` Get help about specified command. -``: `` :: +`--extra-args` `` :: -Command name +Shows help for a specific command `--verbose` `` :: Verbose output format. - - - *pmgqm purge* `[OPTIONS]` Cleanup Quarantine database. Remove entries older than configured @@ -24,8 +21,6 @@ quarantine lifetime. Only search for quarantine files older than configured quarantine lifetime. Just print found files, but do not remove them. - - *pmgqm send* `[OPTIONS]` Generate and send spam report emails. @@ -50,8 +45,6 @@ Spam report style. Default value is read from spam quarantine configuration. Select time span. - - *pmgqm status* `[OPTIONS]` Print quarantine status (mails per user) for specified time span. @@ -61,5 +54,3 @@ Print quarantine status (mails per user) for specified time span. Select time span. - - diff --git a/pmgsubscription.1-synopsis.adoc b/pmgsubscription.1-synopsis.adoc index 65644a8..1e15f29 100644 --- a/pmgsubscription.1-synopsis.adoc +++ b/pmgsubscription.1-synopsis.adoc @@ -4,24 +4,18 @@ Read subscription info. - - - -*pmgsubscription help* `[]` `[OPTIONS]` +*pmgsubscription help* `[OPTIONS]` Get help about specified command. -``: `` :: +`--extra-args` `` :: -Command name +Shows help for a specific command `--verbose` `` :: Verbose output format. - - - *pmgsubscription set* `` Set subscription key. @@ -30,8 +24,6 @@ Set subscription key. Proxmox Mail Gateway subscription key - - *pmgsubscription update* `[OPTIONS]` Update subscription info. @@ -41,5 +33,3 @@ Update subscription info. Always connect to server, even if we have up to date info inside local cache. - - diff --git a/pmgtunnel.8-synopsis.adoc b/pmgtunnel.8-synopsis.adoc index c894d64..cd058a4 100644 --- a/pmgtunnel.8-synopsis.adoc +++ b/pmgtunnel.8-synopsis.adoc @@ -1,26 +1,21 @@ *pmgtunnel* ` [ARGS] [OPTIONS]` -*pmgtunnel help* `[]` `[OPTIONS]` +*pmgtunnel help* `[OPTIONS]` Get help about specified command. -``: `` :: +`--extra-args` `` :: -Command name +Shows help for a specific command `--verbose` `` :: Verbose output format. - - - *pmgtunnel restart* Restart the Cluster Tunnel Daemon - - *pmgtunnel start* `[OPTIONS]` Start the Cluster Tunnel Daemon @@ -29,18 +24,12 @@ Start the Cluster Tunnel Daemon Debug mode - stay in foreground - - *pmgtunnel status* Print cluster tunnel status. - - *pmgtunnel stop* Stop the Cluster Tunnel Daemon - -