docs: add section about DNSLink via Subdomain #110
Conversation
content/guides/concepts/dnslink.md
Outdated
| _dnslink.docs.ipfs.io. 34 IN TXT "dnslink=/ipfs/QmeveuwF5wWBSgUXLG6p1oxF3GKkgjEnhA6AAwHUoVsx6E" | ||
| ``` | ||
|
|
||
| <!-- Not sure if IPNS is fast enough to mention here |
There was a problem hiding this comment.
Does it resolve pretty reliably before your browser times out yet? That might be a better way to decide whether it’s worth discussing.
There was a problem hiding this comment.
AFAIK it is hit or miss right now. That is why I commented out this section, so it won't get rendered.
We can revisit it when IPNS improves enough.
There was a problem hiding this comment.
Was about to merge this morning and realized I had one more burning question here: what’s the use case for _dnslink.whatever.com instead of just whatever.com?
Noted a few other minor nits inline while I was looking, but those are also minor things I can just fix while merging.
content/guides/concepts/dnslink.md
Outdated
| @@ -5,9 +5,16 @@ menu: | |||
| parent: concepts | |||
| --- | |||
|
|
|||
| DNSLink uses DNS records to map a domain name (like `ipfs.io`) to an IPFS address. Because you can edit your DNS records, you can use them to always point to the latest version of an object in IPFS (remember that an IPFS object’s address changes if you modify the object). Because DNSLink uses DNS records, the names it produces are also usually easy to type and read. | |||
| ### Overview | |||
There was a problem hiding this comment.
Could you remove this header? See #105 (comment) for more. I should probably write up a doc about this stuff :\
content/guides/concepts/dnslink.md
Outdated
|
|
||
| ### Publish via Subdomain | ||
|
|
||
| It is possible to publish DNSLink using a special subdomain named `_dnslink`. |
There was a problem hiding this comment.
Can you describe a use case for this? I didn’t know it existed and I’m wondering why you’d want to do this instead just adding another TXT record directly on the domain you want to use.
There was a problem hiding this comment.
I've added a paragraph with generic use case. Basically its useful when you want to delegate control over DNSLink without allowing for changes to anything else.
FYI there is another one, but it is specific to a vendor and probably should not land in the doc: Historically we had a bug where dnsimple automatically added a TXT record "this is an ALIAS record" in some setups, but instead of making a new TXT record they overrode existing TXT record holding the dnslink, effectively breaking it. Using subdomain works around that as well.
content/guides/concepts/dnslink.md
Outdated
| because TXT record exists for `_dnslink.docs.ipfs.io`: | ||
|
|
||
| ``` | ||
| dig +noall +answer TXT _dnslink.docs.ipfs.io |
There was a problem hiding this comment.
Please add a $ or > at the start of this line to show it’s input at the prompt and not output!
content/guides/concepts/dnslink.md
Outdated
| _dnslink.docs.ipfs.io. 34 IN TXT "dnslink=/ipfs/QmeveuwF5wWBSgUXLG6p1oxF3GKkgjEnhA6AAwHUoVsx6E" | ||
| ``` | ||
|
|
||
| <!-- Not sure if IPNS is fast enough to mention here |
|
@Mr0grog applied changes suggested in your review, check again :) |
content/guides/concepts/dnslink.md
Outdated
|
|
||
| It is possible to publish DNSLink using a special subdomain named `_dnslink`. | ||
|
|
||
| This is useful when one wants to improve security of automated setup or |
There was a problem hiding this comment.
Extra minor: since the rest of this doc is written in the second person (it addresses the reader as “you,” we should stick with that here :)
|
@lidel Can you rewrite your commits to include a signoff? Totally forgot to mention that last time, sorry. After that, I’m going to make just a couple grammar tweaks, but this looks great otherwise. Thanks! ❤️ |
License: MIT Signed-off-by: Marcin Rataj <lidel@lidel.org>
|
@Mr0grog added signoff and squashed into a single commit 👍 |
License: MIT Signed-off-by: Rob Brackett <rob@robbrackett.com>
|
Beautiful, thanks!
That’s at least one of the things I’m here for, no worries ;) |
This PR updates
/guides/concepts/dnslink:_dnslinksubdomain"