From 58e255aae27c61beef21181f9e055aad3b36376a Mon Sep 17 00:00:00 2001 From: EricLScace <6785602+EricLScace@users.noreply.github.com> Date: Fri, 10 Apr 2020 14:42:47 -0600 Subject: [PATCH] Clear out reminders from draft Ref #93 --- content/guides/concepts/ipfs-gateway.md | 120 ++++++------------------ 1 file changed, 27 insertions(+), 93 deletions(-) diff --git a/content/guides/concepts/ipfs-gateway.md b/content/guides/concepts/ipfs-gateway.md index 7ccd27b..3754841 100644 --- a/content/guides/concepts/ipfs-gateway.md +++ b/content/guides/concepts/ipfs-gateway.md @@ -14,16 +14,16 @@ related: # IPFS Gateway This document discusses: -* the several types of IPFS gateways; -* their roles in use of IPFS; -* appropriate situations for use of each type of gateway; -* situations when you should avoid use of gateways; -* implementation guidelines. +* the several types of IPFS gateways; +* their roles in use of IPFS; +* appropriate situations for use of each type of gateway; +* situations when you should avoid use of gateways; +* implementation guidelines. You should read this document if you want to: -* understand, at a conceptual level, how gateways fit into the overall use of IPFS; -* decide whether and what type of gateways to deploy for your use case; -* understand how to develop and deploy gateways for your use case. +* understand, at a conceptual level, how gateways fit into the overall use of IPFS; +* decide whether and what type of gateways to deploy for your use case; +* understand how to develop and deploy gateways for your use case. ## What is an IPFS gateway? @@ -33,119 +33,53 @@ ipfs://{contentID} ``` Other tools that rely solely on HTTP(S) (e.g., curl) encounter similar errors in accessing IPFS content in canonical form. -The end stage of IPFS deployment includes native support of IPFS in all browsers/tools. - +The end stage of IPFS deployment includes native support of IPFS in all popular browsers and tools. In the interim, upgrading the browser/tool to support IPFS (e.g., through a browser extension) would resolve IPFS content access errors. -However not every user may be permitted to alter, or be capable of altering, their browser/tool configuration. -IPFS gateways provide an HTTP(S)-based service for such browsers and tools to access IPFS content. +However not every user may be permitted to alter, or be capable of altering, their browser/tool configuration. IPFS gateways provide an HTTP(S)-based service for such browsers and tools to access IPFS content. -The canonical form of access to IPFS gateways is: +The canonical form of access to such IPFS gateways is: ``` https://{gatewayURL}/ipfs/{contentID} ``` -### IPFS gateway types +## Who provides IPFS gateways? -IPFS gateways include: -* the public gateway ipfs.io; -* private or public gateways provided by third parties; e.g., `https://cloudfare.com/ipfs`; -* a gateway installed as a local service on your machine e.g., `localhost:8080`. +IPFS gateway providers include: +* Protocol Labs, which deploys the public gateway ipfs.io; +* Third-party private or public gateways; e.g., `https://cloudfare.com/ipfs`; +* You, with a gateway installed as a local service on your machine e.g., `localhost:8080`. Regardless of who deploys it and where, any IPFS gateway resolves access to any IPFS content ID requested via the canonical HTTP form described above. + +## What types of IPFS gateways exist? + -### Limitations - - - - - - - -## Implementation status - - -## When should a gateway be provided? +## When should a gateway be provided, where, and which type of gateway? ## When not to provide a gateway -## Use cases - -## Further details - - - + +## Use cases -It is assumed that a proliferation of gateway providers and ipfs paths at many different domains would make it less clear to end users and developers what was going on (although ipfs-companion already does a great job of redirecting ipfs addresses from any valid domain). +## Further details + -We also offer it as a "trustable" ipfs gateway. We cannot automatically verify that another gateway is always serving the correct content for a given cid. Using a gateway means placing your trust in the service operator that they will not tamper with the response. Content that is fetched via an ipfs node is always cryptographically validated, but once we switch to using the http-to-ipfs gateway of another node, we lose the end-to-end validation. There is currently no automatic mechanism for validating that an http-to-ipfs gateway is serving the correct content for a given cid, so we provide ipfs.io as the reference gateway. -->