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.

Sign up for GitHub

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] Add note about IPNS and DNSLink #6696

Closed
wants to merge 1 commit into from
Closed

[DOCS] Add note about IPNS and DNSLink #6696

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 12 additions & 0 deletions docs/gateway.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,18 @@ your query string to explicitly specify the filename. For example:

> https://ipfs.io/ipfs/QmfM2r8seH2GiRaC4esTjeraXEachRt8ZsSeGaWTPLyMoG?filename=hello_world.txt

## IPNS & DNSLink
Copy link
Member

Choose a reason for hiding this comment

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

This doesn't seem like the right place for this documentation. This document is about gateway features and these are just general IPFS features.

Maybe we should add sentence to the top saying that the gateway provides access to files/directories served on IPFS and then briefly describe /ipns/... and /ipfs/...?


The gateway supports resolving IPNS and DNSLink names:

```
http://127.0.0.1:8080/ipns/Qm...
http://127.0.0.1:8080/ipns/libp2p.io
```

Additionally, it's possible to configure a DNSLink domain to ALIAS it to a gateway for
a nicer looking URL. See [dnslink documentation](http://dnslink.io/#example-ipfs-gateway) for more details.

## MIME-Types

TODO
Expand Down