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