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