npm.io
6.0.0 • Published 1 week ago

@x12i/catalox-storage

Licence
MIT
Version
6.0.0
Deps
1
Size
24 kB
Vulns
0
Weekly
0

@x12i/catalox-storage

Cloudflare R2 / S3-compatible object store for Catalox (record history, catalog lifecycle manifests, backups).

Quick start

import { createObjectStoreFromEnv } from "@x12i/catalox-storage";

const store = createObjectStoreFromEnv(); // bucket default: catalox
await store.uploadObject("hello.txt", "hi", { contentType: "text/plain" });

Env

Variable Purpose
S3_API / S3_ENDPOINT R2 endpoint
S3_ACCOUNT_ID / S3_ACOUNT_ID Builds endpoint if S3_API unset
S3_ACCESS_ID Access key id
S3_SECRET_ACCESSKEY Secret
S3_TOKEN Optional session token
S3_BUCKET / CATALOX_BUCKET / CATALOX_OBJECT_STORE_BUCKET Bucket (default catalox)

Buckets are not auto-created. Create catalox, magit, and storage in Cloudflare before migrate/runtime use.