Skip to content
This repository has been archived by the owner on Jun 20, 2024. It is now read-only.

Commit

Permalink
docs: cleanup outdated info
Browse files Browse the repository at this point in the history
  • Loading branch information
lidel committed Oct 11, 2023
1 parent f0bcbcb commit 4029475
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 9 deletions.
15 changes: 9 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,12 @@ bifrost-gateway
- [Configuration](#configuration)
- [Docker](#docker)
- [FAQ](#faq)
- [How to run with local gateway as a backend](#how-to-run-with-local-gateway-as-a-backend)
- [How to use other gateway as a block backend](#how-to-use-other-gateway-as-a-block-backend)
- [How to run with Saturn CDN backend](#how-to-run-with-saturn-cdn-backend)
- [How to debug](#how-to-debug)
- [How to use tracing](#how-to-use-tracing)
- [How does this work at ipfs.io and dweb.link](#how-does-this-work-at-ipfsio-and-dweblink)
- [How could this work for hosting a public IPFS gateway](#how-could-this-work-for-hosting-a-public-ipfs-gateway)
- [How does high level overview look like](#how-does-high-level-overview-look-like)
- [Contributing](#contributing)
- [License](#license)

Expand Down Expand Up @@ -111,7 +112,7 @@ on how to generate the `traceparent` HTTP header in order to be able to easily
identify specific requests.


### How does this work at ipfs.io and dweb.link
### How could this work for hosting a public IPFS gateway

This is WIP, but the high level architecture is to move from

Expand Down Expand Up @@ -182,16 +183,18 @@ graph LR

`bifrost-gateway` nodes are responsible for processing requests to:

- [path gateway](https://docs.ipfs.tech/how-to/address-ipfs-on-web/#path-gateway) at `ipfs.io`
- [subdomain gateway](https://docs.ipfs.tech/how-to/address-ipfs-on-web/#subdomain-gateway) at `dweb.link`
- [path gateway](https://docs.ipfs.tech/how-to/address-ipfs-on-web/#path-gateway) (like `ipfs.io`)
- [subdomain gateway](https://docs.ipfs.tech/how-to/address-ipfs-on-web/#subdomain-gateway) (like `dweb.link`)
- [selected DNSLink websites](https://github.com/protocol/bifrost-infra/blob/b6f85a54fddf1c21a966f8d5e5a3e31f54ad5431/ansible/inventories/bifrost/group_vars/collab_cluster.yml#L140-L271) on their own domain names.

Caveats:

- IPFS Gateway interface based on reference implementation from [boxo/gateway](https://github.com/ipfs/boxo/tree/main/gateway#readme).
- IPFS Backend based on https://saturn.tech and HTTP client talking to it via [caboose](https://github.com/filecoin-saturn/caboose) with `STRN_LOGGER_SECRET`.
- Learn more at [Project Rhea (decentralized IPFS gateway)](https://pl-strflt.notion.site/Project-Rhea-decentralized-IPFS-gateway-3d5906e7a0d84bea800d5920005dfea6)
- Functional gaps facilitated by temporary delegation to legacy Kubo RPC (`/api/v0`) at `https://node[0-3].delegate.ipfs.io` infra (already used by js-ipfs).
- Remaining functional gaps facilitated by:
- (initially) temporary delegation to legacy Kubo RPC (`/api/v0`) at `https://node[0-3].delegate.ipfs.io` infra (legacy nodes used by js-ipfs, in process of deprecation).
- (long-term) `IPNS_RECORD_GATEWAY_URL` endpoint capable of resolving `GET /ipns/{name}` with `Accept: application/vnd.ipfs.ipns-record`

### How does high level overview look like

Expand Down
9 changes: 6 additions & 3 deletions docs/environment-variables.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,12 @@

### `KUBO_RPC_URL`

Single URL or a comma separated list of RPC endpoints that provide `/api/v0` from Kubo.
This is used to redirect legacy `/api/v0` commands that need to be handled on `ipfs.io`.
If this is not set, the redirects are not set up.
Single URL or a comma separated list of RPC endpoints that provide `/api/v0` RPC from Kubo.

The URL will be used for handling a subset of legacy `/api/v0` commands,
and also for IPNS Record resolution (via `/api/v0/dht/query` RPC).

If this is not set, the `/api/v0` is not exposed, and `IPNS_RECORD_GATEWAY_URL` has to be set for IPNS resolution to work.

### `BLOCK_CACHE_SIZE`

Expand Down

0 comments on commit 4029475

Please sign in to comment.