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

docs(ADDRESSING): default DNSLink to ipfs:// #150

Closed
wants to merge 1 commit into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions ADDRESSING.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ If no native protocol handler is available, redirect to a gateway:
```bash
ipfs://{cid} → https://{gateway}/ipfs/{cid}
ipns://{libp2p-key} → https://{gateway}/ipns/{libp2p-key}
ipfs://{fqdn-with-dnslink} → https://{gateway}/ipns/{fqdn-with-dnslink}
ipns://{fqdn-with-dnslink} → https://{gateway}/ipns/{fqdn-with-dnslink}
```

Expand All @@ -37,8 +38,8 @@ ipfs://{cidv0} → redirect → ipfs://{cidv1base32} # CIDv0 is case-sensitive B
ipns://{libp2p-key-in-cidv1base32}
ipns://{libp2p-key-in-base58} → redirect → ipns://{libp2p-key-in-cidv1} # Base58, does not work as Origin authority

ipns://{fqdn-with-dnslink}
ipfs://{fqdn-with-dnslink} → redirect → ipns://{fqdn-with-dnslink} # just to improve UX :-)
ipfs://{fqdn-with-dnslink}
ipns://{fqdn-with-dnslink} → redirect → ipfs://{fqdn-with-dnslink} # just to improve UX :-)

dweb:/ipfs/{root}/{resource} → redirect → ipfs://{root}/{resource} # ensures {root} is the authority component
dweb:/ipns/{root}/{resource} → redirect → ipns://{root}/{resource} # ensures {root} is the authority component
Expand Down Expand Up @@ -76,10 +77,12 @@ Read more: [notes on addressing with HTTP](#notes-on-addressing-with-http).
In future, subdomain convention will be replaced with native handler that provides the same origin-based guarantees:

ipfs://{cidv1b32}/path/to/resource
ipfs://{fqdn-with-dnslink}/path/to/resource

Example:

ipfs://bafybeiemxf5abjwjbikoz4mc3a3dla6ual3jsgpdr4cjr3oz3evfyavhwq/wiki/Vincent_van_Gogh.html
ipfs://tr.wikipedia-on-ipfs.org/wiki/Vincent_van_Gogh.html

Read more: [notes on addressing with ipfs://](#notes-on-addressing-with-ipfs).

Expand Down