Skip to content

Commit ff53bb3

Browse files
committed
feat: add information on the features supported by the public IPFS gateways
1 parent 46bca40 commit ff53bb3

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

docs/concepts/public-utilities.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,29 @@ From there, an internal system extracts the relevant information from the reques
3434

3535
Your browser may have a local cache of the content in question and might not reflect that something has been blocked on the gateways. To avoid browser caching, attempt to view the content using your browser's incognito or private mode. You can also prevent caching issues by using a command-line tool such as Curl or Wget.
3636

37+
### Supported Features
38+
39+
IPFS implementations can support a variety of protocols and specifications. The above public gateways support the following:
40+
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: https://specs.ipfs.tech/http-gateways/trustless-gateway/
43+
44+
They support HTTP clients reaching them over both ipv4 and ipv6 addresses
45+
46+
The underlying IPFS nodes backing the gateways support the following mutable identifiers under the `/ipns` namespace:
47+
- IPNS Public Keys
48+
- DNSLink for all IANA registered domains as well as .crypto and .eth
49+
50+
The underlying IPFS nodes backing the gateways support retrieving data from peers that:
51+
- 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
53+
- Support one of the following libp2p transport configurations:
54+
- QUIC-v1
55+
- TCP or WS or WSS, Yamux, TLS or Noise
56+
- WebTransport
57+
- Support the Bitswap protocol (any versions 1 through 1.2)
58+
- Have either advertised their data to the Amino DHT, or have advertised to IPNI such that their data has been indexed by cid.contact
59+
3760
## Other Public Gateways
3861

3962
Additionally, there's a community-maintained [tool for finding and testing public gateways](https://ipfs.github.io/public-gateway-checker/).

0 commit comments

Comments
 (0)