Image Service Configuration

Configurations within the Satellite Configuration Group.

Element: config

TEXT

            Configures the dynamic image cahce service.

Attributes:

@version [ required | fixed: 1 ]
@storage-item [ default: master ] ↦ string
Storage item to use as source image.
@storage-path [ default: images ] ↦ string
Folder name for local cache.
@thread-pool-size [ default: 2 ] ↦ positiveInteger
Image calculation max thread count.
@max-cache-size-in-mb [ required ] ↦ integer
Max size of local cache.
@max-age-in-minutes [ required ] ↦ integer
Max age of calculated image data in cache.
@default-filetype [ default: png ] ↦ { jpg | png }
Default file format to deliver
@auto-detect-type [ default: false ] ↦ boolean
If enabled, censhare:module.oc.dic-image-type is used to init the type of the image
@copy-all-metadata [ default: false ] ↦ boolean
If enabled metadata from source image is copied to the destination image. IF it is of the same format. (so jpeg to jpeg, png to png, but NOT jpg to png). also ALL metadata is copied, which can lead to inconsistent metadata.
@crop-cache-max-size [ default: 1000 ] ↦ integer
how many croppings to cache in memory
@crop-cache-expiration-in-minutes [ default: 60 ] ↦ integer
cache for x minutes after last access

Children:

all of these elements:
- [1, 1] '→rules'
  » Define rules securing and restricting the service.
- [0, 1] '→fs'
  » Configure AWS s3 access.
- [0, 1] '→compatibility'
  » Configure AWS s3 access.

Element: compatibility

Attributes:

@improved-element-idx-handling [ default: false ] ↦ boolean
If enabled use new elementIdx handling

Element: fs

Configure AWS s3 access (remove if no access to AWS needed).

Children:

all of these elements:
- [1, 1] '→s3'

Element: s3

Configure AWS regions and s3 regions in use.

Children:

choice of these elements:
- [1, n] '→s3-region'

Element: s3-region

Configure an available region.

Attributes:

@region [ required ] ↦ string
Select the system AWS region.
@bucket [ required ] ↦ string
Select bucket to use in @region
@bucket-region [ required ] ↦ string
Select the bucket to use's region
@api-key ↦ string
Provide api-key for bucket
@api-secret ↦ string
Provide api-secret for bucket
@refresh-expiry-threshold [ default: 1 ] ↦ positiveInteger
Threshold for caching
@sign-url [ default: true ] ↦ boolean
if files in the bucket are public readable, signed urls can be disabled (better for caching)
@url-override-unsigned-urls ↦ anyURI
allow pointing the url to another host (custom url via accelleration or cloudfront)
@accelerate [ default: false ] ↦ boolean
allow use of accelerated s3
@url-override ↦ string
override default endpoint url
@max-connections [ default: 50 ] ↦ integer
max connections to s3
@request-timeout-ms [ default: 60000 ] ↦ integer
s3 request timeout (ms)
@socket-timeout-ms [ default: 60000 ] ↦ integer
s3 socket timeout (ms)
@connection-idle-timeout-ms [ default: 50 ] ↦ integer
connection idle timeout (ms)
@path-style-access [ default: false ] ↦ boolean
use path style access to bucket

Element: rules

Define rules securing and restricting the service.

Children:

all of these elements:
- [0, 1] '→size'

Element: size

Restrict max size of an image by overall pixel count.

Attributes:

@max-pixel-count [ required ] ↦ positiveInteger

The Image Service Configuration configures the dynamic image cache service.

One Image Service Configurations may be present in a configuration group.

The Dynamic Image Cache Service is service provider when requesting images from skins).