Skip to content

Commit d6de97b

Browse files
authored
docs: gateway.md (#8825)
Adds link to relevant pages at docs.ipfs.io
1 parent d928870 commit d6de97b

File tree

1 file changed

+19
-8
lines changed

1 file changed

+19
-8
lines changed

docs/gateway.md

+19-8
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,30 @@
22

33
An IPFS Gateway acts as a bridge between traditional web browsers and IPFS.
44
Through the gateway, users can browse files and websites stored in IPFS as if
5-
they were stored in a traditional web server.
5+
they were stored in a traditional web server.
66

7-
By default, go-ipfs nodes run a gateway at `http://127.0.0.1:8080/`.
7+
[More about Gateways](https://docs.ipfs.io/concepts/ipfs-gateway/) and [addressing IPFS on the web](https://docs.ipfs.io/how-to/address-ipfs-on-web/).
88

9-
We also provide a public gateway at `https://ipfs.io`. If you've ever seen a
10-
link in the form `https://ipfs.io/ipfs/Qm...`, that's being served from *our*
11-
gateway.
9+
### Local gateway
10+
11+
By default, go-ipfs nodes run
12+
a [path gateway](https://docs.ipfs.io/how-to/address-ipfs-on-web/#path-gateway) at `http://127.0.0.1:8080/`
13+
and a [subdomain gateway](https://docs.ipfs.io/how-to/address-ipfs-on-web/#subdomain-gateway) at `http://localhost:8080/`
14+
15+
Additional listening addresses and gateway behaviors can be set in the [config](#configuration) file.
16+
17+
### Public gateways
18+
19+
Protocol Labs provides a public gateway at `https://ipfs.io` (path) and `https://dweb.link` (subdomain).
20+
If you've ever seen a link in the form `https://ipfs.io/ipfs/Qm...`, that's being served from *our* gateway.
21+
22+
There is a list of third-party public gateways provided by the IPFS community at https://ipfs.github.io/public-gateway-checker/
1223

1324
## Configuration
1425

15-
The gateway's configuration options are (briefly) described in the
26+
The `Gateway.*` configuration options are (briefly) described in the
1627
[config](https://github.com/ipfs/go-ipfs/blob/master/docs/config.md#gateway)
17-
documentation.
28+
documentation, including a list of common [gateway recipes](https://github.com/ipfs/go-ipfs/blob/master/docs/config.md#gateway-recipes).
1829

1930
### Debug
2031
The gateway's log level can be changed with this command:
@@ -40,7 +51,7 @@ for details</sub>
4051
## Static Websites
4152

4253
You can use an IPFS gateway to serve static websites at a custom domain using
43-
[DNSLink](https://dnslink.io). See [Example: IPFS
54+
[DNSLink](https://docs.ipfs.io/concepts/glossary#dnslink). See [Example: IPFS
4455
Gateway](https://dnslink.io/#example-ipfs-gateway) for instructions.
4556

4657
## Filenames

0 commit comments

Comments
 (0)