Skip to content
Fast and secure standalone server for resizing and converting remote images
Go C Other
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci Cache go mod in CircleCI Sep 16, 2019
.github
.lefthook
docker Add jemalloc to Dockerfile Dec 9, 2019
docs
examples
heroku Add build arg to Heroku Dockerfile Jun 18, 2019
image_size Fix lint errors Oct 10, 2019
struct-diff
.dockerignore
.gitignore Ignore .tmp Jun 4, 2019
.golangci.yml Better linter settings + linting errors fix Sep 11, 2019
BENCHMARK.md Add benchmark results May 8, 2019
CHANGELOG.md
LICENSE Initial commit Jun 20, 2017
README.md [skip ci] Update docs with gitter, badge icons and favicon Dec 11, 2019
app.json Fix logo in app.json Jun 18, 2019
bufpool.go Better linter settings + linting errors fix Sep 11, 2019
c_strings.go
cmyk_profile.go
config.go Check presets after vips init Nov 11, 2019
crypt.go
crypt_test.go Multiple key/salt pairs support Nov 15, 2018
download.go Fix lint errors Oct 10, 2019
errors.go IMGPROXY_REPORT_DOWNLOADING_ERRORS config Oct 1, 2019
errors_reporting.go Better Sentry support Aug 19, 2019
etag.go Refactored image downloading and watermark preparation Sep 20, 2019
fs_transport.go Simple filesystem transport Feb 4, 2019
gcs_transport.go
go.mod
go.sum
gzippool.go Reset gzip encoder on put to pool Jan 31, 2019
heroku.yml Add build arg to Heroku Dockerfile Jun 18, 2019
image_type.go Properly marshal imageType, resizingType and gravityType Oct 10, 2019
landing.go Favicon dummy handler & hello message at the root Aug 20, 2019
lefthook.yml Add lefthook Aug 20, 2019
listen_no_reuseport.go
listen_reuseport.go
log.go
log_formatter.go New logging; JSON and structured log formats Sep 16, 2019
logo.svg Optimize logo Aug 20, 2019
main.go
main_test.go Get rid of init() in config.go Jun 6, 2019
newrelic.go Back to net/http May 8, 2019
pprof.go Require pprof build tag to enable net/pprof Jun 6, 2019
presets.go Tests Nov 6, 2018
presets_test.go
process.go
processing_handler.go New logging; JSON and structured log formats Sep 16, 2019
processing_options.go
processing_options_test.go
prometheus.go
router.go
s3transport.go Lint with golangci-lint; Fix linter issues; Add Go 1.12 to CircleCI Apr 11, 2019
server.go New logging; JSON and structured log formats Sep 16, 2019
syslog.go New logging; JSON and structured log formats Sep 16, 2019
timer.go New logging; JSON and structured log formats Sep 16, 2019
utils.go
vips.c Check VIPS_META_ORIENTATION type before get Oct 11, 2019
vips.go
vips.h Load ICO without imagemagick Oct 3, 2019
watermark_data.go Refactored image downloading and watermark preparation Sep 20, 2019

README.md

imgproxy

CircleCI branch Docker MicroBadger Size Docker Pulls Gitter

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

Special thanks

Many thanks to:

License

imgproxy is licensed under the MIT license.

See LICENSE for the full license text.

Security Contact

To report a security vulnerability, please use the Tidelift security contact. Tidelift will coordinate the fix and disclosure.

You can’t perform that action at this time.