ipfs-docs icon indicating copy to clipboard operation
ipfs-docs copied to clipboard

How to turn an IPFS node into a gateway node.

Open TheDiscordian opened this issue 4 years ago • 4 comments

I was thinking it might be a good idea to clarify how a user might host their own gateway. It might be clear to some that they can use their go-ipfs node as a public gateway with some configuration, but the concepts/ipfs-gateway write-up doesn't make this explicitly clear. I think it'd be useful to at least make it explicitly clear what software might be used to setup a gateway (or maybe an example setup?).

I thought to ask this because a user asked about how to accomplish this here in #ipfs, and realised that I couldn't seem to locate a resource to point them to that'd offer them immediate clarity.

TheDiscordian avatar Jun 01 '21 23:06 TheDiscordian

Thank you for submitting your first issue to this repository! A maintainer will be here shortly to triage and review. In the meantime, please double-check that you have provided all the necessary information to make this process easy! Any information that can help save additiona round trips is useful! We currently aim to give initial feedback within two business days. If this does not happen, feel free to leave a comment. Please keep an eye on how this issue will be labeled, as labels give an overview of priorities, assignments and additional actions requested by the maintainers:

  • "Priority" labels will show how urgent this is for the team.
  • "Status" labels will show if this is ready to be worked on, blocked, or in progress.
  • "Need" labels will indicate if additional input or analysis is required.

Finally, remember to use https://discuss.ipfs.io if you just need general support.

welcome[bot] avatar Jun 01 '21 23:06 welcome[bot]

Good call. Having this doc would be very handy, especially for folks running local hackathons that want an in-house gateway to run things from! I've put the p2 tag on here for now, but can up the priority if more we find that more folks are requesting it.

johnnymatthews avatar Jun 02 '21 14:06 johnnymatthews

Topics we should cover:

  • path gateway vs subdomain gateway vs dnslink hosting
  • in-depth explainers for common recipes (https://github.com/ipfs/go-ipfs/blob/master/docs/config.md#gateway-recipes)
  • exposing data over HTTP vs running a gateway for hosting of web apps
    • explaining why origin isolation is important for web app hosting
    • why path gateways are not useful for websites (relative path issues, no origin isolation)
    • setting up wildcard subdomains TLS cert for subdomain gateway

I'm around for a review/call/chat if someone wants to pick this up.

lidel avatar Jun 16 '21 23:06 lidel

Note to self: this should also include some protips / FAQ with things like using separate domain name to avoid issues described in https://www.notion.so/pl-strflt/Notes-on-Gateway-e811b958674a41bfb52fe46943123fd2

lidel avatar Feb 16 '22 12:02 lidel