Home

Awesome

<p align="center"> <img src="logo.png" alt="logo"/> </p>

TransformImgs

Go Reference Go Report Card Build Status codecov Docker Pulls Docker Automated build

Open Source Image CDN that provides image transformation API and supports the latest image formats, such as WebP, AVIF, Jpeg XL, and network client hints.

Table of Contents

<!-- TOC start --> <!-- TOC end -->

Why?

We wrote a big blog on this, and here is TLDR:

Transformimgs is an image CDN for Web, so API must cover typical use cases, like thumbnails, zoom in product images, etc. Any new API endpoints must solve the above problems.

The goal is to have zero-config API that makes decisions based on the input, so you don't need to provide additional parameters like quality, output format, type of compression, etc.

Therefore, this allows you to configure the integration once. New features, like new image formats, will work with your front end automatically without any changes.

To achieve that goal we should keep API to bare minimum and hide the smartness in the implementation.

Features

Quickstart

There is an example of running API behind reverse proxy with integration example in quickstart/ folder.

To run:

cd quickstart
docker-compose up
open https://localhost

API

The API has 4 HTTP endpoints:

Docs:

Running Locally

Docker

The latest docker image published on Docker hub

Starting the server:

$ docker run -p 8080:8080 pixboost/transformimgs [OPTIONS]

To verify:

Options

Everything below is optional and have sensible defaults.

OptionDescriptionDefault
cacheNumber of seconds to cache image(0 to disable cache). Used in max-age HTTP response.2592000 (30 days)
procNumber of images processors to run.Number of CPUs (cores)
disableSaveDataIf set to true then will disable Save-Data client hint. Should be disabled on CDNs that don't support Save-Data header in Vary.false

Running from source code

Prerequisites:

Install illustration command:

cd illustration/
go install

Run the application:

./run.sh

Using from Go Web Application

You could also easily plugin HTTP route into your existing web application using service.GetRouter method. Here is a quick example of how to do that.

SaaS

We run SaaS version at pixboost.com with generous free tier.

Perks of SaaS version:

Go modules have been introduced in v6.

Performance tests

There is a JMeter performance test you can run against a service. To run tests:

$ docker-compose -f docker-compose-perf.yml up

$ jmeter -n -t perf-test.jmx -l ./results.jmx -e -o ./results

$ jmeter -n -t perf-test-webp.jmx -l ./results-webp.jmx -e -o ./results-webp

$ jmeter -n -t perf-test-avif.jmx -l ./results-avif.jmx -e -o ./results-avif

$ jmeter -n -t perf-test-jxl.jmx -l ./results-jxl.jmx -e -o ./results-jxl

Opened tickets for images related features

Contribute

Shout out with any ideas. PRs are more than welcome.

License

MIT

Todo