IPFS Naming - Quickstart

Created by Protocol Labs, InterPlanetary File System (IPFS) is a decentralized protocol used to store and share content.

Scaleway IPFS Naming allows you to create a key to point to your latest update, and above all maintain this information on the IPFS network and share it through Distributed Hash Tables (DHTs), giving you an extra layer of performance in the region of your choice. This way your records remain available and accessible, even when your local machine is offline.

In this quickstart, we will show you how to create and import an IPNS key and update your records using Scaleway IPFS Naming.

Before you start

To complete the actions presented below, you must have:

• A Scaleway account logged into the console
• Owner status or IAM permissions allowing you to perform actions in the intended Organization
• A valid API key

How to create a key

1. Click IPFS Naming in the Labs section of the Scaleway console side menu. The IPFS Naming section displays.
2. Click Create a Key to create a key, which corresponds to the keys you will create to manage your records.
3. Choose a region for the keys.
4. Enter a description for the keys.
5. Click Auto Generated.
6. Enter a value for the keys.
   Note

   The value must be an IPNS key or a CID.

7. Click Create a Name.

How to import your key

1. Click IPFS Naming in the Labs section of the Scaleway console side menu. The IPFS Naming section displays.
2. Click Create a Key to create a key, which corresponds to the keys you will create to manage your records.
3. Choose a region for the keys.
4. Enter a description for the keys.
5. Click Import Key under Choose a key type.
6. Enter a value for the key.
   Important

   The key must be in base64 format.

7. Click on Download key and choose the file containing your private key.
   Note

   You can use ipfs key export $NAME_KEY to generate the file.

8. Enter a value for the keys.
   Note

   The value must be an IPNS key or a CID.

9. Click Create a Name.

How to update your name / record

1. Click IPFS Naming in the Labs section of the Scaleway console side menu. The IPFS Naming section displays.
2. Click on the resource name to access the record information page.
3. Click on Update Value and set your new value.