README.md

odt

On Demand Thumbnail generator

Usage

Starting the handler

$ ./bin/odt --help

  Usage: odt [options]

  Options:

    -h, --help                                 output usage information
    -V, --version                              output the version number
    -i, --instances [instance number]          Number of handler instances. Default: Number of CPU cores
    -p, --port [port]                          Handler port. Default: 5000
    -w, --queue-port [interface port]          Queue interface port. Set to false to disable interface. Default: 4900
    -c, --config <config file>                 Specify a config file to load
    --original-storage-type <type>             Select original storage type.
    --original-storage-source-path <source>    Set original storage source path
    --original-storage-container <container>   Set original storage container name
    --original-storage-username <username>     Set original storage username
    --original-storage-password <password>     Set original storage password
    --original-storage-url <url>               Set original storage url
    --thumbnail-storage-type [type]            Select thumbnail storage type.
    --thumbnail-storage-source-path [source]   Set thumbnail storage source path
    --thumbnail-storage-container <container>  Set thumbnail storage container name
    --thumbnail-storage-username <username>    Set thumbnail storage username
    --thumbnail-storage-password <password>    Set thumbnail storage password
    --thumbnail-storage-url <url>              Set thumbnail storage url
    --statsd-host <host>                       Set statsd host
    --statsd-port <port>                       Set statsd port. Default 8125
    --statsd-prefix <prefix>                   Set statsd prefix.
    --redis-host <host>                        Set redis host. Default: localhost
    --redis-port <port>                        Set redis port. Default: 6379
    --redis-auth <auth>                        Set redis authentication password
    --secret <secret>                          Set a secret used for token generation
    --enable-token-only                        Enable token only access

Starting the worker

$ ./bin/odt-worker --help

  Usage: odt-worker [options]

  Options:

    -h, --help                                 output usage information
    -V, --version                              output the version number
    -i, --instances [instance number]          Number of worker instances. Default: Number of CPU cores
    -c, --config <config file>                 Specify a config file to load
    --original-storage-type <type>             Select original storage type.
    --original-storage-source-path <source>    Set original storage source path
    --original-storage-container <container>   Set original storage container name
    --original-storage-username <username>     Set original storage username
    --original-storage-password <password>     Set original storage password
    --original-storage-url <url>               Set original storage url
    --thumbnail-storage-type [type]            Select thumbnail storage type. If not passed, will use the same as original storage.
    --thumbnail-storage-source-path [source]   Set thumbnail storage source path
    --thumbnail-storage-container <container>  Set thumbnail storage container name
    --thumbnail-storage-username <username>    Set thumbnail storage username
    --thumbnail-storage-password <password>    Set thumbnail storage password
    --thumbnail-storage-url <url>              Set thumbnail storage url
    --statsd-host <host>                       Set statsd host
    --statsd-port <port>                       Set statsd port. Default 8125
    --statsd-prefix <prefix>                   Set statsd prefix.
    --redis-host <host>                        Set redis host. Default: localhost
    --redis-port <port>                        Set redis port. Default: 6379
    --redis-auth <auth>                        Set redis authentication password

Handler endpoints

When started, you can access images on the handler by requesting this url:

http://localhost:5000/v1/400/300/image.jpg

Adding filters

You can define filters that should be added on top of the image. These filters can be things like

• watermarks

The url for this type of requests is:

http://localhost:5000/v1/400/300/filters:watermark(logo.png, 0, center)/image.jpg

Available filters

Watermark

Valid parameters are:

• watermark(*filename*, *x*, *y*, *opacity*)
• watermark(*filename*, *opacity*, tile) tile the watermark over the image
• watermark(*filename*, *opacity*, cover) scale the watermark to cover the whole image
• watermark(*filename*, *opacity*, center) position the watermark in the center without resizing
• watermark(*filename*, *opacity*, [north_east, south_east, south_west, north_west]) position the watermark in the corner and resize to a quarter of the thumbnail size