Skip to content

docs: clarify gateway feature set #2028

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

Merged
merged 2 commits into from
Apr 23, 2025
Merged
Show file tree
Hide file tree
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
2 changes: 2 additions & 0 deletions .github/styles/pln-ignore.txt
Original file line number Diff line number Diff line change
Expand Up @@ -56,11 +56,13 @@ deduplicate
dep
deps
deserialization
deserialized
devs
dheeraj
dht
dhts
dialable
dialback
dns('s)
dnsaddr
dnslink
Expand Down
16 changes: 9 additions & 7 deletions docs/concepts/public-utilities.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,23 +38,25 @@ Your browser may have a local cache of the content in question and might not ref

The above public gateways support the following:

- `ipfs.io` and `dweb.link` support the [full set of IPFS Gateway specifications](https://specs.ipfs.tech/http-gateways/).
- `trustless-gateway.link` supports only the [Trustless Gateway subset of the specification](https://specs.ipfs.tech/http-gateways/trustless-gateway/).
- `ipfs.io` and `dweb.link` support the [full set of IPFS Gateway specifications](https://specs.ipfs.tech/http-gateways/), including deserialized responses to enable website hosting.
- [HTTP Range requests](https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Range) support files up to a maximum size of 5GiB due to limitations of the Cloudflare CDN. Requests for larger files will result in a standard HTTP 200 response instead.
- `trustless-gateway.link` supports only the [Trustless Gateway subset of the specification](https://specs.ipfs.tech/http-gateways/trustless-gateway/)
- Suppoted content types: `application/vnd.ipld.raw`, `application/vnd.ipld.car` and `application/vnd.ipfs.ipns-record`

They support HTTP clients reaching them over both ipv4 and ipv6 addresses
They support HTTP clients reaching them over both ipv4 and ipv6 addresses.

The underlying IPFS nodes backing the gateways support the following mutable identifiers under the `/ipns` namespace:
- IPNS Public Keys, e.g. `dweb.link/ipns/k51q....`
- DNSLink for all [ICANN](https://en.wikipedia.org/wiki/ICANN) registered domains as well as `.crypto` and `.eth`, e.g. `dweb.link/ipns/vitalik.eth`
- [IPNS Names](https://specs.ipfs.tech/ipns/ipns-record/#ipns-name), e.g. `dweb.link/ipns/k51q....`
- [DNSLink](dnslink.md) for all [ICANN](https://en.wikipedia.org/wiki/ICANN) registered domains as well as `.eth`, e.g. `dweb.link/ipns/vitalik.eth`

The underlying IPFS nodes backing the gateways support retrieving data from peers that:
- Have either ipv4 or ipv6 addresses
- Are either reachable over the public internet or are accessible via libp2p's relay-v2 protocol and reach out to the gateway nodes via dialback
- Are either reachable over the public internet or are accessible via libp2p's [relay-v2 protocol](https://github.com/libp2p/specs/blob/master/relay/circuit-v2.md) and reach out to the gateway nodes via dialback
- Support one of the following libp2p transport configurations:
- QUIC-v1
- TCP or WS or WSS, Yamux, TLS or Noise
- WebTransport
- Support the [Bitswap](./bitswap.md) protocol ([v1.2](https://specs.ipfs.tech/bitswap-protocol/#bitswap-1-2-0), [v1.1](https://specs.ipfs.tech/bitswap-protocol/#bitswap-1-1-0) or [v1.0](https://specs.ipfs.tech/bitswap-protocol/#bitswap-1-0-0))
- Support the [Bitswap](./bitswap.md) protocol ([v1.2](https://specs.ipfs.tech/bitswap-protocol/#bitswap-1-2-0), [v1.1](https://specs.ipfs.tech/bitswap-protocol/#bitswap-1-1-0) or [v1.0](https://specs.ipfs.tech/bitswap-protocol/#bitswap-1-0-0)) <!-- TODO: or HTTP retrieval using `application/vnd.ipld.raw` responses as defined in the [Trustless Gateway Specification](https://specs.ipfs.tech/http-gateways/trustless-gateway/) -->
- Have either advertised their data to the [Amino DHT](./glossary.md#amino), or have advertised to [IPNI](./glossary.md#ipni) such that their data has been indexed by [cid.contact](https://cid.contact)

## Other Public Gateways
Expand Down