new files: pmgdaemon.adoc and pmgproxy.adoc

This commit is contained in:
Dietmar Maurer 2017-02-22 18:08:28 +01:00
parent f07c4baff5
commit fa49ddc539
3 changed files with 103 additions and 1 deletions

View File

@ -55,7 +55,10 @@ Important Service Daemons
TODO TODO
:leveloffset: 2 :leveloffset: 2
//include::pvedaemon.adoc[]
include::pmgdaemon.adoc[]
include::pmgproxy.adoc[]
:leveloffset: 0 :leveloffset: 0
@ -99,6 +102,22 @@ include::pmgdb.1-synopsis.adoc[]
Service Daemons 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 *pmgpolicy* - Policy Daemon
~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~

36
pmgdaemon.adoc Normal file
View File

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

47
pmgproxy.adoc Normal file
View File

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