Skip to content
This repository was archived by the owner on Jun 2, 2020. It is now read-only.

Commit dbbee50

Browse files
authored
Merge pull request #105 from rjharmon/patch-3
Create concept doc for pinning (for #94)
2 parents a92f8ee + 572ad98 commit dbbee50

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

content/guides/concepts/pinning.md

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
title: "Pinning"
3+
menu:
4+
guides:
5+
parent: concepts
6+
---
7+
8+
IPFS nodes treat the data they store like a cache, meaning that there is no guarantee that the data will continue to be stored. Pinning a CID tells an IPFS server that the data is important and mustn't be thrown away.
9+
10+
You should pin any content you consider important, to ensure that content is retained long-term. Since data important to someone else may not be important to you, pinning lets you have control over the disk space and data retention you need.
11+
12+
## Context
13+
14+
Your IPFS node can store data based on different kinds of user events. For instance, you can add a file with `ipfs add ...`. It will also store data you request, such as by loading a web page through the gateway (`http://localhost:8080/ipfs/QmXoypizjW3WknFiJnKLwHCnL72vedxjQkDDP1mXWo6uco`) or with `ipfs cat ...`. Your node will consult with other IPFS peers to find these requested data, and will store the results in the local cache. `ipfs add` will automatically pin the content, but other IPFS commands do not include automatic pinning.
15+
16+
When garbage collection is triggered on a node, any pinned content is automatically exempt from deletion. Non-pinned data may be deleted; if you request it again later, the data can be retrieved from another node.
17+
18+
## Pinning Services
19+
20+
To ensure that your important data is retained, you may want to use a pinning service. Such a service normally trades money for the service of guaranteeing they'll keep your data pinned. Some cases where this might be important to you:
21+
22+
* You don’t have a lot of disk space, but you want to ensure some data sticks around.
23+
* Your computer is a laptop, phone, or tablet that will have intermittent connectivity to the network, but you want to be able to access your data on IPFS from anywhere at any time, even when the device you added it from is offline.
24+
* You want a backup that ensures your data is always available from another computer on the network in case you accidentally delete or garbage-collect on your own computer.

0 commit comments

Comments
 (0)