A lightweight IPFS Gateway daemon backed by a remote data store.
IPFS Stewards
bifrost-gateway provides a single binary daemon implementation of HTTP+Web Gateway Specs.
It is capable of serving requests to:
- path gateway at
127.0.0.1 - subdomain gateway requests with
Host: localhost - DNSLink gateway based on
Hostheader
Supported response types include both deserialized flat files, and verifiable Block/CAR.
For more information about IPFS Gateways, see:
- Specifications at specs.ipfs.tech/http-gateways
- Conformance tests at ipfs/gateway-conformance
- Go implementation at boxo/gateway
$ go build
$ ./bifrost-gateway --helpSee ./bifrost-gateway --help and ./docs/environment-variables.md
Official Docker images are provided at hub.docker.com/r/ipfs/bifrost-gateway.
- 🟢 Releases
latestandreleasealways point at the latest releasevN.N.Npoint at a specific release tag
- 🟠 Developer builds
main-latestalways points at theHEADof themainbranchmain-YYYY-DD-MM-GITSHApoints at a specific commit from themainbranch
⚠️ Experimental, unstable buildsstaging-latestalways points at theHEADof thestagingbranchstaging-YYYY-DD-MM-GITSHApoints at a specific commit from thestagingbranch- This tag is used by developers for internal testing, not intended for end users
When using Docker, make sure to pass necessary config via -e:
$ docker pull ipfs/bifrost-gateway:release
$ docker run --rm -it --net=host -e PROXY_GATEWAY_URL=http://127.0.0.1:8080 ipfs/bifrost-gateway:releaseSee ./docs/environment-variables.md.
All you need is a trustless gateway endpoint that supports verifiable response types.
To run against a compatible, local trustless gateway provided by Kubo or IPFS Desktop:
$ PROXY_GATEWAY_URL="http://127.0.0.1:8080" ./bifrost-gatewaySee Proxy Backend in ./docs/environment-variables.md
Saturn is a CDN that provides a pool of trustless gateways.
bifrost-gateway supports it via the Caboose backend,
which takes care of discovering and evaluating Block/CAR gateways (in Saturn called L1 nodes/peers) for increased availability.
See Saturn Backend in ./docs/environment-variables.md
See GOLOG_LOG_LEVEL.
This is WIP, but the high level architecture is:
graph LR
A(((fa:fa-person HTTP</br>clients)))
B[bifrost-gateway]
N[[fa:fa-hive bifrost-infra:<br>HTTP load-balancers<br> nginx, TLS termination]]
S(((saturn.pl<br>CDN)))
A -->| Accept: text/html, *| N
A -->| Accept: application/vnd.ipld.raw | N
A -->| Accept: application/vnd.ipld.car | N
A -->| Accept: application/vnd.ipld.dag-json | N
A -->| Accept: application/vnd.ipld.dag-cbor | N
A -->| Accept: application/json | N
A -->| Accept: application/cbor | N
A -->| Accept: application/x-tar | N
A -->| Accept: application/vnd.ipfs.ipns-record | N
A -->| DNSLink Host: en.wikipedia-on-ipfs.org | N
A -->| Subdomain Host: cid.ipfs.dweb.link | N
N --> B
B --->|fa:fa-cube HTTP GET Block x N | S
B ..->|fa:fa-cubes TBD HTTP GET CAR x N | S
bifrost-gateway nodes are responsible for processing requests to:
- path gateway at
ipfs.io - subdomain gateway at
dweb.link - selected DNSLink websites on their own domain names.
Caveats:
- IPFS Gateway interface based on reference implementation from boxo/gateway.
- IPFS Backend based on https://saturn.tech and HTTP client talking to it via caboose with
STRN_LOGGER_SECRET.- Learn more at Project Rhea (decentralized IPFS gateway)
- Functional gaps facilitated by temporary delegation to legacy Kubo RPC (
/api/v0) athttps://node[0-3].delegate.ipfs.ioinfra (already used by js-ipfs).
For tracing configuration, please check: https://github.com/ipfs/boxo/blob/main/docs/tracing.md - this includes
how to generate a traceparent header in order to be able to easily identify specific requests.
Contributions are welcome! This repository is part of the IPFS project and therefore governed by our contributing guidelines.