pmg-admin-guide.adoc

   1 ifdef::pmglogo[]
   2 image:./images/proxmox-logo.svg[] pass:[<br>] Proxmox Mail Gateway Administration Guide
   3 =======================================================================================
   4 endif::pmglogo[]
   5 ifndef::pmglogo[]
   6 Proxmox Mail Gateway Administration Guide
   7 =========================================
   8 endif::pmglogo[]
   9 :doctype:   book
  10 :title: Proxmox Mail Gateway Administration Guide
  11 :toc:
  12 :numbered:
  13 :data-uri:
  14 :icons:
  15 ifndef::wiki[]
  16 ifndef::manvolnum[]
  17 :pmg-toplevel:
  18
  19 // Push titles down one level.
  20 :leveloffset: 1
  21
  22 include::pmg-intro.adoc[]
  23
  24 include::pmg-planning-deployment.adoc[]
  25
  26 include::pmg-installation.adoc[]
  27
  28 include::pmgconfig.adoc[]
  29
  30 include::pmg-mail-filter.adoc[]
  31
  32 include::pmgbackup.adoc[]
  33
  34
  35 // Return to normal title levels.
  36 :leveloffset: 0
  37
  38 TODO
  39 ----
  40 // FIXME
  41
  42 [[nmap]]
  43 nmap
  44
  45 [[create_bootable_usb]]
  46 create_bootable_usb
  47
  48 [[mail_server_config]]
  49 mail_server_config
  50
  51 [[fitering_outgoing_mail]]
  52 fitering_outgoing_mail
  53
  54
  55 Important Service Daemons
  56 -------------------------
  57
  58 :leveloffset: 2
  59
  60 include::pmgdaemon.adoc[]
  61
  62 include::pmgproxy.adoc[]
  63
  64 include::pmg-smtp-filter.adoc[]
  65
  66 include::pmgpolicy.adoc[]
  67
  68 include::pmgtunnel.adoc[]
  69
  70 include::pmgmirror.adoc[]
  71
  72 :leveloffset: 0
  73
  74
  75 Useful Command Line Tools
  76 -------------------------
  77
  78 :leveloffset: 2
  79 include::pmgdb.adoc[]
  80
  81 include::pmgsh.adoc[]
  82
  83 include::pmgversion.adoc[]
  84
  85 include::pmgsubscription.adoc[]
  86
  87 include::pmgperf.adoc[]
  88
  89 include::pmgqm.adoc[]
  90
  91 include::pmgreport.adoc[]
  92
  93 include::pmgupgrade.adoc[]
  94
  95
  96 :leveloffset: 1
  97
  98 include::pmg-bibliography.adoc[]
  99
 100 :leveloffset: 0
 101
 102
 103 [appendix]
 104 Command Line Interface
 105 ----------------------
 106
 107 *pmgbackup* - Proxmox Mail Gateway Backup and Restore Utility
 108 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 109
 110 include::pmgbackup.1-synopsis.adoc[]
 111
 112
 113 *pmgsh* - API Shell
 114 ~~~~~~~~~~~~~~~~~~~
 115
 116 include::pmgsh.1-synopsis.adoc[]
 117
 118
 119 *pmgperf* - Proxmox Simple Performance Benchmark
 120 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 121
 122 include::pmgperf.1-synopsis.adoc[]
 123
 124
 125 *pmgconfig* - Configuration Management Toolkit
 126 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 127
 128 include::pmgconfig.1-synopsis.adoc[]
 129
 130
 131 *pmgdb* - Database Management Toolkit
 132 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 133
 134 include::pmgdb.1-synopsis.adoc[]
 135
 136
 137 [appendix]
 138 Service Daemons
 139 ---------------
 140
 141 *pmgdaemon* - {pmg} API Daemon
 142 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 143
 144 include::pmgdaemon.8-synopsis.adoc[]
 145
 146
 147 *pmgproxy* - {pmg} API Proxy Daemon
 148 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 149
 150 include::pmgproxy.8-synopsis.adoc[]
 151
 152
 153 *pmg-smtp-filter* - Proxmox SMTP Filter Daemon
 154 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 155
 156 include::pmg-smtp-filter.8-synopsis.adoc[]
 157
 158
 159 *pmgpolicy* - {pmg} Policy Daemon
 160 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 161
 162 include::pmgpolicy.8-synopsis.adoc[]
 163
 164
 165 *pmgtunnel* - Cluster Tunnel Daemon
 166 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 167
 168 include::pmgtunnel.8-synopsis.adoc[]
 169
 170
 171 *pmgmirror* - Database Mirror Daemon
 172 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 173
 174 include::pmgmirror.8-synopsis.adoc[]
 175
 176
 177 [appendix]
 178 include::pmg-rule-macros.adoc[]
 179
 180 [appendix]
 181 Configuration Files
 182 -------------------
 183
 184 :leveloffset: 2
 185
 186 include::pmg.conf.adoc[]
 187
 188 include::cluster.conf.adoc[]
 189
 190 :leveloffset: 0
 191
 192 :leveloffset: 1
 193
 194 [appendix]
 195 include::GFDL.adoc[]
 196
 197 :leveloffset: 0
 198
 199 endif::manvolnum[]
 200 endif::wiki[]