4cabdfefbf
* feat: serveRawBlock implements ?format=block * feat: serveCar implements ?format=car * feat(gw): ?format= or Accept HTTP header - extracted file-like content type responses to separate .go files - Accept HTTP header with support for application/vnd.ipld.* types * fix: use .bin for raw block content-disposition .raw may be handled by something, depending on OS, and .bin seems to be universally "binary file" across all systems: https://en.wikipedia.org/wiki/List_of_filename_extensions_(A%E2%80%93E) * refactor: gateway_handler_unixfs.go - Moved UnixFS response handling to gateway_handler_unixfs*.go files. - Removed support for X-Ipfs-Gateway-Prefix (Closes #7702) * refactor: prefix cleanup and readable paths - removed dead code after X-Ipfs-Gateway-Prefix is gone (https://github.com/ipfs/go-ipfs/issues/7702) - escaped special characters in content paths returned with http.Error making them both safer and easier to reason about (e.g. when invisible whitespace Unicode is used)
3.7 KiB
Gateway
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.
By default, go-ipfs nodes run a gateway at http://127.0.0.1:8080/.
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.
Configuration
The gateway's configuration options are (briefly) described in the config documentation.
Debug
The gateway's log level can be changed with this command:
> ipfs log level core/server debug
Directories
For convenience, the gateway (mostly) acts like a normal web-server when serving a directory:
- If the directory contains an
index.htmlfile: - If the path does not end in a
/, append a/and redirect. This helps avoid serving duplicate content from different paths.† - Otherwise, serve the
index.htmlfile. - Dynamically build and serve a listing of the contents of the directory.
†This redirect is skipped if the query string contains a
go-get=1 parameter. See PR#3964
for details
Static Websites
You can use an IPFS gateway to serve static websites at a custom domain using DNSLink. See Example: IPFS Gateway for instructions.
Filenames
When downloading files, browsers will usually guess a file's filename by looking
at the last component of the path. Unfortunately, when linking directly to a
file (with no containing directory), the final component is just a CID
(Qm...). This isn't exactly user-friendly.
To work around this issue, you can add a filename=some_filename parameter to
your query string to explicitly specify the filename. For example:
https://ipfs.io/ipfs/QmfM2r8seH2GiRaC4esTjeraXEachRt8ZsSeGaWTPLyMoG?filename=hello_world.txt
When you try to save above page, you browser will use passed filename instead of a CID.
Downloads
It is possible to skip browser rendering of supported filetypes (plain text,
images, audio, video, PDF) and trigger immediate "save as" dialog by appending
&download=true:
Response Format
An explicit response format can be requested using ?format=raw|car|.. URL parameter,
or by sending Accept: application/vnd.ipld.{format} HTTP header with one of supported content types.
Content-Types
application/vnd.ipld.raw
Returns a byte array for a single raw block.
Sending such requests for /ipfs/{cid} allows for efficient fetch of blocks with data
encoded in custom format, without the need for deserialization and traversal on the gateway.
This is equivalent of ipfs block get.
application/vnd.ipld.car
Returns a CAR stream for specific DAG and selector.
Right now only 'full DAG' implicit selector is implemented. Support for user-provided IPLD selectors is tracked in https://github.com/ipfs/go-ipfs/issues/8769.
This is a rough equivalent of ipfs dag export.
Deprecated Subset of RPC API
For legacy reasons, the gateway port exposes a small subset of RPC API under /api/v0/.
While this read-only API exposes a read-only, "safe" subset of the normal API,
it is deprecated and should not be used for greenfield projects.
Where possible, leverage /ipfs/ and /ipns/ endpoints.
along with application/vnd.ipld.* Content-Types instead.