pmgproxy.adoc

   1 ifdef::manvolnum[]
   2 pmgproxy(8)
   3 ===========
   4 :pmg-toplevel:
   5
   6 NAME
   7 ----
   8
   9 pmgproxy - Proxmox Mail Gateway API Proxy Daemon
  10
  11
  12 SYNOPSIS
  13 --------
  14
  15 include::pmgproxy.8-synopsis.adoc[]
  16
  17 DESCRIPTION
  18 -----------
  19 endif::manvolnum[]
  20
  21 ifndef::manvolnum[]
  22 pmgproxy - Proxmox Mail Gateway API Proxy Daemon
  23 ================================================
  24 endif::manvolnum[]
  25
  26 This daemon exposes the whole {pmg} API on TCP port 8006 using
  27 HTTPS. It runs as user `www-data` and has very limited permissions.
  28 Operations requiring more permissions are forwarded to the local
  29 `pmgdaemon`.
  30
  31 Requests targeted for other nodes are automatically forwarded to those
  32 nodes. This means that you can manage your whole cluster by connecting
  33 to a single {pmg} node.
  34
  35 Alternative HTTPS certificate
  36 -----------------------------
  37
  38 By default, pmgproxy uses the certificate `/etc/pmg/pmg-api.pem` for HTTPS
  39 connections.  This certificate is self signed, and therefore not trusted by
  40 browsers and operating systems by default. You can simply replace this
  41 certificate with your own (please include the key inside the '.pem' file).
  42
  43
  44 ifdef::manvolnum[]
  45 include::pmg-copyright.adoc[]
  46 endif::manvolnum[]