]> git.proxmox.com Git - pmg-docs.git/blame - pmg-admin-guide.adoc
installation: update chapter based on PVE docs & new GRUB entries
[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
509eaa92 11:toc2:
410dc2c9
DM
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
85115a79
DC
34include::pmg-statistic.adoc[]
35
00a7fa74
DM
36include::pmgbackup.adoc[]
37
3ea67bfe 38include::pmgcm.adoc[]
00a7fa74 39
410dc2c9
DM
40// Return to normal title levels.
41:leveloffset: 0
42
90facef4 43
410dc2c9
DM
44Important Service Daemons
45-------------------------
46
410dc2c9 47:leveloffset: 2
fa49ddc5
DM
48
49include::pmgdaemon.adoc[]
50
51include::pmgproxy.adoc[]
410dc2c9 52
43a49777
DM
53include::pmg-smtp-filter.adoc[]
54
17f66284
DM
55include::pmgpolicy.adoc[]
56
b2e39000
DM
57include::pmgtunnel.adoc[]
58
784c81c8
DM
59include::pmgmirror.adoc[]
60
410dc2c9
DM
61:leveloffset: 0
62
63
db96e742 64Useful Command-line Tools
410dc2c9
DM
65-------------------------
66
410dc2c9 67:leveloffset: 2
93f5feff
DM
68include::pmgdb.adoc[]
69
70include::pmgsh.adoc[]
410dc2c9 71
ead20c24
DM
72include::pmgversion.adoc[]
73
b86ab490
DM
74include::pmgsubscription.adoc[]
75
bcd3ebca
DM
76include::pmgperf.adoc[]
77
d7cd791b
DM
78include::pmgqm.adoc[]
79
80include::pmgreport.adoc[]
81
f2016304
DM
82include::pmgupgrade.adoc[]
83
00dbdd05
ML
84include::pmg-log-tracker.adoc[]
85
abca4c1d 86:leveloffset: 1
9d334946 87
abca4c1d 88include::nmap.adoc[]
9d334946 89
abca4c1d 90:leveloffset: 0
9d334946 91
9d334946 92
9d334946 93
1803c6bd
DM
94
95:leveloffset: 1
96
be5f2f9d
TL
97include::pmg-faq.adoc[]
98
1803c6bd
DM
99include::pmg-bibliography.adoc[]
100
410dc2c9
DM
101:leveloffset: 0
102
103[appendix]
db96e742 104Command-line Interface
410dc2c9
DM
105----------------------
106
00a7fa74
DM
107*pmgbackup* - Proxmox Mail Gateway Backup and Restore Utility
108~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
109
110include::pmgbackup.1-synopsis.adoc[]
111
112
3ea67bfe
DM
113*pmgcm* - Proxmox Mail Gateway Cluster Management Toolkit
114~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
115
116include::pmgcm.1-synopsis.adoc[]
117
118
e62ceaf0
DM
119*pmgsh* - API Shell
120~~~~~~~~~~~~~~~~~~~
410dc2c9 121
93f5feff 122include::pmgsh.1-synopsis.adoc[]
bcd3ebca
DM
123
124
125*pmgperf* - Proxmox Simple Performance Benchmark
126~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
127
128include::pmgperf.1-synopsis.adoc[]
93f5feff 129
410dc2c9 130
e62ceaf0
DM
131*pmgconfig* - Configuration Management Toolkit
132~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
133
e62ceaf0 134include::pmgconfig.1-synopsis.adoc[]
410dc2c9 135
410dc2c9 136
f07c4baf
DM
137*pmgdb* - Database Management Toolkit
138~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
139
f07c4baf
DM
140include::pmgdb.1-synopsis.adoc[]
141
410dc2c9
DM
142
143[appendix]
144Service Daemons
145---------------
146
fa49ddc5
DM
147*pmgdaemon* - {pmg} API Daemon
148~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
149
fa49ddc5
DM
150include::pmgdaemon.8-synopsis.adoc[]
151
43a49777 152
fa49ddc5
DM
153*pmgproxy* - {pmg} API Proxy Daemon
154~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
155
fa49ddc5
DM
156include::pmgproxy.8-synopsis.adoc[]
157
43a49777
DM
158
159*pmg-smtp-filter* - Proxmox SMTP Filter Daemon
160~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
161
43a49777
DM
162include::pmg-smtp-filter.8-synopsis.adoc[]
163
43a49777 164
17f66284
DM
165*pmgpolicy* - {pmg} Policy Daemon
166~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
410dc2c9 167
17f66284 168include::pmgpolicy.8-synopsis.adoc[]
410dc2c9 169
17f66284 170
b2e39000
DM
171*pmgtunnel* - Cluster Tunnel Daemon
172~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
173
174include::pmgtunnel.8-synopsis.adoc[]
175
176
784c81c8
DM
177*pmgmirror* - Database Mirror Daemon
178~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
179
180include::pmgmirror.8-synopsis.adoc[]
181
182
6dea08b0
DM
183[appendix]
184include::pmg-rule-macros.adoc[]
410dc2c9
DM
185
186[appendix]
187Configuration Files
188-------------------
189
410dc2c9 190:leveloffset: 2
f872534d
DM
191
192include::pmg.conf.adoc[]
410dc2c9 193
0802e594
DM
194include::cluster.conf.adoc[]
195
72af0c84
DM
196include::user.conf.adoc[]
197
51ac9592
DM
198include::ldap.conf.adoc[]
199
410dc2c9
DM
200:leveloffset: 0
201
202:leveloffset: 1
203
204[appendix]
205include::GFDL.adoc[]
206
207:leveloffset: 0
208
209endif::manvolnum[]
210endif::wiki[]