Skip to main content

Thumbor image loader reading blobs from zodb-pgjsonb blob_state table

Project description

zodb-pgjsonb-thumborblobloader

Thumbor 7.x image loader that reads blob data directly from the zodb-pgjsonb blob_state PostgreSQL table.

Overview

This loader enables Thumbor to serve images stored as ZODB blobs in a zodb-pgjsonb PostgreSQL database -- without requiring a running ZODB/Zope instance. It supports:

  • Two-tier storage: PostgreSQL bytea (preferred) with optional S3 fallback
  • Async connection pool: psycopg3 AsyncConnectionPool for high concurrency
  • Disk cache: LRU-evicted local cache with deterministic filenames
  • URL-based lookup: <zoid_hex>/<tid_hex> addressing for exact blob versions

Installation

pip install zodb-pgjsonb-thumborblobloader

# With S3 fallback support
pip install zodb-pgjsonb-thumborblobloader[s3]

Configuration

In your thumbor.conf:

LOADER = 'zodb_pgjsonb_thumborblobloader.loader'

# Required
PGTHUMBOR_DSN = 'dbname=zodb user=zodb password=zodb host=localhost port=5432'

# Connection pool (optional)
PGTHUMBOR_POOL_MIN_SIZE = 1
PGTHUMBOR_POOL_MAX_SIZE = 10

# Disk cache (optional)
PGTHUMBOR_CACHE_DIR = '/var/cache/thumbor/blobs'
PGTHUMBOR_CACHE_MAX_SIZE = 1073741824  # 1 GB

# S3 fallback (optional, requires [s3] extra)
PGTHUMBOR_S3_BUCKET = 'my-blob-bucket'
PGTHUMBOR_S3_REGION = 'eu-central-1'
PGTHUMBOR_S3_ENDPOINT = 'https://s3.example.com'  # for MinIO/Ceph

URL Scheme

http://thumbor:8888/<signing>/<transforms>/<zoid_hex>/<tid_hex>

Both zoid_hex and tid_hex are required. The loader fetches the exact blob version identified by the OID/TID pair.

How It Works

Thumbor request
  └-> loader.load(context, path)
       ├-> disk cache hit?  → return cached bytes
       ├-> PostgreSQL query → blob_state.data (bytea)
       ├-> S3 fallback      → blob_state.s3_key → boto3 download
       └-> cache on disk    → LRU eviction by atime

The blob_state table is owned and managed by zodb-pgjsonb -- this loader only reads from it.

Docker Image

A pre-built OCI image is available on GHCR:

docker pull ghcr.io/bluedynamics/zodb-pgjsonb-thumborblobloader:latest

Platforms: linux/amd64, linux/arm64

Image tags

  • thumbor-<THUMBOR_VERSION>_loader-<LOADER_VERSION> -- versioned (e.g. thumbor-7.7.7_loader-0.3.0)
  • latest -- always the newest build

The image is automatically rebuilt weekly when a new Thumbor version appears on PyPI.

Environment Variables

Variable Default Description
PGTHUMBOR_DSN "" PostgreSQL connection string (required)
THUMBOR_SECURITY_KEY "CHANGE-ME" Thumbor HMAC security key
ALLOW_UNSAFE_URL "False" Allow unsigned URLs
RESULT_STORAGE_PATH /tmp/thumbor/result_storage Result cache directory
PGTHUMBOR_POOL_MIN_SIZE 1 Min DB pool connections
PGTHUMBOR_POOL_MAX_SIZE 4 Max DB pool connections
PGTHUMBOR_CACHE_DIR "" Local blob cache directory (empty = disabled)
PGTHUMBOR_CACHE_MAX_SIZE 0 Max cache size in bytes (0 = disabled)
PGTHUMBOR_S3_BUCKET "" S3 bucket for blob fallback (empty = disabled)
PGTHUMBOR_S3_REGION us-east-1 S3 region
PGTHUMBOR_S3_ENDPOINT "" S3 endpoint for MinIO/Ceph (empty = AWS)
THUMBOR_AUTO_WEBP "true" Auto-convert to WebP when browser supports it
THUMBOR_AUTO_AVIF "false" Auto-convert to AVIF when browser supports it
PGTHUMBOR_PLONE_AUTH_URL "" Plone internal URL for auth (empty = disabled)
PGTHUMBOR_AUTH_CACHE_TTL 60 Auth cache TTL in seconds
PGTHUMBOR_CACHE_CONTROL_AUTHENTICATED private, max-age=86400 Cache-Control for authenticated images (browser-only, no proxy caching)
PGTHUMBOR_CACHE_CONTROL_PUBLIC "" Cache-Control for public images (empty = Thumbor default)

