Skip to content

Commit e86fbdd

Browse files
authored
docs: clarify gateway feature set (#2028)
* docs: clarify gateway feature set http retrieval, range requests on cloudflare + some extra links for existing content * chore: lint
1 parent 11b22a1 commit e86fbdd

File tree

2 files changed

+11
-7
lines changed

2 files changed

+11
-7
lines changed

.github/styles/pln-ignore.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,11 +56,13 @@ deduplicate
5656
dep
5757
deps
5858
deserialization
59+
deserialized
5960
devs
6061
dheeraj
6162
dht
6263
dhts
6364
dialable
65+
dialback
6466
dns('s)
6567
dnsaddr
6668
dnslink

docs/concepts/public-utilities.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -38,23 +38,25 @@ Your browser may have a local cache of the content in question and might not ref
3838

3939
The above public gateways support the following:
4040

41-
- `ipfs.io` and `dweb.link` support the [full set of IPFS Gateway specifications](https://specs.ipfs.tech/http-gateways/).
42-
- `trustless-gateway.link` supports only the [Trustless Gateway subset of the specification](https://specs.ipfs.tech/http-gateways/trustless-gateway/).
41+
- `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.
42+
- [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.
43+
- `trustless-gateway.link` supports only the [Trustless Gateway subset of the specification](https://specs.ipfs.tech/http-gateways/trustless-gateway/)
44+
- Suppoted content types: `application/vnd.ipld.raw`, `application/vnd.ipld.car` and `application/vnd.ipfs.ipns-record`
4345

44-
They support HTTP clients reaching them over both ipv4 and ipv6 addresses
46+
They support HTTP clients reaching them over both ipv4 and ipv6 addresses.
4547

4648
The underlying IPFS nodes backing the gateways support the following mutable identifiers under the `/ipns` namespace:
47-
- IPNS Public Keys, e.g. `dweb.link/ipns/k51q....`
48-
- 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`
49+
- [IPNS Names](https://specs.ipfs.tech/ipns/ipns-record/#ipns-name), e.g. `dweb.link/ipns/k51q....`
50+
- [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`
4951

5052
The underlying IPFS nodes backing the gateways support retrieving data from peers that:
5153
- Have either ipv4 or ipv6 addresses
52-
- 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
54+
- 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
5355
- Support one of the following libp2p transport configurations:
5456
- QUIC-v1
5557
- TCP or WS or WSS, Yamux, TLS or Noise
5658
- WebTransport
57-
- 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))
59+
- 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/) -->
5860
- 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)
5961

6062
## Other Public Gateways

0 commit comments

Comments
 (0)