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