Skip to content

Commit

Permalink
review
Browse files Browse the repository at this point in the history
  • Loading branch information
@ldez
ldez committed Feb 7, 2024
1 parent 0c0bc84 commit b848556
Show file tree
Hide file tree
Showing 16 changed files with 984 additions and 631 deletions.
19 changes: 9 additions & 10 deletions cmd/zz_gen_cmd_dnshelp.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1941,22 +1941,21 @@ func displayDNSHelp(w io.Writer, name string) error {
// generated from: providers/dns/nicru/nicru.toml
ew.writeln(`Configuration for RU CENTER.`)
ew.writeln(`Code: 'nicru'`)
ew.writeln(`Since: 'v4.11.0'`)
ew.writeln(`Since: 'v4.12.0'`)
ew.writeln()

ew.writeln(`Credentials:`)
ew.writeln(` - "NIC_RU_PASSWORD": Password for account in RU CENTER`)
ew.writeln(` - "NIC_RU_SECRET": Secret for application in DNS-hosting RU CENTER`)
ew.writeln(` - "NIC_RU_SERVICE_ID": Service ID for application in DNS-hosting RU CENTER`)
ew.writeln(` - "NIC_RU_SERVICE_NAME": Service Name for DNS-hosting RU CENTER`)
ew.writeln(` - "NIC_RU_USER": Agreement for account in RU CENTER`)
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(` - "NIC_RU_HTTP_TIMEOUT": API request timeout`)
ew.writeln(` - "NIC_RU_POLLING_INTERVAL": Time between DNS propagation check`)
ew.writeln(` - "NIC_RU_PROPAGATION_TIMEOUT": Maximum waiting time for DNS propagation`)
ew.writeln(` - "NIC_RU_TTL": The TTL of the TXT record used for the DNS challenge`)
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`)
Expand Down
45 changes: 22 additions & 23 deletions docs/content/dns/zz_gen_nicru.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ date: 2019-03-03T16:39:46+01:00
draft: false
slug: nicru
dnsprovider:
since: "v4.11.0"
since: "v4.12.0"
code: "nicru"
url: "https://nic.ru/"
---
Expand All @@ -20,17 +20,17 @@ Configuration for [RU CENTER](https://nic.ru/).
<!--more-->

- Code: `nicru`
- Since: v4.11.0
- Since: v4.12.0


Here is an example bash command using the RU CENTER provider:

```bash
NIC_RU_USER="<your_user>" \
NIC_RU_PASSWORD="<your_password>" \
NIC_RU_SERVICE_ID="<service_id>" \
NIC_RU_SECRET="<service_secret>" \
NIC_RU_SERVICE_NAME="<service_name>" \
NICRU_USER="<your_user>" \
NICRU_PASSWORD="<your_password>" \
NICRU_SERVICE_ID="<service_id>" \
NICRU_SECRET="<service_secret>" \
NICRU_SERVICE_NAME="<service_name>" \
./lego --dns nicru --domains "*.example.com" --email [email protected] run
```

Expand All @@ -41,11 +41,11 @@ NIC_RU_SERVICE_NAME="<service_name>" \

| Environment Variable Name | Description |
|-----------------------|-------------|
| `NIC_RU_PASSWORD` | Password for account in RU CENTER |
| `NIC_RU_SECRET` | Secret for application in DNS-hosting RU CENTER |
| `NIC_RU_SERVICE_ID` | Service ID for application in DNS-hosting RU CENTER |
| `NIC_RU_SERVICE_NAME` | Service Name for DNS-hosting RU CENTER |
| `NIC_RU_USER` | Agreement for account in RU CENTER |
| `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" >}}).
Expand All @@ -55,10 +55,9 @@ More information [here]({{< ref "dns#configuration-and-credentials" >}}).

| Environment Variable Name | Description |
|--------------------------------|-------------|
| `NIC_RU_HTTP_TIMEOUT` | API request timeout |
| `NIC_RU_POLLING_INTERVAL` | Time between DNS propagation check |
| `NIC_RU_PROPAGATION_TIMEOUT` | Maximum waiting time for DNS propagation |
| `NIC_RU_TTL` | The TTL of the TXT record used for the DNS challenge |
| `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" >}}).
Expand All @@ -67,13 +66,13 @@ More information [here]({{< ref "dns#configuration-and-credentials" >}}).

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 |
|----------------------|--------------------------------|-------------------|
| NIC_RU_USER | Username (Number of agreement) | NNNNNNN/NIC-D |
| NIC_RU_PASSWORD | Password account | |
| NIC_RU_SERVICE_ID | Application ID | hex-based, len 32 |
| NIC_RU_SECRET | Identity endpoint | string len 91 |
| NIC_RU_SERVICE_NAME | Service name in DNS-hosting | DPNNNNNNNNNN |
| 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 |
| NICRU_SERVICE_NAME | Service name in DNS-hosting | DPNNNNNNNNNN |



Expand Down
Loading

0 comments on commit b848556

Please sign in to comment.