Skip to content
Fast and secure standalone server for resizing and converting remote images
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci Test build only with the latest 3 versions of Go and vips Apr 11, 2019
docs Update presets-only mode docs May 16, 2019
examples adds truncated signature example for PHP (#131) Jan 21, 2019
vendor Back to net/http May 8, 2019
.dockerignore
.gitignore gitignore .vscode Apr 1, 2019
.golangci.yml Lint with golangci-lint; Fix linter issues; Add Go 1.12 to CircleCI Apr 11, 2019
BENCHMARK.md Add benchmark results May 8, 2019
CHANGELOG.md Bump version; Update changelog May 7, 2019
Dockerfile PNG quantization Apr 5, 2019
LICENSE Initial commit Jun 20, 2017
README.md Add benchmark results May 8, 2019
app.json Make kay and salt optional in app.json Oct 3, 2018
bufpool.go Improve download buffer calibration Mar 22, 2019
cmyk_profile.go Refactored logging; Syslog support Jan 14, 2019
config.go Don't set default false in boolEnvConfig May 28, 2019
crypt.go Token => signature Nov 20, 2018
crypt_test.go Multiple key/salt pairs support Nov 15, 2018
download.go Check source content length before getting download buffer May 8, 2019
errors.go Better stacktrace of processing errorf May 8, 2019
errors_reporting.go Add Sentry error reporting (#128) Jan 14, 2019
etag.go Back to net/http May 8, 2019
fs_transport.go Simple filesystem transport Feb 4, 2019
gcs_transport.go Lint with golangci-lint; Fix linter issues; Add Go 1.12 to CircleCI Apr 11, 2019
go.mod Back to net/http May 8, 2019
go.sum Back to net/http May 8, 2019
gzippool.go Reset gzip encoder on put to pool Jan 31, 2019
heroku.yml Deploy to Heroku with Docker (#50) Feb 2, 2018
ico_data.go ICO support Dec 2, 2018
log.go Back to net/http May 8, 2019
logo.svg Logo Sep 21, 2017
main.go Bump version; Update changelog May 7, 2019
main_test.go Tests Nov 6, 2018
newrelic.go Back to net/http May 8, 2019
presets.go Tests Nov 6, 2018
presets_test.go Tests Nov 6, 2018
process.go Better stacktrace of processing errorf May 8, 2019
processing_options.go Fix some processing options checking May 28, 2019
processing_options_test.go Adds an option to allows only presets in the URL. (#156) May 16, 2019
prometheus.go Collect vips memory metrics Feb 21, 2019
s3transport.go Lint with golangci-lint; Fix linter issues; Add Go 1.12 to CircleCI Apr 11, 2019
server.go Add development errors mode May 8, 2019
svg.go improve svg format detection (#135) Feb 21, 2019
syslog.go Add specific syslogtag Mar 28, 2019
timer.go Prometheus metrics Oct 29, 2018
utils.go Focus point gravity Oct 2, 2018
vips.c Fix C99 warning May 7, 2019
vips.h Optimized ICC profile check; Always import ICC when linear colorspace… May 6, 2019
watermark_data.go Watermark Oct 19, 2018
webp.go Lint with golangci-lint; Fix linter issues; Add Go 1.12 to CircleCI Apr 11, 2019

README.md

imgproxy

CircleCI branch Docker MicroBadger Size Docker Pulls

imgproxy is a fast and secure standalone server for resizing and converting remote images. The main principles of imgproxy are simplicity, speed, and security.

imgproxy can be used to provide a fast and secure way to replace all the image resizing code of your web application (like calling ImageMagick or GraphicsMagick, or using libraries), while also being able to resize everything on the fly, fast and easy. imgproxy is also indispensable when handling lots of image resizing, especially when images come from a remote source.

imgproxy does one thing — resizing remote images — and does it well. It works great when you need to resize multiple images on the fly to make them match your application design without preparing a ton of cached resized images or re-doing it every time the design changes.

imgproxy is a Go application, ready to be installed and used in any Unix environment — also ready to be containerized using Docker.

See this article for a good intro and all the juicy details! imgproxy: Resize your images instantly and securely

Sponsored by Evil Martians

Simplicity

"No code is better than no code."

imgproxy only includes the must-have features for image processing, fine-tuning and security. Specifically,

  • It would be great to be able to rotate, flip and apply masks to images, but in most of the cases, it is possible — and is much easier — to do that using CSS3.
  • It may be great to have built-in HTTP caching of some kind, but it is way better to use a Content-Delivery Network or a caching proxy server for this, as you will have to do this sooner or later in the production environment.
  • It might be useful to have everything built in — such as HTTPS support — but an easy way to solve that would be just to use a proxying HTTP server such as nginx.

Speed

imgproxy uses probably the most efficient image processing library there is, called libvips. It is screaming fast and has a very low memory footprint; with it, we can handle the processing for a massive amount of images on the fly.

imgproxy also uses native Go's net/http routing for the best HTTP networking support.

You can see benchmarking results and comparison with some well-known alternatives in our benchmark report.

Security

Massive processing of remote images is a potentially dangerous thing, security-wise. There are many attack vectors, so it is a good idea to consider attack prevention measures first. Here is how imgproxy can help:

  • imgproxy checks image type and "real" dimensions when downloading, so the image will not be fully downloaded if it has an unknown format or the dimensions are too big (there is a setting for that). That is how imgproxy protects you from so called "image bombs" like those described at https://www.bamsoftware.com/hacks/deflate.html.

  • imgproxy protects image URLs with a signature, so an attacker cannot cause a denial-of-service attack by requesting multiple image resizes.

  • imgproxy supports authorization by an HTTP header. That prevents using imgproxy directly by an attacker but allows to use it through a CDN or a caching server — just by adding a header to a proxy or CDN config.

Documentation

  1. Getting started
  2. Installation
  3. Configuration
  4. Generating the URL
  5. Watermark
  6. Presets
  7. Serving local files
  8. Serving files from Amazon S3
  9. Serving files from Google Cloud Storage
  10. New Relic
  11. Prometheus
  12. Image formats support
  13. About processing pipeline
  14. Health check
  15. Memory usage tweaks

Author

Sergey "DarthSim" Alexandrovich

Many thanks to Roman Shamin for the awesome logo.

Great bunch of kudos goes to John Cupitt who develops libvips and helps me to optimize its usage under the hood of imgproxy.

License

imgproxy is licensed under the MIT license.

See LICENSE for the full license text.

You can’t perform that action at this time.