pmgconfig.adoc: new file

This commit is contained in:
Dietmar Maurer 2017-02-22 17:26:11 +01:00
parent bd9988d8cd
commit e62ceaf04e
3 changed files with 103 additions and 3 deletions

View File

@ -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

63
pmgconfig.1-synopsis.adoc Normal file
View File

@ -0,0 +1,63 @@
*pmgconfig* `<COMMAND> [ARGS] [OPTIONS]`
*pmgconfig apicert* `[OPTIONS]`
Generate /etc/pmg/pmg-api.pem (self signed certificate for GUI and REST
API).
`-force` `<boolean>` ('default =' `0`)::
Overwrite existing certificate.
*pmgconfig dump*
Print configuration setting which can be used in templates.
*pmgconfig help* `[<cmd>]` `[OPTIONS]`
Get help about specified command.
`<cmd>`: `<string>` ::
Command name
`-verbose` `<boolean>` ::
Verbose output format.
*pmgconfig ldapsync*
Syncronize the LDAP database.
*pmgconfig sync* `[OPTIONS]`
Syncronize Proxmox Mail Gateway configurations with system configuration.
`-restart` `<boolean>` ('default =' `0`)::
Restart services if necessary.
*pmgconfig tlscert* `[OPTIONS]`
Generate /etc/pmg/pmg-tls.pem (self signed certificate for encrypted SMTP
traffic).
`-force` `<boolean>` ('default =' `0`)::
Overwrite existing certificate.

33
pmgconfig.adoc Normal file
View File

@ -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[]