Skip to content
This repository has been archived by the owner on Jan 5, 2024. It is now read-only.

Commit

Permalink
gateway-docs
Browse files Browse the repository at this point in the history
  • Loading branch information
saminacodes committed Sep 10, 2023
1 parent 28c1e79 commit af51641
Show file tree
Hide file tree
Showing 6 changed files with 54 additions and 1 deletion.
31 changes: 31 additions & 0 deletions docs/onboarding/21 Gateway/0 Overview.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
slug: /gateway
title: Overview
hide_title: true
---

# Overview

A gateway is a server that acts as an intermediary between a client and a decentralized storage network. It allows users to access and retrieve data stored on the network.

### Features

- **Save Development Time:** Simplify decentralized file management by serving as an intermediary between clients and the storage network, reducing the need for multiple IPFS gateways and streamlining development.
- **Faster and high availability: E**nable fast downloads for decentralized storage through a reliable global infrastructure, simplifying data access and retrieval.
- **Censorship resistant:** Store your data with greater privacy and security using our decentralized storage solution.

### Pricing & Billing

**Free Tier**

- Ideal for small teams and individuals who require basic features.
- **Features:**
- 100 requests per second rate limit

**Pro** Tier

- Ideal for teams that require a higher level of customization and support
- **Features:**
- 100 requests per second rate limit

If you're interested in upgrading your gateway limits, you can find more information on the different tiers by visiting [thirdweb's pricing page](https://thirdweb.com/pricing).
9 changes: 9 additions & 0 deletions docs/onboarding/21 Gateway/1 How It Works.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# How it works

To read data from IPFS, you need an [IPFS Gateway](https://docs.ipfs.tech/concepts/ipfs-gateway/). This allows you to access data from the IPFS protocol on browsers and other HTTP clients, such as when building an application using the Contract [SDK](https://portal.thirdweb.com/sdks).

When a user requests data from the network, the request is sent to the gateway. The gateway then retrieves the data from the decentralized storage network and returns it to the user.

![Gatway relationship between user and decentralized storage](./assets/gateway.png)

For developers, Gateway reduces the complexity of decentralized file management which requires fetching from multiple IPFS gateways.`
Binary file added docs/onboarding/21 Gateway/assets/gateway.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
12 changes: 12 additions & 0 deletions sidebars/onboarding.js
Original file line number Diff line number Diff line change
Expand Up @@ -123,6 +123,11 @@ const sidebars = {
label: "Storage",
href: "/storage",
},
{
type: "link",
label: "Gateway",
href: "/gateway",
},
{
type: "link",
label: "Wallet SDK",
Expand Down Expand Up @@ -346,6 +351,13 @@ const sidebars = {
},
],

gateway: [
{
type: "autogenerated",
dirName: "21 Gateway",
},
],

dashboard: [
{
type: "autogenerated",
Expand Down
1 change: 1 addition & 0 deletions src/theme/DocSidebarItem/Link/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ export const iconMapping = {
Guides: "/assets/resources/guides.svg",
CLI: "/assets/product/CLI.png",
Glossary: "/assets/icons/journal-album.svg",
Gateway: "/assets/product/sdk.png",
};

export default function DocSidebarItemLink({
Expand Down
2 changes: 1 addition & 1 deletion src/theme/DocSidebarItems/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ function DocSidebarItems({ items, ...props }) {
},
{
title: "Infrastructure",
items: ["Storage"],
items: ["Storage", "Gateway"],
},
{
title: "Tools",
Expand Down

0 comments on commit af51641

Please sign in to comment.