README
Shrine
Shrine is a toolkit for handling file attachments in Ruby applications. Some highlights:
- Modular design – the [plugin system] allows you to load only the functionality you need
- Memory friendly – streaming uploads and [downloads][Retrieving Uploads] make it work great with large files
- Cloud storage – store files on disk, AWS S3, Google Cloud, Cloudinary and others
- Persistence integrations – works with Sequel, ActiveRecord, ROM, Hanami and Mongoid and others
- Flexible processing – generate thumbnails eagerly or on-the-fly using ImageMagick or libvips
- Metadata validation – validate files based on extracted metadata
- Direct uploads – upload asynchronously [to your app][simple upload] or [to the cloud][presigned upload] using Uppy
- Resumable uploads – make large file uploads [resumable][resumable upload] on S3 or tus
- Background jobs – built-in support for background processing that supports [any backgrounding library][Backgrounding Libraries]
If you're curious how it compares to other file attachment libraries, see the [Advantages of Shrine]. Otherwise, follow along with the [Getting Started guide].