Skip to content

Commit 100b14f

Browse files
committed
update README to reflect IPIP-280 gateway selection
1 parent af7ac4f commit 100b14f

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,10 @@ with fsspec.open("ipfs://QmZ4tDuvesekSs4qM5ZBKpXiZGun7S2CYtEZRB3DYXkjGx", "r") a
2020
print(f.read())
2121
```
2222

23-
The current implementation uses a HTTP gateway to access the data. It tries to use a local one (which is expected to be found at `http://127.0.0.1:8080`) and falls back to `ipfs.io` if the local gateway is not available.
23+
The current implementation uses a HTTP gateway to access the data. It uses [IPIP-280](https://github.com/ipfs/specs/pull/280) to determine which gateway to use. If you have a current installation of an IPFS node (e.g. kubo, IPFS Desktop etc...), you should be fine. In case you want to use a different gateway, you can use any of the methods specified in IPIP-280, e.g.:
2424

25-
You can modify the list of gateways using the space separated environment variable `IPFSSPEC_GATEWAYS`.
25+
* create the file `~/.ipfs/gateway` with the gateway address as first line
26+
* define the environment variable `IPFS_GATEWAY` to the gateway address
27+
* create the file `/etc/ipfs/gateway` with the gateway address as first line
28+
29+
No matter which option you use, the gateway has to be specified as an HTTP(S) url, e.g.: `http://127.0.0.1:8080`.

0 commit comments

Comments
 (0)