mirror/stackexchange-dnscontrol
1
0
Fork 0
mirror of https://github.com/StackExchange/dnscontrol.git synced 2024-05-11 05:55:12 +00:00
Code Issues Releases Activity

NAMEDOTCOM: Improve docs about errors related to typos (#465)

Browse Source 
* named.com.md: Improve headings
This commit is contained in:
Tom Limoncelli
2019-04-17 11:34:02 -04:00
committed by GitHub
parent 963bd32e20
commit 460d917774
1 changed files with 24 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
docs/_providers/name.com.md
View File

@ -58,21 +58,40 @@ D("example.tld", REG_NAMECOM, DnsProvider(R53),
## Activation ## Activation
In order to activate API functionality on your Name.com account, you must apply to the API program. The application form is [located here](https://www.name.com/reseller/apply). It usually takes a few days to get a response. After you are accepted, you should receive your API token via email. In order to activate API functionality on your Name.com account, you must apply to the API program. The application form is [located here](https://www.name.com/reseller/apply). It usually takes a few days to get a response. After you are accepted, you should receive your API token via email.
## Tips: ## Tips and error messages
When running integration tests, this error: ### invalid character '<'
``` ```
integration_test.go:140: api returned unexpected response: invalid character '<' looking for beginning of value integration_test.go:140: api returned unexpected response: invalid character '<' looking for beginning of value
``` ```
Means you are setting `export NAMEDOTCOM_URL='api.name.com/api'` and need to remove the `/api`. This error means an invalid URL is being used to reach the API
endpoint. It usually means a setting is `api.name.com/api` when
`api.name.com` is correct (i.e. remove the `/api`).
In integration tests:
* Wrong: `export NAMEDOTCOM_URL='api.name.com/api'`
* Right: `export NAMEDOTCOM_URL='api.name.com'`
In production, the `apiurl` setting in creds.json is wrong. You can
simply leave this option out and use the default, which is correct.
TODO(tlim): Improve the error message. (Volunteer needed!)
When running integration tests, this error: ### dial tcp: lookup https: no such host
``` ```
integration_test.go:81: Failed getting nameservers Get https://https//api.name.com/api/v4/domains/stackosphere.com?: dial tcp: lookup https: no such host integration_test.go:81: Failed getting nameservers Get https://https//api.name.com/api/v4/domains/stackosphere.com?: dial tcp: lookup https: no such host
``` ```
It means you included the `https://` in the `NAMEDOTCOM_URL` variable. You meant to do something like `export NAMEDOTCOM_URL='api.name.com' instead. When running integration tests, this error
means you included the `https://` in the `NAMEDOTCOM_URL` variable.
You meant to do something like `export NAMEDOTCOM_URL='api.name.com' instead.
In production, the `apiurl` setting in creds.json needs to be
adjusted. You can simply leave this option out and use the default,
which is correct. If you are using the EO&T system, leave the
protocol (`http://`) off the URL.