From 496d00bd28599f53d6ec8aaddc5622e8043d7f02 Mon Sep 17 00:00:00 2001 From: Fernandez Ludovic Date: Mon, 25 Nov 2024 16:52:46 +0100 Subject: [PATCH] chore: generate --- README.md | 21 ++++--- cmd/zz_gen_cmd_dnshelp.go | 24 ++++++++ docs/content/dns/zz_gen_nicru.md | 83 +++++++++++++++++++++++++++ providers/dns/zz_gen_dns_providers.go | 3 + 4 files changed, 123 insertions(+), 8 deletions(-) create mode 100644 docs/content/dns/zz_gen_nicru.md diff --git a/README.md b/README.md index 53e9e529eb..0df16b3c73 100644 --- a/README.md +++ b/README.md @@ -189,48 +189,53 @@ Detailed documentation is available [here](https://go-acme.github.io/lego/dns). RFC2136 RimuHosting + RU CENTER Sakura Cloud - Scaleway + Scaleway Selectel Selectel v2 SelfHost.(de|eu) - Servercow + Servercow Shellrent Simply.com Sonic - Stackpath + Stackpath Technitium Tencent Cloud DNS Timeweb Cloud - TransIP + TransIP UKFast SafeDNS Ultradns Variomedia - VegaDNS + VegaDNS Vercel Versio.[nl|eu|uk] VinylDNS - VK Cloud + VK Cloud Volcano Engine/火山引擎 Vscale Vultr - Webnames + Webnames Websupport WEDOS West.cn/西部数码 - Yandex 360 + Yandex 360 Yandex Cloud Yandex PDD Zone.ee + Zonomi + + + diff --git a/cmd/zz_gen_cmd_dnshelp.go b/cmd/zz_gen_cmd_dnshelp.go index b7f6e6c8c6..2a24abbe17 100644 --- a/cmd/zz_gen_cmd_dnshelp.go +++ b/cmd/zz_gen_cmd_dnshelp.go @@ -104,6 +104,7 @@ func allDNSCodes() string { "netcup", "netlify", "nicmanager", + "nicru", "nifcloud", "njalla", "nodion", @@ -2115,6 +2116,29 @@ func displayDNSHelp(w io.Writer, name string) error { ew.writeln() ew.writeln(`More information: https://go-acme.github.io/lego/dns/nicmanager`) + case "nicru": + // generated from: providers/dns/nicru/nicru.toml + ew.writeln(`Configuration for RU CENTER.`) + ew.writeln(`Code: 'nicru'`) + ew.writeln(`Since: 'v4.21.0'`) + ew.writeln() + + ew.writeln(`Credentials:`) + ew.writeln(` - "NICRU_PASSWORD": Password for account in RU CENTER`) + ew.writeln(` - "NICRU_SECRET": Secret for application in DNS-hosting RU CENTER`) + ew.writeln(` - "NICRU_SERVICE_ID": Service ID for application in DNS-hosting RU CENTER`) + ew.writeln(` - "NICRU_SERVICE_NAME": Service Name for DNS-hosting RU CENTER`) + ew.writeln(` - "NICRU_USER": Agreement for account in RU CENTER`) + ew.writeln() + + ew.writeln(`Additional Configuration:`) + ew.writeln(` - "NICRU_POLLING_INTERVAL": Time between DNS propagation check`) + ew.writeln(` - "NICRU_PROPAGATION_TIMEOUT": Maximum waiting time for DNS propagation`) + ew.writeln(` - "NICRU_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/nicru`) + case "nifcloud": // generated from: providers/dns/nifcloud/nifcloud.toml ew.writeln(`Configuration for NIFCloud.`) diff --git a/docs/content/dns/zz_gen_nicru.md b/docs/content/dns/zz_gen_nicru.md new file mode 100644 index 0000000000..b3e19dac07 --- /dev/null +++ b/docs/content/dns/zz_gen_nicru.md @@ -0,0 +1,83 @@ +--- +title: "RU CENTER" +date: 2019-03-03T16:39:46+01:00 +draft: false +slug: nicru +dnsprovider: + since: "v4.21.0" + code: "nicru" + url: "https://nic.ru/" +--- + + + + + + +Configuration for [RU CENTER](https://nic.ru/). + + + + +- Code: `nicru` +- Since: v4.21.0 + + +Here is an example bash command using the RU CENTER provider: + +```bash +NICRU_USER="" \ +NICRU_PASSWORD="" \ +NICRU_SERVICE_ID="" \ +NICRU_SECRET="" \ +lego --dns nicru --domains "*.example.com" --email you@example.com run +``` + + + + +## Credentials + +| Environment Variable Name | Description | +|-----------------------|-------------| +| `NICRU_PASSWORD` | Password for account in RU CENTER | +| `NICRU_SECRET` | Secret for application in DNS-hosting RU CENTER | +| `NICRU_SERVICE_ID` | Service ID for application in DNS-hosting RU CENTER | +| `NICRU_SERVICE_NAME` | Service Name for DNS-hosting RU CENTER | +| `NICRU_USER` | Agreement for account in RU CENTER | + +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 | +|--------------------------------|-------------| +| `NICRU_POLLING_INTERVAL` | Time between DNS propagation check | +| `NICRU_PROPAGATION_TIMEOUT` | Maximum waiting time for DNS propagation | +| `NICRU_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" %}}). + +## Credential inforamtion + +You can find information about service ID and secret https://www.nic.ru/manager/oauth.cgi?step=oauth.app_list + +| ENV Variable | Parameter from page | Example | +|---------------------|--------------------------------|-------------------| +| NICRU_USER | Username (Number of agreement) | NNNNNNN/NIC-D | +| NICRU_PASSWORD | Password account | | +| NICRU_SERVICE_ID | Application ID | hex-based, len 32 | +| NICRU_SECRET | Identity endpoint | string len 91 | + + + +## More information + +- [API documentation](https://www.nic.ru/help/api-dns-hostinga_3643.html) + + + + diff --git a/providers/dns/zz_gen_dns_providers.go b/providers/dns/zz_gen_dns_providers.go index a60b48b701..aa8fbaa417 100644 --- a/providers/dns/zz_gen_dns_providers.go +++ b/providers/dns/zz_gen_dns_providers.go @@ -98,6 +98,7 @@ import ( "github.com/go-acme/lego/v4/providers/dns/netcup" "github.com/go-acme/lego/v4/providers/dns/netlify" "github.com/go-acme/lego/v4/providers/dns/nicmanager" + "github.com/go-acme/lego/v4/providers/dns/nicru" "github.com/go-acme/lego/v4/providers/dns/nifcloud" "github.com/go-acme/lego/v4/providers/dns/njalla" "github.com/go-acme/lego/v4/providers/dns/nodion" @@ -339,6 +340,8 @@ func NewDNSChallengeProviderByName(name string) (challenge.Provider, error) { return netlify.NewDNSProvider() case "nicmanager": return nicmanager.NewDNSProvider() + case "nicru": + return nicru.NewDNSProvider() case "nifcloud": return nifcloud.NewDNSProvider() case "njalla":