opensource/kubo
1
0
Fork 0
mirror of https://github.com/ipfs/kubo.git synced 2025-05-21 17:08:13 +08:00
Code Issues Projects Releases Wiki Activity

docs: gateway.md (#8825)

Browse Source 
Adds link to relevant pages at docs.ipfs.io
This commit is contained in:
Marcin Rataj
2022-03-28 16:31:36 +02:00
committed by GitHub
parent d92887086f
commit d6de97b417
1 changed files with 19 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
docs/gateway.md
View File

@ -4,17 +4,28 @@ 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 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 ### Local gateway
link in the form `https://ipfs.io/ipfs/Qm...`, that's being served from *our*
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 ## 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) [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 ### Debug
The gateway's log level can be changed with this command: The gateway's log level can be changed with this command:
@ -40,7 +51,7 @@ for details</sub>
## Static Websites ## Static Websites
You can use an IPFS gateway to serve static websites at a custom domain using 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. Gateway](https://dnslink.io/#example-ipfs-gateway) for instructions.
## Filenames ## Filenames