The Plone auth handler (and Cache-Control overrides) is only loaded when PGTHUMBOR_PLONE_AUTH_URL is set.

Quick start

docker run --rm -p 8888:8888 \
  -e PGTHUMBOR_DSN="dbname=zodb user=zodb password=zodb host=localhost" \
  -e THUMBOR_SECURITY_KEY="my-secret" \
  ghcr.io/bluedynamics/zodb-pgjsonb-thumborblobloader:latest

# Healthcheck
curl http://localhost:8888/healthcheck

Development

cd sources/zodb-pgjsonb-thumborblobloader
uv pip install -e ".[test,s3]"

# Run tests (requires PostgreSQL on localhost:5433)
pytest

Documentation

This package is documented together with plone-pgthumbor: https://bluedynamics.github.io/plone-pgthumbor/

Source Code and Contributions

The source code is managed in a Git repository, with its main branches hosted on GitHub. Issues can be reported there too.

We'd be happy to see many forks and pull requests to make this package even better. We welcome AI-assisted contributions, but expect every contributor to fully understand and be able to explain the code they submit. Please don't send bulk auto-generated pull requests.

Maintainers are Jens Klein and the BlueDynamics Alliance developer team. We appreciate any contribution and if a release on PyPI is needed, please just contact one of us. We also offer commercial support if any training, coaching, integration or adaptations are needed.

License

ZPL-2.1 (Zope Public License)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

zodb_pgjsonb_thumborblobloader-0.3.2.tar.gz (21.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

zodb_pgjsonb_thumborblobloader-0.3.2-py3-none-any.whl (12.1 kB view details)

Uploaded Python 3

File details

Details for the file zodb_pgjsonb_thumborblobloader-0.3.2.tar.gz.

File metadata

File hashes

Hashes for zodb_pgjsonb_thumborblobloader-0.3.2.tar.gz
Algorithm Hash digest
SHA256 02d1b6ae8833bddde287078532ab145e1fdb52956bc8cfd0371aa5d83fb6f393
MD5 dfbab6bd35879acdd5810b642109554b
BLAKE2b-256 c828c06162b471a82a9e3fc47f4c342c8cb452872b167e4db7f92bf722d3ae79

See more details on using hashes here.

Provenance

The following attestation bundles were made for zodb_pgjsonb_thumborblobloader-0.3.2.tar.gz:

Publisher: release.yaml on bluedynamics/zodb-pgjsonb-thumborblobloader

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file zodb_pgjsonb_thumborblobloader-0.3.2-py3-none-any.whl.

File metadata

File hashes

Hashes for zodb_pgjsonb_thumborblobloader-0.3.2-py3-none-any.whl
Algorithm Hash digest
SHA256 2a4753a4b093fc85fb231fff4926d7f04ea6b43a341fdd39fe9fb125779048d0
MD5 6731fd0ecde3885fd68547f350598904
BLAKE2b-256 b738f43ed2ab3831981f8da7ebfdbfafd58244b18cc4cf3704d262bc46bf15fc

See more details on using hashes here.

Provenance

The following attestation bundles were made for zodb_pgjsonb_thumborblobloader-0.3.2-py3-none-any.whl:

Publisher: release.yaml on bluedynamics/zodb-pgjsonb-thumborblobloader

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page