From de755c1df40d2a6ffbf35953f72ee290f8084e6e Mon Sep 17 00:00:00 2001 From: Aayush Date: Sat, 20 May 2023 13:22:45 +0530 Subject: [PATCH] Adds docs for IPFS gateway (#32) * Add IPFS Gateway docs * Add gateways to quick start * Add two more points to benefits section --- components/quick-start.tsx | 10 ++++++-- package.json | 2 +- pages.config.ts | 1 + pages/_meta.json | 1 + pages/gateways.mdx | 49 ++++++++++++++++++++++++++++++++++++++ 5 files changed, 60 insertions(+), 3 deletions(-) create mode 100644 pages/gateways.mdx diff --git a/components/quick-start.tsx b/components/quick-start.tsx index 0b92ab94..7eb708d8 100644 --- a/components/quick-start.tsx +++ b/components/quick-start.tsx @@ -26,17 +26,23 @@ const QUICK_START_LIST = [ title: "Compute", body: "Deploy compute instances with one click.", }, + { + path: "/gateways", + emoji: "⛩ī¸", + title: "Gateways", + body: "Fast & reliable access to pinned content.", + }, { path: "/framework-guide", emoji: "📍", title: "Framework Guide", - body: "Discover the steps to deploy your framework.", + body: "Learn how to deploy your framework.", }, { path: "/server-guide", emoji: "📌", title: "Server Guide", - body: "Discover the steps to deploy your server.", + body: "Learn how to deploy your server.", }, { path: "/rest-api", diff --git a/package.json b/package.json index 7b299dbc..020cf547 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "docs", - "version": "0.0.1", + "version": "1.9.0", "description": "Documentation", "scripts": { "dev": "next dev", diff --git a/pages.config.ts b/pages.config.ts index e61daf44..e7eec0e7 100644 --- a/pages.config.ts +++ b/pages.config.ts @@ -37,6 +37,7 @@ export const Pages = [ ["Instance Domains", "/compute/instance/domain"], ["Instance Settings", "/compute/instance/settings"], ["Compute Usage", "/compute/usage"], + ["Gateways", "/gateways"], ["Framework Guide", "/framework-guide"], ["Deploy Angular App", "/framework-guide/deploy-angular"], ["Deploy Brunch App", "/framework-guide/deploy-brunch"], diff --git a/pages/_meta.json b/pages/_meta.json index db239788..895a09c3 100644 --- a/pages/_meta.json +++ b/pages/_meta.json @@ -4,6 +4,7 @@ "organization": "Organization", "static": "Static App", "compute": "Compute", + "gateways": "Gateways", "framework-guide": "Framework Guide", "server-guide": "Server Guide", "rest-api": "Spheron API", diff --git a/pages/gateways.mdx b/pages/gateways.mdx new file mode 100644 index 00000000..52c105e0 --- /dev/null +++ b/pages/gateways.mdx @@ -0,0 +1,49 @@ +import Navigation from "components/navigation"; + +# Dedicated Gateways + +Dedicated Gateways are private IPFS gateways specifically designed to enhance access to pinned content by offering faster speeds and +increased rate limits. They ensure a more reliable and consistent experience when accessing and serving content on the IPFS network. + +## Benefits of Dedicated Gateways + +Using Dedicated Gateways offers several benefits: + +- **Improved Speed:** Dedicated Gateways provide faster speeds for accessing content on the IPFS network, resulting in quicker loading times and better user experiences. +- **Increased Rate Limits:** With Dedicated Gateways, you can enjoy higher rate limits, allowing for more efficient content delivery and reduced bottlenecks. +- **Whitelabeling Gateway:** Customize and brand your gateway with your own subdomain, allowing for a professional touch to your content delivery. +- **Serve Content from Any IPFS Node:** You have the flexibility to upload your content on any platform of your choice and effortlessly serve it through your dedicated gateway. There's no need to upload exclusively on Spheron. + +## Create a Dedicated Gateway + +Follow these steps to create a Dedicated Gateway: + +1. Log in to Spheron and navigate to the **Gateways** section in the navbar. +2. Click **Generate** to create a new gateway. +3. Enter a name for your gateway and Click **Create**. + +You will be able to view your newly created gateway in the **All Gateways** table. + +## All Gateways + +The All Gateways table provides you with the following information: + +- **Name:** The URL to access your gateway. +- **Requests:** The number of hits on the gateway. +- **Bandwidth:** The rate of data transfer across the gateway. +- **Created:** The date when the gateway was created. + +## How to Use Your Gateway? + +To access content through your Dedicated Gateway, simply follow these steps: + +1. Obtain the CID (Content Identifier) of the file you wish to view. +2. Append the CID to your gateway URL in the following format: + +``` +https://{gateway-name}.spheron.link/ipfs/{cid} +``` + +That's it! You can now effortlessly view content using your Dedicated Gateway. + +