]> git.proxmox.com Git - pmg-docs.git/blame - pmg-admin-guide.adoc
bump version to 5.0-8
[pmg-docs.git] / pmg-admin-guide.adoc
CommitLineData
410dc2c9
DM
1ifdef::pmglogo[]
2image:./images/proxmox-logo.svg[] pass:[<br>] Proxmox Mail Gateway Administration Guide
3=======================================================================================
4endif::pmglogo[]
5ifndef::pmglogo[]
6Proxmox Mail Gateway Administration Guide
7=========================================
8endif::pmglogo[]
9:doctype: book
10:title: Proxmox Mail Gateway Administration Guide
11:toc:
12:numbered:
13:data-uri:
14:icons:
15ifndef::wiki[]
16ifndef::manvolnum[]
17:pmg-toplevel:
18
19// Push titles down one level.
20:leveloffset: 1
21
22include::pmg-intro.adoc[]
23
5c735ebd
DM
24include::pmg-planning-deployment.adoc[]
25
03c03402
DM
26include::pmg-installation.adoc[]
27
e62ceaf0 28include::pmgconfig.adoc[]
410dc2c9 29
62e86eb6
DM
30include::pmg-mail-filter.adoc[]
31
e3eaa56a
DM
32include::pmg-administration.adoc[]
33
00a7fa74
DM
34include::pmgbackup.adoc[]
35
3ea67bfe 36include::pmgcm.adoc[]
00a7fa74 37
410dc2c9
DM
38// Return to normal title levels.
39:leveloffset: 0
40
90facef4 41
410dc2c9
DM
42Important Service Daemons
43-------------------------
44
410dc2c9 45:leveloffset: 2
fa49ddc5
DM
46
47include::pmgdaemon.adoc[]
48
49include::pmgproxy.adoc[]
410dc2c9 50
43a49777
DM
51include::pmg-smtp-filter.adoc[]
52
17f66284
DM
53include::pmgpolicy.adoc[]
54
b2e39000
DM
55include::pmgtunnel.adoc[]
56
784c81c8
DM
57include::pmgmirror.adoc[]
58
410dc2c9
DM
59:leveloffset: 0
60
61
62Useful Command Line Tools
63-------------------------
64
410dc2c9 65:leveloffset: 2
93f5feff
DM
66include::pmgdb.adoc[]
67
68include::pmgsh.adoc[]
410dc2c9 69
ead20c24
DM
70include::pmgversion.adoc[]
71
b86ab490
DM
72include::pmgsubscription.adoc[]
73
bcd3ebca
DM
74include::pmgperf.adoc[]
75
d7cd791b
DM
76include::pmgqm.adoc[]
77
78include::pmgreport.adoc[]
79
f2016304
DM
80include::pmgupgrade.adoc[]
81
abca4c1d 82:leveloffset: 1
9d334946 83
abca4c1d 84include::nmap.adoc[]
9d334946 85
abca4c1d 86:leveloffset: 0
9d334946 87
9d334946 88
9d334946 89
1803c6bd
DM
90
91:leveloffset: 1
92
93include::pmg-bibliography.adoc[]
94
410dc2c9
DM
95:leveloffset: 0
96
ae62f1b7 97[appendix]
81b3c41f 98include::pmg-ssl-certificate.adoc[]
ae62f1b7 99
aa227838 100
410dc2c9
DM
101[appendix]
102Command Line Interface
103----------------------
104
00a7fa74
DM
105*pmgbackup* - Proxmox Mail Gateway Backup and Restore Utility
106~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
107
108include::pmgbackup.1-synopsis.adoc[]
109
110
3ea67bfe
DM
111*pmgcm* - Proxmox Mail Gateway Cluster Management Toolkit
112~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
113
114include::pmgcm.1-synopsis.adoc[]
115
116
e62ceaf0
DM
117*pmgsh* - API Shell
118~~~~~~~~~~~~~~~~~~~
410dc2c9 119
93f5feff 120include::pmgsh.1-synopsis.adoc[]
bcd3ebca
DM
121
122
123*pmgperf* - Proxmox Simple Performance Benchmark
124~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
125
126include::pmgperf.1-synopsis.adoc[]
93f5feff 127
410dc2c9 128
e62ceaf0
DM
129*pmgconfig* - Configuration Management Toolkit
130~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
131
e62ceaf0 132include::pmgconfig.1-synopsis.adoc[]
410dc2c9 133
410dc2c9 134
f07c4baf
DM
135*pmgdb* - Database Management Toolkit
136~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
137
f07c4baf
DM
138include::pmgdb.1-synopsis.adoc[]
139
410dc2c9
DM
140
141[appendix]
142Service Daemons
143---------------
144
fa49ddc5
DM
145*pmgdaemon* - {pmg} API Daemon
146~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
147
fa49ddc5
DM
148include::pmgdaemon.8-synopsis.adoc[]
149
43a49777 150
fa49ddc5
DM
151*pmgproxy* - {pmg} API Proxy Daemon
152~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
153
fa49ddc5
DM
154include::pmgproxy.8-synopsis.adoc[]
155
43a49777
DM
156
157*pmg-smtp-filter* - Proxmox SMTP Filter Daemon
158~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
159
43a49777
DM
160include::pmg-smtp-filter.8-synopsis.adoc[]
161
43a49777 162
17f66284
DM
163*pmgpolicy* - {pmg} Policy Daemon
164~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
410dc2c9 165
17f66284 166include::pmgpolicy.8-synopsis.adoc[]
410dc2c9 167
17f66284 168
b2e39000
DM
169*pmgtunnel* - Cluster Tunnel Daemon
170~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
171
172include::pmgtunnel.8-synopsis.adoc[]
173
174
784c81c8
DM
175*pmgmirror* - Database Mirror Daemon
176~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
177
178include::pmgmirror.8-synopsis.adoc[]
179
180
6dea08b0
DM
181[appendix]
182include::pmg-rule-macros.adoc[]
410dc2c9
DM
183
184[appendix]
185Configuration Files
186-------------------
187
410dc2c9 188:leveloffset: 2
f872534d
DM
189
190include::pmg.conf.adoc[]
410dc2c9 191
0802e594
DM
192include::cluster.conf.adoc[]
193
72af0c84
DM
194include::user.conf.adoc[]
195
51ac9592
DM
196include::ldap.conf.adoc[]
197
410dc2c9
DM
198:leveloffset: 0
199
200:leveloffset: 1
201
202[appendix]
203include::GFDL.adoc[]
204
205:leveloffset: 0
206
207endif::manvolnum[]
208endif::wiki[]