Installation

Install @igniter-js/storage, configure credentials, and boot a storage manager with a CDN base URL.

Install Dependencies

Use your package manager to add the storage package. Add provider SDKs when you pick an adapter (AWS SDK for S3, @google-cloud/storage for GCS).

npm install @igniter-js/storage @igniter-js/common

# S3 (optional)
npm install @aws-sdk/client-s3 @aws-sdk/lib-storage

# Google Cloud (optional)
npm install @google-cloud/storage

pnpm add @igniter-js/storage @igniter-js/common

# S3 (optional)
pnpm add @aws-sdk/client-s3 @aws-sdk/lib-storage

# Google Cloud (optional)
pnpm add @google-cloud/storage

yarn add @igniter-js/storage @igniter-js/common

# S3 (optional)
yarn add @aws-sdk/client-s3 @aws-sdk/lib-storage

# Google Cloud (optional)
yarn add @google-cloud/storage

bun add @igniter-js/storage @igniter-js/common

# S3 (optional)
bun add @aws-sdk/client-s3 @aws-sdk/lib-storage

# Google Cloud (optional)
bun add @google-cloud/storage

Configure Environment

Provide a public CDN/base URL and choose an adapter. You can set credentials in code or environment variables; the builder merges env (IgniterStorageEnv) with explicit options.

Prop

Type

Create the Storage Manager

Define a storage service

// src/services/storage.ts
import { IgniterStorage } from '@igniter-js/storage'

export const storage = IgniterStorage.create()
  .withAdapter('s3', {
    bucket: process.env.IGNITER_STORAGE_S3_BUCKET,
    region: process.env.IGNITER_STORAGE_S3_REGION,
    endpoint: process.env.IGNITER_STORAGE_S3_ENDPOINT,
    accessKeyId: process.env.IGNITER_STORAGE_S3_ACCESS_KEY_ID,
    secretAccessKey: process.env.IGNITER_STORAGE_S3_SECRET_ACCESS_KEY,
  })
  .withUrl(process.env.IGNITER_STORAGE_URL || 'https://cdn.example.com')
  .addScope('public', '/public')
  .build()

Prefer environment variables for credentials. If you omit .withAdapter(), set IGNITER_STORAGE_ADAPTER and provider env vars so the builder can resolve an adapter automatically.

Verify connectivity

await storage.upload(new Blob(['hello'], { type: 'text/plain' }), 'public/hello.txt')
const file = await storage.get('public/hello.txt')
console.log(file?.url)

If you see an adapter error or IGNITER_STORAGE_ADAPTER_NOT_CONFIGURED, double-check the bucket name, permissions, and IGNITER_STORAGE_URL.

Next Steps

Move to the Quick Start to add scopes and return public URLs, then tighten policies in Policies & Validation.