From 6f0fa75b62af234cd0ee5c34a814117bb8988ee9 Mon Sep 17 00:00:00 2001 From: Marco Rodriguez-Salinas Date: Wed, 24 Apr 2024 13:29:22 -0500 Subject: [PATCH 1/4] Added rk1 update video created by Wade --- docs/functionyard/hardware/fxblox-hardware-rk1.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/functionyard/hardware/fxblox-hardware-rk1.md b/docs/functionyard/hardware/fxblox-hardware-rk1.md index e1100a3..e20ad7d 100644 --- a/docs/functionyard/hardware/fxblox-hardware-rk1.md +++ b/docs/functionyard/hardware/fxblox-hardware-rk1.md @@ -2,6 +2,7 @@ title: FxBlox Lite Plus (RK1) id: fxblox-hardware-rk1 --- +import ReactPlayer from 'react-player'; ## Updating Your FxBlox Lite Plus (RK1) @@ -9,6 +10,13 @@ id: fxblox-hardware-rk1 If you were helping test nightly firmware releases **before** official testnet launch, you will be required to format drive to clear out old/incompatible chain data. **See more [details here.](../fxblox-app.md/#format-drive)** ::: +## Video Guide + +
+ +
+ +## Written Guide ### Step 1: Download the Firmware - **Download**: Find `minimal_update.zip` in the [latest release](https://github.com/functionland/rk1-image/releases/latest) under the Assets section on GitHub. As of 13/APR/2024, this is the latest file: https://github.com/functionland/rk1-image/releases/download/v1.54.3/minimal_update.zip From 05447db30793e18b0740af3ce3b0fe68bb139ea6 Mon Sep 17 00:00:00 2001 From: ehsan shariati Date: Sat, 22 Jun 2024 21:15:20 -0400 Subject: [PATCH 2/4] Update fxblox-hardware-rk1.md --- docs/functionyard/hardware/fxblox-hardware-rk1.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/functionyard/hardware/fxblox-hardware-rk1.md b/docs/functionyard/hardware/fxblox-hardware-rk1.md index e1100a3..4b4fbf4 100644 --- a/docs/functionyard/hardware/fxblox-hardware-rk1.md +++ b/docs/functionyard/hardware/fxblox-hardware-rk1.md @@ -11,7 +11,7 @@ If you were helping test nightly firmware releases **before** official testnet l ### Step 1: Download the Firmware -- **Download**: Find `minimal_update.zip` in the [latest release](https://github.com/functionland/rk1-image/releases/latest) under the Assets section on GitHub. As of 13/APR/2024, this is the latest file: https://github.com/functionland/rk1-image/releases/download/v1.54.3/minimal_update.zip +- **Download**: Find `minimal_update.zip` in the [latest release](https://github.com/functionland/rk1-image/releases/latest) under the Assets section on GitHub. As of 22/JUNE/2024, this is the latest file: https://github.com/functionland/rk1-image/releases/download/v1.54.18/minimal_update.zip - **Options**: - Download files with `minimal_` prefix if you do not need a desktop interface (access via Terminal, smaller file size). From 2464c6a9c0bed7c2365ab1a3ed9576f78fc72270 Mon Sep 17 00:00:00 2001 From: ehsan shariati Date: Fri, 28 Jun 2024 12:24:58 -0400 Subject: [PATCH 3/4] Added ipfs pinning service docs --- docs/pinning-service/index.md | 10 +++ .../ipfs-pinning-service-api.md | 82 +++++++++++++++++++ sidebars.js | 11 +++ 3 files changed, 103 insertions(+) create mode 100644 docs/pinning-service/index.md create mode 100644 docs/pinning-service/ipfs-pinning-service-api.md diff --git a/docs/pinning-service/index.md b/docs/pinning-service/index.md new file mode 100644 index 0000000..82fe492 --- /dev/null +++ b/docs/pinning-service/index.md @@ -0,0 +1,10 @@ +--- +title: Welcome +id: index +--- +# Welcome to Functionland + +Functionland was founded on a core set of Web3 principles. At the heart of these principles is a simple premise: **We each have an inalienable right to own our own data.** + +We set out to build a better future around this simple premise. We started by developing an app that liberates a set of "own data" we think is particularly important to people: personal home photos and video. +We also provide and ipfs compatible pinning service, which is the first true decentralized pinning service for ipfs data \ No newline at end of file diff --git a/docs/pinning-service/ipfs-pinning-service-api.md b/docs/pinning-service/ipfs-pinning-service-api.md new file mode 100644 index 0000000..b9b36ca --- /dev/null +++ b/docs/pinning-service/ipfs-pinning-service-api.md @@ -0,0 +1,82 @@ +--- +title: "IPFS Pinning Service API" +id: ipfs-pinning-service-api +slug: "ipfs-pinning-service-api" +excerpt: "" +hidden: false +createdAt: "Fri JUN 28 2024 15:02:42 GMT+0000 (Coordinated Universal Time)" +updatedAt: "Fri JUN 28 2024 18:39:16 GMT+0000 (Coordinated Universal Time)" +--- +Not to be confused with the Fula API, the Pinning Service API allows you to create a link between your local IPFS node and Functionland Fula Network + +## IPFS Pinning Services API Spec Compatibility + +The [IPFS Pinning Services API Spec](https://ipfs.github.io/pinning-services-api-spec/) is a standardized specification for developers building on top of IPFS that allows an application to integrate a pinning service without needing to learn that pinning service's unique API. + +### Introduction + +Functionland Fula network is the only available true decentralized network for pinning ipfs data. It currently includes 900 globally distributed nodes. These nodes are individually owned and are rewarded using Fula blockchain based on the storage they provide. Since it is an open network, anyone can join and start providing the service and earns. For more information please visit https://fx.land + + + +### Endpoints + +Functionland Fula users looking to utilize the IPFS Pinning Services API can do so from our dedicated API endpoint: + +`https://api.cloud.fx.land` + + +### Authentication + +To authenticate with Functionland through the Pinning Services API spec, you'll first need to have an `accessToken`. You can create this API token on the [Fula Keys Page](https://cloud.fx.land/) (Invite-Only as of this date) + +When you create a new API key, you'll need to take note of the JWT ([JSON Web Token](https://jwt.io/)) token that's shown to you immediately after creation. This JWT is specific to the API key and shares the same permissions. + +If you ever revoke the API key for this JWT, this JWT will no longer be valid for authenticating to the Pinning Services API. + +**Configuring Functionland Fula in the IPFS Desktop App** + +If you are running the IPFS desktop app, you can configure your pinning service of choice within the user interface. To do so, open the app, go to your Preferences, then click Add Service: + + + +Select Functionland as the pinning service, and then configure with your secret access token (JWT): + + + +From there you can upload files and have the option to pin locally as well as remotely to Functionland Fula network! + + +### Configuring Functionland Fula in the IPFS CLI + +You can also pin to Functionland Fula directly from the IPFS CLI using the `ipfs` command. + +To add Functionland Fula credentials, use the following command (where YOUR\_JWT is the JWT token described in the “Authentication” section above): + +```bash +ipfs pin remote service add functionland https://api.cloud.fx.land YOUR_JWT +``` + +To pin a CID to Functionland Fula under a human-readable name: + +```bash +ipfs pin remote add --service=functionland --name=war-and-peace.txt bafybeib32tuqzs2wrc52rdt56cz73sqe3qu2deqdudssspnu4gbezmhig4 +``` + +To list successful pins: + +```bash +ipfs pin remote ls --service=functionland +``` + +To list pending pins: + +```bash +ipfs pin remote ls --service=functionland --status=queued,pinning,failed +``` + +For more commands and general help: + +```bash +ipfs pin remote --help +``` diff --git a/sidebars.js b/sidebars.js index ffd1cae..0688eaa 100644 --- a/sidebars.js +++ b/sidebars.js @@ -77,6 +77,17 @@ const sidebars = { 'functionyard/support', ] }, + { + type: 'category', + label: 'Pinning Service API', + link: { + type:'doc', + id:'pinning-service/index' + }, + items:[ + 'pinning-service/ipfs-pinning-service-api', + ] + }, { type: 'category', label: 'Fula API', From 2b2fbb2b4bc9e108e02beba3a35efe1146a6aba4 Mon Sep 17 00:00:00 2001 From: ehsan shariati Date: Thu, 4 Jul 2024 20:32:57 -0400 Subject: [PATCH 4/4] Update ipfs-pinning-service-api.md --- docs/pinning-service/ipfs-pinning-service-api.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/docs/pinning-service/ipfs-pinning-service-api.md b/docs/pinning-service/ipfs-pinning-service-api.md index b9b36ca..e98217c 100644 --- a/docs/pinning-service/ipfs-pinning-service-api.md +++ b/docs/pinning-service/ipfs-pinning-service-api.md @@ -28,11 +28,9 @@ Functionland Fula users looking to utilize the IPFS Pinning Services API can do ### Authentication -To authenticate with Functionland through the Pinning Services API spec, you'll first need to have an `accessToken`. You can create this API token on the [Fula Keys Page](https://cloud.fx.land/) (Invite-Only as of this date) +To authenticate with Functionland through the Pinning Services API spec, you'll first need to have an `accessToken`. You can create this API token on the [Fula Cloud Page](https://cloud.fx.land/) (FREE 20GB pinning!) -When you create a new API key, you'll need to take note of the JWT ([JSON Web Token](https://jwt.io/)) token that's shown to you immediately after creation. This JWT is specific to the API key and shares the same permissions. - -If you ever revoke the API key for this JWT, this JWT will no longer be valid for authenticating to the Pinning Services API. +If you ever revoke the API key, it will no longer be valid for authenticating to the Pinning Services API. **Configuring Functionland Fula in the IPFS Desktop App**