ConvexFS provides globally distributed file storage and serving for Convex applications with built-in CDN capabilities.
npm install convex-fs[ConvexFS](https://convexfs.dev/) is a Convex component that provides filesystem-like operations for managing files in your Convex application. Instead of dealing with raw blob storage, you work with familiar concepts like paths, files, and directories—while getting the performance benefits of a global CDN.
Features
Path-based file management — Organize files with familiar filesystem paths
Atomic transactions — Move, copy, and delete files with preconditions to prevent data races
Reference-counted blobs — Efficient storage with automatic deduplication
Signed CDN URLs — Secure, time-limited download links served from Bunny.net's global edge network
Soft deletes & disaster recovery — Configurable grace periods let you recover from accidental deletions
Flexible authentication — Bring your own auth logic for uploads and downloads
File expiration — Set automatic expiration times on files for temporary uploads, time-limited sharing, or session-scoped content
Custom CDN parameters — Pass parameters to Bunny.net edge rules for on-the-fly transformations like custom download filenames and image optimization
Documentation
For installation instructions, guides, and API reference, visit:
[ConvexFS](https://convexfs.dev/)
ConvexFS allows you to handle file uploads directly in your Convex mutations, storing them in globally distributed storage. You can then serve these files through built-in CDN endpoints with automatic optimization.
ConvexFS integrates natively with Convex to provide file storage without requiring external services like AWS S3. It handles both storage and global serving through its distributed infrastructure.
ConvexFS enables serving static assets and user-generated content directly from your Convex backend. Files are automatically distributed globally and served through optimized CDN endpoints for fast access.
ConvexFS provides APIs that work directly within Convex mutations and queries, allowing you to store files as part of your database transactions. You can upload files in mutations and reference them in queries using the same patterns as other Convex operations.
Yes. ConvexFS uses bunny.net for blob storage and CDN delivery. You'll need to create a bunny.net account, set up a storage zone and pull zone, and configure four environment variables (storage zone name, CDN hostname, token key, and API key).
ConvexFS supports standard web file types, including images, documents, and media files. The specific size limits and supported formats depend on the component's current implementation details.
ConvexFS itself is a free open-source component, but bunny.net storage and CDN costs are separate. bunny.net offers a trial period and affordable pay-as-you-go pricing. Your Convex usage (database, functions) is billed normally through Convex.