From 37746be75f31b4d6799d96e15734eb1480808130 Mon Sep 17 00:00:00 2001 From: Dominik Menke Date: Wed, 30 Sep 2020 00:27:08 +0200 Subject: [PATCH] chore: spell check docs (#1260) --- cmd/zz_gen_cmd_dnshelp.go | 14 +++++++------- docs/content/dns/_index.md | 2 +- docs/content/dns/zz_gen_autodns.md | 2 +- docs/content/dns/zz_gen_cloudxns.md | 2 +- docs/content/dns/zz_gen_dyn.md | 2 +- docs/content/dns/zz_gen_edgedns.md | 2 +- docs/content/dns/zz_gen_mythicbeasts.md | 2 +- docs/content/dns/zz_gen_oraclecloud.md | 2 +- docs/content/dns/zz_gen_pdns.md | 2 +- docs/content/dns/zz_gen_rfc2136.md | 2 +- docs/content/dns/zz_gen_vscale.md | 2 +- docs/content/usage/cli/_index.md | 8 ++++---- .../usage/library/Writing-a-Challenge-Solver.md | 2 +- docs/content/usage/library/_index.md | 2 +- providers/dns/autodns/autodns.toml | 2 +- providers/dns/bindman/bindman.toml | 2 +- providers/dns/cloudxns/cloudxns.toml | 2 +- providers/dns/dyn/dyn.toml | 2 +- providers/dns/edgedns/edgedns.toml | 2 +- providers/dns/mythicbeasts/mythicbeasts.toml | 2 +- providers/dns/oraclecloud/oraclecloud.toml | 2 +- providers/dns/pdns/pdns.toml | 2 +- providers/dns/rfc2136/rfc2136.toml | 2 +- providers/dns/vscale/vscale.toml | 2 +- 24 files changed, 33 insertions(+), 33 deletions(-) diff --git a/cmd/zz_gen_cmd_dnshelp.go b/cmd/zz_gen_cmd_dnshelp.go index 20c1e704..a4e5e1f2 100644 --- a/cmd/zz_gen_cmd_dnshelp.go +++ b/cmd/zz_gen_cmd_dnshelp.go @@ -372,7 +372,7 @@ func displayDNSHelp(name string) error { ew.writeln(`Credentials:`) ew.writeln(` - "CLOUDXNS_API_KEY": The API key`) - ew.writeln(` - "CLOUDXNS_SECRET_KEY": THe API secret key`) + ew.writeln(` - "CLOUDXNS_SECRET_KEY": The API secret key`) ew.writeln() ew.writeln(`Additional Configuration:`) @@ -626,7 +626,7 @@ func displayDNSHelp(name string) error { ew.writeln(`Credentials:`) ew.writeln(` - "DYN_CUSTOMER_NAME": Customer name`) - ew.writeln(` - "DYN_PASSWORD": Paswword`) + ew.writeln(` - "DYN_PASSWORD": Password`) ew.writeln(` - "DYN_USER_NAME": User name`) ew.writeln() @@ -1103,7 +1103,7 @@ func displayDNSHelp(name string) error { ew.writeln() ew.writeln(`Credentials:`) - ew.writeln(` - "MYTHICBEASTS_PASSWORD": Paswword`) + ew.writeln(` - "MYTHICBEASTS_PASSWORD": Password`) ew.writeln(` - "MYTHICBEASTS_USERNAME": User name`) ew.writeln() @@ -1276,7 +1276,7 @@ func displayDNSHelp(name string) error { ew.writeln(` - "OCI_PRIVKEY_PASS": Private key password`) ew.writeln(` - "OCI_PUBKEY_FINGERPRINT": Public key fingerprint`) ew.writeln(` - "OCI_REGION": Region`) - ew.writeln(` - "OCI_TENANCY_OCID": Tenanct OCID`) + ew.writeln(` - "OCI_TENANCY_OCID": Tenancy OCID`) ew.writeln(` - "OCI_USER_OCID": User OCID`) ew.writeln() @@ -1344,7 +1344,7 @@ func displayDNSHelp(name string) error { ew.writeln(`Credentials:`) ew.writeln(` - "PDNS_API_KEY": API key`) - ew.writeln(` - "PDNS_API_URL": API url`) + ew.writeln(` - "PDNS_API_URL": API URL`) ew.writeln() ew.writeln(`Additional Configuration:`) @@ -1407,7 +1407,7 @@ func displayDNSHelp(name string) error { ew.writeln(`Credentials:`) ew.writeln(` - "RFC2136_NAMESERVER": Network address in the form "host" or "host:port"`) - ew.writeln(` - "RFC2136_TSIG_ALGORITHM": TSIG algorythm. See [miekg/dns#tsig.go](https://github.com/miekg/dns/blob/master/tsig.go) for supported values. To disable TSIG authentication, leave the 'RFC2136_TSIG*' variables unset.`) + ew.writeln(` - "RFC2136_TSIG_ALGORITHM": TSIG algorithm. See [miekg/dns#tsig.go](https://github.com/miekg/dns/blob/master/tsig.go) for supported values. To disable TSIG authentication, leave the 'RFC2136_TSIG*' variables unset.`) ew.writeln(` - "RFC2136_TSIG_KEY": Name of the secret key as defined in DNS server configuration. To disable TSIG authentication, leave the 'RFC2136_TSIG*' variables unset.`) ew.writeln(` - "RFC2136_TSIG_SECRET": Secret key payload. To disable TSIG authentication, leave the' RFC2136_TSIG*' variables unset.`) ew.writeln() @@ -1649,7 +1649,7 @@ func displayDNSHelp(name string) error { ew.writeln() ew.writeln(`Additional Configuration:`) - ew.writeln(` - "VSCALE_BASE_URL": API enddpoint URL`) + ew.writeln(` - "VSCALE_BASE_URL": API endpoint URL`) ew.writeln(` - "VSCALE_HTTP_TIMEOUT": API request timeout`) ew.writeln(` - "VSCALE_POLLING_INTERVAL": Time between DNS propagation check`) ew.writeln(` - "VSCALE_PROPAGATION_TIMEOUT": Maximum waiting time for DNS propagation`) diff --git a/docs/content/dns/_index.md b/docs/content/dns/_index.md index d075229c..174f583a 100644 --- a/docs/content/dns/_index.md +++ b/docs/content/dns/_index.md @@ -13,7 +13,7 @@ Credentials and DNS configuration for DNS providers must be passed through envir The environment variables can reference a value. -Here is an example bash command using the CloudFlare DNS provider: +Here is an example bash command using the Cloudflare DNS provider: ```bash $ CLOUDFLARE_EMAIL=foo@bar.com \ diff --git a/docs/content/dns/zz_gen_autodns.md b/docs/content/dns/zz_gen_autodns.md index f840c14e..de1b33fc 100644 --- a/docs/content/dns/zz_gen_autodns.md +++ b/docs/content/dns/zz_gen_autodns.md @@ -21,7 +21,7 @@ Configuration for [Autodns](https://www.internetx.com/domains/autodns/). Here is an example bash command using the Autodns provider: ```bash -AUTODNS_API_USER=usernam \ +AUTODNS_API_USER=username \ AUTODNS_API_PASSWORD=supersecretpassword \ lego --dns autodns --domains my.domain.com --email my@email.com run ``` diff --git a/docs/content/dns/zz_gen_cloudxns.md b/docs/content/dns/zz_gen_cloudxns.md index 04eba1e9..0c7b0420 100644 --- a/docs/content/dns/zz_gen_cloudxns.md +++ b/docs/content/dns/zz_gen_cloudxns.md @@ -30,7 +30,7 @@ _Please contribute by adding a CLI example._ | Environment Variable Name | Description | |-----------------------|-------------| | `CLOUDXNS_API_KEY` | The API key | -| `CLOUDXNS_SECRET_KEY` | THe API secret key | +| `CLOUDXNS_SECRET_KEY` | The API secret key | The environment variable names can be suffixed by `_FILE` to reference a file instead of a value. More information [here](/lego/dns/#configuration-and-credentials). diff --git a/docs/content/dns/zz_gen_dyn.md b/docs/content/dns/zz_gen_dyn.md index 7878ab45..ff478a35 100644 --- a/docs/content/dns/zz_gen_dyn.md +++ b/docs/content/dns/zz_gen_dyn.md @@ -30,7 +30,7 @@ _Please contribute by adding a CLI example._ | Environment Variable Name | Description | |-----------------------|-------------| | `DYN_CUSTOMER_NAME` | Customer name | -| `DYN_PASSWORD` | Paswword | +| `DYN_PASSWORD` | Password | | `DYN_USER_NAME` | User name | The environment variable names can be suffixed by `_FILE` to reference a file instead of a value. diff --git a/docs/content/dns/zz_gen_edgedns.md b/docs/content/dns/zz_gen_edgedns.md index 817d243c..67553c0a 100644 --- a/docs/content/dns/zz_gen_edgedns.md +++ b/docs/content/dns/zz_gen_edgedns.md @@ -11,7 +11,7 @@ slug: edgedns Since: v3.9.0 -Akamai edgedns supercedes FastDNS; implementing a DNS provider for solving the DNS-01 challenge using Akamai EdgeDNS +Akamai edgedns supersedes FastDNS; implementing a DNS provider for solving the DNS-01 challenge using Akamai EdgeDNS diff --git a/docs/content/dns/zz_gen_mythicbeasts.md b/docs/content/dns/zz_gen_mythicbeasts.md index bc002fc9..f5cf2e1b 100644 --- a/docs/content/dns/zz_gen_mythicbeasts.md +++ b/docs/content/dns/zz_gen_mythicbeasts.md @@ -33,7 +33,7 @@ lego --dns mythicbeasts --domains my.domain.com --email my@email.com run | Environment Variable Name | Description | |-----------------------|-------------| -| `MYTHICBEASTS_PASSWORD` | Paswword | +| `MYTHICBEASTS_PASSWORD` | Password | | `MYTHICBEASTS_USERNAME` | User name | The environment variable names can be suffixed by `_FILE` to reference a file instead of a value. diff --git a/docs/content/dns/zz_gen_oraclecloud.md b/docs/content/dns/zz_gen_oraclecloud.md index 735b886d..1561c7ba 100644 --- a/docs/content/dns/zz_gen_oraclecloud.md +++ b/docs/content/dns/zz_gen_oraclecloud.md @@ -43,7 +43,7 @@ lego --dns oraclecloud --domains my.domain.com --email my@email.com run | `OCI_PRIVKEY_PASS` | Private key password | | `OCI_PUBKEY_FINGERPRINT` | Public key fingerprint | | `OCI_REGION` | Region | -| `OCI_TENANCY_OCID` | Tenanct OCID | +| `OCI_TENANCY_OCID` | Tenancy OCID | | `OCI_USER_OCID` | User OCID | The environment variable names can be suffixed by `_FILE` to reference a file instead of a value. diff --git a/docs/content/dns/zz_gen_pdns.md b/docs/content/dns/zz_gen_pdns.md index f6a0a59a..7e0be2a5 100644 --- a/docs/content/dns/zz_gen_pdns.md +++ b/docs/content/dns/zz_gen_pdns.md @@ -30,7 +30,7 @@ _Please contribute by adding a CLI example._ | Environment Variable Name | Description | |-----------------------|-------------| | `PDNS_API_KEY` | API key | -| `PDNS_API_URL` | API url | +| `PDNS_API_URL` | API URL | The environment variable names can be suffixed by `_FILE` to reference a file instead of a value. More information [here](/lego/dns/#configuration-and-credentials). diff --git a/docs/content/dns/zz_gen_rfc2136.md b/docs/content/dns/zz_gen_rfc2136.md index feaca629..954c21ae 100644 --- a/docs/content/dns/zz_gen_rfc2136.md +++ b/docs/content/dns/zz_gen_rfc2136.md @@ -30,7 +30,7 @@ _Please contribute by adding a CLI example._ | Environment Variable Name | Description | |-----------------------|-------------| | `RFC2136_NAMESERVER` | Network address in the form "host" or "host:port" | -| `RFC2136_TSIG_ALGORITHM` | TSIG algorythm. See [miekg/dns#tsig.go](https://github.com/miekg/dns/blob/master/tsig.go) for supported values. To disable TSIG authentication, leave the `RFC2136_TSIG*` variables unset. | +| `RFC2136_TSIG_ALGORITHM` | TSIG algorithm. See [miekg/dns#tsig.go](https://github.com/miekg/dns/blob/master/tsig.go) for supported values. To disable TSIG authentication, leave the `RFC2136_TSIG*` variables unset. | | `RFC2136_TSIG_KEY` | Name of the secret key as defined in DNS server configuration. To disable TSIG authentication, leave the `RFC2136_TSIG*` variables unset. | | `RFC2136_TSIG_SECRET` | Secret key payload. To disable TSIG authentication, leave the` RFC2136_TSIG*` variables unset. | diff --git a/docs/content/dns/zz_gen_vscale.md b/docs/content/dns/zz_gen_vscale.md index 579c55f1..0e9ccd87 100644 --- a/docs/content/dns/zz_gen_vscale.md +++ b/docs/content/dns/zz_gen_vscale.md @@ -39,7 +39,7 @@ More information [here](/lego/dns/#configuration-and-credentials). | Environment Variable Name | Description | |--------------------------------|-------------| -| `VSCALE_BASE_URL` | API enddpoint URL | +| `VSCALE_BASE_URL` | API endpoint URL | | `VSCALE_HTTP_TIMEOUT` | API request timeout | | `VSCALE_POLLING_INTERVAL` | Time between DNS propagation check | | `VSCALE_PROPAGATION_TIMEOUT` | Maximum waiting time for DNS propagation | diff --git a/docs/content/usage/cli/_index.md b/docs/content/usage/cli/_index.md index d0c0a8c8..0e10321a 100644 --- a/docs/content/usage/cli/_index.md +++ b/docs/content/usage/cli/_index.md @@ -67,12 +67,12 @@ If you'd like to test something without issuing real certificates, consider usin lego --server=https://acme-staging-v02.api.letsencrypt.org/directory … ``` -## Sudo +## Running without root privileges The CLI does not require root permissions but needs to bind to port 80 and 443 for certain challenges. -To run the CLI without sudo, you have four options: +To run the CLI without `sudo`, you have four options: -- Use setcap 'cap_net_bind_service=+ep' /path/to/program +- Use `setcap 'cap_net_bind_service=+ep' /path/to/lego` (Linux only) - Pass the `--http.port` or/and the `--tls.port` option and specify a custom port to bind to. In this case you have to forward port 80/443 to these custom ports (see [Port Usage](#port-usage)). - Pass the `--http.webroot` option and specify the path to your webroot folder. In this case the challenge will be written in a file in `.well-known/acme-challenge/` inside your webroot. - Pass the `--dns` option and specify a DNS provider. @@ -91,4 +91,4 @@ If you are using this option, make sure you proxy all of the following traffic t This traffic redirection is only needed as long as lego solves challenges. As soon as you have received your certificates you can deactivate the forwarding. -[^header]: You must ensure that incoming validation requests containt the correct value for the HTTP `Host` header. If you operate lego behind a non-transparent reverse proxy (such as Apache or NGINX), you might need to alter the header field using `--http.proxy-header X-Forwarded-Host`. +[^header]: You must ensure that incoming validation requests contains the correct value for the HTTP `Host` header. If you operate lego behind a non-transparent reverse proxy (such as Apache or NGINX), you might need to alter the header field using `--http.proxy-header X-Forwarded-Host`. diff --git a/docs/content/usage/library/Writing-a-Challenge-Solver.md b/docs/content/usage/library/Writing-a-Challenge-Solver.md index 79e6209b..3b01c8c1 100644 --- a/docs/content/usage/library/Writing-a-Challenge-Solver.md +++ b/docs/content/usage/library/Writing-a-Challenge-Solver.md @@ -60,7 +60,7 @@ For DNS-01, we'll just use `domain` and `keyAuth`. ```go func (d *DNSProviderBestDNS) Present(domain, token, keyAuth string) error { fqdn, value := dns01.GetRecord(domain, keyAuth) - // make API request to set a TXT record on fqdn with value and ttl + // make API request to set a TXT record on fqdn with value and TTL return nil } ``` diff --git a/docs/content/usage/library/_index.md b/docs/content/usage/library/_index.md index 205b2144..ddb9d6d4 100644 --- a/docs/content/usage/library/_index.md +++ b/docs/content/usage/library/_index.md @@ -77,7 +77,7 @@ func main() { log.Fatal(err) } - // We specify an http port of 5002 and an tls port of 5001 on all interfaces + // We specify an HTTP port of 5002 and an TLS port of 5001 on all interfaces // because we aren't running as root and can't bind a listener to port 80 and 443 // (used later when we attempt to pass challenges). Keep in mind that you still // need to proxy challenge traffic to port 5002 and 5001. diff --git a/providers/dns/autodns/autodns.toml b/providers/dns/autodns/autodns.toml index 0087b16f..7a05cedb 100644 --- a/providers/dns/autodns/autodns.toml +++ b/providers/dns/autodns/autodns.toml @@ -5,7 +5,7 @@ Code = "autodns" Since = "v3.2.0" Example = ''' -AUTODNS_API_USER=usernam \ +AUTODNS_API_USER=username \ AUTODNS_API_PASSWORD=supersecretpassword \ lego --dns autodns --domains my.domain.com --email my@email.com run ''' diff --git a/providers/dns/bindman/bindman.toml b/providers/dns/bindman/bindman.toml index 92b8a539..b9f44d3c 100644 --- a/providers/dns/bindman/bindman.toml +++ b/providers/dns/bindman/bindman.toml @@ -19,4 +19,4 @@ lego --dns bindman --domains my.domain.com --email my@email.com run [Links] API = "https://gitlab.isc.org/isc-projects/bind9" - GoClient = "https://github.com/labbsr0x/bindman-dns-webhook" \ No newline at end of file + GoClient = "https://github.com/labbsr0x/bindman-dns-webhook" diff --git a/providers/dns/cloudxns/cloudxns.toml b/providers/dns/cloudxns/cloudxns.toml index d5bc6d4e..1330d614 100644 --- a/providers/dns/cloudxns/cloudxns.toml +++ b/providers/dns/cloudxns/cloudxns.toml @@ -9,7 +9,7 @@ Example = '''''' [Configuration] [Configuration.Credentials] CLOUDXNS_API_KEY = "The API key" - CLOUDXNS_SECRET_KEY = "THe API secret key" + CLOUDXNS_SECRET_KEY = "The API secret key" [Configuration.Additional] CLOUDXNS_POLLING_INTERVAL = "Time between DNS propagation check" CLOUDXNS_PROPAGATION_TIMEOUT = "Maximum waiting time for DNS propagation" diff --git a/providers/dns/dyn/dyn.toml b/providers/dns/dyn/dyn.toml index b183589a..d351e8e1 100644 --- a/providers/dns/dyn/dyn.toml +++ b/providers/dns/dyn/dyn.toml @@ -10,7 +10,7 @@ Example = '''''' [Configuration.Credentials] DYN_CUSTOMER_NAME = "Customer name" DYN_USER_NAME = "User name" - DYN_PASSWORD = "Paswword" + DYN_PASSWORD = "Password" [Configuration.Additional] DYN_POLLING_INTERVAL = "Time between DNS propagation check" DYN_PROPAGATION_TIMEOUT = "Maximum waiting time for DNS propagation" diff --git a/providers/dns/edgedns/edgedns.toml b/providers/dns/edgedns/edgedns.toml index 908fe79a..97a0bc40 100644 --- a/providers/dns/edgedns/edgedns.toml +++ b/providers/dns/edgedns/edgedns.toml @@ -1,7 +1,7 @@ Name = "Akamai EdgeDNS" Description = ''' -Akamai edgedns supercedes FastDNS; implementing a DNS provider for solving the DNS-01 challenge using Akamai EdgeDNS +Akamai edgedns supersedes FastDNS; implementing a DNS provider for solving the DNS-01 challenge using Akamai EdgeDNS ''' URL = "https://www.akamai.com/us/en/products/security/edge-dns.jsp" Code = "edgedns" diff --git a/providers/dns/mythicbeasts/mythicbeasts.toml b/providers/dns/mythicbeasts/mythicbeasts.toml index 49643394..f977f3e5 100644 --- a/providers/dns/mythicbeasts/mythicbeasts.toml +++ b/providers/dns/mythicbeasts/mythicbeasts.toml @@ -19,7 +19,7 @@ Your API key name is not needed to operate lego. [Configuration] [Configuration.Credentials] MYTHICBEASTS_USERNAME = "User name" - MYTHICBEASTS_PASSWORD = "Paswword" + MYTHICBEASTS_PASSWORD = "Password" [Configuration.Additional] MYTHICBEASTS_API_ENDPOINT = "The endpoint for the API (must implement v2)" MYTHICBEASYS_AUTH_API_ENDPOINT = "The endpoint for Mythic Beasts' Authentication" diff --git a/providers/dns/oraclecloud/oraclecloud.toml b/providers/dns/oraclecloud/oraclecloud.toml index b97ca852..d9c519c1 100644 --- a/providers/dns/oraclecloud/oraclecloud.toml +++ b/providers/dns/oraclecloud/oraclecloud.toml @@ -19,7 +19,7 @@ lego --dns oraclecloud --domains my.domain.com --email my@email.com run [Configuration.Credentials] OCI_PRIVKEY_FILE = "Private key file" OCI_PRIVKEY_PASS = "Private key password" - OCI_TENANCY_OCID = "Tenanct OCID" + OCI_TENANCY_OCID = "Tenancy OCID" OCI_USER_OCID = "User OCID" OCI_PUBKEY_FINGERPRINT = "Public key fingerprint" OCI_REGION = "Region" diff --git a/providers/dns/pdns/pdns.toml b/providers/dns/pdns/pdns.toml index f6b8370a..6c913754 100644 --- a/providers/dns/pdns/pdns.toml +++ b/providers/dns/pdns/pdns.toml @@ -19,7 +19,7 @@ PowerDNS Notes: [Configuration] [Configuration.Credentials] PDNS_API_KEY = "API key" - PDNS_API_URL = "API url" + PDNS_API_URL = "API URL" [Configuration.Additional] PDNS_POLLING_INTERVAL = "Time between DNS propagation check" PDNS_PROPAGATION_TIMEOUT = "Maximum waiting time for DNS propagation" diff --git a/providers/dns/rfc2136/rfc2136.toml b/providers/dns/rfc2136/rfc2136.toml index 6e213c88..020a0968 100644 --- a/providers/dns/rfc2136/rfc2136.toml +++ b/providers/dns/rfc2136/rfc2136.toml @@ -10,7 +10,7 @@ Example = '''''' [Configuration.Credentials] RFC2136_TSIG_KEY = "Name of the secret key as defined in DNS server configuration. To disable TSIG authentication, leave the `RFC2136_TSIG*` variables unset." RFC2136_TSIG_SECRET = "Secret key payload. To disable TSIG authentication, leave the` RFC2136_TSIG*` variables unset." - RFC2136_TSIG_ALGORITHM = "TSIG algorythm. See [miekg/dns#tsig.go](https://github.com/miekg/dns/blob/master/tsig.go) for supported values. To disable TSIG authentication, leave the `RFC2136_TSIG*` variables unset." + RFC2136_TSIG_ALGORITHM = "TSIG algorithm. See [miekg/dns#tsig.go](https://github.com/miekg/dns/blob/master/tsig.go) for supported values. To disable TSIG authentication, leave the `RFC2136_TSIG*` variables unset." RFC2136_NAMESERVER = 'Network address in the form "host" or "host:port"' [Configuration.Additional] RFC2136_POLLING_INTERVAL = "Time between DNS propagation check" diff --git a/providers/dns/vscale/vscale.toml b/providers/dns/vscale/vscale.toml index b86da650..341eb22c 100644 --- a/providers/dns/vscale/vscale.toml +++ b/providers/dns/vscale/vscale.toml @@ -10,7 +10,7 @@ Example = '''''' [Configuration.Credentials] VSCALE_API_TOKEN = "API token" [Configuration.Additional] - VSCALE_BASE_URL = "API enddpoint URL" + VSCALE_BASE_URL = "API endpoint URL" VSCALE_POLLING_INTERVAL = "Time between DNS propagation check" VSCALE_PROPAGATION_TIMEOUT = "Maximum waiting time for DNS propagation" VSCALE_TTL = "The TTL of the TXT record used for the DNS challenge"