From e62ceaf04e952b5791189ede5260e4d7015b169f Mon Sep 17 00:00:00 2001 From: Dietmar Maurer Date: Wed, 22 Feb 2017 17:26:11 +0100 Subject: [PATCH] pmgconfig.adoc: new file --- pmg-admin-guide.adoc | 10 +++++-- pmgconfig.1-synopsis.adoc | 63 +++++++++++++++++++++++++++++++++++++++ pmgconfig.adoc | 33 ++++++++++++++++++++ 3 files changed, 103 insertions(+), 3 deletions(-) create mode 100644 pmgconfig.1-synopsis.adoc create mode 100644 pmgconfig.adoc diff --git a/pmg-admin-guide.adoc b/pmg-admin-guide.adoc index b73e92a..47905ef 100644 --- a/pmg-admin-guide.adoc +++ b/pmg-admin-guide.adoc @@ -25,6 +25,7 @@ include::pmg-quick-start.adoc[] include::pmg-planning-deployment.adoc[] +include::pmgconfig.adoc[] // Return to normal title levels. :leveloffset: 0 @@ -71,13 +72,16 @@ TODO Command Line Interface ---------------------- -*pmgsh* - {pmg} API Shell -~~~~~~~~~~~~~~~~~~~~~~~~~ +*pmgsh* - API Shell +~~~~~~~~~~~~~~~~~~~ TODO +*pmgconfig* - Configuration Management Toolkit +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + :leveloffset: 1 -//include::pvesm.1-synopsis.adoc[] +include::pmgconfig.1-synopsis.adoc[] :leveloffset: 0 diff --git a/pmgconfig.1-synopsis.adoc b/pmgconfig.1-synopsis.adoc new file mode 100644 index 0000000..eb69b84 --- /dev/null +++ b/pmgconfig.1-synopsis.adoc @@ -0,0 +1,63 @@ +*pmgconfig* ` [ARGS] [OPTIONS]` + +*pmgconfig apicert* `[OPTIONS]` + +Generate /etc/pmg/pmg-api.pem (self signed certificate for GUI and REST +API). + +`-force` `` ('default =' `0`):: + +Overwrite existing certificate. + + + +*pmgconfig dump* + +Print configuration setting which can be used in templates. + + + + +*pmgconfig help* `[]` `[OPTIONS]` + +Get help about specified command. + +``: `` :: + +Command name + +`-verbose` `` :: + +Verbose output format. + + + + +*pmgconfig ldapsync* + +Syncronize the LDAP database. + + + +*pmgconfig sync* `[OPTIONS]` + +Syncronize Proxmox Mail Gateway configurations with system configuration. + +`-restart` `` ('default =' `0`):: + +Restart services if necessary. + + + +*pmgconfig tlscert* `[OPTIONS]` + +Generate /etc/pmg/pmg-tls.pem (self signed certificate for encrypted SMTP +traffic). + +`-force` `` ('default =' `0`):: + +Overwrite existing certificate. + + + + diff --git a/pmgconfig.adoc b/pmgconfig.adoc new file mode 100644 index 0000000..446fdef --- /dev/null +++ b/pmgconfig.adoc @@ -0,0 +1,33 @@ +[[chapter_pmgconfig]] +ifdef::manvolnum[] +pmgconfig(1) +============ +:pmg-toplevel: + +NAME +---- + +pmgconfig - Proxmox Mail Gateway Configuration Management Toolkit + + +SYNOPSIS +-------- + +include::pmgconfig.1-synopsis.adoc[] + + +DESCRIPTION +----------- +endif::manvolnum[] +ifndef::manvolnum[] +Configuration Management Toolkit +================================ +:pmg-toplevel: +endif::manvolnum[] + +Toolkit to simplify common configuration tasks. + +ifdef::manvolnum[] +include::pmg-copyright.adoc[] +endif::manvolnum[] +