proxmox-mirrors/pmg-docs
1
0
Fork 0
mirror of https://git.proxmox.com/git/pmg-docs synced 2025-07-09 18:37:16 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

update generated docs

Browse Source
This commit is contained in:
Dietmar Maurer 2018-01-31 14:02:21 +01:00
parent ee34edb0cc
commit b81b1f9520
13 changed files with 68 additions and 157 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
api-viewer/apidata.js
View File

@ -8021,7 +8021,7 @@ var pmgapi = [
"typetext" : "<string>"
},
"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" : "<string>"
},
"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" : "<integer> (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.",

10
pmg.conf.5-opts.adoc
View File

@ -218,7 +218,7 @@ Authentication mode to access the quarantine interface. Mode 'ticket' allows log
`hostname`: `<string>` ::
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`: `<integer> (1 - N)` ('default =' `7`)::
@ -228,6 +228,14 @@ Quarantine life time (days)
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.

10
pmg.spamquar-conf-opts.adoc
View File

@ -8,7 +8,7 @@ Authentication mode to access the quarantine interface. Mode 'ticket' allows log
`hostname`: `<string>` ::
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`: `<integer> (1 - N)` ('default =' `7`)::
@ -18,6 +18,14 @@ Quarantine life time (days)
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.

16
pmgbackup.1-synopsis.adoc
View File

@ -8,30 +8,22 @@ Backup the system configuration.
Backup statistic databases.
*pmgbackup help* `[<cmd>]` `[OPTIONS]`
*pmgbackup help* `[OPTIONS]`
Get help about specified command.
`<cmd>`: `<string>` ::
`--extra-args` `<array>` ::
Command name
Shows help for a specific command
`--verbose` `<boolean>` ::
Verbose output format.
*pmgbackup list*
List all stored backups (files named proxmox-backup_{DATE}.tgz).
*pmgbackup restore* `--filename <string>` `[OPTIONS]`
Restore the system configuration.
@ -53,5 +45,3 @@ The backup file name.
Restore statistic databases. Only considered when you restore the 'database'.

27
pmgcm.1-synopsis.adoc
View File

@ -4,9 +4,6 @@
Create initial cluster config with current node as master.
*pmgcm delete* `<cid>`
Remove a node from the cluster.
@ -15,24 +12,18 @@ Remove a node from the cluster.
Cluster Node ID.
*pmgcm help* `[<cmd>]` `[OPTIONS]`
*pmgcm help* `[OPTIONS]`
Get help about specified command.
`<cmd>`: `<string>` ::
`--extra-args` `<array>` ::
Command name
Shows help for a specific command
`--verbose` `<boolean>` ::
Verbose output format.
*pmgcm join* `<master_ip>` `[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.

22
pmgconfig.1-synopsis.adoc
View File

@ -9,42 +9,30 @@ API).
Overwrite existing certificate.
*pmgconfig dump*
Print configuration setting which can be used in templates.
*pmgconfig help* `[<cmd>]` `[OPTIONS]`
*pmgconfig help* `[OPTIONS]`
Get help about specified command.
`<cmd>`: `<string>` ::
`--extra-args` `<array>` ::
Command name
Shows help for a specific command
`--verbose` `<boolean>` ::
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.

17
pmgdaemon.8-synopsis.adoc
View File

@ -1,26 +1,21 @@
*pmgdaemon* `<COMMAND> [ARGS] [OPTIONS]`
*pmgdaemon help* `[<cmd>]` `[OPTIONS]`
*pmgdaemon help* `[OPTIONS]`
Get help about specified command.
`<cmd>`: `<string>` ::
`--extra-args` `<array>` ::
Command name
Shows help for a specific command
`--verbose` `<boolean>` ::
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.

22
pmgdb.1-synopsis.adoc
View File

@ -4,30 +4,22 @@
Delete PMG rule database.
*pmgdb dump*
Print the PMG rule database.
*pmgdb help* `[<cmd>]` `[OPTIONS]`
*pmgdb help* `[OPTIONS]`
Get help about specified command.
`<cmd>`: `<string>` ::
`--extra-args` `<array>` ::
Command name
Shows help for a specific command
`--verbose` `<boolean>` ::
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.

15
pmgmirror.8-synopsis.adoc
View File

@ -1,26 +1,21 @@
*pmgmirror* `<COMMAND> [ARGS] [OPTIONS]`
*pmgmirror help* `[<cmd>]` `[OPTIONS]`
*pmgmirror help* `[OPTIONS]`
Get help about specified command.
`<cmd>`: `<string>` ::
`--extra-args` `<array>` ::
Command name
Shows help for a specific command
`--verbose` `<boolean>` ::
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

17
pmgproxy.8-synopsis.adoc
View File

@ -1,26 +1,21 @@
*pmgproxy* `<COMMAND> [ARGS] [OPTIONS]`
*pmgproxy help* `[<cmd>]` `[OPTIONS]`
*pmgproxy help* `[OPTIONS]`
Get help about specified command.
`<cmd>`: `<string>` ::
`--extra-args` `<array>` ::
Command name
Shows help for a specific command
`--verbose` `<boolean>` ::
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.

15
pmgqm.1-synopsis.adoc
View File

@ -1,20 +1,17 @@
*pmgqm* `<COMMAND> [ARGS] [OPTIONS]`
*pmgqm help* `[<cmd>]` `[OPTIONS]`
*pmgqm help* `[OPTIONS]`
Get help about specified command.
`<cmd>`: `<string>` ::
`--extra-args` `<array>` ::
Command name
Shows help for a specific command
`--verbose` `<boolean>` ::
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.

16
pmgsubscription.1-synopsis.adoc
View File

@ -4,24 +4,18 @@
Read subscription info.
*pmgsubscription help* `[<cmd>]` `[OPTIONS]`
*pmgsubscription help* `[OPTIONS]`
Get help about specified command.
`<cmd>`: `<string>` ::
`--extra-args` `<array>` ::
Command name
Shows help for a specific command
`--verbose` `<boolean>` ::
Verbose output format.
*pmgsubscription set* `<key>`
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.

17
pmgtunnel.8-synopsis.adoc
View File

@ -1,26 +1,21 @@
*pmgtunnel* `<COMMAND> [ARGS] [OPTIONS]`
*pmgtunnel help* `[<cmd>]` `[OPTIONS]`
*pmgtunnel help* `[OPTIONS]`
Get help about specified command.
`<cmd>`: `<string>` ::
`--extra-args` `<array>` ::
Command name
Shows help for a specific command
`--verbose` `<boolean>` ::
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