pmgconfig.adoc

   1 [[chapter_pmgconfig]]
   2 ifdef::manvolnum[]
   3 pmgconfig(1)
   4 ============
   5 :pmg-toplevel:
   6
   7 NAME
   8 ----
   9
  10 pmgconfig - Proxmox Mail Gateway Configuration Management Toolkit
  11
  12
  13 SYNOPSIS
  14 --------
  15
  16 include::pmgconfig.1-synopsis.adoc[]
  17
  18
  19 DESCRIPTION
  20 -----------
  21 endif::manvolnum[]
  22 ifndef::manvolnum[]
  23 Configuration Management Toolkit
  24 ================================
  25 :pmg-toplevel:
  26 endif::manvolnum[]
  27
  28 {pmg} is usually configured using the web-based Graphical User
  29 Interface (GUI), but it is also possible to directly edit the
  30 configuration files, use the REST API over 'https'
  31 or the command line tool 'pmgsh'.
  32
  33 The command line tool 'pmgconfig' is used to simplify some common
  34 configuration tasks, i.e. to generate cerificates and to rewrite
  35 service configuration files.
  36
  37 System Configuration
  38 --------------------
  39
  40 Network and Time
  41 ~~~~~~~~~~~~~~~~
  42
  43 ifndef::manvolnum[]
  44 image::images/screenshot/pmg-gui-network-config.png[]
  45 endif::manvolnum[]
  46
  47 Normally the network and time is already configured when you visit the
  48 GUI. The installer asks for those setting and sets up the correct
  49 values.
  50
  51 The default setup uses a single Ethernet adapter and static IP
  52 assignment. The configuration is stored at '/etc/network/interfaces',
  53 and the actual network setup is done the standard Debian way using
  54 package 'ifupdown'.
  55
  56 .Example network setup '/etc/network/interfaces'
  57 ----
  58 source /etc/network/interfaces.d/*
  59
  60 auto lo
  61 iface lo inet loopback
  62
  63 auto ens18
  64 iface ens18 inet static
  65         address  192.168.2.127
  66         netmask  255.255.240.0
  67         gateway  192.168.2.1
  68 ----
  69
  70 .DNS recommendations
  71
  72 Many tests to detect SPAM mails use DNS queries, so it is important to
  73 have a fast and reliable DNS server. We also query some public
  74 available DNS Blacklists. Most of them apply rate limits for clients,
  75 so they simply will not work if you use a public DNS server (because
  76 they are usually blocked). We recommend to use your own DNS server,
  77 which need to be configured in 'recursive' mode.
  78
  79
  80 Options
  81 ~~~~~~~
  82
  83 ifndef::manvolnum[]
  84 image::images/screenshot/pmg-gui-system-options.png[]
  85 endif::manvolnum[]
  86
  87 include::pmg.admin-conf-opts.adoc[]
  88
  89
  90 Backup and Restore
  91 ~~~~~~~~~~~~~~~~~~
  92
  93 ifndef::manvolnum[]
  94 image::images/screenshot/pmg-gui-backup.png[]
  95 endif::manvolnum[]
  96
  97 TODO
  98
  99
 100
 101 ifdef::manvolnum[]
 102 include::pmg-copyright.adoc[]
 103 endif::manvolnum[]
 104