]> git.proxmox.com Git - pmg-docs.git/blob - pmg-admin-guide.adoc
pmg-administration.adoc: add administration section
[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::pmg-administration.adoc[]
33
34 include::pmgbackup.adoc[]
35
36 include::pmgcm.adoc[]
37
38 // Return to normal title levels.
39 :leveloffset: 0
40
41
42 Important Service Daemons
43 -------------------------
44
45 :leveloffset: 2
46
47 include::pmgdaemon.adoc[]
48
49 include::pmgproxy.adoc[]
50
51 include::pmg-smtp-filter.adoc[]
52
53 include::pmgpolicy.adoc[]
54
55 include::pmgtunnel.adoc[]
56
57 include::pmgmirror.adoc[]
58
59 :leveloffset: 0
60
61
62 Useful Command Line Tools
63 -------------------------
64
65 :leveloffset: 2
66 include::pmgdb.adoc[]
67
68 include::pmgsh.adoc[]
69
70 include::pmgversion.adoc[]
71
72 include::pmgsubscription.adoc[]
73
74 include::pmgperf.adoc[]
75
76 include::pmgqm.adoc[]
77
78 include::pmgreport.adoc[]
79
80 include::pmgupgrade.adoc[]
81
82 :leveloffset: 1
83
84 include::nmap.adoc[]
85
86 :leveloffset: 0
87
88
89
90
91 :leveloffset: 1
92
93 include::pmg-bibliography.adoc[]
94
95 :leveloffset: 0
96
97 [appendix]
98 include::pmg-ssl-certificate.adoc[]
99
100
101 [appendix]
102 Command Line Interface
103 ----------------------
104
105 *pmgbackup* - Proxmox Mail Gateway Backup and Restore Utility
106 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
107
108 include::pmgbackup.1-synopsis.adoc[]
109
110
111 *pmgcm* - Proxmox Mail Gateway Cluster Management Toolkit
112 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
113
114 include::pmgcm.1-synopsis.adoc[]
115
116
117 *pmgsh* - API Shell
118 ~~~~~~~~~~~~~~~~~~~
119
120 include::pmgsh.1-synopsis.adoc[]
121
122
123 *pmgperf* - Proxmox Simple Performance Benchmark
124 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
125
126 include::pmgperf.1-synopsis.adoc[]
127
128
129 *pmgconfig* - Configuration Management Toolkit
130 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
131
132 include::pmgconfig.1-synopsis.adoc[]
133
134
135 *pmgdb* - Database Management Toolkit
136 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
137
138 include::pmgdb.1-synopsis.adoc[]
139
140
141 [appendix]
142 Service Daemons
143 ---------------
144
145 *pmgdaemon* - {pmg} API Daemon
146 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
147
148 include::pmgdaemon.8-synopsis.adoc[]
149
150
151 *pmgproxy* - {pmg} API Proxy Daemon
152 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
153
154 include::pmgproxy.8-synopsis.adoc[]
155
156
157 *pmg-smtp-filter* - Proxmox SMTP Filter Daemon
158 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
159
160 include::pmg-smtp-filter.8-synopsis.adoc[]
161
162
163 *pmgpolicy* - {pmg} Policy Daemon
164 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
165
166 include::pmgpolicy.8-synopsis.adoc[]
167
168
169 *pmgtunnel* - Cluster Tunnel Daemon
170 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
171
172 include::pmgtunnel.8-synopsis.adoc[]
173
174
175 *pmgmirror* - Database Mirror Daemon
176 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
177
178 include::pmgmirror.8-synopsis.adoc[]
179
180
181 [appendix]
182 include::pmg-rule-macros.adoc[]
183
184 [appendix]
185 Configuration Files
186 -------------------
187
188 :leveloffset: 2
189
190 include::pmg.conf.adoc[]
191
192 include::cluster.conf.adoc[]
193
194 include::user.conf.adoc[]
195
196 include::ldap.conf.adoc[]
197
198 :leveloffset: 0
199
200 :leveloffset: 1
201
202 [appendix]
203 include::GFDL.adoc[]
204
205 :leveloffset: 0
206
207 endif::manvolnum[]
208 endif::wiki[]