class Imgproxy::Config

Imgproxy config

@!attribute endpoint

imgproxy endpoint
@return [String]

@!attribute key

imgproxy hex-encoded signature key
@return [String]

@!attribute salt

imgproxy hex-encoded signature salt
@return [String]

@!attribute raw_key

Decoded signature key
@return [String]

@!attribute raw_salt

Decoded signature salt
@return [String]

@!attribute signature_size

imgproxy signature size. Defaults to 32
@return [String]

@!attribute use_short_options

Use short processing option names (+rs+ for +resize+, +g+ for +gravity+, etc).
Defaults to true
@return [String]

@!attribute base64_encode_urls

Base64 encode the URL. Defaults to false
@return [String]

@!attribute always_escape_plain_urls

Always escape plain URLs. Defaults to false
@return [String]

@!attribute use_s3_urls

Use short S3 urls (s3://...) when possible. Defaults to false
@return [String]

@!attribute use_gcs_urls

Use short Google Cloud Storage urls (gs://...) when possible. Defaults to false
@return [String]

@!attribute gcs_bucket

Google Cloud Storage bucket name
@return [String]

@!attribute shrine_host

Shrine host
@return [String]

@see Imgproxy.configure @see github.com/palkan/anyway_config anyway_config

Public Instance Methods

hex_key=(value) click to toggle source

@deprecated Please use {#key} instead

# File lib/imgproxy/config.rb, line 99
def hex_key=(value)
  warn "[DEPRECATION] #hex_key is deprecated. Please use #key instead."
  self.key = value
end
hex_salt=(value) click to toggle source

@deprecated Please use {#salt} instead

# File lib/imgproxy/config.rb, line 105
def hex_salt=(value)
  warn "[DEPRECATION] #hex_salt is deprecated. Please use #salt instead."
  self.salt = value
end
key=(value) click to toggle source
Calls superclass method
# File lib/imgproxy/config.rb, line 74
def key=(value)
  value = value&.to_s
  super(value)
  set_raw_key(value && [value].pack("H*"))
end
Also aliased as: set_key
raw_key=(value) click to toggle source
Calls superclass method
# File lib/imgproxy/config.rb, line 80
def raw_key=(value)
  value = value&.to_s
  super(value)
  set_key(value&.unpack("H*")&.first)
end
Also aliased as: set_raw_key
raw_salt=(value) click to toggle source
Calls superclass method
# File lib/imgproxy/config.rb, line 92
def raw_salt=(value)
  value = value&.to_s
  super(value)
  set_salt(value&.unpack("H*")&.first)
end
Also aliased as: set_raw_salt
salt=(value) click to toggle source
Calls superclass method
# File lib/imgproxy/config.rb, line 86
def salt=(value)
  value = value&.to_s
  super(value)
  set_raw_salt(value && [value].pack("H*"))
end
Also aliased as: set_salt
set_key(value)
Alias for: key=
set_raw_key(value)
Alias for: raw_key=
set_raw_salt(value)
Alias for: raw_salt=
set_salt(value)
Alias for: salt=
url_adapters() click to toggle source

URL adapters config. Allows to use this gem with ActiveStorage, Shrine, etc.

Imgproxy.configure do |config|
  config.url_adapters.add Imgproxy::UrlAdapters::ActiveStorage.new
end

Imgproxy.url_for(user.avatar)

@return [Imgproxy::UrlAdapters] @see Imgproxy::UrlAdapters

# File lib/imgproxy/config.rb, line 120
def url_adapters
  @url_adapters ||= Imgproxy::UrlAdapters.new
end