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