setup

Create an uplink config file

Usage

./uplink.exe setup [flags]
./uplink.exe setup [flags]

Flags

FlagDescription
--auth-service stringIf generating backwards-compatible S3 Gateway credentials, use this auth service (default "https://auth.storjshare.io")
-f, --forceForce overwrite an existing saved access
--useSwitch the default access to the newly created one

Global flags

FlagDescription
--config-dir stringDirectory that stores the configuration
--help, -hhelp for setup
--advancedwhen used with -h, prints advanced flags help

Example

1. Start the CLI wizard.

PowerShell

FAQ.

./uplink.exe setup
./uplink.exe setup

2. Choose an access name, by default this should be left blank, so hit 'enter'

If you would like to choose your own access name, please be sure to only use lowercase letters. Including any uppercase letters will result in your access name not getting recognized when creating buckets.

Enter name to import as [default: main]:
Enter name to import as [default: main]:

3. Enter the Create Access Grant in CLI you generated:

Enter API key or Access grant:
Enter API key or Access grant:

4. Enter the satellite address (generated when you created access grant):

Satellite address:
Satellite address:

5. Create (or use existing) an encryption passphrase and then confirm. This is used to encrypt your files on your machine before they are uploaded to the network:

Passphrase:
Again:
Passphrase:
Again:

6. (Optional) Disable encryption for object keys to enable lexicographical sort (More info: Object Listings)

Would you like to disable encryption for object keys (allows lexicographical sorting of objects in listings)? (y/N):
Would you like to disable encryption for object keys (allows lexicographical sorting of objects in listings)? (y/N):

7. (Optional) Generate S3 Compatible Gateway Credentials

Would you like S3 backwards-compatible Gateway credentials? (y/N):
Would you like S3 backwards-compatible Gateway credentials? (y/N):

Please note that Storj does not know or store your encryption passphrase, so if you lose it, you will not be able to recover your files.

6. Your Uplink is configured and ready to use!

Previous
rm
Next
share