pogpp/lego
1
0
Fork 0
forked from TrueCloudLab/lego
Code Pull requests Activity

chore: spell check docs (#1260)

Browse source
This commit is contained in:
Dominik Menke 2020-09-30 00:27:08 +02:00 committed by GitHub
parent c3ca7d2c6d
commit 37746be75f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
24 changed files with 33 additions and 33 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
cmd/zz_gen_cmd_dnshelp.go
View file

@ -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`)

2
docs/content/dns/_index.md
View file

@ -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 \

2
docs/content/dns/zz_gen_autodns.md
View file

@ -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
```

2
docs/content/dns/zz_gen_cloudxns.md
View file

@ -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).

2
docs/content/dns/zz_gen_dyn.md
View file

@ -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.

2
docs/content/dns/zz_gen_edgedns.md
View file

@ -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

2
docs/content/dns/zz_gen_mythicbeasts.md
View file

@ -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.

2
docs/content/dns/zz_gen_oraclecloud.md
View file

@ -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.

2
docs/content/dns/zz_gen_pdns.md
View file

@ -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).

2
docs/content/dns/zz_gen_rfc2136.md
View file

@ -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. |

2
docs/content/dns/zz_gen_vscale.md
View file

@ -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 |

8
docs/content/usage/cli/_index.md
View file

@ -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`.

2
docs/content/usage/library/Writing-a-Challenge-Solver.md
View file

@ -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
}
```

2
docs/content/usage/library/_index.md
View file

@ -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.

2
providers/dns/autodns/autodns.toml
View file

@ -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
'''

2
providers/dns/cloudxns/cloudxns.toml
View file

@ -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"

2
providers/dns/dyn/dyn.toml
View file

@ -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"

2
providers/dns/edgedns/edgedns.toml
View file

@ -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"

2
providers/dns/mythicbeasts/mythicbeasts.toml
View file

@ -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"

2
providers/dns/oraclecloud/oraclecloud.toml
View file

@ -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"

2
providers/dns/pdns/pdns.toml
View file

@ -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"

2
providers/dns/rfc2136/rfc2136.toml
View file

@ -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"

2
providers/dns/vscale/vscale.toml
View file

@ -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"