Skip to content

Commit

Permalink
Adds docs for IPFS gateway (#32)
Browse files Browse the repository at this point in the history
* Add IPFS Gateway docs

* Add gateways to quick start

* Add two more points to benefits section
  • Loading branch information
aayushmahapatra authored May 20, 2023
1 parent 91be31a commit de755c1
Show file tree
Hide file tree
Showing 5 changed files with 60 additions and 3 deletions.
10 changes: 8 additions & 2 deletions components/quick-start.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "docs",
"version": "0.0.1",
"version": "1.9.0",
"description": "Documentation",
"scripts": {
"dev": "next dev",
Expand Down
1 change: 1 addition & 0 deletions pages.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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"],
Expand Down
1 change: 1 addition & 0 deletions pages/_meta.json
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
49 changes: 49 additions & 0 deletions pages/gateways.mdx
Original file line number Diff line number Diff line change
@@ -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.

<Navigation name="Gateways" />

0 comments on commit de755c1

Please sign in to comment.