Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README: fix NS address in test command #115

Merged
merged 1 commit into from
Sep 28, 2018

Conversation

julienschmidt
Copy link
Contributor

The address of the nameserver changed when the README was made consistent with the current config file. This PR simply corrects the NS address in a test command.

@coveralls
Copy link

Coverage Status

Coverage remained the same at 93.429% when pulling 9a8453a on julienschmidt:readme_ns into f767904 on joohoi:master.

@@ -205,7 +205,7 @@ Note: The `txt` field must be exactly 43 characters long, otherwise acme-dns wil

4) Perform a DNS lookup to the test subdomain to confirm that everything is working properly:
```
$ dig @ns.auth.example.org d420c923-bbd7-4056-ab64-c3ca54c9b3cf.auth.example.org
$ dig @auth.example.org d420c923-bbd7-4056-ab64-c3ca54c9b3cf.auth.example.org
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

actually the @auth.example.org should not be required at all. If the DNS setup is correct, this server should be queried eventually anyway.

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's correct. And for testing purposes, even more usable actually. The current format is probably more usable for troubleshooting scenarios.

In general, I feel that the README.md should get restructured, and internally linked. For example, installation should link to the DNS configuration section, and testing it out to the (hopefully upcoming) troubleshooting section. Ideally these should follow each other in the document itself. I'll create an issue for that.

@joohoi
Copy link
Owner

joohoi commented Sep 28, 2018

Thanks for fixing this, I'll merge it now, but the whole documentation should go through some rewriting soonish. I added some documentation development thoughts to the code comment above, and will create a new issue for those.

@joohoi joohoi merged commit b452d50 into joohoi:master Sep 28, 2018
jacobmyers-codeninja pushed a commit to jacobmyers-codeninja/acme-dns that referenced this pull request Sep 30, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants