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