Paperclip

Paperclip is an ActiveRecord file attachment manager that links database models to files stored on local disks or cloud storage. It functions as a system for managing file attachments, a fingerprinting system for detecting duplicates and verifying integrity, and a MIME type validator to ensure uploaded files match allowed formats.

The project features an image processing pipeline that uses command-line utilities to automatically generate thumbnails and scaled versions of images based on predefined dimensions. It also provides S3 compatible file storage for managing attachments in Amazon S3 and other compatible cloud backends.

Broad capabilities include file upload validation based on size and content type, as well as custom file pipelines for applying logic such as watermarking or encryption during the upload workflow. The system supports importing files from diverse sources and generating public web addresses for stored versions of a file.

Features

File Attachment Systems - Links database models to files stored on local disks or cloud storage to track metadata.

File Storage Adapters - Provides a pluggable adapter system to abstract file persistence across local and cloud storage providers.

Storage Backend Adapters - Uses a pluggable adapter system to save attachments across multiple storage backends.

Image Processing - Automatically generates thumbnails and scaled versions of uploaded images based on predefined dimensions.

Image Processing Pipelines - Provides a sequence of tools for generating thumbnails and scaled versions of images using command-line utilities.

File Upload Security - Restricts attachments based on size, MIME type, and presence to ensure security and data integrity.

Property Validators - Enforces constraints on file presence, size, and content type to ensure data integrity.

File Type Validators - Verifies the actual content of uploaded files using system utilities to ensure they match allowed MIME types.

Model Extensions - Implements an extension to ActiveRecord models to handle file attachment metadata and lifecycle hooks.

Cloud Storage Integrations - Integrates with remote cloud storage services to persist files and utilize performance features.

S3-Compatible Cloud Storage - Provides integration with S3-compatible object storage providers for persisting uploaded file attachments.

File Fingerprinting Systems - Implements a checksum mechanism that generates unique digests for original files to detect duplicates.

Deduplication - Uses cryptographic checksums to identify identical files and prevent redundant storage.

S3-Compatible Storage Adapters - Provides an adapter for uploading and managing file attachments in Amazon S3 and other compatible cloud backends.

Processing Pipelines - Executes a sequence of custom logic and transformation steps on uploaded files before final storage.

On-Demand Thumbnail Generation - Automatically generates resized and cropped thumbnail variants of uploaded images.

Custom Processing Pipelines - Allows for custom logic such as watermarking or encryption to be applied during the file upload workflow.

Image Style Processing - Creates multiple versions of uploaded files using predefined geometries and formats to produce various output sizes.

File Integrity Verifiers - Validates unique fingerprints for attachments using configurable digest algorithms to detect corruption.

File Upload - Legacy file attachment management for database models.

File Handling - File attachment management for ActiveRecord.

thoughtbotpaperclipArchived

Features

Star history