@cnippet-helm/storage-local
v0.4.0
Published
Local filesystem storage adapter for Admin Kit
Readme
@cnippet-helm/storage-local
Local filesystem storage adapter for Admin Kit. Writes uploaded files to a directory on disk and serves them via a public URL prefix. Suitable for local development and single-server deployments.
Install
pnpm add @cnippet-helm/storage-localUsage
// src/lib/admin.config.ts
import { defineConfig } from "@cnippet-helm/core";
import { localStorageAdapter } from "@cnippet-helm/storage-local";
import path from "node:path";
export const adminConfig = defineConfig({
basePath: "/admin",
db,
auth: myAuthAdapter,
storage: localStorageAdapter({
uploadDir: path.join(process.cwd(), "public/uploads"),
baseUrl: "/uploads",
}),
resources: [],
});Files are written to public/uploads/<uuid>.<ext> and served at /uploads/<uuid>.<ext> via Next.js's built-in static file serving.
API
localStorageAdapter(options: {
uploadDir: string; // absolute path to the upload directory
baseUrl: string; // public URL prefix, e.g. "/uploads"
}): StorageAdapterThe adapter implements:
upload(file)— writes file touploadDir, returns{ url, key }delete(key)— deletes file fromuploadDir, ignores ENOENT
Note
Not suitable for multi-server or serverless deployments (Vercel, Railway, Fly.io) — use @cnippet-helm/storage-vercel-blob or a custom S3 adapter instead.
See the Admin Kit docs for full usage.
