]>
Commit | Line | Data |
---|---|---|
e62ceaf0 DM |
1 | *pmgconfig* `<COMMAND> [ARGS] [OPTIONS]` |
2 | ||
c5ccf1ab TL |
3 | *pmgconfig acme account deactivate* `[<name>]` `[OPTIONS]` |
4 | ||
5 | Deactivate existing ACME account at CA. | |
6 | ||
7 | `<name>`: `<name>` ('default =' `default`):: | |
8 | ||
9 | ACME account config file name. | |
10 | ||
11 | `--force` `<boolean>` ('default =' `0`):: | |
12 | ||
13 | Delete account data even if the server refuses to deactivate the account. | |
14 | ||
15 | *pmgconfig acme account info* `[<name>]` `[FORMAT_OPTIONS]` | |
16 | ||
17 | Return existing ACME account information. | |
18 | ||
19 | `<name>`: `<name>` ('default =' `default`):: | |
20 | ||
21 | ACME account config file name. | |
22 | ||
23 | *pmgconfig acme account list* | |
24 | ||
25 | ACME account index. | |
26 | ||
27 | *pmgconfig acme account register* `[<name>] {<contact>}` `[OPTIONS]` | |
28 | ||
29 | Register a new ACME account with a compatible CA. | |
30 | ||
31 | `<name>`: `<name>` ('default =' `default`):: | |
32 | ||
33 | ACME account config file name. | |
34 | ||
35 | `<contact>`: `<string>` :: | |
36 | ||
37 | Contact email addresses. | |
38 | ||
39 | `--directory` `^https?://.*` :: | |
40 | ||
41 | URL of ACME CA directory endpoint. | |
42 | ||
43 | *pmgconfig acme account update* `[<name>]` `[OPTIONS]` | |
44 | ||
45 | Update existing ACME account information with CA. Note: not specifying any | |
46 | new account information triggers a refresh. | |
47 | ||
48 | `<name>`: `<name>` ('default =' `default`):: | |
49 | ||
50 | ACME account config file name. | |
51 | ||
52 | `--contact` `<string>` :: | |
53 | ||
54 | Contact email addresses. | |
55 | ||
56 | *pmgconfig acme cert order* `<type>` `[OPTIONS]` | |
57 | ||
58 | Order a new certificate from ACME-compatible CA. | |
59 | ||
60 | `<type>`: `<api | smtp>` :: | |
61 | ||
62 | The TLS certificate type (API or SMTP certificate). | |
63 | ||
64 | `--force` `<boolean>` ('default =' `0`):: | |
65 | ||
66 | Overwrite existing custom certificate. | |
67 | ||
68 | *pmgconfig acme cert renew* `<type>` `[OPTIONS]` | |
69 | ||
70 | Renew existing certificate from CA. | |
71 | ||
72 | `<type>`: `<api | smtp>` :: | |
73 | ||
74 | The TLS certificate type (API or SMTP certificate). | |
75 | ||
76 | `--force` `<boolean>` ('default =' `0`):: | |
77 | ||
78 | Force renewal even if expiry is more than 30 days away. | |
79 | ||
80 | *pmgconfig acme cert revoke* `<type>` | |
81 | ||
82 | Revoke existing certificate from CA. | |
83 | ||
84 | `<type>`: `<api | smtp>` :: | |
85 | ||
86 | The TLS certificate type (API or SMTP certificate). | |
87 | ||
88 | *pmgconfig acme plugin add* `<type> <id>` `[OPTIONS]` | |
89 | ||
90 | Add ACME plugin configuration. | |
91 | ||
92 | `<type>`: `<dns | standalone>` :: | |
93 | ||
94 | ACME challenge type. | |
95 | ||
96 | `<id>`: `<string>` :: | |
97 | ||
98 | ACME Plugin ID name | |
99 | ||
100 | `--api` `<1984hosting | acmedns | acmeproxy | active24 | ad | ali | anx | arvan | autodns | aws | azure | cf | clouddns | cloudns | cn | conoha | constellix | cx | cyon | da | ddnss | desec | df | dgon | dnsimple | do | doapi | domeneshop | dp | dpi | dreamhost | duckdns | durabledns | dyn | dynu | dynv6 | easydns | edgedns | euserv | exoscale | freedns | gandi_livedns | gcloud | gd | gdnsdk | he | hetzner | hexonet | hostingde | huaweicloud | infoblox | infomaniak | internetbs | inwx | ionos | ispconfig | jd | joker | kappernet | kas | kinghost | knot | leaseweb | lexicon | linode | linode_v4 | loopia | lua | maradns | me | miab | misaka | myapi | mydevil | mydnsjp | namecheap | namecom | namesilo | nederhost | neodigit | netcup | netlify | nic | njalla | nm | nsd | nsone | nsupdate | nw | one | online | openprovider | openstack | opnsense | ovh | pdns | pleskxml | pointhq | rackcorp | rackspace | rcode0 | regru | scaleway | schlundtech | selectel | servercow | simply | tele3 | transip | ultra | unoeuro | variomedia | vscale | vultr | world4you | yandex | zilore | zone | zonomi>` :: | |
101 | ||
102 | API plugin name | |
103 | ||
104 | `--data` `File with one key-value pair per line, will be base64url encode for storage in plugin config.` :: | |
105 | ||
106 | DNS plugin data. (base64 encoded) | |
107 | ||
108 | `--disable` `<boolean>` :: | |
109 | ||
110 | Flag to disable the config. | |
111 | ||
112 | `--nodes` `<string>` :: | |
113 | ||
114 | List of cluster node names. | |
115 | ||
116 | `--validation-delay` `<integer> (0 - 172800)` ('default =' `30`):: | |
117 | ||
118 | Extra delay in seconds to wait before requesting validation. Allows to cope with a long TTL of DNS records. | |
119 | ||
120 | *pmgconfig acme plugin config* `<id>` `[FORMAT_OPTIONS]` | |
121 | ||
122 | Get ACME plugin configuration. | |
123 | ||
124 | `<id>`: `<string>` :: | |
125 | ||
126 | Unique identifier for ACME plugin instance. | |
127 | ||
128 | *pmgconfig acme plugin list* `[OPTIONS]` `[FORMAT_OPTIONS]` | |
129 | ||
130 | ACME plugin index. | |
131 | ||
132 | `--type` `<dns | standalone>` :: | |
133 | ||
134 | Only list ACME plugins of a specific type | |
135 | ||
136 | *pmgconfig acme plugin remove* `<id>` | |
137 | ||
138 | Delete ACME plugin configuration. | |
139 | ||
140 | `<id>`: `<string>` :: | |
141 | ||
142 | Unique identifier for ACME plugin instance. | |
143 | ||
144 | *pmgconfig acme plugin set* `<id>` `[OPTIONS]` | |
145 | ||
146 | Update ACME plugin configuration. | |
147 | ||
148 | `<id>`: `<string>` :: | |
149 | ||
150 | ACME Plugin ID name | |
151 | ||
152 | `--api` `<1984hosting | acmedns | acmeproxy | active24 | ad | ali | anx | arvan | autodns | aws | azure | cf | clouddns | cloudns | cn | conoha | constellix | cx | cyon | da | ddnss | desec | df | dgon | dnsimple | do | doapi | domeneshop | dp | dpi | dreamhost | duckdns | durabledns | dyn | dynu | dynv6 | easydns | edgedns | euserv | exoscale | freedns | gandi_livedns | gcloud | gd | gdnsdk | he | hetzner | hexonet | hostingde | huaweicloud | infoblox | infomaniak | internetbs | inwx | ionos | ispconfig | jd | joker | kappernet | kas | kinghost | knot | leaseweb | lexicon | linode | linode_v4 | loopia | lua | maradns | me | miab | misaka | myapi | mydevil | mydnsjp | namecheap | namecom | namesilo | nederhost | neodigit | netcup | netlify | nic | njalla | nm | nsd | nsone | nsupdate | nw | one | online | openprovider | openstack | opnsense | ovh | pdns | pleskxml | pointhq | rackcorp | rackspace | rcode0 | regru | scaleway | schlundtech | selectel | servercow | simply | tele3 | transip | ultra | unoeuro | variomedia | vscale | vultr | world4you | yandex | zilore | zone | zonomi>` :: | |
153 | ||
154 | API plugin name | |
155 | ||
156 | `--data` `File with one key-value pair per line, will be base64url encode for storage in plugin config.` :: | |
157 | ||
158 | DNS plugin data. (base64 encoded) | |
159 | ||
160 | `--delete` `<string>` :: | |
161 | ||
162 | A list of settings you want to delete. | |
163 | ||
164 | `--digest` `<string>` :: | |
165 | ||
166 | Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. | |
167 | ||
168 | `--disable` `<boolean>` :: | |
169 | ||
170 | Flag to disable the config. | |
171 | ||
172 | `--nodes` `<string>` :: | |
173 | ||
174 | List of cluster node names. | |
175 | ||
176 | `--validation-delay` `<integer> (0 - 172800)` ('default =' `30`):: | |
177 | ||
178 | Extra delay in seconds to wait before requesting validation. Allows to cope with a long TTL of DNS records. | |
179 | ||
e62ceaf0 DM |
180 | *pmgconfig apicert* `[OPTIONS]` |
181 | ||
182 | Generate /etc/pmg/pmg-api.pem (self signed certificate for GUI and REST | |
183 | API). | |
184 | ||
9fda36b0 | 185 | `--force` `<boolean>` ('default =' `0`):: |
e62ceaf0 DM |
186 | |
187 | Overwrite existing certificate. | |
188 | ||
c5ccf1ab TL |
189 | *pmgconfig cert delete* `<type> [<restart>]` |
190 | ||
191 | DELETE custom certificate chain and key. | |
192 | ||
193 | `<type>`: `<api | smtp>` :: | |
194 | ||
195 | The TLS certificate type (API or SMTP certificate). | |
196 | ||
197 | `<restart>`: `<boolean>` ('default =' `0`):: | |
198 | ||
199 | Restart pmgproxy. | |
200 | ||
201 | *pmgconfig cert info* `[FORMAT_OPTIONS]` | |
202 | ||
203 | Get information about the node's certificates. | |
204 | ||
205 | *pmgconfig cert set* `<type> <certificates> <key>` `[OPTIONS]` `[FORMAT_OPTIONS]` | |
206 | ||
207 | Upload or update custom certificate chain and key. | |
208 | ||
209 | `<type>`: `<api | smtp>` :: | |
210 | ||
211 | The TLS certificate type (API or SMTP certificate). | |
212 | ||
213 | `<certificates>`: `<string>` :: | |
214 | ||
215 | PEM encoded certificate (chain). | |
216 | ||
217 | `<key>`: `<string>` :: | |
218 | ||
219 | PEM encoded private key. | |
220 | ||
221 | `--force` `<boolean>` ('default =' `0`):: | |
222 | ||
223 | Overwrite existing custom or ACME certificate files. | |
224 | ||
225 | `--restart` `<boolean>` ('default =' `0`):: | |
226 | ||
227 | Restart services. | |
228 | ||
d210277a TL |
229 | *pmgconfig dkim_record* |
230 | ||
231 | Get the public key for the configured selector, prepared as DKIM TXT record | |
232 | ||
233 | *pmgconfig dkim_set* `--keysize <integer> --selector <string>` `[OPTIONS]` | |
234 | ||
235 | Generate a new private key for selector. All future mail will be signed | |
236 | with the new key! | |
237 | ||
6bd70b95 TL |
238 | `--force` `<boolean>` :: |
239 | ||
240 | Overwrite existing key | |
241 | ||
d210277a TL |
242 | `--keysize` `<integer> (1024 - N)` :: |
243 | ||
244 | Number of bits for the RSA-Key | |
245 | ||
246 | `--selector` `<string>` :: | |
247 | ||
248 | DKIM Selector | |
249 | ||
e62ceaf0 DM |
250 | *pmgconfig dump* |
251 | ||
252 | Print configuration setting which can be used in templates. | |
253 | ||
b81b1f95 | 254 | *pmgconfig help* `[OPTIONS]` |
e62ceaf0 DM |
255 | |
256 | Get help about specified command. | |
257 | ||
b81b1f95 | 258 | `--extra-args` `<array>` :: |
e62ceaf0 | 259 | |
b81b1f95 | 260 | Shows help for a specific command |
e62ceaf0 | 261 | |
9fda36b0 | 262 | `--verbose` `<boolean>` :: |
e62ceaf0 DM |
263 | |
264 | Verbose output format. | |
265 | ||
eff914dc DM |
266 | *pmgconfig init* |
267 | ||
268 | Generate required files in /etc/pmg/ | |
269 | ||
e62ceaf0 DM |
270 | *pmgconfig ldapsync* |
271 | ||
d8212759 | 272 | Synchronize the LDAP database. |
e62ceaf0 | 273 | |
e62ceaf0 DM |
274 | *pmgconfig sync* `[OPTIONS]` |
275 | ||
d8212759 | 276 | Synchronize Proxmox Mail Gateway configurations with system configuration. |
e62ceaf0 | 277 | |
9fda36b0 | 278 | `--restart` `<boolean>` ('default =' `0`):: |
e62ceaf0 DM |
279 | |
280 | Restart services if necessary. | |
281 | ||
e62ceaf0 DM |
282 | *pmgconfig tlscert* `[OPTIONS]` |
283 | ||
284 | Generate /etc/pmg/pmg-tls.pem (self signed certificate for encrypted SMTP | |
285 | traffic). | |
286 | ||
9fda36b0 | 287 | `--force` `<boolean>` ('default =' `0`):: |
e62ceaf0 DM |
288 | |
289 | Overwrite existing certificate. | |
290 | ||
291 |