Skip to content

Commit

Permalink
Apply suggestions from initial docs reveiw
Browse files Browse the repository at this point in the history
  • Loading branch information
ElPaisano authored Aug 3, 2023
1 parent a673e87 commit 02b6074
Showing 1 changed file with 26 additions and 11 deletions.
37 changes: 26 additions & 11 deletions docs/how-to/work-with-pinning-services.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,19 @@ If you've got just one local IPFS node that's always running, local pinning may
- You don't have all the disk space you need on your local node.
- You run more than one IPFS node, and would like to use one of them as a "personal pinning service" as your preferred location for permanent storage.

There are a number of commercial pinning services that make it easy for you to purchase pinning capacity for your important files. Some of the notable services include [Pinata](https://pinata.cloud/), [Filebase](https://filebase.com/), [Temporal](https://temporal.cloud/), [Crust](https://crust.network/), [Infura](https://infura.io/), and others. Each of these third-party services has its own unique interface for pinning files and managing those pins; this could include a GUI, an API, CLI commands, or other tooling.
Third-party pinning services allow you to purchase pinning capacity for important data. Each service has its own approach to pinning data and managing pins, so users should do their research to ensure that the service meets their particular needs. Service providers include, but are not limited to:

- [Pinata](https://pinata.cloud/)
- [Filebase](https://filebase.com/)
- [Temporal](https://temporal.cloud/)
- [Crust](https://crust.network/)
- [Infura](https://infura.io/)

However, you don't need to learn new commands or tools if your pinning service of choice supports the vendor-agnostic [IPFS Pinning Service API](https://ipfs.github.io/pinning-services-api-spec/) specification. Those services are supported within IPFS itself through the command line: `ipfs pin remote --help`.

As of June 2023, [Filebase](https://filebase.com) and [Pinata](https://pinata.cloud/) support the IPFS Pinning Service API endpoint, with more pinning services on the way! [Learn how to create your own](#create-your-own-pinning-service).
[Learn how to create your own →](#create-your-own-pinning-service)
As of June 2023, [Filebase](https://filebase.com) and [Pinata](https://pinata.cloud/) support the [IPFS Pinning Service API endpoint](https://github.com/ipfs/pinning-services-api-spec).

You can also [create your own pinning service](#create-your-own-pinning-service).

## Use an existing pinning service

Expand Down Expand Up @@ -54,14 +61,22 @@ In the next screen, you’ll be asked for a few other details:
- A **nickname** for this service. This can be helpful if, for example, you want to add two accounts from the same service.
- The URL for your service's **API endpoint**.
_Note: This field only appears if you've selected a custom pinning service!_
- Your **secret access token**. This is the unique token provided to you by the pinning service — check its documentation for more info.
_To illustrate, example below shows which value should be copied from [pinata.cloud/keys](https://pinata.cloud/keys)_
> ![Pinata secret access token](./images/work-with-pinning-services/add-service-pinata-token.jpg)
_Note: Since some dashboards look different on the surface, this is an illustration example showing which values should be copied from
[console.filebase.com/keys](https://console.filebase.com/keys)._
> ![Filebase secret access token](./images/work-with-pinning-services/add-service-filebase-token.png)
After you hit **Save**, you’ll see your new pinning service added to the **Pinning Services** section of your **Settings** screen.
- You **secret access token**: The unique token provided to you by the pinning service — see the specific pinning service documentation for more info.

##### Pinata example

Consider the following example, which illustrates which values from [pinata.cloud/keys] are copied into the Pinata pinning service UI:

![Pinata secret access token](./images/work-with-pinning-services/add-service-pinata-token.jpg)

##### Filebase example

Consider the following example, which demostrates the process for Filebase using

Check failure on line 74 in docs/how-to/work-with-pinning-services.md

View workflow job for this annotation

GitHub Actions / pr-content-check

[vale] reported by reviewdog 🐶 [ipfs-docs-style.PLNSpelling] Did you really mean 'demostrates'? Raw Output: {"message": "[ipfs-docs-style.PLNSpelling] Did you really mean 'demostrates'?", "location": {"path": "docs/how-to/work-with-pinning-services.md", "range": {"start": {"line": 74, "column": 39}}}, "severity": "ERROR"}

Check failure on line 74 in docs/how-to/work-with-pinning-services.md

View workflow job for this annotation

GitHub Actions / pr-content-check

[vale] reported by reviewdog 🐶 [ipfs-docs-style.PLNSpelling] Did you really mean 'demostrates'? Raw Output: {"message": "[ipfs-docs-style.PLNSpelling] Did you really mean 'demostrates'?", "location": {"path": "docs/how-to/work-with-pinning-services.md", "range": {"start": {"line": 74, "column": 39}}}, "severity": "ERROR"}
[console.filebase.com/keys](https://console.filebase.com/keys).

![Filebase secret access token](./images/work-with-pinning-services/add-service-filebase-token.png)

After you click **Save**, your new pinning service is added to the **Pinning Services** section of your **Settings** screen.

> ![Desktop/Web UI Settings screen with a new pinning service added](./images/work-with-pinning-services/added-service.jpg)
Expand Down

0 comments on commit 02b6074

Please sign in to comment.