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