Abstract class serving as an interface for concrete services.
The available services are:
-
Disk
, to manage attachments saved directly on the hard drive. -
GCS
, to manage attachments through Google Cloud Storage. -
S3
, to manage attachments through Amazon S3. -
AzureStorage
, to manage attachments through Microsoft Azure Storage. -
Mirror
, to be able to use several services to manage attachments.
Inside a Rails application, you can set-up your services through the
generated config/storage.yml
file and reference one of the
aforementioned constant under the service
key. For example:
local:
service: Disk
root: <%= Rails.root.join("storage") %>
You can checkout the service's constructor to know which keys are required.
Then, in your application's configuration, you can specify the service to use like this:
config.active_storage.service = :local
If you are using Active Storage outside of a Ruby on Rails application, you can configure the service to use like this:
ActiveStorage::Blob.service = ActiveStorage::Service.configure(
:Disk,
root: Pathname("/foo/bar/storage")
)
- CLASS ActiveStorage::Service::AzureStorageService
- CLASS ActiveStorage::Service::DiskService
- CLASS ActiveStorage::Service::GCSService
- CLASS ActiveStorage::Service::MirrorService
- CLASS ActiveStorage::Service::S3Service
- C
- D
- E
- H
- U
Configure an Active Storage service by name from a set of configurations, typically loaded from a YAML file. The Active Storage engine uses this to set the global Active Storage service when the app boots.
Delete the file at the key
.
Delete files at keys starting with the prefix
.
Return the content of the file at the key
.
Return the partial content in the byte range
of the file at
the key
.
Return true
if a file exists at the key
.
Returns a Hash of headers for
url_for_direct_upload
requests.
Upload the io
to the key
specified. If a
checksum
is provided, the service will ensure a match when the
upload has completed or raise an ActiveStorage::IntegrityError.
Returns a signed, temporary URL for the file at the key
. The
URL will be valid for the amount of seconds specified in
expires_in
. You most also provide the disposition
(:inline
or :attachment
), filename
,
and content_type
that you wish the file to be served with on
request.
Returns a signed, temporary URL that a direct upload file can be PUT to on
the key
. The URL will be valid for the amount of seconds
specified in expires_in
. You must also provide the
content_type
, content_length
, and
checksum
of the file that will be uploaded. All these
attributes will be validated by the service upon upload.