From 4dbc2a8085747fd4afc7f5cfe3491ee9210d0fa3 Mon Sep 17 00:00:00 2001 From: Stefan Benten Date: Sun, 21 Feb 2021 18:21:42 +0100 Subject: [PATCH] README.md: Update Storj Configuration Steps --- README.md | 21 ++++++++++----------- 1 file changed, 10 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 0e61940..2efa93e 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ Easy and fast file sharing from the command-line. This code contains the server with everything you need to create your own instance. -Transfer.sh currently supports the s3 (Amazon S3), gdrive (Google Drive) providers, and local file system (local). +Transfer.sh currently supports the s3 (Amazon S3), gdrive (Google Drive), storj (Storj) providers, and local file system (local). ## Disclaimer @@ -167,22 +167,21 @@ To use the Storj Network as storage provider you need to specify the following f ### Creating Bucket and Scope -In preparation you need to create a scope (or copy it from the uplink configuration) and a bucket. +In preparation you need to create an access grant (or copy it from the uplink configuration) and a bucket. -To get started, download the latest uplink from the release page: https://github.com/storj/storj/releases +To get started, login to your account and go to the Access Grant Menu and start the Wizard on the upper right. -After extracting, execute `uplink setup`. The Wizard asks for Satellite to use, the API Key -(which you can retrieve via the Satellite UI), as well as an Encryption Key. -Once the uplink is setup create the bucket using the following schema: -`uplink mb sj://` where is your desired name. +Enter your access grant name of choice, hit *Next* and restrict it as necessary/preferred. +Aftwards continue either in CLI or within the Browser. You'll be asked for a Passphrase used as Encryption Key. +**Make sure to save it in a safe place, without it you will lose the ability to decrypt your files!** -Afterwards you can copy the SCOPE out of the configuration file of the uplink and then start the startup of the -transfer.sh endpoint. For enhanced security its recommended to provide both the scope and the bucket name as ENV Variables. +Afterwards you can copy the access grant and then start the startup of the transfer.sh endpoint. +For enhanced security its recommended to provide both the access grant and the bucket name as ENV Variables. Example: ``` -export STORJ_BUCKET=transfersh -export STORJ_ACCESS= +export STORJ_BUCKET= +export STORJ_ACCESS= transfer.sh --provider storj ```