Storj

Introduction

Storj is a decentralized cloud storage platform that offers secure, private, and cost-effective data storage. By distributing data across a global network of nodes, Storj ensures highly-available and resilient data access, while securing cost savings to up to 90% than traditional cloud providers.

Follow the guide below to set up an account and get S3-compatible access keys on Storj:

Getting Started with

Getting Started with Storj

1. Create a Storj Account Using ByteNite's Referral Link:

Visit the link below to create an account on Storj

🔗 Unlock 25 GB Free Storage on Storj - ByteNite's Referral Link

Complete the registration process by verifying your email and setting up your password. You can start with a free trial or select a paid plan based on your needs.

2. Log in to the Storj Console:

Access your Storj console using your account credentials.

3. Create a Project:

• Once logged in, click “New Project.”

• Provide a project name (e.g., “My S3 Project”).

• Click “Create Project” to finalize.

4. Create a Bucket:

• Inside your project dashboard, navigate to the “Buckets” tab.

• Click “New Bucket.”

• Provide a bucket name (e.g., my-s3-bucket).

• Optionally, configure additional settings such as default encryption or access permissions.

• Click “Create Bucket” to complete the setup.

---

Setting Up S3-Compatible Access Keys for Storj

1. Navigate to API Keys:

• Inside your project dashboard, click on the “Access Keys” tab in the navigation bar.

2. Generate an Access Grant:

• Click “New Access Key.”

• Select the "S3 Credentials" configuration checkbox.

• Choose the scope of the access (e.g., full project access or limited to specific buckets).

3. Retrieve Your S3-Compatible Credentials:

• Once the access grant is generated, the console will display the Access Key and Secret Key for S3 compatibility.

• Save these credentials securely, as the Secret Key will not be shown again.

---

Storj Secret

secretType : storj

If your Storj bucket requires authentication for read or write access, set up a secret to store your S3-compatible credentials securely with ByteNite (see 🔐 Setting up secrets)

Here's an example of a request body of the Secrets endpoint for saving Storj keys:

POST /auth/secrets

{
    "secret": {
        "id": "my_storj_secret",
        "secretType": "storj",
        "expiresAt": "2025-12-29T18:02:27.140Z", 
        "accessKey": "jwcxl2mccgasmhs1dcir5ex4mple",
        "name": "Storj Full Access S3 Keys - Project 'My App'"
    },
    "secretKey": "jzwi4pcamnhyjpldu4my2cmfscmg55slex4mpleex4mpleex4mple"
}

---

Storj Data Source Object

dataSourceDescriptor : storj

@type :

Set up your data source with Storj using the your previously configured storj secret and the following params :

@type string

Description:

Use the type.googleapis.com/bytenite.data_source.S3DataSource params type.

bucketName string

Description:

The name of your Storj bucket.

Example:

"my-app-data-bucket-12345"

cloudRegion string

Description:

Use global as the Storj bucket region.

name string

Description:

• Usage for Data Sources: The path to your input file following the bucket name.

• Usage for Data Destinations: The path to the output folder following the bucket name. Note: a path will be created if it doesn't exist.

Example:

• Data Source: "/vids/big_buck_bunny.mp4"

• Data Destination: "/vids/encoded/"

secret_id string

Description:

The ID of an existing storj secret.

Example:

"my_storj_secret"

Here is an example Storj data source and destination request body:

POST /customer/jobs/{jobId}/datasource

{
    "dataSource": {  
        "dataSourceDescriptor": "storj", 
        "params": {  
            "@type": "type.googleapis.com/bytenite.data_source.S3DataSource",  
            "name": "/vids/big_buck_bunny.mp4",
            "bucketName": "my-app-data-bucket-12345",
            "cloudRegion": "global",
            "secret_id": "my_storj_secret"
        }  
    },
    
    "dataDestination": {  
        "dataSourceDescriptor": "storj", 
        "params": {  
            "@type": "type.googleapis.com/bytenite.data_source.S3DataSource",  
            "name": "/vids/encoded/",
            "bucketName": "my-app-data-bucket-12345",
            "cloudRegion": "global",
            "secret_id": "my_storj_secret"
        }  
    }
}