From: Thomas Lamprecht Date: Fri, 24 Mar 2023 09:28:58 +0000 (+0100) Subject: update static schema info X-Git-Url: https://git.proxmox.com/?p=pmg-docs.git;a=commitdiff_plain;h=8c3080657b1aefe2b19802df598d1ffef92c5a3f update static schema info Signed-off-by: Thomas Lamprecht --- diff --git a/api-viewer/apidata.js b/api-viewer/apidata.js index a1662b0..242601c 100644 --- a/api-viewer/apidata.js +++ b/api-viewer/apidata.js @@ -7903,6 +7903,106 @@ var apiSchema = [ "path" : "/config/tlspolicy", "text" : "tlspolicy" }, + { + "children" : [ + { + "info" : { + "DELETE" : { + "allowtoken" : 1, + "description" : "Delete a tls_inbound_domains entry", + "method" : "DELETE", + "name" : "delete", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "domain" : { + "description" : "Domain which should be removed from tls_inbound_domains", + "format" : "transport-domain", + "type" : "string", + "typetext" : "" + } + } + }, + "permissions" : { + "check" : [ + "admin" + ] + }, + "protected" : 1, + "proxyto" : "master", + "returns" : { + "type" : "null" + } + } + }, + "leaf" : 1, + "path" : "/config/tls-inbound-domains/{domain}", + "text" : "{domain}" + } + ], + "info" : { + "GET" : { + "allowtoken" : 1, + "description" : "List tls_inbound_domains entries.", + "method" : "GET", + "name" : "index", + "parameters" : { + "additionalProperties" : 0 + }, + "permissions" : { + "check" : [ + "admin", + "audit" + ] + }, + "proxyto" : "master", + "returns" : { + "description" : "List of domains for which TLS will be enforced on incoming connections", + "items" : { + "format" : "transport-domain", + "type" : "string" + }, + "links" : [ + { + "href" : "{domain}", + "rel" : "child" + } + ], + "type" : "array" + } + }, + "POST" : { + "allowtoken" : 1, + "description" : "Add new tls_inbound_domains entry.", + "method" : "POST", + "name" : "create", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "domain" : { + "description" : "Domain for which TLS should be enforced on incoming connections", + "format" : "transport-domain", + "type" : "string", + "typetext" : "" + } + } + }, + "permissions" : { + "check" : [ + "admin" + ] + }, + "protected" : 1, + "proxyto" : "master", + "returns" : { + "type" : "null" + } + } + }, + "leaf" : 0, + "path" : "/config/tls-inbound-domains", + "text" : "tls-inbound-domains" + }, { "children" : [ { @@ -9086,20 +9186,24 @@ var apiSchema = [ "aws", "azion", "azure", + "bunny", "cf", "clouddns", "cloudns", "cn", "conoha", "constellix", - "cx", + "cpanel", + "curanet", "cyon", "da", "ddnss", "desec", "df", "dgon", + "dnshome", "dnsimple", + "dnsservices", "do", "doapi", "domeneshop", @@ -9115,11 +9219,12 @@ var apiSchema = [ "edgedns", "euserv", "exoscale", + "fornex", "freedns", "gandi_livedns", "gcloud", "gd", - "gdnsdk", + "geoscaling", "he", "hetzner", "hexonet", @@ -9137,6 +9242,7 @@ var apiSchema = [ "kas", "kinghost", "knot", + "la", "leaseweb", "lexicon", "linode", @@ -9150,6 +9256,7 @@ var apiSchema = [ "myapi", "mydevil", "mydnsjp", + "mythic_beasts", "namecheap", "namecom", "namesilo", @@ -9177,24 +9284,29 @@ var apiSchema = [ "porkbun", "rackcorp", "rackspace", + "rage4", "rcode0", "regru", "scaleway", "schlundtech", "selectel", + "selfhost", "servercow", "simply", "tele3", "transip", + "udr", "ultra", "unoeuro", "variomedia", "veesp", + "vercel", "vscale", "vultr", "websupport", "world4you", "yandex", + "yc", "zilore", "zone", "zonomi" @@ -9340,20 +9452,24 @@ var apiSchema = [ "aws", "azion", "azure", + "bunny", "cf", "clouddns", "cloudns", "cn", "conoha", "constellix", - "cx", + "cpanel", + "curanet", "cyon", "da", "ddnss", "desec", "df", "dgon", + "dnshome", "dnsimple", + "dnsservices", "do", "doapi", "domeneshop", @@ -9369,11 +9485,12 @@ var apiSchema = [ "edgedns", "euserv", "exoscale", + "fornex", "freedns", "gandi_livedns", "gcloud", "gd", - "gdnsdk", + "geoscaling", "he", "hetzner", "hexonet", @@ -9391,6 +9508,7 @@ var apiSchema = [ "kas", "kinghost", "knot", + "la", "leaseweb", "lexicon", "linode", @@ -9404,6 +9522,7 @@ var apiSchema = [ "myapi", "mydevil", "mydnsjp", + "mythic_beasts", "namecheap", "namecom", "namesilo", @@ -9431,24 +9550,29 @@ var apiSchema = [ "porkbun", "rackcorp", "rackspace", + "rage4", "rcode0", "regru", "scaleway", "schlundtech", "selectel", + "selfhost", "servercow", "simply", "tele3", "transip", + "udr", "ultra", "unoeuro", "variomedia", "veesp", + "vercel", "vscale", "vultr", "websupport", "world4you", "yandex", + "yc", "zilore", "zone", "zonomi" @@ -9935,10 +10059,10 @@ var apiSchema = [ "delete" : { "description" : "A list of settings you want to delete.", "enum" : [ + "rp", "id", "origin", - "allow-subdomains", - "rp" + "allow-subdomains" ], "optional" : 1, "type" : "string" @@ -10589,6 +10713,13 @@ var apiSchema = [ "type" : "integer", "typetext" : " (1 - 65535)" }, + "smtputf8" : { + "default" : 1, + "description" : "Enable SMTPUTF8 support in Postfix and detection for locally generated mail", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, "spf" : { "default" : 1, "description" : "Use Sender Policy Framework.", @@ -10707,6 +10838,13 @@ var apiSchema = [ "type" : "string", "typetext" : "" }, + "extract_text" : { + "default" : 0, + "description" : "Extract text from attachments (doc, pdf, rtf, images) and scan for spam.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, "languages" : { "default" : "all", "description" : "This option is used to specify which languages are considered OK for incoming mail.", @@ -17644,9 +17782,9 @@ var apiSchema = [ "default" : "spam", "description" : "Query this type of quarantine for users.", "enum" : [ - "attachment", "virus", - "spam" + "spam", + "attachment" ], "optional" : 1, "type" : "string" diff --git a/pmg.conf.5-opts.adoc b/pmg.conf.5-opts.adoc index e55a8b3..f254e8b 100644 --- a/pmg.conf.5-opts.adoc +++ b/pmg.conf.5-opts.adoc @@ -212,6 +212,10 @@ When set, all outgoing mails are deliverd to the specified smarthost. SMTP port number for smarthost. +`smtputf8`: `` ('default =' `1`):: + +Enable SMTPUTF8 support in Postfix and detection for locally generated mail + `spf`: `` ('default =' `1`):: Use Sender Policy Framework. @@ -242,6 +246,10 @@ Additional score for bounce mails. Score for ClamAV heuristics (Encrypted Archives/Documents, PhishingScanURLs, ...). +`extract_text`: `` ('default =' `0`):: + +Extract text from attachments (doc, pdf, rtf, images) and scan for spam. + `languages`: `(all|([a-z][a-z])+( ([a-z][a-z])+)*)` ('default =' `all`):: This option is used to specify which languages are considered OK for incoming mail. diff --git a/pmg.mail-options-conf-opts.adoc b/pmg.mail-options-conf-opts.adoc index 9e08597..4baba7a 100644 --- a/pmg.mail-options-conf-opts.adoc +++ b/pmg.mail-options-conf-opts.adoc @@ -70,6 +70,10 @@ Reject unknown clients. Reject unknown senders. +`smtputf8`: `` ('default =' `1`):: + +Enable SMTPUTF8 support in Postfix and detection for locally generated mail + `spf`: `` ('default =' `1`):: Use Sender Policy Framework. diff --git a/pmg.spam-conf-opts.adoc b/pmg.spam-conf-opts.adoc index 349da1a..70d32e2 100644 --- a/pmg.spam-conf-opts.adoc +++ b/pmg.spam-conf-opts.adoc @@ -6,6 +6,10 @@ Additional score for bounce mails. Score for ClamAV heuristics (Encrypted Archives/Documents, PhishingScanURLs, ...). +`extract_text`: `` ('default =' `0`):: + +Extract text from attachments (doc, pdf, rtf, images) and scan for spam. + `languages`: `(all|([a-z][a-z])+( ([a-z][a-z])+)*)` ('default =' `all`):: This option is used to specify which languages are considered OK for incoming mail. diff --git a/pmgconfig.1-synopsis.adoc b/pmgconfig.1-synopsis.adoc index 168cb80..cbd0604 100644 --- a/pmgconfig.1-synopsis.adoc +++ b/pmgconfig.1-synopsis.adoc @@ -97,7 +97,7 @@ ACME challenge type. ACME Plugin ID name -`--api` `<1984hosting | acmedns | acmeproxy | active24 | ad | ali | anx | arvan | aurora | autodns | aws | azion | 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 | oci | one | online | openprovider | openstack | opnsense | ovh | pdns | pleskxml | pointhq | porkbun | rackcorp | rackspace | rcode0 | regru | scaleway | schlundtech | selectel | servercow | simply | tele3 | transip | ultra | unoeuro | variomedia | veesp | vscale | vultr | websupport | world4you | yandex | zilore | zone | zonomi>` :: +`--api` `<1984hosting | acmedns | acmeproxy | active24 | ad | ali | anx | arvan | aurora | autodns | aws | azion | azure | bunny | cf | clouddns | cloudns | cn | conoha | constellix | cpanel | curanet | cyon | da | ddnss | desec | df | dgon | dnshome | dnsimple | dnsservices | do | doapi | domeneshop | dp | dpi | dreamhost | duckdns | durabledns | dyn | dynu | dynv6 | easydns | edgedns | euserv | exoscale | fornex | freedns | gandi_livedns | gcloud | gd | geoscaling | he | hetzner | hexonet | hostingde | huaweicloud | infoblox | infomaniak | internetbs | inwx | ionos | ispconfig | jd | joker | kappernet | kas | kinghost | knot | la | leaseweb | lexicon | linode | linode_v4 | loopia | lua | maradns | me | miab | misaka | myapi | mydevil | mydnsjp | mythic_beasts | namecheap | namecom | namesilo | nederhost | neodigit | netcup | netlify | nic | njalla | nm | nsd | nsone | nsupdate | nw | oci | one | online | openprovider | openstack | opnsense | ovh | pdns | pleskxml | pointhq | porkbun | rackcorp | rackspace | rage4 | rcode0 | regru | scaleway | schlundtech | selectel | selfhost | servercow | simply | tele3 | transip | udr | ultra | unoeuro | variomedia | veesp | vercel | vscale | vultr | websupport | world4you | yandex | yc | zilore | zone | zonomi>` :: API plugin name @@ -149,7 +149,7 @@ Update ACME plugin configuration. ACME Plugin ID name -`--api` `<1984hosting | acmedns | acmeproxy | active24 | ad | ali | anx | arvan | aurora | autodns | aws | azion | 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 | oci | one | online | openprovider | openstack | opnsense | ovh | pdns | pleskxml | pointhq | porkbun | rackcorp | rackspace | rcode0 | regru | scaleway | schlundtech | selectel | servercow | simply | tele3 | transip | ultra | unoeuro | variomedia | veesp | vscale | vultr | websupport | world4you | yandex | zilore | zone | zonomi>` :: +`--api` `<1984hosting | acmedns | acmeproxy | active24 | ad | ali | anx | arvan | aurora | autodns | aws | azion | azure | bunny | cf | clouddns | cloudns | cn | conoha | constellix | cpanel | curanet | cyon | da | ddnss | desec | df | dgon | dnshome | dnsimple | dnsservices | do | doapi | domeneshop | dp | dpi | dreamhost | duckdns | durabledns | dyn | dynu | dynv6 | easydns | edgedns | euserv | exoscale | fornex | freedns | gandi_livedns | gcloud | gd | geoscaling | he | hetzner | hexonet | hostingde | huaweicloud | infoblox | infomaniak | internetbs | inwx | ionos | ispconfig | jd | joker | kappernet | kas | kinghost | knot | la | leaseweb | lexicon | linode | linode_v4 | loopia | lua | maradns | me | miab | misaka | myapi | mydevil | mydnsjp | mythic_beasts | namecheap | namecom | namesilo | nederhost | neodigit | netcup | netlify | nic | njalla | nm | nsd | nsone | nsupdate | nw | oci | one | online | openprovider | openstack | opnsense | ovh | pdns | pleskxml | pointhq | porkbun | rackcorp | rackspace | rage4 | rcode0 | regru | scaleway | schlundtech | selectel | selfhost | servercow | simply | tele3 | transip | udr | ultra | unoeuro | variomedia | veesp | vercel | vscale | vultr | websupport | world4you | yandex | yc | zilore | zone | zonomi>` :: API plugin name