A thumbor server extension for DASH
Project description
thumbor_dash
A thumbor server extension for DASH
Setup
Requirements
- Python >= 3.9
- Pip >= 21.1
- Thumbor == 7.0.0a5
See the requirements for setting up thumbor
in the documentation
1. Install thumbor_dash
pip install thumbor_dash
Note: thumbor_dash, thumbor, and other required dependencies will be installed
2. Create a thumbor configuration file
thumbor-config > thumbor.conf
3. Add these lines to thumbor.conf
file
# Set allowed dimensions
MIN_WIDTH = 1
MIN_HEIGHT = 1
MAX_WIDTH = 1200
MAX_HEIGHT = 800
# Set security key
SECURITY_KEY = "0"
# Use custom Url signing method (sha256)
URL_SIGNER = 'thumbor_dash.url_signers.base64_hmac_sha256'
# Allow only signed URL
ALLOW_UNSAFE_URL = False
# Set user moderation rules
REQUEST_TIME_LIMIT = 1 # time between requests in minutes
USAGE_VIOLATION_LIMIT = 5 # total number of times a requester can violate the time limit before ban
BAN_DURATION = 10 # requester ban duration in minutes
# Use custom error handling
USE_CUSTOM_ERROR_HANDLING = True
ERROR_HANDLER_MODULE = 'thumbor_dash.error_handlers.sentry'
# Custom Service App Class
APP_CLASS = 'thumbor_dash.app.ThumborDashServiceApp'
# Custom Image Loader
LOADER = 'thumbor_dash.loaders.http_loader'
Usage
1. Start thumbor_dash server
thumbor_dash --conf=thumbor.conf
2. Sign image URL
thumbor_dash-url --key="<SECURITY_KEY>" --width=<width> --height=<height> --dashauth="requester(<requesterId>):contract(<contractId>):document(<documentType>):field(<avatarUrl>):owner(<ownerId>):updatedAt(<updatedAt>)" --filters="<filters>" <imageURL>
output:
/<signature>/<width>x<height>/dashauth:requester(<requesterId>):contract(<contractId>):document(<documentType>):field(<field>):owner(<ownerId>):updatedAt(<updatedAt>)/filters:format(<format>)/<encodedImageUrl>
3. Thumbor_dash image retrieval URL
http://<thumbor_dash-server>/<signature>/<width>x<height>/dashauth:requester(<requesterId>):contract(<contractId>):document(<documentType>):field(<field>):owner(<ownerId>):updatedAt(<updatedAt>)/filters:format(<format>)/<encodedImageUrl>
Note: If running the server locally, <thumbor_dash-server>
should be localhost:8888
Example
This is a signed thumbor_dash url
. Simply run thumbor_dash
and paste this link in your browser.
http://localhost:8888/MXd8uDwHf1xqp6YG0RzlkrmtdBaq1ZyzznPLJft1rl4=/1200x800/dashauth:requester(26AxVi5bvYYaC94GmeTmqX21vzsSxar2a4imxSE8ULUQ):contract(D6tjxCZzZobDQztc4S1PK7EDwm4CegLARpiKZn6jQc1R):document(thumbnailField):field(avatarUrl):owner(26AxVi5bvYYaC94GmeTmqX21vzsSxar2a4imxSE8ULUQ):updatedAt(1627948894242)/filters:format(jpeg)/https%3A//github.com/thumbor/thumbor/raw/master/example.jpg
Running thumbor_dash in Docker
This is the fastest way to run thumbor_dash
1. Create a thumbor.env.txt
file containing the environment variables
MIN_WIDTH=1
MIN_HEIGHT=1
MAX_WIDTH=1200
MAX_HEIGHT=800
SECURITY_KEY=0
REQUEST_TIME_LIMIT=1
USAGE_VIOLATION_LIMIT=5
BAN_DURATION=10
USE_CUSTOM_ERROR_HANDLING=True
ALLOW_UNSAFE_URL=False
URL_SIGNER=thumbor_dash.url_signers.base64_hmac_sha256
ERROR_HANDLER_MODULE=thumbor_dash.error_handlers.sentry
APP_CLASS=thumbor_dash.app.ThumborDashServiceApp
LOADER=thumbor_dash.loaders.http_loader
2. Start thumbor_dash server in Docker
docker run -p 80:80 --env-file thumbor.env.txt mayoreee/thumbor_dash
Note: If running in Docker, <thumbor_dash-server>
in the image request URL should be set to localhost:80
instead of localhost:8888
.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for thumbor_dash-0.0.9-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7a6c19616dda90373c943dec247a1ddc06a6fda07f88948a9cee932b9ad4d934 |
|
MD5 | fab3baf27ed9b78abf861d2a3e888118 |
|
BLAKE2b-256 | 26537b50b664f3ca8396a553a0153a6a967908419c09ac3b5d64df209df52c68 |