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