Skip to content

README.md

Latest commit

 

History

History
67 lines (51 loc) · 2.54 KB

README.md

File metadata and controls

67 lines (51 loc) · 2.54 KB

An image proxy that can resize images from an upstream server and store the source and target images locally for quick response times. In a Kubernetes cluster with multiple replicas ixy uses rendezvous hashing (replication factor 2) to route requests to owner pods instead of copying caches between replicas.

Quickstart with KinD

$ ./scripts/quickstart.sh
$ curl -o /dev/null \
       -s \
       -w 'Establish Connection: %{time_connect}s\nTTFB: %{time_starttransfer}s\nTotal: %{time_total}s\n' \
       http://127.0.0.1:8080/200/200/300/300

Quickstart with Docker

$ docker compose up &
$ curl -o /dev/null \
       -s \
       -w 'Establish Connection: %{time_connect}s\nTTFB: %{time_starttransfer}s\nTotal: %{time_total}s\n' \
       http://127.0.0.1:8080/200/200/300/300

Usage

The URL are parsed as followed:

http://127.0.0.1:8080/200/200/g:n/300/300
                     |___|___|___|_______|
                       |   |   |     |
target image width ----+   |   |     |
target image height -------+   |     |
gravity for crop: center ------+     |
source image path -------------------+

If image width or height is set to 0 the aspect ratio is retained. If both are 0 the source image is returned.

The gravity (g) argument is optional and it can also take the following values:

  • n: North
  • e: East
  • w: West
  • s: South

Instead of gravity you can also use a strategy (s) argument:

  • a: Attention
  • e: Entropy

For more details on how crops are applied with these arguments read the Sharp documentation.

Environment variables

  • DEBUG: Enable debug logging
  • BASE_URL: The base URL of the upstream server
  • MAX_WIDTH: The maximum width of the target image (Default: 2000)
  • MAX_HEIGHT: The maximum height of the target image (Default: 2000)
  • MAX_SIZE: The maximum size of the source image in megabytes (Default: 5)
  • REVALIDATE_TIME: The time in minutes for checking the source image for changes after its last access (Default: 30)
  • TIMEOUT: The timeout in seconds when fetching source images (Default: 15)
  • MAX_REDIRECTS: The maximum number of redirects when fetching source images (Default: 5)
  • CACHE_DIR: The directory to store the source and target images in (Default: /home/node/cache)
  • CACHE_CONTROL_MAX_AGE: The maximum age of the cache in hours (Default: 1)
  • CLUSTER_MODE: Enable cluster-aware routing in Kubernetes (Default: false)