diff --git a/pmg-admin-guide.adoc b/pmg-admin-guide.adoc index 1d0bce5..f70fff2 100644 --- a/pmg-admin-guide.adoc +++ b/pmg-admin-guide.adoc @@ -55,7 +55,10 @@ Important Service Daemons TODO :leveloffset: 2 -//include::pvedaemon.adoc[] + +include::pmgdaemon.adoc[] + +include::pmgproxy.adoc[] :leveloffset: 0 @@ -99,6 +102,22 @@ include::pmgdb.1-synopsis.adoc[] Service Daemons --------------- +*pmgdaemon* - {pmg} API Daemon +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +:leveloffset: 1 +include::pmgdaemon.8-synopsis.adoc[] + +:leveloffset: 0 + +*pmgproxy* - {pmg} API Proxy Daemon +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +:leveloffset: 1 +include::pmgproxy.8-synopsis.adoc[] + +:leveloffset: 0 + *pmgpolicy* - Policy Daemon ~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/pmgdaemon.adoc b/pmgdaemon.adoc new file mode 100644 index 0000000..a809c02 --- /dev/null +++ b/pmgdaemon.adoc @@ -0,0 +1,36 @@ +ifdef::manvolnum[] +pmgdaemon(8) +============ +:pmg-toplevel: + +NAME +---- + +pmgdaemon - Proxmox Mail Gateway API Daemon + + +SYNOPSIS +-------- + +include::pmgdaemon.8-synopsis.adoc[] + +DESCRIPTION +----------- +endif::manvolnum[] + +ifndef::manvolnum[] +pmgdaemon - Proxmox Mail Gateway API Daemon +=========================================== +endif::manvolnum[] + +This daemon exposes the whole {pmg} API on `127.0.0.1:85`. It runs as +`root` and has permission to do all privileged operations. + +NOTE: The daemon listens to a local address only, so you cannot access +it from outside. The `pmgproxy` daemon exposes the API to the outside +world. + + +ifdef::manvolnum[] +include::pmg-copyright.adoc[] +endif::manvolnum[] diff --git a/pmgproxy.adoc b/pmgproxy.adoc new file mode 100644 index 0000000..05bb7ea --- /dev/null +++ b/pmgproxy.adoc @@ -0,0 +1,47 @@ +ifdef::manvolnum[] +pmgproxy(8) +=========== +:pmg-toplevel: + +NAME +---- + +pmgproxy - Proxmox Mail Gateway API Proxy Daemon + + +SYNOPSIS +-------- + +include::pmgproxy.8-synopsis.adoc[] + +DESCRIPTION +----------- +endif::manvolnum[] + +ifndef::manvolnum[] +pmgproxy - Proxmox Mail Gateway API Proxy Daemon +================================================ +endif::manvolnum[] + +This daemon exposes the whole {pmg} API on TCP port 8006 using +HTTPS. It runs as user `www-data` and has very limited permissions. +Operation requiring more permissions are forwarded to the local +`pmgdaemon`. + +Requests targeted for other nodes are automatically forwarded to those +nodes. This means that you can manage your whole cluster by connecting +to a single {pmg} node. + +Alternative HTTPS certificate +----------------------------- + +By default, pmgproxy uses the certificate `/etc/pmg/pmg-api.pem` for +HTTPS connections. This certificate is a self signed certificate, and +therefor not trusted by browsers and operating systems by default. You +can simply replace this certificate with your own (please include the key +inside the '.pem' file). + + +ifdef::manvolnum[] +include::pmg-copyright.adoc[] +endif::manvolnum[]