Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename this package (?), clarify what's in scope, and describe how to configure #12

Open
2 of 3 tasks
Tracked by #275
BigLep opened this issue Oct 17, 2023 · 0 comments
Open
2 of 3 tasks
Tracked by #275
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@BigLep
Copy link

BigLep commented Oct 17, 2023

Naming

Is the focus of this repo really around "Docker images for Helia"?

From my poking, it seems like the real value of this repo is that it implements some of the HTTP Gateway APIs and uses Helia behind the scenes. One of the ways we package/distribute this is via Docker.

As a result, maybe call this helia-http-gateway ?

(This is similar to https://github.com/ipfs/bifrost-gateway. It has Docker distribution, but the defining attribute is that it provides "a lightweight IPFS Gateway daemon backed by a remote data store."

Scope

  1. Can we denote how much of https://specs.ipfs.tech/http-gateways/ we're attempting to implement currently?
  2. Lets also call out what of https://docs.ipfs.tech/reference/kubo/rpc/ we're implementing
  3. (I thought I saw it mentioned somewhere, but can't find it now.). Can we hook up the HTTP Gateway Conformance test suite to this? That is the canonical way to show how much this package supports. (Lets create a tracking issue for this if we don't have one.)

Configurability

How does someone customize the Helia config that is used? I have no expertise on how much configurability should be allowed outside of the docker image build vs. asking users to create their own docker image. That said, we're definitely going to want configurability here (e.g., run this with "trustless gateway fallback" enable and disabled.)

Tasks

Preview Give feedback
@BigLep BigLep changed the title Rename this package (?) and clarify what's in scope Rename this package (?), clarify what's in scope, and describe how to configure Oct 17, 2023
@whizzzkid whizzzkid self-assigned this Oct 18, 2023
@SgtPooki SgtPooki self-assigned this Oct 27, 2023
@SgtPooki SgtPooki added documentation Improvements or additions to documentation enhancement New feature or request labels Oct 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants