--- title: "Deploy transformimgs" description: "Open Source Image CDN that provides image transformation API" category: "Automation" url: https://railway.com/deploy/a_Rgxz --- # Deploy transformimgs Open Source Image CDN that provides image transformation API **[Deploy transformimgs on Railway](https://railway.com/template/a_Rgxz)** Machine-readable deploy manifest (JSON, validated by TemplateCI): https://railway.com/deploy/a_Rgxz/manifest.json - **Creator:** karlojacmenjak's Projects - **Category:** Automation - **Total deploys:** 7 ## Template content ### TransformImgs https://upload.wikimedia.org/wikipedia/commons/thumb/3/38/Extracted_image_icon.svg/96px-Extracted_image_icon.svg.png - **Image:** pixboost/transformimgs - **Health check:** health - **Public domain:** Yes ## Documentation # TransformImgs Source Github repository: https://github.com/Pixboost/transformimgs [![Go Reference](https://pkg.go.dev/badge/github.com/Pixboost/transformimgs/v8.svg)](https://pkg.go.dev/github.com/Pixboost/transformimgs/v8) ![Go Report Card](https://goreportcard.com/badge/github.com/Pixboost/transformimgs/v8) ![Build Status](https://github.com/Pixboost/transformimgs/actions/workflows/action.yml/badge.svg) [![codecov](https://codecov.io/gh/Pixboost/transformimgs/branch/main/graph/badge.svg)](https://codecov.io/gh/Pixboost/transformimgs) [![Docker Pulls](https://img.shields.io/docker/pulls/pixboost/transformimgs)](https://hub.docker.com/r/pixboost/transformimgs/) [![Docker Automated build](https://img.shields.io/docker/automated/jrottenberg/ffmpeg.svg)](https://hub.docker.com/r/pixboost/transformimgs/) Open Source [Image CDN](https://web.dev/image-cdns/) that provides image transformation API and supports the latest image formats, such as WebP, AVIF, Jpeg XL, and network client hints. ## Table of Contents - [Why?](#why) - [Features](#features) - [Quickstart](#quickstart) - [API](#api) - [Running](#running-locally) * [Docker](#docker) * [Options](#options) * [Running Locally From Source Code](#running-from-source-code) * [Using from Go Web Application](#using-from-go-web-application) - [SaaS](#saas) - [Performance tests](#performance-tests) - [Opened tickets for images related features](#opened-tickets-for-images-related-features) - [Contribute](#contribute) - [License](#license) - [Todo](#todo) ## Why? [We wrote a big blog on this](https://pixboost.com/blog/why-pixboost-is-the-best-image-cdn/), 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 * Resize/optimises/crops raster (PNG and JPEG) images. * [JpegXL](https://jpegxl.info/) / [AVIF](https://en.wikipedia.org/wiki/AV1) / [WebP](https://developers.google.com/speed/webp/) support based on "Accept" header. * [Vary](www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.44) header support - ready to deploy behind any CDN. * Responsive images support including high DPI (retina) displays * [Save-Data](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Save-Data) support ## 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: * /img/{IMG_URL}/optimise - optimises image * /img/{IMG_URL}/resize - resizes image * /img/{IMG_URL}/fit - resize image to the exact size by resizing and cropping it * /img/{IMG_URL}/asis - returns original image Docs: * [Swagger-UI](https://pixboost.com/docs/api/) - use API key `MjUyMTM3OTQyNw__` which allows to transform any image from unsplash.com * [OpenAPI spec](swagger.yaml) ## Running Locally ### Docker The latest docker image published on [Docker hub](https://hub.docker.com/r/pixboost/transformimgs) Starting the server: ``` $ docker run -p 8080:8080 pixboost/transformimgs [OPTIONS] ``` To verify: * Health check: `curl http://localhost:8080/health` * Transformation: `open http://localhost:8080/img/https://images.unsplash.com/photo-1591769225440-811ad7d6eab3/resize?size=600` ### Options Everything below is optional and have sensible defaults. | Option | Description | Default | |--------|-------------| ------- | | cache | Number of seconds to cache image(0 to disable cache). Used in max-age HTTP response. | 2592000 (30 days) | | proc | Number of images processors to run. | Number of CPUs (cores) | | disableSaveData | If 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: * Go 1.18+ with [modules support](https://golang.org/ref/mod) * Installed [imagemagick v7.0.25+](http://imagemagick.org) with AVIF support in `/usr/local/bin` ``` $ git clone git@github.com:Pixboost/transformimgs.git $ cd transformimgs $ ./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](./example_test.go). ## SaaS We run SaaS version at [pixboost.com](https://pixboost.com?source=github) with generous free tier. Perks of SaaS version: * CDN with HTTP/3 support included * Dashboard with usage monitor * API Key support with domains allow list * AWS S3 integration * API workflows for cache busting and warmup * Version upgrades Go modules have been introduced in v6. ## Performance tests There is a [JMeter](https://jmeter.apache.org) performance test you can run against a service. To run tests: * Start a performance test environment: ``` $ docker-compose -f docker-compose-perf.yml up ``` * Run JMeter tests: ``` $ jmeter -n -t perf-test.jmx -l ./results.jmx -e -o ./results ``` * Run JMeter WebP test: ``` $ jmeter -n -t perf-test-webp.jmx -l ./results-webp.jmx -e -o ./results-webp ``` * Run JMeter AVIF test: ``` $ jmeter -n -t perf-test-avif.jmx -l ./results-avif.jmx -e -o ./results-avif ``` * Run JMeter JPEG XL test: ``` $ jmeter -n -t perf-test-jxl.jmx -l ./results-jxl.jmx -e -o ./results-jxl ``` ## Opened tickets for images related features * [Safari to support Save-Data](https://bugs.webkit.org/show_bug.cgi?id=199101) * [Auto sizes for lazy loaded img in Firefox](https://bugzilla.mozilla.org/show_bug.cgi?id=1816615) * [Auto sizes for lazy loaded img in Safari](https://bugs.webkit.org/show_bug.cgi?id=253143) ## Contribute Shout out with any ideas. PRs are more than welcome. ## License You can check out the [MIT](https://github.com/Pixboost/transformimgs/blob/main/LICENSE) here ## Similar templates - [N8N Main + Worker](https://railway.com/deploy/n8n-main-worker) — Deploy and Host N8N with Inactive worker. - [Evolution API with n8n](https://railway.com/deploy/evolution-api-with-n8n) — Automate WhatsApp workflows with Evolution API, n8n, and Postgres. - [Postgres Backup](https://railway.com/deploy/postgres-s3-backups) — Cron-based PostgreSQL backup to bucket storage Open this page in a browser: https://railway.com/deploy/a_Rgxz