From e2830bf90fd7e60e018840a0f646a319d3a0be72 Mon Sep 17 00:00:00 2001 From: Marcin Rataj Date: Sat, 26 Mar 2022 01:34:56 +0100 Subject: [PATCH] docs: gateway.md Adds link to relevant pages at docs.ipfs.io --- docs/gateway.md | 27 +++++++++++++++++++-------- 1 file changed, 19 insertions(+), 8 deletions(-) diff --git a/docs/gateway.md b/docs/gateway.md index fcfbed36595..0abcb2c0005 100644 --- a/docs/gateway.md +++ b/docs/gateway.md @@ -2,19 +2,30 @@ An IPFS Gateway acts as a bridge between traditional web browsers and IPFS. Through the gateway, users can browse files and websites stored in IPFS as if -they were stored in a traditional web server. +they were stored in a traditional web server. -By default, go-ipfs nodes run a gateway at `http://127.0.0.1:8080/`. +[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/). -We also provide a public gateway at `https://ipfs.io`. If you've ever seen a -link in the form `https://ipfs.io/ipfs/Qm...`, that's being served from *our* -gateway. +### Local gateway + +By default, go-ipfs nodes run +a [path gateway](https://docs.ipfs.io/how-to/address-ipfs-on-web/#path-gateway) at `http://127.0.0.1:8080/` +and a [subdomain gateway](https://docs.ipfs.io/how-to/address-ipfs-on-web/#subdomain-gateway) at `http://localhost:8080/` + +Additional listening addresses and gateway behaviors can be set in the [config](#configuration) file. + +### Public gateways + +Protocol Labs provides a public gateway at `https://ipfs.io` (path) and `https://dweb.link` (subdomain). +If you've ever seen a link in the form `https://ipfs.io/ipfs/Qm...`, that's being served from *our* gateway. + +There is a list of third-party public gateways provided by the IPFS community at https://ipfs.github.io/public-gateway-checker/ ## Configuration -The gateway's configuration options are (briefly) described in the +The `Gateway.*` configuration options are (briefly) described in the [config](https://github.com/ipfs/go-ipfs/blob/master/docs/config.md#gateway) -documentation. +documentation, including a list of common [gateway recipes](https://github.com/ipfs/go-ipfs/blob/master/docs/config.md#gateway-recipes). ### Debug The gateway's log level can be changed with this command: @@ -40,7 +51,7 @@ for details ## Static Websites You can use an IPFS gateway to serve static websites at a custom domain using -[DNSLink](https://dnslink.io). See [Example: IPFS +[DNSLink](https://docs.ipfs.io/concepts/glossary#dnslink). See [Example: IPFS Gateway](https://dnslink.io/#example-ipfs-gateway) for instructions. ## Filenames