steedos-files

Upload, store, and retrieve files via local filesystem or AWS S3.

1.6k|413|Updated Mar 4, 2019
One-click install
npx skills add https://github.com/steedos/steedos-platform --skill steedos-files
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: steedos-files
Source: https://github.com/steedos/steedos-platform/tree/main/skills/steedos-files
Command: npx skills add https://github.com/steedos/steedos-platform --skill steedos-files

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Builder6 file upload/download system that supports local filesystem and AWS S3 storage, with API at /api/v6/files/:collectionName and Meteor-compatible collections for file metadata.

Core Features & Use Cases

  • Dual storage backends: local storage by default or AWS S3 for scalable file storage.
  • Metadata-driven records: uses Meteor-compatible collections such as cfs.files.filerecord, cfs.avatars.filerecord, and cfs.images.
  • Public and secure access: supports presigned URLs and public download configuration.

Quick Start

Upload a file using the API endpoint POST /api/v6/files/:collectionName with a multipart/form-data request.

Frequently Asked Questions about steedos-files

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I handle file upload and metadata storage across local and S3 backends?

File upload and metadata storage is handled via a unified API at /api/v6/files/:collectionName, supporting both local filesystem and AWS S3 backends. Multipart/form-data requests store files while generating Meteor-compatible metadata records.

What is the mechanism for generating secure presigned URLs for S3 file downloads?

Secure S3 file downloads are enabled through presigned URL generation. The system provides API endpoints and configuration options to issue these temporary access links, ensuring controlled public and secure file retrieval.

Does this file storage system work with Meteor-compatible collections for avatars and images?

Yes, the file storage system supports Meteor-compatible collections such as cfs.files.filerecord, cfs.avatars.filerecord, and cfs.images. It manages metadata-driven records for avatars and images across multiple collections with strict path conventions.

Can I use local filesystem storage by default and switch to AWS S3 for scalable file storage later?

Yes, you can use local filesystem storage by default and switch to AWS S3 for scalable file storage. Dual storage backend support allows seamless transition between local and S3 configurations via storage settings.

What are the limitations of using metadata-driven file records with strict path conventions?

Metadata-driven file records enforce strict path conventions across multiple collections, requiring adherence to specific directory structures. This design ensures consistent file retrieval but limits arbitrary path customization during upload and storage operations.