Sources

HTTP Source

The HTTP source fetches original images via GET request.

Example

config.yml

sources:
  - http:
      root: https://example.com/assets/:image

Options

Name
root	The url of original image. Type: string with parameters Required

S3 Source

The S3 sources fetches original images from a S3 bucket. Can also be used for Digital Ocean spaces, by changing the endpoint.

Example

config.yml

sources:
  - s3:
      access_key_id: 'xxxx'
      secret_access_key: 'yyy'
      region: 'nyc3'
      bucket_name: 'my-bucket'
      path: 'originals/:image'

Example (minio)

config.yml

sources:
  - s3:
      access_key_id: 'xxxx'
      secret_access_key: 'yyy'
      region: 'us-east-1'
      bucket_name: 'my-bucket'
      path: 'originals/:image'
      endpoint: "http://localhost:9000"
      sslDisabled: true
      signatureVersion: "v4"
      s3ForcePathStyle: true

Options

Name
access_key_id	Access key id from S3 Type: string Required
secret_access_key	Secret access key from S3 Type: string Required
region	Region of S3 bucket Type: string Required
bucket_name	Name of bucket Type: string Required
path	Path of the original image in the bucket Type: string with parameters Required
endpoint	Which endpoint to use, useful if using Digital Ocean Spaces. Type: string Default: derived from bucket_name and region, as per AWS standard.
sslDisabled	Disable SSL validation (useful when using a local S3 compatible server, minio) Type: boolean Default: false
signatureVersion	S3 Signature Version (useful when using a local S3 compatible server, like minio) Type: string Default: defaults to AWS SDK internal default value for this setting
s3ForcePathStyle	S3 force path style (useful when using a local S3 compatible server, like minio) Type: string Default: defaults to AWS SDK internal default value for this setting

Avoid using forward slash in path, it will create unnamed folders.

Volume Source

The volume sources fetches original image from disk.

Example

config.yml

sources:
  - volume:
      root: /mnt/images/:image

Options

Name
root	The path of the original image on disk Type: string with parameters Required