Skip to content

Commit 275dfb0

Browse files
committed
Initial go at the publish guide
1 parent 7dd0675 commit 275dfb0

File tree

4 files changed

+35
-0
lines changed

4 files changed

+35
-0
lines changed

docs/.vuepress/config.js

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,14 @@ module.exports = {
8282
sidebar: {
8383
'/install/': [
8484
['/concepts/what-is-ipfs','Basic Concepts'],
85+
{
86+
title: 'Quickstart',
87+
sidebarDepth: 1,
88+
collapsable: false,
89+
children: [
90+
['/quickstart/publish','Publish to IPFS'],
91+
]
92+
},
8593
{
8694
title: 'Install',
8795
sidebarDepth: 1,
648 KB
Loading
1000 KB
Loading

docs/quickstart/publish.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
title: 'Publish a file to IPFS'
3+
description: 'learn about pinning services and the lifecycle of content-addressed data in IPFS by pinning a file to the IPFS network'
4+
---
5+
6+
# Publish a file to IPFS
7+
8+
In this quickstart guide, you will learn about pinning services and the lifecycle of content-addressed data in IPFS by pinning a file to the IPFS network. By the end of this guide, you should have a better understanding of how content addressing and CIDs work from a high level.
9+
10+
Pinning a file to IPFS is how content is published to IPFS. Any given file can be pinned to multiple IPFS nodes to increase the redundancy and resilience of a file on the network.
11+
12+
To do this, you will use a [pinning service](../concepts/persistence.md#pinning-in-context) called [web3.storage](https://web3.storage/) for this. Pinning services are like hosting services that run an IPFS node for you and ensure your files are available to the IPFS network.
13+
14+
> **Note:** web3.storage was chosen purely for demonstration purposes, and is one of many [pinning services](../concepts/persistence.md#pinning-in-context) you can chose from. While pinning services have different SDKs and APIs, their fundemental role is the same: to store files and make them available to the IPFS network.
15+
16+
In this guide, you will use the web3.storage UI to upload the file. If you prefer uploading with JavaScript or Go, check out the [Web3.storage docs](https://web3.storage/docs/how-tos/store/). Alternatively,with [Filebase](https://filebase.com/) is a pinning service that offers an AWS S3 compatible API for pinning, so you can use any existing tooling
17+
18+
## Prerequisites
19+
20+
- A free [web3.storage](https://web3.storage/) account.
21+
- The following image, downloaded and saved on your computer: ![following image](./images/earth-image.jpg)
22+
23+
## 1. Sign in to web3.storage
24+
25+
Start by signing into your account on web3.storage:
26+
27+
![asfsaf](./images/login-web3-storage.png)

0 commit comments

Comments
 (0)