From 4d8259aca919bd66405e0a50d090d8e82d8b6044 Mon Sep 17 00:00:00 2001 From: Fernandez Ludovic Date: Mon, 18 Nov 2024 14:01:11 +0100 Subject: [PATCH] chore: generate --- README.md | 2 +- cmd/zz_gen_cmd_dnshelp.go | 21 ++++++++++ docs/content/dns/zz_gen_rainyun.md | 67 ++++++++++++++++++++++++++++++ docs/data/zz_cli_help.toml | 2 +- 4 files changed, 90 insertions(+), 2 deletions(-) create mode 100644 docs/content/dns/zz_gen_rainyun.md diff --git a/README.md b/README.md index 5bfdafccc9..0e4cf617c4 100644 --- a/README.md +++ b/README.md @@ -182,7 +182,7 @@ Detailed documentation is available [here](https://go-acme.github.io/lego/dns). PowerDNS Rackspace - RainCloud + Rain Yun/雨云 RcodeZero reg.ru Regfish diff --git a/cmd/zz_gen_cmd_dnshelp.go b/cmd/zz_gen_cmd_dnshelp.go index 52eb0f11f7..1a9d0fa557 100644 --- a/cmd/zz_gen_cmd_dnshelp.go +++ b/cmd/zz_gen_cmd_dnshelp.go @@ -115,6 +115,7 @@ func allDNSCodes() string { "plesk", "porkbun", "rackspace", + "rainyun", "rcodezero", "regfish", "regru", @@ -2357,6 +2358,26 @@ func displayDNSHelp(w io.Writer, name string) error { ew.writeln() ew.writeln(`More information: https://go-acme.github.io/lego/dns/rackspace`) + case "rainyun": + // generated from: providers/dns/rainyun/rainyun.toml + ew.writeln(`Configuration for Rain Yun/雨云.`) + ew.writeln(`Code: 'rainyun'`) + ew.writeln(`Since: 'v4.21.0'`) + ew.writeln() + + ew.writeln(`Credentials:`) + ew.writeln(` - "RAINYUN_API_KEY": API key`) + ew.writeln() + + ew.writeln(`Additional Configuration:`) + ew.writeln(` - "RAINYUN_HTTP_TIMEOUT": API request timeout`) + ew.writeln(` - "RAINYUN_POLLING_INTERVAL": Time between DNS propagation check`) + ew.writeln(` - "RAINYUN_PROPAGATION_TIMEOUT": Maximum waiting time for DNS propagation`) + ew.writeln(` - "RAINYUN_TTL": The TTL of the TXT record used for the DNS challenge`) + + ew.writeln() + ew.writeln(`More information: https://go-acme.github.io/lego/dns/rainyun`) + case "rcodezero": // generated from: providers/dns/rcodezero/rcodezero.toml ew.writeln(`Configuration for RcodeZero.`) diff --git a/docs/content/dns/zz_gen_rainyun.md b/docs/content/dns/zz_gen_rainyun.md new file mode 100644 index 0000000000..c0ff646b85 --- /dev/null +++ b/docs/content/dns/zz_gen_rainyun.md @@ -0,0 +1,67 @@ +--- +title: "Rain Yun/雨云" +date: 2019-03-03T16:39:46+01:00 +draft: false +slug: rainyun +dnsprovider: + since: "v4.21.0" + code: "rainyun" + url: "https://www.rainyun.com" +--- + + + + + + +Configuration for [Rain Yun/雨云](https://www.rainyun.com). + + + + +- Code: `rainyun` +- Since: v4.21.0 + + +Here is an example bash command using the Rain Yun/雨云 provider: + +```bash +RAINYUN_API_KEY="xxxxxxxxxxxxxxxxxxxxx" \ +lego --email you@example.com --dns rainyun -d '*.example.com' -d example.com run +``` + + + + +## Credentials + +| Environment Variable Name | Description | +|-----------------------|-------------| +| `RAINYUN_API_KEY` | API key | + +The environment variable names can be suffixed by `_FILE` to reference a file instead of a value. +More information [here]({{% ref "dns#configuration-and-credentials" %}}). + + +## Additional Configuration + +| Environment Variable Name | Description | +|--------------------------------|-------------| +| `RAINYUN_HTTP_TIMEOUT` | API request timeout | +| `RAINYUN_POLLING_INTERVAL` | Time between DNS propagation check | +| `RAINYUN_PROPAGATION_TIMEOUT` | Maximum waiting time for DNS propagation | +| `RAINYUN_TTL` | The TTL of the TXT record used for the DNS challenge | + +The environment variable names can be suffixed by `_FILE` to reference a file instead of a value. +More information [here]({{% ref "dns#configuration-and-credentials" %}}). + + + + +## More information + +- [API documentation](https://www.apifox.cn/apidoc/shared-a4595cc8-44c5-4678-a2a3-eed7738dab03/api-151416609) + + + + diff --git a/docs/data/zz_cli_help.toml b/docs/data/zz_cli_help.toml index ad95fe40df..dd086b795d 100644 --- a/docs/data/zz_cli_help.toml +++ b/docs/data/zz_cli_help.toml @@ -142,7 +142,7 @@ To display the documentation for a specific DNS provider, run: $ lego dnshelp -c code Supported DNS providers: - acme-dns, alidns, allinkl, arvancloud, auroradns, autodns, azure, azuredns, bindman, bluecat, brandit, bunny, checkdomain, civo, clouddns, cloudflare, cloudns, cloudru, cloudxns, conoha, constellix, corenetworks, cpanel, derak, desec, designate, digitalocean, directadmin, dnshomede, dnsimple, dnsmadeeasy, dnspod, dode, domeneshop, dreamhost, duckdns, dyn, dynu, easydns, edgedns, efficientip, epik, exec, exoscale, freemyip, gandi, gandiv5, gcloud, gcore, glesys, godaddy, googledomains, hetzner, hostingde, hosttech, httpnet, httpreq, huaweicloud, hurricane, hyperone, ibmcloud, iij, iijdpf, infoblox, infomaniak, internetbs, inwx, ionos, ipv64, iwantmyname, joker, liara, lightsail, limacity, linode, liquidweb, loopia, luadns, mailinabox, manual, metaname, mijnhost, mittwald, mydnsjp, mythicbeasts, namecheap, namedotcom, namesilo, nearlyfreespeech, netcup, netlify, nicmanager, nifcloud, njalla, nodion, ns1, oraclecloud, otc, ovh, pdns, plesk, porkbun, rackspace, rcodezero, regfish, regru, rfc2136, rimuhosting, route53, safedns, sakuracloud, scaleway, selectel, selectelv2, selfhostde, servercow, shellrent, simply, sonic, stackpath, technitium, tencentcloud, timewebcloud, transip, ultradns, variomedia, vegadns, vercel, versio, vinyldns, vkcloud, volcengine, vscale, vultr, webnames, websupport, wedos, yandex, yandex360, yandexcloud, zoneee, zonomi + acme-dns, alidns, allinkl, arvancloud, auroradns, autodns, azure, azuredns, bindman, bluecat, brandit, bunny, checkdomain, civo, clouddns, cloudflare, cloudns, cloudru, cloudxns, conoha, constellix, corenetworks, cpanel, derak, desec, designate, digitalocean, directadmin, dnshomede, dnsimple, dnsmadeeasy, dnspod, dode, domeneshop, dreamhost, duckdns, dyn, dynu, easydns, edgedns, efficientip, epik, exec, exoscale, freemyip, gandi, gandiv5, gcloud, gcore, glesys, godaddy, googledomains, hetzner, hostingde, hosttech, httpnet, httpreq, huaweicloud, hurricane, hyperone, ibmcloud, iij, iijdpf, infoblox, infomaniak, internetbs, inwx, ionos, ipv64, iwantmyname, joker, liara, lightsail, limacity, linode, liquidweb, loopia, luadns, mailinabox, manual, metaname, mijnhost, mittwald, mydnsjp, mythicbeasts, namecheap, namedotcom, namesilo, nearlyfreespeech, netcup, netlify, nicmanager, nifcloud, njalla, nodion, ns1, oraclecloud, otc, ovh, pdns, plesk, porkbun, rackspace, rainyun, rcodezero, regfish, regru, rfc2136, rimuhosting, route53, safedns, sakuracloud, scaleway, selectel, selectelv2, selfhostde, servercow, shellrent, simply, sonic, stackpath, technitium, tencentcloud, timewebcloud, transip, ultradns, variomedia, vegadns, vercel, versio, vinyldns, vkcloud, volcengine, vscale, vultr, webnames, websupport, wedos, yandex, yandex360, yandexcloud, zoneee, zonomi More information: https://go-acme.github.io/lego/dns """