From 864733cdccb5a4dd4993a47aaf6714fbd27f9ae9 Mon Sep 17 00:00:00 2001 From: Matt Smithies Date: Wed, 17 Apr 2024 18:02:41 +0100 Subject: [PATCH] Update documentation for IPFS provider filebase for use on gitbook (#3545) Signed-off-by: Matt Smithies --- README.md | 3 +-- .../README.md | 17 +++++++++++++++++ 2 files changed, 18 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 0b792298ae..dd1b36f1c0 100644 --- a/README.md +++ b/README.md @@ -217,8 +217,7 @@ The complete guide to using the new w3up web3.storage API is available at https: #### 4.3 Setting up IPFS Filebase Bucket: -To configure the Filebase IPFS provider, set the following variables in the file * -*./configs/.env.develop.guardian.system:** +To configure the Filebase IPFS provider, set the following variables in the file *`./configs/.env..guardian.system`* ``` IPFS_STORAGE_API_KEY="Generated Firebase Bucket Token" diff --git a/docs/guardian/readme/getting-started/installation/building-from-source-and-run-using-docker/README.md b/docs/guardian/readme/getting-started/installation/building-from-source-and-run-using-docker/README.md index ee265dbfa4..914b287acc 100644 --- a/docs/guardian/readme/getting-started/installation/building-from-source-and-run-using-docker/README.md +++ b/docs/guardian/readme/getting-started/installation/building-from-source-and-run-using-docker/README.md @@ -163,6 +163,23 @@ IPFS_STORAGE_PROOF="..." To know complete process of How to setup IPFS Storage variables, please check [How to generate Web3.Storage API values](../../how-to-generate-web3.storage-api-key.md) +#### 4.3 Setting up IPFS Filebase Bucket: + +To configure the Filebase IPFS provider, set the following variables in the file * +`./configs/.env..guardian.system` + + ``` + IPFS_STORAGE_API_KEY="Generated Firebase Bucket Token" + IPFS_PROVIDER="filebase" + ``` + +Create a new "bucket" on Filebase since we utilize the **IPFS Pinning Service API Endpoint** service. The **token** +generated for a bucket corresponds to the **IPFS_STORAGE_API_KEY** environment variable within the guardian's +configuration. + +For detailed setup instructions, refer to the +official . + #### 5. Setting up Chat GPT API KEY to enable AI Search and Guided Search: For setting up AI and Guided Search, we need to set OPENAI\_API\_KEY variable in `./configs/.env*` files.