]>
Commit | Line | Data |
---|---|---|
410dc2c9 DM |
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 | ||
5c735ebd DM |
24 | include::pmg-planning-deployment.adoc[] |
25 | ||
03c03402 DM |
26 | include::pmg-installation.adoc[] |
27 | ||
e62ceaf0 | 28 | include::pmgconfig.adoc[] |
410dc2c9 | 29 | |
62e86eb6 DM |
30 | include::pmg-mail-filter.adoc[] |
31 | ||
00a7fa74 DM |
32 | include::pmgbackup.adoc[] |
33 | ||
3ea67bfe | 34 | include::pmgcm.adoc[] |
00a7fa74 | 35 | |
410dc2c9 DM |
36 | // Return to normal title levels. |
37 | :leveloffset: 0 | |
38 | ||
90facef4 | 39 | |
410dc2c9 DM |
40 | Important Service Daemons |
41 | ------------------------- | |
42 | ||
410dc2c9 | 43 | :leveloffset: 2 |
fa49ddc5 DM |
44 | |
45 | include::pmgdaemon.adoc[] | |
46 | ||
47 | include::pmgproxy.adoc[] | |
410dc2c9 | 48 | |
43a49777 DM |
49 | include::pmg-smtp-filter.adoc[] |
50 | ||
17f66284 DM |
51 | include::pmgpolicy.adoc[] |
52 | ||
b2e39000 DM |
53 | include::pmgtunnel.adoc[] |
54 | ||
784c81c8 DM |
55 | include::pmgmirror.adoc[] |
56 | ||
410dc2c9 DM |
57 | :leveloffset: 0 |
58 | ||
59 | ||
60 | Useful Command Line Tools | |
61 | ------------------------- | |
62 | ||
410dc2c9 | 63 | :leveloffset: 2 |
93f5feff DM |
64 | include::pmgdb.adoc[] |
65 | ||
66 | include::pmgsh.adoc[] | |
410dc2c9 | 67 | |
ead20c24 DM |
68 | include::pmgversion.adoc[] |
69 | ||
b86ab490 DM |
70 | include::pmgsubscription.adoc[] |
71 | ||
bcd3ebca DM |
72 | include::pmgperf.adoc[] |
73 | ||
d7cd791b DM |
74 | include::pmgqm.adoc[] |
75 | ||
76 | include::pmgreport.adoc[] | |
77 | ||
f2016304 DM |
78 | include::pmgupgrade.adoc[] |
79 | ||
9d334946 DM |
80 | :leveloffset: 0 |
81 | ||
82 | ||
e43acef1 | 83 | [[nmap]] |
9d334946 | 84 | `nmap` - Port Scans |
e43acef1 | 85 | ------------------- |
9d334946 DM |
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 | ||
1803c6bd DM |
106 | |
107 | :leveloffset: 1 | |
108 | ||
109 | include::pmg-bibliography.adoc[] | |
110 | ||
410dc2c9 DM |
111 | :leveloffset: 0 |
112 | ||
ae62f1b7 DM |
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 | ||
aa227838 | 170 | |
410dc2c9 DM |
171 | [appendix] |
172 | Command Line Interface | |
173 | ---------------------- | |
174 | ||
00a7fa74 DM |
175 | *pmgbackup* - Proxmox Mail Gateway Backup and Restore Utility |
176 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
177 | ||
178 | include::pmgbackup.1-synopsis.adoc[] | |
179 | ||
180 | ||
3ea67bfe DM |
181 | *pmgcm* - Proxmox Mail Gateway Cluster Management Toolkit |
182 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
183 | ||
184 | include::pmgcm.1-synopsis.adoc[] | |
185 | ||
186 | ||
e62ceaf0 DM |
187 | *pmgsh* - API Shell |
188 | ~~~~~~~~~~~~~~~~~~~ | |
410dc2c9 | 189 | |
93f5feff | 190 | include::pmgsh.1-synopsis.adoc[] |
bcd3ebca DM |
191 | |
192 | ||
193 | *pmgperf* - Proxmox Simple Performance Benchmark | |
194 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
195 | ||
196 | include::pmgperf.1-synopsis.adoc[] | |
93f5feff | 197 | |
410dc2c9 | 198 | |
e62ceaf0 DM |
199 | *pmgconfig* - Configuration Management Toolkit |
200 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
201 | ||
e62ceaf0 | 202 | include::pmgconfig.1-synopsis.adoc[] |
410dc2c9 | 203 | |
410dc2c9 | 204 | |
f07c4baf DM |
205 | *pmgdb* - Database Management Toolkit |
206 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
207 | ||
f07c4baf DM |
208 | include::pmgdb.1-synopsis.adoc[] |
209 | ||
410dc2c9 DM |
210 | |
211 | [appendix] | |
212 | Service Daemons | |
213 | --------------- | |
214 | ||
fa49ddc5 DM |
215 | *pmgdaemon* - {pmg} API Daemon |
216 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
217 | ||
fa49ddc5 DM |
218 | include::pmgdaemon.8-synopsis.adoc[] |
219 | ||
43a49777 | 220 | |
fa49ddc5 DM |
221 | *pmgproxy* - {pmg} API Proxy Daemon |
222 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
223 | ||
fa49ddc5 DM |
224 | include::pmgproxy.8-synopsis.adoc[] |
225 | ||
43a49777 DM |
226 | |
227 | *pmg-smtp-filter* - Proxmox SMTP Filter Daemon | |
228 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
229 | ||
43a49777 DM |
230 | include::pmg-smtp-filter.8-synopsis.adoc[] |
231 | ||
43a49777 | 232 | |
17f66284 DM |
233 | *pmgpolicy* - {pmg} Policy Daemon |
234 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
410dc2c9 | 235 | |
17f66284 | 236 | include::pmgpolicy.8-synopsis.adoc[] |
410dc2c9 | 237 | |
17f66284 | 238 | |
b2e39000 DM |
239 | *pmgtunnel* - Cluster Tunnel Daemon |
240 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
241 | ||
242 | include::pmgtunnel.8-synopsis.adoc[] | |
243 | ||
244 | ||
784c81c8 DM |
245 | *pmgmirror* - Database Mirror Daemon |
246 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
247 | ||
248 | include::pmgmirror.8-synopsis.adoc[] | |
249 | ||
250 | ||
6dea08b0 DM |
251 | [appendix] |
252 | include::pmg-rule-macros.adoc[] | |
410dc2c9 DM |
253 | |
254 | [appendix] | |
255 | Configuration Files | |
256 | ------------------- | |
257 | ||
410dc2c9 | 258 | :leveloffset: 2 |
f872534d DM |
259 | |
260 | include::pmg.conf.adoc[] | |
410dc2c9 | 261 | |
0802e594 DM |
262 | include::cluster.conf.adoc[] |
263 | ||
72af0c84 DM |
264 | include::user.conf.adoc[] |
265 | ||
51ac9592 DM |
266 | include::ldap.conf.adoc[] |
267 | ||
410dc2c9 DM |
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[] |