Configuration¶
thumbor’s configuration file is just a regular python script that thumbor loads.
In order to get a commented configuration file, just run:
thumbor-config > ./thumbor.conf
Override config through environment variable¶
It is possible overide string configs through environment variables. This is possible because thumbor uses derpconf to abstract loading configuration and derpconf allows this.
Extensibility Section¶
LOADER¶
The loader is responsible for retrieving the source image that thumbor will work with. This configuration defines the module that thumbor will use for it. This must be a full namespace module (a.k.a. python has to be able to **import it).**
i.e.: thumbor.loaders.http_loader
STORAGE¶
The storage is responsible for storing the source image bytes and related metadata (face-detection, encryption and such) so that we don’t keep loading it every time. This must be a full namespace module (a.k.a. python has to be able to **import it).**
i.e.: thumbor.storages.file_storage
MIXED_STORAGE_FILE_STORAGE¶
If you are using thumbor’s mixed storage (thumbor.storages.mixed_storage), this is where you specify the storage that will be used to store images. This must be a full namespace module (a.k.a. python has to be able to **import it).**
i.e.: thumbor.storages.file_storage
MIXED_STORAGE_CRYPTO_STORAGE¶
If you are using thumbor’s mixed storage (thumbor.storages.mixed_storage), this is where you specify the storage that will be used to store cryptography information. This must be a full namespace module (a.k.a. python has to be able to **import it).**
i.e.: thumbor.storages.redis_storage
MIXED_STORAGE_DETECTOR_STORAGE¶
If you are using thumbor’s mixed storage (thumbor.storages.mixed_storage), this is where you specify the storage that will be used to store facial and feature detection results. This must be a full namespace module (a.k.a. python has to be able to **import it).**
i.e.: thumbor.storages.mongo_storage
ENGINE¶
The engine is responsible for transforming the image. This must be a full namespace module (a.k.a. python has to be able to **import it).**
Thumbor ships with three imaging engines:
thumbor.engines.pil
thumbor.engines.opencv
thumbor.engines.graphicsmagick
thumbor.engines.imagemagick
(This engine isn’t supported anymore, check #52)
RESULT_STORAGE¶
The result storage is responsible for storing the resulting image with the specified parameters (think of it as a cache), so that we don’t keep processing it every time a request comes in. This must be a full namespace module (a.k.a. python has to be able to **import it).**
i.e.: thumbor.result_storages.file_storage
URL_SIGNER¶
The url signer is responsible for validation and signing of requests to prevent url tampering, which could lead to denial of service (example: filling the result_storage by specifying a different size). This must be a full namespace module (a.k.a. python has to be able to **import it).**
i.e.: libthumbor.url_signers.base64_hmac_sha1
Filters Section¶
In order to specify the filters that thumbor will use, you need a configuration key called FILTERS. This is a regular python list with the full names (names that python can import) of the filter modules you want to use.
An example:
FILTERS = [
'thumbor.filters.brightness',
'thumbor.filters.contrast',
'thumbor.filters.rgb',
'thumbor.filters.round_corner',
'thumbor.filters.quality',
'thumbor.filters.noise',
'thumbor.filters.watermark',
]
Metadata Section¶
META_CALLBACK_NAME¶
If you want thumbor to use JSONP for image metadata instead of using JSON, just set this variable to the callback name you want.
i.e.: “thumbor_callback”
Face and Feature Detection Section¶
DETECTORS¶
This options specifies the detectors that should run the image to check for focal points.
i.e.: [“thumbor.detectors.face_detector”, “thumbor.detectors.feature_detector”]
FACE_DETECTOR_CASCADE_FILE¶
This option specifies the cascade (XML) file path to train openCV to find faces.
i.e.: haarcascade_frontalface_alt.xml
Imaging Section¶
ALLOWED_SOURCES¶
This configuration defines the source of the images that thumbor will load. This is only used in the HttpLoader (check the LOADER configuration above).
i.e.: ALLOWED_SOURCES=[‘http://s.glbimg.com’]
Another example with wildcards:
ALLOWED_SOURCES = [‘.+.globo.com’, ‘.+.glbimg.com’]
This is to get any images that are in *.globo.com or *.glbimg.com and it will fail with any other domains.
MAX_WIDTH and MAX_HEIGHT¶
These define the box that the resulting image for thumbor must fit-in. This means that no image that thumbor generates will have a width larger than MAX_WIDTH or height larger than MAX_HEIGHT. It defaults to 0, which means there is not limit. If the original image is larger than MAX_WIDTH x MAX_HEIGHT, it is proportionally resized to MAX_WIDTH x MAX_HEIGHT.
i.e.:
MAX_WIDTH = 1200
MAX_HEIGHT = 800
MIN_WIDTH and MIN_HEIGHT¶
These define the box that the resulting image for thumbor must fit-in. This means that no image that thumbor generates will have a width smaller than MIN_WIDTH or height smaller than MIN_HEIGHT. It defaults to 1. If the original image is smaller than MIN_WIDTH x MIN_HEIGHT, it is proportionally resized to MIN_WIDTH x MIN_HEIGHT.
i.e.:
MIN_WIDTH = 1
MIN_HEIGHT = 1
QUALITY¶
This option defines the quality that JPEG images will be generated with. It defaults to 80.
i.e.: QUALITY = 90
MAX_AGE¶
This option defines the number of seconds that images should remain in the browser’s cache. It relates directly with the Expires and Cache-Control headers.
i.e.: MAX_AGE = 24 * 60 * 60 # A day of caching
MAX_AGE_TEMP_IMAGE¶
When an image has some error in its detection or it has deferred queueing, it’s convenient to set a much lower expiration time for the image cache. This way the browser will request the proper image faster.
This option defines the number of seconds that images in this scenario should remain in the browser’s cache. It relates directly with the Expires and Cache-Control headers.
i.e.: MAX_AGE_TEMP_IMAGE = 60 # A minute of caching
RESPECT_ORIENTATION¶
If this option is set to True, thumbor will reorient the image according to it’s EXIF Orientation tag (if one can be found). This options defaults to False.
The operations performed in the image are as follow (considering the value of the Orientation EXIF tag):
- Nothing
- Flips the image horizontally
- Rotates the image 180 degrees
- Flips the image vertically
- Flips the image vertically and rotates 270 degrees
- Rotates the image 270 degrees
- Flips the image horizontally and rotates 270 degrees
- Rotates the image 90 degrees
i.e.: RESPECT_ORIENTATION = False
ALLOW_ANIMATED_GIFS¶
This option indicates whether animated gifs should be supported.
i.e.: ALLOW_ANIMATED_GIFS = True
USE_GIFSICLE_ENGINE¶
This option indicates whether gifsicle should be used for all gif images, instead of the actual imaging engine. This defaults to False.
When using gifsicle thumbor will generate proper animated gifs, as well as static gifs with the smallest possible size.
i.e.: USE_GIFSICLE_ENGINE = True
WARNING: When using gifsicle engine, filters will be skipped. Thumbor will not do smart cropping as well.
AUTO_WEBP¶
This option indicates whether thumbor should send WebP images automatically if the request comes with an “Accept” header that specifies that the browser supports “image/webp”.
i.e.: AUTO_WEBP = True
AUTO_PNG_TO_JPG¶
This option indicates whether thumbor should transform PNG images automatically to JPEG. If the image is a PNG without transparency and the numpy dependency is installed, thumbor will transform from png to jpeg. In the most of cases the image size will decrease.
WARNING: Depending on case, this is not a good deal. This transformation maybe causes distortions or the size of image can increase. Images with texts, for example, the result image maybe will be distorced. Dark images, for example, the size of result image maybe will be bigger. You have to evaluate the majority of your use cases to take a decision about the usage of this conf.
i.e.: AUTO_PNG_TO_JPG = True
Queueing - Redis¶
REDIS_QUEUE_SERVER_HOST¶
Server host for the queued redis detector.
i.e.: REDIS_QUEUE_SERVER_HOST = 'localhost'
REDIS_QUEUE_SERVER_PORT¶
Server port for the queued redis detector.
i.e.: REDIS_QUEUE_SERVER_PORT = 6379
REDIS_QUEUE_SERVER_DB¶
Server database index for the queued redis detector
i.e.: REDIS_QUEUE_SERVER_DB = 0
REDIS_QUEUE_SERVER_PASSWORD¶
Server password for the queued redis detector
i.e.: REDIS_QUEUE_SERVER_PASSWORD = None
Queueing - Amazon SQS¶
Security Section¶
SECURITY_KEY¶
This option specifies the security key that thumbor uses to sign secure URLs.
i.e.: 1234567890123456
ALLOW_UNSAFE_URL¶
This option specifies that the /unsafe url should be available in this thumbor instance. It is boolean (True or False).
ALLOW_OLD_URLS¶
This option specifies that the format prior to 3.0.0 release changes should be allowed. It defaults to True.
THIS OPTION IS DEPRECATED AND WILL DEFAULT TO FALSE IN THE NEXT MAJOR.
Loader Options Section¶
FILE_LOADER_ROOT_PATH¶
In case you are using thumbor’s built-in file loader, this is the option that allows you to specify where to find the images.
HTTP_LOADER_DEFAULT_USER_AGENT¶
This option allows users to specify the default user-agent that thumbor will send when requesting images with the HTTP Loader. Defaults to ‘Thumbor/’ (like Thumbor/3.10.0).
HTTP_LOADER_FORWARD_USER_AGENT¶
This option tells thumbor to forward the request user agent when requesting images using the HTTP Loader. Defaults to False.
Storage Options Section¶
STORAGE_EXPIRATION_SECONDS¶
This options specifies the default expiration time in seconds for the storage.
i.e.: 60 (1 minute)
STORES_CRYPTO_KEY_FOR_EACH_IMAGE¶
This option specifies whether thumbor should store the key for each image (thus allowing the image to be found even if the security key changes). This is a boolean flag (True or False).
File Storage Section¶
FILE_STORAGE_ROOT_PATH¶
In case you are using thumbor’s built-in file storage, this is the option that allows you to specify where to save the images.
MongoDB Storage Section¶
MONGO_STORAGE_SERVER_PORT¶
This is the option that specifies the port where mongodb is running in.
i.e.: 27017
MONGO_STORAGE_SERVER_COLLECTION¶
This is the option that specifies the collection for thumbor’s documents.
i.e.: images
Redis Storage Section¶
REDIS_STORAGE_SERVER_PASSWORD¶
This option specifies the password that thumbor should use to authenticate with redis.
i.e.: my-redis-password
Memcached Storage Section¶
MEMCACHE_STORAGE_SERVERS¶
List of Memcache storage server hosts.
i.e.: MEMCACHE_STORAGE_SERVERS = ['localhost:11211']
Result Storage Section¶
RESULT_STORAGE_EXPIRATION_SECONDS¶
Expiration in seconds of generated images in the result storage.
i.e.: RESULT_STORAGE_EXPIRATION_SECONDS = 0
RESULT_STORAGE_FILE_STORAGE_ROOT_PATH¶
Path where the Result storage will store generated images.
i.e.:
RESULT_STORAGE_FILE_STORAGE_ROOT_PATH = '/tmp/thumbor/result_storage'
RESULT_STORAGE_STORES_UNSAFE¶
Indicates whether unsafe requests should also be stored in the Result Storage.
i.e.: RESULT_STORAGE_STORES_UNSAFE = False
Healthcheck¶
HEALTHCHECK_ROUTE¶
The URL path to a healthcheck. This will return a 200 and the text ‘WORKING’.
i.e.: HEALTHCHECK_ROUTE = '/status'
Will put the healthcheck response on http://host/status
The default route is ‘/healthcheck’
Logging¶
THUMBOR_LOG_FORMAT¶
This option specifies the format to be used by logging messages sent from thumbor.
i.e.: ‘%(asctime)s %(name)s:%(levelname)s %(message)s’
THUMBOR_LOG_DATE_FORMAT¶
This option specifies the date format to be used by logging messages sent from thumbor.
i.e.: ‘%Y-%m-%d %H:%M:%S’
Error Handling¶
USE_CUSTOM_ERROR_HANDLING¶
This configuration indicates whether thumbor should use a custom error handler.
i.e.: USE_CUSTOM_ERROR_HANDLING = False
ERROR_HANDLER_MODULE¶
Error reporting module. Needs to contain a class called ErrorHandler with a handle_error(context, handler, exception) method.
i.e.: ERROR_HANDLER_MODULE = 'thumbor.error_handlers.sentry'
Error Handling - Sentry¶
SENTRY_DSN_URL¶
Sentry thumbor project dsn. i.e.: http://5a63d58ae7b94f1dab3dee740b301d6a:73eea45d3e8649239a973087e8f21f98@localhost:9000/2
i.e.: SENTRY_DSN_URL = ''
Upload¶
UPLOAD_PHOTO_STORAGE¶
The type of storage to store uploaded images with.
i.e.: UPLOAD_PHOTO_STORAGE = 'thumbor.storages.file_storage'
UPLOAD_DELETE_ALLOWED¶
Indicates whether image deletion should be allowed.
i.e.: UPLOAD_DELETE_ALLOWED = False
UPLOAD_PUT_ALLOWED¶
Indicates whether image overwrite should be allowed.
i.e.: UPLOAD_PUT_ALLOWED = False
UPLOAD_DEFAULT_FILENAME¶
Default filename for image uploaded.
i.e.: UPLOAD_DEFAULT_FILENAME = 'image'
GC_INTERVAL¶
Set manual garbage collection interval in seconds. Defaults to None (no manual garbage collection). Try this if your Thumbor is running out of memory. May cause an increase in CPU load.
i.e.: GC_INTERVAL=60
Example of Configuration File¶
################################### Logging ####################################
## Log Format to be used by thumbor when writing log messages.
## Defaults to: %(asctime)s %(name)s:%(levelname)s %(message)s
#THUMBOR_LOG_FORMAT = '%(asctime)s %(name)s:%(levelname)s %(message)s'
## Date Format to be used by thumbor when writing log messages.
## Defaults to: %Y-%m-%d %H:%M:%S
#THUMBOR_LOG_DATE_FORMAT = '%Y-%m-%d %H:%M:%S'
################################################################################
################################### Imaging ####################################
## Max width in pixels for images read or generated by thumbor
## Defaults to: 0
#MAX_WIDTH = 0
## Max height in pixels for images read or generated by thumbor
## Defaults to: 0
#MAX_HEIGHT = 0
## Min width in pixels for images read or generated by thumbor
## Defaults to: 1
#MIN_WIDTH = 1
## Min width in pixels for images read or generated by thumbor
## Defaults to: 1
#MIN_HEIGHT = 1
## Allowed domains for the http loader to download. These are regular
## expressions.
## Defaults to: []
#ALLOWED_SOURCES = # [
# ]
## Quality index used for generated JPEG images
## Defaults to: 80
#QUALITY = 80
## Max AGE sent as a header for the image served by thumbor in seconds
## Set to False to disable setting of Expires and Cache-Control headers
## Defaults to: 86400
#MAX_AGE = 86400
## Indicates the Max AGE header in seconds for temporary images (images that
## haven't been detected yet)
## Defaults to: 0
#MAX_AGE_TEMP_IMAGE = 0
## Indicates whether thumbor should rotate images that have an Orientation EXIF
## header
## Defaults to: False
#RESPECT_ORIENTATION = False
## Indicates whether thumbor should enable the EXPERIMENTAL support for animated
## gifs.
## Defaults to: True
#ALLOW_ANIMATED_GIFS = True
################################################################################
################################ Extensibility #################################
## The loader thumbor should use to load the original image. This must be the
## full name of a python module (python must be able to import it)
## Defaults to: thumbor.loaders.http_loader
#LOADER = 'thumbor.loaders.http_loader'
## The file storage thumbor should use to store original images. This must be the
## full name of a python module (python must be able to import it)
## Defaults to: thumbor.storages.file_storage
#STORAGE = 'thumbor.storages.file_storage'
## The result storage thumbor should use to store generated images. This must be
## the full name of a python module (python must be able to import it)
## Defaults to: None
#RESULT_STORAGE = None
## The imaging engine thumbor should use to perform image operations. This must
## be the full name of a python module (python must be able to import it)
## Defaults to: thumbor.engines.pil
#ENGINE = 'thumbor.engines.pil'
################################################################################
################################### Security ###################################
## The security key thumbor uses to sign image URLs
## Defaults to: MY_SECURE_KEY
#SECURITY_KEY = 'MY_SECURE_KEY'
## Indicates if the /unsafe URL should be available
## Defaults to: True
#ALLOW_UNSAFE_URL = True
## Indicates if encrypted (old style) URLs should be allowed
## Defaults to: True
#ALLOW_OLD_URLS = True
################################################################################
################################# File Loader ##################################
## The root path where the File Loader will try to find images
## Defaults to: /tmp
#FILE_LOADER_ROOT_PATH = '/tmp'
################################################################################
################################# File Storage #################################
## Expiration in seconds for the images in the File Storage. Defaults to one
## month
## Defaults to: 2592000
#STORAGE_EXPIRATION_SECONDS = 2592000
## Indicates whether thumbor should store the signing key for each image in the
## file storage. This allows the key to be changed and old images to still be
## properly found
## Defaults to: False
#STORES_CRYPTO_KEY_FOR_EACH_IMAGE = False
## The root path where the File Storage will try to find images
## Defaults to: /var/folders/th/z6vmj34j1gngpvwl5fg5t9440000gp/T/thumbor/storage
#FILE_STORAGE_ROOT_PATH = '/var/folders/th/z6vmj34j1gngpvwl5fg5t9440000gp/T/thumbor/storage'
################################################################################
#################################### Upload ####################################
## Max size in Kb for images uploaded to thumbor
## Aliases: MAX_SIZE
## Defaults to: 0
#UPLOAD_MAX_SIZE = 0
## Indicates whether thumbor should enable File uploads
## Aliases: ENABLE_ORIGINAL_PHOTO_UPLOAD
## Defaults to: False
#UPLOAD_ENABLED = False
## The type of storage to store uploaded images with
## Aliases: ORIGINAL_PHOTO_STORAGE
## Defaults to: thumbor.storages.file_storage
#UPLOAD_PHOTO_STORAGE = 'thumbor.storages.file_storage'
## Indicates whether image deletion should be allowed
## Aliases: ALLOW_ORIGINAL_PHOTO_DELETION
## Defaults to: False
#UPLOAD_DELETE_ALLOWED = False
## Indicates whether image overwrite should be allowed
## Aliases: ALLOW_ORIGINAL_PHOTO_PUTTING
## Defaults to: False
#UPLOAD_PUT_ALLOWED = False
## Default filename for image uploaded
## Defaults to: image
#UPLOAD_DEFAULT_FILENAME = 'image'
################################################################################
############################### MongoDB Storage ################################
## MongoDB storage server host
## Defaults to: localhost
#MONGO_STORAGE_SERVER_HOST = 'localhost'
## MongoDB storage server port
## Defaults to: 27017
#MONGO_STORAGE_SERVER_PORT = 27017
## MongoDB storage server database name
## Defaults to: thumbor
#MONGO_STORAGE_SERVER_DB = 'thumbor'
## MongoDB storage image collection
## Defaults to: images
#MONGO_STORAGE_SERVER_COLLECTION = 'images'
################################################################################
################################ Redis Storage #################################
## Redis storage server host
## Defaults to: localhost
#REDIS_STORAGE_SERVER_HOST = 'localhost'
## Redis storage server port
## Defaults to: 6379
#REDIS_STORAGE_SERVER_PORT = 6379
## Redis storage database index
## Defaults to: 0
#REDIS_STORAGE_SERVER_DB = 0
## Redis storage server password
## Defaults to: None
#REDIS_STORAGE_SERVER_PASSWORD = None
################################################################################
############################### Memcache Storage ###############################
## List of Memcache storage server hosts
## Defaults to: ['localhost:11211']
#MEMCACHE_STORAGE_SERVERS = # [
# 'localhost:11211',
# ]
################################################################################
################################ Mixed Storage #################################
## Mixed Storage file storage. This must be the full name of a python module
## (python must be able to import it)
## Defaults to: thumbor.storages.no_storage
#MIXED_STORAGE_FILE_STORAGE = 'thumbor.storages.no_storage'
## Mixed Storage signing key storage. This must be the full name of a python
## module (python must be able to import it)
## Defaults to: thumbor.storages.no_storage
#MIXED_STORAGE_CRYPTO_STORAGE = 'thumbor.storages.no_storage'
## Mixed Storage detector information storage. This must be the full name of a
## python module (python must be able to import it)
## Defaults to: thumbor.storages.no_storage
#MIXED_STORAGE_DETECTOR_STORAGE = 'thumbor.storages.no_storage'
################################################################################
##################################### Meta #####################################
## The callback function name that should be used by the META route for JSONP
## access
## Defaults to: None
#META_CALLBACK_NAME = None
################################################################################
################################## Detection ###################################
## List of detectors that thumbor should use to find faces and/or features. All
## of them must be full names of python modules (python must be able to import
## it)
## Defaults to: []
#DETECTORS = # [
# ]
## The cascade file that opencv will use to detect faces
## Defaults to: haarcascade_frontalface_alt.xml
#FACE_DETECTOR_CASCADE_FILE = 'haarcascade_frontalface_alt.xml'
################################################################################
################################### Filters ####################################
## List of filters that thumbor will allow to be used in generated images. All of
## them must be full names of python modules (python must be able to import
## it)
## Defaults to: []
#FILTERS = # [
# ]
################################################################################
################################ Result Storage ################################
## Expiration in seconds of generated images in the result storage
## Defaults to: 0
#RESULT_STORAGE_EXPIRATION_SECONDS = 0
## Path where the Result storage will store generated images
## Defaults to: /var/folders/th/z6vmj34j1gngpvwl5fg5t9440000gp/T/thumbor/result_storage
#RESULT_STORAGE_FILE_STORAGE_ROOT_PATH = '/var/folders/th/z6vmj34j1gngpvwl5fg5t9440000gp/T/thumbor/result_storage'
## Indicates whether unsafe requests should also be stored in the Result Storage
## Defaults to: False
#RESULT_STORAGE_STORES_UNSAFE = False
################################################################################
############################ Queued Redis Detector #############################
## Server host for the queued redis detector
## Defaults to: localhost
#REDIS_QUEUE_SERVER_HOST = 'localhost'
## Server port for the queued redis detector
## Defaults to: 6379
#REDIS_QUEUE_SERVER_PORT = 6379
## Server database index for the queued redis detector
## Defaults to: 0
#REDIS_QUEUE_SERVER_DB = 0
## Server password for the queued redis detector
## Defaults to: None
#REDIS_QUEUE_SERVER_PASSWORD = None
################################################################################
############################# Queued SQS Detector ##############################
## AWS key id
## Defaults to: None
#SQS_QUEUE_KEY_ID = None
## AWS key secret
## Defaults to: None
#SQS_QUEUE_KEY_SECRET = None
## AWS SQS region
## Defaults to: us-east-1
#SQS_QUEUE_REGION = 'us-east-1'
################################################################################
#################################### Errors ####################################
## This configuration indicates whether thumbor should use a custom error
## handler.
## Defaults to: False
#USE_CUSTOM_ERROR_HANDLING = False
## Error reporting module. Needs to contain a class called ErrorHandler with a
## handle_error(context, handler, exception) method.
## Defaults to: thumbor.error_handlers.sentry
#ERROR_HANDLER_MODULE = 'thumbor.error_handlers.sentry'
################################################################################
############################### Errors - Sentry ################################
## Sentry thumbor project dsn. i.e.: http://5a63d58ae7b94f1dab3dee740b301d6a:73ee
## a45d3e8649239a973087e8f21f98@localhost:9000/2
## Defaults to:
#SENTRY_DSN_URL = ''
## Sentry thumbor environment
## Defaults to: None
#SENTRY_ENVIRONMENT = ''
################################################################################