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 include::pmgcm.adoc[]
  35
  36 // Return to normal title levels.
  37 :leveloffset: 0
  38
  39
  40 Important Service Daemons
  41 -------------------------
  42
  43 :leveloffset: 2
  44
  45 include::pmgdaemon.adoc[]
  46
  47 include::pmgproxy.adoc[]
  48
  49 include::pmg-smtp-filter.adoc[]
  50
  51 include::pmgpolicy.adoc[]
  52
  53 include::pmgtunnel.adoc[]
  54
  55 include::pmgmirror.adoc[]
  56
  57 :leveloffset: 0
  58
  59
  60 Useful Command Line Tools
  61 -------------------------
  62
  63 :leveloffset: 2
  64 include::pmgdb.adoc[]
  65
  66 include::pmgsh.adoc[]
  67
  68 include::pmgversion.adoc[]
  69
  70 include::pmgsubscription.adoc[]
  71
  72 include::pmgperf.adoc[]
  73
  74 include::pmgqm.adoc[]
  75
  76 include::pmgreport.adoc[]
  77
  78 include::pmgupgrade.adoc[]
  79
  80 :leveloffset: 1
  81
  82 include::nmap.adoc[]
  83
  84 :leveloffset: 0
  85
  86
  87
  88
  89 :leveloffset: 1
  90
  91 include::pmg-bibliography.adoc[]
  92
  93 :leveloffset: 0
  94
  95 [appendix]
  96 SSL certificate
  97 ---------------
  98
  99 Access to the administration web interface is always done via
 100 `https`. The default certificate is never valid for your browser and
 101 you get always warnings.
 102
 103 If you want to get rid of these warnings, you have to generate a valid
 104 certificate for your server.
 105
 106 Login to your Proxmox via ssh or use the console:
 107
 108 ----
 109 openssl req -newkey rsa:2048 -nodes -keyout key.pem -out req.pem
 110 ----
 111
 112 Follow the instructions on the screen, see this example:
 113
 114 ----
 115 Country Name (2 letter code) [AU]: AT
 116 State or Province Name (full name) [Some-State]:Vienna
 117 Locality Name (eg, city) []:Vienna
 118 Organization Name (eg, company) [Internet Widgits Pty Ltd]: Proxmox GmbH
 119 Organizational Unit Name (eg, section) []:Proxmox Mail Gateway
 120 Common Name (eg, YOUR name) []: yourproxmox.yourdomain.com
 121 Email Address []:support@yourdomain.com
 122
 123 Please enter the following 'extra' attributes to be sent with your certificate request
 124 A challenge password []: not necessary
 125 An optional company name []: not necessary
 126 ----
 127
 128 After you finished this certificate request you have to send the file
 129 `req.pem` to your Certification Authority (CA). The CA will issue the
 130 certificate (BASE64 encoded) based on your request – save this file as
 131 `cert.pem` to your Proxmox.
 132
 133 To activate the new certificate, do the following on your Proxmox:
 134
 135 ----
 136 cat key.pem cert.pem >/etc/pmg/pmg-api.pem
 137 ----
 138
 139 The restart the API servers
 140
 141 ----
 142 systemctl restart pmgproxy
 143 ----
 144
 145 Test your new certificate by using your browser.
 146
 147 NOTE: To transfer files from and to your Proxmox, you can use secure
 148 copy: If you desktop is Linux, you can use the `scp` command line
 149 tool. If your desktop PC is windows, please use a scp client like
 150 WinSCP (see http://winscp.net/).
 151
 152
 153 [appendix]
 154 Command Line Interface
 155 ----------------------
 156
 157 *pmgbackup* - Proxmox Mail Gateway Backup and Restore Utility
 158 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 159
 160 include::pmgbackup.1-synopsis.adoc[]
 161
 162
 163 *pmgcm* - Proxmox Mail Gateway Cluster Management Toolkit
 164 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 165
 166 include::pmgcm.1-synopsis.adoc[]
 167
 168
 169 *pmgsh* - API Shell
 170 ~~~~~~~~~~~~~~~~~~~
 171
 172 include::pmgsh.1-synopsis.adoc[]
 173
 174
 175 *pmgperf* - Proxmox Simple Performance Benchmark
 176 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 177
 178 include::pmgperf.1-synopsis.adoc[]
 179
 180
 181 *pmgconfig* - Configuration Management Toolkit
 182 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 183
 184 include::pmgconfig.1-synopsis.adoc[]
 185
 186
 187 *pmgdb* - Database Management Toolkit
 188 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 189
 190 include::pmgdb.1-synopsis.adoc[]
 191
 192
 193 [appendix]
 194 Service Daemons
 195 ---------------
 196
 197 *pmgdaemon* - {pmg} API Daemon
 198 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 199
 200 include::pmgdaemon.8-synopsis.adoc[]
 201
 202
 203 *pmgproxy* - {pmg} API Proxy Daemon
 204 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 205
 206 include::pmgproxy.8-synopsis.adoc[]
 207
 208
 209 *pmg-smtp-filter* - Proxmox SMTP Filter Daemon
 210 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 211
 212 include::pmg-smtp-filter.8-synopsis.adoc[]
 213
 214
 215 *pmgpolicy* - {pmg} Policy Daemon
 216 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 217
 218 include::pmgpolicy.8-synopsis.adoc[]
 219
 220
 221 *pmgtunnel* - Cluster Tunnel Daemon
 222 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 223
 224 include::pmgtunnel.8-synopsis.adoc[]
 225
 226
 227 *pmgmirror* - Database Mirror Daemon
 228 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 229
 230 include::pmgmirror.8-synopsis.adoc[]
 231
 232
 233 [appendix]
 234 include::pmg-rule-macros.adoc[]
 235
 236 [appendix]
 237 Configuration Files
 238 -------------------
 239
 240 :leveloffset: 2
 241
 242 include::pmg.conf.adoc[]
 243
 244 include::cluster.conf.adoc[]
 245
 246 include::user.conf.adoc[]
 247
 248 include::ldap.conf.adoc[]
 249
 250 :leveloffset: 0
 251
 252 :leveloffset: 1
 253
 254 [appendix]
 255 include::GFDL.adoc[]
 256
 257 :leveloffset: 0
 258
 259 endif::manvolnum[]
 260 endif::wiki[]